mockit.external.asm.MethodVisitor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation
Show all versions of jmockit Show documentation
JMockit is a Java toolkit for automated developer testing.
It contains APIs for the creation of the objects to be tested, for mocking dependencies, and for faking external
APIs; JUnit (4 & 5) and TestNG test runners are supported.
It also contains an advanced code coverage tool.
/*
* ASM: a very small and fast Java bytecode manipulation framework
* Copyright (c) 2000-2011 INRIA, France Telecom
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
package mockit.external.asm;
import javax.annotation.*;
/**
* A visitor to visit a Java method. The methods of this class are called by {@link ClassReader} in the following order:
*
* [visitAnnotationDefault] (visitAnnotation)* (visitParameterAnnotation)*
* [visitCode (visitXInsn | visitLabel | visitTryCatchBlock |
* visitLocalVariable | visitLineNumber)* visitMaxStack] visitEnd.
*
* In addition, the visitXInsn and visitLabel methods are called in the sequential order of the
* bytecode instructions of the visited code, visitTryCatchBlock is called before the labels passed as
* arguments have been visited, and the visitLocalVariable and visitLineNumber methods are called
* after the labels passed as arguments have been visited.
*/
public class MethodVisitor extends BaseWriter
{
/**
* Constructs a new {@link MethodVisitor}.
*/
protected MethodVisitor() {}
// -------------------------------------------------------------------------
// Annotations, code, and frames
// -------------------------------------------------------------------------
/**
* Visits the default value of this annotation interface method.
*
* @return 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, exactly one visit method must be called on this annotation visitor,
* followed by visitEnd.
*/
@Nullable
public AnnotationVisitor visitAnnotationDefault() { return null; }
/**
* Visits an annotation of this method.
*
* @param desc the class descriptor of the annotation class.
* @return a visitor to visit the annotation values, or null if this visitor is not interested in visiting
* this annotation.
*/
@Nullable
public AnnotationVisitor visitAnnotation(@Nonnull String desc) { return null; }
/**
* Visits an annotation of a parameter this method.
*
* @param parameter the parameter index.
* @param desc the class descriptor of the annotation class.
* @return a visitor to visit the annotation values, or null if this visitor is not interested in visiting
* this annotation.
*/
@Nullable
public AnnotationVisitor visitParameterAnnotation(@Nonnegative int parameter, @Nonnull String desc) { return null; }
/**
* Starts the visit of the method's code, if any (i.e. non abstract method).
*/
public void visitCode() {}
// -------------------------------------------------------------------------
// Normal instructions
// -------------------------------------------------------------------------
/**
* Visits a zero operand instruction.
*
* @param 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 visitInsn(int opcode) {}
/**
* Visits an instruction with a single int operand.
*
* @param opcode the opcode of the instruction to be visited. This opcode is either BIPUSH, SIPUSH or NEWARRAY.
* @param 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 of {@link ArrayElementType}.
*/
public void visitIntInsn(int opcode, int operand) {}
/**
* Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value
* of a local variable.
*
* @param 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.
* @param var the operand of the instruction to be visited. This operand is the index of a local variable.
*/
public void visitVarInsn(int opcode, int var) {}
/**
* Visits a type instruction. A type instruction is an instruction that takes the internal name of a class as
* parameter.
*
* @param opcode the opcode of the type instruction to be visited. This opcode
* is either NEW, ANEWARRAY, CHECKCAST or INSTANCEOF.
* @param type the operand of the instruction to be visited. This operand must be the internal name of an object or
* array class (see {@link JavaType#getInternalName()}).
*/
public void visitTypeInsn(int opcode, @Nonnull String type) {}
/**
* Visits a field instruction. A field instruction is an instruction that loads or stores the value of a field of an
* object or a class.
*
* @param opcode the opcode of the type instruction to be visited. This opcode
* is either GETSTATIC, PUTSTATIC, GETFIELD or PUTFIELD.
* @param owner the internal name of the field's owner class (see {@link JavaType#getInternalName()}).
* @param name the field's name.
* @param desc the field's descriptor (see {@link JavaType}).
*/
public void visitFieldInsn(int opcode, @Nonnull String owner, @Nonnull String name, @Nonnull String desc) {}
/**
* Visits a method instruction. A method instruction is an instruction that invokes a method.
*
* @param opcode the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL,
* INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.
* @param owner the internal name of the method's owner class (see {@link JavaType#getInternalName()}).
* @param name the method's name.
* @param desc the method's descriptor (see {@link JavaType}).
* @param itf if the method's owner class is an interface.
*/
public void visitMethodInsn(
int opcode, @Nonnull String owner, @Nonnull String name, @Nonnull String desc, boolean itf) {}
/**
* Visits an invokedynamic instruction.
*
* @param name the method's name.
* @param desc the method's descriptor (see {@link JavaType}).
* @param bsm the bootstrap method.
* @param bsmArgs the bootstrap method constant arguments. Each argument must be an {@link Integer}, {@link Float},
* {@link Long}, {@link Double}, {@link String}, {@link JavaType} or {@link Handle} value.
* This method is allowed to modify the content of the array so a caller should expect that this array
* may change.
*/
public void visitInvokeDynamicInsn(
@Nonnull String name, @Nonnull String desc, @Nonnull Handle bsm, @Nonnull Object... bsmArgs) {}
/**
* Visits a jump instruction. A jump instruction is an instruction that may jump to another instruction.
*
* @param 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.
* @param 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 visitJumpInsn(int opcode, @Nonnull Label label) {}
/**
* Visits a label. A label designates the instruction that will be visited just after it.
*/
public void visitLabel(@Nonnull Label label) {}
// -------------------------------------------------------------------------
// Special instructions
// -------------------------------------------------------------------------
/**
* 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 JavaType) {
* int sort = ((JavaType) cst).getSort();
* if (sort == Type.Sort.OBJECT) {
* // ...
* } else if (sort == Type.Sort.ARRAY) {
* // ...
* } else if (sort == Type.Sort.METHOD) {
* // ...
* } else {
* // throw an exception
* }
* } else if (cst instanceof Handle) {
* // ...
* } else {
* // throw an exception
* }
*
*
* @param cst the constant to be loaded on the stack. This parameter must be a non null {@link Integer}, a
* {@link Float}, a {@link Long}, a {@link Double}, a {@link String}, a {@link JavaType} of OBJECT or ARRAY
* sort for .class constants, for classes whose version is 49.0, a {@link JavaType} of METHOD sort or
* a {@link Handle} for MethodType and MethodHandle constants, for classes whose version is 51.0.
*/
public void visitLdcInsn(@Nonnull Object cst) {}
/**
* Visits an IINC instruction.
*
* @param var index of the local variable to be incremented.
* @param increment amount to increment the local variable by.
*/
public void visitIincInsn(@Nonnegative int var, @Nonnegative int increment) {}
/**
* Visits a TABLESWITCH instruction.
*
* @param min the minimum key value.
* @param max the maximum key value.
* @param dflt beginning of the default handler block.
* @param labels beginnings of the handler blocks. labels[i] is the beginning of the handler block for the
* min + i key.
*/
public void visitTableSwitchInsn(int min, int max, @Nonnull Label dflt, @Nonnull Label... labels) {}
/**
* Visits a LOOKUPSWITCH instruction.
*
* @param dflt beginning of the default handler block.
* @param keys the values of the keys.
* @param labels beginnings of the handler blocks. labels[i] is the beginning of the handler block for the
* keys[i] key.
*/
public void visitLookupSwitchInsn(@Nonnull Label dflt, @Nonnull int[] keys, @Nonnull Label[] labels) {}
/**
* Visits a MULTIANEWARRAY instruction.
*
* @param desc an array type descriptor (see {@link JavaType}).
* @param dims number of dimensions of the array to allocate.
*/
public void visitMultiANewArrayInsn(@Nonnull String desc, @Nonnegative int dims) {}
// -------------------------------------------------------------------------
// Exceptions table entries, debug information, max stack
// -------------------------------------------------------------------------
/**
* Visits a try catch block.
*
* @param start beginning of the exception handler's scope (inclusive).
* @param end end of the exception handler's scope (exclusive).
* @param handler beginning of the exception handler's code.
* @param type internal name of the type of exceptions handled by the handler, or null to catch any
* exceptions (for "finally" blocks).
* @throws IllegalArgumentException if one of the labels has already been visited by this visitor (by the
* {@link #visitLabel} method).
*/
public void visitTryCatchBlock(
@Nonnull Label start, @Nonnull Label end, @Nonnull Label handler, @Nullable String type) {}
/**
* Visits a local variable declaration.
*
* @param name the name of a local variable.
* @param desc the type descriptor of this local variable.
* @param signature the type signature of this local variable.
* May be null if the local variable type does not use generic types.
* @param start the first instruction corresponding to the scope of this local variable (inclusive).
* @param end the last instruction corresponding to the scope of this local variable (exclusive).
* @param index the local variable's index.
* @throws IllegalArgumentException if one of the labels has not already been visited by this visitor (by the
* {@link #visitLabel} method).
*/
public void visitLocalVariable(
@Nonnull String name, @Nonnull String desc, @Nullable String signature, @Nonnull Label start, @Nonnull Label end,
@Nonnegative int index) {}
/**
* Visits a line number declaration.
*
* @param line a line number. This number refers to the source file from which the class was compiled.
* @param start the first instruction corresponding to this line number.
* @throws IllegalArgumentException if start has not already been visited by this visitor (by the
* {@link #visitLabel} method).
*/
public void visitLineNumber(@Nonnegative int line, @Nonnull Label start) {}
/**
* Visits the maximum stack size of the method.
*/
public void visitMaxStack(@Nonnegative int maxStack) {}
/**
* 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.
*/
public void visitEnd() {}
}