This is an archive of the discontinued LLVM Phabricator instance.

Differential D65702

[FileCheck] Move -dump-input diagnostic to first line
ClosedPublic

Authored by jdenny on Aug 3 2019, 1:00 PM.

Details

Reviewers
probinson
thopre
Commits
rG608f2bfd65ec: [FileCheck] Move -dump-input diagnostic to first line
rL368786: [FileCheck] Move -dump-input diagnostic to first line
Summary

Without this patch, -dump-input prints a diagnostic at the end of
its marker range. For example:

         1: Start.
check:1     ^~~~~~
         2: Bad.
next:2      X~~~
         3: Many lines
next:2      ~~~~~~~~~~
         4: of input.
next:2      ~~~~~~~~~
         5: End.
next:2      ~~~~ error: no match found

This patch moves it to the beginning like this:

         1: Start.
check:1     ^~~~~~
         2: Bad.
next:2      X~~~ error: no match found
         3: Many lines
next:2      ~~~~~~~~~~
         4: of input.
next:2      ~~~~~~~~~
         5: End.
next:2      ~~~~

The former somehow looks nicer because the diagnostic doesn't appear
to be somewhere within the marker range. However, the latter is more
practical, especially when the marker range includes the remainder of
a very long dump. First, in the case of an error, this patch enables
me to search the dump for error: and usually immediately land where
the detected error began. Second, when trying to follow FileCheck's
logic, it's best to read top down, so this patch enables me to see
each diagnostic as soon as I encounter its marker.

Diff Detail

Repository
rL LLVM

Event Timeline

jdenny created this revision.Aug 3 2019, 1:00 PM
Herald added a project: Restricted Project. · View Herald TranscriptAug 3 2019, 1:00 PM
thopre added a comment.Aug 5 2019, 8:15 AM

Does this work for multiline annotations? If I read this correctly (I often don't so my apologies if that's the case) it will print the marker for each line in a multiline annotation except the last.

jdenny added a comment.Aug 5 2019, 8:27 AM
In D65702#1614906, @thopre wrote:

Does this work for multiline annotations? If I read this correctly (I often don't so my apologies if that's the case) it will print the marker for each line in a multiline annotation except the last.

It works correctly for the multi-line annotations I've tested: it prints the note (like error: no match found) only for the first line. See the test suite changes and the summary for examples. Does that help? Thanks for reviewing.

thopre accepted this revision.Aug 6 2019, 1:25 AM
In D65702#1614927, @jdenny wrote:
In D65702#1614906, @thopre wrote:

Does this work for multiline annotations? If I read this correctly (I often don't so my apologies if that's the case) it will print the marker for each line in a multiline annotation except the last.

It works correctly for the multi-line annotations I've tested: it prints the note (like error: no match found) only for the first line. See the test suite changes and the summary for examples. Does that help? Thanks for reviewing.

Ah my bad I think I understand it now. The first line is dealt with outside the loop by the Annotations.push_back(A) which will print a note. The other lines, dealt in the loop, get an empty note and thus nothing besides the markers. LGTM then.

This revision is now accepted and ready to land.Aug 6 2019, 1:25 AM
Closed by commit rL368786: [FileCheck] Move -dump-input diagnostic to first line (authored by jdenny). · Explain WhyAug 13 2019, 7:55 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
trunk/
test/
FileCheck/
16 lines
utils/
FileCheck/
16 lines

Diff 215019

llvm/trunk/test/FileCheck/dump-input-annotations.txt

