Add Cognitohazard Reflection (close #30)

Author: object-Object

Common/src/main/kotlin/gay/object/hexdebug/HexDebug.kt

@@ -25,6 +25,7 @@ object HexDebug {
             HexDebugMenus,
             HexDebugActions,
             HexDebugContinuationTypes,
+            HexDebugIotaTypes,
         )
         HexDebugNetworking.init()
         DebugAdapterManager.init()

Common/src/main/kotlin/gay/object/hexdebug/casting/iotas/CognitohazardIota.kt

@@ -0,0 +1,51 @@
+package gay.`object`.hexdebug.casting.iotas
+
+import at.petrak.hexcasting.api.casting.eval.CastResult
+import at.petrak.hexcasting.api.casting.eval.ResolvedPatternType
+import at.petrak.hexcasting.api.casting.eval.vm.CastingVM
+import at.petrak.hexcasting.api.casting.eval.vm.SpellContinuation
+import at.petrak.hexcasting.api.casting.iota.Iota
+import at.petrak.hexcasting.api.casting.iota.IotaType
+import at.petrak.hexcasting.api.utils.asTranslatedComponent
+import at.petrak.hexcasting.api.utils.black
+import at.petrak.hexcasting.common.lib.hex.HexEvalSounds
+import net.minecraft.nbt.CompoundTag
+import net.minecraft.nbt.Tag
+import net.minecraft.server.level.ServerLevel
+
+/** An iota that terminates a debugging session if attempted to be executed. */
+class CognitohazardIota : Iota(TYPE, COGNITOHAZARD_SUBSTITUTE) {
+    override fun isTruthy() = true
+
+    override fun toleratesOther(that: Iota) = typesMatch(this, that)
+
+    override fun serialize() = CompoundTag()
+
+    override fun execute(vm: CastingVM, world: ServerLevel, continuation: SpellContinuation): CastResult {
+        // we shouldn't need any special handling in here, since the cognitohazard should be detected by the debugger before we get to this point
+        return CastResult(
+            this,
+            continuation,
+            null,
+            listOf(),
+            ResolvedPatternType.EVALUATED,
+            HexEvalSounds.NOTHING,
+        )
+    }
+
+    override fun executable() = true
+
+    companion object {
+        private val COGNITOHAZARD_SUBSTITUTE = Object()
+
+        val DISPLAY = "hexdebug.tooltip.cognitohazard_iota".asTranslatedComponent.black
+
+        val TYPE = object : IotaType<CognitohazardIota>() {
+            override fun deserialize(tag: Tag, world: ServerLevel) = CognitohazardIota()
+
+            override fun display(tag: Tag) = DISPLAY
+
+            override fun color() = 0xff_000000.toInt()
+        }
+    }
+}

Common/src/main/kotlin/gay/object/hexdebug/debugger/HexDebugger.kt

@@ -17,6 +17,7 @@ import gay.`object`.hexdebug.adapter.LaunchArgs
 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.debugger.allocators.SourceAllocator
 import gay.`object`.hexdebug.debugger.allocators.VariablesAllocator
 import gay.`object`.hexdebug.utils.ceilToPow
@@ -63,6 +64,9 @@ class HexDebugger(
     private val breakpoints = mutableMapOf<Int, MutableMap<Int, SourceBreakpointMode>>() // source id -> line number
     private val exceptionBreakpoints = mutableSetOf<ExceptionBreakpointType>()
 
+    // this gets set to true by registerNewSource if a frame is loaded that contains a cognitohazard iota
+    private var isPoisoned = false
+
     private val initialSource = registerNewSource(iotas)!!
 
     private var callStack = listOf<NotDone>()
@@ -114,6 +118,9 @@ class HexDebugger(
 
         val source = sourceAllocator.add(unregisteredIotas)
         for ((index, iota) in unregisteredIotas.withIndex()) {
+            if (iota is CognitohazardIota) {
+                isPoisoned = true
+            }
             iotaMetadata[iota] = IotaMetadata(source, index)
         }
         return source
@@ -511,7 +518,7 @@ class HexDebugger(
             val frame = continuation.frame
 
             // TODO: there's probably a less hacky way to do this
-            if (frame is FrameBreakpoint && frame.isFatal) {
+            if (frame is FrameBreakpoint && frame.isFatal || isPoisoned) {
                 continuation = Done
                 break
             }

Common/src/main/kotlin/gay/object/hexdebug/registry/HexDebugActions.kt

@@ -10,8 +10,12 @@ import at.petrak.hexcasting.common.items.magic.ItemPackagedHex
 import at.petrak.hexcasting.common.lib.HexRegistries
 import at.petrak.hexcasting.common.lib.hex.HexActions
 import gay.`object`.hexdebug.casting.actions.*
+import gay.`object`.hexdebug.casting.iotas.CognitohazardIota
 
 object HexDebugActions : HexDebugRegistrar<ActionRegistryEntry>(HexRegistries.ACTION, { HexActions.REGISTRY }) {
+    val COGNITOHAZARD = make("const/cognitohazard", HexDir.NORTH_WEST, "wdeaqqdqeedqadqeedqaeadeaqqeadeaqqdqdeaqqeaeedqaw") {
+        Action.makeConstantOp(CognitohazardIota())
+    }
     val IS_DEBUGGING = make("const/debugging", HexDir.EAST, "qqqqqewaa", OpIsDebugging)
     val NEXT_EVAL_INDEX = make("next_eval_index", HexDir.SOUTH_WEST, "dedqdeqwaa", OpNextEvalIndex)
 

Common/src/main/kotlin/gay/object/hexdebug/registry/HexDebugIotaTypes.kt

@@ -0,0 +1,13 @@
+package gay.`object`.hexdebug.registry
+
+import at.petrak.hexcasting.api.casting.iota.IotaType
+import at.petrak.hexcasting.common.lib.HexRegistries
+import at.petrak.hexcasting.common.lib.hex.HexIotaTypes
+import gay.`object`.hexdebug.casting.iotas.CognitohazardIota
+
+object HexDebugIotaTypes : HexDebugRegistrar<IotaType<*>>(
+    HexRegistries.IOTA_TYPE,
+    { HexIotaTypes.REGISTRY },
+) {
+    val COGNITOHAZARD = register("cognitohazard") { CognitohazardIota.TYPE }
+}

Common/src/main/resources/assets/hexcasting/patchouli_books/thehexbook/en_us/entries/patterns/debugging.json5

@@ -18,6 +18,17 @@
       output: "int or null",
       text: "hexdebug.category.patterns.entry.debugging.page.next_eval_index",
     },
+    {
+      type: "hexcasting:pattern",
+      op_id: "hexdebug:const/cognitohazard",
+      anchor: "hexdebug:const/cognitohazard",
+      output: "cognitohazard",
+      text: "hexdebug.category.patterns.entry.debugging.page.const/cognitohazard.1",
+    },
+    {
+      type: "patchouli:text",
+      text: "hexdebug.category.patterns.entry.debugging.page.const/cognitohazard.2",
+    },
     {
       type: "hexcasting:pattern",
       op_id: "hexdebug:breakpoint/before",

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

@@ -93,6 +93,7 @@
     "hexdebug:": {
       "const/debugging": "Debugger's Reflection",
       "next_eval_index": "Debug Locator's Reflection", // TODO: this name kinda sucks tbh
+      "const/cognitohazard": "Cognitohazard Reflection",
       "breakpoint/": {
         before: "Set Breakpoint Before",
         after: "Set Breakpoint After"
@@ -101,6 +102,7 @@
     },
     "book.hexdebug:": {
       "next_eval_index": "Debug Locator's Rfln.",
+      "const/cognitohazard": "Cognitohazard Rfln."
     },
   },
 
@@ -120,6 +122,7 @@
       focus_holder: {
         item: "Item: %s",
       },
+      cognitohazard_iota: "Cognitohazard",
     },
 
     category: {
@@ -149,6 +152,11 @@
             page: {
               "const/debugging": "Adds $(thing)True/$ to the top of the stack if executed by a $(l:items/debugging#debugger)$(item)Debugger/$ or $(l:items/debugging#evaluator)$(item)Evaluator/$, or $(thing)False/$ otherwise.",
               "next_eval_index": "Adds the index of the next iota to be evaluated if executed by a $(l:items/debugging#debugger)$(item)Debugger/$ or $(l:items/debugging#evaluator)$(item)Evaluator/$, or $(l:casting/influences)$(thing)Null/$ otherwise.",
+              "const/cognitohazard": {
+                "1": "Adds a $(thing)Cognitohazard/$ to the top of the stack.",
+                "2": "It seems certain $(l:items/debugging#evaluator)debugging tools/$ may pose a security risk for some $(l:patterns/meta#hexcasting:eval/cc)high-level techniques/$. To help combat this, I have created this pattern.$(br2)\
+                  When a $(thing)Cognitohazard/$ iota is executed normally, nothing happens. However, if one is present in a _Hex executed by a $(l:items/debugging#debugger)$(item)Debugger/$, it will cause the _Hex to terminate $(italic)immediately/$ - even before the $(thing)Cognitohazard/$ is actually executed.",
+              },
               "breakpoint/": {
                 before: "Pauses the $(l:items/debugging#debugger)$(item)Debugger/$ before executing this pattern.",
                 after: "Pauses the $(l:items/debugging#debugger)$(item)Debugger/$ after executing this pattern (ie. before executing the next pattern).",