Package org.apache.bcel.generic

Class InstructionFactory

  • All Implemented Interfaces:
    InstructionConstants
    public class InstructionFactory
extends java.lang.Object
implements InstructionConstants
    Instances of this class may be used, for example, to generate typed versions of instructions. Its main purpose is to be used as the byte code generating backend of a compiler. You can subclass it to add your own create methods.

    Note: The static createXXX methods return singleton instances from the InstructionConst class.

    See Also:
    Const, InstructionConst

    • Field Detail

      • FQCN_STRING_BUFFER

        private static final java.lang.String FQCN_STRING_BUFFER
        See Also:
        Constant Field Values

      • SHORT_NAMES

        private static final java.lang.String[] SHORT_NAMES
        These must agree with the order of Constants.T_CHAR through T_LONG.

      • cg

        @Deprecated
protected ClassGen cg
        Deprecated.
        (since 6.0) will be made private; do not access directly, use getter/setter

      • cp

        @Deprecated
protected ConstantPoolGen cp
        Deprecated.
        (since 6.0) will be made private; do not access directly, use getter/setter

    • Constructor Detail

      • InstructionFactory

        public InstructionFactory​(ClassGen cg)
        Initialize with ClassGen object.
        Parameters:
        cg - the class generator.

      • InstructionFactory

        public InstructionFactory​(ClassGen cg,
                          ConstantPoolGen cp)
        Constructs an InstructionFactory.
        Parameters:
        cg - the class generator.
        cp - the constant pool generator.

      • InstructionFactory

        public InstructionFactory​(ConstantPoolGen cp)
        Initialize just with ConstantPoolGen object.
        Parameters:
        cp - the constant pool generator.

    • Method Detail

      • createArrayLoad

        public static ArrayInstruction createArrayLoad​(Type type)
        Creates an array load instruction for the given type.
        Parameters:
        type - type of elements of array, that is, array.getElementType().
        Returns:
        the array load instruction.

      • createArrayStore

        public static ArrayInstruction createArrayStore​(Type type)
        Creates an array store instruction for the given type.
        Parameters:
        type - type of elements of array, that is, array.getElementType().
        Returns:
        the array store instruction.

      • createBinaryIntOp

        private static ArithmeticInstruction createBinaryIntOp​(char first,
                                                       java.lang.String op)

      • createBinaryLongOp

        private static ArithmeticInstruction createBinaryLongOp​(char first,
                                                        java.lang.String op)
        Create an invokedynamic instruction.
        Parameters:
        bootstrap_index - index into the bootstrap_methods array.
        name - name of the called method.
        ret_type - return type of method.
        argTypes - argument types of method.
        See Also:
        Const

      • createBinaryOperation

        public static ArithmeticInstruction createBinaryOperation​(java.lang.String op,
                                                          Type type)
        Create binary operation for simple basic types, such as int and float.
        Parameters:
        op - operation, such as "+", "*", "<<", etc.
        type - the operand type.
        Returns:
        the binary arithmetic instruction.

      • createBranchInstruction

        public static BranchInstruction createBranchInstruction​(short opcode,
                                                        InstructionHandle target)
        Create branch instruction by given opcode, except LOOKUPSWITCH and TABLESWITCH. For those you should use the SWITCH compound instruction.
        Parameters:
        opcode - the branch opcode.
        target - the target instruction handle.
        Returns:
        the branch instruction.

      • createDup

        public static StackInstruction createDup​(int size)
        Creates a DUP instruction.
        Parameters:
        size - size of operand, either 1 (int, for example) or 2 (double).
        Returns:
        the DUP instruction.

      • createDup_1

        public static StackInstruction createDup_1​(int size)
        Creates a DUP_X1 instruction.
        Parameters:
        size - size of operand, either 1 (int, for example) or 2 (double).
        Returns:
        the DUP instruction.

      • createDup_2

        public static StackInstruction createDup_2​(int size)
        Creates a DUP_X2 instruction.
        Parameters:
        size - size of operand, either 1 (int, for example) or 2 (double).
        Returns:
        the DUP instruction.

      • createLoad

        public static LocalVariableInstruction createLoad​(Type type,
                                                  int index)
        Creates a load instruction for the given type.
        Parameters:
        type - the variable type.
        index - index of local variable.
        Returns:
        the load instruction.

      • createNull

        public static Instruction createNull​(Type type)
        Create "null" value for reference types, 0 for basic types like int.
        Parameters:
        type - the type.
        Returns:
        the null or zero instruction.

      • createPop

        public static StackInstruction createPop​(int size)
        Creates a pop instruction.
        Parameters:
        size - size of operand, either 1 (int, for example) or 2 (double).
        Returns:
        the pop instruction.

      • createReturn

        public static ReturnInstruction createReturn​(Type type)
        Create typed return.
        Parameters:
        type - the return type.
        Returns:
        the return instruction.

      • createStore

        public static LocalVariableInstruction createStore​(Type type,
                                                   int index)
        Creates a store instruction.
        Parameters:
        type - the variable type.
        index - index of local variable.
        Returns:
        the store instruction.

      • createThis

        public static Instruction createThis()
        Create reference to 'this'.
        Returns:
        reference to 'this'.

      • isString

        private static boolean isString​(Type type)

      • createAppend

        public Instruction createAppend​(Type type)
        Creates an append instruction for the given type.
        Parameters:
        type - the type to append.
        Returns:
        the append instruction.

      • createCast

        public Instruction createCast​(Type srcType,
                              Type destType)
        Create conversion operation for two stack operands, this may be an I2C, instruction, for example, if the operands are basic types and CHECKCAST if they are reference types.
        Parameters:
        srcType - the source type.
        destType - the destination type.
        Returns:
        the conversion instruction.

      • createCheckCast

        public CHECKCAST createCheckCast​(ReferenceType t)
        Creates a CHECKCAST instruction.
        Parameters:
        t - the reference type.
        Returns:
        the CHECKCAST instruction.

      • createConstant

        public Instruction createConstant​(java.lang.Object value)
        Uses PUSH to push a constant value onto the stack.
        Parameters:
        value - must be of type Number, Boolean, Character or String.
        Returns:
        the instruction.

      • createFieldAccess

        public FieldInstruction createFieldAccess​(java.lang.String className,
                                          java.lang.String name,
                                          Type type,
                                          short kind)
        Create a field instruction.
        Parameters:
        className - name of the accessed class.
        name - name of the referenced field.
        type - type of field.
        kind - how to access, that is, GETFIELD, PUTFIELD, GETSTATIC, PUTSTATIC.
        See Also:
        Const

      • createGetField

        public GETFIELD createGetField​(java.lang.String className,
                               java.lang.String name,
                               Type t)
        Creates a GETFIELD instruction.
        Parameters:
        className - the class name.
        name - the field name.
        t - the field type.
        Returns:
        the GETFIELD instruction.

      • createGetStatic

        public GETSTATIC createGetStatic​(java.lang.String className,
                                 java.lang.String name,
                                 Type t)
        Creates a GETSTATIC instruction.
        Parameters:
        className - the class name.
        name - the field name.
        t - the field type.
        Returns:
        the GETSTATIC instruction.

      • createInstanceOf

        public INSTANCEOF createInstanceOf​(ReferenceType t)
        Creates an INSTANCEOF instruction.
        Parameters:
        t - the reference type.
        Returns:
        the INSTANCEOF instruction.

      • createInvoke

        public InvokeInstruction createInvoke​(java.lang.String className,
                                      java.lang.String name,
                                      Type retType,
                                      Type[] argTypes,
                                      short kind)
        Create an invoke instruction. (Except for invokedynamic.)
        Parameters:
        className - name of the called class.
        name - name of the called method.
        retType - return type of method.
        argTypes - argument types of method.
        kind - how to invoke, that is, INVOKEINTERFACE, INVOKESTATIC, INVOKEVIRTUAL, or INVOKESPECIAL.
        Returns:
        the invoke instruction.
        See Also:
        Const

      • createInvoke

        public InvokeInstruction createInvoke​(java.lang.String className,
                                      java.lang.String name,
                                      Type retType,
                                      Type[] argTypes,
                                      short kind,
                                      boolean useInterface)
        Create an invoke instruction. (Except for invokedynamic.)
        Parameters:
        className - name of the called class.
        name - name of the called method.
        retType - return type of method.
        argTypes - argument types of method.
        kind - how to invoke: INVOKEINTERFACE, INVOKESTATIC, INVOKEVIRTUAL, or INVOKESPECIAL.
        useInterface - force use of InterfaceMethodref.
        Returns:
        A new InvokeInstruction.
        Since:
        6.5.0

      • createNew

        public NEW createNew​(ObjectType t)
        Creates a NEW instruction.
        Parameters:
        t - the object type.
        Returns:
        the NEW instruction.

      • createNew

        public NEW createNew​(java.lang.String s)
        Creates a NEW instruction.
        Parameters:
        s - the class name.
        Returns:
        the NEW instruction.

      • createNewArray

        public Instruction createNewArray​(Type t,
                                  short dim)
        Create new array of given size and type.
        Parameters:
        t - the array element type.
        dim - the array dimensions.
        Returns:
        an instruction that creates the corresponding array at runtime, for example is an AllocationInstruction.

      • createPrintln

        public InstructionList createPrintln​(java.lang.String s)
        Create a call to the most popular System.out.println() method.
        Parameters:
        s - the string to print.
        Returns:
        the instruction list.

      • createPutField

        public PUTFIELD createPutField​(java.lang.String className,
                               java.lang.String name,
                               Type t)
        Creates a PUTFIELD instruction.
        Parameters:
        className - the class name.
        name - the field name.
        t - the field type.
        Returns:
        the PUTFIELD instruction.

      • createPutStatic

        public PUTSTATIC createPutStatic​(java.lang.String className,
                                 java.lang.String name,
                                 Type t)
        Creates a PUTSTATIC instruction.
        Parameters:
        className - the class name.
        name - the field name.
        t - the field type.
        Returns:
        the PUTSTATIC instruction.

      • getClassGen

        public ClassGen getClassGen()
        Gets the class generator.
        Returns:
        the class generator.

      • getConstantPool

        public ConstantPoolGen getConstantPool()
        Gets the constant pool generator.
        Returns:
        the constant pool generator.

      • setClassGen

        public void setClassGen​(ClassGen c)
        Sets the class generator.
        Parameters:
        c - the class generator.

      • setConstantPool

        public void setConstantPool​(ConstantPoolGen c)
        Sets the constant pool generator.
        Parameters:
        c - the constant pool generator.