From 21a869aace45586125238fde88c477b330618a0b Mon Sep 17 00:00:00 2001 From: Chandler Carruth Date: Sun, 16 Oct 2011 02:57:39 +0000 Subject: [PATCH] Persist the TextDiagnostic object across multiple diagnostics as long as the SourceManager doesn't change, and the source files don't change. This greatly simplifies the interfaces and interactions. The lifetime of the TextDiagnostic object forms the 'session' over which we attempt to condense and deduplicate information in diagnostics. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@142104 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/Frontend/TextDiagnostic.h | 15 +------ .../clang/Frontend/TextDiagnosticPrinter.h | 27 +++++------- lib/Frontend/TextDiagnostic.cpp | 14 ++----- lib/Frontend/TextDiagnosticPrinter.cpp | 41 +++++++++++-------- 4 files changed, 38 insertions(+), 59 deletions(-) diff --git a/include/clang/Frontend/TextDiagnostic.h b/include/clang/Frontend/TextDiagnostic.h index 19bec5bb96..bea18eaff6 100644 --- a/include/clang/Frontend/TextDiagnostic.h +++ b/include/clang/Frontend/TextDiagnostic.h @@ -70,20 +70,7 @@ public: TextDiagnostic(raw_ostream &OS, const SourceManager &SM, const LangOptions &LangOpts, - const DiagnosticOptions &DiagOpts, - FullSourceLoc LastLoc = FullSourceLoc(), - FullSourceLoc LastIncludeLoc = FullSourceLoc(), - DiagnosticsEngine::Level LastLevel - = DiagnosticsEngine::Level()); - - /// \brief Get the last diagnostic location emitted. - SourceLocation getLastLoc() const { return LastLoc; } - - /// \brief Get the last emitted include stack location. - SourceLocation getLastIncludeLoc() const { return LastIncludeLoc; } - - /// \brief Get the last diagnostic level. - DiagnosticsEngine::Level getLastLevel() const { return LastLevel; } + const DiagnosticOptions &DiagOpts); void emitDiagnostic(SourceLocation Loc, DiagnosticsEngine::Level Level, StringRef Message, ArrayRef Ranges, diff --git a/include/clang/Frontend/TextDiagnosticPrinter.h b/include/clang/Frontend/TextDiagnosticPrinter.h index 4a748f39c4..8051d9ce8b 100644 --- a/include/clang/Frontend/TextDiagnosticPrinter.h +++ b/include/clang/Frontend/TextDiagnosticPrinter.h @@ -16,25 +16,28 @@ #define LLVM_CLANG_FRONTEND_TEXT_DIAGNOSTIC_PRINTER_H_ #include "clang/Basic/Diagnostic.h" -#include "clang/Basic/SourceLocation.h" +#include "clang/Basic/LLVM.h" +#include "llvm/ADT/OwningPtr.h" namespace clang { class DiagnosticOptions; class LangOptions; +class TextDiagnostic; class TextDiagnosticPrinter : public DiagnosticConsumer { raw_ostream &OS; const LangOptions *LangOpts; const DiagnosticOptions *DiagOpts; + const SourceManager *SM; - FullSourceLoc LastLoc; - FullSourceLoc LastIncludeLoc; - DiagnosticsEngine::Level LastLevel; - unsigned OwnsOutputStream : 1; + /// \brief Handle to the currently active text diagnostic emitter. + llvm::OwningPtr TextDiag; /// A string to prefix to error messages. std::string Prefix; + unsigned OwnsOutputStream : 1; + public: TextDiagnosticPrinter(raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false); @@ -45,17 +48,9 @@ public: /// used. void setPrefix(std::string Value) { Prefix = Value; } - void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) { - LangOpts = &LO; - } - - void EndSourceFile() { - LangOpts = 0; - } - - virtual void HandleDiagnostic(DiagnosticsEngine::Level Level, - const Diagnostic &Info); - + void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP); + void EndSourceFile(); + void HandleDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const; }; diff --git a/lib/Frontend/TextDiagnostic.cpp b/lib/Frontend/TextDiagnostic.cpp index d1936e3a02..259e05b473 100644 --- a/lib/Frontend/TextDiagnostic.cpp +++ b/lib/Frontend/TextDiagnostic.cpp @@ -392,17 +392,9 @@ static bool printWordWrapped(raw_ostream &OS, StringRef Str, TextDiagnostic::TextDiagnostic(raw_ostream &OS, const SourceManager &SM, const LangOptions &LangOpts, - const DiagnosticOptions &DiagOpts, - FullSourceLoc LastLoc, - FullSourceLoc LastIncludeLoc, - DiagnosticsEngine::Level LastLevel) - : OS(OS), SM(SM), LangOpts(LangOpts), DiagOpts(DiagOpts), - LastLoc(LastLoc), LastIncludeLoc(LastIncludeLoc), LastLevel(LastLevel) { - if (LastLoc.isValid() && &SM != &LastLoc.getManager()) - this->LastLoc = SourceLocation(); - if (LastIncludeLoc.isValid() && &SM != &LastIncludeLoc.getManager()) - this->LastIncludeLoc = SourceLocation(); - } + const DiagnosticOptions &DiagOpts) + : OS(OS), SM(SM), LangOpts(LangOpts), DiagOpts(DiagOpts), LastLevel() { +} void TextDiagnostic::emitDiagnostic(SourceLocation Loc, DiagnosticsEngine::Level Level, diff --git a/lib/Frontend/TextDiagnosticPrinter.cpp b/lib/Frontend/TextDiagnosticPrinter.cpp index cf2826484f..b5d0bcb0cb 100644 --- a/lib/Frontend/TextDiagnosticPrinter.cpp +++ b/lib/Frontend/TextDiagnosticPrinter.cpp @@ -27,7 +27,7 @@ using namespace clang; TextDiagnosticPrinter::TextDiagnosticPrinter(raw_ostream &os, const DiagnosticOptions &diags, bool _OwnsOutputStream) - : OS(os), LangOpts(0), DiagOpts(&diags), LastLevel(), + : OS(os), LangOpts(0), DiagOpts(&diags), SM(0), OwnsOutputStream(_OwnsOutputStream) { } @@ -36,6 +36,16 @@ TextDiagnosticPrinter::~TextDiagnosticPrinter() { delete &OS; } +void TextDiagnosticPrinter::BeginSourceFile(const LangOptions &LO, + const Preprocessor *PP) { + LangOpts = &LO; +} + +void TextDiagnosticPrinter::EndSourceFile() { + LangOpts = 0; + TextDiag.reset(0); +} + /// \brief Print the diagnostic name to a raw_ostream. /// /// This prints the diagnostic name to a raw_ostream if it has one. It formats @@ -158,23 +168,18 @@ void TextDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level, assert(DiagOpts && "Unexpected diagnostic without options set"); assert(Info.hasSourceManager() && "Unexpected diagnostic with no source manager"); - const SourceManager &SM = Info.getSourceManager(); - TextDiagnostic TextDiag(OS, SM, *LangOpts, *DiagOpts, - LastLoc, LastIncludeLoc, LastLevel); - - TextDiag.emitDiagnostic(Info.getLocation(), Level, DiagMessageStream.str(), - Info.getRanges(), - llvm::makeArrayRef(Info.getFixItHints(), - Info.getNumFixItHints())); - - // Cache the LastLoc from the TextDiagnostic printing. - // FIXME: Rather than this, we should persist a TextDiagnostic object across - // diagnostics until the SourceManager changes. That will allow the - // TextDiagnostic object to form a 'session' of output where we can - // reasonably collapse redundant information. - LastLoc = FullSourceLoc(TextDiag.getLastLoc(), SM); - LastIncludeLoc = FullSourceLoc(TextDiag.getLastIncludeLoc(), SM); - LastLevel = TextDiag.getLastLevel(); + + // Rebuild the TextDiagnostic utility if missing or the source manager has + // changed. + if (!TextDiag || SM != &Info.getSourceManager()) { + SM = &Info.getSourceManager(); + TextDiag.reset(new TextDiagnostic(OS, *SM, *LangOpts, *DiagOpts)); + } + + TextDiag->emitDiagnostic(Info.getLocation(), Level, DiagMessageStream.str(), + Info.getRanges(), + llvm::makeArrayRef(Info.getFixItHints(), + Info.getNumFixItHints())); OS.flush(); } -- 2.40.0