Merge pull request #2708 from comintern/next

Add event source to track selection changes originating in Project Window.

Author: retailcoder

RetailCoder.VBE/App.cs

@@ -63,8 +63,8 @@ public App(IVBE vbe,
             _version = version;
             _checkVersionCommand = checkVersionCommand;
 
-            VBEEvents.SelectionChanged += _vbe_SelectionChanged;
-            VBEEvents.WindowFocusChange += _vbe_FocusChanged;
+            VBENativeServices.SelectionChanged += _vbe_SelectionChanged;
+            VBENativeServices.WindowFocusChange += _vbe_FocusChanged;
 
             _configService.SettingsChanged += _configService_SettingsChanged;
             _parser.State.StateChanged += Parser_StateChanged;
@@ -73,6 +73,9 @@ public App(IVBE vbe,
             UiDispatcher.Initialize();
         }
 
+        //TODO - This should be able to move to the appropriate handling classes now.
+        #region Statusbar 
+
         private void State_StatusMessageUpdate(object sender, RubberduckStatusMessageEventArgs e)
         {
             var message = e.Message;
@@ -92,90 +95,79 @@ private void _vbe_SelectionChanged(object sender, SelectionChangedEventArgs e)
 
         private void _vbe_FocusChanged(object sender, WindowChangedEventArgs e)
         {
-            if (e.EventType == WindowChangedEventArgs.FocusType.GotFocus)
+            if (e.EventType == FocusType.GotFocus)
             {
                 switch (e.Window.Type)
                 {
                     case WindowKind.Designer:
+                        //Designer or control on designer form selected.
                         RefreshSelection(e.Window);
                         break;
                     case WindowKind.CodeWindow:
+                        //Caret changed in a code pane.
                         RefreshSelection(e.CodePane);
                         break;
                 }              
-            }          
+            }
+            else if (e.EventType == FocusType.ChildFocus)
+            {
+                //Treeview selection changed in project window.
+                RefreshSelection();
+            }
         }
 
         private ParserState _lastStatus;
         private Declaration _lastSelectedDeclaration;
         private void RefreshSelection(ICodePane pane)
         {
-            Declaration selectedDeclaration = null;
-            if (!pane.IsWrappingNullReference)
+            if (pane == null || pane.IsWrappingNullReference)
             {
-                selectedDeclaration = _parser.State.FindSelectedDeclaration(pane);
-                var refCount = selectedDeclaration == null ? 0 : selectedDeclaration.References.Count();
-                var caption = _stateBar.GetContextSelectionCaption(_vbe.ActiveCodePane, selectedDeclaration);
-                _stateBar.SetContextSelectionCaption(caption, refCount);
-            }
-
-            var currentStatus = _parser.State.Status;
-            if (ShouldEvaluateCanExecute(selectedDeclaration, currentStatus))
-            {
-                _appMenus.EvaluateCanExecute(_parser.State);
-                _stateBar.EvaluateCanExecute(_parser.State);
+                return;
             }
 
-            _lastStatus = currentStatus;
-            _lastSelectedDeclaration = selectedDeclaration;
+            var selectedDeclaration = _parser.State.FindSelectedDeclaration(pane);
+            var caption = _stateBar.GetContextSelectionCaption(_vbe.ActiveCodePane, selectedDeclaration);
+            UpdateStatusbarAndCommandState(caption, selectedDeclaration);
         }
 
         private void RefreshSelection(IWindow window)
         {
-            if (window.IsWrappingNullReference || window.Type != WindowKind.Designer)
+            if (window == null || window.IsWrappingNullReference || window.Type != WindowKind.Designer)
             {
                 return;
             }
-            var caption = String.Empty;
-            var refCount = 0;
 
-            WindowKind windowKind = _vbe.ActiveWindow.Type;
-            var pane = _vbe.ActiveCodePane;
             var component = _vbe.SelectedVBComponent;
+            var caption = GetComponentControlsCaption(component);
+            //TODO: Need to find the selected declaration for the Form\Control.
+            UpdateStatusbarAndCommandState(caption, null);
+        }
 
-            Declaration selectedDeclaration = null;
-
-            //TODO - I doubt this is the best way to check if the SelectedVBComponent and the ActiveCodePane are the same component.
-            if (windowKind == WindowKind.CodeWindow || (!_vbe.SelectedVBComponent.IsWrappingNullReference
-                                                        && component.ParentProject.ProjectId == pane.CodeModule.Parent.ParentProject.ProjectId
-                                                        && component.Name == pane.CodeModule.Parent.Name))
-            {
-                selectedDeclaration = _parser.State.FindSelectedDeclaration(pane);
-                refCount = selectedDeclaration == null ? 0 : selectedDeclaration.References.Count();
-                caption = _stateBar.GetContextSelectionCaption(_vbe.ActiveCodePane, selectedDeclaration);
-            }
-            else if (windowKind == WindowKind.Designer)
+        private void RefreshSelection()
+        {
+            var caption = string.Empty;
+            var component = _vbe.SelectedVBComponent;
+            if (component == null || component.IsWrappingNullReference)
             {
-                caption = GetComponentControlsCaption(component);
+                //The user might have selected the project node in Project Explorer
+                //If they've chosen a folder, we'll return the project anyway
+                caption = !_vbe.ActiveVBProject.IsWrappingNullReference
+                    ? _vbe.ActiveVBProject.Name
+                    : null;
             }
             else
             {
-                if (_vbe.SelectedVBComponent.IsWrappingNullReference)
-                {
-                    //The user might have selected the project node in Project Explorer
-                    //If they've chosen a folder, we'll return the project anyway
-                    caption = !_vbe.ActiveVBProject.IsWrappingNullReference
-                        ? _vbe.ActiveVBProject.Name
-                        : null;
-                }
-                else
-                {
-                    caption = component.Type == ComponentType.UserForm && component.HasOpenDesigner
-                        ? GetComponentControlsCaption(component)
-                        : String.Format("{0}.{1} ({2})", component.ParentProject.Name, component.Name, component.Type);
-                }
+                caption = component.Type == ComponentType.UserForm && component.HasOpenDesigner
+                    ? GetComponentControlsCaption(component)
+                    : string.Format("{0}.{1} ({2})", component.ParentProject.Name, component.Name, component.Type);
             }
+            //TODO: Need to find the selected declaration for the selected treeview item.
+            UpdateStatusbarAndCommandState(caption, null);
+        }
 
+        private void UpdateStatusbarAndCommandState(string caption, Declaration selectedDeclaration)
+        {
+            var refCount = selectedDeclaration == null ? 0 : selectedDeclaration.References.Count();
             _stateBar.SetContextSelectionCaption(caption, refCount);
 
             var currentStatus = _parser.State.Status;
@@ -186,7 +178,7 @@ private void RefreshSelection(IWindow window)
             }
 
             _lastStatus = currentStatus;
-            _lastSelectedDeclaration = selectedDeclaration;
+            _lastSelectedDeclaration = selectedDeclaration;            
         }
 
         private string GetComponentControlsCaption(IVBComponent component)
