clang 10.0.0git

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