org.checkerframework.dataflow.cfg

Class AbstractCFGVisualizer<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>>

java.lang.Object

org.checkerframework.dataflow.cfg.AbstractCFGVisualizer<V,S,T>

Type Parameters:

V - the abstract value type to be tracked by the analysis

S - the store type used in the analysis

T - the transfer function type that is used to approximate runtime behavior

All Implemented Interfaces:

CFGVisualizer<V,S,T>

Direct Known Subclasses:

DOTCFGVisualizer, StringCFGVisualizer

public abstract class AbstractCFGVisualizer<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>>
extends Object
implements CFGVisualizer<V,S,T>

This abstract class makes implementing a CFGVisualizer easier. Some of the methods in CFGVisualizer are already implemented in this abstract class, but can be overridden if necessary.

See Also:

DOTCFGVisualizer, StringCFGVisualizer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	lineSeparator The line separator.
protected String	storeEntryIndent The indentation for elements of the store.
protected boolean	verbose Initialized in init(Map).

Constructor Summary

Constructors

Constructor and Description
AbstractCFGVisualizer()

Method Summary

Modifier and Type	Method and Description
protected void	addBlock(Block b, Set<Block> visited, Queue<Block> workList) Checks whether a block exists in the visited blocks list, and, if not, adds it to the visited blocks list and the work list.
protected List<Node>	addBlockContent(Block bb) Returns the contents of the block.
protected abstract String	addEdge(long sId, long eId, String flowRule) Generate the String representation of an edge.
protected abstract String	format(Object obj) Format the given object as a String suitable for the output format, i.e.
protected @Nullable Node	getLastNode(Block bb) Returns the last node of a block, or null if none.
protected String	getNodeSimpleName(Node t) Get the simple name of a node.
protected IdentityHashMap<Block,List<Integer>>	getProcessOrder(ControlFlowGraph cfg) Generate the order of processing blocks.
protected String	getProcessOrderSimpleString(List<Integer> order) Return the simple String of the process order of a node, e.g., "Process order: 23".
protected void	handleSuccessorsHelper(Block cur, Set<Block> visited, Queue<Block> workList, StringBuilder sbGraph) Adds the successors of the current block to the work list and the visited blocks list.
void	init(Map<String,Object> args) Initialization method guaranteed to be called once before the first invocation of CFGVisualizer.visualize(org.checkerframework.dataflow.cfg.ControlFlowGraph, org.checkerframework.dataflow.cfg.block.Block, org.checkerframework.dataflow.analysis.Analysis<V, S, T>).
protected String	loopOverBlockContents(Block bb, @Nullable Analysis<V,S,T> analysis, String separator) Iterates over the block content and visualizes all the nodes in it.
protected String	visualizeBlockHelper(Block bb, @Nullable Analysis<V,S,T> analysis, String escapeString) Helper method to visualize a block.
String	visualizeBlockNode(Node t, @Nullable Analysis<V,S,T> analysis) Visualize a Node based on the analysis.
protected String	visualizeBlockTransferInputAfterHelper(Block bb, Analysis<V,S,T> analysis, String escapeString) Visualize the transfer input after the given block.
protected String	visualizeBlockTransferInputBeforeHelper(Block bb, Analysis<V,S,T> analysis, String escapeString) Visualize the transfer input before the given block.
protected String	visualizeGraph(ControlFlowGraph cfg, Block entry, @Nullable Analysis<V,S,T> analysis) Visualize a control flow graph.
protected abstract String	visualizeGraphFooter() Return the footer of the generated graph.
protected abstract String	visualizeGraphHeader() Return the header of the generated graph.
protected String	visualizeGraphWithoutHeaderAndFooter(ControlFlowGraph cfg, Block entry, @Nullable Analysis<V,S,T> analysis) Helper method to visualize a control flow graph, without outputting a header or footer.
protected abstract String	visualizeNodes(Set<Block> blocks, ControlFlowGraph cfg, @Nullable Analysis<V,S,T> analysis) Generate the String representation of the nodes of a control flow graph.
protected String	visualizeSpecialBlockHelper(SpecialBlock sbb, String separator) Visualize a special block.
String	visualizeStore(S store) Delegate the visualization responsibility to the passed Store instance, which will call back to this visualizer instance for sub-components.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.dataflow.cfg.CFGVisualizer

