soot.shimple.internal

Class SPatchingChain

java.lang.Object

java.util.AbstractCollection<E>

soot.PatchingChain<Unit>

soot.UnitPatchingChain

soot.shimple.internal.SPatchingChain

All Implemented Interfaces:

Serializable, Iterable<Unit>, Collection<Unit>, Chain<Unit>

public class SPatchingChain
extends UnitPatchingChain

Internal Shimple extension of PatchingChain.

Author:

Navindra Umanee

See Also:

PatchingChain, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SPatchingChain.SPatchingIterator

Nested classes/interfaces inherited from class soot.PatchingChain

PatchingChain.PatchingIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected Body	body Needed to find non-trapped Units of the body.
protected Map<SUnitBox,Boolean>	boxToNeedsPatching Flag that indicates whether control flow falls through from the unit referenced in the SUnitBox to the Phi node that owns the SUnitBox.
protected Map<UnitBox,Unit>	boxToPhiNode Map from UnitBox to the Phi node owning it.
protected boolean	debug
protected Set<Unit>	phiNodeSet Set of the values of boxToPhiNode.

Fields inherited from class soot.PatchingChain

innerChain

Constructor Summary

Constructors

Constructor and Description
SPatchingChain(Body aBody, Chain<Unit> aChain)

Method Summary

Modifier and Type	Method and Description
boolean	add(Unit o) Adds the given object to this Chain.
void	addFirst(Unit u) Adds the given object at the beginning of the Chain.
void	addLast(Unit u) Adds the given object at the end of the Chain.
protected void	computeNeedsPatching() Computes boxToNeedsPatching which maps each UnitBox from a PhiExpr to true if the referenced Unit falls-through to the statement containing the PhiExpr, false otherwise.
protected SUnitBox	getSBox(UnitBox box)
void	insertAfter(Chain<Unit> toInsert, Unit point) Inserts toInsert in the Chain after point.
void	insertAfter(Collection<? extends Unit> toInsert, Unit point) Inserts toInsert in the Chain after point.
void	insertAfter(List<Unit> toInsert, Unit point) Inserts toInsert in the Chain after point.
void	insertAfter(Unit toInsert, Unit point) Inserts toInsert in the Chain after point.
void	insertBefore(Chain<Unit> toInsert, Unit point) Inserts toInsert in the Chain before point.
void	insertBefore(Collection<? extends Unit> toInsert, Unit point) Inserts toInsert in the Chain before point.
void	insertBefore(List<Unit> toInsert, Unit point) Inserts toInsert in the Chain before point.
void	insertBefore(Unit toInsert, Unit point) Inserts toInsert in the Chain before point.
Iterator<Unit>	iterator() Returns an iterator over this Chain.
Iterator<Unit>	iterator(Unit u) Returns an iterator over this Chain, starting at the given object.
Iterator<Unit>	iterator(Unit head, Unit tail) Returns an iterator over this Chain, starting at head and reaching tail (inclusive).
protected static void	patchAfterRemoval(Unit removing)
protected void	processPhiNode(Unit phiNode)
boolean	remove(Object obj) Removes the given object from this Chain.
boolean	remove(Unit u)
protected void	reprocessPhiNodes()
void	swapWith(Unit out, Unit in) Replaces out in the Chain by in.

Methods inherited from class soot.UnitPatchingChain

insertOnEdge, insertOnEdge, insertOnEdge, insertOnEdge

Methods inherited from class soot.PatchingChain

contains, follows, getElementsUnsorted, getFirst, getLast, getModificationCount, getNonPatchingChain, getPredOf, getSuccOf, insertBeforeNoRedirect, insertBeforeNoRedirect, patchBeforeRemoval, removeFirst, removeLast, size, snapshotIterator

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

body

protected final Body body

Needed to find non-trapped Units of the body.

debug

protected final boolean debug

boxToPhiNode

protected Map<UnitBox,Unit> boxToPhiNode

Map from UnitBox to the Phi node owning it.

phiNodeSet

protected Set<Unit> phiNodeSet

Set of the values of boxToPhiNode. Used to allow O(1) contains() on the values.

boxToNeedsPatching

protected Map<SUnitBox,Boolean> boxToNeedsPatching

Flag that indicates whether control flow falls through from the unit referenced in the SUnitBox to the Phi node that owns the SUnitBox.

Constructor Detail

SPatchingChain

public SPatchingChain(Body aBody,
                      Chain<Unit> aChain)

