Class SummarizedMethodWithNames

java.lang.Object

com.ibm.wala.classLoader.SyntheticMethod

com.ibm.wala.ipa.summaries.SummarizedMethod

com.ibm.wala.ipa.summaries.SummarizedMethodWithNames

All Implemented Interfaces:

IMember, IMethod, ContextItem, IClassHierarchyDweller

public class SummarizedMethodWithNames
extends SummarizedMethod

A SummarizedMethod (for synthetic functions) with variable names.

Using this class instead of a normal SummarizedMethod enables the use of human-readable variable names in synthetic methods. This should not change th analysis-result but may come in handy when debugging.

Since:

2013-11-25

Author:

Tobias Blaschke <code@tobiasblaschke.de>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummarizedMethodWithNames.SyntheticIRWithNames

Nested classes/interfaces inherited from interface ContextItem

ContextItem.Value<T>

Modifier and Type	Interface	Description
static class	ContextItem.Value<T>

Nested classes/interfaces inherited from interface IMethod

IMethod.SourcePosition

Modifier and Type	Interface	Description
static interface	IMethod.SourcePosition

Field Summary

Fields inherited from class SyntheticMethod

declaringClass, NO_STATEMENTS, resolvedMethod

Modifier and Type	Field	Description
final IClass	declaringClass
static final SSAInstruction[]	NO_STATEMENTS
protected final IMethod	resolvedMethod

Constructor Summary

Constructors

Constructor	Description
SummarizedMethodWithNames(MethodReference ref, MethodSummary summary, IClass declaringClass)
SummarizedMethodWithNames(MethodReference ref, MethodSummary summary, IClass declaringClass, Map<Integer, @NonNull Atom> localNames)
SummarizedMethodWithNames(MethodReference ref, VolatileMethodSummary summary, IClass declaringClass)

Method Summary

Modifier and Type	Method	Description
String	getLocalVariableName(int bcIndex, int localNumber)	Returns the variable name to a ssa-number.
boolean	hasLocalVariableTable()
IR	makeIR(Context context, SSAOptions options)	Most subclasses should override this.

Methods inherited from class SummarizedMethod

getNumberOfParameters, getParameterType, getPoison, getPoisonLevel, getStatements, hasPoison, isAbstract, isNative, isStatic

Modifier and Type	Method	Description
int	getNumberOfParameters()	Method getNumberOfParameters.
TypeReference	getParameterType(int i)	By convention, for a non-static method, getParameterType(0) is the this pointer
String	getPoison()
byte	getPoisonLevel()
SSAInstruction[]	getStatements(SSAOptions options)
boolean	hasPoison()
boolean	isAbstract()	Is this method abstract?
boolean	isNative()	Is this method native?
boolean	isStatic()	Is this member static?

Methods inherited from class SyntheticMethod

equals, getAnnotations, getBytecodeStream, getClassHierarchy, getDeclaredExceptions, getDeclaringClass, getDescriptor, getLineNumber, getMaxLocals, getMaxStackHeight, getName, getParameterSourcePosition, getReference, getReturnType, getSelector, getSignature, getSourcePosition, getStatements, hasExceptionHandler, hashCode, isAnnotation, isBridge, isClinit, isEnum, isFactoryMethod, isFinal, isInit, isModule, isPrivate, isProtected, isPublic, isSynchronized, isSynthetic, isWalaSynthetic, makeControlFlowGraph, toString

Modifier and Type	Method	Description
boolean	equals(Object obj)
Collection<Annotation>	getAnnotations()	Get the annotations on this member, if any
BytecodeStream	getBytecodeStream()
IClassHierarchy	getClassHierarchy()
TypeReference[]	getDeclaredExceptions()
IClass	getDeclaringClass()	Return the object that represents the declaring class for this member.
Descriptor	getDescriptor()	something like: (IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
int	getLineNumber(int bcIndex)
int	getMaxLocals()
int	getMaxStackHeight()
Atom	getName()
IMethod.SourcePosition	getParameterSourcePosition(int paramNum)
MethodReference	getReference()
TypeReference	getReturnType()
Selector	getSelector()	something like: foo(Ljava/langString;)Ljava/lang/Class;
String	getSignature()	something like: com.foo.bar.createLargeOrder(IILjava.lang.String;SLjava.sql.Date;)Ljava.lang.Integer;
IMethod.SourcePosition	getSourcePosition(int bcIndex)
SSAInstruction[]	getStatements()
boolean	hasExceptionHandler()
int	hashCode()
boolean	isAnnotation()
boolean	isBridge()	Is this method a bridge method? See JLS 3rd Edition 15.12.4.5
boolean	isClinit()	Is this method a class initializer?
boolean	isEnum()
boolean	isFactoryMethod()
boolean	isFinal()	Is this method final?
boolean	isInit()	Is this method an object initializer?
boolean	isModule()
boolean	isPrivate()	Is this method private?
boolean	isProtected()	Is this method protected?
boolean	isPublic()	Is this method public?
boolean	isSynchronized()	Is this method synchronized?
boolean	isSynthetic()	Is this method synthetic, i.e., compiler-generated (this refers to the synthetic flag in java/dex bytecode)
boolean	isWalaSynthetic()	Is the implementation of this method a model generated by WALA? For compiler-generated synthetic methods, refer to IMethod.isSynthetic()
InducedCFG	makeControlFlowGraph(SSAInstruction[] instructions)	Create an InducedCFG from an instruction array.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IMethod

getNumberOfDefaultParameters

Modifier and Type	Method	Description
default int	getNumberOfDefaultParameters()

Constructor Details

SummarizedMethodWithNames

public SummarizedMethodWithNames(MethodReference ref,
 MethodSummary summary,
 IClass declaringClass)

SummarizedMethodWithNames

public SummarizedMethodWithNames(MethodReference ref,
 MethodSummary summary,
 IClass declaringClass,
 Map<Integer, @NonNull Atom> localNames)
                          throws NullPointerException

Throws:

NullPointerException

SummarizedMethodWithNames

public SummarizedMethodWithNames(MethodReference ref,
 VolatileMethodSummary summary,
 IClass declaringClass)
                          throws NullPointerException

Throws:

NullPointerException

Method Details

getLocalVariableName

public String getLocalVariableName(int bcIndex,
 int localNumber)

Returns the variable name to a ssa-number.

Does not respect the value of bcIndex.

Specified by:

getLocalVariableName in interface IMethod

Overrides:

getLocalVariableName in class SummarizedMethod

Returns:

the (source code) name of the local variable of a given number at the specified program counter, or null if the information is not available.

hasLocalVariableTable

public boolean hasLocalVariableTable()

Specified by:

hasLocalVariableTable in interface IMethod

Overrides:

hasLocalVariableTable in class SyntheticMethod

Returns:

true iff the local variable table information for this method is available

makeIR

public IR makeIR(Context context,
 SSAOptions options)

Description copied from class: SyntheticMethod

Most subclasses should override this.

Overrides:

makeIR in class SummarizedMethod

Parameters:

context - TODO

options - options governing IR conversion