blob: de3d469cad8489bbc24aee60996f6f130cba9684 [file] [log] [blame]
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +00001//===--- DiagnosticIDs.cpp - Diagnostic IDs Handling ----------------------===//
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 file implements the Diagnostic IDs-related interfaces.
11//
12//===----------------------------------------------------------------------===//
13
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000014#include "clang/Basic/DiagnosticIDs.h"
David Blaikie6c448862012-02-15 21:58:34 +000015#include "clang/Basic/AllDiagnostics.h"
John McCall923cd572011-06-15 21:46:43 +000016#include "clang/Basic/DiagnosticCategories.h"
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000017#include "clang/Basic/SourceManager.h"
Daniel Dunbar3f839462011-09-29 01:47:16 +000018#include "llvm/ADT/SmallVector.h"
David Majnemercfaa5522013-07-20 07:15:15 +000019#include "llvm/ADT/STLExtras.h"
David Blaikie9fe8c742011-09-23 05:35:21 +000020#include "llvm/Support/ErrorHandling.h"
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000021#include <map>
22using namespace clang;
23
24//===----------------------------------------------------------------------===//
25// Builtin Diagnostic information
26//===----------------------------------------------------------------------===//
27
28namespace {
29
30// Diagnostic classes.
31enum {
32 CLASS_NOTE = 0x01,
33 CLASS_WARNING = 0x02,
34 CLASS_EXTENSION = 0x03,
35 CLASS_ERROR = 0x04
36};
37
38struct StaticDiagInfoRec {
Craig Topper8bfffa52013-07-21 21:56:18 +000039 uint16_t DiagID;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000040 unsigned Mapping : 3;
41 unsigned Class : 3;
Douglas Gregor418df342011-01-27 21:06:28 +000042 unsigned SFINAE : 1;
43 unsigned AccessControl : 1;
Daniel Dunbar4213df32011-09-29 00:34:06 +000044 unsigned WarnNoWerror : 1;
45 unsigned WarnShowInSystemHeader : 1;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000046 unsigned Category : 5;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000047
Benjamin Kramerd49cb202012-02-15 20:57:03 +000048 uint16_t OptionGroupIndex;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000049
50 uint16_t DescriptionLen;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000051 const char *DescriptionStr;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000052
Benjamin Kramerd49cb202012-02-15 20:57:03 +000053 unsigned getOptionGroupIndex() const {
54 return OptionGroupIndex;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000055 }
56
Chris Lattner5f9e2722011-07-23 10:55:15 +000057 StringRef getDescription() const {
58 return StringRef(DescriptionStr, DescriptionLen);
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000059 }
Douglas Gregor7d2b8c12011-04-15 22:04:17 +000060
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000061 bool operator<(const StaticDiagInfoRec &RHS) const {
62 return DiagID < RHS.DiagID;
63 }
64};
65
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000066} // namespace anonymous
67
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000068static const StaticDiagInfoRec StaticDiagInfo[] = {
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +000069#define DIAG(ENUM,CLASS,DEFAULT_MAPPING,DESC,GROUP, \
Daniel Dunbar4213df32011-09-29 00:34:06 +000070 SFINAE,ACCESS,NOWERROR,SHOWINSYSHEADER, \
Benjamin Kramerf94d3922012-02-09 19:38:26 +000071 CATEGORY) \
Daniel Dunbar4213df32011-09-29 00:34:06 +000072 { diag::ENUM, DEFAULT_MAPPING, CLASS, SFINAE, ACCESS, \
Benjamin Kramerd49cb202012-02-15 20:57:03 +000073 NOWERROR, SHOWINSYSHEADER, CATEGORY, GROUP, \
74 STR_SIZE(DESC, uint16_t), DESC },
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000075#include "clang/Basic/DiagnosticCommonKinds.inc"
76#include "clang/Basic/DiagnosticDriverKinds.inc"
77#include "clang/Basic/DiagnosticFrontendKinds.inc"
Chandler Carrutha2398d72011-12-09 00:02:23 +000078#include "clang/Basic/DiagnosticSerializationKinds.inc"
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000079#include "clang/Basic/DiagnosticLexKinds.inc"
80#include "clang/Basic/DiagnosticParseKinds.inc"
81#include "clang/Basic/DiagnosticASTKinds.inc"
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000082#include "clang/Basic/DiagnosticCommentKinds.inc"
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000083#include "clang/Basic/DiagnosticSemaKinds.inc"
84#include "clang/Basic/DiagnosticAnalysisKinds.inc"
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000085#undef DIAG
Douglas Gregor7d2b8c12011-04-15 22:04:17 +000086};
87
David Majnemercfaa5522013-07-20 07:15:15 +000088static const unsigned StaticDiagInfoSize = llvm::array_lengthof(StaticDiagInfo);
Douglas Gregor7d2b8c12011-04-15 22:04:17 +000089
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000090/// GetDiagInfo - Return the StaticDiagInfoRec entry for the specified DiagID,
91/// or null if the ID is invalid.
92static const StaticDiagInfoRec *GetDiagInfo(unsigned DiagID) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +000093 // If assertions are enabled, verify that the StaticDiagInfo array is sorted.
94#ifndef NDEBUG
Craig Toppercbfb8d72013-07-21 18:58:40 +000095 static bool IsFirst = true; // So the check is only performed on first call.
96 if (IsFirst) {
97 for (unsigned i = 1; i != StaticDiagInfoSize; ++i) {
98 assert(StaticDiagInfo[i-1].DiagID != StaticDiagInfo[i].DiagID &&
99 "Diag ID conflict, the enums at the start of clang::diag (in "
100 "DiagnosticIDs.h) probably need to be increased");
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000101
Craig Toppercbfb8d72013-07-21 18:58:40 +0000102 assert(StaticDiagInfo[i-1] < StaticDiagInfo[i] &&
103 "Improperly sorted diag info");
104 }
105 IsFirst = false;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000106 }
107#endif
108
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000109 // Out of bounds diag. Can't be in the table.
110 using namespace diag;
David Majnemercfaa5522013-07-20 07:15:15 +0000111 if (DiagID >= DIAG_UPPER_LIMIT || DiagID <= DIAG_START_COMMON)
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000112 return 0;
113
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000114 // Compute the index of the requested diagnostic in the static table.
115 // 1. Add the number of diagnostics in each category preceeding the
116 // diagnostic and of the category the diagnostic is in. This gives us
117 // the offset of the category in the table.
118 // 2. Subtract the number of IDs in each category from our ID. This gives us
119 // the offset of the diagnostic in the category.
120 // This is cheaper than a binary search on the table as it doesn't touch
121 // memory at all.
122 unsigned Offset = 0;
David Majnemercfaa5522013-07-20 07:15:15 +0000123 unsigned ID = DiagID - DIAG_START_COMMON - 1;
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000124#define CATEGORY(NAME, PREV) \
125 if (DiagID > DIAG_START_##NAME) { \
Argyrios Kyrtzidis35abfcd2013-01-02 22:26:07 +0000126 Offset += NUM_BUILTIN_##PREV##_DIAGNOSTICS - DIAG_START_##PREV - 1; \
127 ID -= DIAG_START_##NAME - DIAG_START_##PREV; \
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000128 }
129CATEGORY(DRIVER, COMMON)
130CATEGORY(FRONTEND, DRIVER)
131CATEGORY(SERIALIZATION, FRONTEND)
132CATEGORY(LEX, SERIALIZATION)
133CATEGORY(PARSE, LEX)
134CATEGORY(AST, PARSE)
135CATEGORY(COMMENT, AST)
136CATEGORY(SEMA, COMMENT)
137CATEGORY(ANALYSIS, SEMA)
138#undef CATEGORY
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000139
140 // Avoid out of bounds reads.
141 if (ID + Offset >= StaticDiagInfoSize)
142 return 0;
143
Argyrios Kyrtzidis35abfcd2013-01-02 22:26:07 +0000144 assert(ID < StaticDiagInfoSize && Offset < StaticDiagInfoSize);
145
Benjamin Kramera07b59e2012-12-11 18:00:22 +0000146 const StaticDiagInfoRec *Found = &StaticDiagInfo[ID + Offset];
147 // If the diag id doesn't match we found a different diag, abort. This can
148 // happen when this function is called with an ID that points into a hole in
149 // the diagID space.
150 if (Found->DiagID != DiagID)
151 return 0;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000152 return Found;
153}
154
Daniel Dunbara5e41332011-09-29 01:52:06 +0000155static DiagnosticMappingInfo GetDefaultDiagMappingInfo(unsigned DiagID) {
Daniel Dunbaraeacae52011-09-29 02:03:01 +0000156 DiagnosticMappingInfo Info = DiagnosticMappingInfo::Make(
Daniel Dunbara5e41332011-09-29 01:52:06 +0000157 diag::MAP_FATAL, /*IsUser=*/false, /*IsPragma=*/false);
Daniel Dunbar4213df32011-09-29 00:34:06 +0000158
Daniel Dunbara5e41332011-09-29 01:52:06 +0000159 if (const StaticDiagInfoRec *StaticInfo = GetDiagInfo(DiagID)) {
160 Info.setMapping((diag::Mapping) StaticInfo->Mapping);
161
162 if (StaticInfo->WarnNoWerror) {
163 assert(Info.getMapping() == diag::MAP_WARNING &&
Daniel Dunbar4213df32011-09-29 00:34:06 +0000164 "Unexpected mapping with no-Werror bit!");
Daniel Dunbara5e41332011-09-29 01:52:06 +0000165 Info.setNoWarningAsError(true);
Daniel Dunbar4213df32011-09-29 00:34:06 +0000166 }
167
Daniel Dunbara5e41332011-09-29 01:52:06 +0000168 if (StaticInfo->WarnShowInSystemHeader) {
169 assert(Info.getMapping() == diag::MAP_WARNING &&
Daniel Dunbar4213df32011-09-29 00:34:06 +0000170 "Unexpected mapping with show-in-system-header bit!");
Daniel Dunbara5e41332011-09-29 01:52:06 +0000171 Info.setShowInSystemHeader(true);
Daniel Dunbar4213df32011-09-29 00:34:06 +0000172 }
Daniel Dunbar4213df32011-09-29 00:34:06 +0000173 }
Daniel Dunbara5e41332011-09-29 01:52:06 +0000174
175 return Info;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000176}
177
Douglas Gregor7d2b8c12011-04-15 22:04:17 +0000178/// getCategoryNumberForDiag - Return the category number that a specified
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000179/// DiagID belongs to, or 0 if no category.
180unsigned DiagnosticIDs::getCategoryNumberForDiag(unsigned DiagID) {
181 if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
182 return Info->Category;
183 return 0;
184}
185
Benjamin Kramerdbda5132011-06-13 18:38:45 +0000186namespace {
187 // The diagnostic category names.
188 struct StaticDiagCategoryRec {
189 const char *NameStr;
190 uint8_t NameLen;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000191
Chris Lattner5f9e2722011-07-23 10:55:15 +0000192 StringRef getName() const {
193 return StringRef(NameStr, NameLen);
Benjamin Kramerdbda5132011-06-13 18:38:45 +0000194 }
195 };
196}
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000197
Daniel Dunbarba494c62011-09-29 01:42:25 +0000198// Unfortunately, the split between DiagnosticIDs and Diagnostic is not
199// particularly clean, but for now we just implement this method here so we can
200// access GetDefaultDiagMapping.
201DiagnosticMappingInfo &DiagnosticsEngine::DiagState::getOrAddMappingInfo(
202 diag::kind Diag)
203{
204 std::pair<iterator, bool> Result = DiagMap.insert(
Daniel Dunbaraeacae52011-09-29 02:03:01 +0000205 std::make_pair(Diag, DiagnosticMappingInfo()));
Daniel Dunbarba494c62011-09-29 01:42:25 +0000206
207 // Initialize the entry if we added it.
Daniel Dunbaraeacae52011-09-29 02:03:01 +0000208 if (Result.second)
Daniel Dunbara5e41332011-09-29 01:52:06 +0000209 Result.first->second = GetDefaultDiagMappingInfo(Diag);
Daniel Dunbarba494c62011-09-29 01:42:25 +0000210
211 return Result.first->second;
212}
213
Benjamin Kramerdbda5132011-06-13 18:38:45 +0000214static const StaticDiagCategoryRec CategoryNameTable[] = {
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000215#define GET_CATEGORY_TABLE
John McCall923cd572011-06-15 21:46:43 +0000216#define CATEGORY(X, ENUM) { X, STR_SIZE(X, uint8_t) },
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000217#include "clang/Basic/DiagnosticGroups.inc"
218#undef GET_CATEGORY_TABLE
219 { 0, 0 }
220};
221
222/// getNumberOfCategories - Return the number of categories
223unsigned DiagnosticIDs::getNumberOfCategories() {
Craig Topperb9602322013-07-15 03:38:40 +0000224 return llvm::array_lengthof(CategoryNameTable) - 1;
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000225}
226
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000227/// getCategoryNameFromID - Given a category ID, return the name of the
228/// category, an empty string if CategoryID is zero, or null if CategoryID is
229/// invalid.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000230StringRef DiagnosticIDs::getCategoryNameFromID(unsigned CategoryID) {
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000231 if (CategoryID >= getNumberOfCategories())
Chris Lattner5f9e2722011-07-23 10:55:15 +0000232 return StringRef();
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000233 return CategoryNameTable[CategoryID].getName();
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000234}
235
236
237
238DiagnosticIDs::SFINAEResponse
239DiagnosticIDs::getDiagnosticSFINAEResponse(unsigned DiagID) {
240 if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID)) {
Douglas Gregor418df342011-01-27 21:06:28 +0000241 if (Info->AccessControl)
242 return SFINAE_AccessControl;
243
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000244 if (!Info->SFINAE)
245 return SFINAE_Report;
246
247 if (Info->Class == CLASS_ERROR)
248 return SFINAE_SubstitutionFailure;
249
250 // Suppress notes, warnings, and extensions;
251 return SFINAE_Suppress;
252 }
253
254 return SFINAE_Report;
255}
256
Douglas Gregor7d2b8c12011-04-15 22:04:17 +0000257/// getBuiltinDiagClass - Return the class field of the diagnostic.
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000258///
259static unsigned getBuiltinDiagClass(unsigned DiagID) {
260 if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
261 return Info->Class;
262 return ~0U;
263}
264
265//===----------------------------------------------------------------------===//
266// Custom Diagnostic information
267//===----------------------------------------------------------------------===//
268
269namespace clang {
270 namespace diag {
271 class CustomDiagInfo {
272 typedef std::pair<DiagnosticIDs::Level, std::string> DiagDesc;
273 std::vector<DiagDesc> DiagInfo;
274 std::map<DiagDesc, unsigned> DiagIDs;
275 public:
276
277 /// getDescription - Return the description of the specified custom
278 /// diagnostic.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000279 StringRef getDescription(unsigned DiagID) const {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000280 assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
Stefanus Du Toitfc093362013-03-01 21:41:22 +0000281 "Invalid diagnostic ID");
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000282 return DiagInfo[DiagID-DIAG_UPPER_LIMIT].second;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000283 }
284
285 /// getLevel - Return the level of the specified custom diagnostic.
286 DiagnosticIDs::Level getLevel(unsigned DiagID) const {
287 assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
Stefanus Du Toitfc093362013-03-01 21:41:22 +0000288 "Invalid diagnostic ID");
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000289 return DiagInfo[DiagID-DIAG_UPPER_LIMIT].first;
290 }
291
Chris Lattner5f9e2722011-07-23 10:55:15 +0000292 unsigned getOrCreateDiagID(DiagnosticIDs::Level L, StringRef Message,
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000293 DiagnosticIDs &Diags) {
294 DiagDesc D(L, Message);
295 // Check to see if it already exists.
296 std::map<DiagDesc, unsigned>::iterator I = DiagIDs.lower_bound(D);
297 if (I != DiagIDs.end() && I->first == D)
298 return I->second;
299
300 // If not, assign a new ID.
301 unsigned ID = DiagInfo.size()+DIAG_UPPER_LIMIT;
302 DiagIDs.insert(std::make_pair(D, ID));
303 DiagInfo.push_back(D);
304 return ID;
305 }
306 };
307
308 } // end diag namespace
309} // end clang namespace
310
311
312//===----------------------------------------------------------------------===//
313// Common Diagnostic implementation
314//===----------------------------------------------------------------------===//
315
316DiagnosticIDs::DiagnosticIDs() {
317 CustomDiagInfo = 0;
318}
319
320DiagnosticIDs::~DiagnosticIDs() {
321 delete CustomDiagInfo;
322}
323
324/// getCustomDiagID - Return an ID for a diagnostic with the specified message
Stefanus Du Toitfc093362013-03-01 21:41:22 +0000325/// and level. If this is the first request for this diagnostic, it is
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000326/// registered and created, otherwise the existing ID is returned.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000327unsigned DiagnosticIDs::getCustomDiagID(Level L, StringRef Message) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000328 if (CustomDiagInfo == 0)
329 CustomDiagInfo = new diag::CustomDiagInfo();
330 return CustomDiagInfo->getOrCreateDiagID(L, Message, *this);
331}
332
333
334/// isBuiltinWarningOrExtension - Return true if the unmapped diagnostic
335/// level of the specified diagnostic ID is a Warning or Extension.
336/// This only works on builtin diagnostics, not custom ones, and is not legal to
337/// call on NOTEs.
338bool DiagnosticIDs::isBuiltinWarningOrExtension(unsigned DiagID) {
339 return DiagID < diag::DIAG_UPPER_LIMIT &&
340 getBuiltinDiagClass(DiagID) != CLASS_ERROR;
341}
342
343/// \brief Determine whether the given built-in diagnostic ID is a
344/// Note.
345bool DiagnosticIDs::isBuiltinNote(unsigned DiagID) {
346 return DiagID < diag::DIAG_UPPER_LIMIT &&
347 getBuiltinDiagClass(DiagID) == CLASS_NOTE;
348}
349
350/// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic
351/// ID is for an extension of some sort. This also returns EnabledByDefault,
352/// which is set to indicate whether the diagnostic is ignored by default (in
353/// which case -pedantic enables it) or treated as a warning/error by default.
354///
355bool DiagnosticIDs::isBuiltinExtensionDiag(unsigned DiagID,
356 bool &EnabledByDefault) {
357 if (DiagID >= diag::DIAG_UPPER_LIMIT ||
358 getBuiltinDiagClass(DiagID) != CLASS_EXTENSION)
359 return false;
360
Daniel Dunbara5e41332011-09-29 01:52:06 +0000361 EnabledByDefault =
362 GetDefaultDiagMappingInfo(DiagID).getMapping() != diag::MAP_IGNORE;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000363 return true;
364}
365
Daniel Dunbar76101cf2011-09-29 01:01:08 +0000366bool DiagnosticIDs::isDefaultMappingAsError(unsigned DiagID) {
367 if (DiagID >= diag::DIAG_UPPER_LIMIT)
368 return false;
369
Daniel Dunbara5e41332011-09-29 01:52:06 +0000370 return GetDefaultDiagMappingInfo(DiagID).getMapping() == diag::MAP_ERROR;
Daniel Dunbar76101cf2011-09-29 01:01:08 +0000371}
372
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000373/// getDescription - Given a diagnostic ID, return a description of the
374/// issue.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000375StringRef DiagnosticIDs::getDescription(unsigned DiagID) const {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000376 if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000377 return Info->getDescription();
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000378 return CustomDiagInfo->getDescription(DiagID);
379}
380
David Blaikied6471f72011-09-25 23:23:43 +0000381/// getDiagnosticLevel - Based on the way the client configured the
382/// DiagnosticsEngine object, classify the specified diagnostic ID into a Level,
383/// by consumable the DiagnosticClient.
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000384DiagnosticIDs::Level
385DiagnosticIDs::getDiagnosticLevel(unsigned DiagID, SourceLocation Loc,
Daniel Dunbar1656aae2011-09-29 01:20:28 +0000386 const DiagnosticsEngine &Diag) const {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000387 // Handle custom diagnostics, which cannot be mapped.
388 if (DiagID >= diag::DIAG_UPPER_LIMIT)
389 return CustomDiagInfo->getLevel(DiagID);
390
391 unsigned DiagClass = getBuiltinDiagClass(DiagID);
Jordan Rosec6d64a22012-07-11 16:50:36 +0000392 if (DiagClass == CLASS_NOTE) return DiagnosticIDs::Note;
Daniel Dunbar1656aae2011-09-29 01:20:28 +0000393 return getDiagnosticLevel(DiagID, DiagClass, Loc, Diag);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000394}
395
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000396/// \brief Based on the way the client configured the Diagnostic
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000397/// object, classify the specified diagnostic ID into a Level, consumable by
398/// the DiagnosticClient.
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000399///
400/// \param Loc The source location we are interested in finding out the
401/// diagnostic state. Can be null in order to query the latest state.
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000402DiagnosticIDs::Level
403DiagnosticIDs::getDiagnosticLevel(unsigned DiagID, unsigned DiagClass,
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000404 SourceLocation Loc,
Daniel Dunbar1656aae2011-09-29 01:20:28 +0000405 const DiagnosticsEngine &Diag) const {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000406 // Specific non-error diagnostics may be mapped to various levels from ignored
407 // to error. Errors can only be mapped to fatal.
408 DiagnosticIDs::Level Result = DiagnosticIDs::Fatal;
409
David Blaikied6471f72011-09-25 23:23:43 +0000410 DiagnosticsEngine::DiagStatePointsTy::iterator
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000411 Pos = Diag.GetDiagStatePointForLoc(Loc);
David Blaikied6471f72011-09-25 23:23:43 +0000412 DiagnosticsEngine::DiagState *State = Pos->State;
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000413
Daniel Dunbarba494c62011-09-29 01:42:25 +0000414 // Get the mapping information, or compute it lazily.
415 DiagnosticMappingInfo &MappingInfo = State->getOrAddMappingInfo(
416 (diag::kind)DiagID);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000417
Daniel Dunbarb1c99c62011-09-29 01:30:00 +0000418 switch (MappingInfo.getMapping()) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000419 case diag::MAP_IGNORE:
Daniel Dunbarbe1aa412011-09-29 01:58:05 +0000420 Result = DiagnosticIDs::Ignored;
421 break;
422 case diag::MAP_WARNING:
423 Result = DiagnosticIDs::Warning;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000424 break;
425 case diag::MAP_ERROR:
426 Result = DiagnosticIDs::Error;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000427 break;
428 case diag::MAP_FATAL:
429 Result = DiagnosticIDs::Fatal;
430 break;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000431 }
432
Daniel Dunbarbe1aa412011-09-29 01:58:05 +0000433 // Upgrade ignored diagnostics if -Weverything is enabled.
434 if (Diag.EnableAllWarnings && Result == DiagnosticIDs::Ignored &&
435 !MappingInfo.isUser())
436 Result = DiagnosticIDs::Warning;
437
Bob Wilson18c407f2011-10-12 19:55:31 +0000438 // Ignore -pedantic diagnostics inside __extension__ blocks.
439 // (The diagnostics controlled by -pedantic are the extension diagnostics
440 // that are not enabled by default.)
Daniel Dunbarf3dee202011-11-28 22:19:36 +0000441 bool EnabledByDefault = false;
Bob Wilson18c407f2011-10-12 19:55:31 +0000442 bool IsExtensionDiag = isBuiltinExtensionDiag(DiagID, EnabledByDefault);
443 if (Diag.AllExtensionsSilenced && IsExtensionDiag && !EnabledByDefault)
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000444 return DiagnosticIDs::Ignored;
445
Daniel Dunbarbe1aa412011-09-29 01:58:05 +0000446 // For extension diagnostics that haven't been explicitly mapped, check if we
447 // should upgrade the diagnostic.
448 if (IsExtensionDiag && !MappingInfo.isUser()) {
449 switch (Diag.ExtBehavior) {
450 case DiagnosticsEngine::Ext_Ignore:
451 break;
452 case DiagnosticsEngine::Ext_Warn:
453 // Upgrade ignored diagnostics to warnings.
454 if (Result == DiagnosticIDs::Ignored)
455 Result = DiagnosticIDs::Warning;
456 break;
457 case DiagnosticsEngine::Ext_Error:
458 // Upgrade ignored or warning diagnostics to errors.
459 if (Result == DiagnosticIDs::Ignored || Result == DiagnosticIDs::Warning)
460 Result = DiagnosticIDs::Error;
461 break;
462 }
463 }
464
465 // At this point, ignored errors can no longer be upgraded.
466 if (Result == DiagnosticIDs::Ignored)
467 return Result;
468
469 // Honor -w, which is lower in priority than pedantic-errors, but higher than
470 // -Werror.
471 if (Result == DiagnosticIDs::Warning && Diag.IgnoreAllWarnings)
472 return DiagnosticIDs::Ignored;
473
474 // If -Werror is enabled, map warnings to errors unless explicitly disabled.
475 if (Result == DiagnosticIDs::Warning) {
476 if (Diag.WarningsAsErrors && !MappingInfo.hasNoWarningAsError())
477 Result = DiagnosticIDs::Error;
478 }
479
480 // If -Wfatal-errors is enabled, map errors to fatal unless explicity
481 // disabled.
482 if (Result == DiagnosticIDs::Error) {
483 if (Diag.ErrorsAsFatal && !MappingInfo.hasNoErrorAsFatal())
484 Result = DiagnosticIDs::Fatal;
485 }
486
Daniel Dunbaraeacae52011-09-29 02:03:01 +0000487 // If we are in a system header, we ignore it. We look at the diagnostic class
488 // because we also want to ignore extensions and warnings in -Werror and
Argyrios Kyrtzidiscfdadfe2011-04-21 23:08:18 +0000489 // -pedantic-errors modes, which *map* warnings/extensions to errors.
490 if (Result >= DiagnosticIDs::Warning &&
491 DiagClass != CLASS_ERROR &&
492 // Custom diagnostics always are emitted in system headers.
493 DiagID < diag::DIAG_UPPER_LIMIT &&
Daniel Dunbarbe1aa412011-09-29 01:58:05 +0000494 !MappingInfo.hasShowInSystemHeader() &&
Argyrios Kyrtzidiscfdadfe2011-04-21 23:08:18 +0000495 Diag.SuppressSystemWarnings &&
496 Loc.isValid() &&
497 Diag.getSourceManager().isInSystemHeader(
Chandler Carruth40278532011-07-25 16:49:02 +0000498 Diag.getSourceManager().getExpansionLoc(Loc)))
Argyrios Kyrtzidiscfdadfe2011-04-21 23:08:18 +0000499 return DiagnosticIDs::Ignored;
500
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000501 return Result;
502}
503
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000504#define GET_DIAG_ARRAYS
505#include "clang/Basic/DiagnosticGroups.inc"
506#undef GET_DIAG_ARRAYS
507
Craig Topper46c8fca2013-08-29 06:06:18 +0000508namespace {
509 struct WarningOption {
510 uint16_t NameOffset;
511 uint16_t Members;
512 uint16_t SubGroups;
Craig Topper354f20a2013-08-29 05:18:04 +0000513
Craig Topper46c8fca2013-08-29 06:06:18 +0000514 // String is stored with a pascal-style length byte.
515 StringRef getName() const {
516 return StringRef(DiagGroupNames + NameOffset + 1,
517 DiagGroupNames[NameOffset]);
518 }
519 };
520}
Craig Topper354f20a2013-08-29 05:18:04 +0000521
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000522// Second the table of options, sorted by name for fast binary lookup.
523static const WarningOption OptionTable[] = {
524#define GET_DIAG_TABLE
525#include "clang/Basic/DiagnosticGroups.inc"
526#undef GET_DIAG_TABLE
527};
Craig Topperb9602322013-07-15 03:38:40 +0000528static const size_t OptionTableSize = llvm::array_lengthof(OptionTable);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000529
Craig Topper354f20a2013-08-29 05:18:04 +0000530static bool WarningOptionCompare(const WarningOption &LHS, StringRef RHS) {
531 return LHS.getName() < RHS;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000532}
533
Benjamin Kramerd49cb202012-02-15 20:57:03 +0000534/// getWarningOptionForDiag - Return the lowest-level warning option that
535/// enables the specified diagnostic. If there is no -Wfoo flag that controls
536/// the diagnostic, this returns null.
537StringRef DiagnosticIDs::getWarningOptionForDiag(unsigned DiagID) {
538 if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
539 return OptionTable[Info->getOptionGroupIndex()].getName();
540 return StringRef();
541}
542
Craig Topper46c8fca2013-08-29 06:06:18 +0000543static void getDiagnosticsInGroup(const WarningOption *Group,
544 SmallVectorImpl<diag::kind> &Diags) {
Daniel Dunbar3f839462011-09-29 01:47:16 +0000545 // Add the members of the option diagnostic set.
Craig Topperb1aa16a2013-08-28 04:02:50 +0000546 const int16_t *Member = DiagArrays + Group->Members;
547 for (; *Member != -1; ++Member)
548 Diags.push_back(*Member);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000549
Daniel Dunbar3f839462011-09-29 01:47:16 +0000550 // Add the members of the subgroups.
Craig Topperb1aa16a2013-08-28 04:02:50 +0000551 const int16_t *SubGroups = DiagSubGroups + Group->SubGroups;
552 for (; *SubGroups != (int16_t)-1; ++SubGroups)
553 getDiagnosticsInGroup(&OptionTable[(short)*SubGroups], Diags);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000554}
555
Daniel Dunbar3f839462011-09-29 01:47:16 +0000556bool DiagnosticIDs::getDiagnosticsInGroup(
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000557 StringRef Group,
558 SmallVectorImpl<diag::kind> &Diags) const {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000559 const WarningOption *Found =
Craig Topper354f20a2013-08-29 05:18:04 +0000560 std::lower_bound(OptionTable, OptionTable + OptionTableSize, Group,
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000561 WarningOptionCompare);
562 if (Found == OptionTable + OptionTableSize ||
Argyrios Kyrtzidis477aab62011-05-25 05:05:01 +0000563 Found->getName() != Group)
Daniel Dunbar3f839462011-09-29 01:47:16 +0000564 return true; // Option not found.
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000565
Craig Topper46c8fca2013-08-29 06:06:18 +0000566 ::getDiagnosticsInGroup(Found, Diags);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000567 return false;
568}
569
Argyrios Kyrtzidis11583c72012-01-27 06:15:43 +0000570void DiagnosticIDs::getAllDiagnostics(
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000571 SmallVectorImpl<diag::kind> &Diags) const {
Argyrios Kyrtzidis11583c72012-01-27 06:15:43 +0000572 for (unsigned i = 0; i != StaticDiagInfoSize; ++i)
573 Diags.push_back(StaticDiagInfo[i].DiagID);
574}
575
Benjamin Kramera70cb9d2011-11-14 23:30:34 +0000576StringRef DiagnosticIDs::getNearestWarningOption(StringRef Group) {
577 StringRef Best;
Benjamin Kramerdce63272011-11-15 12:26:39 +0000578 unsigned BestDistance = Group.size() + 1; // Sanity threshold.
Benjamin Kramera70cb9d2011-11-14 23:30:34 +0000579 for (const WarningOption *i = OptionTable, *e = OptionTable + OptionTableSize;
580 i != e; ++i) {
581 // Don't suggest ignored warning flags.
582 if (!i->Members && !i->SubGroups)
583 continue;
584
585 unsigned Distance = i->getName().edit_distance(Group, true, BestDistance);
Benjamin Kramerdce63272011-11-15 12:26:39 +0000586 if (Distance == BestDistance) {
587 // Two matches with the same distance, don't prefer one over the other.
588 Best = "";
589 } else if (Distance < BestDistance) {
590 // This is a better match.
Benjamin Kramera70cb9d2011-11-14 23:30:34 +0000591 Best = i->getName();
592 BestDistance = Distance;
593 }
594 }
595
596 return Best;
597}
598
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000599/// ProcessDiag - This is the method used to report a diagnostic that is
600/// finally fully formed.
David Blaikied6471f72011-09-25 23:23:43 +0000601bool DiagnosticIDs::ProcessDiag(DiagnosticsEngine &Diag) const {
David Blaikie40847cf2011-09-26 01:18:08 +0000602 Diagnostic Info(&Diag);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000603
604 if (Diag.SuppressAllDiagnostics)
605 return false;
606
607 assert(Diag.getClient() && "DiagnosticClient not set!");
608
609 // Figure out the diagnostic level of this message.
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000610 unsigned DiagID = Info.getID();
Jordan Rosec6d64a22012-07-11 16:50:36 +0000611 DiagnosticIDs::Level DiagLevel
612 = getDiagnosticLevel(DiagID, Info.getLocation(), Diag);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000613
614 if (DiagLevel != DiagnosticIDs::Note) {
615 // Record that a fatal error occurred only when we see a second
616 // non-note diagnostic. This allows notes to be attached to the
617 // fatal error, but suppresses any diagnostics that follow those
618 // notes.
619 if (Diag.LastDiagLevel == DiagnosticIDs::Fatal)
620 Diag.FatalErrorOccurred = true;
621
622 Diag.LastDiagLevel = DiagLevel;
623 }
624
Argyrios Kyrtzidisc0a575f2011-07-29 01:25:44 +0000625 // Update counts for DiagnosticErrorTrap even if a fatal error occurred.
626 if (DiagLevel >= DiagnosticIDs::Error) {
627 ++Diag.TrapNumErrorsOccurred;
628 if (isUnrecoverable(DiagID))
629 ++Diag.TrapNumUnrecoverableErrorsOccurred;
630 }
631
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000632 // If a fatal error has already been emitted, silence all subsequent
633 // diagnostics.
634 if (Diag.FatalErrorOccurred) {
635 if (DiagLevel >= DiagnosticIDs::Error &&
636 Diag.Client->IncludeInDiagnosticCounts()) {
637 ++Diag.NumErrors;
638 ++Diag.NumErrorsSuppressed;
639 }
640
641 return false;
642 }
643
644 // If the client doesn't care about this message, don't issue it. If this is
645 // a note and the last real diagnostic was ignored, ignore it too.
646 if (DiagLevel == DiagnosticIDs::Ignored ||
647 (DiagLevel == DiagnosticIDs::Note &&
648 Diag.LastDiagLevel == DiagnosticIDs::Ignored))
649 return false;
650
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000651 if (DiagLevel >= DiagnosticIDs::Error) {
Argyrios Kyrtzidisc0a575f2011-07-29 01:25:44 +0000652 if (isUnrecoverable(DiagID))
Douglas Gregor85bea972011-07-06 17:40:26 +0000653 Diag.UnrecoverableErrorOccurred = true;
Daniel Jasper1c84c682012-09-28 15:45:07 +0000654
DeLesley Hutchins12f37e42012-12-07 22:53:48 +0000655 // Warnings which have been upgraded to errors do not prevent compilation.
656 if (isDefaultMappingAsError(DiagID))
657 Diag.UncompilableErrorOccurred = true;
658
Daniel Jasper1c84c682012-09-28 15:45:07 +0000659 Diag.ErrorOccurred = true;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000660 if (Diag.Client->IncludeInDiagnosticCounts()) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000661 ++Diag.NumErrors;
662 }
663
Douglas Gregorf1d59482011-08-17 19:13:00 +0000664 // If we've emitted a lot of errors, emit a fatal error instead of it to
665 // stop a flood of bogus errors.
666 if (Diag.ErrorLimit && Diag.NumErrors > Diag.ErrorLimit &&
667 DiagLevel == DiagnosticIDs::Error) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000668 Diag.SetDelayedDiagnostic(diag::fatal_too_many_errors);
Douglas Gregorf1d59482011-08-17 19:13:00 +0000669 return false;
670 }
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000671 }
672
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000673 // Finally, report it.
Jordan Rosec6d64a22012-07-11 16:50:36 +0000674 EmitDiag(Diag, DiagLevel);
675 return true;
676}
677
678void DiagnosticIDs::EmitDiag(DiagnosticsEngine &Diag, Level DiagLevel) const {
679 Diagnostic Info(&Diag);
680 assert(DiagLevel != DiagnosticIDs::Ignored && "Cannot emit ignored diagnostics!");
681
David Blaikied6471f72011-09-25 23:23:43 +0000682 Diag.Client->HandleDiagnostic((DiagnosticsEngine::Level)DiagLevel, Info);
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000683 if (Diag.Client->IncludeInDiagnosticCounts()) {
684 if (DiagLevel == DiagnosticIDs::Warning)
685 ++Diag.NumWarnings;
686 }
687
688 Diag.CurDiagID = ~0U;
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +0000689}
John McCall923cd572011-06-15 21:46:43 +0000690
691bool DiagnosticIDs::isUnrecoverable(unsigned DiagID) const {
692 if (DiagID >= diag::DIAG_UPPER_LIMIT) {
693 // Custom diagnostics.
694 return CustomDiagInfo->getLevel(DiagID) >= DiagnosticIDs::Error;
695 }
696
697 // Only errors may be unrecoverable.
Douglas Gregor85bea972011-07-06 17:40:26 +0000698 if (getBuiltinDiagClass(DiagID) < CLASS_ERROR)
John McCall923cd572011-06-15 21:46:43 +0000699 return false;
700
701 if (DiagID == diag::err_unavailable ||
702 DiagID == diag::err_unavailable_message)
703 return false;
704
John McCallf85e1932011-06-15 23:02:42 +0000705 // Currently we consider all ARC errors as recoverable.
Ted Kremenekafdc21a2011-10-20 05:07:47 +0000706 if (isARCDiagnostic(DiagID))
John McCallf85e1932011-06-15 23:02:42 +0000707 return false;
708
John McCall923cd572011-06-15 21:46:43 +0000709 return true;
710}
Ted Kremenekafdc21a2011-10-20 05:07:47 +0000711
712bool DiagnosticIDs::isARCDiagnostic(unsigned DiagID) {
713 unsigned cat = getCategoryNumberForDiag(DiagID);
714 return DiagnosticIDs::getCategoryNameFromID(cat).startswith("ARC ");
715}