soot

Class ModulePathSourceLocator

java.lang.Object

soot.SourceLocator

soot.ModulePathSourceLocator

public class ModulePathSourceLocator
extends SourceLocator

Provides utility methods to retrieve an input stream for a class , given a classfile and module

Author:

Andreas Dann

Nested Class Summary

Nested classes/interfaces inherited from class soot.SourceLocator

SourceLocator.ClassSourceType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DUMMY_CLASSPATH_JDK9_FS

Fields inherited from class soot.SourceLocator

additionalClassLoaders, archivePathToEntriesCache, classPath, classProviders, java9Mode, pathToSourceType, sourcePath

Constructor Summary

Constructors

Constructor and Description
ModulePathSourceLocator(Singletons.Global g)

Method Summary

Modifier and Type	Method and Description
void	additionalClassLoader(ClassLoader c)
Set<String>	classesInDynamicPackage(String str)
List<String>	classPath()
static List<String>	explodeModulePath(String classPath)
List<String>	getClassesUnder(String aPath) For backward compatibility returns classes in the form of module:classname
ClassSource	getClassSource(String className) Given a class name, uses the soot-class-path to return a ClassSource for the given class.
ClassSource	getClassSource(String className, com.google.common.base.Optional<String> moduleName) Given a class name, uses the soot-module-path to return a ClassSource for the given class.
protected SourceLocator.ClassSourceType	getClassSourceType(String path)
Map<String,List<String>>	getClassUnderModulePath(String aPath) Scan the given module path entry.
static Path	getRootModulesPathOfJDK()
void	invalidateClassPath()
protected IFoundFile	lookupInArchive(String archivePath, String fileName) Looks up classes in an archive file
IFoundFile	lookupInClassPath(String fileName) Searches for a file with the given name in the exploded modulePath.
protected IFoundFile	lookupInDir(String dir, String fileName)
IFoundFile	lookUpInModulePath(String fileName)
IFoundFile	lookUpInVirtualFileSystem(String archivePath, String fileName) Looks up classes in Java 9's virtual filesystem jrt:/
protected void	setupClassProviders()
List<String>	sourcePath()
static ModulePathSourceLocator	v()

Methods inherited from class soot.SourceLocator

clearDexClassPathExtensions, dexClassIndex, ensureDirectoryExists, explodeClassPath, extendClassPath, getClassesUnder, getDexClassPathExtensions, getExtensionFor, getFileNameFor, getOutputDir, getOutputJarName, getSourceForClass, invalidateCaches, resetCaches, setClassProviders, setDexClassIndex

Methods inherited from class java.lang.Object

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

Field Detail

DUMMY_CLASSPATH_JDK9_FS

public static final String DUMMY_CLASSPATH_JDK9_FS

See Also:

Constant Field Values

Constructor Detail

ModulePathSourceLocator

public ModulePathSourceLocator(Singletons.Global g)

Method Detail

v

public static ModulePathSourceLocator v()

getClassSource

public ClassSource getClassSource(String className)

Description copied from class: SourceLocator

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

Overrides:

getClassSource in class SourceLocator

getClassSource

public ClassSource getClassSource(String className,
                                  com.google.common.base.Optional<String> moduleName)

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

explodeModulePath

public static List<String> explodeModulePath(String classPath)

additionalClassLoader

public void additionalClassLoader(ClassLoader c)

Overrides:

additionalClassLoader in class SourceLocator

classPath

public List<String> classPath()

Overrides:

classPath in class SourceLocator

invalidateClassPath

public void invalidateClassPath()

Overrides:

invalidateClassPath in class SourceLocator

sourcePath

public List<String> sourcePath()

Overrides:

sourcePath in class SourceLocator

getClassesUnder

public List<String> getClassesUnder(String aPath)

For backward compatibility returns classes in the form of module:classname

Overrides:

getClassesUnder in class SourceLocator

Parameters:

aPath - where to search for classes

Returns:

a String list containing entries of the form module:classname

getClassUnderModulePath

public Map<String,List<String>> getClassUnderModulePath(String aPath)

Scan the given module path entry. If the entry is a directory then it is a directory of modules or an exploded module. If the entry is a regular file then it is assumed to be a packaged module.

getRootModulesPathOfJDK

public static Path getRootModulesPathOfJDK()

classesInDynamicPackage

public Set<String> classesInDynamicPackage(String str)

Overrides:

classesInDynamicPackage in class SourceLocator

lookupInClassPath

public IFoundFile lookupInClassPath(String fileName)

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

Overrides:

lookupInClassPath in class SourceLocator

getClassSourceType

protected SourceLocator.ClassSourceType getClassSourceType(String path)

Overrides:

getClassSourceType in class SourceLocator

lookUpInModulePath

public IFoundFile lookUpInModulePath(String fileName)

lookupInDir

protected IFoundFile lookupInDir(String dir,
                                 String fileName)

Overrides:

lookupInDir in class SourceLocator

lookupInArchive

protected IFoundFile lookupInArchive(String archivePath,
                                     String fileName)

Looks up classes in an archive file

Overrides:

lookupInArchive in class SourceLocator

Parameters:

archivePath - path to the zip/jar

fileName - the filename to search

Returns:

the FoundFile

lookUpInVirtualFileSystem

public IFoundFile lookUpInVirtualFileSystem(String archivePath,
                                            String fileName)

Looks up classes in Java 9's virtual filesystem jrt:/

Parameters:

archivePath - path to the filesystem

fileName - the file to search

Returns:

the FoundFile

setupClassProviders

protected void setupClassProviders()

Overrides:

setupClassProviders in class SourceLocator