public class AnalyzerAdapter extends MethodVisitor
MethodVisitor
that keeps track of stack map frame changes between visitFrame(int, int, Object[], int, Object[])
calls. This adapter must be used with the ClassReader.EXPAND_FRAMES
option. Each visitX instruction delegates to
the next visitor in the chain, if any, and then simulates the effect of this instruction on the
stack map frame, represented by locals
and stack
. The next visitor in the chain
can get the state of the stack map frame before each instruction by reading the value of
these fields in its visitX methods (this requires a reference to the AnalyzerAdapter that
is before it in the chain). If this adapter is used with a class that does not contain stack map
table attributes (i.e., pre Java 6 classes) then this adapter may not be able to compute the
stack map frame for each instruction. In this case no exception is thrown but the locals
and stack
fields will be null for these instructions.Modifier and Type | Field and Description |
---|---|
List<Object> |
locals
The local variable slots for the current execution frame.
|
List<Object> |
stack
The operand stack slots for the current execution frame.
|
Map<Object,Object> |
uninitializedTypes
The uninitialized types in the current execution frame.
|
api, mv
Modifier | Constructor and Description |
---|---|
protected |
AnalyzerAdapter(int api,
String owner,
int access,
String name,
String descriptor,
MethodVisitor methodVisitor)
Constructs a new
AnalyzerAdapter . |
|
AnalyzerAdapter(String owner,
int access,
String name,
String descriptor,
MethodVisitor methodVisitor)
Constructs a new
AnalyzerAdapter . |
Modifier and Type | Method and Description |
---|---|
void |
visitFieldInsn(int opcode,
String owner,
String name,
String descriptor)
Visits a field instruction.
|
void |
visitFrame(int type,
int numLocal,
Object[] local,
int numStack,
Object[] stack)
Visits the current state of the local variables and operand stack elements.
|
void |
visitIincInsn(int var,
int increment)
Visits an IINC instruction.
|
void |
visitInsn(int opcode)
Visits a zero operand instruction.
|
void |
visitIntInsn(int opcode,
int operand)
Visits an instruction with a single int operand.
|
void |
visitInvokeDynamicInsn(String name,
String descriptor,
Handle bootstrapMethodHandle,
Object... bootstrapMethodArguments)
Visits an invokedynamic instruction.
|
void |
visitJumpInsn(int opcode,
Label label)
Visits a jump instruction.
|
void |
visitLabel(Label label)
Visits a label.
|
void |
visitLdcInsn(Object value)
Visits a LDC instruction.
|
void |
visitLocalVariable(String name,
String descriptor,
String signature,
Label start,
Label end,
int index)
Visits a local variable declaration.
|
void |
visitLookupSwitchInsn(Label dflt,
int[] keys,
Label[] labels)
Visits a LOOKUPSWITCH instruction.
|
void |
visitMaxs(int maxStack,
int maxLocals)
Visits the maximum stack size and the maximum number of local variables of the method.
|
void |
visitMethodInsn(int opcodeAndSource,
String owner,
String name,
String descriptor,
boolean isInterface)
Visits a method instruction.
|
void |
visitMultiANewArrayInsn(String descriptor,
int numDimensions)
Visits a MULTIANEWARRAY instruction.
|
void |
visitTableSwitchInsn(int min,
int max,
Label dflt,
Label... labels)
Visits a TABLESWITCH instruction.
|
void |
visitTypeInsn(int opcode,
String type)
Visits a type instruction.
|
void |
visitVarInsn(int opcode,
int var)
Visits a local variable instruction.
|
visitAnnotableParameterCount, visitAnnotation, visitAnnotationDefault, visitAttribute, visitCode, visitEnd, visitInsnAnnotation, visitLineNumber, visitLocalVariableAnnotation, visitMethodInsn, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTryCatchBlock, visitTypeAnnotation
public List<Object> locals
Opcodes.TOP
, Opcodes.INTEGER
, Opcodes.FLOAT
, Opcodes.LONG
,
Opcodes.DOUBLE
,Opcodes.NULL
or Opcodes.UNINITIALIZED_THIS
(long and
double are represented by two elements, the second one being TOP). Reference types are
represented by String objects (representing internal names), and uninitialized types by Label
objects (this label designates the NEW instruction that created this uninitialized value). This
field is null for unreachable instructions.public List<Object> stack
Opcodes.TOP
, Opcodes.INTEGER
, Opcodes.FLOAT
, Opcodes.LONG
,
Opcodes.DOUBLE
,Opcodes.NULL
or Opcodes.UNINITIALIZED_THIS
(long and
double are represented by two elements, the second one being TOP). Reference types are
represented by String objects (representing internal names), and uninitialized types by Label
objects (this label designates the NEW instruction that created this uninitialized value). This
field is null for unreachable instructions.public Map<Object,Object> uninitializedTypes
public AnalyzerAdapter(String owner, int access, String name, String descriptor, MethodVisitor methodVisitor)
AnalyzerAdapter
. Subclasses must not use this constructor.
Instead, they must use the AnalyzerAdapter(int, String, int, String, String,
MethodVisitor)
version.owner
- the owner's class name.access
- the method's access flags (see Opcodes
).name
- the method's name.descriptor
- the method's descriptor (see Type
).methodVisitor
- the method visitor to which this adapter delegates calls. May be null.IllegalStateException
- If a subclass calls this constructor.protected AnalyzerAdapter(int api, String owner, int access, String name, String descriptor, MethodVisitor methodVisitor)
AnalyzerAdapter
.api
- the ASM API version implemented by this visitor. Must be one of Opcodes.ASM4
, Opcodes.ASM5
, Opcodes.ASM6
, Opcodes.ASM7
or Opcodes.ASM8
.owner
- the owner's class name.access
- the method's access flags (see Opcodes
).name
- the method's name.descriptor
- the method's descriptor (see Type
).methodVisitor
- the method visitor to which this adapter delegates calls. May be null.public void visitFrame(int type, int numLocal, Object[] local, int numStack, Object[] stack)
MethodVisitor
Opcodes.V1_6
. Opcodes.F_SAME
representing frame with exactly the same locals as the
previous frame and with the empty stack.
Opcodes.F_SAME1
representing frame with exactly the same locals as the
previous frame and with single value on the stack ( numStack
is 1 and
stack[0]
contains value for the type of the stack item).
Opcodes.F_APPEND
representing frame with current locals are the same as the
locals in the previous frame, except that additional locals are defined (
numLocal
is 1, 2 or 3 and local
elements contains values
representing added types).
Opcodes.F_CHOP
representing frame with current locals are the same as the
locals in the previous frame, except that the last 1-3 locals are absent and with
the empty stack (numLocal
is 1, 2 or 3).
Opcodes.F_FULL
representing complete frame data.
visitFrame
in class MethodVisitor
type
- the type of this stack map frame. Must be Opcodes.F_NEW
for expanded
frames, or Opcodes.F_FULL
, Opcodes.F_APPEND
, Opcodes.F_CHOP
, Opcodes.F_SAME
or Opcodes.F_APPEND
, Opcodes.F_SAME1
for compressed frames.numLocal
- the number of local variables in the visited frame.local
- the local variable types in this frame. This array must not be modified. Primitive
types are represented by Opcodes.TOP
, Opcodes.INTEGER
, Opcodes.FLOAT
, Opcodes.LONG
, Opcodes.DOUBLE
, Opcodes.NULL
or
Opcodes.UNINITIALIZED_THIS
(long and double are represented by a single element).
Reference types are represented by String objects (representing internal names), and
uninitialized types by Label objects (this label designates the NEW instruction that
created this uninitialized value).numStack
- the number of operand stack elements in the visited frame.stack
- the operand stack types in this frame. This array must not be modified. Its
content has the same format as the "local" array.public void visitInsn(int opcode)
MethodVisitor
visitInsn
in class MethodVisitor
opcode
- the opcode of the instruction to be visited. This opcode is either NOP,
ACONST_NULL, ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5,
LCONST_0, LCONST_1, FCONST_0, FCONST_1, FCONST_2, DCONST_0, DCONST_1, IALOAD, LALOAD,
FALOAD, DALOAD, AALOAD, BALOAD, CALOAD, SALOAD, IASTORE, LASTORE, FASTORE, DASTORE,
AASTORE, BASTORE, CASTORE, SASTORE, POP, POP2, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2,
SWAP, IADD, LADD, FADD, DADD, ISUB, LSUB, FSUB, DSUB, IMUL, LMUL, FMUL, DMUL, IDIV, LDIV,
FDIV, DDIV, IREM, LREM, FREM, DREM, INEG, LNEG, FNEG, DNEG, ISHL, LSHL, ISHR, LSHR, IUSHR,
LUSHR, IAND, LAND, IOR, LOR, IXOR, LXOR, I2L, I2F, I2D, L2I, L2F, L2D, F2I, F2L, F2D, D2I,
D2L, D2F, I2B, I2C, I2S, LCMP, FCMPL, FCMPG, DCMPL, DCMPG, IRETURN, LRETURN, FRETURN,
DRETURN, ARETURN, RETURN, ARRAYLENGTH, ATHROW, MONITORENTER, or MONITOREXIT.public void visitIntInsn(int opcode, int operand)
MethodVisitor
visitIntInsn
in class MethodVisitor
opcode
- the opcode of the instruction to be visited. This opcode is either BIPUSH, SIPUSH
or NEWARRAY.operand
- the operand of the instruction to be visited.Opcodes.T_BOOLEAN
, Opcodes.T_CHAR
, Opcodes.T_FLOAT
, Opcodes.T_DOUBLE
, Opcodes.T_BYTE
,
Opcodes.T_SHORT
, Opcodes.T_INT
or Opcodes.T_LONG
.public void visitVarInsn(int opcode, int var)
MethodVisitor
visitVarInsn
in class MethodVisitor
opcode
- the opcode of the local variable instruction to be visited. This opcode is either
ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.var
- the operand of the instruction to be visited. This operand is the index of a local
variable.public void visitTypeInsn(int opcode, String type)
MethodVisitor
visitTypeInsn
in class MethodVisitor
opcode
- the opcode of the type instruction to be visited. This opcode is either NEW,
ANEWARRAY, CHECKCAST or INSTANCEOF.type
- the operand of the instruction to be visited. This operand must be the internal
name of an object or array class (see Type.getInternalName()
).public void visitFieldInsn(int opcode, String owner, String name, String descriptor)
MethodVisitor
visitFieldInsn
in class MethodVisitor
opcode
- the opcode of the type instruction to be visited. This opcode is either
GETSTATIC, PUTSTATIC, GETFIELD or PUTFIELD.owner
- the internal name of the field's owner class (see Type.getInternalName()
).name
- the field's name.descriptor
- the field's descriptor (see Type
).public void visitMethodInsn(int opcodeAndSource, String owner, String name, String descriptor, boolean isInterface)
MethodVisitor
visitMethodInsn
in class MethodVisitor
opcodeAndSource
- the opcode of the type instruction to be visited. This opcode is either
INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.owner
- the internal name of the method's owner class (see Type.getInternalName()
).name
- the method's name.descriptor
- the method's descriptor (see Type
).isInterface
- if the method's owner class is an interface.public void visitInvokeDynamicInsn(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments)
MethodVisitor
visitInvokeDynamicInsn
in class MethodVisitor
name
- the method's name.descriptor
- the method's descriptor (see Type
).bootstrapMethodHandle
- the bootstrap method.bootstrapMethodArguments
- the bootstrap method constant arguments. Each argument must be
an Integer
, Float
, Long
, Double
, String
, Type
, Handle
or ConstantDynamic
value. This method is allowed to modify
the content of the array so a caller should expect that this array may change.public void visitJumpInsn(int opcode, Label label)
MethodVisitor
visitJumpInsn
in class MethodVisitor
opcode
- the opcode of the type instruction to be visited. This opcode is either IFEQ,
IFNE, IFLT, IFGE, IFGT, IFLE, IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT,
IF_ICMPLE, IF_ACMPEQ, IF_ACMPNE, GOTO, JSR, IFNULL or IFNONNULL.label
- the operand of the instruction to be visited. This operand is a label that
designates the instruction to which the jump instruction may jump.public void visitLabel(Label label)
MethodVisitor
visitLabel
in class MethodVisitor
label
- a Label
object.public void visitLdcInsn(Object value)
MethodVisitor
if (cst instanceof Integer) { // ... } else if (cst instanceof Float) { // ... } else if (cst instanceof Long) { // ... } else if (cst instanceof Double) { // ... } else if (cst instanceof String) { // ... } else if (cst instanceof Type) { int sort = ((Type) cst).getSort(); if (sort == Type.OBJECT) { // ... } else if (sort == Type.ARRAY) { // ... } else if (sort == Type.METHOD) { // ... } else { // throw an exception } } else if (cst instanceof Handle) { // ... } else if (cst instanceof ConstantDynamic) { // ... } else { // throw an exception }
visitLdcInsn
in class MethodVisitor
value
- the constant to be loaded on the stack. This parameter must be a non null Integer
, a Float
, a Long
, a Double
, a String
, a Type
of OBJECT or ARRAY sort for .class
constants, for classes whose version is
49, a Type
of METHOD sort for MethodType, a Handle
for MethodHandle
constants, for classes whose version is 51 or a ConstantDynamic
for a constant
dynamic for classes whose version is 55.public void visitIincInsn(int var, int increment)
MethodVisitor
visitIincInsn
in class MethodVisitor
var
- index of the local variable to be incremented.increment
- amount to increment the local variable by.public void visitTableSwitchInsn(int min, int max, Label dflt, Label... labels)
MethodVisitor
visitTableSwitchInsn
in class MethodVisitor
min
- the minimum key value.max
- the maximum key value.dflt
- beginning of the default handler block.labels
- beginnings of the handler blocks. labels[i]
is the beginning of the
handler block for the min + i
key.public void visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels)
MethodVisitor
visitLookupSwitchInsn
in class MethodVisitor
dflt
- beginning of the default handler block.keys
- the values of the keys.labels
- beginnings of the handler blocks. labels[i]
is the beginning of the
handler block for the keys[i]
key.public void visitMultiANewArrayInsn(String descriptor, int numDimensions)
MethodVisitor
visitMultiANewArrayInsn
in class MethodVisitor
descriptor
- an array type descriptor (see Type
).numDimensions
- the number of dimensions of the array to allocate.public void visitLocalVariable(String name, String descriptor, String signature, Label start, Label end, int index)
MethodVisitor
visitLocalVariable
in class MethodVisitor
name
- the name of a local variable.descriptor
- the type descriptor of this local variable.signature
- the type signature of this local variable. May be null if the local
variable type does not use generic types.start
- the first instruction corresponding to the scope of this local variable
(inclusive).end
- the last instruction corresponding to the scope of this local variable (exclusive).index
- the local variable's index.public void visitMaxs(int maxStack, int maxLocals)
MethodVisitor
visitMaxs
in class MethodVisitor
maxStack
- maximum stack size of the method.maxLocals
- maximum number of local variables for the method.Copyright © 2023. All rights reserved.