mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-15 14:38:10 +00:00
Chandler Carruth
2c9739799b
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
144 lines
5.0 KiB
C++
144 lines
5.0 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
|
|
|
|
#include "toolchain/diagnostics/sorting_consumer.h"
|
|
|
|
#include <gmock/gmock.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/diagnostics/emitter.h"
|
|
#include "toolchain/diagnostics/mocks.h"
|
|
|
|
namespace Carbon::Diagnostics {
|
|
namespace {
|
|
|
|
using ::Carbon::Testing::IsSingleDiagnostic;
|
|
using ::testing::_;
|
|
using ::testing::ElementsAreArray;
|
|
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Error, "Diag{0}", int);
|
|
CARBON_DIAGNOSTIC_ON_SCOPE(TestDiagnosticOnScope, Error, "DiagOnScope{0}", int);
|
|
|
|
// Sorting-related locations, consumed by `FakeEmitter::ConvertLoc`.
|
|
struct TestLoc {
|
|
int32_t last_byte_offset;
|
|
int32_t line_number;
|
|
int32_t column_number;
|
|
};
|
|
|
|
// Emits a diagnostic with the requested location.
|
|
class FakeEmitter : public Emitter<TestLoc> {
|
|
public:
|
|
using Emitter::Emitter;
|
|
|
|
protected:
|
|
auto ConvertLoc(TestLoc test_loc, ContextFnT /*context_fn*/) const
|
|
-> ConvertedLoc override {
|
|
return {.loc = {.line_number = test_loc.line_number,
|
|
.column_number = test_loc.column_number},
|
|
.last_byte_offset = test_loc.last_byte_offset};
|
|
}
|
|
};
|
|
|
|
// Stores diagnostics in a vector for `ElementsArray` matching.
|
|
class VectorConsumer : public Consumer {
|
|
public:
|
|
auto HandleDiagnostic(Diagnostic diagnostic) -> void override {
|
|
diagnostics_.push_back(std::move(diagnostic));
|
|
}
|
|
|
|
auto Flush() -> void override {}
|
|
|
|
auto diagnostics() const -> llvm::ArrayRef<Diagnostic> {
|
|
return diagnostics_;
|
|
}
|
|
|
|
private:
|
|
llvm::SmallVector<Diagnostic, 0> diagnostics_;
|
|
};
|
|
|
|
TEST(SortedEmitterTest, SortErrors) {
|
|
VectorConsumer consumer;
|
|
SortingConsumer sorting_consumer(consumer);
|
|
FakeEmitter emitter(&sorting_consumer);
|
|
|
|
emitter.Emit({1, 10, 1}, TestDiagnostic, 1);
|
|
emitter.Emit({-1, 11, 1}, TestDiagnostic, 2);
|
|
emitter.Emit({0, 12, 1}, TestDiagnostic, 3);
|
|
emitter.Emit({4, 13, 1}, TestDiagnostic, 4);
|
|
emitter.Emit({3, 14, 1}, TestDiagnostic, 5);
|
|
emitter.Emit({3, 15, 1}, TestDiagnostic, 6);
|
|
|
|
EXPECT_TRUE(consumer.diagnostics().empty());
|
|
sorting_consumer.Flush();
|
|
EXPECT_THAT(
|
|
consumer.diagnostics(),
|
|
ElementsAreArray({
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag2"),
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag3"),
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag1"),
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag5"),
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag6"),
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag4"),
|
|
}));
|
|
}
|
|
|
|
TEST(SortedEmitterTest, SortOnScope) {
|
|
VectorConsumer consumer;
|
|
SortingConsumer sorting_consumer(consumer);
|
|
FakeEmitter emitter(&sorting_consumer);
|
|
|
|
emitter.Emit({2, 15, 1}, TestDiagnosticOnScope, 1);
|
|
emitter.Emit({4, 1, 1}, TestDiagnosticOnScope, 2);
|
|
// Same `last_byte_offset`, should sort by line/column.
|
|
emitter.Emit({3, 10, 5}, TestDiagnosticOnScope, 3);
|
|
emitter.Emit({3, 10, 1}, TestDiagnosticOnScope, 4);
|
|
emitter.Emit({3, 5, 20}, TestDiagnosticOnScope, 5);
|
|
emitter.Emit({3, 10, 3}, TestDiagnosticOnScope, 6);
|
|
|
|
EXPECT_TRUE(consumer.diagnostics().empty());
|
|
sorting_consumer.Flush();
|
|
|
|
EXPECT_THAT(consumer.diagnostics(),
|
|
ElementsAreArray({
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope1"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope5"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope4"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope6"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope3"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error,
|
|
_, _, "DiagOnScope2"),
|
|
}));
|
|
}
|
|
|
|
TEST(SortedEmitterTest, MixedScope) {
|
|
VectorConsumer consumer;
|
|
SortingConsumer sorting_consumer(consumer);
|
|
FakeEmitter emitter(&sorting_consumer);
|
|
|
|
// Difference in on-scope means only `last_byte_offset` is used.
|
|
emitter.Emit({3, 3, 1}, TestDiagnosticOnScope, 1);
|
|
emitter.Emit({3, 10, 1}, TestDiagnostic, 2);
|
|
|
|
EXPECT_TRUE(consumer.diagnostics().empty());
|
|
sorting_consumer.Flush();
|
|
|
|
EXPECT_THAT(
|
|
consumer.diagnostics(),
|
|
ElementsAreArray({
|
|
IsSingleDiagnostic(Kind::TestDiagnostic, Level::Error, _, _, "Diag2"),
|
|
IsSingleDiagnostic(Kind::TestDiagnosticOnScope, Level::Error, _, _,
|
|
"DiagOnScope1"),
|
|
}));
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace Carbon::Diagnostics
|