Files
carbon-lang/toolchain/diagnostics/consumer.h
Chandler Carruth 2c9739799b 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
2026-10-15 06:08:57 +00:00

69 lines
2.4 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_TOOLCHAIN_DIAGNOSTICS_CONSUMER_H_
#define CARBON_TOOLCHAIN_DIAGNOSTICS_CONSUMER_H_
#include "common/ostream.h"
#include "llvm/ADT/StringRef.h"
#include "toolchain/diagnostics/diagnostic.h"
namespace Carbon::Diagnostics {
// Receives diagnostics as they are emitted.
class Consumer {
public:
virtual ~Consumer() = default;
// Handle a diagnostic.
//
// This relies on moves of the Diagnostic. At present, diagnostics are
// allocated on the stack, so their lifetime is that of HandleDiagnostic.
// However, SortingConsumer needs a longer lifetime, until all
// diagnostics have been produced. As a consequence, it needs to either copy
// or move the Diagnostic, and right now we're moving due to the overhead of
// labels.
//
// At present, there is no persistent storage of diagnostics because IDEs
// would be fine with diagnostics being printed immediately and discarded,
// without SortingConsumer. If this becomes a performance issue, we
// may want to investigate alternative ownership models that address both IDE
// and CLI user needs.
virtual auto HandleDiagnostic(Diagnostic diagnostic) -> void = 0;
// Flushes any buffered input.
virtual auto Flush() -> void {}
};
// Returns a diagnostic consumer instance that prints to stderr. Defined
// alongside `StreamConsumer` in `stream_consumer.h`, which it renders through.
auto ConsoleConsumer() -> Consumer&;
// Diagnostic consumer adaptor that tracks whether any errors have been
// produced.
class ErrorTrackingConsumer : public Consumer {
public:
explicit ErrorTrackingConsumer(Consumer& next_consumer)
: next_consumer_(&next_consumer) {}
auto HandleDiagnostic(Diagnostic diagnostic) -> void override {
seen_error_ |= diagnostic.level == Level::Error;
next_consumer_->HandleDiagnostic(std::move(diagnostic));
}
// Reset whether we've seen an error.
auto Reset() -> void { seen_error_ = false; }
// Returns whether we've seen an error since the last reset.
auto seen_error() const -> bool { return seen_error_; }
private:
Consumer* next_consumer_;
bool seen_error_ = false;
};
} // namespace Carbon::Diagnostics
#endif // CARBON_TOOLCHAIN_DIAGNOSTICS_CONSUMER_H_