Package org.objectweb.asm.util
Class CheckMethodAdapter
- java.lang.Object
-
- org.objectweb.asm.MethodVisitor
-
- org.objectweb.asm.util.CheckMethodAdapter
-
public class CheckMethodAdapter extends MethodVisitor
AMethodVisitor
that checks that its methods are properly used. More precisely this method adapter checks each instruction individually, i.e., each visit method checks some preconditions based only on its arguments - such as the fact that the given opcode is correct for a given visit method. This adapter can also perform some basic data flow checks (more precisely those that can be performed without the full class hierarchy - seeBasicVerifier
). For instance in a method whose signature isvoid m ()
, the invalid instruction IRETURN, or the invalid sequence IADD L2I will be detected if the data flow checks are enabled. These checks are enabled by using theCheckMethodAdapter(int,String,String,MethodVisitor,Map)
constructor. They are not performed if any other constructor is used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
CheckMethodAdapter.Method
The 'generic' instruction visit methods (i.e.
-
Field Summary
Fields Modifier and Type Field Description private int
access
The access flags of the visited method.private static java.lang.String
END_LABEL
private java.util.List<Label>
handlers
The exception handler ranges.private int
insnCount
The number of visited instructions so far.private static java.lang.String
INVALID
private static java.lang.String
INVALID_DESCRIPTOR
private static java.lang.String
INVALID_LOCAL_VARIABLE_INDEX
private static java.lang.String
INVALID_TYPE_REFERENCE
private int
invisibleAnnotableParameterCount
The number of method parameters that can have runtime invisible annotations.private java.util.Map<Label,java.lang.Integer>
labelInsnIndices
The index of the instruction designated by each visited label.private int
lastFrameInsnIndex
The index of the instruction corresponding to the last visited stack map frame.private static java.lang.String
MUST_NOT_BE_NULL_OR_EMPTY
private int
numCompressedFrames
The number of visited frames in compressed form.private int
numExpandedFrames
The number of visited frames in expanded form.private static CheckMethodAdapter.Method[]
OPCODE_METHODS
The method to use to visit each instruction.private java.util.Set<Label>
referencedLabels
The labels referenced by the visited method.private static java.lang.String
START_LABEL
int
version
The class version number.private int
visibleAnnotableParameterCount
The number of method parameters that can have runtime visible annotations.private boolean
visitCodeCalled
Whether thevisitCode()
method has been called.private boolean
visitEndCalled
Whether thevisitEnd()
method has been called.private boolean
visitMaxCalled
Whether thevisitMaxs(int, int)
method has been called.-
Fields inherited from class org.objectweb.asm.MethodVisitor
api, mv
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CheckMethodAdapter(int api, int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object.CheckMethodAdapter(int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object.protected
CheckMethodAdapter(int api, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object.CheckMethodAdapter(MethodVisitor methodvisitor)
Constructs a newCheckMethodAdapter
object.CheckMethodAdapter(MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) static void
checkConstant(java.lang.Object value)
Checks that the given value is anInteger
,Float
,Long
,Double
orString
value.(package private) static void
checkDescriptor(int version, java.lang.String descriptor, boolean canBeVoid)
Checks that the given string is a valid type descriptor.private static int
checkDescriptor(int version, java.lang.String descriptor, int startPos, boolean canBeVoid)
Checks that a the given substring is a valid type descriptor.private void
checkFrameValue(java.lang.Object value)
Checks a stack frame value.(package private) static void
checkIdentifier(int version, java.lang.String name, int startPos, int endPos, java.lang.String message)
Checks that the given substring is a valid Java identifier.private static void
checkInternalClassName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid internal class name.(package private) static void
checkInternalName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid internal class name or array type descriptor.private void
checkLabel(Label label, boolean checkVisited, java.lang.String message)
Checks that the given label is not null.private void
checkLdcConstant(java.lang.Object value)
Checks that the given value is a valid operand for the LDC instruction.(package private) static void
checkMethodDescriptor(int version, java.lang.String descriptor)
Checks that the given string is a valid method descriptor.(package private) static void
checkMethodIdentifier(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid Java identifier.private static void
checkOpcodeMethod(int opcode, CheckMethodAdapter.Method method)
Checks that the method to visit the given opcode is equal to the given method.private static void
checkSignedByte(int value, java.lang.String message)
Checks that the given value is a signed byte.private static void
checkSignedShort(int value, java.lang.String message)
Checks that the given value is a signed short.(package private) static void
checkUnqualifiedName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid unqualified name.private static void
checkUnsignedShort(int value, java.lang.String message)
Checks that the given value is an unsigned short.private void
checkVisitCodeCalled()
Checks that thevisitCode()
method has been called.private void
checkVisitEndNotCalled()
Checks that thevisitEnd()
method has not been called.private void
checkVisitMaxsNotCalled()
Checks that thevisitMaxs(int, int)
method has not been called.void
visitAnnotableParameterCount(int parameterCount, boolean visible)
Visits the number of method parameters that can have annotations.AnnotationVisitor
visitAnnotation(java.lang.String descriptor, boolean visible)
Visits an annotation of this method.AnnotationVisitor
visitAnnotationDefault()
Visits the default value of this annotation interface method.void
visitAttribute(Attribute attribute)
Visits a non standard attribute of this method.void
visitCode()
Starts the visit of the method's code, if any (i.e.void
visitEnd()
Visits the end of the method.void
visitFieldInsn(int opcode, java.lang.String owner, java.lang.String name, java.lang.String descriptor)
Visits a field instruction.void
visitFrame(int type, int numLocal, java.lang.Object[] local, int numStack, java.lang.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.AnnotationVisitor
visitInsnAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Visits an annotation on an instruction.void
visitIntInsn(int opcode, int operand)
Visits an instruction with a single int operand.void
visitInvokeDynamicInsn(java.lang.String name, java.lang.String descriptor, Handle bootstrapMethodHandle, java.lang.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(java.lang.Object value)
Visits a LDC instruction.void
visitLineNumber(int line, Label start)
Visits a line number declaration.void
visitLocalVariable(java.lang.String name, java.lang.String descriptor, java.lang.String signature, Label start, Label end, int index)
Visits a local variable declaration.AnnotationVisitor
visitLocalVariableAnnotation(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, java.lang.String descriptor, boolean visible)
Visits an annotation on a local variable type.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, java.lang.String owner, java.lang.String name, java.lang.String descriptor, boolean isInterface)
Visits a method instruction.void
visitMultiANewArrayInsn(java.lang.String descriptor, int numDimensions)
Visits a MULTIANEWARRAY instruction.void
visitParameter(java.lang.String name, int access)
Visits a parameter of this method.AnnotationVisitor
visitParameterAnnotation(int parameter, java.lang.String descriptor, boolean visible)
Visits an annotation of a parameter this method.void
visitTableSwitchInsn(int min, int max, Label dflt, Label... labels)
Visits a TABLESWITCH instruction.AnnotationVisitor
visitTryCatchAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Visits an annotation on an exception handler type.void
visitTryCatchBlock(Label start, Label end, Label handler, java.lang.String type)
Visits a try catch block.AnnotationVisitor
visitTypeAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Visits an annotation on a type in the method signature.void
visitTypeInsn(int opcode, java.lang.String type)
Visits a type instruction.void
visitVarInsn(int opcode, int var)
Visits a local variable instruction.-
Methods inherited from class org.objectweb.asm.MethodVisitor
visitMethodInsn
-
-
-
-
Field Detail
-
OPCODE_METHODS
private static final CheckMethodAdapter.Method[] OPCODE_METHODS
The method to use to visit each instruction. Only generic methods are represented here.
-
INVALID
private static final java.lang.String INVALID
- See Also:
- Constant Field Values
-
INVALID_DESCRIPTOR
private static final java.lang.String INVALID_DESCRIPTOR
- See Also:
- Constant Field Values
-
INVALID_TYPE_REFERENCE
private static final java.lang.String INVALID_TYPE_REFERENCE
- See Also:
- Constant Field Values
-
INVALID_LOCAL_VARIABLE_INDEX
private static final java.lang.String INVALID_LOCAL_VARIABLE_INDEX
- See Also:
- Constant Field Values
-
MUST_NOT_BE_NULL_OR_EMPTY
private static final java.lang.String MUST_NOT_BE_NULL_OR_EMPTY
- See Also:
- Constant Field Values
-
START_LABEL
private static final java.lang.String START_LABEL
- See Also:
- Constant Field Values
-
END_LABEL
private static final java.lang.String END_LABEL
- See Also:
- Constant Field Values
-
version
public int version
The class version number.
-
access
private int access
The access flags of the visited method.
-
visibleAnnotableParameterCount
private int visibleAnnotableParameterCount
The number of method parameters that can have runtime visible annotations. 0 means that all the parameters from the method descriptor can have annotations.
-
invisibleAnnotableParameterCount
private int invisibleAnnotableParameterCount
The number of method parameters that can have runtime invisible annotations. 0 means that all the parameters from the method descriptor can have annotations.
-
visitCodeCalled
private boolean visitCodeCalled
Whether thevisitCode()
method has been called.
-
visitMaxCalled
private boolean visitMaxCalled
Whether thevisitMaxs(int, int)
method has been called.
-
visitEndCalled
private boolean visitEndCalled
Whether thevisitEnd()
method has been called.
-
insnCount
private int insnCount
The number of visited instructions so far.
-
labelInsnIndices
private final java.util.Map<Label,java.lang.Integer> labelInsnIndices
The index of the instruction designated by each visited label.
-
referencedLabels
private java.util.Set<Label> referencedLabels
The labels referenced by the visited method.
-
lastFrameInsnIndex
private int lastFrameInsnIndex
The index of the instruction corresponding to the last visited stack map frame.
-
numExpandedFrames
private int numExpandedFrames
The number of visited frames in expanded form.
-
numCompressedFrames
private int numCompressedFrames
The number of visited frames in compressed form.
-
handlers
private java.util.List<Label> handlers
The exception handler ranges. Each pair of list element contains the start and end labels of an exception handler block.
-
-
Constructor Detail
-
CheckMethodAdapter
public CheckMethodAdapter(MethodVisitor methodvisitor)
Constructs a newCheckMethodAdapter
object. This method adapter will not perform any data flow check (seeCheckMethodAdapter(int,String,String,MethodVisitor,Map)
). Subclasses must not use this constructor. Instead, they must use theCheckMethodAdapter(int, MethodVisitor, Map)
version.- Parameters:
methodvisitor
- the method visitor to which this adapter must delegate calls.
-
CheckMethodAdapter
public CheckMethodAdapter(MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object. This method adapter will not perform any data flow check (seeCheckMethodAdapter(int,String,String,MethodVisitor,Map)
). Subclasses must not use this constructor. Instead, they must use theCheckMethodAdapter(int, MethodVisitor, Map)
version.- Parameters:
methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far (in other methods). This map is updated with the labels from the visited method.- Throws:
java.lang.IllegalStateException
- If a subclass calls this constructor.
-
CheckMethodAdapter
protected CheckMethodAdapter(int api, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object. This method adapter will not perform any data flow check (seeCheckMethodAdapter(int,String,String,MethodVisitor,Map)
).- Parameters:
api
- the ASM API version implemented by this CheckMethodAdapter. Must be one ofOpcodes.ASM4
,Opcodes.ASM5
,Opcodes.ASM6
,Opcodes.ASM7
,Opcodes.ASM8
orOpcodes.ASM9
.methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far (in other methods). This map is updated with the labels from the visited method.
-
CheckMethodAdapter
public CheckMethodAdapter(int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object. This method adapter will perform basic data flow checks. For instance in a method whose signature isvoid m ()
, the invalid instruction IRETURN, or the invalid sequence IADD L2I will be detected. Subclasses must not use this constructor. Instead, they must use theCheckMethodAdapter(int,int,String,String,MethodVisitor,Map)
version.- Parameters:
access
- the method's access flags.name
- the method's name.descriptor
- the method's descriptor (seeType
).methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far (in other methods). This map is updated with the labels from the visited method.
-
CheckMethodAdapter
protected CheckMethodAdapter(int api, int access, java.lang.String name, java.lang.String descriptor, MethodVisitor methodVisitor, java.util.Map<Label,java.lang.Integer> labelInsnIndices)
Constructs a newCheckMethodAdapter
object. This method adapter will perform basic data flow checks. For instance in a method whose signature isvoid m ()
, the invalid instruction IRETURN, or the invalid sequence IADD L2I will be detected.- Parameters:
api
- the ASM API version implemented by this CheckMethodAdapter. Must be one ofOpcodes.ASM4
,Opcodes.ASM5
,Opcodes.ASM6
,Opcodes.ASM7
,Opcodes.ASM8
orOpcodes.ASM9
.access
- the method's access flags.name
- the method's name.descriptor
- the method's descriptor (seeType
).methodVisitor
- the method visitor to which this adapter must delegate calls.labelInsnIndices
- the index of the instruction designated by each visited label so far (in other methods). This map is updated with the labels from the visited method.
-
-
Method Detail
-
visitParameter
public void visitParameter(java.lang.String name, int access)
Description copied from class:MethodVisitor
Visits a parameter of this method.- Overrides:
visitParameter
in classMethodVisitor
- Parameters:
name
- parameter name or null if none is provided.access
- the parameter's access flags, onlyACC_FINAL
,ACC_SYNTHETIC
or/andACC_MANDATED
are allowed (seeOpcodes
).
-
visitAnnotation
public AnnotationVisitor visitAnnotation(java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation of this method.- Overrides:
visitAnnotation
in classMethodVisitor
- Parameters:
descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitTypeAnnotation
public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation on a type in the method signature.- Overrides:
visitTypeAnnotation
in classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.METHOD_TYPE_PARAMETER
,TypeReference.METHOD_TYPE_PARAMETER_BOUND
,TypeReference.METHOD_RETURN
,TypeReference.METHOD_RECEIVER
,TypeReference.METHOD_FORMAL_PARAMETER
orTypeReference.THROWS
. SeeTypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitAnnotationDefault
public AnnotationVisitor visitAnnotationDefault()
Description copied from class:MethodVisitor
Visits the default value of this annotation interface method.- Overrides:
visitAnnotationDefault
in classMethodVisitor
- Returns:
- a visitor to the visit the actual default value of this annotation interface method, or null if this visitor is not interested in visiting this default value. The 'name' parameters passed to the methods of this annotation visitor are ignored. Moreover, exacly one visit method must be called on this annotation visitor, followed by visitEnd.
-
visitAnnotableParameterCount
public void visitAnnotableParameterCount(int parameterCount, boolean visible)
Description copied from class:MethodVisitor
Visits the number of method parameters that can have annotations. By default (i.e. when this method is not called), all the method parameters defined by the method descriptor can have annotations.- Overrides:
visitAnnotableParameterCount
in classMethodVisitor
- Parameters:
parameterCount
- the number of method parameters than can have annotations. This number must be less or equal than the number of parameter types in the method descriptor. It can be strictly less when a method has synthetic parameters and when these parameters are ignored when computing parameter indices for the purpose of parameter annotations (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).visible
- true to define the number of method parameters that can have annotations visible at runtime, false to define the number of method parameters that can have annotations invisible at runtime.
-
visitParameterAnnotation
public AnnotationVisitor visitParameterAnnotation(int parameter, java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation of a parameter this method.- Overrides:
visitParameterAnnotation
in classMethodVisitor
- Parameters:
parameter
- the parameter index. This index must be strictly smaller than the number of parameters in the method descriptor, and strictly smaller than the parameter count specified inMethodVisitor.visitAnnotableParameterCount(int, boolean)
. Important note: a parameter index i is not required to correspond to the i'th parameter descriptor in the method descriptor, in particular in case of synthetic parameters (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitAttribute
public void visitAttribute(Attribute attribute)
Description copied from class:MethodVisitor
Visits a non standard attribute of this method.- Overrides:
visitAttribute
in classMethodVisitor
- Parameters:
attribute
- an attribute.
-
visitCode
public void visitCode()
Description copied from class:MethodVisitor
Starts the visit of the method's code, if any (i.e. non abstract method).- Overrides:
visitCode
in classMethodVisitor
-
visitFrame
public void visitFrame(int type, int numLocal, java.lang.Object[] local, int numStack, java.lang.Object[] stack)
Description copied from class:MethodVisitor
Visits the current state of the local variables and operand stack elements. This method must(*) be called just before any instruction i that follows an unconditional branch instruction such as GOTO or THROW, that is the target of a jump instruction, or that starts an exception handler block. The visited types must describe the values of the local variables and of the operand stack elements just before i is executed.
(*) this is mandatory only for classes whose version is greater than or equal toOpcodes.V1_6
.
The frames of a method must be given either in expanded form, or in compressed form (all frames must use the same format, i.e. you must not mix expanded and compressed frames within a single method):- In expanded form, all frames must have the F_NEW type.
- In compressed form, frames are basically "deltas" from the state of the previous frame:
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 andstack[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 andlocal
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.
In both cases the first frame, corresponding to the method's parameters and access flags, is implicit and must not be visited. Also, it is illegal to visit two or more frames for the same code location (i.e., at least one instruction must be visited between two calls to visitFrame).- Overrides:
visitFrame
in classMethodVisitor
- Parameters:
type
- the type of this stack map frame. Must beOpcodes.F_NEW
for expanded frames, orOpcodes.F_FULL
,Opcodes.F_APPEND
,Opcodes.F_CHOP
,Opcodes.F_SAME
orOpcodes.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 byOpcodes.TOP
,Opcodes.INTEGER
,Opcodes.FLOAT
,Opcodes.LONG
,Opcodes.DOUBLE
,Opcodes.NULL
orOpcodes.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.
-
visitInsn
public void visitInsn(int opcode)
Description copied from class:MethodVisitor
Visits a zero operand instruction.- Overrides:
visitInsn
in classMethodVisitor
- Parameters:
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.
-
visitIntInsn
public void visitIntInsn(int opcode, int operand)
Description copied from class:MethodVisitor
Visits an instruction with a single int operand.- Overrides:
visitIntInsn
in classMethodVisitor
- Parameters:
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.
When opcode is BIPUSH, operand value should be between Byte.MIN_VALUE and Byte.MAX_VALUE.
When opcode is SIPUSH, operand value should be between Short.MIN_VALUE and Short.MAX_VALUE.
When opcode is NEWARRAY, operand value should be one ofOpcodes.T_BOOLEAN
,Opcodes.T_CHAR
,Opcodes.T_FLOAT
,Opcodes.T_DOUBLE
,Opcodes.T_BYTE
,Opcodes.T_SHORT
,Opcodes.T_INT
orOpcodes.T_LONG
.
-
visitVarInsn
public void visitVarInsn(int opcode, int var)
Description copied from class:MethodVisitor
Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value of a local variable.- Overrides:
visitVarInsn
in classMethodVisitor
- Parameters:
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.
-
visitTypeInsn
public void visitTypeInsn(int opcode, java.lang.String type)
Description copied from class:MethodVisitor
Visits a type instruction. A type instruction is an instruction that takes the internal name of a class as parameter.- Overrides:
visitTypeInsn
in classMethodVisitor
- Parameters:
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 (seeType.getInternalName()
).
-
visitFieldInsn
public void visitFieldInsn(int opcode, java.lang.String owner, java.lang.String name, java.lang.String descriptor)
Description copied from class:MethodVisitor
Visits a field instruction. A field instruction is an instruction that loads or stores the value of a field of an object.- Overrides:
visitFieldInsn
in classMethodVisitor
- Parameters:
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 (seeType.getInternalName()
).name
- the field's name.descriptor
- the field's descriptor (seeType
).
-
visitMethodInsn
public void visitMethodInsn(int opcodeAndSource, java.lang.String owner, java.lang.String name, java.lang.String descriptor, boolean isInterface)
Description copied from class:MethodVisitor
Visits a method instruction. A method instruction is an instruction that invokes a method.- Overrides:
visitMethodInsn
in classMethodVisitor
- Parameters:
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 (seeType.getInternalName()
).name
- the method's name.descriptor
- the method's descriptor (seeType
).isInterface
- if the method's owner class is an interface.
-
visitInvokeDynamicInsn
public void visitInvokeDynamicInsn(java.lang.String name, java.lang.String descriptor, Handle bootstrapMethodHandle, java.lang.Object... bootstrapMethodArguments)
Description copied from class:MethodVisitor
Visits an invokedynamic instruction.- Overrides:
visitInvokeDynamicInsn
in classMethodVisitor
- Parameters:
name
- the method's name.descriptor
- the method's descriptor (seeType
).bootstrapMethodHandle
- the bootstrap method.bootstrapMethodArguments
- the bootstrap method constant arguments. Each argument must be anInteger
,Float
,Long
,Double
,String
,Type
,Handle
orConstantDynamic
value. This method is allowed to modify the content of the array so a caller should expect that this array may change.
-
visitJumpInsn
public void visitJumpInsn(int opcode, Label label)
Description copied from class:MethodVisitor
Visits a jump instruction. A jump instruction is an instruction that may jump to another instruction.- Overrides:
visitJumpInsn
in classMethodVisitor
- Parameters:
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.
-
visitLabel
public void visitLabel(Label label)
Description copied from class:MethodVisitor
Visits a label. A label designates the instruction that will be visited just after it.- Overrides:
visitLabel
in classMethodVisitor
- Parameters:
label
- aLabel
object.
-
visitLdcInsn
public void visitLdcInsn(java.lang.Object value)
Description copied from class:MethodVisitor
Visits a LDC instruction. Note that new constant types may be added in future versions of the Java Virtual Machine. To easily detect new constant types, implementations of this method should check for unexpected constant types, like this: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 }
- Overrides:
visitLdcInsn
in classMethodVisitor
- Parameters:
value
- the constant to be loaded on the stack. This parameter must be a non nullInteger
, aFloat
, aLong
, aDouble
, aString
, aType
of OBJECT or ARRAY sort for.class
constants, for classes whose version is 49, aType
of METHOD sort for MethodType, aHandle
for MethodHandle constants, for classes whose version is 51 or aConstantDynamic
for a constant dynamic for classes whose version is 55.
-
visitIincInsn
public void visitIincInsn(int var, int increment)
Description copied from class:MethodVisitor
Visits an IINC instruction.- Overrides:
visitIincInsn
in classMethodVisitor
- Parameters:
var
- index of the local variable to be incremented.increment
- amount to increment the local variable by.
-
visitTableSwitchInsn
public void visitTableSwitchInsn(int min, int max, Label dflt, Label... labels)
Description copied from class:MethodVisitor
Visits a TABLESWITCH instruction.- Overrides:
visitTableSwitchInsn
in classMethodVisitor
- Parameters:
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 themin + i
key.
-
visitLookupSwitchInsn
public void visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels)
Description copied from class:MethodVisitor
Visits a LOOKUPSWITCH instruction.- Overrides:
visitLookupSwitchInsn
in classMethodVisitor
- Parameters:
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 thekeys[i]
key.
-
visitMultiANewArrayInsn
public void visitMultiANewArrayInsn(java.lang.String descriptor, int numDimensions)
Description copied from class:MethodVisitor
Visits a MULTIANEWARRAY instruction.- Overrides:
visitMultiANewArrayInsn
in classMethodVisitor
- Parameters:
descriptor
- an array type descriptor (seeType
).numDimensions
- the number of dimensions of the array to allocate.
-
visitInsnAnnotation
public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation on an instruction. This method must be called just after the annotated instruction. It can be called several times for the same instruction.- Overrides:
visitInsnAnnotation
in classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.INSTANCEOF
,TypeReference.NEW
,TypeReference.CONSTRUCTOR_REFERENCE
,TypeReference.METHOD_REFERENCE
,TypeReference.CAST
,TypeReference.CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT
,TypeReference.METHOD_INVOCATION_TYPE_ARGUMENT
,TypeReference.CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT
, orTypeReference.METHOD_REFERENCE_TYPE_ARGUMENT
. SeeTypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitTryCatchBlock
public void visitTryCatchBlock(Label start, Label end, Label handler, java.lang.String type)
Description copied from class:MethodVisitor
Visits a try catch block.- Overrides:
visitTryCatchBlock
in classMethodVisitor
- Parameters:
start
- the beginning of the exception handler's scope (inclusive).end
- the end of the exception handler's scope (exclusive).handler
- the beginning of the exception handler's code.type
- the internal name of the type of exceptions handled by the handler, or null to catch any exceptions (for "finally" blocks).
-
visitTryCatchAnnotation
public AnnotationVisitor visitTryCatchAnnotation(int typeRef, TypePath typePath, java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation on an exception handler type. This method must be called after theMethodVisitor.visitTryCatchBlock(org.objectweb.asm.Label, org.objectweb.asm.Label, org.objectweb.asm.Label, java.lang.String)
for the annotated exception handler. It can be called several times for the same exception handler.- Overrides:
visitTryCatchAnnotation
in classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.EXCEPTION_PARAMETER
. SeeTypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitLocalVariable
public void visitLocalVariable(java.lang.String name, java.lang.String descriptor, java.lang.String signature, Label start, Label end, int index)
Description copied from class:MethodVisitor
Visits a local variable declaration.- Overrides:
visitLocalVariable
in classMethodVisitor
- Parameters:
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.
-
visitLocalVariableAnnotation
public AnnotationVisitor visitLocalVariableAnnotation(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, java.lang.String descriptor, boolean visible)
Description copied from class:MethodVisitor
Visits an annotation on a local variable type.- Overrides:
visitLocalVariableAnnotation
in classMethodVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.LOCAL_VARIABLE
orTypeReference.RESOURCE_VARIABLE
. SeeTypeReference
.typePath
- the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.start
- the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive).end
- the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array.index
- the local variable's index in each range. This array must have the same size as the 'start' array.descriptor
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.- Returns:
- a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.
-
visitLineNumber
public void visitLineNumber(int line, Label start)
Description copied from class:MethodVisitor
Visits a line number declaration.- Overrides:
visitLineNumber
in classMethodVisitor
- Parameters:
line
- a line number. This number refers to the source file from which the class was compiled.start
- the first instruction corresponding to this line number.
-
visitMaxs
public void visitMaxs(int maxStack, int maxLocals)
Description copied from class:MethodVisitor
Visits the maximum stack size and the maximum number of local variables of the method.- Overrides:
visitMaxs
in classMethodVisitor
- Parameters:
maxStack
- maximum stack size of the method.maxLocals
- maximum number of local variables for the method.
-
visitEnd
public void visitEnd()
Description copied from class:MethodVisitor
Visits the end of the method. This method, which is the last one to be called, is used to inform the visitor that all the annotations and attributes of the method have been visited.- Overrides:
visitEnd
in classMethodVisitor
-
checkVisitCodeCalled
private void checkVisitCodeCalled()
Checks that thevisitCode()
method has been called.
-
checkVisitMaxsNotCalled
private void checkVisitMaxsNotCalled()
Checks that thevisitMaxs(int, int)
method has not been called.
-
checkVisitEndNotCalled
private void checkVisitEndNotCalled()
Checks that thevisitEnd()
method has not been called.
-
checkFrameValue
private void checkFrameValue(java.lang.Object value)
Checks a stack frame value.- Parameters:
value
- the value to be checked.
-
checkOpcodeMethod
private static void checkOpcodeMethod(int opcode, CheckMethodAdapter.Method method)
Checks that the method to visit the given opcode is equal to the given method.- Parameters:
opcode
- the opcode to be checked.method
- the expected visit method.
-
checkSignedByte
private static void checkSignedByte(int value, java.lang.String message)
Checks that the given value is a signed byte.- Parameters:
value
- the value to be checked.message
- the message to use in case of error.
-
checkSignedShort
private static void checkSignedShort(int value, java.lang.String message)
Checks that the given value is a signed short.- Parameters:
value
- the value to be checked.message
- the message to use in case of error.
-
checkUnsignedShort
private static void checkUnsignedShort(int value, java.lang.String message)
Checks that the given value is an unsigned short.- Parameters:
value
- the value to be checked.message
- the message to use in case of error.
-
checkConstant
static void checkConstant(java.lang.Object value)
Checks that the given value is anInteger
,Float
,Long
,Double
orString
value.- Parameters:
value
- the value to be checked.
-
checkLdcConstant
private void checkLdcConstant(java.lang.Object value)
Checks that the given value is a valid operand for the LDC instruction.- Parameters:
value
- the value to be checked.
-
checkUnqualifiedName
static void checkUnqualifiedName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid unqualified name.- Parameters:
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.
-
checkIdentifier
static void checkIdentifier(int version, java.lang.String name, int startPos, int endPos, java.lang.String message)
Checks that the given substring is a valid Java identifier.- Parameters:
version
- the class version.name
- the string to be checked.startPos
- the index of the first character of the identifier (inclusive).endPos
- the index of the last character of the identifier (exclusive). -1 is equivalent toname.length()
if name is not null.message
- the message to use in case of error.
-
checkMethodIdentifier
static void checkMethodIdentifier(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid Java identifier.- Parameters:
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.
-
checkInternalName
static void checkInternalName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid internal class name or array type descriptor.- Parameters:
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.
-
checkInternalClassName
private static void checkInternalClassName(int version, java.lang.String name, java.lang.String message)
Checks that the given string is a valid internal class name.- Parameters:
version
- the class version.name
- the string to be checked.message
- the message to use in case of error.
-
checkDescriptor
static void checkDescriptor(int version, java.lang.String descriptor, boolean canBeVoid)
Checks that the given string is a valid type descriptor.- Parameters:
version
- the class version.descriptor
- the string to be checked.canBeVoid
- true ifV
can be considered valid.
-
checkDescriptor
private static int checkDescriptor(int version, java.lang.String descriptor, int startPos, boolean canBeVoid)
Checks that a the given substring is a valid type descriptor.- Parameters:
version
- the class version.descriptor
- the string to be checked.startPos
- the index of the first character of the type descriptor (inclusive).canBeVoid
- whetherV
can be considered valid.- Returns:
- the index of the last character of the type descriptor, plus one.
-
checkMethodDescriptor
static void checkMethodDescriptor(int version, java.lang.String descriptor)
Checks that the given string is a valid method descriptor.- Parameters:
version
- the class version.descriptor
- the string to be checked.
-
checkLabel
private void checkLabel(Label label, boolean checkVisited, java.lang.String message)
Checks that the given label is not null. This method can also check that the label has been visited.- Parameters:
label
- the label to be checked.checkVisited
- whether to check that the label has been visited.message
- the message to use in case of error.
-
-