proguard.classfile.editor

Class SimplifiedClassEditor

java.lang.Object

proguard.classfile.util.SimplifiedVisitor

proguard.classfile.editor.SimplifiedClassEditor

All Implemented Interfaces:

AttributeVisitor

public class SimplifiedClassEditor
extends SimplifiedVisitor
implements AttributeVisitor

This editor allows to build and/or edit classes (ProgramClass instances). It provides methods to easily add fields and methods to classes.

Author:

Johan Leys

Constructor Summary

Constructors

Constructor and Description
SimplifiedClassEditor(int u2accessFlags, String className) Creates a new SimplifiedClassEditor for the Java class with the given name.
SimplifiedClassEditor(int u2accessFlags, String className, String superclassName) Creates a new SimplifiedClassEditor for the Java class with the given name and super class.
SimplifiedClassEditor(ProgramClass programClass) Creates a new SimplifiedClassEditor for the given class.

Method Summary

Modifier and Type	Method and Description
int	addClassConstant(String name, Clazz referencedClass) Adds the given class constant to the edited class.
SimplifiedClassEditor	addField(int u2accessFlags, String fieldName, String fieldDescriptor) Adds a new field to the edited class.
void	addInitializerInstructions(Instruction[] instructions) Adds the given initialization instructions to the edited class.
CompactCodeAttributeComposer	addMethod(int u2accessFlags, String methodName, String methodDescriptor, Clazz[] referencedClasses, int maxCodeFragmentLength) Adds a new method to the edited class.
ProgramMethod	addMethod(int u2accessFlags, String methodName, String methodDescriptor, Instruction[] instructions) Adds a new method to the edited class, with the given instructions array.
CompactCodeAttributeComposer	addMethod(int u2accessFlags, String methodName, String methodDescriptor, int maxCodeFragmentLength) Adds a new method to the edited class.
void	addStaticInitializerInstructions(Instruction[] instructions, boolean mergeIntoExistingInitializer) Adds the given static initializer instructions to the edited class.
void	finishEditing() Finalizes the editing of the class.
void	finishEditing(ClassPool programClassPool, ClassPool libraryClassPool) Finalizes the editing of the class, and initializes all references of the edited class w.r.t.
ProgramClass	getProgramClass() Returns the edited ProgramClass instance.
void	visitAnyAttribute(Clazz clazz, Attribute attribute) Visit any type of attribute.
void	visitCodeAttribute(Clazz clazz, Method method, CodeAttribute codeAttribute)

Methods inherited from class proguard.classfile.util.SimplifiedVisitor

