Package proguard.classfile.util.inject

Class CodeInjector

java.lang.Object

proguard.classfile.util.inject.CodeInjector

Direct Known Subclasses:

AccumulatedCodeInjector

public class CodeInjector
extends java.lang.Object

This utility class allows for injecting a method invocation instruction, optionally with arguments modeled by instances of classes implementing the InjectedArgument interface, to the specified target method at an offset determined by the implementation of the InjectStrategy interface.

Example usage: new CodeInjector() .injectInvokeStatic(logUtilClass, logDebugMethod, new ConstantPrimitive(1), new ConstantString("Hello world")) .into(MainProgramClass, mainMethod) .at(new FirstBlock()) .commit();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CodeInjector.ClassMethodPair

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeAttributeEditor	editor

Constructor Summary

Constructors

Constructor	Description
CodeInjector()	Deprecated. Use CodeInjector(CodeAttributeEditor) instead.
CodeInjector(CodeAttributeEditor editor)

Method Summary

Modifier and Type	Method	Description
CodeInjector	at(InjectStrategy injectStrategy)	Specify the location in which the invoke instruction should be injected into.
void	commit()	Apply the invoke instruction in accordance to the specifications provided via the `.injectInvokeStatic(...)`, `.into(...)` and `.at(...)` methods.
java.util.List<InjectedArgument>	getArguments()
CodeInjector.ClassMethodPair	getContent()
InjectStrategy	getInjectStrategy()
protected LocalVariable	getResultLocalIndex()
java.util.List<CodeInjector.ClassMethodPair>	getTargets()
CodeInjector	injectInvokeStatic(Clazz clazz, Method method)	Specify the static method to be invoked.
CodeInjector	injectInvokeStatic(Clazz clazz, Method method, InjectedArgument... arguments)	Specify the static method to be invoked.
CodeInjector	into(ProgramClass programClass, ProgramMethod programMethod)	Specify the method where a static method invocation will be injected into.
boolean	readyToCommit()
void	reset()	Resets the internal state of this injector, allowing it to be reused.
LocalVariable	store()

Methods inherited from class java.lang.Object

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

Field Detail

editor

protected final CodeAttributeEditor editor

Constructor Detail

CodeInjector

@Deprecated
public CodeInjector()

Deprecated.

Use CodeInjector(CodeAttributeEditor) instead.

CodeInjector

public CodeInjector(CodeAttributeEditor editor)

Method Detail

injectInvokeStatic

public CodeInjector injectInvokeStatic(Clazz clazz,
                                       Method method)

Specify the static method to be invoked.

Parameters:

clazz - The class containing the static method to be invoked.

method - The method to be invoked.

injectInvokeStatic

public CodeInjector injectInvokeStatic(Clazz clazz,
                                       Method method,
                                       InjectedArgument... arguments)

Specify the static method to be invoked.

Parameters:

clazz - The class containing the static method to be invoked.

method - The method to be invoked.

arguments - A list of arguments to be passed to the method to be invoked.

reset

public void reset()

Resets the internal state of this injector, allowing it to be reused.

This avoids the performance overhead of re-instantiating the attribute editor for subsequent operations.

into

public CodeInjector into(ProgramClass programClass,
                         ProgramMethod programMethod)

Specify the method where a static method invocation will be injected into.

Parameters:

programClass - The program class that has the method where a static method invocation will be injected into.

programMethod - The method where a static method invocation will be injected into.

at

public CodeInjector at(InjectStrategy injectStrategy)

Specify the location in which the invoke instruction should be injected into.

Parameters:

injectStrategy - The implementation of the InjectStrategy interface which determines the offset to inject the invoke instruction.

store

public LocalVariable store()

commit

public void commit()

Apply the invoke instruction in accordance to the specifications provided via the `.injectInvokeStatic(...)`, `.into(...)` and `.at(...)` methods.

readyToCommit

public boolean readyToCommit()

getTargets

public java.util.List<CodeInjector.ClassMethodPair> getTargets()

getContent

public CodeInjector.ClassMethodPair getContent()

getInjectStrategy

public InjectStrategy getInjectStrategy()

getArguments

public java.util.List<InjectedArgument> getArguments()

getResultLocalIndex

protected LocalVariable getResultLocalIndex()