Files
carbon-lang/toolchain/lex/test_helpers.h
T
Jon Ross-Perkins acbe6530c3 Move diagnostics into a namespace (#5173)
What this really does is avoids shadowing names, so that we can
comfortable have things like `Check::DiagnosticEmitter` or
`Check::DiagnosticLoc` without shadowing being a concern.

Note, down this path I'm also thinking about:

- Renaming misc DiagnosticConsumer/DiagnosticEmitter classes, possibly
just to DiagnosticConsumer/DiagnosticEmitter (so
`Check::DiagnosticEmitter` instead of `SemIRLocDiagnosticEmitter`).
- Dropping `Diagnostic` from `Emitter::DiagnosticBuilder`.
- But not for `Check::DiagnosticBuilder`, because `Check::Builder` would
be ambiguous.
- Renaming diagnostics/diagnostic_* to drop "diagnostic".

[Discussion about SemIRLoc ->
DiagnosticLoc](https://discord.com/channels/655572317891461132/655578254970716160/1353771570463768698)
reminded me of this (in particular the older [Check::DiagnosticBuilder
discussion](https://discord.com/channels/655572317891461132/655578254970716160/1344363562608627763)),
but I'd only do that rename if there's matching consensus about a path
forward where we keep SemIRLoc, and in a way that it's only ever used
for diagnostics (the divergence from which is at the root of current
LocId discussion).

I'm trying to keep that separate from a namespace addition for clarity.
2025-03-26 19:12:10 +00:00

61 lines
2.2 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_LEX_TEST_HELPERS_H_
#define CARBON_TOOLCHAIN_LEX_TEST_HELPERS_H_
#include <gmock/gmock.h>
#include <array>
#include "common/check.h"
#include "common/string_helpers.h"
#include "toolchain/diagnostics/diagnostic_emitter.h"
namespace Carbon::Testing {
// A diagnostic converter for tests that lex a single token. Produces
// locations such as "`12.5`:1:3" to refer to the third character in the token.
class SingleTokenDiagnosticEmitter : public Diagnostics::Emitter<const char*> {
public:
// Form a converter for a given token. The string provided here must refer
// to the same character array that we are going to lex.
explicit SingleTokenDiagnosticEmitter(Diagnostics::Consumer* consumer,
llvm::StringRef token)
: Emitter(consumer), token_(token) {}
protected:
// Implements `DiagnosticConverter::ConvertLoc`.
auto ConvertLoc(const char* pos, ContextFnT /*context_fn*/) const
-> Diagnostics::ConvertedLoc override {
CARBON_CHECK(StringRefContainsPointer(token_, pos),
"invalid diagnostic location");
llvm::StringRef prefix = token_.take_front(pos - token_.begin());
auto [before_last_newline, this_line] = prefix.rsplit('\n');
if (before_last_newline.size() == prefix.size()) {
// On first line.
return {.loc = {.line_number = 1,
.column_number =
static_cast<int32_t>(pos - token_.begin() + 1)},
.last_byte_offset = -1};
} else {
// On second or subsequent lines. Note that the line number here is 2
// more than the number of newlines because `rsplit` removed one newline
// and `line_number` is 1-based.
return {
.loc = {.line_number =
static_cast<int32_t>(before_last_newline.count('\n') + 2),
.column_number = static_cast<int32_t>(this_line.size() + 1)},
.last_byte_offset = -1};
}
}
private:
llvm::StringRef token_;
};
} // namespace Carbon::Testing
#endif // CARBON_TOOLCHAIN_LEX_TEST_HELPERS_H_