From 21f2529e97df51dd775093fe16d059e378010b1d Mon Sep 17 00:00:00 2001
From: morkt <muvluv.ru@gmail.com>
Date: Thu, 11 Jan 2018 18:38:33 +0400
Subject: [PATCH] (ISettingsManager): new public interface.

---
 GameRes/FormatCatalog.cs                | 32 ++++++++++++++++++++-----
 GameRes/Properties/Settings.Designer.cs | 12 ++++++++++
 GameRes/Properties/Settings.settings    |  3 +++
 GameRes/ResourceSettings.cs             | 17 +++++++++++++
 GameRes/app.config                      |  3 +++
 5 files changed, 61 insertions(+), 6 deletions(-)

diff --git a/GameRes/FormatCatalog.cs b/GameRes/FormatCatalog.cs
index 8d62ee28..eebedb7e 100644
--- a/GameRes/FormatCatalog.cs
+++ b/GameRes/FormatCatalog.cs
@@ -49,6 +49,8 @@ namespace GameRes
         private IEnumerable<AudioFormat>    m_audio_formats;
         [ImportMany(typeof(ScriptFormat))]
         private IEnumerable<ScriptFormat>   m_script_formats;
+        [ImportMany(typeof(ISettingsManager))]
+        private IEnumerable<ISettingsManager> m_settings_managers;
         #pragma warning restore 649
 
         private MultiValueDictionary<string, IResource> m_extension_map = new MultiValueDictionary<string, IResource>();
@@ -107,11 +109,6 @@ namespace GameRes
             }
         }
 
-        public void SaveSettings ()
-        {
-            Properties.Settings.Default.Save();
-        }
-
         private void AddResourceImpl (IEnumerable<IResource> formats, CompositionContainer container)
         {
             foreach (var impl in formats)
@@ -137,6 +134,29 @@ namespace GameRes
             }
         }
 
+        public void UpgradeSettings ()
+        {
+            if (Properties.Settings.Default.UpgradeRequired)
+            {
+                Properties.Settings.Default.Upgrade();
+                Properties.Settings.Default.UpgradeRequired = false;
+                Properties.Settings.Default.Save();
+            }
+            foreach (var mgr in m_settings_managers)
+            {
+                mgr.UpgradeSettings();
+            }
+        }
+
+        public void SaveSettings ()
+        {
+            Properties.Settings.Default.Save();
+            foreach (var mgr in m_settings_managers)
+            {
+                mgr.SaveSettings();
+            }
+        }
+
         /// <summary>
         /// Look up filename in format registry by filename extension and return corresponding interfaces.
         /// if no formats available, return empty range.
@@ -320,7 +340,7 @@ namespace GameRes
         }
 
         /// <summary>
-        /// Read text file <paramref name="filename"/> from data directory, performing <paramref name="process_line"/> action on each line.
+        /// Read text file <paramref name="filename"/> from data directory, performing <paramref name="process_line"/> action on each non-empty line.
         /// </summary>
         public void ReadFileList (string filename, Action<string> process_line)
         {
diff --git a/GameRes/Properties/Settings.Designer.cs b/GameRes/Properties/Settings.Designer.cs
index 0c57d68a..b147338a 100644
--- a/GameRes/Properties/Settings.Designer.cs
+++ b/GameRes/Properties/Settings.Designer.cs
@@ -34,5 +34,17 @@ namespace GameRes.Properties {
                 this["BMPEnableExtensions"] = value;
             }
         }
+        
+        [global::System.Configuration.UserScopedSettingAttribute()]
+        [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]
+        [global::System.Configuration.DefaultSettingValueAttribute("True")]
+        public bool UpgradeRequired {
+            get {
+                return ((bool)(this["UpgradeRequired"]));
+            }
+            set {
+                this["UpgradeRequired"] = value;
+            }
+        }
     }
 }
diff --git a/GameRes/Properties/Settings.settings b/GameRes/Properties/Settings.settings
index 52b5370a..549aaf77 100644
--- a/GameRes/Properties/Settings.settings
+++ b/GameRes/Properties/Settings.settings
@@ -5,5 +5,8 @@
     <Setting Name="BMPEnableExtensions" Type="System.Boolean" Scope="User">
       <Value Profile="(Default)">True</Value>
     </Setting>
+    <Setting Name="UpgradeRequired" Type="System.Boolean" Scope="User">
+      <Value Profile="(Default)">True</Value>
+    </Setting>
   </Settings>
 </SettingsFile>
\ No newline at end of file
diff --git a/GameRes/ResourceSettings.cs b/GameRes/ResourceSettings.cs
index 233cd9f2..cd021fa7 100644
--- a/GameRes/ResourceSettings.cs
+++ b/GameRes/ResourceSettings.cs
@@ -52,6 +52,23 @@ namespace GameRes
         object Value { get; set; }
     }
 
+    /// <summary>
+    /// Manage assembly settings during application session. Implementations of this interface are made
+    /// available to GameRes library by means of MEF.
+    /// </summary>
+    public interface ISettingsManager
+    {
+        /// <summary>
+        /// Called on application startup to check if settings need upgrading after assembly version change.
+        /// </summary>
+        void UpgradeSettings ();
+
+        /// <summary>
+        /// Called on application exit.
+        /// </summary>
+        void SaveSettings ();
+    }
+
     public abstract class ResourceSettingBase : IResourceSetting
     {
         public string        Name { get; set; }
diff --git a/GameRes/app.config b/GameRes/app.config
index c5e2a39c..e9cd7531 100644
--- a/GameRes/app.config
+++ b/GameRes/app.config
@@ -10,6 +10,9 @@
             <setting name="BMPEnableExtensions" serializeAs="String">
                 <value>True</value>
             </setting>
+            <setting name="UpgradeRequired" serializeAs="String">
+                <value>True</value>
+            </setting>
         </GameRes.Properties.Settings>
     </userSettings>
 </configuration>
\ No newline at end of file