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