Package soot

Class ModuleScene

java.lang.Object

soot.Scene

soot.ModuleScene

public class ModuleScene
extends Scene

Manages the SootClasses of the application being analyzed for Java 9 modules.

Author:

Andreas Dann

Nested Class Summary

Nested classes/interfaces inherited from class soot.Scene

Scene.AndroidVersionInfo

Field Summary

Fields inherited from class soot.Scene

accessibilityOracle, activeCallGraph, activeFastHierarchy, activeHierarchy, activePointsToAnalysis, activeSideEffectAnalysis, allowsPhantomRefs, applicationClasses, basicclasses, classAddedListeners, classes, cscg, doneResolving, dynamicClasses, entryPoints, excludedPackages, incrementalBuild, libraryClasses, mainClass, phantomClasses, reachableMethods, reservedNames, sootClassPath, subSigNumberer, typeNumberer

Constructor Summary

Constructors

Constructor	Description
ModuleScene(Singletons.Global g)

Method Summary

Modifier and Type	Method	Description
protected void	addClassSilent(SootClass c)	Adds the given class to the Scene.
void	addRefType(RefType type)
boolean	containsClass(String className)
boolean	containsClass(String className, com.google.common.base.Optional<String> moduleName)
boolean	containsType(String className)
void	extendSootClassPath(String newPathElement)
void	extendSootModulePath(String newPathElement)
SootClass	forceResolve(String className, int level)	Forces Soot to resolve the class with the given name to the given level, even if resolving has actually already finished.
SootClass	forceResolve(String className, int level, com.google.common.base.Optional<String> moduleName)
SootMethod	getMainMethod()
RefType	getObjectType()	Returns the RefType for Object.
RefType	getOrAddRefType(String className, com.google.common.base.Optional<String> moduleName)
RefType	getOrAddRefType(RefType tp)
RefType	getRefType(String className)	Returns the RefType with the given className.
RefType	getRefType(String className, com.google.common.base.Optional<String> moduleName)	Returns the RefType with the given className.
RefType	getRefTypeUnsafe(String className)	Returns the RefType with the given className.
RefType	getRefTypeUnsafe(String className, com.google.common.base.Optional<String> moduleName)	Returns the RefType with the given className.
SootClass	getSootClass(String className)	Returns the SootClass with the given className.
SootClass	getSootClass(String className, com.google.common.base.Optional<String> moduleName)
String	getSootClassPath()
SootClass	getSootClassUnsafe(String className)	Returns the SootClass with the given className.
SootClass	getSootClassUnsafe(String className, com.google.common.base.Optional<String> moduleName)
String	getSootModulePath()
Type	getType(String arg, com.google.common.base.Optional<String> moduleName)	Returns the RefType with the given class name or primitive type.
void	loadBasicClasses()	Load just the set of basic classes soot needs, ignoring those specified on the command-line.
SootClass	loadClass(String className, int desiredLevel)
SootClass	loadClass(String className, int desiredLevel, com.google.common.base.Optional<String> moduleName)
SootClass	loadClassAndSupport(String className)	Loads the given class and all of the required support classes.
SootClass	loadClassAndSupport(String className, com.google.common.base.Optional<String> moduleName)
void	loadDynamicClasses()
void	loadNecessaryClasses()	Load the set of classes that soot needs, including those specified on the command-line.
SootClass	makeSootClass(String className)
SootClass	makeSootClass(String name, String moduleName)
protected void	prepareClasses()	Generate classes to process, adding or removing package marked by command line options.
void	setMainClassFromOptions()
void	setSootClassPath(String p)
void	setSootModulePath(String p)
SootClass	tryLoadClass(String className, int desiredLevel, com.google.common.base.Optional<String> moduleName)	Attempts to load the given class and all of the required support classes.
static ModuleScene	v()

Methods inherited from class soot.Scene

