Class ShrikeCTMethod

java.lang.Object

com.ibm.wala.classLoader.ShrikeBTMethod

com.ibm.wala.classLoader.ShrikeCTMethod

All Implemented Interfaces:

IBytecodeMethod<IInstruction>, IMember, IMethod, ContextItem, IClassHierarchyDweller, BytecodeConstants

public final class ShrikeCTMethod
extends ShrikeBTMethod
implements IBytecodeMethod<IInstruction>

A wrapper around a Shrike object that represents a method

Nested Class Summary

Nested classes/interfaces inherited from class ShrikeBTMethod

ShrikeBTMethod.BytecodeInfo

Modifier and Type	Class	Description
protected static class	ShrikeBTMethod.BytecodeInfo

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 ShrikeBTMethod

declaringClass

Modifier and Type	Field	Description
protected final IClass	declaringClass	A wrapper around the declaring class.

Fields inherited from interface BytecodeConstants

JBC_aaload, JBC_aastore, JBC_aconst_null, JBC_aload, JBC_aload_0, JBC_aload_1, JBC_aload_2, JBC_aload_3, JBC_anewarray, JBC_areturn, JBC_arraylength, JBC_astore, JBC_astore_0, JBC_astore_1, JBC_astore_2, JBC_astore_3, JBC_athrow, JBC_baload, JBC_bastore, JBC_bipush, JBC_caload, JBC_castore, JBC_checkcast, JBC_d2f, JBC_d2i, JBC_d2l, JBC_dadd, JBC_daload, JBC_dastore, JBC_dcmpg, JBC_dcmpl, JBC_dconst_0, JBC_dconst_1, JBC_ddiv, JBC_dload, JBC_dload_0, JBC_dload_1, JBC_dload_2, JBC_dload_3, JBC_dmul, JBC_dneg, JBC_drem, JBC_dreturn, JBC_dstore, JBC_dstore_0, JBC_dstore_1, JBC_dstore_2, JBC_dstore_3, JBC_dsub, JBC_dup, JBC_dup_x1, JBC_dup_x2, JBC_dup2, JBC_dup2_x1, JBC_dup2_x2, JBC_f2d, JBC_f2i, JBC_f2l, JBC_fadd, JBC_faload, JBC_fastore, JBC_fcmpg, JBC_fcmpl, JBC_fconst_0, JBC_fconst_1, JBC_fconst_2, JBC_fdiv, JBC_fload, JBC_fload_0, JBC_fload_1, JBC_fload_2, JBC_fload_3, JBC_fmul, JBC_fneg, JBC_frem, JBC_freturn, JBC_fstore, JBC_fstore_0, JBC_fstore_1, JBC_fstore_2, JBC_fstore_3, JBC_fsub, JBC_getfield, JBC_getstatic, JBC_goto, JBC_goto_w, JBC_i2d, JBC_i2f, JBC_i2l, JBC_iadd, JBC_iaload, JBC_iand, JBC_iastore, JBC_iconst_0, JBC_iconst_1, JBC_iconst_2, JBC_iconst_3, JBC_iconst_4, JBC_iconst_5, JBC_iconst_m1, JBC_idiv, JBC_if_acmpeq, JBC_if_acmpne, JBC_if_icmpeq, JBC_if_icmpge, JBC_if_icmpgt, JBC_if_icmple, JBC_if_icmplt, JBC_if_icmpne, JBC_ifeq, JBC_ifge, JBC_ifgt, JBC_ifle, JBC_iflt, JBC_ifne, JBC_ifnonnull, JBC_ifnull, JBC_iinc, JBC_iload, JBC_iload_0, JBC_iload_1, JBC_iload_2, JBC_iload_3, JBC_impdep1, JBC_impdep2, JBC_imul, JBC_ineg, JBC_instanceof, JBC_int2byte, JBC_int2char, JBC_int2short, JBC_invokeinterface, JBC_invokespecial, JBC_invokestatic, JBC_invokevirtual, JBC_ior, JBC_irem, JBC_ireturn, JBC_ishl, JBC_ishr, JBC_istore, JBC_istore_0, JBC_istore_1, JBC_istore_2, JBC_istore_3, JBC_isub, JBC_iushr, JBC_ixor, JBC_jsr, JBC_jsr_w, JBC_l2d, JBC_l2f, JBC_l2i, JBC_ladd, JBC_laload, JBC_land, JBC_lastore, JBC_lcmp, JBC_lconst_0, JBC_lconst_1, JBC_ldc, JBC_ldc_w, JBC_ldc2_w, JBC_ldiv, JBC_length, JBC_lload, JBC_lload_0, JBC_lload_1, JBC_lload_2, JBC_lload_3, JBC_lmul, JBC_lneg, JBC_lookupswitch, JBC_lor, JBC_lrem, JBC_lreturn, JBC_lshl, JBC_lshr, JBC_lstore, JBC_lstore_0, JBC_lstore_1, JBC_lstore_2, JBC_lstore_3, JBC_lsub, JBC_lushr, JBC_lxor, JBC_monitorenter, JBC_monitorexit, JBC_multianewarray, JBC_name, JBC_new, JBC_newarray, JBC_nop, JBC_pop, JBC_pop2, JBC_putfield, JBC_putstatic, JBC_ret, JBC_return, JBC_saload, JBC_sastore, JBC_sipush, JBC_swap, JBC_tableswitch, JBC_wide, JBC_xxxunusedxxx

