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