org.checkerframework.dataflow.cfg

Class CFGBuilder.CFGTranslationPhaseOne

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<Node,java.lang.Void>

org.checkerframework.dataflow.cfg.CFGBuilder.CFGTranslationPhaseOne

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Direct Known Subclasses:

CFCFGBuilder.CFCFGTranslationPhaseOne

Enclosing class:

CFGBuilder

public class CFGBuilder.CFGTranslationPhaseOne
extends com.sun.source.util.TreePathScanner<Node,java.lang.Void>

Class that performs phase one of the translation process. It generates the following information:

• A sequence of extended nodes.
• A set of bindings from CFGBuilder.Labels to positions in the node sequence.
• A set of leader nodes that give rise to basic blocks in phase two.
• A lookup map that gives the mapping from AST tree nodes to Nodes.

The return type of this scanner is Node. For expressions, the corresponding node is returned to allow linking between different nodes.

However, for statements there is usually no single Node that is created, and thus no node is returned (rather, null is returned).

Every visit* method is assumed to add at least one extended node to the list of nodes (which might only be a jump).

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationProvider	annotationProvider
protected java.util.Map<CFGBuilder.Label,java.lang.Integer>	bindings The bindings of labels to positions (i.e., indices) in the nodeList.
protected java.util.Map<javax.lang.model.element.Name,CFGBuilder.Label>	breakLabels Map from AST label Names to CFG CFGBuilder.Labels for breaks.
protected @Nullable CFGBuilder.Label	breakTargetL Current CFGBuilder.Label to which a break statement with no label should jump, or null if there is no valid destination.
protected java.util.Map<javax.lang.model.element.Name,CFGBuilder.Label>	continueLabels Map from AST label Names to CFG CFGBuilder.Labels for continues.
protected @Nullable CFGBuilder.Label	continueTargetL Current CFGBuilder.Label to which a continue statement with no label should jump, or null if there is no valid destination.
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node>	convertedTreeLookupMap Map from AST Trees to post-conversion Nodes.
protected com.sun.source.tree.VariableTree	ea The VariableTree that indicates whether assertions are enabled or not.
protected javax.lang.model.util.Elements	elements
protected javax.annotation.processing.ProcessingEnvironment	env Annotation processing environment and its associated type and tree utilities.
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>>	generatedTreesLookupMap Map from AST Trees to generated Trees.
protected java.util.Set<java.lang.Integer>	leaders The set of leaders (represented as indices into nodeList).
protected java.util.ArrayList<CFGBuilder.ExtendedNode>	nodeList The list of extended nodes.
protected TreeBuilder	treeBuilder
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node>	treeLookupMap Maps from AST Trees to Nodes.
protected com.sun.source.util.Trees	trees
protected javax.lang.model.util.Types	types
protected long	uid
protected java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode>	unaryAssignNodeLookupMap Map from AST UnaryTrees to compound AssignmentNodes.

Constructor Summary

Constructors

Constructor and Description
CFGTranslationPhaseOne()

Method Summary

