org.spongepowered.asm.mixin.injection.struct

Class InjectionInfo

java.lang.Object

org.spongepowered.asm.mixin.struct.SpecialMethodInfo

org.spongepowered.asm.mixin.injection.struct.InjectionInfo

All Implemented Interfaces:

ISliceContext, IInjectionPointContext

Direct Known Subclasses:

CallbackInjectionInfo, ModifyArgInjectionInfo, ModifyArgsInjectionInfo, ModifyConstantInjectionInfo, ModifyVariableInjectionInfo, RedirectInjectionInfo

public abstract class InjectionInfo
extends SpecialMethodInfo
implements ISliceContext

Contructs information about an injection from an Inject annotation and allows the injection to be processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InjectionInfo.AnnotationType Decoration for subclasses which indicates the injector annotation that the subclass handles
static interface	InjectionInfo.HandlerPrefix Decoration for subclasses which specifies the prefix to use when conforming annotated handler methods

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	atKey The key into the annotation which contains the injection points
static java.lang.String	DEFAULT_PREFIX Default conform prefix for handler methods
protected InjectorGroupInfo	group Injection group
protected java.util.List<InjectionPoint>	injectionPoints Injection points parsed from At annotations
protected Injector	injector Bytecode injector
protected boolean	isStatic Annotated method is static
protected MethodSlices	slices Method slice descriptors parsed from the annotation
protected int	targetCount Number of target methods identified by the injection points
protected java.util.Map<Target,java.util.List<InjectionNodes.InjectionNode>>	targetNodes Map of lists of nodes enumerated by calling prepare()
protected java.util.Deque<org.objectweb.asm.tree.MethodNode>	targets Target method(s)

Fields inherited from class org.spongepowered.asm.mixin.struct.SpecialMethodInfo

annotation, annotationType, classNode, method, methodName, mixin

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InjectionInfo(MixinTargetContext mixin, org.objectweb.asm.tree.MethodNode method, org.objectweb.asm.tree.AnnotationNode annotation) ctor
protected	InjectionInfo(MixinTargetContext mixin, org.objectweb.asm.tree.MethodNode method, org.objectweb.asm.tree.AnnotationNode annotation, java.lang.String atKey)

Method Summary

Modifier and Type	Method and Description
void	addCallbackInvocation(org.objectweb.asm.tree.MethodNode handler) Notify method, called by injector when adding a callback into a target
org.objectweb.asm.tree.MethodNode	addMethod(int access, java.lang.String name, java.lang.String desc) Inject a method into the target class
protected java.lang.String	getDescription()
protected java.lang.String	getDynamicInfo() Get info from a decorating Dynamic annotation.
int	getInjectedCallbackCount() Get the injected callback count
static org.objectweb.asm.tree.AnnotationNode	getInjectorAnnotation(IMixinInfo mixin, org.objectweb.asm.tree.MethodNode method) Returns any injector annotation found on the specified method.
static java.lang.String	getInjectorPrefix(org.objectweb.asm.tree.AnnotationNode annotation) Get the conform prefix for an injector handler by type
MethodSlice	getSlice(java.lang.String id) Get the slice descriptors
java.lang.String	getSliceId(java.lang.String id) Return the mapped slice id for the specified ID.
java.util.Collection<org.objectweb.asm.tree.MethodNode>	getTargets() Get methods being injected into
void	inject() Perform injections
boolean	isValid() Get whether there is enough valid information in this info to actually perform an injection.
void	notifyInjected(Target target) Callback from injector which notifies us that a callback was injected.
static InjectionInfo	parse(MixinTargetContext mixin, org.objectweb.asm.tree.MethodNode method) Parse an injector from the specified method (if an injector annotation is present).
protected void	parseInjectionPoints(java.util.List<org.objectweb.asm.tree.AnnotationNode> ats)
protected abstract Injector	parseInjector(org.objectweb.asm.tree.AnnotationNode injectAnnotation)
protected void	parseRequirements()
protected java.util.Set<ITargetSelector>	parseTargets()
void	postInject() Perform cleanup and post-injection tasks
void	prepare() Discover injection points
protected void	readAnnotation() Parse the info from the supplied annotation
protected java.util.List<org.objectweb.asm.tree.AnnotationNode>	readInjectionPoints()
static void	register(java.lang.Class<? extends InjectionInfo> type) Register an injector info class.
java.lang.String	toString()

Methods inherited from class org.spongepowered.asm.mixin.struct.SpecialMethodInfo

getAnnotation, getClassNode, getContext, getMethod, getMethodName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.asm.mixin.injection.IInjectionPointContext

getAnnotation, getContext, getMethod

Field Detail

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

Default conform prefix for handler methods

See Also:

Constant Field Values

isStatic

protected final boolean isStatic

Annotated method is static

targets

protected final java.util.Deque<org.objectweb.asm.tree.MethodNode> targets

Target method(s)

slices

