Finalized FindAllReferences feature - implemented double-click navigation, fixed (worked around) COMException and skipped showing the toolwindow when there's only 1 reference for the target identifier

Author: retailcoder

RetailCoder.VBE/UI/IdentifierReferences/IdentifierReferenceListItem.cs

@@ -12,6 +12,11 @@ public IdentifierReferenceListItem(IdentifierReference reference)
             _reference = reference;
         }
 
+        public IdentifierReference GetReferenceItem()
+        {
+            return _reference;
+        }
+
         public QualifiedSelection Selection { get { return new QualifiedSelection(_reference.QualifiedModuleName, _reference.Selection); } }
         public string IdentifierName { get { return _reference.IdentifierName; } }
 

RetailCoder.VBE/UI/IdentifierReferences/IdentifierReferencesListControl.cs

@@ -1,4 +1,5 @@
-using System.Windows.Forms;
+using System;
+using System.Windows.Forms;
 using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.UI.IdentifierReferences
@@ -9,6 +10,26 @@ public IdentifierReferencesListControl(Declaration target)
         {
             InitializeComponent();
             Target = target;
+            ResultBox.DoubleClick += ResultBox_DoubleClick;
+        }
+
+        public event EventHandler<NavigateCodeEventArgs> NavigateIdentifierReference;
+        private void ResultBox_DoubleClick(object sender, System.EventArgs e)
+        {
+            var handler = NavigateIdentifierReference;
+            if (handler == null || ResultBox.SelectedItem == null)
+            {
+                return;
+            }
+
+            var selectedItem = ResultBox.SelectedItem as IdentifierReferenceListItem;
+            if (selectedItem == null)
+            {
+                return;
+            }
+
+            var arg = new NavigateCodeEventArgs(selectedItem.GetReferenceItem());
+            handler(this, arg);
         }
 
         public Declaration Target { get; private set; }

RetailCoder.VBE/UI/IdentifierReferences/IdentifierReferencesListDockablePresenter.cs

@@ -1,5 +1,8 @@
-using System.Linq;
+using System;
+using System.Linq;
 using Microsoft.Vbe.Interop;
+using Rubberduck.Extensions;
+using Rubberduck.Parsing;
 using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.UI.IdentifierReferences
@@ -18,6 +21,17 @@ private void BindTarget(Declaration target)
             listBox.DataSource = target.References.Select(reference => new IdentifierReferenceListItem(reference)).ToList();
             listBox.DisplayMember = "DisplayString";
             listBox.ValueMember = "Selection";
+            Control.NavigateIdentifierReference += Control_NavigateIdentifierReference;
+        }
+
+        public static void OnNavigateIdentifierReference(VBE vbe, IdentifierReference reference)
+        {
+            vbe.SetSelection(new QualifiedSelection(reference.QualifiedModuleName, reference.Selection));
+        }
+
+        private void Control_NavigateIdentifierReference(object sender, NavigateCodeEventArgs e)
+        {
+            OnNavigateIdentifierReference(VBE, e.Reference);
         }
 
         IdentifierReferencesListControl Control { get { return UserControl as IdentifierReferencesListControl; } }

RetailCoder.VBE/UI/NavigateCodeEventArgs.cs

@@ -31,11 +31,26 @@ public NavigateCodeEventArgs(Declaration declaration)
             _selection = declaration.Selection;
         }
 
-        public    NavigateCodeEventArgs(QualifiedSelection qualifiedSelection)
+        public NavigateCodeEventArgs(IdentifierReference reference)
+        {
+            if (reference == null)
+            {
+                return;
+            }
+
+            _reference = reference;
+            _qualifiedName = reference.QualifiedModuleName;
+            _selection = reference.Selection;
+        }
+
+        public NavigateCodeEventArgs(QualifiedSelection qualifiedSelection)
             :this(qualifiedSelection.QualifiedName, qualifiedSelection.Selection)
         {
         }
 
+        private readonly IdentifierReference _reference;
+        public IdentifierReference Reference { get { return _reference; } }
+
         private readonly Declaration _declaration;
         public Declaration Declaration { get { return _declaration; } }
 

RetailCoder.VBE/UI/RefactorMenu.cs

@@ -1,5 +1,7 @@
-using System.Drawing;
+using System;
+using System.Drawing;
 using System.Linq;
+using System.Runtime.InteropServices;
 using Microsoft.Office.Core;
 using Microsoft.Vbe.Interop;
 using Rubberduck.Extensions;
@@ -78,6 +80,38 @@ private void _findAllReferencesContextMenu_Click(CommandBarButton Ctrl, ref bool
             .FirstOrDefault(item => IsSelectedDeclaration(selection, item)
                                   || IsSelectedReference(selection, item));
 
+            if (target == null)
+            {
+                return;
+            }
+
+            var referenceCount = target.References.Count();
+
+            if (referenceCount == 1)
+            {
+                // if there's only 1 reference, just jump to it:
+                IdentifierReferencesListDockablePresenter.OnNavigateIdentifierReference(IDE, target.References.First());
+
+            }
+            else if (referenceCount > 1)
+            {
+                // if there's more than one reference, show the dockable reference navigation window:
+                try
+                {
+                    ShowReferencesToolwindow(target);
+                }
+                catch (COMException)
+                {
+                    // the exception is related to the docked control host instance,
+                    // trying again will work (I know, that's bad bad bad code)
+                    ShowReferencesToolwindow(target);
+                }
+            }
+        }
+
+        private void ShowReferencesToolwindow(Declaration target)
+        {
+            // throws a COMException if toolwindow was already closed
             var window = new IdentifierReferencesListControl(target);
             var presenter = new IdentifierReferencesListDockablePresenter(IDE, AddIn, window, target);
             presenter.Show();

Rubberduck.Parsing/Symbols/IdentifierReferenceListener.cs

@@ -481,6 +481,10 @@ private Declaration GetClosestScope(IEnumerable<Declaration> declarations, Parse
                 if (matchingParent != null)
                 {
                     var parentType = matches.FirstOrDefault(p => p.ComponentName == matchingParent.AsTypeName);
+                    if (parentType == null)
+                    {
+                        return null;
+                    }
                     return matches.FirstOrDefault(m => m.ParentScope == parentType.ParentScope);
                 }
             }