Package io.quarkus.gizmo

Class BytecodeCreatorImpl

java.lang.Object

io.quarkus.gizmo.BytecodeCreatorImpl

All Implemented Interfaces:

BytecodeCreator, AutoCloseable

Direct Known Subclasses:

AbstractSwitch, CatchBlockCreatorImpl, FunctionCreatorImpl.FunctionBytecodeCreator, IfThenElseImpl, LoopImpl, MethodCreatorImpl, TryBlockImpl

class BytecodeCreatorImpl
extends Object
implements BytecodeCreator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	BytecodeCreatorImpl.AssignOperation
(package private) static class	BytecodeCreatorImpl.BlockOperation
(package private) class	BytecodeCreatorImpl.IfOperation
(package private) class	BytecodeCreatorImpl.InvokeOperation
(package private) static class	BytecodeCreatorImpl.JumpOperation
(package private) class	BytecodeCreatorImpl.NewInstanceOperation
(package private) static class	BytecodeCreatorImpl.Operation

Field Summary

Fields

Modifier and Type	Field	Description
private final org.objectweb.asm.Label	bottom
private static final Map<String,String>	boxingMap
private static final Map<String,String>	boxingMethodMap
private ResultHandle	cachedTccl
private static final MethodDescriptor	CL_FOR_NAME
private static final boolean	DEBUG_SCOPES
private static final String	FUNCTION
private static final Map<String,AtomicInteger>	functionCountersByClass
(package private) static final int	MAX_STRING_LENGTH
private final MethodCreatorImpl	method
protected final List<BytecodeCreatorImpl.Operation>	operations
private final BytecodeCreatorImpl	owner
private static final Set<String>	SAFE_CLASSES_TO_LOAD_AS_CONSTANTS
private final StackTraceElement[]	stack
private static final MethodDescriptor	THREAD_CURRENT_THREAD
private static final MethodDescriptor	THREAD_GET_TCCL
private final org.objectweb.asm.Label	top

Constructor Summary

Constructors

Constructor	Description
BytecodeCreatorImpl(BytecodeCreatorImpl enclosing)
BytecodeCreatorImpl(BytecodeCreatorImpl enclosing, boolean useThisMethod)
BytecodeCreatorImpl(BytecodeCreatorImpl enclosing, MethodCreatorImpl methodCreator)

Method Summary

