Split tokens extension into their own class

Fix bugs w/ GetSelection() extension in the ParserRuleContextExtensions.cs
Add Contains() and IsContainedIn() extensions
Update the tests to cover both ways to check selections

Author: bclothier

Rubberduck.Parsing/ParserRuleContextExtensions.cs

@@ -13,14 +13,15 @@ public static Selection GetSelection(this ParserRuleContext context)
             // if we have an empty module, `Stop` is null
             if (context?.Stop == null) { return Selection.Home; }
 
-            // ANTLR indexes are 0-based, but VBE's are 1-based.
+            // ANTLR indexes for columns are 0-based, but VBE's are 1-based.
+            // ANTLR lines and VBE's lines are both 1-based
             // 1 is the default value that will select all lines. Replace zeroes with ones.
             // See also: https://msdn.microsoft.com/en-us/library/aa443952(v=vs.60).aspx
 
             return new Selection(context.Start.Line == 0 ? 1 : context.Start.Line,
                                  context.Start.Column + 1,
-                                 context.Stop.Line == 0 ? 1 : context.Stop.Line,
-                                 context.Stop.Column + context.Stop.Text.Length + 1);
+                                 context.Stop.Line == 0 ? 1 : context.Stop.EndLine(),
+                                 context.Stop.EndColumn() + 1);
         }
 
         //This set of overloads returns the selection for the entire procedure statement body, i.e. Public Function Foo(bar As String) As String

Rubberduck.Parsing/Rubberduck.Parsing.csproj

@@ -349,6 +349,7 @@
     <Compile Include="Symbols\ConstantDeclaration.cs" />
     <Compile Include="ComReflection\XmlPersistableDeclarations.cs" />
     <Compile Include="Symbols\UnboundMemberDeclaration.cs" />
+    <Compile Include="TokenExtensions.cs" />
     <Compile Include="VBA\AttributeListener.cs" />
     <Compile Include="VBA\AttributeParser.cs" />
     <Compile Include="VBA\Attributes.cs" />

Rubberduck.Parsing/SelectionExtensions.cs

@@ -32,7 +32,7 @@ public static bool Contains(this Selection selection, IToken token)
         /// <param name="context">A context which contains several tokens within a module's parse tree</param>
         /// <param name="selection">One-based selection, usually from CodePane.Selection</param>
         /// <returns>Boolean with true indicating that context is within the selection</returns>
-        public static bool Contains(this ParserRuleContext context, Selection selection)
+        public static bool Contains(this Selection selection, ParserRuleContext context)
         {
             return
                (((selection.StartLine == context.Start.Line) && (selection.StartColumn - 1) <= context.Start.Column) 
@@ -42,45 +42,14 @@ public static bool Contains(this ParserRuleContext context, Selection selection)
         }
 
         /// <summary>
-        /// Obtain the actual last column the token occupies. Because a token can be spread 
-        /// across multiple lines with line continuations it is necessary to do some work 
-        /// to determine the token's actual ending column.
-        /// Whitespace and newline should be preserved within the token.
+        /// Convenience method for validating that a selection is inside a specified parser rule context.
         /// </summary>
-        /// <param name="token">The last token within a given context to test</param>
-        /// <returns>Zero-based column position</returns>
-        public static int EndColumn(this IToken token)
+        /// <param name="selection">The selection that should be contained within the ParserRuleContext</param>
+        /// <param name="context">The containing ParserRuleContext</param>
+        /// <returns>Boolean with true indicating that the selection is inside the given context</returns>
+        public static bool IsContainedIn(this Selection selection, ParserRuleContext context)
         {
-            if (token.Text.Contains(Environment.NewLine))
-            {
-                var splitStrings = token.Text.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
-                var lastOccupiedLine = splitStrings[splitStrings.Length - 1];
-
-                return lastOccupiedLine.Length;
-            }
-            else
-            {
-                return token.Column + token.Text.Length;
-            }
-        }
-
-        /// <summary>
-        /// Obtain the actual last line token occupies. Typically it is same as token.Line but 
-        /// when it contains line continuation and is spread across lines, extra newlines are
-        /// counted and added.
-        /// </summary>
-        /// <param name="token"></param>
-        /// <returns>One-based line position</returns>
-        public static int EndLine(this IToken token)
-        {
-            if(token.Text.Contains(Environment.NewLine))
-            {
-                var splitStrings = token.Text.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
-
-                return token.Line + (splitStrings.Length - 1);
-            }
-
-            return token.Line;
+            return context.GetSelection().Contains(selection);
         }
     }
 }

Rubberduck.Parsing/TokenExtensions.cs

