mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-18 18:00:29 +00:00
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
44 lines
1.5 KiB
C++
44 lines
1.5 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_KIND_H_
|
|
#define CARBON_TOOLCHAIN_DIAGNOSTICS_KIND_H_
|
|
|
|
#include <cstdint>
|
|
|
|
#include "common/enum_base.h"
|
|
|
|
namespace Carbon::Diagnostics {
|
|
|
|
// Although this currently fits into int8_t, it shouldn't be expected to
|
|
// long-term.
|
|
CARBON_DEFINE_RAW_ENUM_CLASS(Kind, uint16_t) {
|
|
#define CARBON_DIAGNOSTIC_KIND(Name) CARBON_RAW_ENUM_ENUMERATOR(Name)
|
|
#include "toolchain/diagnostics/kind.def"
|
|
};
|
|
|
|
// An enumeration of all diagnostics provided by the toolchain. Diagnostics must
|
|
// be added to kind.def, and defined locally to where they're used using the
|
|
// `CARBON_DIAGNOSTIC` macro in diagnostic.h.
|
|
//
|
|
// Diagnostic definitions are decentralized because placing all diagnostic
|
|
// definitions centrally is expected to create a compilation bottleneck
|
|
// long-term, and we also see value to keeping diagnostic format strings close
|
|
// to the consuming code.
|
|
class Kind : public CARBON_ENUM_BASE(Kind) {
|
|
public:
|
|
#define CARBON_DIAGNOSTIC_KIND(Name) CARBON_ENUM_CONSTANT_DECL(Name)
|
|
#include "toolchain/diagnostics/kind.def"
|
|
};
|
|
|
|
#define CARBON_DIAGNOSTIC_KIND(Name) CARBON_ENUM_CONSTANT_DEFINITION(Kind, Name)
|
|
#include "toolchain/diagnostics/kind.def"
|
|
|
|
// We expect Kind to fit into 2 bytes.
|
|
static_assert(sizeof(Kind) == 2, "Kind includes padding!");
|
|
|
|
} // namespace Carbon::Diagnostics
|
|
|
|
#endif // CARBON_TOOLCHAIN_DIAGNOSTICS_KIND_H_
|