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