@@ -0,0 +1,50 @@
+using System;
+using Antlr4.Runtime;
+
+namespace Rubberduck.Parsing
+{
+    public static class TokenExtensions
+    {
+        /// <summary>
+        /// Obtain the actual last column the token occupies. Because a token can be spread 
+        /// across multiple lines with line continuations it is necessary to do some work 
+        /// to determine the token's actual ending column.
+        /// Whitespace and newline should be preserved within the token.
+        /// </summary>
+        /// <param name="token">The last token within a given context to test</param>
+        /// <returns>Zero-based column position</returns>
+        public static int EndColumn(this IToken token)
+        {
+            if (token.Text.Contains(Environment.NewLine))
+            {
+                var splitStrings = token.Text.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
+                var lastOccupiedLine = splitStrings[splitStrings.Length - 1];
+
+                return lastOccupiedLine.Length;
+            }
+            else
+            {
+                return token.Column + token.Text.Length;
+            }
+        }
+
+        /// <summary>
+        /// Obtain the actual last line token occupies. Typically it is same as token.Line but 
+        /// when it contains line continuation and is spread across lines, extra newlines are
+        /// counted and added.
+        /// </summary>
+        /// <param name="token"></param>
+        /// <returns>One-based line position</returns>
+        public static int EndLine(this IToken token)
+        {
+            if (token.Text.Contains(Environment.NewLine))
+            {
+                var splitStrings = token.Text.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
+
+                return token.Line + (splitStrings.Length - 1);
+            }
+
+            return token.Line;
+        }
+    }
+}

RubberduckTests/Grammar/SelectionExtensionsTests.cs

@@ -64,7 +64,8 @@ End _
             var context = visitor.Visit(tree).First();
             var selection = new Selection(3, 0, 10, 5);
 
-            Assert.IsFalse(context.Contains(selection));
+            Assert.IsFalse(selection.Contains(context));
+            Assert.IsFalse(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -92,7 +93,8 @@ End _
             var context = visitor.Visit(tree).First();
             var selection = new Selection(4, 1, 11, 8);
 
-            Assert.IsTrue(context.Contains(selection));
+            Assert.IsTrue(selection.Contains(context));
+            Assert.IsFalse(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -120,7 +122,8 @@ End _
             var context = visitor.Visit(tree).First();
             var selection = new Selection(5, 1, 11, 8);
 
-            Assert.IsFalse(context.Contains(selection));
+            Assert.IsFalse(selection.Contains(context));
+            Assert.IsFalse(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -148,7 +151,8 @@ End _
             var context = visitor.Visit(tree).First();
             var selection = new Selection(4, 1, 10, 8);
 
-            Assert.IsFalse(context.Contains(selection));
+            Assert.IsFalse(selection.Contains(context));
+            Assert.IsTrue(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -175,9 +179,11 @@ End _
             var tree = state.GetParseTree(new QualifiedModuleName(component));
             var visitor = new SubStmtContextElementCollectorVisitor();
             var context = visitor.Visit(tree).First();
-            pane.Selection = new Selection(4, 1, 11, 8);
+            pane.Selection = new Selection(4, 1, 11, 6);
 
-            Assert.IsTrue(context.Contains(pane.Selection));
+            Assert.IsTrue(context.GetSelection().Contains(pane.Selection));
+            Assert.IsTrue(pane.Selection.IsContainedIn(context));
+            Assert.IsTrue(pane.Selection.Contains(context));
         }
 
         [TestMethod]
@@ -203,7 +209,9 @@ Public Sub foo()
             var context = visitor.Visit(tree).First();
             pane.Selection = new Selection(3, 0, 7, 7);
 
-            Assert.IsFalse(context.Contains(pane.Selection));
+            Assert.IsFalse(context.GetSelection().Contains(pane.Selection));
+            Assert.IsFalse(pane.Selection.IsContainedIn(context));
+            Assert.IsFalse(pane.Selection.Contains(context));
         }
 
         [TestMethod]
@@ -229,7 +237,9 @@ Public Sub foo()
             var context = visitor.Visit(tree).First();
             pane.Selection = new Selection(4, 1, 8, 8);
 
-            Assert.IsTrue(context.Contains(pane.Selection));
+            Assert.IsTrue(context.GetSelection().Contains(pane.Selection));
+            Assert.IsTrue(pane.Selection.IsContainedIn(context));
+            Assert.IsTrue(pane.Selection.Contains(context));
         }
 
         [TestMethod]
@@ -255,13 +265,14 @@ Public Sub foo()
             var context = visitor.Visit(tree).First();
             var selection = new Selection(4, 1, 8, 8);
 
-            Assert.IsTrue(context.Contains(selection));
+            Assert.IsTrue(selection.Contains(context));
+            Assert.IsTrue(selection.IsContainedIn(context));
         }
 
         [TestMethod]
         [TestCategory("Grammar")]
         [TestCategory("Selection")]
