dk.brics.tajs.flowgraph

Class FlowGraph

java.lang.Object

dk.brics.tajs.flowgraph.FlowGraph

public class FlowGraph
extends Object

Flow graph. A flow graph is divided into functions, one of them representing the main program. Each function contains blocks of nodes. Nodes represent primitive instructions, edges represent control flow.

Constructor Summary

Constructors

Constructor and Description
FlowGraph() Constructs a new uninitialized flow graph.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(BasicBlock b) Adds a block to this flow graph.
void	addCallback(Function f, CallbackKind kind) Adds the given callback to the flow graph.
void	addFunction(Function f) Adds the given function to the flow graph.
void	check() Perform a consistency check of the flow graph (if in debug or test mode).
FlowGraph	complete() Runs complete on all the functions in the flow graph.
Set<Function>	getCallbacksByKind(CallbackKind kind) Retrieves the callbacks of the given kind.
BasicBlock	getEntryBlock() Returns the entry block of the flow graph.
Function	getFunction(String name) Returns the function with the given name.
Collection<Function>	getFunctions() Returns the functions, including the main function.
Function	getMain() Returns the main code.
int	getNumberOfBlocks() Returns the total number of basic blocks in this flow graph.
int	getNumberOfNodes() Returns the total number of nodes in this flow graph.
void	removeFunctions(Collection<Function> fs) Deletes a collection of functions from the flow graph.
void	toDot(PrintWriter pw) Produces a Graphviz dot representation of this flow graph.
void	toDot(String dest_dir, boolean end) Produces a Graphviz dot representation of each function in this flow graph.
String	toString() Returns a string description of this flow graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowGraph

public FlowGraph()

Constructs a new uninitialized flow graph.

Method Detail

addBlock

public void addBlock(BasicBlock b)

Adds a block to this flow graph. Also sets the block index and the node index for each node in the block.

Parameters:

b - The basic block to add.

addCallback

public void addCallback(Function f,
               CallbackKind kind)

Adds the given callback to the flow graph. The function must already be added to the flow graph.

addFunction

public void addFunction(Function f)

Adds the given function to the flow graph. The first function added becomes main.

check

public void check()

Perform a consistency check of the flow graph (if in debug or test mode).

complete

public FlowGraph complete()

Runs complete on all the functions in the flow graph.

getCallbacksByKind

public Set<Function> getCallbacksByKind(CallbackKind kind)

Retrieves the callbacks of the given kind. Always returns a set (and never null).

getEntryBlock

public BasicBlock getEntryBlock()

Returns the entry block of the flow graph.

getFunction

public Function getFunction(String name)

Returns the function with the given name.

getFunctions

public Collection<Function> getFunctions()

Returns the functions, including the main function.

getMain

public Function getMain()

Returns the main code.

getNumberOfBlocks

public int getNumberOfBlocks()

Returns the total number of basic blocks in this flow graph.

getNumberOfNodes

public int getNumberOfNodes()

Returns the total number of nodes in this flow graph.

removeFunctions

public void removeFunctions(Collection<Function> fs)

Deletes a collection of functions from the flow graph.

toDot

public void toDot(PrintWriter pw)

Produces a Graphviz dot representation of this flow graph.

toDot

public void toDot(String dest_dir,
         boolean end)
           throws IOException

Produces a Graphviz dot representation of each function in this flow graph.

Parameters:

dest_dir - destination directory

end - if set, the name contains "final", otherwise "initial"

Throws:

IOException - if some file operation fails.

toString

public String toString()

Returns a string description of this flow graph.

Overrides:

toString in class Object