Merge branch 'main' into 1.19

Author: object-Object

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ### Changed
 
+- The Debugger can now be used without VSCode being connected! The next evaluated iota is displayed above the hotbar each time the debugger stops (configurable).
 - A message is now displayed if attempting to use an Evaluator when not debugging, instead of silently failing.
 - Evaluators are now prevented from evaluating patterns after an Uncaught Mishap breakpoint is hit.
 

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

@@ -10,14 +10,15 @@ import at.petrak.hexcasting.api.spell.math.HexPattern
 import at.petrak.hexcasting.common.network.MsgNewSpellPatternAck
 import at.petrak.hexcasting.xplat.IXplatAbstractions
 import gay.`object`.hexdebug.HexDebug
-import gay.`object`.hexdebug.adapter.DebugAdapterState.*
+import gay.`object`.hexdebug.adapter.DebugAdapterState.Debugging
+import gay.`object`.hexdebug.adapter.DebugAdapterState.NotDebugging
 import gay.`object`.hexdebug.adapter.proxy.DebugProxyServerLauncher
 import gay.`object`.hexdebug.debugger.*
 import gay.`object`.hexdebug.items.ItemDebugger
 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.msg.MsgDebuggerStateS2C
+import gay.`object`.hexdebug.networking.msg.MsgEvaluatorStateS2C
+import gay.`object`.hexdebug.networking.msg.MsgPrintDebuggerStatusS2C
 import gay.`object`.hexdebug.utils.futureOf
 import gay.`object`.hexdebug.utils.paginate
 import gay.`object`.hexdebug.utils.toFuture
@@ -36,16 +37,14 @@ import java.util.concurrent.CompletableFuture
 import java.util.concurrent.CompletionException
 
 open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
-    private var state: DebugAdapterState = NotConnected
+    private var state: DebugAdapterState = NotDebugging()
         set(value) {
             field = value
             setDebuggerState(value)
         }
 
     val isDebugging get() = state is Debugging
 
-    val canStartDebugging get() = state is ReadyToDebug
-
     val debugger get() = (state as? Debugging)?.debugger
 
     open val launcher: IHexDebugLauncher by lazy {
@@ -62,7 +61,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     )
 
     protected open fun setDebuggerState(debuggerState: ItemDebugger.DebugState) {
-        HexDebugNetworking.sendToPlayer(player, MsgDebuggerStateS2C(debuggerState))
+        MsgDebuggerStateS2C(debuggerState).sendToPlayer(player)
 
         // close the debugger grid if we stopped debugging
         if (debuggerState == ItemDebugger.DebugState.NOT_DEBUGGING) {
@@ -72,21 +71,29 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     }
 
     protected open fun setEvaluatorState(evalState: ItemEvaluator.EvalState) {
-        HexDebugNetworking.sendToPlayer(player, MsgEvaluatorStateS2C(evalState))
+        MsgEvaluatorStateS2C(evalState).sendToPlayer(player)
+    }
+
+    protected open fun printDebuggerStatus(iota: String, index: Int) {
+        MsgPrintDebuggerStatusS2C(
+            iota = iota,
+            index = index,
+            line = state.initArgs.indexToLine(index),
+            isConnected = state.isConnected,
+        ).sendToPlayer(player)
     }
 
     fun startDebugging(args: CastArgs): Boolean {
-        val state = state as? NotDebugging ?: return false
-        this.state = Debugging(state, args)
-        remoteProxy.initialized()
+        if (state is Debugging) return false
+        val state = Debugging(state, args).also { state = it }
+        handleDebuggerStep(state.debugger.start())
         return true
     }
 
     fun disconnectClient() {
-        if (state !is NotConnected) {
+        if (state.isConnected) {
             remoteProxy.terminated(TerminatedEventArguments())
-
-            state = NotConnected
+            state.isConnected = false
         }
     }
 
@@ -99,11 +106,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             it.category = category
             it.output = value
             if (withSource) {
-                debugger?.lastEvaluatedMetadata?.also { meta ->
-                    it.source = meta.source
-                    it.line = meta.line
-                    if (meta.column != null) it.column = meta.column
-                }
+                it.setSourceAndPosition(state.initArgs, debugger?.lastEvaluatedMetadata)
             }
         })
     }
@@ -123,7 +126,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     fun resetEvaluator() {
         setEvaluatorState(ItemEvaluator.EvalState.DEFAULT)
         if (debugger?.resetEvaluator() == true) {
-            sendStoppedEvent("step")
+            sendStoppedEvent(StopReason.STEP)
         }
     }
 
@@ -146,6 +149,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             IXplatAbstractions.INSTANCE.sendPacketToPlayer(player, MsgNewSpellPatternAck(it, -1))
         }
 
