Diagnostic.cpp revision 50f4f469024928670f2d634c445686d00eeb89b7
11320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//===--- Diagnostic.cpp - C Language Family Diagnostic Handling -----------===//
21320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//
31320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//                     The LLVM Compiler Infrastructure
41320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//
51320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// This file is distributed under the University of Illinois Open Source
61320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// License. See LICENSE.TXT for details.
71320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//
81320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//===----------------------------------------------------------------------===//
91320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//
101320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//  This file implements the Diagnostic-related interfaces.
111320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//
121320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//===----------------------------------------------------------------------===//
131320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
141320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/Diagnostic.h"
151320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/IdentifierTable.h"
161320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/SourceLocation.h"
171320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "llvm/ADT/SmallVector.h"
181320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "llvm/ADT/StringExtras.h"
191320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include <vector>
201320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include <map>
211320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include <cstring>
221320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucciusing namespace clang;
231320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
241320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//===----------------------------------------------------------------------===//
251320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Builtin Diagnostic information
261320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci//===----------------------------------------------------------------------===//
271320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
281320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// Flag values for diagnostics.
291320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccienum {
301320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  // Diagnostic classes.
311320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  NOTE       = 0x01,
321320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  WARNING    = 0x02,
331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  EXTENSION  = 0x03,
341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  EXTWARN    = 0x04,
351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  ERROR      = 0x05,
361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  FATAL      = 0x06,
371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  class_mask = 0x07
381320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// DiagnosticFlags - A set of flags, or'd together, that describe the
411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// diagnostic.
421320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#define DIAG(ENUM,FLAGS,DESC) FLAGS,
431320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsCommon[] = {
441320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticCommonKinds.def"
451320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
461320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
471320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsDriver[] = {
481320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticDriverKinds.def"
491320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
501320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
511320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsFrontend[] = {
521320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticFrontendKinds.def"
531320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
541320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
551320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsLex[] = {
561320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticLexKinds.def"
571320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
581320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
591320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsParse[] = {
601320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticParseKinds.def"
611320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
621320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
631320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsAST[] = {
641320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticASTKinds.def"
651320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
661320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
671320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsSema[] = {
681320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticSemaKinds.def"
691320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
701320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
711320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned char DiagnosticFlagsAnalysis[] = {
721320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/DiagnosticAnalysisKinds.def"
731320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci  0
741320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci};
751320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#undef DIAG
761320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci
771320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// getDiagClass - Return the class field of the diagnostic.
781320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci///
791320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccistatic unsigned getBuiltinDiagClass(unsigned DiagID) {
80  assert(DiagID < diag::DIAG_UPPER_LIMIT &&
81         "Diagnostic ID out of range!");
82  unsigned res;
83  if (DiagID < diag::DIAG_START_DRIVER)
84    res = DiagnosticFlagsCommon[DiagID];
85  else if (DiagID < diag::DIAG_START_FRONTEND)
86    res = DiagnosticFlagsDriver[DiagID - diag::DIAG_START_DRIVER - 1];
87  else if (DiagID < diag::DIAG_START_LEX)
88    res = DiagnosticFlagsFrontend[DiagID - diag::DIAG_START_FRONTEND - 1];
89  else if (DiagID < diag::DIAG_START_PARSE)
90    res = DiagnosticFlagsLex[DiagID - diag::DIAG_START_LEX - 1];
91  else if (DiagID < diag::DIAG_START_AST)
92    res = DiagnosticFlagsParse[DiagID - diag::DIAG_START_PARSE - 1];
93  else if (DiagID < diag::DIAG_START_SEMA)
94    res = DiagnosticFlagsAST[DiagID - diag::DIAG_START_AST - 1];
95  else if (DiagID < diag::DIAG_START_ANALYSIS)
96    res = DiagnosticFlagsSema[DiagID - diag::DIAG_START_SEMA - 1];
97  else
98    res = DiagnosticFlagsAnalysis[DiagID - diag::DIAG_START_ANALYSIS - 1];
99  return res & class_mask;
100}
101
102/// DiagnosticText - An english message to print for the diagnostic.  These
103/// should be localized.
104#define DIAG(ENUM,FLAGS,DESC) DESC,
105static const char * const DiagnosticTextCommon[] = {
106#include "clang/Basic/DiagnosticCommonKinds.def"
107  0
108};
109static const char * const DiagnosticTextDriver[] = {
110#include "clang/Basic/DiagnosticDriverKinds.def"
111  0
112};
113static const char * const DiagnosticTextFrontend[] = {
114#include "clang/Basic/DiagnosticFrontendKinds.def"
115  0
116};
117static const char * const DiagnosticTextLex[] = {
118#include "clang/Basic/DiagnosticLexKinds.def"
119  0
120};
121static const char * const DiagnosticTextParse[] = {
122#include "clang/Basic/DiagnosticParseKinds.def"
123  0
124};
125static const char * const DiagnosticTextAST[] = {
126#include "clang/Basic/DiagnosticASTKinds.def"
127  0
128};
129static const char * const DiagnosticTextSema[] = {
130#include "clang/Basic/DiagnosticSemaKinds.def"
131  0
132};
133static const char * const DiagnosticTextAnalysis[] = {
134#include "clang/Basic/DiagnosticAnalysisKinds.def"
135  0
136};
137#undef DIAG
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, const char *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
179        // If this is a warning, and all warnings are supposed to map to errors,
180        // insert the mapping now.
181        if (L == Diagnostic::Warning && Diags.getWarningsAsErrors())
182          Diags.setDiagnosticMapping((diag::kind)ID, diag::MAP_ERROR);
183        return ID;
184      }
185    };
186
187  } // end diag namespace
188} // end clang namespace
189
190
191//===----------------------------------------------------------------------===//
192// Common Diagnostic implementation
193//===----------------------------------------------------------------------===//
194
195static void DummyArgToStringFn(Diagnostic::ArgumentKind AK, intptr_t QT,
196                               const char *Modifier, unsigned ML,
197                               const char *Argument, unsigned ArgLen,
198                               llvm::SmallVectorImpl<char> &Output,
199                               void *Cookie) {
200  const char *Str = "<can't format argument>";
201  Output.append(Str, Str+strlen(Str));
202}
203
204
205Diagnostic::Diagnostic(DiagnosticClient *client) : Client(client) {
206  IgnoreAllWarnings = false;
207  WarningsAsErrors = false;
208  WarnOnExtensions = false;
209  ErrorOnExtensions = false;
210  SuppressSystemWarnings = false;
211  // Clear all mappings, setting them to MAP_DEFAULT.
212  memset(DiagMappings, 0, sizeof(DiagMappings));
213
214  ErrorOccurred = false;
215  FatalErrorOccurred = false;
216  NumDiagnostics = 0;
217  NumErrors = 0;
218  CustomDiagInfo = 0;
219  CurDiagID = ~0U;
220  LastDiagLevel = Fatal;
221
222  ArgToStringFn = DummyArgToStringFn;
223  ArgToStringCookie = 0;
224
225  InPostDiagnosticHook = false;
226}
227
228Diagnostic::~Diagnostic() {
229  delete CustomDiagInfo;
230}
231
232/// getCustomDiagID - Return an ID for a diagnostic with the specified message
233/// and level.  If this is the first request for this diagnosic, it is
234/// registered and created, otherwise the existing ID is returned.
235unsigned Diagnostic::getCustomDiagID(Level L, const char *Message) {
236  if (CustomDiagInfo == 0)
237    CustomDiagInfo = new diag::CustomDiagInfo();
238  return CustomDiagInfo->getOrCreateDiagID(L, Message, *this);
239}
240
241
242/// isBuiltinWarningOrExtension - Return true if the unmapped diagnostic
243/// level of the specified diagnostic ID is a Warning or Extension.
244/// This only works on builtin diagnostics, not custom ones, and is not legal to
245/// call on NOTEs.
246bool Diagnostic::isBuiltinWarningOrExtension(unsigned DiagID) {
247  return DiagID < diag::DIAG_UPPER_LIMIT && getBuiltinDiagClass(DiagID) < ERROR;
248}
249
250/// \brief Determine whether the given built-in diagnostic ID is a
251/// Note.
252bool Diagnostic::isBuiltinNote(unsigned DiagID) {
253  return DiagID < diag::DIAG_UPPER_LIMIT && getBuiltinDiagClass(DiagID) == NOTE;
254}
255
256
257/// getDescription - Given a diagnostic ID, return a description of the
258/// issue.
259const char *Diagnostic::getDescription(unsigned DiagID) const {
260  if (DiagID < diag::DIAG_START_DRIVER)
261    return DiagnosticTextCommon[DiagID];
262  else if (DiagID < diag::DIAG_START_FRONTEND)
263    return DiagnosticTextDriver[DiagID - diag::DIAG_START_DRIVER - 1];
264  else if (DiagID < diag::DIAG_START_LEX)
265    return DiagnosticTextFrontend[DiagID - diag::DIAG_START_FRONTEND - 1];
266  else if (DiagID < diag::DIAG_START_PARSE)
267    return DiagnosticTextLex[DiagID - diag::DIAG_START_LEX - 1];
268  else if (DiagID < diag::DIAG_START_AST)
269    return DiagnosticTextParse[DiagID - diag::DIAG_START_PARSE - 1];
270  else if (DiagID < diag::DIAG_START_SEMA)
271    return DiagnosticTextAST[DiagID - diag::DIAG_START_AST - 1];
272  else if (DiagID < diag::DIAG_START_ANALYSIS)
273    return DiagnosticTextSema[DiagID - diag::DIAG_START_SEMA - 1];
274  else if (DiagID < diag::DIAG_UPPER_LIMIT)
275    return DiagnosticTextAnalysis[DiagID - diag::DIAG_START_ANALYSIS - 1];
276  return CustomDiagInfo->getDescription(DiagID);
277}
278
279/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
280/// object, classify the specified diagnostic ID into a Level, consumable by
281/// the DiagnosticClient.
282Diagnostic::Level Diagnostic::getDiagnosticLevel(unsigned DiagID) const {
283  // Handle custom diagnostics, which cannot be mapped.
284  if (DiagID >= diag::DIAG_UPPER_LIMIT)
285    return CustomDiagInfo->getLevel(DiagID);
286
287  unsigned DiagClass = getBuiltinDiagClass(DiagID);
288  assert(DiagClass != NOTE && "Cannot get the diagnostic level of a note!");
289  return getDiagnosticLevel(DiagID, DiagClass);
290}
291
292/// getDiagnosticLevel - Based on the way the client configured the Diagnostic
293/// object, classify the specified diagnostic ID into a Level, consumable by
294/// the DiagnosticClient.
295Diagnostic::Level
296Diagnostic::getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const {
297  // Specific non-error diagnostics may be mapped to various levels from ignored
298  // to error.  Errors can only be mapped to fatal.
299  switch (getDiagnosticMapping((diag::kind)DiagID)) {
300  case diag::MAP_DEFAULT: break;
301  case diag::MAP_IGNORE:  return Diagnostic::Ignored;
302  case diag::MAP_WARNING: DiagClass = WARNING; break;
303  case diag::MAP_ERROR:   DiagClass = ERROR; break;
304  case diag::MAP_FATAL:   DiagClass = FATAL; break;
305  }
306
307  // Map diagnostic classes based on command line argument settings.
308  if (DiagClass == EXTENSION) {
309    if (ErrorOnExtensions)
310      DiagClass = ERROR;
311    else if (WarnOnExtensions)
312      DiagClass = WARNING;
313    else
314      return Ignored;
315  } else if (DiagClass == EXTWARN) {
316    DiagClass = ErrorOnExtensions ? ERROR : WARNING;
317  }
318
319  // If warnings are globally mapped to ignore or error, do it.
320  if (DiagClass == WARNING) {
321    if (IgnoreAllWarnings)
322      return Diagnostic::Ignored;
323    if (WarningsAsErrors)
324      DiagClass = ERROR;
325  }
326
327  switch (DiagClass) {
328  default: assert(0 && "Unknown diagnostic class!");
329  case WARNING:     return Diagnostic::Warning;
330  case ERROR:       return Diagnostic::Error;
331  case FATAL:       return Diagnostic::Fatal;
332  }
333}
334
335/// ProcessDiag - This is the method used to report a diagnostic that is
336/// finally fully formed.
337void Diagnostic::ProcessDiag() {
338  DiagnosticInfo Info(this);
339
340  // If a fatal error has already been emitted, silence all subsequent
341  // diagnostics.
342  if (FatalErrorOccurred)
343    return;
344
345  // Figure out the diagnostic level of this message.
346  Diagnostic::Level DiagLevel;
347  unsigned DiagID = Info.getID();
348
349  // ShouldEmitInSystemHeader - True if this diagnostic should be produced even
350  // in a system header.
351  bool ShouldEmitInSystemHeader;
352
353  if (DiagID >= diag::DIAG_UPPER_LIMIT) {
354    // Handle custom diagnostics, which cannot be mapped.
355    DiagLevel = CustomDiagInfo->getLevel(DiagID);
356
357    // Custom diagnostics always are emitted in system headers.
358    ShouldEmitInSystemHeader = true;
359  } else {
360    // Get the class of the diagnostic.  If this is a NOTE, map it onto whatever
361    // the diagnostic level was for the previous diagnostic so that it is
362    // filtered the same as the previous diagnostic.
363    unsigned DiagClass = getBuiltinDiagClass(DiagID);
364    if (DiagClass == NOTE) {
365      DiagLevel = Diagnostic::Note;
366      ShouldEmitInSystemHeader = false;  // extra consideration is needed
367    } else {
368      // If this is not an error and we are in a system header, we ignore it.
369      // Check the original Diag ID here, because we also want to ignore
370      // extensions and warnings in -Werror and -pedantic-errors modes, which
371      // *map* warnings/extensions to errors.
372      ShouldEmitInSystemHeader = DiagClass == ERROR;
373
374      DiagLevel = getDiagnosticLevel(DiagID, DiagClass);
375    }
376  }
377
378  if (DiagLevel != Diagnostic::Note)
379    LastDiagLevel = DiagLevel;
380
381  // If the client doesn't care about this message, don't issue it.  If this is
382  // a note and the last real diagnostic was ignored, ignore it too.
383  if (DiagLevel == Diagnostic::Ignored ||
384      (DiagLevel == Diagnostic::Note && LastDiagLevel == Diagnostic::Ignored))
385    return;
386
387  // If this diagnostic is in a system header and is not a clang error, suppress
388  // it.
389  if (SuppressSystemWarnings && !ShouldEmitInSystemHeader &&
390      Info.getLocation().isValid() &&
391      Info.getLocation().getSpellingLoc().isInSystemHeader() &&
392      (DiagLevel != Diagnostic::Note || LastDiagLevel == Diagnostic::Ignored)) {
393    LastDiagLevel = Diagnostic::Ignored;
394    return;
395  }
396
397  if (DiagLevel >= Diagnostic::Error) {
398    ErrorOccurred = true;
399    ++NumErrors;
400
401    if (DiagLevel == Diagnostic::Fatal)
402      FatalErrorOccurred = true;
403  }
404
405  // Finally, report it.
406  Client->HandleDiagnostic(DiagLevel, Info);
407  if (Client->IncludeInDiagnosticCounts()) ++NumDiagnostics;
408
409  // Invoke any post-diagnostic hooks.
410  unsigned LastDiag = CurDiagID;
411  CurDiagID = ~0U;
412
413  InPostDiagnosticHook = true;
414  for (unsigned Hook = 0; Hook < NumPostDiagnosticHooks; ++Hook)
415    PostDiagnosticHooks[Hook].Hook(LastDiag,
416                                   PostDiagnosticHooks[Hook].Cookie);
417  InPostDiagnosticHook = false;
418}
419
420
421DiagnosticClient::~DiagnosticClient() {}
422
423
424/// ModifierIs - Return true if the specified modifier matches specified string.
425template <std::size_t StrLen>
426static bool ModifierIs(const char *Modifier, unsigned ModifierLen,
427                       const char (&Str)[StrLen]) {
428  return StrLen-1 == ModifierLen && !memcmp(Modifier, Str, StrLen-1);
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(unsigned ValNo,
437                                 const char *Argument, unsigned ArgumentLen,
438                                 llvm::SmallVectorImpl<char> &OutStr) {
439  const char *ArgumentEnd = Argument+ArgumentLen;
440
441  // Skip over 'ValNo' |'s.
442  while (ValNo) {
443    const char *NextVal = std::find(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 = std::find(Argument, ArgumentEnd, '|');
452  // Add the value to the output string.
453  OutStr.append(Argument, EndPtr);
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                                   llvm::SmallVectorImpl<char> &OutStr) {
461  if (ValNo != 1)
462    OutStr.push_back('s');
463}
464
465
466/// PluralNumber - Parse an unsigned integer and advance Start.
467static unsigned PluralNumber(const char *&Start, const char *End)
468{
469  // Programming 101: Parse a decimal number :-)
470  unsigned Val = 0;
471  while (Start != End && *Start >= '0' && *Start <= '9') {
472    Val *= 10;
473    Val += *Start - '0';
474    ++Start;
475  }
476  return Val;
477}
478
479/// TestPluralRange - Test if Val is in the parsed range. Modifies Start.
480static bool TestPluralRange(unsigned Val, const char *&Start, const char *End)
481{
482  if (*Start != '[') {
483    unsigned Ref = PluralNumber(Start, End);
484    return Ref == Val;
485  }
486
487  ++Start;
488  unsigned Low = PluralNumber(Start, End);
489  assert(*Start == ',' && "Bad plural expression syntax: expected ,");
490  ++Start;
491  unsigned High = PluralNumber(Start, End);
492  assert(*Start == ']' && "Bad plural expression syntax: expected )");
493  ++Start;
494  return Low <= Val && Val <= High;
495}
496
497/// EvalPluralExpr - Actual expression evaluator for HandlePluralModifier.
498static bool EvalPluralExpr(unsigned ValNo, const char *Start, const char *End)
499{
500  // Empty condition?
501  if (*Start == ':')
502    return true;
503
504  while (1) {
505    char C = *Start;
506    if (C == '%') {
507      // Modulo expression
508      ++Start;
509      unsigned Arg = PluralNumber(Start, End);
510      assert(*Start == '=' && "Bad plural expression syntax: expected =");
511      ++Start;
512      unsigned ValMod = ValNo % Arg;
513      if (TestPluralRange(ValMod, Start, End))
514        return true;
515    } else {
516      assert((C == '[' || (C >= '0' && C <= '9')) &&
517             "Bad plural expression syntax: unexpected character");
518      // Range expression
519      if (TestPluralRange(ValNo, Start, End))
520        return true;
521    }
522
523    // Scan for next or-expr part.
524    Start = std::find(Start, End, ',');
525    if(Start == End)
526      break;
527    ++Start;
528  }
529  return false;
530}
531
532/// HandlePluralModifier - Handle the integer 'plural' modifier. This is used
533/// for complex plural forms, or in languages where all plurals are complex.
534/// The syntax is: %plural{cond1:form1|cond2:form2|:form3}, where condn are
535/// conditions that are tested in order, the form corresponding to the first
536/// that applies being emitted. The empty condition is always true, making the
537/// last form a default case.
538/// Conditions are simple boolean expressions, where n is the number argument.
539/// Here are the rules.
540/// condition  := expression | empty
541/// empty      :=                             -> always true
542/// expression := numeric [',' expression]    -> logical or
543/// numeric    := range                       -> true if n in range
544///             | '%' number '=' range        -> true if n % number in range
545/// range      := number
546///             | '[' number ',' number ']'   -> ranges are inclusive both ends
547///
548/// Here are some examples from the GNU gettext manual written in this form:
549/// English:
550/// {1:form0|:form1}
551/// Latvian:
552/// {0:form2|%100=11,%10=0,%10=[2,9]:form1|:form0}
553/// Gaeilge:
554/// {1:form0|2:form1|:form2}
555/// Romanian:
556/// {1:form0|0,%100=[1,19]:form1|:form2}
557/// Lithuanian:
558/// {%10=0,%100=[10,19]:form2|%10=1:form0|:form1}
559/// Russian (requires repeated form):
560/// {%100=[11,14]:form2|%10=1:form0|%10=[2,4]:form1|:form2}
561/// Slovak
562/// {1:form0|[2,4]:form1|:form2}
563/// Polish (requires repeated form):
564/// {1:form0|%100=[10,20]:form2|%10=[2,4]:form1|:form2}
565static void HandlePluralModifier(unsigned ValNo,
566                                 const char *Argument, unsigned ArgumentLen,
567                                 llvm::SmallVectorImpl<char> &OutStr)
568{
569  const char *ArgumentEnd = Argument + ArgumentLen;
570  while (1) {
571    assert(Argument < ArgumentEnd && "Plural expression didn't match.");
572    const char *ExprEnd = Argument;
573    while (*ExprEnd != ':') {
574      assert(ExprEnd != ArgumentEnd && "Plural missing expression end");
575      ++ExprEnd;
576    }
577    if (EvalPluralExpr(ValNo, Argument, ExprEnd)) {
578      Argument = ExprEnd + 1;
579      ExprEnd = std::find(Argument, ArgumentEnd, '|');
580      OutStr.append(Argument, ExprEnd);
581      return;
582    }
583    Argument = std::find(Argument, ArgumentEnd - 1, '|') + 1;
584  }
585}
586
587
588/// FormatDiagnostic - Format this diagnostic into a string, substituting the
589/// formal arguments into the %0 slots.  The result is appended onto the Str
590/// array.
591void DiagnosticInfo::
592FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const {
593  const char *DiagStr = getDiags()->getDescription(getID());
594  const char *DiagEnd = DiagStr+strlen(DiagStr);
595
596  while (DiagStr != DiagEnd) {
597    if (DiagStr[0] != '%') {
598      // Append non-%0 substrings to Str if we have one.
599      const char *StrEnd = std::find(DiagStr, DiagEnd, '%');
600      OutStr.append(DiagStr, StrEnd);
601      DiagStr = StrEnd;
602      continue;
603    } else if (DiagStr[1] == '%') {
604      OutStr.push_back('%');  // %% -> %.
605      DiagStr += 2;
606      continue;
607    }
608
609    // Skip the %.
610    ++DiagStr;
611
612    // This must be a placeholder for a diagnostic argument.  The format for a
613    // placeholder is one of "%0", "%modifier0", or "%modifier{arguments}0".
614    // The digit is a number from 0-9 indicating which argument this comes from.
615    // The modifier is a string of digits from the set [-a-z]+, arguments is a
616    // brace enclosed string.
617    const char *Modifier = 0, *Argument = 0;
618    unsigned ModifierLen = 0, ArgumentLen = 0;
619
620    // Check to see if we have a modifier.  If so eat it.
621    if (!isdigit(DiagStr[0])) {
622      Modifier = DiagStr;
623      while (DiagStr[0] == '-' ||
624             (DiagStr[0] >= 'a' && DiagStr[0] <= 'z'))
625        ++DiagStr;
626      ModifierLen = DiagStr-Modifier;
627
628      // If we have an argument, get it next.
629      if (DiagStr[0] == '{') {
630        ++DiagStr; // Skip {.
631        Argument = DiagStr;
632
633        for (; DiagStr[0] != '}'; ++DiagStr)
634          assert(DiagStr[0] && "Mismatched {}'s in diagnostic string!");
635        ArgumentLen = DiagStr-Argument;
636        ++DiagStr;  // Skip }.
637      }
638    }
639
640    assert(isdigit(*DiagStr) && "Invalid format for argument in diagnostic");
641    unsigned ArgNo = *DiagStr++ - '0';
642
643    switch (getArgKind(ArgNo)) {
644    // ---- STRINGS ----
645    case Diagnostic::ak_std_string: {
646      const std::string &S = getArgStdStr(ArgNo);
647      assert(ModifierLen == 0 && "No modifiers for strings yet");
648      OutStr.append(S.begin(), S.end());
649      break;
650    }
651    case Diagnostic::ak_c_string: {
652      const char *S = getArgCStr(ArgNo);
653      assert(ModifierLen == 0 && "No modifiers for strings yet");
654      OutStr.append(S, S + strlen(S));
655      break;
656    }
657    // ---- INTEGERS ----
658    case Diagnostic::ak_sint: {
659      int Val = getArgSInt(ArgNo);
660
661      if (ModifierIs(Modifier, ModifierLen, "select")) {
662        HandleSelectModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
663      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
664        HandleIntegerSModifier(Val, OutStr);
665      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
666        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
667      } else {
668        assert(ModifierLen == 0 && "Unknown integer modifier");
669        // FIXME: Optimize
670        std::string S = llvm::itostr(Val);
671        OutStr.append(S.begin(), S.end());
672      }
673      break;
674    }
675    case Diagnostic::ak_uint: {
676      unsigned Val = getArgUInt(ArgNo);
677
678      if (ModifierIs(Modifier, ModifierLen, "select")) {
679        HandleSelectModifier(Val, Argument, ArgumentLen, OutStr);
680      } else if (ModifierIs(Modifier, ModifierLen, "s")) {
681        HandleIntegerSModifier(Val, OutStr);
682      } else if (ModifierIs(Modifier, ModifierLen, "plural")) {
683        HandlePluralModifier((unsigned)Val, Argument, ArgumentLen, OutStr);
684      } else {
685        assert(ModifierLen == 0 && "Unknown integer modifier");
686
687        // FIXME: Optimize
688        std::string S = llvm::utostr_32(Val);
689        OutStr.append(S.begin(), S.end());
690      }
691      break;
692    }
693    // ---- NAMES and TYPES ----
694    case Diagnostic::ak_identifierinfo: {
695      const IdentifierInfo *II = getArgIdentifier(ArgNo);
696      assert(ModifierLen == 0 && "No modifiers for strings yet");
697      OutStr.push_back('\'');
698      OutStr.append(II->getName(), II->getName() + II->getLength());
699      OutStr.push_back('\'');
700      break;
701    }
702    case Diagnostic::ak_qualtype:
703    case Diagnostic::ak_declarationname:
704    case Diagnostic::ak_nameddecl:
705      getDiags()->ConvertArgToString(getArgKind(ArgNo), getRawArg(ArgNo),
706                                     Modifier, ModifierLen,
707                                     Argument, ArgumentLen, OutStr);
708      break;
709    }
710  }
711}
712
713/// IncludeInDiagnosticCounts - This method (whose default implementation
714///  returns true) indicates whether the diagnostics handled by this
715///  DiagnosticClient should be included in the number of diagnostics
716///  reported by Diagnostic.
717bool DiagnosticClient::IncludeInDiagnosticCounts() const { return true; }
718