Modifier and Type	Method and Description
protected void	addLabelForNextNode(CFGBuilder.Label l) Add the label l to the extended node that will be placed next in the sequence.
protected void	addToConvertedLookupMap(Node node) Add a node in the post-conversion lookup map.
protected void	addToConvertedLookupMap(com.sun.source.tree.Tree tree, Node node) Add a node in the post-conversion lookup map.
protected void	addToGeneratedTreesLookupMap(com.sun.source.tree.Tree tree, com.sun.source.tree.Tree generatedTree) Add a tree in the generated-trees lookup map.
protected void	addToLookupMap(Node node) Add a node to the lookup map if it not already present.
protected void	addToUnaryAssignLookupMap(com.sun.source.tree.UnaryTree tree, AssignmentNode unaryAssignNode) Add a unary tree in the compound assign lookup map.
protected Node	assignConvert(Node node, javax.lang.model.type.TypeMirror varType) Perform assignment conversion so that it can be assigned to a variable of the given type.
protected boolean	assumeAssertionsEnabledFor(com.sun.source.tree.AssertTree tree) Should assertions be assumed to be executed for a given AssertTree? False by default.
protected Node	binaryNumericPromotion(Node node, javax.lang.model.type.TypeMirror exprType) Perform binary numeric promotion on the input node to make it match the expression type.
protected javax.lang.model.type.TypeMirror	binaryPromotedType(javax.lang.model.type.TypeMirror left, javax.lang.model.type.TypeMirror right) Compute the type to which two numeric types must be promoted before performing a binary numeric operation on them.
protected Node	box(Node node) If the input node is an unboxed primitive type, insert a call to the appropriate valueOf method, otherwise leave it alone.
protected Node	commonConvert(Node node, javax.lang.model.type.TypeMirror varType, boolean contextAllowsNarrowing) Assignment conversion and method invocation conversion are almost identical, except that assignment conversion allows narrowing.
protected Node	conditionalExprPromotion(Node node, javax.lang.model.type.TypeMirror destType) Convert an operand of a conditional expression to the type of the whole expression.
protected boolean	conversionRequiresNarrowing(javax.lang.model.type.TypeMirror varType, Node node) Return whether a conversion from the type of the node to varType requires narrowing.
protected java.util.List<Node>	convertCallArguments(javax.lang.model.element.ExecutableElement method, java.util.List<? extends com.sun.source.tree.ExpressionTree> actualExprs) Given a method element and as list of argument expressions, return a list of Nodes representing the arguments converted for a call of the method.
protected com.sun.source.tree.VariableTree	createEnhancedForLoopArrayVariable(com.sun.source.tree.ExpressionTree expression, javax.lang.model.element.VariableElement variableElement)
protected com.sun.source.tree.VariableTree	createEnhancedForLoopIteratorVariable(com.sun.source.tree.MethodInvocationTree iteratorCall, javax.lang.model.element.VariableElement variableElement)
protected void	extendWithExtendedNode(CFGBuilder.ExtendedNode n) Extend the list of extended nodes with an extended node.
protected <T extends Node> T	extendWithNode(T node) Extend the list of extended nodes with a node.
protected CFGBuilder.NodeWithExceptionsHolder	extendWithNodeWithException(Node node, javax.lang.model.type.TypeMirror cause) Extend the list of extended nodes with a node, where node might throw the exception cause.
protected CFGBuilder.NodeWithExceptionsHolder	extendWithNodeWithExceptions(Node node, java.util.Set<javax.lang.model.type.TypeMirror> causes) Extend the list of extended nodes with a node, where node might throw any of the exception in causes.
protected com.sun.source.tree.VariableTree	getAssertionsEnabledVariable() Get a synthetic VariableTree that indicates whether assertions are enabled or not.
protected @Nullable javax.lang.model.element.Name	getLabel(com.sun.source.util.TreePath path) Returns the label Name of the leaf in the argument path, or null if the leaf is not a labeled statement.
void	handleArtificialTree(com.sun.source.tree.Tree tree) Perform any actions required when CFG translation creates a new Tree that is not part of the original AST.
protected void	insertExtendedNodeAfter(CFGBuilder.ExtendedNode n, Node pred) Insert n after the node pred in the list of extended nodes, or append n if pred is not present.
protected <T extends Node> T	insertNodeAfter(T node, Node pred) Insert node after pred in the list of extended nodes, or append to the list if pred is not present.
protected CFGBuilder.NodeWithExceptionsHolder	insertNodeWithExceptionsAfter(Node node, java.util.Set<javax.lang.model.type.TypeMirror> causes, Node pred) Insert a node that might throw the exception cause after pred in the list of extended nodes, or append to the list if pred is not present.
protected boolean	isNumericOrBoxed(javax.lang.model.type.TypeMirror type) Returns true if the argument type is a numeric primitive or a boxed numeric primitive and false otherwise.
protected Node	methodInvocationConvert(Node node, javax.lang.model.type.TypeMirror formalType) Perform method invocation conversion so that the node can be passed as a formal parameter of the given type.
protected Node	narrow(Node node, javax.lang.model.type.TypeMirror destType) Perform narrowing conversion on the input node to make it match the destination type.
protected Node	narrowAndBox(Node node, javax.lang.model.type.TypeMirror destType) Perform narrowing conversion and optionally boxing conversion on the input node to make it match the destination type.
CFGBuilder.PhaseOneResult	process(com.sun.source.tree.CompilationUnitTree root, javax.annotation.processing.ProcessingEnvironment env, UnderlyingAST underlyingAST, CFGBuilder.Label exceptionalExitLabel, TreeBuilder treeBuilder, AnnotationProvider annotationProvider)
CFGBuilder.PhaseOneResult	process(com.sun.source.util.TreePath bodyPath, javax.annotation.processing.ProcessingEnvironment env, UnderlyingAST underlyingAST, CFGBuilder.Label exceptionalExitLabel, TreeBuilder treeBuilder, AnnotationProvider annotationProvider) Performs the actual work of phase one.
protected Node	stringConversion(Node node) Convert the input node to String type, if it isn't already.
protected void	translateAssertWithAssertionsEnabled(com.sun.source.tree.AssertTree tree) Translates an assertion statement to the correct CFG nodes.
protected AssignmentNode	translateAssignment(com.sun.source.tree.Tree tree, Node target, com.sun.source.tree.ExpressionTree rhs) Translate an assignment.
protected AssignmentNode	translateAssignment(com.sun.source.tree.Tree tree, Node target, Node expression) Translate an assignment where the RHS has already been scanned.
protected Node	unaryNumericPromotion(Node node) Perform unary numeric promotion on the input node.
protected Node	unbox(Node node) If the input node is a boxed type, unbox it, otherwise leave it alone.
protected java.lang.String	uniqueName(java.lang.String prefix)
Node	visitAnnotatedType(com.sun.source.tree.AnnotatedTypeTree tree, java.lang.Void p)
Node	visitAnnotation(com.sun.source.tree.AnnotationTree tree, java.lang.Void p)
Node	visitArrayAccess(com.sun.source.tree.ArrayAccessTree tree, java.lang.Void p)
Node	visitArrayType(com.sun.source.tree.ArrayTypeTree tree, java.lang.Void p)
Node	visitAssert(com.sun.source.tree.AssertTree tree, java.lang.Void p)
Node	visitAssignment(com.sun.source.tree.AssignmentTree tree, java.lang.Void p)
Node	visitBinary(com.sun.source.tree.BinaryTree tree, java.lang.Void p)
Node	visitBlock(com.sun.source.tree.BlockTree tree, java.lang.Void p)
Node	visitBreak(com.sun.source.tree.BreakTree tree, java.lang.Void p)
Node	visitCase(com.sun.source.tree.CaseTree tree, java.lang.Void p)
Node	visitCatch(com.sun.source.tree.CatchTree tree, java.lang.Void p)
Node	visitClass(com.sun.source.tree.ClassTree tree, java.lang.Void p)
Node	visitCompilationUnit(com.sun.source.tree.CompilationUnitTree tree, java.lang.Void p)
Node	visitCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree tree, java.lang.Void p)
Node	visitConditionalExpression(com.sun.source.tree.ConditionalExpressionTree tree, java.lang.Void p)
Node	visitContinue(com.sun.source.tree.ContinueTree tree, java.lang.Void p)
Node	visitDoWhileLoop(com.sun.source.tree.DoWhileLoopTree tree, java.lang.Void p)
Node	visitEmptyStatement(com.sun.source.tree.EmptyStatementTree tree, java.lang.Void p)
Node	visitEnhancedForLoop(com.sun.source.tree.EnhancedForLoopTree tree, java.lang.Void p)
Node	visitErroneous(com.sun.source.tree.ErroneousTree tree, java.lang.Void p)
Node	visitExpressionStatement(com.sun.source.tree.ExpressionStatementTree tree, java.lang.Void p)
Node	visitForLoop(com.sun.source.tree.ForLoopTree tree, java.lang.Void p)
Node	visitIdentifier(com.sun.source.tree.IdentifierTree tree, java.lang.Void p)
Node	visitIf(com.sun.source.tree.IfTree tree, java.lang.Void p)
Node	visitImport(com.sun.source.tree.ImportTree tree, java.lang.Void p)
Node	visitInstanceOf(com.sun.source.tree.InstanceOfTree tree, java.lang.Void p)
Node	visitLabeledStatement(com.sun.source.tree.LabeledStatementTree tree, java.lang.Void p)
Node	visitLambdaExpression(com.sun.source.tree.LambdaExpressionTree tree, java.lang.Void p)
Node	visitLiteral(com.sun.source.tree.LiteralTree tree, java.lang.Void p)
Node	visitMemberReference(com.sun.source.tree.MemberReferenceTree tree, java.lang.Void p)
Node	visitMemberSelect(com.sun.source.tree.MemberSelectTree tree, java.lang.Void p)
Node	visitMethod(com.sun.source.tree.MethodTree tree, java.lang.Void p)
MethodInvocationNode	visitMethodInvocation(com.sun.source.tree.MethodInvocationTree tree, java.lang.Void p)
Node	visitModifiers(com.sun.source.tree.ModifiersTree tree, java.lang.Void p)
Node	visitNewArray(com.sun.source.tree.NewArrayTree tree, java.lang.Void p)
Node	visitNewClass(com.sun.source.tree.NewClassTree tree, java.lang.Void p)
Node	visitOther(com.sun.source.tree.Tree tree, java.lang.Void p)
Node	visitParameterizedType(com.sun.source.tree.ParameterizedTypeTree tree, java.lang.Void p)
Node	visitParenthesized(com.sun.source.tree.ParenthesizedTree tree, java.lang.Void p)
Node	visitPrimitiveType(com.sun.source.tree.PrimitiveTypeTree tree, java.lang.Void p)
Node	visitReturn(com.sun.source.tree.ReturnTree tree, java.lang.Void p)
Node	visitSwitch(com.sun.source.tree.SwitchTree tree, java.lang.Void p)
Node	visitSynchronized(com.sun.source.tree.SynchronizedTree tree, java.lang.Void p)
Node	visitThrow(com.sun.source.tree.ThrowTree tree, java.lang.Void p)
Node	visitTry(com.sun.source.tree.TryTree tree, java.lang.Void p)
Node	visitTypeCast(com.sun.source.tree.TypeCastTree tree, java.lang.Void p)
Node	visitTypeParameter(com.sun.source.tree.TypeParameterTree tree, java.lang.Void p)
Node	visitUnary(com.sun.source.tree.UnaryTree tree, java.lang.Void p)
Node	visitUnionType(com.sun.source.tree.UnionTypeTree tree, java.lang.Void p)
Node	visitVariable(com.sun.source.tree.VariableTree tree, java.lang.Void p)
Node	visitWhileLoop(com.sun.source.tree.WhileLoopTree tree, java.lang.Void p)
Node	visitWildcard(com.sun.source.tree.WildcardTree tree, java.lang.Void p)
protected Node	widen(Node node, javax.lang.model.type.TypeMirror destType) Perform widening primitive conversion on the input node to make it match the destination type.
protected com.sun.source.tree.Tree.Kind	withoutAssignment(com.sun.source.tree.Tree.Kind kind) Map an operation with assignment to the corresponding operation without assignment.

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitIntersectionType

