Package io.github.douira.glsl_transformer.core

Class WrapIdentifier<T>

java.lang.Object

io.github.douira.glsl_transformer.transform.Transformation<T>

io.github.douira.glsl_transformer.core.WrapIdentifier<T>

public class WrapIdentifier<T>
extends Transformation<T>

The wrap identifier transformation wraps the usage of a certain identifier with new code by replacing its usage with a new expression and inserting code that takes care of handling the conversion from the new to the old value. It also checks that the wrapped value isn't already present in the code.

Nested Class Summary

Nested classes/interfaces inherited from class io.github.douira.glsl_transformer.transform.Transformation

Transformation.PhaseEntry<T>

Field Summary

Fields inherited from class io.github.douira.glsl_transformer.transform.Transformation

DEFAULT_GROUP

Constructor Summary

Constructors

Constructor	Description
WrapIdentifier(String wrapTarget, String wrapResult, HandlerTarget<T> replaceTarget, RunPhase<T> wrappingInjector)	Creates a new wrap identifier transformation.

Method Summary

Modifier and Type	Method	Description
static <T> WrapIdentifier<T>	fromExpression(String wrapTarget, String wrapResult, String wrapExpression, RunPhase<T> wrappingInjector)	Creates a new wrap identifier transformation that uses a parsed replace target that replaces identifiers with an expression.
static <T> WrapIdentifier<T>	fromTerminal(String wrapTarget, String wrapResult, RunPhase<T> wrappingInjector)	Creates a new wrap identifier transformation that uses an unparsed terminal replace target.
static <T> WrapIdentifier<T>	withExternalDeclaration(String wrapTarget, String wrapResult, String wrapExpression, TransformationPhase.InjectionPoint location, String injectedCode)	Creates a new wrap identifier transformation that inserts a parsed expression as a replacement and inserts a new external declaration.

Methods inherited from class io.github.douira.glsl_transformer.transform.Transformation

addConcurrentPhase, addPhase, addPhase, addPhase, addPhase, getDefaultGroup, resetState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WrapIdentifier

public WrapIdentifier(String wrapTarget,
 String wrapResult,
 HandlerTarget<T> replaceTarget,
 RunPhase<T> wrappingInjector)

Creates a new wrap identifier transformation.

Parameters:

wrapTarget - The identifier to replace

wrapResult - The identifier that will be used to replace it

replaceTarget - The target that is used as a replacement

wrappingInjector - A transformation phase that does the additional code injection

Method Details

fromTerminal

public static <T> WrapIdentifier<T> fromTerminal(String wrapTarget,
 String wrapResult,
 RunPhase<T> wrappingInjector)

Creates a new wrap identifier transformation that uses an unparsed terminal replace target. It uses the wrap result as the identifier to disallow as well as the terminal to insert as a replacement. This is a commonly used operation when the inserted replacement is just a different identifier.

Type Parameters:

T - The job parameter type

Parameters:

wrapTarget - The identifier to replace

wrapResult - The identifier that will be used to replace it

wrappingInjector - A transformation phase that does the additional code injection

Returns:

The wrap identifier transformation with the given parameters

fromExpression

public static <T> WrapIdentifier<T> fromExpression(String wrapTarget,
 String wrapResult,
 String wrapExpression,
 RunPhase<T> wrappingInjector)

Creates a new wrap identifier transformation that uses a parsed replace target that replaces identifiers with an expression. (which may also just be an identifier)

Type Parameters:

T - The job parameter type

Parameters:

wrapTarget - The identifier to replace

wrapResult - The identifier that will be used to replace it

wrapExpression - The expression to insert instead of the wrapTarget

wrappingInjector - A transformation phase that does the additional code injection

Returns:

The wrap identifier transformation with the given parameters

withExternalDeclaration

public static <T> WrapIdentifier<T> withExternalDeclaration(String wrapTarget,
 String wrapResult,
 String wrapExpression,
 TransformationPhase.InjectionPoint location,
 String injectedCode)

Creates a new wrap identifier transformation that inserts a parsed expression as a replacement and inserts a new external declaration.

Type Parameters:

T - The job parameter type

Parameters:

wrapTarget - The identifier to replace

wrapResult - The identifier that will be used to replace it

wrapExpression - The expression to insert instead of the wrapTarget

location - The injection location for the new code

injectedCode - The code to parse and inject as an external declaration at the given location

Returns:

The wrap identifier transformation with the given parameters

See Also:

• fromExpression(String, String, String, RunPhase)