+        // TODO: set nonzero exit code if we hit a mishap
         if (result.isDone) {
             terminate(null)
             return view
@@ -158,14 +162,19 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
             })
         }
 
-        sendStoppedEvent(result.reason.value)
+        sendStoppedEvent(result.reason)
+
+        debugger?.getNextIotaToEvaluate()?.also { (iota, index) ->
+            printDebuggerStatus(iota, index)
+        }
+
         return view
     }
 
-    private fun sendStoppedEvent(reason: String) {
+    private fun sendStoppedEvent(reason: StopReason) {
         remoteProxy.stopped(StoppedEventArguments().also {
             it.threadId = 0
-            it.reason = reason
+            it.reason = reason.value
         })
     }
 
@@ -180,7 +189,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     // initialization
 
     override fun initialize(args: InitializeRequestArguments): CompletableFuture<Capabilities> {
-        state = Initialized(args)
+        state.initArgs = args
         return Capabilities().apply {
             supportsConfigurationDoneRequest = true
             supportsLoadedSourcesRequest = true
@@ -205,8 +214,11 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     }
 
     override fun attach(args: MutableMap<String, Any>): CompletableFuture<Void> {
-        val initArgs = state.initArgs ?: return futureOf()
-        state = NotDebugging(initArgs, LaunchArgs(args))
+        state.apply {
+            isConnected = true
+            launchArgs = LaunchArgs(args)
+        }
+        remoteProxy.initialized()
         player.displayClientMessage(Component.translatable("text.hexdebug.connected"), true)
         return futureOf()
     }
@@ -233,7 +245,7 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
 
     override fun configurationDone(args: ConfigurationDoneArguments?): CompletableFuture<Void> {
         knownPlayers.add(player.uuid)
-        debugger?.start()?.also(::handleDebuggerStep)
+        if (isDebugging) sendStoppedEvent(StopReason.STEP)
         return futureOf()
     }
 
@@ -265,34 +277,28 @@ open class DebugAdapter(val player: ServerPlayer) : IDebugProtocolServer {
     }
 
     override fun restart(args: RestartArguments?): CompletableFuture<Void> {
-        val state = state
-        if (state is ReadyToDebug) {
-            this.state = NotDebugging(state)
-            state.restartArgs?.run(::startDebugging)
-        }
+        state = NotDebugging(state)
+        state.restartArgs?.run(::startDebugging)
         return futureOf()
     }
 
     override fun terminate(args: TerminateArguments?): CompletableFuture<Void> {
-        val state = state
-        if (state is ReadyToDebug) {
-            this.state = NotDebugging(state)
-            remoteProxy.exited(ExitedEventArguments().also { it.exitCode = 0 })
-            if (state is Debugging) {
-                for (source in state.debugger.getSources()) {
-                    remoteProxy.loadedSource(LoadedSourceEventArguments().also {
-                        it.source = source
-                        it.reason = LoadedSourceEventArgumentsReason.REMOVED
-                    })
-                }
+        debugger?.let { debugger ->
+            for (source in debugger.getSources()) {
+                remoteProxy.loadedSource(LoadedSourceEventArguments().also {
+                    it.source = source
+                    it.reason = LoadedSourceEventArgumentsReason.REMOVED
+                })
             }
-            remoteProxy.invalidated(InvalidatedEventArguments())
         }
+        remoteProxy.invalidated(InvalidatedEventArguments())
+        remoteProxy.exited(ExitedEventArguments().also { it.exitCode = 0 })
+        state = NotDebugging(state)
         return futureOf()
     }
 
     override fun disconnect(args: DisconnectArguments?): CompletableFuture<Void> {
-        state = NotConnected
+        state.isConnected = false
         return futureOf()
     }
 

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

@@ -1,39 +1,41 @@
 package gay.`object`.hexdebug.adapter
 
-import gay.`object`.hexdebug.debugger.HexDebugger
 import gay.`object`.hexdebug.debugger.CastArgs
+import gay.`object`.hexdebug.debugger.HexDebugger
 import org.eclipse.lsp4j.debug.InitializeRequestArguments
 
 sealed interface DebugAdapterState {
-    val initArgs: InitializeRequestArguments? get() = null
-
-    object NotConnected : DebugAdapterState
-
-    data class Initialized(override val initArgs: InitializeRequestArguments) : DebugAdapterState
-
-    sealed interface ReadyToDebug : DebugAdapterState {
-        override val initArgs: InitializeRequestArguments
-        val launchArgs: LaunchArgs
-        val restartArgs: CastArgs? get() = null
-    }
+    var isConnected: Boolean
+    var initArgs: InitializeRequestArguments
+    var launchArgs: LaunchArgs
+    val restartArgs: CastArgs?
 
     data class NotDebugging(
-        override val initArgs: InitializeRequestArguments,
-        override val launchArgs: LaunchArgs,
+        override var isConnected: Boolean = false,
+        override var initArgs: InitializeRequestArguments = defaultInitArgs(),
+        override var launchArgs: LaunchArgs = LaunchArgs(),
         override val restartArgs: CastArgs? = null,
-    ) : ReadyToDebug {
-        constructor(state: ReadyToDebug) : this(state.initArgs, state.launchArgs, state.restartArgs)
+    ) : DebugAdapterState {
+        constructor(state: DebugAdapterState) : this(state.isConnected, state.initArgs, state.launchArgs, state.restartArgs)
     }
 
     data class Debugging(
-        override val initArgs: InitializeRequestArguments,
-        override val launchArgs: LaunchArgs,
-        val castArgs: CastArgs,
-    ) : ReadyToDebug {
-        constructor(state: ReadyToDebug, castArgs: CastArgs) : this(state.initArgs, state.launchArgs, castArgs)
-
-        val debugger = HexDebugger(initArgs, launchArgs, castArgs)
-
-        override val restartArgs get() = castArgs
+        override var isConnected: Boolean,
+        override val restartArgs: CastArgs,
+        val debugger: HexDebugger,
+    ) : DebugAdapterState {
+        constructor(state: DebugAdapterState, castArgs: CastArgs) : this(
+            state.isConnected,
+            castArgs,
+            HexDebugger(state.initArgs, state.launchArgs, castArgs),
+        )
+
+        override var initArgs by debugger::initArgs
+        override var launchArgs by debugger::launchArgs
     }
 }
+
+fun defaultInitArgs() = InitializeRequestArguments().apply {
+    linesStartAt1 = true
+    columnsStartAt1 = true
+}

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

@@ -1,6 +1,6 @@
 package gay.`object`.hexdebug.adapter
 
-class LaunchArgs(data: Map<String, Any>) {
+class LaunchArgs(data: Map<String, Any> = mapOf()) {
     val stopOnEntry: Boolean by data.withDefault { true }
     val stopOnExit: Boolean by data.withDefault { false }
     val skipNonEvalFrames: Boolean by data.withDefault { true }

Common/src/main/kotlin/gay/object/hexdebug/adapter/proxy/DebugProxyClient.kt

@@ -4,8 +4,7 @@ import dev.architectury.event.events.client.ClientPlayerEvent
 import gay.`object`.hexdebug.HexDebug
 import gay.`object`.hexdebug.config.HexDebugConfig
 import gay.`object`.hexdebug.items.ItemDebugger
-import gay.`object`.hexdebug.networking.HexDebugNetworking
-import gay.`object`.hexdebug.networking.MsgDebugAdapterProxyC2S
+import gay.`object`.hexdebug.networking.msg.MsgDebugAdapterProxyC2S
 import io.ktor.network.selector.*
 import io.ktor.network.sockets.*
 import io.ktor.utils.io.jvm.javaio.*
@@ -140,7 +139,7 @@ class DebugProxyClientProducer(input: InputStream) : StreamMessageProducer(input
 
             // instead of parsing the message here, just forward it to the server
             val content = String(buffer, charset(headers.charset))
-            HexDebugNetworking.sendToServer(MsgDebugAdapterProxyC2S(content))
+            MsgDebugAdapterProxyC2S(content).sendToServer()
         } catch (exception: Exception) {
             // UnsupportedEncodingException can be thrown by String constructor
             // JsonParseException can be thrown by jsonHandler

Common/src/main/kotlin/gay/object/hexdebug/adapter/proxy/DebugProxyServer.kt

@@ -2,8 +2,7 @@ package gay.`object`.hexdebug.adapter.proxy
 
 import gay.`object`.hexdebug.adapter.DebugAdapter
 import gay.`object`.hexdebug.adapter.IHexDebugLauncher
-import gay.`object`.hexdebug.networking.HexDebugNetworking
-import gay.`object`.hexdebug.networking.MsgDebugAdapterProxyS2C
+import gay.`object`.hexdebug.networking.msg.MsgDebugAdapterProxyS2C
 import net.minecraft.server.level.ServerPlayer
 import org.eclipse.lsp4j.debug.services.IDebugProtocolClient
 import org.eclipse.lsp4j.jsonrpc.*
@@ -106,7 +105,7 @@ class DebugProxyServerConsumer(
     override fun consume(message: Message) {
         try {
             val content = jsonHandler.serialize(message)
-            HexDebugNetworking.sendToPlayer(player, MsgDebugAdapterProxyS2C(content))
+            MsgDebugAdapterProxyS2C(content).sendToPlayer(player)
         } catch (exception: IOException) {
             throw JsonRpcException(exception)
         }

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,
+}