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 llvm {
  22   class raw_ostream;
  23 }
  24
  25 namespace clang {
  26 class DiagnosticOptions;
  27 class LangOptions;
  28 class SourceManager;
  29
  30 class TextDiagnosticPrinter : public DiagnosticClient {
  31   llvm::raw_ostream &OS;
  32   const LangOptions *LangOpts;
  33   const DiagnosticOptions *DiagOpts;
  34
  35   SourceLocation LastWarningLoc;
  36   FullSourceLoc LastLoc;
  37   unsigned LastCaretDiagnosticWasNote : 1;
  38   unsigned OwnsOutputStream : 1;
  39
  40   /// A string to prefix to error messages.
  41   std::string Prefix;
  42
  43 public:
  44   TextDiagnosticPrinter(llvm::raw_ostream &os, const DiagnosticOptions &diags,
  45                         bool OwnsOutputStream = false);
  46   virtual ~TextDiagnosticPrinter();
  47
  48   /// setPrefix - Set the diagnostic printer prefix string, which will be
  49   /// printed at the start of any diagnostics. If empty, no prefix string is
  50   /// used.
  51   void setPrefix(std::string Value) { Prefix = Value; }
  52
  53   void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) {
  54     LangOpts = &LO;
  55   }
  56
  57   void EndSourceFile() {
  58     LangOpts = 0;
  59   }
  60
  61   void PrintIncludeStack(SourceLocation Loc, const SourceManager &SM);
  62
  63   void HighlightRange(const SourceRange &R,
  64                       const SourceManager &SrcMgr,
  65                       unsigned LineNo, FileID FID,
  66                       std::string &CaretLine,
  67                       const std::string &SourceLine);
  68
  69   void EmitCaretDiagnostic(SourceLocation Loc,
  70                            SourceRange *Ranges, unsigned NumRanges,
  71                            SourceManager &SM,
  72                            const CodeModificationHint *Hints,
  73                            unsigned NumHints,
  74                            unsigned Columns);
  75
  76   virtual void HandleDiagnostic(Diagnostic::Level DiagLevel,
  77                                 const DiagnosticInfo &Info);
  78 };
  79
  80 } // end namspace clang
  81
  82 #endif