Package sootup.core.graph

Class ForwardingControlFlowGraph<V extends BasicBlock<V>>

java.lang.Object

sootup.core.graph.ControlFlowGraph<V>

sootup.core.graph.ForwardingControlFlowGraph<V>

All Implemented Interfaces:

Iterable<Stmt>

Direct Known Subclasses:

BackwardsControlFlowGraph

public class ForwardingControlFlowGraph<V extends BasicBlock<V>>
extends ControlFlowGraph<V>

forwarding implementation for encapsulating a ControlFlowGraph.

Author:

Markus Schmidt

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull ControlFlowGraph<V>	backingGraph

Constructor Summary

Constructors

Constructor	Description
ForwardingControlFlowGraph(@NonNull ControlFlowGraph<V> backingGraph)

Method Summary

Modifier and Type	Method	Description
boolean	containsNode(@NonNull Stmt node)
int	degree(@NonNull Stmt stmt)	returns the amount of flows with node as source or target.
@NonNull List<Stmt>	exceptionalPredecessors(@NonNull Stmt node)	it is possible to reach traphandlers through inline code i.e. without any exceptional flow
@NonNull Map<ClassType,Stmt>	exceptionalSuccessors(@NonNull Stmt node)
BasicBlock<?>	getBlockOf(@NonNull Stmt stmt)
@NonNull Collection<? extends BasicBlock<?>>	getBlocks()
@NonNull List<? extends BasicBlock<?>>	getBlocksSorted()
@NonNull 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()
List<BasicBlock<?>>	getTailStmtBlocks()
boolean	hasEdgeConnecting(@NonNull Stmt from, @NonNull 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(@NonNull Stmt stmt)	returns the amount of ingoing flows into node
@NonNull Iterator<Stmt>	iterator()
int	outDegree(@NonNull Stmt stmt)	returns the amount of flows that start from node
@NonNull List<Stmt>	predecessors(@NonNull Stmt stmt)	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`
void	removeExceptionalFlowFromAllBlocks(@NonNull ClassType exceptionType, @NonNull Stmt exceptionHandlerStmt)	Removes the specified exceptional flow from all blocks.
@NonNull List<Stmt>	successors(@NonNull Stmt stmt)	returns the outgoing flows of node as ordered List.

Methods inherited from class sootup.core.graph.ControlFlowGraph

equals, getAllSuccessors, getBlockIterator, getBranchTargetsOf, getEntrypoints, getExtendedBasicBlockPathBetween, 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

protected final @NonNull ControlFlowGraph<V extends BasicBlock<V>> backingGraph

Constructor Details

ForwardingControlFlowGraph

public ForwardingControlFlowGraph(@NonNull ControlFlowGraph<V> backingGraph)

Method Details

getStartingStmt

public Stmt getStartingStmt()

Specified by:

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

getStartingStmtBlock

public BasicBlock<?> getStartingStmtBlock()

Specified by:

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

getTailStmtBlocks

public List<BasicBlock<?>> getTailStmtBlocks()

Specified by:

getTailStmtBlocks in class ControlFlowGraph<V extends BasicBlock<V>>

getBlockOf

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

Specified by:

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

getNodes

public @NonNull Collection<Stmt> getNodes()

Description copied from class: ControlFlowGraph

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 ControlFlowGraph<V extends BasicBlock<V>>

getBlocks

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

Specified by:

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

getBlocksSorted

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

Specified by:

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

containsNode

public boolean containsNode(@NonNull Stmt node)

Specified by:

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

predecessors

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

Description copied from class: ControlFlowGraph

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 ControlFlowGraph<V extends BasicBlock<V>>

exceptionalPredecessors

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

Description copied from class: ControlFlowGraph

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

Specified by:

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

successors

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

Description copied from class: ControlFlowGraph

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

Specified by:

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

exceptionalSuccessors

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

Specified by:

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

degree

public int degree(@NonNull Stmt stmt)

Description copied from class: ControlFlowGraph

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

Overrides:

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

inDegree

public int inDegree(@NonNull Stmt stmt)

Description copied from class: ControlFlowGraph

returns the amount of ingoing flows into node

Specified by:

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

outDegree

public int outDegree(@NonNull Stmt stmt)

Description copied from class: ControlFlowGraph

returns the amount of flows that start from node

Specified by:

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

hasEdgeConnecting

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

Description copied from class: ControlFlowGraph

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 ControlFlowGraph<V extends BasicBlock<V>>

iterator

public @NonNull Iterator<Stmt> iterator()

Specified by:

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

Overrides:

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

removeExceptionalFlowFromAllBlocks

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

Description copied from class: ControlFlowGraph

Removes the specified exceptional flow from all blocks.

Specified by:

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

Parameters:

exceptionType - The class type of the exceptional flow.

exceptionHandlerStmt - The handler statement of the exceptional flow.