contrib/llvm/tools/clang/include/clang/Basic/Diagnostic.h

   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 /// \file
  11 /// \brief Defines the Diagnostic-related interfaces.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_BASIC_DIAGNOSTIC_H
  16 #define LLVM_CLANG_BASIC_DIAGNOSTIC_H
  17
  18 #include "clang/Basic/DiagnosticIDs.h"
  19 #include "clang/Basic/DiagnosticOptions.h"
  20 #include "clang/Basic/SourceLocation.h"
  21 #include "llvm/ADT/ArrayRef.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  24 #include "llvm/ADT/iterator_range.h"
  25 #include <list>
  26 #include <vector>
  27
  28 namespace clang {
  29   class DeclContext;
  30   class DiagnosticBuilder;
  31   class DiagnosticConsumer;
  32   class DiagnosticErrorTrap;
  33   class DiagnosticOptions;
  34   class IdentifierInfo;
  35   class LangOptions;
  36   class Preprocessor;
  37   class StoredDiagnostic;
  38   namespace tok {
  39   enum TokenKind : unsigned short;
  40   }
  41
  42 /// \brief Annotates a diagnostic with some code that should be
  43 /// inserted, removed, or replaced to fix the problem.
  44 ///
  45 /// This kind of hint should be used when we are certain that the
  46 /// introduction, removal, or modification of a particular (small!)
  47 /// amount of code will correct a compilation error. The compiler
  48 /// should also provide full recovery from such errors, such that
  49 /// suppressing the diagnostic output can still result in successful
  50 /// compilation.
  51 class FixItHint {
  52 public:
  53   /// \brief Code that should be replaced to correct the error. Empty for an
  54   /// insertion hint.
  55   CharSourceRange RemoveRange;
  56
  57   /// \brief Code in the specific range that should be inserted in the insertion
  58   /// location.
  59   CharSourceRange InsertFromRange;
  60
  61   /// \brief The actual code to insert at the insertion location, as a
  62   /// string.
  63   std::string CodeToInsert;
  64
  65   bool BeforePreviousInsertions;
  66
  67   /// \brief Empty code modification hint, indicating that no code
  68   /// modification is known.
  69   FixItHint() : BeforePreviousInsertions(false) { }
  70
  71   bool isNull() const {
  72     return !RemoveRange.isValid();
  73   }
  74
  75   /// \brief Create a code modification hint that inserts the given
  76   /// code string at a specific location.
  77   static FixItHint CreateInsertion(SourceLocation InsertionLoc,
  78                                    StringRef Code,
  79                                    bool BeforePreviousInsertions = false) {
  80     FixItHint Hint;
  81     Hint.RemoveRange =
  82       CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
  83     Hint.CodeToInsert = Code;
  84     Hint.BeforePreviousInsertions = BeforePreviousInsertions;
  85     return Hint;
  86   }
  87
  88   /// \brief Create a code modification hint that inserts the given
  89   /// code from \p FromRange at a specific location.
  90   static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc,
  91                                             CharSourceRange FromRange,
  92                                         bool BeforePreviousInsertions = false) {
  93     FixItHint Hint;
  94     Hint.RemoveRange =
  95       CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
  96     Hint.InsertFromRange = FromRange;
  97     Hint.BeforePreviousInsertions = BeforePreviousInsertions;
  98     return Hint;
  99   }
 100
 101   /// \brief Create a code modification hint that removes the given
 102   /// source range.
 103   static FixItHint CreateRemoval(CharSourceRange RemoveRange) {
 104     FixItHint Hint;
 105     Hint.RemoveRange = RemoveRange;
 106     return Hint;
 107   }
 108   static FixItHint CreateRemoval(SourceRange RemoveRange) {
 109     return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange));
 110   }
 111
 112   /// \brief Create a code modification hint that replaces the given
 113   /// source range with the given code string.
 114   static FixItHint CreateReplacement(CharSourceRange RemoveRange,
 115                                      StringRef Code) {
 116     FixItHint Hint;
 117     Hint.RemoveRange = RemoveRange;
 118     Hint.CodeToInsert = Code;
 119     return Hint;
 120   }
 121
 122   static FixItHint CreateReplacement(SourceRange RemoveRange,
 123                                      StringRef Code) {
 124     return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code);
 125   }
 126 };
 127
 128 /// \brief Concrete class used by the front-end to report problems and issues.
 129 ///
 130 /// This massages the diagnostics (e.g. handling things like "report warnings
 131 /// as errors" and passes them off to the DiagnosticConsumer for reporting to
 132 /// the user. DiagnosticsEngine is tied to one translation unit and one
 133 /// SourceManager.
 134 class DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> {
 135   DiagnosticsEngine(const DiagnosticsEngine &) = delete;
 136   void operator=(const DiagnosticsEngine &) = delete;
 137
 138 public:
 139   /// \brief The level of the diagnostic, after it has been through mapping.
 140   enum Level {
 141     Ignored = DiagnosticIDs::Ignored,
 142     Note = DiagnosticIDs::Note,
 143     Remark = DiagnosticIDs::Remark,
 144     Warning = DiagnosticIDs::Warning,
 145     Error = DiagnosticIDs::Error,
 146     Fatal = DiagnosticIDs::Fatal
 147   };
 148
 149   enum ArgumentKind {
 150     ak_std_string,      ///< std::string
 151     ak_c_string,        ///< const char *
 152     ak_sint,            ///< int
 153     ak_uint,            ///< unsigned
 154     ak_tokenkind,       ///< enum TokenKind : unsigned
 155     ak_identifierinfo,  ///< IdentifierInfo
 156     ak_qualtype,        ///< QualType
 157     ak_declarationname, ///< DeclarationName
 158     ak_nameddecl,       ///< NamedDecl *
 159     ak_nestednamespec,  ///< NestedNameSpecifier *
 160     ak_declcontext,     ///< DeclContext *
 161     ak_qualtype_pair,   ///< pair<QualType, QualType>
 162     ak_attr             ///< Attr *
 163   };
 164
 165   /// \brief Represents on argument value, which is a union discriminated
 166   /// by ArgumentKind, with a value.
 167   typedef std::pair<ArgumentKind, intptr_t> ArgumentValue;
 168
 169 private:
 170   unsigned char AllExtensionsSilenced; // Used by __extension__
 171   bool IgnoreAllWarnings;        // Ignore all warnings: -w
 172   bool WarningsAsErrors;         // Treat warnings like errors.
 173   bool EnableAllWarnings;        // Enable all warnings.
 174   bool ErrorsAsFatal;            // Treat errors like fatal errors.
 175   bool SuppressSystemWarnings;   // Suppress warnings in system headers.
 176   bool SuppressAllDiagnostics;   // Suppress all diagnostics.
 177   bool ElideType;                // Elide common types of templates.
 178   bool PrintTemplateTree;        // Print a tree when comparing templates.
 179   bool ShowColors;               // Color printing is enabled.
 180   OverloadsShown ShowOverloads;  // Which overload candidates to show.
 181   unsigned ErrorLimit;           // Cap of # errors emitted, 0 -> no limit.
 182   unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack,
 183                                    // 0 -> no limit.
 184   unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation
 185                                     // backtrace stack, 0 -> no limit.
 186   diag::Severity ExtBehavior;       // Map extensions to warnings or errors?
 187   IntrusiveRefCntPtr<DiagnosticIDs> Diags;
 188   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
 189   DiagnosticConsumer *Client;
 190   std::unique_ptr<DiagnosticConsumer> Owner;
 191   SourceManager *SourceMgr;
 192
 193   /// \brief Mapping information for diagnostics.
 194   ///
 195   /// Mapping info is packed into four bits per diagnostic.  The low three
 196   /// bits are the mapping (an instance of diag::Severity), or zero if unset.
 197   /// The high bit is set when the mapping was established as a user mapping.
 198   /// If the high bit is clear, then the low bits are set to the default
 199   /// value, and should be mapped with -pedantic, -Werror, etc.
 200   ///
 201   /// A new DiagState is created and kept around when diagnostic pragmas modify
 202   /// the state so that we know what is the diagnostic state at any given
 203   /// source location.
 204   class DiagState {
 205     llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap;
 206
 207   public:
 208     typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator;
 209     typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator
 210     const_iterator;
 211
 212     void setMapping(diag::kind Diag, DiagnosticMapping Info) {
 213       DiagMap[Diag] = Info;
 214     }
 215
 216     DiagnosticMapping &getOrAddMapping(diag::kind Diag);
 217
 218     const_iterator begin() const { return DiagMap.begin(); }
 219     const_iterator end() const { return DiagMap.end(); }
 220   };
 221
 222   /// \brief Keeps and automatically disposes all DiagStates that we create.
 223   std::list<DiagState> DiagStates;
 224
 225   /// \brief Represents a point in source where the diagnostic state was
 226   /// modified because of a pragma.
 227   ///
 228   /// 'Loc' can be null if the point represents the diagnostic state
 229   /// modifications done through the command-line.
 230   struct DiagStatePoint {
 231     DiagState *State;
 232     FullSourceLoc Loc;
 233     DiagStatePoint(DiagState *State, FullSourceLoc Loc)
 234       : State(State), Loc(Loc) { }
 235
 236     bool operator<(const DiagStatePoint &RHS) const {
 237       // If Loc is invalid it means it came from <command-line>, in which case
 238       // we regard it as coming before any valid source location.
 239       if (RHS.Loc.isInvalid())
 240         return false;
 241       if (Loc.isInvalid())
 242         return true;
 243       return Loc.isBeforeInTranslationUnitThan(RHS.Loc);
 244     }
 245   };
 246
 247   /// \brief A sorted vector of all DiagStatePoints representing changes in
 248   /// diagnostic state due to diagnostic pragmas.
 249   ///
 250   /// The vector is always sorted according to the SourceLocation of the
 251   /// DiagStatePoint.
 252   typedef std::vector<DiagStatePoint> DiagStatePointsTy;
 253   mutable DiagStatePointsTy DiagStatePoints;
 254
 255   /// \brief Keeps the DiagState that was active during each diagnostic 'push'
 256   /// so we can get back at it when we 'pop'.
 257   std::vector<DiagState *> DiagStateOnPushStack;
 258
 259   DiagState *GetCurDiagState() const {
 260     assert(!DiagStatePoints.empty());
 261     return DiagStatePoints.back().State;
 262   }
 263
 264   void PushDiagStatePoint(DiagState *State, SourceLocation L) {
 265     FullSourceLoc Loc(L, getSourceManager());
 266     // Make sure that DiagStatePoints is always sorted according to Loc.
 267     assert(Loc.isValid() && "Adding invalid loc point");
 268     assert(!DiagStatePoints.empty() &&
 269            (DiagStatePoints.back().Loc.isInvalid() ||
 270             DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) &&
 271            "Previous point loc comes after or is the same as new one");
 272     DiagStatePoints.push_back(DiagStatePoint(State, Loc));
 273   }
 274
 275   /// \brief Finds the DiagStatePoint that contains the diagnostic state of
 276   /// the given source location.
 277   DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const;
 278
 279   /// \brief Sticky flag set to \c true when an error is emitted.
 280   bool ErrorOccurred;
 281
 282   /// \brief Sticky flag set to \c true when an "uncompilable error" occurs.
 283   /// I.e. an error that was not upgraded from a warning by -Werror.
 284   bool UncompilableErrorOccurred;
 285
 286   /// \brief Sticky flag set to \c true when a fatal error is emitted.
 287   bool FatalErrorOccurred;
 288
 289   /// \brief Indicates that an unrecoverable error has occurred.
 290   bool UnrecoverableErrorOccurred;
 291
 292   /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred
 293   /// during a parsing section, e.g. during parsing a function.
 294   unsigned TrapNumErrorsOccurred;
 295   unsigned TrapNumUnrecoverableErrorsOccurred;
 296
 297   /// \brief The level of the last diagnostic emitted.
 298   ///
 299   /// This is used to emit continuation diagnostics with the same level as the
 300   /// diagnostic that they follow.
 301   DiagnosticIDs::Level LastDiagLevel;
 302
 303   unsigned NumWarnings;         ///< Number of warnings reported
 304   unsigned NumErrors;           ///< Number of errors reported
 305
 306   /// \brief A function pointer that converts an opaque diagnostic
 307   /// argument to a strings.
 308   ///
 309   /// This takes the modifiers and argument that was present in the diagnostic.
 310   ///
 311   /// The PrevArgs array indicates the previous arguments formatted for this
 312   /// diagnostic.  Implementations of this function can use this information to
 313   /// avoid redundancy across arguments.
 314   ///
 315   /// This is a hack to avoid a layering violation between libbasic and libsema.
 316   typedef void (*ArgToStringFnTy)(
 317       ArgumentKind Kind, intptr_t Val,
 318       StringRef Modifier, StringRef Argument,
 319       ArrayRef<ArgumentValue> PrevArgs,
 320       SmallVectorImpl<char> &Output,
 321       void *Cookie,
 322       ArrayRef<intptr_t> QualTypeVals);
 323   void *ArgToStringCookie;
 324   ArgToStringFnTy ArgToStringFn;
 325
 326   /// \brief ID of the "delayed" diagnostic, which is a (typically
 327   /// fatal) diagnostic that had to be delayed because it was found
 328   /// while emitting another diagnostic.
 329   unsigned DelayedDiagID;
 330
 331   /// \brief First string argument for the delayed diagnostic.
 332   std::string DelayedDiagArg1;
 333
 334   /// \brief Second string argument for the delayed diagnostic.
 335   std::string DelayedDiagArg2;
 336
 337   /// \brief Optional flag value.
 338   ///
 339   /// Some flags accept values, for instance: -Wframe-larger-than=<value> and
 340   /// -Rpass=<value>. The content of this string is emitted after the flag name
 341   /// and '='.
 342   std::string FlagValue;
 343
 344 public:
 345   explicit DiagnosticsEngine(
 346                       const IntrusiveRefCntPtr<DiagnosticIDs> &Diags,
 347                       DiagnosticOptions *DiagOpts,
 348                       DiagnosticConsumer *client = nullptr,
 349                       bool ShouldOwnClient = true);
 350   ~DiagnosticsEngine();
 351
 352   const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const {
 353     return Diags;
 354   }
 355
 356   /// \brief Retrieve the diagnostic options.
 357   DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; }
 358
 359   typedef llvm::iterator_range<DiagState::const_iterator> diag_mapping_range;
 360
 361   /// \brief Get the current set of diagnostic mappings.
 362   diag_mapping_range getDiagnosticMappings() const {
 363     const DiagState &DS = *GetCurDiagState();
 364     return diag_mapping_range(DS.begin(), DS.end());
 365   }
 366
 367   DiagnosticConsumer *getClient() { return Client; }
 368   const DiagnosticConsumer *getClient() const { return Client; }
 369
 370   /// \brief Determine whether this \c DiagnosticsEngine object own its client.
 371   bool ownsClient() const { return Owner != nullptr; }
 372
 373   /// \brief Return the current diagnostic client along with ownership of that
 374   /// client.
 375   std::unique_ptr<DiagnosticConsumer> takeClient() { return std::move(Owner); }
 376
 377   bool hasSourceManager() const { return SourceMgr != nullptr; }
 378   SourceManager &getSourceManager() const {
 379     assert(SourceMgr && "SourceManager not set!");
 380     return *SourceMgr;
 381   }
 382   void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; }
 383
 384   //===--------------------------------------------------------------------===//
 385   //  DiagnosticsEngine characterization methods, used by a client to customize
 386   //  how diagnostics are emitted.
 387   //
 388
 389   /// \brief Copies the current DiagMappings and pushes the new copy
 390   /// onto the top of the stack.
 391   void pushMappings(SourceLocation Loc);
 392
 393   /// \brief Pops the current DiagMappings off the top of the stack,
 394   /// causing the new top of the stack to be the active mappings.
 395   ///
 396   /// \returns \c true if the pop happens, \c false if there is only one
 397   /// DiagMapping on the stack.
 398   bool popMappings(SourceLocation Loc);
 399
 400   /// \brief Set the diagnostic client associated with this diagnostic object.
 401   ///
 402   /// \param ShouldOwnClient true if the diagnostic object should take
 403   /// ownership of \c client.
 404   void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true);
 405
 406   /// \brief Specify a limit for the number of errors we should
 407   /// emit before giving up.
 408   ///
 409   /// Zero disables the limit.
 410   void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; }
 411
 412   /// \brief Specify the maximum number of template instantiation
 413   /// notes to emit along with a given diagnostic.
 414   void setTemplateBacktraceLimit(unsigned Limit) {
 415     TemplateBacktraceLimit = Limit;
 416   }
 417
 418   /// \brief Retrieve the maximum number of template instantiation
 419   /// notes to emit along with a given diagnostic.
 420   unsigned getTemplateBacktraceLimit() const {
 421     return TemplateBacktraceLimit;
 422   }
 423
 424   /// \brief Specify the maximum number of constexpr evaluation
 425   /// notes to emit along with a given diagnostic.
 426   void setConstexprBacktraceLimit(unsigned Limit) {
 427     ConstexprBacktraceLimit = Limit;
 428   }
 429
 430   /// \brief Retrieve the maximum number of constexpr evaluation
 431   /// notes to emit along with a given diagnostic.
 432   unsigned getConstexprBacktraceLimit() const {
 433     return ConstexprBacktraceLimit;
 434   }
 435
 436   /// \brief When set to true, any unmapped warnings are ignored.
 437   ///
 438   /// If this and WarningsAsErrors are both set, then this one wins.
 439   void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; }
 440   bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; }
 441
 442   /// \brief When set to true, any unmapped ignored warnings are no longer
 443   /// ignored.
 444   ///
 445   /// If this and IgnoreAllWarnings are both set, then that one wins.
 446   void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; }
 447   bool getEnableAllWarnings() const { return EnableAllWarnings; }
 448
 449   /// \brief When set to true, any warnings reported are issued as errors.
 450   void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; }
 451   bool getWarningsAsErrors() const { return WarningsAsErrors; }
 452
 453   /// \brief When set to true, any error reported is made a fatal error.
 454   void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; }
 455   bool getErrorsAsFatal() const { return ErrorsAsFatal; }
 456
 457   /// \brief When set to true mask warnings that come from system headers.
 458   void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; }
 459   bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; }
 460
 461   /// \brief Suppress all diagnostics, to silence the front end when we
 462   /// know that we don't want any more diagnostics to be passed along to the
 463   /// client
 464   void setSuppressAllDiagnostics(bool Val = true) {
 465     SuppressAllDiagnostics = Val;
 466   }
 467   bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; }
 468
 469   /// \brief Set type eliding, to skip outputting same types occurring in
 470   /// template types.
 471   void setElideType(bool Val = true) { ElideType = Val; }
 472   bool getElideType() { return ElideType; }
 473
 474   /// \brief Set tree printing, to outputting the template difference in a
 475   /// tree format.
 476   void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; }
 477   bool getPrintTemplateTree() { return PrintTemplateTree; }
 478
 479   /// \brief Set color printing, so the type diffing will inject color markers
 480   /// into the output.
 481   void setShowColors(bool Val = false) { ShowColors = Val; }
 482   bool getShowColors() { return ShowColors; }
 483
 484   /// \brief Specify which overload candidates to show when overload resolution
 485   /// fails.
 486   ///
 487   /// By default, we show all candidates.
 488   void setShowOverloads(OverloadsShown Val) {
 489     ShowOverloads = Val;
 490   }
 491   OverloadsShown getShowOverloads() const { return ShowOverloads; }
 492
 493   /// \brief Pretend that the last diagnostic issued was ignored, so any
 494   /// subsequent notes will be suppressed.
 495   ///
 496   /// This can be used by clients who suppress diagnostics themselves.
 497   void setLastDiagnosticIgnored() {
 498     if (LastDiagLevel == DiagnosticIDs::Fatal)
 499       FatalErrorOccurred = true;
 500     LastDiagLevel = DiagnosticIDs::Ignored;
 501   }
 502
 503   /// \brief Determine whether the previous diagnostic was ignored. This can
 504   /// be used by clients that want to determine whether notes attached to a
 505   /// diagnostic will be suppressed.
 506   bool isLastDiagnosticIgnored() const {
 507     return LastDiagLevel == DiagnosticIDs::Ignored;
 508   }
 509
 510   /// \brief Controls whether otherwise-unmapped extension diagnostics are
 511   /// mapped onto ignore/warning/error.
 512   ///
 513   /// This corresponds to the GCC -pedantic and -pedantic-errors option.
 514   void setExtensionHandlingBehavior(diag::Severity H) { ExtBehavior = H; }
 515   diag::Severity getExtensionHandlingBehavior() const { return ExtBehavior; }
 516
 517   /// \brief Counter bumped when an __extension__  block is/ encountered.
 518   ///
 519   /// When non-zero, all extension diagnostics are entirely silenced, no
 520   /// matter how they are mapped.
 521   void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; }
 522   void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; }
 523   bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; }
 524
 525   /// \brief This allows the client to specify that certain warnings are
 526   /// ignored.
 527   ///
 528   /// Notes can never be mapped, errors can only be mapped to fatal, and
 529   /// WARNINGs and EXTENSIONs can be mapped arbitrarily.
 530   ///
 531   /// \param Loc The source location that this change of diagnostic state should
 532   /// take affect. It can be null if we are setting the latest state.
 533   void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc);
 534
 535   /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to
 536   /// have the specified mapping.
 537   ///
 538   /// \returns true (and ignores the request) if "Group" was unknown, false
 539   /// otherwise.
 540   ///
 541   /// \param Flavor The flavor of group to affect. -Rfoo does not affect the
 542   /// state of the -Wfoo group and vice versa.
 543   ///
 544   /// \param Loc The source location that this change of diagnostic state should
 545   /// take affect. It can be null if we are setting the state from command-line.
 546   bool setSeverityForGroup(diag::Flavor Flavor, StringRef Group,
 547                            diag::Severity Map,
 548                            SourceLocation Loc = SourceLocation());
 549
 550   /// \brief Set the warning-as-error flag for the given diagnostic group.
 551   ///
 552   /// This function always only operates on the current diagnostic state.
 553   ///
 554   /// \returns True if the given group is unknown, false otherwise.
 555   bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled);
 556
 557   /// \brief Set the error-as-fatal flag for the given diagnostic group.
 558   ///
 559   /// This function always only operates on the current diagnostic state.
 560   ///
 561   /// \returns True if the given group is unknown, false otherwise.
 562   bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled);
 563
 564   /// \brief Add the specified mapping to all diagnostics of the specified
 565   /// flavor.
 566   ///
 567   /// Mainly to be used by -Wno-everything to disable all warnings but allow
 568   /// subsequent -W options to enable specific warnings.
 569   void setSeverityForAll(diag::Flavor Flavor, diag::Severity Map,
 570                          SourceLocation Loc = SourceLocation());
 571
 572   bool hasErrorOccurred() const { return ErrorOccurred; }
 573
 574   /// \brief Errors that actually prevent compilation, not those that are
 575   /// upgraded from a warning by -Werror.
 576   bool hasUncompilableErrorOccurred() const {
 577     return UncompilableErrorOccurred;
 578   }
 579   bool hasFatalErrorOccurred() const { return FatalErrorOccurred; }
 580
 581   /// \brief Determine whether any kind of unrecoverable error has occurred.
 582   bool hasUnrecoverableErrorOccurred() const {
 583     return FatalErrorOccurred || UnrecoverableErrorOccurred;
 584   }
 585
 586   unsigned getNumWarnings() const { return NumWarnings; }
 587
 588   void setNumWarnings(unsigned NumWarnings) {
 589     this->NumWarnings = NumWarnings;
 590   }
 591
 592   /// \brief Return an ID for a diagnostic with the specified format string and
 593   /// level.
 594   ///
 595   /// If this is the first request for this diagnostic, it is registered and
 596   /// created, otherwise the existing ID is returned.
 597   ///
 598   /// \param FormatString A fixed diagnostic format string that will be hashed
 599   /// and mapped to a unique DiagID.
 600   template <unsigned N>
 601   unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) {
 602     return Diags->getCustomDiagID((DiagnosticIDs::Level)L,
 603                                   StringRef(FormatString, N - 1));
 604   }
 605
 606   /// \brief Converts a diagnostic argument (as an intptr_t) into the string
 607   /// that represents it.
 608   void ConvertArgToString(ArgumentKind Kind, intptr_t Val,
 609                           StringRef Modifier, StringRef Argument,
 610                           ArrayRef<ArgumentValue> PrevArgs,
 611                           SmallVectorImpl<char> &Output,
 612                           ArrayRef<intptr_t> QualTypeVals) const {
 613     ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output,
 614                   ArgToStringCookie, QualTypeVals);
 615   }
 616
 617   void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) {
 618     ArgToStringFn = Fn;
 619     ArgToStringCookie = Cookie;
 620   }
 621
 622   /// \brief Note that the prior diagnostic was emitted by some other
 623   /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic.
 624   void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) {
 625     LastDiagLevel = Other.LastDiagLevel;
 626   }
 627
 628   /// \brief Reset the state of the diagnostic object to its initial
 629   /// configuration.
 630   void Reset();
 631
 632   //===--------------------------------------------------------------------===//
 633   // DiagnosticsEngine classification and reporting interfaces.
 634   //
 635
 636   /// \brief Determine whether the diagnostic is known to be ignored.
 637   ///
 638   /// This can be used to opportunistically avoid expensive checks when it's
 639   /// known for certain that the diagnostic has been suppressed at the
 640   /// specified location \p Loc.
 641   ///
 642   /// \param Loc The source location we are interested in finding out the
 643   /// diagnostic state. Can be null in order to query the latest state.
 644   bool isIgnored(unsigned DiagID, SourceLocation Loc) const {
 645     return Diags->getDiagnosticSeverity(DiagID, Loc, *this) ==
 646            diag::Severity::Ignored;
 647   }
 648
 649   /// \brief Based on the way the client configured the DiagnosticsEngine
 650   /// object, classify the specified diagnostic ID into a Level, consumable by
 651   /// the DiagnosticConsumer.
 652   ///
 653   /// To preserve invariant assumptions, this function should not be used to
 654   /// influence parse or semantic analysis actions. Instead consider using
 655   /// \c isIgnored().
 656   ///
 657   /// \param Loc The source location we are interested in finding out the
 658   /// diagnostic state. Can be null in order to query the latest state.
 659   Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const {
 660     return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this);
 661   }
 662
 663   /// \brief Issue the message to the client.
 664   ///
 665   /// This actually returns an instance of DiagnosticBuilder which emits the
 666   /// diagnostics (through @c ProcessDiag) when it is destroyed.
 667   ///
 668   /// \param DiagID A member of the @c diag::kind enum.
 669   /// \param Loc Represents the source location associated with the diagnostic,
 670   /// which can be an invalid location if no position information is available.
 671   inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID);
 672   inline DiagnosticBuilder Report(unsigned DiagID);
 673
 674   void Report(const StoredDiagnostic &storedDiag);
 675
 676   /// \brief Determine whethere there is already a diagnostic in flight.
 677   bool isDiagnosticInFlight() const { return CurDiagID != ~0U; }
 678
 679   /// \brief Set the "delayed" diagnostic that will be emitted once
 680   /// the current diagnostic completes.
 681   ///
 682   ///  If a diagnostic is already in-flight but the front end must
 683   ///  report a problem (e.g., with an inconsistent file system
 684   ///  state), this routine sets a "delayed" diagnostic that will be
 685   ///  emitted after the current diagnostic completes. This should
 686   ///  only be used for fatal errors detected at inconvenient
 687   ///  times. If emitting a delayed diagnostic causes a second delayed
 688   ///  diagnostic to be introduced, that second delayed diagnostic
 689   ///  will be ignored.
 690   ///
 691   /// \param DiagID The ID of the diagnostic being delayed.
 692   ///
 693   /// \param Arg1 A string argument that will be provided to the
 694   /// diagnostic. A copy of this string will be stored in the
 695   /// DiagnosticsEngine object itself.
 696   ///
 697   /// \param Arg2 A string argument that will be provided to the
 698   /// diagnostic. A copy of this string will be stored in the
 699   /// DiagnosticsEngine object itself.
 700   void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "",
 701                             StringRef Arg2 = "");
 702
 703   /// \brief Clear out the current diagnostic.
 704   void Clear() { CurDiagID = ~0U; }
 705
 706   /// \brief Return the value associated with this diagnostic flag.
 707   StringRef getFlagValue() const { return FlagValue; }
 708
 709 private:
 710   /// \brief Report the delayed diagnostic.
 711   void ReportDelayed();
 712
 713   // This is private state used by DiagnosticBuilder.  We put it here instead of
 714   // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight
 715   // object.  This implementation choice means that we can only have one
 716   // diagnostic "in flight" at a time, but this seems to be a reasonable
 717   // tradeoff to keep these objects small.  Assertions verify that only one
 718   // diagnostic is in flight at a time.
 719   friend class DiagnosticIDs;
 720   friend class DiagnosticBuilder;
 721   friend class Diagnostic;
 722   friend class PartialDiagnostic;
 723   friend class DiagnosticErrorTrap;
 724
 725   /// \brief The location of the current diagnostic that is in flight.
 726   SourceLocation CurDiagLoc;
 727
 728   /// \brief The ID of the current diagnostic that is in flight.
 729   ///
 730   /// This is set to ~0U when there is no diagnostic in flight.
 731   unsigned CurDiagID;
 732
 733   enum {
 734     /// \brief The maximum number of arguments we can hold.
 735     ///
 736     /// We currently only support up to 10 arguments (%0-%9).  A single
 737     /// diagnostic with more than that almost certainly has to be simplified
 738     /// anyway.
 739     MaxArguments = 10,
 740   };
 741
 742   /// \brief The number of entries in Arguments.
 743   signed char NumDiagArgs;
 744
 745   /// \brief Specifies whether an argument is in DiagArgumentsStr or
 746   /// in DiagArguments.
 747   ///
 748   /// This is an array of ArgumentKind::ArgumentKind enum values, one for each
 749   /// argument.
 750   unsigned char DiagArgumentsKind[MaxArguments];
 751
 752   /// \brief Holds the values of each string argument for the current
 753   /// diagnostic.
 754   ///
 755   /// This is only used when the corresponding ArgumentKind is ak_std_string.
 756   std::string DiagArgumentsStr[MaxArguments];
 757
 758   /// \brief The values for the various substitution positions.
 759   ///
 760   /// This is used when the argument is not an std::string.  The specific
 761   /// value is mangled into an intptr_t and the interpretation depends on
 762   /// exactly what sort of argument kind it is.
 763   intptr_t DiagArgumentsVal[MaxArguments];
 764
 765   /// \brief The list of ranges added to this diagnostic.
 766   SmallVector<CharSourceRange, 8> DiagRanges;
 767
 768   /// \brief If valid, provides a hint with some code to insert, remove,
 769   /// or modify at a particular position.
 770   SmallVector<FixItHint, 8> DiagFixItHints;
 771
 772   DiagnosticMapping makeUserMapping(diag::Severity Map, SourceLocation L) {
 773     bool isPragma = L.isValid();
 774     DiagnosticMapping Mapping =
 775         DiagnosticMapping::Make(Map, /*IsUser=*/true, isPragma);
 776
 777     // If this is a pragma mapping, then set the diagnostic mapping flags so
 778     // that we override command line options.
 779     if (isPragma) {
 780       Mapping.setNoWarningAsError(true);
 781       Mapping.setNoErrorAsFatal(true);
 782     }
 783
 784     return Mapping;
 785   }
 786
 787   /// \brief Used to report a diagnostic that is finally fully formed.
 788   ///
 789   /// \returns true if the diagnostic was emitted, false if it was suppressed.
 790   bool ProcessDiag() {
 791     return Diags->ProcessDiag(*this);
 792   }
 793
 794   /// @name Diagnostic Emission
 795   /// @{
 796 protected:
 797   // Sema requires access to the following functions because the current design
 798   // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to
 799   // access us directly to ensure we minimize the emitted code for the common
 800   // Sema::Diag() patterns.
 801   friend class Sema;
 802
 803   /// \brief Emit the current diagnostic and clear the diagnostic state.
 804   ///
 805   /// \param Force Emit the diagnostic regardless of suppression settings.
 806   bool EmitCurrentDiagnostic(bool Force = false);
 807
 808   unsigned getCurrentDiagID() const { return CurDiagID; }
 809
 810   SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; }
 811
 812   /// @}
 813
 814   friend class ASTReader;
 815   friend class ASTWriter;
 816 };
 817
 818 /// \brief RAII class that determines when any errors have occurred
 819 /// between the time the instance was created and the time it was
 820 /// queried.
 821 class DiagnosticErrorTrap {
 822   DiagnosticsEngine &Diag;
 823   unsigned NumErrors;
 824   unsigned NumUnrecoverableErrors;
 825
 826 public:
 827   explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag)
 828     : Diag(Diag) { reset(); }
 829
 830   /// \brief Determine whether any errors have occurred since this
 831   /// object instance was created.
 832   bool hasErrorOccurred() const {
 833     return Diag.TrapNumErrorsOccurred > NumErrors;
 834   }
 835
 836   /// \brief Determine whether any unrecoverable errors have occurred since this
 837   /// object instance was created.
 838   bool hasUnrecoverableErrorOccurred() const {
 839     return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
 840   }
 841
 842   /// \brief Set to initial state of "no errors occurred".
 843   void reset() {
 844     NumErrors = Diag.TrapNumErrorsOccurred;
 845     NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
 846   }
 847 };
 848
 849 //===----------------------------------------------------------------------===//
 850 // DiagnosticBuilder
 851 //===----------------------------------------------------------------------===//
 852
 853 /// \brief A little helper class used to produce diagnostics.
 854 ///
 855 /// This is constructed by the DiagnosticsEngine::Report method, and
 856 /// allows insertion of extra information (arguments and source ranges) into
 857 /// the currently "in flight" diagnostic.  When the temporary for the builder
 858 /// is destroyed, the diagnostic is issued.
 859 ///
 860 /// Note that many of these will be created as temporary objects (many call
 861 /// sites), so we want them to be small and we never want their address taken.
 862 /// This ensures that compilers with somewhat reasonable optimizers will promote
 863 /// the common fields to registers, eliminating increments of the NumArgs field,
 864 /// for example.
 865 class DiagnosticBuilder {
 866   mutable DiagnosticsEngine *DiagObj;
 867   mutable unsigned NumArgs;
 868
 869   /// \brief Status variable indicating if this diagnostic is still active.
 870   ///
 871   // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)),
 872   // but LLVM is not currently smart enough to eliminate the null check that
 873   // Emit() would end up with if we used that as our status variable.
 874   mutable bool IsActive;
 875
 876   /// \brief Flag indicating that this diagnostic is being emitted via a
 877   /// call to ForceEmit.
 878   mutable bool IsForceEmit;
 879
 880   void operator=(const DiagnosticBuilder &) = delete;
 881   friend class DiagnosticsEngine;
 882
 883   DiagnosticBuilder()
 884       : DiagObj(nullptr), NumArgs(0), IsActive(false), IsForceEmit(false) {}
 885
 886   explicit DiagnosticBuilder(DiagnosticsEngine *diagObj)
 887       : DiagObj(diagObj), NumArgs(0), IsActive(true), IsForceEmit(false) {
 888     assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!");
 889     diagObj->DiagRanges.clear();
 890     diagObj->DiagFixItHints.clear();
 891   }
 892
 893   friend class PartialDiagnostic;
 894
 895 protected:
 896   void FlushCounts() {
 897     DiagObj->NumDiagArgs = NumArgs;
 898   }
 899
 900   /// \brief Clear out the current diagnostic.
 901   void Clear() const {
 902     DiagObj = nullptr;
 903     IsActive = false;
 904     IsForceEmit = false;
 905   }
 906
 907   /// \brief Determine whether this diagnostic is still active.
 908   bool isActive() const { return IsActive; }
 909
 910   /// \brief Force the diagnostic builder to emit the diagnostic now.
 911   ///
 912   /// Once this function has been called, the DiagnosticBuilder object
 913   /// should not be used again before it is destroyed.
 914   ///
 915   /// \returns true if a diagnostic was emitted, false if the
 916   /// diagnostic was suppressed.
 917   bool Emit() {
 918     // If this diagnostic is inactive, then its soul was stolen by the copy ctor
 919     // (or by a subclass, as in SemaDiagnosticBuilder).
 920     if (!isActive()) return false;
 921
 922     // When emitting diagnostics, we set the final argument count into
 923     // the DiagnosticsEngine object.
 924     FlushCounts();
 925
 926     // Process the diagnostic.
 927     bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit);
 928
 929     // This diagnostic is dead.
 930     Clear();
 931
 932     return Result;
 933   }
 934
 935 public:
 936   /// Copy constructor.  When copied, this "takes" the diagnostic info from the
 937   /// input and neuters it.
 938   DiagnosticBuilder(const DiagnosticBuilder &D) {
 939     DiagObj = D.DiagObj;
 940     IsActive = D.IsActive;
 941     IsForceEmit = D.IsForceEmit;
 942     D.Clear();
 943     NumArgs = D.NumArgs;
 944   }
 945
 946   /// \brief Retrieve an empty diagnostic builder.
 947   static DiagnosticBuilder getEmpty() {
 948     return DiagnosticBuilder();
 949   }
 950
 951   /// \brief Emits the diagnostic.
 952   ~DiagnosticBuilder() {
 953     Emit();
 954   }
 955
 956   /// \brief Forces the diagnostic to be emitted.
 957   const DiagnosticBuilder &setForceEmit() const {
 958     IsForceEmit = true;
 959     return *this;
 960   }
 961
 962   /// \brief Conversion of DiagnosticBuilder to bool always returns \c true.
 963   ///
 964   /// This allows is to be used in boolean error contexts (where \c true is
 965   /// used to indicate that an error has occurred), like:
 966   /// \code
 967   /// return Diag(...);
 968   /// \endcode
 969   operator bool() const { return true; }
 970
 971   void AddString(StringRef S) const {
 972     assert(isActive() && "Clients must not add to cleared diagnostic!");
 973     assert(NumArgs < DiagnosticsEngine::MaxArguments &&
 974            "Too many arguments to diagnostic!");
 975     DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string;
 976     DiagObj->DiagArgumentsStr[NumArgs++] = S;
 977   }
 978
 979   void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const {
 980     assert(isActive() && "Clients must not add to cleared diagnostic!");
 981     assert(NumArgs < DiagnosticsEngine::MaxArguments &&
 982            "Too many arguments to diagnostic!");
 983     DiagObj->DiagArgumentsKind[NumArgs] = Kind;
 984     DiagObj->DiagArgumentsVal[NumArgs++] = V;
 985   }
 986
 987   void AddSourceRange(const CharSourceRange &R) const {
 988     assert(isActive() && "Clients must not add to cleared diagnostic!");
 989     DiagObj->DiagRanges.push_back(R);
 990   }
 991
 992   void AddFixItHint(const FixItHint &Hint) const {
 993     assert(isActive() && "Clients must not add to cleared diagnostic!");
 994     if (!Hint.isNull())
 995       DiagObj->DiagFixItHints.push_back(Hint);
 996   }
 997
 998   void addFlagValue(StringRef V) const { DiagObj->FlagValue = V; }
 999 };
