Add dropdown controllers (#95)

7 files changed, 132 insertions, 1 deletions

diff --git a/common/src/main/java/dev/isxander/yacl3/config/GsonConfigInstance.java b/common/src/main/java/dev/isxander/yacl3/config/GsonConfigInstance.java
index acbf338..deff6d7 100644
--- a/common/src/main/java/dev/isxander/yacl3/config/GsonConfigInstance.java
+++ b/common/src/main/java/dev/isxander/yacl3/config/GsonConfigInstance.java
@@ -1,9 +1,12 @@
 package dev.isxander.yacl3.config;
 
 import com.google.gson.*;
+import dev.isxander.yacl3.gui.utils.ItemRegistryHelper;
 import dev.isxander.yacl3.impl.utils.YACLConstants;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.Style;
+import net.minecraft.world.item.Item;
 
 import java.awt.*;
 import java.io.IOException;
@@ -66,6 +69,7 @@ public class GsonConfigInstance<T> extends ConfigInstance<T> {
                 .registerTypeHierarchyAdapter(Component.class, new Component.Serializer())
                 .registerTypeHierarchyAdapter(Style.class, new Style.Serializer())
                 .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter())
+                .registerTypeHierarchyAdapter(Item.class, new ItemTypeAdapter())
                 .serializeNulls()
                 .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
                 .create();
@@ -129,6 +133,17 @@ public class GsonConfigInstance<T> extends ConfigInstance<T> {
             return new JsonPrimitive(color.getRGB());
         }
     }
