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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#if swift(>=6)
@_spi(RawSyntax) internal import SwiftSyntax
#else
@_spi(RawSyntax) import SwiftSyntax
#endif
public enum SyntaxClassification: Sendable {
/// An attribute starting with an `@`.
case attribute
/// A block comment starting with `/**` and ending with `*/.
case blockComment
/// A doc block comment starting with `/**` and ending with `*/.
case docBlockComment
/// A doc line comment starting with `///`.
case docLineComment
/// An identifier starting with `$` like `$0`.
case dollarIdentifier
/// An editor placeholder of the form `<#content#>`
case editorPlaceholder
/// A floating point literal.
case floatLiteral
/// A generic identifier.
case identifier
/// A directive starting with `#if`, `#elseif`or `#else`.
case ifConfigDirective
/// An integer literal.
case integerLiteral
/// A Swift keyword, including contextual keywords.
case keyword
/// A line comment starting with `//`.
case lineComment
/// The token should not receive syntax coloring.
case none
/// An identifier referring to an operator.
case `operator`
/// A regex literal, including multiline regex literals.
case regexLiteral
/// A string literal including multiline string literals.
case stringLiteral
/// An identifier referring to a type.
case type
/// The label of a function parameter or a function call argument.
case argumentLabel
}
extension SyntaxClassification {
/// Checks if a node has a classification attached via its syntax definition.
/// - Parameters:
/// - parentKind: The parent node syntax kind.
/// - indexInParent: The index of the node in its parent.
/// - childKind: The node syntax kind.
/// - Returns: A pair of classification and whether it is "forced", or nil if
/// no classification is attached.
internal static func classify(_ keyPath: AnyKeyPath) -> (SyntaxClassification, Bool)? {
switch keyPath {
case \AttributeSyntax.attributeName:
return (.attribute, true)
case \PlatformVersionItemSyntax.platformVersion:
return (.keyword, false)
case \AvailabilityVersionRestrictionSyntax.platform:
return (.keyword, false)
case \DeclModifierSyntax.name:
return (.attribute, false)
case \IfConfigClauseSyntax.poundKeyword:
return (.ifConfigDirective, false)
case \IfConfigClauseSyntax.condition:
return (.ifConfigDirective, false)
case \IfConfigDeclSyntax.poundEndif:
return (.ifConfigDirective, false)
case \MemberTypeIdentifierSyntax.name:
return (.type, false)
case \OperatorDeclSyntax.name:
return (.operator, false)
case \PrecedenceGroupAssociativitySyntax.associativityLabel:
return (.keyword, false)
case \PrecedenceGroupRelationSyntax.higherThanOrLowerThanLabel:
return (.keyword, false)
case \SimpleTypeIdentifierSyntax.name:
return (.type, false)
case \FunctionParameterSyntax.firstName:
return (.argumentLabel, false)
case \LabeledExprSyntax.label:
return (.argumentLabel, false)
default:
return nil
}
}
}
extension RawTokenKind {
internal var classification: SyntaxClassification {
switch self {
case .arrow:
return .none
case .atSign:
return .attribute
case .backslash:
return .none
case .backtick:
return .none
case .binaryOperator:
return .operator
case .colon:
return .none
case .comma:
return .none
case .dollarIdentifier:
return .dollarIdentifier
case .ellipsis:
return .none
case .endOfFile:
return .none
case .equal:
return .none
case .exclamationMark:
return .none
case .floatLiteral:
return .floatLiteral
case .identifier:
return .identifier
case .infixQuestionMark:
return .none
case .integerLiteral:
return .integerLiteral
case .keyword:
return .keyword
case .leftAngle:
return .none
case .leftBrace:
return .none
case .leftParen:
return .none
case .leftSquare:
return .none
case .multilineStringQuote:
return .stringLiteral
case .period:
return .none
case .postfixOperator:
return .operator
case .postfixQuestionMark:
return .none
case .pound:
return .none
case .poundAvailable:
return .none
case .poundElse:
return .ifConfigDirective
case .poundElseif:
return .ifConfigDirective
case .poundEndif:
return .ifConfigDirective
case .poundIf:
return .ifConfigDirective
case .poundSourceLocation:
return .keyword
case .poundUnavailable:
return .none
case .prefixAmpersand:
return .none
case .prefixOperator:
return .operator
case .rawStringPoundDelimiter:
return .none
case .regexLiteralPattern:
return .regexLiteral
case .regexPoundDelimiter:
return .regexLiteral
case .regexSlash:
return .regexLiteral
case .rightAngle:
return .none
case .rightBrace:
return .none
case .rightParen:
return .none
case .rightSquare:
return .none
case .semicolon:
return .none
case .shebang:
return .none
case .singleQuote:
return .stringLiteral
case .stringQuote:
return .stringLiteral
case .stringSegment:
return .stringLiteral
case .unknown:
return .none
case .wildcard:
return .none
}
}
}
|
