Merge pull request #5675 from bclothier/MinorBugFixes

Potentially fix the AV when initial parse occurs too soon.

Author: retailcoder

Rubberduck.Parsing/ComReflection/XmlComProjectSerializer.cs

@@ -17,20 +17,23 @@ public class XmlComProjectSerializer : IComProjectSerializationProvider
         public readonly string DefaultSerializationPath;
         private readonly IFileSystem _fileSystem;
 
-        public XmlComProjectSerializer(
-            IPersistencePathProvider pathProvider,
-            IFileSystem fileSystem)
+        private XmlComProjectSerializer(IFileSystem fileSystem, string defaultPath, string path)
         {
-            DefaultSerializationPath = pathProvider.DataFolderPath("Declarations");
             _fileSystem = fileSystem;
-        }
-
-        public XmlComProjectSerializer(IFileSystem filesystem, string path = null)
-        {
+            DefaultSerializationPath = defaultPath;
             Target = path ?? DefaultSerializationPath;
-            _fileSystem = filesystem;
         }
 
+        public XmlComProjectSerializer(
+            IPersistencePathProvider pathProvider,
+            IFileSystem fileSystem)
+            : this(fileSystem, pathProvider.DataFolderPath("Declarations"), null)
+        { }
+
+        public XmlComProjectSerializer(IFileSystem fileSystem, string path)
+            : this(fileSystem, path, path)
+        { }
+
         private static readonly XmlReaderSettings ReaderSettings = new XmlReaderSettings
         {
             CheckCharacters = false

Rubberduck.VBEEditor/ComManagement/TypeLibs/TypeLibVBEExtensions.cs

@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Runtime.InteropServices.ComTypes;
+using NLog;
 using Rubberduck.VBEditor.ComManagement.TypeLibs.Abstract;
 using Rubberduck.VBEditor.ComManagement.TypeLibs.Unmanaged;
 
@@ -66,6 +67,7 @@ internal class TypeLibVBEExtensions : ITypeLibVBEExtensions
     {
         private readonly string _name;
         private readonly IVBEProject _target_IVBEProject;
+        private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
         public ITypeLibReferenceCollection VBEReferences { get; }
 
@@ -87,6 +89,24 @@ public bool CompileProject()
         {
             try
             {
+                // Prevent a potential access violation by first calling the Placeholder3(). 
+                // Under certain conditions where the VBA project is fully compiled, clicking parse
+                // as soon as Rubberduck has loaded into VBIDE can cause an access violation when 
+                // accessing CompileProject(). We've tried using ComMessagePumper and 
+                // UiDispatcher.FlushMessageQueue but neither helped in preventing the 
+                // access violation. We at least know that Placeholder3() does not save the unsaved
+                // change so hopefully there should be no permanent side effects from invoking the
+                // Placeholder3(). 
+                try
+                {
+                    _target_IVBEProject.Placeholder3();
+                }
+                catch(Exception ex)
+                {
+                    Logger.Info(ex, $"Cannot compile the VBA project '{_name}' because there may be a potential access violation.");
+                    return false;
+                }
+
                 _target_IVBEProject.CompileProject();
                 return true;
             }

RubberduckBaseProject.csproj

@@ -48,7 +48,18 @@
   <PropertyGroup Condition=" '$(Configuration)' == 'Debug'">
     <DebugType>full</DebugType>
     <Optimize>false</Optimize>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <!-- Valid Constants used in the solution: 
+      LOG_COM_RELEASE     // Records COM objects released when a safe COM wrapper has been disposed
+      PRETTY_XML          // Includes whitespace and formatting to serialized XML files for XmlComProjectSerializer
+      REF_COUNT           // Tracks the reported reference counts when acquiring/disposing COM objects
+      THRISTY_DUCK        // Outputs the message content from the message pump in VBENativeServices / SubclassingWindow
+      THRISTY_DUCK_EVT    // Outptus the events raised from the message pump in VBENativeServices / SubclassingWindow
+      TRACE_COM_SAFE      // Tracks the COM wrappers added & removed to the ComSafe and also allow serializing the contents of ComSafe
+      TRACE_TYPEAPI       // Tracks the methods called on the wrapped ITypeLib & ITypeInfo
+      TRACE_COM_POINTERS  // Tracks the ComPointer access & disposal
+      TRACE_MARSHAL       // Tracks the calls made through the RdMarshal class (useful for tracking all Marshal methods)
+    -->
+    <DefineConstants>DEBUG;TRACE;</DefineConstants>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release'">