Merge pull request #1947 from Hosch250/RefactorSinks

Refactor sinks

Author: retailcoder

RetailCoder.VBE/API/ParserState.cs

@@ -47,16 +47,13 @@ public sealed class ParserState : IParserState, IDisposable
         private const string ClassId = "28754D11-10CC-45FD-9F6A-525A65412B7A";
         private const string ProgId = "Rubberduck.ParserState";
 
-        private readonly RubberduckParserState _state;
+        private RubberduckParserState _state;
         private AttributeParser _attributeParser;
         private RubberduckParser _parser;
 
         public ParserState()
         {
             UiDispatcher.Initialize();
-            _state = new RubberduckParserState();
-            
-            _state.StateChanged += _state_StateChanged;
         }
 
         public void Initialize(VBE vbe)
@@ -65,6 +62,10 @@ public void Initialize(VBE vbe)
             {
                 throw new InvalidOperationException("ParserState is already initialized.");
             }
+
+            _state = new RubberduckParserState(vbe, new Sinks(vbe));
+            _state.StateChanged += _state_StateChanged;
+
             Func<IVBAPreprocessor> preprocessorFactory = () => new VBAPreprocessor(double.Parse(vbe.Version, CultureInfo.InvariantCulture));
             _attributeParser = new AttributeParser(new ModuleExporter(), preprocessorFactory);
             _parser = new RubberduckParser(vbe, _state, _attributeParser, preprocessorFactory,

RetailCoder.VBE/App.cs

@@ -3,63 +3,42 @@
 using Microsoft.Vbe.Interop;
 using NLog;
 using Rubberduck.Common;
-using Rubberduck.Common.Dispatch;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Settings;
 using Rubberduck.UI;
 using Rubberduck.UI.Command.MenuItems;
 using System;
-using System.Collections.Generic;
-using System.Diagnostics;
 using System.Globalization;
-using System.Linq;
-using System.Runtime.InteropServices.ComTypes;
 using System.Threading.Tasks;
 using System.Windows.Forms;
-using Rubberduck.UI.SourceControl;
-using Rubberduck.VBEditor.Extensions;
 
 namespace Rubberduck
 {
     public sealed class App : IDisposable
     {
-        private const string FILE_TARGET_NAME = "file";
         private readonly VBE _vbe;
         private readonly IMessageBox _messageBox;
-        private IRubberduckParser _parser;
+        private readonly IRubberduckParser _parser;
         private AutoSave.AutoSave _autoSave;
         private IGeneralConfigService _configService;
         private readonly IAppMenu _appMenus;
         private RubberduckCommandBar _stateBar;
         private IRubberduckHooks _hooks;
-        private bool _handleSinkEvents = true;
-        private readonly BranchesViewViewModel _branchesVM;
-        private readonly SourceControlViewViewModel _sourceControlPanelVM;
         private readonly UI.Settings.Settings _settings;
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
-
-        private VBProjectsEventsSink _sink;
+        
         private Configuration _config;
 
-        private readonly IConnectionPoint _projectsEventsConnectionPoint;
-        private readonly int _projectsEventsCookie;
-
-        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,
             UI.Settings.Settings settings,
             IRubberduckParser parser,
             IGeneralConfigService configService,
             IAppMenu appMenus,
             RubberduckCommandBar stateBar,
-            IRubberduckHooks hooks,
-            SourceControlDockablePresenter sourceControlPresenter)
+            IRubberduckHooks hooks)
         {
             _vbe = vbe;
             _messageBox = messageBox;
@@ -71,52 +50,14 @@ public App(VBE vbe, IMessageBox messageBox,
             _stateBar = stateBar;
             _hooks = hooks;
 
-            var sourceControlPanel = (SourceControlPanel) sourceControlPresenter.Window();
-            _sourceControlPanelVM = (SourceControlViewViewModel) sourceControlPanel.ViewModel;
-            _branchesVM = (BranchesViewViewModel) _sourceControlPanelVM.TabItems.Single(t => t.ViewModel.Tab == SourceControlTab.Branches).ViewModel;
-
-            _sourceControlPanelVM.OpenRepoStarted += DisableSinkEventHandlers;
-            _sourceControlPanelVM.OpenRepoCompleted += EnableSinkEventHandlersAndUpdateCache;
-
-            _branchesVM.LoadingComponentsStarted += DisableSinkEventHandlers;
-            _branchesVM.LoadingComponentsCompleted += EnableSinkEventHandlersAndUpdateCache;
-
             _hooks.MessageReceived += _hooks_MessageReceived;
             _configService.SettingsChanged += _configService_SettingsChanged;
             _parser.State.StateChanged += Parser_StateChanged;
             _parser.State.StatusMessageUpdate += State_StatusMessageUpdate;
             _stateBar.Refresh += _stateBar_Refresh;
-
-            _sink = new VBProjectsEventsSink();
-            var connectionPointContainer = (IConnectionPointContainer)_vbe.VBProjects;
-            var interfaceId = typeof(_dispVBProjectsEvents).GUID;
-            connectionPointContainer.FindConnectionPoint(ref interfaceId, out _projectsEventsConnectionPoint);
-
-            _sink.ProjectAdded += sink_ProjectAdded;
-            _sink.ProjectRemoved += sink_ProjectRemoved;
-            _sink.ProjectActivated += sink_ProjectActivated;
-            _sink.ProjectRenamed += sink_ProjectRenamed;
-
-            _projectsEventsConnectionPoint.Advise(_sink, out _projectsEventsCookie);
             UiDispatcher.Initialize();
         }
 
-        private void EnableSinkEventHandlersAndUpdateCache(object sender, EventArgs e)
-        {
-            _handleSinkEvents = true;
-
-            // update cache
-            _parser.State.RemoveProject(_vbe.ActiveVBProject.HelpFile);
-            _parser.State.AddProject(_vbe.ActiveVBProject);
-
-            _parser.State.OnParseRequested(this);
-        }
-
-        private void DisableSinkEventHandlers(object sender, EventArgs e)
-        {
-            _handleSinkEvents = false;
-        }
-
         private void State_StatusMessageUpdate(object sender, RubberduckStatusMessageEventArgs e)
         {
             var message = e.Message;
@@ -216,7 +157,7 @@ public void Shutdown()
             }
         }
 
-        #region sink handlers. todo: move to another class
+        /*#region sink handlers.
         async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
         {
             if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
@@ -232,33 +173,10 @@ async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
             var projectId = e.Item.HelpFile;
             Debug.Assert(projectId != null);
 
-            _componentsEventsSinks.Remove(projectId);
-            _referencesEventsSinks.Remove(projectId);
             _parser.State.RemoveProject(e.Item);
             _parser.State.OnParseRequested(this);
-
-            Logger.Debug("Project '{0}' was removed.", e.Item.Name);
-            Tuple<IConnectionPoint, int> componentsTuple;
-            if (_componentsEventsConnectionPoints.TryGetValue(projectId, out componentsTuple))
-            {
-                componentsTuple.Item1.Unadvise(componentsTuple.Item2);
-                _componentsEventsConnectionPoints.Remove(projectId);
-            }
-
-            Tuple<IConnectionPoint, int> referencesTuple;
-            if (_referencesEventsConnectionPoints.TryGetValue(projectId, out referencesTuple))
-            {
-                referencesTuple.Item1.Unadvise(referencesTuple.Item2);
-                _referencesEventsConnectionPoints.Remove(projectId);
-            }
         }
 
-        private readonly IDictionary<string, VBComponentsEventsSink> _componentsEventsSinks =
-            new Dictionary<string, VBComponentsEventsSink>();
-
-        private readonly IDictionary<string, ReferencesEventsSink> _referencesEventsSinks =
-            new Dictionary<string, ReferencesEventsSink>();
-
         async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
         {
             if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
@@ -285,37 +203,6 @@ async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
             _parser.State.OnParseRequested(sender);
         }
 
-        private void RegisterComponentsEventSink(VBComponents components, string projectId)
-        {
-            if (_componentsEventsSinks.ContainsKey(projectId))
-            {
-                // already registered - this is caused by the initial load+rename of a project in the VBE
-                Logger.Debug("Components sink already registered.");
-                return;
-            }
-
-            var connectionPointContainer = (IConnectionPointContainer)components;
-            var interfaceId = typeof(_dispVBComponentsEvents).GUID;
-
-            IConnectionPoint connectionPoint;
-            connectionPointContainer.FindConnectionPoint(ref interfaceId, out connectionPoint);
-
-            var componentsSink = new VBComponentsEventsSink();
-            componentsSink.ComponentActivated += sink_ComponentActivated;
-            componentsSink.ComponentAdded += sink_ComponentAdded;
-            componentsSink.ComponentReloaded += sink_ComponentReloaded;
-            componentsSink.ComponentRemoved += sink_ComponentRemoved;
-            componentsSink.ComponentRenamed += sink_ComponentRenamed;
-            componentsSink.ComponentSelected += sink_ComponentSelected;
-            _componentsEventsSinks.Add(projectId, componentsSink);
-
-            int cookie;
-            connectionPoint.Advise(componentsSink, out cookie);
-
-            _componentsEventsConnectionPoints.Add(projectId, Tuple.Create(connectionPoint, cookie));
-            Logger.Debug("Components sink registered and advising.");
-        }
-
         async void sink_ComponentSelected(object sender, DispatcherEventArgs<VBComponent> e)
         {
             if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
@@ -324,8 +211,6 @@ async void sink_ComponentSelected(object sender, DispatcherEventArgs<VBComponent
             {
                 return;
             }
-            
-            // todo: keep Code Explorer in sync with Project Explorer
         }
 
         async void sink_ComponentRenamed(object sender, DispatcherRenamedEventArgs<VBComponent> e)
@@ -356,25 +241,8 @@ async void sink_ComponentRenamed(object sender, DispatcherRenamedEventArgs<VBCom
                 // with two Document-component types just skip the Worksheet component
                 ((ClassModuleDeclaration) componentDeclaration).Supertypes.All(a => a.IdentifierName != "Worksheet"))
             {
-                _componentsEventsSinks.Remove(projectId);
-                _referencesEventsSinks.Remove(projectId);
                 _parser.State.RemoveProject(projectId);
 
-                Logger.Debug("Project '{0}' was removed.", e.Item.Name);
-                Tuple<IConnectionPoint, int> componentsTuple;
-                if (_componentsEventsConnectionPoints.TryGetValue(projectId, out componentsTuple))
-                {
-                    componentsTuple.Item1.Unadvise(componentsTuple.Item2);
-                    _componentsEventsConnectionPoints.Remove(projectId);
-                }
-
-                Tuple<IConnectionPoint, int> referencesTuple;
-                if (_referencesEventsConnectionPoints.TryGetValue(projectId, out referencesTuple))
-                {
-                    referencesTuple.Item1.Unadvise(referencesTuple.Item2);
-                    _referencesEventsConnectionPoints.Remove(projectId);
-                }
-
                 _parser.State.AddProject(e.Item.Collection.Parent);
             }
             else
@@ -431,18 +299,6 @@ async void sink_ComponentAdded(object sender, DispatcherEventArgs<VBComponent> e
             _parser.State.OnParseRequested(sender, e.Item);
         }
 
-        async void sink_ComponentActivated(object sender, DispatcherEventArgs<VBComponent> e)
-        {
-            if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
-
-            if (!_parser.State.AllDeclarations.Any())
-            {
-                return;
-            }
-            
-            // do something?
-        }
-
         async void sink_ProjectRenamed(object sender, DispatcherRenamedEventArgs<VBProject> e)
         {
             if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
@@ -461,19 +317,7 @@ async void sink_ProjectRenamed(object sender, DispatcherRenamedEventArgs<VBProje
 
             _parser.State.OnParseRequested(sender);
         }
-
-        async void sink_ProjectActivated(object sender, DispatcherEventArgs<VBProject> e)
-        {
-            if (!_handleSinkEvents || !_vbe.IsInDesignMode()) { return; }
-
-            if (!_parser.State.AllDeclarations.Any())
-            {
-                return;
-            }
-            
-            // todo: keep Code Explorer in sync with Project Explorer
-        }
-        #endregion
+        #endregion*/
 
         private void _stateBar_Refresh(object sender, EventArgs e)
         {
@@ -509,28 +353,13 @@ private void LoadConfig()
         }
 
         private bool _disposed;
-
         public void Dispose()
         {
             if (_disposed)
             {
                 return;
             }
 
-            if (_sourceControlPanelVM != null)
-            {
-                _sourceControlPanelVM.OpenRepoStarted -= DisableSinkEventHandlers;
-                _sourceControlPanelVM.OpenRepoCompleted -= EnableSinkEventHandlersAndUpdateCache;
-            }
-
-            if (_branchesVM != null)
-            {
-                _branchesVM.LoadingComponentsStarted -= DisableSinkEventHandlers;
-                _branchesVM.LoadingComponentsCompleted -= EnableSinkEventHandlersAndUpdateCache;
-            }
-
-            _handleSinkEvents = false;
-
             if (_parser != null && _parser.State != null)
             {
                 _parser.State.StateChanged -= Parser_StateChanged;
@@ -564,41 +393,12 @@ public void Dispose()
                 _stateBar = null;
             }
 
-            if (_sink != null)
-            {
-                _sink.ProjectAdded -= sink_ProjectAdded;
-                _sink.ProjectRemoved -= sink_ProjectRemoved;
-                _sink.ProjectActivated -= sink_ProjectActivated;
-                _sink.ProjectRenamed -= sink_ProjectRenamed;
-                _sink = null;
-            }
-
-            foreach (var item in _componentsEventsSinks)
-            {
-                item.Value.ComponentActivated -= sink_ComponentActivated;
-                item.Value.ComponentAdded -= sink_ComponentAdded;
-                item.Value.ComponentReloaded -= sink_ComponentReloaded;
-                item.Value.ComponentRemoved -= sink_ComponentRemoved;
-                item.Value.ComponentRenamed -= sink_ComponentRenamed;
-                item.Value.ComponentSelected -= sink_ComponentSelected;
-            }
-
             if (_autoSave != null)
             {
                 _autoSave.Dispose();
                 _autoSave = null;
             }
 
-            _projectsEventsConnectionPoint.Unadvise(_projectsEventsCookie);
-            foreach (var item in _componentsEventsConnectionPoints)
-            {
-                item.Value.Item1.Unadvise(item.Value.Item2);
-            }
-            foreach (var item in _referencesEventsConnectionPoints)
-            {
-                item.Value.Item1.Unadvise(item.Value.Item2);
-            }
-
             UiDispatcher.Shutdown();
 
             _disposed = true;

RetailCoder.VBE/Common/Dispatch/DispatcherEventArgs.cs

@@ -1,8 +1,9 @@
 using System;
+using Rubberduck.Parsing;
 
 namespace Rubberduck.Common.Dispatch
 {
-    public class DispatcherEventArgs<T> : EventArgs 
+    public class DispatcherEventArgs<T> : EventArgs, IDispatcherEventArgs<T>
         where T : class
     {
         private readonly T _item;

RetailCoder.VBE/Common/Dispatch/DispatcherRenamedEventArgs.cs

@@ -1,6 +1,8 @@
-namespace Rubberduck.Common.Dispatch
+using Rubberduck.Parsing;
+
+namespace Rubberduck.Common.Dispatch
 {
-    public class DispatcherRenamedEventArgs<T> : DispatcherEventArgs<T>
+    public class DispatcherRenamedEventArgs<T> : DispatcherEventArgs<T>, IDispatcherRenamedEventArgs<T>
         where T : class
     {
         private readonly string _oldName;