Skip to content

Commit b296d41

Browse files
AnthonyLatsisAnthonyLatsis
authored
Merge pull request #41429 from AnthonyLatsis/fixit-line-offsets
DiagnosticVerifier: Support line offsets in fix-it verification ranges
2 parents 4a67288 + 2128678 commit b296d41

File tree

3 files changed

+264
-64
lines changed

3 files changed

+264
-64
lines changed

‎lib/Frontend/DiagnosticVerifier.cpp‎

Lines changed: 123 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,113 @@ DiagnosticVerifier::renderFixits(ArrayRef<CapturedFixItInfo> ActualFixIts,
339339
return OS.str();
340340
}
341341

342+
/// Parse the introductory line-column range of an expected fix-it by consuming
343+
/// the given input string. The range format is \c ([+-]?N:)?N-([+-]?N:)?N
344+
/// where \c 'N' is \c [0-9]+.
345+
///
346+
/// \param DiagnosticLineNo The line number of the associated expected
347+
/// diagnostic; used to turn line offsets into line numbers.
348+
static Optional<LineColumnRange> parseExpectedFixItRange(
349+
StringRef &Str, unsigned DiagnosticLineNo,
350+
llvm::function_ref<void(const char *, const Twine &)> diagnoseError) {
351+
assert(!Str.empty());
352+
353+
const auto parseLineAndColumn =
354+
[&]() -> Optional<std::pair<unsigned, unsigned>> {
355+
enum class LineOffsetKind : uint8_t { None, Plus, Minus };
356+
357+
LineOffsetKind lineOffsetKind = LineOffsetKind::None;
358+
if (!Str.empty()) {
359+
switch (Str.front()) {
360+
case '+':
361+
lineOffsetKind = LineOffsetKind::Plus;
362+
Str = Str.drop_front();
363+
break;
364+
case '-':
365+
lineOffsetKind = LineOffsetKind::Minus;
366+
Str = Str.drop_front();
367+
break;
368+
default:
369+
break;
370+
}
371+
}
372+
373+
unsigned firstNumber = LineColumnRange::NoValue;
374+
if (Str.consumeInteger(10, firstNumber)) {
375+
if (lineOffsetKind > LineOffsetKind::None) {
376+
diagnoseError(Str.data(),
377+
"expected line offset after leading '+' or '-' in fix-it "
378+
"verification");
379+
} else {
380+
diagnoseError(Str.data(),
381+
"expected line or column number in fix-it verification");
382+
}
383+
return None;
384+
}
385+
386+
unsigned secondNumber = LineColumnRange::NoValue;
387+
if (!Str.empty() && Str.front() == ':') {
388+
Str = Str.drop_front();
389+
390+
if (Str.consumeInteger(10, secondNumber)) {
391+
diagnoseError(
392+
Str.data(),
393+
"expected column number after ':' in fix-it verification");
394+
return None;
395+
}
396+
} else if (lineOffsetKind > LineOffsetKind::None) {
397+
diagnoseError(Str.data(),
398+
"expected colon-separated column number after line offset "
399+
"in fix-it verification");
400+
return None;
401+
}
402+
403+
if (secondNumber == LineColumnRange::NoValue) {
404+
// If only one value is specified, it's a column number;
405+
return std::make_pair(LineColumnRange::NoValue, firstNumber);
406+
}
407+
408+
unsigned lineNo = DiagnosticLineNo;
409+
switch (lineOffsetKind) {
410+
case LineOffsetKind::None:
411+
lineNo = firstNumber;
412+
break;
413+
case LineOffsetKind::Plus:
414+
lineNo += firstNumber;
415+
break;
416+
case LineOffsetKind::Minus:
417+
lineNo -= firstNumber;
418+
break;
419+
}
420+
421+
return std::make_pair(lineNo, secondNumber);
422+
};
423+
424+
LineColumnRange Range;
425+
426+
if (const auto lineAndCol = parseLineAndColumn()) {
427+
std::tie(Range.StartLine, Range.StartCol) = lineAndCol.getValue();
428+
} else {
429+
return None;
430+
}
431+
432+
if (!Str.empty() && Str.front() == '-') {
433+
Str = Str.drop_front();
434+
} else {
435+
diagnoseError(Str.data(),
436+
"expected '-' range separator in fix-it verification");
437+
return None;
438+
}
439+
440+
if (const auto lineAndCol = parseLineAndColumn()) {
441+
std::tie(Range.EndLine, Range.EndCol) = lineAndCol.getValue();
442+
} else {
443+
return None;
444+
}
445+
446+
return Range;
447+
}
448+
342449
/// After the file has been processed, check to see if we got all of
343450
/// the expected diagnostics and check to see if there were any unexpected
344451
/// ones.
@@ -574,69 +681,35 @@ DiagnosticVerifier::Result DiagnosticVerifier::verifyFile(unsigned BufferID) {
574681
break;
575682
}
576683

