contrib/llvm/tools/clang/include/clang/Frontend/TextDiagnosticPrinter.h

   1 //===--- TextDiagnosticPrinter.h - Text Diagnostic Client -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This is a concrete diagnostic client, which prints the diagnostics to
  11 // standard error.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_FRONTEND_TEXT_DIAGNOSTIC_PRINTER_H_
  16 #define LLVM_CLANG_FRONTEND_TEXT_DIAGNOSTIC_PRINTER_H_
  17
  18 #include "clang/Basic/Diagnostic.h"
  19 #include "clang/Basic/SourceLocation.h"
  20
  21 namespace clang {
  22 class DiagnosticOptions;
  23 class LangOptions;
  24
  25 class TextDiagnosticPrinter : public DiagnosticClient {
  26   llvm::raw_ostream &OS;
  27   const LangOptions *LangOpts;
  28   const DiagnosticOptions *DiagOpts;
  29
  30   SourceLocation LastWarningLoc;
  31   FullSourceLoc LastLoc;
  32   unsigned LastCaretDiagnosticWasNote : 1;
  33   unsigned OwnsOutputStream : 1;
  34
  35   /// A string to prefix to error messages.
  36   std::string Prefix;
  37
  38 public:
  39   TextDiagnosticPrinter(llvm::raw_ostream &os, const DiagnosticOptions &diags,
  40                         bool OwnsOutputStream = false);
  41   virtual ~TextDiagnosticPrinter();
  42
  43   /// setPrefix - Set the diagnostic printer prefix string, which will be
  44   /// printed at the start of any diagnostics. If empty, no prefix string is
  45   /// used.
  46   void setPrefix(std::string Value) { Prefix = Value; }
  47
  48   void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) {
  49     LangOpts = &LO;
  50   }
  51
  52   void EndSourceFile() {
  53     LangOpts = 0;
  54   }
  55
  56   void PrintIncludeStack(Diagnostic::Level Level, SourceLocation Loc,
  57                          const SourceManager &SM);
  58
  59   void HighlightRange(const CharSourceRange &R,
  60                       const SourceManager &SrcMgr,
  61                       unsigned LineNo, FileID FID,
  62                       std::string &CaretLine,
  63                       const std::string &SourceLine);
  64
  65   virtual void HandleDiagnostic(Diagnostic::Level Level,
  66                                 const DiagnosticInfo &Info);
  67
  68 private:
  69   void EmitCaretDiagnostic(SourceLocation Loc, CharSourceRange *Ranges,
  70                            unsigned NumRanges, const SourceManager &SM,
  71                            const FixItHint *Hints,
  72                            unsigned NumHints, unsigned Columns,
  73                            unsigned OnMacroInst, unsigned MacroSkipStart,
  74                            unsigned MacroSkipEnd);
  75
  76 };
  77
  78 } // end namespace clang
  79
  80 #endif