Methods inherited from class java.lang.Object

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

Field Detail

env

protected javax.annotation.processing.ProcessingEnvironment env

Annotation processing environment and its associated type and tree utilities.

elements

protected javax.lang.model.util.Elements elements

types

protected javax.lang.model.util.Types types

trees

protected com.sun.source.util.Trees trees

treeBuilder

protected TreeBuilder treeBuilder

annotationProvider

protected AnnotationProvider annotationProvider

breakTargetL

protected @Nullable CFGBuilder.Label breakTargetL

Current CFGBuilder.Label to which a break statement with no label should jump, or null if there is no valid destination.

breakLabels

protected java.util.Map<javax.lang.model.element.Name,CFGBuilder.Label> breakLabels

Map from AST label Names to CFG CFGBuilder.Labels for breaks. Each labeled statement creates two CFG CFGBuilder.Labels, one for break and one for continue.

continueTargetL

protected @Nullable CFGBuilder.Label continueTargetL

Current CFGBuilder.Label to which a continue statement with no label should jump, or null if there is no valid destination.

continueLabels

protected java.util.Map<javax.lang.model.element.Name,CFGBuilder.Label> continueLabels

Map from AST label Names to CFG CFGBuilder.Labels for continues. Each labeled statement creates two CFG CFGBuilder.Labels, one for break and one for continue.