addBasicClass, addBasicClass, addClass, addReflectionTraceClasses, allowsPhantomRefs, containsField, containsMethod, createLocalCreation, createLocalCreation, createLocalGenerator, defaultClassPath, defaultJavaClassPath, doneResolving, dynamicClasses, getActiveHierarchy, getAndroidAPIVersion, getAndroidJarPath, getAndroidSDKVersionInfo, getApplicationClasses, getBaseExceptionType, getBasicClasses, getCallGraph, getClasses, getClasses, getClientAccessibilityOracle, getContextSensitiveCallGraph, getDefaultThrowAnalysis, getEntryPoints, getFastHierarchy, getField, getLibraryClasses, getMainClass, getMethod, getOrAddRefType, getOrMakeFastHierarchy, getPhantomClasses, getPhantomRefs, getPkgList, getPointsToAnalysis, getReachableMethods, getReservedNames, getSideEffectAnalysis, getSootClassUnsafe, getState, getSubSigNumberer, getType, getTypeNumberer, getTypeUnsafe, getTypeUnsafe, grabField, grabMethod, hasActiveHierarchy, hasCallGraph, hasClientAccessibilityOracle, hasCustomEntryPoints, hasFastHierarchy, hasMainClass, hasPointsToAnalysis, hasReachableMethods, hasSideEffectAnalysis, incrementalBuildFinished, initiateIncrementalBuild, internalMakeCallGraph, isApk, isBasicClass, isExcluded, isExcluded, isIncluded, isIncluded, isIncrementalBuild, isJavaGEQ9, loadNecessaryClass, makeConstructorRef, makeFieldRef, makeMethodRef, makeMethodRef, makeMethodRef, makeSootClass, makeSootField, makeSootField, makeSootMethod, makeSootMethod, makeSootMethod, modifyHierarchy, quotedNameOf, registerSootClassAddedListener, releaseActiveHierarchy, releaseCallGraph, releaseClientAccessibilityOracle, releaseFastHierarchy, releasePointsToAnalysis, releaseReachableMethods, releaseSideEffectAnalysis, removeClass, reset, resetSootClassPathCache, setActiveHierarchy, setCallGraph, setClientAccessibilityOracle, setContextSensitiveCallGraph, setDefaultThrowAnalysis, setDoneResolving, setEntryPoints, setFastHierarchy, setMainClass, setPhantomRefs, setPkgList, setPointsToAnalysis, setReachableMethods, setResolving, setSideEffectAnalysis, signatureToClass, signatureToSubsignature, tryLoadClass, unescapeName, unregisterSootClassAddedListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleScene

public ModuleScene(Singletons.Global g)

Method Detail

v

public static ModuleScene v()

getMainMethod

public SootMethod getMainMethod()

Overrides:

getMainMethod in class Scene

extendSootClassPath

public void extendSootClassPath(String newPathElement)

Overrides:

extendSootClassPath in class Scene

extendSootModulePath

public void extendSootModulePath(String newPathElement)

getSootClassPath

public String getSootClassPath()

Overrides:

getSootClassPath in class Scene

setSootClassPath

public void setSootClassPath(String p)

Overrides:

setSootClassPath in class Scene

getSootModulePath

public String getSootModulePath()

setSootModulePath

public void setSootModulePath(String p)

addClassSilent

protected void addClassSilent(SootClass c)

Description copied from class: Scene

Adds the given class to the Scene. This method does not handle any dependencies such as invalidating the hierarchy. The class is neither marked as application class, nor library class.

Overrides:

addClassSilent in class Scene

Parameters:

c - The class to add

containsClass

public boolean containsClass(String className)

Overrides:

containsClass in class Scene

containsClass

public boolean containsClass(String className,
                             com.google.common.base.Optional<String> moduleName)

containsType

public boolean containsType(String className)

Overrides:

containsType in class Scene

tryLoadClass

public SootClass tryLoadClass(String className,
                              int desiredLevel,
                              com.google.common.base.Optional<String> moduleName)

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(String className)

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