shutdown, visualize, visualizeBlock, visualizeBlockTransferInputAfter, visualizeBlockTransferInputBefore, visualizeConditionalBlock, visualizeSpecialBlock, visualizeStoreArrayVal, visualizeStoreClassVals, visualizeStoreFieldVals, visualizeStoreFooter, visualizeStoreHeader, visualizeStoreKeyVal, visualizeStoreLocalVar, visualizeStoreMethodVals, visualizeStoreThisVal

Field Detail

verbose

protected boolean verbose

Initialized in init(Map). If its value is true, CFGVisualizer returns more detailed information.

lineSeparator

protected final String lineSeparator

The line separator.

storeEntryIndent

protected final String storeEntryIndent

The indentation for elements of the store.

See Also:

Constant Field Values

Constructor Detail

AbstractCFGVisualizer

public AbstractCFGVisualizer()

Method Detail

init

public void init(Map<String,Object> args)

Description copied from interface: CFGVisualizer

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

Specified by:

init in interface CFGVisualizer<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>>

Parameters:

args - implementation-dependent options

visualizeGraph

protected String visualizeGraph(ControlFlowGraph cfg,
                                Block entry,
                                @Nullable Analysis<V,S,T> analysis)

Visualize a control flow graph.

Parameters:

cfg - the current control flow graph

entry - the entry block of the control flow graph

analysis - the current analysis

Returns:

the representation of the control flow graph

visualizeGraphWithoutHeaderAndFooter

protected String visualizeGraphWithoutHeaderAndFooter(ControlFlowGraph cfg,
                                                      Block entry,
                                                      @Nullable Analysis<V,S,T> analysis)

Helper method to visualize a control flow graph, without outputting a header or footer.

Parameters:

cfg - the control flow graph

entry - the entry block of the control flow graph

analysis - the current analysis

Returns:

the String representation of the control flow graph

handleSuccessorsHelper

protected void handleSuccessorsHelper(Block cur,
                                      Set<Block> visited,
                                      Queue<Block> workList,
                                      StringBuilder sbGraph)

Adds the successors of the current block to the work list and the visited blocks list.

Parameters:

cur - the current block

visited - the set of blocks that have already been visited or are in the work list

workList - the queue of blocks to be processed

sbGraph - the StringBuilder to store the graph

addBlock

protected void addBlock(Block b,
                        Set<Block> visited,
                        Queue<Block> workList)

Checks whether a block exists in the visited blocks list, and, if not, adds it to the visited blocks list and the work list.

Parameters:

b - the block to check

visited - the set of blocks that have already been visited or are in the work list

workList - the queue of blocks to be processed

visualizeBlockHelper

protected String visualizeBlockHelper(Block bb,
                                      @Nullable Analysis<V,S,T> analysis,
                                      String escapeString)

Helper method to visualize a block.

Parameters:

bb - the block

analysis - the current analysis

escapeString - the escape String for the special need of visualization, e.g., "\\l" for DOTCFGVisualizer to keep line left-justification, "\n" for StringCFGVisualizer to simply add a new line

Returns:

the String representation of the block

loopOverBlockContents

protected String loopOverBlockContents(Block bb,
                                       @Nullable Analysis<V,S,T> analysis,
                                       String separator)

Iterates over the block content and visualizes all the nodes in it.

Parameters:

bb - the block

analysis - the current analysis

separator - the separator between the nodes of the block

Returns:

the String representation of the contents of the block

addBlockContent

protected List<Node> addBlockContent(Block bb)

Returns the contents of the block.

Parameters:

bb - the block

Returns:

the contents of the block, as a list of nodes

format

protected abstract String format(Object obj)

Format the given object as a String suitable for the output format, i.e. with format-specific characters escaped.