-        public void Context_NotIn_Selection_StartTooSoon_OneBased()
+        public void Context_NotIn_Selection_StartTooLate_OneBased()
         {
             const string inputCode = @"
 Option Explicit
@@ -281,7 +292,8 @@ Public Sub foo()
             var context = visitor.Visit(tree).First();
             var selection = new Selection(4, 2, 8, 8);
 
-            Assert.IsFalse(context.Contains(selection));
+            Assert.IsFalse(selection.Contains(context));
+            Assert.IsTrue(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -307,7 +319,8 @@ Public Sub foo()
             var context = visitor.Visit(tree).First();
             var selection = new Selection(4, 1, 8, 7);
 
-            Assert.IsFalse(context.Contains(selection));
+            Assert.IsFalse(selection.Contains(context));
+            Assert.IsTrue(selection.IsContainedIn(context));
         }
 
         [TestMethod]
@@ -342,8 +355,8 @@ End If
             var contexts = visitor.Visit(tree);
             var selection = new Selection(6, 1, 10, 7);
 
-            Assert.IsTrue(contexts.ElementAt(0).Contains(selection));   // first If block
-            Assert.IsFalse(contexts.ElementAt(1).Contains(selection));  // second If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(0)));   // first If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(1)));  // second If block
         }
 
         [TestMethod]
@@ -379,8 +392,8 @@ End If
             var contexts = visitor.Visit(tree);
             var selection = new Selection(6, 1, 10, 7);
 
-            Assert.IsTrue(contexts.ElementAt(0).Contains(selection));   // first If block
-            Assert.IsFalse(contexts.ElementAt(1).Contains(selection));  // second If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(0)));   // first If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(1)));  // second If block
         }
 
         [TestMethod]
@@ -416,8 +429,8 @@ End If
             var contexts = visitor.Visit(tree);
             var selection = new Selection(12, 1, 16, 7);
 
-            Assert.IsFalse(contexts.ElementAt(0).Contains(selection));  // first If block
-            Assert.IsTrue(contexts.ElementAt(1).Contains(selection));   // second If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(0)));  // first If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(1)));   // second If block
         }
 
         [TestMethod]
@@ -455,8 +468,8 @@ End If
             var selection = new Selection(12, 1, 16, 7);
 
             Assert.IsTrue(selection.Contains(token));                   // last token in second If block
-            Assert.IsFalse(contexts.ElementAt(0).Contains(selection));  // first If block
-            Assert.IsTrue(contexts.ElementAt(1).Contains(selection));   // second If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(0)));  // first If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(1)));   // second If block
         }
 
         [TestMethod]
@@ -534,9 +547,9 @@ End If
             var selection = new Selection(8, 1, 10, 9);
 
             Assert.IsTrue(selection.Contains(token));                   // last token in innermost If block
-            Assert.IsTrue(contexts.ElementAt(0).Contains(selection));   // innermost If block
-            Assert.IsFalse(contexts.ElementAt(1).Contains(selection));  // first outer If block
-            Assert.IsFalse(contexts.ElementAt(2).Contains(selection));  // second outer If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(0)));   // innermost If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(1)));  // first outer If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(2)));  // second outer If block
         }
 
         [TestMethod]
@@ -577,9 +590,9 @@ End If
             var selection = new Selection(6, 1, 13, 7);
 
             Assert.IsTrue(selection.Contains(token));                   // last token in innermost If block
-            Assert.IsTrue(contexts.ElementAt(0).Contains(selection));   // innermost If block
-            Assert.IsTrue(contexts.ElementAt(1).Contains(selection));   // first outer If block
-            Assert.IsFalse(contexts.ElementAt(2).Contains(selection));  // second outer If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(0)));   // innermost If block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(1)));   // first outer If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(2)));  // second outer If block
         }
 
         [TestMethod]
@@ -620,9 +633,9 @@ End If
             var selection = new Selection(15, 1, 19, 7);
 
             Assert.IsFalse(selection.Contains(token));                  // last token in innermost If block
-            Assert.IsFalse(contexts.ElementAt(0).Contains(selection));  // innermost If block
-            Assert.IsFalse(contexts.ElementAt(1).Contains(selection));  // first outer if block
-            Assert.IsTrue(contexts.ElementAt(2).Contains(selection));   // second outer If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(0)));  // innermost If block
+            Assert.IsFalse(selection.Contains(contexts.ElementAt(1)));  // first outer if block
+            Assert.IsTrue(selection.Contains(contexts.ElementAt(2)));   // second outer If block
         }
     }
 }