SourceLocator (Soot - a J*va Optimization Framework 4.6.0-SNAPSHOT API)

java.lang.Object
- soot.SourceLocator

Direct Known Subclasses:

ModulePathSourceLocator
```
public class SourceLocator
extends Object
```
Provides utility methods to retrieve an input stream for a class name, given a classfile, or jimple or baf output files.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class SourceLocator.ClassSourceType

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`SourceLocator.ClassSourceType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<ClassLoader>`	`additionalClassLoaders`
`protected com.google.common.cache.LoadingCache<String,Set<String>>`	`archivePathToEntriesCache`
`protected List<String>`	`classPath`
`protected List<ClassProvider>`	`classProviders`
`protected boolean`	`java9Mode`
`protected com.google.common.cache.LoadingCache<String,SourceLocator.ClassSourceType>`	`pathToSourceType`
`protected List<String>`	`sourcePath`

Constructor Summary

Constructors
Constructor and Description

SourceLocator(Singletons.Global g)

Constructors
Constructor and Description
`SourceLocator(Singletons.Global g)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`additionalClassLoader(ClassLoader c)`
`Set<String>`	`classesInDynamicPackage(String str)`
`List<String>`	`classPath()`
`void`	`clearDexClassPathExtensions()` Clears the set of dex or apk or assembly files that still need to be indexed
`Map<String,File>`	`dexClassIndex()` Return the class index that maps class names to dex/assembly(exe/dll) files.
`static void`	`ensureDirectoryExists(File dir)` Create the given directory and all parent directories if `dir` is non-null.
`static List<String>`	`explodeClassPath(String classPath)` Explodes a class path into a list of individual class path entries.
`void`	`extendClassPath(String newPathElement)`
`List<String>`	`getClassesUnder(String aPath)`
`List<String>`	`getClassesUnder(String aPath, String prefix)`
`ClassSource`	`getClassSource(String className)` Given a class name, uses the soot-class-path to return a ClassSource for the given class.
`protected SourceLocator.ClassSourceType`	`getClassSourceType(String path)`
`Set<String>`	`getDexClassPathExtensions()` Gets all files that were added to the classpath later on and that have not yet been processed for the dexClassIndex mapping
`String`	`getExtensionFor(int rep)`
`String`	`getFileNameFor(SootClass c, int rep)`
`String`	`getOutputDir()` Returns the output directory given by `Options` or a default if not set.
`String`	`getOutputJarName()` If `Options#v()#output_jar()` is set, returns the name of the jar file to which the output will be written.
`String`	`getSourceForClass(String className)` Returns the name of the class in which the (possibly inner) class className appears.
`void`	`invalidateCaches()`
`void`	`invalidateClassPath()`
`protected IFoundFile`	`lookupInArchive(String archivePath, String fileName)`
`IFoundFile`	`lookupInClassPath(String fileName)` Searches for a file with the given name in the exploded classPath.
`protected IFoundFile`	`lookupInDir(String dir, String fileName)`
`void`	`resetCaches()` Resets the cached class path, class providers, and source path to null.
`void`	`setClassProviders(List<ClassProvider> classProviders)`
`void`	`setDexClassIndex(Map<String,File> index)` Set the class_container (dex, assembly) class index
`protected void`	`setupClassProviders()`
`List<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 final Set<ClassLoader> additionalClassLoaders
```
  - classProviders
```
protected List<ClassProvider> classProviders
```
  - classPath
```
protected List<String> classPath
```
  - sourcePath
```
protected List<String> sourcePath
```
  - java9Mode
```
protected boolean java9Mode
```
  - pathToSourceType
```
protected final com.google.common.cache.LoadingCache<String,SourceLocator.ClassSourceType> pathToSourceType
```
  - archivePathToEntriesCache
```
protected final com.google.common.cache.LoadingCache<String,Set<String>> archivePathToEntriesCache
```
- Constructor Detail
  - SourceLocator
