ASTMatcher (Groovy 6.0.0-alpha-1)

org.codehaus.groovy.macro.matcher.ASTMatcher

@AutoFinal
@CompileStatic
class ASTMatcher
extends ContextualClassCodeVisitor

Matches AST nodes against pattern ASTs.

Since:: 2.5.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`WILDCARD`	Wildcard marker used in matcher patterns.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static List<TreeContext>`	`find(ASTNode node, ASTNode pattern)` Locates all nodes in the given AST which match the pattern AST.
	`protected SourceUnit`	`getSourceUnit()` Returns no source unit because AST matching is source-independent.
`<T>`	`T`	`ifConstraint(T defaultValue, Closure<T> code)` Executes the supplied closure with the current matching constraints as delegate.
	`static boolean`	`matches(ASTNode node, ASTNode pattern)` Matches an AST with another AST (pattern).
	`void`	`visitAnnotations(AnnotatedNode node)` Matches annotations on the current annotated node.
	`void`	`visitArrayExpression(ArrayExpression expression)` Matches an array expression against the current candidate.
	`void`	`visitAttributeExpression(AttributeExpression expression)` Matches an attribute expression against the current candidate.
	`void`	`visitBinaryExpression(BinaryExpression expression)` Matches a binary expression against the current candidate.
	`void`	`visitBitwiseNegationExpression(BitwiseNegationExpression expression)` Matches a bitwise-negation expression against the current candidate.
	`void`	`visitBlockStatement(BlockStatement block)` Matches a block statement against the current candidate.
	`void`	`visitBooleanExpression(BooleanExpression expression)` Matches a boolean expression against the current candidate.
	`void`	`visitCastExpression(CastExpression expression)` Matches a cast expression against the current candidate.
	`void`	`visitClass(ClassNode node)` Matches a class node against the current candidate.
	`protected void`	`visitClassCodeContainer(Statement code)` Matches a class code container against the current candidate.
	`void`	`visitClassExpression(ClassExpression expression)` Matches a class expression against the current candidate.
	`void`	`visitClosureExpression(ClosureExpression expression)` Matches a closure expression against the current candidate.
	`void`	`visitClosureListExpression(ClosureListExpression cle)` Matches a closure-list expression against the current candidate.
	`void`	`visitConstantExpression(ConstantExpression expression)` Matches a constant expression against the current candidate.
	`void`	`visitConstructorCallExpression(ConstructorCallExpression call)` Matches a constructor call expression against the current candidate.
	`protected void`	`visitConstructorOrMethod(MethodNode node, boolean isConstructor)` Matches a constructor or method node against the current candidate.
	`void`	`visitDeclarationExpression(DeclarationExpression expression)` Matches a declaration expression against the current candidate.
	`void`	`visitExpressionStatement(ExpressionStatement statement)` Matches an expression statement against the current candidate.
	`void`	`visitField(FieldNode node)` Matches a field node against the current candidate.
	`void`	`visitForLoop(ForStatement forLoop)` Matches a for loop against the current candidate.
	`void`	`visitGStringExpression(GStringExpression expression)` Matches a GString expression against the current candidate.
	`void`	`visitIfElse(IfStatement ifElse)` Matches an if/else statement against the current candidate.
	`void`	`visitImports(ModuleNode node)` Matches module imports against the current candidate.
	`void`	`visitListExpression(ListExpression expression)` Matches a list expression against the current candidate.
	`void`	`visitListOfExpressions(List<? extends Expression> list)` Matches a list of expressions against the current candidate list.
	`void`	`visitMapEntryExpression(MapEntryExpression expression)` Matches a map-entry expression against the current candidate.
	`void`	`visitMapExpression(MapExpression expression)` Matches a map expression against the current candidate.
	`void`	`visitMethodCallExpression(MethodCallExpression call)` Matches a method call expression against the current candidate.
	`void`	`visitMethodPointerExpression(MethodPointerExpression expression)` Matches a method-pointer expression against the current candidate.
	`void`	`visitNotExpression(NotExpression expression)` Matches a not expression against the current candidate.
	`protected void`	`visitObjectInitializerStatements(ClassNode node)` Matches object initializer statements for the current class candidate.
	`void`	`visitPackage(PackageNode node)` Matches a package node against the current candidate.
	`void`	`visitPostfixExpression(PostfixExpression expression)` Matches a postfix expression against the current candidate.
	`void`	`visitPrefixExpression(PrefixExpression expression)` Matches a prefix expression against the current candidate.
	`void`	`visitProperty(PropertyNode node)` Matches a property node against the current candidate.
	`void`	`visitPropertyExpression(PropertyExpression expression)` Matches a property expression against the current candidate.
	`void`	`visitRangeExpression(RangeExpression expression)` Matches a range expression against the current candidate.
	`void`	`visitSpreadExpression(SpreadExpression expression)` Matches a spread expression against the current candidate.
	`void`	`visitTernaryExpression(TernaryExpression expression)` Matches a ternary expression against the current candidate.
	`void`	`visitTupleExpression(TupleExpression expression)` Matches a tuple expression against the current candidate.
	`void`	`visitUnaryMinusExpression(UnaryMinusExpression expression)` Matches a unary-minus expression against the current candidate.
	`void`	`visitUnaryPlusExpression(UnaryPlusExpression expression)` Matches a unary-plus expression against the current candidate.
	`void`	`visitVariableExpression(VariableExpression expression)` Matches a variable expression against the current candidate.
	`void`	`visitWhileLoop(WhileStatement loop)` Matches a while loop against the current candidate.
	`static ASTNode`	`withConstraints(ASTNode pattern, Closure constraintsSpec)` TODO: experimental!

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ContextualClassCodeVisitor`	getLastContext, getTreeContext, getTreePath, matchByClass, pathMatches, pathUpTo, pathUpTo, pathUpTo, popContext, pushContext, pushContext, visitArrayExpression, visitAssertStatement, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBlockStatement, visitBooleanExpression, visitBreakStatement, visitBytecodeExpression, visitCaseStatement, visitCastExpression, visitCatchStatement, visitClass, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitConstructorOrMethod, visitContinueStatement, visitDoWhileLoop, visitEmptyStatement, visitExpressionStatement, visitField, visitFieldExpression, visitForLoop, visitGStringExpression, visitIfElse, visitImports, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitNotExpression, visitPackage, visitPostfixExpression, visitPrefixExpression, visitProperty, visitPropertyExpression, visitRangeExpression, visitReturnStatement, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitSwitch, visitSynchronizedStatement, visitTernaryExpression, visitThrowStatement, visitTryCatchFinally, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression, visitWhileLoop
`class ClassCodeVisitorSupport`	addError, getSourceUnit, visitAnnotation, visitAnnotations, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClass, visitClassCodeContainer, visitClosureExpression, visitConstructor, visitConstructorOrMethod, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitExpressionStatement, visitField, visitForLoop, visitIfElse, visitImports, visitMethod, visitObjectInitializerStatements, visitPackage, visitProperty, visitReturnStatement, visitStatement, visitStatementAnnotations, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally, visitWhileLoop
`class CodeVisitorSupport`	afterSwitchCaseStatementsVisited, afterSwitchConditionExpressionVisited, visitArgumentlistExpression, visitArrayExpression, visitAssertStatement, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBlockStatement, visitBooleanExpression, visitBreakStatement, visitBytecodeExpression, visitCaseStatement, visitCastExpression, visitCatchStatement, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitEmptyStatement, visitExpressionStatement, visitFieldExpression, visitForLoop, visitGStringExpression, visitIfElse, visitLambdaExpression, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitMethodReferenceExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitReturnStatement, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitSwitch, visitSynchronizedStatement, visitTernaryExpression, visitThrowStatement, visitTryCatchFinally, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression, visitWhileLoop

