Major config system upgrade

Author: FalsePattern

src/main/java/com/falsepattern/lib/config/Config.java

@@ -35,6 +35,11 @@ public ConfigException(String message) {
         super(message);
     }
 
+    @StableAPI.Internal
+    public ConfigException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
     @StableAPI.Internal
     public ConfigException(Throwable cause) {
         super(cause);

src/main/java/com/falsepattern/lib/config/ConfigException.java

@@ -30,6 +30,7 @@
 import lombok.SneakyThrows;
 import lombok.val;
 
+import cpw.mods.fml.client.config.DummyConfigElement;
 import cpw.mods.fml.client.config.IConfigElement;
 
 import java.lang.reflect.Field;
@@ -138,4 +139,20 @@ public static List<IConfigElement> getConfigElementsMulti(Class<?>... configClas
                 return result;
         }
     }
+    /**
+     * @return The configuration elements, structured with DummyCategoryElement groups per config class
+     * @see #getConfigElementsMulti(Class[]) 
+     */
+    @SuppressWarnings("rawtypes")
+    @StableAPI.Expose(since = "1.5.0")
+    public static List<IConfigElement> getConfigElementsMultiStructured(Class<?>... configClasses) throws ConfigException {
+        if (configClasses.length == 0) {
+            return Collections.emptyList();
+        }
+        val result = new ArrayList<IConfigElement>();
+        for (val configClass: configClasses) {
+            result.add(ConfigurationManagerImpl.getConfigCategoryElement(configClass));
+        }
+        return result;
+    }
 }

src/main/java/com/falsepattern/lib/config/ConfigurationManager.java

@@ -40,14 +40,20 @@ public SimpleGuiConfig(GuiScreen parent, Class<?> configClass, String modID, Str
     }
 
     @StableAPI.Expose(since = "0.10.0")
-    public SimpleGuiConfig(GuiScreen parent, String modID, String modName, Class<?>... configClasses)
+    public SimpleGuiConfig(GuiScreen parent, String modID, String title, Class<?>... configClasses)
+            throws ConfigException {
+        this(parent, modID, title, null, configClasses);
+    }
+
+    @StableAPI.Expose(since = "1.5.0")
+    public SimpleGuiConfig(GuiScreen parent, String modID, String title, String titleLine2, Class<?>... configClasses)
             throws ConfigException {
         super(parent,
-              ConfigurationManager.getConfigElementsMulti(configClasses),
+              ConfigurationManager.getConfigElementsMultiStructured(configClasses),
               modID,
               false,
               false,
-              modName + " Configuration",
-              I18n.format("falsepatternlib.gui.config.description"));
+              title,
+              titleLine2);
     }
 }

src/main/java/com/falsepattern/lib/config/SimpleGuiConfig.java

@@ -27,7 +27,11 @@
 import com.falsepattern.lib.config.ConfigurationManager;
 import com.falsepattern.lib.internal.Tags;
 
