Create Core subproject and move DebugStepType into it

object-Object · object-Object · commit d3a8e06750a1 · 2025-10-15T22:07:11.000-04:00
diff --git a/Common/build.gradle.kts b/Common/build.gradle.kts
@@ -1,5 +1,3 @@
-import hexdebug.libs
-
 plugins {
     id("hexdebug.conventions.architectury")
 }
@@ -33,4 +31,6 @@ dependencies {
     modImplementation(libs.ioticblocks.common)
 
     modCompileOnly(libs.emi.xplat)
+
+    api(project(":Core"))
 }
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/MixinOpEval.java b/Common/src/main/java/gay/object/hexdebug/mixin/MixinOpEval.java
@@ -8,7 +8,7 @@
 import at.petrak.hexcasting.api.casting.iota.Iota;
 import at.petrak.hexcasting.common.casting.actions.eval.OpEval;
 import gay.object.hexdebug.casting.eval.IDebugCastEnv;
-import gay.object.hexdebug.debugger.DebugStepType;
+import gay.object.hexdebug.core.api.debugging.DebugStepType;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.Inject;
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebuggerCastEnv.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/DebuggerCastEnv.kt
@@ -3,7 +3,7 @@ package gay.`object`.hexdebug.casting.eval
 import at.petrak.hexcasting.api.casting.castables.Action
 import at.petrak.hexcasting.api.casting.eval.env.PackagedItemCastEnv
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect
-import gay.`object`.hexdebug.debugger.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.DebugStepType
 import gay.`object`.hexdebug.utils.findMediaHolderInHand
 import gay.`object`.hexdebug.utils.otherHand
 import net.minecraft.network.chat.Component
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/EvaluatorCastEnv.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/EvaluatorCastEnv.kt
@@ -3,7 +3,7 @@ package gay.`object`.hexdebug.casting.eval
 import at.petrak.hexcasting.api.casting.castables.Action
 import at.petrak.hexcasting.api.casting.eval.env.StaffCastEnv
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect
-import gay.`object`.hexdebug.debugger.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.DebugStepType
 import net.minecraft.network.chat.Component
 import net.minecraft.server.level.ServerPlayer
 import net.minecraft.world.InteractionHand
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/IDebugCastEnv.kt b/Common/src/main/kotlin/gay/object/hexdebug/casting/eval/IDebugCastEnv.kt
@@ -5,7 +5,7 @@ import at.petrak.hexcasting.api.casting.eval.CastingEnvironment
 import at.petrak.hexcasting.api.casting.eval.sideeffects.OperatorSideEffect
 import at.petrak.hexcasting.api.casting.eval.vm.CastingVM
 import gay.`object`.hexdebug.adapter.DebugAdapterManager
-import gay.`object`.hexdebug.debugger.DebugStepType
+import gay.`object`.hexdebug.core.api.debugging.DebugStepType
 import net.minecraft.network.chat.Component
 import net.minecraft.server.level.ServerPlayer
 import org.eclipse.lsp4j.debug.OutputEventArgumentsCategory
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/DebugStepResult.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/DebugStepResult.kt
@@ -1,6 +1,7 @@
 package gay.`object`.hexdebug.debugger
 
 import at.petrak.hexcasting.api.casting.eval.ExecutionClientView
+import gay.`object`.hexdebug.core.api.debugging.DebugStepType
 import org.eclipse.lsp4j.debug.Source
 import org.eclipse.lsp4j.debug.LoadedSourceEventArgumentsReason as LoadedSourceReason
 
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/Enums.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/Enums.kt
@@ -8,13 +8,6 @@ enum class StopReason(val value: String, val stopImmediately: Boolean) {
     TERMINATED("terminated", true),
 }
 
