clang 10.0.0git

DiagnosticOptions.h
Go to the documentation of this file.
1 //===- DiagnosticOptions.h --------------------------------------*- 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 #ifndef LLVM_CLANG_BASIC_DIAGNOSTICOPTIONS_H
10 #define LLVM_CLANG_BASIC_DIAGNOSTICOPTIONS_H
11
12 #include "clang/Basic/LLVM.h"
13 #include "llvm/ADT/IntrusiveRefCntPtr.h"
14 #include <string>
15 #include <type_traits>
16 #include <vector>
17
18 namespace clang {
19
20 /// Specifies which overload candidates to display when overload
21 /// resolution fails.
22 enum OverloadsShown : unsigned {
23 /// Show all overloads.
24 Ovl_All,
25
26 /// Show just the "best" overload candidates.
27 Ovl_Best
28 };
29
30 /// A bitmask representing the diagnostic levels used by
31 /// VerifyDiagnosticConsumer.
32 enum class DiagnosticLevelMask : unsigned {
33 None = 0,
34 Note = 1 << 0,
35 Remark = 1 << 1,
36 Warning = 1 << 2,
37 Error = 1 << 3,
38 All = Note | Remark | Warning | Error
39 };
40
41 inline DiagnosticLevelMask operator~(DiagnosticLevelMask M) {
42 using UT = std::underlying_type<DiagnosticLevelMask>::type;
43 return static_cast<DiagnosticLevelMask>(~static_cast<UT>(M));
44 }
45
46 inline DiagnosticLevelMask operator|(DiagnosticLevelMask LHS,
47 DiagnosticLevelMask RHS) {
48 using UT = std::underlying_type<DiagnosticLevelMask>::type;
49 return static_cast<DiagnosticLevelMask>(
50 static_cast<UT>(LHS) | static_cast<UT>(RHS));
51 }
52
53 inline DiagnosticLevelMask operator&(DiagnosticLevelMask LHS,
54 DiagnosticLevelMask RHS) {
55 using UT = std::underlying_type<DiagnosticLevelMask>::type;
56 return static_cast<DiagnosticLevelMask>(
57 static_cast<UT>(LHS) & static_cast<UT>(RHS));
58 }
59
60 raw_ostream& operator<<(raw_ostream& Out, DiagnosticLevelMask M);
61
62 /// Options for controlling the compiler diagnostics engine.
63 class DiagnosticOptions : public RefCountedBase<DiagnosticOptions>{
64 public:
65 enum TextDiagnosticFormat { Clang, MSVC, Vi };
66
67 // Default values.
68 enum {
69 DefaultTabStop = 8,
70 MaxTabStop = 100,
71 DefaultMacroBacktraceLimit = 6,
72 DefaultTemplateBacktraceLimit = 10,
73 DefaultConstexprBacktraceLimit = 10,
74 DefaultSpellCheckingLimit = 50,
75 DefaultSnippetLineLimit = 1,
76 };
77
78 // Define simple diagnostic options (with no accessors).
79 #define DIAGOPT(Name, Bits, Default) unsigned Name : Bits;
80 #define ENUM_DIAGOPT(Name, Type, Bits, Default)
81 #include "clang/Basic/DiagnosticOptions.def"
82
83 protected:
84 // Define diagnostic options of enumeration type. These are private, and will
85 // have accessors (below).
86 #define DIAGOPT(Name, Bits, Default)
87 #define ENUM_DIAGOPT(Name, Type, Bits, Default) unsigned Name : Bits;
88 #include "clang/Basic/DiagnosticOptions.def"
89
90 public:
91 /// The file to log diagnostic output to.
92 std::string DiagnosticLogFile;
93
94 /// The file to serialize diagnostics to (non-appending).
95 std::string DiagnosticSerializationFile;
96
97 /// The list of -W... options used to alter the diagnostic mappings, with the
98 /// prefixes removed.
99 std::vector<std::string> Warnings;
100
101 /// The list of -R... options used to alter the diagnostic mappings, with the
102 /// prefixes removed.
103 std::vector<std::string> Remarks;
104
105 /// The prefixes for comment directives sought by -verify ("expected" by
106 /// default).
107 std::vector<std::string> VerifyPrefixes;
108
109 public:
110 // Define accessors/mutators for diagnostic options of enumeration type.
111 #define DIAGOPT(Name, Bits, Default)
112 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
113 Type get##Name() const { return static_cast<Type>(Name); } \
114 void set##Name(Type Value) { Name = static_cast<unsigned>(Value); }
115 #include "clang/Basic/DiagnosticOptions.def"
116
117 DiagnosticOptions() {
118 #define DIAGOPT(Name, Bits, Default) Name = Default;
119 #define ENUM_DIAGOPT(Name, Type, Bits, Default) set##Name(Default);
120 #include "clang/Basic/DiagnosticOptions.def"
121 }
122 };
123
124 using TextDiagnosticFormat = DiagnosticOptions::TextDiagnosticFormat;
125
126 } // namespace clang
127
128 #endif // LLVM_CLANG_BASIC_DIAGNOSTICOPTIONS_H
clang::ast_matchers::type
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
Definition: ASTMatchersInternal.cpp:638
clang::operator<<
const DiagnosticBuilder & operator<<(const DiagnosticBuilder &DB, const Attr *At)
Definition: Attr.h:346
clang::Ovl_All
Show all overloads.
Definition: DiagnosticOptions.h:24
clang::DiagnosticLevelMask::Remark
LLVM.h
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
llvm::RefCountedBase
Definition: LLVM.h:46
clang::DiagnosticOptions::Warnings
std::vector< std::string > Warnings
The list of -W...
Definition: DiagnosticOptions.h:99
clang::DiagnosticOptions::TextDiagnosticFormat
TextDiagnosticFormat
Definition: DiagnosticOptions.h:65
clang::DiagnosticLevelMask::Warning
clang::operator|
DiagnosticLevelMask operator|(DiagnosticLevelMask LHS, DiagnosticLevelMask RHS)
Definition: DiagnosticOptions.h:46
clang::operator &
DiagnosticLevelMask operator &(DiagnosticLevelMask LHS, DiagnosticLevelMask RHS)
Definition: DiagnosticOptions.h:53
clang::Ovl_Best
Show just the "best" overload candidates.
Definition: DiagnosticOptions.h:27
clang::DiagnosticOptions::DiagnosticOptions
DiagnosticOptions()
Definition: DiagnosticOptions.h:117
clang::DiagnosticLevelMask::Error
clang::DiagnosticLevelMask::None
clang::DiagnosticLevelMask::Note
clang::DiagnosticOptions
Options for controlling the compiler diagnostics engine.
Definition: DiagnosticOptions.h:63
clang::DiagnosticOptions::DiagnosticSerializationFile
std::string DiagnosticSerializationFile
The file to serialize diagnostics to (non-appending).
Definition: DiagnosticOptions.h:95
clang::DiagnosticOptions::Remarks
std::vector< std::string > Remarks
The list of -R...
Definition: DiagnosticOptions.h:103
clang::DiagnosticLevelMask::All
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:21
clang::DiagnosticOptions::VerifyPrefixes
std::vector< std::string > VerifyPrefixes
The prefixes for comment directives sought by -verify ("expected" by default).
Definition: DiagnosticOptions.h:107
clang::operator~
DiagnosticLevelMask operator~(DiagnosticLevelMask M)
Definition: DiagnosticOptions.h:41
clang::OverloadsShown
OverloadsShown
Specifies which overload candidates to display when overload resolution fails.
Definition: DiagnosticOptions.h:22
clang::DiagnosticLevelMask
DiagnosticLevelMask
A bitmask representing the diagnostic levels used by VerifyDiagnosticConsumer.
Definition: DiagnosticOptions.h:32
clang::DiagnosticOptions::DiagnosticLogFile
std::string DiagnosticLogFile
The file to log diagnostic output to.
Definition: DiagnosticOptions.h:92