Refactor networking classes to make registration less scuffed

Author: object-Object

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

@@ -16,10 +16,9 @@ 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.MsgPrintDebuggerStatusS2C
+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
@@ -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,18 +71,16 @@ 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) {
-        HexDebugNetworking.sendToPlayer(
-            player, MsgPrintDebuggerStatusS2C(
-                iota = iota,
-                index = index,
-                line = state.initArgs.indexToLine(index),
-                isConnected = state.isConnected,
-            )
-        )
+        MsgPrintDebuggerStatusS2C(
+            iota = iota,
+            index = index,
+            line = state.initArgs.indexToLine(index),
+            isConnected = state.isConnected,
+        ).sendToPlayer(player)
     }
 
     fun startDebugging(args: CastArgs): Boolean {

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/networking/HexDebugMessage.kt

@@ -0,0 +1,13 @@
+package gay.`object`.hexdebug.networking
+
+import net.minecraft.server.level.ServerPlayer
+
+interface HexDebugMessage
+
+interface HexDebugMessageC2S : HexDebugMessage {
+    fun sendToServer() = HexDebugNetworking.sendToServer(this)
+}
+
+interface HexDebugMessageS2C : HexDebugMessage {
+    fun sendToPlayer(player: ServerPlayer) = HexDebugNetworking.sendToPlayer(player, this)
+}

Common/src/main/kotlin/gay/object/hexdebug/networking/HexDebugMessageCompanion.kt

@@ -0,0 +1,48 @@
+package gay.`object`.hexdebug.networking
+
+import dev.architectury.networking.NetworkChannel
+import dev.architectury.networking.NetworkManager.PacketContext
+import gay.`object`.hexdebug.HexDebug
+import net.minecraft.network.FriendlyByteBuf
+import java.util.function.Supplier
+
+interface HexDebugMessageCompanion<T : HexDebugMessage> {
+    val type: Class<T>
+
+    fun decode(buf: FriendlyByteBuf): T
+
+    fun T.encode(buf: FriendlyByteBuf)
+
+    fun register(channel: NetworkChannel)
+
+    fun register(channel: NetworkChannel, apply: (T, Supplier<PacketContext>) -> Unit) {
+        channel.register(type, { msg, buf -> msg.encode(buf) }, ::decode, apply)
+    }
+}
+
+interface HexDebugMessageCompanionC2S<T : HexDebugMessageC2S> : HexDebugMessageCompanion<T> {
+    fun T.applyOnServer(ctx: PacketContext)
+
+    fun applyOnServer(msg: T, supplier: Supplier<PacketContext>) {
+        HexDebug.LOGGER.debug("Client received packet: {}", this)
+        msg.applyOnServer(supplier.get())
+    }
+
+    override fun register(channel: NetworkChannel) {
+        register(channel, ::applyOnServer)
+    }
+}
+
+interface HexDebugMessageCompanionS2C<T : HexDebugMessageS2C> : HexDebugMessageCompanion<T> {
+    fun T.applyOnClient(ctx: PacketContext)
+
+    fun applyOnClient(msg: T, supplier: Supplier<PacketContext>) {
+        val ctx = supplier.get()
+        HexDebug.LOGGER.debug("Server received packet from {}: {}", ctx.player.name.string, this)
+        msg.applyOnClient(ctx)
+    }
+
+    override fun register(channel: NetworkChannel) {
+        register(channel, ::applyOnClient)
+    }
+}

Common/src/main/kotlin/gay/object/hexdebug/networking/HexDebugNetworking.kt

@@ -2,18 +2,23 @@ package gay.`object`.hexdebug.networking
 
 import dev.architectury.networking.NetworkChannel
 import gay.`object`.hexdebug.HexDebug
+import gay.`object`.hexdebug.networking.msg.*
 import net.minecraft.server.level.ServerPlayer
 
 object HexDebugNetworking {
     private val CHANNEL = NetworkChannel.create(HexDebug.id("networking_channel"))
 
     fun init() {
-        // FIXME: gross.
-        CHANNEL.register(MsgDebugAdapterProxyC2S::class.java, MsgDebugAdapterProxyC2S::encode, ::MsgDebugAdapterProxyC2S, MsgDebugAdapterProxyC2S::apply)
-        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)
+        val messages = listOf(
+            MsgDebugAdapterProxyC2S,
+            MsgDebugAdapterProxyS2C,
+            MsgDebuggerStateS2C,
+            MsgEvaluatorStateS2C,
+            MsgPrintDebuggerStatusS2C,
+        )
+        for (message in messages) {
+            message.register(CHANNEL)
+        }
     }
 
     fun <T> sendToServer(message: T) = CHANNEL.sendToServer(message)