| /*** |
| * ASM: a very small and fast Java bytecode manipulation framework |
| * Copyright (c) 2000-2005 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 org.objectweb.asm; |
| |
| /** |
| * A visitor to visit a Java method. The methods of this interface must be |
| * called in the following order: [ <tt>visitAnnotationDefault</tt> ] ( |
| * <tt>visitAnnotation</tt> | <tt>visitParameterAnnotation</tt> | |
| * <tt>visitAttribute</tt> )* [ <tt>visitCode</tt> ( <tt>visit</tt><i>X</i>Insn</tt> | |
| * <tt>visitLabel</tt> | <tt>visitTryCatchBlock</tt> | <tt>visitLocalVariable</tt> | |
| * <tt>visitLineNumber</tt>)* <tt>visitMaxs</tt> ] <tt>visitEnd</tt>. In |
| * addition, the <tt>visit</tt><i>X</i>Insn</tt> and <tt>visitLabel</tt> |
| * methods must be called in the sequential order of the bytecode instructions |
| * of the visited code, and the <tt>visitLocalVariable</tt> and <tt>visitLineNumber</tt> |
| * methods must be called <i>after</i> the labels passed as arguments have been |
| * visited. |
| * |
| * @author Eric Bruneton |
| */ |
| public interface MethodVisitor extends MemberVisitor { |
| |
| // ------------------------------------------------------------------------- |
| // Annotations and non standard attributes |
| // ------------------------------------------------------------------------- |
| |
| /** |
| * Visits the default value of this annotation interface method. |
| * |
| * @return a non null visitor to the visit the actual default value of this |
| * annotation interface method. 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. |
| */ |
| AnnotationVisitor visitAnnotationDefault(); |
| |
| /** |
| * Visits an annotation of this method. |
| * |
| * @param desc the class descriptor of the annotation class. |
| * @param visible <tt>true</tt> if the annotation is visible at runtime. |
| * @return a non null visitor to visit the annotation values. |
| */ |
| AnnotationVisitor visitAnnotation(String desc, boolean visible); |
| |
| /** |
| * Visits an annotation of a parameter this method. |
| * |
| * @param parameter the parameter index. |
| * @param desc the class descriptor of the annotation class. |
| * @param visible <tt>true</tt> if the annotation is visible at runtime. |
| * @return a non null visitor to visit the annotation values. |
| */ |
| AnnotationVisitor visitParameterAnnotation( |
| int parameter, |
| String desc, |
| boolean visible); |
| |
| /** |
| * Visits a non standard attribute of this method. |
| * |
| * @param attr an attribute. |
| */ |
| void visitAttribute(Attribute attr); |
| |
| /** |
| * Starts the visit of the method's code, if any (i.e. non abstract method). |
| */ |
| 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. |
| */ |
| 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.<br> |
| * When opcode is BIPUSH, operand value should be between |
| * Byte.MIN_VALUE and Byte.MAX_VALUE.<br> |
| * When opcode is SIPUSH, operand value should be between |
| * Short.MIN_VALUE and Short.MAX_VALUE.<br> |
| * When opcode is NEWARRAY, operand value should be one of |
| * {@link Opcodes#T_BOOLEAN}, {@link Opcodes#T_CHAR}, |
| * {@link Opcodes#T_FLOAT}, {@link Opcodes#T_DOUBLE}, |
| * {@link Opcodes#T_BYTE}, {@link Opcodes#T_SHORT}, |
| * {@link Opcodes#T_INT} or {@link Opcodes#T_LONG}. |
| */ |
| 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. |
| */ |
| void visitVarInsn(int opcode, int var); |
| |
| /** |
| * Visits a type instruction. A type instruction is an instruction that |
| * takes a type descriptor as parameter. |
| * |
| * @param opcode the opcode of the type instruction to be visited. This |
| * opcode is either NEW, ANEWARRAY, CHECKCAST or INSTANCEOF. |
| * @param desc the operand of the instruction to be visited. This operand is |
| * must be a fully qualified class name in internal form, or the type |
| * descriptor of an array type (see {@link Type Type}). |
| */ |
| void visitTypeInsn(int opcode, String desc); |
| |
| /** |
| * Visits a field instruction. A field instruction is an instruction that |
| * loads or stores the value of a field of an object. |
| * |
| * @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 |
| * Type#getInternalName() getInternalName}). |
| * @param name the field's name. |
| * @param desc the field's descriptor (see {@link Type Type}). |
| */ |
| void visitFieldInsn(int opcode, String owner, String name, 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 |
| * Type#getInternalName() getInternalName}). |
| * @param name the method's name. |
| * @param desc the method's descriptor (see {@link Type Type}). |
| */ |
| void visitMethodInsn(int opcode, String owner, String name, String desc); |
| |
| /** |
| * Visits an invokedynamic instruction. |
| * |
| * @param name |
| * the method's name. |
| * @param desc |
| * the method's descriptor (see {@link Type Type}). |
| * @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 Type} 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. |
| */ |
| void visitInvokeDynamicInsn(String name, String desc, Handle bsm, |
| 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. |
| */ |
| void visitJumpInsn(int opcode, Label label); |
| |
| /** |
| * Visits a label. A label designates the instruction that will be visited |
| * just after it. |
| * |
| * @param label a {@link Label Label} object. |
| */ |
| void visitLabel(Label label); |
| |
| // ------------------------------------------------------------------------- |
| // Special instructions |
| // ------------------------------------------------------------------------- |
| |
| /** |
| * Visits a LDC instruction. |
| * |
| * @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} (or a {@link Type} for |
| * <tt>.class</tt> constants, for classes whose version is 49.0 or |
| * more). |
| */ |
| void visitLdcInsn(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. |
| */ |
| void visitIincInsn(int var, 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. <tt>labels[i]</tt> is |
| * the beginning of the handler block for the <tt>min + i</tt> key. |
| */ |
| void visitTableSwitchInsn(int min, int max, Label dflt, 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. <tt>labels[i]</tt> is |
| * the beginning of the handler block for the <tt>keys[i]</tt> key. |
| */ |
| void visitLookupSwitchInsn(Label dflt, int keys[], Label labels[]); |
| |
| /** |
| * Visits a MULTIANEWARRAY instruction. |
| * |
| * @param desc an array type descriptor (see {@link Type Type}). |
| * @param dims number of dimensions of the array to allocate. |
| */ |
| void visitMultiANewArrayInsn(String desc, int dims); |
| |
| /** |
| * Visits an annotation on an instruction. This method must be called just |
| * <i>after</i> the annotated instruction. It can be called several times |
| * for the same instruction. |
| * |
| * @param typeRef |
| * a reference to the annotated type. The sort of this type |
| * reference must be {@link TypeReference#INSTANCEOF INSTANCEOF}, |
| * {@link TypeReference#NEW NEW}, |
| * {@link TypeReference#CONSTRUCTOR_REFERENCE |
| * CONSTRUCTOR_REFERENCE}, {@link TypeReference#METHOD_REFERENCE |
| * METHOD_REFERENCE}, {@link TypeReference#CAST CAST}, |
| * {@link TypeReference#CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT |
| * CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT}, |
| * {@link TypeReference#METHOD_INVOCATION_TYPE_ARGUMENT |
| * METHOD_INVOCATION_TYPE_ARGUMENT}, |
| * {@link TypeReference#CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT |
| * CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT}, or |
| * {@link TypeReference#METHOD_REFERENCE_TYPE_ARGUMENT |
| * METHOD_REFERENCE_TYPE_ARGUMENT}. See {@link TypeReference}. |
| * @param typePath |
| * the path to the annotated type argument, wildcard bound, array |
| * element type, or static inner type within 'typeRef'. May be |
| * <tt>null</tt> if the annotation targets 'typeRef' as a whole. |
| * @param desc |
| * the class descriptor of the annotation class. |
| * @param visible |
| * <tt>true</tt> if the annotation is visible at runtime. |
| * @return a visitor to visit the annotation values, or <tt>null</tt> if |
| * this visitor is not interested in visiting this annotation. |
| */ |
| public AnnotationVisitor visitInsnAnnotation(int typeRef, |
| TypePath typePath, String desc, boolean visible); |
| |
| // ------------------------------------------------------------------------- |
| // Exceptions table entries, debug information, |
| // max stack size and max locals |
| // ------------------------------------------------------------------------- |
| |
| /** |
| * 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 <tt>null</tt> to catch any exceptions (for "finally" |
| * blocks). |
| */ |
| void visitTryCatchBlock(Label start, Label end, Label handler, 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 |
| * <tt>null</tt> 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 visitLabel} method). |
| */ |
| void visitLocalVariable( |
| String name, |
| String desc, |
| String signature, |
| Label start, |
| Label end, |
| 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 <tt>start</tt> has not already been |
| * visited by this visitor (by the {@link #visitLabel visitLabel} |
| * method). |
| */ |
| void visitLineNumber(int line, Label start); |
| |
| /** |
| * Visits the maximum stack size and the maximum number of local variables |
| * of the method. |
| * |
| * @param maxStack maximum stack size of the method. |
| * @param maxLocals maximum number of local variables for the method. |
| */ |
| void visitMaxs(int maxStack, int maxLocals); |
| |
| /** |
| * 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. |
| */ |
| void visitEnd(); |
| } |
