Apache Groovy 3.0.20 · org.codehaus.groovy.transform.ASTTransformationVisitor

This class handles the invocation of the ASTAnnotationTransformation when it is encountered by a tree walk. One instance of each exists for each phase of the compilation it applies to. Before invocation the

org.codehaus.groovy.transform.ASTTransformationCollectorCodeVisitor will add a list of annotations that this visitor should be concerned about. All other annotations are ignored, whether or not they are GroovyASTTransformation annotated or not.

A Two-pass method is used. First all candidate annotations are added to a list then the transformations are called on those collected annotations. This is done to avoid concurrent modification exceptions during the AST tree walk and allows the transformations to alter any portion of the AST tree. Hence annotations that are added in this phase will not be processed as transformations. They will only be handled in later phases (and then only if the type was in the AST prior to any AST transformations being run against it).

Field Summary

Modifier and Type	Field and Description
private static final Tuple3<String, String, String>	COMPILEDYNAMIC_AND_COMPILESTATIC_AND_TYPECHECKED
private final ASTTransformationsContext	context
private final CompilePhase	phase
private SourceUnit	source
private List<ASTNode[]>	targetNodes
private Map<ASTNode, List<ASTTransformation>>	transforms

Constructor Summary

Access	Constructor and Description
private	ASTTransformationVisitor(final CompilePhase phase, final ASTTransformationsContext context)

Method Summary

Modifier and Type	Method and Description
public static void	addGlobalTransforms(ASTTransformationsContext context)
public static void	addGlobalTransformsAfterGrab(ASTTransformationsContext context)
public static void	addPhaseOperations(final CompilationUnit compilationUnit)
private static void	addPhaseOperationsForGlobalTransforms(CompilationUnit compilationUnit, Map<String, URL> transformNames, boolean isFirstScan)
private List<AnnotationNode>	distinctAnnotations(AnnotatedNode node)
private static void	doAddGlobalTransforms(ASTTransformationsContext context, boolean isFirstScan)
protected SourceUnit	getSourceUnit() Implements abstract org.codehaus.groovy.ast.ClassCodeVisitorSupport.getSourceUnit.
public void	visitAnnotations(final AnnotatedNode the node to be processed node) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitAnnotations. Adds the annotation to the internal target list if a match is found.
public void	visitClass(ClassNode the class to visit classNode) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitClass. Implements org.codehaus.groovy.ast.GroovyClassVisitor.visitClass. Main loop entry.

Field Detail

COMPILEDYNAMIC_AND_COMPILESTATIC_AND_TYPECHECKED	back to summary
private static final Tuple3<String, String, String> COMPILEDYNAMIC_AND_COMPILESTATIC_AND_TYPECHECKED

context	back to summary
private final ASTTransformationsContext context

phase	back to summary
private final CompilePhase phase

source	back to summary
private SourceUnit source

targetNodes	back to summary
private List<ASTNode[]> targetNodes

transforms	back to summary
private Map<ASTNode, List<ASTTransformation>> transforms

Constructor Detail

ASTTransformationVisitor	back to summary
private ASTTransformationVisitor(final CompilePhase phase, final ASTTransformationsContext context)

Method Detail

addGlobalTransforms	back to summary
public static void addGlobalTransforms(ASTTransformationsContext context)

addGlobalTransformsAfterGrab	back to summary
public static void addGlobalTransformsAfterGrab(ASTTransformationsContext context)

addPhaseOperations	back to summary
public static void addPhaseOperations(final CompilationUnit compilationUnit)

addPhaseOperationsForGlobalTransforms	back to summary
private static void addPhaseOperationsForGlobalTransforms(CompilationUnit compilationUnit, Map<String, URL> transformNames, boolean isFirstScan)

distinctAnnotations	back to summary
private List<AnnotationNode> distinctAnnotations(AnnotatedNode node)

doAddGlobalTransforms	back to summary
private static void doAddGlobalTransforms(ASTTransformationsContext context, boolean isFirstScan)

getSourceUnit	back to summary
protected SourceUnit getSourceUnit() Implements abstract org.codehaus.groovy.ast.ClassCodeVisitorSupport.getSourceUnit.

visitAnnotations	back to summary
public void visitAnnotations(final AnnotatedNode node) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitAnnotations. Adds the annotation to the internal target list if a match is found. Parameters node:AnnotatedNode the node to be processed

visitAnnotations

back to summary

public void visitAnnotations(final AnnotatedNode node)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitAnnotations.

Adds the annotation to the internal target list if a match is found.

Parameters

node:AnnotatedNode: the node to be processed

visitClass	back to summary
public void visitClass(ClassNode classNode) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitClass. Implements org.codehaus.groovy.ast.GroovyClassVisitor.visitClass. Main loop entry. First, it delegates to the super visitClass so we can collect the relevant annotations in an AST tree walk. Second, it calls the visit method on the transformation for each relevant annotation found. Parameters classNode:ClassNode the class to visit

visitClass

back to summary

public void visitClass(ClassNode classNode)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitClass.

Implements org.codehaus.groovy.ast.GroovyClassVisitor.visitClass.

Main loop entry.

First, it delegates to the super visitClass so we can collect the relevant annotations in an AST tree walk.

Second, it calls the visit method on the transformation for each relevant annotation found.