mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-22 21:52:39 +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
+25
-22
@@ -58,35 +58,36 @@ static auto GetCurrentReturnedVar(Context& context) -> SemIR::InstId {
|
||||
// Produces a note that the given function has no explicit return type.
|
||||
static auto NoteNoReturnTypeProvided(DiagnosticBuilder& diag,
|
||||
const SemIR::Function& function) {
|
||||
CARBON_DIAGNOSTIC(ReturnTypeOmittedNote, Note,
|
||||
"there was no return type provided");
|
||||
diag.Note(function.latest_decl_id(), ReturnTypeOmittedNote);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnTypeOmittedNote, Info,
|
||||
"there was no return type provided");
|
||||
diag.Attach(function.latest_decl_id(), ReturnTypeOmittedNote);
|
||||
}
|
||||
|
||||
// Produces a note describing the return type of the given function, which
|
||||
// must be a function whose definition is currently being checked.
|
||||
static auto NoteReturnType(DiagnosticBuilder& diag,
|
||||
const SemIR::Function& function) {
|
||||
CARBON_DIAGNOSTIC(ReturnTypeHereNote, Note, "return type of function is {0}",
|
||||
InstIdAsType);
|
||||
diag.Note(function.return_type_inst_id, ReturnTypeHereNote,
|
||||
function.return_type_inst_id);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnTypeHereNote, Info,
|
||||
"return type of function is {0}", InstIdAsType);
|
||||
diag.Attach(function.return_type_inst_id, ReturnTypeHereNote,
|
||||
function.return_type_inst_id);
|
||||
}
|
||||
|
||||
// Produces a note that the return type of the given function is deduced, for a
|
||||
// function whose return type has not been deduced yet.
|
||||
static auto NoteReturnTypeIsDeduced(DiagnosticBuilder& diag,
|
||||
const SemIR::Function& function) {
|
||||
CARBON_DIAGNOSTIC(ReturnTypeIsDeducedNote, Note,
|
||||
"return type of function is deduced");
|
||||
diag.Note(function.latest_decl_id(), ReturnTypeIsDeducedNote);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnTypeIsDeducedNote, Info,
|
||||
"return type of function is deduced");
|
||||
diag.Attach(function.latest_decl_id(), ReturnTypeIsDeducedNote);
|
||||
}
|
||||
|
||||
// Produces a note pointing at the currently in scope `returned var`.
|
||||
static auto NoteReturnedVar(DiagnosticBuilder& diag,
|
||||
SemIR::InstId returned_var_id) {
|
||||
CARBON_DIAGNOSTIC(ReturnedVarHere, Note, "`returned var` was declared here");
|
||||
diag.Note(returned_var_id, ReturnedVarHere);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnedVarHere, Info,
|
||||
"`returned var` was declared here");
|
||||
diag.Attach(returned_var_id, ReturnedVarHere);
|
||||
}
|
||||
|
||||
namespace {
|
||||
@@ -219,10 +220,10 @@ static auto CompletePendingReturns(Context& context,
|
||||
&context.emitter(), [&](DiagnosticBuilder& builder) {
|
||||
// TODO: Track the instruction the return type was deduced for and use
|
||||
// TypeOfInstId to preserve sugar.
|
||||
CARBON_DIAGNOSTIC(ReturnTypeDeducedAs, Note,
|
||||
"return type deduced as {0}", InstIdAsType);
|
||||
builder.Note(function.return_type_inst_id, ReturnTypeDeducedAs,
|
||||
function.return_type_inst_id);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnTypeDeducedAs, Info,
|
||||
"return type deduced as {0}", InstIdAsType);
|
||||
builder.Attach(function.return_type_inst_id, ReturnTypeDeducedAs,
|
||||
function.return_type_inst_id);
|
||||
});
|
||||
|
||||
for (const auto& pending_return : pending_returns) {
|
||||
@@ -301,8 +302,9 @@ auto RegisterReturnedVar(Context& context, Parse::NodeId returned_node,
|
||||
"`returned var` declaration in function with "
|
||||
"non-initializing return form");
|
||||
auto diag = context.emitter().Build(returned_node, ReturnedVarNotInit);
|
||||
CARBON_DIAGNOSTIC(ReturnFormHereNote, Note, "return form declared here");
|
||||
diag.Note(function.return_form_inst_id, ReturnFormHereNote);
|
||||
CARBON_DIAGNOSTIC_LABEL(ReturnFormHereNote, Info,
|
||||
"return form declared here");
|
||||
diag.Attach(function.return_form_inst_id, ReturnFormHereNote);
|
||||
diag.Emit();
|
||||
}
|
||||
|
||||
@@ -446,12 +448,13 @@ auto DeduceReturnTypeAtEndOfBody(Context& context,
|
||||
DeducedReturnTypeMismatch, Error,
|
||||
"deduced return type {0} does not match return type deduced earlier",
|
||||
TypeOfInstId);
|
||||
CARBON_DIAGNOSTIC(DeducedReturnTypeMismatchPrevious, Note,
|
||||
"return type previously deduced as {0} here",
|
||||
TypeOfInstId);
|
||||
CARBON_DIAGNOSTIC_LABEL(DeducedReturnTypeMismatchPrevious, Info,
|
||||
"return type previously deduced as {0} here",
|
||||
TypeOfInstId);
|
||||
context.emitter()
|
||||
.Build(pending.expr_id, DeducedReturnTypeMismatch, pending.expr_id)
|
||||
.Note(first_expr_id, DeducedReturnTypeMismatchPrevious, first_expr_id)
|
||||
.Attach(first_expr_id, DeducedReturnTypeMismatchPrevious,
|
||||
first_expr_id)
|
||||
.Emit();
|
||||
return_type_id = SemIR::ErrorInst::TypeId;
|
||||
break;
|
||||
|
||||
Reference in new issue
Block a user