[lldb] Improve rendering of inline diagnostics on the same column #116727
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adrian-prantl
changed the title
|
@llvm/pr-subscribers-lldb Author: Adrian Prantl (adrian-prantl) Changesdepends on #116711 [lldb] Improve rendering of inline diagnostics on the same column by fixing the indentation and printing these annotations in the original order. Before After Full diff: https://github.com/llvm/llvm-project/pull/116727.diff 2 Files Affected:
diff --git a/lldb/source/Utility/DiagnosticsRendering.cpp b/lldb/source/Utility/DiagnosticsRendering.cpp
index 208733ffc86853..9c3a2d5dadcf13 100644
--- a/lldb/source/Utility/DiagnosticsRendering.cpp
+++ b/lldb/source/Utility/DiagnosticsRendering.cpp
@@ -7,6 +7,7 @@
//===----------------------------------------------------------------------===//
#include "lldb/Utility/DiagnosticsRendering.h"
+#include <cstdint>
using namespace lldb_private;
using namespace lldb;
@@ -121,15 +122,34 @@ void RenderDiagnosticDetails(Stream &stream,
continue;
stream << std::string(loc.column - x_pos, ' ') << cursor;
- ++x_pos;
+ x_pos = loc.column + 1;
for (unsigned i = 0; i + 1 < loc.length; ++i) {
stream << underline;
- ++x_pos;
+ x_pos += 1;
}
}
}
stream << '\n';
+ // Reverse the order within groups of diagnostics that are on the same column.
+ auto group = [](auto &ds) {
+ uint16_t column = 0;
+ std::vector<DiagnosticDetail> result, group;
+ for (auto d : ds) {
+ if (d.source_location->column == column) {
+ group.push_back(d);
+ continue;
+ }
+ result.insert(result.end(), group.rbegin(), group.rend());
+ group.clear();
+ column = d.source_location->column;
+ group.push_back(d);
+ }
+ result.insert(result.end(), group.rbegin(), group.rend());
+ return result;
+ };
+ remaining_details = group(remaining_details);
+
// Work through each detail in reverse order using the vector/stack.
bool did_print = false;
for (auto detail = remaining_details.rbegin();
@@ -142,14 +162,19 @@ void RenderDiagnosticDetails(Stream &stream,
for (auto &remaining_detail :
llvm::ArrayRef(remaining_details).drop_back(1)) {
uint16_t column = remaining_detail.source_location->column;
- if (x_pos <= column)
+ // Is this a note with the same column as another diagnostic?
+ if (column == detail->source_location->column)
+ continue;
+
+ if (column >= x_pos) {
stream << std::string(column - x_pos, ' ') << vbar;
- x_pos = column + 1;
+ x_pos = column + 1;
+ }
}
- // Print the line connecting the ^ with the error message.
uint16_t column = detail->source_location->column;
- if (x_pos <= column)
+ // Print the line connecting the ^ with the error message.
+ if (column >= x_pos)
stream << std::string(column - x_pos, ' ') << joint << hbar << spacer;
// Print a colorized string based on the message's severity type.
diff --git a/lldb/unittests/Utility/DiagnosticsRenderingTest.cpp b/lldb/unittests/Utility/DiagnosticsRenderingTest.cpp
index ad2ebf7ffe1e2f..4e5e0bb7dc3552 100644
--- a/lldb/unittests/Utility/DiagnosticsRenderingTest.cpp
+++ b/lldb/unittests/Utility/DiagnosticsRenderingTest.cpp
@@ -29,15 +29,22 @@ TEST_F(ErrorDisplayTest, RenderStatus) {
{
// Test that diagnostics on the same column can be handled and all
// three errors are diagnosed.
- SourceLocation loc1 = {FileSpec{"a.c"}, 13, 11, 0, false, true};
- SourceLocation loc2 = {FileSpec{"a.c"}, 13, 13, 0, false, true};
+ SourceLocation loc1 = {FileSpec{"a.c"}, 13, 5, 0, false, true};
+ SourceLocation loc2 = {FileSpec{"a.c"}, 13, 7, 0, false, true};
+ SourceLocation loc3 = {FileSpec{"a.c"}, 13, 9, 0, false, true};
std::string result =
Render({DiagnosticDetail{loc1, eSeverityError, "1", "1"},
- DiagnosticDetail{loc1, eSeverityError, "2", "2"},
- DiagnosticDetail{loc2, eSeverityError, "3", "3"}});
- ASSERT_TRUE(StringRef(result).contains("error: 1"));
- ASSERT_TRUE(StringRef(result).contains("error: 2"));
- ASSERT_TRUE(StringRef(result).contains("error: 3"));
+ DiagnosticDetail{loc2, eSeverityError, "2a", "2a"},
+ DiagnosticDetail{loc2, eSeverityInfo, "2b", "2b"},
+ DiagnosticDetail{loc3, eSeverityError, "3", "3"}});
+ llvm::SmallVector<StringRef> lines;
+ StringRef(result).split(lines, '\n');
+ // 1234567890123
+ ASSERT_EQ(lines[0], " ^ ^ ^");
+ ASSERT_EQ(lines[1], " | | error: 3");
+ ASSERT_EQ(lines[2], " | error: 2a");
+ ASSERT_EQ(lines[3], " | note: 2b");
+ ASSERT_EQ(lines[4], " error: 1");
}
{
// Test that diagnostics in reverse order are emitted correctly.
@@ -68,15 +75,25 @@ TEST_F(ErrorDisplayTest, RenderStatus) {
std::string result =
Render({DiagnosticDetail{loc1, eSeverityError, "X", "X"},
DiagnosticDetail{loc2, eSeverityError, "Y", "Y"}});
- auto lines = StringRef(result).split('\n');
- auto line1 = lines.first;
- lines = lines.second.split('\n');
- auto line2 = lines.first;
- lines = lines.second.split('\n');
- auto line3 = lines.first;
- // 1234567
- ASSERT_EQ(line1, "^~~ ^~~");
- ASSERT_EQ(line2, "| error: Y");
- ASSERT_EQ(line3, "error: X");
+ llvm::SmallVector<StringRef> lines;
+ StringRef(result).split(lines, '\n');
+ // 1234567
+ ASSERT_EQ(lines[0], "^~~ ^~~");
+ ASSERT_EQ(lines[1], "| error: Y");
+ ASSERT_EQ(lines[2], "error: X");
+ }
+ {
+ // Test diagnostics on the same line are emitted correctly.
+ SourceLocation loc1 = {FileSpec{"a.c"}, 1, 2, 0, false, true};
+ SourceLocation loc2 = {FileSpec{"a.c"}, 1, 6, 0, false, true};
+ std::string result =
+ Render({DiagnosticDetail{loc1, eSeverityError, "X", "X"},
+ DiagnosticDetail{loc2, eSeverityError, "Y", "Y"}});
+ llvm::SmallVector<StringRef> lines;
+ StringRef(result).split(lines, '\n');
+ // 1234567
+ ASSERT_EQ(lines[0], " ^ ^");
+ ASSERT_EQ(lines[1], " | error: Y");
+ ASSERT_EQ(lines[2], " error: X");
}
}
|
|
This reminds me, could you add a release note talking about these diagnostic improvements? They might have started in 19 but we didn't add one then and things have improved more since, and I think it's a cool feature. |
adrian-prantl
requested review from
kastiglione,
augusto2112 and
felipepiovezan
|
augusto2112
approved these changes
Nov 19, 2024
by fixing the indentation and printing these annotations in the original order.
Before
a+b+c;
^ ^ ^
| | error: 3
| |note: 2b
| error: 2a
error: 1
After
a+b+c;
^ ^ ^
| | error: 3
| error: 2a
| note: 2b
error: 1
adrian-prantl
force-pushed
the
annotation-diagnostics
branch
from
aed2bd0 to
4a9a4b0
Compare
| return result; | ||
| }; | ||
| remaining_details = group(remaining_details); | ||
|
|
There was a problem hiding this comment.
I think this is a bit convoluted, and it is one of those rare cases where iterators are very helpful:
auto group = [](llvm::ArrayRef<DiagnosticDetail> details) {
std::vector<DiagnosticDetail> result;
for (auto it = details.begin(), end = details.end(); it != end;) {
auto eq_end = std::find_if(it, end, [&](const DiagnosticDetail &d) {
return d.source_location->column != it->source_location->column;
});
std::reverse_copy(it, eq_end, std::back_inserter(result));
it = eq_end;
}
return result;
};
There was a problem hiding this comment.
Oh, it's already been merged, nvm
There was a problem hiding this comment.
I can still make the change.
adrian-prantl
added a commit
to adrian-prantl/llvm-project
that referenced
this pull request
Nov 19, 2024
…vm#116727) depends on llvm#116711 [lldb] Improve rendering of inline diagnostics on the same column by fixing the indentation and printing these annotations in the original order. Before a+b+c; ^ ^ ^ | | error: 3 | |note: 2b | error: 2a error: 1 After a+b+c; ^ ^ ^ | | error: 3 | error: 2a | note: 2b error: 1 (cherry picked from commit 6b4f675)
adrian-prantl
added a commit
to adrian-prantl/llvm-project
that referenced
this pull request
Dec 5, 2024
…vm#116727) depends on llvm#116711 [lldb] Improve rendering of inline diagnostics on the same column by fixing the indentation and printing these annotations in the original order. Before a+b+c; ^ ^ ^ | | error: 3 | |note: 2b | error: 2a error: 1 After a+b+c; ^ ^ ^ | | error: 3 | error: 2a | note: 2b error: 1 (cherry picked from commit 6b4f675) (cherry picked from commit 7e80550)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
depends on #116711
[lldb] Improve rendering of inline diagnostics on the same column by fixing the indentation and printing these annotations in the original order.
Before
After