Merge pull request #3783 from bclothier/CompileBeforeParse

retailcoder · web-flow · commit 8db3f69aa69c · 2018-02-23T10:05:52.000-05:00
Introducing "Compile before parsing" setting (enabled by default), to help reduce/prevent parser errors caused by uncompilable code.
diff --git a/RetailCoder.VBE/Properties/Settings.Designer.cs b/RetailCoder.VBE/Properties/Settings.Designer.cs
diff --git a/RetailCoder.VBE/Properties/Settings.settings b/RetailCoder.VBE/Properties/Settings.settings
@@ -162,6 +162,7 @@
   &lt;Language Code="en-US" /&gt;
   &lt;CanShowSplash&gt;true&lt;/CanShowSplash&gt;
   &lt;CanCheckVersion&gt;true&lt;/CanCheckVersion&gt;
+  &lt;CompileBeforeParse&gt;true&lt;/CompileBeforeParse&gt;
   &lt;IsSmartIndenterPrompted&gt;false&lt;/IsSmartIndenterPrompted&gt;
   &lt;IsAutoSaveEnabled&gt;false&lt;/IsAutoSaveEnabled&gt;
   &lt;AutoSavePeriod&gt;10&lt;/AutoSavePeriod&gt;
diff --git a/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs b/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs
@@ -45,6 +45,7 @@
 using Rubberduck.UI.CodeMetrics;
 using Rubberduck.VBEditor.ComManagement;
 using Rubberduck.Parsing.Common;
+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 
 
 namespace Rubberduck.Root
@@ -104,6 +105,7 @@ public void Install(IWindsorContainer container, IConfigurationStore store)
 
             RegisterSmartIndenter(container);
             RegisterParsingEngine(container);
+            RegisterTypeLibApi(container);
 
             container.Register(Component.For<TestExplorerModel>()
                 .LifestyleSingleton());
@@ -169,7 +171,7 @@ private void RegisterConfiguration(IWindsorContainer container, Assembly[] assem
             container.Register(Component.For(typeof(IPersistanceService<>), typeof(IFilePersistanceService<>))
                 .ImplementedBy(typeof(XmlPersistanceService<>))
                 .LifestyleSingleton());
-
+            
             container.Register(Component.For<IConfigProvider<IndenterSettings>>()
                 .ImplementedBy<IndenterConfigProvider>()
                 .LifestyleSingleton());
@@ -716,6 +718,13 @@ private void RegisterParsingEngine(IWindsorContainer container)
                 .Instance(() => new VBAPreprocessor(double.Parse(_vbe.Version, CultureInfo.InvariantCulture))));
         }
 
