Implement splicing table rainbow brackets

Author: object-Object

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 - Added a new resource-pack-based data-driven system for addon devs to customize how their iotas are rendered in the Splicing Table.
 - Added Hexical interop to make the telepathy and notebook keys work in the Splicing/Mindsplice Table GUI.
+- Added support for "rainbow brackets" (also known as bracket pair colorization) to the Splicing Table. Introspection and Retrospection are now tinted rainbow colors based on their depth. The list of colors is configurable in HexDebug's client settings, and there's also an option to disable the feature entirely.
 
 ### Changed
 

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRenderer.java

@@ -5,5 +5,5 @@
 
 @FunctionalInterface
 public interface SplicingTableIotaRenderer {
-    void render(@NotNull GuiGraphics guiGraphics, int x, int y);
+    void render(@NotNull GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick);
 }

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRendererProvider.java

@@ -2,6 +2,7 @@
 
 import at.petrak.hexcasting.api.casting.iota.IotaType;
 import at.petrak.hexcasting.common.lib.hex.HexIotaTypes;
+import com.google.common.collect.Lists;
 import gay.object.hexdebug.api.splicing.SplicingTableIotaClientView;
 import gay.object.hexdebug.gui.splicing.SplicingTableScreen;
 import net.minecraft.network.chat.Component;
