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:
Chandler Carruth authored and GitHub committed 2026-10-15 06:08:57 +00:00
1 parent e1c8c1f855
commit 2c9739799b
1205 files changed
+20291 -24988

No files matched your search

+14 -10
View File
@@ -20,6 +20,7 @@
#include "toolchain/diagnostics/consumer.h"
#include "toolchain/diagnostics/diagnostic.h"
#include "toolchain/diagnostics/emitter.h"
#include "toolchain/diagnostics/stream_consumer.h"
#include "toolchain/driver/compile_driver.h"
#include "toolchain/driver/compile_options.h"
#include "toolchain/lex/lex.h"
@@ -43,8 +44,13 @@ class DiagnosticConsumer : public Diagnostics::Consumer {
// Turns a diagnostic into an LSP diagnostic.
auto HandleDiagnostic(Diagnostics::Diagnostic diagnostic) -> void override {
const auto& message = diagnostic.messages[0];
if (message.loc.filename != params_.uri.file()) {
// A context names the operation that failed, and is what the reader is
// told about when a diagnostic has one, so it is what an editor shows too.
const Diagnostics::Context* context =
Diagnostics::LeadingContext(diagnostic);
const Diagnostics::Loc& loc =
context ? context->loc : diagnostic.message.loc;
if (loc.filename != params_.uri.file()) {
// `pushDiagnostic` requires diagnostics to be associated with a location
// in the current file. Suppress diagnostics rooted in other files.
// TODO: Consider if there's a better way to handle this.
@@ -55,20 +61,20 @@ class DiagnosticConsumer : public Diagnostics::Consumer {
CARBON_DIAGNOSTIC(LanguageServerDiagnosticInWrongFile, Warning,
"dropping diagnostic in {0}:\n{1}", std::string,
std::string);
context_->file_emitter().Emit(
params_.uri.file(), LanguageServerDiagnosticInWrongFile,
message.loc.filename.str(), stream.TakeStr());
context_->file_emitter().Emit(params_.uri.file(),
LanguageServerDiagnosticInWrongFile,
loc.filename.str(), stream.TakeStr());
return;
}
// Add the main message.
params_.diagnostics.push_back(clang::clangd::Diagnostic{
.range = GetRange(message.loc),
.range = GetRange(loc),
.severity = GetSeverity(diagnostic.level),
.source = "carbon",
.message = message.Format(),
.message = context ? context->Format() : diagnostic.message.Format(),
});
// TODO: Figure out constructing URIs for note locations.
// TODO: Figure out constructing URIs for the locations of labels.
}
// Returns the constructed request.
@@ -115,8 +121,6 @@ class DiagnosticConsumer : public Diagnostics::Consumer {
return static_cast<int>(DiagnosticSeverity::Error);
case Diagnostics::Level::Warning:
return static_cast<int>(DiagnosticSeverity::Warning);
default:
CARBON_FATAL("Unexpected diagnostic level: {0}", level);
}
}