Merge pull request #1365 from DougGregor/grouped-diagnostics-cleanups

Author: DougGregor

Sources/SwiftDiagnostics/DiagnosticsFormatter.swift

@@ -29,8 +29,9 @@ extension Sequence where Element == Range<Int> {
       }
 
       // If the ranges overlap, expand the prior range.
+      assert(priorRange.lowerBound <= range.lowerBound)
       if priorRange.overlaps(range) {
-        let lower = Swift.min(priorRange.lowerBound, range.lowerBound)
+        let lower = priorRange.lowerBound
         let upper = Swift.max(priorRange.upperBound, range.upperBound)
         prior = lower..<upper
         continue
@@ -151,18 +152,19 @@ public struct DiagnosticsFormatter {
     }.mergingOverlappingRanges()
 
     // Map the column ranges into index ranges within the source string itself.
-    let sourceString = annotatedLine.sourceString
+    let sourceStringUTF8 = annotatedLine.sourceString.utf8
     let highlightIndexRanges: [Range<String.Index>] = highlightRanges.map { highlightRange in
-      let startIndex = sourceString.index(sourceString.startIndex, offsetBy: highlightRange.lowerBound - 1)
-      let endIndex = sourceString.index(startIndex, offsetBy: highlightRange.count)
+      let startIndex = sourceStringUTF8.index(sourceStringUTF8.startIndex, offsetBy: highlightRange.lowerBound - 1)
+      let endIndex = sourceStringUTF8.index(startIndex, offsetBy: highlightRange.count)
       return startIndex..<endIndex
     }
 
     // Form the annotated string by copying in text from the original source,
     // highlighting the column ranges.
     var resultSourceString: String = ""
-    var sourceIndex = sourceString.startIndex
     let annotation = ANSIAnnotation.sourceHighlight
+    let sourceString = annotatedLine.sourceString
+    var sourceIndex = sourceString.startIndex
     for highlightRange in highlightIndexRanges {
       // Text before the highlight range
       resultSourceString += sourceString[sourceIndex..<highlightRange.lowerBound]
@@ -188,7 +190,7 @@ public struct DiagnosticsFormatter {
     tree: SyntaxType,
     diags: [Diagnostic],
     indentString: String,
-    suffixTexts: [(AbsolutePosition, String)],
+    suffixTexts: [AbsolutePosition: String],
     sourceLocationConverter: SourceLocationConverter? = nil
   ) -> String {
     let slc = sourceLocationConverter ?? SourceLocationConverter(file: fileName ?? "", tree: tree)
@@ -318,7 +320,7 @@ public struct DiagnosticsFormatter {
       tree: tree,
       diags: diags,
       indentString: "",
-      suffixTexts: []
+      suffixTexts: [:]
     )
   }
 
@@ -372,6 +374,7 @@ struct ANSIAnnotation {
     case magenta = 35
     case cyan = 36
     case white = 37
+    case `default` = 39
   }
 
   enum Trait: UInt8 {
@@ -414,6 +417,6 @@ struct ANSIAnnotation {
 
   /// Annotation used for highlighting source text.
   static var sourceHighlight: ANSIAnnotation {
-    ANSIAnnotation(color: .white, trait: .underline)
+    ANSIAnnotation(color: .default, trait: .underline)
   }
 }

Sources/SwiftDiagnostics/GroupedDiagnostics.swift

@@ -149,14 +149,16 @@ extension GroupedDiagnostics {
 
     let childPadding = String(slc.sourceLines.count + 1).count + 1;
 
-    let childSources: [(AbsolutePosition, String)] = sourceFiles[sourceFileID.id].children.map { childBufferID in
+    // Collect the child sources.
+    var childSources: [AbsolutePosition: String] = [:]
+    for childBufferID in sourceFiles[sourceFileID.id].children {
       let childSource = annotateSource(
         childBufferID,
         formatter: formatter,
         indentString: indentString + String(repeating: " ", count: childPadding) + "│"
       )
 
-      return (sourceFiles[childBufferID.id].parent!.1, childSource)
+      childSources[sourceFiles[childBufferID.id].parent!.1, default: ""].append(childSource)
     }
 
     // If this is a nested source file, draw a box around it.

Sources/SwiftSyntax/AbsolutePosition.swift

@@ -12,7 +12,7 @@
 
 /// An absolute position in a source file as text - the absolute utf8Offset from
 /// the start of the file.
-public struct AbsolutePosition: Comparable {
+public struct AbsolutePosition: Comparable, Hashable {
   public let utf8Offset: Int
 
   static let startOfFile = AbsolutePosition(utf8Offset: 0)

Tests/SwiftDiagnosticsTest/DiagnosticsFormatterTests.swift

@@ -123,11 +123,11 @@ final class DiagnosticsFormatterTests: XCTestCase {
 
   func testColoringWithHighlights() {
     let source = """
-      for (i = 0; i != 10; i += 1) { }
+      for (i = 🐮; i != 👩‍👩‍👦‍👦; i += 1) { }
       """
 
     let expectedOutput = """
-      \u{001B}[0;36m1 │\u{001B}[0;0m for \u{001B}[4;37m(i\u{001B}[0;0m \u{001B}[4;37m= 0; i != 10; i += 1)\u{001B}[0;0m { }
+      \u{001B}[0;36m1 │\u{001B}[0;0m for \u{001B}[4;39m(i\u{001B}[0;0m \u{001B}[4;39m= 🐮; i != 👩‍👩‍👦‍👦; i += 1)\u{001B}[0;0m { }
         \u{001B}[0;36m∣\u{001B}[0;0m │      ╰─ \u{001B}[1;31merror: expected ')' to end tuple pattern\u{001B}[0;0m
         \u{001B}[0;36m∣\u{001B}[0;0m ╰─ \u{001B}[1;31merror: C-style for statement has been removed in Swift 3\u{001B}[0;0m