Parameters:

obj - an object

Returns:

the formatted String from the given object

visualizeBlockNode

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

Description copied from interface: CFGVisualizer

Visualize a Node based on the analysis.

Specified by:

visualizeBlockNode in interface CFGVisualizer<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>>

Parameters:

t - the node

analysis - the current analysis

Returns:

the String representation of the given node

visualizeBlockTransferInputBeforeHelper

protected String visualizeBlockTransferInputBeforeHelper(Block bb,
                                                         Analysis<V,S,T> analysis,
                                                         String escapeString)

Visualize the transfer input before the given block.

Parameters:

bb - the block

analysis - the current analysis

escapeString - the escape String for the special need of visualization, e.g., "\\l" for DOTCFGVisualizer to keep line left-justification, "\n" for StringCFGVisualizer to simply add a new line

Returns:

the visualization of the transfer input before the given block

visualizeBlockTransferInputAfterHelper

protected String visualizeBlockTransferInputAfterHelper(Block bb,
                                                        Analysis<V,S,T> analysis,
                                                        String escapeString)

Visualize the transfer input after the given block.

Parameters:

bb - the given block

analysis - the current analysis

escapeString - the escape String for the special need of visualization, e.g., "\\l" for DOTCFGVisualizer to keep line left-justification, "\n" for StringCFGVisualizer to simply add a new line

Returns:

the visualization of the transfer input after the given block

visualizeSpecialBlockHelper

protected String visualizeSpecialBlockHelper(SpecialBlock sbb,
                                             String separator)

Visualize a special block.

Parameters:

sbb - the special block

separator - the separator String to put at the end of the result

Returns:

the String representation of the special block, followed by the separator

getLastNode

protected @Nullable Node getLastNode(Block bb)

Returns the last node of a block, or null if none.

Parameters:

bb - the block

Returns:

the last node of this block or null

getProcessOrder

protected IdentityHashMap<Block,List<Integer>> getProcessOrder(ControlFlowGraph cfg)

Generate the order of processing blocks. Because a block may appears more than once in ControlFlowGraph.getDepthFirstOrderedBlocks(), the orders of each block are stored in a separate array list.

Parameters:

cfg - the current control flow graph

Returns:

an IdentityHashMap that maps from blocks to their orders

visualizeStore

public String visualizeStore(S store)

Description copied from interface: CFGVisualizer

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

Specified by:

visualizeStore in interface CFGVisualizer<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>>

Parameters:

store - the store to visualize

Returns:

the String representation of the given store

visualizeNodes

protected abstract String visualizeNodes(Set<Block> blocks,
                                         ControlFlowGraph cfg,
                                         @Nullable Analysis<V,S,T> analysis)

Generate the String representation of the nodes of a control flow graph.

Parameters:

blocks - the set of all the blocks in a control flow graph

cfg - the control flow graph

analysis - the current analysis

Returns:

the String representation of the nodes

addEdge

protected abstract String addEdge(long sId,
                                  long eId,
                                  String flowRule)

Generate the String representation of an edge.

Parameters:

sId - the ID of current block

eId - the ID of successor block

flowRule - the content of the edge

Returns:

the String representation of the edge

visualizeGraphHeader

protected abstract String visualizeGraphHeader()

Return the header of the generated graph.

Returns:

the String representation of the header of the control flow graph

visualizeGraphFooter

protected abstract String visualizeGraphFooter()

Return the footer of the generated graph.

Returns:

the String representation of the footer of the control flow graph

getProcessOrderSimpleString

protected String getProcessOrderSimpleString(List<Integer> order)

Return the simple String of the process order of a node, e.g., "Process order: 23". When a node have multiple process orders, a sequence of numbers will be returned, e.g., "Process order: 23,25".

Parameters:

order - the list of the process order to be processed

Returns:

the String representation of the process order of the node

getNodeSimpleName

protected String getNodeSimpleName(Node t)

Get the simple name of a node.

Parameters:

t - a node

Returns:

the node's simple name, without "Node"