Overrides:

loadClassAndSupport in class Scene

loadClassAndSupport

public SootClass loadClassAndSupport(String className,
                                     com.google.common.base.Optional<String> moduleName)

loadClass

public SootClass loadClass(String className,
                           int desiredLevel)

Overrides:

loadClass in class Scene

loadClass

public SootClass loadClass(String className,
                           int desiredLevel,
                           com.google.common.base.Optional<String> moduleName)

getType

public Type getType(String arg,
                    com.google.common.base.Optional<String> moduleName)

Returns the RefType with the given class name or primitive type.

Throws:

RuntimeException - if the Type for this name cannot be found. Use getRefTypeUnsafe(String, Optional) to check if type is an registered RefType.

getRefType

public RefType getRefType(String className,
                          com.google.common.base.Optional<String> moduleName)

Returns the RefType with the given className.

Throws:

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

getRefType

public RefType getRefType(String className)

Description copied from class: Scene

Returns the RefType with the given className.

Overrides:

getRefType in class Scene

getObjectType

public RefType getObjectType()

Description copied from class: Scene

Returns the RefType for Object.

Overrides:

getObjectType in class Scene

getRefTypeUnsafe

public RefType getRefTypeUnsafe(String className,
                                com.google.common.base.Optional<String> moduleName)

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

getRefTypeUnsafe

public RefType getRefTypeUnsafe(String className)

Description copied from class: Scene

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

Overrides:

getRefTypeUnsafe in class Scene

addRefType

public void addRefType(RefType type)

getSootClassUnsafe

public SootClass getSootClassUnsafe(String className)

Description copied from class: Scene

Returns the SootClass with the given className. If no class with the given name exists, null is returned unless phantom refs are allowed. In this case, a new phantom class is created. The difference with the getSootClass() version is that this version doesn't throw a RuntimeException if the requested class doesn't exist in the Scene. Instead it returns null.

Overrides:

getSootClassUnsafe in class Scene

Parameters:

className - The name of the class to get

Returns:

The class if it exists, otherwise null

getSootClassUnsafe

public SootClass getSootClassUnsafe(String className,
                                    com.google.common.base.Optional<String> moduleName)

getSootClass

public SootClass getSootClass(String className)

Description copied from class: Scene

Returns the SootClass with the given className.

Overrides:

getSootClass in class Scene

Parameters:

className - The name of the class to get; throws RuntimeException if this class does not exist.

getSootClass

public SootClass getSootClass(String className,
                              com.google.common.base.Optional<String> moduleName)

loadBasicClasses

public void loadBasicClasses()

Description copied from class: Scene

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 Scene.loadNecessaryClasses(), though it will only waste time.

Overrides:

loadBasicClasses in class Scene

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.

Overrides:

loadNecessaryClasses in class Scene

loadDynamicClasses

public void loadDynamicClasses()

Overrides:

loadDynamicClasses in class Scene

prepareClasses

protected void prepareClasses()

Generate classes to process, adding or removing package marked by command line options.

Overrides:

prepareClasses in class Scene

setMainClassFromOptions

public void setMainClassFromOptions()

Overrides:

setMainClassFromOptions in class Scene

forceResolve

public SootClass forceResolve(String className,
                              int level)

Description copied from class: Scene

Forces Soot to resolve the class with the given name to the given level, even if resolving has actually already finished.

Overrides:

forceResolve in class Scene

forceResolve

public SootClass forceResolve(String className,
                              int level,
                              com.google.common.base.Optional<String> moduleName)

makeSootClass

public SootClass makeSootClass(String className)

Overrides:

makeSootClass in class Scene

makeSootClass

public SootClass makeSootClass(String name,
                               String moduleName)

getOrAddRefType

public RefType getOrAddRefType(RefType tp)

getOrAddRefType

public RefType getOrAddRefType(String className,
                               com.google.common.base.Optional<String> moduleName)