Class JavaSourceAnalysisEngine

java.lang.Object

com.ibm.wala.client.AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

com.ibm.wala.cast.java.client.JavaSourceAnalysisEngine

All Implemented Interfaces:

AnalysisEngine

Direct Known Subclasses:

ECJJavaSourceAnalysisEngine

public abstract class JavaSourceAnalysisEngine
extends AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAnalysisEngine

AbstractAnalysisEngine.EntrypointBuilder

Modifier and Type	Class	Description
static interface	AbstractAnalysisEngine.EntrypointBuilder

Field Summary

Fields inherited from class AbstractAnalysisEngine

cg, DEBUG_LEVEL, j2seLibs, moduleFiles, pointerAnalysis, scope, SYNTHETIC_J2SE_MODEL

Modifier and Type	Field	Description
protected CallGraph	cg	Governing call graph
protected static final int	DEBUG_LEVEL	DEBUG_LEVEL: 0 No output 1 Print some simple stats and warning information 2 Detailed debugging
protected Module[]	j2seLibs	The standard J2SE libraries to analyze
protected Collection<? extends Module>	moduleFiles	The modules to analyze
protected PointerAnalysis<InstanceKey>	pointerAnalysis	Results of pointer analysis
protected AnalysisScope	scope	A representation of the analysis scope
static final String	SYNTHETIC_J2SE_MODEL

Constructor Summary

Constructors

Constructor	Description
JavaSourceAnalysisEngine()

Method Summary

Modifier and Type	Method	Description
protected void	addApplicationModulesToScope()	Add the application modules to the analysis scope.
void	addCompiledModule(Module M)	Adds the given compiled module to the application loader's module list.
void	addSourceModule(Module M)	Adds the given source module to the source loader's module list.
void	addSystemModule(Module M)	Adds the given module to the primordial loader's module list.
void	buildAnalysisScope()	Set up the AnalysisScope object
IClassHierarchy	buildClassHierarchy()
protected AstJavaZeroXCFABuilder	getCallGraphBuilder(IClassHierarchy cha, AnalysisOptions options, IAnalysisCacheView cache)
protected abstract ClassLoaderFactory	getClassLoaderFactory(StringFilter exclusions)
AnalysisOptions	getDefaultOptions(Iterable<Entrypoint> entrypoints)	Get the default analysis options appropriate for this engine
AnalysisOptions	getOptions()
IAnalysisCacheView	makeDefaultCache()
protected Iterable<Entrypoint>	makeDefaultEntrypoints(IClassHierarchy cha)
protected AnalysisScope	makeSourceAnalysisScope()

Methods inherited from class AbstractAnalysisEngine

buildCallGraph, buildDefaultCallGraph, defaultCallGraphBuilder, getCache, getCallGraph, getClassHierarchy, getExclusionsFile, getHeapGraph, getPointerAnalysis, getScope, getSDG, isClosedWorld, makeClassLoaderFactory, performAnalysis, setClassHierarchy, setClosedWorld, setEntrypointBuilder, setExclusionsFile, setJ2SELibraries, setJ2SELibraries, setModuleFiles

Modifier and Type	Method	Description
protected CallGraphBuilder<InstanceKey>	buildCallGraph(IClassHierarchy cha, AnalysisOptions options, boolean savePointerAnalysis, MonitorUtil.IProgressMonitor monitor)
CallGraph	buildDefaultCallGraph()
CallGraphBuilder<InstanceKey>	defaultCallGraphBuilder()	Builds the call graph for the analysis scope in effect, using all of the given entry points.
IAnalysisCacheView	getCache()
protected CallGraph	getCallGraph()
IClassHierarchy	getClassHierarchy()
String	getExclusionsFile()
HeapGraph<?>	getHeapGraph()
PointerAnalysis<? super InstanceKey>	getPointerAnalysis()
protected AnalysisScope	getScope()
SDG<? super InstanceKey>	getSDG(Slicer.DataDependenceOptions data, Slicer.ControlDependenceOptions ctrl)
boolean	isClosedWorld()
protected ClassLoaderFactory	makeClassLoaderFactory(StringFilter exclusions)
Void	performAnalysis(PropagationCallGraphBuilder builder)
protected IClassHierarchy	setClassHierarchy(IClassHierarchy cha)
void	setClosedWorld(boolean b)	Specify whether the engine should or should not employ "closed-world" analysis.
void	setEntrypointBuilder(AbstractAnalysisEngine.EntrypointBuilder builder)
void	setExclusionsFile(String exclusionsFile)
void	setJ2SELibraries(Module[] libs)	Specify the mdoules that represent the standard J2SE libraries
void	setJ2SELibraries(JarFile[] libs)	Specify the jar files that represent the standard J2SE libraries
void	setModuleFiles(Collection<? extends Module> moduleFiles)	Specify the list of modules that should be analyzed.

Methods inherited from class Object

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

Constructor Details

JavaSourceAnalysisEngine

public JavaSourceAnalysisEngine()

Method Details

addSourceModule

public void addSourceModule(Module M)

Adds the given source module to the source loader's module list. Clients should/may call this method if they don't supply an IJavaProject to the constructor.

addCompiledModule

public void addCompiledModule(Module M)

Adds the given compiled module to the application loader's module list. Clients should/may call this method if they don't supply an IJavaProject to the constructor.

addSystemModule

public void addSystemModule(Module M)

Adds the given module to the primordial loader's module list. Clients should/may call this method if they don't supply an IJavaProject to the constructor.

addApplicationModulesToScope

protected void addApplicationModulesToScope()

Description copied from class: AbstractAnalysisEngine

Add the application modules to the analysis scope.

Overrides:

addApplicationModulesToScope in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

buildAnalysisScope

public void buildAnalysisScope()
                        throws IOException

Description copied from class: AbstractAnalysisEngine

Set up the AnalysisScope object

Overrides:

buildAnalysisScope in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

Throws:

IOException

makeSourceAnalysisScope

protected AnalysisScope makeSourceAnalysisScope()

getClassLoaderFactory

protected abstract ClassLoaderFactory getClassLoaderFactory(StringFilter exclusions)

buildClassHierarchy

public IClassHierarchy buildClassHierarchy()

Overrides:

buildClassHierarchy in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

Returns:

a IClassHierarchy object for this analysis scope

makeDefaultEntrypoints

protected Iterable<Entrypoint> makeDefaultEntrypoints(IClassHierarchy cha)

Overrides:

makeDefaultEntrypoints in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

makeDefaultCache

public IAnalysisCacheView makeDefaultCache()

Overrides:

makeDefaultCache in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

getOptions

public AnalysisOptions getOptions()

Overrides:

getOptions in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

getDefaultOptions

public AnalysisOptions getDefaultOptions(Iterable<Entrypoint> entrypoints)

Description copied from interface: AnalysisEngine

Get the default analysis options appropriate for this engine

Specified by:

getDefaultOptions in interface AnalysisEngine

Overrides:

getDefaultOptions in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>

getCallGraphBuilder

protected AstJavaZeroXCFABuilder getCallGraphBuilder(IClassHierarchy cha,
 AnalysisOptions options,
 IAnalysisCacheView cache)

Specified by:

getCallGraphBuilder in class AbstractAnalysisEngine<InstanceKey, CallGraphBuilder<InstanceKey>, Void>