Merge pull request #862 from ahoppen/ahoppen/notes

Add `to match this opening <thing>` notes to the diagnostics

Author: ahoppen

CodeGeneration/Sources/SyntaxSupport/gyb_generated/StmtNodes.swift

@@ -699,7 +699,7 @@ public let STMT_NODES: [Node] = [
        ]),
 
   Node(name: "PoundAssertStmt",
-       nameForDiagnostics: "'#assert' statement",
+       nameForDiagnostics: "'#assert' directive",
        kind: "Stmt",
        children: [
          Child(name: "PoundAssert",

Sources/SwiftDiagnostics/CMakeLists.txt

@@ -7,9 +7,10 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(SwiftDiagnostics STATIC
+  Diagnostic.swift
   FixIt.swift
   Message.swift
-  Diagnostic.swift
+  Note.swift
 )
 
 target_link_libraries(SwiftDiagnostics PUBLIC

Sources/SwiftDiagnostics/Diagnostic.swift

@@ -26,15 +26,26 @@ public struct Diagnostic: CustomDebugStringConvertible {
   /// Nodes that should be highlighted in the source code.
   public let highlights: [Syntax]
 
+  /// Notes that point to additional locations which are relevant for this diagnostic.
+  public let notes: [Note]
+
   /// Fix-Its that can be applied to resolve this diagnostic.
   /// Each Fix-It offers a different way to resolve the diagnostic. Usually, there's only one.
   public let fixIts: [FixIt]
 
-  public init(node: Syntax, position: AbsolutePosition? = nil, message: DiagnosticMessage, highlights: [Syntax] = [], fixIts: [FixIt] = []) {
+  public init(
+    node: Syntax,
+    position: AbsolutePosition? = nil,
+    message: DiagnosticMessage,
+    highlights: [Syntax] = [],
+    notes: [Note] = [],
+    fixIts: [FixIt] = []
+  ) {
     self.node = node
     self.position = position ?? node.positionAfterSkippingLeadingTrivia
     self.diagMessage = message
     self.highlights = highlights
+    self.notes = notes
     self.fixIts = fixIts
   }
 

Sources/SwiftDiagnostics/FixIt.swift

@@ -16,7 +16,7 @@ import SwiftSyntax
 /// shown to the client.
 /// The messages should describe the change that the Fix-It will perform
 public protocol FixItMessage {
-  /// The diagnostic message that should be displayed in the client.
+  /// The Fix-It message that should be displayed in the client.
   var message: String { get }
 
   /// See ``MessageID``.
@@ -38,7 +38,7 @@ public struct FixIt {
   public let changes: [Change]
 
   public init(message: FixItMessage, changes: [Change]) {
-    assert(!changes.isEmpty, "A Fix-It must have at least one diagnostic associated with it")
+    assert(!changes.isEmpty, "A Fix-It must have at least one change associated with it")
     self.message = message
     self.changes = changes
   }

Sources/SwiftDiagnostics/Note.swift

@@ -0,0 +1,68 @@
+//===--- Note.swift -------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSyntax
+
+/// Types conforming to this protocol represent note messages that can be
+/// shown to the client.
+/// The messages should describe what the note is pointing at.
+public protocol NoteMessage {
+  /// The message that should be displayed in the client.
+  var message: String { get }
+
+  /// See ``MessageID``.
+  var fixItID: MessageID { get }
+}
+
+/// A note that points to another node that's relevant for a Diagnostic.
+public struct Note: CustomDebugStringConvertible {
+  /// The node whose location the node is pointing.
+  public let node: Syntax
+
+  /// The position at which the location should be anchored.
+  /// By default, this is the start location of `node`.
+  public let position: AbsolutePosition
+
+  /// A description of what this note is pointing at.
+  public let noteMessage: NoteMessage
+
+  public init(
+    node: Syntax,
+    position: AbsolutePosition? = nil,
+    message: NoteMessage
+  ) {
+    self.node = node
+    self.position = position ?? node.positionAfterSkippingLeadingTrivia
+    self.noteMessage = message
+  }
+
+  /// The message that should be displayed to the user.
+  public var message: String {
+    return noteMessage.message
+  }
+
+  /// The location at which the note should be displayed.
+  public func location(converter: SourceLocationConverter) -> SourceLocation {
+    return converter.location(for: position)
+  }
+
+  public var debugDescription: String {
+    if let root = node.root.as(SourceFileSyntax.self) {
+      let locationConverter = SourceLocationConverter(file: "", tree: root)
+      let location = location(converter: locationConverter)
+      return "\(location): \(message)"
+    } else {
+      return "<unknown>: \(message)"
+    }
+  }
+}
+

Sources/SwiftParser/Diagnostics/MissingNodesError.swift

@@ -102,6 +102,38 @@ private func missingNodesDescription(missingNodes: [Syntax], commonParent: Synta
   }
 }
 
+fileprivate extension TokenKind {
+  var isStartMarker: Bool {
+    switch self {
+    case .leftBrace, .leftAngle, .leftParen, .leftSquareBracket:
+      return true
+    default:
+      return false
+    }
+  }
+
+  var isEndMarker: Bool {
+    return matchingStartMarkerKind != nil
+  }
+
+  var matchingStartMarkerKind: TokenKind? {
+    switch self {
+    case .rightBrace:
+      return .leftBrace
+    case .rightAngle:
+      return .leftAngle
+    case .rightParen:
+      return .leftParen
+    case .rightSquareBracket:
+      return .leftSquareBracket
+    case .stringQuote, .multilineStringQuote, .rawStringDelimiter:
+      return self
+    default:
+      return nil
+    }
+  }
+}
+
 // MARK: - Error
 
 public struct MissingNodesError: ParserError {
@@ -142,22 +174,8 @@ public struct MissingNodesError: ParserError {
       return nil
     }
 
-    var isFirstTokenStartMarker: Bool
-    switch missingNodes.first?.as(TokenSyntax.self)?.tokenKind {
-    case .leftBrace, .leftAngle, .leftParen, .leftSquareBracket:
-      isFirstTokenStartMarker = true
-    default:
-      isFirstTokenStartMarker = false
-    }
-
-    var isLastTokenEndMarker: Bool
-    switch missingNodes.last?.as(TokenSyntax.self)?.tokenKind {
-    case .rightBrace, .rightAngle, .rightParen, .rightSquareBracket, .stringQuote, .multilineStringQuote, .rawStringDelimiter(_):
-      isLastTokenEndMarker = true
-    default:
-      isLastTokenEndMarker = false
-    }
-
+    let isFirstTokenStartMarker = missingNodes.first?.as(TokenSyntax.self)?.tokenKind.isStartMarker ?? false
+    let isLastTokenEndMarker = missingNodes.last?.as(TokenSyntax.self)?.tokenKind.isEndMarker ?? false
     switch (isFirstTokenStartMarker, isLastTokenEndMarker) {
     case (true, false) where Syntax(anchorParent.firstToken(viewMode: .all)) == missingNodes.first:
       return "to start \(anchorTypeName)"
@@ -180,6 +198,14 @@ public struct MissingNodesError: ParserError {
   }
 }
 
+// MARK: - Note
+
+public struct MatchingOpeningTokenNote: ParserNote {
+  let openingToken: TokenSyntax
+
+  public var message: String { "to match this opening '\(openingToken.text)'" }
+}
+
 // MARK: - Fix-It
 
 public struct InsertTokenFixIt: ParserFixIt {
@@ -233,10 +259,19 @@ extension ParseDiagnosticsGenerator {
       changes: missingNodes.map(FixIt.Change.makePresent)
     )
 
+    var notes: [Note] = []
+    if missingNodes.count == 1,
+       let token = missingNodes.last?.as(TokenSyntax.self),
+       let matchingStartMarkerKind = token.tokenKind.matchingStartMarkerKind,
+       let startToken = token.parent?.children(viewMode: .sourceAccurate).lazy.compactMap({ $0.as(TokenSyntax.self) }).first(where: { $0.tokenKind == matchingStartMarkerKind }) {
+      notes.append(Note(node: Syntax(startToken), message: MatchingOpeningTokenNote(openingToken: startToken)))
+    }
+
     addDiagnostic(
       node,
       position: node.endPosition,
       MissingNodesError(missingNodes: missingNodes),
+      notes: notes,
       fixIts: [fixIt],
       handledNodes: missingNodes.map(\.id)
     )

Sources/SwiftParser/Diagnostics/ParseDiagnosticsGenerator.swift

@@ -51,15 +51,39 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
   // MARK: - Private helper functions
 
   /// Produce a diagnostic.
-  func addDiagnostic<T: SyntaxProtocol>(_ node: T, position: AbsolutePosition? = nil, _ message: DiagnosticMessage, highlights: [Syntax] = [], fixIts: [FixIt] = [], handledNodes: [SyntaxIdentifier] = []) {
+  func addDiagnostic<T: SyntaxProtocol>(
+    _ node: T,
+    position: AbsolutePosition? = nil,
+    _ message: DiagnosticMessage,
+    highlights: [Syntax] = [],
+    notes: [Note] = [],
+    fixIts: [FixIt] = [],
+    handledNodes: [SyntaxIdentifier] = []
+  ) {
     diagnostics.removeAll(where: { handledNodes.contains($0.node.id) })
-    diagnostics.append(Diagnostic(node: Syntax(node), position: position, message: message, highlights: highlights, fixIts: fixIts))
+    diagnostics.append(Diagnostic(node: Syntax(node), position: position, message: message, highlights: highlights, notes: notes, fixIts: fixIts))
     self.handledNodes.append(contentsOf: handledNodes)
   }
 
   /// Produce a diagnostic.
-  func addDiagnostic<T: SyntaxProtocol>(_ node: T,position: AbsolutePosition? = nil,  _ message: StaticParserError, highlights: [Syntax] = [], fixIts: [FixIt] = [], handledNodes: [SyntaxIdentifier] = []) {
-    addDiagnostic(node, position: position, message as DiagnosticMessage, highlights: highlights, fixIts: fixIts, handledNodes: handledNodes)
+  func addDiagnostic<T: SyntaxProtocol>(
+    _ node: T,
+    position: AbsolutePosition? = nil,
+    _ message: StaticParserError,
+    highlights: [Syntax] = [],
+    notes: [Note] = [],
+    fixIts: [FixIt] = [],
+    handledNodes: [SyntaxIdentifier] = []
+  ) {
+    addDiagnostic(
+      node,
+      position: position,
+      message as DiagnosticMessage,
+      highlights: highlights,
+      notes: notes,
+      fixIts: fixIts,
+      handledNodes: handledNodes
+    )
   }
 
   /// Whether the node should be skipped for diagnostic emission.

Sources/SwiftParser/Diagnostics/ParserDiagnosticMessages.swift

@@ -34,6 +34,20 @@ public extension ParserError {
   }
 }
 
+public protocol ParserNote: NoteMessage {
+  var fixItID: MessageID { get }
+}
+
+public extension ParserNote {
+  static var fixItID: MessageID {
+    return MessageID(domain: diagnosticDomain, id: "\(self)")
+  }
+
+  var fixItID: MessageID {
+    return Self.fixItID
+  }
+}
+
 public protocol ParserFixIt: FixItMessage {
   var fixItID: MessageID { get }
 }

Sources/SwiftSyntax/gyb_generated/SyntaxEnum.swift

@@ -736,7 +736,7 @@ public enum SyntaxEnum {
     case .catchClause:
       return "'catch' clause"
     case .poundAssertStmt:
-      return "'#assert' statement"
+      return "'#assert' directive"
     case .genericWhereClause:
       return "'where' clause"
     case .genericRequirementList: