Files
carbon-lang/toolchain/diagnostics/sorting_diagnostic_consumer.h
T
Richard Smith 063a201b6d Remove automatic flushing in the SortingDiagnosticConsumer destructor. (#3134)
We already needed to manually flush diagnostics along every path out of
the driver, so switch to a CHECK-failure if we get this wrong rather
than a potential use-after-lifetime bug.

Switch the driver to flush explicitly rather than using a bunch of
cleanup lambdas, now that we have checking that we get this right.

This is a follow-up after #3126.
2023-08-22 20:45:04 +00:00

60 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_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 {
// Buffers incoming diagnostics for printing and sorting.
class SortingDiagnosticConsumer : public DiagnosticConsumer {
public:
explicit SortingDiagnosticConsumer(DiagnosticConsumer& next_consumer)
: next_consumer_(&next_consumer) {}
~SortingDiagnosticConsumer() 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.
void Flush() override {
llvm::stable_sort(diagnostics_,
[](const Diagnostic& lhs, const Diagnostic& rhs) {
return std::tie(lhs.message.location.line_number,
lhs.message.location.column_number) <
std::tie(rhs.message.location.line_number,
rhs.message.location.column_number);
});
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_;
DiagnosticConsumer* next_consumer_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_DIAGNOSTICS_SORTING_DIAGNOSTIC_CONSUMER_H_