org.checkerframework.dataflow.cfg

Interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

All Known Implementing Classes:

AbstractCFGVisualizer, DOTCFGVisualizer, StringCFGVisualizer

public interface CFGVisualizer<A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>>

Perform some visualization on a control flow graph. The particular operations depend on the implementation.

Method Summary

Modifier and Type	Method and Description
void	init(Map<String,Object> args) Initialization method guaranteed to be called once before the first invocation of visualize(org.checkerframework.dataflow.cfg.ControlFlowGraph, org.checkerframework.dataflow.cfg.block.Block, org.checkerframework.dataflow.analysis.Analysis<A, S, T>).
void	shutdown() Shutdown method called once from the shutdown hook of the BaseTypeChecker.
@Nullable Map<String,Object>	visualize(ControlFlowGraph cfg, Block entry, @Nullable Analysis<A,S,T> analysis) Output a visualization representing the control flow graph starting at entry.
String	visualizeBlock(Block bb, @Nullable Analysis<A,S,T> analysis) Visualize a block based on the analysis.
String	visualizeBlockNode(Node t, @Nullable Analysis<A,S,T> analysis) Visualize a Node based on the analysis.
String	visualizeBlockTransferInput(Block bb, Analysis<A,S,T> analysis) Visualize the transferInput of a Block based on the analysis.
String	visualizeSpecialBlock(SpecialBlock sbb) Visualize a SpecialBlock.
String	visualizeStore(S store) Delegate the visualization responsibility to the passed Store instance, which will call back to this visualizer instance for sub-components.
String	visualizeStoreArrayVal(FlowExpressions.ArrayAccess arrayValue, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of arrays collected by this Store.
String	visualizeStoreClassVals(FlowExpressions.ClassName className, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of class names collected by this Store.
String	visualizeStoreFieldVals(FlowExpressions.FieldAccess fieldAccess, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of fields collected by this Store.
String	visualizeStoreFooter() Called by CFAbstractStore to visualize any information after the invocation of CFAbstractStore#internalVisualize().
String	visualizeStoreHeader(String classCanonicalName) Called by a CFAbstractStore to visualize the class name before calling the CFAbstractStore#internalVisualize() method.
String	visualizeStoreKeyVal(String keyName, Object value) Called by CFAbstractStore#internalVisualize() to visualize the specific information collected according to the specific kind of Store.
String	visualizeStoreLocalVar(FlowExpressions.LocalVariable localVar, A value) Called by CFAbstractStore#internalVisualize() to visualize a local variable.
String	visualizeStoreMethodVals(FlowExpressions.MethodCall methodCall, A value) Called by CFAbstractStore#internalVisualize() to visualize the value of pure method calls collected by this Store.
String	visualizeStoreThisVal(A value) Called by CFAbstractStore#internalVisualize() to visualize the value of the current object this in this Store.

Method Detail

init

void init(Map<String,Object> args)

Initialization method guaranteed to be called once before the first invocation of visualize(org.checkerframework.dataflow.cfg.ControlFlowGraph, org.checkerframework.dataflow.cfg.block.Block, org.checkerframework.dataflow.analysis.Analysis<A, S, T>).

Parameters:

args - implementation-dependent options

visualize

@Nullable Map<String,Object> visualize(ControlFlowGraph cfg,
                                       Block entry,
                                       @Nullable Analysis<A,S,T> analysis)

Output a visualization representing the control flow graph starting at entry. The concrete actions are implementation dependent.

An invocation visualize(cfg, entry, null); does not output stores at the beginning of basic blocks.

Parameters:

cfg - the CFG to visualize

entry - the entry node of the control flow graph to be represented

analysis - an analysis containing information about the program represented by the CFG. The information includes Stores that are valid at the beginning of basic blocks reachable from entry and per-node information for value producing Nodes. Can also be null to indicate that this information should not be output.

Returns:

visualization results, e.g. generated file names (DOTCFGVisualizer) or a String representation of the CFG (StringCFGVisualizer)

visualizeStore

String visualizeStore(S store)

Delegate the visualization responsibility to the passed Store instance, which will call back to this visualizer instance for sub-components.

Parameters:

store - the store to visualize

Returns:

the String representation of the given store

visualizeStoreHeader

String visualizeStoreHeader(String classCanonicalName)

Called by a CFAbstractStore to visualize the class name before calling the CFAbstractStore#internalVisualize() method.

Parameters:

classCanonicalName - the canonical name of the class

Returns:

the String representation of the class name

visualizeStoreLocalVar

String visualizeStoreLocalVar(FlowExpressions.LocalVariable localVar,
                              A value)

Called by CFAbstractStore#internalVisualize() to visualize a local variable.

Parameters:

localVar - the local variable

value - the value of the local variable

Returns:

the String representation of the local variable

visualizeStoreThisVal

String visualizeStoreThisVal(A value)

Called by CFAbstractStore#internalVisualize() to visualize the value of the current object this in this Store.

Parameters:

value - the value of the current object this

Returns:

the String representation of this

visualizeStoreFieldVals

String visualizeStoreFieldVals(FlowExpressions.FieldAccess fieldAccess,
                               A value)

Called by CFAbstractStore#internalVisualize() to visualize the value of fields collected by this Store.

Parameters:

fieldAccess - the field

value - the value of the field

Returns:

the String representation of the field

visualizeStoreArrayVal

String visualizeStoreArrayVal(FlowExpressions.ArrayAccess arrayValue,
                              A value)

Called by CFAbstractStore#internalVisualize() to visualize the value of arrays collected by this Store.

Parameters:

arrayValue - the array

value - the value of the array

Returns:

the String representation of the array

visualizeStoreMethodVals

String visualizeStoreMethodVals(FlowExpressions.MethodCall methodCall,
                                A value)

Called by CFAbstractStore#internalVisualize() to visualize the value of pure method calls collected by this Store.

Parameters:

methodCall - the pure method call

value - the value of the pure method call

Returns:

the String representation of the pure method call

visualizeStoreClassVals

String visualizeStoreClassVals(FlowExpressions.ClassName className,
                               A value)

Called by CFAbstractStore#internalVisualize() to visualize the value of class names collected by this Store.

Parameters:

className - the class name

value - the value of the class name

Returns:

the String representation of the class name

visualizeStoreKeyVal

String visualizeStoreKeyVal(String keyName,
                            Object value)

Called by CFAbstractStore#internalVisualize() to visualize the specific information collected according to the specific kind of Store. Currently, these Stores call this method: LockStore, NullnessStore, and InitializationStore to visualize additional information.

Parameters:

keyName - the name of the specific information to be visualized

value - the value of the specific information to be visualized

Returns:

the String representation of the specific information

visualizeStoreFooter

String visualizeStoreFooter()

Called by CFAbstractStore to visualize any information after the invocation of CFAbstractStore#internalVisualize().

Returns:

the String representation of the footer

visualizeBlock

String visualizeBlock(Block bb,
                      @Nullable Analysis<A,S,T> analysis)

Visualize a block based on the analysis.

Parameters:

bb - the block

analysis - the current analysis

Returns:

the String representation of the given block

visualizeSpecialBlock

String visualizeSpecialBlock(SpecialBlock sbb)

Visualize a SpecialBlock.

Parameters:

sbb - the special block

Returns:

the String representation of the type of the special block sbb: entry, exit, or exceptional-exit

visualizeBlockTransferInput

String visualizeBlockTransferInput(Block bb,
                                   Analysis<A,S,T> analysis)

Visualize the transferInput of a Block based on the analysis.

Parameters:

bb - the block

analysis - the current analysis

Returns:

the String representation of the transferInput of the given block

visualizeBlockNode

String visualizeBlockNode(Node t,
                          @Nullable Analysis<A,S,T> analysis)

Visualize a Node based on the analysis.

Parameters:

t - the node

analysis - the current analysis

Returns:

the String representation of the given node

shutdown

void shutdown()

Shutdown method called once from the shutdown hook of the BaseTypeChecker.