soot

Class PatchingChain<E extends Unit>

java.lang.Object

java.util.AbstractCollection<E>

soot.PatchingChain<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, Chain<E>

Direct Known Subclasses:

SPatchingChain

public class PatchingChain<E extends Unit>
extends java.util.AbstractCollection<E>
implements Chain<E>

An implementation of a Chain which can contain only Units, and handles patching to deal with element insertions and removals. This is done by calling Unit.redirectJumpsToThisTo at strategic times.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PatchingChain.PatchingIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected Chain<E>	innerChain

Constructor Summary

Constructors

Constructor and Description
PatchingChain(Chain<E> aChain) Constructs a PatchingChain from the given Chain.

Method Summary

Modifier and Type	Method and Description
boolean	add(E o) Adds the given object to this Chain.
void	addFirst(E u) Adds the given object at the beginning of the Chain.
void	addLast(E u) Adds the given object at the end of the Chain.
boolean	contains(java.lang.Object u) Returns true if this patching chain contains the specified element.
boolean	follows(E a, E b) Returns true if object a follows object b in the Chain.
java.util.Collection<E>	getElementsUnsorted() Gets all elements in the chain.
E	getFirst() Returns the first object in this Chain.
E	getLast() Returns the last object in this Chain.
long	getModificationCount() Returns the number of times this chain has been modified.
Chain<E>	getNonPatchingChain() Returns the inner chain used by the PatchingChain.
E	getPredOf(E point) Returns the object immediately preceding point.
E	getSuccOf(E point) Returns the object immediately following point.
void	insertAfter(Chain<E> toInsert, E point) Inserts toInsert in the Chain after point.
void	insertAfter(E toInsert, E point) Inserts toInsert in the Chain after point.
void	insertAfter(java.util.List<E> toInsert, E point) Inserts toInsert in the Chain after point.
void	insertBefore(Chain<E> toInsert, E point) Inserts toInsert in the Chain before point.
void	insertBefore(E toInsert, E point) Inserts toInsert in the Chain before point.
void	insertBefore(java.util.List<E> toInsert, E point) Inserts toInsert in the Chain before point.
void	insertBeforeNoRedirect(E toInsert, E point) Inserts toInsert in the Chain before point WITHOUT redirecting jumps.
void	insertOnEdge(Chain<E> toInsert, E point_src, E point_tgt) Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
void	insertOnEdge(E toInsert, E point_src, E point_tgt) Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
void	insertOnEdge(java.util.List<E> toInsert, E point_src, E point_tgt) Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.
java.util.Iterator<E>	iterator() Returns an iterator over this Chain.
java.util.Iterator<E>	iterator(E u) Returns an iterator over this Chain, starting at the given object.
java.util.Iterator<E>	iterator(E head, E tail) Returns an iterator over this Chain, starting at head and reaching tail (inclusive).
boolean	remove(java.lang.Object obj) Removes the given object from this Chain.
void	removeFirst() Removes the first object from this Chain.
void	removeLast() Removes the last object from this Chain.
int	size() Returns the size of this Chain.
java.util.Iterator<E>	snapshotIterator() Returns an iterator over a copy of this chain.
void	swapWith(E out, E in) Replaces out in the Chain by in.

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

innerChain

protected Chain<E extends Unit> innerChain

Constructor Detail

PatchingChain

public PatchingChain(Chain<E> aChain)

Constructs a PatchingChain from the given Chain.

Method Detail

getNonPatchingChain

public Chain<E> getNonPatchingChain()

Returns the inner chain used by the PatchingChain. In general, this should not be used. However, direct access to the inner chain may be necessary if you wish to perform certain operations (such as control-flow manipulations) without interference from the patching algorithms.

add

public boolean add(E o)

Adds the given object to this Chain.

Specified by:

add in interface java.util.Collection<E extends Unit>

Overrides:

add in class java.util.AbstractCollection<E extends Unit>

swapWith

public void swapWith(E out,
                     E in)

Replaces out in the Chain by in.

Specified by:

swapWith in interface Chain<E extends Unit>

insertAfter

public void insertAfter(E toInsert,
                        E point)

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<E extends Unit>

insertAfter

public void insertAfter(java.util.List<E> toInsert,
                        E point)

Inserts toInsert in the Chain after point.

Specified by:

insertAfter in interface Chain<E extends Unit>

insertAfter

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

Description copied from interface: Chain

Inserts toInsert in the Chain after point. (It would probably be better to make Chain implement List)

Specified by:

insertAfter in interface Chain<E extends Unit>

insertBefore

public void insertBefore(java.util.List<E> toInsert,
                         E point)

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<E extends Unit>

insertBefore

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

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<E extends Unit>

insertBefore

public void insertBefore(E toInsert,
                         E point)

Inserts toInsert in the Chain before point.

Specified by:

insertBefore in interface Chain<E extends Unit>

insertBeforeNoRedirect