@@ -20,7 +21,9 @@ public interface SplicingTableIotaRendererProvider {
     @NotNull
     SplicingTableIotaRenderer createRenderer(
         @NotNull IotaType<?> type,
-        @NotNull SplicingTableIotaClientView iota
+        @NotNull SplicingTableIotaClientView iota,
+        int x,
+        int y
     );
 
     /**
@@ -32,25 +35,31 @@ SplicingTableIotaRenderer createRenderer(
     @NotNull
     default SplicingTableIotaTooltip createTooltip(
         @NotNull IotaType<?> type,
-        @NotNull SplicingTableIotaClientView iota,
-        int index
+        @NotNull SplicingTableIotaClientView iota
     ) {
-        ArrayList<Component> advanced =  new ArrayList<>();
+        ArrayList<Component> advanced = new ArrayList<>();
         var typeKey = HexIotaTypes.REGISTRY.getKey(type);
         if (typeKey != null) {
             advanced.add(Component.literal(typeKey.toString()));
         }
+        advanced.add(SplicingTableScreen.tooltipText("depth", iota.depth()));
+
         return new SplicingTableIotaTooltip(
             iota.name(),
             new ArrayList<>(),
-            new ArrayList<>(List.of(SplicingTableScreen.tooltipText("index", index))),
+            Lists.newArrayList(
+                SplicingTableScreen.tooltipText("index", iota.index())
+            ),
             advanced,
             null
         );
     }
 
     /**
      * Returns the background type for this renderer.
+     * <br>
+     * This is called every time the splicing table changes which iotas are currently visible, so
+     * don't do anything too laggy in here.
      */
     @NotNull
     default SplicingTableIotaBackgroundType getBackgroundType(

Common/src/main/java/gay/object/hexdebug/api/splicing/SplicingTableIotaClientView.java

@@ -8,19 +8,44 @@
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.nbt.Tag;
 import net.minecraft.network.chat.Component;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * A client-side representation of an iota in the Splicing Table's main list.
+ * <br>
+ * NOTE: Consumers should not construct this class themselves, as its fields may change at any time.
+ * All constructors are annotated with {@link ApiStatus.Internal} to indicate this.
+ * @param tag The raw iota NBT.
+ * @param name The formatted name of the iota for use in tooltips.
+ * @param hexpatternSource The iota converted to a plain string in {@code .hexpattern} format.
+ * @param index The index of this iota in the list.
+ * @param depth The number of unclosed Introspection patterns preceding this iota.
+ */
 public record SplicingTableIotaClientView(
     @NotNull CompoundTag tag,
     @NotNull Component name,
-    @NotNull String hexpatternSource
+    @NotNull String hexpatternSource,
+    int index,
+    int depth
 ) {
-    public SplicingTableIotaClientView(@NotNull Iota iota, @NotNull CastingEnvironment env) {
+    @ApiStatus.Internal
+    public SplicingTableIotaClientView {}
+
+    @ApiStatus.Internal
+    public SplicingTableIotaClientView(
+        @NotNull Iota iota,
+        @NotNull CastingEnvironment env,
+        int index,
+        int depth
+    ) {
         this(
             IotaType.serialize(iota),
             ExtensionsKt.displayWithPatternName(iota, env),
-            ExtensionsKt.toHexpatternSource(iota, env)
+            ExtensionsKt.toHexpatternSource(iota, env),
+            index,
+            depth
         );
     }
 

Common/src/main/kotlin/gay/object/hexdebug/blocks/splicing/SplicingTableBlockEntity.kt

@@ -6,6 +6,7 @@ import at.petrak.hexcasting.api.addldata.ADMediaHolder
 import at.petrak.hexcasting.api.block.HexBlockEntity
 import at.petrak.hexcasting.api.casting.ParticleSpray
 import at.petrak.hexcasting.api.casting.eval.ResolvedPatternType
+import at.petrak.hexcasting.api.casting.eval.SpecialPatterns
 import at.petrak.hexcasting.api.casting.eval.vm.CastingVM
 import at.petrak.hexcasting.api.casting.iota.Iota
 import at.petrak.hexcasting.api.casting.iota.IotaType
@@ -30,6 +31,7 @@ import gay.`object`.hexdebug.splicing.*
 import gay.`object`.hexdebug.utils.Option.None
 import gay.`object`.hexdebug.utils.Option.Some
 import gay.`object`.hexdebug.utils.setPropertyIfChanged
+import gay.`object`.hexdebug.utils.sigsEqual
 import net.minecraft.core.BlockPos
 import net.minecraft.nbt.CompoundTag
 import net.minecraft.nbt.ListTag
@@ -201,8 +203,14 @@ class SplicingTableBlockEntity(pos: BlockPos, state: BlockState) :
 
     override fun getClientView() = getData(null)?.run {
         val env = FakeCastEnv(level)
+        var depth = 0
         SplicingTableClientView(
-            list = list?.map { SplicingTableIotaClientView(it, env) },
+            list = list?.mapIndexed { index, iota ->
+                if ((iota as? PatternIota)?.pattern.sigsEqual(SpecialPatterns.RETROSPECTION)) depth--
+                val view = SplicingTableIotaClientView(iota, env, index, depth)
+                if ((iota as? PatternIota)?.pattern.sigsEqual(SpecialPatterns.INTROSPECTION)) depth++
+                view
+            },
             clipboard = clipboard?.let { IotaType.serialize(it) },
             isListWritable = listWriter != null,
             isClipboardWritable = clipboardWriter != null,

Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugClientConfig.kt

@@ -3,13 +3,15 @@ package gay.`object`.hexdebug.config
 import at.petrak.hexcasting.api.utils.asTranslatedComponent
 import com.mojang.blaze3d.platform.InputConstants
 import gay.`object`.hexdebug.HexDebug
+import gay.`object`.hexdebug.gui.config.startColorList
 import gay.`object`.hexdebug.gui.splicing.SplicingTableScreen
 import gay.`object`.hexdebug.splicing.SplicingTableAction
 import me.shedaniel.autoconfig.AutoConfig
 import me.shedaniel.autoconfig.ConfigData
 import me.shedaniel.autoconfig.ConfigHolder
 import me.shedaniel.autoconfig.annotation.Config
 import me.shedaniel.autoconfig.annotation.ConfigEntry.Category
+import me.shedaniel.autoconfig.annotation.ConfigEntry.ColorPicker
 import me.shedaniel.autoconfig.annotation.ConfigEntry.Gui.*
 import me.shedaniel.autoconfig.serializer.PartitioningSerializer
 import me.shedaniel.autoconfig.serializer.PartitioningSerializer.GlobalData
@@ -20,6 +22,7 @@ import me.shedaniel.clothconfig2.api.ConfigEntryBuilder
 import me.shedaniel.clothconfig2.api.Modifier
 import me.shedaniel.clothconfig2.api.ModifierKeyCode
 import net.minecraft.world.InteractionResult
+import java.lang.reflect.ParameterizedType
 
 object HexDebugClientConfig {
     @JvmStatic
@@ -34,7 +37,7 @@ object HexDebugClientConfig {
 
             // ModifierKeyCode
             registerTypeProvider(
-                { i18n, field, config, defaults, _ -> listOf(
+                { i18n, field, config, defaults, _ ->
                     entryBuilder.startModifierKeyCodeField(
                         when (config) {
                             is ClientConfig.SplicingTableKeybinds,
@@ -48,9 +51,28 @@ object HexDebugClientConfig {
                         .setModifierDefaultValue { (getUnsafely(field, defaults) as ConfigModifierKey).inner }
                         .setModifierSaveConsumer { setUnsafely(field, config, ConfigModifierKey(it)) }
                         .build()
-                ) },
+                        .toList()
+                },
                 ConfigModifierKey::class.java,
             )
+
+            // list of color pickers
+            registerAnnotationProvider(
+                { i18n, field, config, defaults, _ ->
+                    entryBuilder.startColorList(i18n.asTranslatedComponent, getUnsafely(field, config))
+                        .setDefaultValue { getUnsafely(field, defaults) }
+                        .setSaveConsumer { setUnsafely(field, config, it) }
+                        .build()
+                        .toList()
+                },
+                { field ->
+                    val typeArgs = (field.genericType as? ParameterizedType)?.actualTypeArguments
+                    List::class.java.isAssignableFrom(field.type)
+                        && typeArgs?.size == 1
+                        && typeArgs[0] == Integer::class.java
+                },
+                ColorPicker::class.java,
+            )
         }
 
         holder = AutoConfig.register(
@@ -96,6 +118,21 @@ object HexDebugClientConfig {
         @Tooltip
         val invertSplicingTableScrollDirection: Boolean = false
 
+        @Tooltip
+        val enableSplicingTableRainbowBrackets: Boolean = true
+
+        // split Turbo into 8 samples, took the middle 6
+        @Tooltip
+        @ColorPicker
+        val rainbowBracketColors: List<Int> = listOf(
+            0xda3907,
+            0xfe9b2d,
+            0xd1e934,
+            0x62fc6b,
+            0x1bcfd5,
+            0x4676ee,
+        )
+
         @Tooltip
         @CollapsibleObject
         val splicingTableKeybinds = SplicingTableKeybinds()
@@ -243,3 +280,5 @@ data class ConfigModifierKey(
 private val camelRegex = "(?<=[a-zA-Z])[A-Z]".toRegex()
 
 private fun String.camelToSnakeCase() = replace(camelRegex) { "_${it.value}" }.lowercase()
+
+private fun <T> T.toList() = listOf(this)

Common/src/main/kotlin/gay/object/hexdebug/gui/config/ColorListListEntry.kt

@@ -0,0 +1,151 @@
+package gay.`object`.hexdebug.gui.config
+
+import at.petrak.hexcasting.api.utils.asTranslatedComponent
+import me.shedaniel.clothconfig2.api.ConfigEntryBuilder
+import me.shedaniel.clothconfig2.gui.entries.AbstractTextFieldListListEntry
+import me.shedaniel.clothconfig2.gui.widget.ColorDisplayWidget
+import me.shedaniel.clothconfig2.impl.builders.AbstractListBuilder
+import net.minecraft.client.Minecraft
+import net.minecraft.client.gui.GuiGraphics
+import net.minecraft.network.chat.Component
+import java.util.*
+import java.util.function.Consumer
+import java.util.function.Supplier
+
+// note: alpha support is not implemented
+class ColorListListEntry(
+    fieldName: Component,
+    value: List<Int>,
+    defaultExpanded: Boolean,
+    tooltipSupplier: Supplier<Optional<Array<Component>>>?,
+    saveConsumer: Consumer<List<Int>>,
+    defaultValue: Supplier<List<Int>>?,
+    resetButtonKey: Component,
+    requiresRestart: Boolean = false,
+    deleteButtonEnabled: Boolean = true,
+    insertInFront: Boolean = true,
+) : AbstractTextFieldListListEntry<Int, ColorListListEntry.ColorListCell, ColorListListEntry>(
+    fieldName,
+    value,
+    defaultExpanded,
+    tooltipSupplier,
+    saveConsumer,
+    defaultValue,
+    resetButtonKey,
+    requiresRestart,
+    deleteButtonEnabled,
+    insertInFront,
+    ::ColorListCell,
+) {
+    override fun self() = this
+
+    class ColorListCell(
+        value: Int,
+        listListEntry: ColorListListEntry,
+    ) : AbstractTextFieldListCell<Int, ColorListCell, ColorListListEntry>(
+        value,
+        listListEntry,
+    ) {
+        init {
+            widget.value = "#" + value.toUInt().toString(16)
+        }
+
+        private val colorWidgetSize = widget.height
+        private val colorWidget = ColorDisplayWidget(widget, 0, 0, colorWidgetSize, getValue())
+
+        override fun render(
+            graphics: GuiGraphics,
+            index: Int,
+            y: Int,
+            x: Int,
+            entryWidth: Int,
+            entryHeight: Int,
+            mouseX: Int,
+            mouseY: Int,
+            isSelected: Boolean,
+            delta: Float
+        ) {
+            val textX = if (Minecraft.getInstance().font.isBidirectional) {
+                colorWidget.x = x + entryWidth - colorWidgetSize
+                x
+            } else {
+                colorWidget.x = x
+                x + colorWidgetSize + 3
+            }
+            super.render(graphics, index, y, textX, entryWidth - colorWidgetSize - 3, entryHeight, mouseX, mouseY, isSelected, delta)
+            colorWidget.y = y - 4
+            colorWidget.setColor(0xff000000.toInt() or value)
+            colorWidget.render(graphics, mouseX, mouseY, delta)
+        }
+
+        override fun getError(): Optional<Component> {
+            if (unsignedValue == null) {
+                return Optional.of("text.cloth-config.error.color.invalid_color".asTranslatedComponent)
+            }
+            return Optional.empty()
+        }
+
+        override fun getValue(): Int = unsignedValue?.toInt() ?: -1
+
+        // this must return valid for "" and "#", otherwise you can't clear the field
+        override fun isValidText(text: String): Boolean =
+            text.removePrefix("#").isEmpty() || parseColor(text) != null
+
+        override fun substituteDefault(value: Int?): Int = value ?: 0
+
+        private val unsignedValue get() = parseColor(widget.value)
+
+        private fun parseColor(color: String): UInt? {
+            return try {
+                if (color.startsWith("#")) {
+                    color.removePrefix("#").takeIf { it.length <= 6 }?.toUInt(16)
+                } else {
+                    color.toUInt()
+                }?.takeIf { it <= 0xffffffu }
+            } catch (e: NumberFormatException) {
+                null
+            }
+        }
+    }
+}
+
+class ColorListBuilder(
+    resetButtonKey: Component,
+    fieldNameKey: Component,
+) : AbstractListBuilder<Int, ColorListListEntry, ColorListBuilder>(
+    resetButtonKey,
+    fieldNameKey,
+) {
+    constructor(
+        resetButtonKey: Component,
+        fieldNameKey: Component,
+        value: List<Int>,
+    ) : this(resetButtonKey, fieldNameKey) {
+        this.value = value
+    }
+
+    override fun build(): ColorListListEntry {
+        val entry = ColorListListEntry(
+            fieldName = fieldNameKey,
+            value = value,
+            defaultExpanded = isExpanded,
+            tooltipSupplier = null,
+            saveConsumer = saveConsumer,
+            defaultValue = defaultValue,
+            resetButtonKey = resetButtonKey,
+            requiresRestart = isRequireRestart,
+            deleteButtonEnabled = isDeleteButtonEnabled,
+            insertInFront = isInsertInFront,
+        )
+        entry.isInsertButtonEnabled = isInsertButtonEnabled
+        entry.cellErrorSupplier = cellErrorSupplier
+        entry.setTooltipSupplier { tooltipSupplier.apply(entry.value) }
+        entry.addTooltip = addTooltip
+        entry.removeTooltip = removeTooltip
+        errorSupplier?.let { entry.setErrorSupplier { it.apply(entry.value) } }
+        return finishBuilding(entry)
+    }
+}
+
+fun ConfigEntryBuilder.startColorList(fieldNameKey: Component, value: List<Int>) =
+    ColorListBuilder(resetButtonKey, fieldNameKey, value)