Class ASMifier


  • public class ASMifier
    extends Printer
    A Printer that prints the ASM code to generate the classes if visits.
    • Field Detail

      • name

        protected final java.lang.String name
        The name of the visitor variable in the produced code.
      • id

        protected final int id
        The identifier of the annotation visitor variable in the produced code.
      • labelNames

        protected java.util.Map<Label,​java.lang.String> labelNames
        The name of the Label variables in the produced code.
    • Constructor Detail

      • ASMifier

        public ASMifier()
        Constructs a new ASMifier. Subclasses must not use this constructor. Instead, they must use the ASMifier(int, String, int) version.
        Throws:
        java.lang.IllegalStateException - If a subclass calls this constructor.
      • ASMifier

        protected ASMifier​(int api,
                           java.lang.String visitorVariableName,
                           int annotationVisitorId)
        Constructs a new ASMifier.
        Parameters:
        api - the ASM API version implemented by this class. Must be one of Opcodes.ASM4, Opcodes.ASM5, Opcodes.ASM6, Opcodes.ASM7, Opcodes.ASM8 or Opcodes.ASM9.
        visitorVariableName - the name of the visitor variable in the produced code.
        annotationVisitorId - identifier of the annotation visitor variable in the produced code.
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.io.IOException
        Prints the ASM source code to generate the given class to the standard output.

        Usage: ASMifier [-nodebug] <binary class name or class file name>

        Parameters:
        args - the command line arguments.
        Throws:
        java.io.IOException - if the class cannot be found, or if an IOException occurs.
      • visit

        public void visit​(int version,
                          int access,
                          java.lang.String name,
                          java.lang.String signature,
                          java.lang.String superName,
                          java.lang.String[] interfaces)
        Description copied from class: Printer
        Specified by:
        visit in class Printer
        Parameters:
        version - the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits.
        access - the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated.
        name - the internal name of the class (see Type.getInternalName()).
        signature - the signature of this class. May be null if the class is not a generic one, and does not extend or implement generic classes or interfaces.
        superName - the internal of name of the super class (see Type.getInternalName()). For interfaces, the super class is Object. May be null, but only for the Object class.
        interfaces - the internal names of the class's interfaces (see Type.getInternalName()). May be null.
      • visitSource

        public void visitSource​(java.lang.String file,
                                java.lang.String debug)
        Description copied from class: Printer
        Specified by:
        visitSource in class Printer
        Parameters:
        file - the name of the source file from which the class was compiled. May be null.
        debug - additional debug information to compute the correspondence between source and compiled elements of the class. May be null.
      • visitNestHost

        public void visitNestHost​(java.lang.String nestHost)
        Description copied from class: Printer
        Visits the nest host class of the class. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only once and only if the visited class is a non-host member of a nest. A class is implicitly its own nest, so it's invalid to call this method with the visited class name as argument.
        Overrides:
        visitNestHost in class Printer
        Parameters:
        nestHost - the internal name of the host class of the nest.
      • visitOuterClass

        public void visitOuterClass​(java.lang.String owner,
                                    java.lang.String name,
                                    java.lang.String descriptor)
        Description copied from class: Printer
        Specified by:
        visitOuterClass in class Printer
        Parameters:
        owner - internal name of the enclosing class of the class.
        name - the name of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.
        descriptor - the descriptor of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.
      • visitNestMember

        public void visitNestMember​(java.lang.String nestMember)
        Description copied from class: Printer
        Visits a member of the nest. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only if the visited class is the host of a nest. A nest host is implicitly a member of its own nest, so it's invalid to call this method with the visited class name as argument.
        Overrides:
        visitNestMember in class Printer
        Parameters:
        nestMember - the internal name of a nest member.
      • visitPermittedSubclass

        public void visitPermittedSubclass​(java.lang.String permittedSubclass)
        Description copied from class: Printer
        Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class. See ClassVisitor.visitPermittedSubclass(String).
        Overrides:
        visitPermittedSubclass in class Printer
        Parameters:
        permittedSubclass - the internal name of a permitted subclass.
      • visitRecordComponent

        public ASMifier visitRecordComponent​(java.lang.String name,
                                             java.lang.String descriptor,
                                             java.lang.String signature)
        Description copied from class: Printer
        Visits a record component of the class. See ClassVisitor.visitRecordComponent(String, String, String).
        Overrides:
        visitRecordComponent in class Printer
        Parameters:
        name - the field's name.
        descriptor - the record component descriptor (see Type).
        signature - the record component signature. May be null if the record component type does not use generic types.
        Returns:
        a visitor to visit this record component annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.
      • visitField

        public ASMifier visitField​(int access,
                                   java.lang.String name,
                                   java.lang.String descriptor,
                                   java.lang.String signature,
                                   java.lang.Object value)
        Description copied from class: Printer
        Specified by:
        visitField in class Printer
        Parameters:
        access - the field's access flags (see Opcodes). This parameter also indicates if the field is synthetic and/or deprecated.
        name - the field's name.
        descriptor - the field's descriptor (see Type).
        signature - the field's signature. May be null if the field's type does not use generic types.
        value - the field's initial value. This parameter, which may be null if the field does not have an initial value, must be an Integer, a Float, a Long, a Double or a String (for int, float, long or String fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods.
        Returns:
        the printer.
      • visitMethod

        public ASMifier visitMethod​(int access,
                                    java.lang.String name,
                                    java.lang.String descriptor,
                                    java.lang.String signature,
                                    java.lang.String[] exceptions)
        Description copied from class: Printer
        Specified by:
        visitMethod in class Printer
        Parameters:
        access - the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.
        name - the method's name.
        descriptor - the method's descriptor (see Type).
        signature - the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.
        exceptions - the internal names of the method's exception classes (see Type.getInternalName()). May be null.
        Returns:
        the printer.
      • visitRequire

        public void visitRequire​(java.lang.String module,
                                 int access,
                                 java.lang.String version)
        Description copied from class: Printer
        Overrides:
        visitRequire in class Printer
        Parameters:
        module - the fully qualified name (using dots) of the dependence.
        access - the access flag of the dependence among ACC_TRANSITIVE, ACC_STATIC_PHASE, ACC_SYNTHETIC and ACC_MANDATED.
        version - the module version at compile time, or null.
      • visitExport

        public void visitExport​(java.lang.String packaze,
                                int access,
                                java.lang.String... modules)
        Description copied from class: Printer
        Overrides:
        visitExport in class Printer
        Parameters:
        packaze - the internal name of the exported package.
        access - the access flag of the exported package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.
        modules - the fully qualified names (using dots) of the modules that can access the public classes of the exported package, or null.
      • visitOpen

        public void visitOpen​(java.lang.String packaze,
                              int access,
                              java.lang.String... modules)
        Description copied from class: Printer
        Overrides:
        visitOpen in class Printer
        Parameters:
        packaze - the internal name of the opened package.
        access - the access flag of the opened package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.
        modules - the fully qualified names (using dots) of the modules that can use deep reflection to the classes of the open package, or null.
      • visitRecordComponentAnnotation

        public ASMifier visitRecordComponentAnnotation​(java.lang.String descriptor,
                                                       boolean visible)
        Description copied from class: Printer
        Visits an annotation of the record component. See RecordComponentVisitor.visitAnnotation(java.lang.String, boolean).
        Overrides:
        visitRecordComponentAnnotation in class Printer
        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.
      • visitRecordComponentEnd

        public void visitRecordComponentEnd()
        Description copied from class: Printer
        Visits the end of the record component. See RecordComponentVisitor.visitEnd(). This method, which is the last one to be called, is used to inform the visitor that everything have been visited.
        Overrides:
        visitRecordComponentEnd in class Printer
      • visitParameter

        public void visitParameter​(java.lang.String parameterName,
                                   int access)
        Description copied from class: Printer
        Overrides:
        visitParameter in class Printer
        Parameters:
        parameterName - 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 (see Opcodes).
      • visitAnnotableParameterCount

        public ASMifier visitAnnotableParameterCount​(int parameterCount,
                                                     boolean visible)
        Description copied from class: Printer
        Number of method parameters that can have annotations. See MethodVisitor.visitAnnotableParameterCount(int, boolean).
        Overrides:
        visitAnnotableParameterCount in class Printer
        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.
        Returns:
        the printer.
      • visitParameterAnnotation

        public ASMifier visitParameterAnnotation​(int parameter,
                                                 java.lang.String descriptor,
                                                 boolean visible)
        Description copied from class: Printer
        Specified by:
        visitParameterAnnotation in class Printer
        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 in Printer.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:
        the printer.
      • visitInsn

        public void visitInsn​(int opcode)
        Description copied from class: Printer
        Method instruction. See MethodVisitor.visitInsn(int)
        Specified by:
        visitInsn in class Printer
        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.
      • visitVarInsn

        public void visitVarInsn​(int opcode,
                                 int var)
        Description copied from class: Printer
        Method instruction. See MethodVisitor.visitVarInsn(int, int).
        Specified by:
        visitVarInsn in class Printer
        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: Printer
        Specified by:
        visitTypeInsn in class Printer
        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 (see Type.getInternalName()).
      • visitMethodInsn

        public void visitMethodInsn​(int opcode,
                                    java.lang.String owner,
                                    java.lang.String name,
                                    java.lang.String descriptor,
                                    boolean isInterface)
        Description copied from class: Printer
        Overrides:
        visitMethodInsn in class Printer
        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 (see Type.getInternalName()).
        name - the method's name.
        descriptor - the method's descriptor (see Type).
        isInterface - if the method's owner class is an interface.
      • visitJumpInsn

        public void visitJumpInsn​(int opcode,
                                  Label label)
        Description copied from class: Printer
        Specified by:
        visitJumpInsn in class Printer
        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.
      • visitLdcInsn

        public void visitLdcInsn​(java.lang.Object value)
        Description copied from class: Printer
        Specified by:
        visitLdcInsn in class Printer
        Parameters:
        value - the constant to be loaded on the stack. This parameter must be a non null Integer, a Float, a Long, a Double, a String, a Type of OBJECT or ARRAY sort for .class constants, for classes whose version is 49, a Type of METHOD sort for MethodType, a Handle for MethodHandle constants, for classes whose version is 51 or a ConstantDynamic for a constant dynamic for classes whose version is 55.
      • visitIincInsn

        public void visitIincInsn​(int var,
                                  int increment)
        Description copied from class: Printer
        Method instruction. See MethodVisitor.visitIincInsn(int, int).
        Specified by:
        visitIincInsn in class Printer
        Parameters:
        var - index of the local variable to be incremented.
        increment - amount to increment the local variable by.
      • visitLocalVariableAnnotation

        public Printer visitLocalVariableAnnotation​(int typeRef,
                                                    TypePath typePath,
                                                    Label[] start,
                                                    Label[] end,
                                                    int[] index,
                                                    java.lang.String descriptor,
                                                    boolean visible)
        Description copied from class: Printer
        Overrides:
        visitLocalVariableAnnotation in class Printer
        Parameters:
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.LOCAL_VARIABLE or TypeReference.RESOURCE_VARIABLE. See TypeReference.
        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:
        the printer.
      • visitMaxs

        public void visitMaxs​(int maxStack,
                              int maxLocals)
        Description copied from class: Printer
        Method max stack and max locals. See MethodVisitor.visitMaxs(int, int).
        Specified by:
        visitMaxs in class Printer
        Parameters:
        maxStack - maximum stack size of the method.
        maxLocals - maximum number of local variables for the method.
      • visitAnnotation

        public ASMifier visitAnnotation​(java.lang.String descriptor,
                                        boolean visible)
        Visits a class, field or method annotation.
        Parameters:
        descriptor - the class descriptor of the annotation class.
        visible - true if the annotation is visible at runtime.
        Returns:
        a new ASMifier to visit the annotation values.
      • visitTypeAnnotation

        public ASMifier visitTypeAnnotation​(int typeRef,
                                            TypePath typePath,
                                            java.lang.String descriptor,
                                            boolean visible)
        Visits a class, field or method type annotation.
        Parameters:
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.FIELD. See TypeReference.
        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 new ASMifier to visit the annotation values.
      • visitTypeAnnotation

        public ASMifier visitTypeAnnotation​(java.lang.String method,
                                            int typeRef,
                                            TypePath typePath,
                                            java.lang.String descriptor,
                                            boolean visible)
        Visits a class, field, method, instruction or try catch block type annotation.
        Parameters:
        method - the name of the visit method for this type of annotation.
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.FIELD. See TypeReference.
        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 new ASMifier to visit the annotation values.
      • visitAttribute

        public void visitAttribute​(Attribute attribute)
        Visit a class, field or method attribute.
        Parameters:
        attribute - an attribute.
      • createASMifier

        protected ASMifier createASMifier​(java.lang.String visitorVariableName,
                                          int annotationVisitorId)
        Constructs a new ASMifier.
        Parameters:
        visitorVariableName - the name of the visitor variable in the produced code.
        annotationVisitorId - identifier of the annotation visitor variable in the produced code.
        Returns:
        a new ASMifier.
      • appendConstant

        protected void appendConstant​(java.lang.Object value)
        Appends a string representation of the given constant to Printer.stringBuilder.
        Parameters:
        value - a String, Type, Handle, Byte, Short, Character, Integer, Float, Long or Double object, or an array of primitive values. May be null.
      • declareLabel

        protected void declareLabel​(Label label)
        Appends a declaration of the given label to Printer.stringBuilder. This declaration is of the form "Label labelXXX = new Label();". Does nothing if the given label has already been declared.
        Parameters:
        label - a label.