Merge pull request #2435 from comintern/next

retailcoder · web-flow · commit a2580e1cfb9a · 2016-12-17T13:15:27.000-05:00
Check for legacy Smart Indenter settings on load.
diff --git a/RetailCoder.VBE/App.cs b/RetailCoder.VBE/App.cs
@@ -146,6 +146,7 @@ public void Startup()
         {
             EnsureLogFolderPathExists();
             LoadConfig();
+            CheckForLegacyIndenterSettings();
             _appMenus.Initialize();
             _stateBar.Initialize();
             _hooks.HookHotkeys(); // need to hook hotkeys before we localize menus, to correctly display ShortcutTexts
@@ -196,6 +197,32 @@ private void LoadConfig()
             }
         }
 
+        private void CheckForLegacyIndenterSettings()
+        {
+            try
+            {
+                Logger.Trace("Checking for legacy Smart Indenter settings.");
+                if (_config.UserSettings.GeneralSettings.SmartIndenterPrompted ||
+                    !_config.UserSettings.IndenterSettings.LegacySettingsExist())
+                {
+                    return;
+                }
+                var response =
+                    _messageBox.Show(RubberduckUI.SmartIndenter_LegacySettingPrompt, "Rubberduck", MessageBoxButtons.YesNo, MessageBoxIcon.Question);
+                if (response == DialogResult.Yes)
+                {
+                    Logger.Trace("Attempting to load legacy Smart Indenter settings.");
+                    _config.UserSettings.IndenterSettings.LoadLegacyFromRegistry();
+                }
+                _config.UserSettings.GeneralSettings.SmartIndenterPrompted = true;
+                _configService.SaveConfiguration(_config);
+            }
+            catch 
+            {
+                //Meh.
+            }
+        }
+
         private bool _disposed;
         public void Dispose()
         {
diff --git a/RetailCoder.VBE/Settings/GeneralSettings.cs b/RetailCoder.VBE/Settings/GeneralSettings.cs
@@ -7,6 +7,7 @@ public interface IGeneralSettings
     {
         DisplayLanguageSetting Language { get; set; }
         bool ShowSplash { get; set; }
+        bool SmartIndenterPrompted { get; set; }
         bool AutoSaveEnabled { get; set; }
         int AutoSavePeriod { get; set; }
         char Delimiter { get; set; }
@@ -18,6 +19,7 @@ public class GeneralSettings : IGeneralSettings
     {
         public DisplayLanguageSetting Language { get; set; }
         public bool ShowSplash { get; set; }
+        public bool SmartIndenterPrompted { get; set; }
         public bool AutoSaveEnabled { get; set; }
         public int AutoSavePeriod { get; set; }
         public char Delimiter { get; set; }
@@ -27,6 +29,7 @@ public GeneralSettings()
         {
             Language = new DisplayLanguageSetting("en-US");
             ShowSplash = true;
+            SmartIndenterPrompted = false;
             AutoSaveEnabled = false;
             AutoSavePeriod = 10;
             Delimiter = '.';
diff --git a/RetailCoder.VBE/UI/RubberduckUI.Designer.cs b/RetailCoder.VBE/UI/RubberduckUI.Designer.cs
diff --git a/RetailCoder.VBE/UI/RubberduckUI.resx b/RetailCoder.VBE/UI/RubberduckUI.resx
@@ -1883,4 +1883,8 @@ End Sub</value>
     <value>references</value>
     <comment>Used to display number of references in commandbar's context selection</comment>
   </data>
+  <data name="SmartIndenter_LegacySettingPrompt" xml:space="preserve">
+    <value>Smart Indenter settings were found in your registry.
+Would you like to import them to Rubberduck?</value>
+  </data>
 </root>
diff --git a/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs b/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs
@@ -17,6 +17,7 @@ public enum DelimiterOptions
     public class GeneralSettingsViewModel : SettingsViewModelBase, ISettingsViewModel
     {
         private readonly IOperatingSystem _operatingSystem;
+        private bool _indenterPrompted;
 
         public GeneralSettingsViewModel(Configuration config, IOperatingSystem operatingSystem)
         {
@@ -166,6 +167,7 @@ private Rubberduck.Settings.GeneralSettings GetCurrentGeneralSettings()
             {
                 Language = SelectedLanguage,
                 ShowSplash = ShowSplashAtStartup,
+                SmartIndenterPrompted = _indenterPrompted,
                 AutoSaveEnabled = AutoSaveEnabled,
                 AutoSavePeriod = AutoSavePeriod,
                 Delimiter = (char)Delimiter,
@@ -178,6 +180,7 @@ private void TransferSettingsToView(IGeneralSettings general, IHotkeySettings ho
             SelectedLanguage = Languages.First(l => l.Code == general.Language.Code);
             Hotkeys = new ObservableCollection<HotkeySetting>(hottkey.Settings);
             ShowSplashAtStartup = general.ShowSplash;
+            _indenterPrompted = general.SmartIndenterPrompted;
             AutoSaveEnabled = general.AutoSaveEnabled;
             AutoSavePeriod = general.AutoSavePeriod;
             Delimiter = (DelimiterOptions)general.Delimiter;
@@ -198,6 +201,8 @@ private void ImportSettings()
                 var general = service.Load(new Rubberduck.Settings.GeneralSettings());
                 var hkService = new XmlPersistanceService<HotkeySettings> { FilePath = dialog.FileName };
                 var hotkey = hkService.Load(new HotkeySettings());
+                //Always assume Smart Indenter registry import has been prompted if importing.
+                general.SmartIndenterPrompted = true;
                 TransferSettingsToView(general, hotkey);
             }
         }
diff --git a/Rubberduck.SmartIndenter/IIndenterSettings.cs b/Rubberduck.SmartIndenter/IIndenterSettings.cs
@@ -18,6 +18,9 @@ public interface IIndenterSettings
         EndOfLineCommentStyle EndOfLineCommentStyle { get; set; }
         int EndOfLineCommentColumnSpaceAlignment { get; set; }
         int IndentSpaces { get; set; }
+
+        bool LegacySettingsExist();
+        void LoadLegacyFromRegistry();
     }
 
     public enum EndOfLineCommentStyle
diff --git a/Rubberduck.SmartIndenter/IndenterSettings.cs b/Rubberduck.SmartIndenter/IndenterSettings.cs
@@ -27,13 +27,20 @@ public class IndenterSettings : IIndenterSettings
         public IndenterSettings()
         {
             var tabWidth = 4;
-            var reg = Registry.CurrentUser.OpenSubKey(@"Software\Microsoft\VBA\6.0\Common", false) ??
-                      Registry.CurrentUser.OpenSubKey(@"Software\Microsoft\VBA\7.0\Common", false);
-            if (reg != null)
+            try
             {
-                tabWidth = Convert.ToInt32(reg.GetValue("TabWidth") ?? tabWidth);
+                var reg = Registry.CurrentUser.OpenSubKey(@"Software\Microsoft\VBA\6.0\Common", false) ??
+                          Registry.CurrentUser.OpenSubKey(@"Software\Microsoft\VBA\7.0\Common", false);
+                if (reg != null)
+                {
+                    tabWidth = Convert.ToInt32(reg.GetValue("TabWidth") ?? tabWidth);
+                }
             }
+            // ReSharper disable once EmptyGeneralCatchClause
+            catch { }
 
+            // Mocking requires these to be virtual.
+            // ReSharper disable DoNotCallOverridableMethodsInConstructor
             IndentEntireProcedureBody = true;
             IndentFirstCommentBlock = true;
             IndentEnumTypeAsProcedure = false;
@@ -50,6 +57,74 @@ public IndenterSettings()
             EndOfLineCommentStyle = EndOfLineCommentStyle.AlignInColumn;
             EndOfLineCommentColumnSpaceAlignment = 50;
             IndentSpaces = tabWidth;
+            // ReSharper restore DoNotCallOverridableMethodsInConstructor
+        }
+
+        private const string LegacySettingsSubKey = @"Software\VB and VBA Program Settings\Office Automation Ltd.\Smart Indenter";
+        public bool LegacySettingsExist()
+        {
+            try
+            {
+                return (Registry.CurrentUser.OpenSubKey(LegacySettingsSubKey, false) != null);
+            }
+            catch 
+            {
+                return false;
+            }
+            
+        }
+
+        public void LoadLegacyFromRegistry()
+        {
+            try
+            {
+                var reg = Registry.CurrentUser.OpenSubKey(LegacySettingsSubKey, false);
+                if (reg == null) return;
+                IndentEntireProcedureBody = GetSmartIndenterBoolean(reg, "IndentProc", IndentEntireProcedureBody);
+                IndentFirstCommentBlock = GetSmartIndenterBoolean(reg, "IndentFirst", IndentFirstCommentBlock);
+                IndentFirstDeclarationBlock = GetSmartIndenterBoolean(reg, "IndentDim", IndentFirstDeclarationBlock);
+                AlignCommentsWithCode = GetSmartIndenterBoolean(reg, "IndentCmt", AlignCommentsWithCode);
+                AlignContinuations = GetSmartIndenterBoolean(reg, "AlignContinued", AlignContinuations);
+                IgnoreOperatorsInContinuations = GetSmartIndenterBoolean(reg, "AlignIgnoreOps",
+                    IgnoreOperatorsInContinuations);
+                IndentCase = GetSmartIndenterBoolean(reg, "IndentCase", IndentCase);
+                ForceDebugStatementsInColumn1 = GetSmartIndenterBoolean(reg, "DebugCol1", ForceDebugStatementsInColumn1);
+                ForceCompilerDirectivesInColumn1 = GetSmartIndenterBoolean(reg, "CompilerCol1",
+                    ForceCompilerDirectivesInColumn1);
+                IndentCompilerDirectives = GetSmartIndenterBoolean(reg, "IndentCompiler", IndentCompilerDirectives);
+                AlignDims = GetSmartIndenterBoolean(reg, "AlignDim", AlignDims);
+                AlignDimColumn = Convert.ToInt32(reg.GetValue("AlignDimCol") ?? AlignDimColumn);
+
+                var eolSytle = reg.GetValue("EOLComments") as string;
+                if (!string.IsNullOrEmpty(eolSytle))
+                {
+                    switch (eolSytle)
+                    {
+                        case "Absolute":
+                            EndOfLineCommentStyle = EndOfLineCommentStyle.Absolute;
+                            break;
+                        case "SameGap":
+                            EndOfLineCommentStyle = EndOfLineCommentStyle.SameGap;
+                            break;
+                        case "StandardGap":
+                            EndOfLineCommentStyle = EndOfLineCommentStyle.StandardGap;
+                            break;
+                        case "AlignInCol":
+                            EndOfLineCommentStyle = EndOfLineCommentStyle.AlignInColumn;
+                            break;
+                    }
+                }
+                EndOfLineCommentColumnSpaceAlignment =
+                    Convert.ToInt32(reg.GetValue("EOLAlignCol") ?? EndOfLineCommentColumnSpaceAlignment);
+            }
+            // ReSharper disable once EmptyGeneralCatchClause
+            catch { }
+        }
+
+        private static bool GetSmartIndenterBoolean(RegistryKey key, string name, bool current)
+        {
+            var value = key.GetValue(name) as string;
+            return string.IsNullOrEmpty(value) ? current : value.Trim().Equals("Y");
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ public enum DelimiterOptions`
`17`	`17`	`public class GeneralSettingsViewModel : SettingsViewModelBase, ISettingsViewModel`
`18`	`18`	`{`
`19`	`19`	`private readonly IOperatingSystem _operatingSystem;`
	`20`	`+ private bool _indenterPrompted;`
`20`	`21`
`21`	`22`	`public GeneralSettingsViewModel(Configuration config, IOperatingSystem operatingSystem)`
`22`	`23`	`{`
`@@ -166,6 +167,7 @@ private Rubberduck.Settings.GeneralSettings GetCurrentGeneralSettings()`
`166`	`167`	`{`
`167`	`168`	`Language = SelectedLanguage,`
`168`	`169`	`ShowSplash = ShowSplashAtStartup,`
	`170`	`+ SmartIndenterPrompted = _indenterPrompted,`
`169`	`171`	`AutoSaveEnabled = AutoSaveEnabled,`
`170`	`172`	`AutoSavePeriod = AutoSavePeriod,`
`171`	`173`	`Delimiter = (char)Delimiter,`
`@@ -178,6 +180,7 @@ private void TransferSettingsToView(IGeneralSettings general, IHotkeySettings ho`
`178`	`180`	`SelectedLanguage = Languages.First(l => l.Code == general.Language.Code);`
`179`	`181`	`Hotkeys = new ObservableCollection<HotkeySetting>(hottkey.Settings);`
`180`	`182`	`ShowSplashAtStartup = general.ShowSplash;`
	`183`	`+ _indenterPrompted = general.SmartIndenterPrompted;`
`181`	`184`	`AutoSaveEnabled = general.AutoSaveEnabled;`
`182`	`185`	`AutoSavePeriod = general.AutoSavePeriod;`
`183`	`186`	`Delimiter = (DelimiterOptions)general.Delimiter;`
`@@ -198,6 +201,8 @@ private void ImportSettings()`
`198`	`201`	`var general = service.Load(new Rubberduck.Settings.GeneralSettings());`
`199`	`202`	`var hkService = new XmlPersistanceService<HotkeySettings> { FilePath = dialog.FileName };`
`200`	`203`	`var hotkey = hkService.Load(new HotkeySettings());`
	`204`	`+ //Always assume Smart Indenter registry import has been prompted if importing.`
	`205`	`+ general.SmartIndenterPrompted = true;`
`201`	`206`	`TransferSettingsToView(general, hotkey);`
`202`	`207`	`}`
`203`	`208`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@ public interface IIndenterSettings`
`18`	`18`	`EndOfLineCommentStyle EndOfLineCommentStyle { get; set; }`
`19`	`19`	`int EndOfLineCommentColumnSpaceAlignment { get; set; }`
`20`	`20`	`int IndentSpaces { get; set; }`
	`21`	`+`
	`22`	`+ bool LegacySettingsExist();`
	`23`	`+ void LoadLegacyFromRegistry();`
`21`	`24`	`}`
`22`	`25`
`23`	`26`	`public enum EndOfLineCommentStyle`