Skip to content

Improve unexpected tokens diagnostics #2811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2024
Merged

Improve unexpected tokens diagnostics #2811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2c6854
Use `continue` instead of `break` after failing to match a closing de…
mateusrodriguesxyz Aug 19, 2024
b02a7f1
Skip tokens in `canRecoverTo` when a closing delimiter is found at th…
mateusrodriguesxyz Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions Sources/SwiftParser/Recovery.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,33 @@ extension Parser.Lookahead {
if currentTokenPrecedence >= recoveryPrecedence {
break
}
self.consumeAnyToken()
if let closingDelimiter = currentTokenPrecedence.closingTokenKind {
let closingDelimiterSpec = TokenSpec(closingDelimiter)
let canCloseAtSameLine: Int? = self.withLookahead { lookahead in
var tokensToSkip = 0
while !lookahead.at(.endOfFile), !lookahead.currentToken.isAtStartOfLine {
tokensToSkip += 1
if lookahead.at(closingDelimiterSpec) {
return tokensToSkip
} else {
lookahead.consumeAnyToken()
}
}
return nil
}
if let tokensToSkip = canCloseAtSameLine {
for _ in 0..<tokensToSkip {
self.consumeAnyToken()
}
continue
}
self.consumeAnyToken()
guard self.canRecoverTo(closingDelimiterSpec) != nil else {
break
continue
}
self.eat(closingDelimiterSpec)
} else {
self.consumeAnyToken()
}
}

