Package org.checkerframework.dataflow.cfg.builder

Class CFGTranslationPhaseOne

java.lang.Object

com.sun.source.util.TreeScanner<Node,Void>

org.checkerframework.dataflow.cfg.builder.CFGTranslationPhaseOne

All Implemented Interfaces:

TreeVisitor<Node,Void>

Direct Known Subclasses:

CFCFGBuilder.CFCFGTranslationPhaseOne

public class CFGTranslationPhaseOne
extends TreeScanner<Node,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 Labels to positions in the node sequence.
• A set of leader nodes that give rise to basic blocks in phase two.
• A 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 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).

The entry point to process a single body (e.g., method, lambda, top-level block) is process(TreePath, UnderlyingAST).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CFGTranslationPhaseOne.AssertMethodTuple	Holds the elements of an AssertMethod annotation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationProvider	annotationProvider	The annotation provider, e.g., a type factory.
protected final TypeMirror	arithmeticExceptionType	The ArithmeticException type.
protected final TypeMirror	arrayIndexOutOfBoundsExceptionType	The ArrayIndexOutOfBoundsException type.
protected final TypeMirror	assertionErrorType	The AssertionError type.
protected final boolean	assumeAssertionsDisabled	Can assertions be assumed to be disabled?
protected final boolean	assumeAssertionsEnabled	Can assertions be assumed to be enabled?
protected final TypeMirror	classCastExceptionType	The ClassCastException type .
protected final @Nullable TypeMirror	classCircularityErrorType	The ClassCircularityError type.
protected final @Nullable TypeMirror	classFormatErrorType	The ClassFormatErrorType type.
protected VariableTree	ea	The VariableTree that indicates whether assertions are enabled or not.
protected final Elements	elements	The javac element utilities.
protected final ProcessingEnvironment	env	Annotation processing environment and its associated type and tree utilities.
protected final TypeMirror	iterableType	The Iterable type (erased).
protected final TypeMirror	negativeArraySizeExceptionType	The NegativeArraySizeException type.
protected final Set<TypeMirror>	newArrayExceptionTypes	Exceptions that can be thrown by array creation "new SomeType[]".
protected final @Nullable TypeMirror	noClassDefFoundErrorType	The NoClassDefFoundError type.
protected final TypeMirror	nullPointerExceptionType	The NullPointerException type .
protected final @Nullable TypeMirror	outOfMemoryErrorType	The OutOfMemoryError type.
protected final TypeMirror	stringType	The String type.
protected final TypeMirror	throwableType	The Throwable type.
protected final TreeBuilder	treeBuilder	The tree builder.
protected final Trees	trees	The javac tree utilities.
protected final Types	types	The javac type utilities.
protected long	uid	The UID for the next unique name.
protected final Set<TypeMirror>	uncheckedExceptionTypes	Supertypes of all unchecked exceptions.

Constructor Summary

Constructors

Constructor	Description
CFGTranslationPhaseOne(TreeBuilder treeBuilder, AnnotationProvider annotationProvider, boolean assumeAssertionsEnabled, boolean assumeAssertionsDisabled, ProcessingEnvironment env)	Creates CFGTranslationPhaseOne.

Method Summary