-enum class DebugStepType {
-    IN,
-    OUT,
-    JUMP,
-    ESCAPE,
-}
-
 enum class SourceBreakpointMode(val label: String, val description: String) {
     EVALUATED("Evaluated", "Stop if this iota would be evaluated. (default)"),
     ESCAPED("Escaped", "Stop if this iota would be escaped."),
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt b/Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt
@@ -17,6 +17,7 @@ import gay.`object`.hexdebug.casting.eval.FrameBreakpoint
 import gay.`object`.hexdebug.casting.eval.IDebugCastEnv
 import gay.`object`.hexdebug.casting.eval.debugCastEnv
 import gay.`object`.hexdebug.casting.iotas.CognitohazardIota
+import gay.`object`.hexdebug.core.api.debugging.DebugStepType
 import gay.`object`.hexdebug.debugger.allocators.VariablesAllocator
 import gay.`object`.hexdebug.utils.ceilToPow
 import gay.`object`.hexdebug.utils.displayWithPatternName
diff --git a/Core/build.gradle.kts b/Core/build.gradle.kts
@@ -0,0 +1,14 @@
+// minimal set of classes required to implement debug support in another mod
+// this is intended to be included via JiJ to allow HexDebug to be an optional dependency
+
+plugins {
+    id("hexdebug.conventions.architectury")
+}
+
+architectury {
+    common("fabric", "forge")
+}
+
+dependencies {
+    modApi(libs.hexcasting.common)
+}
diff --git a/Core/gradle.properties b/Core/gradle.properties
@@ -0,0 +1 @@
+platform=core
diff --git a/Core/src/main/java/gay/object/hexdebug/core/api/debugging/DebugStepType.java b/Core/src/main/java/gay/object/hexdebug/core/api/debugging/DebugStepType.java
@@ -0,0 +1,8 @@
+package gay.object.hexdebug.core.api.debugging;
+
+public enum DebugStepType {
+    IN,
+    OUT,
+    JUMP,
+    ESCAPE,
+}
diff --git a/Fabric/build.gradle.kts b/Fabric/build.gradle.kts
@@ -1,5 +1,4 @@
 import hexdebug.hexdebugProperties
-import hexdebug.libs
 
 plugins {
     id("hexdebug.conventions.platform")
diff --git a/Forge/build.gradle.kts b/Forge/build.gradle.kts
@@ -1,4 +1,3 @@
-import hexdebug.libs
 import hexdebug.utils.kotlinForgeRuntimeLibrary
 
 plugins {
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ modImplementation("gay.object.hexdebug:hexdebug-fabric:0.2.0+1.20.1-SNAPSHOT")
 modImplementation("gay.object.hexdebug:hexdebug-forge:0.2.0+1.20.1-SNAPSHOT")
 ```
 
-Try to avoid using things outside of the `gay.object.hexdebug.api` package, since they may change at any time.
+Note that anything outside of the `gay.object.hexdebug.api` and `gay.object.hexdebug.core.api` packages may be changed, renamed, or removed at any time without warning. 
 
 ## Attribution
 
diff --git a/plugins/src/main/kotlin/hexdebug/conventions/platform.gradle.kts b/plugins/src/main/kotlin/hexdebug/conventions/platform.gradle.kts
@@ -46,6 +46,10 @@ configurations {
 dependencies {
     "common"(project(":Common", "namedElements")) { isTransitive = false }
     "shadowCommon"(project(":Common", "transformProduction$platformCapitalized")) { isTransitive = false }
+
+    // include, not shadow
+    api(project(":Core", "namedElements")) { isTransitive = false }
+    include(project(":Core")) { isTransitive = false }
 }
 
 // FIXME: find a less broken way to include common resources in platform devenv - this one breaks mixin refmaps
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -13,4 +13,4 @@ pluginManagement {
 
 rootProject.name = "HexDebug"
 
-include("Common", "Fabric", "Forge")
+include("Common", "Core", "Fabric", "Forge")

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import hexdebug.libs`
`2`		`-`
`3`	`1`	`plugins {`
`4`	`2`	`id("hexdebug.conventions.architectury")`
`5`	`3`	`}`
`@@ -33,4 +31,6 @@ dependencies {`
`33`	`31`	`modImplementation(libs.ioticblocks.common)`
`34`	`32`
`35`	`33`	`modCompileOnly(libs.emi.xplat)`
	`34`	`+`
	`35`	`+ api(project(":Core"))`
`36`	`36`	`}`