-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #84 from LlamaLad7/feature/cancellable-sugar
Feature/cancellable sugar
- Loading branch information
Showing
6 changed files
with
195 additions
and
9 deletions.
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
src/main/java/com/llamalad7/mixinextras/sugar/Cancellable.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
package com.llamalad7.mixinextras.sugar; | ||
|
||
import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation; | ||
import org.spongepowered.asm.mixin.injection.Inject; | ||
import org.spongepowered.asm.mixin.injection.ModifyConstant; | ||
import org.spongepowered.asm.mixin.injection.Redirect; | ||
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; | ||
import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable; | ||
|
||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Retention; | ||
import java.lang.annotation.RetentionPolicy; | ||
import java.lang.annotation.Target; | ||
|
||
/** | ||
* Allows you to receive a cancellable {@link CallbackInfo} or {@link CallbackInfoReturnable} as appropriate | ||
* from any kind of injector. This allows you to optionally cancel the target method without being forced to use | ||
* {@link Inject @Inject}. | ||
* <p> | ||
* The same {@link CallbackInfo}s will be passed to every handler method in a chain of | ||
* {@link WrapOperation @WrapOperation}s (i.e. any number of {@link WrapOperation @WrapOperation}s and at most one inner | ||
* {@link Redirect @Redirect} / {@link ModifyConstant @ModifyConstant}). This means you can choose to use the | ||
* {@link CallbackInfo#isCancelled()} and {@link CallbackInfoReturnable#getReturnValue()} methods to see if the wrapped | ||
* handler cancelled, so you can respond accordingly. | ||
* <p> | ||
* See <a href="https://github.com/LlamaLad7/MixinExtras/wiki/Cancellable">the wiki article</a> for more info. | ||
*/ | ||
@Target(ElementType.PARAMETER) | ||
@Retention(RetentionPolicy.CLASS) | ||
public @interface Cancellable { | ||
} |
115 changes: 115 additions & 0 deletions
115
src/main/java/com/llamalad7/mixinextras/sugar/impl/CancellableSugarApplicator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
package com.llamalad7.mixinextras.sugar.impl; | ||
|
||
import com.llamalad7.mixinextras.injector.StackExtension; | ||
import com.llamalad7.mixinextras.utils.ASMUtils; | ||
import com.llamalad7.mixinextras.utils.Decorations; | ||
import org.objectweb.asm.Opcodes; | ||
import org.objectweb.asm.Type; | ||
import org.objectweb.asm.tree.*; | ||
import org.spongepowered.asm.mixin.injection.struct.InjectionInfo; | ||
import org.spongepowered.asm.mixin.injection.struct.InjectionNodes.InjectionNode; | ||
import org.spongepowered.asm.mixin.injection.struct.Target; | ||
|
||
class CancellableSugarApplicator extends SugarApplicator { | ||
CancellableSugarApplicator(InjectionInfo info, SugarParameter parameter) { | ||
super(info, parameter); | ||
} | ||
|
||
@Override | ||
void validate(Target target, InjectionNode node) { | ||
} | ||
|
||
@Override | ||
void prepare(Target target, InjectionNode node) { | ||
} | ||
|
||
@Override | ||
void inject(Target target, InjectionNode node, StackExtension stack) { | ||
Type ciType = Type.getObjectType(target.getCallbackInfoClass()); | ||
if (!ciType.equals(paramType)) { | ||
throw new IllegalStateException( | ||
String.format( | ||
"@Cancellable sugar has wrong type! Expected %s but got %s!", | ||
ciType.getClassName(), | ||
paramType.getClassName() | ||
) | ||
); | ||
} | ||
int ciIndex = getOrCreateCi(target, node, stack, ciType); | ||
stack.extra(1); | ||
target.insns.insertBefore(node.getCurrentTarget(), new VarInsnNode(Opcodes.ALOAD, ciIndex)); | ||
} | ||
|
||
@Override | ||
int postProcessingPriority() { | ||
// Early, we don't care about being particularly tight compared to e.g. `@Local`s. | ||
return -1000; | ||
} | ||
|
||
private int getOrCreateCi(Target target, InjectionNode node, StackExtension stack, Type ciType) { | ||
if (node.hasDecoration(Decorations.CANCELLABLE_CI_INDEX)) { | ||
return node.getDecoration(Decorations.CANCELLABLE_CI_INDEX); | ||
} | ||
int ciIndex = target.allocateLocal(); | ||
target.addLocalVariable(ciIndex, "callbackInfo" + ciIndex, ciType.getDescriptor()); | ||
node.decorate(Decorations.CANCELLABLE_CI_INDEX, ciIndex); | ||
|
||
InsnList init = new InsnList(); | ||
init.add(new TypeInsnNode(Opcodes.NEW, ciType.getInternalName())); | ||
init.add(new InsnNode(Opcodes.DUP)); | ||
init.add(new LdcInsnNode(target.method.name)); | ||
init.add(new InsnNode(Opcodes.ICONST_1)); | ||
init.add(new MethodInsnNode( | ||
Opcodes.INVOKESPECIAL, | ||
ciType.getInternalName(), | ||
"<init>", | ||
"(Ljava/lang/String;Z)V", | ||
false | ||
)); | ||
init.add(new VarInsnNode(Opcodes.ASTORE, ciIndex)); | ||
target.insertBefore(node, init); | ||
stack.extra(4); | ||
|
||
SugarPostProcessingExtension.enqueuePostProcessing(this, () -> { | ||
InsnList cancellation = new InsnList(); | ||
LabelNode notCancelled = new LabelNode(); | ||
cancellation.add(new VarInsnNode(Opcodes.ALOAD, ciIndex)); | ||
cancellation.add(new MethodInsnNode( | ||
Opcodes.INVOKEVIRTUAL, | ||
ciType.getInternalName(), | ||
"isCancelled", | ||
"()Z", | ||
false | ||
)); | ||
cancellation.add(new JumpInsnNode(Opcodes.IFEQ, notCancelled)); | ||
cancellation.add(new VarInsnNode(Opcodes.ALOAD, ciIndex)); | ||
if (target.returnType.equals(Type.VOID_TYPE)) { | ||
cancellation.add(new InsnNode(Opcodes.RETURN)); | ||
} else if (ASMUtils.isPrimitive(target.returnType)) { | ||
cancellation.add(new MethodInsnNode( | ||
Opcodes.INVOKEVIRTUAL, | ||
ciType.getInternalName(), | ||
"getReturnValue" + target.returnType.getDescriptor(), | ||
"()" + target.returnType.getDescriptor(), | ||
false | ||
)); | ||
cancellation.add(new InsnNode(target.returnType.getOpcode(Opcodes.IRETURN))); | ||
} else { | ||
cancellation.add(new MethodInsnNode( | ||
Opcodes.INVOKEVIRTUAL, | ||
ciType.getInternalName(), | ||
"getReturnValue", | ||
"()Ljava/lang/Object;", | ||
false | ||
)); | ||
cancellation.add(new TypeInsnNode(Opcodes.CHECKCAST, target.returnType.getInternalName())); | ||
cancellation.add(new InsnNode(Opcodes.ARETURN)); | ||
} | ||
cancellation.add(notCancelled); | ||
target.insns.insert(node.getCurrentTarget(), cancellation); | ||
// No need to adjust the stack because we only increase the height by at most 2, which is covered by | ||
// our bump of 4 earlier. | ||
}); | ||
return ciIndex; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters