mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 21:51:12 +01:00
Jon Ross-PerkinsandChandler Carruth
7befe2ce9f
This switches most error printing to use diagnostics instead of direct stream writes, even when not a specific file diagnostic. I'm allowing empty filenames for this use-case. This allows a little more specific testing to validate coverage of output using the diagnostic coverage test. I'm adding a few tests to cover things that weren't previously tested. Separately, this also forces a little more standardization in format... considering how changes like #4568 show effort being spent to _mirror_ diagnostic style, my thought is now to just use diagnostic code where possible. Note this also allows incrementally better testing of the language server; I'm changing the crash fix from #4847 in favor of diagnostic testing. --------- Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
94 lines
3.2 KiB
C++
94 lines
3.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_DIAGNOSTIC_CONSUMER_H_
|
|
#define CARBON_TOOLCHAIN_DIAGNOSTICS_DIAGNOSTIC_CONSUMER_H_
|
|
|
|
#include "common/ostream.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/diagnostics/diagnostic.h"
|
|
|
|
namespace Carbon {
|
|
|
|
// Receives diagnostics as they are emitted.
|
|
class DiagnosticConsumer {
|
|
public:
|
|
virtual ~DiagnosticConsumer() = default;
|
|
|
|
// Handle a diagnostic.
|
|
//
|
|
// This relies on moves of the Diagnostic. At present, diagnostics are
|
|
// allocated on the stack, so their lifetime is that of HandleDiagnostic.
|
|
// However, SortingDiagnosticConsumer needs a longer lifetime, until all
|
|
// diagnostics have been produced. As a consequence, it needs to either copy
|
|
// or move the Diagnostic, and right now we're moving due to the overhead of
|
|
// notes.
|
|
//
|
|
// At present, there is no persistent storage of diagnostics because IDEs
|
|
// would be fine with diagnostics being printed immediately and discarded,
|
|
// without SortingDiagnosticConsumer. If this becomes a performance issue, we
|
|
// may want to investigate alternative ownership models that address both IDE
|
|
// and CLI user needs.
|
|
virtual auto HandleDiagnostic(Diagnostic diagnostic) -> void = 0;
|
|
|
|
// Flushes any buffered input.
|
|
virtual auto Flush() -> void {}
|
|
};
|
|
|
|
// A diagnostic consumer that prints to a stream.
|
|
class StreamDiagnosticConsumer : public DiagnosticConsumer {
|
|
public:
|
|
explicit StreamDiagnosticConsumer(llvm::raw_ostream* stream)
|
|
: stream_(stream) {}
|
|
|
|
auto HandleDiagnostic(Diagnostic diagnostic) -> void override;
|
|
auto Flush() -> void override { stream_->flush(); }
|
|
|
|
auto set_stream(llvm::raw_ostream* stream) -> void { stream_ = stream; }
|
|
auto set_include_diagnostic_kind(bool value) -> void {
|
|
include_diagnostic_kind_ = value;
|
|
}
|
|
|
|
private:
|
|
auto Print(const DiagnosticMessage& message, llvm::StringRef prefix) -> void;
|
|
|
|
llvm::raw_ostream* stream_;
|
|
|
|
// Whether to include the diagnostic kind when printing.
|
|
bool include_diagnostic_kind_ = false;
|
|
|
|
// Whethere we've printed a diagnostic. Used for printing separators.
|
|
bool printed_diagnostic_ = false;
|
|
};
|
|
|
|
// Returns a diagnostic consumer instance that prints to stderr.
|
|
auto ConsoleDiagnosticConsumer() -> DiagnosticConsumer&;
|
|
|
|
// Diagnostic consumer adaptor that tracks whether any errors have been
|
|
// produced.
|
|
class ErrorTrackingDiagnosticConsumer : public DiagnosticConsumer {
|
|
public:
|
|
explicit ErrorTrackingDiagnosticConsumer(DiagnosticConsumer& next_consumer)
|
|
: next_consumer_(&next_consumer) {}
|
|
|
|
auto HandleDiagnostic(Diagnostic diagnostic) -> void override {
|
|
seen_error_ |= diagnostic.level == DiagnosticLevel::Error;
|
|
next_consumer_->HandleDiagnostic(std::move(diagnostic));
|
|
}
|
|
|
|
// Reset whether we've seen an error.
|
|
auto Reset() -> void { seen_error_ = false; }
|
|
|
|
// Returns whether we've seen an error since the last reset.
|
|
auto seen_error() const -> bool { return seen_error_; }
|
|
|
|
private:
|
|
DiagnosticConsumer* next_consumer_;
|
|
bool seen_error_ = false;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_TOOLCHAIN_DIAGNOSTICS_DIAGNOSTIC_CONSUMER_H_
|