org.checkerframework.dataflow.cfg.visualize

Class CFGVisualizeLauncher

java.lang.Object

org.checkerframework.dataflow.cfg.visualize.CFGVisualizeLauncher

public class CFGVisualizeLauncher
extends Object

Launcher to generate the DOT or String representation of the control flow graph of a given method in a given class.

Usage: Directly run it as the main class to generate the DOT representation of the control flow graph of a given method in a given class. See ConstantPropagationPlayground for another way to use it.

Constructor Summary

Constructors

Constructor and Description
CFGVisualizeLauncher()

Method Summary

Modifier and Type	Method and Description
<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>> void	generateDOTofCFG(String inputFile, String outputDir, String method, String clas, boolean pdf, boolean verbose, @Nullable Analysis<V,S,T> analysis) Generate the DOT representation of the CFG for a method.
protected void	generateDOTofCFGWithoutAnalysis(String inputFile, String outputDir, String method, String clas, boolean pdf, boolean verbose) Generate the DOT representation of the CFG for a method, only.
protected ControlFlowGraph	generateMethodCFG(String file, String clas, String method) Generate the control flow graph of a method in a class.
<V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>> @Nullable Map<String,Object>	generateStringOfCFG(String inputFile, String method, String clas, boolean verbose, @Nullable Analysis<V,S,T> analysis) Generate the String representation of the CFG for a method.
protected String	generateStringOfCFGWithoutAnalysis(String inputFile, String method, String clas, boolean verbose) Generate the String representation of the CFG for a method, only.
static void	main(String[] args) The main entry point of CFGVisualizeLauncher.
protected void	printError(@Nullable String string) Print error message.
protected void	printUsage() Print usage information.
protected void	producePDF(String file) Invoke "dot" command to generate a PDF.

Methods inherited from class java.lang.Object

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

Constructor Detail

CFGVisualizeLauncher

public CFGVisualizeLauncher()

Method Detail

main

public static void main(String[] args)

The main entry point of CFGVisualizeLauncher.

Parameters:

args - the passed arguments, see printUsage() for the usage

generateDOTofCFGWithoutAnalysis

protected void generateDOTofCFGWithoutAnalysis(String inputFile,
                                               String outputDir,
                                               String method,
                                               String clas,
                                               boolean pdf,
                                               boolean verbose)

Generate the DOT representation of the CFG for a method, only. Does no dataflow analysis.

Parameters:

inputFile - java source input file

outputDir - output directory

method - name of the method to generate the CFG for

clas - name of the class which includes the method to generate the CFG for

pdf - also generate a PDF

verbose - show verbose information in CFG

generateStringOfCFGWithoutAnalysis

protected String generateStringOfCFGWithoutAnalysis(String inputFile,
                                                    String method,
                                                    String clas,
                                                    boolean verbose)

Generate the String representation of the CFG for a method, only. Does no dataflow analysis.

Parameters:

inputFile - java source input file

method - name of the method to generate the CFG for

clas - name of the class which includes the method to generate the CFG for

verbose - show verbose information in CFG

Returns:

the String representation of the CFG

generateDOTofCFG

public <V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>> void generateDOTofCFG(String inputFile,
                                                                                                             String outputDir,
                                                                                                             String method,
                                                                                                             String clas,
                                                                                                             boolean pdf,
                                                                                                             boolean verbose,
                                                                                                             @Nullable Analysis<V,S,T> analysis)

Generate the DOT representation of the CFG for a method.

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 approximated runtime behavior

Parameters:

inputFile - java source input file

outputDir - source output directory

method - name of the method to generate the CFG for

clas - name of the class which includes the method to generate the CFG for

pdf - also generate a PDF

verbose - show verbose information in CFG

analysis - analysis to perform before the visualization (or null if no analysis is to be performed)

generateMethodCFG

protected ControlFlowGraph generateMethodCFG(String file,
                                             String clas,
                                             String method)

Generate the control flow graph of a method in a class.

Parameters:

file - java source input file

clas - name of the class which includes the method to generate the CFG for

method - name of the method to generate the CFG for

Returns:

control flow graph of the specified method

producePDF

protected void producePDF(String file)

Invoke "dot" command to generate a PDF.

Parameters:

file - name of the dot file

generateStringOfCFG

public <V extends AbstractValue<V>,S extends Store<S>,T extends TransferFunction<V,S>> @Nullable Map<String,Object> generateStringOfCFG(String inputFile,
                                                                                                                                        String method,
                                                                                                                                        String clas,
                                                                                                                                        boolean verbose,
                                                                                                                                        @Nullable Analysis<V,S,T> analysis)

Generate the String representation of the CFG for a method.

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 approximated runtime behavior

Parameters:

inputFile - java source input file

method - name of the method to generate the CFG for

clas - name of the class which includes the method to generate the CFG for

verbose - show verbose information in CFG

analysis - analysis to perform before the visualization (or null if no analysis is to be performed)

Returns:

a map which includes a key "stringGraph" and the String representation of CFG as the value

printUsage

protected void printUsage()

Print usage information.

printError

protected void printError(@Nullable String string)

Print error message.

Parameters:

string - error message