1 //===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 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 defines the Diagnostic-related interfaces. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_CLANG_DIAGNOSTIC_H 15 #define LLVM_CLANG_DIAGNOSTIC_H 16 17 #include "clang/Basic/DiagnosticIDs.h" 18 #include "clang/Basic/SourceLocation.h" 19 #include "llvm/ADT/ArrayRef.h" 20 #include "llvm/ADT/DenseMap.h" 21 #include "llvm/ADT/IntrusiveRefCntPtr.h" 22 #include "llvm/ADT/OwningPtr.h" 23 #include "llvm/Support/type_traits.h" 24 25 #include <vector> 26 #include <list> 27 28 namespace clang { 29 class DiagnosticConsumer; 30 class DiagnosticBuilder; 31 class IdentifierInfo; 32 class DeclContext; 33 class LangOptions; 34 class Preprocessor; 35 class DiagnosticErrorTrap; 36 class StoredDiagnostic; 37 38 /// \brief Annotates a diagnostic with some code that should be 39 /// inserted, removed, or replaced to fix the problem. 40 /// 41 /// This kind of hint should be used when we are certain that the 42 /// introduction, removal, or modification of a particular (small!) 43 /// amount of code will correct a compilation error. The compiler 44 /// should also provide full recovery from such errors, such that 45 /// suppressing the diagnostic output can still result in successful 46 /// compilation. 47 class FixItHint { 48 public: 49 /// \brief Code that should be replaced to correct the error. Empty for an 50 /// insertion hint. 51 CharSourceRange RemoveRange; 52 53 /// \brief The actual code to insert at the insertion location, as a 54 /// string. 55 std::string CodeToInsert; 56 57 /// \brief Empty code modification hint, indicating that no code 58 /// modification is known. 59 FixItHint() : RemoveRange() { } 60 61 bool isNull() const { 62 return !RemoveRange.isValid(); 63 } 64 65 /// \brief Create a code modification hint that inserts the given 66 /// code string at a specific location. 67 static FixItHint CreateInsertion(SourceLocation InsertionLoc, 68 StringRef Code) { 69 FixItHint Hint; 70 Hint.RemoveRange = 71 CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 72 Hint.CodeToInsert = Code; 73 return Hint; 74 } 75 76 /// \brief Create a code modification hint that removes the given 77 /// source range. 78 static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 79 FixItHint Hint; 80 Hint.RemoveRange = RemoveRange; 81 return Hint; 82 } 83 static FixItHint CreateRemoval(SourceRange RemoveRange) { 84 return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 85 } 86 87 /// \brief Create a code modification hint that replaces the given 88 /// source range with the given code string. 89 static FixItHint CreateReplacement(CharSourceRange RemoveRange, 90 StringRef Code) { 91 FixItHint Hint; 92 Hint.RemoveRange = RemoveRange; 93 Hint.CodeToInsert = Code; 94 return Hint; 95 } 96 97 static FixItHint CreateReplacement(SourceRange RemoveRange, 98 StringRef Code) { 99 return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 100 } 101 }; 102 103 /// DiagnosticsEngine - This concrete class is used by the front-end to report 104 /// problems and issues. It massages the diagnostics (e.g. handling things like 105 /// "report warnings as errors" and passes them off to the DiagnosticConsumer 106 /// for reporting to the user. DiagnosticsEngine is tied to one translation unit 107 /// and one SourceManager. 108 class DiagnosticsEngine : public llvm::RefCountedBase<DiagnosticsEngine> { 109 public: 110 /// Level - The level of the diagnostic, after it has been through mapping. 111 enum Level { 112 Ignored = DiagnosticIDs::Ignored, 113 Note = DiagnosticIDs::Note, 114 Warning = DiagnosticIDs::Warning, 115 Error = DiagnosticIDs::Error, 116 Fatal = DiagnosticIDs::Fatal 117 }; 118 119 /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 120 /// is controlled by -pedantic and -pedantic-errors. 121 enum ExtensionHandling { 122 Ext_Ignore, Ext_Warn, Ext_Error 123 }; 124 125 enum ArgumentKind { 126 ak_std_string, // std::string 127 ak_c_string, // const char * 128 ak_sint, // int 129 ak_uint, // unsigned 130 ak_identifierinfo, // IdentifierInfo 131 ak_qualtype, // QualType 132 ak_declarationname, // DeclarationName 133 ak_nameddecl, // NamedDecl * 134 ak_nestednamespec, // NestedNameSpecifier * 135 ak_declcontext // DeclContext * 136 }; 137 138 /// Specifies which overload candidates to display when overload resolution 139 /// fails. 140 enum OverloadsShown { 141 Ovl_All, ///< Show all overloads. 142 Ovl_Best ///< Show just the "best" overload candidates. 143 }; 144 145 /// ArgumentValue - This typedef represents on argument value, which is a 146 /// union discriminated by ArgumentKind, with a value. 147 typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 148 149 private: 150 unsigned char AllExtensionsSilenced; // Used by __extension__ 151 bool IgnoreAllWarnings; // Ignore all warnings: -w 152 bool WarningsAsErrors; // Treat warnings like errors. 153 bool EnableAllWarnings; // Enable all warnings. 154 bool ErrorsAsFatal; // Treat errors like fatal errors. 155 bool SuppressSystemWarnings; // Suppress warnings in system headers. 156 bool SuppressAllDiagnostics; // Suppress all diagnostics. 157 OverloadsShown ShowOverloads; // Which overload candidates to show. 158 unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 159 unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 160 // 0 -> no limit. 161 ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 162 llvm::IntrusiveRefCntPtr<DiagnosticIDs> Diags; 163 DiagnosticConsumer *Client; 164 bool OwnsDiagClient; 165 SourceManager *SourceMgr; 166 167 /// \brief Mapping information for diagnostics. Mapping info is 168 /// packed into four bits per diagnostic. The low three bits are the mapping 169 /// (an instance of diag::Mapping), or zero if unset. The high bit is set 170 /// when the mapping was established as a user mapping. If the high bit is 171 /// clear, then the low bits are set to the default value, and should be 172 /// mapped with -pedantic, -Werror, etc. 173 /// 174 /// A new DiagState is created and kept around when diagnostic pragmas modify 175 /// the state so that we know what is the diagnostic state at any given 176 /// source location. 177 class DiagState { 178 llvm::DenseMap<unsigned, DiagnosticMappingInfo> DiagMap; 179 180 public: 181 typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::iterator 182 iterator; 183 typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::const_iterator 184 const_iterator; 185 186 void setMappingInfo(diag::kind Diag, DiagnosticMappingInfo Info) { 187 DiagMap[Diag] = Info; 188 } 189 190 DiagnosticMappingInfo &getOrAddMappingInfo(diag::kind Diag); 191 192 const_iterator begin() const { return DiagMap.begin(); } 193 const_iterator end() const { return DiagMap.end(); } 194 }; 195 196 /// \brief Keeps and automatically disposes all DiagStates that we create. 197 std::list<DiagState> DiagStates; 198 199 /// \brief Represents a point in source where the diagnostic state was 200 /// modified because of a pragma. 'Loc' can be null if the point represents 201 /// the diagnostic state modifications done through the command-line. 202 struct DiagStatePoint { 203 DiagState *State; 204 FullSourceLoc Loc; 205 DiagStatePoint(DiagState *State, FullSourceLoc Loc) 206 : State(State), Loc(Loc) { } 207 208 bool operator<(const DiagStatePoint &RHS) const { 209 // If Loc is invalid it means it came from <command-line>, in which case 210 // we regard it as coming before any valid source location. 211 if (RHS.Loc.isInvalid()) 212 return false; 213 if (Loc.isInvalid()) 214 return true; 215 return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 216 } 217 }; 218 219 /// \brief A vector of all DiagStatePoints representing changes in diagnostic 220 /// state due to diagnostic pragmas. The vector is always sorted according to 221 /// the SourceLocation of the DiagStatePoint. 222 typedef std::vector<DiagStatePoint> DiagStatePointsTy; 223 mutable DiagStatePointsTy DiagStatePoints; 224 225 /// \brief Keeps the DiagState that was active during each diagnostic 'push' 226 /// so we can get back at it when we 'pop'. 227 std::vector<DiagState *> DiagStateOnPushStack; 228 229 DiagState *GetCurDiagState() const { 230 assert(!DiagStatePoints.empty()); 231 return DiagStatePoints.back().State; 232 } 233 234 void PushDiagStatePoint(DiagState *State, SourceLocation L) { 235 FullSourceLoc Loc(L, *SourceMgr); 236 // Make sure that DiagStatePoints is always sorted according to Loc. 237 assert((Loc.isValid() || DiagStatePoints.empty()) && 238 "Adding invalid loc point after another point"); 239 assert((Loc.isInvalid() || DiagStatePoints.empty() || 240 DiagStatePoints.back().Loc.isInvalid() || 241 DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 242 "Previous point loc comes after or is the same as new one"); 243 DiagStatePoints.push_back(DiagStatePoint(State, 244 FullSourceLoc(Loc, *SourceMgr))); 245 } 246 247 /// \brief Finds the DiagStatePoint that contains the diagnostic state of 248 /// the given source location. 249 DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 250 251 /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 252 /// fatal error is emitted, and is sticky. 253 bool ErrorOccurred; 254 bool FatalErrorOccurred; 255 256 /// \brief Indicates that an unrecoverable error has occurred. 257 bool UnrecoverableErrorOccurred; 258 259 /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 260 /// during a parsing section, e.g. during parsing a function. 261 unsigned TrapNumErrorsOccurred; 262 unsigned TrapNumUnrecoverableErrorsOccurred; 263 264 /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 265 /// used to emit continuation diagnostics with the same level as the 266 /// diagnostic that they follow. 267 DiagnosticIDs::Level LastDiagLevel; 268 269 unsigned NumWarnings; // Number of warnings reported 270 unsigned NumErrors; // Number of errors reported 271 unsigned NumErrorsSuppressed; // Number of errors suppressed 272 273 /// ArgToStringFn - A function pointer that converts an opaque diagnostic 274 /// argument to a strings. This takes the modifiers and argument that was 275 /// present in the diagnostic. 276 /// 277 /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 278 /// arguments formatted for this diagnostic. Implementations of this function 279 /// can use this information to avoid redundancy across arguments. 280 /// 281 /// This is a hack to avoid a layering violation between libbasic and libsema. 282 typedef void (*ArgToStringFnTy)( 283 ArgumentKind Kind, intptr_t Val, 284 const char *Modifier, unsigned ModifierLen, 285 const char *Argument, unsigned ArgumentLen, 286 const ArgumentValue *PrevArgs, 287 unsigned NumPrevArgs, 288 SmallVectorImpl<char> &Output, 289 void *Cookie, 290 SmallVectorImpl<intptr_t> &QualTypeVals); 291 void *ArgToStringCookie; 292 ArgToStringFnTy ArgToStringFn; 293 294 /// \brief ID of the "delayed" diagnostic, which is a (typically 295 /// fatal) diagnostic that had to be delayed because it was found 296 /// while emitting another diagnostic. 297 unsigned DelayedDiagID; 298 299 /// \brief First string argument for the delayed diagnostic. 300 std::string DelayedDiagArg1; 301 302 /// \brief Second string argument for the delayed diagnostic. 303 std::string DelayedDiagArg2; 304 305 public: 306 explicit DiagnosticsEngine( 307 const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 308 DiagnosticConsumer *client = 0, 309 bool ShouldOwnClient = true); 310 ~DiagnosticsEngine(); 311 312 const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 313 return Diags; 314 } 315 316 DiagnosticConsumer *getClient() { return Client; } 317 const DiagnosticConsumer *getClient() const { return Client; } 318 319 /// \brief Determine whether this \c DiagnosticsEngine object own its client. 320 bool ownsClient() const { return OwnsDiagClient; } 321 322 /// \brief Return the current diagnostic client along with ownership of that 323 /// client. 324 DiagnosticConsumer *takeClient() { 325 OwnsDiagClient = false; 326 return Client; 327 } 328 329 bool hasSourceManager() const { return SourceMgr != 0; } 330 SourceManager &getSourceManager() const { 331 assert(SourceMgr && "SourceManager not set!"); 332 return *SourceMgr; 333 } 334 void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 335 336 //===--------------------------------------------------------------------===// 337 // DiagnosticsEngine characterization methods, used by a client to customize 338 // how diagnostics are emitted. 339 // 340 341 /// pushMappings - Copies the current DiagMappings and pushes the new copy 342 /// onto the top of the stack. 343 void pushMappings(SourceLocation Loc); 344 345 /// popMappings - Pops the current DiagMappings off the top of the stack 346 /// causing the new top of the stack to be the active mappings. Returns 347 /// true if the pop happens, false if there is only one DiagMapping on the 348 /// stack. 349 bool popMappings(SourceLocation Loc); 350 351 /// \brief Set the diagnostic client associated with this diagnostic object. 352 /// 353 /// \param ShouldOwnClient true if the diagnostic object should take 354 /// ownership of \c client. 355 void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 356 357 /// setErrorLimit - Specify a limit for the number of errors we should 358 /// emit before giving up. Zero disables the limit. 359 void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 360 361 /// \brief Specify the maximum number of template instantiation 362 /// notes to emit along with a given diagnostic. 363 void setTemplateBacktraceLimit(unsigned Limit) { 364 TemplateBacktraceLimit = Limit; 365 } 366 367 /// \brief Retrieve the maximum number of template instantiation 368 /// nodes to emit along with a given diagnostic. 369 unsigned getTemplateBacktraceLimit() const { 370 return TemplateBacktraceLimit; 371 } 372 373 /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 374 /// ignored. If this and WarningsAsErrors are both set, then this one wins. 375 void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 376 bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 377 378 /// setEnableAllWarnings - When set to true, any unmapped ignored warnings 379 /// are no longer ignored. If this and IgnoreAllWarnings are both set, 380 /// then that one wins. 381 void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 382 bool getEnableAllWarnngs() const { return EnableAllWarnings; } 383 384 /// setWarningsAsErrors - When set to true, any warnings reported are issued 385 /// as errors. 386 void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 387 bool getWarningsAsErrors() const { return WarningsAsErrors; } 388 389 /// setErrorsAsFatal - When set to true, any error reported is made a 390 /// fatal error. 391 void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 392 bool getErrorsAsFatal() const { return ErrorsAsFatal; } 393 394 /// setSuppressSystemWarnings - When set to true mask warnings that 395 /// come from system headers. 396 void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 397 bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 398 399 /// \brief Suppress all diagnostics, to silence the front end when we 400 /// know that we don't want any more diagnostics to be passed along to the 401 /// client 402 void setSuppressAllDiagnostics(bool Val = true) { 403 SuppressAllDiagnostics = Val; 404 } 405 bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 406 407 /// \brief Specify which overload candidates to show when overload resolution 408 /// fails. By default, we show all candidates. 409 void setShowOverloads(OverloadsShown Val) { 410 ShowOverloads = Val; 411 } 412 OverloadsShown getShowOverloads() const { return ShowOverloads; } 413 414 /// \brief Pretend that the last diagnostic issued was ignored. This can 415 /// be used by clients who suppress diagnostics themselves. 416 void setLastDiagnosticIgnored() { 417 LastDiagLevel = DiagnosticIDs::Ignored; 418 } 419 420 /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 421 /// extension diagnostics are mapped onto ignore/warning/error. This 422 /// corresponds to the GCC -pedantic and -pedantic-errors option. 423 void setExtensionHandlingBehavior(ExtensionHandling H) { 424 ExtBehavior = H; 425 } 426 ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; } 427 428 /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 429 /// block is encountered. When non-zero, all extension diagnostics are 430 /// entirely silenced, no matter how they are mapped. 431 void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 432 void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 433 bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 434 435 /// \brief This allows the client to specify that certain 436 /// warnings are ignored. Notes can never be mapped, errors can only be 437 /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 438 /// 439 /// \param Loc The source location that this change of diagnostic state should 440 /// take affect. It can be null if we are setting the latest state. 441 void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map, 442 SourceLocation Loc); 443 444 /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 445 /// "unknown-pragmas" to have the specified mapping. This returns true and 446 /// ignores the request if "Group" was unknown, false otherwise. 447 /// 448 /// 'Loc' is the source location that this change of diagnostic state should 449 /// take affect. It can be null if we are setting the state from command-line. 450 bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map, 451 SourceLocation Loc = SourceLocation()); 452 453 /// \brief Set the warning-as-error flag for the given diagnostic group. This 454 /// function always only operates on the current diagnostic state. 455 /// 456 /// \returns True if the given group is unknown, false otherwise. 457 bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 458 459 /// \brief Set the error-as-fatal flag for the given diagnostic group. This 460 /// function always only operates on the current diagnostic state. 461 /// 462 /// \returns True if the given group is unknown, false otherwise. 463 bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 464 465 bool hasErrorOccurred() const { return ErrorOccurred; } 466 bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 467 468 /// \brief Determine whether any kind of unrecoverable error has occurred. 469 bool hasUnrecoverableErrorOccurred() const { 470 return FatalErrorOccurred || UnrecoverableErrorOccurred; 471 } 472 473 unsigned getNumWarnings() const { return NumWarnings; } 474 475 void setNumWarnings(unsigned NumWarnings) { 476 this->NumWarnings = NumWarnings; 477 } 478 479 /// getCustomDiagID - Return an ID for a diagnostic with the specified message 480 /// and level. If this is the first request for this diagnosic, it is 481 /// registered and created, otherwise the existing ID is returned. 482 unsigned getCustomDiagID(Level L, StringRef Message) { 483 return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message); 484 } 485 486 /// ConvertArgToString - This method converts a diagnostic argument (as an 487 /// intptr_t) into the string that represents it. 488 void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 489 const char *Modifier, unsigned ModLen, 490 const char *Argument, unsigned ArgLen, 491 const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 492 SmallVectorImpl<char> &Output, 493 SmallVectorImpl<intptr_t> &QualTypeVals) const { 494 ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 495 PrevArgs, NumPrevArgs, Output, ArgToStringCookie, 496 QualTypeVals); 497 } 498 499 void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 500 ArgToStringFn = Fn; 501 ArgToStringCookie = Cookie; 502 } 503 504 /// \brief Reset the state of the diagnostic object to its initial 505 /// configuration. 506 void Reset(); 507 508 //===--------------------------------------------------------------------===// 509 // DiagnosticsEngine classification and reporting interfaces. 510 // 511 512 /// \brief Based on the way the client configured the DiagnosticsEngine 513 /// object, classify the specified diagnostic ID into a Level, consumable by 514 /// the DiagnosticConsumer. 515 /// 516 /// \param Loc The source location we are interested in finding out the 517 /// diagnostic state. Can be null in order to query the latest state. 518 Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 519 return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 520 } 521 522 /// Report - Issue the message to the client. @c DiagID is a member of the 523 /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 524 /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 525 /// @c Pos represents the source location associated with the diagnostic, 526 /// which can be an invalid location if no position information is available. 527 inline DiagnosticBuilder Report(SourceLocation Pos, unsigned DiagID); 528 inline DiagnosticBuilder Report(unsigned DiagID); 529 530 void Report(const StoredDiagnostic &storedDiag); 531 532 /// \brief Determine whethere there is already a diagnostic in flight. 533 bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 534 535 /// \brief Set the "delayed" diagnostic that will be emitted once 536 /// the current diagnostic completes. 537 /// 538 /// If a diagnostic is already in-flight but the front end must 539 /// report a problem (e.g., with an inconsistent file system 540 /// state), this routine sets a "delayed" diagnostic that will be 541 /// emitted after the current diagnostic completes. This should 542 /// only be used for fatal errors detected at inconvenient 543 /// times. If emitting a delayed diagnostic causes a second delayed 544 /// diagnostic to be introduced, that second delayed diagnostic 545 /// will be ignored. 546 /// 547 /// \param DiagID The ID of the diagnostic being delayed. 548 /// 549 /// \param Arg1 A string argument that will be provided to the 550 /// diagnostic. A copy of this string will be stored in the 551 /// DiagnosticsEngine object itself. 552 /// 553 /// \param Arg2 A string argument that will be provided to the 554 /// diagnostic. A copy of this string will be stored in the 555 /// DiagnosticsEngine object itself. 556 void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 557 StringRef Arg2 = ""); 558 559 /// \brief Clear out the current diagnostic. 560 void Clear() { CurDiagID = ~0U; } 561 562 private: 563 /// \brief Report the delayed diagnostic. 564 void ReportDelayed(); 565 566 // This is private state used by DiagnosticBuilder. We put it here instead of 567 // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 568 // object. This implementation choice means that we can only have one 569 // diagnostic "in flight" at a time, but this seems to be a reasonable 570 // tradeoff to keep these objects small. Assertions verify that only one 571 // diagnostic is in flight at a time. 572 friend class DiagnosticIDs; 573 friend class DiagnosticBuilder; 574 friend class Diagnostic; 575 friend class PartialDiagnostic; 576 friend class DiagnosticErrorTrap; 577 578 /// CurDiagLoc - This is the location of the current diagnostic that is in 579 /// flight. 580 SourceLocation CurDiagLoc; 581 582 /// CurDiagID - This is the ID of the current diagnostic that is in flight. 583 /// This is set to ~0U when there is no diagnostic in flight. 584 unsigned CurDiagID; 585 586 enum { 587 /// MaxArguments - The maximum number of arguments we can hold. We currently 588 /// only support up to 10 arguments (%0-%9). A single diagnostic with more 589 /// than that almost certainly has to be simplified anyway. 590 MaxArguments = 10 591 }; 592 593 /// NumDiagArgs - This contains the number of entries in Arguments. 594 signed char NumDiagArgs; 595 /// NumRanges - This is the number of ranges in the DiagRanges array. 596 unsigned char NumDiagRanges; 597 /// \brief The number of code modifications hints in the 598 /// FixItHints array. 599 unsigned char NumFixItHints; 600 601 /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 602 /// values, with one for each argument. This specifies whether the argument 603 /// is in DiagArgumentsStr or in DiagArguments. 604 unsigned char DiagArgumentsKind[MaxArguments]; 605 606 /// DiagArgumentsStr - This holds the values of each string argument for the 607 /// current diagnostic. This value is only used when the corresponding 608 /// ArgumentKind is ak_std_string. 609 std::string DiagArgumentsStr[MaxArguments]; 610 611 /// DiagArgumentsVal - The values for the various substitution positions. This 612 /// is used when the argument is not an std::string. The specific value is 613 /// mangled into an intptr_t and the interpretation depends on exactly what 614 /// sort of argument kind it is. 615 intptr_t DiagArgumentsVal[MaxArguments]; 616 617 /// DiagRanges - The list of ranges added to this diagnostic. It currently 618 /// only support 10 ranges, could easily be extended if needed. 619 CharSourceRange DiagRanges[10]; 620 621 enum { MaxFixItHints = 6 }; 622 623 /// FixItHints - If valid, provides a hint with some code 624 /// to insert, remove, or modify at a particular position. 625 FixItHint FixItHints[MaxFixItHints]; 626 627 /// ProcessDiag - This is the method used to report a diagnostic that is 628 /// finally fully formed. 629 /// 630 /// \returns true if the diagnostic was emitted, false if it was 631 /// suppressed. 632 bool ProcessDiag() { 633 return Diags->ProcessDiag(*this); 634 } 635 636 friend class ASTReader; 637 friend class ASTWriter; 638 }; 639 640 /// \brief RAII class that determines when any errors have occurred 641 /// between the time the instance was created and the time it was 642 /// queried. 643 class DiagnosticErrorTrap { 644 DiagnosticsEngine &Diag; 645 unsigned NumErrors; 646 unsigned NumUnrecoverableErrors; 647 648 public: 649 explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 650 : Diag(Diag) { reset(); } 651 652 /// \brief Determine whether any errors have occurred since this 653 /// object instance was created. 654 bool hasErrorOccurred() const { 655 return Diag.TrapNumErrorsOccurred > NumErrors; 656 } 657 658 /// \brief Determine whether any unrecoverable errors have occurred since this 659 /// object instance was created. 660 bool hasUnrecoverableErrorOccurred() const { 661 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 662 } 663 664 // Set to initial state of "no errors occurred". 665 void reset() { 666 NumErrors = Diag.TrapNumErrorsOccurred; 667 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 668 } 669 }; 670 671 //===----------------------------------------------------------------------===// 672 // DiagnosticBuilder 673 //===----------------------------------------------------------------------===// 674 675 /// DiagnosticBuilder - This is a little helper class used to produce 676 /// diagnostics. This is constructed by the DiagnosticsEngine::Report method, 677 /// and allows insertion of extra information (arguments and source ranges) into 678 /// the currently "in flight" diagnostic. When the temporary for the builder is 679 /// destroyed, the diagnostic is issued. 680 /// 681 /// Note that many of these will be created as temporary objects (many call 682 /// sites), so we want them to be small and we never want their address taken. 683 /// This ensures that compilers with somewhat reasonable optimizers will promote 684 /// the common fields to registers, eliminating increments of the NumArgs field, 685 /// for example. 686 class DiagnosticBuilder { 687 mutable DiagnosticsEngine *DiagObj; 688 mutable unsigned NumArgs, NumRanges, NumFixItHints; 689 690 void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 691 friend class DiagnosticsEngine; 692 explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 693 : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 694 695 friend class PartialDiagnostic; 696 697 protected: 698 void FlushCounts(); 699 700 public: 701 /// Copy constructor. When copied, this "takes" the diagnostic info from the 702 /// input and neuters it. 703 DiagnosticBuilder(const DiagnosticBuilder &D) { 704 DiagObj = D.DiagObj; 705 D.DiagObj = 0; 706 NumArgs = D.NumArgs; 707 NumRanges = D.NumRanges; 708 NumFixItHints = D.NumFixItHints; 709 } 710 711 /// \brief Simple enumeration value used to give a name to the 712 /// suppress-diagnostic constructor. 713 enum SuppressKind { Suppress }; 714 715 /// \brief Create an empty DiagnosticBuilder object that represents 716 /// no actual diagnostic. 717 explicit DiagnosticBuilder(SuppressKind) 718 : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 719 720 /// \brief Force the diagnostic builder to emit the diagnostic now. 721 /// 722 /// Once this function has been called, the DiagnosticBuilder object 723 /// should not be used again before it is destroyed. 724 /// 725 /// \returns true if a diagnostic was emitted, false if the 726 /// diagnostic was suppressed. 727 bool Emit(); 728 729 /// Destructor - The dtor emits the diagnostic if it hasn't already 730 /// been emitted. 731 ~DiagnosticBuilder() { Emit(); } 732 733 /// isActive - Determine whether this diagnostic is still active. 734 bool isActive() const { return DiagObj != 0; } 735 736 /// \brief Retrieve the active diagnostic ID. 737 /// 738 /// \pre \c isActive() 739 unsigned getDiagID() const { 740 assert(isActive() && "DiagnosticsEngine is inactive"); 741 return DiagObj->CurDiagID; 742 } 743 744 /// \brief Retrieve the active diagnostic's location. 745 /// 746 /// \pre \c isActive() 747 SourceLocation getLocation() const { return DiagObj->CurDiagLoc; } 748 749 /// \brief Clear out the current diagnostic. 750 void Clear() { DiagObj = 0; } 751 752 /// Operator bool: conversion of DiagnosticBuilder to bool always returns 753 /// true. This allows is to be used in boolean error contexts like: 754 /// return Diag(...); 755 operator bool() const { return true; } 756 757 void AddString(StringRef S) const { 758 assert(NumArgs < DiagnosticsEngine::MaxArguments && 759 "Too many arguments to diagnostic!"); 760 if (DiagObj) { 761 DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string; 762 DiagObj->DiagArgumentsStr[NumArgs++] = S; 763 } 764 } 765 766 void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 767 assert(NumArgs < DiagnosticsEngine::MaxArguments && 768 "Too many arguments to diagnostic!"); 769 if (DiagObj) { 770 DiagObj->DiagArgumentsKind[NumArgs] = Kind; 771 DiagObj->DiagArgumentsVal[NumArgs++] = V; 772 } 773 } 774 775 void AddSourceRange(const CharSourceRange &R) const { 776 assert(NumRanges < 777 sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 778 "Too many arguments to diagnostic!"); 779 if (DiagObj) 780 DiagObj->DiagRanges[NumRanges++] = R; 781 } 782 783 void AddFixItHint(const FixItHint &Hint) const { 784 assert(NumFixItHints < DiagnosticsEngine::MaxFixItHints && 785 "Too many fix-it hints!"); 786 if (NumFixItHints >= DiagnosticsEngine::MaxFixItHints) 787 return; // Don't crash in release builds 788 if (DiagObj) 789 DiagObj->FixItHints[NumFixItHints++] = Hint; 790 } 791 }; 792 793 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 794 StringRef S) { 795 DB.AddString(S); 796 return DB; 797 } 798 799 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 800 const char *Str) { 801 DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 802 DiagnosticsEngine::ak_c_string); 803 return DB; 804 } 805 806 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 807 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 808 return DB; 809 } 810 811 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 812 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 813 return DB; 814 } 815 816 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 817 unsigned I) { 818 DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 819 return DB; 820 } 821 822 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 823 const IdentifierInfo *II) { 824 DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 825 DiagnosticsEngine::ak_identifierinfo); 826 return DB; 827 } 828 829 // Adds a DeclContext to the diagnostic. The enable_if template magic is here 830 // so that we only match those arguments that are (statically) DeclContexts; 831 // other arguments that derive from DeclContext (e.g., RecordDecls) will not 832 // match. 833 template<typename T> 834 inline 835 typename llvm::enable_if<llvm::is_same<T, DeclContext>, 836 const DiagnosticBuilder &>::type 837 operator<<(const DiagnosticBuilder &DB, T *DC) { 838 DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 839 DiagnosticsEngine::ak_declcontext); 840 return DB; 841 } 842 843 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 844 const SourceRange &R) { 845 DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 846 return DB; 847 } 848 849 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 850 const CharSourceRange &R) { 851 DB.AddSourceRange(R); 852 return DB; 853 } 854 855 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 856 const FixItHint &Hint) { 857 DB.AddFixItHint(Hint); 858 return DB; 859 } 860 861 /// Report - Issue the message to the client. DiagID is a member of the 862 /// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 863 /// which emits the diagnostics (through ProcessDiag) when it is destroyed. 864 inline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 865 unsigned DiagID){ 866 assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 867 CurDiagLoc = Loc; 868 CurDiagID = DiagID; 869 return DiagnosticBuilder(this); 870 } 871 inline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 872 return Report(SourceLocation(), DiagID); 873 } 874 875 //===----------------------------------------------------------------------===// 876 // Diagnostic 877 //===----------------------------------------------------------------------===// 878 879 /// Diagnostic - This is a little helper class (which is basically a smart 880 /// pointer that forward info from DiagnosticsEngine) that allows clients to 881 /// enquire about the currently in-flight diagnostic. 882 class Diagnostic { 883 const DiagnosticsEngine *DiagObj; 884 StringRef StoredDiagMessage; 885 public: 886 explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 887 Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 888 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 889 890 const DiagnosticsEngine *getDiags() const { return DiagObj; } 891 unsigned getID() const { return DiagObj->CurDiagID; } 892 const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 893 bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 894 SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 895 896 unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 897 898 /// getArgKind - Return the kind of the specified index. Based on the kind 899 /// of argument, the accessors below can be used to get the value. 900 DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 901 assert(Idx < getNumArgs() && "Argument index out of range!"); 902 return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 903 } 904 905 /// getArgStdStr - Return the provided argument string specified by Idx. 906 const std::string &getArgStdStr(unsigned Idx) const { 907 assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 908 "invalid argument accessor!"); 909 return DiagObj->DiagArgumentsStr[Idx]; 910 } 911 912 /// getArgCStr - Return the specified C string argument. 913 const char *getArgCStr(unsigned Idx) const { 914 assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 915 "invalid argument accessor!"); 916 return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 917 } 918 919 /// getArgSInt - Return the specified signed integer argument. 920 int getArgSInt(unsigned Idx) const { 921 assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 922 "invalid argument accessor!"); 923 return (int)DiagObj->DiagArgumentsVal[Idx]; 924 } 925 926 /// getArgUInt - Return the specified unsigned integer argument. 927 unsigned getArgUInt(unsigned Idx) const { 928 assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 929 "invalid argument accessor!"); 930 return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 931 } 932 933 /// getArgIdentifier - Return the specified IdentifierInfo argument. 934 const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 935 assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 936 "invalid argument accessor!"); 937 return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 938 } 939 940 /// getRawArg - Return the specified non-string argument in an opaque form. 941 intptr_t getRawArg(unsigned Idx) const { 942 assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 943 "invalid argument accessor!"); 944 return DiagObj->DiagArgumentsVal[Idx]; 945 } 946 947 948 /// getNumRanges - Return the number of source ranges associated with this 949 /// diagnostic. 950 unsigned getNumRanges() const { 951 return DiagObj->NumDiagRanges; 952 } 953 954 const CharSourceRange &getRange(unsigned Idx) const { 955 assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 956 return DiagObj->DiagRanges[Idx]; 957 } 958 959 /// \brief Return an array reference for this diagnostic's ranges. 960 ArrayRef<CharSourceRange> getRanges() const { 961 return llvm::makeArrayRef(DiagObj->DiagRanges, DiagObj->NumDiagRanges); 962 } 963 964 unsigned getNumFixItHints() const { 965 return DiagObj->NumFixItHints; 966 } 967 968 const FixItHint &getFixItHint(unsigned Idx) const { 969 return DiagObj->FixItHints[Idx]; 970 } 971 972 const FixItHint *getFixItHints() const { 973 return DiagObj->NumFixItHints? 974 &DiagObj->FixItHints[0] : 0; 975 } 976 977 /// FormatDiagnostic - Format this diagnostic into a string, substituting the 978 /// formal arguments into the %0 slots. The result is appended onto the Str 979 /// array. 980 void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 981 982 /// FormatDiagnostic - Format the given format-string into the 983 /// output buffer using the arguments stored in this diagnostic. 984 void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 985 SmallVectorImpl<char> &OutStr) const; 986 }; 987 988 /** 989 * \brief Represents a diagnostic in a form that can be retained until its 990 * corresponding source manager is destroyed. 991 */ 992 class StoredDiagnostic { 993 unsigned ID; 994 DiagnosticsEngine::Level Level; 995 FullSourceLoc Loc; 996 std::string Message; 997 std::vector<CharSourceRange> Ranges; 998 std::vector<FixItHint> FixIts; 999 1000 public: 1001 StoredDiagnostic(); 1002 StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1003 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1004 StringRef Message); 1005 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1006 StringRef Message, FullSourceLoc Loc, 1007 ArrayRef<CharSourceRange> Ranges, 1008 ArrayRef<FixItHint> Fixits); 1009 ~StoredDiagnostic(); 1010 1011 /// \brief Evaluates true when this object stores a diagnostic. 1012 operator bool() const { return Message.size() > 0; } 1013 1014 unsigned getID() const { return ID; } 1015 DiagnosticsEngine::Level getLevel() const { return Level; } 1016 const FullSourceLoc &getLocation() const { return Loc; } 1017 StringRef getMessage() const { return Message; } 1018 1019 void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1020 1021 typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1022 range_iterator range_begin() const { return Ranges.begin(); } 1023 range_iterator range_end() const { return Ranges.end(); } 1024 unsigned range_size() const { return Ranges.size(); } 1025 1026 typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1027 fixit_iterator fixit_begin() const { return FixIts.begin(); } 1028 fixit_iterator fixit_end() const { return FixIts.end(); } 1029 unsigned fixit_size() const { return FixIts.size(); } 1030 }; 1031 1032 /// DiagnosticConsumer - This is an abstract interface implemented by clients of 1033 /// the front-end, which formats and prints fully processed diagnostics. 1034 class DiagnosticConsumer { 1035 protected: 1036 unsigned NumWarnings; // Number of warnings reported 1037 unsigned NumErrors; // Number of errors reported 1038 1039 public: 1040 DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1041 1042 unsigned getNumErrors() const { return NumErrors; } 1043 unsigned getNumWarnings() const { return NumWarnings; } 1044 1045 virtual ~DiagnosticConsumer(); 1046 1047 /// BeginSourceFile - Callback to inform the diagnostic client that processing 1048 /// of a source file is beginning. 1049 /// 1050 /// Note that diagnostics may be emitted outside the processing of a source 1051 /// file, for example during the parsing of command line options. However, 1052 /// diagnostics with source range information are required to only be emitted 1053 /// in between BeginSourceFile() and EndSourceFile(). 1054 /// 1055 /// \arg LO - The language options for the source file being processed. 1056 /// \arg PP - The preprocessor object being used for the source; this optional 1057 /// and may not be present, for example when processing AST source files. 1058 virtual void BeginSourceFile(const LangOptions &LangOpts, 1059 const Preprocessor *PP = 0) {} 1060 1061 /// EndSourceFile - Callback to inform the diagnostic client that processing 1062 /// of a source file has ended. The diagnostic client should assume that any 1063 /// objects made available via \see BeginSourceFile() are inaccessible. 1064 virtual void EndSourceFile() {} 1065 1066 /// IncludeInDiagnosticCounts - This method (whose default implementation 1067 /// returns true) indicates whether the diagnostics handled by this 1068 /// DiagnosticConsumer should be included in the number of diagnostics 1069 /// reported by DiagnosticsEngine. 1070 virtual bool IncludeInDiagnosticCounts() const; 1071 1072 /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 1073 /// capturing it to a log as needed. 1074 /// 1075 /// Default implementation just keeps track of the total number of warnings 1076 /// and errors. 1077 virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1078 const Diagnostic &Info); 1079 1080 /// \brief Clone the diagnostic consumer, producing an equivalent consumer 1081 /// that can be used in a different context. 1082 virtual DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const = 0; 1083 }; 1084 1085 /// IgnoringDiagConsumer - This is a diagnostic client that just ignores all 1086 /// diags. 1087 class IgnoringDiagConsumer : public DiagnosticConsumer { 1088 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1089 const Diagnostic &Info) { 1090 // Just ignore it. 1091 } 1092 DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const { 1093 return new IgnoringDiagConsumer(); 1094 } 1095 }; 1096 1097 } // end namespace clang 1098 1099 #endif 1100