Class ScopeMappingInstanceKeys

java.lang.Object

com.ibm.wala.cast.ipa.callgraph.ScopeMappingInstanceKeys

All Implemented Interfaces:

InstanceKeyFactory

Direct Known Subclasses:

JavaScopeMappingInstanceKeys, JavaScriptScopeMappingInstanceKeys

public abstract class ScopeMappingInstanceKeys
extends Object
implements InstanceKeyFactory

An InstanceKeyFactory that returns ScopeMappingInstanceKeys.ScopeMappingInstanceKeys as necessary to handle interprocedural lexical scoping (specifically, to handle closure creation when a function escapes its allocating scope)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ScopeMappingInstanceKeys.ScopeMappingInstanceKey	An InstanceKey carrying information about which CGNodes represent lexical parents of the allocating CGNode.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PropagationCallGraphBuilder	builder

Constructor Summary

Constructors

Constructor	Description
ScopeMappingInstanceKeys(PropagationCallGraphBuilder builder, InstanceKeyFactory basic)

Method Summary

Modifier and Type	Method	Description
protected abstract Collection<CGNode>	getConstructorCallers(ScopeMappingInstanceKeys.ScopeMappingInstanceKey smik, Pair<String,String> name)	get the CGNodes corresponding to the method that invoked the constructor for smik
InstanceKey	getInstanceKeyForAllocation(CGNode creatorNode, NewSiteReference allocationSite)
InstanceKey	getInstanceKeyForConstant(TypeReference type, Object S)
InstanceKey	getInstanceKeyForMetadataObject(Object obj, TypeReference objType)
InstanceKey	getInstanceKeyForMultiNewArray(CGNode node, NewSiteReference allocation, int dim)
InstanceKey	getInstanceKeyForPEI(CGNode node, ProgramCounter instr, TypeReference type)
protected abstract boolean	isTrueConstructorCall(Pair<String,String> name, CGNode callerOfConstructor)
protected abstract boolean	needsScopeMappingKey(InstanceKey base)	does base require a scope mapping key? Typically, true if base is allocated in a nested lexical scope, to handle the case of base being a function that performs closure accesses

Methods inherited from class Object

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

Field Details

builder

protected final PropagationCallGraphBuilder builder

Constructor Details

ScopeMappingInstanceKeys

public ScopeMappingInstanceKeys(PropagationCallGraphBuilder builder,
 InstanceKeyFactory basic)

Method Details

needsScopeMappingKey

protected abstract boolean needsScopeMappingKey(InstanceKey base)

does base require a scope mapping key? Typically, true if base is allocated in a nested lexical scope, to handle the case of base being a function that performs closure accesses

isTrueConstructorCall

protected abstract boolean isTrueConstructorCall(Pair<String,String> name,
 CGNode callerOfConstructor)

Parameters:

name - the variable name and creator pair

callerOfConstructor - the purported caller of the constructor

Returns:

whether this is a real constructor call or an artifact of function pointers (always true for lexical scoping in Java)

getInstanceKeyForAllocation

public InstanceKey getInstanceKeyForAllocation(CGNode creatorNode,
 NewSiteReference allocationSite)

Specified by:

getInstanceKeyForAllocation in interface InstanceKeyFactory

Returns:

the instance key that represents a particular allocation

getConstructorCallers

protected abstract Collection<CGNode> getConstructorCallers(ScopeMappingInstanceKeys.ScopeMappingInstanceKey smik,
 Pair<String,String> name)

get the CGNodes corresponding to the method that invoked the constructor for smik

getInstanceKeyForMultiNewArray

public InstanceKey getInstanceKeyForMultiNewArray(CGNode node,
 NewSiteReference allocation,
 int dim)

Specified by:

getInstanceKeyForMultiNewArray in interface InstanceKeyFactory

Returns:

the instance key that represents the array allocated as the dim_th dimension at a particular allocation

getInstanceKeyForConstant

public InstanceKey getInstanceKeyForConstant(TypeReference type,
 Object S)

Specified by:

getInstanceKeyForConstant in interface InstanceKeyFactory

Returns:

the instance key that represents a constant with value S, when considered as a particular type

getInstanceKeyForPEI

public InstanceKey getInstanceKeyForPEI(CGNode node,
 ProgramCounter instr,
 TypeReference type)

Specified by:

getInstanceKeyForPEI in interface InstanceKeyFactory

Returns:

the instance key that represents the exception of type _type_ thrown by a particular PEI.

getInstanceKeyForMetadataObject

public InstanceKey getInstanceKeyForMetadataObject(Object obj,
 TypeReference objType)

Specified by:

getInstanceKeyForMetadataObject in interface InstanceKeyFactory

Parameters:

objType - TODO

Returns:

the instance key that represents the metadata object obj