Expand Down
44 changes: 5 additions & 39 deletions Tests/SwiftParserTest/DeclarationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1301,47 +1301,13 @@ final class DeclarationTests: ParserTestCase {
func testExpressionMember() {
assertParse(
"""
struct S 1️⃣{2️⃣
3️⃣/4️⃣ ###line 25 "line-directive.swift"5️⃣
6️⃣}
struct S {
1️⃣/ ###line 25 "line-directive.swift"
}
""",
diagnostics: [
DiagnosticSpec(
locationMarker: "2️⃣",
message: "expected '}' to end struct",
notes: [NoteSpec(locationMarker: "1️⃣", message: "to match this opening '{'")],
fixIts: ["insert '}'"]
),
DiagnosticSpec(
locationMarker: "4️⃣",
message: "bare slash regex literal may not start with space",
fixIts: [
"convert to extended regex literal with '#'",
#"insert '\'"#,
]
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "expected '/' to end regex literal",
notes: [NoteSpec(locationMarker: "3️⃣", message: "to match this opening '/'")],
fixIts: ["insert '/'"]
),
DiagnosticSpec(
locationMarker: "6️⃣",
message: "extraneous brace at top level"
),
],
applyFixIts: [
"insert '}'",
#"insert '\'"#,
"insert '/'",
],
fixedSource: #"""
struct S {
}
/\ ###line 25 "line-directive.swift"/
}
"""#
DiagnosticSpec(message: #"unexpected code '/ ###line 25 "line-directive.swift"' in struct"#)
]
)
}

Expand Down
165 changes: 33 additions & 132 deletions Tests/SwiftParserTest/translated/RecoveryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1838,44 +1838,31 @@ final class RecoveryTests: ParserTestCase {
func testRecovery100() {
assertParse(
"""
struct ErrorInFunctionSignatureResultArrayType1 1️⃣{
func foo() -> Int2️⃣[ {
struct ErrorInFunctionSignatureResultArrayType1 {
func foo() -> Int1️⃣[ {
return [0]
}3️⃣
func bar() -> Int4️⃣] {
}
func bar() -> Int2️⃣] {
return [0]
}
5️⃣}
}
""",
diagnostics: [
DiagnosticSpec(
locationMarker: "2️⃣",
message: "expected '}' to end struct",
notes: [NoteSpec(locationMarker: "1️⃣", message: "to match this opening '{'")],
fixIts: ["insert '}'"]
),
DiagnosticSpec(
locationMarker: "3️⃣",
message: "expected ']' to end array",
notes: [NoteSpec(locationMarker: "2️⃣", message: "to match this opening '['")],
fixIts: ["insert ']'"]
locationMarker: "1️⃣",
message: "unexpected code '[' in function"
),
DiagnosticSpec(
locationMarker: "4️⃣",
locationMarker: "2️⃣",
message: "unexpected ']' in type; did you mean to write an array type?",
fixIts: ["insert '['"]
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "extraneous brace at top level"
),
],
fixedSource: """
struct ErrorInFunctionSignatureResultArrayType1 {
func foo() -> Int
}[ {
func foo() -> Int[ {
return [0]
}]
}
func bar() -> [Int] {
return [0]
}
Expand All @@ -1887,45 +1874,15 @@ final class RecoveryTests: ParserTestCase {
func testRecovery101() {
assertParse(
"""
struct ErrorInFunctionSignatureResultArrayType2 1️⃣{
func foo() -> Int2️⃣[03️⃣ {
struct ErrorInFunctionSignatureResultArrayType2 {
func foo() -> Int1️⃣[0 {
return [0]
}4️⃣
5️⃣}
}
}
""",
diagnostics: [
// TODO: Old parser expected error to add `]` on line 2, but we should just recover to
// `{` with `[0` becoming unexpected.
DiagnosticSpec(
locationMarker: "2️⃣",
message: "expected '}' to end struct",
notes: [NoteSpec(locationMarker: "1️⃣", message: "to match this opening '{'")],
fixIts: ["insert '}'"]
),
DiagnosticSpec(
locationMarker: "3️⃣",
message: "expected ',' in array element",
fixIts: ["insert ','"]
),
DiagnosticSpec(
locationMarker: "4️⃣",
message: "expected ']' to end array",
notes: [NoteSpec(locationMarker: "2️⃣", message: "to match this opening '['")],
fixIts: ["insert ']'"]
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "extraneous brace at top level"
),
],
fixedSource: """
struct ErrorInFunctionSignatureResultArrayType2 {
func foo() -> Int
}[0, {
return [0]
}]
}
"""
DiagnosticSpec(message: "unexpected code '[0' in function")
]
)
}

Expand Down Expand Up @@ -1977,37 +1934,14 @@ final class RecoveryTests: ParserTestCase {
func testRecovery105() {
assertParse(
"""
struct ErrorInFunctionSignatureResultArrayType11 ℹ️{
func foo() -> Int1️⃣[(a){a++}]2️⃣ {
struct ErrorInFunctionSignatureResultArrayType11 {
func foo() -> Int1️⃣[(a){a++}] {
}
3️⃣}
}
""",
diagnostics: [
// TODO: We should just recover to `{` with `[(a){a++}]` becoming unexpected.
DiagnosticSpec(
locationMarker: "1️⃣",
message: "expected '}' to end struct",
notes: [NoteSpec(message: "to match this opening '{'")],
fixIts: ["insert '}'"]
),
DiagnosticSpec(
locationMarker: "2️⃣",
message: "consecutive statements on a line must be separated by newline or ';'",
fixIts: ["insert newline", "insert ';'"]
),
DiagnosticSpec(
locationMarker: "3️⃣",
message: "extraneous brace at top level"
),
],
fixedSource: """
struct ErrorInFunctionSignatureResultArrayType11 {
func foo() -> Int
}[(a){a++}]
{
}
}
"""
DiagnosticSpec(message: "unexpected code '[(a){a++}]' in function")
]
)
}

Expand Down Expand Up @@ -2513,50 +2447,32 @@ final class RecoveryTests: ParserTestCase {
assertParse(
"""
#if true
struct Foo19605164 1️⃣{
func a2️⃣(s: S3️⃣[{{g4️⃣) -> Int {}
}}5️⃣}
struct Foo19605164 {
func a1️⃣(s: S2️⃣3️⃣[{{g4️⃣) -> Int {}
}}}
#endif
""",
diagnostics: [
DiagnosticSpec(
locationMarker: "3️⃣",
locationMarker: "2️⃣",
message: "expected ')' to end parameter clause",
notes: [NoteSpec(locationMarker: "2️⃣", message: "to match this opening '('")],
notes: [NoteSpec(locationMarker: "1️⃣", message: "to match this opening '('")],
fixIts: ["insert ')'"]
),
DiagnosticSpec(
locationMarker: "3️⃣",
message: "expected '}' to end struct",
notes: [NoteSpec(locationMarker: "1️⃣", message: "to match this opening '{'")],
fixIts: ["insert '}'"]
message: "unexpected code '[' in function"
),
DiagnosticSpec(
locationMarker: "4️⃣",
message: "unexpected code ') -> Int {}' in closure"
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "expected ',' in array element",
fixIts: ["insert ','"]
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "expected ']' to end array",
notes: [NoteSpec(locationMarker: "3️⃣", message: "to match this opening '['")],
fixIts: ["insert ']'"]
),
DiagnosticSpec(
locationMarker: "5️⃣",
message: "unexpected brace in conditional compilation block"
),
],
fixedSource: """
#if true
struct Foo19605164 {
func a(s: S)
}[{{g) -> Int {}
}},]}
func a(s: S) [{{g) -> Int {}
}}}
#endif
"""
)
Expand Down Expand Up @@ -3211,28 +3127,13 @@ final class RecoveryTests: ParserTestCase {
func testRecovery179() {
assertParse(
"""
func testSkipUnbalancedParen() ℹ️{1️⃣
2️⃣?(
func testSkipUnbalancedParen() {
1️⃣?(
}
""",
diagnostics: [
DiagnosticSpec(
locationMarker: "1️⃣",
message: "expected '}' to end function",
notes: [NoteSpec(message: "to match this opening '{'")],
fixIts: ["insert '}'"]
),
DiagnosticSpec(
locationMarker: "2️⃣",
message: "extraneous code at top level"
),
],
fixedSource: """
func testSkipUnbalancedParen() {
}
?(
}
"""
DiagnosticSpec(message: "unexpected code '?(' in function")
]
)
}

Expand Down