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

+21 -20
View File
@@ -22,12 +22,7 @@ constexpr Kind Kinds[] = {
constexpr Kind UntestedKinds[] = {
// These exist only for unit tests.
Kind::TestDiagnostic,
Kind::TestDiagnosticContext,
Kind::TestDiagnosticContext2,
Kind::TestDiagnosticNote,
Kind::TestDiagnosticOnScope,
Kind::TestDiagnosticSoftContext,
Kind::TestDiagnosticSoftContext2,
// Diagnosing erroneous install conditions, but test environments are
// typically correct.
@@ -60,27 +55,33 @@ constexpr Kind UntestedKinds[] = {
// Producing an emit failure may be infeasible.
Kind::CodeGenUnableToEmit,
// TODO: This is currently hard to test because it requires building and
// importing a module, which attempts to create additional files with
// unpredictable names in the module cache, which bazel doesn't permit.
Kind::InCppModule,
// Degradation for a Clang note that leads a flushed buffer instead of
// trailing the diagnostic it explains, which needs a mistimed flush or a
// Clang bug to produce.
Kind::CppInteropStrayNote,
// TODO: This can only fire if the first message in a diagnostic is rooted
// in a file other than the file being compiled. The language server
// currently only supports compiling one file at a time. Do one of:
// - When imports are supported, find a diagnostic whose first message isn't
// in the current file.
// - Require all diagnostics produced by compiling have their first location
// be in the file being compiled, never an import.
// TODO: This can only fire if a diagnostic's message is rooted in a file
// other than the file being compiled. The language server currently only
// supports compiling one file at a time. Do one of:
// - When imports are supported, find a diagnostic whose message isn't in
// the current file.
// - Require all diagnostics produced by compiling have their message's
// location be in the file being compiled, never an import.
Kind::LanguageServerDiagnosticInWrongFile,
};
// Looks for diagnostic kinds that aren't covered by a file_test.
//
// A line names either a kind or an attached label, and there is no list of
// labels to enumerate from here, so a match that isn't a kind is left alone.
// `check_diagnostics.py` is what covers them: it reads the declarations and the
// testdata directly, so it checks that every label is exercised and that every
// name a test matches on is a kind or a label that exists.
TEST(Coverage, Kind) {
Testing::TestKindCoverage(absl::GetFlag(FLAGS_testdata_manifest),
R"(^ *// CHECK:STDERR: .* \[(\w+)\]$)",
llvm::ArrayRef(Kinds),
llvm::ArrayRef(UntestedKinds));
Testing::TestKindCoverage(
absl::GetFlag(FLAGS_testdata_manifest),
R"(^ *// CHECK:STDERR: .* \[(\w+)\]$)", llvm::ArrayRef(Kinds),
llvm::ArrayRef(UntestedKinds), /*allow_unlisted_matches=*/true);
}
} // namespace