1 //===--- DiagnosticIDs.h - Diagnostic IDs Handling --------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the Diagnostic IDs-related interfaces.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_BASIC_DIAGNOSTICIDS_H
16 #define LLVM_CLANG_BASIC_DIAGNOSTICIDS_H
18 #include "clang/Basic/LLVM.h"
19 #include "llvm/ADT/IntrusiveRefCntPtr.h"
20 #include "llvm/ADT/StringRef.h"
23 class DiagnosticsEngine;
26 // Import the diagnostic enums themselves.
28 // Start position for diagnostics.
30 DIAG_START_COMMON = 0,
31 DIAG_START_DRIVER = DIAG_START_COMMON + 300,
32 DIAG_START_FRONTEND = DIAG_START_DRIVER + 200,
33 DIAG_START_SERIALIZATION = DIAG_START_FRONTEND + 100,
34 DIAG_START_LEX = DIAG_START_SERIALIZATION + 120,
35 DIAG_START_PARSE = DIAG_START_LEX + 300,
36 DIAG_START_AST = DIAG_START_PARSE + 500,
37 DIAG_START_COMMENT = DIAG_START_AST + 110,
38 DIAG_START_SEMA = DIAG_START_COMMENT + 100,
39 DIAG_START_ANALYSIS = DIAG_START_SEMA + 3500,
40 DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100
45 /// \brief All of the diagnostics that can be emitted by the frontend.
46 typedef unsigned kind;
48 // Get typedefs for common diagnostics.
50 #define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,\
51 SFINAE,CATEGORY,NOWERROR,SHOWINSYSHEADER) ENUM,
53 #include "clang/Basic/DiagnosticCommonKinds.inc"
54 NUM_BUILTIN_COMMON_DIAGNOSTICS
58 /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs
59 /// to either Ignore (nothing), Remark (emit a remark), Warning
60 /// (emit a warning) or Error (emit as an error). It allows clients to
61 /// map ERRORs to Error or Fatal (stop emitting diagnostics after this one).
63 // NOTE: 0 means "uncomputed".
64 Ignored = 1, ///< Do not present this diagnostic, ignore it.
65 Remark = 2, ///< Present this diagnostic as a remark.
66 Warning = 3, ///< Present this diagnostic as a warning.
67 Error = 4, ///< Present this diagnostic as an error.
68 Fatal = 5 ///< Present this diagnostic as a fatal error.
71 /// Flavors of diagnostics we can emit. Used to filter for a particular
72 /// kind of diagnostic (for instance, for -W/-R flags).
74 WarningOrError, ///< A diagnostic that indicates a problem or potential
75 ///< problem. Can be made fatal by -Werror.
76 Remark ///< A diagnostic that indicates normal progress through
81 class DiagnosticMapping {
82 unsigned Severity : 3;
84 unsigned IsPragma : 1;
85 unsigned HasNoWarningAsError : 1;
86 unsigned HasNoErrorAsFatal : 1;
87 unsigned WasUpgradedFromWarning : 1;
90 static DiagnosticMapping Make(diag::Severity Severity, bool IsUser,
92 DiagnosticMapping Result;
93 Result.Severity = (unsigned)Severity;
94 Result.IsUser = IsUser;
95 Result.IsPragma = IsPragma;
96 Result.HasNoWarningAsError = 0;
97 Result.HasNoErrorAsFatal = 0;
98 Result.WasUpgradedFromWarning = 0;
102 diag::Severity getSeverity() const { return (diag::Severity)Severity; }
103 void setSeverity(diag::Severity Value) { Severity = (unsigned)Value; }
105 bool isUser() const { return IsUser; }
106 bool isPragma() const { return IsPragma; }
108 bool isErrorOrFatal() const {
109 return getSeverity() == diag::Severity::Error ||
110 getSeverity() == diag::Severity::Fatal;
113 bool hasNoWarningAsError() const { return HasNoWarningAsError; }
114 void setNoWarningAsError(bool Value) { HasNoWarningAsError = Value; }
116 bool hasNoErrorAsFatal() const { return HasNoErrorAsFatal; }
117 void setNoErrorAsFatal(bool Value) { HasNoErrorAsFatal = Value; }
119 /// Whether this mapping attempted to map the diagnostic to a warning, but
120 /// was overruled because the diagnostic was already mapped to an error or
122 bool wasUpgradedFromWarning() const { return WasUpgradedFromWarning; }
123 void setUpgradedFromWarning(bool Value) { WasUpgradedFromWarning = Value; }
125 /// Serialize the bits that aren't based on context.
126 unsigned serializeBits() const {
127 return (WasUpgradedFromWarning << 3) | Severity;
129 static diag::Severity deserializeSeverity(unsigned Bits) {
130 return (diag::Severity)(Bits & 0x7);
132 static bool deserializeUpgradedFromWarning(unsigned Bits) {
137 /// \brief Used for handling and querying diagnostic IDs.
139 /// Can be used and shared by multiple Diagnostics for multiple translation units.
140 class DiagnosticIDs : public RefCountedBase<DiagnosticIDs> {
142 /// \brief The level of the diagnostic, after it has been through mapping.
144 Ignored, Note, Remark, Warning, Error, Fatal
148 /// \brief Information for uniquing and looking up custom diags.
149 diag::CustomDiagInfo *CustomDiagInfo;
155 /// \brief Return an ID for a diagnostic with the specified format string and
158 /// If this is the first request for this diagnostic, it is registered and
159 /// created, otherwise the existing ID is returned.
161 // FIXME: Replace this function with a create-only facilty like
162 // createCustomDiagIDFromFormatString() to enforce safe usage. At the time of
163 // writing, nearly all callers of this function were invalid.
164 unsigned getCustomDiagID(Level L, StringRef FormatString);
166 //===--------------------------------------------------------------------===//
167 // Diagnostic classification and reporting interfaces.
170 /// \brief Given a diagnostic ID, return a description of the issue.
171 StringRef getDescription(unsigned DiagID) const;
173 /// \brief Return true if the unmapped diagnostic levelof the specified
174 /// diagnostic ID is a Warning or Extension.
176 /// This only works on builtin diagnostics, not custom ones, and is not
177 /// legal to call on NOTEs.
178 static bool isBuiltinWarningOrExtension(unsigned DiagID);
180 /// \brief Return true if the specified diagnostic is mapped to errors by
182 static bool isDefaultMappingAsError(unsigned DiagID);
184 /// \brief Determine whether the given built-in diagnostic ID is a Note.
185 static bool isBuiltinNote(unsigned DiagID);
187 /// \brief Determine whether the given built-in diagnostic ID is for an
188 /// extension of some sort.
189 static bool isBuiltinExtensionDiag(unsigned DiagID) {
191 return isBuiltinExtensionDiag(DiagID, ignored);
194 /// \brief Determine whether the given built-in diagnostic ID is for an
195 /// extension of some sort, and whether it is enabled by default.
197 /// This also returns EnabledByDefault, which is set to indicate whether the
198 /// diagnostic is ignored by default (in which case -pedantic enables it) or
199 /// treated as a warning/error by default.
201 static bool isBuiltinExtensionDiag(unsigned DiagID, bool &EnabledByDefault);
204 /// \brief Return the lowest-level warning option that enables the specified
207 /// If there is no -Wfoo flag that controls the diagnostic, this returns null.
208 static StringRef getWarningOptionForDiag(unsigned DiagID);
210 /// \brief Return the category number that a specified \p DiagID belongs to,
211 /// or 0 if no category.
212 static unsigned getCategoryNumberForDiag(unsigned DiagID);
214 /// \brief Return the number of diagnostic categories.
215 static unsigned getNumberOfCategories();
217 /// \brief Given a category ID, return the name of the category.
218 static StringRef getCategoryNameFromID(unsigned CategoryID);
220 /// \brief Return true if a given diagnostic falls into an ARC diagnostic
222 static bool isARCDiagnostic(unsigned DiagID);
224 /// \brief Enumeration describing how the emission of a diagnostic should
225 /// be treated when it occurs during C++ template argument deduction.
226 enum SFINAEResponse {
227 /// \brief The diagnostic should not be reported, but it should cause
228 /// template argument deduction to fail.
230 /// The vast majority of errors that occur during template argument
231 /// deduction fall into this category.
232 SFINAE_SubstitutionFailure,
234 /// \brief The diagnostic should be suppressed entirely.
236 /// Warnings generally fall into this category.
239 /// \brief The diagnostic should be reported.
241 /// The diagnostic should be reported. Various fatal errors (e.g.,
242 /// template instantiation depth exceeded) fall into this category.
245 /// \brief The diagnostic is an access-control diagnostic, which will be
246 /// substitution failures in some contexts and reported in others.
250 /// \brief Determines whether the given built-in diagnostic ID is
251 /// for an error that is suppressed if it occurs during C++ template
252 /// argument deduction.
254 /// When an error is suppressed due to SFINAE, the template argument
255 /// deduction fails but no diagnostic is emitted. Certain classes of
256 /// errors, such as those errors that involve C++ access control,
257 /// are not SFINAE errors.
258 static SFINAEResponse getDiagnosticSFINAEResponse(unsigned DiagID);
260 /// \brief Get the set of all diagnostic IDs in the group with the given name.
262 /// \param[out] Diags - On return, the diagnostics in the group.
263 /// \returns \c true if the given group is unknown, \c false otherwise.
264 bool getDiagnosticsInGroup(diag::Flavor Flavor, StringRef Group,
265 SmallVectorImpl<diag::kind> &Diags) const;
267 /// \brief Get the set of all diagnostic IDs.
268 void getAllDiagnostics(diag::Flavor Flavor,
269 SmallVectorImpl<diag::kind> &Diags) const;
271 /// \brief Get the diagnostic option with the closest edit distance to the
272 /// given group name.
273 static StringRef getNearestOption(diag::Flavor Flavor, StringRef Group);
276 /// \brief Classify the specified diagnostic ID into a Level, consumable by
277 /// the DiagnosticClient.
279 /// The classification is based on the way the client configured the
280 /// DiagnosticsEngine object.
282 /// \param Loc The source location for which we are interested in finding out
283 /// the diagnostic state. Can be null in order to query the latest state.
285 getDiagnosticLevel(unsigned DiagID, SourceLocation Loc,
286 const DiagnosticsEngine &Diag) const LLVM_READONLY;
289 getDiagnosticSeverity(unsigned DiagID, SourceLocation Loc,
290 const DiagnosticsEngine &Diag) const LLVM_READONLY;
292 /// \brief Used to report a diagnostic that is finally fully formed.
294 /// \returns \c true if the diagnostic was emitted, \c false if it was
296 bool ProcessDiag(DiagnosticsEngine &Diag) const;
298 /// \brief Used to emit a diagnostic that is finally fully formed,
299 /// ignoring suppression.
300 void EmitDiag(DiagnosticsEngine &Diag, Level DiagLevel) const;
302 /// \brief Whether the diagnostic may leave the AST in a state where some
303 /// invariants can break.
304 bool isUnrecoverable(unsigned DiagID) const;
306 friend class DiagnosticsEngine;
309 } // end namespace clang