- Field Detail
  - public static final String WILDCARD
    
    Wildcard marker used in matcher patterns.
- Method Detail
  - static List<TreeContext> find(ASTNode node, ASTNode pattern)
    
    Locates all nodes in the given AST which match the pattern AST. This operation can cost a lot, because it tries to match a sub-tree to every node of the AST.
    Parameters:
    node - an AST Node
    pattern - a pattern to be found somewhere in the AST
    Returns:
    a list of TreeContext, always not null.
  - @Override
    protected SourceUnit getSourceUnit()
    
    Returns no source unit because AST matching is source-independent.
  - <T> T ifConstraint(T defaultValue, @DelegatesTo(value=MatchingConstraints, strategy=Closure.DELEGATE_FIRST)
    Closure<T> code)
    
    Executes the supplied closure with the current matching constraints as delegate.
    Parameters:
    defaultValue - the value to return when no constraints are available
    code - the code to execute with the current constraints
    Returns:
    the closure result, or defaultValue when no constraints are present
  - static boolean matches(ASTNode node, ASTNode pattern)
    
    Matches an AST with another AST (pattern). It will return true if the AST matches all the nodes from the pattern AST.
    Parameters:
    node - the AST we want to match with
    pattern - the pattern AST we want to match to
    Returns:
    true if this AST matches the pattern
  - @Override
    void visitAnnotations(AnnotatedNode node)
    
    Matches annotations on the current annotated node.
  - @Override
    void visitArrayExpression(ArrayExpression expression)
    
    Matches an array expression against the current candidate.
  - @Override
    void visitAttributeExpression(AttributeExpression expression)
    
    Matches an attribute expression against the current candidate.
  - @Override
    void visitBinaryExpression(BinaryExpression expression)
    
    Matches a binary expression against the current candidate.
  - @Override
    void visitBitwiseNegationExpression(BitwiseNegationExpression expression)
    
    Matches a bitwise-negation expression against the current candidate.
  - @Override
    void visitBlockStatement(BlockStatement block)
    
    Matches a block statement against the current candidate.
  - @Override
    void visitBooleanExpression(BooleanExpression expression)
    
    Matches a boolean expression against the current candidate.
  - @Override
    void visitCastExpression(CastExpression expression)
    
    Matches a cast expression against the current candidate.
  - @Override
    void visitClass(ClassNode node)
    
    Matches a class node against the current candidate.
  - @Override
    protected void visitClassCodeContainer(Statement code)
    
    Matches a class code container against the current candidate.
  - @Override
    @CompileDynamic
    void visitClassExpression(ClassExpression expression)
    
    Matches a class expression against the current candidate.
  - @Override
    void visitClosureExpression(ClosureExpression expression)
    
    Matches a closure expression against the current candidate.
  - @Override
    void visitClosureListExpression(ClosureListExpression cle)
    
    Matches a closure-list expression against the current candidate.
  - @Override
    @CompileDynamic
    void visitConstantExpression(ConstantExpression expression)
    
    Matches a constant expression against the current candidate.
  - @Override
    void visitConstructorCallExpression(ConstructorCallExpression call)
    
    Matches a constructor call expression against the current candidate.
  - @Override
    protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor)
    
    Matches a constructor or method node against the current candidate.
  - @Override
    @CompileDynamic
    void visitDeclarationExpression(DeclarationExpression expression)
    
    Matches a declaration expression against the current candidate.
  - @Override
    void visitExpressionStatement(ExpressionStatement statement)
    
    Matches an expression statement against the current candidate.
  - @Override
    void visitField(FieldNode node)
    
    Matches a field node against the current candidate.
  - @Override
    void visitForLoop(ForStatement forLoop)
    
    Matches a for loop against the current candidate.
  - @Override
    void visitGStringExpression(GStringExpression expression)
    
    Matches a GString expression against the current candidate.
  - @Override
    void visitIfElse(IfStatement ifElse)
    
    Matches an if/else statement against the current candidate.
  - @Override
    void visitImports(ModuleNode node)
    
    Matches module imports against the current candidate.
  - @Override
    void visitListExpression(ListExpression expression)
    
    Matches a list expression against the current candidate.
  - @Override
    void visitListOfExpressions(List<? extends Expression> list)
    
    Matches a list of expressions against the current candidate list.
  - @Override
    void visitMapEntryExpression(MapEntryExpression expression)
    
    Matches a map-entry expression against the current candidate.
  - @Override
    void visitMapExpression(MapExpression expression)
    
    Matches a map expression against the current candidate.
  - @Override
    void visitMethodCallExpression(MethodCallExpression call)
    
    Matches a method call expression against the current candidate.
  - @Override
    void visitMethodPointerExpression(MethodPointerExpression expression)
    
    Matches a method-pointer expression against the current candidate.
  - @Override
    void visitNotExpression(NotExpression expression)
    
    Matches a not expression against the current candidate.
  - @Override
    protected void visitObjectInitializerStatements(ClassNode node)
    
    Matches object initializer statements for the current class candidate.
  - @Override
    void visitPackage(PackageNode node)
    
    Matches a package node against the current candidate.
  - @Override
    void visitPostfixExpression(PostfixExpression expression)
    
    Matches a postfix expression against the current candidate.
  - @Override
    void visitPrefixExpression(PrefixExpression expression)
    
    Matches a prefix expression against the current candidate.
  - @Override
    void visitProperty(PropertyNode node)
    
    Matches a property node against the current candidate.
  - @Override
    void visitPropertyExpression(PropertyExpression expression)
    
    Matches a property expression against the current candidate.
  - @Override
    void visitRangeExpression(RangeExpression expression)
    
    Matches a range expression against the current candidate.
  - @Override
    void visitSpreadExpression(SpreadExpression expression)
    
    Matches a spread expression against the current candidate.
  - @Override
    void visitTernaryExpression(TernaryExpression expression)
    
    Matches a ternary expression against the current candidate.
  - @Override
    void visitTupleExpression(TupleExpression expression)
    
    Matches a tuple expression against the current candidate.
  - @Override
    void visitUnaryMinusExpression(UnaryMinusExpression expression)
    
    Matches a unary-minus expression against the current candidate.
  - @Override
    void visitUnaryPlusExpression(UnaryPlusExpression expression)
    
    Matches a unary-plus expression against the current candidate.
  - @Override
    void visitVariableExpression(VariableExpression expression)
    
    Matches a variable expression against the current candidate.
  - @Override
    void visitWhileLoop(WhileStatement loop)
    
    Matches a while loop against the current candidate.
  - static ASTNode withConstraints(ASTNode pattern, @DelegatesTo(value=MatchingConstraintsBuilder, strategy=Closure.DELEGATE_ONLY)
    Closure constraintsSpec)
    
    TODO: experimental! Annotates an AST node with matching contraints. This method should be called on an AST intended to be used as a pattern only. It will put node metadata on the AST node allowing customized behavior in pattern matching.
    Parameters:
    pattern - a pattern AST
    constraintsSpec - a closure specification of matching constraints
    Returns:
    the same pattern, annotated with constraints

