Merge pull request #1887 from Hosch250/Issue1873

Fix the line label rule(s) in the grammar.  Add tests.

Author: Hosch250

Rubberduck.Parsing/Grammar/VBAParser.cs

@@ -546,10 +546,9 @@ complexType :
 
 fieldLength : MULT whiteSpace? (numberLiteral | identifierValue);
 
-statementLabelDefinition : statementLabel whiteSpace? COLON;
-statementLabel : identifierStatementLabel | lineNumberLabel;
-identifierStatementLabel : unrestrictedIdentifier;
-lineNumberLabel : numberLiteral;
+statementLabelDefinition : identifierStatementLabel | lineNumberLabel;
+identifierStatementLabel : unrestrictedIdentifier whiteSpace? COLON;
+lineNumberLabel : numberLiteral whiteSpace? COLON?;
 
 numberLiteral : HEXLITERAL | OCTLITERAL | FLOATLITERAL | INTEGERLITERAL;
 

Rubberduck.Parsing/Grammar/VBAParser.g4

@@ -3140,19 +3140,6 @@ public virtual void EnterVariableListStmt([NotNull] VBAParser.VariableListStmtCo
 	/// <param name="context">The parse tree.</param>
 	public virtual void ExitVariableListStmt([NotNull] VBAParser.VariableListStmtContext context) { }
 
-	/// <summary>
-	/// Enter a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// <para>The default implementation does nothing.</para>
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	public virtual void EnterStatementLabel([NotNull] VBAParser.StatementLabelContext context) { }
-	/// <summary>
-	/// Exit a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// <para>The default implementation does nothing.</para>
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	public virtual void ExitStatementLabel([NotNull] VBAParser.StatementLabelContext context) { }
-
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.addOp"/>.
 	/// <para>The default implementation does nothing.</para>

Rubberduck.Parsing/Grammar/VBAParserBaseListener.cs

@@ -2661,17 +2661,6 @@ public partial class VBAParserBaseVisitor<Result> : AbstractParseTreeVisitor<Res
 	/// <return>The visitor result.</return>
 	public virtual Result VisitVariableListStmt([NotNull] VBAParser.VariableListStmtContext context) { return VisitChildren(context); }
 
-	/// <summary>
-	/// Visit a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// <para>
-	/// The default implementation returns the result of calling <see cref="AbstractParseTreeVisitor{Result}.VisitChildren(IRuleNode)"/>
-	/// on <paramref name="context"/>.
-	/// </para>
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	/// <return>The visitor result.</return>
-	public virtual Result VisitStatementLabel([NotNull] VBAParser.StatementLabelContext context) { return VisitChildren(context); }
-
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.addOp"/>.
 	/// <para>

Rubberduck.Parsing/Grammar/VBAParserBaseVisitor.cs

@@ -2736,17 +2736,6 @@ public interface IVBAParserListener : IParseTreeListener {
 	/// <param name="context">The parse tree.</param>
 	void ExitVariableListStmt([NotNull] VBAParser.VariableListStmtContext context);
 
-	/// <summary>
-	/// Enter a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	void EnterStatementLabel([NotNull] VBAParser.StatementLabelContext context);
-	/// <summary>
-	/// Exit a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	void ExitStatementLabel([NotNull] VBAParser.StatementLabelContext context);
-
 	/// <summary>
 	/// Enter a parse tree produced by the <c>addOp</c>
 	/// labeled alternative in <see cref="VBAParser.expression"/>.

Rubberduck.Parsing/Grammar/VBAParserListener.cs

@@ -1742,13 +1742,6 @@ public interface IVBAParserVisitor<Result> : IParseTreeVisitor<Result> {
 	/// <return>The visitor result.</return>
 	Result VisitVariableListStmt([NotNull] VBAParser.VariableListStmtContext context);
 
-	/// <summary>
-	/// Visit a parse tree produced by <see cref="VBAParser.statementLabel"/>.
-	/// </summary>
-	/// <param name="context">The parse tree.</param>
-	/// <return>The visitor result.</return>
-	Result VisitStatementLabel([NotNull] VBAParser.StatementLabelContext context);
-
 	/// <summary>
 	/// Visit a parse tree produced by the <c>addOp</c>
 	/// labeled alternative in <see cref="VBAParser.expression"/>.

Rubberduck.Parsing/Grammar/VBAParserVisitor.cs

@@ -699,14 +699,22 @@ public override void EnterArgList(VBAParser.ArgListContext context)
 
         public override void EnterStatementLabelDefinition(VBAParser.StatementLabelDefinitionContext context)
         {
+            var statementText = context.identifierStatementLabel() != null
+                ? context.identifierStatementLabel().unrestrictedIdentifier().GetText()
+                : context.lineNumberLabel().numberLiteral().GetText();
+
+            var statementSelection = context.identifierStatementLabel() != null
+                ? context.identifierStatementLabel().unrestrictedIdentifier().GetSelection()
+                : context.lineNumberLabel().numberLiteral().GetSelection();
+
             AddDeclaration(
                 CreateDeclaration(
-                    context.statementLabel().GetText(),
+                    statementText,
                     null,
                     Accessibility.Private,
                     DeclarationType.LineLabel,
                     context,
-                    context.statementLabel().GetSelection(),
+                    statementSelection,
                     true,
                     null,
                     null));

Rubberduck.Parsing/Symbols/DeclarationSymbolsListener.cs

@@ -245,7 +245,7 @@ End Sub
         }
 
         [TestMethod]
-        public void SingleLineIfStatementLabel_IsReferenceToLabel()
+        public void SingleLineIfStatementLabel_IsReferenceToLabel_NumberLabelHasColon()
         {
             // arrange
             var code = @"
@@ -266,6 +266,54 @@ End Sub
             Assert.AreEqual("DoSomething", reference.ParentScoping.IdentifierName);
         }
 
+        [TestMethod]
+        public void SingleLineIfStatementLabel_IsReferenceToLabel_NumberLabelNoColon()
+        {
+            // arrange
+            var code = @"
+Public Sub DoSomething()
+    Dim fizz As Integer
+    fizz = 5
+    If fizz = 5 Then Exit Sub
+
+    If True Then 5
+5
+End Sub
+";
+            // act
+            var state = Resolve(code);
+
+            // assert
+            var declaration = state.AllUserDeclarations.Single(item =>
+                item.DeclarationType == DeclarationType.LineLabel && item.IdentifierName == "5");
+
+            var reference = declaration.References.SingleOrDefault();
+            Assert.IsNotNull(reference);
+            Assert.AreEqual("DoSomething", reference.ParentScoping.IdentifierName);
+        }
+
+        [TestMethod]
+        public void SingleLineIfStatementLabel_IsReferenceToLabel_IdentifierLabel()
+        {
+            // arrange
+            var code = @"
+Public Sub DoSomething()
+    If True Then GoTo foo
+foo:
+End Sub
+";
+            // act
+            var state = Resolve(code);
+
+            // assert
+            var declaration = state.AllUserDeclarations.Single(item =>
+                item.DeclarationType == DeclarationType.LineLabel && item.IdentifierName == "foo");
+
+            var reference = declaration.References.SingleOrDefault();
+            Assert.IsNotNull(reference);
+            Assert.AreEqual("DoSomething", reference.ParentScoping.IdentifierName);
+        }
+
         [TestMethod]
         public void ProjectUdtSameNameFirstProjectThenUdt_FirstReferenceIsToProject()
         {

RubberduckTests/Grammar/ResolverTests.cs

@@ -776,9 +776,10 @@ public void TestLineLabelStatement()
 Sub Test()
     a:
     10:
+    15
 End Sub";
             var parseResult = Parse(code);
-            AssertTree(parseResult.Item1, parseResult.Item2, "//statementLabelDefinition", matches => matches.Count == 2);
+            AssertTree(parseResult.Item1, parseResult.Item2, "//statementLabelDefinition", matches => matches.Count == 3);
         }
 
         [TestMethod]