soot

Class Scene

java.lang.Object

soot.Scene

public class Scene
extends java.lang.Object

Manages the SootClasses of the application being analyzed.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedList<java.lang.String>	excludedPackages

Constructor Summary

Constructors

Constructor and Description
Scene(Singletons.Global g)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBasicClass(java.lang.String name)
void	addBasicClass(java.lang.String name, int level)
void	addClass(SootClass c)
void	addRefType(RefType type) Returns the RefType with the given className.
boolean	allowsPhantomRefs()
boolean	containsClass(java.lang.String className)
boolean	containsField(java.lang.String fieldSignature)
boolean	containsMethod(java.lang.String methodSignature)
boolean	containsType(java.lang.String className)
java.lang.String	defaultClassPath()
boolean	doneResolving()
java.util.Collection<SootClass>	dynamicClasses()
SootClass	forceResolve(java.lang.String className, int level)
Hierarchy	getActiveHierarchy() Retrieves the active hierarchy
int	getAndroidAPIVersion(java.lang.String jars, java.lang.String apk)
java.lang.String	getAndroidJarPath(java.lang.String jars, java.lang.String apk)
Chain<SootClass>	getApplicationClasses() Returns a chain of the application classes in this scene.
java.util.Set<java.lang.String>	getBasicClasses()
CallGraph	getCallGraph()
Chain<SootClass>	getClasses() Returns an backed chain of the classes in this manager.
java.util.List<SootClass>	getClasses(int desiredLevel) Returns the list of SootClasses that have been resolved at least to the level specified.
ArrayNumberer<SootClass>	getClassNumberer()
Numberer<Context>	getContextNumberer()
ContextSensitiveCallGraph	getContextSensitiveCallGraph()
ThrowAnalysis	getDefaultThrowAnalysis() Returns the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.
java.util.List<SootMethod>	getEntryPoints() Get the set of entry points that are used to build the call graph.
FastHierarchy	getFastHierarchy() Retrieves the active fast hierarchy
SootField	getField(java.lang.String fieldSignature)
Numberer<SparkField>	getFieldNumberer()
Chain<SootClass>	getLibraryClasses() Returns a chain of the library classes in this scene.
ArrayNumberer<Local>	getLocalNumberer()
SootClass	getMainClass()
SootMethod	getMainMethod()
SootMethod	getMethod(java.lang.String methodSignature)
ArrayNumberer<SootMethod>	getMethodNumberer()
RefType	getObjectType() Returns the RefType for Object.
FastHierarchy	getOrMakeFastHierarchy() Makes a new fast hierarchy is none is active, and returns the active fast hierarchy.
Chain<SootClass>	getPhantomClasses() Returns a chain of the phantom classes in this scene.
boolean	getPhantomRefs()
java.util.List<java.lang.String>	getPkgList()
PointsToAnalysis	getPointsToAnalysis() Retrieves the active pointer analysis
ReachableMethods	getReachableMethods()
RefType	getRefType(java.lang.String className) Returns the RefType with the given className.
RefType	getRefTypeUnsafe(java.lang.String className) Returns the RefType with the given className.
java.util.Set<java.lang.String>	getReservedNames() Returns a set of tokens which are reserved.
SideEffectAnalysis	getSideEffectAnalysis() Retrieves the active side-effect analysis
SootClass	getSootClass(java.lang.String className) Returns the SootClass with the given className.
java.lang.String	getSootClassPath()
SootClass	getSootClassUnsafe(java.lang.String className) Returns the SootClass with the given className.
int	getState()
StringNumberer	getSubSigNumberer()
ArrayNumberer<Type>	getTypeNumberer()
Numberer<Unit>	getUnitNumberer()
SootField	grabField(java.lang.String fieldSignature)
SootMethod	grabMethod(java.lang.String methodSignature)
boolean	hasActiveHierarchy()
boolean	hasCallGraph()
boolean	hasCustomEntryPoints()
boolean	hasFastHierarchy()
boolean	hasMainClass()
boolean	hasPointsToAnalysis()
boolean	hasReachableMethods()
boolean	hasSideEffectAnalysis()
void	incrementalBuildFinished()
void	initiateIncrementalBuild()
boolean	isExcluded(SootClass sc)
boolean	isIncluded(SootClass sc)
boolean	isIncrementalBuild() This method returns true when in incremental build mode.
Numberer<Kind>	kindNumberer()
void	loadBasicClasses() Load just the set of basic classes soot needs, ignoring those specified on the command-line.
SootClass	loadClass(java.lang.String className, int desiredLevel)
SootClass	loadClassAndSupport(java.lang.String className) Loads the given class and all of the required support classes.
void	loadDynamicClasses()
void	loadNecessaryClasses() Load the set of classes that soot needs, including those specified on the command-line.
SootMethodRef	makeConstructorRef(SootClass declaringClass, java.util.List<Type> parameterTypes) Create an unresolved reference to a constructor.
SootFieldRef	makeFieldRef(SootClass declaringClass, java.lang.String name, Type type, boolean isStatic) Create an unresolved reference to a field.
SootMethodRef	makeMethodRef(SootClass declaringClass, java.lang.String name, java.util.List<Type> parameterTypes, Type returnType, boolean isStatic) Create an unresolved reference to a method.
java.lang.String	quotedNameOf(java.lang.String s) If this name is in the set of reserved names, then return a quoted version of it.
void	releaseActiveHierarchy()
void	releaseCallGraph()
void	releaseFastHierarchy()
void	releasePointsToAnalysis()
void	releaseReachableMethods()
void	releaseSideEffectAnalysis()
void	removeClass(SootClass c)
void	setActiveHierarchy(Hierarchy hierarchy) Sets the active hierarchy
void	setCallGraph(CallGraph cg)
void	setContextNumberer(Numberer<Context> n)
void	setContextSensitiveCallGraph(ContextSensitiveCallGraph cscg)
void	setDefaultThrowAnalysis(ThrowAnalysis ta) Sets the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.
void	setDoneResolving()
void	setEntryPoints(java.util.List<SootMethod> entryPoints) Change the set of entry point methods used to build the call graph.
void	setFastHierarchy(FastHierarchy hierarchy) Sets the active hierarchy
void	setMainClass(SootClass m)
void	setMainClassFromOptions()
void	setPhantomRefs(boolean value)
void	setPkgList(java.util.List<java.lang.String> list)
void	setPointsToAnalysis(PointsToAnalysis pa) Sets the active pointer analysis
void	setReachableMethods(ReachableMethods rm)
void	setSideEffectAnalysis(SideEffectAnalysis sea) Sets the active side-effect analysis
void	setSootClassPath(java.lang.String p)
java.lang.String	signatureToClass(java.lang.String sig)
java.lang.String	signatureToSubsignature(java.lang.String sig)
SootClass	tryLoadClass(java.lang.String className, int desiredLevel) Attempts to load the given class and all of the required support classes.
static Scene	v()