Modifier and Type	Method	Description
ResultHandle	add(ResultHandle a1, ResultHandle a2)	Adds the two result handles together and returns the result
protected int	allocateLocalVariables(int localVarCount)
private ResultHandle	allocateResult(String returnType)
ResultHandle	arrayLength(ResultHandle array)
void	assign(AssignableResultHandle target, ResultHandle value)	Assign the given value to the given assignable target.
ResultHandle	bitwiseAnd(ResultHandle a1, ResultHandle a2)	Computes the bitwise AND of the two result handles and returns the result
ResultHandle	bitwiseOr(ResultHandle a1, ResultHandle a2)	Computes the bitwise OR of the two result handles and returns the result
ResultHandle	bitwiseXor(ResultHandle a1, ResultHandle a2)	Computes the bitwise XOR of the two result handles and returns the result
void	breakScope(BytecodeCreator scope)	Go to the end of the given scope.
ResultHandle	checkCast(ResultHandle resultHandle, String castTarget)	Perform a check cast operation which transforms the type of the given result handle.
(package private) ResultHandle[]	checkScope(ResultHandle[] handles)
(package private) <R extends ResultHandle> R	checkScope(R handle)
ResultHandle	compareDouble(ResultHandle value1, ResultHandle value2, boolean nanComparesAsGreater)	Compares two double values and pushes the resulting integer to the stack.
ResultHandle	compareFloat(ResultHandle value1, ResultHandle value2, boolean nanComparesAsGreater)	Compares two float values and pushes the resulting integer to the stack.
ResultHandle	compareLong(ResultHandle value1, ResultHandle value2)	Compares two long values and pushes the resulting integer to the stack.
void	continueScope(BytecodeCreator scope)	Go to the top of the given scope.
ResultHandle	convertPrimitive(ResultHandle value, Class<?> conversionTarget)	Converts given value, which must be of a primitive type, to the given conversionTarget, which must be a primitive type, using primitive conversions defined by the Java language specification.
FunctionCreator	createFunction(Class<?> functionalInterface)	Creates an instance of a functional interface
(package private) BytecodeCreatorImpl.Operation	createNewInstanceOp(ResultHandle handle, MethodDescriptor descriptor, ResultHandle[] args)
BytecodeCreator	createScope()	Create a nested scope.
AssignableResultHandle	createVariable(String typeDescr)	Create a local variable which can be assigned within this scope.
ResultHandle	divide(ResultHandle a1, ResultHandle a2)	Divides the first result handle by the second and returns the result
private int	doubleArithmeticOpcode(int intOpcode)
private void	dumpScope(StringBuilder builder)
private ResultHandle	emitBinaryArithmetic(int intOpcode, ResultHandle a1, ResultHandle a2)
private ResultHandle	emitCompare(int opcode, String expectedType, ResultHandle value1, ResultHandle value2)
private static void	emitLoadConstant(org.objectweb.asm.MethodVisitor methodVisitor, Object constant)
<E extends Enum<E>> Switch.EnumSwitch<E>	enumSwitch(ResultHandle value, Class<E> enumClass)	Create a new switch construct for an enum constant.
(package private) void	findActiveResultHandles(Set<ResultHandle> handlesToAllocate)
private int	floatArithmeticOpcode(int intOpcode)
ForEachLoop	forEach(ResultHandle iterable)	Create a new for-each loop construct.
(package private) org.objectweb.asm.Label	getBottom()
(package private) MethodCreatorImpl	getMethod()
ResultHandle	getMethodParam(int methodNo)
(package private) BytecodeCreatorImpl	getOwner()
ResultHandle	getThis()
(package private) org.objectweb.asm.Label	getTop()
BranchResult	ifFalse(ResultHandle resultHandle)	An if statement.
BranchResult	ifGreaterEqualZero(ResultHandle resultHandle)	An if statement.
BranchResult	ifGreaterThanZero(ResultHandle resultHandle)	An if statement.
BranchResult	ifIntegerEqual(ResultHandle value1, ResultHandle value2)	An if statement.
BranchResult	ifIntegerGreaterEqual(ResultHandle value1, ResultHandle value2)	An if statement.
BranchResult	ifIntegerGreaterThan(ResultHandle value1, ResultHandle value2)	An if statement.
BranchResult	ifIntegerLessEqual(ResultHandle value1, ResultHandle value2)	An if statement.
BranchResult	ifIntegerLessThan(ResultHandle value1, ResultHandle value2)	An if statement.
BranchResult	ifLessEqualZero(ResultHandle resultHandle)	An if statement.
BranchResult	ifLessThanZero(ResultHandle resultHandle)	An if statement.
BranchResult	ifNonZero(ResultHandle resultHandle)	An if statement.
BranchResult	ifNotNull(ResultHandle resultHandle)	An if statement.
BranchResult	ifNull(ResultHandle resultHandle)	An if statement.
BranchResult	ifReferencesEqual(ResultHandle ref1, ResultHandle ref2)	An if statement.
BranchResult	ifReferencesNotEqual(ResultHandle ref1, ResultHandle ref2)	An if statement.
IfThenElse	ifThenElse(ResultHandle value)	Create a new if-then-else construct.
BranchResult	ifTrue(ResultHandle resultHandle)	An if statement.
private BranchResult	ifValue(ResultHandle resultHandle, int opcode, String opType)
private BranchResult	ifValues(ResultHandle resultHandle1, ResultHandle resultHandle2, int opcode, String opType)
BranchResult	ifZero(ResultHandle resultHandle)	An if statement.
ResultHandle	instanceOf(ResultHandle resultHandle, String castTarget)	Checks if the given resultHandle is an instance of the target type
ResultHandle	invokeInterfaceMethod(MethodDescriptor descriptor, ResultHandle object, ResultHandle... args)	Invokes a interface method, and returns a ResultHandle with the result, or null if the method is void.
ResultHandle	invokeSpecialInterfaceMethod(MethodDescriptor descriptor, ResultHandle object, ResultHandle... args)	Invokes a special interface method, and returns a ResultHandle with the result, or null if the method is void.
ResultHandle	invokeSpecialMethod(MethodDescriptor descriptor, ResultHandle object, ResultHandle... args)	Invokes a special method, and returns a ResultHandle with the result, or null if the method is void.
ResultHandle	invokeStaticInterfaceMethod(MethodDescriptor descriptor, ResultHandle... args)	Invokes a static method of an interface, and returns a ResultHandle with the result, or null if the method is void.
ResultHandle	invokeStaticMethod(MethodDescriptor descriptor, ResultHandle... args)	Invokes a static method, and returns a ResultHandle with the result, or null if the method is void.
ResultHandle	invokeVirtualMethod(MethodDescriptor descriptor, ResultHandle object, ResultHandle... args)	Invokes a virtual method, and returns a ResultHandle with the result, or null if the method is void.
private boolean	isNonPrimitiveSafeJavaClass(String className)	Returns true if the is a non-primitive Java type that is guaranteed to be absolutely safe to load from a constant.
boolean	isScopedWithin(BytecodeCreator other)	Determine if this bytecode creator is scoped within the given bytecode creator.
(package private) void	jumpTo(BytecodeCreator scope)	Go the the top of the given scope.
ResultHandle	load(boolean val)	Returns a ResultHandle representing the specified value
ResultHandle	load(byte val)	Returns a ResultHandle representing the specified value
ResultHandle	load(char val)	Returns a ResultHandle representing the specified value
ResultHandle	load(double val)	Returns a ResultHandle representing the specified value
ResultHandle	load(float val)	Returns a ResultHandle representing the specified value
ResultHandle	load(int val)	Returns a ResultHandle representing the specified value
ResultHandle	load(long val)	Returns a ResultHandle representing the specified value
ResultHandle	load(short val)	Returns a ResultHandle representing the specified value
ResultHandle	load(String val)	Implementation detail: when the string to be loaded is larger than MAX_STRING_LENGTH, then a StringBuilder is used to construct the final String.
ResultHandle	loadClass(String className)	Returns a ResultHandle representing the specified class Note that in almost all circumstances you are better off using BytecodeCreator.loadClassFromTCCL(String), as it can load classes that are not visible from the current class.
private ResultHandle	loadClass(String className, boolean useTccl)
private ResultHandle	loadClassConstant(String className)
ResultHandle	loadClassFromTCCL(String className)	Returns a ResultHandle representing the specified class This method can load all classes, including package private classes that are not visible to the current bytecode.
ResultHandle	loadNull()	Returns a ResultHandle representing null}
(package private) void	loadResultHandle(org.objectweb.asm.MethodVisitor methodVisitor, ResultHandle handle, BytecodeCreatorImpl bc, String expectedType)
(package private) void	loadResultHandle(org.objectweb.asm.MethodVisitor methodVisitor, ResultHandle handle, BytecodeCreatorImpl bc, String expectedType, boolean dontCast)
private int	longArithmeticOpcode(int intOpcode)
private Class<?>	matchPossiblyPrimitive(String className)
ResultHandle	multiply(ResultHandle a1, ResultHandle a2)	Multiplies the two result handles together and returns the result
ResultHandle	newArray(String type, ResultHandle length)
ResultHandle	newInstance(MethodDescriptor descriptor, ResultHandle... args)	Creates a new instance of a given type, by calling the specified constructor, and returns a ResultHandle representing the result
ResultHandle	readArrayValue(ResultHandle array, ResultHandle index)
ResultHandle	readInstanceField(FieldDescriptor fieldDescriptor, ResultHandle instance)	Reads an instance field and returns a ResultHandle representing the result.
ResultHandle	readStaticField(FieldDescriptor fieldDescriptor)	Reads a static field and returns a ResultHandle representing the result.
ResultHandle	remainder(ResultHandle a1, ResultHandle a2)	Computes the remainder after division of the first result handle by the second and returns the result
private ResultHandle[]	requireNonNullHandles(ResultHandle[] handles)
(package private) ResultHandle[]	resolve(BytecodeCreator creator, ResultHandle... handles)
(package private) final ResultHandle	resolve(ResultHandle handle)
(package private) final ResultHandle[]	resolve(ResultHandle... handles)
(package private) ResultHandle	resolve(ResultHandle handle, BytecodeCreator creator)
void	returnValue(ResultHandle returnValue)	Represents a return statement.
(package private) static void	storeResultHandle(org.objectweb.asm.MethodVisitor methodVisitor, ResultHandle handle)
Switch.StringSwitch	stringSwitch(ResultHandle value)	Create a new switch construct for a string value.
ResultHandle	subtract(ResultHandle a1, ResultHandle a2)	Subtracts the second result handle from the first result and returns the result
void	throwException(ResultHandle exception)	Throws an exception
TryBlock	tryBlock()	Add a try block.
WhileLoop	whileLoop(Function<BytecodeCreator,BranchResult> conditionFun)	Create a new while loop statement.
void	writeArrayValue(ResultHandle array, ResultHandle index, ResultHandle value)
void	writeInstanceField(FieldDescriptor fieldDescriptor, ResultHandle instance, ResultHandle value)	Writes the specified value to an instance field
protected void	writeInteriorOperations(org.objectweb.asm.MethodVisitor visitor)
protected void	writeOperations(org.objectweb.asm.MethodVisitor visitor)
void	writeStaticField(FieldDescriptor fieldDescriptor, ResultHandle value)	Writes the specified value to an static field

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.gizmo.BytecodeCreator

