clang  6.0.0svn
TextDiagnostic.h
Go to the documentation of this file.
1 //===--- TextDiagnostic.h - Text Diagnostic Pretty-Printing -----*- 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 utility class that provides support for textual pretty-printing of
11 // diagnostics. It is used to implement the different code paths which require
12 // such functionality in a consistent way.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_CLANG_FRONTEND_TEXTDIAGNOSTIC_H
17 #define LLVM_CLANG_FRONTEND_TEXTDIAGNOSTIC_H
18 
20 
21 namespace clang {
22 
23 /// \brief Class to encapsulate the logic for formatting and printing a textual
24 /// diagnostic message.
25 ///
26 /// This class provides an interface for building and emitting a textual
27 /// diagnostic, including all of the macro backtraces, caret diagnostics, FixIt
28 /// Hints, and code snippets. In the presence of macros this involves
29 /// a recursive process, synthesizing notes for each macro expansion.
30 ///
31 /// The purpose of this class is to isolate the implementation of printing
32 /// beautiful text diagnostics from any particular interfaces. The Clang
33 /// DiagnosticClient is implemented through this class as is diagnostic
34 /// printing coming out of libclang.
36  raw_ostream &OS;
37 
38 public:
39  TextDiagnostic(raw_ostream &OS,
40  const LangOptions &LangOpts,
42 
43  ~TextDiagnostic() override;
44 
45  /// \brief Print the diagonstic level to a raw_ostream.
46  ///
47  /// This is a static helper that handles colorizing the level and formatting
48  /// it into an arbitrary output stream. This is used internally by the
49  /// TextDiagnostic emission code, but it can also be used directly by
50  /// consumers that don't have a source manager or other state that the full
51  /// TextDiagnostic logic requires.
52  static void printDiagnosticLevel(raw_ostream &OS,
54  bool ShowColors,
55  bool CLFallbackMode = false);
56 
57  /// \brief Pretty-print a diagnostic message to a raw_ostream.
58  ///
59  /// This is a static helper to handle the line wrapping, colorizing, and
60  /// rendering of a diagnostic message to a particular ostream. It is
61  /// publicly visible so that clients which do not have sufficient state to
62  /// build a complete TextDiagnostic object can still get consistent
63  /// formatting of their diagnostic messages.
64  ///
65  /// \param OS Where the message is printed
66  /// \param IsSupplemental true if this is a continuation note diagnostic
67  /// \param Message The text actually printed
68  /// \param CurrentColumn The starting column of the first line, accounting
69  /// for any prefix.
70  /// \param Columns The number of columns to use in line-wrapping, 0 disables
71  /// all line-wrapping.
72  /// \param ShowColors Enable colorizing of the message.
73  static void printDiagnosticMessage(raw_ostream &OS, bool IsSupplemental,
74  StringRef Message, unsigned CurrentColumn,
75  unsigned Columns, bool ShowColors);
76 
77 protected:
79  DiagnosticsEngine::Level Level, StringRef Message,
81  DiagOrStoredDiag D) override;
82 
85  ArrayRef<CharSourceRange> Ranges) override;
86 
89  ArrayRef<FixItHint> Hints) override {
90  emitSnippetAndCaret(Loc, Level, Ranges, Hints);
91  }
92 
93  void emitIncludeLocation(FullSourceLoc Loc, PresumedLoc PLoc) override;
94 
96  StringRef ModuleName) override;
97 
99  StringRef ModuleName) override;
100 
101 private:
102  void emitFilename(StringRef Filename, const SourceManager &SM);
103 
104  void emitSnippetAndCaret(FullSourceLoc Loc, DiagnosticsEngine::Level Level,
106  ArrayRef<FixItHint> Hints);
107 
108  void emitSnippet(StringRef SourceLine);
109 
110  void emitParseableFixits(ArrayRef<FixItHint> Hints, const SourceManager &SM);
111 };
112 
113 } // end namespace clang
114 
115 #endif
const LangOptions & LangOpts
Class to encapsulate the logic for formatting and printing a textual diagnostic message.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:48
Class to encapsulate the logic for formatting a diagnostic message.
void emitDiagnosticMessage(FullSourceLoc Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, StringRef Message, ArrayRef< CharSourceRange > Ranges, DiagOrStoredDiag D) override
TextDiagnostic(raw_ostream &OS, const LangOptions &LangOpts, DiagnosticOptions *DiagOpts)
void emitBuildingModuleLocation(FullSourceLoc Loc, PresumedLoc PLoc, StringRef ModuleName) override
void emitIncludeLocation(FullSourceLoc Loc, PresumedLoc PLoc) override
StringRef Filename
Definition: Format.cpp:1345
void emitDiagnosticLoc(FullSourceLoc Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, ArrayRef< CharSourceRange > Ranges) override
Print out the file/line/column information and include trace.
IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts
Represents an unpacked "presumed" location which can be presented to the user.
const SourceManager & SM
Definition: Format.cpp:1337
llvm::PointerUnion< const Diagnostic *, const StoredDiagnostic * > DiagOrStoredDiag
Options for controlling the compiler diagnostics engine.
static void printDiagnosticLevel(raw_ostream &OS, DiagnosticsEngine::Level Level, bool ShowColors, bool CLFallbackMode=false)
Print the diagonstic level to a raw_ostream.
static void printDiagnosticMessage(raw_ostream &OS, bool IsSupplemental, StringRef Message, unsigned CurrentColumn, unsigned Columns, bool ShowColors)
Pretty-print a diagnostic message to a raw_ostream.
Dataflow Directional Tag Classes.
void emitCodeContext(FullSourceLoc Loc, DiagnosticsEngine::Level Level, SmallVectorImpl< CharSourceRange > &Ranges, ArrayRef< FixItHint > Hints) override
Level
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:150
A SourceLocation and its associated SourceManager.
void emitImportLocation(FullSourceLoc Loc, PresumedLoc PLoc, StringRef ModuleName) override
This class handles loading and caching of source files into memory.