Methods inherited from class java.lang.Object

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

Field Detail

excludedPackages

protected java.util.LinkedList<java.lang.String> excludedPackages

Constructor Detail

Scene

public Scene(Singletons.Global g)

Method Detail

v

public static Scene v()

setMainClass

public void setMainClass(SootClass m)

getReservedNames

public java.util.Set<java.lang.String> getReservedNames()

Returns a set of tokens which are reserved. Any field, class, method, or local variable with such a name will be quoted.

quotedNameOf

public java.lang.String quotedNameOf(java.lang.String s)

If this name is in the set of reserved names, then return a quoted version of it. Else pass it through.

hasMainClass

public boolean hasMainClass()

getMainClass

public SootClass getMainClass()

getMainMethod

public SootMethod getMainMethod()

setSootClassPath

public void setSootClassPath(java.lang.String p)

getSootClassPath

public java.lang.String getSootClassPath()

getAndroidJarPath

public java.lang.String getAndroidJarPath(java.lang.String jars,
                                 java.lang.String apk)

getAndroidAPIVersion

public int getAndroidAPIVersion(java.lang.String jars,
                       java.lang.String apk)

defaultClassPath

public java.lang.String defaultClassPath()

getState

public int getState()

addClass

public void addClass(SootClass c)

removeClass

public void removeClass(SootClass c)

containsClass

public boolean containsClass(java.lang.String className)

containsType

public boolean containsType(java.lang.String className)

signatureToClass

public java.lang.String signatureToClass(java.lang.String sig)

signatureToSubsignature

public java.lang.String signatureToSubsignature(java.lang.String sig)

grabField

public SootField grabField(java.lang.String fieldSignature)

