Print next iota on debugger step

object-Object · object-Object · commit 8d10f5c2f64a · 2024-05-27T17:24:45.000-04:00
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapter.kt b/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapter.kt
@@ -19,6 +19,7 @@ import gay.`object`.hexdebug.items.ItemEvaluator
 import gay.`object`.hexdebug.networking.HexDebugNetworking
 import gay.`object`.hexdebug.networking.MsgDebuggerStateS2C
 import gay.`object`.hexdebug.networking.MsgEvaluatorStateS2C
+import gay.`object`.hexdebug.networking.MsgPrintDebuggerStatusS2C
 import gay.`object`.hexdebug.utils.futureOf
 import gay.`object`.hexdebug.utils.paginate
 import gay.`object`.hexdebug.utils.toFuture
@@ -74,11 +75,21 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
         HexDebugNetworking.sendToPlayer(player, MsgEvaluatorStateS2C(evalState))
     }
 
+    protected open fun printDebuggerStatus(iota: String, index: Int) {
+        HexDebugNetworking.sendToPlayer(
+            player, MsgPrintDebuggerStatusS2C(
+                iota = iota,
+                index = index,
+                line = state.initArgs.indexToLine(index),
+                isConnected = state.isConnected,
+            )
+        )
+    }
+
     fun startDebugging(args: CastArgs): Boolean {
         if (state is Debugging) return false
-        state = Debugging(state, args).also {
-            handleDebuggerStep(it.debugger.start())
-        }
+        val state = Debugging(state, args).also { state = it }
+        handleDebuggerStep(state.debugger.start())
         return true
     }
 
@@ -155,6 +166,11 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
         }
 
         sendStoppedEvent(result.reason)
+
+        debugger?.getNextIotaToEvaluate()?.also { (iota, index) ->
+            printDebuggerStatus(iota, index)
+        }
+
         return view
     }
 