public void insertBeforeNoRedirect(E toInsert,
                                   E point)

Inserts toInsert in the Chain before point WITHOUT redirecting jumps.

insertOnEdge

public void insertOnEdge(E toInsert,
                         E point_src,
                         E point_tgt)

Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.

Specified by:

insertOnEdge in interface Chain<E extends Unit>

Parameters:

toInsert - the instrumentation to be added in the Chain

point_src - the source point of an edge in CFG

point_tgt - the target point of an edge

insertOnEdge

public void insertOnEdge(java.util.List<E> toInsert,
                         E point_src,
                         E point_tgt)

Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.

Specified by:

insertOnEdge in interface Chain<E extends Unit>

Parameters:

toInsert - instrumentation to be added in the Chain

point_src - the source point of an edge in CFG

point_tgt - the target point of an edge

insertOnEdge

public void insertOnEdge(Chain<E> toInsert,
                         E point_src,
                         E point_tgt)

Inserts instrumentation in a manner such that the resulting control flow graph (CFG) of the program will contain toInsert on an edge that is defined by point_source and point_target.

Specified by:

insertOnEdge in interface Chain<E extends Unit>

Parameters:

toInsert - instrumentation to be added in the Chain

point_src - the source point of an edge in CFG

point_tgt - the target point of an edge

follows

public boolean follows(E a,
                       E b)

Returns true if object a follows object b in the Chain.

Specified by:

follows in interface Chain<E extends Unit>

remove

public boolean remove(java.lang.Object obj)

Removes the given object from this Chain.

Specified by:

remove in interface java.util.Collection<E extends Unit>

Specified by:

remove in interface Chain<E extends Unit>

Overrides:

remove in class java.util.AbstractCollection<E extends Unit>

contains

public boolean contains(java.lang.Object u)

Returns true if this patching chain contains the specified element.

Specified by:

contains in interface java.util.Collection<E extends Unit>

Overrides:

contains in class java.util.AbstractCollection<E extends Unit>

addFirst

public void addFirst(E u)

Adds the given object at the beginning of the Chain.

Specified by:

addFirst in interface Chain<E extends Unit>

addLast

public void addLast(E u)

Adds the given object at the end of the Chain.

Specified by:

addLast in interface Chain<E extends Unit>

removeFirst

public void removeFirst()

Removes the first object from this Chain.

Specified by:

removeFirst in interface Chain<E extends Unit>

removeLast

public void removeLast()

Removes the last object from this Chain.

Specified by:

removeLast in interface Chain<E extends Unit>

getFirst

public E getFirst()

Returns the first object in this Chain.

Specified by:

getFirst in interface Chain<E extends Unit>

getLast

public E getLast()

Returns the last object in this Chain.

Specified by:

getLast in interface Chain<E extends Unit>

getSuccOf

public E getSuccOf(E point)

Returns the object immediately following point.

Specified by:

getSuccOf in interface Chain<E extends Unit>

getPredOf

public E getPredOf(E point)

Returns the object immediately preceding point.

Specified by:

getPredOf in interface Chain<E extends Unit>

snapshotIterator

public java.util.Iterator<E> snapshotIterator()

Returns an iterator over a copy of this chain. This avoids ConcurrentModificationExceptions from being thrown if the underlying Chain is modified during iteration. Do not use this to remove elements which have not yet been iterated over!

Specified by:

snapshotIterator in interface Chain<E extends Unit>

iterator

public java.util.Iterator<E> iterator()

Returns an iterator over this Chain.

Specified by:

iterator in interface java.lang.Iterable<E extends Unit>

Specified by:

iterator in interface java.util.Collection<E extends Unit>

Specified by:

iterator in interface Chain<E extends Unit>

Specified by:

iterator in class java.util.AbstractCollection<E extends Unit>

iterator

public java.util.Iterator<E> iterator(E u)

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

Specified by:

iterator in interface Chain<E extends Unit>

iterator

public java.util.Iterator<E> iterator(E head,
                                      E tail)

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

Specified by:

iterator in interface Chain<E extends Unit>

size

public int size()

Returns the size of this Chain.

Specified by:

size in interface java.util.Collection<E extends Unit>

Specified by:

size in interface Chain<E extends Unit>

Specified by:

size in class java.util.AbstractCollection<E extends Unit>

getModificationCount

public long getModificationCount()

Description copied from interface: Chain

Returns the number of times this chain has been modified.

Specified by:

getModificationCount in interface Chain<E extends Unit>

getElementsUnsorted

public java.util.Collection<E> getElementsUnsorted()

Description copied from interface: Chain

Gets all elements in the chain. There is no guarantee on sorting. On the other hand, the collection returned by this method is thread-safe. You can iterate over it even in the case of concurrent modifications to the underlying chain.

Specified by:

getElementsUnsorted in interface Chain<E extends Unit>

Returns:

All elements in the chain in an unsorted collection