Introduce ConfigSection wrapper to hide ML in ModConfiguration

Author: Banane9

MonkeyLoader.GamePacks.ResoniteModLoader/IModConfigurationDefinition.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+
+namespace ResoniteModLoader
+{
+    /// <summary>
+    /// Represents an interface for mod configurations.
+    /// </summary>
+    public interface IModConfigurationDefinition
+    {
+        /// <summary>
+        /// Gets the set of configuration keys defined in this configuration definition.
+        /// </summary>
+        ISet<ModConfigurationKey> ConfigurationItemDefinitions { get; }
+
+        /// <summary>
+        /// Gets the mod that owns this configuration definition.
+        /// </summary>
+        ResoniteModBase Owner { get; }
+
+        /// <summary>
+        /// Gets the semantic version for this configuration definition. This is used to check if the defined and saved configs are compatible.
+        /// </summary>
+        Version Version { get; }
+    }
+}

MonkeyLoader.GamePacks.ResoniteModLoader/IncompatibleConfigurationHandlingOption.cs

@@ -0,0 +1,25 @@
+using MonkeyLoader.Configuration;
+
+namespace ResoniteModLoader
+{
+    /// <summary>
+    /// Defines options for the handling of incompatible configuration versions.
+    /// </summary>
+    public enum IncompatibleConfigurationHandlingOption
+    {
+        /// <summary>
+        /// Fail to read the config, and block saving over the config on disk.
+        /// </summary>
+        ERROR = IncompatibleConfigHandling.Error,
+
+        /// <summary>
+        /// Destroy the saved config and start over from scratch.
+        /// </summary>
+        CLOBBER = IncompatibleConfigHandling.Clobber,
+
+        /// <summary>
+        /// Ignore the version number and attempt to load the config from disk.
+        /// </summary>
+        FORCELOAD = IncompatibleConfigHandling.ForceLoad,
+    }
+}

MonkeyLoader.GamePacks.ResoniteModLoader/ModConfiguration.cs

@@ -1,94 +1,36 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
-using System.IO;
-using System.Linq;
 using EnumerableToolkit;
-using FrooxEngine;
-using HarmonyLib;
 using MonkeyLoader;