Modifier and Type	Field	Description
static final int	JBC_aaload
static final int	JBC_aastore
static final int	JBC_aconst_null
static final int	JBC_aload
static final int	JBC_aload_0
static final int	JBC_aload_1
static final int	JBC_aload_2
static final int	JBC_aload_3
static final int	JBC_anewarray
static final int	JBC_areturn
static final int	JBC_arraylength
static final int	JBC_astore
static final int	JBC_astore_0
static final int	JBC_astore_1
static final int	JBC_astore_2
static final int	JBC_astore_3
static final int	JBC_athrow
static final int	JBC_baload
static final int	JBC_bastore
static final int	JBC_bipush
static final int	JBC_caload
static final int	JBC_castore
static final int	JBC_checkcast
static final int	JBC_d2f
static final int	JBC_d2i
static final int	JBC_d2l
static final int	JBC_dadd
static final int	JBC_daload
static final int	JBC_dastore
static final int	JBC_dcmpg
static final int	JBC_dcmpl
static final int	JBC_dconst_0
static final int	JBC_dconst_1
static final int	JBC_ddiv
static final int	JBC_dload
static final int	JBC_dload_0
static final int	JBC_dload_1
static final int	JBC_dload_2
static final int	JBC_dload_3
static final int	JBC_dmul
static final int	JBC_dneg
static final int	JBC_drem
static final int	JBC_dreturn
static final int	JBC_dstore
static final int	JBC_dstore_0
static final int	JBC_dstore_1
static final int	JBC_dstore_2
static final int	JBC_dstore_3
static final int	JBC_dsub
static final int	JBC_dup
static final int	JBC_dup_x1
static final int	JBC_dup_x2
static final int	JBC_dup2
static final int	JBC_dup2_x1
static final int	JBC_dup2_x2
static final int	JBC_f2d
static final int	JBC_f2i
static final int	JBC_f2l
static final int	JBC_fadd
static final int	JBC_faload
static final int	JBC_fastore
static final int	JBC_fcmpg
static final int	JBC_fcmpl
static final int	JBC_fconst_0
static final int	JBC_fconst_1
static final int	JBC_fconst_2
static final int	JBC_fdiv
static final int	JBC_fload
static final int	JBC_fload_0
static final int	JBC_fload_1
static final int	JBC_fload_2
static final int	JBC_fload_3
static final int	JBC_fmul
static final int	JBC_fneg
static final int	JBC_frem
static final int	JBC_freturn
static final int	JBC_fstore
static final int	JBC_fstore_0
static final int	JBC_fstore_1
static final int	JBC_fstore_2
static final int	JBC_fstore_3
static final int	JBC_fsub
static final int	JBC_getfield
static final int	JBC_getstatic
static final int	JBC_goto
static final int	JBC_goto_w
static final int	JBC_i2d
static final int	JBC_i2f
static final int	JBC_i2l
static final int	JBC_iadd
static final int	JBC_iaload
static final int	JBC_iand
static final int	JBC_iastore
static final int	JBC_iconst_0
static final int	JBC_iconst_1
static final int	JBC_iconst_2
static final int	JBC_iconst_3
static final int	JBC_iconst_4
static final int	JBC_iconst_5
static final int	JBC_iconst_m1
static final int	JBC_idiv
static final int	JBC_if_acmpeq
static final int	JBC_if_acmpne
static final int	JBC_if_icmpeq
static final int	JBC_if_icmpge
static final int	JBC_if_icmpgt
static final int	JBC_if_icmple
static final int	JBC_if_icmplt
static final int	JBC_if_icmpne
static final int	JBC_ifeq
static final int	JBC_ifge
static final int	JBC_ifgt
static final int	JBC_ifle
static final int	JBC_iflt
static final int	JBC_ifne
static final int	JBC_ifnonnull
static final int	JBC_ifnull
static final int	JBC_iinc
static final int	JBC_iload
static final int	JBC_iload_0
static final int	JBC_iload_1
static final int	JBC_iload_2
static final int	JBC_iload_3
static final int	JBC_impdep1
static final int	JBC_impdep2
static final int	JBC_imul
static final int	JBC_ineg
static final int	JBC_instanceof
static final int	JBC_int2byte
static final int	JBC_int2char
static final int	JBC_int2short
static final int	JBC_invokeinterface
static final int	JBC_invokespecial
static final int	JBC_invokestatic
static final int	JBC_invokevirtual
static final int	JBC_ior
static final int	JBC_irem
static final int	JBC_ireturn
static final int	JBC_ishl
static final int	JBC_ishr
static final int	JBC_istore
static final int	JBC_istore_0
static final int	JBC_istore_1
static final int	JBC_istore_2
static final int	JBC_istore_3
static final int	JBC_isub
static final int	JBC_iushr
static final int	JBC_ixor
static final int	JBC_jsr
static final int	JBC_jsr_w
static final int	JBC_l2d
static final int	JBC_l2f
static final int	JBC_l2i
static final int	JBC_ladd
static final int	JBC_laload
static final int	JBC_land
static final int	JBC_lastore
static final int	JBC_lcmp
static final int	JBC_lconst_0
static final int	JBC_lconst_1
static final int	JBC_ldc
static final int	JBC_ldc_w
static final int	JBC_ldc2_w
static final int	JBC_ldiv
static final byte[]	JBC_length
static final int	JBC_lload
static final int	JBC_lload_0
static final int	JBC_lload_1
static final int	JBC_lload_2
static final int	JBC_lload_3
static final int	JBC_lmul
static final int	JBC_lneg
static final int	JBC_lookupswitch
static final int	JBC_lor
static final int	JBC_lrem
static final int	JBC_lreturn
static final int	JBC_lshl
static final int	JBC_lshr
static final int	JBC_lstore
static final int	JBC_lstore_0
static final int	JBC_lstore_1
static final int	JBC_lstore_2
static final int	JBC_lstore_3
static final int	JBC_lsub
static final int	JBC_lushr
static final int	JBC_lxor
static final int	JBC_monitorenter
static final int	JBC_monitorexit
static final int	JBC_multianewarray
static final String[]	JBC_name	Bytecode names (for debugging/printing)
static final int	JBC_new
static final int	JBC_newarray
static final int	JBC_nop
static final int	JBC_pop
static final int	JBC_pop2
static final int	JBC_putfield
static final int	JBC_putstatic
static final int	JBC_ret
static final int	JBC_return
static final int	JBC_saload
static final int	JBC_sastore
static final int	JBC_sipush
static final int	JBC_swap
static final int	JBC_tableswitch
static final int	JBC_wide
static final int	JBC_xxxunusedxxx