577-
// Parse the pieces of the fix-it: (L:)?C-(L:)?C=text
578-
const size_t MinusLoc = CheckStr.find('-');
579-
if (MinusLoc == StringRef::npos) {
580-
addError(CheckStr.data(), "expected '-' in fix-it verification");
581-
continue;
582-
}
583-
584-
const size_t EqualLoc = CheckStr.find('=', /*From=*/MinusLoc + 1);
585-
if (EqualLoc == StringRef::npos) {
586-
addError(CheckStr.data(),
587-
"expected '=' after '-' in fix-it verification");
684+
if (CheckStr.empty()) {
685+
addError(CheckStr.data(), Twine("expected fix-it verification within "
686+
"braces; example: '1-2=text' or '") +
687+
fixitExpectationNoneString + Twine("'"));
588688
continue;
589689
}
590690

591-
const size_t FirstColonLoc = CheckStr.take_front(MinusLoc).find(':');
592-
const size_t SecondColonLoc =
593-
CheckStr.take_front(EqualLoc).find(':', /*From=*/MinusLoc + 1);
594-
691+
// Parse the pieces of the fix-it.
595692
ExpectedFixIt FixIt;
596693
FixIt.StartLoc = OpenLoc;
597694
FixIt.EndLoc = CloseLoc;
598-
if (FirstColonLoc != StringRef::npos) {
599-
const StringRef StartLineStr = CheckStr.take_front(FirstColonLoc);
600-
if (StartLineStr.getAsInteger(10, FixIt.Range.StartLine)) {
601-
addError(StartLineStr.data(),
602-
"invalid line number in fix-it verification");
603-
continue;
604-
}
605-
}
606695

607-
const StringRef StartColStr =
608-
(FirstColonLoc != StringRef::npos)
609-
? CheckStr.slice(FirstColonLoc + 1, MinusLoc)
610-
: CheckStr.take_front(MinusLoc);
611-
if (StartColStr.getAsInteger(10, FixIt.Range.StartCol)) {
612-
addError(StartColStr.data(),
613-
"invalid column number in fix-it verification");
696+
if (const auto range =
697+
parseExpectedFixItRange(CheckStr, Expected.LineNo, addError)) {
698+
FixIt.Range = range.getValue();
699+
} else {
614700
continue;
615701
}
616702

617-
if (SecondColonLoc != StringRef::npos) {
618-
const StringRef EndLineStr =
619-
CheckStr.slice(MinusLoc + 1, SecondColonLoc);
620-
if (EndLineStr.getAsInteger(10, FixIt.Range.EndLine)) {
621-
addError(EndLineStr.data(),
622-
"invalid line number in fix-it verification");
623-
continue;
624-
}
625-
}
626-
627-
const StringRef EndColStr =
628-
(SecondColonLoc != StringRef::npos)
629-
? CheckStr.slice(SecondColonLoc + 1, EqualLoc)
630-
: CheckStr.slice(MinusLoc + 1, EqualLoc);
631-
if (EndColStr.getAsInteger(10, FixIt.Range.EndCol)) {
632-
addError(EndColStr.data(),
633-
"invalid column number in fix-it verification");
703+
if (!CheckStr.empty() && CheckStr.front() == '=') {
704+
CheckStr = CheckStr.drop_front();
705+
} else {
706+
addError(CheckStr.data(),
707+
"expected '=' after range in fix-it verification");
634708
continue;
635709
}
636-
710+
637711
// Translate literal "\\n" into '\n', inefficiently.
638-
const StringRef fixItText = CheckStr.substr(EqualLoc + 1);
639-
for (const char *current = fixItText.begin(), *end = fixItText.end();
712+
for (const char *current = CheckStr.begin(), *end = CheckStr.end();
640713
current != end; /* in loop */) {
641714
if (*current == '\\' && current + 1 < end) {
642715
if (current[1] == 'n') {

‎test/Frontend/verify-fixits.swift‎

Lines changed: 133 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,129 @@ func testNoneMarkerCheck() {
1515
func test0Fixits() {
1616
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}}
1717

18+
// CHECK: [[@LINE+1]]:80: error: expected fix-it verification within braces; example: '1-2=text' or 'none'
19+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{}}
20+
21+
// CHECK: [[@LINE+1]]:81: error: expected line offset after leading '+' or '-' in fix-it verification
22+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+}}
23+
24+
// CHECK: [[@LINE+1]]:81: error: expected line offset after leading '+' or '-' in fix-it verification
25+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{-}}
26+
27+
// CHECK: [[@LINE+1]]:81: error: expected '-' range separator in fix-it verification
28+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1}}
29+
30+
// CHECK: [[@LINE+1]]:82: error: expected colon-separated column number after line offset in fix-it verification
31+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{-1}}
32+
33+
// CHECK: [[@LINE+1]]:82: error: expected colon-separated column number after line offset in fix-it verification
34+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1}}
35+
36+
// CHECK: [[@LINE+1]]:82: error: expected column number after ':' in fix-it verification
37+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:}}
38+
39+
// CHECK: [[@LINE+1]]:83: error: expected column number after ':' in fix-it verification
40+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:}}
41+
42+
// CHECK: [[@LINE+1]]:83: error: expected '-' range separator in fix-it verification
43+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1}}
44+
45+
// CHECK: [[@LINE+1]]:84: error: expected '-' range separator in fix-it verification
46+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{-1:1}}
47+
48+
// CHECK: [[@LINE+1]]:83: error: expected column number after ':' in fix-it verification
49+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:-1}}
50+
51+
// CHECK: [[@LINE+1]]:82: error: expected line or column number in fix-it verification
52+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-}}
53+
54+
// CHECK: [[@LINE+1]]:84: error: expected line or column number in fix-it verification
55+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-}}
56+
57+
// CHECK: [[@LINE+1]]:85: error: expected line or column number in fix-it verification
58+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{-1:1-}}
59+
60+
// CHECK: [[@LINE+1]]:83: error: expected line offset after leading '+' or '-' in fix-it verification
61+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1--}}
62+
63+
// CHECK: [[@LINE+1]]:83: error: expected '=' after range in fix-it verification
64+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1}}
65+
66+
// CHECK: [[@LINE+1]]:85: error: expected '=' after range in fix-it verification
67+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-1}}
68+
69+
// CHECK: [[@LINE+1]]:86: error: expected '=' after range in fix-it verification
70+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:1-1}}
71+
72+
// CHECK: [[@LINE+1]]:83: error: expected line offset after leading '+' or '-' in fix-it verification
73+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1--:}}
74+
75+
// CHECK: [[@LINE+1]]:84: error: expected column number after ':' in fix-it verification
76+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1:}}
77+
78+
// CHECK: [[@LINE+1]]:86: error: expected column number after ':' in fix-it verification
79+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-1:}}
80+
81+
// CHECK: [[@LINE+1]]:87: error: expected column number after ':' in fix-it verification
82+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:1-1:}}
83+
84+
// CHECK: [[@LINE+1]]:85: error: expected '=' after range in fix-it verification
85+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1:1}}
86+
87+
// CHECK: [[@LINE+1]]:86: error: expected '=' after range in fix-it verification
88+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-+1:1}}
89+
90+
// CHECK: [[@LINE+1]]:87: error: expected '=' after range in fix-it verification
91+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-1:1}}
92+
93+
// CHECK: [[@LINE+1]]:89: error: expected '=' after range in fix-it verification
94+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:1--1:1}}
95+
96+
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
97+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1=}}
98+
1899
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
19100
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1=a}}
20101

