Package sootup.core.graph

Class ImmutableBlockStmtGraph

java.lang.Object

sootup.core.graph.StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

sootup.core.graph.ImmutableBlockStmtGraph

All Implemented Interfaces:

Iterable<Stmt>

public class ImmutableBlockStmtGraph
extends StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ImmutableBlockStmtGraph.ImmutableBasicBlock

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

StmtGraph.BlockGraphIterator, StmtGraph.BlockGraphIteratorAndTrapAggregator

Constructor Summary

Constructors

Constructor	Description
ImmutableBlockStmtGraph(MutableStmtGraph graph)

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)
List<Stmt>	exceptionalPredecessors(Stmt node)	it is possible to reach traphandlers through inline code i.e.
Map<ClassType,Stmt>	exceptionalSuccessors(Stmt node)
BasicBlock<ImmutableBlockStmtGraph.ImmutableBasicBlock>	getBlockOf(Stmt stmt)
Collection<ImmutableBlockStmtGraph.ImmutableBasicBlock>	getBlocks()
List<? extends BasicBlock<?>>	getBlocksSorted()
List<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 source, Stmt target)	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 node)	returns the amount of ingoing flows into node
Iterator<Stmt>	iterator()
int	outDegree(Stmt node)	returns the amount of flows that start from node
List<Stmt>	predecessors(Stmt node)	returns the ingoing flows to node as an List with no reliable/specific order and possibly duplicate entries i.e.
void	removeExceptionalFlowFromAllBlocks(ClassType classType, Stmt exceptionHandlerStmt)	Removes the specified exceptional flow from all blocks.
List<Stmt>	successors(Stmt node)	returns the outgoing flows of node as ordered List.

Methods inherited from class sootup.core.graph.StmtGraph

degree, 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

Constructor Details

ImmutableBlockStmtGraph

public ImmutableBlockStmtGraph(@Nonnull
 MutableStmtGraph graph)

Method Details

getStartingStmt

@Nullable
public Stmt getStartingStmt()

Specified by:

getStartingStmt in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

getStartingStmtBlock

public BasicBlock<?> getStartingStmtBlock()

Specified by:

getStartingStmtBlock in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

getBlockOf

public BasicBlock<ImmutableBlockStmtGraph.ImmutableBasicBlock> getBlockOf(@Nonnull
 Stmt stmt)

Specified by:

getBlockOf in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

getNodes

@Nonnull
public List<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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

getBlocks

@Nonnull
public Collection<ImmutableBlockStmtGraph.ImmutableBasicBlock> getBlocks()

Specified by:

getBlocks in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

getBlocksSorted

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

Specified by:

getBlocksSorted in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

containsNode

public boolean containsNode(@Nonnull
 Stmt node)

Specified by:

containsNode in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

predecessors

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

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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

successors

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

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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

exceptionalSuccessors

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

Specified by:

exceptionalSuccessors in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

inDegree

public int inDegree(@Nonnull
 Stmt node)

Description copied from class: StmtGraph

returns the amount of ingoing flows into node

Specified by:

inDegree in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

outDegree

public int outDegree(@Nonnull
 Stmt node)

Description copied from class: StmtGraph

returns the amount of flows that start from node

Specified by:

outDegree in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

hasEdgeConnecting

public boolean hasEdgeConnecting(@Nonnull
 Stmt source,
 @Nonnull
 Stmt target)

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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

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<ImmutableBlockStmtGraph.ImmutableBasicBlock>

removeExceptionalFlowFromAllBlocks

public void removeExceptionalFlowFromAllBlocks(ClassType classType,
 Stmt exceptionHandlerStmt)

Description copied from class: StmtGraph

Removes the specified exceptional flow from all blocks.

Specified by:

removeExceptionalFlowFromAllBlocks in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>

Parameters:

classType - The class type of the exceptional flow.

exceptionHandlerStmt - The handler statement of the exceptional flow.

iterator

@Nonnull
public Iterator<Stmt> iterator()

Specified by:

iterator in interface Iterable<Stmt>

Overrides:

iterator in class StmtGraph<ImmutableBlockStmtGraph.ImmutableBasicBlock>