Method Detail

add

public boolean add(Unit o)

Description copied from class: PatchingChain

Adds the given object to this Chain.

Specified by:

add in interface Collection<Unit>

Overrides:

add in class PatchingChain<Unit>

swapWith

public void swapWith(Unit out,
                     Unit in)

Description copied from class: PatchingChain

Replaces out in the Chain by in.

Specified by:

swapWith in interface Chain<Unit>

Overrides:

swapWith in class PatchingChain<Unit>

insertAfter

public void insertAfter(Unit toInsert,
                        Unit point)

Description copied from class: PatchingChain

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<Unit>

Overrides:

insertAfter in class PatchingChain<Unit>

insertAfter

public void insertAfter(List<Unit> toInsert,
                        Unit point)

Description copied from class: PatchingChain

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<Unit>

Overrides:

insertAfter in class PatchingChain<Unit>

insertAfter

public void insertAfter(Chain<Unit> toInsert,
                        Unit point)

Description copied from interface: Chain

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<Unit>

Overrides:

insertAfter in class PatchingChain<Unit>

insertAfter

public void insertAfter(Collection<? extends Unit> toInsert,
                        Unit point)

Description copied from interface: Chain

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<Unit>

Overrides:

insertAfter in class PatchingChain<Unit>

insertBefore

public void insertBefore(Unit toInsert,
                         Unit point)

Description copied from class: PatchingChain

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<Unit>

Overrides:

insertBefore in class PatchingChain<Unit>

insertBefore

public void insertBefore(List<Unit> toInsert,
                         Unit point)

Description copied from class: PatchingChain

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<Unit>

Overrides:

insertBefore in class PatchingChain<Unit>

insertBefore

public void insertBefore(Chain<Unit> toInsert,
                         Unit point)

Description copied from class: PatchingChain

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<Unit>

Overrides:

insertBefore in class PatchingChain<Unit>

insertBefore

public void insertBefore(Collection<? extends Unit> toInsert,
                         Unit point)

Description copied from interface: Chain

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<Unit>

Overrides:

insertBefore in class PatchingChain<Unit>

addFirst

public void addFirst(Unit u)

Description copied from class: PatchingChain

Adds the given object at the beginning of the Chain.

Specified by:

addFirst in interface Chain<Unit>

Overrides:

addFirst in class PatchingChain<Unit>

addLast

public void addLast(Unit u)

Description copied from class: PatchingChain

Adds the given object at the end of the Chain.

Specified by:

addLast in interface Chain<Unit>

Overrides:

addLast in class PatchingChain<Unit>

remove

public boolean remove(Unit u)

remove

public boolean remove(Object obj)

Description copied from class: PatchingChain

Removes the given object from this Chain.

Specified by:

remove in interface Collection<Unit>

Specified by:

remove in interface Chain<Unit>

Overrides:

remove in class PatchingChain<Unit>

patchAfterRemoval

protected static void patchAfterRemoval(Unit removing)

processPhiNode

protected void processPhiNode(Unit phiNode)

reprocessPhiNodes

protected void reprocessPhiNodes()

computeNeedsPatching

protected void computeNeedsPatching()

Computes boxToNeedsPatching which maps each UnitBox from a PhiExpr to true if the referenced Unit falls-through to the statement containing the PhiExpr, false otherwise. NOTE: This will *miss* all the Phi nodes outside a chain. So make sure you know what you are doing if you remove a Phi node from a chain and don't put it back or call clearUnitBoxes() on it.

getSBox

protected SUnitBox getSBox(UnitBox box)

iterator

public Iterator<Unit> iterator()

Description copied from class: PatchingChain

Returns an iterator over this Chain.

Specified by:

iterator in interface Iterable<Unit>

Specified by:

iterator in interface Collection<Unit>

Specified by:

iterator in interface Chain<Unit>

Overrides:

iterator in class PatchingChain<Unit>

iterator

public Iterator<Unit> iterator(Unit u)

Description copied from class: PatchingChain

Returns an iterator over this Chain, starting at the given object.

Specified by:

iterator in interface Chain<Unit>

Overrides:

iterator in class PatchingChain<Unit>

iterator

public Iterator<Unit> iterator(Unit head,
                               Unit tail)

Description copied from class: PatchingChain

Returns an iterator over this Chain, starting at head and reaching tail (inclusive).

Specified by:

iterator in interface Chain<Unit>

Overrides:

iterator in class PatchingChain<Unit>