Improve sorting of diagnostics at MissingDeclaration

Resolves rdar://100214284
Fixes #823

Author: ahoppen

Sources/SwiftParser/Diagnostics/ParseDiagnosticsGenerator.swift

@@ -23,6 +23,19 @@ extension UnexpectedNodesSyntax {
   }
 }
 
+extension Syntax {
+  func hasParent(_ expectedParent: Syntax) -> Bool {
+    var walk = self.parent
+    while walk != nil {
+      if walk == expectedParent {
+        return true
+      }
+      walk = walk?.parent
+    }
+    return false
+  }
+}
+
 fileprivate extension FixIt.Change {
   /// Replaced a present node with a missing node
   static func makeMissing(node: TokenSyntax) -> FixIt.Change {
@@ -59,7 +72,17 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
     let diagProducer = ParseDiagnosticsGenerator()
     diagProducer.walk(tree)
     diagProducer.diagnostics.sort {
-      return $0.node.id.indexInTree < $1.node.id.indexInTree
+      if $0.position == $1.position {
+        if $0.node.hasParent($1.node) {
+          return true
+        } else if $1.node.hasParent($0.node) {
+          return false
+        } else {
+          return $0.node.id.indexInTree < $1.node.id.indexInTree
+        }
+      } else {
+        return $0.position < $1.position
+      }
     }
     return diagProducer.diagnostics
   }

Tests/SwiftParserTest/Attributes.swift

@@ -11,10 +11,10 @@ final class AttributeTests: XCTestCase {
       }
       """,
       diagnostics: [
-        DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected declaration after attribute"),
         DiagnosticSpec(locationMarker: "DIAG_1", message: "Expected 'for' in attribute argument"),
         DiagnosticSpec(locationMarker: "DIAG_1", message: "Expected ':' in attribute argument"),
         DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected ')' to end attribute"),
+        DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected declaration after attribute"),
       ]
     )
   }
@@ -42,9 +42,9 @@ final class AttributeTests: XCTestCase {
       @_specialize(e#^DIAG^#
       """,
       diagnostics: [
-        DiagnosticSpec(message: "Expected declaration after attribute"),
         DiagnosticSpec(message: "Expected ':' in attribute argument"),
         DiagnosticSpec(message: "Expected ')' to end attribute"),
+        DiagnosticSpec(message: "Expected declaration after attribute"),
       ]
     )
   }
@@ -55,10 +55,10 @@ final class AttributeTests: XCTestCase {
       @_specialize(e#^DIAG_1^#, exported#^DIAG_2^#)#^DIAG_3^#
       """,
       diagnostics: [
-        DiagnosticSpec(locationMarker: "DIAG_3", message: "Expected declaration after attribute"),
         DiagnosticSpec(locationMarker: "DIAG_1", message: "Expected ':' in attribute argument"),
         DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected ':' in attribute argument"),
         DiagnosticSpec(locationMarker: "DIAG_2", message: "Expected 'false' in attribute argument"),
+        DiagnosticSpec(locationMarker: "DIAG_3", message: "Expected declaration after attribute"),
       ]
     )
   }

Tests/SwiftParserTest/Declarations.swift

@@ -904,8 +904,8 @@ final class DeclarationTests: XCTestCase {
       diagnostics: [
         DiagnosticSpec(locationMarker: "OPENING_BRACE", message: "Expected '{' to start struct"),
         DiagnosticSpec(locationMarker: "AFTER_POUND_IF", message: "Expected condition of conditional compilation clause"),
-        DiagnosticSpec(locationMarker: "END", message: "Expected declaration after attribute in conditional compilation clause"),
         DiagnosticSpec(locationMarker: "END", message: "Expected name of attribute"),
+        DiagnosticSpec(locationMarker: "END", message: "Expected declaration after attribute in conditional compilation clause"),
         DiagnosticSpec(locationMarker: "END", message: "Expected '#endif' in conditional compilation block"),
         DiagnosticSpec(locationMarker: "END", message: "Expected '}' to end struct")
       ]