IPANode

java.lang.Object
- cetus.analysis.DFANode
- - cetus.analysis.IPANode

```
public class IPANode
extends DFANode
```
Class IPANode represents workspace for a procedure, used in interprocedural analysis. It is built upon the DFANode data structure which maintains a generic map for satellite data. IPANode also use the mapped data internally while exposing such data through public methods.

Constructor Summary

Constructors
Constructor and Description

IPANode(Procedure proc)
Constructs an IPANode object with the given procedure.

Constructors
Constructor and Description
`IPANode(Procedure proc)` Constructs an IPANode object with the given procedure.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clean()` Removes the IN/OUT data.
`boolean`	`containsVarArg()` Marks this node as one with variable argument list
`java.util.Set<IPANode>`	`getCallers()` Returns the set of IPANode objects that call the current node.
`java.util.List<CallSite>`	`getCallingSites()` Returns the set of CallSite objects that calls the current node.
`CallSite`	`getCallSite(FunctionCall fc)` Returns the call site object associated with the given function call.
`java.util.List<CallSite>`	`getCallSites()` Returns the list of call sites present in the procedure.
`java.lang.String`	`getName()` Returns the name of the procedure.
`java.util.List<Symbol>`	`getParameters()` Returns the list of formal parameter symbols.
`Procedure`	`getProcedure()` Returns the procedure associated with the current node.
`<T extends Domain> T`	`in()` Returns the IN data after joining all IN data.
`<T extends Domain> T`	`in(CallSite calling_site)` Returns the context-sensitive IN data.
`void`	`in(CallSite calling_site, Domain domain)` Set the IN data with the specified Domain object and the calling site.
`boolean`	`isRecursive()` Checks if this node can be called recursively
`boolean`	`isRoot()` Checks if this node is a root node
`<T extends Domain> T`	`out()` Returns the OUT data.
`void`	`out(Domain domain)` Set the OUT data with the specified Domain object.
`void`	`setCloneable(boolean cloneable)` Marks this node as a cloneable node -- not within any call cycle
`void`	`setRoot()` Marks this node as a root node
`java.lang.String`	`toString()` Returns a string dump of this node

Methods inherited from class cetus.analysis.DFANode
addPred, addSucc, getData, getData, getKeys, getPredData, getPreds, getSuccData, getSuccs, putData, putPredData, putSuccData, removeData, removePred, removeSucc, toDot

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

- Constructor Detail
  - IPANode
```
public IPANode(Procedure proc)
```
    Constructs an IPANode object with the given procedure.
- Method Detail
  - getCallSites
```
public java.util.List<CallSite> getCallSites()
```
    Returns the list of call sites present in the procedure.
    
    Returns:
    the list of call sites
  - getName
```
public java.lang.String getName()
```
    Returns the name of the procedure.
  - getProcedure
```
public Procedure getProcedure()
```
    Returns the procedure associated with the current node.
    
    Returns:
    a procedure.
  - getCallSite
```
public CallSite getCallSite(FunctionCall fc)
```
    Returns the call site object associated with the given function call.
    
    Returns:
    a call site object.
  - getCallers
```
public java.util.Set<IPANode> getCallers()
```
    Returns the set of IPANode objects that call the current node.
    
    Returns:
    the set of IPANode.
  - getCallingSites
```
public java.util.List<CallSite> getCallingSites()
```
    Returns the set of CallSite objects that calls the current node.
    
    Returns:
    the set of calling sites.
  - getParameters
```
public java.util.List<Symbol> getParameters()
```
    Returns the list of formal parameter symbols.
  - in
```
public <T extends Domain> T in(CallSite calling_site)
```
    Returns the context-sensitive IN data.
    
    Parameters:
    calling_site - the calling site of this node.
    
    Returns:
    the context-sensitive IN data associated with calling_site.
  - in
```
public <T extends Domain> T in()
```
    Returns the IN data after joining all IN data.
  - out
```
public <T extends Domain> T out()
```
    Returns the OUT data.
  - in
```
public void in(CallSite calling_site,
      Domain domain)
```
    Set the IN data with the specified Domain object and the calling site.
  - out
```
public void out(Domain domain)
```
    Set the OUT data with the specified Domain object.
  - clean
```
public void clean()
```
    Removes the IN/OUT data.
  - setRoot
```
public void setRoot()
```
    Marks this node as a root node
  - setCloneable
```
public void setCloneable(boolean cloneable)
```
    Marks this node as a cloneable node -- not within any call cycle
  - containsVarArg
```
public boolean containsVarArg()
```
    Marks this node as one with variable argument list
  - isRoot
```
public boolean isRoot()
```
    Checks if this node is a root node
  - isRecursive
```
public boolean isRecursive()
```
    Checks if this node can be called recursively
  - toString
```
public java.lang.String toString()
```
    Returns a string dump of this node
    
    Overrides:
    
    toString in class DFANode
    
    Returns:
    the listing of the contents of the graph in a string.

Class IPANode

Constructor Summary

Method Summary

Methods inherited from class cetus.analysis.DFANode

Methods inherited from class java.lang.Object

Constructor Detail

IPANode

Method Detail

getCallSites

getName

getProcedure

getCallSite

getCallers

getCallingSites

getParameters

in

in

out

in

out

clean

setRoot

setCloneable

containsVarArg

isRoot

isRecursive

toString