Show All 21 Lines
; Verbose diagnostics are suppressed but not errors. ; Verbose diagnostics are suppressed but not errors.
; ALIGN:{{.*}}error:{{.*}} ; ALIGN:{{.*}}error:{{.*}}
; ALIGN:{{.*}}possible intended match here{{.*}} ; ALIGN:{{.*}}possible intended match here{{.*}}
; ALIGN:Full input was: ; ALIGN:Full input was:
; ALIGN-NEXT:<<<<<< ; ALIGN-NEXT:<<<<<<
; ALIGN-NEXT: 1: hello world ; ALIGN-NEXT: 1: hello world
; ALIGN-NEXT:check:1 ^~~~~ ; ALIGN-NEXT:check:1 ^~~~~
; ALIGN-NEXT:check:2'0 X~~~~ ; ALIGN-NEXT:check:2'0 X~~~~ error: no match found
; ALIGN-NEXT: 2: goodbye ; ALIGN-NEXT: 2: goodbye
; ALIGN-NEXT:check:2'0 ~~~~~~~ ; ALIGN-NEXT:check:2'0 ~~~~~~~
; ALIGN-NEXT: 3: world ; ALIGN-NEXT: 3: world
; ALIGN-NEXT:check:2'0 ~~~~~ ; ALIGN-NEXT:check:2'0 ~~~~~
; ALIGN-NEXT: 4: unicorn ; ALIGN-NEXT: 4: unicorn
; ALIGN-NEXT:check:2'0 ~~~~~~~ error: no match found ; ALIGN-NEXT:check:2'0 ~~~~~~~
; ALIGN-NEXT:check:2'1 ? possible intended match ; ALIGN-NEXT:check:2'1 ? possible intended match
; ALIGN-NEXT:>>>>>> ; ALIGN-NEXT:>>>>>>
; ALIGN-NOT:{{.}} ; ALIGN-NOT:{{.}}
;-------------------------------------------------- ;--------------------------------------------------
; CHECK (also: multi-line search range, fuzzy match) ; CHECK (also: multi-line search range, fuzzy match)
;-------------------------------------------------- ;--------------------------------------------------
Show All 19 Lines
; Verbose diagnostics are suppressed but not errors. ; Verbose diagnostics are suppressed but not errors.
; CHK: {{.*}}error:{{.*}} ; CHK: {{.*}}error:{{.*}}
; CHK: {{.*}}possible intended match here{{.*}} ; CHK: {{.*}}possible intended match here{{.*}}
; CHK: <<<<<< ; CHK: <<<<<<
; CHK-NEXT: 1: hello ; CHK-NEXT: 1: hello
; CHK-V-NEXT: check:1 ^~~~~ ; CHK-V-NEXT: check:1 ^~~~~
; CHK-NEXT: 2: again ; CHK-NEXT: 2: again
; CHK-NEXT: check:2'0 X~~~~ ; CHK-NEXT: check:2'0 X~~~~ error: no match found
; CHK-NEXT: 3: whirled ; CHK-NEXT: 3: whirled
; CHK-NEXT: check:2'0 ~~~~~~~ error: no match found ; CHK-NEXT: check:2'0 ~~~~~~~
; CHK-NEXT: check:2'1 ? possible intended match ; CHK-NEXT: check:2'1 ? possible intended match
; CHK-NEXT: >>>>>> ; CHK-NEXT: >>>>>>
; CHK-NOT: {{.}} ; CHK-NOT: {{.}}
;-------------------------------------------------- ;--------------------------------------------------
; CHECK-COUNT-<num> ; CHECK-COUNT-<num>
;-------------------------------------------------- ;--------------------------------------------------
▲ Show 20 Lines • Show All 172 Lines • ▼ Show 20 Lines
; EMP: {{.*}}error:{{.*}} ; EMP: {{.*}}error:{{.*}}
; EMP: <<<<<< ; EMP: <<<<<<
; EMP-NEXT: 1: hello ; EMP-NEXT: 1: hello
; EMP-V-NEXT: check:1 ^~~~~ ; EMP-V-NEXT: check:1 ^~~~~
; EMP-NEXT: 2: ; EMP-NEXT: 2:
; EMP-V-NEXT: empty:2 ^ ; EMP-V-NEXT: empty:2 ^
; EMP-NEXT: 3: world ; EMP-NEXT: 3: world
; EMP-NEXT: empty:3 X~~~~ ; EMP-NEXT: empty:3 X~~~~ error: no match found
; EMP-NEXT: 4: label ; EMP-NEXT: 4: label
; EMP-NEXT: empty:3 ~~~~~ error: no match found ; EMP-NEXT: empty:3 ~~~~~
; EMP-V-NEXT: label:4 ^~~~~ ; EMP-V-NEXT: label:4 ^~~~~
; EMP-NEXT: >>>>>> ; EMP-NEXT: >>>>>>
; EMP-NOT: {{.}} ; EMP-NOT: {{.}}
; Wrong-line match. ; Wrong-line match.
; RUN: echo 'hello' > %t.in ; RUN: echo 'hello' > %t.in
; RUN: echo 'world' >> %t.in ; RUN: echo 'world' >> %t.in
▲ Show 20 Lines • Show All 174 Lines • ▼ Show 20 Lines
; LAB: {{.*}}error:{{.*}} ; LAB: {{.*}}error:{{.*}}
; LAB: {{.*}}possible intended match{{.*}} ; LAB: {{.*}}possible intended match{{.*}}
; LAB: <<<<<< ; LAB: <<<<<<
; LAB-NEXT: 1: lab0 ; LAB-NEXT: 1: lab0
; LAB-V-NEXT: label:1'0 ^~~~ ; LAB-V-NEXT: label:1'0 ^~~~
; LAB-V-NEXT: label:1'1 ^~~~ ; LAB-V-NEXT: label:1'1 ^~~~
; LAB-NEXT: 2: foo ; LAB-NEXT: 2: foo
; LAB-NEXT: label:3'0 X~~ ; LAB-NEXT: label:3'0 X~~ error: no match found
; LAB-NEXT: 3: lab1 ; LAB-NEXT: 3: lab1
; LAB-NEXT: label:3'0 ~~~~ ; LAB-NEXT: label:3'0 ~~~~
; LAB-NEXT: label:3'1 ? possible intended match ; LAB-NEXT: label:3'1 ? possible intended match
; LAB-NEXT: 4: bar ; LAB-NEXT: 4: bar
; LAB-NEXT: label:3'0 ~~~ error: no match found ; LAB-NEXT: label:3'0 ~~~
; LAB-NEXT: >>>>>> ; LAB-NEXT: >>>>>>
; LAB-NOT: {{.}} ; LAB-NOT: {{.}}