Summary:
Field
Method

| Detail:
Field
Method

[Groovy] Class ASTMatcher

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String WILDCARD

Method Detail

static List<TreeContext> find(ASTNode node, ASTNode pattern)

@Overrideprotected SourceUnit getSourceUnit()

<T> T ifConstraint(T defaultValue, @DelegatesTo(value=MatchingConstraints, strategy=Closure.DELEGATE_FIRST)Closure<T> code)

static boolean matches(ASTNode node, ASTNode pattern)

@Overridevoid visitAnnotations(AnnotatedNode node)

@Overridevoid visitArrayExpression(ArrayExpression expression)

@Overridevoid visitAttributeExpression(AttributeExpression expression)

@Overridevoid visitBinaryExpression(BinaryExpression expression)

@Overridevoid visitBitwiseNegationExpression(BitwiseNegationExpression expression)

@Overridevoid visitBlockStatement(BlockStatement block)

@Overridevoid visitBooleanExpression(BooleanExpression expression)

@Overridevoid visitCastExpression(CastExpression expression)

@Overridevoid visitClass(ClassNode node)

@Overrideprotected void visitClassCodeContainer(Statement code)

@Override@CompileDynamicvoid visitClassExpression(ClassExpression expression)

@Overridevoid visitClosureExpression(ClosureExpression expression)

