fixed event sink disposal and exception with protected projects; parser state still broken.

Author: retailcoder

RetailCoder.VBE/App.cs

@@ -17,6 +17,7 @@
 using Rubberduck.UI.Command.MenuItems;
 using Infralution.Localization.Wpf;
 using Rubberduck.Common.Dispatch;
+using Rubberduck.VBEditor.Extensions;
 
 namespace Rubberduck
 {
@@ -39,10 +40,10 @@ public class App : IDisposable
         private readonly IConnectionPoint _projectsEventsConnectionPoint;
         private readonly int _projectsEventsCookie;
 
-        private readonly IDictionary<VBProjectsEventsSink, Tuple<IConnectionPoint, int>>  _componentsEventsConnectionPoints = 
-            new Dictionary<VBProjectsEventsSink, Tuple<IConnectionPoint, int>>();
-        private readonly IDictionary<VBProjectsEventsSink, Tuple<IConnectionPoint, int>> _referencesEventsConnectionPoints =
-            new Dictionary<VBProjectsEventsSink, Tuple<IConnectionPoint, int>>();
+        private readonly IDictionary<string, Tuple<IConnectionPoint, int>>  _componentsEventsConnectionPoints = 
+            new Dictionary<string, Tuple<IConnectionPoint, int>>();
+        private readonly IDictionary<string, Tuple<IConnectionPoint, int>> _referencesEventsConnectionPoints =
+            new Dictionary<string, Tuple<IConnectionPoint, int>>();
 
         public App(VBE vbe, IMessageBox messageBox,
             IRubberduckParser parser,
@@ -127,11 +128,6 @@ public void Startup()
         {
             CleanReloadConfig();
 
-            foreach (var project in _vbe.VBProjects.Cast<VBProject>())
-            {
-                _parser.State.AddProject(project);
-            }
-
             _appMenus.Initialize();
             _appMenus.Localize();
 
@@ -150,40 +146,51 @@ public void Startup()
         #region sink handlers. todo: move to another class
         async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
         {
-            var sink = (VBProjectsEventsSink)sender;
-            _componentsEventSinks.Remove(sink);
-            _referencesEventsSinks.Remove(sink);
+            if (e.Item.Protection == vbext_ProjectProtection.vbext_pp_locked)
+            {
+                Debug.WriteLine(string.Format("Locked project '{0}' was removed.", e.Item.Name));
+                return;
+            }
+
+            var projectId = e.Item.HelpFile;
+            _componentsEventsSinks.Remove(projectId);
+            _referencesEventsSinks.Remove(projectId);
             _parser.State.RemoveProject(e.Item);
 
             Debug.WriteLine(string.Format("Project '{0}' was removed.", e.Item.Name));
             Tuple<IConnectionPoint, int> componentsTuple;
-            if (_componentsEventsConnectionPoints.TryGetValue(sink, out componentsTuple))
+            if (_componentsEventsConnectionPoints.TryGetValue(projectId, out componentsTuple))
             {
                 componentsTuple.Item1.Unadvise(componentsTuple.Item2);
-                _componentsEventsConnectionPoints.Remove(sink);
+                _componentsEventsConnectionPoints.Remove(projectId);
             }
 
             Tuple<IConnectionPoint, int> referencesTuple;
-            if (_referencesEventsConnectionPoints.TryGetValue(sink, out referencesTuple))
+            if (_referencesEventsConnectionPoints.TryGetValue(projectId, out referencesTuple))
             {
                 referencesTuple.Item1.Unadvise(referencesTuple.Item2);
-                _referencesEventsConnectionPoints.Remove(sink);
+                _referencesEventsConnectionPoints.Remove(projectId);
             }
-
-            _parser.State.ClearDeclarations(e.Item);
         }
 
-        private readonly IDictionary<VBProjectsEventsSink, VBComponentsEventsSink> _componentsEventSinks = 
-            new Dictionary<VBProjectsEventsSink, VBComponentsEventsSink>();
+        private readonly IDictionary<string,VBComponentsEventsSink> _componentsEventsSinks =
+            new Dictionary<string,VBComponentsEventsSink>();
 
-        private readonly IDictionary<VBProjectsEventsSink, ReferencesEventsSink> _referencesEventsSinks = 
-            new Dictionary<VBProjectsEventsSink, ReferencesEventsSink>();
+        private readonly IDictionary<string,ReferencesEventsSink> _referencesEventsSinks = 
+            new Dictionary<string, ReferencesEventsSink>();
 
         async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
         {
-            var sink = (VBProjectsEventsSink)sender;
-            RegisterComponentsEventSink(e, sink);
-            _parser.State.AddProject(e.Item);
+            Debug.WriteLine(string.Format("Project '{0}' was added.", e.Item.Name));
+            if (e.Item.Protection == vbext_ProjectProtection.vbext_pp_locked)
+            {
+                Debug.WriteLine("Project is protected and will not be added to parser state.");
+                return;
+            }
+
+            _parser.State.AddProject(e.Item); // note side-effect: assigns ProjectId/HelpFile
+            var projectId = e.Item.HelpFile;
+            RegisterComponentsEventSink(e.Item.VBComponents, projectId);
 
             if (!_parser.State.AllDeclarations.Any())
             {
@@ -193,13 +200,19 @@ async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
                 return;
             }
 
-            Debug.WriteLine(string.Format("Project '{0}' was added.", e.Item.Name));
             _parser.State.OnParseRequested(sender);
         }
 
-        private void RegisterComponentsEventSink(DispatcherEventArgs<VBProject> e, VBProjectsEventsSink sink)
+        private void RegisterComponentsEventSink(VBComponents components, string projectId)
         {
-            var connectionPointContainer = (IConnectionPointContainer) e.Item.VBComponents;
+            if (_componentsEventsSinks.ContainsKey(projectId))
+            {
+                // already registered - this is caused by the initial load+rename of a project in the VBE
+                Debug.WriteLine("Components sink already registered.");
+                return;
+            }
+
+            var connectionPointContainer = (IConnectionPointContainer)components;
             var interfaceId = typeof (_dispVBComponentsEvents).GUID;
 
             IConnectionPoint connectionPoint;
@@ -212,12 +225,13 @@ private void RegisterComponentsEventSink(DispatcherEventArgs<VBProject> e, VBPro
             componentsSink.ComponentRemoved += sink_ComponentRemoved;
             componentsSink.ComponentRenamed += sink_ComponentRenamed;
             componentsSink.ComponentSelected += sink_ComponentSelected;
-            _componentsEventSinks.Add(sink, componentsSink);
+            _componentsEventsSinks.Add(projectId, componentsSink);
 
             int cookie;
             connectionPoint.Advise(componentsSink, out cookie);
 
-            _componentsEventsConnectionPoints.Add(sink, Tuple.Create(connectionPoint, cookie));
+            _componentsEventsConnectionPoints.Add(projectId, Tuple.Create(connectionPoint, cookie));
+            Debug.WriteLine("Components sink registered and advising.");
         }
 
         async void sink_ComponentSelected(object sender, DispatcherEventArgs<VBComponent> e)
@@ -251,7 +265,7 @@ async void sink_ComponentRemoved(object sender, DispatcherEventArgs<VBComponent>
             }
 
             Debug.WriteLine(string.Format("Component '{0}' was removed.", e.Item.Name));
-            _parser.State.ClearDeclarations(e.Item);
+            _parser.State.ClearStateCache(e.Item);
         }
 
         async void sink_ComponentReloaded(object sender, DispatcherEventArgs<VBComponent> e)
@@ -364,7 +378,10 @@ public void Dispose()
             {
                 item.Value.Item1.Unadvise(item.Value.Item2);
             }
-
+            foreach (var item in _referencesEventsConnectionPoints)
+            {
+                item.Value.Item1.Unadvise(item.Value.Item2);
+            }
             _hooks.Dispose();
         }
     }

RetailCoder.VBE/UI/Command/MenuItems/RubberduckCommandBar.cs

@@ -41,8 +41,9 @@ private void _statusButton_Click(CommandBarButton Ctrl, ref bool CancelDefault)
 
         public void SetStatusText(string value = null)
         {
-            Debug.WriteLine(string.Format("RubberduckCommandBar status text changes to '{0}'.", value));
-            UiDispatcher.Invoke(() => _statusButton.Caption = value ?? RubberduckUI.ResourceManager.GetString("ParserState_" + _state.Status));
+            var text = value ?? RubberduckUI.ResourceManager.GetString("ParserState_" + _state.Status);
+            Debug.WriteLine(string.Format("RubberduckCommandBar status text changes to '{0}'.", text));
+            UiDispatcher.Invoke(() => _statusButton.Caption = text);
         }
 
         public void SetSelectionText(Declaration declaration)

Rubberduck.Parsing/VBA/RubberduckParser.cs

@@ -89,15 +89,13 @@ public void Parse()
         {
             if (!_state.Projects.Any())
             {
-                foreach (var project in _vbe.VBProjects.Cast<VBProject>())
+                foreach (var project in _vbe.VBProjects.UnprotectedProjects())
                 {
                     _state.AddProject(project);
                 }
             }
 
-            var projects = _state.Projects
-                .Where(project => project.Protection == vbext_ProjectProtection.vbext_pp_none)
-                .ToList();
+            var projects = _state.Projects.ToList();
 
             var components = projects.SelectMany(p => p.VBComponents.Cast<VBComponent>()).ToList();
             SyncComReferences(projects);
@@ -115,7 +113,7 @@ public void Parse()
 
             foreach (var vbComponent in components)
             {
-                while (!_state.ClearDeclarations(vbComponent)) { }
+                while (!_state.ClearStateCache(vbComponent)) { }
 
                 // expects synchronous parse :/
                 ParseComponent(vbComponent);
@@ -127,14 +125,19 @@ public void Parse()
         /// </summary>
         private void ParseAll()
         {
-            var projects = _state.Projects
-                // accessing the code of a protected VBComponent throws a COMException:
-                .Where(project => project.Protection == vbext_ProjectProtection.vbext_pp_none)
-                .ToList();
+            if (!_state.Projects.Any())
+            {
+                foreach (var project in _vbe.VBProjects.UnprotectedProjects())
+                {
+                    _state.AddProject(project);
+                }
+            }
+
+            var projects = _state.Projects.ToList();
 
             var components = projects.SelectMany(p => p.VBComponents.Cast<VBComponent>()).ToList();
-            var modified = components.Where(_state.IsModified).ToList();
-            var unchanged = components.Where(c => !_state.IsModified(c)).ToList();
+            var modified = components.Where(c => _state.IsNewOrModified(c)).ToList();
+            var unchanged = components.Where(c => !_state.IsNewOrModified(c)).ToList();
 
             SyncComReferences(projects);
 
@@ -228,7 +231,7 @@ private void UnloadComReference(Reference reference)
 
         public Task ParseAsync(VBComponent component, CancellationToken token, TokenStreamRewriter rewriter = null)
         {
-            _state.ClearDeclarations(component);            
+            _state.ClearStateCache(component);            
             _state.SetModuleState(component, ParserState.Pending); // also clears module-exceptions
 
             var linkedTokenSource = CancellationTokenSource.CreateLinkedTokenSource(_central.Token, token);
@@ -322,7 +325,7 @@ private void ResolveInternal(CancellationToken token)
                 var qualifiedName = kvp.Key;
                 if (true /*_state.IsModified(qualifiedName)*/)
                 {
-                    Debug.WriteLine("Module '{0}' {1}", qualifiedName.ComponentName, _state.IsModified(qualifiedName) ? "was modified" : "was NOT modified");
+                    Debug.WriteLine("Module '{0}' {1}", qualifiedName.ComponentName, _state.IsNewOrModified(qualifiedName) ? "was modified" : "was NOT modified");
                     // modified module; walk parse tree and re-acquire all declarations
                     if (token.IsCancellationRequested) return;
                     ResolveDeclarations(qualifiedName.Component, kvp.Value);