Begin working on debug API

Author: object-Object

Common/src/main/java/gay/object/hexdebug/mixin/MixinCastingEnvironment.java

@@ -0,0 +1,26 @@
+package gay.object.hexdebug.mixin;
+
+import at.petrak.hexcasting.api.casting.eval.CastingEnvironment;
+import gay.object.hexdebug.core.api.debugging.DebugEnvironment;
+import gay.object.hexdebug.impl.IDebugEnvAccessor;
+import org.jetbrains.annotations.Nullable;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Unique;
+
+@Mixin(CastingEnvironment.class)
+public abstract class MixinCastingEnvironment implements IDebugEnvAccessor {
+    @Unique
+    @Nullable
+    private DebugEnvironment debugEnv$hexdebug;
+
+    @Override
+    @Nullable
+    public DebugEnvironment getDebugEnv$hexdebug() {
+        return debugEnv$hexdebug;
+    }
+
+    @Override
+    public void setDebugEnv$hexdebug(@Nullable DebugEnvironment debugEnvironment) {
+        debugEnv$hexdebug = debugEnvironment;
+    }
+}

Common/src/main/java/gay/object/hexdebug/mixin/MixinOpEval.java

@@ -7,7 +7,7 @@
 import at.petrak.hexcasting.api.casting.eval.vm.SpellContinuation;
 import at.petrak.hexcasting.api.casting.iota.Iota;
 import at.petrak.hexcasting.common.casting.actions.eval.OpEval;
-import gay.object.hexdebug.casting.eval.IDebugCastEnv;
+import gay.object.hexdebug.core.api.HexDebugCoreAPI;
 import gay.object.hexdebug.core.api.debugging.DebugStepType;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.injection.At;
@@ -27,9 +27,10 @@ private void setDebugStepType(
             Iota iota,
             CallbackInfoReturnable<OperationResult> cir
     ) {
-        if (env instanceof IDebugCastEnv debugCastEnv) {
-            debugCastEnv.setLastEvaluatedAction(this);
-            debugCastEnv.setLastDebugStepType(DebugStepType.IN);
+        var debugEnv = HexDebugCoreAPI.INSTANCE.getDebugEnv(env);
+        if (debugEnv != null) {
+            debugEnv.setLastEvaluatedAction(this);
+            debugEnv.setLastDebugStepType(DebugStepType.IN);
         }
     }
 }

Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapter.kt

@@ -38,6 +38,7 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     private var isConnected = false
     private var lastDebugger: HexDebugger? = null // for resolving sources after exit
     private val debuggers = mutableMapOf<Int, HexDebugger>()
+    private val threadIds = mutableMapOf<UUID, Int>()
     private val restartArgs = mutableMapOf<Int, CastArgs>()
     private val state = SharedDebugState()
 
@@ -49,6 +50,11 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
 
     fun isDebugging(threadId: Int) = debugger(threadId) != null
 
+    fun debugger(sessionId: UUID) =
+        threadIds[sessionId]
+            ?.let(debuggers::get)
+            ?.takeIf { it.sessionId == sessionId }
+
     fun debugger(threadId: Int) = debuggers[threadId]
 
     private fun packId(threadId: Int, reference: Int): Int =
@@ -85,6 +91,7 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
         val debugger = HexDebugger(threadId, state, args)
         lastDebugger = debugger
         debuggers[threadId] = debugger
+        threadIds[args.debugEnv.sessionId] = threadId
         restartArgs[threadId] = args
 
         remoteProxy.thread(ThreadEventArguments().also {
@@ -109,16 +116,17 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     }
 
     fun print(
-        threadId: Int,
+        sessionId: UUID,
         value: String,
         category: String = OutputEventArgumentsCategory.STDOUT,
         withSource: Boolean = true,
     ) {
+        val debugger = debugger(sessionId) ?: return
         remoteProxy.output(OutputEventArguments().also {
             it.category = category
             it.output = value
             if (withSource) {
-                it.setSourceAndPosition(state.initArgs, debugger(threadId)?.lastEvaluatedMetadata)
+                it.setSourceAndPosition(state.initArgs, debugger.lastEvaluatedMetadata)
             }
         })
     }
@@ -187,10 +195,18 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             })
         }
 