containsField

public boolean containsField(java.lang.String fieldSignature)

grabMethod

public SootMethod grabMethod(java.lang.String methodSignature)

containsMethod

public boolean containsMethod(java.lang.String methodSignature)

getField

public SootField getField(java.lang.String fieldSignature)

getMethod

public SootMethod getMethod(java.lang.String methodSignature)

tryLoadClass

public SootClass tryLoadClass(java.lang.String className,
                     int desiredLevel)

Attempts to load the given class and all of the required support classes. Returns the original class if it was loaded, or null otherwise.

loadClassAndSupport

public SootClass loadClassAndSupport(java.lang.String className)

Loads the given class and all of the required support classes. Returns the first class.

loadClass

public SootClass loadClass(java.lang.String className,
                  int desiredLevel)

getRefType

public RefType getRefType(java.lang.String className)

Returns the RefType with the given className.

Throws:

java.lang.IllegalStateException - if the RefType for this class cannot be found. Use containsType(String) to check if type is registered

getRefTypeUnsafe

public RefType getRefTypeUnsafe(java.lang.String className)

Returns the RefType with the given className. Returns null if no type with the given name can be found.

getObjectType

public RefType getObjectType()

Returns the RefType for Object.

addRefType

public void addRefType(RefType type)

Returns the RefType with the given className.

getSootClassUnsafe

public SootClass getSootClassUnsafe(java.lang.String className)

Returns the SootClass with the given className. If no class with the given name exists, null is returned

Parameters:

className - The name of the class to get

Returns:

The class if it exists, otherwise null

getSootClass

public SootClass getSootClass(java.lang.String className)

Returns the SootClass with the given className.

getClasses

public Chain<SootClass> getClasses()

Returns an backed chain of the classes in this manager.

getApplicationClasses

public Chain<SootClass> getApplicationClasses()

Returns a chain of the application classes in this scene. These classes are the ones which can be freely analysed & modified.

getLibraryClasses

public Chain<SootClass> getLibraryClasses()

Returns a chain of the library classes in this scene. These classes can be analysed but not modified.

getPhantomClasses

public Chain<SootClass> getPhantomClasses()

Returns a chain of the phantom classes in this scene. These classes are referred to by other classes, but cannot be loaded.

getSideEffectAnalysis

public SideEffectAnalysis getSideEffectAnalysis()

Retrieves the active side-effect analysis

setSideEffectAnalysis

public void setSideEffectAnalysis(SideEffectAnalysis sea)

Sets the active side-effect analysis

hasSideEffectAnalysis

public boolean hasSideEffectAnalysis()

releaseSideEffectAnalysis

public void releaseSideEffectAnalysis()

getPointsToAnalysis

public PointsToAnalysis getPointsToAnalysis()

Retrieves the active pointer analysis

setPointsToAnalysis

public void setPointsToAnalysis(PointsToAnalysis pa)

Sets the active pointer analysis

hasPointsToAnalysis

public boolean hasPointsToAnalysis()

releasePointsToAnalysis

public void releasePointsToAnalysis()

getOrMakeFastHierarchy

public FastHierarchy getOrMakeFastHierarchy()

Makes a new fast hierarchy is none is active, and returns the active fast hierarchy.

getFastHierarchy

public FastHierarchy getFastHierarchy()

Retrieves the active fast hierarchy

setFastHierarchy

public void setFastHierarchy(FastHierarchy hierarchy)

Sets the active hierarchy

hasFastHierarchy

public boolean hasFastHierarchy()

releaseFastHierarchy

public void releaseFastHierarchy()

getActiveHierarchy

public Hierarchy getActiveHierarchy()

Retrieves the active hierarchy

setActiveHierarchy

public void setActiveHierarchy(Hierarchy hierarchy)

Sets the active hierarchy

hasActiveHierarchy

public boolean hasActiveHierarchy()

releaseActiveHierarchy

public void releaseActiveHierarchy()

hasCustomEntryPoints

public boolean hasCustomEntryPoints()

getEntryPoints

public java.util.List<SootMethod> getEntryPoints()

Get the set of entry points that are used to build the call graph.

setEntryPoints

public void setEntryPoints(java.util.List<SootMethod> entryPoints)

Change the set of entry point methods used to build the call graph.

getContextSensitiveCallGraph