treeLookupMap

protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> treeLookupMap

Maps from AST Trees to Nodes. Every Tree that produces a value will have at least one corresponding Node. Trees that undergo conversions, such as boxing or unboxing, can map to two distinct Nodes. The Node for the pre-conversion value is stored in the treeLookupMap, while the Node for the post-conversion value is stored in the convertedTreeLookupMap.

convertedTreeLookupMap

protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> convertedTreeLookupMap

Map from AST Trees to post-conversion Nodes.

unaryAssignNodeLookupMap

protected java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookupMap

Map from AST UnaryTrees to compound AssignmentNodes.

nodeList

protected java.util.ArrayList<CFGBuilder.ExtendedNode> nodeList

The list of extended nodes.

bindings

protected java.util.Map<CFGBuilder.Label,java.lang.Integer> bindings

The bindings of labels to positions (i.e., indices) in the nodeList.

leaders

protected java.util.Set<java.lang.Integer> leaders

The set of leaders (represented as indices into nodeList).

generatedTreesLookupMap

protected java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>> generatedTreesLookupMap

Map from AST Trees to generated Trees.

uid

protected long uid

ea

protected com.sun.source.tree.VariableTree ea

The VariableTree that indicates whether assertions are enabled or not.

Constructor Detail

CFGTranslationPhaseOne

public CFGTranslationPhaseOne()

Method Detail

process

public CFGBuilder.PhaseOneResult process(com.sun.source.util.TreePath bodyPath,
                                         javax.annotation.processing.ProcessingEnvironment env,
                                         UnderlyingAST underlyingAST,
                                         CFGBuilder.Label exceptionalExitLabel,
                                         TreeBuilder treeBuilder,
                                         AnnotationProvider annotationProvider)

Performs the actual work of phase one.

Parameters:

bodyPath - path to the body of the underlying AST's method

env - annotation processing environment containing type utilities

underlyingAST - the AST for which the CFG is to be built

exceptionalExitLabel - the label for exceptional exits from the CFG

treeBuilder - builder for new AST nodes

annotationProvider - extracts annotations from AST nodes

Returns:

the result of phase one

process

public CFGBuilder.PhaseOneResult process(com.sun.source.tree.CompilationUnitTree root,
                                         javax.annotation.processing.ProcessingEnvironment env,
                                         UnderlyingAST underlyingAST,
                                         CFGBuilder.Label exceptionalExitLabel,
                                         TreeBuilder treeBuilder,
                                         AnnotationProvider annotationProvider)

handleArtificialTree

public void handleArtificialTree(com.sun.source.tree.Tree tree)

Perform any actions required when CFG translation creates a new Tree that is not part of the original AST.

Parameters:

tree - the newly created Tree

addToLookupMap

protected void addToLookupMap(Node node)

Add a node to the lookup map if it not already present.

Parameters:

node - the node to add to the lookup map

addToConvertedLookupMap

protected void addToConvertedLookupMap(Node node)

Add a node in the post-conversion lookup map. The node should refer to a Tree and that Tree should already be in the pre-conversion lookup map. This method is used to update the Tree-Node mapping with conversion nodes.

Parameters:

node - the node to add to the lookup map

addToConvertedLookupMap

protected void addToConvertedLookupMap(com.sun.source.tree.Tree tree,
                                       Node node)

Add a node in the post-conversion lookup map. The tree argument should already be in the pre-conversion lookup map. This method is used to update the Tree-Node mapping with conversion nodes.

Parameters:

tree - the tree used as a key in the map

node - the node to add to the lookup map

addToUnaryAssignLookupMap