21-
// CHECK: [[@LINE+1]]:80: error: invalid column number in fix-it verification
102+
// CHECK: [[@LINE+1]]:80: error: expected line or column number in fix-it verification
22103
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{x-1=a}}
23104

24-
// CHECK: [[@LINE+1]]:82: error: invalid column number in fix-it verification
105+
// CHECK: [[@LINE+1]]:82: error: expected line or column number in fix-it verification
25106
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-x=a}}
26107

27-
// CHECK: [[@LINE+1]]:82: error: invalid column number in fix-it verification
108+
// CHECK: [[@LINE+1]]:82: error: expected column number after ':' in fix-it verification
28109
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:x-1=a}}
29110

30-
// CHECK: [[@LINE+1]]:80: error: invalid line number in fix-it verification
111+
// CHECK: [[@LINE+1]]:80: error: expected line or column number in fix-it verification
31112
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{x:1-1=a}}
32113

33-
// CHECK: [[@LINE+1]]:84: error: invalid column number in fix-it verification
114+
// CHECK: [[@LINE+1]]:81: error: expected line offset after leading '+' or '-' in fix-it verification
115+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+x:1-1=a}}
116+
117+
// CHECK: [[@LINE+1]]:84: error: expected column number after ':' in fix-it verification
34118
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1:x=a}}
35119

