Merge pull request #442 from searica/config_ext

ConfigFile extension with a convenience method to bind config entries.

JotunnLib/Extensions/ConfigFileExtensions.cs

@@ -0,0 +1,150 @@
+using System;
+using System.Collections.Generic;
+using BepInEx.Configuration;
+
+namespace Jotunn.Extensions
+{
+    /// <summary>
+    ///     Extends ConfigFile with a convenience method to bind config entries with less boilerplate code 
+    ///     and explicitly expose commonly used configuration manager attributes.
+    /// </summary>
+    public static class ConfigFileExtensions
+    {
+        internal class ConfigFileOrderingMaps
+        {
+            public Dictionary<string, int> sectionToSectionNumber = new Dictionary<string, int>();
+            public Dictionary<string, int> sectionToSettingOrder = new Dictionary<string, int>();
+        }
+        private static readonly Dictionary<string, ConfigFileOrderingMaps> _configFileOrderingMaps = new Dictionary<string, ConfigFileOrderingMaps>();
+
+        /// <summary>
+        ///     Formats section name as "{sectionNumber} - {section}" based on how
+        ///     many sections have been bound to this config.
+        /// </summary>
+        /// <param name="section"></param>
+        /// <returns></returns>
+        private static string GetOrderedSectionName(this ConfigFile configFile, string section)
+        {
+            if (!_configFileOrderingMaps.TryGetValue(configFile.ConfigFilePath, out ConfigFileOrderingMaps orderingMaps))
+            {
+                orderingMaps = new ConfigFileOrderingMaps();
+                _configFileOrderingMaps.Add(configFile.ConfigFilePath, orderingMaps);
+            }
+
+            if (!orderingMaps.sectionToSectionNumber.TryGetValue(section, out int number))
+            {
+                number = orderingMaps.sectionToSectionNumber.Count + 1;
+                orderingMaps.sectionToSectionNumber[section] = number;
+            }
+
+            return $"{number} - {section}";
+        }
+
+        /// <summary>
+        ///     Orders settings within a section.
+        /// </summary>
+        /// <param name="section"></param>
+        /// <returns></returns>
+        private static int GetSettingOrder(this ConfigFile configFile, string section)
+        {
+            if (!_configFileOrderingMaps.TryGetValue(configFile.ConfigFilePath, out ConfigFileOrderingMaps orderingMaps))
+            {
+                orderingMaps = new ConfigFileOrderingMaps();
+                _configFileOrderingMaps.Add(configFile.ConfigFilePath, orderingMaps);
+            }
+
+            if (!orderingMaps.sectionToSettingOrder.TryGetValue(section, out int order))
+            {
+                order = 0;
+            }
+
+            orderingMaps.sectionToSettingOrder[section] = order - 1;
+            return order;
+        }
+
+        internal static string GetExtendedDescription(string description, bool synchronizedSetting)
+        {
+            return description + (synchronizedSetting ? " [Synced with Server]" : " [Not Synced with Server]");
+        }
+
+        /// <summary>
+        ///     Bind a new config entry to the config file and modify description to state whether the config entry is synced or not.
+        /// </summary>
+        /// <typeparam name="T">Type of the value the config entry holds.</typeparam>
+        /// <param name="configFile">Configuration file to bind the config entry to.</param>
+        /// <param name="section">Configuration file section to list the config entry in. Settings are grouped by this.</param>
+        /// <param name="key">Name of the setting.</param>
+        /// <param name="defaultValue">Default value of the config entry.</param>
+        /// <param name="description">Plain text description of the config entry to display as hover text in configuration manager.</param>
+        /// <param name="synced">Whether the config entry IsAdminOnly and should be synced with server.</param>
+        /// <param name="sectionOrder">Whether to number the section names using a prefix based on the order they are bound to the config file.</param>
+        /// <param name="settingOrder">Whether to order the settings in each section based on the order they are bound to the config file.</param>
+        /// <param name="acceptableValues">Acceptable values for config entry as an AcceptableValueRange, AcceptableValueList, or custom subclass.</param>
+        /// <param name="customDrawer">Custom setting editor (OnGUI code that replaces the default editor provided by ConfigurationManager).</param>
+        /// <param name="configAttributes">Config manager attributes for additional user specified functionality. Any fields of BindConfig will overwrite properties in configAttributes.</param>
+        /// <returns>ConfigEntry bound to the config file.</returns>
+        public static ConfigEntry<T> BindConfigInOrder<T>(
+            this ConfigFile configFile,
+            string section,
+            string key,
+            T defaultValue,
+            string description,
+            bool synced = true,
+            bool sectionOrder = true,
+            bool settingOrder = true,
+            AcceptableValueBase acceptableValues = null,
+            Action<ConfigEntryBase> customDrawer = null,
+            ConfigurationManagerAttributes configAttributes = null
+        )
+        {
+            section = sectionOrder ? configFile.GetOrderedSectionName(section) : section;
+            int order = settingOrder ? configFile.GetSettingOrder(section) : 0;
+            return configFile.BindConfig(section, key, defaultValue, description, synced, order, acceptableValues, customDrawer, configAttributes);
+        }
+
+        /// <summary>
+        ///     Bind a new config entry to the config file and modify description to state whether the config entry is synced or not.
+        /// </summary>
+        /// <typeparam name="T">Type of the value the config entry holds.</typeparam>
+        /// <param name="configFile">Configuration file to bind the config entry to.</param>
+        /// <param name="section">Configuration file section to list the config entry in. Settings are grouped by this.</param>
+        /// <param name="key">Name of the setting.</param>
+        /// <param name="defaultValue">Default value of the config entry.</param>
+        /// <param name="description">Plain text description of the config entry to display as hover text in configuration manager.</param>
+        /// <param name="synced">Whether the config entry IsAdminOnly and should be synced with server.</param>
+        /// <param name="order">Order of the setting on the settings list relative to other settings in a category. 0 by default, higher number is higher on the list.</param>
+        /// <param name="acceptableValues">Acceptable values for config entry as an AcceptableValueRange, AcceptableValueList, or custom subclass.</param>
+        /// <param name="customDrawer">Custom setting editor (OnGUI code that replaces the default editor provided by ConfigurationManager).</param>
+        /// <param name="configAttributes">Config manager attributes for additional user specified functionality. Any fields of BindConfig will overwrite properties in configAttributes.</param>
+        /// <returns>ConfigEntry bound to the config file.</returns>
+        public static ConfigEntry<T> BindConfig<T>(
+            this ConfigFile configFile,
+            string section,
+            string key,
+            T defaultValue,
+            string description,
+            bool synced = true,
+            int? order = null,
+            AcceptableValueBase acceptableValues = null,
+            Action<ConfigEntryBase> customDrawer = null,
+            ConfigurationManagerAttributes configAttributes = null
+        )
+        {
+            string extendedDescription = GetExtendedDescription(description, synced);
+
+            configAttributes ??= new ConfigurationManagerAttributes();
+            configAttributes.IsAdminOnly = synced;
+            configAttributes.Order = order;
+            configAttributes.CustomDrawer = customDrawer;
+
+            ConfigEntry<T> configEntry = configFile.Bind(
+                section,
+                key,
+                defaultValue,
+                new ConfigDescription(extendedDescription, acceptableValues, configAttributes)
+            );
+
+            return configEntry;
+        }
+    }
+}