visitAnnotation, visitAnnotation, visitAnnotation, visitAnnotation, visitAnnotation, visitAnnotation, visitAnnotationDefaultAttribute, visitAnnotationElementValue, visitAnyAnnotationsAttribute, visitAnyClass, visitAnyConstant, visitAnyElementValue, visitAnyInstruction, visitAnyMember, visitAnyMethodrefConstant, visitAnyParameterAnnotationsAttribute, visitAnyPrimitiveArrayConstant, visitAnyPrimitiveArrayConstantElement, visitAnyRefConstant, visitAnyStackMapFrame, visitAnySwitchInstruction, visitAnyTargetInfo, visitAnyTypeAnnotationsAttribute, visitAnyVerificationType, visitArrayElementValue, visitBooleanArrayConstant, visitBooleanArrayConstantElement, visitBootstrapMethodsAttribute, visitBranchInstruction, visitByteArrayConstant, visitByteArrayConstantElement, visitCatchTargetInfo, visitCharArrayConstant, visitCharArrayConstantElement, visitClassConstant, visitClassElementValue, visitConstantElementValue, visitConstantInstruction, visitConstantValueAttribute, visitDeprecatedAttribute, visitDeprecatedAttribute, visitDeprecatedAttribute, visitDeprecatedAttribute, visitDoubleArrayConstant, visitDoubleArrayConstantElement, visitDoubleConstant, visitDoubleType, visitDynamicConstant, visitEmptyTargetInfo, visitEmptyTargetInfo, visitEmptyTargetInfo, visitEnclosingMethodAttribute, visitEnumConstantElementValue, visitExceptionsAttribute, visitFieldrefConstant, visitFloatArrayConstant, visitFloatArrayConstantElement, visitFloatConstant, visitFloatType, visitFormalParameterTargetInfo, visitFullFrame, visitInnerClassesAttribute, visitIntArrayConstant, visitIntArrayConstantElement, visitIntegerConstant, visitIntegerType, visitInterfaceMethodrefConstant, visitInvokeDynamicConstant, visitLessZeroFrame, visitLibraryClass, visitLibraryField, visitLibraryMember, visitLibraryMethod, visitLineNumberTableAttribute, visitLocalVariableTableAttribute, visitLocalVariableTargetInfo, visitLocalVariableTypeTableAttribute, visitLongArrayConstant, visitLongArrayConstantElement, visitLongConstant, visitLongType, visitLookUpSwitchInstruction, visitMethodHandleConstant, visitMethodParametersAttribute, visitMethodrefConstant, visitMethodTypeConstant, visitModuleAttribute, visitModuleConstant, visitModuleMainClassAttribute, visitModulePackagesAttribute, visitMoreZeroFrame, visitNameAndTypeConstant, visitNestHostAttribute, visitNestMembersAttribute, visitNullType, visitObjectType, visitOffsetTargetInfo, visitPackageConstant, visitPrimitiveArrayConstant, visitProgramClass, visitProgramField, visitProgramMember, visitProgramMethod, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleParameterAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleParameterAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitSameOneFrame, visitSameZeroFrame, visitShortArrayConstant, visitShortArrayConstantElement, visitSignatureAttribute, visitSignatureAttribute, visitSignatureAttribute, visitSignatureAttribute, visitSimpleInstruction, visitSourceDirAttribute, visitSourceFileAttribute, visitStackDoubleType, visitStackFloatType, visitStackIntegerType, visitStackLongType, visitStackMapAttribute, visitStackMapTableAttribute, visitStackNullType, visitStackObjectType, visitStackTopType, visitStackUninitializedThisType, visitStackUninitializedType, visitStringConstant, visitSuperTypeTargetInfo, visitSyntheticAttribute, visitSyntheticAttribute, visitSyntheticAttribute, visitSyntheticAttribute, visitTableSwitchInstruction, visitThrowsTargetInfo, visitTopType, visitTypeAnnotation, visitTypeAnnotation, visitTypeAnnotation, visitTypeAnnotation, visitTypeAnnotation, visitTypeAnnotation, visitTypeArgumentTargetInfo, visitTypeParameterBoundTargetInfo, visitTypeParameterBoundTargetInfo, visitTypeParameterBoundTargetInfo, visitTypeParameterBoundTargetInfo, visitTypeParameterTargetInfo, visitTypeParameterTargetInfo, visitTypePathInfo, visitTypePathInfo, visitTypePathInfo, visitTypePathInfo, visitTypePathInfo, visitUninitializedThisType, visitUninitializedType, visitUnknownAttribute, visitUtf8Constant, visitVariableInstruction, visitVariablesDoubleType, visitVariablesFloatType, visitVariablesIntegerType, visitVariablesLongType, visitVariablesNullType, visitVariablesObjectType, visitVariablesTopType, visitVariablesUninitializedThisType, visitVariablesUninitializedType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface proguard.classfile.attribute.visitor.AttributeVisitor

visitAnnotationDefaultAttribute, visitBootstrapMethodsAttribute, visitConstantValueAttribute, visitDeprecatedAttribute, visitDeprecatedAttribute, visitDeprecatedAttribute, visitEnclosingMethodAttribute, visitExceptionsAttribute, visitInnerClassesAttribute, visitLineNumberTableAttribute, visitLocalVariableTableAttribute, visitLocalVariableTypeTableAttribute, visitMethodParametersAttribute, visitModuleAttribute, visitModuleMainClassAttribute, visitModulePackagesAttribute, visitNestHostAttribute, visitNestMembersAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleAnnotationsAttribute, visitRuntimeInvisibleParameterAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeInvisibleTypeAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleAnnotationsAttribute, visitRuntimeVisibleParameterAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitRuntimeVisibleTypeAnnotationsAttribute, visitSignatureAttribute, visitSignatureAttribute, visitSignatureAttribute, visitSourceDirAttribute, visitSourceFileAttribute, visitStackMapAttribute, visitStackMapTableAttribute, visitSyntheticAttribute, visitSyntheticAttribute, visitSyntheticAttribute, visitUnknownAttribute

Constructor Detail

SimplifiedClassEditor

public SimplifiedClassEditor(int u2accessFlags,
                             String className)

Creates a new SimplifiedClassEditor for the Java class with the given name.

Parameters:

u2accessFlags - access flags for the new class.

className - the fully qualified name of the new class.

See Also:

ClassConstants

SimplifiedClassEditor

public SimplifiedClassEditor(int u2accessFlags,
                             String className,
                             String superclassName)

Creates a new SimplifiedClassEditor for the Java class with the given name and super class.

Parameters:

u2accessFlags - access flags for the new class.

className - the fully qualified name of the new class.

superclassName - the fully qualified name of the super class.

See Also:

ClassConstants

SimplifiedClassEditor