protected final MethodSlices slices

Method slice descriptors parsed from the annotation

atKey

protected final java.lang.String atKey

The key into the annotation which contains the injection points

injectionPoints

protected final java.util.List<InjectionPoint> injectionPoints

Injection points parsed from At annotations

targetNodes

protected final java.util.Map<Target,java.util.List<InjectionNodes.InjectionNode>> targetNodes

Map of lists of nodes enumerated by calling prepare()

targetCount

protected int targetCount

Number of target methods identified by the injection points

injector

protected Injector injector

Bytecode injector

group

protected InjectorGroupInfo group

Injection group

Constructor Detail

InjectionInfo

protected InjectionInfo(MixinTargetContext mixin,
                        org.objectweb.asm.tree.MethodNode method,
                        org.objectweb.asm.tree.AnnotationNode annotation)

ctor

Parameters:

mixin - Mixin data

method - Injector method

annotation - Annotation to parse

InjectionInfo

protected InjectionInfo(MixinTargetContext mixin,
                        org.objectweb.asm.tree.MethodNode method,
                        org.objectweb.asm.tree.AnnotationNode annotation,
                        java.lang.String atKey)

Method Detail

readAnnotation

protected void readAnnotation()

Parse the info from the supplied annotation

parseTargets

protected java.util.Set<ITargetSelector> parseTargets()

readInjectionPoints

protected java.util.List<org.objectweb.asm.tree.AnnotationNode> readInjectionPoints()

parseInjectionPoints

protected void parseInjectionPoints(java.util.List<org.objectweb.asm.tree.AnnotationNode> ats)

parseRequirements

protected void parseRequirements()

parseInjector

protected abstract Injector parseInjector(org.objectweb.asm.tree.AnnotationNode injectAnnotation)

isValid

public boolean isValid()

Get whether there is enough valid information in this info to actually perform an injection.

Returns:

true if this InjectionInfo was successfully parsed

prepare

public void prepare()

Discover injection points

inject

public void inject()

Perform injections

postInject

public void postInject()

Perform cleanup and post-injection tasks

notifyInjected

public void notifyInjected(Target target)

Callback from injector which notifies us that a callback was injected. No longer used.

Parameters:

target - target into which the injector injected

getDescription

protected java.lang.String getDescription()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTargets

public java.util.Collection<org.objectweb.asm.tree.MethodNode> getTargets()

Get methods being injected into

Returns:

methods being injected into

getSlice

public MethodSlice getSlice(java.lang.String id)

Get the slice descriptors

Specified by:

getSlice in interface ISliceContext

Parameters:

id - slice id to fetch

Returns:

method slice matching query

getSliceId

public java.lang.String getSliceId(java.lang.String id)

Return the mapped slice id for the specified ID. Injectors which only support use of a single slice will always return the default id (an empty string)

Parameters:

id - slice id

Returns:

mapped id

getInjectedCallbackCount

public int getInjectedCallbackCount()

Get the injected callback count

Returns:

the injected callback count

addMethod

public org.objectweb.asm.tree.MethodNode addMethod(int access,
                                                   java.lang.String name,
                                                   java.lang.String desc)

Inject a method into the target class

Parameters:

access - Method access flags, synthetic will be automatically added

name - Method name

desc - Method descriptor

Returns:

new method

addCallbackInvocation

public void addCallbackInvocation(org.objectweb.asm.tree.MethodNode handler)

Notify method, called by injector when adding a callback into a target

Parameters:

handler - callback handler being invoked

getDynamicInfo

protected java.lang.String getDynamicInfo()

Get info from a decorating Dynamic annotation. If the annotation is present, a descriptive string suitable for inclusion in an error message is returned. If the annotation is not present then an empty string is returned.

parse

public static InjectionInfo parse(MixinTargetContext mixin,
                                  org.objectweb.asm.tree.MethodNode method)

Parse an injector from the specified method (if an injector annotation is present). If no injector annotation is present then null is returned.

Parameters:

mixin - context

method - mixin method

Returns:

parsed InjectionInfo or null

getInjectorAnnotation

public static org.objectweb.asm.tree.AnnotationNode getInjectorAnnotation(IMixinInfo mixin,
                                                                          org.objectweb.asm.tree.MethodNode method)

Returns any injector annotation found on the specified method. If multiple matching annotations are found then an exception is thrown. If no annotations are present then null is returned.

Parameters:

mixin - context

method - mixin method

Returns:

annotation or null

getInjectorPrefix

public static java.lang.String getInjectorPrefix(org.objectweb.asm.tree.AnnotationNode annotation)

Get the conform prefix for an injector handler by type

Parameters:

annotation - Annotation to inspect

Returns:

conform prefix

register

public static void register(java.lang.Class<? extends InjectionInfo> type)

Register an injector info class. The supplied class must be decorated with an InjectionInfo.AnnotationType annotation for registration purposes.

Parameters:

type - injection info subclass to register