Merge pull request #68 from rubberduck-vba/next

sync with main repo

Author: retailcoder

README.md

@@ -92,6 +92,12 @@ This library makes localizing WPF applications at runtime using resx files a bre
 
 > Licensed under [The Code Project Open License](http://www.codeproject.com/info/cpol10.aspx).
 
+###[EventHook](https://github.com/justcoding121/Windows-User-Action-Hook)
+
+> A one stop library for global windows user actions such mouse, keyboard, clipboard, website visit & print events.
+
+This library allows Rubberduck to detect righ-click actions in the active code pane, to dynamically enable/disable menu commands depending on the current context/selection. We're also using it to capture keypresses, to trigger a reparse of the current module as it's being modified.
+
 ##Icons
 
 We didn't come up with these icons ourselves! Here's who did what:

RetailCoder.VBE/API/ParserState.cs

@@ -65,12 +65,18 @@ public void Initialize(VBE vbe)
             _parser = new RubberduckParser(vbe, _state, _attributeParser);
         }
 
+        /// <summary>
+        /// Blocking call, for easier unit-test code
+        /// </summary>
         public void Parse()
         {
             // blocking call
             _parser.Parse();
         }
 
+        /// <summary>
+        /// Begins asynchronous parsing
+        /// </summary>
         public void BeginParse()
         {
             // non-blocking call

RetailCoder.VBE/App.cs

@@ -5,7 +5,6 @@
 using System.Linq;
 using System.Runtime.InteropServices.ComTypes;
 using System.Windows.Forms;
-using System.Windows.Input;
 using Microsoft.Vbe.Interop;
 using NLog;
 using Rubberduck.Common;
@@ -61,6 +60,8 @@ public App(VBE vbe, IMessageBox messageBox,
             _hooks = hooks;
             _logger = LogManager.GetCurrentClassLogger();
 
+            _hooks.MessageReceived += _hooks_MessageReceived;
+            _configService.SettingsChanged += _configService_SettingsChanged;
             _configService.LanguageChanged += ConfigServiceLanguageChanged;
             _parser.State.StateChanged += Parser_StateChanged;
             _stateBar.Refresh += _stateBar_Refresh;
@@ -80,10 +81,31 @@ public App(VBE vbe, IMessageBox messageBox,
             UiDispatcher.Initialize();
         }
 
+        private void _hooks_MessageReceived(object sender, HookEventArgs e)
+        {
+            if (sender is MouseHookWrapper)
+            {
+                // right-click detected
+                _appMenus.EvaluateCanExecute(_parser.State);
+            }
+        }
+
+        private void _configService_SettingsChanged(object sender, EventArgs e)
+        {
+            // also updates the ShortcutKey text
+            _appMenus.Localize();
+            _hooks.HookHotkeys();
+        }
+
         public void Startup()
         {
             CleanReloadConfig();
 
+            foreach (var project in _vbe.VBProjects.Cast<VBProject>())
+            {
+                _parser.State.AddProject(project);
+            }
+
             _appMenus.Initialize();
             _appMenus.Localize();
 
@@ -94,6 +116,8 @@ public void Startup()
         #region sink handlers. todo: move to another class
         async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
         {
+            _parser.State.RemoveProject(e.Item);
+
             Debug.WriteLine(string.Format("Project '{0}' was removed.", e.Item.Name));
             Tuple<IConnectionPoint, int> value;
             if (_componentsEventsConnectionPoints.TryGetValue(e.Item.VBComponents, out value))
@@ -107,6 +131,8 @@ async void sink_ProjectRemoved(object sender, DispatcherEventArgs<VBProject> e)
 
         async void sink_ProjectAdded(object sender, DispatcherEventArgs<VBProject> e)
         {
+            _parser.State.AddProject(e.Item);
+
             if (!_parser.State.AllDeclarations.Any())
             {
                 // forces menus to evaluate their CanExecute state:
@@ -235,6 +261,15 @@ private void _stateBar_Refresh(object sender, EventArgs e)
 
         private void Parser_StateChanged(object sender, EventArgs e)
         {
+            if (_parser.State.Status != ParserState.Ready)
+            {
+                _hooks.Detach();
+            }
+            else
+            {
+                _hooks.Attach();
+            }
+
             Debug.WriteLine("App handles StateChanged ({0}), evaluating menu states...", _parser.State.Status);
             _appMenus.EvaluateCanExecute(_parser.State);
         }

RetailCoder.VBE/AutoSave/AutoSave.cs

@@ -48,11 +48,11 @@ private void _timer_Elapsed(object sender, ElapsedEventArgs e)
             {
                 try
                 {
-                    // note: VBProject.FileName getter throws IOException if unsaved
-                    _vbe.VBProjects.OfType<VBProject>().Select(p => p.FileName).ToList();
+                    var projects = _vbe.VBProjects.OfType<VBProject>().Select(p => p.FileName).ToList();
                 }
-                catch (DirectoryNotFoundException)
+                catch (IOException)
                 {
+                    // note: VBProject.FileName getter throws IOException if unsaved
                     return;
                 }
 

RetailCoder.VBE/Common/DeclarationExtensions.cs

@@ -354,7 +354,7 @@ public static IEnumerable<Declaration> FindEventProcedures(this IEnumerable<Decl
             var handlerNames = events.Select(e => withEventsDeclaration.IdentifierName + '_' + e.IdentifierName);
 
             return items.Where(item => item.Project != null 
-                                               && item.Project.Equals(withEventsDeclaration.Project)
+                                               && item.ProjectName == withEventsDeclaration.ProjectName
                                                && item.ParentScope == withEventsDeclaration.ParentScope
                                                && item.DeclarationType == DeclarationType.Procedure
                                                && handlerNames.Any(name => item.IdentifierName == name))
@@ -363,7 +363,7 @@ public static IEnumerable<Declaration> FindEventProcedures(this IEnumerable<Decl
 
         private static IEnumerable<Declaration> GetTypeMembers(this IEnumerable<Declaration> declarations, Declaration type)
         {
-            return declarations.Where(item => item.Project != null && item.Project.Equals(type.Project) && item.ParentScope == type.Scope);
+            return declarations.Where(item => item.Project != null && item.ProjectName == type.ProjectName && item.ParentScope == type.Scope);
         }
 
             /// <summary>
@@ -394,10 +394,18 @@ public static Declaration FindInterfaceMember(this IEnumerable<Declaration> decl
             var matches = members.Where(m => !m.IsBuiltIn && implementation.IdentifierName == m.ComponentName + '_' + m.IdentifierName).ToList();
 
             return matches.Count > 1 
-                ? matches.SingleOrDefault(m => m.Project == implementation.Project) 
+                ? matches.SingleOrDefault(m => m.ProjectName == implementation.ProjectName) 
                 : matches.First();
         }
 
+        public static Declaration FindTarget(this IEnumerable<Declaration> declarations, QualifiedSelection selection)
+        {
+            var items = declarations.ToList();
+            Debug.Assert(!items.Any(item => item.IsBuiltIn));
+
+            return items.SingleOrDefault(item => item.IsSelected(selection) || item.References.Any(reference => reference.IsSelected(selection)));
+        }
+
         /// <summary>
         /// Returns the declaration contained in a qualified selection.
         /// To get the selection of a variable or field, use FindVariable(QualifiedSelection)
@@ -412,7 +420,7 @@ public static Declaration FindTarget(this IEnumerable<Declaration> declarations,
 
             var target = items
                 .Where(item => !item.IsBuiltIn)
-                .FirstOrDefault(item => item.IsSelected(selection)
+                .SingleOrDefault(item => item.IsSelected(selection)
                                      || item.References.Any(r => r.IsSelected(selection)));
 
             if (target != null && validDeclarationTypes.Contains(target.DeclarationType))
@@ -531,8 +539,7 @@ public static Declaration FindInterface(this IEnumerable<Declaration> declaratio
                         implementsStmt.GetSelection().StartColumn, reference.Selection.EndLine,
                         reference.Selection.EndColumn);
 
-                    if (reference.QualifiedModuleName.ComponentName == selection.QualifiedName.ComponentName &&
-                        reference.QualifiedModuleName.Project == selection.QualifiedName.Project &&
+                    if (reference.QualifiedModuleName.Equals(selection.QualifiedName) &&
                         completeSelection.Contains(selection.Selection))
                     {
                         return declaration;

RetailCoder.VBE/Common/Dispatch/VBProjectsEventsSink.cs

@@ -8,20 +8,26 @@ public class VBProjectsEventsSink : _dispVBProjectsEvents
         public event EventHandler<DispatcherEventArgs<VBProject>> ProjectAdded;
         public void ItemAdded(VBProject VBProject)
         {
-            OnDispatch(ProjectAdded, VBProject);
+            if (VBProject.Protection == vbext_ProjectProtection.vbext_pp_none)
+            {
+                OnDispatch(ProjectAdded, VBProject);
+            }
         }
 
         public event EventHandler<DispatcherEventArgs<VBProject>> ProjectRemoved;
         public void ItemRemoved(VBProject VBProject)
         {
-            OnDispatch(ProjectRemoved, VBProject);
+            if (VBProject.Protection == vbext_ProjectProtection.vbext_pp_none)
+            {
+                OnDispatch(ProjectRemoved, VBProject);
+            }
         }
 
         public event EventHandler<DispatcherRenamedEventArgs<VBProject>> ProjectRenamed;
         public void ItemRenamed(VBProject VBProject, string OldName)
         {
             var handler = ProjectRenamed;
-            if (handler != null)
+            if (handler != null && VBProject.Protection == vbext_ProjectProtection.vbext_pp_none)
             {
                 handler.Invoke(this, new DispatcherRenamedEventArgs<VBProject>(VBProject, OldName));
             }
@@ -30,7 +36,10 @@ public void ItemRenamed(VBProject VBProject, string OldName)
         public event EventHandler<DispatcherEventArgs<VBProject>> ProjectActivated;
         public void ItemActivated(VBProject VBProject)
         {
-            OnDispatch(ProjectActivated, VBProject);
+            if (VBProject.Protection == vbext_ProjectProtection.vbext_pp_none)
+            {
+                OnDispatch(ProjectActivated, VBProject);
+            }
         }
 
         private void OnDispatch(EventHandler<DispatcherEventArgs<VBProject>> dispatched, VBProject project)

RetailCoder.VBE/Common/Hotkeys/Hotkey.cs

@@ -53,7 +53,7 @@ public void Attach()
 
             if (key == Keys.None)
             {
-                throw new InvalidOperationException("Invalid key.");
+                throw new InvalidOperationException(Rubberduck.UI.RubberduckUI.CommonHotkey_InvalidKey);
             }
 
             HookKey(key, shift);
@@ -63,7 +63,7 @@ public void Detach()
         {
             if (!IsAttached)
             {
-                throw new InvalidOperationException("Hook is already detached.");
+                throw new InvalidOperationException(Rubberduck.UI.RubberduckUI.CommonHotkey_HookDetached);
             }
 
             User32.UnregisterHotKey(_hWndVbe, HotkeyInfo.HookId);
@@ -76,19 +76,20 @@ private void HookKey(Keys key, uint shift)
         {
             if (IsAttached)
             {
-                throw new InvalidOperationException("Hook is already attached.");
+                throw new InvalidOperationException(Rubberduck.UI.RubberduckUI.CommonHotkey_HookAttached);
             }
 
             var hookId = (IntPtr)Kernel32.GlobalAddAtom(Guid.NewGuid().ToString());
             var success = User32.RegisterHotKey(_hWndVbe, hookId, shift, (uint)key);
             if (!success)
             {
-                throw new Win32Exception("HotKey was not registered.");
+                Debug.WriteLine(Rubberduck.UI.RubberduckUI.CommonHotkey_KeyNotRegistered, key);
+                //throw new Win32Exception(Rubberduck.UI.RubberduckUI.CommonHotkey_KeyNotRegistered, key);
             }
 
             HotkeyInfo = new HotkeyInfo(hookId, Combo);
             IsAttached = true;
-            Debug.WriteLine("Hotkey '{0}' hooked successfully to command '{1}'", Key, Command.GetType());
+            Debug.WriteLine("Hotkey '{0}' hooked successfully to command '{1}'", Key, Command.GetType());  //no translation needed for Debug.Writeline
         }
 
         private static readonly IDictionary<char,uint> Modifiers = new Dictionary<char, uint>

RetailCoder.VBE/Common/MouseHookWrapper.cs

@@ -0,0 +1,44 @@
+using System;
+using EventHook;
+using EventHook.Hooks;
+
+namespace Rubberduck.Common
+{
+    public class MouseHookWrapper : IAttachable
+    {
+        public MouseHookWrapper()
+        {
+            MouseWatcher.OnMouseInput += MouseWatcher_OnMouseInput;
+        }
+
+        private void MouseWatcher_OnMouseInput(object sender, MouseEventArgs e)
+        {
+            // only handle right-clicks
+            if (e.Message != MouseMessages.WM_RBUTTONDOWN)
+            {
+                return;
+            }
+
+            var handler = MessageReceived;
+            if (handler != null)
+            {
+                handler.Invoke(this, HookEventArgs.Empty);
+            }
+        }
+
+        public bool IsAttached { get; private set; }
+        public event EventHandler<HookEventArgs> MessageReceived;
+
+        public void Attach()
+        {
+            MouseWatcher.Start();
+            IsAttached = true;
+        }
+
+        public void Detach()
+        {
+            MouseWatcher.Stop();
+            IsAttached = false;
+        }
+    }
+}

RetailCoder.VBE/Common/RubberduckHooks.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Runtime.InteropServices;
 using Microsoft.Vbe.Interop;
@@ -31,19 +32,27 @@ public RubberduckHooks(VBE vbe, IAttachable timerHook, IGeneralConfigService con
             _oldWndPointer = User32.SetWindowLong(_mainWindowHandle, (int)WindowLongFlags.GWL_WNDPROC, _newWndProc);
             _oldWndProc = (User32.WndProc)Marshal.GetDelegateForFunctionPointer(_oldWndPointer, typeof(User32.WndProc));
 
-            _timerHook = timerHook;
             _config = config;
+            _timerHook = timerHook;
             _timerHook.MessageReceived += timerHook_MessageReceived;
         }
 
+
         public void HookHotkeys()
         {
+            Detach();
+            _hooks.Clear();
+
+            AddHook(new MouseHookWrapper());
+
             var config = _config.LoadConfiguration();
             var settings = config.UserSettings.GeneralSettings.HotkeySettings;
             foreach (var hotkey in settings.Where(hotkey => hotkey.IsEnabled))
             {
                 AddHook(new Hotkey(_mainWindowHandle, hotkey.ToString(), hotkey.Command));
             }
+
+            Attach();
         }
 
         public IEnumerable<IAttachable> Hooks { get { return _hooks; } }
@@ -77,19 +86,26 @@ public void Attach()
             {
                 hook.Attach();
                 hook.MessageReceived += hook_MessageReceived;
-                }
+            }
 
             IsAttached = true;
         }
 
         private void hook_MessageReceived(object sender, HookEventArgs e)
         {
-            if (sender is ILowLevelKeyboardHook)
+            if (sender is LowLevelKeyboardHook)
             {
                 // todo: handle 2-step hotkeys?
                 return;
             }
 
+            if (sender is MouseHookWrapper)
+            {
+                Debug.WriteLine("MouseHookWrapper message received");
+                OnMessageReceived(sender, HookEventArgs.Empty);
+                return;
+            }
+
             var hotkey = sender as IHotkey;
             if (hotkey != null)
             {
@@ -110,7 +126,7 @@ public void Detach()
             {
                 hook.Detach();
                 hook.MessageReceived -= hook_MessageReceived;
-                }
+            }
 
             IsAttached = false;
         }