Function (TAJS)

java.lang.Object
- dk.brics.tajs.flowgraph.Function

```
public class Function
extends Object
```
Function sub-graph. Whenever a function has been created or modified, complete() must be called.

Constructor Summary

Constructors
Constructor and Description
`Function(String name, List<String> parameter_names, Function outer_function, SourceLocation location)` Constructs a new function.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBlock(BasicBlock bb)` Adds a basic block to the function.
`void`	`addVariableName(String varname)` Adds a variable name (only during flow graph construction).
`void`	`check(Function main, Set<Integer> seen_functions, Set<Integer> seen_blocks, Set<Integer> seen_nodes)` Perform a consistency check of the function.
`void`	`complete()` Sets the block orders.
`Collection<BasicBlock>`	`getBlocks()` Returns the collection of basic blocks.
`BasicBlock`	`getEntry()` Returns the entry block.
`BasicBlock`	`getExceptionalExit()` Returns the exceptional exit block.
`int`	`getIndex()` Returns the function index.
`int`	`getMaxRegister()` Returns the upper bound of the register numbers used in this function.
`String`	`getName()` Returns the function name, or null if the function is anonymous.
`BasicBlock`	`getOrdinaryExit()` Returns the ordinary exit block.
`Function`	`getOuterFunction()` Returns the outer function, or null if there is no outer function.
`List<String>`	`getParameterNames()` Returns the list of parameter names.
`SourceLocation`	`getSourceLocation()` Returns a source location for this function.
`Set<String>`	`getVariableNames()` Returns the set of variable names declared in this function.
`boolean`	`hasOuterFunction()` Returns true iff the function has an outer function.
`boolean`	`isMain()` Returns true if this is the main function.
`void`	`removeBlocks(Collection<BasicBlock> bbs)` Removes a collection of basic blocks from the function.
`void`	`setEntry(BasicBlock entry)` Sets the entry block.
`void`	`setExceptionalExit(BasicBlock exceptional_exit)` Sets the exceptional exit basic block.
`(package private) void`	`setIndex(int index)` Sets the function index.
`void`	`setMaxRegister(int max_tmp)` Sets the upper bound of the register numbers used in this function.
`void`	`setOrdinaryExit(BasicBlock ordinary_exit)` Sets the ordinary exit block.
`void`	`toDot(PrintWriter pw, boolean standalone, boolean main)` Produces a Graphviz dot representation of this function.
`String`	`toString()` Returns a string description of this function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Function
```
public Function(String name,
        List<String> parameter_names,
        Function outer_function,
        SourceLocation location)
```
    Constructs a new function. The node set is initially empty, and the entry/exit nodes are not set. The function name is null for anonymous functions.
    
    Parameters:
    name - Function name. Null for anonymous functions.
    parameter_names - A list of parameter names.
    outer_function - the outer function
    location - The source location.
- Method Detail
  - addBlock
```
public void addBlock(BasicBlock bb)
```
    Adds a basic block to the function.
  - addVariableName
```
public void addVariableName(String varname)
```
    Adds a variable name (only during flow graph construction).
  - check
```
public void check(Function main,
         Set<Integer> seen_functions,
         Set<Integer> seen_blocks,
         Set<Integer> seen_nodes)
```
    Perform a consistency check of the function.
  - complete
```
public void complete()
```
    Sets the block orders. Call after construction or modification of the function.
  - getBlocks
```
public Collection<BasicBlock> getBlocks()
```
    Returns the collection of basic blocks.
  - getEntry
```
public BasicBlock getEntry()
```
    Returns the entry block.
  - getExceptionalExit
```
public BasicBlock getExceptionalExit()
```
    Returns the exceptional exit block.
  - getIndex
```
public int getIndex()
```
    Returns the function index. The function index uniquely identifies the function within the flow graph.
  - getMaxRegister
```
public int getMaxRegister()
```
    Returns the upper bound of the register numbers used in this function. Used to safely extend the flow graph during the analysis.
  - getName
```
public String getName()
```
    Returns the function name, or null if the function is anonymous.
  - getOrdinaryExit
```
public BasicBlock getOrdinaryExit()
```
    Returns the ordinary exit block.
  - getOuterFunction
```
public Function getOuterFunction()
```
    Returns the outer function, or null if there is no outer function.
  - getParameterNames
```
public List<String> getParameterNames()
```
    Returns the list of parameter names.
  - getSourceLocation
```
public SourceLocation getSourceLocation()
```
    Returns a source location for this function.
  - getVariableNames
```
public Set<String> getVariableNames()
```
    Returns the set of variable names declared in this function.
  - hasOuterFunction
```
public boolean hasOuterFunction()
```
    Returns true iff the function has an outer function.
  - isMain
```
public boolean isMain()
```
    Returns true if this is the main function.
  - removeBlocks
```
public void removeBlocks(Collection<BasicBlock> bbs)
```
    Removes a collection of basic blocks from the function.
  - setEntry
```
public void setEntry(BasicBlock entry)
```
    Sets the entry block.
  - setExceptionalExit
```
public void setExceptionalExit(BasicBlock exceptional_exit)
```
    Sets the exceptional exit basic block. This block must consist of a single ExceptionalReturnNode.
  - setIndex
```
void setIndex(int index)
```
    Sets the function index. Called when the function is added to a flow graph.
  - setMaxRegister
```
public void setMaxRegister(int max_tmp)
```
    Sets the upper bound of the register numbers used in this function. Used to safely extend the flow graph during the analysis.
  - setOrdinaryExit
```
public void setOrdinaryExit(BasicBlock ordinary_exit)
```
    Sets the ordinary exit block. This block must consist of a single ReturnNode.
  - toDot
```
public void toDot(PrintWriter pw,
         boolean standalone,
         boolean main)
```
    Produces a Graphviz dot representation of this function.
    
    Parameters:
    pw - A receiving print writer.
    standalone - Is this a standalone graph?
    main - Is this main?
  - toString
```
public String toString()
```
    Returns a string description of this function.
    
    Overrides:
    
    toString in class Object

Class Function

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Function

Method Detail

addBlock

addVariableName

check

complete

getBlocks

getEntry

getExceptionalExit

getIndex

getMaxRegister

getName

getOrdinaryExit

getOuterFunction

getParameterNames

getSourceLocation

getVariableNames

hasOuterFunction

isMain

removeBlocks

setEntry

setExceptionalExit

setIndex

setMaxRegister

setOrdinaryExit

toDot

toString