public ContextSensitiveCallGraph getContextSensitiveCallGraph()

setContextSensitiveCallGraph

public void setContextSensitiveCallGraph(ContextSensitiveCallGraph cscg)

getCallGraph

public CallGraph getCallGraph()

setCallGraph

public void setCallGraph(CallGraph cg)

hasCallGraph

public boolean hasCallGraph()

releaseCallGraph

public void releaseCallGraph()

getReachableMethods

public ReachableMethods getReachableMethods()

setReachableMethods

public void setReachableMethods(ReachableMethods rm)

hasReachableMethods

public boolean hasReachableMethods()

releaseReachableMethods

public void releaseReachableMethods()

getPhantomRefs

public boolean getPhantomRefs()

setPhantomRefs

public void setPhantomRefs(boolean value)

allowsPhantomRefs

public boolean allowsPhantomRefs()

kindNumberer

public Numberer<Kind> kindNumberer()

getTypeNumberer

public ArrayNumberer<Type> getTypeNumberer()

getMethodNumberer

public ArrayNumberer<SootMethod> getMethodNumberer()

getContextNumberer

public Numberer<Context> getContextNumberer()

getUnitNumberer

public Numberer<Unit> getUnitNumberer()

getFieldNumberer

public Numberer<SparkField> getFieldNumberer()

getClassNumberer

public ArrayNumberer<SootClass> getClassNumberer()

getSubSigNumberer

public StringNumberer getSubSigNumberer()

getLocalNumberer

public ArrayNumberer<Local> getLocalNumberer()

setContextNumberer

public void setContextNumberer(Numberer<Context> n)

getDefaultThrowAnalysis

public ThrowAnalysis getDefaultThrowAnalysis()

Returns the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.

Returns:

the default ThrowAnalysis

setDefaultThrowAnalysis

public void setDefaultThrowAnalysis(ThrowAnalysis ta)

Sets the ThrowAnalysis to be used by default when constructing CFGs which include exceptional control flow.

Parameters:

ta - the default ThrowAnalysis.

addBasicClass

public void addBasicClass(java.lang.String name)

addBasicClass

public void addBasicClass(java.lang.String name,
                 int level)

loadBasicClasses

public void loadBasicClasses()

Load just the set of basic classes soot needs, ignoring those specified on the command-line. You don't need to use both this and loadNecessaryClasses, though it will only waste time.

getBasicClasses

public java.util.Set<java.lang.String> getBasicClasses()

dynamicClasses

public java.util.Collection<SootClass> dynamicClasses()

loadNecessaryClasses

public void loadNecessaryClasses()

Load the set of classes that soot needs, including those specified on the command-line. This is the standard way of initialising the list of classes soot should use.

loadDynamicClasses

public void loadDynamicClasses()

isExcluded

public boolean isExcluded(SootClass sc)

isIncluded

public boolean isIncluded(SootClass sc)

setPkgList

public void setPkgList(java.util.List<java.lang.String> list)

getPkgList

public java.util.List<java.lang.String> getPkgList()

makeMethodRef

public SootMethodRef makeMethodRef(SootClass declaringClass,
                          java.lang.String name,
                          java.util.List<Type> parameterTypes,
                          Type returnType,
                          boolean isStatic)

Create an unresolved reference to a method.

makeConstructorRef

public SootMethodRef makeConstructorRef(SootClass declaringClass,
                               java.util.List<Type> parameterTypes)

Create an unresolved reference to a constructor.

makeFieldRef

public SootFieldRef makeFieldRef(SootClass declaringClass,
                        java.lang.String name,
                        Type type,
                        boolean isStatic)

Create an unresolved reference to a field.

getClasses

public java.util.List<SootClass> getClasses(int desiredLevel)

Returns the list of SootClasses that have been resolved at least to the level specified.

doneResolving

public boolean doneResolving()

setDoneResolving

public void setDoneResolving()

setMainClassFromOptions

public void setMainClassFromOptions()

isIncrementalBuild

public boolean isIncrementalBuild()

This method returns true when in incremental build mode. Other classes can query this flag and change the way in which they use the Scene, depending on the flag's value.

initiateIncrementalBuild

public void initiateIncrementalBuild()

incrementalBuildFinished

public void incrementalBuildFinished()

forceResolve

public SootClass forceResolve(java.lang.String className,
                     int level)