CFGVisualizer (checker-framework 2.5.1 API)

All Known Implementing Classes:

DOTCFGVisualizer
```
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

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

- Method Detail
  - init
```
void init(java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.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:
    
    possible analysis results, e.g. generated file names.
  - visualizeStore
```
void 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
  - visualizeStoreHeader
```
void visualizeStoreHeader(java.lang.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
  - visualizeStoreLocalVar
```
void 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
  - visualizeStoreThisVal
```
void 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
  - visualizeStoreFieldVals
```
void 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
  - visualizeStoreArrayVal
```
void 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
  - visualizeStoreMethodVals
```
void 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
  - visualizeStoreClassVals
```
void 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
  - visualizeStoreKeyVal
```
void visualizeStoreKeyVal(java.lang.String keyName,
                          java.lang.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
  - visualizeStoreFooter
```
void visualizeStoreFooter()
```
    Called by CFAbstractStore to visualize any information after the invocation of CFAbstractStore#internalVisualize().
  - visualizeBlock
```
void visualizeBlock(Block bb,
                    @Nullable Analysis<A,S,T> analysis)
```
    Visualize a block based on the analysis.
    
    Parameters:
    
    bb - the block
    
    analysis - the current analysis
  - visualizeSpecialBlock
```
void visualizeSpecialBlock(SpecialBlock sbb)
```
    Visualize a SpecialBlock.
    
    Parameters:
    
    sbb - the special block
  - visualizeBlockTransferInput
```
void 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
  - visualizeBlockNode
```
void visualizeBlockNode(Node t,
                        @Nullable Analysis<A,S,T> analysis)
```
    Visualize a Node based on the analysis.
    
    Parameters:
    
    t - the node
    
    analysis - the current analysis
  - shutdown
```
void shutdown()
```
    Shutdown method called once from the shutdown hook of the BaseTypeChecker.

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

Method Summary

Method Detail

init

visualize

visualizeStore

visualizeStoreHeader

visualizeStoreLocalVar

visualizeStoreThisVal

visualizeStoreFieldVals

visualizeStoreArrayVal

visualizeStoreMethodVals

visualizeStoreClassVals

visualizeStoreKeyVal

visualizeStoreFooter

visualizeBlock

visualizeSpecialBlock

visualizeBlockTransferInput

visualizeBlockNode

shutdown