Made the AttributeListener add module variable attributes to the correct scope, added MembersAllowingAttributes and fixed the failing tests caused by the necessary grammar change.

MDoerner · MDoerner · commit 41d91e13a624 · 2018-08-19T15:00:49.000+02:00
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyModuleInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/EmptyModuleInspection.cs
@@ -87,7 +87,7 @@ public override bool VisitModuleDeclarations(VBAParser.ModuleDeclarationsContext
 
         public override bool VisitModuleDeclarationsElement(VBAParser.ModuleDeclarationsElementContext context)
         {
-            return context.variableStmt() == null
+            return context.moduleVariableStmt() == null
                    && context.constStmt() == null
                    && context.enumerationStmt() == null
                    && context.udtDeclaration() == null
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/ModuleScopeDimKeywordInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/ModuleScopeDimKeywordInspection.cs
@@ -45,7 +45,7 @@ public void ClearContexts()
 
             public override void ExitVariableStmt([NotNull] VBAParser.VariableStmtContext context)
             {
-                if (context.DIM() != null && context.Parent is VBAParser.ModuleDeclarationsElementContext)
+                if (context.DIM() != null && context.TryGetAncestor<VBAParser.ModuleDeclarationsElementContext>(out _))
                 {
                     _contexts.Add(new QualifiedContext<ParserRuleContext>(CurrentModuleName, context));
                 }
diff --git a/Rubberduck.Parsing/Grammar/VBAParser.g4 b/Rubberduck.Parsing/Grammar/VBAParser.g4
@@ -97,11 +97,16 @@ moduleDeclarationsElement :
     | eventStmt
     | constStmt
     | implementsStmt
-    | variableStmt
+    | moduleVariableStmt
     | moduleOption
     | udtDeclaration)
 ;
 
+moduleVariableStmt :
+	variableStmt
+	(endOfLine attributeStmt)*
+;
+
 moduleBody : 
     whiteSpace?
     (moduleBodyElement endOfStatement)*;
diff --git a/Rubberduck.Parsing/ParserRuleContextExtensions.cs b/Rubberduck.Parsing/ParserRuleContextExtensions.cs
@@ -131,6 +131,15 @@ public static TContext GetAncestor<TContext>(this ParserRuleContext context)
             return GetAncestor_Recursive<TContext>(context);
         }
 
+        /// <summary>
+        /// Tries to return the context's first ancestor of the generic Type.
+        /// </summary>
+        public static bool TryGetAncestor<TContext>(this ParserRuleContext context, out TContext ancestor)
+        {
+            ancestor = context.GetAncestor<TContext>();
+            return ancestor != null;
+        }
+
         private static TContext GetAncestor_Recursive<TContext>(ParserRuleContext context)
         {
             if (context == null)
diff --git a/Rubberduck.Parsing/Rewriter/RewriterInfo/VariableRewriterInfoFinder.cs b/Rubberduck.Parsing/Rewriter/RewriterInfo/VariableRewriterInfoFinder.cs
@@ -24,7 +24,7 @@ private static RewriterInfo GetRewriterInfo(VBAParser.VariableSubStmtContext var
             var itemIndex = items.ToList().IndexOf(variable);
             var count = items.Length;
 
-            if (context.Parent.Parent is VBAParser.ModuleDeclarationsElementContext element)
+            if (context.TryGetAncestor<VBAParser.ModuleDeclarationsElementContext>(out var element))
             {
                 return GetModuleVariableRemovalInfo(variable, element, count, itemIndex, items);
             }
diff --git a/Rubberduck.Parsing/Symbols/Identifier.cs b/Rubberduck.Parsing/Symbols/Identifier.cs
@@ -35,6 +35,12 @@ public static string GetName(VBAParser.VariableSubStmtContext context, out Inter
             return GetName(nameContext, out tokenInterval);
         }
 
+        public static string GetName(VBAParser.VariableSubStmtContext context)
+        {
+            var nameContext = context.identifier();
+            return GetName(nameContext);
+        }
+
         public static string GetName(VBAParser.ConstSubStmtContext context, out Interval tokenInterval)
         {
             var nameContext = context.identifier();
diff --git a/Rubberduck.Parsing/VBA/Parsing/AttributeListener.cs b/Rubberduck.Parsing/VBA/Parsing/AttributeListener.cs
@@ -11,18 +11,23 @@ public class AttributeListener : VBAParserBaseListener
     {
         private readonly Dictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes> _attributes 
             = new Dictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes>();
+        private readonly Dictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext> _membersAllowingAttributes
+            = new Dictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext>();
 
-        private IAnnotatedContext _currentAnnotatedContext;
+        private readonly (string scopeIdentifier, DeclarationType scopeType) _initialScope;
         private (string scopeIdentifier, DeclarationType scopeType) _currentScope;
+        private IAnnotatedContext _currentAnnotatedContext;
         private Attributes _currentScopeAttributes;
 
         public AttributeListener((string scopeIdentifier, DeclarationType scopeType) initialScope)
         {
+            _initialScope = initialScope;
             _currentScope = initialScope;
             _currentScopeAttributes = new Attributes();
         }
 
         public IDictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes> Attributes => _attributes;
+        public IDictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext> MembersAllowingAttributes => _membersAllowingAttributes;
 
         public override void ExitAnnotation(VBAParser.AnnotationContext context)
         {
@@ -38,11 +43,41 @@ public override void ExitModuleAttributes(VBAParser.ModuleAttributesContext cont
             }
         }
 
+        public override void EnterModuleVariableStmt(VBAParser.ModuleVariableStmtContext context)
+        {
+            _currentScopeAttributes = new Attributes();
+            var annotatedContext = context.variableStmt().variableListStmt().variableSubStmt().Last();
+            _currentScope = (Identifier.GetName(annotatedContext), DeclarationType.Variable);
+            _currentAnnotatedContext = annotatedContext;
+            _membersAllowingAttributes[_currentScope] = context;
+        }
+
+        public override void ExitModuleVariableStmt(VBAParser.ModuleVariableStmtContext context)
+        {
+            if (_currentScopeAttributes.Any())
+            {
+                _attributes.Add(_currentScope, _currentScopeAttributes);
+                var annotatedContext = context.variableStmt().variableListStmt().variableSubStmt().Last();
+                annotatedContext.AddAttributes(_currentScopeAttributes);
+            }
+
+            ResetScope();
+        }
+
+        private void ResetScope()
+        {
+            _currentScope = _initialScope;
+            _currentScopeAttributes = _attributes.TryGetValue(_currentScope, out var attributes)
+                ? attributes
+                : new Attributes();
+        }
+
         public override void EnterSubStmt(VBAParser.SubStmtContext context)
         {
             _currentScopeAttributes = new Attributes();
             _currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.Procedure);
             _currentAnnotatedContext = context;
+            _membersAllowingAttributes[_currentScope] = context;
         }
 
         public override void ExitSubStmt(VBAParser.SubStmtContext context)
@@ -52,13 +87,16 @@ public override void ExitSubStmt(VBAParser.SubStmtContext context)
                 _attributes.Add(_currentScope, _currentScopeAttributes);
                 context.AddAttributes(_currentScopeAttributes);
             }
+
+            ResetScope();
         }
 
         public override void EnterFunctionStmt(VBAParser.FunctionStmtContext context)
         {
             _currentScopeAttributes = new Attributes();
             _currentScope = (Identifier.GetName(context.functionName()), DeclarationType.Function);
             _currentAnnotatedContext = context;
+            _membersAllowingAttributes[_currentScope] = context;
         }
 
         public override void ExitFunctionStmt(VBAParser.FunctionStmtContext context)
@@ -68,13 +106,16 @@ public override void ExitFunctionStmt(VBAParser.FunctionStmtContext context)
                 _attributes.Add(_currentScope, _currentScopeAttributes);
                 context.AddAttributes(_currentScopeAttributes);
             }
+
+            ResetScope();
         }
 
         public override void EnterPropertyGetStmt(VBAParser.PropertyGetStmtContext context)
         {
             _currentScopeAttributes = new Attributes();
             _currentScope = (Identifier.GetName(context.functionName()), DeclarationType.PropertyGet);
             _currentAnnotatedContext = context;
+            _membersAllowingAttributes[_currentScope] = context;
         }
 
         public override void ExitPropertyGetStmt(VBAParser.PropertyGetStmtContext context)