-using MonkeyLoader.Configuration;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace ResoniteModLoader
 {
     /// <summary>
-    /// Represents an interface for mod configurations.
-    /// </summary>
-    public interface IModConfigurationDefinition
-    {
-        /// <summary>
-        /// Gets the set of configuration keys defined in this configuration definition.
-        /// </summary>
-        ISet<ModConfigurationKey> ConfigurationItemDefinitions { get; }
-
-        /// <summary>
-        /// Gets the mod that owns this configuration definition.
-        /// </summary>
-        ResoniteModBase Owner { get; }
-
-        /// <summary>
-        /// Gets the semantic version for this configuration definition. This is used to check if the defined and saved configs are compatible.
-        /// </summary>
-        Version Version { get; }
-    }
-
-    /// <summary>
-    /// Defines options for the handling of incompatible configuration versions.
+    /// The configuration for a mod. Each mod has zero or one configuration. The configuration object will never be reassigned once initialized.
     /// </summary>
-    public enum IncompatibleConfigurationHandlingOption
+    public class ModConfiguration : IModConfigurationDefinition
     {
-        /// <summary>
-        /// Fail to read the config, and block saving over the config on disk.
-        /// </summary>
-        ERROR = IncompatibleConfigHandling.Error,
+        internal ModConfigurationDefinition Definition { get; }
 
         /// <summary>
-        /// Destroy the saved config and start over from scratch.
+        /// Gets the internal <see cref="MonkeyLoader.Configuration.ConfigSection"/>
+        /// that actually handles storing the data for this.
         /// </summary>
-        CLOBBER = IncompatibleConfigHandling.Clobber,
-
-        /// <summary>
-        /// Ignore the version number and attempt to load the config from disk.
-        /// </summary>
-        FORCELOAD = IncompatibleConfigHandling.ForceLoad,
-    }
-
-    /// <summary>
-    /// The configuration for a mod. Each mod has zero or one configuration. The configuration object will never be reassigned once initialized.
-    /// </summary>
-    public class ModConfiguration : ConfigSection, IModConfigurationDefinition
-    {
-        private readonly ModConfigurationDefinition _definition;
-
-        /// <inheritdoc/>
-        public ISet<ModConfigurationKey> ConfigurationItemDefinitions => _definition.ConfigurationItemDefinitions;
-
-        /// <inheritdoc/>
-        public override string Description => "RML Mod Config";
+        internal RmlModConfigSection ConfigSection { get; }
 
         /// <inheritdoc/>
-        public override string Id => "values";
+        public Version Version => Definition.Version;
 
         /// <inheritdoc/>
-        public ResoniteModBase Owner => _definition.Owner;
+        public ISet<ModConfigurationKey> ConfigurationItemDefinitions => Definition.ConfigurationItemDefinitions;
 
         /// <inheritdoc/>
-        public override Version Version => _definition.Version;
+        public ResoniteModBase Owner => Definition.Owner;
 
         internal ModConfiguration(ModConfigurationDefinition definition)
         {
-            _definition = definition;
-        }
-
-        /// <inheritdoc/>
-        protected override IncompatibleConfigHandling HandleIncompatibleVersions(Version serializedVersion)
-        {
-            if (Owner is ResoniteMod resoniteMod)
-                return (IncompatibleConfigHandling)resoniteMod.HandleIncompatibleConfigurationVersions(serializedVersion, Version);
-
-            return base.HandleIncompatibleVersions(serializedVersion);
+            Definition = definition;
+            ConfigSection = new(this);
         }
 
         /// <summary>
@@ -97,7 +39,8 @@ protected override IncompatibleConfigHandling HandleIncompatibleVersions(Version
         /// <param name="key">The key to get the value for.</param>
         /// <returns>The value for the key.</returns>
         /// <exception cref="KeyNotFoundException">The given key does not exist in the configuration.</exception>
-        public object GetValue(ModConfigurationKey key) => GetDefinedKey(key.UntypedKey).GetValue()!;
+        public object GetValue(ModConfigurationKey key)
+            => ConfigSection.GetDefinedKey(key.UntypedKey).GetValue()!;
 
         /// <summary>
         /// Get a value, throwing a <see cref="KeyNotFoundException"/> if the key is not found.
@@ -106,14 +49,16 @@ protected override IncompatibleConfigHandling HandleIncompatibleVersions(Version
         /// <param name="key">The key to get the value for.</param>
         /// <returns>The value for the key.</returns>
         /// <exception cref="KeyNotFoundException">The given key does not exist in the configuration.</exception>
-        public T? GetValue<T>(ModConfigurationKey<T> key) => GetDefinedKey(key.Key).GetValue();
+        public T? GetValue<T>(ModConfigurationKey<T> key)
+            => ConfigSection.GetDefinedKey(key.Key).GetValue();
 
         /// <summary>
         /// Checks if the given key is defined in this config.
         /// </summary>
         /// <param name="key">The key to check.</param>
         /// <returns><c>true</c> if the key is defined.</returns>
-        public bool IsKeyDefined(ModConfigurationKey key) => TryGetDefinedKey(key.UntypedKey, out _);
+        public bool IsKeyDefined(ModConfigurationKey key)
+            => ConfigSection.TryGetDefinedKey(key.UntypedKey, out _);
 
         /// <summary>
         /// Persist this configuration to disk.<br/>
@@ -125,7 +70,8 @@ protected override IncompatibleConfigHandling HandleIncompatibleVersions(Version
         /// </remarks>
 #pragma warning disable IDE0060 // Remove unused parameter
 
-        public void Save(bool saveDefaultValues = false) => Config.Save();
+        public void Save(bool saveDefaultValues = false)
+            => ConfigSection.Config.Save();
 
 #pragma warning restore IDE0060 // Remove unused parameter
 
@@ -139,7 +85,7 @@ protected override IncompatibleConfigHandling HandleIncompatibleVersions(Version
         /// <exception cref="KeyNotFoundException">The given key does not exist in the configuration.</exception>
         /// <exception cref="ArgumentException">The new value is not valid for the given key.</exception>
         public void Set(ModConfigurationKey key, object? value, string? eventLabel = null)
-            => GetDefinedKey(key.UntypedKey).SetValue(value, eventLabel);
+            => ConfigSection.GetDefinedKey(key.UntypedKey).SetValue(value, eventLabel);
 
         /// <summary>
         /// Sets a configuration value for the given key, throwing a <see cref="KeyNotFoundException"/> if the key is not found
@@ -152,7 +98,7 @@ public void Set(ModConfigurationKey key, object? value, string? eventLabel = nul
         /// <exception cref="KeyNotFoundException">The given key does not exist in the configuration.</exception>
         /// <exception cref="ArgumentException">The new value is not valid for the given key.</exception>
         public void Set<T>(ModConfigurationKey<T> key, T value, string? eventLabel = null)
-            => GetDefinedKey(key.Key).SetValue(value, eventLabel);
+            => ConfigSection.GetDefinedKey(key.Key).SetValue(value, eventLabel);
 
         /// <summary>
         /// Tries to get a value, returning <c>default</c> if the key is not found.
@@ -162,7 +108,7 @@ public void Set<T>(ModConfigurationKey<T> key, T value, string? eventLabel = nul
         /// <returns><c>true</c> if the value was read successfully.</returns>
         public bool TryGetValue(ModConfigurationKey key, out object? value)
         {
-            if (TryGetDefinedKey(key.UntypedKey, out var definingKey))
+            if (ConfigSection.TryGetDefinedKey(key.UntypedKey, out var definingKey))
             {
                 value = definingKey.GetValue();
                 return true;
@@ -180,7 +126,7 @@ public bool TryGetValue(ModConfigurationKey key, out object? value)
         /// <returns><c>true</c> if the value was read successfully.</returns>
         public bool TryGetValue<T>(ModConfigurationKey<T> key, out T? value)
         {
-            if (TryGetDefinedKey(key.Key, out var definingKey))
+            if (ConfigSection.TryGetDefinedKey(key.Key, out var definingKey))
             {
                 value = definingKey.GetValue();
                 return true;
@@ -196,7 +142,8 @@ public bool TryGetValue<T>(ModConfigurationKey<T> key, out T? value)
         /// <param name="key">The key to remove the value for.</param>
         /// <returns><c>true</c> if a value was successfully found and removed, <c>false</c> if there was no value to remove.</returns>
         /// <exception cref="KeyNotFoundException">The given key does not exist in the configuration.</exception>
-        public bool Unset(ModConfigurationKey key) => GetDefinedKey(key.UntypedKey).Unset();
+        public bool Unset(ModConfigurationKey key)
+            => ConfigSection.GetDefinedKey(key.UntypedKey).Unset();
 
         internal void FireConfigurationChangedEvent(ModConfigurationKey key, string? label)
         {
@@ -208,7 +155,7 @@ internal void FireConfigurationChangedEvent(ModConfigurationKey key, string? lab
             }
             catch (AggregateException ex)
             {
-                Config.Logger.Error(() => ex.Format($"An OnAnyConfigurationChanged event subscriber threw an exception:"));
+                ConfigSection.Config.Logger.Error(() => ex.Format($"An OnAnyConfigurationChanged event subscriber threw an exception:"));
             }
 
             try
@@ -217,14 +164,10 @@ internal void FireConfigurationChangedEvent(ModConfigurationKey key, string? lab
             }
             catch (AggregateException ex)
             {
-                Config.Logger.Error(() => ex.Format($"An OnThisConfigurationChanged event subscriber threw an exception:"));
+                ConfigSection.Config.Logger.Error(() => ex.Format($"An OnThisConfigurationChanged event subscriber threw an exception:"));
             }
         }
 
-        /// <inheritdoc/>
-        protected override IEnumerable<IDefiningConfigKey> GetConfigKeys()
-            => _definition.ConfigurationItemDefinitions.Select(item => item.UntypedKey);
-
         /// <summary>
         /// Called if any config value for any mod changed.
         /// </summary>
@@ -241,39 +184,4 @@ protected override IEnumerable<IDefiningConfigKey> GetConfigKeys()
         /// </summary>
         public event ConfigurationChangedHandler? OnThisConfigurationChanged;
     }
-
-    /// <summary>
-    /// Defines a mod configuration. This should be defined by a <see cref="ResoniteMod"/> using the <see cref="ResoniteMod.DefineConfiguration(ModConfigurationDefinitionBuilder)"/> method.
-    /// </summary>
-    public class ModConfigurationDefinition : IModConfigurationDefinition
-    {
-        internal readonly HashSet<ModConfigurationKey> ConfigurationItems;
-        internal bool AutoSave;
-
-        /// <inheritdoc/>
-        // clone the collection because I don't trust giving public API users shallow copies one bit
-        public ISet<ModConfigurationKey> ConfigurationItemDefinitions
-            => new HashSet<ModConfigurationKey>(ConfigurationItems);
-
-        /// <inheritdoc/>
-        public ResoniteModBase Owner { get; private set; }
-
-        /// <inheritdoc/>
-        public Version Version { get; private set; }
-
-        /// <summary>
-        /// Creates a new <see cref="ModConfiguration"/> definition.
-        /// </summary>
-        /// <param name="owner">The mod owning the config.</param>
-        /// <param name="configVersion">The version of the config.</param>
-        /// <param name="keys">The config keys for the config.</param>
-        /// <param name="autoSaveConfig">Whether to automatically save the config.</param>
-        public ModConfigurationDefinition(ResoniteModBase owner, Version configVersion, HashSet<ModConfigurationKey> keys, bool autoSaveConfig)
-        {
-            Owner = owner;
-            Version = configVersion;
-            ConfigurationItems = [.. keys];
-            AutoSave = autoSaveConfig;
-        }
-    }
 }

MonkeyLoader.GamePacks.ResoniteModLoader/ModConfigurationDefinition.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+
+namespace ResoniteModLoader
+{
+    /// <summary>
+    /// Defines a mod configuration. This should be defined by a <see cref="ResoniteMod"/> using the <see cref="ResoniteMod.DefineConfiguration(ModConfigurationDefinitionBuilder)"/> method.
+    /// </summary>
+    public class ModConfigurationDefinition : IModConfigurationDefinition
+    {
+        internal readonly HashSet<ModConfigurationKey> ConfigurationItems;
+        internal bool AutoSave;
+
+        /// <inheritdoc/>
+        // clone the collection because I don't trust giving public API users shallow copies one bit
+        public ISet<ModConfigurationKey> ConfigurationItemDefinitions
+            => new HashSet<ModConfigurationKey>(ConfigurationItems);
+
+        /// <inheritdoc/>
+        public ResoniteModBase Owner { get; private set; }
+
+        /// <inheritdoc/>
+        public Version Version { get; private set; }
+
+        /// <summary>
+        /// Creates a new <see cref="ModConfiguration"/> definition.
+        /// </summary>
+        /// <param name="owner">The mod owning the config.</param>
+        /// <param name="configVersion">The version of the config.</param>
+        /// <param name="keys">The config keys for the config.</param>
+        /// <param name="autoSaveConfig">Whether to automatically save the config.</param>
+        public ModConfigurationDefinition(ResoniteModBase owner, Version configVersion, HashSet<ModConfigurationKey> keys, bool autoSaveConfig)
+        {
+            Owner = owner;
+            Version = configVersion;
+            ConfigurationItems = [.. keys];
+            AutoSave = autoSaveConfig;
+        }
+    }
+}

MonkeyLoader.GamePacks.ResoniteModLoader/ModConfigurationKey.cs

@@ -146,7 +146,7 @@ public T? Value
 
         internal override IDefiningConfigKey UntypedKey => Key;
 
-        private ModConfiguration ModConfiguration => (ModConfiguration)Key.Section;
+        private ModConfiguration ModConfiguration => ((RmlModConfigSection)Key.Section).ModConfiguration;
 
         /// <summary>
         /// Creates a new instance of the <see cref="ModConfigurationKey{T}"/> class with the given parameters.

MonkeyLoader.GamePacks.ResoniteModLoader/ResoniteMod.cs

@@ -34,7 +34,10 @@ protected ResoniteMod()
                 if (BuildConfigurationDefinition() is not ModConfigurationDefinition definition)
                     return null;
 
-                return Config.LoadSection(new ModConfiguration(definition));
+                var modConfiguration = new ModConfiguration(definition);
+                Config.LoadSection(modConfiguration.ConfigSection);
+
+                return modConfiguration;
             });
         }