llvm/trunk/utils/FileCheck/FileCheck.cpp

Show First 20 Lines • Show All 307 Lines • ▼ Show 20 Lines for (auto DiagItr = Diags.begin(), DiagEnd = Diags.end(); DiagItr != DiagEnd;
} }
if (A.CheckDiagIndex != UINT_MAX) if (A.CheckDiagIndex != UINT_MAX)
Label << "'" << A.CheckDiagIndex; Label << "'" << A.CheckDiagIndex;
else else
A.CheckDiagIndex = 0; A.CheckDiagIndex = 0;
Label.flush(); Label.flush();
LabelWidth = std::max((std::string::size_type)LabelWidth, A.Label.size()); LabelWidth = std::max((std::string::size_type)LabelWidth, A.Label.size());
MarkerStyle Marker = GetMarker(DiagItr->MatchTy); A.Marker = GetMarker(DiagItr->MatchTy);
A.Marker = Marker;
A.FoundAndExpectedMatch = A.FoundAndExpectedMatch =
DiagItr->MatchTy == FileCheckDiag::MatchFoundAndExpected; DiagItr->MatchTy == FileCheckDiag::MatchFoundAndExpected;
// Compute the mark location, and break annotation into multiple // Compute the mark location, and break annotation into multiple
// annotations if it spans multiple lines. // annotations if it spans multiple lines.
A.InputLine = DiagItr->InputStartLine; A.InputLine = DiagItr->InputStartLine;
A.InputStartCol = DiagItr->InputStartCol; A.InputStartCol = DiagItr->InputStartCol;
if (DiagItr->InputStartLine == DiagItr->InputEndLine) { if (DiagItr->InputStartLine == DiagItr->InputEndLine) {
// Sometimes ranges are empty in order to indicate a specific point, but // Sometimes ranges are empty in order to indicate a specific point, but
// that would mean nothing would be marked, so adjust the range to // that would mean nothing would be marked, so adjust the range to
// include the following character. // include the following character.
A.InputEndCol = A.InputEndCol =
std::max(DiagItr->InputStartCol + 1, DiagItr->InputEndCol); std::max(DiagItr->InputStartCol + 1, DiagItr->InputEndCol);
Annotations.push_back(A); Annotations.push_back(A);
} else { } else {
assert(DiagItr->InputStartLine < DiagItr->InputEndLine && assert(DiagItr->InputStartLine < DiagItr->InputEndLine &&
"expected input range not to be inverted"); "expected input range not to be inverted");
A.InputEndCol = UINT_MAX; A.InputEndCol = UINT_MAX;
A.Marker.Note = "";
Annotations.push_back(A); Annotations.push_back(A);
for (unsigned L = DiagItr->InputStartLine + 1, E = DiagItr->InputEndLine; for (unsigned L = DiagItr->InputStartLine + 1, E = DiagItr->InputEndLine;
L <= E; ++L) { L <= E; ++L) {
// If a range ends before the first column on a line, then it has no // If a range ends before the first column on a line, then it has no
// characters on that line, so there's nothing to render. // characters on that line, so there's nothing to render.
if (DiagItr->InputEndCol == 1 && L == E) { if (DiagItr->InputEndCol == 1 && L == E)
Annotations.back().Marker.Note = Marker.Note;
break; break;
}
InputAnnotation B; InputAnnotation B;
B.CheckLine = A.CheckLine; B.CheckLine = A.CheckLine;
B.CheckDiagIndex = A.CheckDiagIndex; B.CheckDiagIndex = A.CheckDiagIndex;
B.Label = A.Label; B.Label = A.Label;
B.InputLine = L; B.InputLine = L;
B.Marker = Marker; B.Marker = A.Marker;
B.Marker.Lead = '~'; B.Marker.Lead = '~';
B.Marker.Note = "";
B.InputStartCol = 1; B.InputStartCol = 1;
if (L != E) { if (L != E)
B.InputEndCol = UINT_MAX; B.InputEndCol = UINT_MAX;
B.Marker.Note = ""; else
} else
B.InputEndCol = DiagItr->InputEndCol; B.InputEndCol = DiagItr->InputEndCol;
B.FoundAndExpectedMatch = A.FoundAndExpectedMatch; B.FoundAndExpectedMatch = A.FoundAndExpectedMatch;
Annotations.push_back(B); Annotations.push_back(B);
} }
} }
} }
} }
▲ Show 20 Lines • Show All 287 Lines • Show Last 20 Lines