@@ -84,13 +125,16 @@ public override void ExitPropertyGetStmt(VBAParser.PropertyGetStmtContext contex
                 _attributes.Add(_currentScope, _currentScopeAttributes);
                 context.AddAttributes(_currentScopeAttributes);
             }
+
+            ResetScope();
         }
 
         public override void EnterPropertyLetStmt(VBAParser.PropertyLetStmtContext context)
         {
             _currentScopeAttributes = new Attributes();
             _currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.PropertyLet);
             _currentAnnotatedContext = context;
+            _membersAllowingAttributes[_currentScope] = context;
         }
 
         public override void ExitPropertyLetStmt(VBAParser.PropertyLetStmtContext context)
@@ -100,13 +144,16 @@ public override void ExitPropertyLetStmt(VBAParser.PropertyLetStmtContext contex
                 _attributes.Add(_currentScope, _currentScopeAttributes);
                 context.AddAttributes(_currentScopeAttributes);
             }
+
+            ResetScope();
         }
 
         public override void EnterPropertySetStmt(VBAParser.PropertySetStmtContext context)
         {
             _currentScopeAttributes = new Attributes();
             _currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.PropertySet);
             _currentAnnotatedContext = context;
+            _membersAllowingAttributes[_currentScope] = context;
         }
 
         public override void ExitPropertySetStmt(VBAParser.PropertySetStmtContext context)