@Overridevoid visitClosureListExpression(ClosureListExpression cle)

@Override@CompileDynamicvoid visitConstantExpression(ConstantExpression expression)

@Overridevoid visitConstructorCallExpression(ConstructorCallExpression call)

@Overrideprotected void visitConstructorOrMethod(MethodNode node, boolean isConstructor)

@Override@CompileDynamicvoid visitDeclarationExpression(DeclarationExpression expression)

@Overridevoid visitExpressionStatement(ExpressionStatement statement)

@Overridevoid visitField(FieldNode node)

@Overridevoid visitForLoop(ForStatement forLoop)

@Overridevoid visitGStringExpression(GStringExpression expression)

@Overridevoid visitIfElse(IfStatement ifElse)

@Overridevoid visitImports(ModuleNode node)

@Overridevoid visitListExpression(ListExpression expression)

@Overridevoid visitListOfExpressions(List<? extends Expression> list)

@Overridevoid visitMapEntryExpression(MapEntryExpression expression)

@Overridevoid visitMapExpression(MapExpression expression)

@Overridevoid visitMethodCallExpression(MethodCallExpression call)

@Overridevoid visitMethodPointerExpression(MethodPointerExpression expression)

@Overridevoid visitNotExpression(NotExpression expression)

@Overrideprotected void visitObjectInitializerStatements(ClassNode node)

