Clean up position/range API on SyntaxProtocol

The position and range API on `SyntaxProtocol` was a little inconsistent and misleading. Clean it up so that we have `totalLength` (including trivia), `contentLength` (excluding trivia) and a matching pair for `byteRange`.

Author: ahoppen

Sources/SwiftIDEUtils/Syntax+Classifications.swift

@@ -21,7 +21,7 @@ public extension SyntaxProtocol {
   /// consecutive tokens would have the same classification then a single classified
   /// range is provided for all of them.
   var classifications: SyntaxClassifications {
-    let fullRange = ByteSourceRange(offset: 0, length: byteSize)
+    let fullRange = ByteSourceRange(offset: 0, length: totalLength.utf8Length)
     return SyntaxClassifications(_syntaxNode, in: fullRange)
   }
 

Sources/SwiftParser/IncrementalParseTransition.swift

@@ -20,7 +20,7 @@ extension Parser {
 
     let currentOffset = self.lexemes.offsetToStart(self.currentToken)
     if let node = parseLookup!.lookUp(currentOffset, kind: kind) {
-      self.lexemes.advance(by: node.byteSize, currentToken: &self.currentToken)
+      self.lexemes.advance(by: node.totalLength.utf8Length, currentToken: &self.currentToken)
       return node
     }
 

Sources/SwiftSyntax/SourceLocation.swift

@@ -192,7 +192,7 @@ public final class SourceLocationConverter {
     self.file = file
     self.source = tree.syntaxTextBytes
     (self.lines, endOfFile) = computeLines(tree: Syntax(tree))
-    precondition(tree.byteSize == endOfFile.utf8Offset)
+    precondition(tree.totalLength.utf8Length == endOfFile.utf8Offset)
 
     for directive in SourceLocationCollector.collectSourceLocations(in: tree) {
       let location = self.physicalLocation(for: directive.positionAfterSkippingLeadingTrivia)

Sources/SwiftSyntax/Syntax.swift

@@ -477,14 +477,9 @@ public extension SyntaxProtocol {
     return data.endPosition
   }
 
-  /// The textual byte length of this node including leading and trailing trivia.
-  var byteSize: Int {
-    return totalLength.utf8Length
-  }
-
-  /// The byte source range of this node including leading and trailing trivia.
-  var byteRange: ByteSourceRange {
-    return ByteSourceRange(offset: position.utf8Offset, length: byteSize)
+  /// The length of this node including all of its trivia.
+  var totalLength: SourceLength {
+    return raw.totalLength
   }
 
   /// The length this node takes up spelled out in the source, excluding its
@@ -493,12 +488,32 @@ public extension SyntaxProtocol {
     return raw.contentLength
   }
 
-  /// The length of this node including all of its trivia.
-  var totalLength: SourceLength {
-    return raw.totalLength
+  /// The byte source range of this node including leading and trailing trivia.
+  var totalByteRange: ByteSourceRange {
+    return ByteSourceRange(offset: position.utf8Offset, length: totalLength.utf8Length)
+  }
+
+  /// The byte source range of this node excluding leading and trailing trivia.
+  var contentByteRange: ByteSourceRange {
+    return ByteSourceRange(
+      offset: positionAfterSkippingLeadingTrivia.utf8Offset,
+      length: contentLength.utf8Length
+    )
+  }
+
+  @available(*, deprecated, renamed: "totalByteRange")
+  var byteRange: ByteSourceRange {
+    return ByteSourceRange(offset: position.utf8Offset, length: totalLength.utf8Length)
+  }
+
+  /// The textual byte length of this node including leading and trailing trivia.
+  @available(*, deprecated, message: "Use totalLength.utf8Length")
+  var byteSize: Int {
+    return totalLength.utf8Length
   }
 
   /// The textual byte length of this node exluding leading and trailing trivia.
+  @available(*, deprecated, message: "Use contentLength.utf8Length")
   var byteSizeAfterTrimmingTrivia: Int {
     return contentLength.utf8Length
   }

Sources/_SwiftSyntaxTestSupport/IncrementalParseTestUtils.swift

@@ -84,11 +84,11 @@ public func assertIncrementalParse(
       continue
     }
 
-    guard let reusedNode = reusedNodes.first(where: { $0.byteRangeAfterTrimmingTrivia == range }) else {
+    guard let reusedNode = reusedNodes.first(where: { $0.contentByteRange == range }) else {
       XCTFail(
         """
         Fail to match the range of \(expectedReusedNode.source) in:
-        \(reusedNodes.map({"\($0.byteRangeAfterTrimmingTrivia): \($0.description)"}).joined(separator: "\n"))
+        \(reusedNodes.map({"\($0.contentByteRange): \($0.description)"}).joined(separator: "\n"))
         """,
         file: expectedReusedNode.file,
         line: expectedReusedNode.line
@@ -220,10 +220,3 @@ public func applyEdits(
   }
   return String(bytes: bytes, encoding: .utf8)!
 }
-
-fileprivate extension Syntax {
-  /// The  byte source range of this node exluding leading and trailing trivia.
-  var byteRangeAfterTrimmingTrivia: ByteSourceRange {
-    return ByteSourceRange(offset: positionAfterSkippingLeadingTrivia.utf8Offset, length: byteSizeAfterTrimmingTrivia)
-  }
-}

Tests/SwiftSyntaxTest/AbsolutePositionTests.swift

@@ -34,7 +34,7 @@ public class AbsolutePositionTests: XCTestCase {
       endOfFileToken: .endOfFileToken()
     )
     _ = root.statements[idx].position
-    _ = root.statements[idx].byteSize
+    _ = root.statements[idx].totalLength.utf8Length
     _ = root.statements[idx].positionAfterSkippingLeadingTrivia
   }
 
@@ -80,10 +80,10 @@ public class AbsolutePositionTests: XCTestCase {
     XCTAssertEqual(3, state.leadingTrivia.count)
     XCTAssertEqual(2, state.trailingTrivia.count)
     XCTAssertEqual(
-      state.byteSize,
+      state.totalLength.utf8Length,
       state.leadingTrivia.sourceLength.utf8Length
         + state.trailingTrivia.sourceLength.utf8Length
-        + state.byteSizeAfterTrimmingTrivia
+        + state.contentLength.utf8Length
     )
 
     // Test Node trivia setters and getters