Function (TAJS)

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Function(java.lang.String name, java.util.List<java.lang.String> parameter_names, Function outer_function, boolean strict, SourceLocation location, java.lang.String source)` Constructs a new function.
`Function(java.lang.String name, java.util.List<java.lang.String> parameter_names, Function outer_function, SourceLocation location)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlock(BasicBlock bb)` Adds a basic block to the function.
`void`	`addVariableName(java.lang.String varname)` Adds a variable name (only during flow graph construction).
`void`	`check(Function main, java.util.Set<java.lang.Integer> seen_functions, java.util.Set<java.lang.Integer> seen_blocks, java.util.Set<java.lang.Integer> seen_nodes)` Perform a consistency check of the function.
`void`	`complete()` Sets the block orders.
`java.util.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.
`java.lang.String`	`getName()` Returns the function name, or null if the function is anonymous.
`DeclareFunctionNode`	`getNode()` Returns the node where this function is declared.
`BasicBlock`	`getOrdinaryExit()` Returns the ordinary exit block.
`Function`	`getOuterFunction()` Returns the outer function, or null if there is no outer function.
`java.util.List<java.lang.String>`	`getParameterNames()` Returns the list of parameter names.
`java.lang.String`	`getSource()` Returns the source code of the function, null if full source code is not available (e.g.
`SourceLocation`	`getSourceLocation()` Returns a source location for this function.
`java.util.Set<java.lang.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.
`boolean`	`isStrict()` Returns true if this function is in strict mode.
`void`	`removeBlocks(java.util.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`	`setNode(DeclareFunctionNode node)` Sets the node where this function is declared.
`void`	`setOrdinaryExit(BasicBlock ordinary_exit)` Sets the ordinary exit block.
`void`	`setSourceLocation(SourceLocation location)` Sets the source location.
`void`	`toDot(java.io.PrintWriter pw, boolean standalone, boolean main)` Produces a Graphviz dot representation of this function.
`java.lang.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(java.lang.String name,
                java.util.List<java.lang.String> parameter_names,
                Function outer_function,
                boolean strict,
                SourceLocation location,
                java.lang.String source)
```
    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 - list of parameter names, null can be used in place of an empty list
    
    outer_function - the outer function, null if none
    
    location - source location
    
    source - full source code of function, null if not available
  - Function
```
public Function(java.lang.String name,
                java.util.List<java.lang.String> parameter_names,
                Function outer_function,
                SourceLocation location)
```
    See Also:
    
    Function(String, List, Function, boolean, SourceLocation, String)
- Method Detail
  - addBlock
```
public void addBlock(BasicBlock bb)
```
    Adds a basic block to the function.
  - addVariableName
```
public void addVariableName(java.lang.String varname)
```
    Adds a variable name (only during flow graph construction).
  - check
```
public void check(Function main,
                  java.util.Set<java.lang.Integer> seen_functions,
                  java.util.Set<java.lang.Integer> seen_blocks,
                  java.util.Set<java.lang.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 java.util.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 java.lang.String getName()
```
    Returns the function name, or null if the function is anonymous.
  - getNode
```
public DeclareFunctionNode getNode()
```
    Returns the node where this function is declared.
  - 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 java.util.List<java.lang.String> getParameterNames()
```
    Returns the list of parameter names.
  - getSource
```
public java.lang.String getSource()
```
    Returns the source code of the function, null if full source code is not available (e.g. eventhandlers in html).
  - getSourceLocation
```
public SourceLocation getSourceLocation()
```
    Returns a source location for this function.
  - getVariableNames
```
public java.util.Set<java.lang.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.
  - isStrict
```
public boolean isStrict()
```
    Returns true if this function is in strict mode.
  - removeBlocks
```
public void removeBlocks(java.util.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.
  - setNode
```
public void setNode(DeclareFunctionNode node)
```
    Sets the node where this function is declared.
  - setOrdinaryExit
```
public void setOrdinaryExit(BasicBlock ordinary_exit)
```
    Sets the ordinary exit block. This block must consist of a single ReturnNode.
  - setSourceLocation
```
public void setSourceLocation(SourceLocation location)
```
    Sets the source location.
  - toDot
```
public void toDot(java.io.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 java.lang.String toString()
```
    Returns a string description of this function.
    
    Overrides:
    
    toString in class java.lang.Object

Class Function

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Function

Function

Method Detail

addBlock

addVariableName

check

complete

getBlocks

getEntry

getExceptionalExit

getIndex

getMaxRegister

getName

getNode

getOrdinaryExit

getOuterFunction

getParameterNames

getSource

getSourceLocation

getVariableNames

hasOuterFunction

isMain

isStrict

removeBlocks

setEntry

setExceptionalExit

setIndex

setMaxRegister

setNode

setOrdinaryExit

setSourceLocation

toDot

toString