```
public SourceLocator(Singletons.Global g)
```
- Method Detail
  - invalidateCaches
```
public void invalidateCaches()
```
  - v
```
public static SourceLocator v()
```
  - ensureDirectoryExists
```
public static void ensureDirectoryExists(File dir)
```
    Create the given directory and all parent directories if dir is non-null.
    
    Parameters:
    
    dir -
  - explodeClassPath
```
public static List<String> explodeClassPath(String classPath)
```
    Explodes a class path into a list of individual class path entries.
  - getClassSource
```
public ClassSource getClassSource(String className)
```
    Given a class name, uses the soot-class-path to return a ClassSource for the given class.
  - additionalClassLoader
```
public void additionalClassLoader(ClassLoader c)
```
  - setupClassProviders
```
protected void setupClassProviders()
```
  - setClassProviders
```
public void setClassProviders(List<ClassProvider> classProviders)
```
  - classPath
```
public List<String> classPath()
```
  - invalidateClassPath
```
public void invalidateClassPath()
```
  - sourcePath
```
public List<String> sourcePath()
```
  - getClassSourceType
```
protected SourceLocator.ClassSourceType getClassSourceType(String path)
```
  - getClassesUnder
```
public List<String> getClassesUnder(String aPath)
```
  - getClassesUnder
```
public List<String> getClassesUnder(String aPath,
                                    String prefix)
```
  - getFileNameFor
```
public String getFileNameFor(SootClass c,
                             int rep)
```
  - classesInDynamicPackage
```
public Set<String> classesInDynamicPackage(String str)
```
  - getExtensionFor
```
public String getExtensionFor(int rep)
```
  - getOutputDir
```
public 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 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 IFoundFile lookupInClassPath(String fileName)
```
    Searches for a file with the given name in the exploded classPath.
  - lookupInDir
```
protected IFoundFile lookupInDir(String dir,
                                 String fileName)
```
  - lookupInArchive
```
protected IFoundFile lookupInArchive(String archivePath,
                                     String fileName)
```
  - getSourceForClass
```
public String getSourceForClass(String className)
```
    Returns the name of the class in which the (possibly inner) class className appears.
  - dexClassIndex
```
public Map<String,File> dexClassIndex()
```
    Return the class index that maps class names to dex/assembly(exe/dll) files. A dex/exe/dll file contains multiple classes and is not structured as a "folder structure"
    
    Returns:
    
    the index
  - setDexClassIndex
```
public void setDexClassIndex(Map<String,File> index)
```
    Set the class_container (dex, assembly) class index
    
    Parameters:
    
    index - the index
  - extendClassPath
```
public void extendClassPath(String newPathElement)
```
  - getDexClassPathExtensions
```
public Set<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 or assembly (exe/dll) files that still need to be indexed
  - clearDexClassPathExtensions
```
public void clearDexClassPathExtensions()
```
    Clears the set of dex or apk or assembly files that still need to be indexed
  - resetCaches
```
public void resetCaches()
```
    Resets the cached class path, class providers, and source path to null. This method allows for subsequent calls to Scene.loadNecessaryClasses() to recompute and load the classes using updated configurations if provided.

Class SourceLocator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

additionalClassLoaders

classProviders

classPath

sourcePath

java9Mode

pathToSourceType

archivePathToEntriesCache

Constructor Detail

SourceLocator

Method Detail

invalidateCaches

v

ensureDirectoryExists

explodeClassPath

getClassSource

additionalClassLoader

setupClassProviders

setClassProviders

classPath

invalidateClassPath

sourcePath

getClassSourceType

getClassesUnder

getClassesUnder

getFileNameFor

classesInDynamicPackage

getExtensionFor

getOutputDir

getOutputJarName

lookupInClassPath

lookupInDir

lookupInArchive

getSourceForClass

dexClassIndex

setDexClassIndex

extendClassPath

getDexClassPathExtensions

clearDexClassPathExtensions

resetCaches