Diagnostic.cpp revision 3f09327b26033d0a9676d52d80cf92c48f581aff 
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/Basic/Diagnostic.h"
15
16#include "clang/Lex/LexDiagnostic.h"
17#include "clang/Parse/ParseDiagnostic.h"
18#include "clang/AST/ASTDiagnostic.h"
19#include "clang/Sema/SemaDiagnostic.h"
20#include "clang/Frontend/FrontendDiagnostic.h"
21#include "clang/Analysis/AnalysisDiagnostic.h"
22#include "clang/Driver/DriverDiagnostic.h"
23
24#include "clang/Basic/IdentifierTable.h"
25#include "clang/Basic/SourceLocation.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/ADT/StringExtras.h"
28#include <vector>
29#include <map>
30#include <cstring>
31using namespace clang;
32
33//===----------------------------------------------------------------------===//
34// Builtin Diagnostic information
35//===----------------------------------------------------------------------===//
36
37// Diagnostic classes.
38enum {
39  CLASS_NOTE       = 0x01,
40  CLASS_WARNING    = 0x02,
41  CLASS_EXTENSION  = 0x03,
42  CLASS_ERROR      = 0x04
43};
44
45struct StaticDiagInfoRec {
46  unsigned short DiagID;
47  unsigned Mapping : 3;
48  unsigned Class : 3;
49  bool SFINAE : 1;
50  const char *Description;
51  const char *OptionGroup;
52
53  bool operator<(const StaticDiagInfoRec &RHS) const {
54    return DiagID < RHS.DiagID;
55  }
56  bool operator>(const StaticDiagInfoRec &RHS) const {
57    return DiagID > RHS.DiagID;
58  }
59};
60
61static const StaticDiagInfoRec StaticDiagInfo[] = {
62#define DIAG(ENUM,CLASS,DEFAULT_MAPPING,DESC,GROUP,SFINAE)    \
63  { diag::ENUM, DEFAULT_MAPPING, CLASS, SFINAE, DESC, GROUP },
64#include "clang/Basic/DiagnosticCommonKinds.inc"
65#include "clang/Basic/DiagnosticDriverKinds.inc"
66#include "clang/Basic/DiagnosticFrontendKinds.inc"
67#include "clang/Basic/DiagnosticLexKinds.inc"
68#include "clang/Basic/DiagnosticParseKinds.inc"
69#include "clang/Basic/DiagnosticASTKinds.inc"
70#include "clang/Basic/DiagnosticSemaKinds.inc"
71#include "clang/Basic/DiagnosticAnalysisKinds.inc"
72  { 0, 0, 0, 0, 0, 0}
73};
74#undef DIAG
75
76/// GetDiagInfo - Return the StaticDiagInfoRec entry for the specified DiagID,
77/// or null if the ID is invalid.
78static const StaticDiagInfoRec *GetDiagInfo(unsigned DiagID) {
79  unsigned NumDiagEntries = sizeof(StaticDiagInfo)/sizeof(StaticDiagInfo[0])-1;
80
81  // If assertions are enabled, verify that the StaticDiagInfo array is sorted.
82#ifndef NDEBUG
83  static bool IsFirst = true;
84  if (IsFirst) {
85    for (unsigned i = 1; i != NumDiagEntries; ++i)
86      assert(StaticDiagInfo[i-1] < StaticDiagInfo[i] &&
87             "Improperly sorted diag info");
88    IsFirst = false;
89  }
90#endif
91
92  // Search the diagnostic table with a binary search.
93  StaticDiagInfoRec Find = { DiagID, 0, 0, 0, 0, 0 };
94
95  const StaticDiagInfoRec *Found =
96    std::lower_bound(StaticDiagInfo, StaticDiagInfo + NumDiagEntries, Find);
97  if (Found == StaticDiagInfo + NumDiagEntries ||
98      Found->DiagID != DiagID)
99    return 0;
100
101  return Found;
102}
103
104static unsigned GetDefaultDiagMapping(unsigned DiagID) {
105  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
106    return Info->Mapping;
107  return diag::MAP_FATAL;
108}
109
110/// getWarningOptionForDiag - Return the lowest-level warning option that
111/// enables the specified diagnostic.  If there is no -Wfoo flag that controls
112/// the diagnostic, this returns null.
113const char *Diagnostic::getWarningOptionForDiag(unsigned DiagID) {
114  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
115    return Info->OptionGroup;
116  return 0;
117}
118
119bool Diagnostic::isBuiltinSFINAEDiag(unsigned DiagID) {
120  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
121    return Info->SFINAE && Info->Class == CLASS_ERROR;
122  return false;
123}
124
125/// getDiagClass - Return the class field of the diagnostic.
126///
127static unsigned getBuiltinDiagClass(unsigned DiagID) {
128  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
129    return Info->Class;
130  return ~0U;
131}
132
133//===----------------------------------------------------------------------===//
134// Custom Diagnostic information
135//===----------------------------------------------------------------------===//
136
137namespace clang {
138  namespace diag {
139    class CustomDiagInfo {
140      typedef std::pair<Diagnostic::Level, std::string> DiagDesc;
141      std::vector<DiagDesc> DiagInfo;
142      std::map<DiagDesc, unsigned> DiagIDs;
143    public:
144
145      /// getDescription - Return the description of the specified custom
146      /// diagnostic.
147      const char *getDescription(unsigned DiagID) const {
148        assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
149               "Invalid diagnosic ID");
150        return DiagInfo[DiagID-DIAG_UPPER_LIMIT].second.c_str();
151      }
152
153      /// getLevel - Return the level of the specified custom diagnostic.
154      Diagnostic::Level getLevel(unsigned DiagID) const {
155        assert(this && DiagID-DIAG_UPPER_LIMIT < DiagInfo.size() &&
156               "Invalid diagnosic ID");
157        return DiagInfo[DiagID-DIAG_UPPER_LIMIT].first;
158      }
159
160      unsigned getOrCreateDiagID(Diagnostic::Level L, const char *Message,
161                                 Diagnostic &Diags) {
162        DiagDesc D(L, Message);
163        // Check to see if it already exists.
164        std::map<DiagDesc, unsigned>::iterator I = DiagIDs.lower_bound(D);
165        if (I != DiagIDs.end() && I->first == D)
166          return I->second;
167
168        // If not, assign a new ID.
169        unsigned ID = DiagInfo.size()+DIAG_UPPER_LIMIT;
170        DiagIDs.insert(std::make_pair(D, ID));
171        DiagInfo.push_back(D);
172        return ID;
173      }
174    };
175
176  } // end diag namespace
177} // end clang namespace
178
179
180//===----------------------------------------------------------------------===//
181// Common Diagnostic implementation
182//===----------------------------------------------------------------------===//
183
184static void DummyArgToStringFn(Diagnostic::ArgumentKind AK, intptr_t QT,
185                               const char *Modifier, unsigned ML,
186                               const char *Argument, unsigned ArgLen,
187                               llvm::SmallVectorImpl<char> &Output,
188                               void *Cookie) {
189  const char *Str = "<can't format argument>";
190  Output.append(Str, Str+strlen(Str));
191}
192
193
194Diagnostic::Diagnostic(DiagnosticClient *client) : Client(client) {
195  AllExtensionsSilenced = 0;
196  IgnoreAllWarnings = false;
197  WarningsAsErrors = false;
198  SuppressSystemWarnings = false;
199  SuppressAllDiagnostics = false;
200  ExtBehavior = Ext_Ignore;
201
202  ErrorOccurred = false;
203  FatalErrorOccurred = false;
204  NumDiagnostics = 0;
205
206  NumErrors = 0;
207  CustomDiagInfo = 0;
208  CurDiagID = ~0U;
209  LastDiagLevel = Ignored;
210
211  ArgToStringFn = DummyArgToStringFn;
212  ArgToStringCookie = 0;
213
214  // Set all mappings to 'unset'.
215  DiagMappings BlankDiags(diag::DIAG_UPPER_LIMIT/2, 0);
216  DiagMappingsStack.push_back(BlankDiags);
217}
218
219Diagnostic::~Diagnostic() {
220  delete CustomDiagInfo;
221}
222
223
224void Diagnostic::pushMappings() {
225  DiagMappingsStack.push_back(DiagMappingsStack.back());
226}
227
228bool Diagnostic::popMappings() {
229  if (DiagMappingsStack.size() == 1)
230    return false;
231
232  DiagMappingsStack.pop_back();
233  return true;
234}
235
236/// getCustomDiagID - Return an ID for a diagnostic with the specified message
237/// and level.  If this is the first request for this diagnosic, it is
238/// registered and created, otherwise the existing ID is returned.
239unsigned Diagnostic::getCustomDiagID(Level L, const char *Message) {
240  if (CustomDiagInfo == 0)
241    CustomDiagInfo = new diag::CustomDiagInfo();
242  return CustomDiagInfo->getOrCreateDiagID(L, Message, *this);
243}
244
245
246/// isBuiltinWarningOrExtension - Return true if the unmapped diagnostic
247/// level of the specified diagnostic ID is a Warning or Extension.
248/// This only works on builtin diagnostics, not custom ones, and is not legal to
249/// call on NOTEs.
250bool Diagnostic::isBuiltinWarningOrExtension(unsigned DiagID) {
251  return DiagID < diag::DIAG_UPPER_LIMIT &&
252         getBuiltinDiagClass(DiagID) != CLASS_ERROR;
253}
254
255/// \brief Determine whether the given built-in diagnostic ID is a
256/// Note.
257bool Diagnostic::isBuiltinNote(unsigned DiagID) {
258  return DiagID < diag::DIAG_UPPER_LIMIT &&
259    getBuiltinDiagClass(DiagID) == CLASS_NOTE;
260}
261
262/// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic
263/// ID is for an extension of some sort.
264///
265bool Diagnostic::isBuiltinExtensionDiag(unsigned DiagID) {
266  return DiagID < diag::DIAG_UPPER_LIMIT &&
267         getBuiltinDiagClass(DiagID) == CLASS_EXTENSION;
268}
269
270
271/// getDescription - Given a diagnostic ID, return a description of the
272/// issue.
273const char *Diagnostic::getDescription(unsigned DiagID) const {
274  if (const StaticDiagInfoRec *Info = GetDiagInfo(DiagID))
275    return Info->Description;
276  return CustomDiagInfo->getDescription(DiagID);
277}
278
279/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
280/// object, classify the specified diagnostic ID into a Level, consumable by
281/// the DiagnosticClient.
282Diagnostic::Level Diagnostic::getDiagnosticLevel(unsigned DiagID) const {
283  // Handle custom diagnostics, which cannot be mapped.
284  if (DiagID >= diag::DIAG_UPPER_LIMIT)
285    return CustomDiagInfo->getLevel(DiagID);
286
287  unsigned DiagClass = getBuiltinDiagClass(DiagID);
288  assert(DiagClass != CLASS_NOTE && "Cannot get diagnostic level of a note!");
289  return getDiagnosticLevel(DiagID, DiagClass);
290}
291
292/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
293/// object, classify the specified diagnostic ID into a Level, consumable by
294/// the DiagnosticClient.
295Diagnostic::Level
296Diagnostic::getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const {
297  // Specific non-error diagnostics may be mapped to various levels from ignored
298  // to error.  Errors can only be mapped to fatal.
299  Diagnostic::Level Result = Diagnostic::Fatal;
300
301  // Get the mapping information, if unset, compute it lazily.
302  unsigned MappingInfo = getDiagnosticMappingInfo((diag::kind)DiagID);
303  if (MappingInfo == 0) {
304    MappingInfo = GetDefaultDiagMapping(DiagID);
305    setDiagnosticMappingInternal(DiagID, MappingInfo, false);
306  }
307
308  switch (MappingInfo & 7) {
309  default: assert(0 && "Unknown mapping!");
310  case diag::MAP_IGNORE:
311    // Ignore this, unless this is an extension diagnostic and we're mapping
312    // them onto warnings or errors.
313    if (!isBuiltinExtensionDiag(DiagID) ||  // Not an extension
314        ExtBehavior == Ext_Ignore ||        // Extensions ignored anyway
315        (MappingInfo & 8) != 0)             // User explicitly mapped it.
316      return Diagnostic::Ignored;
317    Result = Diagnostic::Warning;
318    if (ExtBehavior == Ext_Error) Result = Diagnostic::Error;
319    break;
320  case diag::MAP_ERROR:
321    Result = Diagnostic::Error;
322    break;
323  case diag::MAP_FATAL:
324    Result = Diagnostic::Fatal;
325    break;
326  case diag::MAP_WARNING:
327    // If warnings are globally mapped to ignore or error, do it.
328    if (IgnoreAllWarnings)
329      return Diagnostic::Ignored;
330
331    Result = Diagnostic::Warning;
332
333    // If this is an extension diagnostic and we're in -pedantic-error mode, and
334    // if the user didn't explicitly map it, upgrade to an error.
335    if (ExtBehavior == Ext_Error &&
336        (MappingInfo & 8) == 0 &&
337        isBuiltinExtensionDiag(DiagID))
338      Result = Diagnostic::Error;
339
340    if (WarningsAsErrors)
341      Result = Diagnostic::Error;
342    break;
343
344  case diag::MAP_WARNING_NO_WERROR:
345    // Diagnostics specified with -Wno-error=foo should be set to warnings, but
346    // not be adjusted by -Werror or -pedantic-errors.
347    Result = Diagnostic::Warning;
348
349    // If warnings are globally mapped to ignore or error, do it.
350    if (IgnoreAllWarnings)
351      return Diagnostic::Ignored;
352
353    break;
354  }
355
356  // Okay, we're about to return this as a "diagnostic to emit" one last check:
357  // if this is any sort of extension warning, and if we're in an __extension__
358  // block, silence it.
359  if (AllExtensionsSilenced && isBuiltinExtensionDiag(DiagID))
360    return Diagnostic::Ignored;
361
362  return Result;
363}
364
365struct WarningOption {
366  const char  *Name;
367  const short *Members;
368  const char  *SubGroups;
369};
370
371#define GET_DIAG_ARRAYS
372#include "clang/Basic/DiagnosticGroups.inc"
373#undef GET_DIAG_ARRAYS
374
375// Second the table of options, sorted by name for fast binary lookup.
376static const WarningOption OptionTable[] = {
377#define GET_DIAG_TABLE
378#include "clang/Basic/DiagnosticGroups.inc"
379#undef GET_DIAG_TABLE
380};
381static const size_t OptionTableSize =
382sizeof(OptionTable) / sizeof(OptionTable[0]);
383
384static bool WarningOptionCompare(const WarningOption &LHS,
385                                 const WarningOption &RHS) {
386  return strcmp(LHS.Name, RHS.Name) < 0;
387}
388
389static void MapGroupMembers(const WarningOption *Group, diag::Mapping Mapping,
390                            Diagnostic &Diags) {
391  // Option exists, poke all the members of its diagnostic set.
392  if (const short *Member = Group->Members) {
393    for (; *Member != -1; ++Member)
394      Diags.setDiagnosticMapping(*Member, Mapping);
395  }
396
397  // Enable/disable all subgroups along with this one.
398  if (const char *SubGroups = Group->SubGroups) {
399    for (; *SubGroups != (char)-1; ++SubGroups)
400      MapGroupMembers(&OptionTable[(unsigned char)*SubGroups], Mapping, Diags);
401  }
402}
403
404/// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g.
405/// "unknown-pragmas" to have the specified mapping.  This returns true and
406/// ignores the request if "Group" was unknown, false otherwise.
407bool Diagnostic::setDiagnosticGroupMapping(const char *Group,
408                                           diag::Mapping Map) {
409
410  WarningOption Key = { Group, 0, 0 };
411  const WarningOption *Found =
412  std::lower_bound(OptionTable, OptionTable + OptionTableSize, Key,
413                   WarningOptionCompare);
414  if (Found == OptionTable + OptionTableSize ||
415      strcmp(Found->Name, Group) != 0)
416    return true;  // Option not found.
417
418  MapGroupMembers(Found, Map, *this);
419  return false;
420}
421
422
423/// ProcessDiag - This is the method used to report a diagnostic that is
424/// finally fully formed.
425bool Diagnostic::ProcessDiag() {
426  DiagnosticInfo Info(this);
427
428  if (SuppressAllDiagnostics)
429    return false;
430
431  // Figure out the diagnostic level of this message.
432  Diagnostic::Level DiagLevel;
433  unsigned DiagID = Info.getID();
434
435  // ShouldEmitInSystemHeader - True if this diagnostic should be produced even
436  // in a system header.
437  bool ShouldEmitInSystemHeader;
438
439  if (DiagID >= diag::DIAG_UPPER_LIMIT) {
440    // Handle custom diagnostics, which cannot be mapped.
441    DiagLevel = CustomDiagInfo->getLevel(DiagID);
442
443    // Custom diagnostics always are emitted in system headers.
444    ShouldEmitInSystemHeader = true;
445  } else {
446    // Get the class of the diagnostic.  If this is a NOTE, map it onto whatever
447    // the diagnostic level was for the previous diagnostic so that it is
448    // filtered the same as the previous diagnostic.
449    unsigned DiagClass = getBuiltinDiagClass(DiagID);
450    if (DiagClass == CLASS_NOTE) {
451      DiagLevel = Diagnostic::Note;
452      ShouldEmitInSystemHeader = false;  // extra consideration is needed
453    } else {
454      // If this is not an error and we are in a system header, we ignore it.
455      // Check the original Diag ID here, because we also want to ignore
456      // extensions and warnings in -Werror and -pedantic-errors modes, which
457      // *map* warnings/extensions to errors.
458      ShouldEmitInSystemHeader = DiagClass == CLASS_ERROR;
459
460      DiagLevel = getDiagnosticLevel(DiagID, DiagClass);
461    }
462  }
463
464  if (DiagLevel != Diagnostic::Note) {
465    // Record that a fatal error occurred only when we see a second
466    // non-note diagnostic. This allows notes to be attached to the
467    // fatal error, but suppresses any diagnostics that follow those
468    // notes.
469    if (LastDiagLevel == Diagnostic::Fatal)
470      FatalErrorOccurred = true;
471
472    LastDiagLevel = DiagLevel;
473  }
474
475  // If a fatal error has already been emitted, silence all subsequent
476  // diagnostics.
477  if (FatalErrorOccurred)
478    return false;
479
480  // If the client doesn't care about this message, don't issue it.  If this is
481  // a note and the last real diagnostic was ignored, ignore it too.
482  if (DiagLevel == Diagnostic::Ignored ||
483      (DiagLevel == Diagnostic::Note && LastDiagLevel == Diagnostic::Ignored))
484    return false;
485
486  // If this diagnostic is in a system header and is not a clang error, suppress
487  // it.
488  if (SuppressSystemWarnings && !ShouldEmitInSystemHeader &&
489      Info.getLocation().isValid() &&
490      Info.getLocation().getSpellingLoc().isInSystemHeader() &&
491      (DiagLevel != Diagnostic::Note || LastDiagLevel == Diagnostic::Ignored)) {
492    LastDiagLevel = Diagnostic::Ignored;
493    return false;
494  }
495
496  if (DiagLevel >= Diagnostic::Error) {
497    ErrorOccurred = true;
498    ++NumErrors;
499  }
500
501  // Finally, report it.
502  Client->HandleDiagnostic(DiagLevel, Info);
503  if (Client->IncludeInDiagnosticCounts()) ++NumDiagnostics;
504
505  CurDiagID = ~0U;
506
507  return true;
508}
509
510
511DiagnosticClient::~DiagnosticClient() {}
512
513
514/// ModifierIs - Return true if the specified modifier matches specified string.
515template <std::size_t StrLen>
516static bool ModifierIs(const char *Modifier, unsigned ModifierLen,
517                       const char (&Str)[StrLen]) {
518  return StrLen-1 == ModifierLen && !memcmp(Modifier, Str, StrLen-1);
519}
520
521/// HandleSelectModifier - Handle the integer 'select' modifier.  This is used
522/// like this:  %select{foo|bar|baz}2.  This means that the integer argument
523/// "%2" has a value from 0-2.  If the value is 0, the diagnostic prints 'foo'.
524/// If the value is 1, it prints 'bar'.  If it has the value 2, it prints 'baz'.
525/// This is very useful for certain classes of variant diagnostics.
526static void HandleSelectModifier(unsigned ValNo,
527                                 const char *Argument, unsigned ArgumentLen,
528                                 llvm::SmallVectorImpl<char> &OutStr) {
529  const char *ArgumentEnd = Argument+ArgumentLen;
530
531  // Skip over 'ValNo' |'s.
532  while (ValNo) {
533    const char *NextVal = std::find(Argument, ArgumentEnd, '|');
534    assert(NextVal != ArgumentEnd && "Value for integer select modifier was"
535           " larger than the number of options in the diagnostic string!");
536    Argument = NextVal+1;  // Skip this string.
537    --ValNo;
538  }
539
540  // Get the end of the value.  This is either the } or the |.
541  const char *EndPtr = std::find(Argument, ArgumentEnd, '|');
542  // Add the value to the output string.
543  OutStr.append(Argument, EndPtr);
544}
545
546/// HandleIntegerSModifier - Handle the integer 's' modifier.  This adds the
547/// letter 's' to the string if the value is not 1.  This is used in cases like
548/// this:  "you idiot, you have %4 parameter%s4!".
549static void HandleIntegerSModifier(unsigned ValNo,
550                                   llvm::SmallVectorImpl<char> &OutStr) {
551  if (ValNo != 1)
552    OutStr.push_back('s');
553}
554
555
556/// PluralNumber - Parse an unsigned integer and advance Start.
557static unsigned PluralNumber(const char *&Start, const char *End) {
558  // Programming 101: Parse a decimal number :-)
559  unsigned Val = 0;
560  while (Start != End && *Start >= '0' && *Start <= '9') {
561    Val *= 10;
562    Val += *Start - '0';
563    ++Start;
564  }
565  return Val;
566}
567
568/// TestPluralRange - Test if Val is in the parsed range. Modifies Start.
569static bool TestPluralRange(unsigned Val, const char *&Start, const char *End) {
570  if (*Start != '[') {
571    unsigned Ref = PluralNumber(Start, End);
572    return Ref == Val;
573  }
574
575  ++Start;
576  unsigned Low = PluralNumber(Start, End);
577  assert(*Start == ',' && "Bad plural expression syntax: expected ,");
578  ++Start;
579  unsigned High = PluralNumber(Start, End);
580  assert(*Start == ']' && "Bad plural expression syntax: expected )");
581  ++Start;
582  return Low <= Val && Val <= High;
583}
584
585/// EvalPluralExpr - Actual expression evaluator for HandlePluralModifier.
586static bool EvalPluralExpr(unsigned ValNo, const char *Start, const char *End) {
587  // Empty condition?
588  if (*Start == ':')
589    return true;
590
591  while (1) {
592    char C = *Start;
593    if (C == '%') {
594      // Modulo expression
595      ++Start;
596      unsigned Arg = PluralNumber(Start, End);
597      assert(*Start == '=' && "Bad plural expression syntax: expected =");
598      ++Start;
599      unsigned ValMod = ValNo % Arg;
600      if (TestPluralRange(ValMod, Start, End))
601        return true;
602    } else {
603      assert((C == '[' || (C >= '0' && C <= '9')) &&
604             "Bad plural expression syntax: unexpected character");
605      // Range expression
606      if (TestPluralRange(ValNo, Start, End))
607        return true;
608    }
609
610    // Scan for next or-expr part.
611    Start = std::find(Start, End, ',');
612    if (Start == End)
613      break;
614    ++Start;
615  }
616  return false;
617}
618
619/// HandlePluralModifier - Handle the integer 'plural' modifier. This is used
620/// for complex plural forms, or in languages where all plurals are complex.
621/// The syntax is: %plural{cond1:form1|cond2:form2|:form3}, where condn are
622/// conditions that are tested in order, the form corresponding to the first
623/// that applies being emitted. The empty condition is always true, making the
624/// last form a default case.
625/// Conditions are simple boolean expressions, where n is the number argument.
626/// Here are the rules.
627/// condition  := expression | empty
628/// empty      :=                             -> always true
629/// expression := numeric [',' expression]    -> logical or
630/// numeric    := range                       -> true if n in range
631///             | '%' number '=' range        -> true if n % number in range
632/// range      := number
633///             | '[' number ',' number ']'   -> ranges are inclusive both ends
634///
635/// Here are some examples from the GNU gettext manual written in this form:
636/// English:
637/// {1:form0|:form1}
638/// Latvian:
639/// {0:form2|%100=11,%10=0,%10=[2,9]:form1|:form0}
640/// Gaeilge:
641/// {1:form0|2:form1|:form2}
642/// Romanian:
643/// {1:form0|0,%100=[1,19]:form1|:form2}
644/// Lithuanian:
645/// {%10=0,%100=[10,19]:form2|%10=1:form0|:form1}
646/// Russian (requires repeated form):
647/// {%100=[11,14]:form2|%10=1:form0|%10=[2,4]:form1|:form2}
648/// Slovak
649/// {1:form0|[2,4]:form1|:form2}
650/// Polish (requires repeated form):
651/// {1:form0|%100=[10,20]:form2|%10=[2,4]:form1|:form2}
652static void HandlePluralModifier(unsigned ValNo,
653                                 const char *Argument, unsigned ArgumentLen,
654                                 llvm::SmallVectorImpl<char> &OutStr) {
655  const char *ArgumentEnd = Argument + ArgumentLen;
656  while (1) {
657    assert(Argument < ArgumentEnd && "Plural expression didn't match.");
658    const char *ExprEnd = Argument;
659    while (*ExprEnd != ':') {
660      assert(ExprEnd != ArgumentEnd && "Plural missing expression end");
661      ++ExprEnd;
662    }
663    if (EvalPluralExpr(ValNo, Argument, ExprEnd)) {
664      Argument = ExprEnd + 1;
665      ExprEnd = std::find(Argument, ArgumentEnd, '|');
666      OutStr.append(Argument, ExprEnd);
667      return;
668    }
669    Argument = std::find(Argument, ArgumentEnd - 1, '|') + 1;
670  }
671}
672
673
674/// FormatDiagnostic - Format this diagnostic into a string, substituting the
675/// formal arguments into the %0 slots.  The result is appended onto the Str
676/// array.
677void DiagnosticInfo::
678FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const {
679  const char *DiagStr = getDiags()->getDescription(getID());
680  const char *DiagEnd = DiagStr+strlen(DiagStr);
681
682  while (DiagStr != DiagEnd) {
683    if (DiagStr[0] != '%') {
684      // Append non-%0 substrings to Str if we have one.
685      const char *StrEnd = std::find(DiagStr, DiagEnd, '%');
686      OutStr.append(DiagStr, StrEnd);
687      DiagStr = StrEnd;
688      continue;
689    } else if (DiagStr[1] == '%') {
690      OutStr.push_back('%');  // %% -> %.
691      DiagStr += 2;
692      continue;
693    }
694
695    // Skip the %.
696    ++DiagStr;
697
698    // This must be a placeholder for a diagnostic argument.  The format for a
699    // placeholder is one of "%0", "%modifier0", or "%modifier{arguments}0".
700    // The digit is a number from 0-9 indicating which argument this comes from.
701    // The modifier is a string of digits from the set [-a-z]+, arguments is a
702    // brace enclosed string.
703    const char *Modifier = 0, *Argument = 0;
704    unsigned ModifierLen = 0, ArgumentLen = 0;
705
706    // Check to see if we have a modifier.  If so eat it.
707    if (!isdigit(DiagStr[0])) {
708      Modifier = DiagStr;
709      while (DiagStr[0] == '-' ||
710             (DiagStr[0] >= 'a' && DiagStr[0] <= 'z'))
711        ++DiagStr;
712      ModifierLen = DiagStr-Modifier;
713
714      // If we have an argument, get it next.
715      if (DiagStr[0] == '{') {
716        ++DiagStr; // Skip {.
717        Argument = DiagStr;
718
719        for (; DiagStr[0] != '}'; ++DiagStr)
720          assert(DiagStr[0] && "Mismatched {}'s in diagnostic string!");
721        ArgumentLen = DiagStr-Argument;
722        ++DiagStr;  // Skip }.
723      }
724    }
725
726    assert(isdigit(*DiagStr) && "Invalid format for argument in diagnostic");
727    unsigned ArgNo = *DiagStr++ - '0';
728
729    switch (getArgKind(ArgNo)) {
730    // ---- STRINGS ----
731    case Diagnostic::ak_std_string: {
732      const std::string &S = getArgStdStr(ArgNo);
733      assert(ModifierLen == 0 && "No modifiers for strings yet");
734      OutStr.append(S.begin(), S.end());
735      break;
736    }
737    case Diagnostic::ak_c_string: {
738      const char *S = getArgCStr(ArgNo);
739      assert(ModifierLen == 0 && "No modifiers for strings yet");
740
741      // Don't crash if get passed a null pointer by accident.
742      if (!S)
743        S = "(null)";
744
745      OutStr.append(S, S + strlen(S));
746      break;
747    }
748    // ---- INTEGERS ----
749    case Diagnostic::ak_sint: {
750      int Val = getArgSInt(ArgNo);
751
752      if (ModifierIs(Modifier, ModifierLen, "select")) {
753        HandleSelectModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
754      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
755        HandleIntegerSModifier(Val, OutStr);
756      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
757        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
758      } else {
759        assert(ModifierLen == 0 && "Unknown integer modifier");
760        // FIXME: Optimize
761        std::string S = llvm::itostr(Val);
762        OutStr.append(S.begin(), S.end());
763      }
764      break;
765    }
766    case Diagnostic::ak_uint: {
767      unsigned Val = getArgUInt(ArgNo);
768
769      if (ModifierIs(Modifier, ModifierLen, "select")) {
770        HandleSelectModifier(Val, Argument, ArgumentLen, OutStr);
771      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
772        HandleIntegerSModifier(Val, OutStr);
773      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
774        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
775      } else {
776        assert(ModifierLen == 0 && "Unknown integer modifier");
777
778        // FIXME: Optimize
779        std::string S = llvm::utostr_32(Val);
780        OutStr.append(S.begin(), S.end());
781      }
782      break;
783    }
784    // ---- NAMES and TYPES ----
785    case Diagnostic::ak_identifierinfo: {
786      const IdentifierInfo *II = getArgIdentifier(ArgNo);
787      assert(ModifierLen == 0 && "No modifiers for strings yet");
788
789      // Don't crash if get passed a null pointer by accident.
790      if (!II) {
791        const char *S = "(null)";
792        OutStr.append(S, S + strlen(S));
793        continue;
794      }
795
796      OutStr.push_back('\'');
797      OutStr.append(II->getName(), II->getName() + II->getLength());
798      OutStr.push_back('\'');
799      break;
800    }
801    case Diagnostic::ak_qualtype:
802    case Diagnostic::ak_declarationname:
803    case Diagnostic::ak_nameddecl:
804    case Diagnostic::ak_nestednamespec:
805    case Diagnostic::ak_declcontext:
806      getDiags()->ConvertArgToString(getArgKind(ArgNo), getRawArg(ArgNo),
807                                     Modifier, ModifierLen,
808                                     Argument, ArgumentLen, OutStr);
809      break;
810    }
811  }
812}
813
814/// IncludeInDiagnosticCounts - This method (whose default implementation
815///  returns true) indicates whether the diagnostics handled by this
816///  DiagnosticClient should be included in the number of diagnostics
817///  reported by Diagnostic.
818bool DiagnosticClient::IncludeInDiagnosticCounts() const { return true; }
819