Package sootup.core.graph

Class ForwardingStmtGraph<V extends BasicBlock<V>>

java.lang.Object

sootup.core.graph.StmtGraph<V>

sootup.core.graph.ForwardingStmtGraph<V>

All Implemented Interfaces:

Iterable<Stmt>

Direct Known Subclasses:

BackwardsStmtGraph

public class ForwardingStmtGraph<V extends BasicBlock<V>>
extends StmtGraph<V>

forwarding implementation for encapsulating a StmtGraph.

Author:

Markus Schmidt

Nested Class Summary

Nested classes/interfaces inherited from class sootup.core.graph.StmtGraph

StmtGraph.BlockGraphIterator, StmtGraph.BlockGraphIteratorAndTrapAggregator

Field Summary

Fields

Modifier and Type	Field	Description
protected final StmtGraph<V>	backingGraph

Constructor Summary

Constructors

Constructor	Description
ForwardingStmtGraph(StmtGraph<V> backingGraph)

Method Summary

Modifier and Type	Method	Description
List<Trap>	buildTraps()	returns a (reconstructed) list of traps like the traptable in the bytecode
boolean	containsNode(Stmt node)
int	degree(Stmt stmt)	returns the amount of flows with node as source or target.
List<Stmt>	exceptionalPredecessors(Stmt node)	it is possible to reach traphandlers through inline code i.e.
Map<ClassType,Stmt>	exceptionalSuccessors(Stmt node)
BasicBlock<?>	getBlockOf(Stmt stmt)
Collection<? extends BasicBlock<?>>	getBlocks()
List<? extends BasicBlock<?>>	getBlocksSorted()
Collection<Stmt>	getNodes()	returns the nodes in this graph in a non-deterministic order (->Set) to get the nodes in linearized, ordered manner use iterator() or getStmts.
Stmt	getStartingStmt()
BasicBlock<?>	getStartingStmtBlock()
boolean	hasEdgeConnecting(Stmt from, Stmt to)	returns true if there is a flow between source and target throws an Exception if at least one of the parameters is not contained in the graph.
int	inDegree(Stmt stmt)	returns the amount of ingoing flows into node
Iterator<Stmt>	iterator()
int	outDegree(Stmt stmt)	returns the amount of flows that start from node
List<Stmt>	predecessors(Stmt stmt)	returns the ingoing flows to node as an List with no reliable/specific order and possibly duplicate entries i.e.
void	removeExceptionalFlowFromAllBlocks(ClassType exceptionType, Stmt exceptionHandlerStmt)	Removes the specified exceptional flow from all blocks.
List<Stmt>	successors(Stmt stmt)	returns the outgoing flows of node as ordered List.

Methods inherited from class sootup.core.graph.StmtGraph

equals, getAllSuccessors, getBlockIterator, getBranchTargetsOf, getEntrypoints, getExtendedBasicBlockPathBetween, getLabeledStmts, getStmts, getTails, isStmtBranchTarget, toString, validateStmtConnectionsInGraph

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

backingGraph

@Nonnull
protected final StmtGraph<V extends BasicBlock<V>> backingGraph

Constructor Details

ForwardingStmtGraph

public ForwardingStmtGraph(@Nonnull
 StmtGraph<V> backingGraph)

Method Details

getStartingStmt

public Stmt getStartingStmt()

Specified by:

getStartingStmt in class StmtGraph<V extends BasicBlock<V>>

getStartingStmtBlock

public BasicBlock<?> getStartingStmtBlock()

Specified by:

getStartingStmtBlock in class StmtGraph<V extends BasicBlock<V>>

getBlockOf

public BasicBlock<?> getBlockOf(@Nonnull
 Stmt stmt)

Specified by:

getBlockOf in class StmtGraph<V extends BasicBlock<V>>

getNodes

@Nonnull
public Collection<Stmt> getNodes()

Description copied from class: StmtGraph

returns the nodes in this graph in a non-deterministic order (->Set) to get the nodes in linearized, ordered manner use iterator() or getStmts.

Specified by:

getNodes in class StmtGraph<V extends BasicBlock<V>>