protected void addToUnaryAssignLookupMap(com.sun.source.tree.UnaryTree tree,
                                         AssignmentNode unaryAssignNode)

Add a unary tree in the compound assign lookup map. This method is used to update the UnaryTree-AssignmentNode mapping with compound assign nodes.

Parameters:

tree - the tree used as a key in the map

unaryAssignNode - the node to add to the lookup map

addToGeneratedTreesLookupMap

protected void addToGeneratedTreesLookupMap(com.sun.source.tree.Tree tree,
                                            com.sun.source.tree.Tree generatedTree)

Add a tree in the generated-trees lookup map.

Parameters:

tree - the tree used as a key in the map

generatedTree - the tree to add to the lookup map

extendWithNode

protected <T extends Node> T extendWithNode(T node)

Extend the list of extended nodes with a node.

Parameters:

node - the node to add

Returns:

the same node (for convenience)

extendWithNodeWithException

protected CFGBuilder.NodeWithExceptionsHolder extendWithNodeWithException(Node node,
                                                                          javax.lang.model.type.TypeMirror cause)

Extend the list of extended nodes with a node, where node might throw the exception cause.

Parameters:

node - the node to add

cause - an exception that the node might throw

Returns:

the node holder

extendWithNodeWithExceptions

protected CFGBuilder.NodeWithExceptionsHolder extendWithNodeWithExceptions(Node node,
                                                                           java.util.Set<javax.lang.model.type.TypeMirror> causes)

Extend the list of extended nodes with a node, where node might throw any of the exception in causes.

Parameters:

node - the node to add

causes - set of exceptions that the node might throw

Returns:

the node holder

insertNodeAfter

protected <T extends Node> T insertNodeAfter(T node,
                                             Node pred)

Insert node after pred in the list of extended nodes, or append to the list if pred is not present.

Parameters:

node - the node to add

pred - the desired predecessor of node

Returns:

the node holder

insertNodeWithExceptionsAfter

protected CFGBuilder.NodeWithExceptionsHolder insertNodeWithExceptionsAfter(Node node,
                                                                            java.util.Set<javax.lang.model.type.TypeMirror> causes,
                                                                            Node pred)

Insert a node that might throw the exception cause after pred in the list of extended nodes, or append to the list if pred is not present.

Parameters:

node - the node to add

causes - set of exceptions that the node might throw

pred - the desired predecessor of node

Returns:

the node holder

extendWithExtendedNode

protected void extendWithExtendedNode(CFGBuilder.ExtendedNode n)

Extend the list of extended nodes with an extended node.

Parameters:

n - the extended node

insertExtendedNodeAfter

protected void insertExtendedNodeAfter(CFGBuilder.ExtendedNode n,
                                       Node pred)

Insert n after the node pred in the list of extended nodes, or append n if pred is not present.

Parameters:

n - the extended node

pred - the desired predecessor

addLabelForNextNode

protected void addLabelForNextNode(CFGBuilder.Label l)

Add the label l to the extended node that will be placed next in the sequence.

uniqueName

protected java.lang.String uniqueName(java.lang.String prefix)

box

protected Node box(Node node)

If the input node is an unboxed primitive type, insert a call to the appropriate valueOf method, otherwise leave it alone.

Parameters:

node - in input node

Returns:

a Node representing the boxed version of the input, which may simply be the input node

unbox

protected Node unbox(Node node)

If the input node is a boxed type, unbox it, otherwise leave it alone.

Parameters:

node - in input node

Returns:

a Node representing the unboxed version of the input, which may simply be the input node

stringConversion

protected Node stringConversion(Node node)

Convert the input node to String type, if it isn't already.

Parameters:

node - an input node

Returns:

a Node with the value promoted to String, which may be the input node

unaryNumericPromotion

protected Node unaryNumericPromotion(Node node)

Perform unary numeric promotion on the input node.

Parameters:

node - a node producing a value of numeric primitive or boxed type

Returns:

a Node with the value promoted to the int, long float or double, which may be the input node

isNumericOrBoxed

protected boolean isNumericOrBoxed(javax.lang.model.type.TypeMirror type)

Returns true if the argument type is a numeric primitive or a boxed numeric primitive and false otherwise.

binaryPromotedType

protected javax.lang.model.type.TypeMirror binaryPromotedType(javax.lang.model.type.TypeMirror left,
                                                              javax.lang.model.type.TypeMirror right)

Compute the type to which two numeric types must be promoted before performing a binary numeric operation on them. The input types must both be numeric and the output type is primitive.

Parameters:

left - the type of the left operand

right - the type of the right operand

Returns:

a TypeMirror representing the binary numeric promoted type

binaryNumericPromotion

protected Node binaryNumericPromotion(Node node,
                                      javax.lang.model.type.TypeMirror exprType)

Perform binary numeric promotion on the input node to make it match the expression type.

Parameters:

node - a node producing a value of numeric primitive or boxed type

exprType - the type to promote the value to

Returns:

a Node with the value promoted to the exprType, which may be the input node

widen

protected Node widen(Node node,
                     javax.lang.model.type.TypeMirror destType)