36-
// CHECK: [[@LINE+1]]:82: error: invalid line number in fix-it verification
120+
// CHECK: [[@LINE+1]]:82: error: expected line or column number in fix-it verification
37121
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-x:1=a}}
38122

39-
// CHECK: [[@LINE+1]]:82: error: invalid column number in fix-it verification
123+
// CHECK: [[@LINE+1]]:83: error: expected line offset after leading '+' or '-' in fix-it verification
124+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-+x:1=a}}
125+
126+
// CHECK: [[@LINE+1]]:82: error: expected column number after ':' in fix-it verification
40127
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:x-1:x=a}}
41128

42-
// CHECK: [[@LINE+1]]:80: error: invalid line number in fix-it verification
129+
// CHECK: [[@LINE+1]]:80: error: expected line or column number in fix-it verification
43130
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{x:1-1:x=a}}
44131

45-
// CHECK: [[@LINE+1]]:82: error: invalid column number in fix-it verification
132+
// CHECK: [[@LINE+1]]:81: error: expected line offset after leading '+' or '-' in fix-it verification
133+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+x:1-1:x=a}}
134+
135+
// CHECK: [[@LINE+1]]:82: error: expected column number after ':' in fix-it verification
46136
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:x-x:1=a}}
47137

138+
// CHECK: [[@LINE+1]]:82: error: expected column number after ':' in fix-it verification
139+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:x--x:1=a}}
140+
48141
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
49142
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-1:1=a}}
50143

@@ -54,6 +147,15 @@ func test0Fixits() {
54147
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
55148
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1:1-1=a}}
56149

150+
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
151+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{-1:1-1=a}}
152+
153+
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
154+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-+1:1=a}}
155+
156+
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
157+
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{+1:1-+1:1=a}}
158+
57159
// CHECK: [[@LINE+1]]:78: error: expected fix-it not seen
58160
undefinedFunc() // expected-error {{cannot find 'undefinedFunc' in scope}} {{1-1=a}} {{2-2=b}}
59161

@@ -95,13 +197,32 @@ func test1Fixits() {
95197
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{15-18=xx}} {{15-18=aa}} {{none}}
96198

97199
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
98-
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{98:15-98:18=aa}}
200+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{200:15-200:18=aa}}
201+
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
202+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{202:15-18=aa}}
203+
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
204+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{15-204:18=aa}}
205+
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
206+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{-0:15-+0:18=aa}}
207+
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
208+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{15--0:18=aa}}
99209
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
100-
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{100:15-18=aa}}
210+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {+0:15-210:18=aa}}
101211
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
102-
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{15-102:18=aa}}
212+
labeledFunc(aa: 0, // expected-error {{incorrect argument label in call (have 'aa:bbx:', expected 'aa:bb:')}} {{+1:15-+1:18=bb}}
213+
bbx: 1)
214+
// CHECK-NOT: [[@LINE+1]]:{{[0-9]+}}: error:
215+
labeledFunc(aa: 0, // expected-error {{incorrect argument label in call (have 'aa:bbx:', expected 'aa:bb:')}} {{216:15-+1:18=bb}}
216+
bbx: 1)
217+
103218
// CHECK: [[@LINE+1]]:121: error: expected fix-it not seen; actual fix-it seen: {{{{}}15-18=aa}}
104219
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{61:15-18=aa}}
220+
// CHECK: [[@LINE+1]]:121: error: expected fix-it not seen; actual fix-it seen: {{{{}}15-18=aa}}
221+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{-1:15-18=aa}}
222+
// CHECK: [[@LINE+1]]:121: error: expected fix-it not seen; actual fix-it seen: {{{{}}15-18=aa}}
223+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{+0:15--1:18=aa}}
224+
// CHECK: [[@LINE+1]]:121: error: expected fix-it not seen; actual fix-it seen: {{{{}}15-18=aa}}
225+
labeledFunc(aax: 0, bb: 1) // expected-error {{incorrect argument label in call (have 'aax:bb:', expected 'aa:bb:')}} {{61:15-+1:18=aa}}
105226
}
106227

107228
func test2Fixits() {

0 commit comments

Comments
 (0)