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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import SwiftSyntax
public class Trivia {
/// The name of the trivia.
public let name: TokenSyntax
/// The doc comment describing the trivia.
public let comment: SwiftSyntax.Trivia
/// The list of characters that make up the trivia.
///
/// Useful for multi-character trivias like `\r\n`.
public let characters: [Character]
/// The list of characters as they would appear in Swift code.
///
/// This might differ from `characters` due to Swift's character escape requirements.
public let swiftCharacters: [Character]
/// Indicates if the trivia represents a comment.
///
/// If `true`, the trivia is some form of a comment in the Swift code.
public let isComment: Bool
/// The name of the trivia in lowercase.
public var lowerName: TokenSyntax { .identifier(lowercaseFirstWord(name: name.text)) }
/// The name of the trivia when used as an enum case.
///
/// This is typically the plural form of the `lowerName`, with exceptions for certain trivias.
public var enumCaseName: TokenSyntax {
if self.isCollection {
if lowerName.text == "backslash" {
return "backslashes"
} else {
return .identifier("\(lowerName)s")
}
} else {
return lowerName
}
}
/// The length of the `characters` array.
public var charactersLen: Int { characters.count }
/// Indicates if the trivia is a collection of characters.
///
/// If `true`, the trivia is made up of multiple characters.
public var isCollection: Bool { charactersLen > 0 }
/// Indicates if the trivia contains only whitespace characters.
public var isBlank: Bool {
characters.contains { $0.isWhitespace }
}
/// Indicates if the trivia contains newline characters.
public var isNewLine: Bool {
characters.contains { $0.isNewline }
}
/// Initializes a new `Trivia` instance.
///
/// - Parameters:
/// - name: A name of the trivia.
/// - comment: A doc comment describing the trivia.
/// - characters: A list of characters that make up the trivia.
/// - swiftCharacters: A list of characters as they would appear in Swift code.
/// - isComment: Indicates if the trivia represents a comment.
init(
name: TokenSyntax,
comment: SwiftSyntax.Trivia,
characters: [Character] = [],
swiftCharacters: [Character] = [],
isComment: Bool = false
) {
self.name = name
self.comment = comment
self.isComment = isComment
self.characters = characters
// Swift sometimes doesn't support escaped characters like \f or \v;
// we should allow specifying alternatives explicitly.
if !swiftCharacters.isEmpty {
self.swiftCharacters = swiftCharacters
} else {
self.swiftCharacters = characters
}
}
}
public let TRIVIAS: [Trivia] = [
Trivia(
name: "Backslash",
comment: #"A backslash that is at the end of a line in a multi-line string literal to escape the newline."#,
characters: [
Character("\\")
],
swiftCharacters: [
Character("\\")
]
),
Trivia(
name: "BlockComment",
comment: #"A developer block comment, starting with '/*' and ending with '*/'."#,
isComment: true
),
Trivia(
name: "CarriageReturn",
comment: #"A newline '\r' character."#,
characters: [
Character("\r")
],
swiftCharacters: [
Character("\r")
]
),
Trivia(
name: "CarriageReturnLineFeed",
comment: #"A newline consists of contiguous '\r' and '\n' characters."#,
characters: [
Character("\r"),
Character("\n"),
],
swiftCharacters: [
Character("\r"),
Character("\n"),
]
),
Trivia(
name: "DocBlockComment",
comment: #"A documentation block comment, starting with '/**' and ending with '*/'."#,
isComment: true
),
Trivia(
name: "DocLineComment",
comment: #"A documentation line comment, starting with '///'."#,
isComment: true
),
// Swift don't support form feed '\f' so we use the raw unicode
Trivia(
name: "Formfeed",
comment: #"A form-feed 'f' character."#,
characters: [
Character("\u{c}")
],
swiftCharacters: [
Character("\u{240C}")
]
),
Trivia(
name: "LineComment",
comment: #"A developer line comment, starting with '//'"#,
isComment: true
),
Trivia(
name: "Newline",
comment: #"A newline '\n' character."#,
characters: [
Character("\n")
],
swiftCharacters: [
Character("\n")
]
),
Trivia(
name: "Pound",
comment: #"A '#' that is at the end of a line in a multi-line string literal to escape the newline."#,
characters: [
Character("#")
],
swiftCharacters: [
Character("#")
]
),
Trivia(
name: "Space",
comment: #"A space ' ' character."#,
characters: [
Character(" ")
],
swiftCharacters: [
Character(" ")
]
),
Trivia(
name: "Tab",
comment: #"A tab '\t' character."#,
characters: [
Character("\t")
],
swiftCharacters: [
Character("\t")
]
),
Trivia(
name: "UnexpectedText",
comment: #"Any skipped unexpected text."#
),
// Swift don't support vertical tab '\v' so we use the raw unicode
Trivia(
name: "VerticalTab",
comment: #"A vertical tab '\v' character."#,
characters: [
Character("\u{b}")
],
swiftCharacters: [
Character("\u{2B7F}")
]
),
]
|
