ObservableICFG (boomerangPDS 2.5.1 API)

Type Parameters:

N - Nodes in the CFG, typically Unit or Block

M - Method representation

All Known Implementing Classes:

BackwardsObservableICFG, ObservableDynamicICFG, ObservableStaticICFG
```
public interface ObservableICFG<N,M>
```
An interprocedural control-flow graph, for which caller-callee edges can be observed using CalleeListener and CallerListener. Can be used for demand-driven call graph generation.

Author:

Melanie Bruns on 04.05.2018

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCalleeListener(CalleeListener<N,M> listener)` Registers a listener that will be notified whenever a callee is added
`void`	`addCallerListener(CallerListener<N,M> listener)` Registers a listener that will be notified whenever a caller is added.
`void`	`addUnbalancedMethod(soot.SootMethod method)`
`Set<N>`	`allNonCallEndNodes()`
`Set<N>`	`allNonCallStartNodes()` Returns the set of all nodes that are neither call nor start nodes.
`Collection<N>`	`getAllPrecomputedCallers(M m)` Returns all precomputed callers for a given method.
`soot.jimple.toolkits.callgraph.CallGraph`	`getCallGraphCopy()`
`Set<N>`	`getCallsFromWithin(M m)` Returns all call sites within a given method.
`Collection<N>`	`getEndPointsOf(M m)`
`M`	`getMethodOf(N n)` Returns the method containing a node.
`int`	`getNumberOfEdgesTakenFromPrecomputedGraph()`
`List<soot.Value>`	`getParameterRefs(M m)` Returns the list of parameter references used in the method's body.
`List<N>`	`getPredsOf(N u)`
`Collection<N>`	`getStartPointsOf(M m)` Returns all start points of a given method.
`List<N>`	`getSuccsOf(N n)` Returns the successor nodes.
`boolean`	`isCallStmt(N stmt)` Returns `true` if the given statement is a call site.
`boolean`	`isExitStmt(N stmt)` Returns `true` if the given statement leads to a method return (exceptional or not).
`boolean`	`isReachable(N u)` Checks whether the given statement is reachable from the entry point
`boolean`	`isStartPoint(N stmt)` Returns true is this is a method's start statement.
`boolean`	`isUnbalancedMethod(soot.SootMethod method)`
`void`	`resetCallGraph()` Resets the call graph.

- Method Detail
  - getMethodOf
```
M getMethodOf(N n)
```
    Returns the method containing a node.
    
    Parameters:
    
    n - The node for which to get the parent method
  - getPredsOf
```
List<N> getPredsOf(N u)
```
  - getSuccsOf
```
List<N> getSuccsOf(N n)
```
    Returns the successor nodes.
  - addCalleeListener
```
void addCalleeListener(CalleeListener<N,M> listener)
```
    Registers a listener that will be notified whenever a callee is added
  - addCallerListener
```
void addCallerListener(CallerListener<N,M> listener)
```
    Registers a listener that will be notified whenever a caller is added.
  - getAllPrecomputedCallers
```
Collection<N> getAllPrecomputedCallers(M m)
```
    Returns all precomputed callers for a given method. Behaviour from addCalleeListener(CalleeListener) only differs when using dynamic call graph.
  - getCallsFromWithin
```
Set<N> getCallsFromWithin(M m)
```
    Returns all call sites within a given method.
  - getStartPointsOf
```
Collection<N> getStartPointsOf(M m)
```
    Returns all start points of a given method. There may be more than one start point in case of a backward analysis.
  - isCallStmt
```
boolean isCallStmt(N stmt)
```
    Returns true if the given statement is a call site.
  - isExitStmt
```
boolean isExitStmt(N stmt)
```
    Returns true if the given statement leads to a method return (exceptional or not). For backward analyses may also be start statements.
  - isStartPoint
```
boolean isStartPoint(N stmt)
```
    Returns true is this is a method's start statement. For backward analyses those may also be return or throws statements.
  - allNonCallStartNodes
```
Set<N> allNonCallStartNodes()
```
    Returns the set of all nodes that are neither call nor start nodes.
  - getEndPointsOf
```
Collection<N> getEndPointsOf(M m)
```
  - allNonCallEndNodes
```
Set<N> allNonCallEndNodes()
```
  - getParameterRefs
```
List<soot.Value> getParameterRefs(M m)
```
    Returns the list of parameter references used in the method's body. The list is as long as the number of parameters declared in the associated method's signature. The list may have null entries for parameters not referenced in the body. The returned list is of fixed size.
  - isReachable
```
boolean isReachable(N u)
```
    Checks whether the given statement is reachable from the entry point
    
    Parameters:
    
    u - The statement to check
    
    Returns:
    
    True if there is a control flow path from the entry point of the program to the given statement, otherwise false
  - getCallGraphCopy
```
soot.jimple.toolkits.callgraph.CallGraph getCallGraphCopy()
```
  - isUnbalancedMethod
```
boolean isUnbalancedMethod(soot.SootMethod method)
```
  - addUnbalancedMethod
```
void addUnbalancedMethod(soot.SootMethod method)
```
  - getNumberOfEdgesTakenFromPrecomputedGraph
```
int getNumberOfEdgesTakenFromPrecomputedGraph()
```
  - resetCallGraph
```
void resetCallGraph()
```
    Resets the call graph. Only affects the call graph if it was built demand-driven, otherwise graph will remain unchanged. Demand-driven call graph will keep intraprocedual information, but reset start with an empty call graph again.

Interface ObservableICFG<N,M>

Method Summary

Method Detail

getMethodOf

getPredsOf

getSuccsOf

addCalleeListener

addCallerListener

getAllPrecomputedCallers

getCallsFromWithin

getStartPointsOf

isCallStmt

isExitStmt

isStartPoint

allNonCallStartNodes

getEndPointsOf

allNonCallEndNodes

getParameterRefs

isReachable

getCallGraphCopy

isUnbalancedMethod

addUnbalancedMethod

getNumberOfEdgesTakenFromPrecomputedGraph

resetCallGraph