Diagnostic.cpp revision b535041ee33c5eff255832bc5541c8d52aae8254 
1//===--- Diagnostic.cpp - C Language Family Diagnostic 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-related interfaces.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/AST/ASTDiagnostic.h"
15#include "clang/Analysis/AnalysisDiagnostic.h"
16#include "clang/Basic/Diagnostic.h"
17#include "clang/Basic/FileManager.h"
18#include "clang/Basic/IdentifierTable.h"
19#include "clang/Basic/PartialDiagnostic.h"
20#include "clang/Basic/SourceLocation.h"
21#include "clang/Basic/SourceManager.h"
22#include "clang/Driver/DriverDiagnostic.h"
23#include "clang/Frontend/FrontendDiagnostic.h"
24#include "clang/Lex/LexDiagnostic.h"
25#include "clang/Parse/ParseDiagnostic.h"
26#include "clang/Sema/SemaDiagnostic.h"
27#include "llvm/ADT/SmallVector.h"
28#include "llvm/ADT/StringExtras.h"
29#include "llvm/Support/MemoryBuffer.h"
30#include "llvm/Support/raw_ostream.h"
31
32#include <vector>
33#include <map>
34#include <cstring>
35using namespace clang;
36
37//===----------------------------------------------------------------------===//
38// Builtin Diagnostic information
39//===----------------------------------------------------------------------===//
40
41namespace {
42
43// Diagnostic classes.
44enum {
45  CLASS_NOTE       = 0x01,
46  CLASS_WARNING    = 0x02,
47  CLASS_EXTENSION  = 0x03,
48  CLASS_ERROR      = 0x04
49};
50
51struct StaticDiagInfoRec {
52  unsigned short DiagID;
53  unsigned Mapping : 3;
54  unsigned Class : 3;
55  bool SFINAE : 1;
56  unsigned Category : 5;
57
58  const char *Description;
59  const char *OptionGroup;
60
61  bool operator<(const StaticDiagInfoRec &RHS) const {
62    return DiagID < RHS.DiagID;
63  }
64};
65
66}
67
68static const StaticDiagInfoRec StaticDiagInfo[] = {
69#define DIAG(ENUM,CLASS,DEFAULT_MAPPING,DESC,GROUP,SFINAE, CATEGORY)    \
70  { diag::ENUM, DEFAULT_MAPPING, CLASS, SFINAE, CATEGORY, DESC, GROUP },
71#include "clang/Basic/DiagnosticCommonKinds.inc"
72#include "clang/Basic/DiagnosticDriverKinds.inc"
73#include "clang/Basic/DiagnosticFrontendKinds.inc"
74#include "clang/Basic/DiagnosticLexKinds.inc"
75#include "clang/Basic/DiagnosticParseKinds.inc"
76#include "clang/Basic/DiagnosticASTKinds.inc"
77#include "clang/Basic/DiagnosticSemaKinds.inc"
78#include "clang/Basic/DiagnosticAnalysisKinds.inc"
79  { 0, 0, 0, 0, 0, 0, 0}
80};
81#undef DIAG
82
83/// GetDiagInfo - Return the StaticDiagInfoRec entry for the specified DiagID,
84/// or null if the ID is invalid.
85static const StaticDiagInfoRec *GetDiagInfo(unsigned DiagID) {
86  unsigned NumDiagEntries = sizeof(StaticDiagInfo)/sizeof(StaticDiagInfo[0])-1;
87
88  // If assertions are enabled, verify that the StaticDiagInfo array is sorted.
89#ifndef NDEBUG
90  static bool IsFirst = true;
91  if (IsFirst) {
92    for (unsigned i = 1; i != NumDiagEntries; ++i) {
93      assert(StaticDiagInfo[i-1].DiagID != StaticDiagInfo[i].DiagID &&
94             "Diag ID conflict, the enums at the start of clang::diag (in "
95             "Diagnostic.h) probably need to be increased");
96
97      assert(StaticDiagInfo[i-1] < StaticDiagInfo[i] &&
98             "Improperly sorted diag info");
99    }
100    IsFirst = false;
101  }
102#endif
103
104  // Search the diagnostic table with a binary search.
105  StaticDiagInfoRec Find = { DiagID, 0, 0, 0, 0, 0, 0 };
106
107  const StaticDiagInfoRec *Found =
108    std::lower_bound(StaticDiagInfo, StaticDiagInfo + NumDiagEntries, Find);
109  if (Found == StaticDiagInfo + NumDiagEntries ||
110      Found->DiagID != DiagID)
111    return 0;
112
113  return Found;
114}
115
116static unsigned GetDefaultDiagMapping(unsigned DiagID) {
117  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
118    return Info->Mapping;
119  return diag::MAP_FATAL;
120}
121
122/// getWarningOptionForDiag - Return the lowest-level warning option that
123/// enables the specified diagnostic.  If there is no -Wfoo flag that controls
124/// the diagnostic, this returns null.
125const char *Diagnostic::getWarningOptionForDiag(unsigned DiagID) {
126  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
127    return Info->OptionGroup;
128  return 0;
129}
130
131/// getWarningOptionForDiag - Return the category number that a specified
132/// DiagID belongs to, or 0 if no category.
133unsigned Diagnostic::getCategoryNumberForDiag(unsigned DiagID) {
134  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
135    return Info->Category;
136  return 0;
137}
138
139/// getCategoryNameFromID - Given a category ID, return the name of the
140/// category, an empty string if CategoryID is zero, or null if CategoryID is
141/// invalid.
142const char *Diagnostic::getCategoryNameFromID(unsigned CategoryID) {
143  // Second the table of options, sorted by name for fast binary lookup.
144  static const char *CategoryNameTable[] = {
145#define GET_CATEGORY_TABLE
146#define CATEGORY(X) X,
147#include "clang/Basic/DiagnosticGroups.inc"
148#undef GET_CATEGORY_TABLE
149    "<<END>>"
150  };
151  static const size_t CategoryNameTableSize =
152    sizeof(CategoryNameTable) / sizeof(CategoryNameTable[0])-1;
153
154  if (CategoryID >= CategoryNameTableSize) return 0;
155  return CategoryNameTable[CategoryID];
156}
157
158
159
160Diagnostic::SFINAEResponse
161Diagnostic::getDiagnosticSFINAEResponse(unsigned DiagID) {
162  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID)) {
163    if (!Info->SFINAE)
164      return SFINAE_Report;
165
166    if (Info->Class == CLASS_ERROR)
167      return SFINAE_SubstitutionFailure;
168
169    // Suppress notes, warnings, and extensions;
170    return SFINAE_Suppress;
171  }
172
173  return SFINAE_Report;
174}
175
176/// getDiagClass - Return the class field of the diagnostic.
177///
178static unsigned getBuiltinDiagClass(unsigned DiagID) {
179  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
180    return Info->Class;
181  return ~0U;
182}
183
184//===----------------------------------------------------------------------===//
185// Custom Diagnostic information
186//===----------------------------------------------------------------------===//
187
188namespace clang {
189  namespace diag {
190    class CustomDiagInfo {
191      typedef std::pair<Diagnostic::Level, std::string> DiagDesc;
192      std::vector<DiagDesc> DiagInfo;
193      std::map<DiagDesc, unsigned> DiagIDs;
194    public:
195
196      /// getDescription - Return the description of the specified custom
197      /// diagnostic.
198      const char *getDescription(unsigned DiagID) const {
199        assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
200               "Invalid diagnosic ID");
201        return DiagInfo[DiagID-DIAG_UPPER_LIMIT].second.c_str();
202      }
203
204      /// getLevel - Return the level of the specified custom diagnostic.
205      Diagnostic::Level getLevel(unsigned DiagID) const {
206        assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
207               "Invalid diagnosic ID");
208        return DiagInfo[DiagID-DIAG_UPPER_LIMIT].first;
209      }
210
211      unsigned getOrCreateDiagID(Diagnostic::Level L, llvm::StringRef Message,
212                                 Diagnostic &Diags) {
213        DiagDesc D(L, Message);
214        // Check to see if it already exists.
215        std::map<DiagDesc, unsigned>::iterator I = DiagIDs.lower_bound(D);
216        if (I != DiagIDs.end() && I->first == D)
217          return I->second;
218
219        // If not, assign a new ID.
220        unsigned ID = DiagInfo.size()+DIAG_UPPER_LIMIT;
221        DiagIDs.insert(std::make_pair(D, ID));
222        DiagInfo.push_back(D);
223        return ID;
224      }
225    };
226
227  } // end diag namespace
228} // end clang namespace
229
230
231//===----------------------------------------------------------------------===//
232// Common Diagnostic implementation
233//===----------------------------------------------------------------------===//
234
235static void DummyArgToStringFn(Diagnostic::ArgumentKind AK, intptr_t QT,
236                               const char *Modifier, unsigned ML,
237                               const char *Argument, unsigned ArgLen,
238                               const Diagnostic::ArgumentValue *PrevArgs,
239                               unsigned NumPrevArgs,
240                               llvm::SmallVectorImpl<char> &Output,
241                               void *Cookie) {
242  const char *Str = "<can't format argument>";
243  Output.append(Str, Str+strlen(Str));
244}
245
246
247Diagnostic::Diagnostic(DiagnosticClient *client) : Client(client) {
248  ArgToStringFn = DummyArgToStringFn;
249  ArgToStringCookie = 0;
250
251  AllExtensionsSilenced = 0;
252  IgnoreAllWarnings = false;
253  WarningsAsErrors = false;
254  ErrorsAsFatal = false;
255  SuppressSystemWarnings = false;
256  SuppressAllDiagnostics = false;
257  ShowOverloads = Ovl_All;
258  ExtBehavior = Ext_Ignore;
259
260  ErrorLimit = 0;
261  TemplateBacktraceLimit = 0;
262  CustomDiagInfo = 0;
263
264  // Set all mappings to 'unset'.
265  DiagMappingsStack.clear();
266  DiagMappingsStack.push_back(DiagMappings());
267
268  Reset();
269}
270
271Diagnostic::~Diagnostic() {
272  delete CustomDiagInfo;
273}
274
275
276void Diagnostic::pushMappings() {
277  // Avoids undefined behavior when the stack has to resize.
278  DiagMappingsStack.reserve(DiagMappingsStack.size() + 1);
279  DiagMappingsStack.push_back(DiagMappingsStack.back());
280}
281
282bool Diagnostic::popMappings() {
283  if (DiagMappingsStack.size() == 1)
284    return false;
285
286  DiagMappingsStack.pop_back();
287  return true;
288}
289
290/// getCustomDiagID - Return an ID for a diagnostic with the specified message
291/// and level.  If this is the first request for this diagnosic, it is
292/// registered and created, otherwise the existing ID is returned.
293unsigned Diagnostic::getCustomDiagID(Level L, llvm::StringRef Message) {
294  if (CustomDiagInfo == 0)
295    CustomDiagInfo = new diag::CustomDiagInfo();
296  return CustomDiagInfo->getOrCreateDiagID(L, Message, *this);
297}
298
299
300/// isBuiltinWarningOrExtension - Return true if the unmapped diagnostic
301/// level of the specified diagnostic ID is a Warning or Extension.
302/// This only works on builtin diagnostics, not custom ones, and is not legal to
303/// call on NOTEs.
304bool Diagnostic::isBuiltinWarningOrExtension(unsigned DiagID) {
305  return DiagID < diag::DIAG_UPPER_LIMIT &&
306         getBuiltinDiagClass(DiagID) != CLASS_ERROR;
307}
308
309/// \brief Determine whether the given built-in diagnostic ID is a
310/// Note.
311bool Diagnostic::isBuiltinNote(unsigned DiagID) {
312  return DiagID < diag::DIAG_UPPER_LIMIT &&
313    getBuiltinDiagClass(DiagID) == CLASS_NOTE;
314}
315
316/// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic
317/// ID is for an extension of some sort.  This also returns EnabledByDefault,
318/// which is set to indicate whether the diagnostic is ignored by default (in
319/// which case -pedantic enables it) or treated as a warning/error by default.
320///
321bool Diagnostic::isBuiltinExtensionDiag(unsigned DiagID,
322                                        bool &EnabledByDefault) {
323  if (DiagID >= diag::DIAG_UPPER_LIMIT ||
324      getBuiltinDiagClass(DiagID) != CLASS_EXTENSION)
325    return false;
326
327  EnabledByDefault = GetDefaultDiagMapping(DiagID) != diag::MAP_IGNORE;
328  return true;
329}
330
331void Diagnostic::Reset() {
332  ErrorOccurred = false;
333  FatalErrorOccurred = false;
334
335  NumWarnings = 0;
336  NumErrors = 0;
337  NumErrorsSuppressed = 0;
338  CurDiagID = ~0U;
339  LastDiagLevel = Ignored;
340  DelayedDiagID = 0;
341}
342
343/// getDescription - Given a diagnostic ID, return a description of the
344/// issue.
345const char *Diagnostic::getDescription(unsigned DiagID) const {
346  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
347    return Info->Description;
348  return CustomDiagInfo->getDescription(DiagID);
349}
350
351void Diagnostic::SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1,
352                                      llvm::StringRef Arg2) {
353  if (DelayedDiagID)
354    return;
355
356  DelayedDiagID = DiagID;
357  DelayedDiagArg1 = Arg1.str();
358  DelayedDiagArg2 = Arg2.str();
359}
360
361void Diagnostic::ReportDelayed() {
362  Report(DelayedDiagID) << DelayedDiagArg1 << DelayedDiagArg2;
363  DelayedDiagID = 0;
364  DelayedDiagArg1.clear();
365  DelayedDiagArg2.clear();
366}
367
368/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
369/// object, classify the specified diagnostic ID into a Level, consumable by
370/// the DiagnosticClient.
371Diagnostic::Level Diagnostic::getDiagnosticLevel(unsigned DiagID) const {
372  // Handle custom diagnostics, which cannot be mapped.
373  if (DiagID >= diag::DIAG_UPPER_LIMIT)
374    return CustomDiagInfo->getLevel(DiagID);
375
376  unsigned DiagClass = getBuiltinDiagClass(DiagID);
377  assert(DiagClass != CLASS_NOTE && "Cannot get diagnostic level of a note!");
378  return getDiagnosticLevel(DiagID, DiagClass);
379}
380
381/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
382/// object, classify the specified diagnostic ID into a Level, consumable by
383/// the DiagnosticClient.
384Diagnostic::Level
385Diagnostic::getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const {
386  // Specific non-error diagnostics may be mapped to various levels from ignored
387  // to error.  Errors can only be mapped to fatal.
388  Diagnostic::Level Result = Diagnostic::Fatal;
389
390  // Get the mapping information, if unset, compute it lazily.
391  unsigned MappingInfo = getDiagnosticMappingInfo((diag::kind)DiagID);
392  if (MappingInfo == 0) {
393    MappingInfo = GetDefaultDiagMapping(DiagID);
394    setDiagnosticMappingInternal(DiagID, MappingInfo, false);
395  }
396
397  switch (MappingInfo & 7) {
398  default: assert(0 && "Unknown mapping!");
399  case diag::MAP_IGNORE:
400    // Ignore this, unless this is an extension diagnostic and we're mapping
401    // them onto warnings or errors.
402    if (!isBuiltinExtensionDiag(DiagID) ||  // Not an extension
403        ExtBehavior == Ext_Ignore ||        // Extensions ignored anyway
404        (MappingInfo & 8) != 0)             // User explicitly mapped it.
405      return Diagnostic::Ignored;
406    Result = Diagnostic::Warning;
407    if (ExtBehavior == Ext_Error) Result = Diagnostic::Error;
408    if (Result == Diagnostic::Error && ErrorsAsFatal)
409      Result = Diagnostic::Fatal;
410    break;
411  case diag::MAP_ERROR:
412    Result = Diagnostic::Error;
413    if (ErrorsAsFatal)
414      Result = Diagnostic::Fatal;
415    break;
416  case diag::MAP_FATAL:
417    Result = Diagnostic::Fatal;
418    break;
419  case diag::MAP_WARNING:
420    // If warnings are globally mapped to ignore or error, do it.
421    if (IgnoreAllWarnings)
422      return Diagnostic::Ignored;
423
424    Result = Diagnostic::Warning;
425
426    // If this is an extension diagnostic and we're in -pedantic-error mode, and
427    // if the user didn't explicitly map it, upgrade to an error.
428    if (ExtBehavior == Ext_Error &&
429        (MappingInfo & 8) == 0 &&
430        isBuiltinExtensionDiag(DiagID))
431      Result = Diagnostic::Error;
432
433    if (WarningsAsErrors)
434      Result = Diagnostic::Error;
435    if (Result == Diagnostic::Error && ErrorsAsFatal)
436      Result = Diagnostic::Fatal;
437    break;
438
439  case diag::MAP_WARNING_NO_WERROR:
440    // Diagnostics specified with -Wno-error=foo should be set to warnings, but
441    // not be adjusted by -Werror or -pedantic-errors.
442    Result = Diagnostic::Warning;
443
444    // If warnings are globally mapped to ignore or error, do it.
445    if (IgnoreAllWarnings)
446      return Diagnostic::Ignored;
447
448    break;
449
450  case diag::MAP_ERROR_NO_WFATAL:
451    // Diagnostics specified as -Wno-fatal-error=foo should be errors, but
452    // unaffected by -Wfatal-errors.
453    Result = Diagnostic::Error;
454    break;
455  }
456
457  // Okay, we're about to return this as a "diagnostic to emit" one last check:
458  // if this is any sort of extension warning, and if we're in an __extension__
459  // block, silence it.
460  if (AllExtensionsSilenced && isBuiltinExtensionDiag(DiagID))
461    return Diagnostic::Ignored;
462
463  return Result;
464}
465
466struct WarningOption {
467  const char  *Name;
468  const short *Members;
469  const short *SubGroups;
470};
471
472#define GET_DIAG_ARRAYS
473#include "clang/Basic/DiagnosticGroups.inc"
474#undef GET_DIAG_ARRAYS
475
476// Second the table of options, sorted by name for fast binary lookup.
477static const WarningOption OptionTable[] = {
478#define GET_DIAG_TABLE
479#include "clang/Basic/DiagnosticGroups.inc"
480#undef GET_DIAG_TABLE
481};
482static const size_t OptionTableSize =
483sizeof(OptionTable) / sizeof(OptionTable[0]);
484
485static bool WarningOptionCompare(const WarningOption &LHS,
486                                 const WarningOption &RHS) {
487  return strcmp(LHS.Name, RHS.Name) < 0;
488}
489
490static void MapGroupMembers(const WarningOption *Group, diag::Mapping Mapping,
491                            Diagnostic &Diags) {
492  // Option exists, poke all the members of its diagnostic set.
493  if (const short *Member = Group->Members) {
494    for (; *Member != -1; ++Member)
495      Diags.setDiagnosticMapping(*Member, Mapping);
496  }
497
498  // Enable/disable all subgroups along with this one.
499  if (const short *SubGroups = Group->SubGroups) {
500    for (; *SubGroups != (short)-1; ++SubGroups)
501      MapGroupMembers(&OptionTable[(short)*SubGroups], Mapping, Diags);
502  }
503}
504
505/// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g.
506/// "unknown-pragmas" to have the specified mapping.  This returns true and
507/// ignores the request if "Group" was unknown, false otherwise.
508bool Diagnostic::setDiagnosticGroupMapping(const char *Group,
509                                           diag::Mapping Map) {
510
511  WarningOption Key = { Group, 0, 0 };
512  const WarningOption *Found =
513  std::lower_bound(OptionTable, OptionTable + OptionTableSize, Key,
514                   WarningOptionCompare);
515  if (Found == OptionTable + OptionTableSize ||
516      strcmp(Found->Name, Group) != 0)
517    return true;  // Option not found.
518
519  MapGroupMembers(Found, Map, *this);
520  return false;
521}
522
523
524/// ProcessDiag - This is the method used to report a diagnostic that is
525/// finally fully formed.
526bool Diagnostic::ProcessDiag() {
527  DiagnosticInfo Info(this);
528
529  if (SuppressAllDiagnostics)
530    return false;
531
532  // Figure out the diagnostic level of this message.
533  Diagnostic::Level DiagLevel;
534  unsigned DiagID = Info.getID();
535
536  // ShouldEmitInSystemHeader - True if this diagnostic should be produced even
537  // in a system header.
538  bool ShouldEmitInSystemHeader;
539
540  if (DiagID >= diag::DIAG_UPPER_LIMIT) {
541    // Handle custom diagnostics, which cannot be mapped.
542    DiagLevel = CustomDiagInfo->getLevel(DiagID);
543
544    // Custom diagnostics always are emitted in system headers.
545    ShouldEmitInSystemHeader = true;
546  } else {
547    // Get the class of the diagnostic.  If this is a NOTE, map it onto whatever
548    // the diagnostic level was for the previous diagnostic so that it is
549    // filtered the same as the previous diagnostic.
550    unsigned DiagClass = getBuiltinDiagClass(DiagID);
551    if (DiagClass == CLASS_NOTE) {
552      DiagLevel = Diagnostic::Note;
553      ShouldEmitInSystemHeader = false;  // extra consideration is needed
554    } else {
555      // If this is not an error and we are in a system header, we ignore it.
556      // Check the original Diag ID here, because we also want to ignore
557      // extensions and warnings in -Werror and -pedantic-errors modes, which
558      // *map* warnings/extensions to errors.
559      ShouldEmitInSystemHeader = DiagClass == CLASS_ERROR;
560
561      DiagLevel = getDiagnosticLevel(DiagID, DiagClass);
562    }
563  }
564
565  if (DiagLevel != Diagnostic::Note) {
566    // Record that a fatal error occurred only when we see a second
567    // non-note diagnostic. This allows notes to be attached to the
568    // fatal error, but suppresses any diagnostics that follow those
569    // notes.
570    if (LastDiagLevel == Diagnostic::Fatal)
571      FatalErrorOccurred = true;
572
573    LastDiagLevel = DiagLevel;
574  }
575
576  // If a fatal error has already been emitted, silence all subsequent
577  // diagnostics.
578  if (FatalErrorOccurred) {
579    if (DiagLevel >= Diagnostic::Error && Client->IncludeInDiagnosticCounts()) {
580      ++NumErrors;
581      ++NumErrorsSuppressed;
582    }
583
584    return false;
585  }
586
587  // If the client doesn't care about this message, don't issue it.  If this is
588  // a note and the last real diagnostic was ignored, ignore it too.
589  if (DiagLevel == Diagnostic::Ignored ||
590      (DiagLevel == Diagnostic::Note && LastDiagLevel == Diagnostic::Ignored))
591    return false;
592
593  // If this diagnostic is in a system header and is not a clang error, suppress
594  // it.
595  if (SuppressSystemWarnings && !ShouldEmitInSystemHeader &&
596      Info.getLocation().isValid() &&
597      Info.getLocation().getInstantiationLoc().isInSystemHeader() &&
598      (DiagLevel != Diagnostic::Note || LastDiagLevel == Diagnostic::Ignored)) {
599    LastDiagLevel = Diagnostic::Ignored;
600    return false;
601  }
602
603  if (DiagLevel >= Diagnostic::Error) {
604    if (Client->IncludeInDiagnosticCounts()) {
605      ErrorOccurred = true;
606      ++NumErrors;
607    }
608
609    // If we've emitted a lot of errors, emit a fatal error after it to stop a
610    // flood of bogus errors.
611    if (ErrorLimit && NumErrors >= ErrorLimit &&
612        DiagLevel == Diagnostic::Error)
613      SetDelayedDiagnostic(diag::fatal_too_many_errors);
614  }
615
616  // Finally, report it.
617  Client->HandleDiagnostic(DiagLevel, Info);
618  if (Client->IncludeInDiagnosticCounts()) {
619    if (DiagLevel == Diagnostic::Warning)
620      ++NumWarnings;
621  }
622
623  CurDiagID = ~0U;
624
625  return true;
626}
627
628void DiagnosticBuilder::FlushCounts() {
629  DiagObj->NumDiagArgs = NumArgs;
630  DiagObj->NumDiagRanges = NumRanges;
631  DiagObj->NumFixItHints = NumFixItHints;
632}
633
634bool DiagnosticBuilder::Emit() {
635  // If DiagObj is null, then its soul was stolen by the copy ctor
636  // or the user called Emit().
637  if (DiagObj == 0) return false;
638
639  // When emitting diagnostics, we set the final argument count into
640  // the Diagnostic object.
641  FlushCounts();
642
643  // Process the diagnostic, sending the accumulated information to the
644  // DiagnosticClient.
645  bool Emitted = DiagObj->ProcessDiag();
646
647  // Clear out the current diagnostic object.
648  unsigned DiagID = DiagObj->CurDiagID;
649  DiagObj->Clear();
650
651  // If there was a delayed diagnostic, emit it now.
652  if (DiagObj->DelayedDiagID && DiagObj->DelayedDiagID != DiagID)
653    DiagObj->ReportDelayed();
654
655  // This diagnostic is dead.
656  DiagObj = 0;
657
658  return Emitted;
659}
660
661
662DiagnosticClient::~DiagnosticClient() {}
663
664
665/// ModifierIs - Return true if the specified modifier matches specified string.
666template <std::size_t StrLen>
667static bool ModifierIs(const char *Modifier, unsigned ModifierLen,
668                       const char (&Str)[StrLen]) {
669  return StrLen-1 == ModifierLen && !memcmp(Modifier, Str, StrLen-1);
670}
671
672/// ScanForward - Scans forward, looking for the given character, skipping
673/// nested clauses and escaped characters.
674static const char *ScanFormat(const char *I, const char *E, char Target) {
675  unsigned Depth = 0;
676
677  for ( ; I != E; ++I) {
678    if (Depth == 0 && *I == Target) return I;
679    if (Depth != 0 && *I == '}') Depth--;
680
681    if (*I == '%') {
682      I++;
683      if (I == E) break;
684
685      // Escaped characters get implicitly skipped here.
686
687      // Format specifier.
688      if (!isdigit(*I) && !ispunct(*I)) {
689        for (I++; I != E && !isdigit(*I) && *I != '{'; I++) ;
690        if (I == E) break;
691        if (*I == '{')
692          Depth++;
693      }
694    }
695  }
696  return E;
697}
698
699/// HandleSelectModifier - Handle the integer 'select' modifier.  This is used
700/// like this:  %select{foo|bar|baz}2.  This means that the integer argument
701/// "%2" has a value from 0-2.  If the value is 0, the diagnostic prints 'foo'.
702/// If the value is 1, it prints 'bar'.  If it has the value 2, it prints 'baz'.
703/// This is very useful for certain classes of variant diagnostics.
704static void HandleSelectModifier(const DiagnosticInfo &DInfo, unsigned ValNo,
705                                 const char *Argument, unsigned ArgumentLen,
706                                 llvm::SmallVectorImpl<char> &OutStr) {
707  const char *ArgumentEnd = Argument+ArgumentLen;
708
709  // Skip over 'ValNo' |'s.
710  while (ValNo) {
711    const char *NextVal = ScanFormat(Argument, ArgumentEnd, '|');
712    assert(NextVal != ArgumentEnd && "Value for integer select modifier was"
713           " larger than the number of options in the diagnostic string!");
714    Argument = NextVal+1;  // Skip this string.
715    --ValNo;
716  }
717
718  // Get the end of the value.  This is either the } or the |.
719  const char *EndPtr = ScanFormat(Argument, ArgumentEnd, '|');
720
721  // Recursively format the result of the select clause into the output string.
722  DInfo.FormatDiagnostic(Argument, EndPtr, OutStr);
723}
724
725/// HandleIntegerSModifier - Handle the integer 's' modifier.  This adds the
726/// letter 's' to the string if the value is not 1.  This is used in cases like
727/// this:  "you idiot, you have %4 parameter%s4!".
728static void HandleIntegerSModifier(unsigned ValNo,
729                                   llvm::SmallVectorImpl<char> &OutStr) {
730  if (ValNo != 1)
731    OutStr.push_back('s');
732}
733
734/// HandleOrdinalModifier - Handle the integer 'ord' modifier.  This
735/// prints the ordinal form of the given integer, with 1 corresponding
736/// to the first ordinal.  Currently this is hard-coded to use the
737/// English form.
738static void HandleOrdinalModifier(unsigned ValNo,
739                                  llvm::SmallVectorImpl<char> &OutStr) {
740  assert(ValNo != 0 && "ValNo must be strictly positive!");
741
742  llvm::raw_svector_ostream Out(OutStr);
743
744  // We could use text forms for the first N ordinals, but the numeric
745  // forms are actually nicer in diagnostics because they stand out.
746  Out << ValNo;
747
748  // It is critically important that we do this perfectly for
749  // user-written sequences with over 100 elements.
750  switch (ValNo % 100) {
751  case 11:
752  case 12:
753  case 13:
754    Out << "th"; return;
755  default:
756    switch (ValNo % 10) {
757    case 1: Out << "st"; return;
758    case 2: Out << "nd"; return;
759    case 3: Out << "rd"; return;
760    default: Out << "th"; return;
761    }
762  }
763}
764
765
766/// PluralNumber - Parse an unsigned integer and advance Start.
767static unsigned PluralNumber(const char *&Start, const char *End) {
768  // Programming 101: Parse a decimal number :-)
769  unsigned Val = 0;
770  while (Start != End && *Start >= '0' && *Start <= '9') {
771    Val *= 10;
772    Val += *Start - '0';
773    ++Start;
774  }
775  return Val;
776}
777
778/// TestPluralRange - Test if Val is in the parsed range. Modifies Start.
779static bool TestPluralRange(unsigned Val, const char *&Start, const char *End) {
780  if (*Start != '[') {
781    unsigned Ref = PluralNumber(Start, End);
782    return Ref == Val;
783  }
784
785  ++Start;
786  unsigned Low = PluralNumber(Start, End);
787  assert(*Start == ',' && "Bad plural expression syntax: expected ,");
788  ++Start;
789  unsigned High = PluralNumber(Start, End);
790  assert(*Start == ']' && "Bad plural expression syntax: expected )");
791  ++Start;
792  return Low <= Val && Val <= High;
793}
794
795/// EvalPluralExpr - Actual expression evaluator for HandlePluralModifier.
796static bool EvalPluralExpr(unsigned ValNo, const char *Start, const char *End) {
797  // Empty condition?
798  if (*Start == ':')
799    return true;
800
801  while (1) {
802    char C = *Start;
803    if (C == '%') {
804      // Modulo expression
805      ++Start;
806      unsigned Arg = PluralNumber(Start, End);
807      assert(*Start == '=' && "Bad plural expression syntax: expected =");
808      ++Start;
809      unsigned ValMod = ValNo % Arg;
810      if (TestPluralRange(ValMod, Start, End))
811        return true;
812    } else {
813      assert((C == '[' || (C >= '0' && C <= '9')) &&
814             "Bad plural expression syntax: unexpected character");
815      // Range expression
816      if (TestPluralRange(ValNo, Start, End))
817        return true;
818    }
819
820    // Scan for next or-expr part.
821    Start = std::find(Start, End, ',');
822    if (Start == End)
823      break;
824    ++Start;
825  }
826  return false;
827}
828
829/// HandlePluralModifier - Handle the integer 'plural' modifier. This is used
830/// for complex plural forms, or in languages where all plurals are complex.
831/// The syntax is: %plural{cond1:form1|cond2:form2|:form3}, where condn are
832/// conditions that are tested in order, the form corresponding to the first
833/// that applies being emitted. The empty condition is always true, making the
834/// last form a default case.
835/// Conditions are simple boolean expressions, where n is the number argument.
836/// Here are the rules.
837/// condition  := expression | empty
838/// empty      :=                             -> always true
839/// expression := numeric [',' expression]    -> logical or
840/// numeric    := range                       -> true if n in range
841///             | '%' number '=' range        -> true if n % number in range
842/// range      := number
843///             | '[' number ',' number ']'   -> ranges are inclusive both ends
844///
845/// Here are some examples from the GNU gettext manual written in this form:
846/// English:
847/// {1:form0|:form1}
848/// Latvian:
849/// {0:form2|%100=11,%10=0,%10=[2,9]:form1|:form0}
850/// Gaeilge:
851/// {1:form0|2:form1|:form2}
852/// Romanian:
853/// {1:form0|0,%100=[1,19]:form1|:form2}
854/// Lithuanian:
855/// {%10=0,%100=[10,19]:form2|%10=1:form0|:form1}
856/// Russian (requires repeated form):
857/// {%100=[11,14]:form2|%10=1:form0|%10=[2,4]:form1|:form2}
858/// Slovak
859/// {1:form0|[2,4]:form1|:form2}
860/// Polish (requires repeated form):
861/// {1:form0|%100=[10,20]:form2|%10=[2,4]:form1|:form2}
862static void HandlePluralModifier(unsigned ValNo,
863                                 const char *Argument, unsigned ArgumentLen,
864                                 llvm::SmallVectorImpl<char> &OutStr) {
865  const char *ArgumentEnd = Argument + ArgumentLen;
866  while (1) {
867    assert(Argument < ArgumentEnd && "Plural expression didn't match.");
868    const char *ExprEnd = Argument;
869    while (*ExprEnd != ':') {
870      assert(ExprEnd != ArgumentEnd && "Plural missing expression end");
871      ++ExprEnd;
872    }
873    if (EvalPluralExpr(ValNo, Argument, ExprEnd)) {
874      Argument = ExprEnd + 1;
875      ExprEnd = ScanFormat(Argument, ArgumentEnd, '|');
876      OutStr.append(Argument, ExprEnd);
877      return;
878    }
879    Argument = ScanFormat(Argument, ArgumentEnd - 1, '|') + 1;
880  }
881}
882
883
884/// FormatDiagnostic - Format this diagnostic into a string, substituting the
885/// formal arguments into the %0 slots.  The result is appended onto the Str
886/// array.
887void DiagnosticInfo::
888FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const {
889  const char *DiagStr = getDiags()->getDescription(getID());
890  const char *DiagEnd = DiagStr+strlen(DiagStr);
891
892  FormatDiagnostic(DiagStr, DiagEnd, OutStr);
893}
894
895void DiagnosticInfo::
896FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
897                 llvm::SmallVectorImpl<char> &OutStr) const {
898
899  /// FormattedArgs - Keep track of all of the arguments formatted by
900  /// ConvertArgToString and pass them into subsequent calls to
901  /// ConvertArgToString, allowing the implementation to avoid redundancies in
902  /// obvious cases.
903  llvm::SmallVector<Diagnostic::ArgumentValue, 8> FormattedArgs;
904
905  while (DiagStr != DiagEnd) {
906    if (DiagStr[0] != '%') {
907      // Append non-%0 substrings to Str if we have one.
908      const char *StrEnd = std::find(DiagStr, DiagEnd, '%');
909      OutStr.append(DiagStr, StrEnd);
910      DiagStr = StrEnd;
911      continue;
912    } else if (ispunct(DiagStr[1])) {
913      OutStr.push_back(DiagStr[1]);  // %% -> %.
914      DiagStr += 2;
915      continue;
916    }
917
918    // Skip the %.
919    ++DiagStr;
920
921    // This must be a placeholder for a diagnostic argument.  The format for a
922    // placeholder is one of "%0", "%modifier0", or "%modifier{arguments}0".
923    // The digit is a number from 0-9 indicating which argument this comes from.
924    // The modifier is a string of digits from the set [-a-z]+, arguments is a
925    // brace enclosed string.
926    const char *Modifier = 0, *Argument = 0;
927    unsigned ModifierLen = 0, ArgumentLen = 0;
928
929    // Check to see if we have a modifier.  If so eat it.
930    if (!isdigit(DiagStr[0])) {
931      Modifier = DiagStr;
932      while (DiagStr[0] == '-' ||
933             (DiagStr[0] >= 'a' && DiagStr[0] <= 'z'))
934        ++DiagStr;
935      ModifierLen = DiagStr-Modifier;
936
937      // If we have an argument, get it next.
938      if (DiagStr[0] == '{') {
939        ++DiagStr; // Skip {.
940        Argument = DiagStr;
941
942        DiagStr = ScanFormat(DiagStr, DiagEnd, '}');
943        assert(DiagStr != DiagEnd && "Mismatched {}'s in diagnostic string!");
944        ArgumentLen = DiagStr-Argument;
945        ++DiagStr;  // Skip }.
946      }
947    }
948
949    assert(isdigit(*DiagStr) && "Invalid format for argument in diagnostic");
950    unsigned ArgNo = *DiagStr++ - '0';
951
952    Diagnostic::ArgumentKind Kind = getArgKind(ArgNo);
953
954    switch (Kind) {
955    // ---- STRINGS ----
956    case Diagnostic::ak_std_string: {
957      const std::string &S = getArgStdStr(ArgNo);
958      assert(ModifierLen == 0 && "No modifiers for strings yet");
959      OutStr.append(S.begin(), S.end());
960      break;
961    }
962    case Diagnostic::ak_c_string: {
963      const char *S = getArgCStr(ArgNo);
964      assert(ModifierLen == 0 && "No modifiers for strings yet");
965
966      // Don't crash if get passed a null pointer by accident.
967      if (!S)
968        S = "(null)";
969
970      OutStr.append(S, S + strlen(S));
971      break;
972    }
973    // ---- INTEGERS ----
974    case Diagnostic::ak_sint: {
975      int Val = getArgSInt(ArgNo);
976
977      if (ModifierIs(Modifier, ModifierLen, "select")) {
978        HandleSelectModifier(*this, (unsigned)Val, Argument, ArgumentLen, OutStr);
979      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
980        HandleIntegerSModifier(Val, OutStr);
981      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
982        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
983      } else if (ModifierIs(Modifier, ModifierLen, "ordinal")) {
984        HandleOrdinalModifier((unsigned)Val, OutStr);
985      } else {
986        assert(ModifierLen == 0 && "Unknown integer modifier");
987        llvm::raw_svector_ostream(OutStr) << Val;
988      }
989      break;
990    }
991    case Diagnostic::ak_uint: {
992      unsigned Val = getArgUInt(ArgNo);
993
994      if (ModifierIs(Modifier, ModifierLen, "select")) {
995        HandleSelectModifier(*this, Val, Argument, ArgumentLen, OutStr);
996      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
997        HandleIntegerSModifier(Val, OutStr);
998      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
999        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
1000      } else if (ModifierIs(Modifier, ModifierLen, "ordinal")) {
1001        HandleOrdinalModifier(Val, OutStr);
1002      } else {
1003        assert(ModifierLen == 0 && "Unknown integer modifier");
1004        llvm::raw_svector_ostream(OutStr) << Val;
1005      }
1006      break;
1007    }
1008    // ---- NAMES and TYPES ----
1009    case Diagnostic::ak_identifierinfo: {
1010      const IdentifierInfo *II = getArgIdentifier(ArgNo);
1011      assert(ModifierLen == 0 && "No modifiers for strings yet");
1012
1013      // Don't crash if get passed a null pointer by accident.
1014      if (!II) {
1015        const char *S = "(null)";
1016        OutStr.append(S, S + strlen(S));
1017        continue;
1018      }
1019
1020      llvm::raw_svector_ostream(OutStr) << '\'' << II->getName() << '\'';
1021      break;
1022    }
1023    case Diagnostic::ak_qualtype:
1024    case Diagnostic::ak_declarationname:
1025    case Diagnostic::ak_nameddecl:
1026    case Diagnostic::ak_nestednamespec:
1027    case Diagnostic::ak_declcontext:
1028      getDiags()->ConvertArgToString(Kind, getRawArg(ArgNo),
1029                                     Modifier, ModifierLen,
1030                                     Argument, ArgumentLen,
1031                                     FormattedArgs.data(), FormattedArgs.size(),
1032                                     OutStr);
1033      break;
1034    }
1035
1036    // Remember this argument info for subsequent formatting operations.  Turn
1037    // std::strings into a null terminated string to make it be the same case as
1038    // all the other ones.
1039    if (Kind != Diagnostic::ak_std_string)
1040      FormattedArgs.push_back(std::make_pair(Kind, getRawArg(ArgNo)));
1041    else
1042      FormattedArgs.push_back(std::make_pair(Diagnostic::ak_c_string,
1043                                        (intptr_t)getArgStdStr(ArgNo).c_str()));
1044
1045  }
1046}
1047
1048StoredDiagnostic::StoredDiagnostic() { }
1049
1050StoredDiagnostic::StoredDiagnostic(Diagnostic::Level Level,
1051                                   llvm::StringRef Message)
1052  : Level(Level), Loc(), Message(Message) { }
1053
1054StoredDiagnostic::StoredDiagnostic(Diagnostic::Level Level,
1055                                   const DiagnosticInfo &Info)
1056  : Level(Level), Loc(Info.getLocation()) {
1057  llvm::SmallString<64> Message;
1058  Info.FormatDiagnostic(Message);
1059  this->Message.assign(Message.begin(), Message.end());
1060
1061  Ranges.reserve(Info.getNumRanges());
1062  for (unsigned I = 0, N = Info.getNumRanges(); I != N; ++I)
1063    Ranges.push_back(Info.getRange(I));
1064
1065  FixIts.reserve(Info.getNumFixItHints());
1066  for (unsigned I = 0, N = Info.getNumFixItHints(); I != N; ++I)
1067    FixIts.push_back(Info.getFixItHint(I));
1068}
1069
1070StoredDiagnostic::~StoredDiagnostic() { }
1071
1072/// IncludeInDiagnosticCounts - This method (whose default implementation
1073///  returns true) indicates whether the diagnostics handled by this
1074///  DiagnosticClient should be included in the number of diagnostics
1075///  reported by Diagnostic.
1076bool DiagnosticClient::IncludeInDiagnosticCounts() const { return true; }
1077
1078PartialDiagnostic::StorageAllocator::StorageAllocator() {
1079  for (unsigned I = 0; I != NumCached; ++I)
1080    FreeList[I] = Cached + I;
1081  NumFreeListEntries = NumCached;
1082}
1083
1084PartialDiagnostic::StorageAllocator::~StorageAllocator() {
1085  assert(NumFreeListEntries == NumCached && "A partial is on the lamb");
1086}
1087