Fix errors from 0.2.1 backport

object-Object · object-Object · commit 9461f3b9f6c4 · 2024-05-27T01:26:25.000-04:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -31,4 +31,5 @@
         "*.jcss.jinja": "jinja-css", // for files with a lot of jinja stuff, where the linting isn't useful
         "*.json5.jinja": "json5",
     },
+    "kotlin.languageServer.enabled": false,
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ### Fixed
 
 - Evaluators were unable to cast any spells requiring media.
-- When debugging, spells requiring media would fail if a Debugger was not in the hand that the debug session was started with.
 - Evaluator mishaps were unintentionally caught by the Uncaught Mishaps option, and did not apply side effects to the stack.
 
 ## 0.2.0+1.19.2
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/MixinCastingContext.java b/Common/src/main/java/gay/object/hexdebug/mixin/MixinCastingContext.java
@@ -2,6 +2,7 @@
 
 import at.petrak.hexcasting.api.spell.Action;
 import at.petrak.hexcasting.api.spell.casting.CastingContext;
+import gay.object.hexdebug.casting.eval.DebugCastEnvType;
 import gay.object.hexdebug.casting.eval.IMixinCastingContext;
 import gay.object.hexdebug.debugger.DebugStepType;
 import net.minecraft.network.chat.Component;
@@ -39,6 +40,9 @@ public abstract class MixinCastingContext implements IMixinCastingContext {
     private boolean isDebugging$hexdebug = false;
     @Nullable
     @Unique
+    private DebugCastEnvType debugCastEnvType$hexdebug = null;
+    @Nullable
+    @Unique
     private Action lastEvaluatedAction$hexdebug = null;
     @Nullable
     @Unique
@@ -75,4 +79,15 @@ public abstract class MixinCastingContext implements IMixinCastingContext {
     public void setLastDebugStepType$hexdebug(@Nullable DebugStepType lastDebugStepType) {
         lastDebugStepType$hexdebug = lastDebugStepType;
     }
+
+    @Nullable
+    @Override
+    public DebugCastEnvType getDebugCastEnvType$hexdebug() {
+        return debugCastEnvType$hexdebug;
+    }
+
+    @Override
+    public void setDebugCastEnvType$hexdebug(@Nullable DebugCastEnvType debugCastEnvType) {
+        debugCastEnvType$hexdebug = debugCastEnvType;
+    }
 }
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/MixinDoMishap.java b/Common/src/main/java/gay/object/hexdebug/mixin/MixinDoMishap.java
@@ -5,6 +5,7 @@
 import at.petrak.hexcasting.api.spell.mishaps.Mishap;
 import gay.object.hexdebug.casting.eval.IMixinCastingContext;
 import gay.object.hexdebug.casting.eval.IMixinCastingContextKt;
+import gay.object.hexdebug.casting.eval.UtilsKt;
 import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory;
 import org.spongepowered.asm.mixin.Final;
 import org.spongepowered.asm.mixin.Mixin;
@@ -26,10 +27,10 @@ public abstract class MixinDoMishap {
     @Inject(method = "performEffect", at = @At("HEAD"), remap = false)
     private void printDebugMessage$hexdebug(CastingHarness harness, CallbackInfoReturnable<Boolean> cir) {
         var ctx = harness.getCtx();
-        var msg = mishap.errorMessage(ctx, errorCtx);
         var debugCastEnv = (IMixinCastingContext) (Object) ctx;
         if (debugCastEnv != null && debugCastEnv.isDebugging$hexdebug()) {
-            IMixinCastingContextKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDERR, true);
+            var msg = mishap.errorMessage(ctx, errorCtx);
+            UtilsKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDERR, true);
         }
     }
 }
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/MixinOpPrintSpell.java b/Common/src/main/java/gay/object/hexdebug/mixin/MixinOpPrintSpell.java
@@ -4,6 +4,7 @@
 import at.petrak.hexcasting.api.spell.iota.Iota;
 import gay.object.hexdebug.casting.eval.IMixinCastingContext;
 import gay.object.hexdebug.casting.eval.IMixinCastingContextKt;
+import gay.object.hexdebug.casting.eval.UtilsKt;
 import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory;
 import org.spongepowered.asm.mixin.Final;
 import org.spongepowered.asm.mixin.Mixin;
@@ -24,7 +25,7 @@ public class MixinOpPrintSpell {
         var msg = datum.display();
         var debugCastEnv = (IMixinCastingContext) (Object) ctx;
         if (debugCastEnv != null && debugCastEnv.isDebugging$hexdebug()) {
-            IMixinCastingContextKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDOUT, true);
+            UtilsKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDOUT, true);
         }
     }
 }
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapter.kt b/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapter.kt
@@ -108,11 +108,11 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
         })
     }
 