Perform widening primitive conversion on the input node to make it match the destination type.

Parameters:

node - a node producing a value of numeric primitive type

destType - the type to widen the value to

Returns:

a Node with the value widened to the exprType, which may be the input node

narrow

protected Node narrow(Node node,
                      javax.lang.model.type.TypeMirror destType)

Perform narrowing conversion on the input node to make it match the destination type.

Parameters:

node - a node producing a value of numeric primitive type

destType - the type to narrow the value to

Returns:

a Node with the value narrowed to the exprType, which may be the input node

narrowAndBox

protected Node narrowAndBox(Node node,
                            javax.lang.model.type.TypeMirror destType)

Perform narrowing conversion and optionally boxing conversion on the input node to make it match the destination type.

Parameters:

node - a node producing a value of numeric primitive type

destType - the type to narrow the value to (possibly boxed)

Returns:

a Node with the value narrowed and boxed to the destType, which may be the input node

conversionRequiresNarrowing

protected boolean conversionRequiresNarrowing(javax.lang.model.type.TypeMirror varType,
                                              Node node)

Return whether a conversion from the type of the node to varType requires narrowing.

Parameters:

varType - the type of a variable (or general LHS) to be converted to

node - a node whose value is being converted

Returns:

whether this conversion requires narrowing to succeed

commonConvert

protected Node commonConvert(Node node,
                             javax.lang.model.type.TypeMirror varType,
                             boolean contextAllowsNarrowing)

Assignment conversion and method invocation conversion are almost identical, except that assignment conversion allows narrowing. We factor out the common logic here.

Parameters:

node - a Node producing a value

varType - the type of a variable

contextAllowsNarrowing - whether to allow narrowing (for assignment conversion) or not (for method invocation conversion)

Returns:

a Node with the value converted to the type of the variable, which may be the input node itself

assignConvert

protected Node assignConvert(Node node,
                             javax.lang.model.type.TypeMirror varType)

Perform assignment conversion so that it can be assigned to a variable of the given type.

Parameters:

node - a Node producing a value

varType - the type of a variable

Returns:

a Node with the value converted to the type of the variable, which may be the input node itself

methodInvocationConvert

protected Node methodInvocationConvert(Node node,
                                       javax.lang.model.type.TypeMirror formalType)

Perform method invocation conversion so that the node can be passed as a formal parameter of the given type.

Parameters:

node - a Node producing a value

formalType - the type of a formal parameter

Returns:

a Node with the value converted to the type of the formal, which may be the input node itself

convertCallArguments

protected java.util.List<Node> convertCallArguments(javax.lang.model.element.ExecutableElement method,
                                                    java.util.List<? extends com.sun.source.tree.ExpressionTree> actualExprs)

Given a method element and as list of argument expressions, return a list of Nodes representing the arguments converted for a call of the method. This method applies to both method invocations and constructor calls.

Parameters:

method - an ExecutableElement representing a method to be called

actualExprs - a List of argument expressions to a call

Returns:

a List of Nodes representing arguments after conversions required by a call to this method

conditionalExprPromotion

protected Node conditionalExprPromotion(Node node,
                                        javax.lang.model.type.TypeMirror destType)

Convert an operand of a conditional expression to the type of the whole expression.

Parameters:

node - a node occurring as the second or third operand of a conditional expression

destType - the type to promote the value to

Returns:

a Node with the value promoted to the destType, which may be the input node

getLabel

protected @Nullable javax.lang.model.element.Name getLabel(com.sun.source.util.TreePath path)

Returns the label Name of the leaf in the argument path, or null if the leaf is not a labeled statement.

visitAnnotatedType

public Node visitAnnotatedType(com.sun.source.tree.AnnotatedTypeTree tree,
                               java.lang.Void p)

Specified by:

visitAnnotatedType in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitAnnotatedType in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitAnnotation

public Node visitAnnotation(com.sun.source.tree.AnnotationTree tree,
                            java.lang.Void p)

Specified by:

visitAnnotation in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitAnnotation in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitMethodInvocation

public MethodInvocationNode visitMethodInvocation(com.sun.source.tree.MethodInvocationTree tree,
                                                  java.lang.Void p)

Specified by:

visitMethodInvocation in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitMethodInvocation in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitAssert

public Node visitAssert(com.sun.source.tree.AssertTree tree,
                        java.lang.Void p)

Specified by:

visitAssert in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitAssert in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

assumeAssertionsEnabledFor

protected boolean assumeAssertionsEnabledFor(com.sun.source.tree.AssertTree tree)

Should assertions be assumed to be executed for a given AssertTree? False by default.

getAssertionsEnabledVariable

protected com.sun.source.tree.VariableTree getAssertionsEnabledVariable()

Get a synthetic VariableTree that indicates whether assertions are enabled or not.

translateAssertWithAssertionsEnabled

protected void translateAssertWithAssertionsEnabled(com.sun.source.tree.AssertTree tree)

Translates an assertion statement to the correct CFG nodes. The translation assumes that assertions are enabled.

visitAssignment

public Node visitAssignment(com.sun.source.tree.AssignmentTree tree,
                            java.lang.Void p)