@@ -215,6 +207,8 @@ private bool ShouldEvaluateCanExecute(Declaration selectedDeclaration, ParserSta
                    (selectedDeclaration == null && _lastSelectedDeclaration != null);
         }
 
+        #endregion
+
         private void _configService_SettingsChanged(object sender, ConfigurationChangedEventArgs e)
         {
             _config = _configService.LoadConfiguration();
@@ -366,8 +360,8 @@ public void Dispose()
                 _parser.State.StatusMessageUpdate -= State_StatusMessageUpdate;
             }
 
-            VBEEvents.SelectionChanged += _vbe_SelectionChanged;
-            VBEEvents.WindowFocusChange += _vbe_FocusChanged;
+            VBENativeServices.SelectionChanged += _vbe_SelectionChanged;
+            VBENativeServices.WindowFocusChange += _vbe_FocusChanged;
 
             if (_configService != null)
             {

RetailCoder.VBE/Extension.cs

@@ -56,7 +56,7 @@ public void OnConnection(object Application, ext_ConnectMode ConnectMode, object
                 {
                     var vbe = (Microsoft.Vbe.Interop.VBE) Application;                  
                     _ide = new VBEditor.SafeComWrappers.VBA.VBE(vbe);
-                    VBEEvents.HookEvents(_ide);
+                    VBENativeServices.HookEvents(_ide);
 
                     var addin = (Microsoft.Vbe.Interop.AddIn)AddInInst;
                     _addin = new VBEditor.SafeComWrappers.VBA.AddIn(addin) { Object = this };
@@ -221,7 +221,7 @@ private void Startup()
 
         private void ShutdownAddIn()
         {
-            VBEEvents.UnhookEvents();
+            VBENativeServices.UnhookEvents();
 
             var currentDomain = AppDomain.CurrentDomain;
             currentDomain.AssemblyResolve -= LoadFromSameFolder;

Rubberduck.VBEEditor/Events/VBEEvents.cs renamed to Rubberduck.VBEEditor/Events/VBENativeServices.cs

@@ -9,7 +9,7 @@
 
 namespace Rubberduck.VBEditor.Events
 {
-    public static class VBEEvents
+    public static class VBENativeServices
     {
         private static User32.WinEventProc _eventProc;
         private static IntPtr _eventHandle;
@@ -66,7 +66,10 @@ public static void UnhookEvents()
         public static void VbeEventCallback(IntPtr hWinEventHook, uint eventType, IntPtr hwnd, int idObject, int idChild,
             uint dwEventThread, uint dwmsEventTime)
         {
-            if (hwnd != IntPtr.Zero && idObject == (int)ObjId.Caret && eventType == (uint)WinEvent.ObjectLocationChange && hwnd.ToWindowType() == WindowType.VbaWindow)
+            if (hwnd != IntPtr.Zero && 
+                idObject == (int)ObjId.Caret && 
+                (eventType == (uint)WinEvent.ObjectLocationChange || eventType == (uint)WinEvent.ObjectCreate) && 
+                hwnd.ToWindowType() == WindowType.VbaWindow)
             {
                 OnSelectionChanged(hwnd);             
             }
@@ -83,6 +86,17 @@ public static void VbeEventCallback(IntPtr hWinEventHook, uint eventType, IntPtr
                     DetachWindow(hwnd);
                 }
             }
+            else if (eventType == (uint)WinEvent.ObjectFocus && idObject == (int)ObjId.Client)
+            {
+                //Test to see if it was a selection change in the project window.
+                var parent = User32.GetParent(hwnd);
+                if (parent != IntPtr.Zero && parent.ToWindowType() == WindowType.Project)
+                {
+                    FocusDispatcher(_vbe, new WindowChangedEventArgs(parent, null, null, FocusType.ChildFocus));
+                }                
+            }
+            //This is an output window firehose, leave this here, but comment it out when done.
+            //if (idObject != (int)ObjId.Cursor) Debug.WriteLine("Hwnd: {0:X4} - EventType {1:X4}, idObject {2}, idChild {3}", (int)hwnd, eventType, idObject, idChild);
         }
 
         private static void AttachWindow(IntPtr hwnd)
@@ -176,15 +190,21 @@ public enum WindowType
         {
             Indeterminate,
             VbaWindow,
-            DesignerWindow
+            DesignerWindow,
+            Project
         }
 
         public static WindowType ToWindowType(this IntPtr hwnd)
+        {
+            WindowType id;
+            return Enum.TryParse(hwnd.ToClassName(), true, out id) ? id : WindowType.Indeterminate;
+        }
+
+        public static string ToClassName(this IntPtr hwnd)
         {
             var name = new StringBuilder(128);
             User32.GetClassName(hwnd, name, name.Capacity);
-            WindowType id;
-            return Enum.TryParse(name.ToString(), out id) ? id : WindowType.Indeterminate;
+            return name.ToString();
         }
     }
 }

Rubberduck.VBEEditor/Events/WindowChangedEventArgs.cs

@@ -3,14 +3,15 @@
 
 namespace Rubberduck.VBEditor.Events
 {
-    public class WindowChangedEventArgs : EventArgs
+    public enum FocusType
     {
-        public enum FocusType
-        {
-            GotFocus,
-            LostFocus
-        }
+        GotFocus,
+        LostFocus,
+        ChildFocus
+    }
 
+    public class WindowChangedEventArgs : EventArgs
+    {
         public IntPtr Hwnd { get; private set; }
         public IWindow Window { get; private set; }
         public ICodePane CodePane { get; private set; }

Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

@@ -125,7 +125,7 @@
     <Compile Include="Events\ProjectEventArgs.cs" />
     <Compile Include="Events\ProjectRenamedEventArgs.cs" />
     <Compile Include="Events\SelectionChangedEventArgs.cs" />
-    <Compile Include="Events\VBEEvents.cs" />
+    <Compile Include="Events\VBENativeServices.cs" />
     <Compile Include="Events\WindowChangedEventArgs.cs" />
     <Compile Include="Extensions\MSAccessComponentTypeExtensions.cs" />
     <Compile Include="SafeComWrappers\Abstract\ISafeComWrapper.cs" />

Rubberduck.VBEEditor/WindowsApi/CodePaneSubclass.cs

@@ -16,9 +16,9 @@ internal CodePaneSubclass(IntPtr hwnd, ICodePane pane) : base(hwnd)
             _pane = pane;
         }
 
-        protected override void DispatchFocusEvent(WindowChangedEventArgs.FocusType type)
+        protected override void DispatchFocusEvent(FocusType type)
         {
-            var window = VBEEvents.GetWindowInfoFromHwnd(Hwnd);
+            var window = VBENativeServices.GetWindowInfoFromHwnd(Hwnd);
             if (window == null)
             {
                 return;

Rubberduck.VBEEditor/WindowsApi/DesignerWindowSubclass.cs

@@ -1,10 +1,26 @@
 using System;
+using System.Diagnostics;
+using Rubberduck.Common.WinAPI;
+using Rubberduck.VBEditor.Events;
 
 namespace Rubberduck.VBEditor.WindowsApi
 {
     internal class DesignerWindowSubclass : FocusSource
     {
         //Stub for designer window replacement.  :-)
         internal DesignerWindowSubclass(IntPtr hwnd) : base(hwnd) { }
+
+        public override int SubClassProc(IntPtr hWnd, IntPtr msg, IntPtr wParam, IntPtr lParam, IntPtr uIdSubclass, IntPtr dwRefData)
+        {
+            //Any time the selected control changes in the hosted userform, the F3 Overlay has to be redrawn.  This is a good proxy
+            //for child control selections, so raise a focus event.
+            if ((int) msg == (int)WM.ERASEBKGND)
+            {
+                DispatchFocusEvent(FocusType.GotFocus);
+            }
+            //This is an output window firehose, leave this here, but comment it out when done.
+            //Debug.WriteLine("WM: {0:X4}, wParam {1}, lParam {2}", msg, wParam, lParam);
+            return base.SubClassProc(hWnd, msg, wParam, lParam, uIdSubclass, dwRefData);
+        }
     }
 }

Rubberduck.VBEEditor/WindowsApi/FocusSource.cs

@@ -17,9 +17,9 @@ protected void OnFocusChange(WindowChangedEventArgs eventArgs)
             }
         }
 
-        protected virtual void DispatchFocusEvent(WindowChangedEventArgs.FocusType type)
+        protected virtual void DispatchFocusEvent(FocusType type)
         {
-            var window = VBEEvents.GetWindowInfoFromHwnd(Hwnd);
+            var window = VBENativeServices.GetWindowInfoFromHwnd(Hwnd);
             if (window == null)
             {
                 return;
@@ -33,10 +33,10 @@ public override int SubClassProc(IntPtr hWnd, IntPtr msg, IntPtr wParam, IntPtr
             {
                 case (uint)WM.SETFOCUS:
 
-                    DispatchFocusEvent(WindowChangedEventArgs.FocusType.GotFocus);
+                    DispatchFocusEvent(FocusType.GotFocus);
                     break;
                 case (uint)WM.KILLFOCUS:
-                    DispatchFocusEvent(WindowChangedEventArgs.FocusType.LostFocus);
+                    DispatchFocusEvent(FocusType.LostFocus);
                     break;
             }
             return base.SubClassProc(hWnd, msg, wParam, lParam, uIdSubclass, dwRefData);

Rubberduck.VBEEditor/WindowsApi/NativeMethods.cs

@@ -69,15 +69,6 @@ public static string GetWindowText(this IntPtr windowHandle)
             return result;
         }
 
-        /// <summary>   Gets the parent window of this item. </summary>
-        ///
-        /// <param name="hWnd"> The window handle. </param>
-        /// <returns>   The parent window IntPtr handle. </returns>
-        [DllImport("User32.dll")]
-        internal static extern IntPtr GetParent(IntPtr hWnd);
-
-
-
         /// <summary>Activates the window by simulating a click.</summary>
         ///
         /// <param name="windowHandle">         Handle of the window to be activated. </param>

Rubberduck.VBEEditor/WindowsApi/User32.cs

@@ -66,5 +66,12 @@ public static class User32
         /// <returns>The length of the returned class name (without the null terminator), zero on error.</returns>
         [DllImport("user32.dll", SetLastError = true, CharSet = CharSet.Auto)]
         public static extern int GetClassName(IntPtr hWnd, StringBuilder lpClassName, int nMaxCount);
+
+        /// <summary>   Gets the parent window of this item. </summary>
+        ///
+        /// <param name="hWnd"> The window handle. </param>
+        /// <returns>   The parent window IntPtr handle. </returns>
+        [DllImport("User32.dll")]
+        internal static extern IntPtr GetParent(IntPtr hWnd);
     }
 }