Package org.eclipse.sisu.space.asm
Class MethodWriter
java.lang.Object
org.eclipse.sisu.space.asm.MethodVisitor
org.eclipse.sisu.space.asm.MethodWriter
A
MethodVisitor
that generates methods in bytecode form. Each visit
method of this class appends the bytecode corresponding to the visited
instruction to a byte vector, in the order these methods are called.-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
Pseudo access flag used to denote constructors.private int
Access flags of this method.private ByteVector
The annotation default attribute of this method.private AnnotationWriter
The runtime visible annotations of this method.(package private) static final int
Frame where current locals are the same as the locals in the previous frame, except that k additional locals are defined.private Attribute
The non standard attributes of the method.private Attribute
The non standard attributes of the method's code.(package private) static final int
Frame where current locals are the same as the locals in the previous frame, except that the k last locals are absent.(package private) int
If not zero, indicates that the code of this method must be copied from the ClassReader associated to this writer incw.cr
.(package private) int
If not zero, indicates that the code of this method must be copied from the ClassReader associated to this writer incw.cr
.private ByteVector
The bytecode of this method.private final int
Indicates what must be automatically computed.private AnnotationWriter
The runtime visible type annotations of the code.private Label
The current basic block.private int
Number of local variables in the current stack map frame.(package private) final ClassWriter
The class writer to which this method must be added.private final int
The index of the constant pool item that contains the descriptor of this method.private final String
The descriptor of this method.(package private) int
Number of exceptions that can be thrown by this method.(package private) int[]
The exceptions that can be thrown by this method.private Handler
The first element in the exception handler list.private int[]
The current stack map frame.private int
Number of stack map frames in the StackMapTable attribute.private static final int
Indicates that the stack map frames must be recomputed from scratch.(package private) static final int
Full frameprivate int
Number of elements in the exception handler list.private AnnotationWriter
The runtime invisible annotations of this method.private AnnotationWriter
The runtime invisible type annotations of the code.private AnnotationWriter[]
The runtime invisible parameter annotations of this method.private AnnotationWriter
The runtime invisible type annotations of this method.private Label
A list of labels.private int
The start offset of the last visited instruction.private Handler
The last element in the exception handler list.private ByteVector
The LineNumberTable attribute.private int
Number of entries in the LineNumberTable attribute.private ByteVector
The LocalVariableTable attribute.private int
Number of entries in the LocalVariableTable attribute.private ByteVector
The LocalVariableTypeTable attribute.private int
Number of entries in the LocalVariableTypeTable attribute.private int
Maximum number of local variables for this method.private static final int
Indicates that the maximum stack size and number of local variables must be automatically computed.private int
Maximum stack size of this method.private int
The (relative) maximum stack size after the last visited instruction.private ByteVector
The MethodParameters attribute.private int
Number of entries in the MethodParameters attribute.private final int
The index of the constant pool item that contains the name of this method.private static final int
Indicates that nothing must be automatically computed.private AnnotationWriter[]
The runtime visible parameter annotations of this method.private Label
The previous basic block.private int[]
The last frame that was written in the StackMapTable attribute.private int
The offset of the last frame that was written in the StackMapTable attribute.(package private) static final int
Reserved for future useprivate boolean
Indicates if some jump instructions are too small and need to be resized.(package private) static final int
Frame has exactly the same locals as the previous stack map frame and number of stack items is zero.(package private) static final int
Frame has exactly the same locals as the previous stack map frame and number of stack items is zero.(package private) static final int
Frame has exactly the same locals as the previous stack map frame and number of stack items is 1(package private) static final int
Frame has exactly the same locals as the previous stack map frame and number of stack items is 1.(package private) String
The signature of this method.private ByteVector
The StackMapTable attribute.private int
The (relative) stack size after the last visited instruction.private int
The number of subroutines in this method.private int
The number of synthetic parameters of this method.private AnnotationWriter
The runtime visible type annotations of this method.Fields inherited from class org.eclipse.sisu.space.asm.MethodVisitor
api, mv
-
Constructor Summary
ConstructorsConstructorDescriptionMethodWriter
(ClassWriter cw, int access, String name, String desc, String signature, String[] exceptions, boolean computeMaxs, boolean computeFrames) Constructs a newMethodWriter
. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addSuccessor
(int info, Label successor) Adds a successor to thecurrentBlock
block.private void
endFrame()
Checks if the visit of the current frameframe
is finished, and if yes, write it in the StackMapTable attribute.(package private) static int
getNewOffset
(int[] indexes, int[] sizes, int begin, int end) Computes the future value of a bytecode offset.(package private) static void
getNewOffset
(int[] indexes, int[] sizes, Label label) Updates the offset of the given label.(package private) final int
getSize()
Returns the size of the bytecode of this method.private void
Ends the current basic block.(package private) final void
put
(ByteVector out) Puts the bytecode of this method in the given byte vector.(package private) static int
readInt
(byte[] b, int index) Reads a signed int value in the given byte array.(package private) static short
readShort
(byte[] b, int index) Reads a signed short value in the given byte array.(package private) static int
readUnsignedShort
(byte[] b, int index) Reads an unsigned short value in the given byte array.private void
Resizes and replaces the temporary instructions inserted byLabel.resolve(org.eclipse.sisu.space.asm.MethodWriter, int, byte[])
for wide forward jumps, while keeping jump offsets and instruction addresses consistent.private int
startFrame
(int offset, int nLocal, int nStack) Starts the visit of a stack map frame.visitAnnotation
(String desc, boolean visible) Visits an annotation of this method.Visits the default value of this annotation interface method.void
visitAttribute
(Attribute attr) Visits a non standard attribute of this method.void
Starts the visit of the method's code, if any (i.e.void
visitEnd()
Visits the end of the method.void
visitFieldInsn
(int opcode, String owner, String name, String desc) Visits a field instruction.void
visitFrame
(int type, int nLocal, Object[] local, int nStack, Object[] stack) Visits the current state of the local variables and operand stack elements.private void
visitFrame
(Frame f) Visits a frame that has been computed from scratch.void
visitIincInsn
(int var, int increment) Visits an IINC instruction.private void
Visit the implicit first frame of this method.void
visitInsn
(int opcode) Visits a zero operand instruction.visitInsnAnnotation
(int typeRef, TypePath typePath, String desc, boolean visible) Visits an annotation on an instruction.void
visitIntInsn
(int opcode, int operand) Visits an instruction with a single int operand.void
visitInvokeDynamicInsn
(String name, String desc, Handle bsm, Object... bsmArgs) Visits an invokedynamic instruction.void
visitJumpInsn
(int opcode, Label label) Visits a jump instruction.void
visitLabel
(Label label) Visits a label.void
visitLdcInsn
(Object cst) Visits a LDC instruction.void
visitLineNumber
(int line, Label start) Visits a line number declaration.void
Visits a local variable declaration.visitLocalVariableAnnotation
(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, String desc, 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 opcode, String owner, String name, String desc, boolean itf) Visits a method instruction.void
visitMultiANewArrayInsn
(String desc, int dims) Visits a MULTIANEWARRAY instruction.void
visitParameter
(String name, int access) Visits a parameter of this method.visitParameterAnnotation
(int parameter, String desc, boolean visible) Visits an annotation of a parameter this method.private void
visitSwitchInsn
(Label dflt, Label[] labels) void
visitTableSwitchInsn
(int min, int max, Label dflt, Label... labels) Visits a TABLESWITCH instruction.visitTryCatchAnnotation
(int typeRef, TypePath typePath, String desc, boolean visible) Visits an annotation on an exception handler type.void
visitTryCatchBlock
(Label start, Label end, Label handler, String type) Visits a try catch block.visitTypeAnnotation
(int typeRef, TypePath typePath, String desc, boolean visible) Visits an annotation on a type in the method signature.void
visitTypeInsn
(int opcode, String type) Visits a type instruction.void
visitVarInsn
(int opcode, int var) Visits a local variable instruction.private void
Compress and writes the current frameframe
in the StackMapTable attribute.private void
writeFrameType
(Object type) private void
writeFrameTypes
(int start, int end) Writes some types of the current frameframe
into the StackMapTableAttribute.(package private) static void
writeShort
(byte[] b, int index, int s) Writes a short value in the given byte array.Methods inherited from class org.eclipse.sisu.space.asm.MethodVisitor
visitMethodInsn
-
Field Details
-
ACC_CONSTRUCTOR
static final int ACC_CONSTRUCTORPseudo access flag used to denote constructors.- See Also:
-
SAME_FRAME
static final int SAME_FRAMEFrame has exactly the same locals as the previous stack map frame and number of stack items is zero.- See Also:
-
SAME_LOCALS_1_STACK_ITEM_FRAME
static final int SAME_LOCALS_1_STACK_ITEM_FRAMEFrame has exactly the same locals as the previous stack map frame and number of stack items is 1- See Also:
-
RESERVED
static final int RESERVEDReserved for future use- See Also:
-
SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED
static final int SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDEDFrame has exactly the same locals as the previous stack map frame and number of stack items is 1. Offset is bigger then 63;- See Also:
-
CHOP_FRAME
static final int CHOP_FRAMEFrame where current locals are the same as the locals in the previous frame, except that the k last locals are absent. The value of k is given by the formula 251-frame_type.- See Also:
-
SAME_FRAME_EXTENDED
static final int SAME_FRAME_EXTENDEDFrame has exactly the same locals as the previous stack map frame and number of stack items is zero. Offset is bigger then 63;- See Also:
-
APPEND_FRAME
static final int APPEND_FRAMEFrame where current locals are the same as the locals in the previous frame, except that k additional locals are defined. The value of k is given by the formula frame_type-251.- See Also:
-
FULL_FRAME
static final int FULL_FRAMEFull frame- See Also:
-
FRAMES
private static final int FRAMESIndicates that the stack map frames must be recomputed from scratch. In this case the maximum stack size and number of local variables is also recomputed from scratch.- See Also:
-
MAXS
private static final int MAXSIndicates that the maximum stack size and number of local variables must be automatically computed.- See Also:
-
NOTHING
private static final int NOTHINGIndicates that nothing must be automatically computed.- See Also:
-
cw
The class writer to which this method must be added. -
access
private int accessAccess flags of this method. -
name
private final int nameThe index of the constant pool item that contains the name of this method. -
desc
private final int descThe index of the constant pool item that contains the descriptor of this method. -
descriptor
The descriptor of this method. -
signature
String signatureThe signature of this method. -
classReaderOffset
int classReaderOffsetIf not zero, indicates that the code of this method must be copied from the ClassReader associated to this writer incw.cr
. More precisely, this field gives the index of the first byte to copied fromcw.cr.b
. -
classReaderLength
int classReaderLengthIf not zero, indicates that the code of this method must be copied from the ClassReader associated to this writer incw.cr
. More precisely, this field gives the number of bytes to copied fromcw.cr.b
. -
exceptionCount
int exceptionCountNumber of exceptions that can be thrown by this method. -
exceptions
int[] exceptionsThe exceptions that can be thrown by this method. More precisely, this array contains the indexes of the constant pool items that contain the internal names of these exception classes. -
annd
The annotation default attribute of this method. May be null. -
anns
The runtime visible annotations of this method. May be null. -
ianns
The runtime invisible annotations of this method. May be null. -
tanns
The runtime visible type annotations of this method. May be null . -
itanns
The runtime invisible type annotations of this method. May be null. -
panns
The runtime visible parameter annotations of this method. May be null. -
ipanns
The runtime invisible parameter annotations of this method. May be null. -
synthetics
private int syntheticsThe number of synthetic parameters of this method. -
attrs
The non standard attributes of the method. -
code
The bytecode of this method. -
maxStack
private int maxStackMaximum stack size of this method. -
maxLocals
private int maxLocalsMaximum number of local variables for this method. -
currentLocals
private int currentLocalsNumber of local variables in the current stack map frame. -
frameCount
private int frameCountNumber of stack map frames in the StackMapTable attribute. -
stackMap
The StackMapTable attribute. -
previousFrameOffset
private int previousFrameOffsetThe offset of the last frame that was written in the StackMapTable attribute. -
previousFrame
private int[] previousFrameThe last frame that was written in the StackMapTable attribute.- See Also:
-
frame
private int[] frameThe current stack map frame. The first element contains the offset of the instruction to which the frame corresponds, the second element is the number of locals and the third one is the number of stack elements. The local variables start at index 3 and are followed by the operand stack values. In summary frame[0] = offset, frame[1] = nLocal, frame[2] = nStack, frame[3] = nLocal. All types are encoded as integers, with the same format as the one used inLabel
, but limited to BASE types. -
handlerCount
private int handlerCountNumber of elements in the exception handler list. -
firstHandler
The first element in the exception handler list. -
lastHandler
The last element in the exception handler list. -
methodParametersCount
private int methodParametersCountNumber of entries in the MethodParameters attribute. -
methodParameters
The MethodParameters attribute. -
localVarCount
private int localVarCountNumber of entries in the LocalVariableTable attribute. -
localVar
The LocalVariableTable attribute. -
localVarTypeCount
private int localVarTypeCountNumber of entries in the LocalVariableTypeTable attribute. -
localVarType
The LocalVariableTypeTable attribute. -
lineNumberCount
private int lineNumberCountNumber of entries in the LineNumberTable attribute. -
lineNumber
The LineNumberTable attribute. -
lastCodeOffset
private int lastCodeOffsetThe start offset of the last visited instruction. -
ctanns
The runtime visible type annotations of the code. May be null. -
ictanns
The runtime invisible type annotations of the code. May be null. -
cattrs
The non standard attributes of the method's code. -
resize
private boolean resizeIndicates if some jump instructions are too small and need to be resized. -
subroutines
private int subroutinesThe number of subroutines in this method. -
compute
private final int computeIndicates what must be automatically computed. -
labels
A list of labels. This list is the list of basic blocks in the method, i.e. a list of Label objects linked to each other by theirLabel.successor
field, in the order they are visited byMethodVisitor.visitLabel(org.eclipse.sisu.space.asm.Label)
, and starting with the first basic block. -
previousBlock
The previous basic block. -
currentBlock
The current basic block. -
stackSize
private int stackSizeThe (relative) stack size after the last visited instruction. This size is relative to the beginning of the current basic block, i.e., the true stack size after the last visited instruction is equal to thebeginStackSize
of the current basic block plus stackSize. -
maxStackSize
private int maxStackSizeThe (relative) maximum stack size after the last visited instruction. This size is relative to the beginning of the current basic block, i.e., the true maximum stack size after the last visited instruction is equal to thebeginStackSize
of the current basic block plus stackSize.
-
-
Constructor Details
-
MethodWriter
MethodWriter(ClassWriter cw, int access, String name, String desc, String signature, String[] exceptions, boolean computeMaxs, boolean computeFrames) Constructs a newMethodWriter
.- Parameters:
cw
- the class writer in which the method must be added.access
- the method's access flags (seeOpcodes
).name
- the method's name.desc
- the method's descriptor (seeType
).signature
- the method's signature. May be null.exceptions
- the internal names of the method's exceptions. May be null.computeMaxs
- true if the maximum stack size and number of local variables must be automatically computed.computeFrames
- true if the stack map tables must be recomputed from scratch.
-
-
Method Details
-
visitParameter
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, only ACC_FINAL, ACC_SYNTHETIC or/and ACC_MANDATED are allowed (seeOpcodes
).
-
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.
-
visitAnnotation
Description copied from class:MethodVisitor
Visits an annotation of this method.- Overrides:
visitAnnotation
in classMethodVisitor
- Parameters:
desc
- 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, String desc, 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 beMETHOD_TYPE_PARAMETER
,METHOD_TYPE_PARAMETER_BOUND
,METHOD_RETURN
,METHOD_RECEIVER
,METHOD_FORMAL_PARAMETER
orTHROWS
. 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.desc
- 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.
-
visitParameterAnnotation
Description copied from class:MethodVisitor
Visits an annotation of a parameter this method.- Overrides:
visitParameterAnnotation
in classMethodVisitor
- Parameters:
parameter
- the parameter index.desc
- 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
Description copied from class:MethodVisitor
Visits a non standard attribute of this method.- Overrides:
visitAttribute
in classMethodVisitor
- Parameters:
attr
- 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
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 toV1_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 (nStack
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 (nLocal
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 (nLocals
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.nLocal
- 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).nStack
- 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
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 (seegetInternalName
).
-
visitFieldInsn
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 (seegetInternalName
).name
- the field's name.desc
- the field's descriptor (seeType
).
-
visitMethodInsn
Description copied from class:MethodVisitor
Visits a method instruction. A method instruction is an instruction that invokes a method.- Overrides:
visitMethodInsn
in classMethodVisitor
- Parameters:
opcode
- 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 (seegetInternalName
).name
- the method's name.desc
- the method's descriptor (seeType
).itf
- if the method's owner class is an interface.
-
visitInvokeDynamicInsn
Description copied from class:MethodVisitor
Visits an invokedynamic instruction.- Overrides:
visitInvokeDynamicInsn
in classMethodVisitor
- Parameters:
name
- the method's name.desc
- the method's descriptor (seeType
).bsm
- the bootstrap method.bsmArgs
- the bootstrap method constant arguments. Each argument must be anInteger
,Float
,Long
,Double
,String
,Type
orHandle
value. This method is allowed to modify the content of the array so a caller should expect that this array may change.
-
visitJumpInsn
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
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
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 { // throw an exception }
- Overrides:
visitLdcInsn
in classMethodVisitor
- Parameters:
cst
- 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.0, aType
of METHOD sort or aHandle
for MethodType and MethodHandle constants, for classes whose version is 51.0.
-
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
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 the min + i key.
-
visitLookupSwitchInsn
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 the keys[i] key.
-
visitSwitchInsn
-
visitMultiANewArrayInsn
Description copied from class:MethodVisitor
Visits a MULTIANEWARRAY instruction.- Overrides:
visitMultiANewArrayInsn
in classMethodVisitor
- Parameters:
desc
- an array type descriptor (seeType
).dims
- number of dimensions of the array to allocate.
-
visitInsnAnnotation
public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, String desc, 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 beINSTANCEOF
,NEW
,CONSTRUCTOR_REFERENCE
,METHOD_REFERENCE
,CAST
,CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT
,METHOD_INVOCATION_TYPE_ARGUMENT
,CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT
, orMETHOD_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.desc
- 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
Description copied from class:MethodVisitor
Visits a try catch block.- Overrides:
visitTryCatchBlock
in classMethodVisitor
- Parameters:
start
- beginning of the exception handler's scope (inclusive).end
- end of the exception handler's scope (exclusive).handler
- beginning of the exception handler's code.type
- 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, String desc, boolean visible) Description copied from class:MethodVisitor
Visits an annotation on an exception handler type. This method must be called after theMethodVisitor.visitTryCatchBlock(org.eclipse.sisu.space.asm.Label, org.eclipse.sisu.space.asm.Label, org.eclipse.sisu.space.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 beEXCEPTION_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.desc
- 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(String name, String desc, 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.desc
- 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, String desc, 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 beLOCAL_VARIABLE
orRESOURCE_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.desc
- 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
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
-
addSuccessor
Adds a successor to thecurrentBlock
block.- Parameters:
info
- information about the control flow edge to be added.successor
- the successor block to be added to the current block.
-
noSuccessor
private void noSuccessor()Ends the current basic block. This method must be used in the case where the current basic block does not have any successor. -
visitFrame
Visits a frame that has been computed from scratch.- Parameters:
f
- the frame that must be visited.
-
visitImplicitFirstFrame
private void visitImplicitFirstFrame()Visit the implicit first frame of this method. -
startFrame
private int startFrame(int offset, int nLocal, int nStack) Starts the visit of a stack map frame.- Parameters:
offset
- the offset of the instruction to which the frame corresponds.nLocal
- the number of local variables in the frame.nStack
- the number of stack elements in the frame.- Returns:
- the index of the next element to be written in this frame.
-
endFrame
private void endFrame()Checks if the visit of the current frameframe
is finished, and if yes, write it in the StackMapTable attribute. -
writeFrame
private void writeFrame()Compress and writes the current frameframe
in the StackMapTable attribute. -
writeFrameTypes
private void writeFrameTypes(int start, int end) -
writeFrameType
-
getSize
final int getSize()Returns the size of the bytecode of this method.- Returns:
- the size of the bytecode of this method.
-
put
Puts the bytecode of this method in the given byte vector.- Parameters:
out
- the byte vector into which the bytecode of this method must be copied.
-
resizeInstructions
private void resizeInstructions()Resizes and replaces the temporary instructions inserted byLabel.resolve(org.eclipse.sisu.space.asm.MethodWriter, int, byte[])
for wide forward jumps, while keeping jump offsets and instruction addresses consistent. This may require to resize other existing instructions, or even to introduce new instructions: for example, increasing the size of an instruction by 2 at the middle of a method can increases the offset of an IFEQ instruction from 32766 to 32768, in which case IFEQ 32766 must be replaced with IFNEQ 8 GOTO_W 32765. This, in turn, may require to increase the size of another jump instruction, and so on... All these operations are handled automatically by this method.This method must be called after all the method that is being built has been visited. In particular, the
Label
objects used to construct the method are no longer valid after this method has been called. -
readUnsignedShort
static int readUnsignedShort(byte[] b, int index) Reads an unsigned short value in the given byte array.- Parameters:
b
- a byte array.index
- the start index of the value to be read.- Returns:
- the read value.
-
readShort
static short readShort(byte[] b, int index) Reads a signed short value in the given byte array.- Parameters:
b
- a byte array.index
- the start index of the value to be read.- Returns:
- the read value.
-
readInt
static int readInt(byte[] b, int index) Reads a signed int value in the given byte array.- Parameters:
b
- a byte array.index
- the start index of the value to be read.- Returns:
- the read value.
-
writeShort
static void writeShort(byte[] b, int index, int s) Writes a short value in the given byte array.- Parameters:
b
- a byte array.index
- where the first byte of the short value must be written.s
- the value to be written in the given byte array.
-
getNewOffset
static int getNewOffset(int[] indexes, int[] sizes, int begin, int end) Computes the future value of a bytecode offset.Note: it is possible to have several entries for the same instruction in the indexes and sizes: two entries (index=a,size=b) and (index=a,size=b') are equivalent to a single entry (index=a,size=b+b').
- Parameters:
indexes
- current positions of the instructions to be resized. Each instruction must be designated by the index of its last byte, plus one (or, in other words, by the index of the first byte of the next instruction).sizes
- the number of bytes to be added to the above instructions. More precisely, for each i < len, sizes[i] bytes will be added at the end of the instruction designated by indexes[i] or, if sizes[i] is negative, the last | sizes[i]| bytes of the instruction will be removed (the instruction size must not become negative or null).begin
- index of the first byte of the source instruction.end
- index of the first byte of the target instruction.- Returns:
- the future value of the given bytecode offset.
-
getNewOffset
Updates the offset of the given label.- Parameters:
indexes
- current positions of the instructions to be resized. Each instruction must be designated by the index of its last byte, plus one (or, in other words, by the index of the first byte of the next instruction).sizes
- the number of bytes to be added to the above instructions. More precisely, for each i < len, sizes[i] bytes will be added at the end of the instruction designated by indexes[i] or, if sizes[i] is negative, the last | sizes[i]| bytes of the instruction will be removed (the instruction size must not become negative or null).label
- the label whose offset must be updated.
-