Rename contentLength -> trimmedLength

Author: ahoppen

Sources/SwiftParserDiagnostics/MissingTokenError.swift

@@ -136,7 +136,7 @@ extension ParseDiagnosticsGenerator {
     missingToken: TokenSyntax,
     invalidTokenContainer: UnexpectedNodesSyntax
   ) -> Bool {
-    let isTooMany = invalidToken.contentLength > missingToken.contentLength
+    let isTooMany = invalidToken.trimmedLength > missingToken.trimmedLength
     let message: DiagnosticMessage
     if missingToken.parent?.is(ExpressionSegmentSyntax.self) == true {
       message = .tooManyRawStringDelimitersToStartInterpolation
@@ -157,7 +157,7 @@ extension ParseDiagnosticsGenerator {
     )
     addDiagnostic(
       invalidToken,
-      position: invalidToken.positionAfterSkippingLeadingTrivia.advanced(by: missingToken.contentLength.utf8Length),
+      position: invalidToken.positionAfterSkippingLeadingTrivia.advanced(by: missingToken.trimmedLength.utf8Length),
       message,
       fixIts: [fixIt],
       handledNodes: [invalidTokenContainer.id]

Sources/SwiftSyntax/Raw/RawSyntax.swift

@@ -508,7 +508,7 @@ extension RawSyntax {
   /// The length of this node’s content, without the first leading and the last
   /// trailing trivia. Intermediate trivia inside a layout node is included in
   /// this.
-  var contentByteLength: Int {
+  var trimmedByteLength: Int {
     let result = byteLength - leadingTriviaByteLength - trailingTriviaByteLength
     precondition(result >= 0)
     return result
@@ -523,8 +523,8 @@ extension RawSyntax {
   }
 
   /// The length of this node excluding its leading and trailing trivia.
-  var contentLength: SourceLength {
-    SourceLength(utf8Length: contentByteLength)
+  var trimmedLength: SourceLength {
+    SourceLength(utf8Length: trimmedByteLength)
   }
 }
 

Sources/SwiftSyntax/Raw/RawSyntaxTokenView.swift

@@ -229,7 +229,7 @@ public struct RawSyntaxTokenView {
   }
 
   @_spi(RawSyntax)
-  public var contentLength: SourceLength {
+  public var trimmedLength: SourceLength {
     SourceLength(utf8Length: textByteLength)
   }
 

Sources/SwiftSyntax/SourceLocation.swift

@@ -400,7 +400,7 @@ public extension Syntax {
   ) -> SourceLocation {
     var pos = data.position
     pos += raw.leadingTriviaLength
-    pos += raw.contentLength
+    pos += raw.trimmedLength
     if afterTrailingTrivia {
       pos += raw.trailingTriviaLength
     }

Sources/SwiftSyntax/Syntax.swift

@@ -484,8 +484,11 @@ public extension SyntaxProtocol {
 
   /// The length this node takes up spelled out in the source, excluding its
   /// leading or trailing trivia.
-  var contentLength: SourceLength {
-    return raw.contentLength
+  ///
+  /// - Note: If this node consists of multiple tokens, only the first token’s
+  ///   leading and the last token’s trailing trivia will be trimmed.
+  var trimmedLength: SourceLength {
+    return raw.trimmedLength
   }
 
   /// The byte source range of this node including leading and trailing trivia.
@@ -494,13 +497,21 @@ public extension SyntaxProtocol {
   }
 
   /// The byte source range of this node excluding leading and trailing trivia.
-  var contentByteRange: ByteSourceRange {
+  ///
+  /// - Note: If this node consists of multiple tokens, only the first token’s
+  ///   leading and the last token’s trailing trivia will be trimmed.
+  var trimmedByteRange: ByteSourceRange {
     return ByteSourceRange(
       offset: positionAfterSkippingLeadingTrivia.utf8Offset,
-      length: contentLength.utf8Length
+      length: trimmedLength.utf8Length
     )
   }
 
+  @available(*, deprecated, renamed: "trimmedLength")
+  var contentLength: SourceLength {
+    return trimmedLength
+  }
+
   @available(*, deprecated, renamed: "totalByteRange")
   var byteRange: ByteSourceRange {
     return ByteSourceRange(offset: position.utf8Offset, length: totalLength.utf8Length)
@@ -513,9 +524,9 @@ public extension SyntaxProtocol {
   }
 
   /// The textual byte length of this node exluding leading and trailing trivia.
-  @available(*, deprecated, message: "Use contentLength.utf8Length")
+  @available(*, deprecated, message: "Use trimmedLength.utf8Length")
   var byteSizeAfterTrimmingTrivia: Int {
-    return contentLength.utf8Length
+    return trimmedLength.utf8Length
   }
 }
 

Sources/SwiftSyntax/TokenSyntax.swift

@@ -121,8 +121,8 @@ public struct TokenSyntax: SyntaxProtocol, SyntaxHashable {
 
   /// The length this node takes up spelled out in the source, excluding its
   /// leading or trailing trivia.
-  public var contentLength: SourceLength {
-    return tokenView.contentLength
+  public var trimmedLength: SourceLength {
+    return tokenView.trimmedLength
   }
 
   /// The length this node's leading trivia takes up spelled out in source.

Sources/_SwiftSyntaxTestSupport/IncrementalParseTestUtils.swift

@@ -84,11 +84,11 @@ public func assertIncrementalParse(
       continue
     }
 
-    guard let reusedNode = reusedNodes.first(where: { $0.contentByteRange == range }) else {
+    guard let reusedNode = reusedNodes.first(where: { $0.trimmedByteRange == range }) else {
       XCTFail(
         """
         Fail to match the range of \(expectedReusedNode.source) in:
-        \(reusedNodes.map({"\($0.contentByteRange): \($0.description)"}).joined(separator: "\n"))
+        \(reusedNodes.map({"\($0.trimmedByteRange): \($0.description)"}).joined(separator: "\n"))
         """,
         file: expectedReusedNode.file,
         line: expectedReusedNode.line

Tests/SwiftSyntaxTest/AbsolutePositionTests.swift

@@ -83,7 +83,7 @@ public class AbsolutePositionTests: XCTestCase {
       state.totalLength.utf8Length,
       state.leadingTrivia.sourceLength.utf8Length
         + state.trailingTrivia.sourceLength.utf8Length
-        + state.contentLength.utf8Length
+        + state.trimmedLength.utf8Length
     )
 
     // Test Node trivia setters and getters

Tests/SwiftSyntaxTest/SyntaxTests.swift

@@ -123,6 +123,6 @@ public class SyntaxTests: XCTestCase {
     XCTAssertEqual(funcKW.positionAfterSkippingLeadingTrivia, AbsolutePosition(utf8Offset: 2))
     XCTAssertEqual(funcKW.endPositionBeforeTrailingTrivia, AbsolutePosition(utf8Offset: 6))
     XCTAssertEqual(funcKW.endPosition, AbsolutePosition(utf8Offset: 7))
-    XCTAssertEqual(funcKW.contentLength, SourceLength(utf8Length: 4))
+    XCTAssertEqual(funcKW.trimmedLength, SourceLength(utf8Length: 4))
   }
 }