Specified by:

visitAssignment in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitAssignment in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

translateAssignment

protected AssignmentNode translateAssignment(com.sun.source.tree.Tree tree,
                                             Node target,
                                             com.sun.source.tree.ExpressionTree rhs)

Translate an assignment.

translateAssignment

protected AssignmentNode translateAssignment(com.sun.source.tree.Tree tree,
                                             Node target,
                                             Node expression)

Translate an assignment where the RHS has already been scanned.

withoutAssignment

protected com.sun.source.tree.Tree.Kind withoutAssignment(com.sun.source.tree.Tree.Kind kind)

Map an operation with assignment to the corresponding operation without assignment.

Parameters:

kind - a Tree.Kind representing an operation with assignment

Returns:

the Tree.Kind for the same operation without assignment

visitCompoundAssignment

public Node visitCompoundAssignment(com.sun.source.tree.CompoundAssignmentTree tree,
                                    java.lang.Void p)

Specified by:

visitCompoundAssignment in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitCompoundAssignment in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitBinary

public Node visitBinary(com.sun.source.tree.BinaryTree tree,
                        java.lang.Void p)

Specified by:

visitBinary in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitBinary in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitBlock

public Node visitBlock(com.sun.source.tree.BlockTree tree,
                       java.lang.Void p)

Specified by:

visitBlock in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitBlock in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitBreak

public Node visitBreak(com.sun.source.tree.BreakTree tree,
                       java.lang.Void p)

Specified by:

visitBreak in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitBreak in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitSwitch

public Node visitSwitch(com.sun.source.tree.SwitchTree tree,
                        java.lang.Void p)

Specified by:

visitSwitch in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitSwitch in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitCase

public Node visitCase(com.sun.source.tree.CaseTree tree,
                      java.lang.Void p)

Specified by:

visitCase in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitCase in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitCatch

public Node visitCatch(com.sun.source.tree.CatchTree tree,
                       java.lang.Void p)

Specified by:

visitCatch in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitCatch in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitClass

public Node visitClass(com.sun.source.tree.ClassTree tree,
                       java.lang.Void p)

Specified by:

visitClass in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitClass in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitConditionalExpression

public Node visitConditionalExpression(com.sun.source.tree.ConditionalExpressionTree tree,
                                       java.lang.Void p)

Specified by:

visitConditionalExpression in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitConditionalExpression in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitContinue

public Node visitContinue(com.sun.source.tree.ContinueTree tree,
                          java.lang.Void p)

Specified by:

visitContinue in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitContinue in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitDoWhileLoop

public Node visitDoWhileLoop(com.sun.source.tree.DoWhileLoopTree tree,
                             java.lang.Void p)

Specified by:

visitDoWhileLoop in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitDoWhileLoop in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitErroneous

public Node visitErroneous(com.sun.source.tree.ErroneousTree tree,
                           java.lang.Void p)

Specified by:

visitErroneous in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitErroneous in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitExpressionStatement

public Node visitExpressionStatement(com.sun.source.tree.ExpressionStatementTree tree,
                                     java.lang.Void p)

Specified by:

visitExpressionStatement in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitExpressionStatement in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitEnhancedForLoop

public Node visitEnhancedForLoop(com.sun.source.tree.EnhancedForLoopTree tree,
                                 java.lang.Void p)

Specified by:

visitEnhancedForLoop in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitEnhancedForLoop in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

createEnhancedForLoopIteratorVariable

protected com.sun.source.tree.VariableTree createEnhancedForLoopIteratorVariable(com.sun.source.tree.MethodInvocationTree iteratorCall,
                                                                                 javax.lang.model.element.VariableElement variableElement)

createEnhancedForLoopArrayVariable

protected com.sun.source.tree.VariableTree createEnhancedForLoopArrayVariable(com.sun.source.tree.ExpressionTree expression,
                                                                              javax.lang.model.element.VariableElement variableElement)

visitForLoop

public Node visitForLoop(com.sun.source.tree.ForLoopTree tree,
                         java.lang.Void p)

Specified by:

visitForLoop in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitForLoop in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitIdentifier

public Node visitIdentifier(com.sun.source.tree.IdentifierTree tree,
                            java.lang.Void p)

Specified by:

visitIdentifier in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitIdentifier in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitIf

public Node visitIf(com.sun.source.tree.IfTree tree,
                    java.lang.Void p)

Specified by:

visitIf in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitIf in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitImport

public Node visitImport(com.sun.source.tree.ImportTree tree,
                        java.lang.Void p)

Specified by:

visitImport in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitImport in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitArrayAccess

public Node visitArrayAccess(com.sun.source.tree.ArrayAccessTree tree,
                             java.lang.Void p)

Specified by:

visitArrayAccess in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitArrayAccess in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitLabeledStatement

public Node visitLabeledStatement(com.sun.source.tree.LabeledStatementTree tree,
                                  java.lang.Void p)

Specified by:

visitLabeledStatement in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitLabeledStatement in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitLiteral

public Node visitLiteral(com.sun.source.tree.LiteralTree tree,
                         java.lang.Void p)