Constructor Summary

Constructors

Constructor	Description
ShrikeCTMethod(IClass klass, int index)

Method Summary

Modifier and Type	Method	Description
Collection<Annotation>	getAnnotations()	Get the annotations on this member, if any
Collection<Annotation>	getAnnotations(boolean runtimeInvisible)
byte[]	getBytecodes()
IClassHierarchy	getClassHierarchy()
protected String[]	getDeclaredExceptionTypeNames()
IndirectionData	getIndirectionData()
String	getLocalVariableName(int bcIndex, int localNumber)
int	getMaxLocals()
int	getMaxStackHeight()
protected String	getMethodName()
protected String	getMethodSignature()
MethodTypeSignature	getMethodTypeSignature()	UNDER CONSTRUCTION
protected int	getModifiers()
Collection<Annotation>[]	getParameterAnnotations()	get annotations on parameters as an array of Collections, where each array element gives the annotations on the corresponding parameter.
TypeReference	getReturnType()
Collection<Annotation>	getRuntimeInvisibleAnnotations()	read the runtime-invisible annotations from the class file
Collection<Annotation>	getRuntimeVisibleAnnotations()	read the runtime-visible annotations from the class file
Collection<TypeAnnotation>	getTypeAnnotationsAtCode(boolean runtimeInvisible)
Collection<TypeAnnotation>	getTypeAnnotationsAtMethodInfo(boolean runtimeInvisible)
boolean	hasExceptionHandler()
boolean	hasLocalVariableTable()
protected Decoder	makeDecoder()	Find the decoder object for this method, or create one if necessary.
protected void	processDebugInfo(ShrikeBTMethod.BytecodeInfo bcInfo)	Walk through the bytecodes and collect trivial information.