breakScope, checkCast, close, continueScope, createVariable, increment, instanceOf, invokeInterfaceMethod, invokeSpecialInterfaceMethod, invokeSpecialMethod, invokeStaticInterfaceMethod, invokeStaticMethod, invokeVirtualMethod, load, loadClass, loadClass, loadClassFromTCCL, loadClassFromTCCL, marshalAsArray, newArray, newArray, newArray, newInstance, readArrayValue, readInstanceField, readStaticField, returnBoolean, returnInt, returnNull, returnVoid, throwException, throwException, writeArrayValue, writeInstanceField, writeStaticField

Field Details

THREAD_CURRENT_THREAD

private static final MethodDescriptor THREAD_CURRENT_THREAD

THREAD_GET_TCCL

private static final MethodDescriptor THREAD_GET_TCCL

CL_FOR_NAME

private static final MethodDescriptor CL_FOR_NAME

DEBUG_SCOPES

private static final boolean DEBUG_SCOPES

functionCountersByClass

private static final Map<String,AtomicInteger> functionCountersByClass

FUNCTION

private static final String FUNCTION

See Also:

• Constant Field Values

SAFE_CLASSES_TO_LOAD_AS_CONSTANTS

private static final Set<String> SAFE_CLASSES_TO_LOAD_AS_CONSTANTS

MAX_STRING_LENGTH

static final int MAX_STRING_LENGTH

See Also:

• Constant Field Values

operations

protected final List<BytecodeCreatorImpl.Operation> operations

method

private final MethodCreatorImpl method

owner

private final BytecodeCreatorImpl owner

top

private final org.objectweb.asm.Label top

bottom

private final org.objectweb.asm.Label bottom

