Show better error messages for thread or target out of range, allow pausing with debugger item

Author: object-Object

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

@@ -320,7 +320,7 @@ class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
         isConnected = true
         state.launchArgs = LaunchArgs(args)
         remoteProxy.initialized()
-        player.displayClientMessage(Component.translatable("text.hexdebug.connected"), true)
+        player.displayClientMessage(Component.translatable("text.hexdebug.debugging.connected"), true)
         return futureOf()
     }
 

Common/src/main/kotlin/gay/object/hexdebug/items/DebuggerItem.kt

@@ -111,32 +111,36 @@ class DebuggerItem(
         val debugger = debugAdapter.debugger(threadId)
         if (debugger != null) {
             if (!debugger.debugEnv.isCasterInRange) {
+                player.displayClientMessage("text.hexdebug.debugging.out_of_range".asTranslatedComponent, true)
                 return InteractionResultHolder.fail(stack)
             }
 
-            // TODO: implement pause?
-
-            // step the ongoing debug session
-            debugAdapter.apply {
-                when (getStepMode(stack)) {
-                    StepMode.CONTINUE -> continue_(ContinueArguments().also {
+            val stepMode = getStepMode(stack)
+            if (debugger.state.canPause && stepMode.canPause) {
+                debugAdapter.pause(PauseArguments().also {
+                    it.threadId = threadId
+                })
+            } else {
+                // step the ongoing debug session
+                when (stepMode) {
+                    StepMode.CONTINUE -> debugAdapter.continue_(ContinueArguments().also {
                         it.threadId = threadId
                         it.singleThread = true
                     })
-                    StepMode.OVER -> next(NextArguments().also {
+                    StepMode.OVER -> debugAdapter.next(NextArguments().also {
                         it.threadId = threadId
                         it.singleThread = true
                     })
-                    StepMode.IN -> stepIn(StepInArguments().also {
+                    StepMode.IN -> debugAdapter.stepIn(StepInArguments().also {
                         it.threadId = threadId
                         it.singleThread = true
                     })
-                    StepMode.OUT -> stepOut(StepOutArguments().also {
+                    StepMode.OUT -> debugAdapter.stepOut(StepOutArguments().also {
                         it.threadId = threadId
                         it.singleThread = true
                     })
-                    StepMode.RESTART -> restartThread(threadId)
-                    StepMode.STOP -> terminateThreads(TerminateThreadsArguments().also {
+                    StepMode.RESTART -> debugAdapter.restartThread(threadId)
+                    StepMode.STOP -> debugAdapter.terminateThreads(TerminateThreadsArguments().also {
                         it.threadIds = intArrayOf(threadId)
                     })
                 }
@@ -163,6 +167,7 @@ class DebuggerItem(
             try {
                 debugEnv.start(threadId)
             } catch (_: DebugException) {
+                player.displayClientMessage("text.hexdebug.debugging.illegal_thread".asTranslatedComponent, true)
                 return InteractionResultHolder.fail(stack)
             }
         }
@@ -260,12 +265,12 @@ class DebuggerItem(
         }
     }
 
-    enum class StepMode {
-        CONTINUE,
-        OVER,
-        IN,
-        OUT,
-        RESTART,
-        STOP,
+    enum class StepMode(val canPause: Boolean) {
+        CONTINUE(canPause = true),
+        OVER(canPause = true),
+        IN(canPause = true),
+        OUT(canPause = true),
+        RESTART(canPause = false),
+        STOP(canPause = false),
     }
 }

Common/src/main/kotlin/gay/object/hexdebug/items/EvaluatorItem.kt

@@ -42,7 +42,7 @@ class EvaluatorItem(
         val debugAdapter = DebugAdapterManager[player]
         val debugger = debugAdapter?.debugger(threadId)
         if (debugAdapter == null || debugger == null) {
-            player.displayClientMessage("text.hexdebug.no_session".asTranslatedComponent(threadId), true)
+            player.displayClientMessage("text.hexdebug.debugging.no_session".asTranslatedComponent(threadId), true)
             return InteractionResultHolder.fail(itemStack)
         }
 
@@ -51,7 +51,7 @@ class EvaluatorItem(
         }
 
         if (debugger.state != DebuggerState.PAUSED) {
-            player.displayClientMessage("text.hexdebug.not_paused".asTranslatedComponent(threadId), true)
+            player.displayClientMessage("text.hexdebug.debugging.not_paused".asTranslatedComponent(threadId), true)
             return InteractionResultHolder.fail(itemStack)
         }
 

Common/src/main/kotlin/gay/object/hexdebug/networking/handler/ClientMessageHandler.kt

@@ -63,7 +63,7 @@ fun HexDebugMessageS2C.applyOnClient(ctx: PacketContext) = ctx.queue {
             if (shouldPrint) {
                 ctx.player.displayClientMessage(
                     Component.translatable(
-                        "text.hexdebug.debugger_stopped",
+                        "text.hexdebug.debugging.debugger_stopped",
                         if (config.showDebugClientLineNumber) line else index,
                         iota,
                     ),

Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5

@@ -16,12 +16,17 @@
 
   text: {
     hexdebug: {
-      connected: "Debug client connected!",
-      no_session: "Debug session is not running for thread %d.",
-      not_paused: "Debug session is not paused for thread %d.",
+      debugging: {
+        connected: "Debug client connected!",
+        no_session: "Debug session is not running for thread %d.",
+        not_paused: "Debug session is not paused for thread %d.",
+        // Next Iota: [{index}] {iota}
+        debugger_stopped: "Next Iota: [%d] %s",
+        illegal_thread: "The item failed, somehow... am I not skilled enough?",
+        out_of_range: "Debuggee is out of range.",
+      },
+
       thwack: "Thwack!",
-      // Next Iota: [{index}] {iota}
-      debugger_stopped: "Next Iota: [%d] %s",
 
       splicing_table: {
         button: {