File: Diagnostics.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (153 lines) | stat: -rw-r--r-- 4,686 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#if swift(>=6)
internal import SwiftDiagnostics
internal import SwiftSyntax
#else
import SwiftDiagnostics
import SwiftSyntax
#endif

/// Errors in macro handing.
enum MacroExpansionError {
  case macroTypeNotFound(PluginMessage.MacroReference)
  case freestandingMacroSyntaxIsNotMacro
  case invalidExpansionMessage
  case invalidMacroRole(PluginMessage.MacroRole)
}

extension MacroExpansionError: DiagnosticMessage {
  var message: String {
    switch self {
    case .macroTypeNotFound(let ref):
      return "macro type '\(ref.moduleName).\(ref.typeName)' not found when expanding macro '\(ref.name)'"

    case .freestandingMacroSyntaxIsNotMacro:
      return "macro syntax couldn't be parsed"

    case .invalidExpansionMessage:
      return "internal message error; please file a bug report"

    case .invalidMacroRole(let role):
      return "invalid macro role '\(role)' for expansion"
    }
  }
  var diagnosticID: SwiftDiagnostics.MessageID {
    .init(domain: "SwiftCompilerPlugin", id: "\(type(of: self)).\(self)")
  }
  var severity: SwiftDiagnostics.DiagnosticSeverity {
    .error
  }
}

extension MacroExpansionError: Error {}

extension PluginMessage.Diagnostic.Severity {
  init(from syntaxDiagSeverity: SwiftDiagnostics.DiagnosticSeverity) {
    switch syntaxDiagSeverity {
    case .error: self = .error
    case .warning: self = .warning
    case .note: self = .note
    case .remark: self = .remark
    #if RESILIENT_LIBRARIES
    @unknown default: fatalError()
    #endif
    }
  }
}

extension PluginMessage.Diagnostic {
  init(from syntaxDiag: SwiftDiagnostics.Diagnostic, in sourceManager: SourceManager) {
    if let position = sourceManager.position(
      of: syntaxDiag.node,
      at: .afterLeadingTrivia
    ) {
      self.position = .init(fileName: position.fileName, offset: position.utf8Offset)
    } else {
      self.position = .invalid
    }

    self.severity = .init(from: syntaxDiag.diagMessage.severity)
    self.message = syntaxDiag.message

    self.highlights = syntaxDiag.highlights.compactMap {
      guard let range = sourceManager.range(of: $0) else {
        return nil
      }
      return .init(
        fileName: range.fileName,
        startOffset: range.startUTF8Offset,
        endOffset: range.endUTF8Offset
      )
    }

    self.notes = syntaxDiag.notes.compactMap {
      guard let pos = sourceManager.position(of: $0.node, at: .afterLeadingTrivia) else {
        return nil
      }
      let position = PluginMessage.Diagnostic.Position(
        fileName: pos.fileName,
        offset: pos.utf8Offset
      )
      return .init(position: position, message: $0.message)
    }

    self.fixIts = syntaxDiag.fixIts.compactMap {
      PluginMessage.Diagnostic.FixIt(
        message: $0.message.message,
        changes: $0.changes.compactMap {
          let range: SourceManager.SourceRange?
          let text: String
          switch $0 {
          case .replace(let oldNode, let newNode):
            range = sourceManager.range(
              of: oldNode,
              from: .afterLeadingTrivia,
              to: .beforeTrailingTrivia
            )
            text = newNode.trimmedDescription
          case .replaceLeadingTrivia(let token, let newTrivia):
            range = sourceManager.range(
              of: Syntax(token),
              from: .beforeLeadingTrivia,
              to: .afterLeadingTrivia
            )
            text = newTrivia.description
          case .replaceTrailingTrivia(let token, let newTrivia):
            range = sourceManager.range(
              of: Syntax(token),
              from: .beforeTrailingTrivia,
              to: .afterTrailingTrivia
            )
            text = newTrivia.description
          #if RESILIENT_LIBRARIES
          @unknown default:
            fatalError()
          #endif
          }
          guard let range = range else {
            return nil
          }
          return .init(
            range: PositionRange(
              fileName: range.fileName,
              startOffset: range.startUTF8Offset,
              endOffset: range.endUTF8Offset
            ),
            newText: text
          )
        }
      )
    }
  }
}