1000
1001 struct AddFlagValue {
1002   explicit AddFlagValue(StringRef V) : Val(V) {}
1003   StringRef Val;
1004 };
1005
1006 /// \brief Register a value for the flag in the current diagnostic. This
1007 /// value will be shown as the suffix "=value" after the flag name. It is
1008 /// useful in cases where the diagnostic flag accepts values (e.g.,
1009 /// -Rpass or -Wframe-larger-than).
1010 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1011                                            const AddFlagValue V) {
1012   DB.addFlagValue(V.Val);
1013   return DB;
1014 }
1015
1016 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1017                                            StringRef S) {
1018   DB.AddString(S);
1019   return DB;
1020 }
1021
1022 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1023                                            const char *Str) {
1024   DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str),
1025                   DiagnosticsEngine::ak_c_string);
1026   return DB;
1027 }
1028
1029 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) {
1030   DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1031   return DB;
1032 }
1033
1034 // We use enable_if here to prevent that this overload is selected for
1035 // pointers or other arguments that are implicitly convertible to bool.
1036 template <typename T>
1037 inline
1038 typename std::enable_if<std::is_same<T, bool>::value,
1039                         const DiagnosticBuilder &>::type
1040 operator<<(const DiagnosticBuilder &DB, T I) {
1041   DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1042   return DB;
1043 }
1044
1045 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1046                                            unsigned I) {
1047   DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint);
1048   return DB;
1049 }
1050
1051 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1052                                            tok::TokenKind I) {
1053   DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind);
1054   return DB;
1055 }
1056
1057 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1058                                            const IdentifierInfo *II) {
1059   DB.AddTaggedVal(reinterpret_cast<intptr_t>(II),
1060                   DiagnosticsEngine::ak_identifierinfo);
1061   return DB;
1062 }
1063
1064 // Adds a DeclContext to the diagnostic. The enable_if template magic is here
1065 // so that we only match those arguments that are (statically) DeclContexts;
1066 // other arguments that derive from DeclContext (e.g., RecordDecls) will not
1067 // match.
1068 template<typename T>
1069 inline
1070 typename std::enable_if<std::is_same<T, DeclContext>::value,
1071                         const DiagnosticBuilder &>::type
1072 operator<<(const DiagnosticBuilder &DB, T *DC) {
1073   DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC),
1074                   DiagnosticsEngine::ak_declcontext);
1075   return DB;
1076 }
1077
1078 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1079                                            const SourceRange &R) {
1080   DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1081   return DB;
1082 }
1083
1084 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1085                                            ArrayRef<SourceRange> Ranges) {
1086   for (const SourceRange &R: Ranges)
1087     DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1088   return DB;
1089 }
1090
1091 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1092                                            const CharSourceRange &R) {
1093   DB.AddSourceRange(R);
1094   return DB;
1095 }
1096
1097 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1098                                            const FixItHint &Hint) {
1099   DB.AddFixItHint(Hint);
1100   return DB;
1101 }
1102
1103 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1104                                            ArrayRef<FixItHint> Hints) {
1105   for (const FixItHint &Hint : Hints)
1106     DB.AddFixItHint(Hint);
1107   return DB;
1108 }
1109
1110 inline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc,
1111                                                    unsigned DiagID) {
1112   assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!");
1113   CurDiagLoc = Loc;
1114   CurDiagID = DiagID;
1115   FlagValue.clear();
1116   return DiagnosticBuilder(this);
1117 }
1118
1119 inline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) {
1120   return Report(SourceLocation(), DiagID);
1121 }
1122
1123 //===----------------------------------------------------------------------===//
1124 // Diagnostic
1125 //===----------------------------------------------------------------------===//
1126
1127 /// A little helper class (which is basically a smart pointer that forwards
1128 /// info from DiagnosticsEngine) that allows clients to enquire about the
1129 /// currently in-flight diagnostic.
1130 class Diagnostic {
1131   const DiagnosticsEngine *DiagObj;
1132   StringRef StoredDiagMessage;
1133 public:
1134   explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {}
1135   Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
1136     : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
1137
1138   const DiagnosticsEngine *getDiags() const { return DiagObj; }
1139   unsigned getID() const { return DiagObj->CurDiagID; }
1140   const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; }
1141   bool hasSourceManager() const { return DiagObj->hasSourceManager(); }
1142   SourceManager &getSourceManager() const { return DiagObj->getSourceManager();}
1143
1144   unsigned getNumArgs() const { return DiagObj->NumDiagArgs; }
1145
1146   /// \brief Return the kind of the specified index.
1147   ///
1148   /// Based on the kind of argument, the accessors below can be used to get
1149   /// the value.
1150   ///
1151   /// \pre Idx < getNumArgs()
1152   DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const {
1153     assert(Idx < getNumArgs() && "Argument index out of range!");
1154     return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx];
1155   }
1156
1157   /// \brief Return the provided argument string specified by \p Idx.
1158   /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string
1159   const std::string &getArgStdStr(unsigned Idx) const {
1160     assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string &&
1161            "invalid argument accessor!");
1162     return DiagObj->DiagArgumentsStr[Idx];
1163   }
1164
1165   /// \brief Return the specified C string argument.
1166   /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string
1167   const char *getArgCStr(unsigned Idx) const {
1168     assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string &&
1169            "invalid argument accessor!");
1170     return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]);
1171   }
1172
1173   /// \brief Return the specified signed integer argument.
1174   /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint
1175   int getArgSInt(unsigned Idx) const {
1176     assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint &&
1177            "invalid argument accessor!");
1178     return (int)DiagObj->DiagArgumentsVal[Idx];
1179   }
1180
1181   /// \brief Return the specified unsigned integer argument.
1182   /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint
1183   unsigned getArgUInt(unsigned Idx) const {
1184     assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint &&
1185            "invalid argument accessor!");
1186     return (unsigned)DiagObj->DiagArgumentsVal[Idx];
1187   }
1188
1189   /// \brief Return the specified IdentifierInfo argument.
1190   /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo
1191   const IdentifierInfo *getArgIdentifier(unsigned Idx) const {
1192     assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo &&
1193            "invalid argument accessor!");
1194     return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]);
1195   }
1196
1197   /// \brief Return the specified non-string argument in an opaque form.
1198   /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string
1199   intptr_t getRawArg(unsigned Idx) const {
1200     assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string &&
1201            "invalid argument accessor!");
1202     return DiagObj->DiagArgumentsVal[Idx];
1203   }
1204
1205   /// \brief Return the number of source ranges associated with this diagnostic.
1206   unsigned getNumRanges() const {
1207     return DiagObj->DiagRanges.size();
1208   }
1209
1210   /// \pre Idx < getNumRanges()
1211   const CharSourceRange &getRange(unsigned Idx) const {
1212     assert(Idx < getNumRanges() && "Invalid diagnostic range index!");
1213     return DiagObj->DiagRanges[Idx];
1214   }
1215
1216   /// \brief Return an array reference for this diagnostic's ranges.
1217   ArrayRef<CharSourceRange> getRanges() const {
1218     return DiagObj->DiagRanges;
1219   }
1220
1221   unsigned getNumFixItHints() const {
1222     return DiagObj->DiagFixItHints.size();
1223   }
1224
1225   const FixItHint &getFixItHint(unsigned Idx) const {
1226     assert(Idx < getNumFixItHints() && "Invalid index!");
1227     return DiagObj->DiagFixItHints[Idx];
1228   }
1229
1230   ArrayRef<FixItHint> getFixItHints() const {
1231     return DiagObj->DiagFixItHints;
1232   }
1233
1234   /// \brief Format this diagnostic into a string, substituting the
1235   /// formal arguments into the %0 slots.
1236   ///
1237   /// The result is appended onto the \p OutStr array.
1238   void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const;
1239
1240   /// \brief Format the given format-string into the output buffer using the
1241   /// arguments stored in this diagnostic.
1242   void FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
1243                         SmallVectorImpl<char> &OutStr) const;
1244 };
1245
1246 /**
1247  * \brief Represents a diagnostic in a form that can be retained until its
1248  * corresponding source manager is destroyed.
1249  */
1250 class StoredDiagnostic {
1251   unsigned ID;
1252   DiagnosticsEngine::Level Level;
1253   FullSourceLoc Loc;
1254   std::string Message;
1255   std::vector<CharSourceRange> Ranges;
1256   std::vector<FixItHint> FixIts;
1257
1258 public:
1259   StoredDiagnostic();
1260   StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info);
1261   StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1262                    StringRef Message);
1263   StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1264                    StringRef Message, FullSourceLoc Loc,
1265                    ArrayRef<CharSourceRange> Ranges,
1266                    ArrayRef<FixItHint> Fixits);
1267   ~StoredDiagnostic();
1268
1269   /// \brief Evaluates true when this object stores a diagnostic.
1270   explicit operator bool() const { return Message.size() > 0; }
1271
1272   unsigned getID() const { return ID; }
1273   DiagnosticsEngine::Level getLevel() const { return Level; }
1274   const FullSourceLoc &getLocation() const { return Loc; }
1275   StringRef getMessage() const { return Message; }
1276
1277   void setLocation(FullSourceLoc Loc) { this->Loc = Loc; }
1278
1279   typedef std::vector<CharSourceRange>::const_iterator range_iterator;
1280   range_iterator range_begin() const { return Ranges.begin(); }
1281   range_iterator range_end() const { return Ranges.end(); }
1282   unsigned range_size() const { return Ranges.size(); }
1283
1284   ArrayRef<CharSourceRange> getRanges() const {
1285     return llvm::makeArrayRef(Ranges);
1286   }
1287
1288
1289   typedef std::vector<FixItHint>::const_iterator fixit_iterator;
1290   fixit_iterator fixit_begin() const { return FixIts.begin(); }
1291   fixit_iterator fixit_end() const { return FixIts.end(); }
1292   unsigned fixit_size() const { return FixIts.size(); }
1293
1294   ArrayRef<FixItHint> getFixIts() const {
1295     return llvm::makeArrayRef(FixIts);
1296   }
1297 };
1298
1299 /// \brief Abstract interface, implemented by clients of the front-end, which
1300 /// formats and prints fully processed diagnostics.
1301 class DiagnosticConsumer {
1302 protected:
1303   unsigned NumWarnings;       ///< Number of warnings reported
1304   unsigned NumErrors;         ///< Number of errors reported
1305
1306 public:
1307   DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { }
1308
1309   unsigned getNumErrors() const { return NumErrors; }
1310   unsigned getNumWarnings() const { return NumWarnings; }
1311   virtual void clear() { NumWarnings = NumErrors = 0; }
1312
1313   virtual ~DiagnosticConsumer();
1314
1315   /// \brief Callback to inform the diagnostic client that processing
1316   /// of a source file is beginning.
1317   ///
1318   /// Note that diagnostics may be emitted outside the processing of a source
1319   /// file, for example during the parsing of command line options. However,
1320   /// diagnostics with source range information are required to only be emitted
1321   /// in between BeginSourceFile() and EndSourceFile().
1322   ///
1323   /// \param LangOpts The language options for the source file being processed.
1324   /// \param PP The preprocessor object being used for the source; this is
1325   /// optional, e.g., it may not be present when processing AST source files.
1326   virtual void BeginSourceFile(const LangOptions &LangOpts,
1327                                const Preprocessor *PP = nullptr) {}
1328
1329   /// \brief Callback to inform the diagnostic client that processing
1330   /// of a source file has ended.
1331   ///
1332   /// The diagnostic client should assume that any objects made available via
1333   /// BeginSourceFile() are inaccessible.
1334   virtual void EndSourceFile() {}
1335
1336   /// \brief Callback to inform the diagnostic client that processing of all
1337   /// source files has ended.
1338   virtual void finish() {}
1339
1340   /// \brief Indicates whether the diagnostics handled by this
1341   /// DiagnosticConsumer should be included in the number of diagnostics
1342   /// reported by DiagnosticsEngine.
1343   ///
1344   /// The default implementation returns true.
1345   virtual bool IncludeInDiagnosticCounts() const;
1346
1347   /// \brief Handle this diagnostic, reporting it to the user or
1348   /// capturing it to a log as needed.
1349   ///
1350   /// The default implementation just keeps track of the total number of
1351   /// warnings and errors.
1352   virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1353                                 const Diagnostic &Info);
1354 };
1355
1356 /// \brief A diagnostic client that ignores all diagnostics.
1357 class IgnoringDiagConsumer : public DiagnosticConsumer {
1358   virtual void anchor();
1359   void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1360                         const Diagnostic &Info) override {
1361     // Just ignore it.
1362   }
1363 };
1364
1365 /// \brief Diagnostic consumer that forwards diagnostics along to an
1366 /// existing, already-initialized diagnostic consumer.
1367 ///
1368 class ForwardingDiagnosticConsumer : public DiagnosticConsumer {
1369   DiagnosticConsumer &Target;
1370
1371 public:
1372   ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {}
1373
1374   ~ForwardingDiagnosticConsumer() override;
1375
1376   void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1377                         const Diagnostic &Info) override;
1378   void clear() override;
1379
1380   bool IncludeInDiagnosticCounts() const override;
1381 };
1382
1383 // Struct used for sending info about how a type should be printed.
1384 struct TemplateDiffTypes {
1385   intptr_t FromType;
1386   intptr_t ToType;
1387   unsigned PrintTree : 1;
1388   unsigned PrintFromType : 1;
1389   unsigned ElideType : 1;
1390   unsigned ShowColors : 1;
1391   // The printer sets this variable to true if the template diff was used.
1392   unsigned TemplateDiffUsed : 1;
1393 };
1394
1395 /// Special character that the diagnostic printer will use to toggle the bold
1396 /// attribute.  The character itself will be not be printed.
1397 const char ToggleHighlight = 127;
1398
1399
1400 /// ProcessWarningOptions - Initialize the diagnostic client and process the
1401 /// warning options specified on the command line.
1402 void ProcessWarningOptions(DiagnosticsEngine &Diags,
1403                            const DiagnosticOptions &Opts,
1404                            bool ReportDiags = true);
1405
1406 }  // end namespace clang
1407
1408 #endif