mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-28 19:24:53 +01:00
Jon Ross-PerkinsandChandler Carruth
0c0998d7cd
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>
74 lines
2.7 KiB
C++
74 lines
2.7 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/diagnostic_emitter.h"
|
|
|
|
#include <gmock/gmock.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/diagnostics/mocks.h"
|
|
|
|
namespace Carbon {
|
|
namespace {
|
|
|
|
using ::Carbon::Testing::IsDiagnostic;
|
|
|
|
struct FakeDiagnosticLocationTranslator : DiagnosticLocationTranslator<int> {
|
|
auto GetLocation(int n) -> DiagnosticLocation override {
|
|
return {.line_number = 1, .column_number = n};
|
|
}
|
|
};
|
|
|
|
class DiagnosticEmitterTest : public ::testing::Test {
|
|
protected:
|
|
DiagnosticEmitterTest() : emitter_(translator_, consumer_) {}
|
|
|
|
FakeDiagnosticLocationTranslator translator_;
|
|
Testing::MockDiagnosticConsumer consumer_;
|
|
DiagnosticEmitter<int> emitter_;
|
|
};
|
|
|
|
TEST_F(DiagnosticEmitterTest, EmitSimpleError) {
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Error, "simple error");
|
|
EXPECT_CALL(consumer_, HandleDiagnostic(IsDiagnostic(
|
|
DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 1, 1, "simple error")));
|
|
EXPECT_CALL(consumer_, HandleDiagnostic(IsDiagnostic(
|
|
DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 1, 2, "simple error")));
|
|
emitter_.Emit(1, TestDiagnostic);
|
|
emitter_.Emit(2, TestDiagnostic);
|
|
}
|
|
|
|
TEST_F(DiagnosticEmitterTest, EmitSimpleWarning) {
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Warning, "simple warning");
|
|
EXPECT_CALL(consumer_,
|
|
HandleDiagnostic(IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Warning, 1, 1,
|
|
"simple warning")));
|
|
emitter_.Emit(1, TestDiagnostic);
|
|
}
|
|
|
|
TEST_F(DiagnosticEmitterTest, EmitOneArgDiagnostic) {
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Error, "arg: `{0}`", llvm::StringLiteral);
|
|
EXPECT_CALL(consumer_, HandleDiagnostic(IsDiagnostic(
|
|
DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Error, 1, 1, "arg: `str`")));
|
|
emitter_.Emit(1, TestDiagnostic, "str");
|
|
}
|
|
|
|
TEST_F(DiagnosticEmitterTest, EmitNote) {
|
|
CARBON_DIAGNOSTIC(TestDiagnostic, Warning, "simple warning");
|
|
CARBON_DIAGNOSTIC(TestDiagnosticNote, Note, "note");
|
|
EXPECT_CALL(consumer_,
|
|
HandleDiagnostic(IsDiagnostic(DiagnosticKind::TestDiagnostic,
|
|
DiagnosticLevel::Warning, 1, 1,
|
|
"simple warning")));
|
|
emitter_.Build(1, TestDiagnostic).Note(2, TestDiagnosticNote).Emit();
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace Carbon
|