Add DebugEnvironment.postStep

Author: object-Object

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

@@ -11,6 +11,7 @@ import at.petrak.hexcasting.api.casting.math.HexPattern
 import gay.`object`.hexdebug.HexDebug
 import gay.`object`.hexdebug.adapter.proxy.DebugProxyServerLauncher
 import gay.`object`.hexdebug.config.HexDebugServerConfig
+import gay.`object`.hexdebug.core.api.debugging.StopReason
 import gay.`object`.hexdebug.core.api.debugging.env.DebugEnvironment
 import gay.`object`.hexdebug.core.api.exceptions.IllegalDebugSessionException
 import gay.`object`.hexdebug.core.api.exceptions.IllegalDebugThreadException
@@ -244,8 +245,12 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             // stopped
             sendStoppedEvent(threadId, result.reason)
 
-            debugger(threadId)?.getNextIotaToEvaluate()?.also { (iota, index) ->
-                printDebuggerStatus(iota, index)
+            debugger(threadId)?.let { debugger ->
+                debugger.getNextIotaToEvaluate()?.also { (iota, index) ->
+                    printDebuggerStatus(iota, index)
+                }
+
+                debugger.postStep(result.reason)
             }
         } else if (wasPaused) {
             // running
@@ -260,10 +265,18 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     private fun sendStoppedEvent(threadId: Int?, reason: StopReason) {
         if (threadId == null) {
             debuggers.keys.forEach { sendStoppedEvent(it, reason) }
-        } else if (reason.value != null) {
+        } else {
+            val reasonStr = when (reason) {
+                StopReason.STEP -> StoppedEventArgumentsReason.STEP
+                StopReason.PAUSE -> StoppedEventArgumentsReason.PAUSE
+                StopReason.BREAKPOINT -> StoppedEventArgumentsReason.BREAKPOINT
+                StopReason.EXCEPTION -> StoppedEventArgumentsReason.EXCEPTION
+                StopReason.STARTED -> StoppedEventArgumentsReason.ENTRY
+                StopReason.TERMINATED -> return
+            }
             remoteProxy.stopped(StoppedEventArguments().also {
                 it.threadId = threadId
-                it.reason = reason.value
+                it.reason = reasonStr
             })
         }
     }

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

@@ -2,6 +2,7 @@ package gay.`object`.hexdebug.debugger
 
 import at.petrak.hexcasting.api.casting.eval.ExecutionClientView
 import gay.`object`.hexdebug.core.api.debugging.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.StopReason
 import org.eclipse.lsp4j.debug.Source
 import org.eclipse.lsp4j.debug.LoadedSourceEventArgumentsReason as LoadedSourceReason
 

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

@@ -1,7 +1,5 @@
 package gay.`object`.hexdebug.debugger
 
-import org.eclipse.lsp4j.debug.StoppedEventArgumentsReason
-
 enum class DebuggerState(val canPause: Boolean = false, val canResume: Boolean = false) {
     RUNNING(canPause = true),
     PAUSING(canPause = true),
@@ -10,15 +8,6 @@ enum class DebuggerState(val canPause: Boolean = false, val canResume: Boolean =
     TERMINATED,
 }
 
-enum class StopReason(val value: String?, val stopImmediately: Boolean) {
-    STEP(StoppedEventArgumentsReason.STEP, false),
-    PAUSE(StoppedEventArgumentsReason.PAUSE, true),
-    BREAKPOINT(StoppedEventArgumentsReason.BREAKPOINT, true),
-    EXCEPTION(StoppedEventArgumentsReason.EXCEPTION, true),
-    STARTED(StoppedEventArgumentsReason.ENTRY, true),
-    TERMINATED(null, true),
-}
-
 enum class SourceBreakpointMode(val label: String, val description: String) {
     EVALUATED("Evaluated", "Stop if this iota would be evaluated. (default)"),
     ESCAPED("Escaped", "Stop if this iota would be escaped."),

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

@@ -15,8 +15,9 @@ import at.petrak.hexcasting.common.casting.actions.eval.OpEval
 import at.petrak.hexcasting.common.lib.hex.HexEvalSounds
 import gay.`object`.hexdebug.casting.eval.FrameBreakpoint
 import gay.`object`.hexdebug.casting.iotas.CognitohazardIota
-import gay.`object`.hexdebug.core.api.debugging.env.DebugEnvironment
 import gay.`object`.hexdebug.core.api.debugging.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.StopReason
+import gay.`object`.hexdebug.core.api.debugging.env.DebugEnvironment
 import gay.`object`.hexdebug.debugger.allocators.VariablesAllocator
 import gay.`object`.hexdebug.impl.IDebugEnvAccessor
 import gay.`object`.hexdebug.utils.ceilToPow
@@ -138,6 +139,10 @@ class HexDebugger(
         return iotaToString(iota, isSource = false) to (meta?.lineIndex ?: -1)
     }
 
+    fun postStep(reason: StopReason) {
+        currentEnv?.let { debugEnv.postStep(it, image, reason) }
+    }
+
     fun getStackFrames(): Sequence<StackFrame> {
         var frameId = 1
         var virtualFrameId = (callStack.size + 1).ceilToPow(10)

Core/Common/src/main/java/gay/object/hexdebug/core/api/debugging/StopReason.java

@@ -0,0 +1,16 @@
+package gay.object.hexdebug.core.api.debugging;
+
+public enum StopReason {
+    STEP(false),
+    PAUSE(true),
+    BREAKPOINT(true),
+    EXCEPTION(true),
+    STARTED(true),
+    TERMINATED(true);
+
+    public final boolean stopImmediately;
+
+    StopReason(boolean stopImmediately) {
+        this.stopImmediately = stopImmediately;
+    }
+}

Core/Common/src/main/java/gay/object/hexdebug/core/api/debugging/env/DebugEnvironment.java

@@ -8,6 +8,7 @@
 import gay.object.hexdebug.core.api.HexDebugCoreAPI;
 import gay.object.hexdebug.core.api.debugging.DebugOutputCategory;
 import gay.object.hexdebug.core.api.debugging.DebugStepType;
+import gay.object.hexdebug.core.api.debugging.StopReason;
 import net.minecraft.network.chat.Component;
 import net.minecraft.server.level.ServerPlayer;
 import org.jetbrains.annotations.ApiStatus;
@@ -80,6 +81,18 @@ public abstract boolean resume(
     @NotNull
     public abstract Component getName();
 
+    /**
+     * Do whatever you like after each debugger step.
+     * <br>
+     * Called by the debugger after an execution step is finished, unless the debug session was
+     * resumed or terminated as a result of the step.
+     */
+    public void postStep(
+        @NotNull CastingEnvironment env,
+        @NotNull CastingImage image,
+        @NotNull StopReason reason
+    ) {}
+
     public void printDebugMessage(@NotNull Component message) {
         printDebugMessage(message, DebugOutputCategory.STDOUT, true);
     }

plantuml/debug_api/initialization.puml

@@ -40,6 +40,9 @@ activate Debuggee
             return stopped on entry
 
             Adapter ->> User: event: stopped on entry
+
+            Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
+            return
         return
     return
 deactivate Debuggee

plantuml/debug_api/nested.puml

@@ -38,6 +38,9 @@ User ->> Adapter ++: request: step
     return stopped on step
 
     Adapter ->> User: event: stopped on step
+
+    Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
+    return
 deactivate Adapter
 
 ...
@@ -49,6 +52,9 @@ Debuggee2 -> Debuggee2 ++: pause
             return stopped on entry
 
             Adapter ->> User: event: stopped on entry
+
+            Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
+            return
         return
     return
 deactivate Debuggee2

plantuml/debug_api/stepping.puml

@@ -22,7 +22,11 @@ User ->> Adapter ++: request: step forward
                 end
             return
         return stopped on step
+
         Adapter ->> User: event: stopped on step
+
+        Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
+        return
     else caster out of range
         Adapter ->> User: error: out of range
     end
@@ -55,6 +59,9 @@ Debuggee -> API ++: ""startDebuggingIotas(...)""
         return stopped on step
 
         Adapter ->> User: event: stopped on step
+
+        Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
+        return
     return
 return
 deactivate Debuggee