1 //===--- 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 
14 #include "clang/Basic/DiagnosticIDs.h"
15 #include "clang/Basic/AllDiagnostics.h"
16 #include "clang/Basic/DiagnosticCategories.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include <map>
22 using namespace clang;
23 
24 //===----------------------------------------------------------------------===//
25 // Builtin Diagnostic information
26 //===----------------------------------------------------------------------===//
27 
28 namespace {
29 
30 // Diagnostic classes.
31 enum {
32   CLASS_NOTE       = 0x01,
33   CLASS_WARNING    = 0x02,
34   CLASS_EXTENSION  = 0x03,
35   CLASS_ERROR      = 0x04
36 };
37 
38 struct StaticDiagInfoRec {
39   uint16_t DiagID;
40   unsigned Mapping : 3;
41   unsigned Class : 3;
42   unsigned SFINAE : 2;
43   unsigned WarnNoWerror : 1;
44   unsigned WarnShowInSystemHeader : 1;
45   unsigned Category : 5;
46 
47   uint16_t OptionGroupIndex;
48 
49   uint16_t DescriptionLen;
50   const char *DescriptionStr;
51 
52   unsigned getOptionGroupIndex() const {
53     return OptionGroupIndex;
54   }
55 
56   StringRef getDescription() const {
57     return StringRef(DescriptionStr, DescriptionLen);
58   }
59 
60   bool operator<(const StaticDiagInfoRec &RHS) const {
61     return DiagID < RHS.DiagID;
62   }
63 };
64 
65 } // namespace anonymous
66 
67 static const StaticDiagInfoRec StaticDiagInfo[] = {
68 #define DIAG(ENUM,CLASS,DEFAULT_MAPPING,DESC,GROUP,               \
69              SFINAE,NOWERROR,SHOWINSYSHEADER,CATEGORY)            \
70   { diag::ENUM, DEFAULT_MAPPING, CLASS,                           \
71     DiagnosticIDs::SFINAE,                                        \
72     NOWERROR, SHOWINSYSHEADER, CATEGORY, GROUP,                   \
73     STR_SIZE(DESC, uint16_t), DESC },
74 #include "clang/Basic/DiagnosticCommonKinds.inc"
75 #include "clang/Basic/DiagnosticDriverKinds.inc"
76 #include "clang/Basic/DiagnosticFrontendKinds.inc"
77 #include "clang/Basic/DiagnosticSerializationKinds.inc"
78 #include "clang/Basic/DiagnosticLexKinds.inc"
79 #include "clang/Basic/DiagnosticParseKinds.inc"
80 #include "clang/Basic/DiagnosticASTKinds.inc"
81 #include "clang/Basic/DiagnosticCommentKinds.inc"
82 #include "clang/Basic/DiagnosticSemaKinds.inc"
83 #include "clang/Basic/DiagnosticAnalysisKinds.inc"
84 #undef DIAG
85 };
86 
87 static const unsigned StaticDiagInfoSize = llvm::array_lengthof(StaticDiagInfo);
88 
89 /// GetDiagInfo - Return the StaticDiagInfoRec entry for the specified DiagID,
90 /// or null if the ID is invalid.
91 static const StaticDiagInfoRec *GetDiagInfo(unsigned DiagID) {
92   // If assertions are enabled, verify that the StaticDiagInfo array is sorted.
93 #ifndef NDEBUG
94   static bool IsFirst = true; // So the check is only performed on first call.
95   if (IsFirst) {
96     for (unsigned i = 1; i != StaticDiagInfoSize; ++i) {
97       assert(StaticDiagInfo[i-1].DiagID != StaticDiagInfo[i].DiagID &&
98              "Diag ID conflict, the enums at the start of clang::diag (in "
99              "DiagnosticIDs.h) probably need to be increased");
100 
101       assert(StaticDiagInfo[i-1] < StaticDiagInfo[i] &&
102              "Improperly sorted diag info");
103     }
104     IsFirst = false;
105   }
106 #endif
107 
108   // Out of bounds diag. Can't be in the table.
109   using namespace diag;
110   if (DiagID >= DIAG_UPPER_LIMIT || DiagID <= DIAG_START_COMMON)
111     return 0;
112 
113   // Compute the index of the requested diagnostic in the static table.
114   // 1. Add the number of diagnostics in each category preceding the
115   //    diagnostic and of the category the diagnostic is in. This gives us
116   //    the offset of the category in the table.
117   // 2. Subtract the number of IDs in each category from our ID. This gives us
118   //    the offset of the diagnostic in the category.
119   // This is cheaper than a binary search on the table as it doesn't touch
120   // memory at all.
121   unsigned Offset = 0;
122   unsigned ID = DiagID - DIAG_START_COMMON - 1;
123 #define CATEGORY(NAME, PREV) \
124   if (DiagID > DIAG_START_##NAME) { \
125     Offset += NUM_BUILTIN_##PREV##_DIAGNOSTICS - DIAG_START_##PREV - 1; \
126     ID -= DIAG_START_##NAME - DIAG_START_##PREV; \
127   }
128 CATEGORY(DRIVER, COMMON)
129 CATEGORY(FRONTEND, DRIVER)
130 CATEGORY(SERIALIZATION, FRONTEND)
131 CATEGORY(LEX, SERIALIZATION)
132 CATEGORY(PARSE, LEX)
133 CATEGORY(AST, PARSE)
134 CATEGORY(COMMENT, AST)
135 CATEGORY(SEMA, COMMENT)
136 CATEGORY(ANALYSIS, SEMA)
137 #undef CATEGORY
138 
139   // Avoid out of bounds reads.
140   if (ID + Offset >= StaticDiagInfoSize)
141     return 0;
142 
143   assert(ID < StaticDiagInfoSize && Offset < StaticDiagInfoSize);
144 
145   const StaticDiagInfoRec *Found = &StaticDiagInfo[ID + Offset];
146   // If the diag id doesn't match we found a different diag, abort. This can
147   // happen when this function is called with an ID that points into a hole in
148   // the diagID space.
149   if (Found->DiagID != DiagID)
150     return 0;
151   return Found;
152 }
153 
154 static DiagnosticMappingInfo GetDefaultDiagMappingInfo(unsigned DiagID) {
155   DiagnosticMappingInfo Info = DiagnosticMappingInfo::Make(
156     diag::MAP_FATAL, /*IsUser=*/false, /*IsPragma=*/false);
157 
158   if (const StaticDiagInfoRec *StaticInfo = GetDiagInfo(DiagID)) {
159     Info.setMapping((diag::Mapping) StaticInfo->Mapping);
160 
161     if (StaticInfo->WarnNoWerror) {
162       assert(Info.getMapping() == diag::MAP_WARNING &&
163              "Unexpected mapping with no-Werror bit!");
164       Info.setNoWarningAsError(true);
165     }
166 
167     if (StaticInfo->WarnShowInSystemHeader) {
168       assert(Info.getMapping() == diag::MAP_WARNING &&
169              "Unexpected mapping with show-in-system-header bit!");
170       Info.setShowInSystemHeader(true);
171     }
172   }
173 
174   return Info;
175 }
176 
177 /// getCategoryNumberForDiag - Return the category number that a specified
178 /// DiagID belongs to, or 0 if no category.
179 unsigned DiagnosticIDs::getCategoryNumberForDiag(unsigned DiagID) {
180   if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
181     return Info->Category;
182   return 0;
183 }
184 
185 namespace {
186   // The diagnostic category names.
187   struct StaticDiagCategoryRec {
188     const char *NameStr;
189     uint8_t NameLen;
190 
191     StringRef getName() const {
192       return StringRef(NameStr, NameLen);
193     }
194   };
195 }
196 
197 // Unfortunately, the split between DiagnosticIDs and Diagnostic is not
198 // particularly clean, but for now we just implement this method here so we can
199 // access GetDefaultDiagMapping.
200 DiagnosticMappingInfo &DiagnosticsEngine::DiagState::getOrAddMappingInfo(
201   diag::kind Diag)
202 {
203   std::pair<iterator, bool> Result = DiagMap.insert(
204     std::make_pair(Diag, DiagnosticMappingInfo()));
205 
206   // Initialize the entry if we added it.
207   if (Result.second)
208     Result.first->second = GetDefaultDiagMappingInfo(Diag);
209 
210   return Result.first->second;
211 }
212 
213 static const StaticDiagCategoryRec CategoryNameTable[] = {
214 #define GET_CATEGORY_TABLE
215 #define CATEGORY(X, ENUM) { X, STR_SIZE(X, uint8_t) },
216 #include "clang/Basic/DiagnosticGroups.inc"
217 #undef GET_CATEGORY_TABLE
218   { 0, 0 }
219 };
220 
221 /// getNumberOfCategories - Return the number of categories
222 unsigned DiagnosticIDs::getNumberOfCategories() {
223   return llvm::array_lengthof(CategoryNameTable) - 1;
224 }
225 
226 /// getCategoryNameFromID - Given a category ID, return the name of the
227 /// category, an empty string if CategoryID is zero, or null if CategoryID is
228 /// invalid.
229 StringRef DiagnosticIDs::getCategoryNameFromID(unsigned CategoryID) {
230   if (CategoryID >= getNumberOfCategories())
231    return StringRef();
232   return CategoryNameTable[CategoryID].getName();
233 }
234 
235 
236 
237 DiagnosticIDs::SFINAEResponse
238 DiagnosticIDs::getDiagnosticSFINAEResponse(unsigned DiagID) {
239   if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
240     return static_cast<DiagnosticIDs::SFINAEResponse>(Info->SFINAE);
241   return SFINAE_Report;
242 }
243 
244 /// getBuiltinDiagClass - Return the class field of the diagnostic.
245 ///
246 static unsigned getBuiltinDiagClass(unsigned DiagID) {
247   if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
248     return Info->Class;
249   return ~0U;
250 }
251 
252 //===----------------------------------------------------------------------===//
253 // Custom Diagnostic information
254 //===----------------------------------------------------------------------===//
255 
256 namespace clang {
257   namespace diag {
258     class CustomDiagInfo {
259       typedef std::pair<DiagnosticIDs::Level, std::string> DiagDesc;
260       std::vector<DiagDesc> DiagInfo;
261       std::map<DiagDesc, unsigned> DiagIDs;
262     public:
263 
264       /// getDescription - Return the description of the specified custom
265       /// diagnostic.
266       StringRef getDescription(unsigned DiagID) const {
267         assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
268                "Invalid diagnostic ID");
269         return DiagInfo[DiagID-DIAG_UPPER_LIMIT].second;
270       }
271 
272       /// getLevel - Return the level of the specified custom diagnostic.
273       DiagnosticIDs::Level getLevel(unsigned DiagID) const {
274         assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
275                "Invalid diagnostic ID");
276         return DiagInfo[DiagID-DIAG_UPPER_LIMIT].first;
277       }
278 
279       unsigned getOrCreateDiagID(DiagnosticIDs::Level L, StringRef Message,
280                                  DiagnosticIDs &Diags) {
281         DiagDesc D(L, Message);
282         // Check to see if it already exists.
283         std::map<DiagDesc, unsigned>::iterator I = DiagIDs.lower_bound(D);
284         if (I != DiagIDs.end() && I->first == D)
285           return I->second;
286 
287         // If not, assign a new ID.
288         unsigned ID = DiagInfo.size()+DIAG_UPPER_LIMIT;
289         DiagIDs.insert(std::make_pair(D, ID));
290         DiagInfo.push_back(D);
291         return ID;
292       }
293     };
294 
295   } // end diag namespace
296 } // end clang namespace
297 
298 
299 //===----------------------------------------------------------------------===//
300 // Common Diagnostic implementation
301 //===----------------------------------------------------------------------===//
302 
303 DiagnosticIDs::DiagnosticIDs() {
304   CustomDiagInfo = 0;
305 }
306 
307 DiagnosticIDs::~DiagnosticIDs() {
308   delete CustomDiagInfo;
309 }
310 
311 /// getCustomDiagID - Return an ID for a diagnostic with the specified message
312 /// and level.  If this is the first request for this diagnostic, it is
313 /// registered and created, otherwise the existing ID is returned.
314 ///
315 /// \param Message A fixed diagnostic format string that will be hashed and
316 /// mapped to a unique DiagID.
317 unsigned DiagnosticIDs::getCustomDiagID(Level L, StringRef Message) {
318   if (CustomDiagInfo == 0)
319     CustomDiagInfo = new diag::CustomDiagInfo();
320   return CustomDiagInfo->getOrCreateDiagID(L, Message, *this);
321 }
322 
323 
324 /// isBuiltinWarningOrExtension - Return true if the unmapped diagnostic
325 /// level of the specified diagnostic ID is a Warning or Extension.
326 /// This only works on builtin diagnostics, not custom ones, and is not legal to
327 /// call on NOTEs.
328 bool DiagnosticIDs::isBuiltinWarningOrExtension(unsigned DiagID) {
329   return DiagID < diag::DIAG_UPPER_LIMIT &&
330          getBuiltinDiagClass(DiagID) != CLASS_ERROR;
331 }
332 
333 /// \brief Determine whether the given built-in diagnostic ID is a
334 /// Note.
335 bool DiagnosticIDs::isBuiltinNote(unsigned DiagID) {
336   return DiagID < diag::DIAG_UPPER_LIMIT &&
337     getBuiltinDiagClass(DiagID) == CLASS_NOTE;
338 }
339 
340 /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic
341 /// ID is for an extension of some sort.  This also returns EnabledByDefault,
342 /// which is set to indicate whether the diagnostic is ignored by default (in
343 /// which case -pedantic enables it) or treated as a warning/error by default.
344 ///
345 bool DiagnosticIDs::isBuiltinExtensionDiag(unsigned DiagID,
346                                         bool &EnabledByDefault) {
347   if (DiagID >= diag::DIAG_UPPER_LIMIT ||
348       getBuiltinDiagClass(DiagID) != CLASS_EXTENSION)
349     return false;
350 
351   EnabledByDefault =
352     GetDefaultDiagMappingInfo(DiagID).getMapping() != diag::MAP_IGNORE;
353   return true;
354 }
355 
356 bool DiagnosticIDs::isDefaultMappingAsError(unsigned DiagID) {
357   if (DiagID >= diag::DIAG_UPPER_LIMIT)
358     return false;
359 
360   return GetDefaultDiagMappingInfo(DiagID).getMapping() == diag::MAP_ERROR;
361 }
362 
363 /// getDescription - Given a diagnostic ID, return a description of the
364 /// issue.
365 StringRef DiagnosticIDs::getDescription(unsigned DiagID) const {
366   if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
367     return Info->getDescription();
368   return CustomDiagInfo->getDescription(DiagID);
369 }
370 
371 /// getDiagnosticLevel - Based on the way the client configured the
372 /// DiagnosticsEngine object, classify the specified diagnostic ID into a Level,
373 /// by consumable the DiagnosticClient.
374 DiagnosticIDs::Level
375 DiagnosticIDs::getDiagnosticLevel(unsigned DiagID, SourceLocation Loc,
376                                   const DiagnosticsEngine &Diag) const {
377   // Handle custom diagnostics, which cannot be mapped.
378   if (DiagID >= diag::DIAG_UPPER_LIMIT)
379     return CustomDiagInfo->getLevel(DiagID);
380 
381   unsigned DiagClass = getBuiltinDiagClass(DiagID);
382   if (DiagClass == CLASS_NOTE) return DiagnosticIDs::Note;
383   return getDiagnosticLevel(DiagID, DiagClass, Loc, Diag);
384 }
385 
386 /// \brief Based on the way the client configured the Diagnostic
387 /// object, classify the specified diagnostic ID into a Level, consumable by
388 /// the DiagnosticClient.
389 ///
390 /// \param Loc The source location we are interested in finding out the
391 /// diagnostic state. Can be null in order to query the latest state.
392 DiagnosticIDs::Level
393 DiagnosticIDs::getDiagnosticLevel(unsigned DiagID, unsigned DiagClass,
394                                   SourceLocation Loc,
395                                   const DiagnosticsEngine &Diag) const {
396   // Specific non-error diagnostics may be mapped to various levels from ignored
397   // to error.  Errors can only be mapped to fatal.
398   DiagnosticIDs::Level Result = DiagnosticIDs::Fatal;
399 
400   DiagnosticsEngine::DiagStatePointsTy::iterator
401     Pos = Diag.GetDiagStatePointForLoc(Loc);
402   DiagnosticsEngine::DiagState *State = Pos->State;
403 
404   // Get the mapping information, or compute it lazily.
405   DiagnosticMappingInfo &MappingInfo = State->getOrAddMappingInfo(
406     (diag::kind)DiagID);
407 
408   switch (MappingInfo.getMapping()) {
409   case diag::MAP_IGNORE:
410     Result = DiagnosticIDs::Ignored;
411     break;
412   case diag::MAP_WARNING:
413     Result = DiagnosticIDs::Warning;
414     break;
415   case diag::MAP_ERROR:
416     Result = DiagnosticIDs::Error;
417     break;
418   case diag::MAP_FATAL:
419     Result = DiagnosticIDs::Fatal;
420     break;
421   }
422 
423   // Upgrade ignored diagnostics if -Weverything is enabled.
424   if (Diag.EnableAllWarnings && Result == DiagnosticIDs::Ignored &&
425       !MappingInfo.isUser())
426     Result = DiagnosticIDs::Warning;
427 
428   // Ignore -pedantic diagnostics inside __extension__ blocks.
429   // (The diagnostics controlled by -pedantic are the extension diagnostics
430   // that are not enabled by default.)
431   bool EnabledByDefault = false;
432   bool IsExtensionDiag = isBuiltinExtensionDiag(DiagID, EnabledByDefault);
433   if (Diag.AllExtensionsSilenced && IsExtensionDiag && !EnabledByDefault)
434     return DiagnosticIDs::Ignored;
435 
436   // For extension diagnostics that haven't been explicitly mapped, check if we
437   // should upgrade the diagnostic.
438   if (IsExtensionDiag && !MappingInfo.isUser()) {
439     switch (Diag.ExtBehavior) {
440     case DiagnosticsEngine::Ext_Ignore:
441       break;
442     case DiagnosticsEngine::Ext_Warn:
443       // Upgrade ignored diagnostics to warnings.
444       if (Result == DiagnosticIDs::Ignored)
445         Result = DiagnosticIDs::Warning;
446       break;
447     case DiagnosticsEngine::Ext_Error:
448       // Upgrade ignored or warning diagnostics to errors.
449       if (Result == DiagnosticIDs::Ignored || Result == DiagnosticIDs::Warning)
450         Result = DiagnosticIDs::Error;
451       break;
452     }
453   }
454 
455   // At this point, ignored errors can no longer be upgraded.
456   if (Result == DiagnosticIDs::Ignored)
457     return Result;
458 
459   // Honor -w, which is lower in priority than pedantic-errors, but higher than
460   // -Werror.
461   if (Result == DiagnosticIDs::Warning && Diag.IgnoreAllWarnings)
462     return DiagnosticIDs::Ignored;
463 
464   // If -Werror is enabled, map warnings to errors unless explicitly disabled.
465   if (Result == DiagnosticIDs::Warning) {
466     if (Diag.WarningsAsErrors && !MappingInfo.hasNoWarningAsError())
467       Result = DiagnosticIDs::Error;
468   }
469 
470   // If -Wfatal-errors is enabled, map errors to fatal unless explicity
471   // disabled.
472   if (Result == DiagnosticIDs::Error) {
473     if (Diag.ErrorsAsFatal && !MappingInfo.hasNoErrorAsFatal())
474       Result = DiagnosticIDs::Fatal;
475   }
476 
477   // If we are in a system header, we ignore it. We look at the diagnostic class
478   // because we also want to ignore extensions and warnings in -Werror and
479   // -pedantic-errors modes, which *map* warnings/extensions to errors.
480   if (Result >= DiagnosticIDs::Warning &&
481       DiagClass != CLASS_ERROR &&
482       // Custom diagnostics always are emitted in system headers.
483       DiagID < diag::DIAG_UPPER_LIMIT &&
484       !MappingInfo.hasShowInSystemHeader() &&
485       Diag.SuppressSystemWarnings &&
486       Loc.isValid() &&
487       Diag.getSourceManager().isInSystemHeader(
488           Diag.getSourceManager().getExpansionLoc(Loc)))
489     return DiagnosticIDs::Ignored;
490 
491   return Result;
492 }
493 
494 #define GET_DIAG_ARRAYS
495 #include "clang/Basic/DiagnosticGroups.inc"
496 #undef GET_DIAG_ARRAYS
497 
498 namespace {
499   struct WarningOption {
500     uint16_t NameOffset;
501     uint16_t Members;
502     uint16_t SubGroups;
503 
504     // String is stored with a pascal-style length byte.
505     StringRef getName() const {
506       return StringRef(DiagGroupNames + NameOffset + 1,
507                        DiagGroupNames[NameOffset]);
508     }
509   };
510 }
511 
512 // Second the table of options, sorted by name for fast binary lookup.
513 static const WarningOption OptionTable[] = {
514 #define GET_DIAG_TABLE
515 #include "clang/Basic/DiagnosticGroups.inc"
516 #undef GET_DIAG_TABLE
517 };
518 static const size_t OptionTableSize = llvm::array_lengthof(OptionTable);
519 
520 static bool WarningOptionCompare(const WarningOption &LHS, StringRef RHS) {
521   return LHS.getName() < RHS;
522 }
523 
524 /// getWarningOptionForDiag - Return the lowest-level warning option that
525 /// enables the specified diagnostic.  If there is no -Wfoo flag that controls
526 /// the diagnostic, this returns null.
527 StringRef DiagnosticIDs::getWarningOptionForDiag(unsigned DiagID) {
528   if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
529     return OptionTable[Info->getOptionGroupIndex()].getName();
530   return StringRef();
531 }
532 
533 static void getDiagnosticsInGroup(const WarningOption *Group,
534                                   SmallVectorImpl<diag::kind> &Diags) {
535   // Add the members of the option diagnostic set.
536   const int16_t *Member = DiagArrays + Group->Members;
537   for (; *Member != -1; ++Member)
538     Diags.push_back(*Member);
539 
540   // Add the members of the subgroups.
541   const int16_t *SubGroups = DiagSubGroups + Group->SubGroups;
542   for (; *SubGroups != (int16_t)-1; ++SubGroups)
543     getDiagnosticsInGroup(&OptionTable[(short)*SubGroups], Diags);
544 }
545 
546 bool DiagnosticIDs::getDiagnosticsInGroup(
547     StringRef Group,
548     SmallVectorImpl<diag::kind> &Diags) const {
549   const WarningOption *Found =
550   std::lower_bound(OptionTable, OptionTable + OptionTableSize, Group,
551                    WarningOptionCompare);
552   if (Found == OptionTable + OptionTableSize ||
553       Found->getName() != Group)
554     return true; // Option not found.
555 
556   ::getDiagnosticsInGroup(Found, Diags);
557   return false;
558 }
559 
560 void DiagnosticIDs::getAllDiagnostics(
561                                SmallVectorImpl<diag::kind> &Diags) const {
562   for (unsigned i = 0; i != StaticDiagInfoSize; ++i)
563     Diags.push_back(StaticDiagInfo[i].DiagID);
564 }
565 
566 StringRef DiagnosticIDs::getNearestWarningOption(StringRef Group) {
567   StringRef Best;
568   unsigned BestDistance = Group.size() + 1; // Sanity threshold.
569   for (const WarningOption *i = OptionTable, *e = OptionTable + OptionTableSize;
570        i != e; ++i) {
571     // Don't suggest ignored warning flags.
572     if (!i->Members && !i->SubGroups)
573       continue;
574 
575     unsigned Distance = i->getName().edit_distance(Group, true, BestDistance);
576     if (Distance == BestDistance) {
577       // Two matches with the same distance, don't prefer one over the other.
578       Best = "";
579     } else if (Distance < BestDistance) {
580       // This is a better match.
581       Best = i->getName();
582       BestDistance = Distance;
583     }
584   }
585 
586   return Best;
587 }
588 
589 /// ProcessDiag - This is the method used to report a diagnostic that is
590 /// finally fully formed.
591 bool DiagnosticIDs::ProcessDiag(DiagnosticsEngine &Diag) const {
592   Diagnostic Info(&Diag);
593 
594   if (Diag.SuppressAllDiagnostics)
595     return false;
596 
597   assert(Diag.getClient() && "DiagnosticClient not set!");
598 
599   // Figure out the diagnostic level of this message.
600   unsigned DiagID = Info.getID();
601   DiagnosticIDs::Level DiagLevel
602     = getDiagnosticLevel(DiagID, Info.getLocation(), Diag);
603 
604   if (DiagLevel != DiagnosticIDs::Note) {
605     // Record that a fatal error occurred only when we see a second
606     // non-note diagnostic. This allows notes to be attached to the
607     // fatal error, but suppresses any diagnostics that follow those
608     // notes.
609     if (Diag.LastDiagLevel == DiagnosticIDs::Fatal)
610       Diag.FatalErrorOccurred = true;
611 
612     Diag.LastDiagLevel = DiagLevel;
613   }
614 
615   // Update counts for DiagnosticErrorTrap even if a fatal error occurred.
616   if (DiagLevel >= DiagnosticIDs::Error) {
617     ++Diag.TrapNumErrorsOccurred;
618     if (isUnrecoverable(DiagID))
619       ++Diag.TrapNumUnrecoverableErrorsOccurred;
620   }
621 
622   // If a fatal error has already been emitted, silence all subsequent
623   // diagnostics.
624   if (Diag.FatalErrorOccurred) {
625     if (DiagLevel >= DiagnosticIDs::Error &&
626         Diag.Client->IncludeInDiagnosticCounts()) {
627       ++Diag.NumErrors;
628       ++Diag.NumErrorsSuppressed;
629     }
630 
631     return false;
632   }
633 
634   // If the client doesn't care about this message, don't issue it.  If this is
635   // a note and the last real diagnostic was ignored, ignore it too.
636   if (DiagLevel == DiagnosticIDs::Ignored ||
637       (DiagLevel == DiagnosticIDs::Note &&
638        Diag.LastDiagLevel == DiagnosticIDs::Ignored))
639     return false;
640 
641   if (DiagLevel >= DiagnosticIDs::Error) {
642     if (isUnrecoverable(DiagID))
643       Diag.UnrecoverableErrorOccurred = true;
644 
645     // Warnings which have been upgraded to errors do not prevent compilation.
646     if (isDefaultMappingAsError(DiagID))
647       Diag.UncompilableErrorOccurred = true;
648 
649     Diag.ErrorOccurred = true;
650     if (Diag.Client->IncludeInDiagnosticCounts()) {
651       ++Diag.NumErrors;
652     }
653 
654     // If we've emitted a lot of errors, emit a fatal error instead of it to
655     // stop a flood of bogus errors.
656     if (Diag.ErrorLimit && Diag.NumErrors > Diag.ErrorLimit &&
657         DiagLevel == DiagnosticIDs::Error) {
658       Diag.SetDelayedDiagnostic(diag::fatal_too_many_errors);
659       return false;
660     }
661   }
662 
663   // Finally, report it.
664   EmitDiag(Diag, DiagLevel);
665   return true;
666 }
667 
668 void DiagnosticIDs::EmitDiag(DiagnosticsEngine &Diag, Level DiagLevel) const {
669   Diagnostic Info(&Diag);
670   assert(DiagLevel != DiagnosticIDs::Ignored && "Cannot emit ignored diagnostics!");
671 
672   Diag.Client->HandleDiagnostic((DiagnosticsEngine::Level)DiagLevel, Info);
673   if (Diag.Client->IncludeInDiagnosticCounts()) {
674     if (DiagLevel == DiagnosticIDs::Warning)
675       ++Diag.NumWarnings;
676   }
677 
678   Diag.CurDiagID = ~0U;
679 }
680 
681 bool DiagnosticIDs::isUnrecoverable(unsigned DiagID) const {
682   if (DiagID >= diag::DIAG_UPPER_LIMIT) {
683     // Custom diagnostics.
684     return CustomDiagInfo->getLevel(DiagID) >= DiagnosticIDs::Error;
685   }
686 
687   // Only errors may be unrecoverable.
688   if (getBuiltinDiagClass(DiagID) < CLASS_ERROR)
689     return false;
690 
691   if (DiagID == diag::err_unavailable ||
692       DiagID == diag::err_unavailable_message)
693     return false;
694 
695   // Currently we consider all ARC errors as recoverable.
696   if (isARCDiagnostic(DiagID))
697     return false;
698 
699   return true;
700 }
701 
702 bool DiagnosticIDs::isARCDiagnostic(unsigned DiagID) {
703   unsigned cat = getCategoryNumberForDiag(DiagID);
704   return DiagnosticIDs::getCategoryNameFromID(cat).startswith("ARC ");
705 }
706