stack

private final StackTraceElement[] stack

boxingMap

private static final Map<String,String> boxingMap

boxingMethodMap

private static final Map<String,String> boxingMethodMap

cachedTccl

private ResultHandle cachedTccl

Constructor Details

BytecodeCreatorImpl

BytecodeCreatorImpl(BytecodeCreatorImpl enclosing,
 MethodCreatorImpl methodCreator)

BytecodeCreatorImpl

BytecodeCreatorImpl(BytecodeCreatorImpl enclosing,
 boolean useThisMethod)

BytecodeCreatorImpl

BytecodeCreatorImpl(BytecodeCreatorImpl enclosing)

Method Details

getTop

org.objectweb.asm.Label getTop()

getBottom

org.objectweb.asm.Label getBottom()

getThis

public ResultHandle getThis()

Specified by:

getThis in interface BytecodeCreator

Returns:

A ResultHandle that represents the current object

invokeVirtualMethod

public ResultHandle invokeVirtualMethod(MethodDescriptor descriptor,
 ResultHandle object,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a virtual method, and returns a ResultHandle with the result, or null if the method is void.

Specified by:

invokeVirtualMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

object - A ResultHandle representing the object to invoke on

args - The method parameters

Returns:

The method result, or null if a void method

invokeInterfaceMethod

public ResultHandle invokeInterfaceMethod(MethodDescriptor descriptor,
 ResultHandle object,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a interface method, and returns a ResultHandle with the result, or null if the method is void.

Specified by:

invokeInterfaceMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

object - A ResultHandle representing the object to invoke on

args - The method parameters

Returns:

The method result, or null if a void method

invokeStaticMethod

public ResultHandle invokeStaticMethod(MethodDescriptor descriptor,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a static method, and returns a ResultHandle with the result, or null if the method is void.

Specified by:

invokeStaticMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

args - The method parameters

Returns:

The method result, or null if a void method

invokeStaticInterfaceMethod

public ResultHandle invokeStaticInterfaceMethod(MethodDescriptor descriptor,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a static method of an interface, and returns a ResultHandle with the result, or null if the method is void.

Specified by:

invokeStaticInterfaceMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

args - The method parameters

Returns:

The method result, or null if a void method

invokeSpecialMethod

public ResultHandle invokeSpecialMethod(MethodDescriptor descriptor,
 ResultHandle object,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a special method, and returns a ResultHandle with the result, or null if the method is void.

Special methods are constructor invocations, or invocations on a superclass method of the current class.

Specified by:

invokeSpecialMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

object - A ResultHandle representing the object to invoke on

args - The method parameters

Returns:

The method result, or null if a void method

invokeSpecialInterfaceMethod

public ResultHandle invokeSpecialInterfaceMethod(MethodDescriptor descriptor,
 ResultHandle object,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Invokes a special interface method, and returns a ResultHandle with the result, or null if the method is void.

Special interface method invocations are invocations of a superinterface method of the current class.

Specified by:

invokeSpecialInterfaceMethod in interface BytecodeCreator

Parameters:

descriptor - The method descriptor

object - A ResultHandle representing the object to invoke on

args - The method parameters

Returns:

The method result, or null if a void method

newInstance

public ResultHandle newInstance(MethodDescriptor descriptor,
 ResultHandle... args)

Description copied from interface: BytecodeCreator

Creates a new instance of a given type, by calling the specified constructor, and returns a ResultHandle representing the result

Specified by:

newInstance in interface BytecodeCreator

Parameters:

descriptor - The constructor descriptor

args - The constructor parameters

Returns:

The new instance

newArray

public ResultHandle newArray(String type,
 ResultHandle length)

Specified by:

newArray in interface BytecodeCreator

load

public ResultHandle load(String val)

Implementation detail: when the string to be loaded is larger than MAX_STRING_LENGTH, then a StringBuilder is used to construct the final String. This is done because strings constants cannot be larger than MAX_STRING_LENGTH.

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(byte val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(short val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(char val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(int val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(long val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(float val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(double val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

load

public ResultHandle load(boolean val)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified value

Specified by:

load in interface BytecodeCreator

Parameters:

val - The value

Returns:

A ResultHandle representing the specified value

loadClass

public ResultHandle loadClass(String className)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified class Note that in almost all circumstances you are better off using BytecodeCreator.loadClassFromTCCL(String), as it can load classes that are not visible from the current class. This method should only be used if you are sure that the class being loaded will be accessible from the generated bytecode.

Specified by:

loadClass in interface BytecodeCreator

Parameters:

className - The class name

Returns:

A ResultHandle representing the specified class

loadClassFromTCCL

public ResultHandle loadClassFromTCCL(String className)

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing the specified class This method can load all classes, including package private classes that are not visible to the current bytecode.

Specified by:

loadClassFromTCCL in interface BytecodeCreator

Parameters:

className - The class name

Returns:

A ResultHandle representing the specified class

loadClass

private ResultHandle loadClass(String className,
 boolean useTccl)

loadClassConstant

private ResultHandle loadClassConstant(String className)

matchPossiblyPrimitive

private Class<?> matchPossiblyPrimitive(String className)

isNonPrimitiveSafeJavaClass

private boolean isNonPrimitiveSafeJavaClass(String className)

Returns true if the is a non-primitive Java type that is guaranteed to be absolutely safe to load from a constant.

Note that it's not safe to load all JDK classes using this, see this for an example.

loadNull

public ResultHandle loadNull()

Description copied from interface: BytecodeCreator

Returns a ResultHandle representing null}

Specified by:

loadNull in interface BytecodeCreator

Returns:

A ResultHandle representing null}

writeInstanceField

public void writeInstanceField(FieldDescriptor fieldDescriptor,
 ResultHandle instance,
 ResultHandle value)

Description copied from interface: BytecodeCreator

Writes the specified value to an instance field

Specified by:

writeInstanceField in interface BytecodeCreator

Parameters:

fieldDescriptor - The field to write to

instance - A ResultHandle representing the instance that contains the field

value - A ResultHandle representing the value

readInstanceField

public ResultHandle readInstanceField(FieldDescriptor fieldDescriptor,
 ResultHandle instance)

Description copied from interface: BytecodeCreator

Reads an instance field and returns a ResultHandle representing the result. The result of the read is stored in a local variable, so even if the field value changes the ResultHandle will represent the same result.

Specified by:

readInstanceField in interface BytecodeCreator

Parameters:

fieldDescriptor - The field to read from

instance - A ResultHandle representing the instance that contains the field

Returns:

A ResultHandle representing the field value at the current point in time

writeStaticField

public void writeStaticField(FieldDescriptor fieldDescriptor,
 ResultHandle value)

Description copied from interface: BytecodeCreator

Writes the specified value to an static field

Specified by:

writeStaticField in interface BytecodeCreator

Parameters:

fieldDescriptor - The field to write to

value - A ResultHandle representing the value

readStaticField

public ResultHandle readStaticField(FieldDescriptor fieldDescriptor)

Description copied from interface: BytecodeCreator

Reads a static field and returns a ResultHandle representing the result. The result of the read is stored in a local variable, so even if the field value changes the ResultHandle will represent the same result.

Specified by:

readStaticField in interface BytecodeCreator

Parameters:

fieldDescriptor - The field to read from

Returns:

A ResultHandle representing the field value at the current point in time

arrayLength

public ResultHandle arrayLength(ResultHandle array)

Specified by:

arrayLength in interface BytecodeCreator

readArrayValue

public ResultHandle readArrayValue(ResultHandle array,
 ResultHandle index)

Specified by:

readArrayValue in interface BytecodeCreator

writeArrayValue

public void writeArrayValue(ResultHandle array,
 ResultHandle index,
 ResultHandle value)

Specified by:

writeArrayValue in interface BytecodeCreator

createVariable

public AssignableResultHandle createVariable(String typeDescr)

Description copied from interface: BytecodeCreator

Create a local variable which can be assigned within this scope.

Specified by:

createVariable in interface BytecodeCreator

Parameters:

typeDescr - the type descriptor of the variable's type (must not be null)

Returns:

the assignable local variable (not null)

assign

public void assign(AssignableResultHandle target,
 ResultHandle value)

Description copied from interface: BytecodeCreator

Assign the given value to the given assignable target.

Specified by:

assign in interface BytecodeCreator

Parameters:

target - the assignment target (must not be null)

value - the value to assign (must not be null)

checkCast

public ResultHandle checkCast(ResultHandle resultHandle,
 String castTarget)

Description copied from interface: BytecodeCreator

Perform a check cast operation which transforms the type of the given result handle.

Specified by:

checkCast in interface BytecodeCreator

Parameters:

resultHandle - the result handle

castTarget - the cast target type descriptor

Returns:

a new result handle with updated type

convertPrimitive

public ResultHandle convertPrimitive(ResultHandle value,
 Class<?> conversionTarget)

Description copied from interface: BytecodeCreator

Converts given value, which must be of a primitive type, to the given conversionTarget, which must be a primitive type, using primitive conversions defined by the Java language specification.

Returns value directly when its static type is the same as conversionTarget.

Throws an exception if any of the arguments is null. Throws an exception when the static type of value is not a primitive type or when conversionTarget is not a primitive type. Throws an exception if no primitive conversion exists from the type of value to the conversionTarget. (Note that "throws an exception" in this paragraph does not mean that a bytecode sequence for throwing an exception is emitted; instead, the method convertPrimitive throws an exception directly and eagerly.)

Specified by:

convertPrimitive in interface BytecodeCreator

Parameters:

value - the value to be converted

conversionTarget - the primitive type to which the value should be converted

Returns:

the converted value

isScopedWithin

public boolean isScopedWithin(BytecodeCreator other)

Description copied from interface: BytecodeCreator

Determine if this bytecode creator is scoped within the given bytecode creator.

Specified by:

isScopedWithin in interface BytecodeCreator

Parameters:

other - the other bytecode creator

Returns:

true if this bytecode creator is scoped within the given creator, false otherwise

continueScope

public void continueScope(BytecodeCreator scope)

Description copied from interface: BytecodeCreator

Go to the top of the given scope.

Specified by:

continueScope in interface BytecodeCreator

Parameters:

scope - the scope to continue

breakScope

public void breakScope(BytecodeCreator scope)

Description copied from interface: BytecodeCreator

Go to the end of the given scope.

Specified by:

breakScope in interface BytecodeCreator

Parameters:

scope - the scope to break out of

createScope

public BytecodeCreator createScope()

Description copied from interface: BytecodeCreator

Create a nested scope. Bytecode added to the nested scope will be inserted at this point of the enclosing scope.

Specified by:

createScope in interface BytecodeCreator

Returns:

the nested scope

jumpTo

void jumpTo(BytecodeCreator scope)

Go the the top of the given scope. Unlike continueScope(BytecodeCreator) this method does not verify if this bytecode creator is scoped within the given bytecode creator.

Parameters:

scope -

storeResultHandle

static void storeResultHandle(org.objectweb.asm.MethodVisitor methodVisitor,
 ResultHandle handle)

loadResultHandle

void loadResultHandle(org.objectweb.asm.MethodVisitor methodVisitor,
 ResultHandle handle,
 BytecodeCreatorImpl bc,
 String expectedType)

loadResultHandle

void loadResultHandle(org.objectweb.asm.MethodVisitor methodVisitor,
 ResultHandle handle,
 BytecodeCreatorImpl bc,
 String expectedType,
 boolean dontCast)

emitLoadConstant

private static void emitLoadConstant(org.objectweb.asm.MethodVisitor methodVisitor,
 Object constant)

tryBlock

public TryBlock tryBlock()

Description copied from interface: BytecodeCreator

Add a try block.

Specified by:

tryBlock in interface BytecodeCreator

Returns:

the try block

compareLong

public ResultHandle compareLong(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

Compares two long values and pushes the resulting integer to the stack. If value1 is greater than value2, the result is 1; if value1 is equal to value2, the result is 0; if value1 is less than value2, the result is -1. One of the if* methods should be used to process the result. Both parameters must be of type long.

Specified by:

compareLong in interface BytecodeCreator

Parameters:

value1 - first long value to compare

value2 - second long value to compare

Returns:

the comparison result

compareFloat

public ResultHandle compareFloat(ResultHandle value1,
 ResultHandle value2,
 boolean nanComparesAsGreater)

Description copied from interface: BytecodeCreator

Compares two float values and pushes the resulting integer to the stack. If value1 is greater than value2, the result is 1; if value1 is equal to value2, the result is 0; if value1 is less than value2, the result is -1. One of the if* methods should be used to process the result. Both parameters must be of type float.

If one of the values is NaN, the result is 1 if nanComparesAsGreater is true and -1 if not.

Specified by:

compareFloat in interface BytecodeCreator

Parameters:

value1 - first long value to compare

value2 - second long value to compare

nanComparesAsGreater - whether presence of NaN should result in "greater"

Returns:

the comparison result

compareDouble

public ResultHandle compareDouble(ResultHandle value1,
 ResultHandle value2,
 boolean nanComparesAsGreater)

Description copied from interface: BytecodeCreator

Compares two double values and pushes the resulting integer to the stack. If value1 is greater than value2, the result is 1; if value1 is equal to value2, the result is 0; if value1 is less than value2, the result is -1. One of the if* methods should be used to process the result. Both parameters must be of type double.

If one of the values is NaN, the result is 1 if nanComparesAsGreater is true and -1 if not.

Specified by:

compareDouble in interface BytecodeCreator

Parameters:

value1 - first long value to compare

value2 - second long value to compare

nanComparesAsGreater - whether presence of NaN should result in "greater"

Returns:

the comparison result

emitCompare

private ResultHandle emitCompare(int opcode,
 String expectedType,
 ResultHandle value1,
 ResultHandle value2)

ifNonZero

public BranchResult ifNonZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type or boolean. If this value is true or non-zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifNonZero in interface BytecodeCreator

Parameters:

resultHandle - The result to compare with zero

Returns:

The branch result that is used to build the if statement

ifNull

public BranchResult ifNull(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement. If the value is null the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifNull in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifZero

public BranchResult ifZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type or boolean. If this value is false or zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifZero in interface BytecodeCreator

Parameters:

resultHandle - The result to compare with zero

Returns:

The branch result that is used to build the if statement

ifTrue

public BranchResult ifTrue(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement. An alias for BytecodeCreator.ifNonZero(ResultHandle).

Specified by:

ifTrue in interface BytecodeCreator

Parameters:

resultHandle - The result to compare with zero

Returns:

The branch result that is used to build the if statement

ifFalse

public BranchResult ifFalse(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement. An alias for BytecodeCreator.ifZero(ResultHandle).

Specified by:

ifFalse in interface BytecodeCreator

Parameters:

resultHandle - The result to compare with zero

Returns:

The branch result that is used to build the if statement

ifNotNull

public BranchResult ifNotNull(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement. If the value is not null the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifNotNull in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifGreaterThanZero

public BranchResult ifGreaterThanZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type. If this value is greater than zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifGreaterThanZero in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifGreaterEqualZero

public BranchResult ifGreaterEqualZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type. If this value is greater or equals to zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifGreaterEqualZero in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifLessThanZero

public BranchResult ifLessThanZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type. If this value is lower than zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifLessThanZero in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifLessEqualZero

public BranchResult ifLessEqualZero(ResultHandle resultHandle)

Description copied from interface: BytecodeCreator

An if statement.

resultHandle must be an integer type. If this value is lower or equals to zero the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifLessEqualZero in interface BytecodeCreator

Parameters:

resultHandle -

Returns:

The branch result that is used to build the if statement

ifIntegerEqual

public BranchResult ifIntegerEqual(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

An if statement.

Values must be integer types. If value1 is equal to value2 the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifIntegerEqual in interface BytecodeCreator

Parameters:

value1 -

value2 -

Returns:

The branch result that is used to build the if statement

ifIntegerGreaterThan

public BranchResult ifIntegerGreaterThan(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

An if statement.

Values must be integer types. If value1 is greater than value2 the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifIntegerGreaterThan in interface BytecodeCreator

Parameters:

value1 -

value2 -

Returns:

The branch result that is used to build the if statement

ifIntegerGreaterEqual

public BranchResult ifIntegerGreaterEqual(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

An if statement.

Values must be integer types. If value1 is greater or equal to value2 the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifIntegerGreaterEqual in interface BytecodeCreator

Parameters:

value1 -

value2 -

Returns:

The branch result that is used to build the if statement

ifIntegerLessThan

public BranchResult ifIntegerLessThan(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

An if statement.

Values must be integer types. If value1 is less than value2 the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifIntegerLessThan in interface BytecodeCreator

Parameters:

value1 -

value2 -

Returns:

The branch result that is used to build the if statement

instanceOf

public ResultHandle instanceOf(ResultHandle resultHandle,
 String castTarget)

Description copied from interface: BytecodeCreator

Checks if the given resultHandle is an instance of the target type

Specified by:

instanceOf in interface BytecodeCreator

Parameters:

resultHandle - the result handle

castTarget - the cast target class

Returns:

a boolean result handle with the result of the instanceof call

ifIntegerLessEqual

public BranchResult ifIntegerLessEqual(ResultHandle value1,
 ResultHandle value2)

Description copied from interface: BytecodeCreator

An if statement.

Values must be integer types. If value1 is less or equal to value2 the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifIntegerLessEqual in interface BytecodeCreator

Parameters:

value1 -

value2 -

Returns:

The branch result that is used to build the if statement

ifReferencesEqual

public BranchResult ifReferencesEqual(ResultHandle ref1,
 ResultHandle ref2)

Description copied from interface: BytecodeCreator

An if statement.

If references are equal (object identity) the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

Specified by:

ifReferencesEqual in interface BytecodeCreator

Parameters:

ref1 -

ref2 -

Returns:

The branch result that is used to build the if statement

ifReferencesNotEqual

public BranchResult ifReferencesNotEqual(ResultHandle ref1,
 ResultHandle ref2)

Description copied from interface: BytecodeCreator

An if statement.

If references are not equal (as in object identity) the BranchResult.trueBranch() code will be executed, otherwise the BranchResult.falseBranch() will be run.

This method is dual to BytecodeCreator.ifReferencesEqual(ResultHandle, ResultHandle) and can be used to emit bytecode that is closer to what javac emits, when useful.

Specified by:

ifReferencesNotEqual in interface BytecodeCreator

Parameters:

ref1 -

ref2 -

Returns:

The branch result that is used to build the if statement

ifThenElse

public IfThenElse ifThenElse(ResultHandle value)

Description copied from interface: BytecodeCreator

Create a new if-then-else construct.

The IfThenElse.then() block is executed if the condition result handle evaluates to true.

Specified by:

ifThenElse in interface BytecodeCreator

Parameters:

value -

Returns:

the if-then-else construct

getMethodParam

public ResultHandle getMethodParam(int methodNo)

Specified by:

getMethodParam in interface BytecodeCreator

Parameters:

methodNo - The method parameter number, zero indexed

Returns:

A ResultHandle representing the parameter

createFunction

public FunctionCreator createFunction(Class<?> functionalInterface)

Description copied from interface: BytecodeCreator

Creates an instance of a functional interface

The resulting FunctionCreator can be used to both define the functions bytecode, and to get a ResultHandle that represents the instance of the function.

Specified by:

createFunction in interface BytecodeCreator

Parameters:

functionalInterface - A functional interface

Returns:

The function builder

returnValue

public void returnValue(ResultHandle returnValue)

Description copied from interface: BytecodeCreator

Represents a return statement. If this is a void method the return value must be null, otherwise it must be a ResultHandle of the correct type which will be returned from the method.

Specified by:

returnValue in interface BytecodeCreator

Parameters:

returnValue - The value to return

throwException

public void throwException(ResultHandle exception)

Description copied from interface: BytecodeCreator

Throws an exception

Specified by:

throwException in interface BytecodeCreator

Parameters:

exception - A result handle representing the exception to throw

whileLoop

public WhileLoop whileLoop(Function<BytecodeCreator,BranchResult> conditionFun)

Description copied from interface: BytecodeCreator

Create a new while loop statement.

Specified by:

whileLoop in interface BytecodeCreator

Parameters:

conditionFun - A function used to create the condition. The true branch continues executing the block and the false branch terminates the statement.

Returns:

the while loop statement

forEach

public ForEachLoop forEach(ResultHandle iterable)

Description copied from interface: BytecodeCreator

Create a new for-each loop construct.

Specified by:

forEach in interface BytecodeCreator

Parameters:

iterable -

Returns:

the for-each construct

add

public ResultHandle add(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Adds the two result handles together and returns the result

Specified by:

add in interface BytecodeCreator

Parameters:

a1 - The first number, aka the augend

a2 - The second number, aka the addend

Returns:

The result

subtract

public ResultHandle subtract(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Subtracts the second result handle from the first result and returns the result

Specified by:

subtract in interface BytecodeCreator

Parameters:

a1 - The first number, aka the minuend

a2 - The second number, aka the subtrahend

Returns:

The result

multiply

public ResultHandle multiply(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Multiplies the two result handles together and returns the result

Specified by:

multiply in interface BytecodeCreator

Parameters:

a1 - The first number, aka the multiplier

a2 - The second number, aka the multiplicand

Returns:

The result

divide

public ResultHandle divide(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Divides the first result handle by the second and returns the result

Specified by:

divide in interface BytecodeCreator

Parameters:

a1 - The first number, aka the numerator

a2 - The second number, aka the denominator

Returns:

The result

remainder

public ResultHandle remainder(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Computes the remainder after division of the first result handle by the second and returns the result

Specified by:

remainder in interface BytecodeCreator

Parameters:

a1 - The first number, aka the numerator

a2 - The second number, aka the denominator

Returns:

The result

bitwiseAnd

public ResultHandle bitwiseAnd(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Computes the bitwise AND of the two result handles and returns the result

Specified by:

bitwiseAnd in interface BytecodeCreator

Parameters:

a1 - The first number

a2 - The second number

Returns:

The result

bitwiseOr

public ResultHandle bitwiseOr(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Computes the bitwise OR of the two result handles and returns the result

Specified by:

bitwiseOr in interface BytecodeCreator

Parameters:

a1 - The first number

a2 - The second number

Returns:

The result

bitwiseXor

public ResultHandle bitwiseXor(ResultHandle a1,
 ResultHandle a2)

Description copied from interface: BytecodeCreator

Computes the bitwise XOR of the two result handles and returns the result

Specified by:

bitwiseXor in interface BytecodeCreator

Parameters:

a1 - The first number

a2 - The second number

Returns:

The result

stringSwitch

public Switch.StringSwitch stringSwitch(ResultHandle value)

Description copied from interface: BytecodeCreator

Create a new switch construct for a string value.

Specified by:

stringSwitch in interface BytecodeCreator

Parameters:

value - The string value to switch on

Returns:

the switch construct

enumSwitch

public <E extends Enum<E>> Switch.EnumSwitch<E> enumSwitch(ResultHandle value,
 Class<E> enumClass)

Description copied from interface: BytecodeCreator

Create a new switch construct for an enum constant.

Specified by:

enumSwitch in interface BytecodeCreator

Type Parameters:

E -

Parameters:

value - The enum constant to switch on

enumClass -

Returns:

the switch construct

emitBinaryArithmetic

private ResultHandle emitBinaryArithmetic(int intOpcode,
 ResultHandle a1,
 ResultHandle a2)

longArithmeticOpcode

private int longArithmeticOpcode(int intOpcode)

floatArithmeticOpcode

private int floatArithmeticOpcode(int intOpcode)

doubleArithmeticOpcode

private int doubleArithmeticOpcode(int intOpcode)

allocateResult

private ResultHandle allocateResult(String returnType)

allocateLocalVariables

protected int allocateLocalVariables(int localVarCount)

findActiveResultHandles

void findActiveResultHandles(Set<ResultHandle> handlesToAllocate)

writeOperations

protected void writeOperations(org.objectweb.asm.MethodVisitor visitor)

writeInteriorOperations

protected void writeInteriorOperations(org.objectweb.asm.MethodVisitor visitor)

checkScope

<R extends ResultHandle> R checkScope(R handle)

dumpScope

private void dumpScope(StringBuilder builder)

checkScope

ResultHandle[] checkScope(ResultHandle[] handles)

resolve

final ResultHandle resolve(ResultHandle handle)

resolve

ResultHandle resolve(ResultHandle handle,
 BytecodeCreator creator)

resolve

ResultHandle[] resolve(BytecodeCreator creator,
 ResultHandle... handles)

resolve

final ResultHandle[] resolve(ResultHandle... handles)

getMethod

MethodCreatorImpl getMethod()

getOwner

BytecodeCreatorImpl getOwner()

ifValue

private BranchResult ifValue(ResultHandle resultHandle,
 int opcode,
 String opType)

ifValues

private BranchResult ifValues(ResultHandle resultHandle1,
 ResultHandle resultHandle2,
 int opcode,
 String opType)

requireNonNullHandles

private ResultHandle[] requireNonNullHandles(ResultHandle[] handles)

createNewInstanceOp

BytecodeCreatorImpl.Operation createNewInstanceOp(ResultHandle handle,
 MethodDescriptor descriptor,
 ResultHandle[] args)