org.checkerframework.dataflow.cfg

Class ControlFlowGraph

java.lang.Object

org.checkerframework.dataflow.cfg.ControlFlowGraph

public class ControlFlowGraph
extends java.lang.Object

A control flow graph (CFG for short) of a single method.

Author:

Stefan Heule

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node>	convertedTreeLookup Map from AST Trees to post-conversion Nodes.
protected SpecialBlock	entryBlock The entry block of the control flow graph.
protected SpecialBlock	exceptionalExitBlock The exceptional exit block of the control flow graph.
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 SpecialBlock	regularExitBlock The regular exit block of the control flow graph.
protected java.util.List<ReturnNode>	returnNodes All return nodes (if any) encountered.
protected java.util.IdentityHashMap<com.sun.source.tree.Tree,Node>	treeLookup Maps from AST Trees to Nodes.
protected java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode>	unaryAssignNodeLookup Map from AST UnaryTrees to corresponding AssignmentNodes.
protected UnderlyingAST	underlyingAST The AST this CFG corresponds to.

Constructor Summary

Constructors

Constructor and Description

ControlFlowGraph(SpecialBlock entryBlock, SpecialBlockImpl regularExitBlock, SpecialBlockImpl exceptionalExitBlock, UnderlyingAST underlyingAST, java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> treeLookup, java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> convertedTreeLookup, java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup, java.util.List<ReturnNode> returnNodes, java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>> generatedTreesLookupMap)

Method Summary

Modifier and Type	Method and Description
java.util.Set<Block>	getAllBlocks()
@Nullable com.sun.source.tree.ClassTree	getContainingClass(com.sun.source.tree.Tree t) Get the ClassTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.
@Nullable com.sun.source.tree.MethodTree	getContainingMethod(com.sun.source.tree.Tree t) Get the MethodTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.
java.util.List<Block>	getDepthFirstOrderedBlocks()
SpecialBlock	getEntryBlock()
SpecialBlock	getExceptionalExitBlock()
java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>>	getGeneratedTreesLookup()
Node	getNodeCorrespondingToTree(com.sun.source.tree.Tree t)
SpecialBlock	getRegularExitBlock()
java.util.List<ReturnNode>	getReturnNodes()
java.util.IdentityHashMap<com.sun.source.tree.Tree,Node>	getTreeLookup()
java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode>	getUnaryAssignNodeLookup()
UnderlyingAST	getUnderlyingAST()

Methods inherited from class java.lang.Object

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

Field Detail

entryBlock

protected final SpecialBlock entryBlock

The entry block of the control flow graph.

regularExitBlock

protected final SpecialBlock regularExitBlock

The regular exit block of the control flow graph.

exceptionalExitBlock

protected final SpecialBlock exceptionalExitBlock

The exceptional exit block of the control flow graph.

underlyingAST

protected UnderlyingAST underlyingAST

The AST this CFG corresponds to.

treeLookup

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

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 treeLookup, while the Node for the post-conversion value is stored in convertedTreeLookup.

convertedTreeLookup

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

Map from AST Trees to post-conversion Nodes.

unaryAssignNodeLookup

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

Map from AST UnaryTrees to corresponding AssignmentNodes.

returnNodes

protected final java.util.List<ReturnNode> returnNodes

All return nodes (if any) encountered. Only includes return statements that actually return something

generatedTreesLookupMap

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

Map from AST Trees to generated Trees.

Constructor Detail

ControlFlowGraph

public ControlFlowGraph(SpecialBlock entryBlock,
                        SpecialBlockImpl regularExitBlock,
                        SpecialBlockImpl exceptionalExitBlock,
                        UnderlyingAST underlyingAST,
                        java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> treeLookup,
                        java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> convertedTreeLookup,
                        java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> unaryAssignNodeLookup,
                        java.util.List<ReturnNode> returnNodes,
                        java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>> generatedTreesLookupMap)

Method Detail

getNodeCorrespondingToTree

public Node getNodeCorrespondingToTree(com.sun.source.tree.Tree t)

Returns:

the Node to which the Tree t corresponds.

getEntryBlock

public SpecialBlock getEntryBlock()

Returns:

the entry block of the control flow graph.

getReturnNodes

public java.util.List<ReturnNode> getReturnNodes()

getRegularExitBlock

public SpecialBlock getRegularExitBlock()

getExceptionalExitBlock

public SpecialBlock getExceptionalExitBlock()

getUnderlyingAST

public UnderlyingAST getUnderlyingAST()

Returns:

the AST this CFG corresponds to.

getAllBlocks

public java.util.Set<Block> getAllBlocks()

Returns:

the set of all basic block in this control flow graph

getDepthFirstOrderedBlocks

public java.util.List<Block> getDepthFirstOrderedBlocks()

Returns:

the list of all basic block in this control flow graph in reversed depth-first postorder sequence.

Blocks may appear more than once in the sequence.

getTreeLookup

public java.util.IdentityHashMap<com.sun.source.tree.Tree,Node> getTreeLookup()

Returns:

the copied tree-lookup map

getUnaryAssignNodeLookup

public java.util.IdentityHashMap<com.sun.source.tree.UnaryTree,AssignmentNode> getUnaryAssignNodeLookup()

Returns:

the copied lookup-map of the assign node for unary operation

getGeneratedTreesLookup

public java.util.IdentityHashMap<com.sun.source.tree.Tree,java.util.List<com.sun.source.tree.Tree>> getGeneratedTreesLookup()

Returns:

the copied map to lookup generated Trees from Tree

getContainingMethod

public @Nullable com.sun.source.tree.MethodTree getContainingMethod(com.sun.source.tree.Tree t)

Get the MethodTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.

getContainingClass

public @Nullable com.sun.source.tree.ClassTree getContainingClass(com.sun.source.tree.Tree t)

Get the ClassTree of the CFG if the argument Tree maps to a Node in the CFG or null otherwise.