Implement data-driven splicing table iota rendering

Author: object-Object

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

@@ -0,0 +1,6 @@
+package gay.object.hexdebug.api.client.splicing;
+
+public enum SplicingTableIotaBackgroundType {
+    GOLD,
+    SLATE,
+}

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

@@ -0,0 +1,9 @@
+package gay.object.hexdebug.api.client.splicing;
+
+import net.minecraft.client.gui.GuiGraphics;
+import org.jetbrains.annotations.NotNull;
+
+@FunctionalInterface
+public interface SplicingTableIotaRenderer {
+    void render(@NotNull GuiGraphics guiGraphics, int x, int y);
+}

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

@@ -0,0 +1,25 @@
+package gay.object.hexdebug.api.client.splicing;
+
+import com.google.gson.Gson;
+import com.google.gson.JsonObject;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+@FunctionalInterface
+public interface SplicingTableIotaRendererParser<T extends SplicingTableIotaRendererProvider> {
+    /**
+     * Attempts to parse the JSON data and return a provider for an iota renderer.
+     * Throws {@link IllegalArgumentException} or {@link com.google.gson.JsonParseException} if
+     * the input is invalid.
+     */
+    @NotNull
+    T parse(@NotNull Gson gson, @NotNull JsonObject jsonObject, @Nullable T parent);
+
+    /**
+     * Creates a parser that always returns the given instance.
+     */
+    @NotNull
+    static <T extends SplicingTableIotaRendererProvider> SplicingTableIotaRendererParser<T> of(T instance) {
+        return (gson, jsonObject, parent) -> instance;
+    }
+}

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

@@ -0,0 +1,62 @@
+package gay.object.hexdebug.api.client.splicing;
+
+import at.petrak.hexcasting.api.casting.iota.IotaType;
+import at.petrak.hexcasting.common.lib.hex.HexIotaTypes;
+import gay.object.hexdebug.api.splicing.SplicingTableIotaClientView;
+import gay.object.hexdebug.gui.splicing.SplicingTableScreen;
+import net.minecraft.network.chat.Component;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public interface SplicingTableIotaRendererProvider {
+    /**
+     * Creates and returns a new renderer for the provided iota.
+     * <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
+    SplicingTableIotaRenderer createRenderer(
+        @NotNull IotaType<?> type,
+        @NotNull SplicingTableIotaClientView iota
+    );
+
+    /**
+     * Creates and returns a new tooltip for the provided iota.
+     * <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 SplicingTableIotaTooltip createTooltip(
+        @NotNull IotaType<?> type,
+        @NotNull SplicingTableIotaClientView iota,
+        int index
+    ) {
+        ArrayList<Component> advanced =  new ArrayList<>();
+        var typeKey = HexIotaTypes.REGISTRY.getKey(type);
+        if (typeKey != null) {
+            advanced.add(Component.literal(typeKey.toString()));
+        }
+        return new SplicingTableIotaTooltip(
+            iota.name(),
+            new ArrayList<>(),
+            new ArrayList<>(List.of(SplicingTableScreen.tooltipText("index", index))),
+            advanced,
+            null
+        );
+    }
+
+    /**
+     * Returns the background type for this renderer.
+     */
+    @NotNull
+    default SplicingTableIotaBackgroundType getBackgroundType(
+        @NotNull IotaType<?> type,
+        @NotNull SplicingTableIotaClientView iota
+    ) {
+        return SplicingTableIotaBackgroundType.GOLD;
+    }
+}

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

@@ -0,0 +1,35 @@
+package gay.object.hexdebug.api.client.splicing;
+
+import com.google.common.collect.Maps;
+import gay.object.hexdebug.HexDebug;
+import net.minecraft.resources.ResourceLocation;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Map;
+
+public final class SplicingTableIotaRenderers {
+    private static final Map<ResourceLocation, SplicingTableIotaRendererParser<?>> PARSERS = Maps.newHashMap();
+
+    /**
+     * Register a splicing table iota renderer.
+     * <br>
+     * This is used to parse resource files and create providers for iota renderers.
+     */
+    public static void register(
+        @NotNull ResourceLocation id,
+        @NotNull SplicingTableIotaRendererParser<?> parser
+    ) {
+        if (PARSERS.containsKey(id)) {
+            HexDebug.LOGGER.warn("Overriding existing splicing table iota renderer parser: {}", id);
+        }
+        PARSERS.put(id, parser);
+    }
+
+    @ApiStatus.Internal
+    @Nullable
+    public static SplicingTableIotaRendererParser<?> getParser(@NotNull ResourceLocation id) {
+        return PARSERS.get(id);
+    }
+}

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

@@ -0,0 +1,39 @@
+package gay.object.hexdebug.api.client.splicing;
+
+import net.minecraft.ChatFormatting;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.components.Tooltip;
+import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.ArrayList;
+
+public record SplicingTableIotaTooltip(
+    @NotNull Component name,
+    @NotNull ArrayList<Component> body,
+    @NotNull ArrayList<Component> details,
+    @NotNull ArrayList<Component> advanced,
+    @Nullable Component narration
+) {
+    public Tooltip build() {
+        var lines = new ArrayList<Component>();
+        lines.add(name);
+        lines.addAll(body);
+        for (var line : details) {
+            lines.add(line.copy().withStyle(ChatFormatting.GRAY));
+        }
+        if (Minecraft.getInstance().options.advancedItemTooltips) {
+            for (var line : advanced) {
+                lines.add(line.copy().withStyle(ChatFormatting.DARK_GRAY));
+            }
+        }
+
+        var tooltipText = ComponentUtils.formatList(lines, Component.literal("\n"));
+        if (narration != null) {
+            return Tooltip.create(tooltipText, narration);
+        }
+        return Tooltip.create(tooltipText);
+    }
+}

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