@@ -201,7 +217,10 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     }
 
     override fun attach(args: MutableMap<String, Any>): CompletableFuture<Void> {
-        state.launchArgs = LaunchArgs(args)
+        state.apply {
+            isConnected = true
+            launchArgs = LaunchArgs(args)
+        }
         remoteProxy.initialized()
         player.displayClientMessage(Component.translatable("text.hexdebug.connected"), true)
         return futureOf()
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapterState.kt b/Common/src/main/kotlin/gay/object/hexdebug/adapter/DebugAdapterState.kt
@@ -12,7 +12,7 @@ sealed interface DebugAdapterState {
 
     data class NotDebugging(
         override var isConnected: Boolean = false,
-        override var initArgs: InitializeRequestArguments = InitializeRequestArguments(),
+        override var initArgs: InitializeRequestArguments = defaultInitArgs(),
         override var launchArgs: LaunchArgs = LaunchArgs(),
         override val restartArgs: CastArgs? = null,
     ) : DebugAdapterState {
@@ -34,3 +34,8 @@ sealed interface DebugAdapterState {
         override var launchArgs by debugger::launchArgs
     }
 }
+
+fun defaultInitArgs() = InitializeRequestArguments().apply {
+    linesStartAt1 = true
+    columnsStartAt1 = true
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugConfig.kt b/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugConfig.kt
@@ -46,5 +46,17 @@ object HexDebugConfig {
 
         @Tooltip
         val smartDebuggerSneakScroll: Boolean = true
+
+        @Tooltip
+        val debuggerDisplayMode: DebuggerDisplayMode = DebuggerDisplayMode.ENABLED
+
+        @Tooltip
+        val showDebugClientLineNumber: Boolean = false
     }
 }
+
+enum class DebuggerDisplayMode {
+    DISABLED,
+    NOT_CONNECTED,
+    ENABLED,
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt
@@ -56,7 +56,8 @@ class HexDebugger(
     private val sourceAllocator = SourceAllocator(iotas.hashCode())
 
     private val iotaMetadata = IdentityHashMap<Iota, IotaMetadata>()
-    private val frameInvocationMetadata = IdentityHashMap<SpellContinuation, () -> IotaMetadata?>()
+    // FIXME: this is really terrible and gross and i don't like it
+    private val frameInvocationMetadata = IdentityHashMap<SpellContinuation, () -> Pair<Iota, IotaMetadata?>?>()
     private val virtualFrames = IdentityHashMap<SpellContinuation, MutableList<StackFrame>>()
 
     private val breakpoints = mutableMapOf<Int, MutableMap<Int, SourceBreakpointMode>>() // source id -> line number
@@ -93,7 +94,7 @@ class HexDebugger(
                     }
                     pushFrame(FrameBreakpoint(stopBefore = true)).also { newCont ->
                         frameInvocationMetadata[newCont] = {
-                            lastIota?.let { iotaMetadata[it] }?.copy(columnIndex = columnIndex)
+                            lastIota?.let { it to iotaMetadata[it]?.copy(columnIndex = columnIndex) }
                         }
                     }
                 } else this
@@ -124,15 +125,15 @@ class HexDebugger(
         else -> null
     }
 
-    private fun getFirstIotaMetadata(continuation: NotDone): IotaMetadata? =
+    private fun getFirstIotaMetadata(continuation: NotDone): Pair<Iota, IotaMetadata?>? =
         // for FrameEvaluate, show the next iota to be evaluated (if any)
         (continuation.frame as? FrameEvaluate)?.let(::getFirstIotaMetadata)
         // for everything else, show the caller if we have it
         ?: frameInvocationMetadata[continuation]?.invoke()
         // otherwise show the first contained iota
         ?: getFirstIotaMetadata(continuation.frame)
 
-    private fun getFirstIotaMetadata(frame: ContinuationFrame) = getIotas(frame)?.let { iotaMetadata[it.car] }
+    private fun getFirstIotaMetadata(frame: ContinuationFrame) = getIotas(frame)?.let { it.car to iotaMetadata[it.car] }
 
     // current continuation is last
     private fun getCallStack(current: SpellContinuation) = generateSequence(current as? NotDone) {
@@ -142,6 +143,13 @@ class HexDebugger(
         }
     }.toList().asReversed()
 
+    /** (iota, index) */
+    fun getNextIotaToEvaluate(): Pair<String, Int>? {
+        val continuation = nextContinuation as? NotDone ?: return null
+        val (iota, meta) = getFirstIotaMetadata(continuation) ?: return null
+        return iotaToString(iota, isSource = false) to (meta?.lineIndex ?: -1)
+    }
+
     fun getStackFrames(): Sequence<StackFrame> {
         var frameId = 1
         var virtualFrameId = (callStack.size + 1).ceilToPow(10)
@@ -150,7 +158,7 @@ class HexDebugger(
                 StackFrame().apply {
                     id = frameId++
                     name = "[$id] ${continuation.frame.name}"
-                    setSourceAndPosition(initArgs, getFirstIotaMetadata(continuation))
+                    setSourceAndPosition(initArgs, getFirstIotaMetadata(continuation)?.second)
                 }
             ) + virtualFrames[continuation]?.map {
                 it.apply {
@@ -549,7 +557,7 @@ class HexDebugger(
                 // insert a virtual FrameFinishEval if OpEval didn't (ie. if we did a TCO)
                 if (launchArgs.showTailCallFrames && vm.debugCastEnv.lastEvaluatedAction is OpEval) {
                     val invokeMeta = iotaMetadata[castResult.cast]
-                    val nextInvokeMeta = frameInvocationMetadata[newContinuation.next]?.invoke()
+                    val nextInvokeMeta = frameInvocationMetadata[newContinuation.next]?.invoke()?.second
                     if (invokeMeta != null && invokeMeta != nextInvokeMeta) {
                         virtualFrames.getOrPut(continuation.next) { mutableListOf() }.add(
                             StackFrame().apply {
@@ -712,7 +720,7 @@ class HexDebugger(
 
     private fun trySetIotaOverride(continuation: SpellContinuation, castResult: CastResult): Boolean {
         return if (continuation !in frameInvocationMetadata && continuation is NotDone) {
-            frameInvocationMetadata[continuation] = { iotaMetadata[castResult.cast] }
+            frameInvocationMetadata[continuation] = { castResult.cast to iotaMetadata[castResult.cast] }
             true
         } else false
     }
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/networking/HexDebugNetworking.kt b/Common/src/main/kotlin/gay/object/hexdebug/networking/HexDebugNetworking.kt
@@ -13,6 +13,7 @@ object HexDebugNetworking {
         CHANNEL.register(MsgDebugAdapterProxyS2C::class.java, MsgDebugAdapterProxyS2C::encode, ::MsgDebugAdapterProxyS2C, MsgDebugAdapterProxyS2C::apply)
         CHANNEL.register(MsgDebuggerStateS2C::class.java, MsgDebuggerStateS2C::encode, ::MsgDebuggerStateS2C, MsgDebuggerStateS2C::apply)
         CHANNEL.register(MsgEvaluatorStateS2C::class.java, MsgEvaluatorStateS2C::encode, ::MsgEvaluatorStateS2C, MsgEvaluatorStateS2C::apply)
+        CHANNEL.register(MsgPrintDebuggerStatusS2C::class.java, MsgPrintDebuggerStatusS2C::encode, ::MsgPrintDebuggerStatusS2C, MsgPrintDebuggerStatusS2C::apply)
     }
 
     fun <T> sendToServer(message: T) = CHANNEL.sendToServer(message)
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/networking/MsgPrintDebuggerStatusS2C.kt b/Common/src/main/kotlin/gay/object/hexdebug/networking/MsgPrintDebuggerStatusS2C.kt
@@ -0,0 +1,55 @@
+package gay.`object`.hexdebug.networking
+
+import dev.architectury.networking.NetworkManager.PacketContext
+import gay.`object`.hexdebug.HexDebug
+import gay.`object`.hexdebug.config.DebuggerDisplayMode
+import gay.`object`.hexdebug.config.HexDebugConfig
+import net.minecraft.network.FriendlyByteBuf
+import net.minecraft.network.chat.Component
+import java.util.function.Supplier
+
+// we need a message for this because the client config isn't available on the server
+data class MsgPrintDebuggerStatusS2C(
+    val iota: String,
+    val index: Int,
+    val line: Int,
+    val isConnected: Boolean,
+) {
+    constructor(buf: FriendlyByteBuf) : this(
+        buf.readUtf(),
+        buf.readInt(),
+        buf.readInt(),
+        buf.readBoolean(),
+    )
+
+    fun encode(buf: FriendlyByteBuf) {
+        buf.writeUtf(iota)
+        buf.writeInt(index)
+        buf.writeInt(line)
+        buf.writeBoolean(isConnected)
+    }
+
+    fun apply(supplier: Supplier<PacketContext>) = supplier.get().also { ctx ->
+        ctx.queue {
+            HexDebug.LOGGER.debug("Client received packet: {}", this)
+
+            val config = HexDebugConfig.get().client
+            val shouldPrint = when (config.debuggerDisplayMode) {
+                DebuggerDisplayMode.DISABLED -> false
+                DebuggerDisplayMode.NOT_CONNECTED -> !isConnected
+                DebuggerDisplayMode.ENABLED -> true
+            }
+
+            if (shouldPrint) {
+                ctx.player.displayClientMessage(
+                    Component.translatable(
+                        "text.hexdebug.debugger_stopped",
+                        if (config.showDebugClientLineNumber) line else index,
+                        iota,
+                    ),
+                    true,
+                )
+            }
+        }
+    }
+}
diff --git a/Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5 b/Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5
@@ -11,6 +11,8 @@
       connected: "Debug client connected!",
       no_session: "Debug session is not running.",
       thwack: "Thwack!",
+      // Next Iota: [{index}] {iota}
+      debugger_stopped: "Next Iota: [%d] %s",
     },
 
     "autoconfig.hexdebug": {
@@ -32,6 +34,18 @@
             "": "Smart Debugger Sneak-Scroll",
             "@Tooltip": "If a hex is not currently being debugged and a Debugger is in your main hand, prefer shift-scrolling whatever item is in your offhand (eg. a spellbook).",
           },
+          debuggerDisplayMode: {
+            "": "Debugger Display Mode",
+            "@Tooltip": "\
+              Changes when the Debugger should print the next iota to be evaluated.\n\
+                DISABLED: Never show Debugger status messages.\n\
+                NOT_CONNECTED: Only show Debugger status messages if a debug client is not connected.\n\
+                ENABLED: Always show Debugger status messages. (default)",
+          },
+          showDebugClientLineNumber: {
+            "": "Show Debug Client Line Number",
+            "@Tooltip": "If true, show the line number (usually 1-indexed) from the debug client (eg. VSCode) in Debugger status messages; otherwise, show the list index (0-indexed)."
+          }
         },
       },
     },

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ object HexDebugNetworking {`
`13`	`13`	`CHANNEL.register(MsgDebugAdapterProxyS2C::class.java, MsgDebugAdapterProxyS2C::encode, ::MsgDebugAdapterProxyS2C, MsgDebugAdapterProxyS2C::apply)`
`14`	`14`	`CHANNEL.register(MsgDebuggerStateS2C::class.java, MsgDebuggerStateS2C::encode, ::MsgDebuggerStateS2C, MsgDebuggerStateS2C::apply)`
`15`	`15`	`CHANNEL.register(MsgEvaluatorStateS2C::class.java, MsgEvaluatorStateS2C::encode, ::MsgEvaluatorStateS2C, MsgEvaluatorStateS2C::apply)`
	`16`	`+ CHANNEL.register(MsgPrintDebuggerStatusS2C::class.java, MsgPrintDebuggerStatusS2C::encode, ::MsgPrintDebuggerStatusS2C, MsgPrintDebuggerStatusS2C::apply)`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`fun <T> sendToServer(message: T) = CHANNEL.sendToServer(message)`