Class CAstAbstractModuleLoader

java.lang.Object

com.ibm.wala.cast.loader.CAstAbstractLoader

com.ibm.wala.cast.loader.CAstAbstractModuleLoader

All Implemented Interfaces:

IClassLoader, SummaryClassShellLoader

Direct Known Subclasses:

JavaScriptLoader

public abstract class CAstAbstractModuleLoader
extends CAstAbstractLoader
implements SummaryClassShellLoader

abstract class loader that performs CAst and IR generation for relevant entities in a list of Modules. Subclasses provide the CAst / IR translators appropriate for the language.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CAstAbstractModuleLoader.CoreClass
class	CAstAbstractModuleLoader.DynamicCodeBody
class	CAstAbstractModuleLoader.DynamicMethodObject

Field Summary

Fields inherited from class CAstAbstractLoader

cha, parent, types

Modifier and Type	Field	Description
protected final IClassHierarchy	cha
protected final IClassLoader	parent
protected final Map<TypeName,IClass>	types	types loaded by this

Constructor Summary

Constructors

Constructor	Description
CAstAbstractModuleLoader(IClassHierarchy cha)
CAstAbstractModuleLoader(IClassHierarchy cha, IClassLoader parent)

Method Summary

Modifier and Type	Method	Description
IClass	defineSummaryClassShell(TypeName name, TypeName superName)	Register a "shell" IClass for a summary-modeled type, so that source classes loaded by this loader can resolve it as a superclass at definition time.
protected void	finishTranslation()	subclasses should override to perform actions after CAst and IR have been generated.
protected File	getLocalFile(SourceModule M)
protected abstract TranslatorToCAst	getTranslatorToCAst(CAst ast, ModuleEntry M, List<Module> modules)	create the appropriate CAst translator for the language and source module
void	init(List<Module> modules)	Initialize internal data structures.
protected abstract TranslatorToIR	initTranslator(Set<Pair<CAstEntity, ModuleEntry>> topLevelEntities)	create the appropriate IR translator for the language
protected abstract boolean	shouldTranslate(CAstEntity entity)	should IR be generated for entity?

Methods inherited from class CAstAbstractLoader

addMessage, addMessages, clearMessages, getMessages, getModulesWithParseErrors, getModulesWithWarnings, getName, getNumberOfClasses, getNumberOfMethods, getParent, getSource, getSource, getSourceFileName, getSourceFileName, iterateAllClasses, lookupClass, lookupClass, removeAll

Modifier and Type	Method	Description
void	addMessage(ModuleEntry module, Warning message)
void	addMessages(ModuleEntry module, Set<Warning> message)
void	clearMessages()
Set<Warning>	getMessages(ModuleEntry m)
Iterator<ModuleEntry>	getModulesWithParseErrors()
Iterator<ModuleEntry>	getModulesWithWarnings()
Atom	getName()
int	getNumberOfClasses()
int	getNumberOfMethods()
IClassLoader	getParent()
Reader	getSource(IClass klass)
Reader	getSource(IMethod method, int bcOffset)
String	getSourceFileName(IClass klass)
String	getSourceFileName(IMethod method, int bcOffset)
Iterator<IClass>	iterateAllClasses()
IClass	lookupClass(TypeName className)	Find and return the IClass defined by this class loader that corresponds to the given class name.
IClass	lookupClass(String className, IClassHierarchy cha)
void	removeAll(Collection<IClass> toRemove)	blow away references to any classes in the set

Methods inherited from class Object

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

Methods inherited from interface IClassLoader

getInstructionFactory, getLanguage, getReference

Modifier and Type	Method	Description
SSAInstructionFactory	getInstructionFactory()
Language	getLanguage()
ClassLoaderReference	getReference()	Return the ClassLoaderReference for this class loader.

Methods inherited from interface SummaryClassShellLoader

defineSummaryClassShell

Modifier and Type	Method	Description
default IClass	defineSummaryClassShell(TypeName name, TypeName superName, Collection<MethodSummary> methods)	Register a shell IClass that also exposes the given method summaries as its own declared methods, so that a walk of the shell (e.g.

Constructor Details

CAstAbstractModuleLoader

public CAstAbstractModuleLoader(IClassHierarchy cha,
 IClassLoader parent)

CAstAbstractModuleLoader

public CAstAbstractModuleLoader(IClassHierarchy cha)

Method Details

getTranslatorToCAst

protected abstract TranslatorToCAst getTranslatorToCAst(CAst ast,
 ModuleEntry M,
 List<Module> modules)
                                                 throws IOException

create the appropriate CAst translator for the language and source module

Parameters:

modules - all modules in the analysis

Throws:

IOException

shouldTranslate

protected abstract boolean shouldTranslate(CAstEntity entity)

should IR be generated for entity?

initTranslator

protected abstract TranslatorToIR initTranslator(Set<Pair<CAstEntity, ModuleEntry>> topLevelEntities)

create the appropriate IR translator for the language

Parameters:

topLevelEntities - the set of all modules being translated

getLocalFile

protected File getLocalFile(SourceModule M)
                     throws IOException

Throws:

IOException

finishTranslation

protected void finishTranslation()

subclasses should override to perform actions after CAst and IR have been generated. by default, do nothing

init

public void init(List<Module> modules)

Description copied from interface: IClassLoader

Initialize internal data structures.

Specified by:

init in interface IClassLoader

defineSummaryClassShell

public IClass defineSummaryClassShell(TypeName name,
 TypeName superName)

Register a "shell" IClass for a summary-modeled type, so that source classes loaded by this loader can resolve it as a superclass at definition time.

A CAst class resolves its superclass through this loader's own type map (CAstAbstractLoader.lookupClass(TypeName), CAstAbstractModuleLoader.CoreClass.getSuperclass()), which is loader-local and does not consult the IClassHierarchy or parent loaders. When a framework base type is modeled only by an XML method summary, the corresponding class is materialized into the BypassSyntheticClassLoader only after the class hierarchy is built, which is too late, and in the wrong loader, for a source subclass to pick up the inheritance edge. Registering a shell here, before the hierarchy is built, closes that gap (see #1957).

Idempotent: if a class is already registered under name, it is returned unchanged.

Specified by:

defineSummaryClassShell in interface SummaryClassShellLoader

Parameters:

name - the type to register a shell for

superName - the shell's superclass, or null for this loader's language root type

Returns:

the registered (or pre-existing) class