net.lenni0451.classtransform.utils

Class ASMUtils

java.lang.Object

net.lenni0451.classtransform.utils.ASMUtils

@ParametersAreNonnullByDefault
public class ASMUtils
extends java.lang.Object

General utils for using ASM.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	FIELD_DECLARATION_PATTERN
static java.lang.String	FIELD_DECLARATION_REGEX
static java.util.regex.Pattern	METHOD_DECLARATION_PATTERN
static java.lang.String	METHOD_DECLARATION_REGEX

Constructor Summary

Constructors

Constructor and Description
ASMUtils()

Method Summary

Modifier and Type	Method and Description
static void	addParameters(org.objectweb.asm.tree.MethodNode methodNode, org.objectweb.asm.Type... parameters) Add parameters to a method. The actual code is not changed, only the descriptor and annotations.
static org.objectweb.asm.tree.ClassNode	cloneClass(org.objectweb.asm.tree.ClassNode classNode) Clone a class node with all its methods and fields.
static org.objectweb.asm.tree.InsnList	cloneInsnList(org.objectweb.asm.tree.InsnList insnList) Clone an insn list with all its instructions.
static java.util.Map<org.objectweb.asm.tree.LabelNode,org.objectweb.asm.tree.LabelNode>	cloneLabels(org.objectweb.asm.tree.InsnList original) Clone all labels from an insn list.
static org.objectweb.asm.tree.MethodNode	cloneMethod(org.objectweb.asm.tree.MethodNode methodNode) Clone a method node with all its instructions.
static java.lang.String	combiToRegex(java.lang.String combi) Convert a field or method search pattern to a regex pattern. Use * for a wildcard search. e.g.
static boolean	compareType(org.objectweb.asm.Type type, org.objectweb.asm.Type targetType) Compare a single type with a target type This supports the usage of object instead of the actual type but does not check for other inheritance. Object can not be used as a replacement for primitives.
static boolean	compareTypes(org.objectweb.asm.Type[] types, org.objectweb.asm.Type[] targetTypes) Compare an array of types with a target array of types. This supports the usage of object instead of the actual type but does not check for other inheritance. Object can not be used as a replacement for primitives.
static boolean	compareTypes(org.objectweb.asm.Type[] types, org.objectweb.asm.Type[] targetTypes, boolean prepend, org.objectweb.asm.Type... additionalNeededTypes) Compare an array of types with a target array of types. This supports the usage of object instead of the actual type but does not check for other inheritance. Object can not be used as a replacement for primitives.
static org.objectweb.asm.tree.ClassNode	createEmptyClass(java.lang.String name) Create an empty class with a default constructor.
static void	cutParameters(org.objectweb.asm.tree.MethodNode methodNode, int count) Cut the given amount of parameters from the end of a method. The actual code is not changed, only the descriptor and annotations.
static java.lang.String	dot(java.lang.String s) Replace all slashes with dots in the given class/package name.
static org.objectweb.asm.tree.ClassNode	fromBytes(byte[] bytecode) Get a class node from the raw bytecode of a class.
static org.objectweb.asm.tree.ClassNode	fromBytes(byte[] bytecode, int flags) Get a class node from the raw bytecode of a class.
static org.objectweb.asm.tree.InsnList	getCast(org.objectweb.asm.Type wantedType) Get the byte code to cast an object to a given type. Converts primitive wrapper to their primitive types (e.g.
static org.objectweb.asm.tree.FieldNode	getField(org.objectweb.asm.tree.ClassNode classNode, java.lang.String name, java.lang.String desc) Get a field node from a class node using the name. The descriptor is passed as a parameter but is not used for the search.
static java.util.List<org.objectweb.asm.tree.FieldNode>	getFieldsFromCombi(org.objectweb.asm.tree.ClassNode classNode, java.lang.String combi) Get a list of method nodes from a class node using the combined name and descriptor. Use * for a wildcard search. e.g.
static org.objectweb.asm.tree.AbstractInsnNode	getFirstConstructorInstruction(java.lang.String superClass, org.objectweb.asm.tree.MethodNode methodNode) Get the first instruction of a constructor skipping the super init call.
static int	getFreeVarIndex(org.objectweb.asm.tree.MethodNode methodNode) Get the last empty local variable index. You can simply count the index up from there.
static int	getLoadOpcode(org.objectweb.asm.Type type) Get the needed load opcode for the given type.
static org.objectweb.asm.tree.MethodNode	getMethod(org.objectweb.asm.tree.ClassNode classNode, java.lang.String name, java.lang.String desc) Get a method node from a class node using the name and descriptor.
static java.util.List<org.objectweb.asm.tree.MethodNode>	getMethodsFromCombi(org.objectweb.asm.tree.ClassNode classNode, java.lang.String combi) Get a list of method nodes from a class node using the combined name and descriptor. Use * for a wildcard search. e.g.
static java.lang.Number	getNumber(org.objectweb.asm.tree.AbstractInsnNode instruction) Get a number from an insn node if it represents one. This also works for constants (e.g.
static int[]	getParameterIndices(org.objectweb.asm.tree.MethodNode methodNode) Get the variable indices for the parameters of a method.
static int[]	getParameterIndices(org.objectweb.asm.Type[] types, boolean isStatic) Get the variable indices for an array of types.
static org.objectweb.asm.tree.AbstractInsnNode	getPrimitiveToObject(org.objectweb.asm.Type primitive) Get the byte code to wrap a primitive to its wrapper type (e.g.
static int	getReturnOpcode(org.objectweb.asm.Type returnType) Get the needed return opcode for the given type.
static int	getStoreOpcode(org.objectweb.asm.Type type) Get the needed store opcode for the given type.
static boolean	hasField(org.objectweb.asm.tree.ClassNode classNode, java.lang.String name, java.lang.String desc) Check if a class node has a field with the given name and descriptor.
static boolean	hasMethod(org.objectweb.asm.tree.ClassNode classNode, java.lang.String name, java.lang.String desc) Check if a class node has a method with the given name and descriptor.
static org.objectweb.asm.tree.AbstractInsnNode	intPush(int i) Create a new insn node representing the given int. This uses the most efficient opcode for the given int.
static boolean	isAccessLower(int toCheck, int checkAgainst) Check if the given access is lower than another. private < package private < protected < public
static void	removeParameters(org.objectweb.asm.tree.MethodNode methodNode, int... indices) Remove the given parameter indices from a method. The actual code is not changed, only the descriptor and annotations.
static int	setAccess(int currentAccess, int newAccess) Set the wanted access to a given access mask. Other access flags will be removed.
static int	setModifier(int currentAccess, int modifier, boolean value) Set a modifier to a given access mask.
static java.lang.String	slash(java.lang.String s) Replace all dots with slashes in the given class/package name.
static MemberDeclaration	splitMemberDeclaration(java.lang.String memberDeclaration) Split a member declaration into owner, name and descriptor. All parts are required. Examples: - java/lang/String.length()I - java/lang/System.out:Ljava/io/PrintStream; - Ljava/lang/String;length()I - Ljava/lang/System;out:Ljava/io/PrintStream;
static org.objectweb.asm.tree.InsnList	swap(org.objectweb.asm.Type top, org.objectweb.asm.Type bottom) Get the bytecode to swap two stack elements. This also works for long and double types.
static byte[]	toBytes(org.objectweb.asm.tree.ClassNode node, ClassTree classTree, IClassProvider classProvider) Get the bytecode from a class node.
static byte[]	toBytes(org.objectweb.asm.tree.ClassNode node, ClassTree classTree, IClassProvider classProvider, int flags) Get the bytecode from a class node.
static byte[]	toBytes(org.objectweb.asm.tree.ClassNode node, TransformerManager transformerManager) Get the bytecode from a class node.
static byte[]	toBytes(org.objectweb.asm.tree.ClassNode node, TransformerManager transformerManager, int flags) Get the bytecode from a class node.
static byte[]	toStacklessBytes(org.objectweb.asm.tree.ClassNode node) Get the bytecode from a class node without calculating stack map frames.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_DECLARATION_REGEX

public static final java.lang.String METHOD_DECLARATION_REGEX

See Also:

Constant Field Values

FIELD_DECLARATION_REGEX

public static final java.lang.String FIELD_DECLARATION_REGEX

See Also:

Constant Field Values

METHOD_DECLARATION_PATTERN

public static final java.util.regex.Pattern METHOD_DECLARATION_PATTERN

FIELD_DECLARATION_PATTERN

public static final java.util.regex.Pattern FIELD_DECLARATION_PATTERN

Constructor Detail

ASMUtils

public ASMUtils()

Method Detail

fromBytes

public static org.objectweb.asm.tree.ClassNode fromBytes(byte[] bytecode)

Get a class node from the raw bytecode of a class.

Parameters:

bytecode - The bytecode of the class

Returns:

The parsed class node

fromBytes

public static org.objectweb.asm.tree.ClassNode fromBytes(byte[] bytecode,
                                                         int flags)

Get a class node from the raw bytecode of a class.

Parameters:

bytecode - The bytecode of the class

flags - The flags to use for the class reader

Returns:

The parsed class node

toBytes

public static byte[] toBytes(org.objectweb.asm.tree.ClassNode node,
                             TransformerManager transformerManager)

Get the bytecode from a class node.

Parameters:

node - The class node

transformerManager - The transformer manager

Returns:

The bytecode of the class

toBytes

public static byte[] toBytes(org.objectweb.asm.tree.ClassNode node,
                             ClassTree classTree,
                             IClassProvider classProvider)

Get the bytecode from a class node.

Parameters:

node - The class node

classTree - The class tree used to get the super classes

classProvider - The class provider used for stack frame calculation

Returns:

The bytecode of the class

toBytes

public static byte[] toBytes(org.objectweb.asm.tree.ClassNode node,
                             TransformerManager transformerManager,
                             int flags)

Get the bytecode from a class node.

Parameters:

node - The class node

transformerManager - The transformer manager

flags - The flags to use for the class writer

Returns:

The bytecode of the class

toBytes

public static byte[] toBytes(org.objectweb.asm.tree.ClassNode node,
                             ClassTree classTree,
                             IClassProvider classProvider,
                             int flags)

Get the bytecode from a class node.

Parameters:

node - The class node

classTree - The class tree used to get the super classes

classProvider - The class provider used for stack frame calculation

flags - The flags to use for the class writer

Returns:

The bytecode of the class

toStacklessBytes

public static byte[] toStacklessBytes(org.objectweb.asm.tree.ClassNode node)

Get the bytecode from a class node without calculating stack map frames.

Parameters:

node - The class node

Returns:

The bytecode of the class

getMethod

@Nullable
public static org.objectweb.asm.tree.MethodNode getMethod(org.objectweb.asm.tree.ClassNode classNode,
                                                                    java.lang.String name,
                                                                    java.lang.String desc)

Get a method node from a class node using the name and descriptor.

Parameters:

classNode - The class node to search in

name - The name of the method

desc - The descriptor of the method

Returns:

The method node or null if no method was found

hasMethod

public static boolean hasMethod(org.objectweb.asm.tree.ClassNode classNode,
                                java.lang.String name,
                                java.lang.String desc)

Check if a class node has a method with the given name and descriptor.

Parameters:

classNode - The class node to search in

name - The name of the method

desc - The descriptor of the method

Returns:

If the class node has a method with the given name and descriptor

getField

@Nullable
public static org.objectweb.asm.tree.FieldNode getField(org.objectweb.asm.tree.ClassNode classNode,
                                                                  java.lang.String name,
                                                                  java.lang.String desc)

Get a field node from a class node using the name.
The descriptor is passed as a parameter but is not used for the search.

Parameters:

classNode - The class node to search in

name - The name of the field

desc - The descriptor of the field

Returns:

The field node or null if no field was found

hasField

public static boolean hasField(org.objectweb.asm.tree.ClassNode classNode,
                               java.lang.String name,
                               java.lang.String desc)

Check if a class node has a field with the given name and descriptor.

Parameters:

classNode - The class node to search in

name - The name of the field

desc - The descriptor of the field

Returns:

If the class node has a field with the given name and descriptor

getMethodsFromCombi

public static java.util.List<org.objectweb.asm.tree.MethodNode> getMethodsFromCombi(org.objectweb.asm.tree.ClassNode classNode,
                                                                                    java.lang.String combi)

Get a list of method nodes from a class node using the combined name and descriptor.
Use * for a wildcard search.
e.g. print(Ljava/lang/String;)V

Parameters:

classNode - The class node to search in

combi - The combined name and descriptor

Returns:

The list of method nodes

Throws:

java.lang.IllegalArgumentException - If the combined name and descriptor is empty

getFieldsFromCombi

public static java.util.List<org.objectweb.asm.tree.FieldNode> getFieldsFromCombi(org.objectweb.asm.tree.ClassNode classNode,
                                                                                  java.lang.String combi)

Get a list of method nodes from a class node using the combined name and descriptor.
Use * for a wildcard search.
e.g. print(Ljava/lang/String;)V

Parameters:

classNode - The class node to search in

combi - The combined name and descriptor

Returns:

The list of method nodes

combiToRegex

public static java.lang.String combiToRegex(java.lang.String combi)

Convert a field or method search pattern to a regex pattern.
Use * for a wildcard search.
e.g. get* -> ^\Qget\E.*$

Parameters:

combi - The search pattern

Returns:

The converted regex pattern

isAccessLower

public static boolean isAccessLower(int toCheck,
                                    int checkAgainst)

Check if the given access is lower than another.
private < package private < protected < public

Parameters:

toCheck - The access to check

checkAgainst - The access to check against

Returns:

If the access is lower than the other

setAccess

public static int setAccess(int currentAccess,
                            int newAccess)

Set the wanted access to a given access mask.
Other access flags will be removed.

Parameters:

currentAccess - The current access mask

newAccess - The wanted access

Returns:

The new access mask

setModifier

public static int setModifier(int currentAccess,
                              int modifier,
                              boolean value)

Set a modifier to a given access mask.

Parameters:

currentAccess - The current access mask

modifier - The modifier to set

value - The value to set the modifier to

Returns:

The new access mask

getReturnOpcode

public static int getReturnOpcode(org.objectweb.asm.Type returnType)

Get the needed return opcode for the given type.

Parameters:

returnType - The return type of a method

Returns:

The needed return opcode

getLoadOpcode

public static int getLoadOpcode(org.objectweb.asm.Type type)

Get the needed load opcode for the given type.

Parameters:

type - The type to get the load opcode for

Returns:

The needed load opcode

getStoreOpcode

public static int getStoreOpcode(org.objectweb.asm.Type type)

Get the needed store opcode for the given type.

Parameters:

type - The type to get the store opcode for

Returns:

The needed store opcode

getFreeVarIndex

public static int getFreeVarIndex(org.objectweb.asm.tree.MethodNode methodNode)

Get the last empty local variable index.
You can simply count the index up from there.

Parameters:

methodNode - The method to get the last empty local variable index for

Returns:

The last empty local variable index

getCast

public static org.objectweb.asm.tree.InsnList getCast(org.objectweb.asm.Type wantedType)

Get the byte code to cast an object to a given type.
Converts primitive wrapper to their primitive types (e.g. Integer to int).

Parameters:

wantedType - The wanted type

Returns:

The byte code for the cast

getPrimitiveToObject

@Nullable
public static org.objectweb.asm.tree.AbstractInsnNode getPrimitiveToObject(org.objectweb.asm.Type primitive)

Get the byte code to wrap a primitive to its wrapper type (e.g. int to Integer).

Parameters:

primitive - The primitive type to wrap

Returns:

The byte code for the wrapper or null if the given type is not a primitive

splitMemberDeclaration

@Nullable
public static MemberDeclaration splitMemberDeclaration(java.lang.String memberDeclaration)

Split a member declaration into owner, name and descriptor.
All parts are required.
Examples:
- java/lang/String.length()I
- java/lang/System.out:Ljava/io/PrintStream;
- Ljava/lang/String;length()I
- Ljava/lang/System;out:Ljava/io/PrintStream;

Parameters:

memberDeclaration - The member declaration

Returns:

The split member declaration

getFirstConstructorInstruction

@Nullable
public static org.objectweb.asm.tree.AbstractInsnNode getFirstConstructorInstruction(java.lang.String superClass,
                                                                                               org.objectweb.asm.tree.MethodNode methodNode)

Get the first instruction of a constructor skipping the super init call.

Parameters:

superClass - The name of the super class

methodNode - The constructor method node

Returns:

The first actual instruction of the constructor

getNumber

@Nullable
public static java.lang.Number getNumber(@Nullable
                                                   org.objectweb.asm.tree.AbstractInsnNode instruction)

Get a number from an insn node if it represents one.
This also works for constants (e.g. Opcodes.ICONST_0)

Parameters:

instruction - The insn node

Returns:

The number or null if it's not a number

compareTypes

public static boolean compareTypes(org.objectweb.asm.Type[] types,
                                   org.objectweb.asm.Type[] targetTypes)

Compare an array of types with a target array of types.
This supports the usage of object instead of the actual type but does not check for other inheritance.
Object can not be used as a replacement for primitives.

Parameters:

types - The source array of types

targetTypes - The target array of types

Returns:

If the arrays match

compareTypes

public static boolean compareTypes(org.objectweb.asm.Type[] types,
                                   org.objectweb.asm.Type[] targetTypes,
                                   boolean prepend,
                                   org.objectweb.asm.Type... additionalNeededTypes)

Compare an array of types with a target array of types.
This supports the usage of object instead of the actual type but does not check for other inheritance.
Object can not be used as a replacement for primitives.

Parameters:

types - The source array of types

targetTypes - The target array of types

prepend - If the additional types array should be prepended or appended

additionalNeededTypes - The additional types to append/prepend to the source

Returns:

If the arrays match

compareType

public static boolean compareType(org.objectweb.asm.Type type,
                                  org.objectweb.asm.Type targetType)

Compare a single type with a target type
This supports the usage of object instead of the actual type but does not check for other inheritance.
Object can not be used as a replacement for primitives.

Parameters:

type - The source type

targetType - The target type

Returns:

If the types match

cloneClass

public static org.objectweb.asm.tree.ClassNode cloneClass(org.objectweb.asm.tree.ClassNode classNode)

Clone a class node with all its methods and fields.

Parameters:

classNode - The class node to clone

Returns:

The cloned class node

cloneMethod

public static org.objectweb.asm.tree.MethodNode cloneMethod(org.objectweb.asm.tree.MethodNode methodNode)

Clone a method node with all its instructions.

Parameters:

methodNode - The method node to clone

Returns:

The cloned method node

cloneInsnList

public static org.objectweb.asm.tree.InsnList cloneInsnList(org.objectweb.asm.tree.InsnList insnList)

Clone an insn list with all its instructions.

Parameters:

insnList - The insn list to clone

Returns:

The cloned insn list

cloneLabels

public static java.util.Map<org.objectweb.asm.tree.LabelNode,org.objectweb.asm.tree.LabelNode> cloneLabels(org.objectweb.asm.tree.InsnList original)

Clone all labels from an insn list.

Parameters:

original - The insn list to clone the labels from

Returns:

The original -> cloned label map

createEmptyClass

public static org.objectweb.asm.tree.ClassNode createEmptyClass(java.lang.String name)

Create an empty class with a default constructor.

Parameters:

name - The name of the class

Returns:

The generated class node

intPush

public static org.objectweb.asm.tree.AbstractInsnNode intPush(int i)

Create a new insn node representing the given int.
This uses the most efficient opcode for the given int.

Parameters:

i - The int

Returns:

The insn node

getParameterIndices

public static int[] getParameterIndices(org.objectweb.asm.tree.MethodNode methodNode)

Get the variable indices for the parameters of a method.

Parameters:

methodNode - The method node

Returns:

The variable indices

getParameterIndices

public static int[] getParameterIndices(org.objectweb.asm.Type[] types,
                                        boolean isStatic)

Get the variable indices for an array of types.

Parameters:

types - The types

isStatic - If the first index should be 0 or 1

Returns:

The variable indices

cutParameters

public static void cutParameters(org.objectweb.asm.tree.MethodNode methodNode,
                                 int count)

Cut the given amount of parameters from the end of a method.
The actual code is not changed, only the descriptor and annotations.

Parameters:

methodNode - The method node

count - The amount of parameters to cut

removeParameters

public static void removeParameters(org.objectweb.asm.tree.MethodNode methodNode,
                                    int... indices)

Remove the given parameter indices from a method.
The actual code is not changed, only the descriptor and annotations.

Parameters:

methodNode - The method node

indices - The indices to remove

addParameters

public static void addParameters(org.objectweb.asm.tree.MethodNode methodNode,
                                 org.objectweb.asm.Type... parameters)

Add parameters to a method.
The actual code is not changed, only the descriptor and annotations.

Parameters:

methodNode - The method node

parameters - The parameters to add

swap

public static org.objectweb.asm.tree.InsnList swap(org.objectweb.asm.Type top,
                                                   org.objectweb.asm.Type bottom)

Get the bytecode to swap two stack elements.
This also works for long and double types.

Parameters:

top - The type of the top stack element

bottom - The type of the bottom stack element

Returns:

The bytecode to swap the stack elements

dot

public static java.lang.String dot(java.lang.String s)

Replace all slashes with dots in the given class/package name.

Parameters:

s - The class/package name

Returns:

The class/package name with dots

slash

public static java.lang.String slash(java.lang.String s)

Replace all dots with slashes in the given class/package name.

Parameters:

s - The class/package name

Returns:

The class/package name with slashes