Change where/when postStep is called

Author: object-Object

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

@@ -245,12 +245,8 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             // stopped
             sendStoppedEvent(threadId, result.reason)
 
-            debugger(threadId)?.let { debugger ->
-                debugger.getNextIotaToEvaluate()?.also { (iota, index) ->
-                    printDebuggerStatus(iota, index)
-                }
-
-                debugger.postStep(result.reason)
+            debugger(threadId)?.getNextIotaToEvaluate()?.also { (iota, index) ->
+                printDebuggerStatus(iota, index)
             }
         } else if (wasPaused) {
             // running

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

@@ -13,11 +13,16 @@ data class DebugStepResult(
     val clientInfo: ExecutionClientView? = null,
     val loadedSources: Map<Source, LoadedSourceReason> = mapOf(),
     val startedEvaluating: Boolean = false,
+    val skipped: Boolean = false,
 ) {
     val isDone = reason == StopReason.TERMINATED
 
     fun done() = copy(reason = StopReason.TERMINATED)
 
+    fun resumed() = copy(reason = null)
+
+    fun skipped() = copy(skipped = true)
+
     operator fun plus(other: DebugStepResult) = copy(
         loadedSources = loadedSources + other.loadedSources,
     )

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

@@ -139,10 +139,6 @@ 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)
@@ -362,7 +358,9 @@ class HexDebugger(
         }
 
         nextContinuation = nextContinuation.pushFrame(FrameEvaluate(list, false))
-        return executeNextDebugStep(vm, doStaffMishaps = true).copy(startedEvaluating = startedEvaluating)
+        return executeNextDebugStep(vm, doStaffMishaps = true)
+            .copy(startedEvaluating = startedEvaluating)
+            .also { postStep(vm, it) }
     }
 
     /**
@@ -430,8 +428,11 @@ class HexDebugger(
     }
 
     fun executeUntilStopped(stepType: RequestStepType? = null): DebugStepResult {
-        val vm = getVM() ?: return DebugStepResult(null)
+        val vm = getVM() ?: return DebugStepResult(null, skipped = true)
+        return executeUntilStopped(vm, stepType).also { postStep(vm, it) }
+    }
 
+    private fun executeUntilStopped(vm: CastingVM, stepType: RequestStepType? = null): DebugStepResult {
         lastRequestStepType = stepType
         if (stepType == RequestStepType.IN) return executeNextDebugStep(vm)
 
@@ -500,10 +501,10 @@ class HexDebugger(
     ): DebugStepResult {
         var stepResult = DebugStepResult(StopReason.STEP)
 
-        if (state == DebuggerState.RUNNING) return stepResult.copy(reason = null)
+        if (state == DebuggerState.RUNNING) return stepResult.resumed().skipped()
 
         var continuation = nextContinuation // bind locally so we can do smart casting
-        if (continuation !is NotDone) return stepResult.done()
+        if (continuation !is NotDone) return stepResult.done().skipped()
 
         variablesAllocator.clear()
 
@@ -622,7 +623,7 @@ class HexDebugger(
         return when (continuation) {
             is Done -> if (state.canResume && debugEnv.resume(vm.env, image, lastResolutionType)) {
                 state = DebuggerState.RUNNING
-                stepResult.copy(reason = null)
+                stepResult.resumed()
             } else {
                 // we terminate the debuggee in handleDebuggerStep
                 state = DebuggerState.TERMINATED
@@ -632,6 +633,12 @@ class HexDebugger(
         }.copy(clientInfo = getClientView(vm))
     }
 
+    private fun postStep(vm: CastingVM, result: DebugStepResult) {
+        if (!result.skipped) {
+            debugEnv.postStep(vm.env, image, result.reason)
+        }
+    }
+
     private fun shouldStopAtFrame(continuation: SpellContinuation) =
         continuation !is NotDone || shouldStopAtFrame(continuation.frame)
 

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

@@ -3,6 +3,7 @@
 import at.petrak.hexcasting.api.casting.castables.Action;
 import at.petrak.hexcasting.api.casting.eval.CastingEnvironment;
 import at.petrak.hexcasting.api.casting.eval.ResolvedPatternType;
+import at.petrak.hexcasting.api.casting.eval.env.StaffCastEnv;
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect;
 import at.petrak.hexcasting.api.casting.eval.vm.CastingImage;
 import gay.object.hexdebug.core.api.HexDebugCoreAPI;
@@ -84,13 +85,14 @@ public abstract boolean resume(
     /**
      * 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.
+     * This is called by the debugger after it finishes executing some number of iotas.
+     * {@code reason} is the reason why the debugger stopped at this point, or {@code null} if it
+     * ran out of iotas to execute and {@link DebugEnvironment#resume} returned {@code true}.
      */
     public void postStep(
         @NotNull CastingEnvironment env,
         @NotNull CastingImage image,
-        @NotNull StopReason reason
+        @Nullable StopReason reason
     ) {}
 
     public void printDebugMessage(@NotNull Component message) {

plantuml/debug_api/initialization.puml

@@ -40,9 +40,6 @@ 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

@@ -35,12 +35,12 @@ User ->> Adapter ++: request: step
                 Debuggee2 ->> Debuggee2: start
             return
         return
+
+        Debugger -> DebugEnv ++: ""postStep(env, image, reason)""
+        return
     return stopped on step
 
     Adapter ->> User: event: stopped on step
-
-    Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
-    return
 deactivate Adapter
 
 ...
@@ -52,9 +52,6 @@ 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

@@ -21,12 +21,12 @@ User ->> Adapter ++: request: step forward
                     return
                 end
             return
+
+            Debugger -> DebugEnv ++: ""postStep(env, image, reason)""
+            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
@@ -44,6 +44,9 @@ User ->> Adapter ++: request: step over final iota
         Debugger -> DebugEnv ++: ""resume(env, image, resolutionType)""
             DebugEnv ->> Debuggee ++: unpause
         DebugEnv --> Debugger --: ""true""
+
+        Debugger -> DebugEnv ++: ""postStep(env, image, reason)""
+        return
     Debugger --> Adapter --: resumed
 
     Adapter ->> User: event: continued
@@ -57,11 +60,12 @@ Debuggee -> API ++: ""startDebuggingIotas(...)""
     API -> Adapter ++: start executing
         Adapter -> Debugger ++: start executing
         return stopped on step
+        note right
+            ""postStep"" is not called here
+            because no iotas were executed.
+        end note
 
         Adapter ->> User: event: stopped on step
-
-        Adapter -> DebugEnv ++: ""postStep(env, image, reason)""
-        return
     return
 return
 deactivate Debuggee

plantuml/debug_api/terminating.puml

@@ -15,6 +15,9 @@ User ->> Adapter ++: request: continue
 
         Debugger -> DebugEnv ++: ""resume(env, image, resolutionType)""
         return ""false""
+
+        Debugger -> DebugEnv ++: ""postStep(env, image, reason)""
+        return
     return unable to resume
 
     Adapter ->> User: event: thread exited