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