@@ -0,0 +1,31 @@
+package gay.object.hexdebug.api.splicing;
+
+import at.petrak.hexcasting.api.casting.eval.CastingEnvironment;
+import at.petrak.hexcasting.api.casting.iota.Iota;
+import at.petrak.hexcasting.api.casting.iota.IotaType;
+import at.petrak.hexcasting.common.lib.hex.HexIotaTypes;
+import gay.object.hexdebug.utils.ExtensionsKt;
+import net.minecraft.nbt.CompoundTag;
+import net.minecraft.nbt.Tag;
+import net.minecraft.network.chat.Component;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public record SplicingTableIotaClientView(
+    @NotNull CompoundTag tag,
+    @NotNull Component name,
+    @NotNull String hexpatternSource
+) {
+    public SplicingTableIotaClientView(@NotNull Iota iota, @NotNull CastingEnvironment env) {
+        this(
+            IotaType.serialize(iota),
+            ExtensionsKt.displayWithPatternName(iota, env),
+            ExtensionsKt.toHexpatternSource(iota, env)
+        );
+    }
+
+    @Nullable
+    public Tag getData() {
+        return tag.get(HexIotaTypes.KEY_DATA);
+    }
+}

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

@@ -5,6 +5,8 @@ package gay.`object`.hexdebug
 
 import dev.architectury.injectables.annotations.ExpectPlatform
 import gay.`object`.hexdebug.registry.HexDebugRegistrar
+import net.minecraft.resources.ResourceLocation
+import net.minecraft.server.packs.resources.PreparableReloadListener
 
 fun initRegistries(vararg registries: HexDebugRegistrar<*>) {
     for (registry in registries) {
@@ -16,3 +18,8 @@ fun initRegistries(vararg registries: HexDebugRegistrar<*>) {
 fun <T : Any> initRegistry(registrar: HexDebugRegistrar<T>) {
     throw AssertionError()
 }
+
+@ExpectPlatform
+fun registerClientResourceReloadListener(id: ResourceLocation, listener: PreparableReloadListener) {
+    throw AssertionError()
+}

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

@@ -7,10 +7,15 @@ import at.petrak.hexcasting.api.utils.gray
 import at.petrak.hexcasting.api.utils.plusAssign
 import gay.`object`.hexdebug.HexDebug.LOGGER
 import gay.`object`.hexdebug.adapter.proxy.DebugProxyClient
+import gay.`object`.hexdebug.api.client.splicing.SplicingTableIotaRenderers
 import gay.`object`.hexdebug.blocks.focusholder.FocusHolderBlock
 import gay.`object`.hexdebug.config.HexDebugClientConfig
 import gay.`object`.hexdebug.config.HexDebugServerConfig
+import gay.`object`.hexdebug.gui.splicing.renderers.ListRendererProvider
+import gay.`object`.hexdebug.gui.splicing.renderers.PatternRendererProvider
+import gay.`object`.hexdebug.gui.splicing.renderers.TextureRendererProvider
 import gay.`object`.hexdebug.registry.HexDebugBlocks
+import gay.`object`.hexdebug.resources.splicing.SplicingTableIotasResourceReloadListener
 import gay.`object`.hexdebug.utils.styledHoverName
 import gay.`object`.hexdebug.utils.toComponent
 import me.shedaniel.autoconfig.AutoConfig
@@ -35,6 +40,8 @@ object HexDebugClient {
         HexDebugClientConfig.init()
         DebugProxyClient.init()
         addScryingLensOverlays()
+        registerSplicingTableIotaRenderers()
+        registerClientResourceReloadListener(HexDebug.id("splicing_iotas"), SplicingTableIotasResourceReloadListener)
     }
 
     fun getConfigScreen(parent: Screen): Screen {
@@ -86,4 +93,10 @@ object HexDebugClient {
 
         return MojangPair(stack, truncatedDisplay)
     }
+
+    private fun registerSplicingTableIotaRenderers() {
+        SplicingTableIotaRenderers.register(HexDebug.id("list"), ListRendererProvider.PARSER)
+        SplicingTableIotaRenderers.register(HexDebug.id("pattern"), PatternRendererProvider.PARSER)
+        SplicingTableIotaRenderers.register(HexDebug.id("texture"), TextureRendererProvider.PARSER)
+    }
 }

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

@@ -16,6 +16,7 @@ import at.petrak.hexcasting.api.pigment.FrozenPigment
 import at.petrak.hexcasting.api.utils.*
 import at.petrak.hexcasting.xplat.IXplatAbstractions
 import gay.`object`.hexdebug.api.HexDebugTags
+import gay.`object`.hexdebug.api.splicing.SplicingTableIotaClientView
 import gay.`object`.hexdebug.blocks.base.BaseContainer
 import gay.`object`.hexdebug.blocks.base.ContainerDataDelegate
 import gay.`object`.hexdebug.blocks.base.ContainerDataLongDelegate
@@ -201,7 +202,7 @@ class SplicingTableBlockEntity(pos: BlockPos, state: BlockState) :
     override fun getClientView() = getData(null)?.run {
         val env = FakeCastEnv(level)
         SplicingTableClientView(
-            list = list?.map { IotaClientView(it, env) },
+            list = list?.map { SplicingTableIotaClientView(it, env) },
             clipboard = clipboard?.let { IotaType.serialize(it) },
             isListWritable = listWriter != null,
             isClipboardWritable = clipboardWriter != null,