Files
carbon-lang/toolchain/diagnostics/diagnostic.cpp
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

51 lines
1.3 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.h"
#include <algorithm>
#include <cstdint>
namespace Carbon::Diagnostics {
auto Loc::FormatLocation(llvm::raw_ostream& out) const -> void {
if (filename.empty()) {
return;
}
out << filename;
if (line_number > 0) {
out << ":" << line_number;
if (column_number > 0) {
out << ":" << column_number;
}
}
out << ": ";
}
auto Loc::FormatSnippet(llvm::raw_ostream& out, int indent) const -> void {
if (column_number == -1) {
return;
}
// column_number is 1-based.
int32_t column = column_number - 1;
out.indent(indent);
out << line << "\n";
out.indent(indent + column);
out << "^";
// We want to ensure that we don't underline past the end of the line in
// case of a multiline token.
// TODO: Revisit this once we can reference multiple ranges on multiple
// lines in a single diagnostic message.
int underline_length =
std::min(length, static_cast<int32_t>(line.size()) - column);
for (int i = 1; i < underline_length; ++i) {
out << '~';
}
out << '\n';
}
} // namespace Carbon::Diagnostics