Specified by:

visitLiteral in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitLiteral in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitMethod

public Node visitMethod(com.sun.source.tree.MethodTree tree,
                        java.lang.Void p)

Specified by:

visitMethod in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitMethod in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitModifiers

public Node visitModifiers(com.sun.source.tree.ModifiersTree tree,
                           java.lang.Void p)

Specified by:

visitModifiers in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitModifiers in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitNewArray

public Node visitNewArray(com.sun.source.tree.NewArrayTree tree,
                          java.lang.Void p)

Specified by:

visitNewArray in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitNewArray in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitNewClass

public Node visitNewClass(com.sun.source.tree.NewClassTree tree,
                          java.lang.Void p)

Specified by:

visitNewClass in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitNewClass in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitParenthesized

public Node visitParenthesized(com.sun.source.tree.ParenthesizedTree tree,
                               java.lang.Void p)

Specified by:

visitParenthesized in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitParenthesized in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitReturn

public Node visitReturn(com.sun.source.tree.ReturnTree tree,
                        java.lang.Void p)

Specified by:

visitReturn in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitReturn in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitMemberSelect

public Node visitMemberSelect(com.sun.source.tree.MemberSelectTree tree,
                              java.lang.Void p)

Specified by:

visitMemberSelect in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitMemberSelect in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitEmptyStatement

public Node visitEmptyStatement(com.sun.source.tree.EmptyStatementTree tree,
                                java.lang.Void p)

Specified by:

visitEmptyStatement in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitEmptyStatement in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitSynchronized

public Node visitSynchronized(com.sun.source.tree.SynchronizedTree tree,
                              java.lang.Void p)

Specified by:

visitSynchronized in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitSynchronized in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitThrow

public Node visitThrow(com.sun.source.tree.ThrowTree tree,
                       java.lang.Void p)

Specified by:

visitThrow in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitThrow in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitCompilationUnit

public Node visitCompilationUnit(com.sun.source.tree.CompilationUnitTree tree,
                                 java.lang.Void p)

Specified by:

visitCompilationUnit in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitCompilationUnit in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitTry

public Node visitTry(com.sun.source.tree.TryTree tree,
                     java.lang.Void p)

Specified by:

visitTry in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitTry in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitParameterizedType

public Node visitParameterizedType(com.sun.source.tree.ParameterizedTypeTree tree,
                                   java.lang.Void p)

Specified by:

visitParameterizedType in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitParameterizedType in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitUnionType

public Node visitUnionType(com.sun.source.tree.UnionTypeTree tree,
                           java.lang.Void p)

Specified by:

visitUnionType in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitUnionType in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitArrayType

public Node visitArrayType(com.sun.source.tree.ArrayTypeTree tree,
                           java.lang.Void p)

Specified by:

visitArrayType in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitArrayType in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitTypeCast

public Node visitTypeCast(com.sun.source.tree.TypeCastTree tree,
                          java.lang.Void p)

Specified by:

visitTypeCast in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitTypeCast in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitPrimitiveType

public Node visitPrimitiveType(com.sun.source.tree.PrimitiveTypeTree tree,
                               java.lang.Void p)

Specified by:

visitPrimitiveType in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitPrimitiveType in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitTypeParameter

public Node visitTypeParameter(com.sun.source.tree.TypeParameterTree tree,
                               java.lang.Void p)

Specified by:

visitTypeParameter in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitTypeParameter in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitInstanceOf

public Node visitInstanceOf(com.sun.source.tree.InstanceOfTree tree,
                            java.lang.Void p)

Specified by:

visitInstanceOf in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitInstanceOf in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitUnary

public Node visitUnary(com.sun.source.tree.UnaryTree tree,
                       java.lang.Void p)

Specified by:

visitUnary in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitUnary in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitVariable

public Node visitVariable(com.sun.source.tree.VariableTree tree,
                          java.lang.Void p)

Specified by:

visitVariable in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitVariable in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitWhileLoop

public Node visitWhileLoop(com.sun.source.tree.WhileLoopTree tree,
                           java.lang.Void p)

Specified by:

visitWhileLoop in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitWhileLoop in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitLambdaExpression

public Node visitLambdaExpression(com.sun.source.tree.LambdaExpressionTree tree,
                                  java.lang.Void p)

Specified by:

visitLambdaExpression in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitLambdaExpression in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitMemberReference

public Node visitMemberReference(com.sun.source.tree.MemberReferenceTree tree,
                                 java.lang.Void p)

Specified by:

visitMemberReference in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitMemberReference in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitWildcard

public Node visitWildcard(com.sun.source.tree.WildcardTree tree,
                          java.lang.Void p)

Specified by:

visitWildcard in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitWildcard in class com.sun.source.util.TreeScanner<Node,java.lang.Void>

visitOther

public Node visitOther(com.sun.source.tree.Tree tree,
                       java.lang.Void p)

Specified by:

visitOther in interface com.sun.source.tree.TreeVisitor<Node,java.lang.Void>

Overrides:

visitOther in class com.sun.source.util.TreeScanner<Node,java.lang.Void>