Line Numbers

Rubberduck.Inspections/Concrete/EmptyIfBlockInspection.cs

@@ -78,11 +78,19 @@ private bool ContainsExecutableStatements(VBAParser.BlockContext block)
                 {
                     if (child is VBAParser.BlockStmtContext)
                     {
-                        Debug.Assert(child.ChildCount == 1);
+                        var blockStmt = (VBAParser.BlockStmtContext)child;
+                        var mainBlockStmt = blockStmt.mainBlockStmt();
+
+                        if(mainBlockStmt == null)
+                        {
+                            continue;   //We have a lone line lable, which is not executable.
+                        }
+
+                        Debug.Assert(mainBlockStmt.ChildCount == 1);
 
                         // exclude variables and consts because they are not executable statements
-                        if (child.GetChild(0) is VBAParser.VariableStmtContext ||
-                            child.GetChild(0) is VBAParser.ConstStmtContext)
+                        if (mainBlockStmt.GetChild(0) is VBAParser.VariableStmtContext ||
+                            mainBlockStmt.GetChild(0) is VBAParser.ConstStmtContext)
                         {
                             continue;
                         }

Rubberduck.Inspections/QuickFixes/RemoveEmptyIfBlockQuickFix.cs

@@ -38,7 +38,7 @@ private void UpdateContext(VBAParser.IfStmtContext context, IModuleRewriter rewr
 
             if (BlockHasDeclaration(context.block()))
             {
-                rewriter.InsertBefore(context.Start.TokenIndex, context.block().GetText());
+                rewriter.InsertBefore(context.Start.TokenIndex, AdjustedBlockText(context.block()));
             }
 
             if (elseIfBlock != null)
@@ -86,7 +86,7 @@ private void UpdateContext(VBAParser.ElseIfBlockContext context, IModuleRewriter
         {
             if (BlockHasDeclaration(context.block()))
             {
-                rewriter.InsertBefore(((VBAParser.IfStmtContext)context.Parent).Start.TokenIndex, context.block().GetText());
+                rewriter.InsertBefore(((VBAParser.IfStmtContext)context.Parent).Start.TokenIndex, AdjustedBlockText(context.block()));
             }
 
             rewriter.Remove(context);
@@ -159,8 +159,22 @@ private void UpdateCondition(ParserRuleContext condition, IModuleRewriter rewrit
             }
         }
 
+        private string AdjustedBlockText(VBAParser.BlockContext blockContext)
+        {
+            var blockText = blockContext.GetText();
+            if (FirstBlockStmntHasLabel(blockContext))
+            {
+                blockText = Environment.NewLine + blockText;
+            }
+
+            return blockText;
+        }
+
         private bool BlockHasDeclaration(VBAParser.BlockContext block)
-            => block.children?.Any(s => s is VBAParser.BlockStmtContext) ?? false;
+            => block.blockStmt()?.Any() ?? false;
+
+        private bool FirstBlockStmntHasLabel(VBAParser.BlockContext block)
+            => block.blockStmt()?.FirstOrDefault()?.statementLabelDefinition() != null;
 
         public string Description(IInspectionResult result)
         {

Rubberduck.Parsing/Grammar/VBALexer.g4

@@ -17,6 +17,7 @@
 
 lexer grammar VBALexer;
 
+
 ABS : A B S;
 ANY : A N Y;
 ARRAY : A R R A Y;

Rubberduck.Parsing/Grammar/VBAParser.g4

@@ -93,9 +93,13 @@ moduleBodyElement :
 
 block : (blockStmt endOfStatement)*;
 
-blockStmt :
-    statementLabelDefinition
-    | fileStmt
+blockStmt : 
+    statementLabelDefinition whiteSpace? mainBlockStmt?
+    | mainBlockStmt 
+;
+
+mainBlockStmt :
+    fileStmt
     | attributeStmt
     | constStmt
     | doLoopStmt
@@ -558,9 +562,14 @@ complexType :
 
 fieldLength : MULT whiteSpace? (numberLiteral | identifierValue);
 
-statementLabelDefinition : identifierStatementLabel | lineNumberLabel;
-identifierStatementLabel : unrestrictedIdentifier whiteSpace? COLON;
-lineNumberLabel : numberLiteral whiteSpace? COLON?;
+//Statement labels can only appear at the start of a line.
+statementLabelDefinition : {_input.La(-1) == NEWLINE}? (combinedLabels | identifierStatementLabel | standaloneLineNumberLabel);
+identifierStatementLabel : unrestrictedIdentifier whiteSpace? COLON; 
+standaloneLineNumberLabel : 
+	lineNumberLabel whiteSpace? COLON
+	| lineNumberLabel;
+combinedLabels : lineNumberLabel whiteSpace identifierStatementLabel;
+lineNumberLabel : numberLiteral;
 
 numberLiteral : HEXLITERAL | OCTLITERAL | FLOATLITERAL | INTEGERLITERAL;
 

Rubberduck.Parsing/Grammar/VBAParserBaseListener.cs

@@ -1489,6 +1489,19 @@ public virtual void EnterAttributeName([NotNull] VBAParser.AttributeNameContext
 	/// <param name="context">The parse tree.</param>
 	public virtual void ExitAttributeName([NotNull] VBAParser.AttributeNameContext context) { }
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void EnterMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context) { }
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void ExitMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context) { }
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.implementsStmt"/>.
 	/// <para>The default implementation does nothing.</para>
@@ -2022,6 +2035,19 @@ public virtual void EnterIdentifier([NotNull] VBAParser.IdentifierContext contex
 	/// <param name="context">The parse tree.</param>
 	public virtual void ExitIdentifier([NotNull] VBAParser.IdentifierContext context) { }
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void EnterCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context) { }
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void ExitCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context) { }
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.attributeStmt"/>.
 	/// <para>The default implementation does nothing.</para>
@@ -2763,6 +2789,19 @@ public virtual void EnterComparisonOperator([NotNull] VBAParser.ComparisonOperat
 	/// <param name="context">The parse tree.</param>
 	public virtual void ExitComparisonOperator([NotNull] VBAParser.ComparisonOperatorContext context) { }
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void EnterStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context) { }
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// <para>The default implementation does nothing.</para>
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	public virtual void ExitStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context) { }
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.startRecordNumber"/>.
 	/// <para>The default implementation does nothing.</para>

Rubberduck.Parsing/Grammar/VBAParserBaseVisitor.cs

@@ -1264,6 +1264,17 @@ public partial class VBAParserBaseVisitor<Result> : AbstractParseTreeVisitor<Res
 	/// <return>The visitor result.</return>
 	public virtual Result VisitAttributeName([NotNull] VBAParser.AttributeNameContext context) { return VisitChildren(context); }
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// <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 VisitMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context) { return VisitChildren(context); }
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.implementsStmt"/>.
 	/// <para>
@@ -1715,6 +1726,17 @@ public partial class VBAParserBaseVisitor<Result> : AbstractParseTreeVisitor<Res
 	/// <return>The visitor result.</return>
 	public virtual Result VisitIdentifier([NotNull] VBAParser.IdentifierContext context) { return VisitChildren(context); }
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// <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 VisitCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context) { return VisitChildren(context); }
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.attributeStmt"/>.
 	/// <para>
@@ -2342,6 +2364,17 @@ public partial class VBAParserBaseVisitor<Result> : AbstractParseTreeVisitor<Res
 	/// <return>The visitor result.</return>
 	public virtual Result VisitComparisonOperator([NotNull] VBAParser.ComparisonOperatorContext context) { return VisitChildren(context); }
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// <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 VisitStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context) { return VisitChildren(context); }
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.startRecordNumber"/>.
 	/// <para>

Rubberduck.Parsing/Grammar/VBAParserListener.cs

@@ -1305,6 +1305,17 @@ public interface IVBAParserListener : IParseTreeListener {
 	/// <param name="context">The parse tree.</param>
 	void ExitAttributeName([NotNull] VBAParser.AttributeNameContext context);
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void EnterMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context);
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void ExitMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context);
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.implementsStmt"/>.
 	/// </summary>
@@ -1762,6 +1773,17 @@ public interface IVBAParserListener : IParseTreeListener {
 	/// <param name="context">The parse tree.</param>
 	void ExitIdentifier([NotNull] VBAParser.IdentifierContext context);
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void EnterCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context);
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void ExitCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context);
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.attributeStmt"/>.
 	/// </summary>
