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