soot

Class SourceLocator

java.lang.Object

soot.SourceLocator

public class SourceLocator
extends java.lang.Object

Provides utility methods to retrieve an input stream for a class name, given a classfile, or jimple or baf output files.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.ClassLoader>	additionalClassLoaders
protected java.util.List<java.lang.String>	classPath
protected java.util.List<ClassProvider>	classProviders

Constructor Summary

Constructors

Constructor and Description
SourceLocator(Singletons.Global g)

Method Summary

Modifier and Type	Method and Description
void	additionalClassLoader(java.lang.ClassLoader c)
java.util.Set<java.lang.String>	classesInDynamicPackage(java.lang.String str)
java.util.List<java.lang.String>	classPath()
void	clearDexClassPathExtensions() Clears the set of dex or apk files that still need to be indexed
java.util.Map<java.lang.String,java.io.File>	dexClassIndex() Return the dex class index that maps class names to files
static void	ensureDirectoryExists(java.io.File dir) Create the given directory and all parent directories if dir is non-null.
static java.util.List<java.lang.String>	explodeClassPath(java.lang.String classPath) Explodes a class path into a list of individual class path entries.
void	extendClassPath(java.lang.String newPathElement)
java.util.List<java.lang.String>	getClassesUnder(java.lang.String aPath)
ClassSource	getClassSource(java.lang.String className) Given a class name, uses the soot-class-path to return a ClassSource for the given class.
java.util.Set<java.lang.String>	getDexClassPathExtensions() Gets all files that were added to the classpath later on and that have not yet been processed for the dexClassIndex mapping
java.lang.String	getExtensionFor(int rep)
java.lang.String	getFileNameFor(SootClass c, int rep)
java.lang.String	getOutputDir() Returns the output directory given by Options or a default if not set.
java.lang.String	getOutputJarName() If Options#v()#output_jar() is set, returns the name of the jar file to which the output will be written.
java.lang.String	getSourceForClass(java.lang.String className) Returns the name of the class in which the (possibly inner) class className appears.
void	invalidateClassPath()
protected FoundFile	lookupInArchive(java.lang.String archivePath, java.lang.String fileName)
FoundFile	lookupInClassPath(java.lang.String fileName) Searches for a file with the given name in the exploded classPath.
void	setClassProviders(java.util.List<ClassProvider> classProviders)
void	setDexClassIndex(java.util.Map<java.lang.String,java.io.File> index) Set the dex class index
protected void	setupClassProviders()
java.util.List<java.lang.String>	sourcePath()
static SourceLocator	v()

Methods inherited from class java.lang.Object

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

Field Detail

additionalClassLoaders

protected java.util.Set<java.lang.ClassLoader> additionalClassLoaders

classProviders

protected java.util.List<ClassProvider> classProviders

classPath

protected java.util.List<java.lang.String> classPath

Constructor Detail

SourceLocator

public SourceLocator(Singletons.Global g)

Method Detail

v

public static SourceLocator v()

ensureDirectoryExists

public static void ensureDirectoryExists(java.io.File dir)

Create the given directory and all parent directories if dir is non-null.

Parameters:

dir -

explodeClassPath

public static java.util.List<java.lang.String> explodeClassPath(java.lang.String classPath)

Explodes a class path into a list of individual class path entries.

getClassSource

public ClassSource getClassSource(java.lang.String className)

Given a class name, uses the soot-class-path to return a ClassSource for the given class.

additionalClassLoader

public void additionalClassLoader(java.lang.ClassLoader c)

setupClassProviders

protected void setupClassProviders()

setClassProviders

public void setClassProviders(java.util.List<ClassProvider> classProviders)

classPath

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

invalidateClassPath

public void invalidateClassPath()

sourcePath

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

getClassesUnder

public java.util.List<java.lang.String> getClassesUnder(java.lang.String aPath)

getFileNameFor

public java.lang.String getFileNameFor(SootClass c,
                                       int rep)

classesInDynamicPackage

public java.util.Set<java.lang.String> classesInDynamicPackage(java.lang.String str)

getExtensionFor

public java.lang.String getExtensionFor(int rep)

getOutputDir

public java.lang.String getOutputDir()

Returns the output directory given by Options or a default if not set. Also ensures that all directories in the path exist.

Returns:

the output directory from Options or a default if not set

getOutputJarName

public java.lang.String getOutputJarName()

If Options#v()#output_jar() is set, returns the name of the jar file to which the output will be written. The name of the jar file can be given with the -output-dir option or a default will be used. Also ensures that all directories in the path exist.

Returns:

the name of the Jar file to which outputs are written

lookupInClassPath

public FoundFile lookupInClassPath(java.lang.String fileName)

Searches for a file with the given name in the exploded classPath.

lookupInArchive

protected FoundFile lookupInArchive(java.lang.String archivePath,
                                    java.lang.String fileName)

getSourceForClass

public java.lang.String getSourceForClass(java.lang.String className)

Returns the name of the class in which the (possibly inner) class className appears.

dexClassIndex

public java.util.Map<java.lang.String,java.io.File> dexClassIndex()

Return the dex class index that maps class names to files

Returns:

the index

setDexClassIndex

public void setDexClassIndex(java.util.Map<java.lang.String,java.io.File> index)

Set the dex class index

Parameters:

index - the index

extendClassPath

public void extendClassPath(java.lang.String newPathElement)

getDexClassPathExtensions

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

Gets all files that were added to the classpath later on and that have not yet been processed for the dexClassIndex mapping

Returns:

The set of dex or apk files that still need to be indexed

clearDexClassPathExtensions

public void clearDexClassPathExtensions()

Clears the set of dex or apk files that still need to be indexed