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
|
//===----------------------------------------------------------------------===//
//
// 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)
internal import SwiftDiagnostics
@_spi(Diagnostics) internal import SwiftParser
@_spi(RawSyntax) internal import SwiftSyntax
#else
import SwiftDiagnostics
@_spi(Diagnostics) import SwiftParser
@_spi(RawSyntax) import SwiftSyntax
#endif
extension ParseDiagnosticsGenerator {
func handleMissingToken(_ missingToken: TokenSyntax) {
guard let invalidToken = missingToken.previousToken(viewMode: .all),
invalidToken.presence == .present,
let invalidTokenContainer = invalidToken.parent?.as(UnexpectedNodesSyntax.self),
invalidTokenContainer.count == 1
else {
_ = handleMissingSyntax(missingToken)
return
}
// The previous token is unexpected, assume that it was intended to be
// this token.
let handled: Bool
switch (missingToken.tokenView.rawKind, invalidToken.tokenView.rawKind) {
case (.identifier, _):
handled = handleInvalidIdentifier(
invalidToken: invalidToken,
missingToken: missingToken,
invalidTokenContainer: invalidTokenContainer
)
case (.multilineStringQuote, .multilineStringQuote):
handled = handleInvalidMultilineStringQuote(
invalidToken: invalidToken,
missingToken: missingToken,
invalidTokenContainer: invalidTokenContainer
)
case (.period, .period):
handled = handleInvalidPeriod(
invalidToken: invalidToken,
missingToken: missingToken,
invalidTokenContainer: invalidTokenContainer
)
case (.rawStringPoundDelimiter, .rawStringPoundDelimiter), (.regexPoundDelimiter, .regexPoundDelimiter):
handled = handleInvalidPoundDelimiter(
invalidToken: invalidToken,
missingToken: missingToken,
invalidTokenContainer: invalidTokenContainer
)
default:
handled = false
}
if !handled {
_ = handleMissingSyntax(missingToken)
}
}
private func handleInvalidIdentifier(
invalidToken: TokenSyntax,
missingToken: TokenSyntax,
invalidTokenContainer: UnexpectedNodesSyntax
) -> Bool {
let fixIts: [FixIt]
if invalidToken.tokenKind.isLexerClassifiedKeyword || invalidToken.tokenKind.isDollarIdentifier {
fixIts = [
FixIt(
message: .wrapInBackticks,
changes: [
.replace(
oldNode: Syntax(invalidToken),
newNode: Syntax(
TokenSyntax.identifier(
"`\(invalidToken.text)`",
leadingTrivia: invalidToken.leadingTrivia,
trailingTrivia: invalidToken.trailingTrivia
)
)
)
]
)
]
} else {
fixIts = []
}
addDiagnostic(
invalidToken,
InvalidIdentifierError(invalidIdentifier: invalidToken, missingIdentifier: missingToken),
fixIts: fixIts,
handledNodes: [invalidTokenContainer.id]
)
return true
}
private func handleInvalidMultilineStringQuote(
invalidToken: TokenSyntax,
missingToken: TokenSyntax,
invalidTokenContainer: UnexpectedNodesSyntax
) -> Bool {
if invalidToken.trailingTrivia.isEmpty && !missingToken.trailingTrivia.isEmpty {
addDiagnostic(
invalidToken,
position: invalidToken.endPositionBeforeTrailingTrivia,
.multiLineStringLiteralMustBeginOnNewLine,
fixIts: [
FixIt(
message: .insertNewline,
changes: [.replaceTrailingTrivia(token: invalidToken, newTrivia: missingToken.trailingTrivia)]
)
],
handledNodes: [invalidTokenContainer.id]
)
return true
} else if invalidToken.leadingTrivia.isEmpty && !missingToken.leadingTrivia.isEmpty {
addDiagnostic(
invalidToken,
.multiLineStringLiteralMustHaveClosingDelimiterOnNewLine,
fixIts: [
FixIt(
message: .insertNewline,
changes: [.replaceLeadingTrivia(token: invalidToken, newTrivia: missingToken.leadingTrivia)]
)
],
handledNodes: [invalidTokenContainer.id]
)
return true
}
return false
}
private func handleInvalidPeriod(
invalidToken: TokenSyntax,
missingToken: TokenSyntax,
invalidTokenContainer: UnexpectedNodesSyntax
) -> Bool {
// Trailing trivia is the cause of this diagnostic, don't transfer it.
let changes: [FixIt.MultiNodeChange] = [
.makeMissing(invalidToken, transferTrivia: false),
.makePresent(missingToken),
]
if let identifier = missingToken.nextToken(viewMode: .all),
identifier.tokenView.rawKind == .identifier,
identifier.isMissing
{
// The extraneous whitespace caused a missing identifier, output a
// diagnostic inserting it instead of a diagnostic to fix the trivia
// around the period.
let fixIt = FixIt(
message: InsertTokenFixIt(missingNodes: [Syntax(identifier)]),
changes: changes + [.makePresent(identifier, trailingTrivia: invalidToken.trailingTrivia)]
)
addDiagnostic(
identifier,
position: invalidToken.endPositionBeforeTrailingTrivia,
MissingNodesError(missingNodes: [Syntax(identifier)]),
fixIts: [fixIt],
handledNodes: [invalidTokenContainer.id, identifier.id]
)
} else {
let fixIt = FixIt(message: .removeExtraneousWhitespace, changes: changes)
addDiagnostic(
invalidToken,
ExtraneousWhitespace(tokenWithWhitespace: invalidToken),
fixIts: [fixIt],
handledNodes: [invalidTokenContainer.id]
)
}
return true
}
private func handleInvalidPoundDelimiter(
invalidToken: TokenSyntax,
missingToken: TokenSyntax,
invalidTokenContainer: UnexpectedNodesSyntax
) -> Bool {
let isTooMany = invalidToken.trimmedLength > missingToken.trimmedLength
let message: DiagnosticMessage
if missingToken.parent?.is(ExpressionSegmentSyntax.self) == true {
message = .tooManyRawStringDelimitersToStartInterpolation
} else {
let parent = missingToken.parent!
precondition(
parent.is(StringLiteralExprSyntax.self) || parent.is(RegexLiteralExprSyntax.self),
"Raw string delimiters should only occur in string interpolation and at the end of a string or regex literal"
)
message = isTooMany ? StaticParserError.tooManyClosingPoundDelimiters : .tooFewClosingPoundDelimiters
}
let fixIt = FixIt(
message: isTooMany ? .removeExtraneousDelimiters : .insertExtraClosingPounds,
changes: [
.makeMissing(invalidToken),
.makePresent(missingToken),
]
)
addDiagnostic(
invalidToken,
position: invalidToken.positionAfterSkippingLeadingTrivia.advanced(by: missingToken.trimmedLength.utf8Length),
message,
fixIts: [fixIt],
handledNodes: [invalidTokenContainer.id]
)
return true
}
}
|
