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