feat: Add support for specifying custom controls on config properties (#252)

* feat: Add support for specifying custom controls on config properties #251

* test: Add custom control usage in example config

* refactor: Change BalmCustomConfigControlRegistrar to be backed by an interface, move ConfigControlRegistry to internal package

* refactor: Cleanup some review findings

* refactor: Log unsupported properties on NeoForge config screen, use Balm i18n key

* refactor: ConfigControlContext -> ConfigControlBinding, and make the property private to force controls to go through the getter/setter since not every config screen makes immediate changes

* refactor: Rename displayName -> label

* refactor: Fallback to regular default if createElement failed, since our fallback is more precise than ValueEntry

* refactor: Fallback to default instead of throwing if custom control is invalid for a screen

* refactor: Inline IConfigEntry fallback creation

* refactor: Simplify ClothConfigSupport save consumers to skip unnecessary ConfigControlBinding

* refactor: Make Configured range validation hint translatable

* refactor: Use set instead of setRaw like before

* refactor: Fix i18n

* refactor: Rename context -> binding

* refactor: Revert formatting changes

* refactor: Revert unnecessary routing through binding/control in fallback Configured IConfigValue

* refactor: context -> binding

* feat: Add ConfigControlContext for access to things like sizing info

Author: BlayTheNinth

common-example/src/main/java/com/example/balm/ExampleConfig.java

@@ -1,5 +1,6 @@
 package com.example.balm;
 
+import net.blay09.mods.balm.platform.config.reflection.CustomControl;
 import net.blay09.mods.balm.platform.config.reflection.Comment;
 import net.blay09.mods.balm.platform.config.reflection.Config;
 import net.blay09.mods.balm.platform.config.reflection.Range;
@@ -9,4 +10,8 @@ public class ExampleConfig {
     @Comment("Example ranged integer config value.")
     @Range(min = "0", max = "10")
     public int rangedValue = 5;
+
+    @Comment("Example custom widget config value.")
+    @CustomControl("fancy_button")
+    public boolean fancyBoolean;
 }

common-example/src/main/java/com/example/balm/client/BalmExampleClient.java

@@ -1,10 +1,32 @@
 package com.example.balm.client;
 
 import net.blay09.mods.balm.client.BalmClientRegistrars;
+import net.blay09.mods.balm.client.platform.config.ConfigControl;
+import net.blay09.mods.balm.client.platform.config.ConfigControlContext;
+import net.blay09.mods.balm.platform.config.schema.ConfigControlBinding;
+import net.minecraft.client.gui.components.Button;
+import net.minecraft.network.chat.Component;
 
 public class BalmExampleClient {
     public static void initialize(BalmClientRegistrars registrars) {
         System.out.println("Hello client");
+        registrars.customConfigControls(configControls -> configControls.register("fancy_button", ConfigControl.<Boolean>builder()
+                .element(FancyConfigButton::new)
+                .build()));
         registrars.registerModule(new ClientCommandTestModule());
     }
+
+    private static class FancyConfigButton extends Button.Plain {
+        private final ConfigControlBinding<Boolean> binding;
+
+        public FancyConfigButton(ConfigControlBinding<Boolean> binding, ConfigControlContext context) {
+            super(0, 0, context.entryWidth(), context.entryHeight(), Component.empty(), (_) -> binding.set(!binding.get()), DEFAULT_NARRATION);
+            this.binding = binding;
+        }
+
+        @Override
+        public Component getMessage() {
+            return Component.literal("Custom: " + binding.get());
+        }
+    }
 }

common/src/main/java/net/blay09/mods/balm/client/BalmClientRegistrars.java

@@ -7,6 +7,8 @@
 import net.blay09.mods.balm.client.gui.screens.inventory.BalmMenuScreenRegistrar;
 import net.blay09.mods.balm.client.model.geom.BalmModelLayerRegistrar;
 import net.blay09.mods.balm.client.particle.BalmParticleProviderRegistrar;
+import net.blay09.mods.balm.client.platform.config.BalmCustomConfigControlRegistrar;
+import net.blay09.mods.balm.client.platform.config.internal.BalmCustomConfigControlRegistrarImpl;
 import net.blay09.mods.balm.client.renderer.block.model.BalmBlockStateModelRegistrar;
 import net.blay09.mods.balm.client.renderer.blockentity.BalmBlockEntityRendererRegistrar;
 import net.blay09.mods.balm.client.renderer.entity.BalmEntityRendererRegistrar;
@@ -128,6 +130,15 @@ public void rangeSelectItemModelProperties(Consumer<BalmRangeSelectItemModelProp
         runtime.rangeSelectItemModelProperties(namespace, initializer);
     }
 
+    /**
+     * Use this to register client-side config controls for schema properties that reference a control id.
+     *
+     * @param initializer Callback that receives a scoped registrar for config controls.
+     */
+    public void customConfigControls(Consumer<BalmCustomConfigControlRegistrar> initializer) {
+        initializer.accept(new BalmCustomConfigControlRegistrarImpl(namespace));
+    }
+
     public void registerModule(BalmClientModule module) {
         runtime.registerModule(this, module);
     }

common/src/main/java/net/blay09/mods/balm/client/platform/config/BalmCustomConfigControlRegistrar.java

@@ -0,0 +1,9 @@
+package net.blay09.mods.balm.client.platform.config;
+
+import net.minecraft.resources.Identifier;
+
+public interface BalmCustomConfigControlRegistrar {
+    <T> void register(String path, ConfigControl<T> control);
+
+    <T> void register(Identifier identifier, ConfigControl<T> control);
+}

common/src/main/java/net/blay09/mods/balm/client/platform/config/ConfigControl.java

@@ -0,0 +1,78 @@
+package net.blay09.mods.balm.client.platform.config;
+
+import com.mojang.serialization.DataResult;
+import net.blay09.mods.balm.platform.config.schema.ConfigControlBinding;
+import net.minecraft.network.chat.Component;
+import org.jspecify.annotations.Nullable;
+
+import java.util.Optional;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
+public class ConfigControl<T> {
+    private final ElementFactory<T> elementFactory;
+    private final BiFunction<ConfigControlBinding<T>, T, DataResult<T>> validator;
+    private final Function<ConfigControlBinding<T>, Optional<Component>> validationHint;
+
+    private ConfigControl(ElementFactory<T> elementFactory, BiFunction<ConfigControlBinding<T>, T, DataResult<T>> validator, Function<ConfigControlBinding<T>, Optional<Component>> validationHint) {
+        this.elementFactory = elementFactory;
+        this.validator = validator;
+        this.validationHint = validationHint;
+    }
+
+    private static <T> @Nullable Object noElement(ConfigControlBinding<T> binding, ConfigControlContext context) {
+        return null;
+    }
+
+    public Optional<Object> createElement(ConfigControlBinding<T> binding, ConfigControlContext context) {
+        return Optional.ofNullable(elementFactory.create(binding, context));
+    }
+
+    public DataResult<T> validate(ConfigControlBinding<T> binding, T value) {
+        return validator.apply(binding, value);
+    }
+
+    public Optional<Component> getValidationHint(ConfigControlBinding<T> binding) {
+        return validationHint.apply(binding);
+    }
+
+    public static <T> Builder<T> builder() {
+        return new Builder<>();
+    }
+
+    public static final class Builder<T> {
+        private ElementFactory<T> elementFactory = ConfigControl::noElement;
+        private BiFunction<ConfigControlBinding<T>, T, DataResult<T>> validator = (context, value) -> context.validateValue(value);
+        private Function<ConfigControlBinding<T>, Optional<Component>> validationHint = _ -> Optional.empty();
+
+        public Builder<T> element(ElementFactory<T> elementFactory) {
+            this.elementFactory = elementFactory;
+            return this;
+        }
+
+        public Builder<T> validator(BiFunction<ConfigControlBinding<T>, T, DataResult<T>> validator) {
+            this.validator = validator;
+            return this;
+        }
+
+        public Builder<T> validationHint(Component validationHint) {
+            this.validationHint = context -> Optional.of(validationHint);
+            return this;
+        }
+
+        public Builder<T> validationHint(Function<ConfigControlBinding<T>, Optional<Component>> validationHint) {
+            this.validationHint = validationHint;
+            return this;
+        }
+
+        public ConfigControl<T> build() {
+            return new ConfigControl<>(elementFactory, validator, validationHint);
+        }
+    }
+
+    @FunctionalInterface
+    public interface ElementFactory<T> {
+        @Nullable
+        Object create(ConfigControlBinding<T> binding, ConfigControlContext context);
+    }
+}

common/src/main/java/net/blay09/mods/balm/client/platform/config/ConfigControlContext.java

@@ -0,0 +1,16 @@
+package net.blay09.mods.balm.client.platform.config;
+
+import net.blay09.mods.balm.platform.config.schema.ConfiguredProperty;
+import net.minecraft.network.chat.Component;
+
+public interface ConfigControlContext {
+
+    int entryWidth();
+
+    int entryHeight();
+
+    Component label(ConfiguredProperty<?> property);
+
+    Component tooltip(ConfiguredProperty<?> property);
+
+}

common/src/main/java/net/blay09/mods/balm/client/platform/config/internal/BalmCustomConfigControlRegistrarImpl.java

@@ -0,0 +1,23 @@
+package net.blay09.mods.balm.client.platform.config.internal;
+
+import net.blay09.mods.balm.client.platform.config.BalmCustomConfigControlRegistrar;
+import net.blay09.mods.balm.client.platform.config.ConfigControl;
+import net.minecraft.resources.Identifier;
+
+public class BalmCustomConfigControlRegistrarImpl implements BalmCustomConfigControlRegistrar {
+    private final String namespace;
+
+    public BalmCustomConfigControlRegistrarImpl(String namespace) {
+        this.namespace = namespace;
+    }
+
+    @Override
+    public <T> void register(String path, ConfigControl<T> control) {
+        register(Identifier.fromNamespaceAndPath(namespace, path), control);
+    }
+
+    @Override
+    public <T> void register(Identifier identifier, ConfigControl<T> control) {
+        ConfigControlRegistry.register(identifier, control);
+    }
+}

common/src/main/java/net/blay09/mods/balm/client/platform/config/internal/ConfigControlContextImpl.java

@@ -0,0 +1,36 @@
+package net.blay09.mods.balm.client.platform.config.internal;
+
+import net.blay09.mods.balm.client.platform.config.ConfigControlContext;
+import net.blay09.mods.balm.platform.config.schema.ConfiguredProperty;
+import net.blay09.mods.balm.platform.config.util.ConfigLocalization;
+import net.minecraft.network.chat.Component;
+
+public class ConfigControlContextImpl implements ConfigControlContext {
+    private final int entryWidth;
+    private final int entryHeight;
+
+    public ConfigControlContextImpl(int entryWidth, int entryHeight) {
+        this.entryWidth = entryWidth;
+        this.entryHeight = entryHeight;
+    }
+
+    @Override
+    public int entryWidth() {
+        return entryWidth;
+    }
+
+    @Override
+    public int entryHeight() {
+        return entryHeight;
+    }
+
+    @Override
+    public Component label(ConfiguredProperty<?> property) {
+        return Component.translatable(ConfigLocalization.forProperty(property));
+    }
+
+    @Override
+    public Component tooltip(ConfiguredProperty<?> property) {
+        return Component.translatable(ConfigLocalization.forPropertyTooltip(property));
+    }
+}

common/src/main/java/net/blay09/mods/balm/client/platform/config/internal/ConfigControlRegistry.java

@@ -0,0 +1,30 @@
+package net.blay09.mods.balm.client.platform.config.internal;
+
+import net.blay09.mods.balm.client.platform.config.ConfigControl;
+import net.blay09.mods.balm.client.platform.config.ConfigControlContext;
+import net.blay09.mods.balm.platform.config.schema.ConfigControlBinding;
+import net.minecraft.resources.Identifier;
+
+import java.util.Map;
+import java.util.Optional;
+import java.util.concurrent.ConcurrentHashMap;
+
+public final class ConfigControlRegistry {
+    private static final Map<Identifier, ConfigControl<?>> controls = new ConcurrentHashMap<>();
+
+    private ConfigControlRegistry() {
+    }
+
+    public static <T> void register(Identifier identifier, ConfigControl<T> control) {
+        controls.put(identifier, control);
+    }
+
+    @SuppressWarnings("unchecked")
+    public static <T> Optional<ConfigControl<T>> get(Identifier identifier) {
+        return Optional.ofNullable((ConfigControl<T>) controls.get(identifier));
+    }
+
+    public static <T> Optional<Object> createElement(Identifier identifier, ConfigControlBinding<T> binding, ConfigControlContext context) {
+        return ConfigControlRegistry.<T>get(identifier).flatMap(control -> control.createElement(binding, context));
+    }
+}

common/src/main/java/net/blay09/mods/balm/client/platform/module/BalmClientModule.java

@@ -7,6 +7,7 @@
 import net.blay09.mods.balm.client.BalmRangeSelectItemModelPropertyRegistrar;
 import net.blay09.mods.balm.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.client.gui.screens.inventory.BalmMenuScreenRegistrar;
+import net.blay09.mods.balm.client.platform.config.BalmCustomConfigControlRegistrar;
 import net.blay09.mods.balm.client.renderer.blockentity.BalmBlockEntityRendererRegistrar;
 import net.blay09.mods.balm.client.renderer.entity.BalmEntityRendererRegistrar;
 import net.blay09.mods.balm.client.renderer.block.model.BalmBlockStateModelRegistrar;
@@ -61,6 +62,9 @@ default void registerClientTooltipComponents(BalmClientTooltipComponentRegistrar
     default void registerRangeSelectItemModelProperties(BalmRangeSelectItemModelPropertyRegistrar rangeSelectItemModelProperties) {
     }
 
+    default void registerCustomConfigControls(BalmCustomConfigControlRegistrar customConfigControls) {
+    }
+
     default void registerClientCommands(BalmClientCommands commands) {
     }