+    public static class ItemTypeAdapter implements JsonSerializer<Item>, JsonDeserializer<Item> {
+        @Override
+        public Item deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
+            return ItemRegistryHelper.getItemFromName(jsonElement.getAsString());
+        }
+
+        @Override
+        public JsonElement serialize(Item item, Type type, JsonSerializationContext jsonSerializationContext) {
+            return new JsonPrimitive(BuiltInRegistries.ITEM.getKey(item).toString());
+        }
+    }
 
     /**
      * Creates a builder for a GSON config instance.
@@ -148,7 +163,8 @@ public class GsonConfigInstance<T> extends ConfigInstance<T> {
                 .serializeNulls()
                 .registerTypeHierarchyAdapter(Component.class, new Component.Serializer())
                 .registerTypeHierarchyAdapter(Style.class, new Style.Serializer())
-                .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter());
+                .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter())
+                .registerTypeHierarchyAdapter(Item.class, new ItemTypeAdapter());
 
         private Builder(Class<T> configClass) {
             this.configClass = configClass;
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/Dropdown.java b/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/Dropdown.java
new file mode 100644
index 0000000..44239d5
--- /dev/null
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/Dropdown.java
@@ -0,0 +1,43 @@
+package dev.isxander.yacl3.config.v2.api.autogen;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * An option factory.
+ * <p>
+ * This creates a regular option with a
+ * {@link dev.isxander.yacl3.api.controller.DropdownStringControllerBuilder} controller.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface Dropdown {
+	/**
+	 * The allowed values for the field. These will be shown in a dropdown
+	 * that the user can filter and select from.
+	 * <p>
+	 * Only values in this list will be accepted and written to the config
+	 * file, unless {@link #allow()} is set to ${@code ALLOW_ANY}.
+	 * <p>
+	 * Empty string is a valid value only if it appears in this list, or if
+	 * {@link #allow()} is set to {@code ALLOW_EMPTY} or {@code ALLOW_ANY}.
+	 */
+	String[] values();
+
+	/**
+	 * Whether to accept the empty string as a valid value if it does not
+	 * already appear in {@link #values()}. If it already appears there,
+	 * the value of this does not apply.
+	 */
+	boolean allowEmptyValue() default false;
+
+	/**
+	 * Whether to accept any string as a valid value. The list of strings
+	 * supplied in {@link #values()} are only used as dropdown suggestions.
+	 * Empty strings are still prohibited unless the empty string appears in
+	 * {@link #values()} or {@link #allowEmptyValue()}.
+	 */
+	boolean allowAnyValue() default false;
+}
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/ItemField.java b/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/ItemField.java
new file mode 100644
index 0000000..84d2c7a
--- /dev/null
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/api/autogen/ItemField.java
@@ -0,0 +1,17 @@
+package dev.isxander.yacl3.config.v2.api.autogen;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * An option factory.
+ * <p>
+ * This creates a regular option with a
+ * {@link dev.isxander.yacl3.api.controller.ItemControllerBuilder} controller.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface ItemField {
+}
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/DropdownImpl.java b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/DropdownImpl.java
new file mode 100644
index 0000000..c487aab
--- /dev/null
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/DropdownImpl.java
@@ -0,0 +1,19 @@
+package dev.isxander.yacl3.config.v2.impl.autogen;
+
+import dev.isxander.yacl3.api.Option;
+import dev.isxander.yacl3.api.controller.ControllerBuilder;
+import dev.isxander.yacl3.api.controller.DropdownStringControllerBuilder;
+import dev.isxander.yacl3.config.v2.api.ConfigField;
+import dev.isxander.yacl3.config.v2.api.autogen.Dropdown;
+import dev.isxander.yacl3.config.v2.api.autogen.OptionAccess;
+import dev.isxander.yacl3.config.v2.api.autogen.SimpleOptionFactory;
+
+public class DropdownImpl extends SimpleOptionFactory<Dropdown, String> {
+	@Override
+	protected ControllerBuilder<String> createController(Dropdown annotation, ConfigField<String> field, OptionAccess storage, Option<String> option) {
+		return DropdownStringControllerBuilder.create(option)
+				.values(annotation.values())
+				.allowEmptyValue(annotation.allowEmptyValue())
+				.allowAnyValue(annotation.allowAnyValue());
+	}
+}
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/ItemFieldImpl.java b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/ItemFieldImpl.java
new file mode 100644
index 0000000..2802f5c
--- /dev/null
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/ItemFieldImpl.java
@@ -0,0 +1,17 @@
+package dev.isxander.yacl3.config.v2.impl.autogen;
+
+import dev.isxander.yacl3.api.Option;
+import dev.isxander.yacl3.api.controller.ControllerBuilder;
+import dev.isxander.yacl3.api.controller.ItemControllerBuilder;
+import dev.isxander.yacl3.config.v2.api.ConfigField;
+import dev.isxander.yacl3.config.v2.api.autogen.ItemField;
+import dev.isxander.yacl3.config.v2.api.autogen.OptionAccess;
+import dev.isxander.yacl3.config.v2.api.autogen.SimpleOptionFactory;
+import net.minecraft.world.item.Item;
+
+public class ItemFieldImpl extends SimpleOptionFactory<ItemField, Item> {
+	@Override
+	protected ControllerBuilder<Item> createController(ItemField annotation, ConfigField<Item> field, OptionAccess storage, Option<Item> option) {
+		return ItemControllerBuilder.create(option);
+	}
+}
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/OptionFactoryRegistry.java b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/OptionFactoryRegistry.java
index 4bcf5d6..4f6e3c7 100644
--- a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/OptionFactoryRegistry.java
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/autogen/OptionFactoryRegistry.java
@@ -31,6 +31,8 @@ public class OptionFactoryRegistry {
         registerOptionFactory(EnumCycler.class, new EnumCyclerImpl());
         registerOptionFactory(StringField.class, new StringFieldImpl());
         registerOptionFactory(ColorField.class, new ColorFieldImpl());
+        registerOptionFactory(Dropdown.class, new DropdownImpl());
+        registerOptionFactory(ItemField.class, new ItemFieldImpl());
         registerOptionFactory(Label.class, new LabelImpl());
         registerOptionFactory(ListGroup.class, new ListGroupImpl<>());
 
diff --git a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/serializer/GsonConfigSerializer.java b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/serializer/GsonConfigSerializer.java
index 1df9cfb..d308c23 100644
--- a/common/src/main/java/dev/isxander/yacl3/config/v2/impl/serializer/GsonConfigSerializer.java
+++ b/common/src/main/java/dev/isxander/yacl3/config/v2/impl/serializer/GsonConfigSerializer.java
@@ -1,12 +1,16 @@
 package dev.isxander.yacl3.config.v2.impl.serializer;
 
 import com.google.gson.*;
+import dev.isxander.yacl3.config.GsonConfigInstance;
 import dev.isxander.yacl3.config.v2.api.*;
 import dev.isxander.yacl3.config.v2.api.serializer.GsonConfigSerializerBuilder;
+import dev.isxander.yacl3.gui.utils.ItemRegistryHelper;
 import dev.isxander.yacl3.impl.utils.YACLConstants;
 import dev.isxander.yacl3.platform.YACLPlatform;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.Style;
+import net.minecraft.world.item.Item;
 import org.quiltmc.parsers.json.JsonReader;
 import org.quiltmc.parsers.json.JsonWriter;
 import org.quiltmc.parsers.json.gson.GsonReader;
@@ -129,6 +133,18 @@ public class GsonConfigSerializer<T> extends ConfigSerializer<T> {
         }
     }
 
+    public static class ItemTypeAdapter implements JsonSerializer<Item>, JsonDeserializer<Item> {
+        @Override
+        public Item deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
+            return ItemRegistryHelper.getItemFromName(jsonElement.getAsString());
+        }
+
+        @Override
+        public JsonElement serialize(Item item, Type type, JsonSerializationContext jsonSerializationContext) {
+            return new JsonPrimitive(BuiltInRegistries.ITEM.getKey(item).toString());
+        }
+    }
+
     public static class Builder<T> implements GsonConfigSerializerBuilder<T> {
         private final ConfigClassHandler<T> config;
         private Path path;
@@ -139,6 +155,7 @@ public class GsonConfigSerializer<T> extends ConfigSerializer<T> {
                 .registerTypeHierarchyAdapter(Component.class, new Component.Serializer())
                 .registerTypeHierarchyAdapter(Style.class, new Style.Serializer())
                 .registerTypeHierarchyAdapter(Color.class, new ColorTypeAdapter())
+                .registerTypeHierarchyAdapter(Item.class, new ItemTypeAdapter())
                 .setPrettyPrinting();
 
         public Builder(ConfigClassHandler<T> config) {