@Overridevoid visitPackage(PackageNode node)

@Overridevoid visitPostfixExpression(PostfixExpression expression)

@Overridevoid visitPrefixExpression(PrefixExpression expression)

@Overridevoid visitProperty(PropertyNode node)

@Overridevoid visitPropertyExpression(PropertyExpression expression)

@Overridevoid visitRangeExpression(RangeExpression expression)

@Overridevoid visitSpreadExpression(SpreadExpression expression)

@Overridevoid visitTernaryExpression(TernaryExpression expression)

@Overridevoid visitTupleExpression(TupleExpression expression)

@Overridevoid visitUnaryMinusExpression(UnaryMinusExpression expression)

@Overridevoid visitUnaryPlusExpression(UnaryPlusExpression expression)

@Overridevoid visitVariableExpression(VariableExpression expression)

@Overridevoid visitWhileLoop(WhileStatement loop)

static ASTNode withConstraints(ASTNode pattern, @DelegatesTo(value=MatchingConstraintsBuilder, strategy=Closure.DELEGATE_ONLY)Closure constraintsSpec)

@Override
protected SourceUnit getSourceUnit()

<T> T ifConstraint(T defaultValue, @DelegatesTo(value=MatchingConstraints, strategy=Closure.DELEGATE_FIRST)
Closure<T> code)

@Override
void visitAnnotations(AnnotatedNode node)

@Override
void visitArrayExpression(ArrayExpression expression)

@Override
void visitAttributeExpression(AttributeExpression expression)

@Override
void visitBinaryExpression(BinaryExpression expression)

@Override
void visitBitwiseNegationExpression(BitwiseNegationExpression expression)

@Override
void visitBlockStatement(BlockStatement block)

@Override
void visitBooleanExpression(BooleanExpression expression)

@Override
void visitCastExpression(CastExpression expression)

@Override
void visitClass(ClassNode node)

@Override
protected void visitClassCodeContainer(Statement code)

@Override
@CompileDynamic
void visitClassExpression(ClassExpression expression)

@Override
void visitClosureExpression(ClosureExpression expression)

@Override
void visitClosureListExpression(ClosureListExpression cle)

@Override
@CompileDynamic
void visitConstantExpression(ConstantExpression expression)

@Override
void visitConstructorCallExpression(ConstructorCallExpression call)

@Override
protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor)

@Override
@CompileDynamic
void visitDeclarationExpression(DeclarationExpression expression)

@Override
void visitExpressionStatement(ExpressionStatement statement)

@Override
void visitField(FieldNode node)

@Override
void visitForLoop(ForStatement forLoop)

@Override
void visitGStringExpression(GStringExpression expression)

@Override
void visitIfElse(IfStatement ifElse)

@Override
void visitImports(ModuleNode node)

@Override
void visitListExpression(ListExpression expression)

@Override
void visitListOfExpressions(List<? extends Expression> list)

@Override
void visitMapEntryExpression(MapEntryExpression expression)

@Override
void visitMapExpression(MapExpression expression)

@Override
void visitMethodCallExpression(MethodCallExpression call)

@Override
void visitMethodPointerExpression(MethodPointerExpression expression)

@Override
void visitNotExpression(NotExpression expression)

@Override
protected void visitObjectInitializerStatements(ClassNode node)

@Override
void visitPackage(PackageNode node)

@Override
void visitPostfixExpression(PostfixExpression expression)

@Override
void visitPrefixExpression(PrefixExpression expression)

@Override
void visitProperty(PropertyNode node)

@Override
void visitPropertyExpression(PropertyExpression expression)

@Override
void visitRangeExpression(RangeExpression expression)

@Override
void visitSpreadExpression(SpreadExpression expression)

@Override
void visitTernaryExpression(TernaryExpression expression)

@Override
void visitTupleExpression(TupleExpression expression)

@Override
void visitUnaryMinusExpression(UnaryMinusExpression expression)

@Override
void visitUnaryPlusExpression(UnaryPlusExpression expression)

@Override
void visitVariableExpression(VariableExpression expression)

@Override
void visitWhileLoop(WhileStatement loop)

static ASTNode withConstraints(ASTNode pattern, @DelegatesTo(value=MatchingConstraintsBuilder, strategy=Closure.DELEGATE_ONLY)
Closure constraintsSpec)