Diagnostic.h revision 6c1cb9916e9988dcdd65b9266dbe24afd173427a
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/SourceLocation.h" 18#include "llvm/ADT/IntrusiveRefCntPtr.h" 19#include "llvm/ADT/StringRef.h" 20#include "llvm/Support/type_traits.h" 21#include <string> 22#include <vector> 23#include <cassert> 24 25namespace llvm { 26 template <typename T> class SmallVectorImpl; 27 class raw_ostream; 28} 29 30namespace clang { 31 class DeclContext; 32 class DiagnosticBuilder; 33 class DiagnosticClient; 34 class FileManager; 35 class IdentifierInfo; 36 class LangOptions; 37 class PartialDiagnostic; 38 class Preprocessor; 39 class SourceManager; 40 class SourceRange; 41 42 // Import the diagnostic enums themselves. 43 namespace diag { 44 // Start position for diagnostics. 45 enum { 46 DIAG_START_DRIVER = 300, 47 DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 48 DIAG_START_LEX = DIAG_START_FRONTEND + 100, 49 DIAG_START_PARSE = DIAG_START_LEX + 300, 50 DIAG_START_AST = DIAG_START_PARSE + 300, 51 DIAG_START_SEMA = DIAG_START_AST + 100, 52 DIAG_START_ANALYSIS = DIAG_START_SEMA + 1500, 53 DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 54 }; 55 56 class CustomDiagInfo; 57 58 /// diag::kind - All of the diagnostics that can be emitted by the frontend. 59 typedef unsigned kind; 60 61 // Get typedefs for common diagnostics. 62 enum { 63#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 64#include "clang/Basic/DiagnosticCommonKinds.inc" 65 NUM_BUILTIN_COMMON_DIAGNOSTICS 66#undef DIAG 67 }; 68 69 /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 70 /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 71 /// (emit as an error). It allows clients to map errors to 72 /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 73 /// one). 74 enum Mapping { 75 // NOTE: 0 means "uncomputed". 76 MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 77 MAP_WARNING = 2, //< Map this diagnostic to a warning. 78 MAP_ERROR = 3, //< Map this diagnostic to an error. 79 MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 80 81 /// Map this diagnostic to "warning", but make it immune to -Werror. This 82 /// happens when you specify -Wno-error=foo. 83 MAP_WARNING_NO_WERROR = 5, 84 /// Map this diagnostic to "error", but make it immune to -Wfatal-errors. 85 /// This happens for -Wno-fatal-errors=foo. 86 MAP_ERROR_NO_WFATAL = 6 87 }; 88 } 89 90/// \brief Annotates a diagnostic with some code that should be 91/// inserted, removed, or replaced to fix the problem. 92/// 93/// This kind of hint should be used when we are certain that the 94/// introduction, removal, or modification of a particular (small!) 95/// amount of code will correct a compilation error. The compiler 96/// should also provide full recovery from such errors, such that 97/// suppressing the diagnostic output can still result in successful 98/// compilation. 99class FixItHint { 100public: 101 /// \brief Tokens that should be removed to correct the error. 102 SourceRange RemoveRange; 103 104 /// \brief The location at which we should insert code to correct 105 /// the error. 106 SourceLocation InsertionLoc; 107 108 /// \brief The actual code to insert at the insertion location, as a 109 /// string. 110 std::string CodeToInsert; 111 112 /// \brief Empty code modification hint, indicating that no code 113 /// modification is known. 114 FixItHint() : RemoveRange(), InsertionLoc() { } 115 116 bool isNull() const { 117 return !RemoveRange.isValid() && !InsertionLoc.isValid(); 118 } 119 120 /// \brief Create a code modification hint that inserts the given 121 /// code string at a specific location. 122 static FixItHint CreateInsertion(SourceLocation InsertionLoc, 123 llvm::StringRef Code) { 124 FixItHint Hint; 125 Hint.InsertionLoc = InsertionLoc; 126 Hint.CodeToInsert = Code; 127 return Hint; 128 } 129 130 /// \brief Create a code modification hint that removes the given 131 /// source range. 132 static FixItHint CreateRemoval(SourceRange RemoveRange) { 133 FixItHint Hint; 134 Hint.RemoveRange = RemoveRange; 135 return Hint; 136 } 137 138 /// \brief Create a code modification hint that replaces the given 139 /// source range with the given code string. 140 static FixItHint CreateReplacement(SourceRange RemoveRange, 141 llvm::StringRef Code) { 142 FixItHint Hint; 143 Hint.RemoveRange = RemoveRange; 144 Hint.InsertionLoc = RemoveRange.getBegin(); 145 Hint.CodeToInsert = Code; 146 return Hint; 147 } 148}; 149 150/// Diagnostic - This concrete class is used by the front-end to report 151/// problems and issues. It massages the diagnostics (e.g. handling things like 152/// "report warnings as errors" and passes them off to the DiagnosticClient for 153/// reporting to the user. 154class Diagnostic : public llvm::RefCountedBase<Diagnostic> { 155public: 156 /// Level - The level of the diagnostic, after it has been through mapping. 157 enum Level { 158 Ignored, Note, Warning, Error, Fatal 159 }; 160 161 /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 162 /// is controlled by -pedantic and -pedantic-errors. 163 enum ExtensionHandling { 164 Ext_Ignore, Ext_Warn, Ext_Error 165 }; 166 167 enum ArgumentKind { 168 ak_std_string, // std::string 169 ak_c_string, // const char * 170 ak_sint, // int 171 ak_uint, // unsigned 172 ak_identifierinfo, // IdentifierInfo 173 ak_qualtype, // QualType 174 ak_declarationname, // DeclarationName 175 ak_nameddecl, // NamedDecl * 176 ak_nestednamespec, // NestedNameSpecifier * 177 ak_declcontext // DeclContext * 178 }; 179 180 /// ArgumentValue - This typedef represents on argument value, which is a 181 /// union discriminated by ArgumentKind, with a value. 182 typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 183 184private: 185 unsigned char AllExtensionsSilenced; // Used by __extension__ 186 bool IgnoreAllWarnings; // Ignore all warnings: -w 187 bool WarningsAsErrors; // Treat warnings like errors: 188 bool ErrorsAsFatal; // Treat errors like fatal errors. 189 bool SuppressSystemWarnings; // Suppress warnings in system headers. 190 bool SuppressAllDiagnostics; // Suppress all diagnostics. 191 unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 192 unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 193 // 0 -> no limit. 194 ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 195 DiagnosticClient *Client; 196 197 /// DiagMappings - Mapping information for diagnostics. Mapping info is 198 /// packed into four bits per diagnostic. The low three bits are the mapping 199 /// (an instance of diag::Mapping), or zero if unset. The high bit is set 200 /// when the mapping was established as a user mapping. If the high bit is 201 /// clear, then the low bits are set to the default value, and should be 202 /// mapped with -pedantic, -Werror, etc. 203 204 typedef std::vector<unsigned char> DiagMappings; 205 mutable std::vector<DiagMappings> DiagMappingsStack; 206 207 /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 208 /// fatal error is emitted, and is sticky. 209 bool ErrorOccurred; 210 bool FatalErrorOccurred; 211 212 /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 213 /// used to emit continuation diagnostics with the same level as the 214 /// diagnostic that they follow. 215 Diagnostic::Level LastDiagLevel; 216 217 unsigned NumWarnings; // Number of warnings reported 218 unsigned NumErrors; // Number of errors reported 219 unsigned NumErrorsSuppressed; // Number of errors suppressed 220 221 /// CustomDiagInfo - Information for uniquing and looking up custom diags. 222 diag::CustomDiagInfo *CustomDiagInfo; 223 224 /// ArgToStringFn - A function pointer that converts an opaque diagnostic 225 /// argument to a strings. This takes the modifiers and argument that was 226 /// present in the diagnostic. 227 /// 228 /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 229 /// arguments formatted for this diagnostic. Implementations of this function 230 /// can use this information to avoid redundancy across arguments. 231 /// 232 /// This is a hack to avoid a layering violation between libbasic and libsema. 233 typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 234 const char *Modifier, unsigned ModifierLen, 235 const char *Argument, unsigned ArgumentLen, 236 const ArgumentValue *PrevArgs, 237 unsigned NumPrevArgs, 238 llvm::SmallVectorImpl<char> &Output, 239 void *Cookie); 240 void *ArgToStringCookie; 241 ArgToStringFnTy ArgToStringFn; 242 243 /// \brief ID of the "delayed" diagnostic, which is a (typically 244 /// fatal) diagnostic that had to be delayed because it was found 245 /// while emitting another diagnostic. 246 unsigned DelayedDiagID; 247 248 /// \brief First string argument for the delayed diagnostic. 249 std::string DelayedDiagArg1; 250 251 /// \brief Second string argument for the delayed diagnostic. 252 std::string DelayedDiagArg2; 253 254public: 255 explicit Diagnostic(DiagnosticClient *client = 0); 256 ~Diagnostic(); 257 258 //===--------------------------------------------------------------------===// 259 // Diagnostic characterization methods, used by a client to customize how 260 // 261 262 DiagnosticClient *getClient() { return Client; } 263 const DiagnosticClient *getClient() const { return Client; } 264 265 /// pushMappings - Copies the current DiagMappings and pushes the new copy 266 /// onto the top of the stack. 267 void pushMappings(); 268 269 /// popMappings - Pops the current DiagMappings off the top of the stack 270 /// causing the new top of the stack to be the active mappings. Returns 271 /// true if the pop happens, false if there is only one DiagMapping on the 272 /// stack. 273 bool popMappings(); 274 275 void setClient(DiagnosticClient* client) { Client = client; } 276 277 /// setErrorLimit - Specify a limit for the number of errors we should 278 /// emit before giving up. Zero disables the limit. 279 void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 280 281 /// \brief Specify the maximum number of template instantiation 282 /// notes to emit along with a given diagnostic. 283 void setTemplateBacktraceLimit(unsigned Limit) { 284 TemplateBacktraceLimit = Limit; 285 } 286 287 /// \brief Retrieve the maximum number of template instantiation 288 /// nodes to emit along with a given diagnostic. 289 unsigned getTemplateBacktraceLimit() const { 290 return TemplateBacktraceLimit; 291 } 292 293 /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 294 /// ignored. If this and WarningsAsErrors are both set, then this one wins. 295 void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 296 bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 297 298 /// setWarningsAsErrors - When set to true, any warnings reported are issued 299 /// as errors. 300 void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 301 bool getWarningsAsErrors() const { return WarningsAsErrors; } 302 303 /// setErrorsAsFatal - When set to true, any error reported is made a 304 /// fatal error. 305 void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 306 bool getErrorsAsFatal() const { return ErrorsAsFatal; } 307 308 /// setSuppressSystemWarnings - When set to true mask warnings that 309 /// come from system headers. 310 void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 311 bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 312 313 /// \brief Suppress all diagnostics, to silence the front end when we 314 /// know that we don't want any more diagnostics to be passed along to the 315 /// client 316 void setSuppressAllDiagnostics(bool Val = true) { 317 SuppressAllDiagnostics = Val; 318 } 319 bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 320 321 /// \brief Pretend that the last diagnostic issued was ignored. This can 322 /// be used by clients who suppress diagnostics themselves. 323 void setLastDiagnosticIgnored() { 324 LastDiagLevel = Ignored; 325 } 326 327 /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 328 /// extension diagnostics are mapped onto ignore/warning/error. This 329 /// corresponds to the GCC -pedantic and -pedantic-errors option. 330 void setExtensionHandlingBehavior(ExtensionHandling H) { 331 ExtBehavior = H; 332 } 333 334 /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 335 /// block is encountered. When non-zero, all extension diagnostics are 336 /// entirely silenced, no matter how they are mapped. 337 void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 338 void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 339 bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 340 341 /// setDiagnosticMapping - This allows the client to specify that certain 342 /// warnings are ignored. Notes can never be mapped, errors can only be 343 /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 344 void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 345 assert(Diag < diag::DIAG_UPPER_LIMIT && 346 "Can only map builtin diagnostics"); 347 assert((isBuiltinWarningOrExtension(Diag) || 348 (Map == diag::MAP_FATAL || Map == diag::MAP_ERROR)) && 349 "Cannot map errors into warnings!"); 350 setDiagnosticMappingInternal(Diag, Map, true); 351 } 352 353 /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 354 /// "unknown-pragmas" to have the specified mapping. This returns true and 355 /// ignores the request if "Group" was unknown, false otherwise. 356 bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 357 358 bool hasErrorOccurred() const { return ErrorOccurred; } 359 bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 360 361 unsigned getNumErrors() const { return NumErrors; } 362 unsigned getNumErrorsSuppressed() const { return NumErrorsSuppressed; } 363 unsigned getNumWarnings() const { return NumWarnings; } 364 365 /// getCustomDiagID - Return an ID for a diagnostic with the specified message 366 /// and level. If this is the first request for this diagnosic, it is 367 /// registered and created, otherwise the existing ID is returned. 368 unsigned getCustomDiagID(Level L, llvm::StringRef Message); 369 370 371 /// ConvertArgToString - This method converts a diagnostic argument (as an 372 /// intptr_t) into the string that represents it. 373 void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 374 const char *Modifier, unsigned ModLen, 375 const char *Argument, unsigned ArgLen, 376 const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 377 llvm::SmallVectorImpl<char> &Output) const { 378 ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 379 PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 380 } 381 382 void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 383 ArgToStringFn = Fn; 384 ArgToStringCookie = Cookie; 385 } 386 387 //===--------------------------------------------------------------------===// 388 // Diagnostic classification and reporting interfaces. 389 // 390 391 /// getDescription - Given a diagnostic ID, return a description of the 392 /// issue. 393 const char *getDescription(unsigned DiagID) const; 394 395 /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 396 /// level of the specified diagnostic ID is a Warning or Extension. 397 /// This only works on builtin diagnostics, not custom ones, and is not legal to 398 /// call on NOTEs. 399 static bool isBuiltinWarningOrExtension(unsigned DiagID); 400 401 /// \brief Determine whether the given built-in diagnostic ID is a 402 /// Note. 403 static bool isBuiltinNote(unsigned DiagID); 404 405 /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 406 /// ID is for an extension of some sort. 407 /// 408 static bool isBuiltinExtensionDiag(unsigned DiagID) { 409 bool ignored; 410 return isBuiltinExtensionDiag(DiagID, ignored); 411 } 412 413 /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 414 /// ID is for an extension of some sort. This also returns EnabledByDefault, 415 /// which is set to indicate whether the diagnostic is ignored by default (in 416 /// which case -pedantic enables it) or treated as a warning/error by default. 417 /// 418 static bool isBuiltinExtensionDiag(unsigned DiagID, bool &EnabledByDefault); 419 420 421 /// getWarningOptionForDiag - Return the lowest-level warning option that 422 /// enables the specified diagnostic. If there is no -Wfoo flag that controls 423 /// the diagnostic, this returns null. 424 static const char *getWarningOptionForDiag(unsigned DiagID); 425 426 /// \brief Enumeration describing how the the emission of a diagnostic should 427 /// be treated when it occurs during C++ template argument deduction. 428 enum SFINAEResponse { 429 /// \brief The diagnostic should not be reported, but it should cause 430 /// template argument deduction to fail. 431 /// 432 /// The vast majority of errors that occur during template argument 433 /// deduction fall into this category. 434 SFINAE_SubstitutionFailure, 435 436 /// \brief The diagnostic should be suppressed entirely. 437 /// 438 /// Warnings generally fall into this category. 439 SFINAE_Suppress, 440 441 /// \brief The diagnostic should be reported. 442 /// 443 /// The diagnostic should be reported. Various fatal errors (e.g., 444 /// template instantiation depth exceeded) fall into this category. 445 SFINAE_Report 446 }; 447 448 /// \brief Determines whether the given built-in diagnostic ID is 449 /// for an error that is suppressed if it occurs during C++ template 450 /// argument deduction. 451 /// 452 /// When an error is suppressed due to SFINAE, the template argument 453 /// deduction fails but no diagnostic is emitted. Certain classes of 454 /// errors, such as those errors that involve C++ access control, 455 /// are not SFINAE errors. 456 static SFINAEResponse getDiagnosticSFINAEResponse(unsigned DiagID); 457 458 /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 459 /// object, classify the specified diagnostic ID into a Level, consumable by 460 /// the DiagnosticClient. 461 Level getDiagnosticLevel(unsigned DiagID) const; 462 463 /// Report - Issue the message to the client. @c DiagID is a member of the 464 /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 465 /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 466 /// @c Pos represents the source location associated with the diagnostic, 467 /// which can be an invalid location if no position information is available. 468 inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 469 inline DiagnosticBuilder Report(unsigned DiagID); 470 471 /// \brief Determine whethere there is already a diagnostic in flight. 472 bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 473 474 /// \brief Set the "delayed" diagnostic that will be emitted once 475 /// the current diagnostic completes. 476 /// 477 /// If a diagnostic is already in-flight but the front end must 478 /// report a problem (e.g., with an inconsistent file system 479 /// state), this routine sets a "delayed" diagnostic that will be 480 /// emitted after the current diagnostic completes. This should 481 /// only be used for fatal errors detected at inconvenient 482 /// times. If emitting a delayed diagnostic causes a second delayed 483 /// diagnostic to be introduced, that second delayed diagnostic 484 /// will be ignored. 485 /// 486 /// \param DiagID The ID of the diagnostic being delayed. 487 /// 488 /// \param Arg1 A string argument that will be provided to the 489 /// diagnostic. A copy of this string will be stored in the 490 /// Diagnostic object itself. 491 /// 492 /// \param Arg2 A string argument that will be provided to the 493 /// diagnostic. A copy of this string will be stored in the 494 /// Diagnostic object itself. 495 void SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1 = "", 496 llvm::StringRef Arg2 = ""); 497 498 /// \brief Clear out the current diagnostic. 499 void Clear() { CurDiagID = ~0U; } 500 501private: 502 /// \brief Report the delayed diagnostic. 503 void ReportDelayed(); 504 505 506 /// getDiagnosticMappingInfo - Return the mapping info currently set for the 507 /// specified builtin diagnostic. This returns the high bit encoding, or zero 508 /// if the field is completely uninitialized. 509 diag::Mapping getDiagnosticMappingInfo(diag::kind Diag) const { 510 const DiagMappings ¤tMappings = DiagMappingsStack.back(); 511 return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 512 } 513 514 void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 515 bool isUser) const { 516 if (isUser) Map |= 8; // Set the high bit for user mappings. 517 unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 518 unsigned Shift = (DiagId & 1)*4; 519 Slot &= ~(15 << Shift); 520 Slot |= Map << Shift; 521 } 522 523 /// getDiagnosticLevel - This is an internal implementation helper used when 524 /// DiagClass is already known. 525 Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 526 527 // This is private state used by DiagnosticBuilder. We put it here instead of 528 // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 529 // object. This implementation choice means that we can only have one 530 // diagnostic "in flight" at a time, but this seems to be a reasonable 531 // tradeoff to keep these objects small. Assertions verify that only one 532 // diagnostic is in flight at a time. 533 friend class DiagnosticBuilder; 534 friend class DiagnosticInfo; 535 536 /// CurDiagLoc - This is the location of the current diagnostic that is in 537 /// flight. 538 FullSourceLoc CurDiagLoc; 539 540 /// CurDiagID - This is the ID of the current diagnostic that is in flight. 541 /// This is set to ~0U when there is no diagnostic in flight. 542 unsigned CurDiagID; 543 544 enum { 545 /// MaxArguments - The maximum number of arguments we can hold. We currently 546 /// only support up to 10 arguments (%0-%9). A single diagnostic with more 547 /// than that almost certainly has to be simplified anyway. 548 MaxArguments = 10 549 }; 550 551 /// NumDiagArgs - This contains the number of entries in Arguments. 552 signed char NumDiagArgs; 553 /// NumRanges - This is the number of ranges in the DiagRanges array. 554 unsigned char NumDiagRanges; 555 /// \brief The number of code modifications hints in the 556 /// FixItHints array. 557 unsigned char NumFixItHints; 558 559 /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 560 /// values, with one for each argument. This specifies whether the argument 561 /// is in DiagArgumentsStr or in DiagArguments. 562 unsigned char DiagArgumentsKind[MaxArguments]; 563 564 /// DiagArgumentsStr - This holds the values of each string argument for the 565 /// current diagnostic. This value is only used when the corresponding 566 /// ArgumentKind is ak_std_string. 567 std::string DiagArgumentsStr[MaxArguments]; 568 569 /// DiagArgumentsVal - The values for the various substitution positions. This 570 /// is used when the argument is not an std::string. The specific value is 571 /// mangled into an intptr_t and the intepretation depends on exactly what 572 /// sort of argument kind it is. 573 intptr_t DiagArgumentsVal[MaxArguments]; 574 575 /// DiagRanges - The list of ranges added to this diagnostic. It currently 576 /// only support 10 ranges, could easily be extended if needed. 577 SourceRange DiagRanges[10]; 578 579 enum { MaxFixItHints = 3 }; 580 581 /// FixItHints - If valid, provides a hint with some code 582 /// to insert, remove, or modify at a particular position. 583 FixItHint FixItHints[MaxFixItHints]; 584 585 /// ProcessDiag - This is the method used to report a diagnostic that is 586 /// finally fully formed. 587 /// 588 /// \returns true if the diagnostic was emitted, false if it was 589 /// suppressed. 590 bool ProcessDiag(); 591}; 592 593//===----------------------------------------------------------------------===// 594// DiagnosticBuilder 595//===----------------------------------------------------------------------===// 596 597/// DiagnosticBuilder - This is a little helper class used to produce 598/// diagnostics. This is constructed by the Diagnostic::Report method, and 599/// allows insertion of extra information (arguments and source ranges) into the 600/// currently "in flight" diagnostic. When the temporary for the builder is 601/// destroyed, the diagnostic is issued. 602/// 603/// Note that many of these will be created as temporary objects (many call 604/// sites), so we want them to be small and we never want their address taken. 605/// This ensures that compilers with somewhat reasonable optimizers will promote 606/// the common fields to registers, eliminating increments of the NumArgs field, 607/// for example. 608class DiagnosticBuilder { 609 mutable Diagnostic *DiagObj; 610 mutable unsigned NumArgs, NumRanges, NumFixItHints; 611 612 void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 613 friend class Diagnostic; 614 explicit DiagnosticBuilder(Diagnostic *diagObj) 615 : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 616 617public: 618 /// Copy constructor. When copied, this "takes" the diagnostic info from the 619 /// input and neuters it. 620 DiagnosticBuilder(const DiagnosticBuilder &D) { 621 DiagObj = D.DiagObj; 622 D.DiagObj = 0; 623 NumArgs = D.NumArgs; 624 NumRanges = D.NumRanges; 625 NumFixItHints = D.NumFixItHints; 626 } 627 628 /// \brief Simple enumeration value used to give a name to the 629 /// suppress-diagnostic constructor. 630 enum SuppressKind { Suppress }; 631 632 /// \brief Create an empty DiagnosticBuilder object that represents 633 /// no actual diagnostic. 634 explicit DiagnosticBuilder(SuppressKind) 635 : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 636 637 /// \brief Force the diagnostic builder to emit the diagnostic now. 638 /// 639 /// Once this function has been called, the DiagnosticBuilder object 640 /// should not be used again before it is destroyed. 641 /// 642 /// \returns true if a diagnostic was emitted, false if the 643 /// diagnostic was suppressed. 644 bool Emit(); 645 646 /// Destructor - The dtor emits the diagnostic if it hasn't already 647 /// been emitted. 648 ~DiagnosticBuilder() { Emit(); } 649 650 /// isActive - Determine whether this diagnostic is still active. 651 bool isActive() const { return DiagObj != 0; } 652 653 /// Operator bool: conversion of DiagnosticBuilder to bool always returns 654 /// true. This allows is to be used in boolean error contexts like: 655 /// return Diag(...); 656 operator bool() const { return true; } 657 658 void AddString(llvm::StringRef S) const { 659 assert(NumArgs < Diagnostic::MaxArguments && 660 "Too many arguments to diagnostic!"); 661 if (DiagObj) { 662 DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 663 DiagObj->DiagArgumentsStr[NumArgs++] = S; 664 } 665 } 666 667 void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 668 assert(NumArgs < Diagnostic::MaxArguments && 669 "Too many arguments to diagnostic!"); 670 if (DiagObj) { 671 DiagObj->DiagArgumentsKind[NumArgs] = Kind; 672 DiagObj->DiagArgumentsVal[NumArgs++] = V; 673 } 674 } 675 676 void AddSourceRange(const SourceRange &R) const { 677 assert(NumRanges < 678 sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 679 "Too many arguments to diagnostic!"); 680 if (DiagObj) 681 DiagObj->DiagRanges[NumRanges++] = R; 682 } 683 684 void AddFixItHint(const FixItHint &Hint) const { 685 if (Hint.isNull()) 686 return; 687 688 assert(NumFixItHints < Diagnostic::MaxFixItHints && 689 "Too many fix-it hints!"); 690 if (DiagObj) 691 DiagObj->FixItHints[NumFixItHints++] = Hint; 692 } 693}; 694 695inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 696 llvm::StringRef S) { 697 DB.AddString(S); 698 return DB; 699} 700 701inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 702 const char *Str) { 703 DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 704 Diagnostic::ak_c_string); 705 return DB; 706} 707 708inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 709 DB.AddTaggedVal(I, Diagnostic::ak_sint); 710 return DB; 711} 712 713inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 714 DB.AddTaggedVal(I, Diagnostic::ak_sint); 715 return DB; 716} 717 718inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 719 unsigned I) { 720 DB.AddTaggedVal(I, Diagnostic::ak_uint); 721 return DB; 722} 723 724inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 725 const IdentifierInfo *II) { 726 DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 727 Diagnostic::ak_identifierinfo); 728 return DB; 729} 730 731// Adds a DeclContext to the diagnostic. The enable_if template magic is here 732// so that we only match those arguments that are (statically) DeclContexts; 733// other arguments that derive from DeclContext (e.g., RecordDecls) will not 734// match. 735template<typename T> 736inline 737typename llvm::enable_if<llvm::is_same<T, DeclContext>, 738 const DiagnosticBuilder &>::type 739operator<<(const DiagnosticBuilder &DB, T *DC) { 740 DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 741 Diagnostic::ak_declcontext); 742 return DB; 743} 744 745inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 746 const SourceRange &R) { 747 DB.AddSourceRange(R); 748 return DB; 749} 750 751inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 752 const FixItHint &Hint) { 753 DB.AddFixItHint(Hint); 754 return DB; 755} 756 757/// Report - Issue the message to the client. DiagID is a member of the 758/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 759/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 760inline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 761 assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 762 CurDiagLoc = Loc; 763 CurDiagID = DiagID; 764 return DiagnosticBuilder(this); 765} 766inline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 767 return Report(FullSourceLoc(), DiagID); 768} 769 770//===----------------------------------------------------------------------===// 771// DiagnosticInfo 772//===----------------------------------------------------------------------===// 773 774/// DiagnosticInfo - This is a little helper class (which is basically a smart 775/// pointer that forward info from Diagnostic) that allows clients to enquire 776/// about the currently in-flight diagnostic. 777class DiagnosticInfo { 778 const Diagnostic *DiagObj; 779public: 780 explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 781 782 const Diagnostic *getDiags() const { return DiagObj; } 783 unsigned getID() const { return DiagObj->CurDiagID; } 784 const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 785 786 unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 787 788 /// getArgKind - Return the kind of the specified index. Based on the kind 789 /// of argument, the accessors below can be used to get the value. 790 Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 791 assert(Idx < getNumArgs() && "Argument index out of range!"); 792 return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 793 } 794 795 /// getArgStdStr - Return the provided argument string specified by Idx. 796 const std::string &getArgStdStr(unsigned Idx) const { 797 assert(getArgKind(Idx) == Diagnostic::ak_std_string && 798 "invalid argument accessor!"); 799 return DiagObj->DiagArgumentsStr[Idx]; 800 } 801 802 /// getArgCStr - Return the specified C string argument. 803 const char *getArgCStr(unsigned Idx) const { 804 assert(getArgKind(Idx) == Diagnostic::ak_c_string && 805 "invalid argument accessor!"); 806 return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 807 } 808 809 /// getArgSInt - Return the specified signed integer argument. 810 int getArgSInt(unsigned Idx) const { 811 assert(getArgKind(Idx) == Diagnostic::ak_sint && 812 "invalid argument accessor!"); 813 return (int)DiagObj->DiagArgumentsVal[Idx]; 814 } 815 816 /// getArgUInt - Return the specified unsigned integer argument. 817 unsigned getArgUInt(unsigned Idx) const { 818 assert(getArgKind(Idx) == Diagnostic::ak_uint && 819 "invalid argument accessor!"); 820 return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 821 } 822 823 /// getArgIdentifier - Return the specified IdentifierInfo argument. 824 const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 825 assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 826 "invalid argument accessor!"); 827 return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 828 } 829 830 /// getRawArg - Return the specified non-string argument in an opaque form. 831 intptr_t getRawArg(unsigned Idx) const { 832 assert(getArgKind(Idx) != Diagnostic::ak_std_string && 833 "invalid argument accessor!"); 834 return DiagObj->DiagArgumentsVal[Idx]; 835 } 836 837 838 /// getNumRanges - Return the number of source ranges associated with this 839 /// diagnostic. 840 unsigned getNumRanges() const { 841 return DiagObj->NumDiagRanges; 842 } 843 844 SourceRange getRange(unsigned Idx) const { 845 assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 846 return DiagObj->DiagRanges[Idx]; 847 } 848 849 unsigned getNumFixItHints() const { 850 return DiagObj->NumFixItHints; 851 } 852 853 const FixItHint &getFixItHint(unsigned Idx) const { 854 return DiagObj->FixItHints[Idx]; 855 } 856 857 const FixItHint *getFixItHints() const { 858 return DiagObj->NumFixItHints? 859 &DiagObj->FixItHints[0] : 0; 860 } 861 862 /// FormatDiagnostic - Format this diagnostic into a string, substituting the 863 /// formal arguments into the %0 slots. The result is appended onto the Str 864 /// array. 865 void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 866 867 /// FormatDiagnostic - Format the given format-string into the 868 /// output buffer using the arguments stored in this diagnostic. 869 void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 870 llvm::SmallVectorImpl<char> &OutStr) const; 871}; 872 873/** 874 * \brief Represents a diagnostic in a form that can be serialized and 875 * deserialized. 876 */ 877class StoredDiagnostic { 878 Diagnostic::Level Level; 879 FullSourceLoc Loc; 880 std::string Message; 881 std::vector<SourceRange> Ranges; 882 std::vector<FixItHint> FixIts; 883 884public: 885 StoredDiagnostic(); 886 StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 887 StoredDiagnostic(Diagnostic::Level Level, llvm::StringRef Message); 888 ~StoredDiagnostic(); 889 890 /// \brief Evaluates true when this object stores a diagnostic. 891 operator bool() const { return Message.size() > 0; } 892 893 Diagnostic::Level getLevel() const { return Level; } 894 const FullSourceLoc &getLocation() const { return Loc; } 895 llvm::StringRef getMessage() const { return Message; } 896 897 typedef std::vector<SourceRange>::const_iterator range_iterator; 898 range_iterator range_begin() const { return Ranges.begin(); } 899 range_iterator range_end() const { return Ranges.end(); } 900 unsigned range_size() const { return Ranges.size(); } 901 902 typedef std::vector<FixItHint>::const_iterator fixit_iterator; 903 fixit_iterator fixit_begin() const { return FixIts.begin(); } 904 fixit_iterator fixit_end() const { return FixIts.end(); } 905 unsigned fixit_size() const { return FixIts.size(); } 906 907 /// Serialize - Serialize the given diagnostic (with its diagnostic 908 /// level) to the given stream. Serialization is a lossy operation, 909 /// since the specific diagnostic ID and any macro-instantiation 910 /// information is lost. 911 void Serialize(llvm::raw_ostream &OS) const; 912 913 /// Deserialize - Deserialize the first diagnostic within the memory 914 /// [Memory, MemoryEnd), producing a new diagnostic builder describing the 915 /// deserialized diagnostic. If the memory does not contain a 916 /// diagnostic, returns a diagnostic builder with no diagnostic ID. 917 static StoredDiagnostic Deserialize(FileManager &FM, SourceManager &SM, 918 const char *&Memory, const char *MemoryEnd); 919}; 920 921/// DiagnosticClient - This is an abstract interface implemented by clients of 922/// the front-end, which formats and prints fully processed diagnostics. 923class DiagnosticClient { 924public: 925 virtual ~DiagnosticClient(); 926 927 /// BeginSourceFile - Callback to inform the diagnostic client that processing 928 /// of a source file is beginning. 929 /// 930 /// Note that diagnostics may be emitted outside the processing of a source 931 /// file, for example during the parsing of command line options. However, 932 /// diagnostics with source range information are required to only be emitted 933 /// in between BeginSourceFile() and EndSourceFile(). 934 /// 935 /// \arg LO - The language options for the source file being processed. 936 /// \arg PP - The preprocessor object being used for the source; this optional 937 /// and may not be present, for example when processing AST source files. 938 virtual void BeginSourceFile(const LangOptions &LangOpts, 939 const Preprocessor *PP = 0) {} 940 941 /// EndSourceFile - Callback to inform the diagnostic client that processing 942 /// of a source file has ended. The diagnostic client should assume that any 943 /// objects made available via \see BeginSourceFile() are inaccessible. 944 virtual void EndSourceFile() {} 945 946 /// IncludeInDiagnosticCounts - This method (whose default implementation 947 /// returns true) indicates whether the diagnostics handled by this 948 /// DiagnosticClient should be included in the number of diagnostics reported 949 /// by Diagnostic. 950 virtual bool IncludeInDiagnosticCounts() const; 951 952 /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 953 /// capturing it to a log as needed. 954 virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 955 const DiagnosticInfo &Info) = 0; 956}; 957 958} // end namespace clang 959 960#endif 961