public SimplifiedClassEditor(ProgramClass programClass)

Creates a new SimplifiedClassEditor for the given class.

Parameters:

programClass - the class to be edited.

Method Detail

finishEditing

public void finishEditing()

Finalizes the editing of the class. This method does not initialize references to/from related classes. At least one of the finishEditing methods should be called before calling getProgramClass().

See Also:

finishEditing(ClassPool, ClassPool)

finishEditing

public void finishEditing(ClassPool programClassPool,
                          ClassPool libraryClassPool)

Finalizes the editing of the class, and initializes all references of the edited class w.r.t. the given program and library class pool. At least one of the finishEditing methods should be called before calling getProgramClass().

Parameters:

programClassPool - the program class pool

libraryClassPool - the library class pool

getProgramClass

public ProgramClass getProgramClass()

Returns the edited ProgramClass instance. Make sure to call one of the finishEditing methods after finishing editing, before calling this method.

Returns:

the edited ProgramClass instance.

See Also:

finishEditing(), finishEditing(ClassPool, ClassPool)

addClassConstant

public int addClassConstant(String name,
                            Clazz referencedClass)

Adds the given class constant to the edited class.

Parameters:

name - the class name to be added.

referencedClass - the corresponding referenced class.

Returns:

the constant pool index of the ClassConstant.

addField

public SimplifiedClassEditor addField(int u2accessFlags,
                                      String fieldName,
                                      String fieldDescriptor)

Adds a new field to the edited class.

Parameters:

u2accessFlags - acces flags for the new field.

fieldName - name of the new field.

fieldDescriptor - descriptor of the new field.

Returns:

this SimpleClassEditor.

addMethod

public CompactCodeAttributeComposer addMethod(int u2accessFlags,
                                              String methodName,
                                              String methodDescriptor,
                                              int maxCodeFragmentLength)

Adds a new method to the edited class. The returned composer can be used to attach code to the method.

Parameters:

u2accessFlags - acces flags for the new method.

methodName - name of the new method.

methodDescriptor - descriptor of the new method.

maxCodeFragmentLength - maximum length for the code fragment of the new method.

Returns:

the composer for adding code to the created method.

addMethod

public CompactCodeAttributeComposer addMethod(int u2accessFlags,
                                              String methodName,
                                              String methodDescriptor,
                                              Clazz[] referencedClasses,
                                              int maxCodeFragmentLength)

Adds a new method to the edited class. The returned composer can be used to attach code to the method.

Parameters:

u2accessFlags - acces flags for the new method.

methodName - name of the new method.

methodDescriptor - descriptor of the new method.

referencedClasses - the classes referenced by the method descriptor.

maxCodeFragmentLength - maximum length for the code fragment of the new method.

Returns:

the composer for adding code to the created method.

addMethod

public ProgramMethod addMethod(int u2accessFlags,
                               String methodName,
                               String methodDescriptor,
                               Instruction[] instructions)

Adds a new method to the edited class, with the given instructions array.

Parameters:

u2accessFlags - acces flags for the new method.

methodName - name of the new method.

methodDescriptor - descriptor of the new method.

instructions - the instructions of the new method.

addStaticInitializerInstructions

public void addStaticInitializerInstructions(Instruction[] instructions,
                                             boolean mergeIntoExistingInitializer)

Adds the given static initializer instructions to the edited class. If the class already contains a static initializer, the new instructions will be appended to the existing initializer.

Parameters:

instructions - the instructions to be added.

mergeIntoExistingInitializer - indicates whether the instructions should be added to the existing static initializer (if it exists), or if a new method should be created, which is then called from the existing initializer.

addInitializerInstructions

public void addInitializerInstructions(Instruction[] instructions)

Adds the given initialization instructions to the edited class. - If the class doesn't contain a constructor yet, it will be created, and the instructions will be added to this constructor. - If there is a single super-calling constructor, the instructions will be added at the beginning of it's code attribute. - If there are multiple super-calling constructors, a new private parameterless helper method will be created, to which the instructions will be added. An invocation to this new method will be added at the beginning of the code attribute of all super-calling constructors.

Parameters:

instructions - the instructions to be added.

visitAnyAttribute

public void visitAnyAttribute(Clazz clazz,
                              Attribute attribute)

Description copied from class: SimplifiedVisitor

Visit any type of attribute.

Overrides:

visitAnyAttribute in class SimplifiedVisitor

visitCodeAttribute

public void visitCodeAttribute(Clazz clazz,
                               Method method,
                               CodeAttribute codeAttribute)

Specified by:

visitCodeAttribute in interface AttributeVisitor

Overrides:

visitCodeAttribute in class SimplifiedVisitor