Methods inherited from class ShrikeBTMethod

clearCaches, equals, getArraysRead, getArraysWritten, getBCInfo, getBytecodeIndex, getBytecodeStream, getCallSites, getCastTypes, getCaughtExceptionTypes, getDeclaredExceptions, getDeclaringClass, getDescriptor, getFieldsRead, getFieldsWritten, getHandlers, getImplicitExceptionTypes, getInstructionIndex, getInstructions, getLineNumber, getName, getNewSites, getNumberOfParameters, getNumShrikeInstructions, getParameterSourcePosition, getParameterType, getReference, getSelector, getSignature, getSourcePosition, hashCode, hasMonitorOp, isAbstract, isAnnotation, isBridge, isClinit, isEnum, isFinal, isInit, isModule, isNative, isPrivate, isProtected, isPublic, isStatic, isSynchronized, isSynthetic, isWalaSynthetic, toString

Modifier and Type	Method	Description
void	clearCaches()	Clear all optional cached data associated with this class.
boolean	equals(Object obj)
Iterator<TypeReference>	getArraysRead()
Iterator<TypeReference>	getArraysWritten()
protected ShrikeBTMethod.BytecodeInfo	getBCInfo()
int	getBytecodeIndex(int instructionIndex)	Return the program counter (bytecode index) for a particular Shrike instruction index.
BytecodeStream	getBytecodeStream()	Method getBytecodeStream.
Collection<CallSiteReference>	getCallSites()
Iterator<TypeReference>	getCastTypes()
Set<TypeReference>	getCaughtExceptionTypes()
TypeReference[]	getDeclaredExceptions()	Clients should not modify the returned array.
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;
Iterator<FieldReference>	getFieldsRead()
Iterator<FieldReference>	getFieldsWritten()
ExceptionHandler[][]	getHandlers()
Collection<TypeReference>	getImplicitExceptionTypes()
int	getInstructionIndex(int bcIndex)	Return the Shrike instruction index for a particular valid program counter (bytecode index), or -1 if the Shrike instruction index could not be determined.
IInstruction[]	getInstructions()
int	getLineNumber(int bcIndex)
Atom	getName()
Collection<NewSiteReference>	getNewSites()
int	getNumberOfParameters()	Method getNumberOfParameters.
int	getNumShrikeInstructions()	Return the number of Shrike instructions for this method.
IMethod.SourcePosition	getParameterSourcePosition(int paramNum)
TypeReference	getParameterType(int i)	By convention, for a non-static method, getParameterType(0) is the this pointer
MethodReference	getReference()
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)
int	hashCode()
boolean	hasMonitorOp()
boolean	isAbstract()	Is this method abstract?
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	isFinal()	Is this method final?
boolean	isInit()	Is this method an object initializer?
boolean	isModule()
boolean	isNative()	Is this method native?
boolean	isPrivate()	Is this method private?
boolean	isProtected()	Is this method protected?
boolean	isPublic()	Is this method public?
boolean	isStatic()	Is this member static?
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()
String	toString()

Methods inherited from class Object

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

Methods inherited from interface IBytecodeMethod

getArraysWritten, getBytecodeIndex, getCallSites, getFieldsRead, getFieldsWritten, getHandlers, getInstructionIndex, getInstructions, getNewSites

Modifier and Type	Method	Description
Iterator<TypeReference>	getArraysWritten()
int	getBytecodeIndex(int i)
Collection<CallSiteReference>	getCallSites()	there
Iterator<FieldReference>	getFieldsRead()
Iterator<FieldReference>	getFieldsWritten()
ExceptionHandler[][]	getHandlers()
int	getInstructionIndex(int bcIndex)
IInstruction[]	getInstructions()
Collection<NewSiteReference>	getNewSites()

Methods inherited from interface IMethod

getNumberOfDefaultParameters

Modifier and Type	Method	Description
default int	getNumberOfDefaultParameters()

Constructor Details

ShrikeCTMethod

public ShrikeCTMethod(IClass klass,
 int index)

Method Details

getBytecodes

public byte[] getBytecodes()

Specified by:

getBytecodes in class ShrikeBTMethod

