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