+        private void RegisterTypeLibApi(IWindsorContainer container)
+        {
+            container.Register(Component.For<IVBETypeLibsAPI>()
+                .ImplementedBy<VBETypeLibsAPI>()
+                .LifestyleSingleton());
+        }
+
         private void RegisterCustomDeclarationLoadersToParser(IWindsorContainer container)
         {
             container.Register(Classes.FromAssemblyContaining<ICustomDeclarationLoader>()
diff --git a/RetailCoder.VBE/Settings/GeneralSettings.cs b/RetailCoder.VBE/Settings/GeneralSettings.cs
@@ -12,6 +12,7 @@ public interface IGeneralSettings
         DisplayLanguageSetting Language { get; set; }
         bool CanShowSplash { get; set; }
         bool CanCheckVersion { get; set; }
+        bool CompileBeforeParse { get; set; }
         bool IsSmartIndenterPrompted { get; set; }
         bool IsAutoSaveEnabled { get; set; }
         int AutoSavePeriod { get; set; }
@@ -26,6 +27,7 @@ public class GeneralSettings : IGeneralSettings, IEquatable<GeneralSettings>
         public DisplayLanguageSetting Language { get; set; }
         public bool CanShowSplash { get; set; }
         public bool CanCheckVersion { get; set; }
+        public bool CompileBeforeParse { get; set; }
         public bool IsSmartIndenterPrompted { get; set; }
         public bool IsAutoSaveEnabled { get; set; }
         public int AutoSavePeriod { get; set; }
@@ -59,6 +61,7 @@ public bool Equals(GeneralSettings other)
                    Language.Equals(other.Language) &&
                    CanShowSplash == other.CanShowSplash &&
                    CanCheckVersion == other.CanCheckVersion &&
+                   CompileBeforeParse == other.CompileBeforeParse &&
                    IsSmartIndenterPrompted == other.IsSmartIndenterPrompted &&
                    IsAutoSaveEnabled == other.IsAutoSaveEnabled &&
                    AutoSavePeriod == other.AutoSavePeriod &&
diff --git a/RetailCoder.VBE/UI/Command/ReparseCommand.cs b/RetailCoder.VBE/UI/Command/ReparseCommand.cs
@@ -1,19 +1,36 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Runtime.InteropServices;
+using System.Windows.Forms;
 using NLog;
 using Rubberduck.Parsing.VBA;
+using Rubberduck.Settings;
+using Rubberduck.SettingsProvider;
 using Rubberduck.UI.CodeExplorer.Commands;
+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
+using Rubberduck.VBEditor.SafeComWrappers;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.UI.Command
 {
     [ComVisible(false)]
     [CodeExplorerCommand]
     public class ReparseCommand : CommandBase
     {
+        private readonly IVBE _vbe;
+        private readonly IVBETypeLibsAPI _typeLibApi;
+        private readonly IMessageBox _messageBox;
         private readonly RubberduckParserState _state;
+        private readonly GeneralSettings _settings;
 
-        public ReparseCommand(RubberduckParserState state) : base(LogManager.GetCurrentClassLogger())
+        public ReparseCommand(IVBE vbe, IConfigProvider<GeneralSettings> settingsProvider, RubberduckParserState state, IVBETypeLibsAPI typeLibApi, IMessageBox messageBox) : base(LogManager.GetCurrentClassLogger())
         {
+            _vbe = vbe;
+            _typeLibApi = typeLibApi;
             _state = state;
+            _settings = settingsProvider.Create();
+            _messageBox = messageBox;
         }
 
         protected override bool EvaluateCanExecute(object parameter)
@@ -26,7 +43,54 @@ protected override bool EvaluateCanExecute(object parameter)
 
         protected override void OnExecute(object parameter)
         {
+            if (_settings.CompileBeforeParse)
+            {
+                if (CompileAllProjects(out var failedNames))
+                {
+                    if (!PromptUserToContinue(failedNames))
+                    {
+                        return;
+                    }
+                }
+            }
             _state.OnParseRequested(this);
         }
+
+        private bool CompileAllProjects(out List<string> failedNames)
+        {
+            failedNames = new List<string>();
+            using (var projects = _vbe.VBProjects)
+            {
+                foreach (var project in projects)
+                {
+                    using (project)
+                    {
+                        if (project.Protection != ProjectProtection.Unprotected)
+                        {
+                            continue;
+                        }
+
+                        if (!_typeLibApi.CompileProject(project))
+                        {
+                            failedNames.Add(project.Name);
+                        }
+                    }
+                }
+            }
+
+            return failedNames.Any();
+        }
+
+        private bool PromptUserToContinue(List<string> failedNames)
+        {
+            var formattedList = string.Concat(Environment.NewLine, Environment.NewLine,
+                string.Join(Environment.NewLine, failedNames));
+            var result = _messageBox.Show(
+                string.Format(RubberduckUI.Command_Reparse_CannotCompile,
+                    formattedList),
+                RubberduckUI.Command_Reparse_CannotCompile_Caption, MessageBoxButtons.YesNo,
+                MessageBoxIcon.Warning, MessageBoxDefaultButton.Button2);
+            return result == DialogResult.Yes;
+        }
     }
 }
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
@@ -1780,4 +1780,13 @@ Would you like to import them to Rubberduck?</value>
   <data name="GeneralSettings_ModifierWarning" xml:space="preserve">
     <value>Modifier Warning</value>
   </data>
+  <data name="Command_Reparse_CannotCompile" xml:space="preserve">
+    <value>The following project(s) cannot be compiled, which will most likely result in parser errors. Continue anyway? {0}</value>
+  </data>
+  <data name="Command_Reparse_CannotCompile_Caption" xml:space="preserve">
+    <value>Unable to compile for parsing</value>
+  </data>
+  <data name="GeneralSettings_CompileBeforeParse" xml:space="preserve">
+    <value>Compile code before parsing</value>
+  </data>
 </root>
diff --git a/RetailCoder.VBE/UI/Settings/GeneralSettings.xaml b/RetailCoder.VBE/UI/Settings/GeneralSettings.xaml
@@ -124,6 +124,8 @@
 
                     <CheckBox Margin="5,0,0,5" Content="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GeneralSettings_CheckVersion}"
                               IsChecked="{Binding CheckVersionAtStartup}" />
+                    <CheckBox Margin="5,0,0,5" Content="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GeneralSettings_CompileBeforeParse}"
+                              IsChecked="{Binding CompileBeforeParse}" />
                     <StackPanel Orientation="Horizontal"/>
 
                     <Label Content="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GeneralSettings_MinimumLogLevelLabel}" FontWeight="SemiBold" />
diff --git a/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs b/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs
@@ -124,6 +124,21 @@ public bool CheckVersionAtStartup
             }
         }
 
