Diagnostic.h revision 78243658c533168d51fd076fba328437932ba6f1
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 28namespace clang { 29 class DiagnosticClient; 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. 47class FixItHint { 48public: 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/// Diagnostic - 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 DiagnosticClient for 106/// reporting to the user. Diagnostic is tied to one translation unit and 107/// one SourceManager. 108class Diagnostic : public llvm::RefCountedBase<Diagnostic> { 109public: 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 149private: 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 DiagnosticClient *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, unsigned> DiagMap; 179 180 public: 181 typedef llvm::DenseMap<unsigned, unsigned>::const_iterator iterator; 182 183 void setMapping(diag::kind Diag, unsigned Map) { DiagMap[Diag] = Map; } 184 185 diag::Mapping getMapping(diag::kind Diag) const { 186 iterator I = DiagMap.find(Diag); 187 if (I != DiagMap.end()) 188 return (diag::Mapping)I->second; 189 return diag::Mapping(); 190 } 191 192 iterator begin() const { return DiagMap.begin(); } 193 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 305public: 306 explicit Diagnostic(const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 307 DiagnosticClient *client = 0, 308 bool ShouldOwnClient = true); 309 ~Diagnostic(); 310 311 const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 312 return Diags; 313 } 314 315 DiagnosticClient *getClient() { return Client; } 316 const DiagnosticClient *getClient() const { return Client; } 317 318 /// \brief Determine whether this \c Diagnostic object own its client. 319 bool ownsClient() const { return OwnsDiagClient; } 320 321 /// \brief Return the current diagnostic client along with ownership of that 322 /// client. 323 DiagnosticClient *takeClient() { 324 OwnsDiagClient = false; 325 return Client; 326 } 327 328 bool hasSourceManager() const { return SourceMgr != 0; } 329 SourceManager &getSourceManager() const { 330 assert(SourceMgr && "SourceManager not set!"); 331 return *SourceMgr; 332 } 333 void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 334 335 //===--------------------------------------------------------------------===// 336 // Diagnostic characterization methods, used by a client to customize how 337 // diagnostics are emitted. 338 // 339 340 /// pushMappings - Copies the current DiagMappings and pushes the new copy 341 /// onto the top of the stack. 342 void pushMappings(SourceLocation Loc); 343 344 /// popMappings - Pops the current DiagMappings off the top of the stack 345 /// causing the new top of the stack to be the active mappings. Returns 346 /// true if the pop happens, false if there is only one DiagMapping on the 347 /// stack. 348 bool popMappings(SourceLocation Loc); 349 350 /// \brief Set the diagnostic client associated with this diagnostic object. 351 /// 352 /// \param ShouldOwnClient true if the diagnostic object should take 353 /// ownership of \c client. 354 void setClient(DiagnosticClient *client, bool ShouldOwnClient = true); 355 356 /// setErrorLimit - Specify a limit for the number of errors we should 357 /// emit before giving up. Zero disables the limit. 358 void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 359 360 /// \brief Specify the maximum number of template instantiation 361 /// notes to emit along with a given diagnostic. 362 void setTemplateBacktraceLimit(unsigned Limit) { 363 TemplateBacktraceLimit = Limit; 364 } 365 366 /// \brief Retrieve the maximum number of template instantiation 367 /// nodes to emit along with a given diagnostic. 368 unsigned getTemplateBacktraceLimit() const { 369 return TemplateBacktraceLimit; 370 } 371 372 /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 373 /// ignored. If this and WarningsAsErrors are both set, then this one wins. 374 void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 375 bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 376 377 /// setEnableAllWarnings - When set to true, any unmapped ignored warnings 378 /// are no longer ignored. If this and IgnoreAllWarnings are both set, 379 /// then that one wins. 380 void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 381 bool getEnableAllWarnngs() const { return EnableAllWarnings; } 382 383 /// setWarningsAsErrors - When set to true, any warnings reported are issued 384 /// as errors. 385 void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 386 bool getWarningsAsErrors() const { return WarningsAsErrors; } 387 388 /// setErrorsAsFatal - When set to true, any error reported is made a 389 /// fatal error. 390 void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 391 bool getErrorsAsFatal() const { return ErrorsAsFatal; } 392 393 /// setSuppressSystemWarnings - When set to true mask warnings that 394 /// come from system headers. 395 void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 396 bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 397 398 /// \brief Suppress all diagnostics, to silence the front end when we 399 /// know that we don't want any more diagnostics to be passed along to the 400 /// client 401 void setSuppressAllDiagnostics(bool Val = true) { 402 SuppressAllDiagnostics = Val; 403 } 404 bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 405 406 /// \brief Specify which overload candidates to show when overload resolution 407 /// fails. By default, we show all candidates. 408 void setShowOverloads(OverloadsShown Val) { 409 ShowOverloads = Val; 410 } 411 OverloadsShown getShowOverloads() const { return ShowOverloads; } 412 413 /// \brief Pretend that the last diagnostic issued was ignored. This can 414 /// be used by clients who suppress diagnostics themselves. 415 void setLastDiagnosticIgnored() { 416 LastDiagLevel = DiagnosticIDs::Ignored; 417 } 418 419 /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 420 /// extension diagnostics are mapped onto ignore/warning/error. This 421 /// corresponds to the GCC -pedantic and -pedantic-errors option. 422 void setExtensionHandlingBehavior(ExtensionHandling H) { 423 ExtBehavior = H; 424 } 425 ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; } 426 427 /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 428 /// block is encountered. When non-zero, all extension diagnostics are 429 /// entirely silenced, no matter how they are mapped. 430 void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 431 void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 432 bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 433 434 /// \brief This allows the client to specify that certain 435 /// warnings are ignored. Notes can never be mapped, errors can only be 436 /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 437 /// 438 /// \param Loc The source location that this change of diagnostic state should 439 /// take affect. It can be null if we are setting the latest state. 440 void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map, 441 SourceLocation Loc); 442 443 /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 444 /// "unknown-pragmas" to have the specified mapping. This returns true and 445 /// ignores the request if "Group" was unknown, false otherwise. 446 /// 447 /// 'Loc' is the source location that this change of diagnostic state should 448 /// take affect. It can be null if we are setting the state from command-line. 449 bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map, 450 SourceLocation Loc = SourceLocation()) { 451 return Diags->setDiagnosticGroupMapping(Group, Map, Loc, *this); 452 } 453 454 bool hasErrorOccurred() const { return ErrorOccurred; } 455 bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 456 457 /// \brief Determine whether any kind of unrecoverable error has occurred. 458 bool hasUnrecoverableErrorOccurred() const { 459 return FatalErrorOccurred || UnrecoverableErrorOccurred; 460 } 461 462 unsigned getNumWarnings() const { return NumWarnings; } 463 464 void setNumWarnings(unsigned NumWarnings) { 465 this->NumWarnings = NumWarnings; 466 } 467 468 /// getCustomDiagID - Return an ID for a diagnostic with the specified message 469 /// and level. If this is the first request for this diagnosic, it is 470 /// registered and created, otherwise the existing ID is returned. 471 unsigned getCustomDiagID(Level L, StringRef Message) { 472 return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message); 473 } 474 475 /// ConvertArgToString - This method converts a diagnostic argument (as an 476 /// intptr_t) into the string that represents it. 477 void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 478 const char *Modifier, unsigned ModLen, 479 const char *Argument, unsigned ArgLen, 480 const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 481 SmallVectorImpl<char> &Output, 482 SmallVectorImpl<intptr_t> &QualTypeVals) const { 483 ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 484 PrevArgs, NumPrevArgs, Output, ArgToStringCookie, 485 QualTypeVals); 486 } 487 488 void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 489 ArgToStringFn = Fn; 490 ArgToStringCookie = Cookie; 491 } 492 493 /// \brief Reset the state of the diagnostic object to its initial 494 /// configuration. 495 void Reset(); 496 497 //===--------------------------------------------------------------------===// 498 // Diagnostic classification and reporting interfaces. 499 // 500 501 /// \brief Based on the way the client configured the Diagnostic 502 /// object, classify the specified diagnostic ID into a Level, consumable by 503 /// the DiagnosticClient. 504 /// 505 /// \param Loc The source location we are interested in finding out the 506 /// diagnostic state. Can be null in order to query the latest state. 507 Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc, 508 diag::Mapping *mapping = 0) const { 509 return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this, mapping); 510 } 511 512 /// Report - Issue the message to the client. @c DiagID is a member of the 513 /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 514 /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 515 /// @c Pos represents the source location associated with the diagnostic, 516 /// which can be an invalid location if no position information is available. 517 inline DiagnosticBuilder Report(SourceLocation Pos, unsigned DiagID); 518 inline DiagnosticBuilder Report(unsigned DiagID); 519 520 void Report(const StoredDiagnostic &storedDiag); 521 522 /// \brief Determine whethere there is already a diagnostic in flight. 523 bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 524 525 /// \brief Set the "delayed" diagnostic that will be emitted once 526 /// the current diagnostic completes. 527 /// 528 /// If a diagnostic is already in-flight but the front end must 529 /// report a problem (e.g., with an inconsistent file system 530 /// state), this routine sets a "delayed" diagnostic that will be 531 /// emitted after the current diagnostic completes. This should 532 /// only be used for fatal errors detected at inconvenient 533 /// times. If emitting a delayed diagnostic causes a second delayed 534 /// diagnostic to be introduced, that second delayed diagnostic 535 /// will be ignored. 536 /// 537 /// \param DiagID The ID of the diagnostic being delayed. 538 /// 539 /// \param Arg1 A string argument that will be provided to the 540 /// diagnostic. A copy of this string will be stored in the 541 /// Diagnostic object itself. 542 /// 543 /// \param Arg2 A string argument that will be provided to the 544 /// diagnostic. A copy of this string will be stored in the 545 /// Diagnostic object itself. 546 void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 547 StringRef Arg2 = ""); 548 549 /// \brief Clear out the current diagnostic. 550 void Clear() { CurDiagID = ~0U; } 551 552private: 553 /// \brief Report the delayed diagnostic. 554 void ReportDelayed(); 555 556 557 /// getDiagnosticMappingInfo - Return the mapping info currently set for the 558 /// specified builtin diagnostic. This returns the high bit encoding, or zero 559 /// if the field is completely uninitialized. 560 diag::Mapping getDiagnosticMappingInfo(diag::kind Diag, 561 DiagState *State) const { 562 return State->getMapping(Diag); 563 } 564 565 void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 566 DiagState *State, 567 bool isUser, bool isPragma) const { 568 if (isUser) Map |= 8; // Set the high bit for user mappings. 569 if (isPragma) Map |= 0x10; // Set the bit for diagnostic pragma mappings. 570 State->setMapping((diag::kind)DiagId, Map); 571 } 572 573 // This is private state used by DiagnosticBuilder. We put it here instead of 574 // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 575 // object. This implementation choice means that we can only have one 576 // diagnostic "in flight" at a time, but this seems to be a reasonable 577 // tradeoff to keep these objects small. Assertions verify that only one 578 // diagnostic is in flight at a time. 579 friend class DiagnosticIDs; 580 friend class DiagnosticBuilder; 581 friend class DiagnosticInfo; 582 friend class PartialDiagnostic; 583 friend class DiagnosticErrorTrap; 584 585 /// CurDiagLoc - This is the location of the current diagnostic that is in 586 /// flight. 587 SourceLocation CurDiagLoc; 588 589 /// CurDiagID - This is the ID of the current diagnostic that is in flight. 590 /// This is set to ~0U when there is no diagnostic in flight. 591 unsigned CurDiagID; 592 593 enum { 594 /// MaxArguments - The maximum number of arguments we can hold. We currently 595 /// only support up to 10 arguments (%0-%9). A single diagnostic with more 596 /// than that almost certainly has to be simplified anyway. 597 MaxArguments = 10 598 }; 599 600 /// NumDiagArgs - This contains the number of entries in Arguments. 601 signed char NumDiagArgs; 602 /// NumRanges - This is the number of ranges in the DiagRanges array. 603 unsigned char NumDiagRanges; 604 /// \brief The number of code modifications hints in the 605 /// FixItHints array. 606 unsigned char NumFixItHints; 607 608 /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 609 /// values, with one for each argument. This specifies whether the argument 610 /// is in DiagArgumentsStr or in DiagArguments. 611 unsigned char DiagArgumentsKind[MaxArguments]; 612 613 /// DiagArgumentsStr - This holds the values of each string argument for the 614 /// current diagnostic. This value is only used when the corresponding 615 /// ArgumentKind is ak_std_string. 616 std::string DiagArgumentsStr[MaxArguments]; 617 618 /// DiagArgumentsVal - The values for the various substitution positions. This 619 /// is used when the argument is not an std::string. The specific value is 620 /// mangled into an intptr_t and the interpretation depends on exactly what 621 /// sort of argument kind it is. 622 intptr_t DiagArgumentsVal[MaxArguments]; 623 624 /// DiagRanges - The list of ranges added to this diagnostic. It currently 625 /// only support 10 ranges, could easily be extended if needed. 626 CharSourceRange DiagRanges[10]; 627 628 enum { MaxFixItHints = 6 }; 629 630 /// FixItHints - If valid, provides a hint with some code 631 /// to insert, remove, or modify at a particular position. 632 FixItHint FixItHints[MaxFixItHints]; 633 634 /// ProcessDiag - This is the method used to report a diagnostic that is 635 /// finally fully formed. 636 /// 637 /// \returns true if the diagnostic was emitted, false if it was 638 /// suppressed. 639 bool ProcessDiag() { 640 return Diags->ProcessDiag(*this); 641 } 642 643 friend class ASTReader; 644 friend class ASTWriter; 645}; 646 647/// \brief RAII class that determines when any errors have occurred 648/// between the time the instance was created and the time it was 649/// queried. 650class DiagnosticErrorTrap { 651 Diagnostic &Diag; 652 unsigned NumErrors; 653 unsigned NumUnrecoverableErrors; 654 655public: 656 explicit DiagnosticErrorTrap(Diagnostic &Diag) 657 : Diag(Diag) { reset(); } 658 659 /// \brief Determine whether any errors have occurred since this 660 /// object instance was created. 661 bool hasErrorOccurred() const { 662 return Diag.TrapNumErrorsOccurred > NumErrors; 663 } 664 665 /// \brief Determine whether any unrecoverable errors have occurred since this 666 /// object instance was created. 667 bool hasUnrecoverableErrorOccurred() const { 668 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 669 } 670 671 // Set to initial state of "no errors occurred". 672 void reset() { 673 NumErrors = Diag.TrapNumErrorsOccurred; 674 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 675 } 676}; 677 678//===----------------------------------------------------------------------===// 679// DiagnosticBuilder 680//===----------------------------------------------------------------------===// 681 682/// DiagnosticBuilder - This is a little helper class used to produce 683/// diagnostics. This is constructed by the Diagnostic::Report method, and 684/// allows insertion of extra information (arguments and source ranges) into the 685/// currently "in flight" diagnostic. When the temporary for the builder is 686/// destroyed, the diagnostic is issued. 687/// 688/// Note that many of these will be created as temporary objects (many call 689/// sites), so we want them to be small and we never want their address taken. 690/// This ensures that compilers with somewhat reasonable optimizers will promote 691/// the common fields to registers, eliminating increments of the NumArgs field, 692/// for example. 693class DiagnosticBuilder { 694 mutable Diagnostic *DiagObj; 695 mutable unsigned NumArgs, NumRanges, NumFixItHints; 696 697 void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 698 friend class Diagnostic; 699 explicit DiagnosticBuilder(Diagnostic *diagObj) 700 : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 701 702 friend class PartialDiagnostic; 703 704protected: 705 void FlushCounts(); 706 707public: 708 /// Copy constructor. When copied, this "takes" the diagnostic info from the 709 /// input and neuters it. 710 DiagnosticBuilder(const DiagnosticBuilder &D) { 711 DiagObj = D.DiagObj; 712 D.DiagObj = 0; 713 NumArgs = D.NumArgs; 714 NumRanges = D.NumRanges; 715 NumFixItHints = D.NumFixItHints; 716 } 717 718 /// \brief Simple enumeration value used to give a name to the 719 /// suppress-diagnostic constructor. 720 enum SuppressKind { Suppress }; 721 722 /// \brief Create an empty DiagnosticBuilder object that represents 723 /// no actual diagnostic. 724 explicit DiagnosticBuilder(SuppressKind) 725 : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 726 727 /// \brief Force the diagnostic builder to emit the diagnostic now. 728 /// 729 /// Once this function has been called, the DiagnosticBuilder object 730 /// should not be used again before it is destroyed. 731 /// 732 /// \returns true if a diagnostic was emitted, false if the 733 /// diagnostic was suppressed. 734 bool Emit(); 735 736 /// Destructor - The dtor emits the diagnostic if it hasn't already 737 /// been emitted. 738 ~DiagnosticBuilder() { Emit(); } 739 740 /// isActive - Determine whether this diagnostic is still active. 741 bool isActive() const { return DiagObj != 0; } 742 743 /// \brief Retrieve the active diagnostic ID. 744 /// 745 /// \pre \c isActive() 746 unsigned getDiagID() const { 747 assert(isActive() && "Diagnostic is inactive"); 748 return DiagObj->CurDiagID; 749 } 750 751 /// \brief Clear out the current diagnostic. 752 void Clear() { DiagObj = 0; } 753 754 /// Operator bool: conversion of DiagnosticBuilder to bool always returns 755 /// true. This allows is to be used in boolean error contexts like: 756 /// return Diag(...); 757 operator bool() const { return true; } 758 759 void AddString(StringRef S) const { 760 assert(NumArgs < Diagnostic::MaxArguments && 761 "Too many arguments to diagnostic!"); 762 if (DiagObj) { 763 DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 764 DiagObj->DiagArgumentsStr[NumArgs++] = S; 765 } 766 } 767 768 void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 769 assert(NumArgs < Diagnostic::MaxArguments && 770 "Too many arguments to diagnostic!"); 771 if (DiagObj) { 772 DiagObj->DiagArgumentsKind[NumArgs] = Kind; 773 DiagObj->DiagArgumentsVal[NumArgs++] = V; 774 } 775 } 776 777 void AddSourceRange(const CharSourceRange &R) const { 778 assert(NumRanges < 779 sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 780 "Too many arguments to diagnostic!"); 781 if (DiagObj) 782 DiagObj->DiagRanges[NumRanges++] = R; 783 } 784 785 void AddFixItHint(const FixItHint &Hint) const { 786 assert(NumFixItHints < Diagnostic::MaxFixItHints && 787 "Too many fix-it hints!"); 788 if (DiagObj) 789 DiagObj->FixItHints[NumFixItHints++] = Hint; 790 } 791}; 792 793inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 794 StringRef S) { 795 DB.AddString(S); 796 return DB; 797} 798 799inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 800 const char *Str) { 801 DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 802 Diagnostic::ak_c_string); 803 return DB; 804} 805 806inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 807 DB.AddTaggedVal(I, Diagnostic::ak_sint); 808 return DB; 809} 810 811inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 812 DB.AddTaggedVal(I, Diagnostic::ak_sint); 813 return DB; 814} 815 816inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 817 unsigned I) { 818 DB.AddTaggedVal(I, Diagnostic::ak_uint); 819 return DB; 820} 821 822inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 823 const IdentifierInfo *II) { 824 DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 825 Diagnostic::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. 833template<typename T> 834inline 835typename llvm::enable_if<llvm::is_same<T, DeclContext>, 836 const DiagnosticBuilder &>::type 837operator<<(const DiagnosticBuilder &DB, T *DC) { 838 DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 839 Diagnostic::ak_declcontext); 840 return DB; 841} 842 843inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 844 const SourceRange &R) { 845 DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 846 return DB; 847} 848 849inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 850 const CharSourceRange &R) { 851 DB.AddSourceRange(R); 852 return DB; 853} 854 855inline 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. 864inline DiagnosticBuilder Diagnostic::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} 871inline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 872 return Report(SourceLocation(), DiagID); 873} 874 875//===----------------------------------------------------------------------===// 876// DiagnosticInfo 877//===----------------------------------------------------------------------===// 878 879/// DiagnosticInfo - This is a little helper class (which is basically a smart 880/// pointer that forward info from Diagnostic) that allows clients to enquire 881/// about the currently in-flight diagnostic. 882class DiagnosticInfo { 883 const Diagnostic *DiagObj; 884 StringRef StoredDiagMessage; 885public: 886 explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 887 DiagnosticInfo(const Diagnostic *DO, StringRef storedDiagMessage) 888 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 889 890 const Diagnostic *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 Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 901 assert(Idx < getNumArgs() && "Argument index out of range!"); 902 return (Diagnostic::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) == Diagnostic::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) == Diagnostic::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) == Diagnostic::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) == Diagnostic::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) == Diagnostic::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) != Diagnostic::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 unsigned getNumFixItHints() const { 960 return DiagObj->NumFixItHints; 961 } 962 963 const FixItHint &getFixItHint(unsigned Idx) const { 964 return DiagObj->FixItHints[Idx]; 965 } 966 967 const FixItHint *getFixItHints() const { 968 return DiagObj->NumFixItHints? 969 &DiagObj->FixItHints[0] : 0; 970 } 971 972 /// FormatDiagnostic - Format this diagnostic into a string, substituting the 973 /// formal arguments into the %0 slots. The result is appended onto the Str 974 /// array. 975 void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 976 977 /// FormatDiagnostic - Format the given format-string into the 978 /// output buffer using the arguments stored in this diagnostic. 979 void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 980 SmallVectorImpl<char> &OutStr) const; 981}; 982 983/** 984 * \brief Represents a diagnostic in a form that can be retained until its 985 * corresponding source manager is destroyed. 986 */ 987class StoredDiagnostic { 988 unsigned ID; 989 Diagnostic::Level Level; 990 FullSourceLoc Loc; 991 std::string Message; 992 std::vector<CharSourceRange> Ranges; 993 std::vector<FixItHint> FixIts; 994 995public: 996 StoredDiagnostic(); 997 StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 998 StoredDiagnostic(Diagnostic::Level Level, unsigned ID, 999 StringRef Message); 1000 StoredDiagnostic(Diagnostic::Level Level, unsigned ID, 1001 StringRef Message, FullSourceLoc Loc, 1002 ArrayRef<CharSourceRange> Ranges, 1003 ArrayRef<FixItHint> Fixits); 1004 ~StoredDiagnostic(); 1005 1006 /// \brief Evaluates true when this object stores a diagnostic. 1007 operator bool() const { return Message.size() > 0; } 1008 1009 unsigned getID() const { return ID; } 1010 Diagnostic::Level getLevel() const { return Level; } 1011 const FullSourceLoc &getLocation() const { return Loc; } 1012 StringRef getMessage() const { return Message; } 1013 1014 void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1015 1016 typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1017 range_iterator range_begin() const { return Ranges.begin(); } 1018 range_iterator range_end() const { return Ranges.end(); } 1019 unsigned range_size() const { return Ranges.size(); } 1020 1021 typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1022 fixit_iterator fixit_begin() const { return FixIts.begin(); } 1023 fixit_iterator fixit_end() const { return FixIts.end(); } 1024 unsigned fixit_size() const { return FixIts.size(); } 1025}; 1026 1027/// DiagnosticClient - This is an abstract interface implemented by clients of 1028/// the front-end, which formats and prints fully processed diagnostics. 1029class DiagnosticClient { 1030protected: 1031 unsigned NumWarnings; // Number of warnings reported 1032 unsigned NumErrors; // Number of errors reported 1033 1034public: 1035 DiagnosticClient() : NumWarnings(0), NumErrors(0) { } 1036 1037 unsigned getNumErrors() const { return NumErrors; } 1038 unsigned getNumWarnings() const { return NumWarnings; } 1039 1040 virtual ~DiagnosticClient(); 1041 1042 /// BeginSourceFile - Callback to inform the diagnostic client that processing 1043 /// of a source file is beginning. 1044 /// 1045 /// Note that diagnostics may be emitted outside the processing of a source 1046 /// file, for example during the parsing of command line options. However, 1047 /// diagnostics with source range information are required to only be emitted 1048 /// in between BeginSourceFile() and EndSourceFile(). 1049 /// 1050 /// \arg LO - The language options for the source file being processed. 1051 /// \arg PP - The preprocessor object being used for the source; this optional 1052 /// and may not be present, for example when processing AST source files. 1053 virtual void BeginSourceFile(const LangOptions &LangOpts, 1054 const Preprocessor *PP = 0) {} 1055 1056 /// EndSourceFile - Callback to inform the diagnostic client that processing 1057 /// of a source file has ended. The diagnostic client should assume that any 1058 /// objects made available via \see BeginSourceFile() are inaccessible. 1059 virtual void EndSourceFile() {} 1060 1061 /// IncludeInDiagnosticCounts - This method (whose default implementation 1062 /// returns true) indicates whether the diagnostics handled by this 1063 /// DiagnosticClient should be included in the number of diagnostics reported 1064 /// by Diagnostic. 1065 virtual bool IncludeInDiagnosticCounts() const; 1066 1067 /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 1068 /// capturing it to a log as needed. 1069 /// 1070 /// Default implementation just keeps track of the total number of warnings 1071 /// and errors. 1072 virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 1073 const DiagnosticInfo &Info); 1074}; 1075 1076} // end namespace clang 1077 1078#endif 1079