Interface Language

All Known Subinterfaces:

BytecodeLanguage

All Known Implementing Classes:

JavaLanguage, LanguageImpl

public interface Language

Main interface for language-specific information. This interface helps build analyses which can operate over multiple languages.

Field Summary

Fields

Modifier and Type	Field	Description
static final JavaLanguage	JAVA	The canonical Language implementation for Java

Method Summary

Modifier and Type	Method	Description
TypeReference[]	getArrayInterfaces()	get the interfaces implemented by all arrays in the language
Language	getBaseLanguage()	If this language is "derived" from some other langauge, which one?
TypeReference	getConstantType(Object o)	Given a Java constant o, return the appropriate language type to associate with the constant.
Set<Language>	getDerivedLanguages()
AbstractRootMethod	getFakeRootMethod(IClassHierarchy cha, AnalysisOptions options, IAnalysisCacheView cache)
Object	getMetadataToken(Object value)	Get the representation of the meta-data corresponding to value.
Atom	getName()	What is the name of the language?
TypeReference	getPointerType(TypeReference pointee)
PrimitiveType	getPrimitive(TypeReference reference)	get the abstraction of a primitive type to be used for type inference
TypeReference	getRootType()	What is the root type in a type hierarchy for this language? e.g.
TypeReference	getStringType()
TypeReference	getThrowableType()	What is the root type of exceptions in this language? e.g.
Collection<TypeReference>	inferInvokeExceptions(MethodReference target, IClassHierarchy cha)	determine the set of possible exception types a call to target may throw
SSAInstructionFactory	instructionFactory()
boolean	isBooleanType(TypeReference t)
boolean	isCharType(TypeReference t)
boolean	isDoubleType(TypeReference t)
boolean	isFloatType(TypeReference t)
boolean	isIntType(TypeReference t)
boolean	isLongType(TypeReference t)
boolean	isMetadataType(TypeReference t)	Is t a "metadata" type for the language, i.e., a type describing some other type (e.g., java.lang.Class for Java)?
boolean	isNullType(TypeReference t)	Is t the type of the language's null value? Should return true if t == null (?).
boolean	isStringType(TypeReference t)
boolean	isVoidType(TypeReference t)
TypeName	lookupPrimitiveType(String name)	Given a source-level primitive type name, get the corresponding "low-level" type name, e.g., the corresponding character to use in a Java method descriptor
InducedCFG	makeInducedCFG(SSAInstruction[] instructions, IMethod method, Context context)
<T extends InstanceKey> ModRef.ModVisitor<T,? extends ExtendedHeapModel>	makeModVisitor(CGNode n, Collection<PointerKey> result, PointerAnalysis<T> pa, ExtendedHeapModel h, boolean ignoreAllocHeapDefs)
<T extends InstanceKey> ModRef.RefVisitor<T,? extends ExtendedHeapModel>	makeRefVisitor(CGNode n, Collection<PointerKey> result, PointerAnalysis<T> pa, ExtendedHeapModel h)
boolean	methodsHaveDeclaredParameterTypes()	do MethodReference objects have declared parameter types?
boolean	modelConstant(Object o)
void	registerDerivedLanguage(Language l)	Yuck? Languages are mutable?

Field Details

JAVA

static final JavaLanguage JAVA

The canonical Language implementation for Java

Method Details

getName

Atom getName()

What is the name of the language?

getBaseLanguage

Language getBaseLanguage()

If this language is "derived" from some other langauge, which one?

registerDerivedLanguage

void registerDerivedLanguage(Language l)

Yuck? Languages are mutable?

getDerivedLanguages

Set<Language> getDerivedLanguages()

getRootType

TypeReference getRootType()

What is the root type in a type hierarchy for this language? e.g. java.lang.Object in Java.

getThrowableType

TypeReference getThrowableType()

What is the root type of exceptions in this language? e.g. java.lang.Throwable in Java

getConstantType

TypeReference getConstantType(Object o)

Given a Java constant o, return the appropriate language type to associate with the constant. Possible types for o can be language dependent, but typically include Boolean, String, Integer, Float, etc.

isNullType

boolean isNullType(TypeReference t)

Is t the type of the language's null value? Should return true if t == null (?).

isIntType

boolean isIntType(TypeReference t)

isLongType

boolean isLongType(TypeReference t)

isVoidType

boolean isVoidType(TypeReference t)

isFloatType

boolean isFloatType(TypeReference t)

isDoubleType

boolean isDoubleType(TypeReference t)

isStringType

boolean isStringType(TypeReference t)

isMetadataType

boolean isMetadataType(TypeReference t)

Is t a "metadata" type for the language, i.e., a type describing some other type (e.g., java.lang.Class for Java)?

isCharType

boolean isCharType(TypeReference t)

isBooleanType

boolean isBooleanType(TypeReference t)

getMetadataToken

Object getMetadataToken(Object value)

Get the representation of the meta-data corresponding to value. For example, in Java, if value represents some type, the returned object should be the corresponding TypeReference. The returned object should be appropriate for use as the token in an SSALoadMetadataInstruction for the language

getArrayInterfaces

TypeReference[] getArrayInterfaces()

get the interfaces implemented by all arrays in the language

lookupPrimitiveType

TypeName lookupPrimitiveType(String name)

Given a source-level primitive type name, get the corresponding "low-level" type name, e.g., the corresponding character to use in a Java method descriptor

instructionFactory

SSAInstructionFactory instructionFactory()

inferInvokeExceptions

Collection<TypeReference> inferInvokeExceptions(MethodReference target,
 IClassHierarchy cha)
                                         throws InvalidClassFileException

determine the set of possible exception types a call to target may throw

Throws:

InvalidClassFileException

getStringType

TypeReference getStringType()

getPointerType

TypeReference getPointerType(TypeReference pointee)

getPrimitive

PrimitiveType getPrimitive(TypeReference reference)

get the abstraction of a primitive type to be used for type inference

See Also:

• TypeInference

methodsHaveDeclaredParameterTypes

boolean methodsHaveDeclaredParameterTypes()

do MethodReference objects have declared parameter types?

getFakeRootMethod

AbstractRootMethod getFakeRootMethod(IClassHierarchy cha,
 AnalysisOptions options,
 IAnalysisCacheView cache)

makeInducedCFG

InducedCFG makeInducedCFG(SSAInstruction[] instructions,
 IMethod method,
 Context context)

modelConstant

boolean modelConstant(Object o)

makeRefVisitor

<T extends InstanceKey>
ModRef.RefVisitor<T,? extends ExtendedHeapModel> makeRefVisitor(CGNode n,
 Collection<PointerKey> result,
 PointerAnalysis<T> pa,
 ExtendedHeapModel h)

makeModVisitor

<T extends InstanceKey>
ModRef.ModVisitor<T,? extends ExtendedHeapModel> makeModVisitor(CGNode n,
 Collection<PointerKey> result,
 PointerAnalysis<T> pa,
 ExtendedHeapModel h,
 boolean ignoreAllocHeapDefs)