-        sendStoppedEvent(threadId, result.reason)
+        if (result.reason != null) {
+            // stopped
+            sendStoppedEvent(threadId, result.reason)
 
-        debugger(threadId)?.getNextIotaToEvaluate()?.also { (iota, index) ->
-            printDebuggerStatus(iota, index)
+            debugger(threadId)?.getNextIotaToEvaluate()?.also { (iota, index) ->
+                printDebuggerStatus(iota, index)
+            }
+        } else {
+            // running
+            remoteProxy.continued(ContinuedEventArguments().also {
+                it.threadId = threadId
+            })
         }
 
         return view
@@ -356,6 +372,7 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
 
     override fun restart(args: RestartArguments?): CompletableFuture<Void> {
         debuggers.clear()
+        threadIds.clear()
 
         for ((threadId, castArgs) in restartArgs) {
             startDebugging(threadId, castArgs, false)
@@ -378,7 +395,7 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
                 it.reason = ThreadEventArgumentsReason.EXITED
                 it.threadId = threadId
             })
-            debuggers.remove(threadId)
+            debuggers.remove(threadId)?.let { threadIds.remove(it.sessionId) }
         }
 
         MsgDebuggerStateS2C(

Common/src/main/kotlin/gay/object/hexdebug/casting/actions/OpIsDebugging.kt

@@ -4,13 +4,11 @@ import at.petrak.hexcasting.api.casting.asActionResult
 import at.petrak.hexcasting.api.casting.castables.ConstMediaAction
 import at.petrak.hexcasting.api.casting.eval.CastingEnvironment
 import at.petrak.hexcasting.api.casting.iota.Iota
-import gay.`object`.hexdebug.casting.eval.IDebugCastEnv
+import gay.`object`.hexdebug.core.api.HexDebugCoreAPI
 
 object OpIsDebugging : ConstMediaAction {
     override val argc = 0
 
-    override fun execute(args: List<Iota>, env: CastingEnvironment) = when (env) {
-        is IDebugCastEnv -> env.isDebugging
-        else -> false
-    }.asActionResult
+    override fun execute(args: List<Iota>, env: CastingEnvironment) =
+        (HexDebugCoreAPI.INSTANCE.getDebugEnv(env) != null).asActionResult
 }

Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebuggerCastEnv.kt

@@ -1,9 +1,8 @@
 package gay.`object`.hexdebug.casting.eval
 
-import at.petrak.hexcasting.api.casting.castables.Action
 import at.petrak.hexcasting.api.casting.eval.env.PackagedItemCastEnv
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect
-import gay.`object`.hexdebug.core.api.debugging.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.IDebuggableCastEnv
 import gay.`object`.hexdebug.utils.findMediaHolderInHand
 import gay.`object`.hexdebug.utils.otherHand
 import net.minecraft.network.chat.Component
@@ -13,22 +12,17 @@ import net.minecraft.world.InteractionHand
 class DebuggerCastEnv(
     caster: ServerPlayer,
     castingHand: InteractionHand,
-) : PackagedItemCastEnv(caster, castingHand), IDebugCastEnv {
+) : PackagedItemCastEnv(caster, castingHand), IDebuggableCastEnv {
     private val item = caster.getItemInHand(castingHand).item
 
-    override var threadId: Int? = null
-
-    override var lastEvaluatedAction: Action? = null
-    override var lastDebugStepType: DebugStepType? = null
-
     override fun printMessage(message: Component) {
         super.printMessage(message)
-        printDebugMessage(caster, message)
+        debugEnv?.printDebugMessage(message)
     }
 
     override fun sendMishapMsgToPlayer(mishap: OperatorSideEffect.DoMishap) {
         super.sendMishapMsgToPlayer(mishap)
-        printDebugMishap(this, caster, mishap)
+        debugEnv?.printDebugMishap(this, mishap)
     }
 
     override fun extractMediaEnvironment(cost: Long, simulate: Boolean): Long {

Common/src/main/kotlin/gay/object/hexdebug/casting/eval/EvaluatorCastEnv.kt

@@ -1,29 +1,23 @@
 package gay.`object`.hexdebug.casting.eval
 
-import at.petrak.hexcasting.api.casting.castables.Action
 import at.petrak.hexcasting.api.casting.eval.env.StaffCastEnv
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect
-import gay.`object`.hexdebug.core.api.debugging.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.IDebuggableCastEnv
 import net.minecraft.network.chat.Component
 import net.minecraft.server.level.ServerPlayer
 import net.minecraft.world.InteractionHand
 
 class EvaluatorCastEnv(
     caster: ServerPlayer,
     castingHand: InteractionHand,
-) : StaffCastEnv(caster, castingHand), IDebugCastEnv {
-    override var threadId: Int? = null
-
-    override var lastEvaluatedAction: Action? = null
-    override var lastDebugStepType: DebugStepType? = null
-
+) : StaffCastEnv(caster, castingHand), IDebuggableCastEnv {
     override fun printMessage(message: Component) {
         super.printMessage(message)
-        printDebugMessage(caster, message)
+        debugEnv?.printDebugMessage(message)
     }
 
     override fun sendMishapMsgToPlayer(mishap: OperatorSideEffect.DoMishap) {
         super.sendMishapMsgToPlayer(mishap)
-        printDebugMishap(this, caster, mishap)
+        debugEnv?.printDebugMishap(this, mishap)
     }
 }

Common/src/main/kotlin/gay/object/hexdebug/casting/eval/IDebugCastEnv.kt

@@ -2,10 +2,12 @@ package gay.`object`.hexdebug.debugger
 
 import at.petrak.hexcasting.api.casting.eval.CastingEnvironment
 import at.petrak.hexcasting.api.casting.iota.Iota
+import gay.`object`.hexdebug.core.api.debugging.DebugEnvironment
 import net.minecraft.server.level.ServerLevel
 
 data class CastArgs(
     val iotas: List<Iota>,
+    val debugEnv: DebugEnvironment,
     val env: CastingEnvironment,
     val world: ServerLevel,
     val onExecute: ((Iota) -> Unit)? = null,

Common/src/main/kotlin/gay/object/hexdebug/debugger/CastArgs.kt

@@ -6,7 +6,8 @@ import org.eclipse.lsp4j.debug.Source
 import org.eclipse.lsp4j.debug.LoadedSourceEventArgumentsReason as LoadedSourceReason
 
 data class DebugStepResult(
-    val reason: StopReason,
+    /** If null, the debuggee has continued instead of stopping.  */
+    val reason: StopReason?,
     val type: DebugStepType? = null,
     val clientInfo: ExecutionClientView? = null,
     val loadedSources: Map<Source, LoadedSourceReason> = mapOf(),