mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 20:40:11 +01:00
Jon Ross-Perkins
45e4c71703
The intent is that `last_byte_offset` is still the main sorting key. Diagnostics issued normally (e.g. in an expression) will keep sorting the same, and come before the new diagnostic sort. Diagnostics issued at the end of a scope (e.g. `unused`) can request sorting by their start location, and would become interleaved through that. Choosing "on scope" because I think that's the main way we'll use this functionality (on scope changes); can always rename later if usage expands. Assisted-by: Google Antigravity with Gemini 3 Flash
77 lines
2.9 KiB
C++
77 lines
2.9 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_CONSUMER_H_
|
|
#define CARBON_TOOLCHAIN_DIAGNOSTICS_SORTING_CONSUMER_H_
|
|
|
|
#include "common/check.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "toolchain/diagnostics/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) {
|
|
if (lhs.last_byte_offset != rhs.last_byte_offset) {
|
|
return lhs.last_byte_offset < rhs.last_byte_offset;
|
|
}
|
|
|
|
if (lhs.is_on_scope && rhs.is_on_scope) {
|
|
// When both are on-scope, we need to compare the locations.
|
|
const auto& lhs_loc = lhs.messages[0].loc;
|
|
const auto& rhs_loc = rhs.messages[0].loc;
|
|
return std::tie(lhs_loc.line_number, lhs_loc.column_number) <
|
|
std::tie(rhs_loc.line_number, rhs_loc.column_number);
|
|
} else {
|
|
// Order non-on-scope before on-scope diagnostics.
|
|
return !lhs.is_on_scope && rhs.is_on_scope;
|
|
}
|
|
});
|
|
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_CONSUMER_H_
|