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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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
//
//===----------------------------------------------------------------------===//
/// An identifier that identifies a diagnostic message's type.
/// Fundamentally different diagnostics should have a different `diagnosticID`
/// so that clients may filter/prioritise/highlight/... certain diagnostics.
/// Two diagnostics with the same ID don’t need to necessarily have the exact
/// same wording. Eg. it’s possible that the message contains more context when
/// available.
public struct MessageID: Hashable, Sendable {
private let domain: String
private let id: String
public init(domain: String, id: String) {
self.domain = domain
self.id = id
}
}
public enum DiagnosticSeverity: Sendable, Hashable {
case error
case warning
case note
case remark
}
/// Describes a category of diagnostics, which covers a set of related
/// diagnostics that can share documentation.
public struct DiagnosticCategory: Sendable, Hashable {
/// Name that identifies the category, e.g., StrictMemorySafety.
public let name: String
/// URL providing documentation documentation for this category.
public let documentationURL: String?
public init(name: String, documentationURL: String?) {
self.name = name
self.documentationURL = documentationURL
}
}
/// Types conforming to this protocol represent diagnostic messages that can be
/// shown to the client.
public protocol DiagnosticMessage: Sendable {
/// The diagnostic message that should be displayed in the client.
var message: String { get }
/// See ``MessageID``.
var diagnosticID: MessageID { get }
var severity: DiagnosticSeverity { get }
/// The category that this diagnostic belongs in.
var category: DiagnosticCategory? { get }
}
extension DiagnosticMessage {
/// Diagnostic messages default to having no category.
public var category: DiagnosticCategory? { nil }
}
|