@@ -116,6 +163,8 @@ public override void ExitPropertySetStmt(VBAParser.PropertySetStmtContext contex
                 _attributes.Add(_currentScope, _currentScopeAttributes);
                 context.AddAttributes(_currentScopeAttributes);
             }
+
+            ResetScope();
         }
 
         public override void ExitAttributeStmt(VBAParser.AttributeStmtContext context)

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public override bool VisitModuleDeclarations(VBAParser.ModuleDeclarationsContext`
`87`	`87`
`88`	`88`	`public override bool VisitModuleDeclarationsElement(VBAParser.ModuleDeclarationsElementContext context)`
`89`	`89`	`{`
`90`		`- return context.variableStmt() == null`
	`90`	`+ return context.moduleVariableStmt() == null`
`91`	`91`	`&& context.constStmt() == null`
`92`	`92`	`&& context.enumerationStmt() == null`
`93`	`93`	`&& context.udtDeclaration() == null`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public void ClearContexts()`
`45`	`45`
`46`	`46`	`public override void ExitVariableStmt([NotNull] VBAParser.VariableStmtContext context)`
`47`	`47`	`{`
`48`		`- if (context.DIM() != null && context.Parent is VBAParser.ModuleDeclarationsElementContext)`
	`48`	`+ if (context.DIM() != null && context.TryGetAncestor<VBAParser.ModuleDeclarationsElementContext>(out _))`
`49`	`49`	`{`
`50`	`50`	`_contexts.Add(new QualifiedContext<ParserRuleContext>(CurrentModuleName, context));`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ private static RewriterInfo GetRewriterInfo(VBAParser.VariableSubStmtContext var`
`24`	`24`	`var itemIndex = items.ToList().IndexOf(variable);`
`25`	`25`	`var count = items.Length;`
`26`	`26`
`27`		`- if (context.Parent.Parent is VBAParser.ModuleDeclarationsElementContext element)`
	`27`	`+ if (context.TryGetAncestor<VBAParser.ModuleDeclarationsElementContext>(out var element))`
`28`	`28`	`{`
`29`	`29`	`return GetModuleVariableRemovalInfo(variable, element, count, itemIndex, items);`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,12 @@ public static string GetName(VBAParser.VariableSubStmtContext context, out Inter`
`35`	`35`	`return GetName(nameContext, out tokenInterval);`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ public static string GetName(VBAParser.VariableSubStmtContext context)`
	`39`	`+ {`
	`40`	`+ var nameContext = context.identifier();`
	`41`	`+ return GetName(nameContext);`
	`42`	`+ }`
	`43`	`+`
`38`	`44`	`public static string GetName(VBAParser.ConstSubStmtContext context, out Interval tokenInterval)`
`39`	`45`	`{`
`40`	`46`	`var nameContext = context.identifier();`
Original file line number	Diff line number	Diff line change
`@@ -11,18 +11,23 @@ public class AttributeListener : VBAParserBaseListener`
`11`	`11`	`{`
`12`	`12`	`private readonly Dictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes> _attributes`
`13`	`13`	`= new Dictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes>();`
	`14`	`+ private readonly Dictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext> _membersAllowingAttributes`
	`15`	`+ = new Dictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext>();`
`14`	`16`
`15`		`- private IAnnotatedContext _currentAnnotatedContext;`
	`17`	`+ private readonly (string scopeIdentifier, DeclarationType scopeType) _initialScope;`
`16`	`18`	`private (string scopeIdentifier, DeclarationType scopeType) _currentScope;`
	`19`	`+ private IAnnotatedContext _currentAnnotatedContext;`
`17`	`20`	`private Attributes _currentScopeAttributes;`
`18`	`21`
`19`	`22`	`public AttributeListener((string scopeIdentifier, DeclarationType scopeType) initialScope)`
`20`	`23`	`{`
	`24`	`+ _initialScope = initialScope;`
`21`	`25`	`_currentScope = initialScope;`
`22`	`26`	`_currentScopeAttributes = new Attributes();`
`23`	`27`	`}`
`24`	`28`
`25`	`29`	`public IDictionary<(string scopeIdentifier, DeclarationType scopeType), Attributes> Attributes => _attributes;`
	`30`	`+ public IDictionary<(string scopeIdentifier, DeclarationType scopeType), ParserRuleContext> MembersAllowingAttributes => _membersAllowingAttributes;`
`26`	`31`
`27`	`32`	`public override void ExitAnnotation(VBAParser.AnnotationContext context)`
`28`	`33`	`{`
`@@ -38,11 +43,41 @@ public override void ExitModuleAttributes(VBAParser.ModuleAttributesContext cont`
`38`	`43`	`}`
`39`	`44`	`}`
`40`	`45`
	`46`	`+ public override void EnterModuleVariableStmt(VBAParser.ModuleVariableStmtContext context)`
	`47`	`+ {`
	`48`	`+ _currentScopeAttributes = new Attributes();`
	`49`	`+ var annotatedContext = context.variableStmt().variableListStmt().variableSubStmt().Last();`
	`50`	`+ _currentScope = (Identifier.GetName(annotatedContext), DeclarationType.Variable);`
	`51`	`+ _currentAnnotatedContext = annotatedContext;`
	`52`	`+ _membersAllowingAttributes[_currentScope] = context;`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ public override void ExitModuleVariableStmt(VBAParser.ModuleVariableStmtContext context)`
	`56`	`+ {`
	`57`	`+ if (_currentScopeAttributes.Any())`
	`58`	`+ {`
	`59`	`+ _attributes.Add(_currentScope, _currentScopeAttributes);`
	`60`	`+ var annotatedContext = context.variableStmt().variableListStmt().variableSubStmt().Last();`
	`61`	`+ annotatedContext.AddAttributes(_currentScopeAttributes);`
	`62`	`+ }`
	`63`	`+`
	`64`	`+ ResetScope();`
	`65`	`+ }`
	`66`	`+`
	`67`	`+ private void ResetScope()`
	`68`	`+ {`
	`69`	`+ _currentScope = _initialScope;`
	`70`	`+ _currentScopeAttributes = _attributes.TryGetValue(_currentScope, out var attributes)`
	`71`	`+ ? attributes`
	`72`	`+ : new Attributes();`
	`73`	`+ }`
	`74`	`+`
`41`	`75`	`public override void EnterSubStmt(VBAParser.SubStmtContext context)`
`42`	`76`	`{`
`43`	`77`	`_currentScopeAttributes = new Attributes();`
`44`	`78`	`_currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.Procedure);`
`45`	`79`	`_currentAnnotatedContext = context;`
	`80`	`+ _membersAllowingAttributes[_currentScope] = context;`
`46`	`81`	`}`
`47`	`82`
`48`	`83`	`public override void ExitSubStmt(VBAParser.SubStmtContext context)`
`@@ -52,13 +87,16 @@ public override void ExitSubStmt(VBAParser.SubStmtContext context)`
`52`	`87`	`_attributes.Add(_currentScope, _currentScopeAttributes);`
`53`	`88`	`context.AddAttributes(_currentScopeAttributes);`
`54`	`89`	`}`
	`90`	`+`
	`91`	`+ ResetScope();`
`55`	`92`	`}`
`56`	`93`
`57`	`94`	`public override void EnterFunctionStmt(VBAParser.FunctionStmtContext context)`
`58`	`95`	`{`
`59`	`96`	`_currentScopeAttributes = new Attributes();`
`60`	`97`	`_currentScope = (Identifier.GetName(context.functionName()), DeclarationType.Function);`
`61`	`98`	`_currentAnnotatedContext = context;`
	`99`	`+ _membersAllowingAttributes[_currentScope] = context;`
`62`	`100`	`}`
`63`	`101`
`64`	`102`	`public override void ExitFunctionStmt(VBAParser.FunctionStmtContext context)`
`@@ -68,13 +106,16 @@ public override void ExitFunctionStmt(VBAParser.FunctionStmtContext context)`
`68`	`106`	`_attributes.Add(_currentScope, _currentScopeAttributes);`
`69`	`107`	`context.AddAttributes(_currentScopeAttributes);`
`70`	`108`	`}`
	`109`	`+`
	`110`	`+ ResetScope();`
`71`	`111`	`}`
`72`	`112`
`73`	`113`	`public override void EnterPropertyGetStmt(VBAParser.PropertyGetStmtContext context)`
`74`	`114`	`{`
`75`	`115`	`_currentScopeAttributes = new Attributes();`
`76`	`116`	`_currentScope = (Identifier.GetName(context.functionName()), DeclarationType.PropertyGet);`
`77`	`117`	`_currentAnnotatedContext = context;`
	`118`	`+ _membersAllowingAttributes[_currentScope] = context;`
`78`	`119`	`}`
`79`	`120`
`80`	`121`	`public override void ExitPropertyGetStmt(VBAParser.PropertyGetStmtContext context)`
`@@ -84,13 +125,16 @@ public override void ExitPropertyGetStmt(VBAParser.PropertyGetStmtContext contex`
`84`	`125`	`_attributes.Add(_currentScope, _currentScopeAttributes);`
`85`	`126`	`context.AddAttributes(_currentScopeAttributes);`
`86`	`127`	`}`
	`128`	`+`
	`129`	`+ ResetScope();`
`87`	`130`	`}`
`88`	`131`
`89`	`132`	`public override void EnterPropertyLetStmt(VBAParser.PropertyLetStmtContext context)`
`90`	`133`	`{`
`91`	`134`	`_currentScopeAttributes = new Attributes();`
`92`	`135`	`_currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.PropertyLet);`
`93`	`136`	`_currentAnnotatedContext = context;`
	`137`	`+ _membersAllowingAttributes[_currentScope] = context;`
`94`	`138`	`}`
`95`	`139`
`96`	`140`	`public override void ExitPropertyLetStmt(VBAParser.PropertyLetStmtContext context)`
`@@ -100,13 +144,16 @@ public override void ExitPropertyLetStmt(VBAParser.PropertyLetStmtContext contex`
`100`	`144`	`_attributes.Add(_currentScope, _currentScopeAttributes);`
`101`	`145`	`context.AddAttributes(_currentScopeAttributes);`
`102`	`146`	`}`
	`147`	`+`
	`148`	`+ ResetScope();`
`103`	`149`	`}`
`104`	`150`
`105`	`151`	`public override void EnterPropertySetStmt(VBAParser.PropertySetStmtContext context)`
`106`	`152`	`{`
`107`	`153`	`_currentScopeAttributes = new Attributes();`
`108`	`154`	`_currentScope = (Identifier.GetName(context.subroutineName()), DeclarationType.PropertySet);`
`109`	`155`	`_currentAnnotatedContext = context;`
	`156`	`+ _membersAllowingAttributes[_currentScope] = context;`
`110`	`157`	`}`
`111`	`158`
`112`	`159`	`public override void ExitPropertySetStmt(VBAParser.PropertySetStmtContext context)`
`@@ -116,6 +163,8 @@ public override void ExitPropertySetStmt(VBAParser.PropertySetStmtContext contex`
`116`	`163`	`_attributes.Add(_currentScope, _currentScopeAttributes);`
`117`	`164`	`context.AddAttributes(_currentScopeAttributes);`
`118`	`165`	`}`
	`166`	`+`
	`167`	`+ ResetScope();`
`119`	`168`	`}`
`120`	`169`
`121`	`170`	`public override void ExitAttributeStmt(VBAParser.AttributeStmtContext context)`