-@Config(modid = Tags.MODID)
+@Config.Comment("Miscellaneous FalsePatternLib settings")
+@Config.LangKey
+@Config(modid = Tags.MODID,
+        category = "misc",
+        categoryMigrations = "general")
 public class LibraryConfig {
     static {
         ConfigurationManager.selfInit();
@@ -36,14 +40,19 @@ public class LibraryConfig {
     @Config.Comment({"Fixes the mod options menu in-game.",
                      "By default, the mod options when in already in a game will show \"Test1, Test2, DISABLED\" in bright red.",
                      "This replaces that interface with the one from the main menu."})
-    @Config.LangKey("config.falsepatternlib.ingamemodoptionsfix")
+    @Config.LangKey
     @Config.DefaultBoolean(true)
+    @Config.Name(value = "inGameModOptionsFix",
+                 migrations = "")
     public static boolean IN_GAME_MOD_OPTIONS_FIX;
 
-    @Config.Comment("How \"loud\" the config error logging should be.")
-    @Config.LangKey("config.falsepatternlib.configlogging")
+    @Config.Comment({"How the config error logging should be set up.",
+                    "[None] disables all built-in config validation error logging"})
+    @Config.LangKey
     @Config.DefaultEnum("Log")
-    public static ValidationLogging CONFIG_ERROR_LOUDNESS;
+    @Config.Name(value = "configErrorLogging",
+                 migrations = "CONFIG_ERROR_LOUDNESS")
+    public static ValidationLogging CONFIG_ERROR_LOGGING;
 
     public enum ValidationLogging {
         @StableAPI.Expose(since = "__INTERNAL__") None,

src/main/java/com/falsepattern/lib/internal/config/LibraryConfig.java

@@ -27,34 +27,38 @@
 import com.falsepattern.lib.config.ConfigurationManager;
 import com.falsepattern.lib.internal.Tags;
 
-import cpw.mods.fml.relauncher.Side;
-import cpw.mods.fml.relauncher.SideOnly;
-
-@SideOnly(Side.CLIENT)
+@Config.Comment("Toast notification settings")
+@Config.LangKey
 @Config(modid = Tags.MODID,
         category = "toasts")
 public class ToastConfig {
     static {
         ConfigurationManager.selfInit();
     }
 
-    @Config.Comment("The maximum amount of toasts to show on the screen")
-    @Config.LangKey("config.falsepatternlib.maxtoasts")
+    @Config.Comment("The maximum amount of toasts to show on the screen.")
+    @Config.LangKey
     @Config.DefaultInt(5)
     @Config.RangeInt(min = 1,
                      max = 10)
+    @Config.Name(value = "maxVisible",
+                 migrations = "")
     public static int MAX_VISIBLE;
 
-    @Config.Comment("The amount of empty space from the top of the screen in pixels")
-    @Config.LangKey("config.falsepatternlib.toastoffset")
+    @Config.Comment("The amount of empty space from the top of the screen in pixels.")
+    @Config.LangKey
     @Config.DefaultInt(0)
     @Config.RangeInt(min = 0,
                      max = 10000)
+    @Config.Name(value = "yOffset",
+                 migrations = "")
     public static int Y_OFFSET;
 
-    @Config.Comment("Which side of the screen should toasts show up on")
-    @Config.LangKey("config.falsepatternlib.toastalign")
+    @Config.Comment("Which side of the screen should toasts show up on.")
+    @Config.LangKey
     @Config.DefaultEnum("Right")
+    @Config.Name(value = "align",
+                 migrations = "")
     public static Side ALIGN;
 
     public static boolean leftAlign() {

src/main/java/com/falsepattern/lib/internal/config/ToastConfig.java

@@ -35,10 +35,12 @@
 
 public class ConfigElementProxy<T> implements IConfigElement<T> {
     private final ConfigElement<T> element;
+    private final String comment;
     private final Runnable syncCallback;
 
-    public ConfigElementProxy(Property prop, Runnable syncCallback) {
+    public ConfigElementProxy(Property prop, String comment, Runnable syncCallback) {
         this.element = new ConfigElement<>(prop);
+        this.comment = comment;
         this.syncCallback = syncCallback;
     }
 
@@ -74,14 +76,15 @@ public String getLanguageKey() {
 
     @Override
     public String getComment() {
-        return element.getComment();
+        return comment;
     }
 
     @Override
     public List<IConfigElement> getChildElements() {
         return element.getChildElements();
     }
 
+    // Caller sensitive
     @Override
     public ConfigGuiType getType() {
         return element.getType();

src/main/java/com/falsepattern/lib/internal/impl/config/ConfigElementProxy.java

@@ -0,0 +1,38 @@
+/*
+ * This file is part of FalsePatternLib.
+ *
+ * Copyright (C) 2022-2024 FalsePattern
+ * All Rights Reserved
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * FalsePatternLib is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * FalsePatternLib is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with FalsePatternLib. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.falsepattern.lib.internal.impl.config;
+
+import com.github.bsideup.jabel.Desugar;
+
+import net.minecraftforge.common.config.Configuration;
+
+import java.lang.reflect.Field;
+
+@Desugar
+public record ConfigFieldParameters(
+        Field field,
+        Configuration configuration,
+        String modid,
+        String category
+) {}

src/main/java/com/falsepattern/lib/internal/impl/config/ConfigFieldParameters.java

@@ -34,8 +34,11 @@
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 import lombok.val;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import net.minecraftforge.common.config.Configuration;
+import cpw.mods.fml.client.config.DummyConfigElement;
 import cpw.mods.fml.client.config.IConfigElement;
 import cpw.mods.fml.client.event.ConfigChangedEvent;
 
@@ -47,6 +50,7 @@
 import java.io.DataOutputStream;
 import java.io.IOException;
 import java.lang.reflect.Field;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -64,7 +68,7 @@
  */
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public final class ConfigurationManagerImpl {
-    private static final Map<String, Configuration> configs = new HashMap<>();
+    private static final Map<Path, Configuration> configs = new HashMap<>();
     private static final Map<Configuration, Set<Class<?>>> configToClassMap = new HashMap<>();
     private static final Map<Class<?>, ParsedConfiguration> parsedConfigMap = new HashMap<>();
     private static final BiMap<String, Class<?>> serializedNames = HashBiMap.create();
@@ -81,9 +85,33 @@ public static void register(Class<?> configClass) throws ConfigException {
         }
     }
 
-    static Configuration getForgeConfig(String modid) {
-        return configs.computeIfAbsent(modid, (ignored) -> {
-            val c = new Configuration(configDir.resolve(modid + ".cfg").toFile());
+    private static @Nullable Path resolveConfigFile(String pathSuffix, boolean create) throws ConfigException {
+        var thePath = configDir.resolve(pathSuffix);
+        val parent = thePath.getParent();
+        if (!Files.exists(parent)) {
+            if (!create) {
+                return null;
+            }
+            try {
+                Files.createDirectories(parent);
+            } catch (IOException e) {
+                throw new ConfigException(String.format("Failed to create config parent directory at %s", parent), e);
+            }
+        }
+        val fileName = thePath.getFileName().toString();
+        if (!fileName.contains(".")) {
+            thePath = parent.resolve(fileName + ".cfg");
+        }
+        return thePath;
+    }
+
+    static @NotNull Configuration getForgeConfig(String pathSuffix, boolean create) throws ConfigException {
+        val thePath = resolveConfigFile(pathSuffix, create);
+        if (thePath == null || !(create || Files.exists(thePath))) {
+            throw new ConfigException(String.format("Could not find config file at %s", pathSuffix));
+        }
+        return configs.computeIfAbsent(thePath, (ignored) -> {
+            val c = new Configuration(thePath.toFile());
             c.load();
             return c;
         });
@@ -93,14 +121,14 @@ public static void load(Class<?> configClass) throws ConfigException {
         if (!parsedConfigMap.containsKey(configClass)) {
             throw new ConfigException("Class " + configClass.getName() + " is not a registered configuration!");
         }
-        parsedConfigMap.get(configClass).load();
+        parsedConfigMap.get(configClass).loadFile();
     }
 
     public static void save(Class<?> configClass) throws ConfigException {
         if (!parsedConfigMap.containsKey(configClass)) {
             throw new ConfigException("Class " + configClass.getName() + " is not a registered configuration!");
         }
-        parsedConfigMap.get(configClass).save();
+        parsedConfigMap.get(configClass).saveFile();
     }
 
     public static boolean validateFields(BiConsumer<Class<?>, Field> invalidFieldHandler, Class<?> configClass, boolean resetInvalid)
@@ -235,6 +263,21 @@ private static void init() {
         initialized = true;
     }
 
+    public static DummyConfigElement.DummyCategoryElement<?> getConfigCategoryElement(Class<?> configClass) throws ConfigException {
+        if (!parsedConfigMap.containsKey(configClass)) {
+            throw new ConfigException("Class " + configClass.getName() + " is not a registered configuration!");
+        }
+        val config = parsedConfigMap.get(configClass);
+        val entry = new DummyConfigElement.DummyCategoryElement<>(
+                config.category,
+                config.langKey,
+                config.getConfigElements()
+        );
+        entry.setRequiresWorldRestart(config.requiresWorldRestart());
+        entry.setRequiresMcRestart(config.requiresMcRestart());
+        return entry;
+    }
+
     public static void sendSyncRequest() throws IOException {
         val event = new SyncRequest();
         event.transmit();