Modifier and Type	Method	Description
protected void	addLabelForNextNode(Label l)	Add the label l to the extended node that will be placed next in the sequence.
protected void	addToConvertedLookupMap(Tree tree, Node node)	Add a node in the post-conversion lookup map.
protected void	addToConvertedLookupMap(Node node)	Add a node in the post-conversion lookup map.
protected void	addToLookupMap(Node node)	Add a node to the lookup map if it not already present.
protected Node	assignConvert(Node node, TypeMirror varType)	Perform assignment conversion so that it can be assigned to a variable of the given type.
protected boolean	assumeAssertionsEnabledFor(AssertTree tree)	Should assertions be assumed to be executed for a given AssertTree? False by default.
protected Node	binaryNumericPromotion(Node node, TypeMirror exprType)	Perform binary numeric promotion on the input node to make it match the expression type.
protected TypeMirror	binaryPromotedType(TypeMirror left, 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, TypeMirror varType, boolean contextAllowsNarrowing)	Assignment conversion and method invocation conversion are almost identical, except that assignment conversion allows narrowing.
protected Node	conditionalExprPromotion(Node node, TypeMirror destType)	Convert an operand of a conditional expression to the type of the whole expression.
protected boolean	conversionRequiresNarrowing(TypeMirror varType, Node node)	Return whether a conversion from the type of the node to varType requires narrowing.
protected List<Node>	convertCallArguments(ExpressionTree tree, ExecutableElement method, ExecutableType methodType, List<? extends ExpressionTree> actualExprs)	Given a method element, its type at the call site, and a list of argument expressions, return a list of Nodes representing the arguments converted for a call of the method.
protected VariableTree	createEnhancedForLoopArrayVariable(ExpressionTree expression, VariableElement variableElement)
protected VariableTree	createEnhancedForLoopIteratorVariable(MethodInvocationTree iteratorCall, VariableElement variableElement)
protected org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder	extendWithClassNameNode(ClassNameNode node)	Extend a list of extended nodes with a ClassName node.
protected void	extendWithExtendedNode(ExtendedNode n)	Extend the list of extended nodes with an extended node.
protected void	extendWithNode(Node node)	Extend the list of extended nodes with a node.
protected org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder	extendWithNodeWithException(Node node, TypeMirror cause)	Extend the list of extended nodes with a node, where node might throw the exception cause.
protected org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder	extendWithNodeWithExceptions(Node node, Set<TypeMirror> causes)	Extend the list of extended nodes with a node, where node might throw any of the exceptions in causes.
protected VariableTree	getAssertionsEnabledVariable()	Get a synthetic VariableTree that indicates whether assertions are enabled or not.
protected CFGTranslationPhaseOne.AssertMethodTuple	getAssertMethodTuple(ExecutableElement method)	Returns the AssertMethodTuple for method.
TreePath	getCurrentPath()	Returns the current path for the tree currently being scanned.
protected @Nullable Name	getLabel(TreePath path)	Returns the label Name of the leaf in the argument path, or null if the leaf is not a labeled statement.
protected TypeMirror	getTypeMirror(Class<?> clazz)	Returns the TypeMirror for the given class.
void	handleArtificialTree(Tree tree)	Perform any actions required when CFG translation creates a new Tree that is not part of the original AST.
protected void	insertExtendedNodeAfter(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 org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder	insertNodeWithExceptionsAfter(Node node, Set<TypeMirror> causes, Node pred)	Insert a node that might throw the exceptions in causes after pred in the list of extended nodes, or append to the list if pred is not present.
protected boolean	isNumericOrBoxed(TypeMirror type)	Returns true if the argument type is a numeric primitive or a boxed numeric primitive and false otherwise.
protected @Nullable TypeMirror	maybeGetTypeMirror(Class<?> clazz)	Returns the TypeMirror for the given class, or null if the type is not present.
protected Node	methodInvocationConvert(Node node, 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, TypeMirror destType)	Perform narrowing conversion on the input node to make it match the destination type.
protected Node	narrowAndBox(Node node, TypeMirror destType)	Perform narrowing conversion and optionally boxing conversion on the input node to make it match the destination type.
PhaseOneResult	process(CompilationUnitTree root, UnderlyingAST underlyingAST)	Process a single body within root.
PhaseOneResult	process(TreePath bodyPath, UnderlyingAST underlyingAST)	Performs the actual work of phase one: processing a single body (of a method, lambda, top-level block, etc.).
Node	scan(Tree tree, Void p)
protected Node	stringConversion(Node node)	Convert the input node to String type, if it isn't already.
protected void	translateAssertWithAssertionsEnabled(AssertTree tree)	Translates an assertion statement to the correct CFG nodes.
protected AssignmentNode	translateAssignment(Tree tree, Node target, ExpressionTree rhs)	Translate an assignment.
protected AssignmentNode	translateAssignment(Tree tree, Node target, Node expression)	Translate an assignment where the RHS has already been scanned.
protected void	treatMethodAsAssert(MethodInvocationTree tree, CFGTranslationPhaseOne.AssertMethodTuple assertMethodTuple, Node condition)	Translates a method marked as AssertMethod into CFG nodes corresponding to an assert statement.
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 String	uniqueName(String prefix)	Returns a unique name starting with prefix.
Node	visitAnnotatedType(AnnotatedTypeTree tree, Void p)
Node	visitAnnotation(AnnotationTree tree, Void p)
Node	visitArrayAccess(ArrayAccessTree tree, Void p)
Node	visitArrayType(ArrayTypeTree tree, Void p)
Node	visitAssert(AssertTree tree, Void p)
Node	visitAssignment(AssignmentTree tree, Void p)
Node	visitBinary(BinaryTree tree, Void p)
Node	visitBindingPattern17(Tree bindingPatternTree, Void p)	Visit a BindingPatternTree
Node	visitBlock(BlockTree tree, Void p)
Node	visitBreak(BreakTree tree, Void p)
Node	visitCase(CaseTree tree, Void p)
Node	visitCatch(CatchTree tree, Void p)
Node	visitClass(ClassTree tree, Void p)
Node	visitCompilationUnit(CompilationUnitTree tree, Void p)
Node	visitCompoundAssignment(CompoundAssignmentTree tree, Void p)
Node	visitConditionalExpression(ConditionalExpressionTree tree, Void p)
Node	visitContinue(ContinueTree tree, Void p)
Node	visitDeconstructionPattern21(Tree deconstructionPatternTree, Void p)	Visit a DeconstructionPatternTree.
Node	visitDoWhileLoop(DoWhileLoopTree tree, Void p)
Node	visitEmptyStatement(EmptyStatementTree tree, Void p)
Node	visitEnhancedForLoop(EnhancedForLoopTree tree, Void p)
Node	visitErroneous(ErroneousTree tree, Void p)
Node	visitExpressionStatement(ExpressionStatementTree tree, Void p)
Node	visitForLoop(ForLoopTree tree, Void p)
Node	visitIdentifier(IdentifierTree tree, Void p)
Node	visitIf(IfTree tree, Void p)
Node	visitImport(ImportTree tree, Void p)
Node	visitInstanceOf(InstanceOfTree tree, Void p)
Node	visitLabeledStatement(LabeledStatementTree tree, Void p)
Node	visitLambdaExpression(LambdaExpressionTree tree, Void p)
Node	visitLiteral(LiteralTree tree, Void p)
Node	visitMemberReference(MemberReferenceTree tree, Void p)
Node	visitMemberSelect(MemberSelectTree tree, Void p)
Node	visitMethod(MethodTree tree, Void p)
MethodInvocationNode	visitMethodInvocation(MethodInvocationTree tree, Void p)
Node	visitModifiers(ModifiersTree tree, Void p)
Node	visitNewArray(NewArrayTree tree, Void p)
Node	visitNewClass(NewClassTree tree, Void p)
Node	visitOther(Tree tree, Void p)
Node	visitParameterizedType(ParameterizedTypeTree tree, Void p)
Node	visitParenthesized(ParenthesizedTree tree, Void p)
Node	visitPrimitiveType(PrimitiveTypeTree tree, Void p)
Node	visitReturn(ReturnTree tree, Void p)
Node	visitSwitch(SwitchTree tree, Void p)
Node	visitSwitchExpression17(Tree switchExpressionTree, Void p)	Visit a SwitchExpressionTree
Node	visitSynchronized(SynchronizedTree tree, Void p)
Node	visitThrow(ThrowTree tree, Void p)
Node	visitTry(TryTree tree, Void p)
Node	visitTypeCast(TypeCastTree tree, Void p)
Node	visitTypeParameter(TypeParameterTree tree, Void p)
Node	visitUnary(UnaryTree tree, Void p)
Node	visitUnionType(UnionTypeTree tree, Void p)
Node	visitVariable(VariableTree tree, Void p)
Node	visitWhileLoop(WhileLoopTree tree, Void p)
Node	visitWildcard(WildcardTree tree, Void p)
Node	visitYield17(Tree yieldTree, Void p)	Visit a SwitchExpressionTree.
protected Node	widen(Node node, TypeMirror destType)	Perform widening primitive conversion on the input node to make it match the destination type.
protected Tree.Kind	withoutAssignment(Tree.Kind kind)	Map an operation with assignment to the corresponding operation without assignment.

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

reduce, scan, visitBindingPattern, visitDefaultCaseLabel, visitExports, visitGuardedPattern, visitIntersectionType, visitModule, visitOpens, visitPackage, visitParenthesizedPattern, visitProvides, visitRequires, visitSwitchExpression, visitUses, visitYield

Methods inherited from class java.lang.Object

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

Field Details

env

protected final ProcessingEnvironment env

Annotation processing environment and its associated type and tree utilities.

elements

protected final Elements elements

The javac element utilities.

types

protected final Types types

The javac type utilities.

trees

protected final Trees trees

The javac tree utilities.

treeBuilder

protected final TreeBuilder treeBuilder

The tree builder.

annotationProvider

protected final AnnotationProvider annotationProvider

The annotation provider, e.g., a type factory.

assumeAssertionsDisabled

protected final boolean assumeAssertionsDisabled

Can assertions be assumed to be disabled?

assumeAssertionsEnabled

protected final boolean assumeAssertionsEnabled

Can assertions be assumed to be enabled?

arithmeticExceptionType

protected final TypeMirror arithmeticExceptionType

The ArithmeticException type.

arrayIndexOutOfBoundsExceptionType

protected final TypeMirror arrayIndexOutOfBoundsExceptionType

The ArrayIndexOutOfBoundsException type.

assertionErrorType

protected final TypeMirror assertionErrorType

The AssertionError type.

classCastExceptionType

protected final TypeMirror classCastExceptionType

The ClassCastException type .

iterableType

protected final TypeMirror iterableType

The Iterable type (erased).

negativeArraySizeExceptionType

protected final TypeMirror negativeArraySizeExceptionType

The NegativeArraySizeException type.

nullPointerExceptionType

protected final TypeMirror nullPointerExceptionType

The NullPointerException type .

outOfMemoryErrorType

protected final @Nullable TypeMirror outOfMemoryErrorType

The OutOfMemoryError type.

classCircularityErrorType

protected final @Nullable TypeMirror classCircularityErrorType

The ClassCircularityError type.

classFormatErrorType

protected final @Nullable TypeMirror classFormatErrorType

The ClassFormatErrorType type.

noClassDefFoundErrorType

protected final @Nullable TypeMirror noClassDefFoundErrorType

The NoClassDefFoundError type.

stringType

protected final TypeMirror stringType

The String type.

throwableType

protected final TypeMirror throwableType

The Throwable type.

uncheckedExceptionTypes

protected final Set<TypeMirror> uncheckedExceptionTypes

Supertypes of all unchecked exceptions. The size is 2 and the contents are RuntimeException and Error.

newArrayExceptionTypes

protected final Set<TypeMirror> newArrayExceptionTypes

Exceptions that can be thrown by array creation "new SomeType[]". The size is 2 and the contents are NegativeArraySizeException and OutOfMemoryError. This list comes from JLS 15.10.1 "Run-Time Evaluation of Array Creation Expressions".

uid

protected long uid

The UID for the next unique name.

ea

protected VariableTree ea

The VariableTree that indicates whether assertions are enabled or not.

Constructor Details

CFGTranslationPhaseOne

public CFGTranslationPhaseOne(TreeBuilder treeBuilder,
 AnnotationProvider annotationProvider,
 boolean assumeAssertionsEnabled,
 boolean assumeAssertionsDisabled,
 ProcessingEnvironment env)

Creates CFGTranslationPhaseOne.

Parameters:

treeBuilder - builder for new AST nodes

annotationProvider - extracts annotations from AST nodes

assumeAssertionsDisabled - can assertions be assumed to be disabled?

assumeAssertionsEnabled - can assertions be assumed to be enabled?

env - annotation processing environment containing type utilities

Method Details

process

public PhaseOneResult process(TreePath bodyPath,
 UnderlyingAST underlyingAST)

Performs the actual work of phase one: processing a single body (of a method, lambda, top-level block, etc.).

Parameters:

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

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

Returns:

the result of phase one

process

public PhaseOneResult process(CompilationUnitTree root,
 UnderlyingAST underlyingAST)

Process a single body within root. This method does not process the entire given CompilationUnitTree. Rather, it processes one body (of a method/lambda/etc.) within it, which corresponds to underlyingAST.

Parameters:

root - the compilation unit

underlyingAST - the AST corresponding to the body to process

Returns:

a PhaseOneResult

handleArtificialTree

public void handleArtificialTree(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

getCurrentPath

public TreePath getCurrentPath()

Returns the current path for the tree currently being scanned.

Returns:

the current path

scan

public Node scan(Tree tree,
 Void p)

Overrides:

scan in class TreeScanner<Node,Void>

visitYield17

public Node visitYield17(Tree yieldTree,
 Void p)

Visit a SwitchExpressionTree.

Parameters:

yieldTree - a YieldTree, typed as Tree to be backward-compatible

p - parameter

Returns:

the result of visiting the switch expression tree

visitSwitchExpression17

public Node visitSwitchExpression17(Tree switchExpressionTree,
 Void p)

Visit a SwitchExpressionTree

Parameters:

switchExpressionTree - a SwitchExpressionTree, typed as Tree to be backward-compatible

p - parameter

Returns:

the result of visiting the switch expression tree

visitBindingPattern17

public Node visitBindingPattern17(Tree bindingPatternTree,
 Void p)

Visit a BindingPatternTree

Parameters:

bindingPatternTree - a BindingPatternTree, typed as Tree to be backward-compatible

p - parameter

Returns:

the result of visiting the binding pattern tree

visitDeconstructionPattern21

public Node visitDeconstructionPattern21(Tree deconstructionPatternTree,
 Void p)

Visit a DeconstructionPatternTree.

Parameters:

deconstructionPatternTree - a DeconstructionPatternTree, typed as Tree so the Checker Framework compiles under JDK 20 and earlier

p - an unused parameter

Returns:

the result of visiting the 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(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

extendWithNode

protected void extendWithNode(Node node)

Extend the list of extended nodes with a node.

Parameters:

node - the node to add

extendWithNodeWithException

protected org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder extendWithNodeWithException(Node node,
 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 org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder extendWithNodeWithExceptions(Node node,
 Set<TypeMirror> causes)

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

Parameters:

node - the node to add

causes - set of exceptions that the node might throw

Returns:

the node holder

extendWithClassNameNode

protected org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder extendWithClassNameNode(ClassNameNode node)

Extend a list of extended nodes with a ClassName node.

Evaluating a class literal kicks off class loading (JLS 15.8.2) which can fail and throw one of the specified subclasses of a LinkageError or an OutOfMemoryError (JLS 12.2.1).

Parameters:

node - the ClassName node to add

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 org.checkerframework.dataflow.cfg.builder.NodeWithExceptionsHolder insertNodeWithExceptionsAfter(Node node,
 Set<TypeMirror> causes,
 Node pred)

Insert a node that might throw the exceptions in causes 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(ExtendedNode n)

Extend the list of extended nodes with an extended node.

Parameters:

n - the extended node

insertExtendedNodeAfter

protected void insertExtendedNodeAfter(ExtendedNode n,
 @FindDistinct
 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(Label l)

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

Parameters:

l - the node to add to the forthcoming extended node

uniqueName

protected String uniqueName(String prefix)

Returns a unique name starting with prefix.

Parameters:

prefix - the prefix of the unique name

Returns:

a unique name starting with 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; may return be the input node

isNumericOrBoxed

protected boolean isNumericOrBoxed(TypeMirror type)

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

binaryPromotedType

protected TypeMirror binaryPromotedType(TypeMirror left,
 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,
 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,
 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,
 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,
 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(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,
 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,
 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,
 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 List<Node> convertCallArguments(ExpressionTree tree,
 ExecutableElement method,
 ExecutableType methodType,
 List<? extends ExpressionTree> actualExprs)

Given a method element, its type at the call site, and a 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:

tree - the invocation tree for the call

method - an ExecutableElement representing a method to be called

methodType - an ExecutableType representing the type of the method call; the type must be viewpoint-adapted to the call

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

getAssertMethodTuple

protected CFGTranslationPhaseOne.AssertMethodTuple getAssertMethodTuple(ExecutableElement method)

Returns the AssertMethodTuple for method. If method is not an assert method, then CFGTranslationPhaseOne.AssertMethodTuple.NONE is returned.

Parameters:

method - a method element that might be an assert method

Returns:

the AssertMethodTuple for method

conditionalExprPromotion

protected Node conditionalExprPromotion(Node node,
 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 Name getLabel(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(AnnotatedTypeTree tree,
 Void p)

Specified by:

visitAnnotatedType in interface TreeVisitor<Node,Void>

Overrides:

visitAnnotatedType in class TreeScanner<Node,Void>

visitAnnotation

public Node visitAnnotation(AnnotationTree tree,
 Void p)

Specified by:

visitAnnotation in interface TreeVisitor<Node,Void>

Overrides:

visitAnnotation in class TreeScanner<Node,Void>

visitMethodInvocation

public MethodInvocationNode visitMethodInvocation(MethodInvocationTree tree,
 Void p)

Specified by:

visitMethodInvocation in interface TreeVisitor<Node,Void>

Overrides:

visitMethodInvocation in class TreeScanner<Node,Void>

visitAssert

public Node visitAssert(AssertTree tree,
 Void p)

Specified by:

visitAssert in interface TreeVisitor<Node,Void>

Overrides:

visitAssert in class TreeScanner<Node,Void>

assumeAssertionsEnabledFor

protected boolean assumeAssertionsEnabledFor(AssertTree tree)

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

getAssertionsEnabledVariable

protected VariableTree getAssertionsEnabledVariable()

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

translateAssertWithAssertionsEnabled

protected void translateAssertWithAssertionsEnabled(AssertTree tree)

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

treatMethodAsAssert

protected void treatMethodAsAssert(MethodInvocationTree tree,
 CFGTranslationPhaseOne.AssertMethodTuple assertMethodTuple,
 Node condition)

Translates a method marked as AssertMethod into CFG nodes corresponding to an assert statement.

Parameters:

tree - the method invocation tree for a method marked as AssertMethod

assertMethodTuple - the assert method tuple for the method

condition - the boolean expression node for the argument that the method tests

visitAssignment

public Node visitAssignment(AssignmentTree tree,
 Void p)

Specified by:

visitAssignment in interface TreeVisitor<Node,Void>

Overrides:

visitAssignment in class TreeScanner<Node,Void>

translateAssignment

protected AssignmentNode translateAssignment(Tree tree,
 Node target,
 ExpressionTree rhs)

Translate an assignment.

translateAssignment

protected AssignmentNode translateAssignment(Tree tree,
 Node target,
 Node expression)

Translate an assignment where the RHS has already been scanned.

withoutAssignment

protected Tree.Kind withoutAssignment(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(CompoundAssignmentTree tree,
 Void p)

Specified by:

visitCompoundAssignment in interface TreeVisitor<Node,Void>

Overrides:

visitCompoundAssignment in class TreeScanner<Node,Void>

visitBinary

public Node visitBinary(BinaryTree tree,
 Void p)

Specified by:

visitBinary in interface TreeVisitor<Node,Void>

Overrides:

visitBinary in class TreeScanner<Node,Void>

visitBlock

public Node visitBlock(BlockTree tree,
 Void p)

Specified by:

visitBlock in interface TreeVisitor<Node,Void>

Overrides:

visitBlock in class TreeScanner<Node,Void>

visitBreak

public Node visitBreak(BreakTree tree,
 Void p)

Specified by:

visitBreak in interface TreeVisitor<Node,Void>

Overrides:

visitBreak in class TreeScanner<Node,Void>

visitSwitch

public Node visitSwitch(SwitchTree tree,
 Void p)

Specified by:

visitSwitch in interface TreeVisitor<Node,Void>

Overrides:

visitSwitch in class TreeScanner<Node,Void>

visitCase

public Node visitCase(CaseTree tree,
 Void p)

Specified by:

visitCase in interface TreeVisitor<Node,Void>

Overrides:

visitCase in class TreeScanner<Node,Void>

visitCatch

public Node visitCatch(CatchTree tree,
 Void p)

Specified by:

visitCatch in interface TreeVisitor<Node,Void>

Overrides:

visitCatch in class TreeScanner<Node,Void>

visitClass

public Node visitClass(ClassTree tree,
 Void p)

Specified by:

visitClass in interface TreeVisitor<Node,Void>

Overrides:

visitClass in class TreeScanner<Node,Void>

visitConditionalExpression

public Node visitConditionalExpression(ConditionalExpressionTree tree,
 Void p)

Specified by:

visitConditionalExpression in interface TreeVisitor<Node,Void>

Overrides:

visitConditionalExpression in class TreeScanner<Node,Void>

visitContinue

public Node visitContinue(ContinueTree tree,
 Void p)

Specified by:

visitContinue in interface TreeVisitor<Node,Void>

Overrides:

visitContinue in class TreeScanner<Node,Void>

visitDoWhileLoop

public Node visitDoWhileLoop(DoWhileLoopTree tree,
 Void p)

Specified by:

visitDoWhileLoop in interface TreeVisitor<Node,Void>

Overrides:

visitDoWhileLoop in class TreeScanner<Node,Void>

visitErroneous

public Node visitErroneous(ErroneousTree tree,
 Void p)

Specified by:

visitErroneous in interface TreeVisitor<Node,Void>

Overrides:

visitErroneous in class TreeScanner<Node,Void>

visitExpressionStatement

public Node visitExpressionStatement(ExpressionStatementTree tree,
 Void p)

Specified by:

visitExpressionStatement in interface TreeVisitor<Node,Void>

Overrides:

visitExpressionStatement in class TreeScanner<Node,Void>

visitEnhancedForLoop

public Node visitEnhancedForLoop(EnhancedForLoopTree tree,
 Void p)

Specified by:

visitEnhancedForLoop in interface TreeVisitor<Node,Void>

Overrides:

visitEnhancedForLoop in class TreeScanner<Node,Void>

createEnhancedForLoopIteratorVariable

protected VariableTree createEnhancedForLoopIteratorVariable(MethodInvocationTree iteratorCall,
 VariableElement variableElement)

createEnhancedForLoopArrayVariable

protected VariableTree createEnhancedForLoopArrayVariable(ExpressionTree expression,
 VariableElement variableElement)

visitForLoop

public Node visitForLoop(ForLoopTree tree,
 Void p)

Specified by:

visitForLoop in interface TreeVisitor<Node,Void>

Overrides:

visitForLoop in class TreeScanner<Node,Void>

visitIdentifier

public Node visitIdentifier(IdentifierTree tree,
 Void p)

Specified by:

visitIdentifier in interface TreeVisitor<Node,Void>

Overrides:

visitIdentifier in class TreeScanner<Node,Void>

visitIf

public Node visitIf(IfTree tree,
 Void p)

Specified by:

visitIf in interface TreeVisitor<Node,Void>

Overrides:

visitIf in class TreeScanner<Node,Void>

visitImport

public Node visitImport(ImportTree tree,
 Void p)

Specified by:

visitImport in interface TreeVisitor<Node,Void>

Overrides:

visitImport in class TreeScanner<Node,Void>

visitArrayAccess

public Node visitArrayAccess(ArrayAccessTree tree,
 Void p)

Specified by:

visitArrayAccess in interface TreeVisitor<Node,Void>

Overrides:

visitArrayAccess in class TreeScanner<Node,Void>

visitLabeledStatement

public Node visitLabeledStatement(LabeledStatementTree tree,
 Void p)

Specified by:

visitLabeledStatement in interface TreeVisitor<Node,Void>

Overrides:

visitLabeledStatement in class TreeScanner<Node,Void>

visitLiteral

public Node visitLiteral(LiteralTree tree,
 Void p)

Specified by:

visitLiteral in interface TreeVisitor<Node,Void>

Overrides:

visitLiteral in class TreeScanner<Node,Void>

visitMethod

public Node visitMethod(MethodTree tree,
 Void p)

Specified by:

visitMethod in interface TreeVisitor<Node,Void>

Overrides:

visitMethod in class TreeScanner<Node,Void>

visitModifiers

public Node visitModifiers(ModifiersTree tree,
 Void p)

Specified by:

visitModifiers in interface TreeVisitor<Node,Void>

Overrides:

visitModifiers in class TreeScanner<Node,Void>

visitNewArray

public Node visitNewArray(NewArrayTree tree,
 Void p)

Specified by:

visitNewArray in interface TreeVisitor<Node,Void>

Overrides:

visitNewArray in class TreeScanner<Node,Void>

visitNewClass

public Node visitNewClass(NewClassTree tree,
 Void p)

Specified by:

visitNewClass in interface TreeVisitor<Node,Void>

Overrides:

visitNewClass in class TreeScanner<Node,Void>

visitParenthesized

public Node visitParenthesized(ParenthesizedTree tree,
 Void p)

Specified by:

visitParenthesized in interface TreeVisitor<Node,Void>

Overrides:

visitParenthesized in class TreeScanner<Node,Void>

visitReturn

public Node visitReturn(ReturnTree tree,
 Void p)

Specified by:

visitReturn in interface TreeVisitor<Node,Void>

Overrides:

visitReturn in class TreeScanner<Node,Void>

visitMemberSelect

public Node visitMemberSelect(MemberSelectTree tree,
 Void p)

Specified by:

visitMemberSelect in interface TreeVisitor<Node,Void>

Overrides:

visitMemberSelect in class TreeScanner<Node,Void>

visitEmptyStatement

public Node visitEmptyStatement(EmptyStatementTree tree,
 Void p)

Specified by:

visitEmptyStatement in interface TreeVisitor<Node,Void>

Overrides:

visitEmptyStatement in class TreeScanner<Node,Void>

visitSynchronized

public Node visitSynchronized(SynchronizedTree tree,
 Void p)

Specified by:

visitSynchronized in interface TreeVisitor<Node,Void>

Overrides:

visitSynchronized in class TreeScanner<Node,Void>

visitThrow

public Node visitThrow(ThrowTree tree,
 Void p)

Specified by:

visitThrow in interface TreeVisitor<Node,Void>

Overrides:

visitThrow in class TreeScanner<Node,Void>

visitCompilationUnit

public Node visitCompilationUnit(CompilationUnitTree tree,
 Void p)

Specified by:

visitCompilationUnit in interface TreeVisitor<Node,Void>

Overrides:

visitCompilationUnit in class TreeScanner<Node,Void>

visitTry

public Node visitTry(TryTree tree,
 Void p)

Specified by:

visitTry in interface TreeVisitor<Node,Void>

Overrides:

visitTry in class TreeScanner<Node,Void>

visitParameterizedType

public Node visitParameterizedType(ParameterizedTypeTree tree,
 Void p)

Specified by:

visitParameterizedType in interface TreeVisitor<Node,Void>

Overrides:

visitParameterizedType in class TreeScanner<Node,Void>

visitUnionType

public Node visitUnionType(UnionTypeTree tree,
 Void p)

Specified by:

visitUnionType in interface TreeVisitor<Node,Void>

Overrides:

visitUnionType in class TreeScanner<Node,Void>

visitArrayType

public Node visitArrayType(ArrayTypeTree tree,
 Void p)

Specified by:

visitArrayType in interface TreeVisitor<Node,Void>

Overrides:

visitArrayType in class TreeScanner<Node,Void>

visitTypeCast

public Node visitTypeCast(TypeCastTree tree,
 Void p)

Specified by:

visitTypeCast in interface TreeVisitor<Node,Void>

Overrides:

visitTypeCast in class TreeScanner<Node,Void>

visitPrimitiveType

public Node visitPrimitiveType(PrimitiveTypeTree tree,
 Void p)

Specified by:

visitPrimitiveType in interface TreeVisitor<Node,Void>

Overrides:

visitPrimitiveType in class TreeScanner<Node,Void>

visitTypeParameter

public Node visitTypeParameter(TypeParameterTree tree,
 Void p)

Specified by:

visitTypeParameter in interface TreeVisitor<Node,Void>

Overrides:

visitTypeParameter in class TreeScanner<Node,Void>

visitInstanceOf

public Node visitInstanceOf(InstanceOfTree tree,
 Void p)

Specified by:

visitInstanceOf in interface TreeVisitor<Node,Void>

Overrides:

visitInstanceOf in class TreeScanner<Node,Void>

visitUnary

public Node visitUnary(UnaryTree tree,
 Void p)

Specified by:

visitUnary in interface TreeVisitor<Node,Void>

Overrides:

visitUnary in class TreeScanner<Node,Void>

visitVariable

public Node visitVariable(VariableTree tree,
 Void p)

Specified by:

visitVariable in interface TreeVisitor<Node,Void>

Overrides:

visitVariable in class TreeScanner<Node,Void>

visitWhileLoop

public Node visitWhileLoop(WhileLoopTree tree,
 Void p)

Specified by:

visitWhileLoop in interface TreeVisitor<Node,Void>

Overrides:

visitWhileLoop in class TreeScanner<Node,Void>

visitLambdaExpression

public Node visitLambdaExpression(LambdaExpressionTree tree,
 Void p)

Specified by:

visitLambdaExpression in interface TreeVisitor<Node,Void>

Overrides:

visitLambdaExpression in class TreeScanner<Node,Void>

visitMemberReference

public Node visitMemberReference(MemberReferenceTree tree,
 Void p)

Specified by:

visitMemberReference in interface TreeVisitor<Node,Void>

Overrides:

visitMemberReference in class TreeScanner<Node,Void>

visitWildcard

public Node visitWildcard(WildcardTree tree,
 Void p)

Specified by:

visitWildcard in interface TreeVisitor<Node,Void>

Overrides:

visitWildcard in class TreeScanner<Node,Void>

visitOther

public Node visitOther(Tree tree,
 Void p)

Specified by:

visitOther in interface TreeVisitor<Node,Void>

Overrides:

visitOther in class TreeScanner<Node,Void>

getTypeMirror

protected TypeMirror getTypeMirror(Class<?> clazz)

Returns the TypeMirror for the given class.

Parameters:

clazz - a class

Returns:

the TypeMirror for the class

maybeGetTypeMirror

protected @Nullable TypeMirror maybeGetTypeMirror(Class<?> clazz)

Returns the TypeMirror for the given class, or null if the type is not present.

This can be used to handle system types that are not present. For example, in Java code that is translated to JavaScript using j2cl, the custom bootclasspath contains APIs that are emulated in JavaScript, so some types such as OutOfMemoryError are deliberately not present.

Parameters:

clazz - a class, which must have a canonical name

Returns:

the TypeMirror for the class, or null if the type is not present