mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-28 10:20:09 +01:00
This gets to a lifetime subtlety, particularly with things like the
sorting diagnostic consumer that delay output. In order to reduce the
chance of accidental references, disallow StringRef in the diagnostics.
For example:
```
./toolchain/diagnostics/diagnostic_emitter.h:162:5: error: static_assert failed due to requirement '!std::is_same_v<llvm::StringRef, llvm::StringRef>' "Use std::string or llvm::StringLiteral for diagnostic lifetimes."
static_assert(
^
toolchain/check/convert.cpp:477:11: note: in instantiation of member function 'Carbon::Internal::DiagnosticBase<std::string, std::string, llvm::StringRef>::DiagnosticBase' requested here
CARBON_DIAGNOSTIC(StructInitMissingFieldInConversion, Error,
^
./toolchain/diagnostics/diagnostic_emitter.h:47:7: note: expanded from macro 'CARBON_DIAGNOSTIC'
::Carbon::Internal::DiagnosticBase<__VA_ARGS__>( \
^
```
---------
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
66 lines
2.6 KiB
C++
66 lines
2.6 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_diagnostic_consumer.h"
|
|
|
|
#include <gmock/gmock.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/diagnostics/diagnostic_emitter.h"
|
|
#include "toolchain/diagnostics/mocks.h"
|
|
|
|
namespace Carbon {
|
|
namespace {
|
|
|
|
using ::Carbon::Testing::IsDiagnostic;
|
|
using ::testing::InSequence;
|
|
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Error, "{0}", llvm::StringLiteral);
|
|
|
|
struct FakeDiagnosticLocationTranslator
|
|
: DiagnosticLocationTranslator<DiagnosticLocation> {
|
|
auto GetLocation(DiagnosticLocation loc) -> DiagnosticLocation override {
|
|
return loc;
|
|
}
|
|
};
|
|
|
|
TEST(SortedDiagnosticEmitterTest, SortErrors) {
|
|
FakeDiagnosticLocationTranslator translator;
|
|
Testing::MockDiagnosticConsumer consumer;
|
|
SortingDiagnosticConsumer sorting_consumer(consumer);
|
|
DiagnosticEmitter<DiagnosticLocation> emitter(translator, sorting_consumer);
|
|
|
|
emitter.Emit({"f", "line", 2, 1}, TestDiagnostic, "M1");
|
|
emitter.Emit({"f", "line", 1, 1}, TestDiagnostic, "M2");
|
|
emitter.Emit({"f", "line", 1, 3}, TestDiagnostic, "M3");
|
|
emitter.Emit({"f", "line", 3, 4}, TestDiagnostic, "M4");
|
|
emitter.Emit({"f", "line", 3, 2}, TestDiagnostic, "M5");
|
|
emitter.Emit({"f", "line", 3, 2}, TestDiagnostic, "M6");
|
|
|
|
InSequence s;
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 1, 1, "M2")));
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 1, 3, "M3")));
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 2, 1, "M1")));
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 3, 2, "M5")));
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 3, 2, "M6")));
|
|
EXPECT_CALL(consumer, HandleDiagnostic(
|
|
IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 3, 4, "M4")));
|
|
sorting_consumer.Flush();
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace Carbon
|