@@ -2405,6 +2427,17 @@ public interface IVBAParserListener : IParseTreeListener {
 	/// <param name="context">The parse tree.</param>
 	void ExitComparisonOperator([NotNull] VBAParser.ComparisonOperatorContext context);
 
+	/// <summary>
+	/// Enter a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void EnterStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context);
+	/// <summary>
+	/// Exit a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	void ExitStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context);
+
 	/// <summary>
 	/// Enter a parse tree produced by <see cref="VBAParser.startRecordNumber"/>.
 	/// </summary>

Rubberduck.Parsing/Grammar/VBAParserVisitor.cs

@@ -836,6 +836,13 @@ public interface IVBAParserVisitor<Result> : IParseTreeVisitor<Result> {
 	/// <return>The visitor result.</return>
 	Result VisitAttributeName([NotNull] VBAParser.AttributeNameContext context);
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.mainBlockStmt"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	/// <return>The visitor result.</return>
+	Result VisitMainBlockStmt([NotNull] VBAParser.MainBlockStmtContext context);
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.implementsStmt"/>.
 	/// </summary>
@@ -1126,6 +1133,13 @@ public interface IVBAParserVisitor<Result> : IParseTreeVisitor<Result> {
 	/// <return>The visitor result.</return>
 	Result VisitIdentifier([NotNull] VBAParser.IdentifierContext context);
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.combinedLabels"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	/// <return>The visitor result.</return>
+	Result VisitCombinedLabels([NotNull] VBAParser.CombinedLabelsContext context);
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.attributeStmt"/>.
 	/// </summary>
@@ -1533,6 +1547,13 @@ public interface IVBAParserVisitor<Result> : IParseTreeVisitor<Result> {
 	/// <return>The visitor result.</return>
 	Result VisitComparisonOperator([NotNull] VBAParser.ComparisonOperatorContext context);
 
+	/// <summary>
+	/// Visit a parse tree produced by <see cref="VBAParser.standaloneLineNumberLabel"/>.
+	/// </summary>
+	/// <param name="context">The parse tree.</param>
+	/// <return>The visitor result.</return>
+	Result VisitStandaloneLineNumberLabel([NotNull] VBAParser.StandaloneLineNumberLabelContext context);
+
 	/// <summary>
 	/// Visit a parse tree produced by <see cref="VBAParser.startRecordNumber"/>.
 	/// </summary>

Rubberduck.Parsing/PostProcessing/RewriterInfo/ConstantRewriterInfoFinder.cs

@@ -53,14 +53,15 @@ private static RewriterInfo GetLocalConstantRemovalInfo(VBAParser.ConstSubStmtCo
             VBAParser.ConstStmtContext constants,
             int count, int itemIndex, IReadOnlyList<VBAParser.ConstSubStmtContext> items)
         {
-            var blockStmt = (VBAParser.BlockStmtContext)constants.Parent;
-            var startIndex = blockStmt.Start.TokenIndex;
-            var parent = (VBAParser.BlockContext)blockStmt.Parent;
-            var statements = parent.blockStmt();
+            var mainBlockStmt = (VBAParser.MainBlockStmtContext)constants.Parent;
+            var startIndex = mainBlockStmt.Start.TokenIndex;
+            var blockStmt = (VBAParser.BlockStmtContext)mainBlockStmt.Parent;
+            var block = (VBAParser.BlockContext)blockStmt.Parent;
+            var statements = block.blockStmt();
 
             if (count == 1)
             {
-                var stopIndex = FindStopTokenIndex(statements, blockStmt, parent);
+                var stopIndex = FindStopTokenIndex(statements, mainBlockStmt, block);
                 return new RewriterInfo(startIndex, stopIndex);
             }
             return GetRewriterInfoForTargetRemovedFromListStmt(target.Start, itemIndex, items);

Rubberduck.Parsing/PostProcessing/RewriterInfo/RewriterInfoFinderBase.cs

@@ -35,6 +35,24 @@ protected static int FindStopTokenIndex<TParent>(IReadOnlyList<ParserRuleContext
             return item.Stop.TokenIndex;
         }
 
+        protected static int FindStopTokenIndex(IReadOnlyList<VBAParser.BlockStmtContext> blockStmts, VBAParser.MainBlockStmtContext mainBlockStmt, VBAParser.BlockContext block)
+        {
+            for (var i = 0; i < blockStmts.Count; i++)
+            {
+                if (blockStmts[i].mainBlockStmt() != mainBlockStmt)
+                {
+                    continue;
+                }
+                if (blockStmts[i].statementLabelDefinition() != null)
+                {
+                    return mainBlockStmt.Stop.TokenIndex;   //Removing the following endOfStatement if there is a label on the line would break the code. 
+                }
+                return FindStopTokenIndex(block, i);
+            }
+
+            return mainBlockStmt.Stop.TokenIndex;
+        }
+
         private static int FindStopTokenIndex(VBAParser.BlockContext context, int index)
         {
             return context.endOfStatement(index).Stop.TokenIndex;

Rubberduck.Parsing/PostProcessing/RewriterInfo/VariableRewriterInfoFinder.cs

@@ -58,14 +58,15 @@ private static RewriterInfo GetLocalVariableRemovalInfo(VBAParser.VariableSubStm
             VBAParser.VariableListStmtContext variables,
             int count, int itemIndex, IReadOnlyList<VBAParser.VariableSubStmtContext> items)
         {
-            var blockStmt = (VBAParser.BlockStmtContext)variables.Parent.Parent;
-            var startIndex = blockStmt.Start.TokenIndex;
-            var parent = (VBAParser.BlockContext)blockStmt.Parent;
-            var statements = parent.blockStmt();
+            var mainBlockStmt = (VBAParser.MainBlockStmtContext)variables.Parent.Parent;
+            var startIndex = mainBlockStmt.Start.TokenIndex;
+            var blockStmt = (VBAParser.BlockStmtContext)mainBlockStmt.Parent;
+            var block = (VBAParser.BlockContext)blockStmt.Parent;
+            var statements = block.blockStmt();
 
             if (count == 1)
             {
-                var stopIndex = FindStopTokenIndex(statements, blockStmt, parent);
+                var stopIndex = FindStopTokenIndex(statements, blockStmt, block);
                 return new RewriterInfo(startIndex, stopIndex);
             }
             return GetRewriterInfoForTargetRemovedFromListStmt(target.Start, itemIndex, items);