org.checkerframework.dataflow.cfg

Class JavaSource2CFGDOT

java.lang.Object

org.checkerframework.dataflow.cfg.JavaSource2CFGDOT

public class JavaSource2CFGDOT
extends Object

Class to generate the DOT representation of the control flow graph of a given method.

Constructor Summary

Constructors

Constructor and Description
JavaSource2CFGDOT()

Method Summary

Modifier and Type	Method and Description
static void	generateDOTofCFG(String inputFile, String outputDir, String method, String clas, boolean pdf) Just like method above but without analysis.
static <A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>> void	generateDOTofCFG(String inputFile, String outputDir, String method, String clas, boolean pdf, @Nullable Analysis<A,S,T> analysis) Generate the DOT representation of the CFG for a method.
static <A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>> void	generateDOTofCFG(String inputFile, String outputDir, String method, String clas, boolean pdf, @Nullable Analysis<A,S,T> analysis, @Nullable MethodTree m, @Nullable CompilationUnitTree r)
static @Nullable MethodTree	getMethodTree(String file, String method, String clas)
static Map.Entry<MethodTree,CompilationUnitTree>	getMethodTreeAndCompilationUnit(String file, String method, String clas)
static void	main(String[] args) Main method.
protected static void	printError(String string) Print an error message.
protected static void	printUsage() Print usage information.
protected static void	producePDF(String file) Invoke DOT to generate a PDF.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaSource2CFGDOT

public JavaSource2CFGDOT()

Method Detail

main

public static void main(String[] args)

Main method.

printError

protected static void printError(String string)

Print an error message.

printUsage

protected static void printUsage()

Print usage information.

generateDOTofCFG

public static void generateDOTofCFG(String inputFile,
                                    String outputDir,
                                    String method,
                                    String clas,
                                    boolean pdf)

Just like method above but without analysis.

generateDOTofCFG

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

Generate the DOT representation of the CFG for a method.

Parameters:

inputFile - java source input file

outputDir - source output directory

method - method name to generate the CFG for

pdf - also generate a PDF?

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

generateDOTofCFG

public static <A extends AbstractValue<A>,S extends Store<S>,T extends TransferFunction<A,S>> void generateDOTofCFG(String inputFile,
                                                                                                                    String outputDir,
                                                                                                                    String method,
                                                                                                                    String clas,
                                                                                                                    boolean pdf,
                                                                                                                    @Nullable Analysis<A,S,T> analysis,
                                                                                                                    @Nullable MethodTree m,
                                                                                                                    @Nullable CompilationUnitTree r)

producePDF

protected static void producePDF(String file)

Invoke DOT to generate a PDF.

getMethodTree

public static @Nullable MethodTree getMethodTree(String file,
                                                 String method,
                                                 String clas)

Returns:

the AST of a specific method in a specific class in a specific file (or null if no such method exists)

getMethodTreeAndCompilationUnit

public static Map.Entry<MethodTree,CompilationUnitTree> getMethodTreeAndCompilationUnit(String file,
                                                                                        String method,
                                                                                        String clas)

Returns:

the AST of a specific method in a specific class as well as the CompilationUnitTree in a specific file (or null they do not exist).