getMethodName

protected String getMethodName()
                        throws InvalidClassFileException

Specified by:

getMethodName in class ShrikeBTMethod

Throws:

InvalidClassFileException

getMethodSignature

protected String getMethodSignature()
                             throws InvalidClassFileException

Specified by:

getMethodSignature in class ShrikeBTMethod

Throws:

InvalidClassFileException

getModifiers

protected int getModifiers()

Specified by:

getModifiers in class ShrikeBTMethod

makeDecoder

protected Decoder makeDecoder()

Description copied from class: ShrikeBTMethod

Find the decoder object for this method, or create one if necessary.

Specified by:

makeDecoder in class ShrikeBTMethod

Returns:

null if the method has no code.

getMaxLocals

public int getMaxLocals()

Specified by:

getMaxLocals in class ShrikeBTMethod

See Also:

• SyntheticMethod.getMaxLocals()

getMaxStackHeight

public int getMaxStackHeight()

Specified by:

getMaxStackHeight in class ShrikeBTMethod

hasExceptionHandler

public boolean hasExceptionHandler()

Specified by:

hasExceptionHandler in interface IMethod

Specified by:

hasExceptionHandler in class ShrikeBTMethod

Returns:

true iff this method has at least one exception handler

getDeclaredExceptionTypeNames

protected String[] getDeclaredExceptionTypeNames()
                                          throws InvalidClassFileException

Specified by:

getDeclaredExceptionTypeNames in class ShrikeBTMethod

Throws:

InvalidClassFileException

processDebugInfo

protected void processDebugInfo(ShrikeBTMethod.BytecodeInfo bcInfo)
                         throws InvalidClassFileException

Description copied from class: ShrikeBTMethod

Walk through the bytecodes and collect trivial information.

Specified by:

processDebugInfo in class ShrikeBTMethod

Throws:

InvalidClassFileException

getLocalVariableName

public String getLocalVariableName(int bcIndex,
 int localNumber)

Specified by:

getLocalVariableName in interface IMethod

Specified by:

getLocalVariableName in class ShrikeBTMethod

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

Specified by:

hasLocalVariableTable in class ShrikeBTMethod

Returns:

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

getReturnType

public TypeReference getReturnType()

Specified by:

getReturnType in interface IMethod

Returns:

the name of the return type for this method

getClassHierarchy

public IClassHierarchy getClassHierarchy()

Specified by:

getClassHierarchy in interface IClassHierarchyDweller

getMethodTypeSignature

public MethodTypeSignature getMethodTypeSignature()
                                           throws InvalidClassFileException

UNDER CONSTRUCTION

Throws:

InvalidClassFileException

getRuntimeInvisibleAnnotations

public Collection<Annotation> getRuntimeInvisibleAnnotations()
                                                      throws InvalidClassFileException

read the runtime-invisible annotations from the class file

Throws:

InvalidClassFileException

getRuntimeVisibleAnnotations

public Collection<Annotation> getRuntimeVisibleAnnotations()
                                                    throws InvalidClassFileException

read the runtime-visible annotations from the class file

Throws:

InvalidClassFileException

getAnnotations

public Collection<Annotation> getAnnotations(boolean runtimeInvisible)
                                      throws InvalidClassFileException

Specified by:

getAnnotations in interface IBytecodeMethod<IInstruction>

Throws:

InvalidClassFileException

getTypeAnnotationsAtMethodInfo

public Collection<TypeAnnotation> getTypeAnnotationsAtMethodInfo(boolean runtimeInvisible)
                                                          throws InvalidClassFileException

Throws:

InvalidClassFileException

getTypeAnnotationsAtCode

public Collection<TypeAnnotation> getTypeAnnotationsAtCode(boolean runtimeInvisible)
                                                    throws InvalidClassFileException

Throws:

InvalidClassFileException

getAnnotations

public Collection<Annotation> getAnnotations()

Description copied from interface: IMember

Get the annotations on this member, if any

Specified by:

getAnnotations in interface IMember

getParameterAnnotations

public Collection<Annotation>[] getParameterAnnotations()

get annotations on parameters as an array of Collections, where each array element gives the annotations on the corresponding parameter. Note that the 'this' parameter for an instance method cannot have annotations.

Specified by:

getParameterAnnotations in interface IBytecodeMethod<IInstruction>

getIndirectionData

public IndirectionData getIndirectionData()

Specified by:

getIndirectionData in interface IBytecodeMethod<IInstruction>

Returns:

information about any indirect uses of local variables