Merge pull request #1953 from StevenWong12/convert_coloring_lit_test

Convert `lit`-based syntax classification test to XCTest

Author: ahoppen

Sources/SwiftIDEUtils/SyntaxClassification.swift

@@ -39,8 +39,6 @@ public enum SyntaxClassification {
   case lineComment
   /// The token should not receive syntax coloring.
   case none
-  /// An image, color, etc. literal.
-  case objectLiteral
   /// An identifier referring to an operator.
   case operatorIdentifier
   /// A `#` token like `#warning`.
@@ -66,7 +64,7 @@ extension SyntaxClassification {
   internal static func classify(_ keyPath: AnyKeyPath) -> (SyntaxClassification, Bool)? {
     switch keyPath {
     case \AttributeSyntax.attributeName:
-      return (.attribute, false)
+      return (.attribute, true)
     case \PlatformVersionItemSyntax.availabilityVersionRestriction:
       return (.keyword, false)
     case \AvailabilityVersionRestrictionSyntax.platform:

Sources/SwiftIDEUtils/SyntaxClassifier.swift

@@ -160,17 +160,24 @@ private struct ClassificationVisitor {
     classifications.append(range)
   }
 
+  /// Classifies `triviaPieces` starting from `offset` and returns the number of bytes the trivia took up in the source
+  private mutating func classify(triviaPieces: [RawTriviaPiece], at offset: Int) -> Int {
+    var classifiedBytes = 0
+    for triviaPiece in triviaPieces {
+      let range = triviaPiece.classify(offset: offset + classifiedBytes)
+      report(range: range)
+      classifiedBytes += triviaPiece.byteLength
+    }
+    return classifiedBytes
+  }
+
   // Report classification ranges in `descriptor.node` that is a token.
   private mutating func handleToken(_ descriptor: Descriptor) -> VisitResult {
     let tokenView = descriptor.node.tokenView!
     var byteOffset = descriptor.byteOffset
 
     // Leading trivia.
-    for piece in tokenView.leadingRawTriviaPieces {
-      let range = piece.classify(offset: byteOffset)
-      report(range: range)
-      byteOffset += piece.byteLength
-    }
+    byteOffset += classify(triviaPieces: tokenView.leadingRawTriviaPieces, at: byteOffset)
     // Token text.
     do {
       let range = TokenKindAndText(kind: tokenView.rawKind, text: tokenView.rawText)
@@ -179,11 +186,7 @@ private struct ClassificationVisitor {
       byteOffset += tokenView.rawText.count
     }
     // Trailing trivia.
-    for piece in tokenView.trailingRawTriviaPieces {
-      let range = piece.classify(offset: byteOffset)
-      report(range: range)
-      byteOffset += piece.byteLength
-    }
+    byteOffset += classify(triviaPieces: tokenView.trailingRawTriviaPieces, at: byteOffset)
 
     precondition(byteOffset == descriptor.byteOffset + descriptor.node.byteLength)
     return .continue
@@ -196,12 +199,37 @@ private struct ClassificationVisitor {
 
     for case (let index, let child?) in children.enumerated() {
 
-      let classification: (SyntaxClassification, Bool)?
+      let classification: (classification: SyntaxClassification, force: Bool)?
       if case .layout(let layout) = descriptor.node.kind.syntaxNodeType.structure {
         classification = SyntaxClassification.classify(layout[index])
       } else {
         classification = nil
       }
+
+      if let classification, classification.force {
+        // Leading trivia.
+        if let leadingTriviaPieces = child.leadingTriviaPieces {
+          byteOffset += classify(triviaPieces: leadingTriviaPieces, at: byteOffset)
+        }
+        // Layout node text.
+        let layoutNodeTextLength = child.byteLength - child.leadingTriviaByteLength - child.trailingTriviaByteLength
+        let range = SyntaxClassifiedRange(
+          kind: classification.classification,
+          range: ByteSourceRange(
+            offset: byteOffset,
+            length: layoutNodeTextLength
+          )
+        )
+        report(range: range)
+        byteOffset += layoutNodeTextLength
+
+        // Trailing trivia.
+        if let trailingTriviaPieces = child.trailingTriviaPieces {
+          byteOffset += classify(triviaPieces: trailingTriviaPieces, at: byteOffset)
+        }
+        continue
+      }
+
       let result = visit(
         .init(
           node: child,

Sources/SwiftSyntax/Raw/RawSyntax.swift

@@ -505,6 +505,16 @@ extension RawSyntax {
     lastToken(viewMode: .sourceAccurate)?.trailingTriviaByteLength ?? 0
   }
 
+  @_spi(RawSyntax)
+  public var leadingTriviaPieces: [RawTriviaPiece]? {
+    firstToken(viewMode: .sourceAccurate)?.leadingRawTriviaPieces
+  }
+
+  @_spi(RawSyntax)
+  public var trailingTriviaPieces: [RawTriviaPiece]? {
+    lastToken(viewMode: .sourceAccurate)?.trailingRawTriviaPieces
+  }
+
   /// 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.

Sources/lit-test-helper/ClassifiedSyntaxTreePrinter.swift

@@ -30,7 +30,6 @@ extension SyntaxClassification {
     case .poundDirective: return "#kw"
     case .buildConfigId: return "#id"
     case .attribute: return "attr-builtin"
-    case .objectLiteral: return "object-literal"
     case .editorPlaceholder: return "placeholder"
     case .lineComment: return "comment-line"
     case .blockComment: return "comment-block"

Tests/SwiftIDEUtilsTest/Assertions.swift

@@ -71,7 +71,7 @@ func assertClassification(
       line: spec.line
     )
 
-    lastRangeUpperBound = source.index(source.startIndex, offsetBy: range.endOffset)
+    lastRangeUpperBound = source.utf8.index(source.utf8.startIndex, offsetBy: range.endOffset)
   }
 }