-    fun evaluate(env: CastingEnvironment, pattern: HexPattern) = evaluate(env, PatternIota(pattern))
+    fun evaluate(env: CastingContext, pattern: HexPattern) = evaluate(env, PatternIota(pattern))
 
-    fun evaluate(env: CastingEnvironment, iota: Iota) = evaluate(env, SpellList.LList(listOf(iota)))
+    fun evaluate(env: CastingContext, iota: Iota) = evaluate(env, SpellList.LList(listOf(iota)))
 
-    fun evaluate(env: CastingEnvironment, list: SpellList) = debugger?.let {
+    fun evaluate(env: CastingContext, list: SpellList) = debugger?.let {
         val result = it.evaluate(env, list)
         if (result.startedEvaluating) {
             setEvaluatorState(ItemEvaluator.EvalState.MODIFIED)
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebugCastEnvType.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebugCastEnvType.kt
@@ -0,0 +1,6 @@
+package gay.`object`.hexdebug.casting.eval
+
+enum class DebugCastEnvType {
+    DEBUGGER,
+    EVALUATOR,
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebuggerCastEnv.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebuggerCastEnv.kt
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/IMixinCastingContext.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/IMixinCastingContext.kt
@@ -1,15 +1,23 @@
+@file:Suppress("CAST_NEVER_SUCCEEDS")
+
 package gay.`object`.hexdebug.casting.eval
 
 import at.petrak.hexcasting.api.spell.Action
+import at.petrak.hexcasting.api.spell.casting.CastingContext
+import at.petrak.hexcasting.api.spell.casting.CastingContext.CastSource
+import at.petrak.hexcasting.api.spell.casting.CastingHarness
+import at.petrak.hexcasting.api.spell.casting.sideeffects.OperatorSideEffect
 import gay.`object`.hexdebug.adapter.DebugAdapterManager
 import gay.`object`.hexdebug.debugger.DebugStepType
 import net.minecraft.network.chat.Component
 import net.minecraft.server.level.ServerPlayer
+import net.minecraft.world.InteractionHand
 import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory
 
 @Suppress("PropertyName")
 interface IMixinCastingContext {
     var `isDebugging$hexdebug`: Boolean
+    var `debugCastEnvType$hexdebug`: DebugCastEnvType?
     var `lastEvaluatedAction$hexdebug`: Action?
     var `lastDebugStepType$hexdebug`: DebugStepType?
 }
@@ -19,23 +27,19 @@ fun IMixinCastingContext.reset() {
     `lastDebugStepType$hexdebug` = null
 }
 
-fun printDebugMessage(
-    caster: ServerPlayer,
-    message: Component,
-    category: String = OutputEventArgumentsCategory.STDOUT,
-    withSource: Boolean = true,
-) {
-    DebugAdapterManager[caster]?.print(message.string + "\n", category, withSource)
+fun newDebuggerCastEnv(caster: ServerPlayer, castingHand: InteractionHand): CastingContext {
+    return CastingContext(caster, castingHand, CastSource.PACKAGED_HEX).apply {
+        this as IMixinCastingContext
+        `isDebugging$hexdebug` = true
+        `debugCastEnvType$hexdebug` = DebugCastEnvType.DEBUGGER
+    }
 }
 
-fun printDebugMishap(
-    env: CastingContext,
-    caster: ServerPlayer,
-    mishap: OperatorSideEffect.DoMishap,
-) {
-    mishap.mishap.errorMessageWithName(env, mishap.errorCtx)?.also {
-        printDebugMessage(caster, it, OutputEventArgumentsCategory.STDERR)
+fun newEvaluatorCastEnv(caster: ServerPlayer, castingHand: InteractionHand): CastingContext {
+    return CastingContext(caster, castingHand, CastSource.STAFF).apply {
+        this as IMixinCastingContext
+        `isDebugging$hexdebug` = true
+        `debugCastEnvType$hexdebug` = DebugCastEnvType.EVALUATOR
     }
 }
 
-val CastingVM.debugCastEnv get() = ctx as IMixinCastingContext
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/Utils.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/Utils.kt
@@ -0,0 +1,21 @@
+
+package gay.`object`.hexdebug.casting.eval
+
+import at.petrak.hexcasting.api.spell.casting.CastingHarness
+import gay.`object`.hexdebug.adapter.DebugAdapterManager
+import net.minecraft.network.chat.Component
+import net.minecraft.server.level.ServerPlayer
+import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory
+
+@Suppress("CAST_NEVER_SUCCEEDS")
+val CastingHarness.debugCastEnv get() = ctx as IMixinCastingContext
+
+fun printDebugMessage(
+    caster: ServerPlayer,
+    message: Component,
+    category: String = OutputEventArgumentsCategory.STDOUT,
+    withSource: Boolean = true,
+) {
+    DebugAdapterManager[caster]?.print(message.string + "\n", category, withSource)
+}
+
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/DebugStepResult.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/DebugStepResult.kt
@@ -1,13 +1,13 @@
 package gay.`object`.hexdebug.debugger
 
-import at.petrak.hexcasting.api.casting.eval.ExecutionClientView
+import at.petrak.hexcasting.api.spell.casting.ControllerInfo
 import org.eclipse.lsp4j.debug.Source
 import org.eclipse.lsp4j.debug.LoadedSourceEventArgumentsReason as LoadedSourceReason
 
 data class DebugStepResult(
     val reason: StopReason,
     val type: DebugStepType? = null,
-    val clientInfo: ExecutionClientView? = null,
+    val clientInfo: ControllerInfo? = null,
     val loadedSources: Map<Source, LoadedSourceReason> = mapOf(),
     val startedEvaluating: Boolean = false,
 ) {
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt
@@ -8,6 +8,7 @@ import at.petrak.hexcasting.api.spell.casting.CastingHarness.CastResult
 import at.petrak.hexcasting.api.spell.casting.eval.*
 import at.petrak.hexcasting.api.spell.casting.eval.SpellContinuation.Done
 import at.petrak.hexcasting.api.spell.casting.eval.SpellContinuation.NotDone
+import at.petrak.hexcasting.api.spell.casting.sideeffects.EvalSound
 import at.petrak.hexcasting.api.spell.casting.sideeffects.OperatorSideEffect
 import at.petrak.hexcasting.api.spell.iota.*
 import at.petrak.hexcasting.api.spell.math.HexDir
@@ -38,21 +39,24 @@ class HexDebugger(
     private val world: ServerLevel,
     private val onExecute: ((Iota) -> Unit)? = null,
     iotas: List<Iota>,
-    private var image: FunctionalData? = null,
+    private var image: FunctionalData = emptyFunctionalData(),
 ) {
     constructor(
         initArgs: InitializeRequestArguments,
         launchArgs: LaunchArgs,
         castArgs: CastArgs,
-        image: FunctionalData? = null,
+        image: FunctionalData = emptyFunctionalData(),
     ) : this(initArgs, launchArgs, castArgs.env, castArgs.world, castArgs.onExecute, castArgs.iotas, image)
 
     var lastEvaluatedMetadata: IotaMetadata? = null
         private set
 
     // ensure we passed a debug cast env to help catch errors early
     init {
-        (defaultEnv as IMixinCastingContext).`isDebugging$hexdebug` = true
+        @Suppress("CAST_NEVER_SUCCEEDS")
+        if (!(defaultEnv as IMixinCastingContext).`isDebugging$hexdebug`) {
+            throw IllegalArgumentException("defaultEnv.isDebugging\$hexdebug must be true")
+        }
     }
 
     private val variablesAllocator = VariablesAllocator()
@@ -106,7 +110,9 @@ class HexDebugger(
 
     private val nextFrame get() = (nextContinuation as? NotDone)?.frame
 
-    private fun getVM(env: CastingEnvironment? = null) = CastingVM(image, env ?: defaultEnv)
+    private fun getVM(env: CastingContext? = null) = CastingHarness(env ?: defaultEnv).apply {
+        applyFunctionalData(image)
+    }
 
     private fun registerNewSource(frame: ContinuationFrame): Source? = getIotas(frame)?.let(::registerNewSource)
 
@@ -343,6 +349,8 @@ class HexDebugger(
 
     fun generateDescs() = getVM().generateDescs()
 
+    fun getClientView() = getClientView(getVM())
+
     private fun getClientView(vm: CastingHarness): ControllerInfo {
         val (stackDescs, parenthesized, ravenmind) = vm.generateDescs()
         val isStackClear = nextContinuation is Done // only close the window if we're done evaluating
@@ -352,15 +360,11 @@ class HexDebugger(
     /**
      * Use [DebugAdapter.evaluate][gay.object.hexdebug.adapter.DebugAdapter.evaluate] instead.
      */
-    internal fun evaluate(env: CastingEnvironment, list: SpellList): DebugStepResult {
+    internal fun evaluate(env: CastingContext, list: SpellList): DebugStepResult {
         val vm = getVM(env)
 
         if (isAtCaughtMishap) {
-            // manually trigger the mishap sound
-            // TODO: this feels scuffed.
-            env.postExecution(
-                CastResult(NullIota(), nextContinuation, null, listOf(), lastResolutionType, HexEvalSounds.MISHAP)
-            )
+            playSound(vm, HexEvalSounds.MISHAP)
             return DebugStepResult(StopReason.EXCEPTION, clientInfo = getClientView(vm))
         }
 
@@ -585,14 +589,7 @@ class HexDebugger(
             }
         }
 
-        sound.sound?.let {
-            vm.ctx.world.playSound(
-                null, vm.ctx.position.x, vm.ctx.position.y, vm.ctx.position.z, it,
-                SoundSource.PLAYERS, 1f, 1f
-            )
-            // TODO: is it worth mixing in to the immut map and making our own game event with blackjack and hookers
-            vm.ctx.world.gameEvent(vm.ctx.caster, GameEvent.ITEM_INTERACT_FINISH, vm.ctx.position)
-        }
+        playSound(vm, sound)
 
         // never show virtual frames above the top of the call stack
         virtualFrames[continuation]?.clear()
@@ -606,6 +603,17 @@ class HexDebugger(
         }.copy(clientInfo = getClientView(vm))
     }
 
+    private fun playSound(vm: CastingHarness, sound: EvalSound) {
+        sound.sound?.let {
+            vm.ctx.world.playSound(
+                null, vm.ctx.position.x, vm.ctx.position.y, vm.ctx.position.z, it,
+                SoundSource.PLAYERS, 1f, 1f
+            )
+            // TODO: is it worth mixing in to the immut map and making our own game event with blackjack and hookers
+            vm.ctx.world.gameEvent(vm.ctx.caster, GameEvent.ITEM_INTERACT_FINISH, vm.ctx.position)
+        }
+    }
+
     // directly copied from CastingHarness
     private fun getOperatorForPattern(iota: Iota, world: ServerLevel): Action? {
         if (iota is PatternIota)
@@ -670,7 +678,7 @@ class HexDebugger(
     }
 
     private fun getStepType(
-        vm: CastingVM,
+        vm: CastingHarness,
         castResult: CastResult,
         continuation: NotDone,
         newContinuation: SpellContinuation,
@@ -793,3 +801,5 @@ enum class RequestStepType {
     OVER,
     OUT,
 }
+
+fun emptyFunctionalData() = FunctionalData(listOf(), 0, listOf(), false, null)
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/items/ItemDebugger.kt b/Common/src/main/kotlin/gay/object/hexdebug/items/ItemDebugger.kt
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/items/ItemEvaluator.kt b/Common/src/main/kotlin/gay/object/hexdebug/items/ItemEvaluator.kt
diff --git a/Common/src/main/resources/hexdebug-common.mixins.json b/Common/src/main/resources/hexdebug-common.mixins.json
diff --git a/gradle.properties b/gradle.properties

Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,5 @@`
`31`	`31`	`"*.jcss.jinja": "jinja-css", // for files with a lot of jinja stuff, where the linting isn't useful`
`32`	`32`	`"*.json5.jinja": "json5",`
`33`	`33`	`},`
	`34`	`+ "kotlin.languageServer.enabled": false,`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`import at.petrak.hexcasting.api.spell.iota.Iota;`
`5`	`5`	`import gay.object.hexdebug.casting.eval.IMixinCastingContext;`
`6`	`6`	`import gay.object.hexdebug.casting.eval.IMixinCastingContextKt;`
	`7`	`+import gay.object.hexdebug.casting.eval.UtilsKt;`
`7`	`8`	`import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory;`
`8`	`9`	`import org.spongepowered.asm.mixin.Final;`
`9`	`10`	`import org.spongepowered.asm.mixin.Mixin;`
`@@ -24,7 +25,7 @@ public class MixinOpPrintSpell {`
`24`	`25`	`var msg = datum.display();`
`25`	`26`	`var debugCastEnv = (IMixinCastingContext) (Object) ctx;`
`26`	`27`	`if (debugCastEnv != null && debugCastEnv.isDebugging$hexdebug()) {`
`27`		`- IMixinCastingContextKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDOUT, true);`
	`28`	`+ UtilsKt.printDebugMessage(ctx.getCaster(), msg, OutputEventArgumentsCategory.STDOUT, true);`
`28`	`29`	`}`
`29`	`30`	`}`
`30`	`31`	`}`