|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.retrotranslator.runtime.asm.ClassWriter
public class ClassWriter
A ClassVisitor
that generates classes in bytecode form. More
precisely this visitor generates a byte array conforming to the Java class
file format. It can be used alone, to generate a Java class "from scratch",
or with one or more ClassReader
and adapter class visitor
to generate a modified class from one or more existing Java classes.
Field Summary | |
---|---|
private int |
access
The access flags of this class. |
private AnnotationWriter |
anns
The runtime visible annotations of this class. |
private Attribute |
attrs
The non standard attributes of this class. |
(package private) static int |
CLASS
The type of CONSTANT_Class constant pool items. |
private boolean |
computeMaxs
true if the maximum stack size and number of local variables must be automatically computed. |
(package private) ClassReader |
cr
The class reader from which this class writer was constructed, if any. |
(package private) static int |
DOUBLE
The type of CONSTANT_Double constant pool items. |
private int |
enclosingMethod
The constant pool item that contains the name and descriptor of the enclosing method of this class. |
private int |
enclosingMethodOwner
The constant pool item that contains the name of the enclosing class of this class. |
(package private) static int |
FIELD
The type of CONSTANT_Fieldref constant pool items. |
(package private) static int |
FIELDORMETH_INSN
The type of field and method invocations instructions. |
(package private) FieldWriter |
firstField
The fields of this class. |
(package private) MethodWriter |
firstMethod
The methods of this class. |
(package private) static int |
FLOAT
The type of CONSTANT_Float constant pool items. |
private AnnotationWriter |
ianns
The runtime invisible annotations of this class. |
(package private) static int |
IINC_INSN
The type of the IINC instruction. |
(package private) static int |
IMETH
The type of CONSTANT_InterfaceMethodref constant pool items. |
(package private) static int |
IMPLVAR_INSN
The type of instructions with an implicit local variable index argument. |
(package private) int |
index
Index of the next item to be added in the constant pool. |
private ByteVector |
innerClasses
The InnerClasses attribute. |
private int |
innerClassesCount
The number of entries in the InnerClasses attribute. |
(package private) static int |
INT
The type of CONSTANT_Integer constant pool items. |
private int |
interfaceCount
Number of interfaces implemented or extended by this class or interface. |
private int[] |
interfaces
The interfaces implemented or extended by this class or interface. |
(package private) Item[] |
items
The constant pool's hash table data. |
(package private) static int |
ITFMETH_INSN
The type of the INVOKEINTERFACE instruction. |
(package private) Item |
key
A reusable key used to look for items in the hash items . |
(package private) Item |
key2
A reusable key used to look for items in the hash items . |
(package private) Item |
key3
A reusable key used to look for items in the hash items . |
(package private) static int |
LABEL_INSN
The type of instructions with a 2 bytes bytecode offset label. |
(package private) static int |
LABELW_INSN
The type of instructions with a 4 bytes bytecode offset label. |
(package private) FieldWriter |
lastField
The fields of this class. |
(package private) MethodWriter |
lastMethod
The methods of this class. |
(package private) static int |
LDC_INSN
The type of the LDC instruction. |
(package private) static int |
LDCW_INSN
The type of the LDC_W and LDC2_W instructions. |
(package private) static int |
LONG
The type of CONSTANT_Long constant pool items. |
(package private) static int |
LOOK_INSN
The type of the LOOKUPSWITCH instruction. |
(package private) static int |
MANA_INSN
The type of the MULTIANEWARRAY instruction. |
(package private) static int |
METH
The type of CONSTANT_Methodref constant pool items. |
private int |
name
The constant pool item that contains the internal name of this class. |
(package private) static int |
NAME_TYPE
The type of CONSTANT_NameAndType constant pool items. |
(package private) static int |
NOARG_INSN
The type of instructions without any argument. |
(package private) ByteVector |
pool
The constant pool of this class. |
(package private) static int |
SBYTE_INSN
The type of instructions with an signed byte argument. |
(package private) static int |
SHORT_INSN
The type of instructions with an signed short argument. |
private int |
signature
The constant pool item that contains the signature of this class. |
private ByteVector |
sourceDebug
The SourceDebug attribute of this class. |
private int |
sourceFile
The index of the constant pool item that contains the name of the source file from which this class was compiled. |
(package private) static int |
STR
The type of CONSTANT_String constant pool items. |
private int |
superName
The constant pool item that contains the internal name of the super class of this class. |
(package private) static int |
TABL_INSN
The type of the TABLESWITCH instruction. |
(package private) int |
threshold
The threshold of the constant pool's hash table. |
(package private) static byte[] |
TYPE
The instruction types of all JVM opcodes. |
(package private) static int |
TYPE_INSN
The type of instructions with a type descriptor argument. |
(package private) static int |
UTF8
The type of CONSTANT_Utf8 constant pool items. |
(package private) static int |
VAR_INSN
The type of instructions with a local variable index argument. |
(package private) int |
version
Minor and major version numbers of the class to be generated. |
(package private) static int |
WIDE_INSN
The type of the WIDE instruction. |
Constructor Summary | |
---|---|
ClassWriter(boolean computeMaxs)
Constructs a new ClassWriter object. |
|
ClassWriter(boolean computeMaxs,
boolean skipUnknownAttributes)
Constructs a new ClassWriter object. |
|
ClassWriter(ClassReader classReader,
boolean computeMaxs)
Constructs a new ClassWriter object and enables optimizations for
"mostly add" bytecode transformations. |
Method Summary | |
---|---|
private Item |
get(Item key)
Returns the constant pool's hash table item which is equal to the given item. |
int |
newClass(java.lang.String value)
Adds a class reference to the constant pool of the class being build. |
private Item |
newClassItem(java.lang.String value)
Adds a class reference to the constant pool of the class being build. |
int |
newConst(java.lang.Object cst)
Adds a number or string constant to the constant pool of the class being build. |
(package private) Item |
newConstItem(java.lang.Object cst)
Adds a number or string constant to the constant pool of the class being build. |
(package private) Item |
newDouble(double value)
Adds a double to the constant pool of the class being build. |
int |
newField(java.lang.String owner,
java.lang.String name,
java.lang.String desc)
Adds a field reference to the constant pool of the class being build. |
(package private) Item |
newFloat(float value)
Adds a float to the constant pool of the class being build. |
(package private) Item |
newInteger(int value)
Adds an integer to the constant pool of the class being build. |
(package private) Item |
newLong(long value)
Adds a long to the constant pool of the class being build. |
int |
newMethod(java.lang.String owner,
java.lang.String name,
java.lang.String desc,
boolean itf)
Adds a method reference to the constant pool of the class being build. |
(package private) Item |
newMethodItem(java.lang.String owner,
java.lang.String name,
java.lang.String desc,
boolean itf)
Adds a method reference to the constant pool of the class being build. |
int |
newNameType(java.lang.String name,
java.lang.String desc)
Adds a name and type to the constant pool of the class being build. |
private Item |
newString(java.lang.String value)
Adds a string to the constant pool of the class being build. |
int |
newUTF8(java.lang.String value)
Adds an UTF8 string to the constant pool of the class being build. |
private void |
put(Item i)
Puts the given item in the constant pool's hash table. |
private void |
put122(int b,
int s1,
int s2)
Puts one byte and two shorts into the constant pool. |
byte[] |
toByteArray()
Returns the bytecode of the class that was build with this class writer. |
byte[] |
toByteArray(boolean dropTigerFlags)
|
void |
visit(int version,
int access,
java.lang.String name,
java.lang.String signature,
java.lang.String superName,
java.lang.String[] interfaces)
Visits the header of the class. |
AnnotationVisitor |
visitAnnotation(java.lang.String desc,
boolean visible)
Visits an annotation of the class. |
void |
visitAttribute(Attribute attr)
Visits a non standard attribute of the class. |
void |
visitEnd()
Visits the end of the class. |
FieldVisitor |
visitField(int access,
java.lang.String name,
java.lang.String desc,
java.lang.String signature,
java.lang.Object value)
Visits a field of the class. |
void |
visitInnerClass(java.lang.String name,
java.lang.String outerName,
java.lang.String innerName,
int access)
Visits information about an inner class. |
MethodVisitor |
visitMethod(int access,
java.lang.String name,
java.lang.String desc,
java.lang.String signature,
java.lang.String[] exceptions)
Visits a method of the class. |
void |
visitOuterClass(java.lang.String owner,
java.lang.String name,
java.lang.String desc)
Visits the enclosing class of the class. |
void |
visitSource(java.lang.String file,
java.lang.String debug)
Visits the source of the class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
static final int NOARG_INSN
static final int SBYTE_INSN
static final int SHORT_INSN
static final int VAR_INSN
static final int IMPLVAR_INSN
static final int TYPE_INSN
static final int FIELDORMETH_INSN
static final int ITFMETH_INSN
static final int LABEL_INSN
static final int LABELW_INSN
static final int LDC_INSN
static final int LDCW_INSN
static final int IINC_INSN
static final int TABL_INSN
static final int LOOK_INSN
static final int MANA_INSN
static final int WIDE_INSN
static byte[] TYPE
static final int CLASS
static final int FIELD
static final int METH
static final int IMETH
static final int STR
static final int INT
static final int FLOAT
static final int LONG
static final int DOUBLE
static final int NAME_TYPE
static final int UTF8
ClassReader cr
int version
int index
ByteVector pool
Item[] items
int threshold
Item key
items
.
Item key2
items
.
Item key3
items
.
private int access
private int name
private int signature
private int superName
private int interfaceCount
private int[] interfaces
private int sourceFile
private ByteVector sourceDebug
private int enclosingMethodOwner
private int enclosingMethod
private AnnotationWriter anns
private AnnotationWriter ianns
private Attribute attrs
private int innerClassesCount
private ByteVector innerClasses
FieldWriter firstField
FieldWriter
objects, linked to each other by their
FieldWriter.next
field. This field stores the first element of
this list.
FieldWriter lastField
FieldWriter
objects, linked to each other by their
FieldWriter.next
field. This field stores the last element of
this list.
MethodWriter firstMethod
MethodWriter
objects, linked to each other by their
MethodWriter.next
field. This field stores the first element of
this list.
MethodWriter lastMethod
MethodWriter
objects, linked to each other by their
MethodWriter.next
field. This field stores the last element of
this list.
private boolean computeMaxs
Constructor Detail |
---|
public ClassWriter(boolean computeMaxs)
ClassWriter
object.
computeMaxs
- true if the maximum stack size and the
maximum number of local variables must be automatically computed.
If this flag is true, then the arguments of the
visitMaxs
method of the
MethodVisitor
returned by the
visitMethod
method will be ignored, and
computed automatically from the signature and the bytecode of each
method.public ClassWriter(boolean computeMaxs, boolean skipUnknownAttributes)
ClassWriter
object.
computeMaxs
- true if the maximum stack size and the
maximum number of local variables must be automatically computed.
If this flag is true, then the arguments of the
visitMaxs
method of the
MethodVisitor
returned by the
visitMethod
method will be ignored, and
computed automatically from the signature and the bytecode of each
method.skipUnknownAttributes
- Deprecated. The value of this
parameter is ignored.public ClassWriter(ClassReader classReader, boolean computeMaxs)
ClassWriter
object and enables optimizations for
"mostly add" bytecode transformations. These optimizations are the
following:
ClassReader
receives MethodVisitor
objects
that come from a ClassWriter
(and not from a custom
ClassAdapter
or any other ClassVisitor
instance).
classReader
- the ClassReader
used to read the original
class. It will be used to copy the entire constant pool from the
original class and also to copy other fragments of original
bytecode where applicable.computeMaxs
- true if the maximum stack size and the
maximum number of local variables must be automatically computed.
If this flag is true, then the arguments of the
visitMaxs
method of the
MethodVisitor
returned by the
visitMethod
method will be ignored, and
computed automatically from the signature and the bytecode of each
method.Method Detail |
---|
public void visit(int version, int access, java.lang.String name, java.lang.String signature, java.lang.String superName, java.lang.String[] interfaces)
ClassVisitor
visit
in interface ClassVisitor
version
- the class version.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
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
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
getInternalName
). May be
null.public void visitSource(java.lang.String file, java.lang.String debug)
ClassVisitor
visitSource
in interface ClassVisitor
file
- the name of the source file from which the class was
compiled. May be null.debug
- additional debug information to compute the correspondance
between source and compiled elements of the class. May be
null.public void visitOuterClass(java.lang.String owner, java.lang.String name, java.lang.String desc)
ClassVisitor
visitOuterClass
in interface ClassVisitor
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.desc
- the descriptor of the method that contains the class, or
null if the class is not enclosed in a method of its
enclosing class.public AnnotationVisitor visitAnnotation(java.lang.String desc, boolean visible)
ClassVisitor
visitAnnotation
in interface ClassVisitor
desc
- the class descriptor of the annotation class.visible
- true if the annotation is visible at runtime.
public void visitAttribute(Attribute attr)
ClassVisitor
visitAttribute
in interface ClassVisitor
attr
- an attribute.public void visitInnerClass(java.lang.String name, java.lang.String outerName, java.lang.String innerName, int access)
ClassVisitor
visitInnerClass
in interface ClassVisitor
name
- the internal name of an inner class (see
getInternalName
).outerName
- the internal name of the class to which the inner class
belongs (see getInternalName
). May
be null.innerName
- the (simple) name of the inner class inside its
enclosing class. May be null for anonymous inner
classes.access
- the access flags of the inner class as originally declared
in the enclosing class.public FieldVisitor visitField(int access, java.lang.String name, java.lang.String desc, java.lang.String signature, java.lang.Object value)
ClassVisitor
visitField
in interface ClassVisitor
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.desc
- 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.
public MethodVisitor visitMethod(int access, java.lang.String name, java.lang.String desc, java.lang.String signature, java.lang.String[] exceptions)
ClassVisitor
MethodVisitor
instance (or null) each time it is
called, i.e., it should not return a previously returned visitor.
visitMethod
in interface ClassVisitor
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.desc
- 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 getInternalName
). May be
null.
public void visitEnd()
ClassVisitor
visitEnd
in interface ClassVisitor
public byte[] toByteArray()
public byte[] toByteArray(boolean dropTigerFlags)
Item newConstItem(java.lang.Object cst)
cst
- the value of the constant to be added to the constant pool.
This parameter must be an Integer
, a Float
, a
Long
, a Double
, a String
or a
Type
.
public int newConst(java.lang.Object cst)
Attribute
sub classes, and is
normally not needed by class generators or adapters.
cst
- the value of the constant to be added to the constant pool.
This parameter must be an Integer
, a Float
, a
Long
, a Double
or a String
.
public int newUTF8(java.lang.String value)
Attribute
sub classes, and is normally not
needed by class generators or adapters.
value
- the String value.
public int newClass(java.lang.String value)
Attribute
sub classes, and is
normally not needed by class generators or adapters.
value
- the internal name of the class.
private Item newClassItem(java.lang.String value)
Attribute
sub classes, and is
normally not needed by class generators or adapters.
value
- the internal name of the class.
public int newField(java.lang.String owner, java.lang.String name, java.lang.String desc)
Attribute
sub classes, and is
normally not needed by class generators or adapters.
owner
- the internal name of the field's owner class.name
- the field's name.desc
- the field's descriptor.
Item newMethodItem(java.lang.String owner, java.lang.String name, java.lang.String desc, boolean itf)
owner
- the internal name of the method's owner class.name
- the method's name.desc
- the method's descriptor.itf
- true if owner is an interface.
public int newMethod(java.lang.String owner, java.lang.String name, java.lang.String desc, boolean itf)
Attribute
sub classes, and is
normally not needed by class generators or adapters.
owner
- the internal name of the method's owner class.name
- the method's name.desc
- the method's descriptor.itf
- true if owner is an interface.
Item newInteger(int value)
value
- the int value.
Item newFloat(float value)
value
- the float value.
Item newLong(long value)
value
- the long value.
Item newDouble(double value)
value
- the double value.
private Item newString(java.lang.String value)
value
- the String value.
public int newNameType(java.lang.String name, java.lang.String desc)
Attribute
sub classes, and is normally not
needed by class generators or adapters.
name
- a name.desc
- a type descriptor.
private Item get(Item key)
key
- a constant pool item.
private void put(Item i)
i
- the item to be added to the constant pool's hash table.private void put122(int b, int s1, int s2)
b
- a byte.s1
- a short.s2
- another short.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |