mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-04 07:51:05 +01:00
Jon Ross-Perkins
acbe6530c3
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.
64 lines
2.4 KiB
C++
64 lines
2.4 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_DIAGNOSTICS_SORTING_DIAGNOSTIC_CONSUMER_H_
|
|
#define CARBON_TOOLCHAIN_DIAGNOSTICS_SORTING_DIAGNOSTIC_CONSUMER_H_
|
|
|
|
#include "common/check.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "toolchain/diagnostics/diagnostic_emitter.h"
|
|
|
|
namespace Carbon::Diagnostics {
|
|
|
|
// Buffers incoming diagnostics for printing and sorting.
|
|
//
|
|
// Sorting is based on `last_byte_offset` without taking the filename into
|
|
// account. When processing multiple files, it's expected that separate
|
|
// consumers will be used in order to keep diagnostics distinct. Typically
|
|
// `Diagnostic::messages[0]` will always be a location in the consumer's primary
|
|
// file, but if it needs to correspond to a different file, the
|
|
// `last_byte_offset` must still indicate an offset within the primary file.
|
|
class SortingConsumer : public Consumer {
|
|
public:
|
|
explicit SortingConsumer(Consumer& next_consumer)
|
|
: next_consumer_(&next_consumer) {}
|
|
|
|
~SortingConsumer() override {
|
|
// We choose not to automatically flush diagnostics here, because they are
|
|
// likely to refer to data that gets destroyed before the diagnostics
|
|
// consumer is destroyed, because the diagnostics consumer is typically
|
|
// created before the objects that diagnostics refer into are created.
|
|
CARBON_CHECK(diagnostics_.empty(),
|
|
"Must flush diagnostics consumer before destroying it");
|
|
}
|
|
|
|
// Buffers the diagnostic.
|
|
auto HandleDiagnostic(Diagnostic diagnostic) -> void override {
|
|
diagnostics_.push_back(std::move(diagnostic));
|
|
}
|
|
|
|
// Sorts and flushes buffered diagnostics.
|
|
auto Flush() -> void override {
|
|
llvm::stable_sort(diagnostics_,
|
|
[](const Diagnostic& lhs, const Diagnostic& rhs) {
|
|
return lhs.last_byte_offset < rhs.last_byte_offset;
|
|
});
|
|
for (auto& diag : diagnostics_) {
|
|
next_consumer_->HandleDiagnostic(std::move(diag));
|
|
}
|
|
diagnostics_.clear();
|
|
}
|
|
|
|
private:
|
|
// A Diagnostic is undesirably large for inline storage by SmallVector, so we
|
|
// specify 0.
|
|
llvm::SmallVector<Diagnostic, 0> diagnostics_;
|
|
|
|
Consumer* next_consumer_;
|
|
};
|
|
|
|
} // namespace Carbon::Diagnostics
|
|
|
|
#endif // CARBON_TOOLCHAIN_DIAGNOSTICS_SORTING_DIAGNOSTIC_CONSUMER_H_
|