+        private bool _compileBeforeParse;
+
+        public bool CompileBeforeParse
+        {
+            get => _compileBeforeParse;
+            set
+            {
+                if (_compileBeforeParse != value)
+                {
+                    _compileBeforeParse = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
+
         private int _autoSavePeriod;
         public int AutoSavePeriod
         {
@@ -192,6 +207,7 @@ private Rubberduck.Settings.GeneralSettings GetCurrentGeneralSettings()
                 Language = SelectedLanguage,
                 CanShowSplash = ShowSplashAtStartup,
                 CanCheckVersion = CheckVersionAtStartup,
+                CompileBeforeParse = CompileBeforeParse,
                 IsSmartIndenterPrompted = _indenterPrompted,
                 IsAutoSaveEnabled = AutoSaveEnabled,
                 AutoSavePeriod = AutoSavePeriod,
@@ -206,6 +222,7 @@ private void TransferSettingsToView(IGeneralSettings general, IHotkeySettings ho
             Hotkeys = new ObservableCollection<HotkeySetting>(hottkey.Settings);
             ShowSplashAtStartup = general.CanShowSplash;
             CheckVersionAtStartup = general.CanCheckVersion;
+            CompileBeforeParse = general.CompileBeforeParse;
             _indenterPrompted = general.IsSmartIndenterPrompted;
             AutoSaveEnabled = general.IsAutoSaveEnabled;
             AutoSavePeriod = general.AutoSavePeriod;
diff --git a/RetailCoder.VBE/UnitTesting/TestEngine.cs b/RetailCoder.VBE/UnitTesting/TestEngine.cs
@@ -21,16 +21,18 @@ public class TestEngine : ITestEngine
         private readonly IVBE _vbe;
         private readonly RubberduckParserState _state;
         private readonly IFakesProviderFactory _fakesFactory;
+        private readonly IVBETypeLibsAPI _typeLibApi;
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
-        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory)
+        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory, IVBETypeLibsAPI typeLibApi)
         {
             Debug.WriteLine("TestEngine created.");
             Model = model;
             _vbe = vbe;
             _state = state;
             _fakesFactory = fakesFactory;
+            _typeLibApi = typeLibApi;
         }
 
         public TestExplorerModel Model { get; }
@@ -126,7 +128,7 @@ private void Run(IEnumerable<Declaration> members)
                 {
                     foreach (var member in group)
                     {
-                        VBETypeLibsAPI.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,
+                        _typeLibApi.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,
                             member.QualifiedName.MemberName);
                     }
                 }
diff --git a/RetailCoder.VBE/UnitTesting/TestMethod.cs b/RetailCoder.VBE/UnitTesting/TestMethod.cs
@@ -19,11 +19,13 @@ public class TestMethod : ViewModelBase, IEquatable<TestMethod>, INavigateSource
     {
         private readonly ICollection<AssertCompletedEventArgs> _assertResults = new List<AssertCompletedEventArgs>();
         private readonly IVBE _vbe;
+        private readonly IVBETypeLibsAPI _typeLibApi;
 
-        public TestMethod(Declaration declaration, IVBE vbe)
+        public TestMethod(Declaration declaration, IVBE vbe, IVBETypeLibsAPI typeLibApi)
         {
             _declaration = declaration;
             _vbe = vbe;
+            _typeLibApi = typeLibApi;
         }
 
         private Declaration _declaration;
@@ -45,7 +47,7 @@ public void Run()
             try
             {
                 AssertHandler.OnAssertCompleted += HandleAssertCompleted;
-                VBETypeLibsAPI.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,
+                _typeLibApi.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,
                     Declaration.QualifiedName.MemberName);
                 AssertHandler.OnAssertCompleted -= HandleAssertCompleted;
                 
diff --git a/RetailCoder.VBE/UnitTesting/UnitTestUtils.cs b/RetailCoder.VBE/UnitTesting/UnitTestUtils.cs
@@ -5,6 +5,7 @@
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor;
+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 using Rubberduck.VBEditor.Extensions;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
@@ -16,7 +17,7 @@ public static IEnumerable<TestMethod> GetAllTests(IVBE vbe, RubberduckParserStat
         {
             return GetTestModuleProcedures(state)
                     .Where(item => IsTestMethod(state, item))
-                    .Select(item => new TestMethod(item, vbe));
+                    .Select(item => new TestMethod(item, vbe, new VBETypeLibsAPI()));
         }
 
         public static IEnumerable<TestMethod> GetTests(this IVBComponent component, IVBE vbe, RubberduckParserState state)
diff --git a/RetailCoder.VBE/app.config b/RetailCoder.VBE/app.config
@@ -210,6 +210,7 @@
             <Language Code="en-US" />
             <CanShowSplash>true</CanShowSplash>
             <CanCheckVersion>true</CanCheckVersion>
+            <CompileBeforeParse>true</CompileBeforeParse>
             <IsSmartIndenterPrompted>false</IsSmartIndenterPrompted>
             <IsAutoSaveEnabled>false</IsAutoSaveEnabled>
             <AutoSavePeriod>10</AutoSavePeriod>
diff --git a/Rubberduck.VBEEditor/ComManagement/TypeLibs/IVBETypeLibsAPI.cs b/Rubberduck.VBEEditor/ComManagement/TypeLibs/IVBETypeLibsAPI.cs
diff --git a/Rubberduck.VBEEditor/ComManagement/TypeLibs/TypeLibsAPI.cs b/Rubberduck.VBEEditor/ComManagement/TypeLibs/TypeLibsAPI.cs
diff --git a/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj b/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,18 @@ public class TestEngine : ITestEngine`
`21`	`21`	`private readonly IVBE _vbe;`
`22`	`22`	`private readonly RubberduckParserState _state;`
`23`	`23`	`private readonly IFakesProviderFactory _fakesFactory;`
	`24`	`+ private readonly IVBETypeLibsAPI _typeLibApi;`
`24`	`25`
`25`	`26`	`private static readonly Logger Logger = LogManager.GetCurrentClassLogger();`
`26`	`27`
`27`		`- public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory)`
	`28`	`+ public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory, IVBETypeLibsAPI typeLibApi)`
`28`	`29`	`{`
`29`	`30`	`Debug.WriteLine("TestEngine created.");`
`30`	`31`	`Model = model;`
`31`	`32`	`_vbe = vbe;`
`32`	`33`	`_state = state;`
`33`	`34`	`_fakesFactory = fakesFactory;`
	`35`	`+ _typeLibApi = typeLibApi;`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`public TestExplorerModel Model { get; }`
`@@ -126,7 +128,7 @@ private void Run(IEnumerable<Declaration> members)`
`126`	`128`	`{`
`127`	`129`	`foreach (var member in group)`
`128`	`130`	`{`
`129`		`- VBETypeLibsAPI.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,`
	`131`	`+ _typeLibApi.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,`
`130`	`132`	`member.QualifiedName.MemberName);`
`131`	`133`	`}`
`132`	`134`	`}`