Package io.github.douira.glsl_transformer.transform

Class WalkPhase

java.lang.Object
io.github.douira.glsl_transformer.GLSLParserBaseListener
io.github.douira.glsl_transformer.transform.TransformationPhase
io.github.douira.glsl_transformer.transform.WalkPhase
All Implemented Interfaces:
io.github.douira.glsl_transformer.GLSLParserListener, ParseTreeListener
Direct Known Subclasses:
ProcessIdentifiers
public abstract class WalkPhase extends TransformationPhase
The walk phase is a phase on which the listener methods of the generated listener interface are called. It can control when it is run by changing the is*Walk and isActive methods. It can also run before and after the tree walk happens.

  • Nested Class Summary

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

    TransformationPhase.InjectionPoint

  • Constructor Summary

    Constructors
    Constructor
    Description
    WalkPhase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    afterWalk(io.github.douira.glsl_transformer.GLSLParser.TranslationUnitContext ctx)
    This method is called after the tree walk was performed.
    protected void
    beforeWalk(io.github.douira.glsl_transformer.GLSLParser.TranslationUnitContext ctx)
    This method is called before the tree walk is performed.
    protected boolean
    isActiveAfterWalk()
    Determines if this phase's afterWalk(TranslationUnitContext) should be run.
    protected boolean
    isActiveAtWalk()
    Determines if the phase's listener methods should be run.
    protected boolean
    isActiveBeforeWalk()
    Determines if this phase's beforeWalk(TranslationUnitContext) should be run.

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

    compilePath, compilePattern, createLocalRoot, findAndMatch, getCollector, getLexer, getParser, getRootNode, getSiblings, init, injectDefine, injectExternalDeclaration, injectNode, injectNodes, isActive, removeNode, replaceNode, replaceNode, setCollector

    Methods inherited from class io.github.douira.glsl_transformer.GLSLParserBaseListener

    enterAdditiveExpression, enterAndExpression, enterArraySpecifier, enterAssignmentExpression, enterAssignmentOperator, enterAttribute, enterBuiltinTypeSpecifierFixed, enterBuiltinTypeSpecifierParseable, enterCallParameterList, enterCaseLabel, enterCompoundStatement, enterCondition, enterConditionalExpression, enterConstantExpression, enterDeclaration, enterDeclarationMember, enterDeclarationMemberList, enterDeclarationStatement, enterDemoteStatement, enterDoWhileStatement, enterEmptyStatement, enterEqualityExpression, enterEveryRule, enterExclusiveOrExpression, enterExpression, enterExpressionStatement, enterExtensionState, enterExtensionStatement, enterExternalDeclaration, enterForStatement, enterFullySpecifiedType, enterFunctionCall, enterFunctionDefinition, enterFunctionHeader, enterFunctionIdentifier, enterFunctionParameterList, enterFunctionPrototype, enterInclusiveOrExpression, enterInitDeclaratorList, enterInitializer, enterInterpolationQualifier, enterInvariantQualifier, enterJumpStatement, enterLayoutDefaults, enterLayoutModes, enterLayoutQualifier, enterLayoutQualifierId, enterLogicalAndExpression, enterLogicalOrExpression, enterLogicalXorExpression, enterMethodCall, enterMultiplicativeExpression, enterParameterDeclaration, enterParameterDeclarator, enterPostfixExpression, enterPragmaStatement, enterPreciseQualifier, enterPrecisionQualifier, enterPrimaryExpression, enterRelationalExpression, enterSelectionStatement, enterShiftExpression, enterSimpleStatement, enterSingleAttribute, enterStatement, enterStorageQualifier, enterStructDeclaration, enterStructDeclarationList, enterStructDeclarator, enterStructDeclaratorList, enterStructSpecifier, enterSwitchStatement, enterTranslationUnit, enterTypeNameList, enterTypeQualifier, enterTypeSpecifier, enterTypeSpecifierNonarray, enterUnaryExpression, enterUnaryOperator, enterVariableIdentifier, enterVersionStatement, enterWhileStatement, exitAdditiveExpression, exitAndExpression, exitArraySpecifier, exitAssignmentExpression, exitAssignmentOperator, exitAttribute, exitBuiltinTypeSpecifierFixed, exitBuiltinTypeSpecifierParseable, exitCallParameterList, exitCaseLabel, exitCompoundStatement, exitCondition, exitConditionalExpression, exitConstantExpression, exitDeclaration, exitDeclarationMember, exitDeclarationMemberList, exitDeclarationStatement, exitDemoteStatement, exitDoWhileStatement, exitEmptyStatement, exitEqualityExpression, exitEveryRule, exitExclusiveOrExpression, exitExpression, exitExpressionStatement, exitExtensionState, exitExtensionStatement, exitExternalDeclaration, exitForStatement, exitFullySpecifiedType, exitFunctionCall, exitFunctionDefinition, exitFunctionHeader, exitFunctionIdentifier, exitFunctionParameterList, exitFunctionPrototype, exitInclusiveOrExpression, exitInitDeclaratorList, exitInitializer, exitInterpolationQualifier, exitInvariantQualifier, exitJumpStatement, exitLayoutDefaults, exitLayoutModes, exitLayoutQualifier, exitLayoutQualifierId, exitLogicalAndExpression, exitLogicalOrExpression, exitLogicalXorExpression, exitMethodCall, exitMultiplicativeExpression, exitParameterDeclaration, exitParameterDeclarator, exitPostfixExpression, exitPragmaStatement, exitPreciseQualifier, exitPrecisionQualifier, exitPrimaryExpression, exitRelationalExpression, exitSelectionStatement, exitShiftExpression, exitSimpleStatement, exitSingleAttribute, exitStatement, exitStorageQualifier, exitStructDeclaration, exitStructDeclarationList, exitStructDeclarator, exitStructDeclaratorList, exitStructSpecifier, exitSwitchStatement, exitTranslationUnit, exitTypeNameList, exitTypeQualifier, exitTypeSpecifier, exitTypeSpecifierNonarray, exitUnaryExpression, exitUnaryOperator, exitVariableIdentifier, exitVersionStatement, exitWhileStatement, visitErrorNode, visitTerminal

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WalkPhase

      public WalkPhase()

  • Method Details

    • isActiveBeforeWalk

      protected boolean isActiveBeforeWalk()
      Determines if this phase's beforeWalk(TranslationUnitContext) should be run.
      Returns:
      If it should be run

    • isActiveAtWalk

      protected boolean isActiveAtWalk()
      Determines if the phase's listener methods should be run. If this returns false, the phase effectively degenerates into a RunPhase.
      Returns:
      If the phase should participate in the tree walk

    • isActiveAfterWalk

      protected boolean isActiveAfterWalk()
      Determines if this phase's afterWalk(TranslationUnitContext) should be run.
      Returns:
      If it should be run

    • beforeWalk

      protected void beforeWalk(io.github.douira.glsl_transformer.GLSLParser.TranslationUnitContext ctx)
      This method is called before the tree walk is performed.
      Parameters:
      ctx - The root translation unit node

    • afterWalk

      protected void afterWalk(io.github.douira.glsl_transformer.GLSLParser.TranslationUnitContext ctx)
      This method is called after the tree walk was performed.
      Parameters:
      ctx - The root translation unit node