Skip to content

Commit 40c91b1

Browse files
author
Nathan Hawes
committed
[syntax-coloring] Highlight unterminated regular and multi-line strings as strings
Also add tests for syntax map deltas when editing multi-line strings
1 parent ffaf8d5 commit 40c91b1

File tree

5 files changed

+218
-0
lines changed

5 files changed

+218
-0
lines changed

‎lib/IDE/SyntaxModel.cpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,15 @@ SyntaxModelContext::SyntaxModelContext(SourceFile &SrcFile)
206206
break;
207207
}
208208

209+
case tok::unknown: {
210+
if (Tok.getRawText().startswith("\"")) {
211+
// This is an invalid string literal
212+
Kind = SyntaxNodeKind::String;
213+
break;
214+
}
215+
continue;
216+
}
217+
209218
default:
210219
continue;
211220
}

‎test/IDE/coloring.swift

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,15 @@ func f(x: Int) -> Int {
227227
// CHECK: <str>"This is string </str>\<anchor>(</anchor>genFn({(a:<type>Int</type> -> <type>Int</type>) <kw>in</kw> a})<anchor>)</anchor><str> interpolation"</str>
228228
"This is string \(genFn({(a:Int -> Int) in a})) interpolation"
229229

230+
// CHECK: <str>"This is unterminated</str>
231+
"This is unterminated
232+
233+
// CHECK: <str>"This is unterminated with ignored \(interpolation) in it</str>
234+
"This is unterminated with ignored \(interpolation) in it
235+
236+
// CHECK: <str>"This is terminated with invalid \(interpolation" + "in it"</str>
237+
"This is terminated with invalid \(interpolation" + "in it"
238+
230239
// CHECK: <str>"""
231240
// CHECK-NEXT: This is a multiline string.
232241
// CHECK-NEXT: """</str>
@@ -236,9 +245,19 @@ func f(x: Int) -> Int {
236245

237246
// CHECK: <str>"""
238247
// CHECK-NEXT: This is a multiline</str>\<anchor>(</anchor> <str>"interpolated"</str> <anchor>)</anchor><str>string
248+
// CHECK-NEXT: </str>\<anchor>(</anchor>
249+
// CHECK-NEXT: <str>"""
250+
// CHECK-NEXT: inner
251+
// CHECK-NEXT: """</str>
252+
// CHECK-NEXT: <anchor>)</anchor><str>
239253
// CHECK-NEXT: """</str>
240254
"""
241255
This is a multiline\( "interpolated" )string
256+
\(
257+
"""
258+
inner
259+
"""
260+
)
242261
"""
243262
}
244263

‎test/IDE/unterminated_multiline.swift

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// RUN: %target-swift-ide-test -syntax-coloring -source-filename %s | %FileCheck %s
2+
// RUN: %target-swift-ide-test -syntax-coloring -typecheck -source-filename %s | %FileCheck %s
3+
4+
// CHECK: <kw>let</kw> x = <str>"""
5+
// CHECK-NEXT: This is an unterminated
6+
// CHECK-NEXT: \( "multiline" )
7+
// CHECK-NEXT: string followed by code
8+
// CHECK-NEXT: ""
9+
// CHECK-NEXT: func foo() {}
10+
// CHECK-NEXT: </str>
11+
let x = """
12+
This is an unterminated
13+
\( "multiline" )
14+
string followed by code
15+
""
16+
func foo() {}

‎test/SourceKit/SyntaxMapData/Inputs/syntaxmap-edit-multiline-string.swift

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
let a = "value"
2+
let x = """
3+
4+
\(
5+
a
6+
)
7+
8+
9+
10+
func foo () -> String {
11+
return "foo"
12+
}

‎test/SourceKit/SyntaxMapData/syntaxmap-edit-multiline-string.swift

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
// RUN: %sourcekitd-test -req=open -print-raw-response %S/Inputs/syntaxmap-edit-multiline-string.swift == -req=edit -print-raw-response %S/Inputs/syntaxmap-edit-multiline-string.swift -pos=8:1 -replace='"""' -length=3 == -req=edit -print-raw-response %S/Inputs/syntaxmap-edit-multiline-string.swift -pos=6:2 -replace=')' -length=1 == -req=edit -print-raw-response %S/Inputs/syntaxmap-edit-multiline-string.swift -pos=2:10 -replace=' ' -length=1 | %sed_clean > %t.response
2+
// RUN: %FileCheck -input-file=%t.response %s
3+
4+
// Original file contents
5+
6+
// CHECK: {{^}}{
7+
// CHECK-NEXT: key.offset: 0,
8+
// CHECK-NEXT: key.length: 84,
9+
// CHECK-NEXT: key.diagnostic_stage: source.diagnostic.stage.swift.parse,
10+
// CHECK-NEXT: key.syntaxmap: [
11+
// CHECK-NEXT: {
12+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
13+
// CHECK-NEXT: key.offset: 0,
14+
// CHECK-NEXT: key.length: 3
15+
// CHECK-NEXT: },
16+
// CHECK-NEXT: {
17+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
18+
// CHECK-NEXT: key.offset: 4,
19+
// CHECK-NEXT: key.length: 1
20+
// CHECK-NEXT: },
21+
// CHECK-NEXT: {
22+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
23+
// CHECK-NEXT: key.offset: 8,
24+
// CHECK-NEXT: key.length: 7
25+
// CHECK-NEXT: },
26+
// CHECK-NEXT: {
27+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
28+
// CHECK-NEXT: key.offset: 16,
29+
// CHECK-NEXT: key.length: 3
30+
// CHECK-NEXT: },
31+
// CHECK-NEXT: {
32+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
33+
// CHECK-NEXT: key.offset: 20,
34+
// CHECK-NEXT: key.length: 1
35+
// CHECK-NEXT: },
36+
// CHECK-NEXT: {
37+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
38+
// CHECK-NEXT: key.offset: 24,
39+
// CHECK-NEXT: key.length: 60
40+
// CHECK-NEXT: }
41+
// CHECK-NEXT: ],
42+
43+
// After terminating the multiline string
44+
45+
// CHECK: {{^}}{
46+
// CHECK-NEXT: key.offset: 16,
47+
// CHECK-NEXT: key.length: 66,
48+
// CHECK-NEXT: key.diagnostic_stage: source.diagnostic.stage.swift.parse,
49+
// CHECK-NEXT: key.syntaxmap: [
50+
// CHECK-NEXT: {
51+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
52+
// CHECK-NEXT: key.offset: 16,
53+
// CHECK-NEXT: key.length: 3
54+
// CHECK-NEXT: },
55+
// CHECK-NEXT: {
56+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
57+
// CHECK-NEXT: key.offset: 20,
58+
// CHECK-NEXT: key.length: 1
59+
// CHECK-NEXT: },
60+
// CHECK-NEXT: {
61+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
62+
// CHECK-NEXT: key.offset: 24,
63+
// CHECK-NEXT: key.length: 5
64+
// CHECK-NEXT: },
65+
// CHECK-NEXT: {
66+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string_interpolation_anchor,
67+
// CHECK-NEXT: key.offset: 30,
68+
// CHECK-NEXT: key.length: 1
69+
// CHECK-NEXT: },
70+
// CHECK-NEXT: {
71+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
72+
// CHECK-NEXT: key.offset: 32,
73+
// CHECK-NEXT: key.length: 1
74+
// CHECK-NEXT: },
75+
// CHECK-NEXT: {
76+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string_interpolation_anchor,
77+
// CHECK-NEXT: key.offset: 34,
78+
// CHECK-NEXT: key.length: 1
79+
// CHECK-NEXT: },
80+
// CHECK-NEXT: {
81+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
82+
// CHECK-NEXT: key.offset: 35,
83+
// CHECK-NEXT: key.length: 6
84+
// CHECK-NEXT: },
85+
// CHECK-NEXT: {
86+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
87+
// CHECK-NEXT: key.offset: 43,
88+
// CHECK-NEXT: key.length: 4
89+
// CHECK-NEXT: },
90+
// CHECK-NEXT: {
91+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
92+
// CHECK-NEXT: key.offset: 48,
93+
// CHECK-NEXT: key.length: 3
94+
// CHECK-NEXT: },
95+
// CHECK-NEXT: {
96+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.typeidentifier,
97+
// CHECK-NEXT: key.offset: 58,
98+
// CHECK-NEXT: key.length: 6
99+
// CHECK-NEXT: },
100+
// CHECK-NEXT: {
101+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
102+
// CHECK-NEXT: key.offset: 69,
103+
// CHECK-NEXT: key.length: 6
104+
// CHECK-NEXT: },
105+
// CHECK-NEXT: {
106+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
107+
// CHECK-NEXT: key.offset: 76,
108+
// CHECK-NEXT: key.length: 5
109+
// CHECK-NEXT: }
110+
// CHECK-NEXT: ],
111+
112+
// After adding a character after the interpolation
113+
// CHECK: {{^}}{
114+
// CHECK-NEXT: key.offset: 34,
115+
// CHECK-NEXT: key.length: 8,
116+
// CHECK-NEXT: key.diagnostic_stage: source.diagnostic.stage.swift.parse,
117+
// CHECK-NEXT: key.syntaxmap: [
118+
// CHECK-NEXT: {
119+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string_interpolation_anchor,
120+
// CHECK-NEXT: key.offset: 34,
121+
// CHECK-NEXT: key.length: 1
122+
// CHECK-NEXT: },
123+
// CHECK-NEXT: {
124+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
125+
// CHECK-NEXT: key.offset: 35,
126+
// CHECK-NEXT: key.length: 6
127+
// CHECK-NEXT: }
128+
// CHECK-NEXT: ],
129+
130+
// After replacing the middle opening quote with a space
131+
132+
// CHECK: {{^}}{
133+
// CHECK-NEXT: key.offset: 16,
134+
// CHECK-NEXT: key.length: 68,
135+
// CHECK-NEXT: key.diagnostic_stage: source.diagnostic.stage.swift.parse,
136+
// CHECK-NEXT: key.syntaxmap: [
137+
// CHECK-NEXT: {
138+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.keyword,
139+
// CHECK-NEXT: key.offset: 16,
140+
// CHECK-NEXT: key.length: 3
141+
// CHECK-NEXT: },
142+
// CHECK-NEXT: {
143+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
144+
// CHECK-NEXT: key.offset: 20,
145+
// CHECK-NEXT: key.length: 1
146+
// CHECK-NEXT: },
147+
// CHECK-NEXT: {
148+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
149+
// CHECK-NEXT: key.offset: 24,
150+
// CHECK-NEXT: key.length: 3
151+
// CHECK-NEXT: },
152+
// CHECK-NEXT: {
153+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.identifier,
154+
// CHECK-NEXT: key.offset: 32,
155+
// CHECK-NEXT: key.length: 1
156+
// CHECK-NEXT: },
157+
// CHECK-NEXT: {
158+
// CHECK-NEXT: key.kind: source.lang.swift.syntaxtype.string,
159+
// CHECK-NEXT: key.offset: 38,
160+
// CHECK-NEXT: key.length: 46
161+
// CHECK-NEXT: }
162+
// CHECK-NEXT: ],

0 commit comments

Comments
 (0)