getBlocks

@Nonnull
public Collection<? extends BasicBlock<?>> getBlocks()

Specified by:

getBlocks in class StmtGraph<V extends BasicBlock<V>>

getBlocksSorted

@Nonnull
public List<? extends BasicBlock<?>> getBlocksSorted()

Specified by:

getBlocksSorted in class StmtGraph<V extends BasicBlock<V>>

containsNode

public boolean containsNode(@Nonnull
 Stmt node)

Specified by:

containsNode in class StmtGraph<V extends BasicBlock<V>>

predecessors

@Nonnull
public List<Stmt> predecessors(@Nonnull
 Stmt stmt)

Description copied from class: StmtGraph

returns the ingoing flows to node as an List with no reliable/specific order and possibly duplicate entries i.e. if a JSwitchStmt has multiple cases that brnach to `node`

Specified by:

predecessors in class StmtGraph<V extends BasicBlock<V>>

exceptionalPredecessors

@Nonnull
public List<Stmt> exceptionalPredecessors(@Nonnull
 Stmt node)

Description copied from class: StmtGraph

it is possible to reach traphandlers through inline code i.e. without any exceptional flow

Specified by:

exceptionalPredecessors in class StmtGraph<V extends BasicBlock<V>>

successors

@Nonnull
public List<Stmt> successors(@Nonnull
 Stmt stmt)

Description copied from class: StmtGraph

returns the outgoing flows of node as ordered List. The List can have duplicate entries!

Specified by:

successors in class StmtGraph<V extends BasicBlock<V>>

exceptionalSuccessors

@Nonnull
public Map<ClassType,Stmt> exceptionalSuccessors(@Nonnull
 Stmt node)

Specified by:

exceptionalSuccessors in class StmtGraph<V extends BasicBlock<V>>

degree

public int degree(@Nonnull
 Stmt stmt)

Description copied from class: StmtGraph

returns the amount of flows with node as source or target.

Overrides:

degree in class StmtGraph<V extends BasicBlock<V>>

inDegree

public int inDegree(@Nonnull
 Stmt stmt)

Description copied from class: StmtGraph

returns the amount of ingoing flows into node

Specified by:

inDegree in class StmtGraph<V extends BasicBlock<V>>

outDegree

public int outDegree(@Nonnull
 Stmt stmt)

Description copied from class: StmtGraph

returns the amount of flows that start from node

Specified by:

outDegree in class StmtGraph<V extends BasicBlock<V>>

hasEdgeConnecting

public boolean hasEdgeConnecting(@Nonnull
 Stmt from,
 @Nonnull
 Stmt to)

Description copied from class: StmtGraph

returns true if there is a flow between source and target throws an Exception if at least one of the parameters is not contained in the graph.

Specified by:

hasEdgeConnecting in class StmtGraph<V extends BasicBlock<V>>

iterator

@Nonnull
public Iterator<Stmt> iterator()

Specified by:

iterator in interface Iterable<V extends BasicBlock<V>>

Overrides:

iterator in class StmtGraph<V extends BasicBlock<V>>

buildTraps

@Nonnull
public List<Trap> buildTraps()

Description copied from class: StmtGraph

returns a (reconstructed) list of traps like the traptable in the bytecode

Note: if you need exceptionional flow information in more augmented with the affected blocks/stmts and not just a (reconstructed, possibly more verbose) traptable - have a look at BasicBlock.getExceptionalSuccessor()

Specified by:

buildTraps in class StmtGraph<V extends BasicBlock<V>>

removeExceptionalFlowFromAllBlocks

public void removeExceptionalFlowFromAllBlocks(@Nonnull
 ClassType exceptionType,
 @Nonnull
 Stmt exceptionHandlerStmt)

Description copied from class: StmtGraph

Removes the specified exceptional flow from all blocks.

Specified by:

removeExceptionalFlowFromAllBlocks in class StmtGraph<V extends BasicBlock<V>>

Parameters:

exceptionType - The class type of the exceptional flow.

exceptionHandlerStmt - The handler statement of the exceptional flow.