Merge pull request #5101 from Vogel612/feature/excel-hotkey-annotation

Add Excel Hotkey Annotation, Closes #4959

Author: retailcoder

Rubberduck.Parsing/Annotations/AnnotationType.cs

@@ -72,7 +72,9 @@ public enum AnnotationType
         ModuleAttribute = 1 << 20 | Attribute | ModuleAnnotation,
         MemberAttribute = 1 << 21 | Attribute | MemberAnnotation | VariableAnnotation,
         [FlexibleAttributeValueAnnotation("VB_VarDescription", 1)]
-        VariableDescription = 1 << 13 | Attribute | VariableAnnotation
+        VariableDescription = 1 << 13 | Attribute | VariableAnnotation,
+        [FlexibleAttributeValueAnnotation("VB_ProcData.VB_Invoke_Func", 1)]
+        ExcelHotKey = 1 << 16 | Attribute | MemberAnnotation
     }
 
     [AttributeUsage(AttributeTargets.Field)]

Rubberduck.Parsing/Annotations/AttributeAnnotationProvider.cs

@@ -33,6 +33,11 @@ public class AttributeAnnotationProvider : IAttributeAnnotationProvider
             var flexibleValueAttributeAnnotation = FirstMatchingFlexibleAttributeValueAnnotation(annotationTypes, attributeName, attributeValues.Count);
             if (flexibleValueAttributeAnnotation != default)
             {
+                // FIXME special cased bodge for ExcelHotKeyAnnotation to deal with the value transformation:
+                if (flexibleValueAttributeAnnotation == AnnotationType.ExcelHotKey)
+                {
+                    return (flexibleValueAttributeAnnotation, attributeValues.Select(keySpec => keySpec.Substring(0, 1)).ToList());
+                }
                 return (flexibleValueAttributeAnnotation, attributeValues);
             }
 

Rubberduck.Parsing/Annotations/ExcelHotKeyAnnotation.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Parsing.Annotations
+{
+    public sealed class ExcelHotKeyAnnotation : FlexibleAttributeValueAnnotationBase
+    {
+        public ExcelHotKeyAnnotation(QualifiedSelection qualifiedSelection, VBAParser.AnnotationContext context, IEnumerable<string> annotationParameterValues) :
+            base(AnnotationType.ExcelHotKey, qualifiedSelection, context, GetHotKeyAttributeValue(annotationParameterValues))
+        { }
+
+        private static IEnumerable<string> GetHotKeyAttributeValue(IEnumerable<string> parameters) => 
+            parameters.Take(1).Select(StripStringLiteralQuotes).Select(v => v[0] + @"\n14").ToList();
+
+        private static string StripStringLiteralQuotes(string value) =>
+            value.StartsWith("\"") && value.EndsWith("\"") && value.Length > 2
+                ? value.Substring(1, value.Length - 2)
+                : value;
+    }
+}

Rubberduck.Parsing/Annotations/FlexibleAttributeValueAnnotationBase.cs

@@ -8,26 +8,19 @@ namespace Rubberduck.Parsing.Annotations
 {
     public abstract class FlexibleAttributeValueAnnotationBase : AnnotationBase, IAttributeAnnotation
     {
-        protected FlexibleAttributeValueAnnotationBase(AnnotationType annotationType, QualifiedSelection qualifiedSelection, VBAParser.AnnotationContext context, IEnumerable<string> parameters)
+        public string Attribute { get; }
+        public IReadOnlyList<string> AttributeValues { get; }
+
+        protected FlexibleAttributeValueAnnotationBase(AnnotationType annotationType, QualifiedSelection qualifiedSelection, VBAParser.AnnotationContext context, IEnumerable<string> attributeValues)
         :base(annotationType, qualifiedSelection, context)
         {
             var flexibleAttributeValueInfo = FlexibleAttributeValueInfo(annotationType);
 
-            if (flexibleAttributeValueInfo == null)
-            {
-                Attribute = string.Empty;
-                AttributeValues = new List<string>();
-                return;
-            }
-
-            Attribute = flexibleAttributeValueInfo.Value.attribute;
-            AttributeValues = parameters?.Take(flexibleAttributeValueInfo.Value.numberOfValues).ToList() ?? new List<string>();
+            Attribute = flexibleAttributeValueInfo.attribute;
+            AttributeValues = attributeValues?.Take(flexibleAttributeValueInfo.numberOfValues).ToList() ?? new List<string>();
         }
 
-        public string Attribute { get; }
-        public IReadOnlyList<string> AttributeValues { get; }
-
-        private static (string attribute, int numberOfValues)? FlexibleAttributeValueInfo(AnnotationType annotationType)
+        private static (string attribute, int numberOfValues) FlexibleAttributeValueInfo(AnnotationType annotationType)
         {
             var type = annotationType.GetType();
             var name = Enum.GetName(type, annotationType);
@@ -38,7 +31,7 @@ private static (string attribute, int numberOfValues)? FlexibleAttributeValueInf
 
             if (attribute == null)
             {
-                return null;
+                return ("", 0);
             }
 
             return (attribute.AttributeName, attribute.NumberOfParameters);

Rubberduck.Parsing/Annotations/VBAParserAnnotationFactory.cs

@@ -33,6 +33,7 @@ public VBAParserAnnotationFactory()
             _creators.Add(AnnotationType.ModuleAttribute.ToString().ToUpperInvariant(), typeof(ModuleAttributeAnnotation));
             _creators.Add(AnnotationType.MemberAttribute.ToString().ToUpperInvariant(), typeof(MemberAttributeAnnotation));
             _creators.Add(AnnotationType.ModuleDescription.ToString().ToUpperInvariant(), typeof(ModuleDescriptionAnnotation));
+            _creators.Add(AnnotationType.ExcelHotKey.ToString().ToUpperInvariant(), typeof(ExcelHotKeyAnnotation));
         }
 
         public IAnnotation Create(VBAParser.AnnotationContext context, QualifiedSelection qualifiedSelection)

RubberduckTests/Annotations/AttributeAnnotationProviderTests.cs

@@ -5,6 +5,7 @@
 namespace RubberduckTests.Annotations
 {
     [TestFixture]
+    [Category("Annotations")]
     public class AttributeAnnotationProviderTests
     {
         [Test]
@@ -56,13 +57,14 @@ public void ModuleAttributeAnnotationReturnsSpecializedAnnotationsWhereApplicabl
             AssertEqual(expectedValues, actualValues);
         }
 
+        [TestCase("VB_ProcData.VB_Invoke_Func", @"A\n14", AnnotationType.ExcelHotKey, "A")]
         [TestCase("VB_Description", "\"SomeDescription\"", AnnotationType.Description, "\"SomeDescription\"")]
         [TestCase("VB_VarDescription", "\"SomeDescription\"", AnnotationType.VariableDescription, "\"SomeDescription\"")]
         [TestCase("VB_UserMemId", "0", AnnotationType.DefaultMember)]
         [TestCase("VB_UserMemId", "-4", AnnotationType.Enumerator)]
-        public void MemberAttributeAnnotationReturnsSpecializedAnnotationsWhereApplicable(string attributeName, string annotationValue, AnnotationType expectedAnnotationType, string expectedValue = null)
+        public void MemberAttributeAnnotationReturnsSpecializedAnnotationsWhereApplicable(string attributeName, string attributeValue, AnnotationType expectedAnnotationType, string expectedValue = null)
         {
-            var attributeValues = new List<string> { annotationValue };
+            var attributeValues = new List<string> { attributeValue };
             var expectedValues = expectedValue != null
                 ? new List<string> { expectedValue }
                 : new List<string>();