mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-17 20:30:27 +00:00
Render diagnostics through the terminal library (#7683)
Diagnostic rendering was part of the data model: `Loc::FormatLocation` and `Loc::FormatSnippet` wrote plain text to a stream, so no capability, color, or terminal width could reach them. A diagnostic is now one message with labels, contexts, and location information attached, and `Diagnostics::Renderer` draws it into a `Terminal::Buffer`. The design is in `toolchain/docs/diagnostics_rendering.md` (#7668), authoring in `toolchain/docs/diagnostics.md`. Before: ``` example.carbon:6:3: error: 1 argument passed to function expecting 0 arguments Run0(1); ^~~~~~~ example.carbon:3:1: note: calling function declared here fn Run0() {} ^~~~~~~~~~~ ``` After: ``` error: 1 argument passed to function expecting 0 arguments ╭─┤ example.carbon:6:3 ┆ 3 │ fn Run0() {} · ─────┬───── · ╰──┤ calling function declared here ┆ -> 6 │ Run0(1); · ─────── ╰──────────── ``` `--no-diagnostic-snippets` gives a compact form, `example.carbon:6:3-9`. File tests use it; the rendering tests under `toolchain/diagnostics/testdata` ask for snippets. C++ interop diagnostics are data now rather than text Clang drew: `SemIR::ClangSourceLocId` names a `clang::SourceRange`, and a Clang location is marked as the point it names. `StreamConsumer` moves to a `:renderer` target that `:emitter` does not depend on, keeping `common/terminal` out of `consumer.h`. Capabilities come from the file behind the error stream, so tests get plain ASCII. `renderer_fuzzer` draws diagnostics built from fuzzer bytes with every capability combination, since a shape the renderer doesn't expect must never be why the compiler dies while reporting a problem. TODOs mark the follow-ups: line weights and crossing lines, wrapping that keeps a quoted type whole, and ordering diagnostics that share a byte offset. Also: `IncorrectExtension`'s hint moves into its message, since its note had no location of its own, and `strip_noise` in `check_diagnostics.py` blanks multi-line `#define`s instead of deleting them. Assisted-by: Claude Code
This commit is contained in:
1 parent
e1c8c1f855
commit
2c9739799b
1205 files changed
+20291
-24988
No files matched your search
@@ -12,6 +12,7 @@
|
||||
#include <utility>
|
||||
|
||||
#include "absl/strings/str_replace.h"
|
||||
#include "common/check.h"
|
||||
#include "common/error.h"
|
||||
#include "llvm/ADT/STLExtras.h"
|
||||
#include "llvm/ADT/SmallVector.h"
|
||||
@@ -172,7 +173,8 @@ auto ToolchainFileTest::Run(
|
||||
overlay_fs->pushOverlay(fs);
|
||||
|
||||
llvm::SmallVector<llvm::StringRef> filtered_test_args;
|
||||
if (component_ == "check" || component_ == "lower") {
|
||||
if (component_ == "check" || component_ == "lower" ||
|
||||
component_ == "diagnostics") {
|
||||
filtered_test_args.reserve(test_args.size());
|
||||
bool found_prelude_flag = false;
|
||||
bool found_include_core_flag = false;
|
||||
@@ -206,6 +208,25 @@ auto ToolchainFileTest::Run(
|
||||
filtered_test_args = test_args;
|
||||
}
|
||||
|
||||
// Most tests are about which diagnostics are produced and what they point at
|
||||
// rather than how they are drawn, so they render compactly: one line per
|
||||
// part, led by its location and the extent of its range. Nothing is then
|
||||
// positioned against a line number, so adding a `CHECK` line above a
|
||||
// diagnostic doesn't move anything inside one. A test that is about the
|
||||
// drawing itself asks for `--diagnostic-snippets` in its `ARGS` and takes on
|
||||
// goldens whose frames number their own `CHECK` lines. This is applied here
|
||||
// rather than in `GetDefaultArgs` so that a test writing its own `ARGS` line
|
||||
// still renders compactly unless it asks not to.
|
||||
bool chooses_snippets =
|
||||
llvm::any_of(filtered_test_args, [](llvm::StringRef arg) {
|
||||
return arg == "--diagnostic-snippets" ||
|
||||
arg == "--no-diagnostic-snippets";
|
||||
});
|
||||
if (!chooses_snippets) {
|
||||
filtered_test_args.insert(filtered_test_args.begin(),
|
||||
"--no-diagnostic-snippets");
|
||||
}
|
||||
|
||||
Driver driver(overlay_fs, &data_->installation, input_stream, &output_stream,
|
||||
&error_stream);
|
||||
auto driver_result = driver.RunCommand(filtered_test_args);
|
||||
@@ -269,7 +290,9 @@ auto ToolchainFileTest::GetDefaultArgs() const
|
||||
|
||||
args.insert(args.end(), {
|
||||
"compile",
|
||||
"--phase=" + component_.str(),
|
||||
"--phase=" + (component_ == "diagnostics"
|
||||
? std::string("check")
|
||||
: component_.str()),
|
||||
// Use the install path to exclude prelude files.
|
||||
"--exclude-dump-file-prefix=" +
|
||||
data_->installation.core_package().native(),
|
||||
@@ -282,6 +305,8 @@ auto ToolchainFileTest::GetDefaultArgs() const
|
||||
args.insert(args.end(), {"--no-prelude-import", "--dump-parse-tree"});
|
||||
} else if (component_ == "check") {
|
||||
args.insert(args.end(), {"--dump-sem-ir", "--dump-sem-ir-ranges=only"});
|
||||
} else if (component_ == "diagnostics") {
|
||||
// Nothing to dump: these tests are only about the rendered diagnostics.
|
||||
} else if (component_ == "lower") {
|
||||
args.insert(args.end(), {"--dump-llvm-ir", "--target=x86_64-linux-gnu"});
|
||||
} else if (component_ == "codegen") {
|
||||
@@ -388,7 +413,11 @@ auto ToolchainFileTest::DoExtraCheckReplacements(std::string& check_line) const
|
||||
auto ToolchainFileTest::FinalizeCheckLines(CheckLineArray& check_lines,
|
||||
bool is_stderr) const -> void {
|
||||
if (is_stderr) {
|
||||
static const RE2 is_new_diagnostic_re(R"(.*:\d*:\d*: (error|warning): )");
|
||||
// A diagnostic's headline carries its location only when snippets are off;
|
||||
// with them on, the location is on the frame row below it. A compact
|
||||
// location can carry the extent of its range as `-<end>` after the column.
|
||||
static const RE2 is_new_diagnostic_re(
|
||||
R"(^// CHECK:STDERR: (?:.*:\d*:\d*(?:-\d+)?: )?(?:error|warning): )");
|
||||
// If a diagnostic isn't attached to a line, try to position it with its
|
||||
// first note.
|
||||
FileTestAutoupdater::CheckLine* diagnostic_without_loc = nullptr;
|
||||
|
||||
Reference in new issue
Block a user