Diagnostic.cpp revision 11583c757bac6ce5c342f2eb572055dd2619a657 
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#include "clang/Basic/IdentifierTable.h"
16#include "clang/Basic/PartialDiagnostic.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/Support/raw_ostream.h"
19#include "llvm/Support/CrashRecoveryContext.h"
20
21using namespace clang;
22
23static void DummyArgToStringFn(DiagnosticsEngine::ArgumentKind AK, intptr_t QT,
24                               const char *Modifier, unsigned ML,
25                               const char *Argument, unsigned ArgLen,
26                               const DiagnosticsEngine::ArgumentValue *PrevArgs,
27                               unsigned NumPrevArgs,
28                               SmallVectorImpl<char> &Output,
29                               void *Cookie,
30                               SmallVectorImpl<intptr_t> &QualTypeVals) {
31  const char *Str = "<can't format argument>";
32  Output.append(Str, Str+strlen(Str));
33}
34
35
36DiagnosticsEngine::DiagnosticsEngine(
37                       const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &diags,
38                       DiagnosticConsumer *client, bool ShouldOwnClient)
39  : Diags(diags), Client(client), OwnsDiagClient(ShouldOwnClient),
40    SourceMgr(0) {
41  ArgToStringFn = DummyArgToStringFn;
42  ArgToStringCookie = 0;
43
44  AllExtensionsSilenced = 0;
45  IgnoreAllWarnings = false;
46  WarningsAsErrors = false;
47  EnableAllWarnings = false;
48  ErrorsAsFatal = false;
49  SuppressSystemWarnings = false;
50  SuppressAllDiagnostics = false;
51  ShowOverloads = Ovl_All;
52  ExtBehavior = Ext_Ignore;
53
54  ErrorLimit = 0;
55  TemplateBacktraceLimit = 0;
56  ConstexprBacktraceLimit = 0;
57
58  Reset();
59}
60
61DiagnosticsEngine::~DiagnosticsEngine() {
62  if (OwnsDiagClient)
63    delete Client;
64}
65
66void DiagnosticsEngine::setClient(DiagnosticConsumer *client,
67                                  bool ShouldOwnClient) {
68  if (OwnsDiagClient && Client)
69    delete Client;
70
71  Client = client;
72  OwnsDiagClient = ShouldOwnClient;
73}
74
75void DiagnosticsEngine::pushMappings(SourceLocation Loc) {
76  DiagStateOnPushStack.push_back(GetCurDiagState());
77}
78
79bool DiagnosticsEngine::popMappings(SourceLocation Loc) {
80  if (DiagStateOnPushStack.empty())
81    return false;
82
83  if (DiagStateOnPushStack.back() != GetCurDiagState()) {
84    // State changed at some point between push/pop.
85    PushDiagStatePoint(DiagStateOnPushStack.back(), Loc);
86  }
87  DiagStateOnPushStack.pop_back();
88  return true;
89}
90
91void DiagnosticsEngine::Reset() {
92  ErrorOccurred = false;
93  FatalErrorOccurred = false;
94  UnrecoverableErrorOccurred = false;
95
96  NumWarnings = 0;
97  NumErrors = 0;
98  NumErrorsSuppressed = 0;
99  TrapNumErrorsOccurred = 0;
100  TrapNumUnrecoverableErrorsOccurred = 0;
101
102  CurDiagID = ~0U;
103  // Set LastDiagLevel to an "unset" state. If we set it to 'Ignored', notes
104  // using a DiagnosticsEngine associated to a translation unit that follow
105  // diagnostics from a DiagnosticsEngine associated to anoter t.u. will not be
106  // displayed.
107  LastDiagLevel = (DiagnosticIDs::Level)-1;
108  DelayedDiagID = 0;
109
110  // Clear state related to #pragma diagnostic.
111  DiagStates.clear();
112  DiagStatePoints.clear();
113  DiagStateOnPushStack.clear();
114
115  // Create a DiagState and DiagStatePoint representing diagnostic changes
116  // through command-line.
117  DiagStates.push_back(DiagState());
118  PushDiagStatePoint(&DiagStates.back(), SourceLocation());
119}
120
121void DiagnosticsEngine::SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1,
122                                      StringRef Arg2) {
123  if (DelayedDiagID)
124    return;
125
126  DelayedDiagID = DiagID;
127  DelayedDiagArg1 = Arg1.str();
128  DelayedDiagArg2 = Arg2.str();
129}
130
131void DiagnosticsEngine::ReportDelayed() {
132  Report(DelayedDiagID) << DelayedDiagArg1 << DelayedDiagArg2;
133  DelayedDiagID = 0;
134  DelayedDiagArg1.clear();
135  DelayedDiagArg2.clear();
136}
137
138DiagnosticsEngine::DiagStatePointsTy::iterator
139DiagnosticsEngine::GetDiagStatePointForLoc(SourceLocation L) const {
140  assert(!DiagStatePoints.empty());
141  assert(DiagStatePoints.front().Loc.isInvalid() &&
142         "Should have created a DiagStatePoint for command-line");
143
144  FullSourceLoc Loc(L, *SourceMgr);
145  if (Loc.isInvalid())
146    return DiagStatePoints.end() - 1;
147
148  DiagStatePointsTy::iterator Pos = DiagStatePoints.end();
149  FullSourceLoc LastStateChangePos = DiagStatePoints.back().Loc;
150  if (LastStateChangePos.isValid() &&
151      Loc.isBeforeInTranslationUnitThan(LastStateChangePos))
152    Pos = std::upper_bound(DiagStatePoints.begin(), DiagStatePoints.end(),
153                           DiagStatePoint(0, Loc));
154  --Pos;
155  return Pos;
156}
157
158/// \brief This allows the client to specify that certain
159/// warnings are ignored.  Notes can never be mapped, errors can only be
160/// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily.
161///
162/// \param The source location that this change of diagnostic state should
163/// take affect. It can be null if we are setting the latest state.
164void DiagnosticsEngine::setDiagnosticMapping(diag::kind Diag, diag::Mapping Map,
165                                      SourceLocation L) {
166  assert(Diag < diag::DIAG_UPPER_LIMIT &&
167         "Can only map builtin diagnostics");
168  assert((Diags->isBuiltinWarningOrExtension(Diag) ||
169          (Map == diag::MAP_FATAL || Map == diag::MAP_ERROR)) &&
170         "Cannot map errors into warnings!");
171  assert(!DiagStatePoints.empty());
172
173  FullSourceLoc Loc(L, *SourceMgr);
174  FullSourceLoc LastStateChangePos = DiagStatePoints.back().Loc;
175  DiagnosticMappingInfo MappingInfo = makeMappingInfo(Map, L);
176
177  // Common case; setting all the diagnostics of a group in one place.
178  if (Loc.isInvalid() || Loc == LastStateChangePos) {
179    GetCurDiagState()->setMappingInfo(Diag, MappingInfo);
180    return;
181  }
182
183  // Another common case; modifying diagnostic state in a source location
184  // after the previous one.
185  if ((Loc.isValid() && LastStateChangePos.isInvalid()) ||
186      LastStateChangePos.isBeforeInTranslationUnitThan(Loc)) {
187    // A diagnostic pragma occurred, create a new DiagState initialized with
188    // the current one and a new DiagStatePoint to record at which location
189    // the new state became active.
190    DiagStates.push_back(*GetCurDiagState());
191    PushDiagStatePoint(&DiagStates.back(), Loc);
192    GetCurDiagState()->setMappingInfo(Diag, MappingInfo);
193    return;
194  }
195
196  // We allow setting the diagnostic state in random source order for
197  // completeness but it should not be actually happening in normal practice.
198
199  DiagStatePointsTy::iterator Pos = GetDiagStatePointForLoc(Loc);
200  assert(Pos != DiagStatePoints.end());
201
202  // Update all diagnostic states that are active after the given location.
203  for (DiagStatePointsTy::iterator
204         I = Pos+1, E = DiagStatePoints.end(); I != E; ++I) {
205    GetCurDiagState()->setMappingInfo(Diag, MappingInfo);
206  }
207
208  // If the location corresponds to an existing point, just update its state.
209  if (Pos->Loc == Loc) {
210    GetCurDiagState()->setMappingInfo(Diag, MappingInfo);
211    return;
212  }
213
214  // Create a new state/point and fit it into the vector of DiagStatePoints
215  // so that the vector is always ordered according to location.
216  Pos->Loc.isBeforeInTranslationUnitThan(Loc);
217  DiagStates.push_back(*Pos->State);
218  DiagState *NewState = &DiagStates.back();
219  GetCurDiagState()->setMappingInfo(Diag, MappingInfo);
220  DiagStatePoints.insert(Pos+1, DiagStatePoint(NewState,
221                                               FullSourceLoc(Loc, *SourceMgr)));
222}
223
224bool DiagnosticsEngine::setDiagnosticGroupMapping(
225  StringRef Group, diag::Mapping Map, SourceLocation Loc)
226{
227  // Get the diagnostics in this group.
228  llvm::SmallVector<diag::kind, 8> GroupDiags;
229  if (Diags->getDiagnosticsInGroup(Group, GroupDiags))
230    return true;
231
232  // Set the mapping.
233  for (unsigned i = 0, e = GroupDiags.size(); i != e; ++i)
234    setDiagnosticMapping(GroupDiags[i], Map, Loc);
235
236  return false;
237}
238
239bool DiagnosticsEngine::setDiagnosticGroupWarningAsError(StringRef Group,
240                                                         bool Enabled) {
241  // If we are enabling this feature, just set the diagnostic mappings to map to
242  // errors.
243  if (Enabled)
244    return setDiagnosticGroupMapping(Group, diag::MAP_ERROR);
245
246  // Otherwise, we want to set the diagnostic mapping's "no Werror" bit, and
247  // potentially downgrade anything already mapped to be a warning.
248
249  // Get the diagnostics in this group.
250  llvm::SmallVector<diag::kind, 8> GroupDiags;
251  if (Diags->getDiagnosticsInGroup(Group, GroupDiags))
252    return true;
253
254  // Perform the mapping change.
255  for (unsigned i = 0, e = GroupDiags.size(); i != e; ++i) {
256    DiagnosticMappingInfo &Info = GetCurDiagState()->getOrAddMappingInfo(
257      GroupDiags[i]);
258
259    if (Info.getMapping() == diag::MAP_ERROR ||
260        Info.getMapping() == diag::MAP_FATAL)
261      Info.setMapping(diag::MAP_WARNING);
262
263    Info.setNoWarningAsError(true);
264  }
265
266  return false;
267}
268
269bool DiagnosticsEngine::setDiagnosticGroupErrorAsFatal(StringRef Group,
270                                                       bool Enabled) {
271  // If we are enabling this feature, just set the diagnostic mappings to map to
272  // fatal errors.
273  if (Enabled)
274    return setDiagnosticGroupMapping(Group, diag::MAP_FATAL);
275
276  // Otherwise, we want to set the diagnostic mapping's "no Werror" bit, and
277  // potentially downgrade anything already mapped to be an error.
278
279  // Get the diagnostics in this group.
280  llvm::SmallVector<diag::kind, 8> GroupDiags;
281  if (Diags->getDiagnosticsInGroup(Group, GroupDiags))
282    return true;
283
284  // Perform the mapping change.
285  for (unsigned i = 0, e = GroupDiags.size(); i != e; ++i) {
286    DiagnosticMappingInfo &Info = GetCurDiagState()->getOrAddMappingInfo(
287      GroupDiags[i]);
288
289    if (Info.getMapping() == diag::MAP_FATAL)
290      Info.setMapping(diag::MAP_ERROR);
291
292    Info.setNoErrorAsFatal(true);
293  }
294
295  return false;
296}
297
298bool DiagnosticsEngine::setMappingToAllDiagnostics(diag::Mapping Map,
299                                                   SourceLocation Loc) {
300  // Get all the diagnostics.
301  llvm::SmallVector<diag::kind, 64> AllDiags;
302  Diags->getAllDiagnostics(AllDiags);
303
304  // Set the mapping.
305  for (unsigned i = 0, e = AllDiags.size(); i != e; ++i)
306    if (Diags->isBuiltinWarningOrExtension(AllDiags[i]))
307      setDiagnosticMapping(AllDiags[i], Map, Loc);
308
309  return false;
310}
311
312void DiagnosticsEngine::Report(const StoredDiagnostic &storedDiag) {
313  assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!");
314
315  CurDiagLoc = storedDiag.getLocation();
316  CurDiagID = storedDiag.getID();
317  NumDiagArgs = 0;
318
319  NumDiagRanges = storedDiag.range_size();
320  assert(NumDiagRanges < sizeof(DiagRanges)/sizeof(DiagRanges[0]) &&
321         "Too many arguments to diagnostic!");
322  unsigned i = 0;
323  for (StoredDiagnostic::range_iterator
324         RI = storedDiag.range_begin(),
325         RE = storedDiag.range_end(); RI != RE; ++RI)
326    DiagRanges[i++] = *RI;
327
328  NumFixItHints = storedDiag.fixit_size();
329  assert(NumFixItHints < DiagnosticsEngine::MaxFixItHints &&
330      "Too many fix-it hints!");
331  i = 0;
332  for (StoredDiagnostic::fixit_iterator
333         FI = storedDiag.fixit_begin(),
334         FE = storedDiag.fixit_end(); FI != FE; ++FI)
335    FixItHints[i++] = *FI;
336
337  assert(Client && "DiagnosticConsumer not set!");
338  Level DiagLevel = storedDiag.getLevel();
339  Diagnostic Info(this, storedDiag.getMessage());
340  Client->HandleDiagnostic(DiagLevel, Info);
341  if (Client->IncludeInDiagnosticCounts()) {
342    if (DiagLevel == DiagnosticsEngine::Warning)
343      ++NumWarnings;
344  }
345
346  CurDiagID = ~0U;
347}
348
349void DiagnosticBuilder::FlushCounts() {
350  DiagObj->NumDiagArgs = NumArgs;
351  DiagObj->NumDiagRanges = NumRanges;
352  DiagObj->NumFixItHints = NumFixItHints;
353}
354
355bool DiagnosticBuilder::Emit() {
356  // If DiagObj is null, then its soul was stolen by the copy ctor
357  // or the user called Emit().
358  if (DiagObj == 0) return false;
359
360  // When emitting diagnostics, we set the final argument count into
361  // the DiagnosticsEngine object.
362  FlushCounts();
363
364  // Process the diagnostic, sending the accumulated information to the
365  // DiagnosticConsumer.
366  bool Emitted = DiagObj->ProcessDiag();
367
368  // Clear out the current diagnostic object.
369  unsigned DiagID = DiagObj->CurDiagID;
370  DiagObj->Clear();
371
372  // If there was a delayed diagnostic, emit it now.
373  if (DiagObj->DelayedDiagID && DiagObj->DelayedDiagID != DiagID)
374    DiagObj->ReportDelayed();
375
376  // This diagnostic is dead.
377  DiagObj = 0;
378
379  return Emitted;
380}
381
382
383DiagnosticConsumer::~DiagnosticConsumer() {}
384
385void DiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
386                                        const Diagnostic &Info) {
387  if (!IncludeInDiagnosticCounts())
388    return;
389
390  if (DiagLevel == DiagnosticsEngine::Warning)
391    ++NumWarnings;
392  else if (DiagLevel >= DiagnosticsEngine::Error)
393    ++NumErrors;
394}
395
396/// ModifierIs - Return true if the specified modifier matches specified string.
397template <std::size_t StrLen>
398static bool ModifierIs(const char *Modifier, unsigned ModifierLen,
399                       const char (&Str)[StrLen]) {
400  return StrLen-1 == ModifierLen && !memcmp(Modifier, Str, StrLen-1);
401}
402
403/// ScanForward - Scans forward, looking for the given character, skipping
404/// nested clauses and escaped characters.
405static const char *ScanFormat(const char *I, const char *E, char Target) {
406  unsigned Depth = 0;
407
408  for ( ; I != E; ++I) {
409    if (Depth == 0 && *I == Target) return I;
410    if (Depth != 0 && *I == '}') Depth--;
411
412    if (*I == '%') {
413      I++;
414      if (I == E) break;
415
416      // Escaped characters get implicitly skipped here.
417
418      // Format specifier.
419      if (!isdigit(*I) && !ispunct(*I)) {
420        for (I++; I != E && !isdigit(*I) && *I != '{'; I++) ;
421        if (I == E) break;
422        if (*I == '{')
423          Depth++;
424      }
425    }
426  }
427  return E;
428}
429
430/// HandleSelectModifier - Handle the integer 'select' modifier.  This is used
431/// like this:  %select{foo|bar|baz}2.  This means that the integer argument
432/// "%2" has a value from 0-2.  If the value is 0, the diagnostic prints 'foo'.
433/// If the value is 1, it prints 'bar'.  If it has the value 2, it prints 'baz'.
434/// This is very useful for certain classes of variant diagnostics.
435static void HandleSelectModifier(const Diagnostic &DInfo, unsigned ValNo,
436                                 const char *Argument, unsigned ArgumentLen,
437                                 SmallVectorImpl<char> &OutStr) {
438  const char *ArgumentEnd = Argument+ArgumentLen;
439
440  // Skip over 'ValNo' |'s.
441  while (ValNo) {
442    const char *NextVal = ScanFormat(Argument, ArgumentEnd, '|');
443    assert(NextVal != ArgumentEnd && "Value for integer select modifier was"
444           " larger than the number of options in the diagnostic string!");
445    Argument = NextVal+1;  // Skip this string.
446    --ValNo;
447  }
448
449  // Get the end of the value.  This is either the } or the |.
450  const char *EndPtr = ScanFormat(Argument, ArgumentEnd, '|');
451
452  // Recursively format the result of the select clause into the output string.
453  DInfo.FormatDiagnostic(Argument, EndPtr, OutStr);
454}
455
456/// HandleIntegerSModifier - Handle the integer 's' modifier.  This adds the
457/// letter 's' to the string if the value is not 1.  This is used in cases like
458/// this:  "you idiot, you have %4 parameter%s4!".
459static void HandleIntegerSModifier(unsigned ValNo,
460                                   SmallVectorImpl<char> &OutStr) {
461  if (ValNo != 1)
462    OutStr.push_back('s');
463}
464
465/// HandleOrdinalModifier - Handle the integer 'ord' modifier.  This
466/// prints the ordinal form of the given integer, with 1 corresponding
467/// to the first ordinal.  Currently this is hard-coded to use the
468/// English form.
469static void HandleOrdinalModifier(unsigned ValNo,
470                                  SmallVectorImpl<char> &OutStr) {
471  assert(ValNo != 0 && "ValNo must be strictly positive!");
472
473  llvm::raw_svector_ostream Out(OutStr);
474
475  // We could use text forms for the first N ordinals, but the numeric
476  // forms are actually nicer in diagnostics because they stand out.
477  Out << ValNo;
478
479  // It is critically important that we do this perfectly for
480  // user-written sequences with over 100 elements.
481  switch (ValNo % 100) {
482  case 11:
483  case 12:
484  case 13:
485    Out << "th"; return;
486  default:
487    switch (ValNo % 10) {
488    case 1: Out << "st"; return;
489    case 2: Out << "nd"; return;
490    case 3: Out << "rd"; return;
491    default: Out << "th"; return;
492    }
493  }
494}
495
496
497/// PluralNumber - Parse an unsigned integer and advance Start.
498static unsigned PluralNumber(const char *&Start, const char *End) {
499  // Programming 101: Parse a decimal number :-)
500  unsigned Val = 0;
501  while (Start != End && *Start >= '0' && *Start <= '9') {
502    Val *= 10;
503    Val += *Start - '0';
504    ++Start;
505  }
506  return Val;
507}
508
509/// TestPluralRange - Test if Val is in the parsed range. Modifies Start.
510static bool TestPluralRange(unsigned Val, const char *&Start, const char *End) {
511  if (*Start != '[') {
512    unsigned Ref = PluralNumber(Start, End);
513    return Ref == Val;
514  }
515
516  ++Start;
517  unsigned Low = PluralNumber(Start, End);
518  assert(*Start == ',' && "Bad plural expression syntax: expected ,");
519  ++Start;
520  unsigned High = PluralNumber(Start, End);
521  assert(*Start == ']' && "Bad plural expression syntax: expected )");
522  ++Start;
523  return Low <= Val && Val <= High;
524}
525
526/// EvalPluralExpr - Actual expression evaluator for HandlePluralModifier.
527static bool EvalPluralExpr(unsigned ValNo, const char *Start, const char *End) {
528  // Empty condition?
529  if (*Start == ':')
530    return true;
531
532  while (1) {
533    char C = *Start;
534    if (C == '%') {
535      // Modulo expression
536      ++Start;
537      unsigned Arg = PluralNumber(Start, End);
538      assert(*Start == '=' && "Bad plural expression syntax: expected =");
539      ++Start;
540      unsigned ValMod = ValNo % Arg;
541      if (TestPluralRange(ValMod, Start, End))
542        return true;
543    } else {
544      assert((C == '[' || (C >= '0' && C <= '9')) &&
545             "Bad plural expression syntax: unexpected character");
546      // Range expression
547      if (TestPluralRange(ValNo, Start, End))
548        return true;
549    }
550
551    // Scan for next or-expr part.
552    Start = std::find(Start, End, ',');
553    if (Start == End)
554      break;
555    ++Start;
556  }
557  return false;
558}
559
560/// HandlePluralModifier - Handle the integer 'plural' modifier. This is used
561/// for complex plural forms, or in languages where all plurals are complex.
562/// The syntax is: %plural{cond1:form1|cond2:form2|:form3}, where condn are
563/// conditions that are tested in order, the form corresponding to the first
564/// that applies being emitted. The empty condition is always true, making the
565/// last form a default case.
566/// Conditions are simple boolean expressions, where n is the number argument.
567/// Here are the rules.
568/// condition  := expression | empty
569/// empty      :=                             -> always true
570/// expression := numeric [',' expression]    -> logical or
571/// numeric    := range                       -> true if n in range
572///             | '%' number '=' range        -> true if n % number in range
573/// range      := number
574///             | '[' number ',' number ']'   -> ranges are inclusive both ends
575///
576/// Here are some examples from the GNU gettext manual written in this form:
577/// English:
578/// {1:form0|:form1}
579/// Latvian:
580/// {0:form2|%100=11,%10=0,%10=[2,9]:form1|:form0}
581/// Gaeilge:
582/// {1:form0|2:form1|:form2}
583/// Romanian:
584/// {1:form0|0,%100=[1,19]:form1|:form2}
585/// Lithuanian:
586/// {%10=0,%100=[10,19]:form2|%10=1:form0|:form1}
587/// Russian (requires repeated form):
588/// {%100=[11,14]:form2|%10=1:form0|%10=[2,4]:form1|:form2}
589/// Slovak
590/// {1:form0|[2,4]:form1|:form2}
591/// Polish (requires repeated form):
592/// {1:form0|%100=[10,20]:form2|%10=[2,4]:form1|:form2}
593static void HandlePluralModifier(const Diagnostic &DInfo, unsigned ValNo,
594                                 const char *Argument, unsigned ArgumentLen,
595                                 SmallVectorImpl<char> &OutStr) {
596  const char *ArgumentEnd = Argument + ArgumentLen;
597  while (1) {
598    assert(Argument < ArgumentEnd && "Plural expression didn't match.");
599    const char *ExprEnd = Argument;
600    while (*ExprEnd != ':') {
601      assert(ExprEnd != ArgumentEnd && "Plural missing expression end");
602      ++ExprEnd;
603    }
604    if (EvalPluralExpr(ValNo, Argument, ExprEnd)) {
605      Argument = ExprEnd + 1;
606      ExprEnd = ScanFormat(Argument, ArgumentEnd, '|');
607
608      // Recursively format the result of the plural clause into the
609      // output string.
610      DInfo.FormatDiagnostic(Argument, ExprEnd, OutStr);
611      return;
612    }
613    Argument = ScanFormat(Argument, ArgumentEnd - 1, '|') + 1;
614  }
615}
616
617
618/// FormatDiagnostic - Format this diagnostic into a string, substituting the
619/// formal arguments into the %0 slots.  The result is appended onto the Str
620/// array.
621void Diagnostic::
622FormatDiagnostic(SmallVectorImpl<char> &OutStr) const {
623  if (!StoredDiagMessage.empty()) {
624    OutStr.append(StoredDiagMessage.begin(), StoredDiagMessage.end());
625    return;
626  }
627
628  StringRef Diag =
629    getDiags()->getDiagnosticIDs()->getDescription(getID());
630
631  FormatDiagnostic(Diag.begin(), Diag.end(), OutStr);
632}
633
634void Diagnostic::
635FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
636                 SmallVectorImpl<char> &OutStr) const {
637
638  /// FormattedArgs - Keep track of all of the arguments formatted by
639  /// ConvertArgToString and pass them into subsequent calls to
640  /// ConvertArgToString, allowing the implementation to avoid redundancies in
641  /// obvious cases.
642  SmallVector<DiagnosticsEngine::ArgumentValue, 8> FormattedArgs;
643
644  /// QualTypeVals - Pass a vector of arrays so that QualType names can be
645  /// compared to see if more information is needed to be printed.
646  SmallVector<intptr_t, 2> QualTypeVals;
647  for (unsigned i = 0, e = getNumArgs(); i < e; ++i)
648    if (getArgKind(i) == DiagnosticsEngine::ak_qualtype)
649      QualTypeVals.push_back(getRawArg(i));
650
651  while (DiagStr != DiagEnd) {
652    if (DiagStr[0] != '%') {
653      // Append non-%0 substrings to Str if we have one.
654      const char *StrEnd = std::find(DiagStr, DiagEnd, '%');
655      OutStr.append(DiagStr, StrEnd);
656      DiagStr = StrEnd;
657      continue;
658    } else if (ispunct(DiagStr[1])) {
659      OutStr.push_back(DiagStr[1]);  // %% -> %.
660      DiagStr += 2;
661      continue;
662    }
663
664    // Skip the %.
665    ++DiagStr;
666
667    // This must be a placeholder for a diagnostic argument.  The format for a
668    // placeholder is one of "%0", "%modifier0", or "%modifier{arguments}0".
669    // The digit is a number from 0-9 indicating which argument this comes from.
670    // The modifier is a string of digits from the set [-a-z]+, arguments is a
671    // brace enclosed string.
672    const char *Modifier = 0, *Argument = 0;
673    unsigned ModifierLen = 0, ArgumentLen = 0;
674
675    // Check to see if we have a modifier.  If so eat it.
676    if (!isdigit(DiagStr[0])) {
677      Modifier = DiagStr;
678      while (DiagStr[0] == '-' ||
679             (DiagStr[0] >= 'a' && DiagStr[0] <= 'z'))
680        ++DiagStr;
681      ModifierLen = DiagStr-Modifier;
682
683      // If we have an argument, get it next.
684      if (DiagStr[0] == '{') {
685        ++DiagStr; // Skip {.
686        Argument = DiagStr;
687
688        DiagStr = ScanFormat(DiagStr, DiagEnd, '}');
689        assert(DiagStr != DiagEnd && "Mismatched {}'s in diagnostic string!");
690        ArgumentLen = DiagStr-Argument;
691        ++DiagStr;  // Skip }.
692      }
693    }
694
695    assert(isdigit(*DiagStr) && "Invalid format for argument in diagnostic");
696    unsigned ArgNo = *DiagStr++ - '0';
697
698    DiagnosticsEngine::ArgumentKind Kind = getArgKind(ArgNo);
699
700    switch (Kind) {
701    // ---- STRINGS ----
702    case DiagnosticsEngine::ak_std_string: {
703      const std::string &S = getArgStdStr(ArgNo);
704      assert(ModifierLen == 0 && "No modifiers for strings yet");
705      OutStr.append(S.begin(), S.end());
706      break;
707    }
708    case DiagnosticsEngine::ak_c_string: {
709      const char *S = getArgCStr(ArgNo);
710      assert(ModifierLen == 0 && "No modifiers for strings yet");
711
712      // Don't crash if get passed a null pointer by accident.
713      if (!S)
714        S = "(null)";
715
716      OutStr.append(S, S + strlen(S));
717      break;
718    }
719    // ---- INTEGERS ----
720    case DiagnosticsEngine::ak_sint: {
721      int Val = getArgSInt(ArgNo);
722
723      if (ModifierIs(Modifier, ModifierLen, "select")) {
724        HandleSelectModifier(*this, (unsigned)Val, Argument, ArgumentLen,
725                             OutStr);
726      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
727        HandleIntegerSModifier(Val, OutStr);
728      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
729        HandlePluralModifier(*this, (unsigned)Val, Argument, ArgumentLen,
730                             OutStr);
731      } else if (ModifierIs(Modifier, ModifierLen, "ordinal")) {
732        HandleOrdinalModifier((unsigned)Val, OutStr);
733      } else {
734        assert(ModifierLen == 0 && "Unknown integer modifier");
735        llvm::raw_svector_ostream(OutStr) << Val;
736      }
737      break;
738    }
739    case DiagnosticsEngine::ak_uint: {
740      unsigned Val = getArgUInt(ArgNo);
741
742      if (ModifierIs(Modifier, ModifierLen, "select")) {
743        HandleSelectModifier(*this, Val, Argument, ArgumentLen, OutStr);
744      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
745        HandleIntegerSModifier(Val, OutStr);
746      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
747        HandlePluralModifier(*this, (unsigned)Val, Argument, ArgumentLen,
748                             OutStr);
749      } else if (ModifierIs(Modifier, ModifierLen, "ordinal")) {
750        HandleOrdinalModifier(Val, OutStr);
751      } else {
752        assert(ModifierLen == 0 && "Unknown integer modifier");
753        llvm::raw_svector_ostream(OutStr) << Val;
754      }
755      break;
756    }
757    // ---- NAMES and TYPES ----
758    case DiagnosticsEngine::ak_identifierinfo: {
759      const IdentifierInfo *II = getArgIdentifier(ArgNo);
760      assert(ModifierLen == 0 && "No modifiers for strings yet");
761
762      // Don't crash if get passed a null pointer by accident.
763      if (!II) {
764        const char *S = "(null)";
765        OutStr.append(S, S + strlen(S));
766        continue;
767      }
768
769      llvm::raw_svector_ostream(OutStr) << '\'' << II->getName() << '\'';
770      break;
771    }
772    case DiagnosticsEngine::ak_qualtype:
773    case DiagnosticsEngine::ak_declarationname:
774    case DiagnosticsEngine::ak_nameddecl:
775    case DiagnosticsEngine::ak_nestednamespec:
776    case DiagnosticsEngine::ak_declcontext:
777      getDiags()->ConvertArgToString(Kind, getRawArg(ArgNo),
778                                     Modifier, ModifierLen,
779                                     Argument, ArgumentLen,
780                                     FormattedArgs.data(), FormattedArgs.size(),
781                                     OutStr, QualTypeVals);
782      break;
783    }
784
785    // Remember this argument info for subsequent formatting operations.  Turn
786    // std::strings into a null terminated string to make it be the same case as
787    // all the other ones.
788    if (Kind != DiagnosticsEngine::ak_std_string)
789      FormattedArgs.push_back(std::make_pair(Kind, getRawArg(ArgNo)));
790    else
791      FormattedArgs.push_back(std::make_pair(DiagnosticsEngine::ak_c_string,
792                                        (intptr_t)getArgStdStr(ArgNo).c_str()));
793
794  }
795}
796
797StoredDiagnostic::StoredDiagnostic() { }
798
799StoredDiagnostic::StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
800                                   StringRef Message)
801  : ID(ID), Level(Level), Loc(), Message(Message) { }
802
803StoredDiagnostic::StoredDiagnostic(DiagnosticsEngine::Level Level,
804                                   const Diagnostic &Info)
805  : ID(Info.getID()), Level(Level)
806{
807  assert((Info.getLocation().isInvalid() || Info.hasSourceManager()) &&
808       "Valid source location without setting a source manager for diagnostic");
809  if (Info.getLocation().isValid())
810    Loc = FullSourceLoc(Info.getLocation(), Info.getSourceManager());
811  llvm::SmallString<64> Message;
812  Info.FormatDiagnostic(Message);
813  this->Message.assign(Message.begin(), Message.end());
814
815  Ranges.reserve(Info.getNumRanges());
816  for (unsigned I = 0, N = Info.getNumRanges(); I != N; ++I)
817    Ranges.push_back(Info.getRange(I));
818
819  FixIts.reserve(Info.getNumFixItHints());
820  for (unsigned I = 0, N = Info.getNumFixItHints(); I != N; ++I)
821    FixIts.push_back(Info.getFixItHint(I));
822}
823
824StoredDiagnostic::StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
825                                   StringRef Message, FullSourceLoc Loc,
826                                   ArrayRef<CharSourceRange> Ranges,
827                                   ArrayRef<FixItHint> Fixits)
828  : ID(ID), Level(Level), Loc(Loc), Message(Message)
829{
830  this->Ranges.assign(Ranges.begin(), Ranges.end());
831  this->FixIts.assign(FixIts.begin(), FixIts.end());
832}
833
834StoredDiagnostic::~StoredDiagnostic() { }
835
836/// IncludeInDiagnosticCounts - This method (whose default implementation
837///  returns true) indicates whether the diagnostics handled by this
838///  DiagnosticConsumer should be included in the number of diagnostics
839///  reported by DiagnosticsEngine.
840bool DiagnosticConsumer::IncludeInDiagnosticCounts() const { return true; }
841
842void IgnoringDiagConsumer::anchor() { }
843
844PartialDiagnostic::StorageAllocator::StorageAllocator() {
845  for (unsigned I = 0; I != NumCached; ++I)
846    FreeList[I] = Cached + I;
847  NumFreeListEntries = NumCached;
848}
849
850PartialDiagnostic::StorageAllocator::~StorageAllocator() {
851  // Don't assert if we are in a CrashRecovery context, as this
852  // invariant may be invalidated during a crash.
853  assert((NumFreeListEntries == NumCached || llvm::CrashRecoveryContext::isRecoveringFromCrash()) && "A partial is on the lamb");
854}
855