1 //===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the Diagnostic-related interfaces.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_DIAGNOSTIC_H
16 #define LLVM_CLANG_DIAGNOSTIC_H
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"
30 class DiagnosticBuilder;
31 class DiagnosticConsumer;
32 class DiagnosticErrorTrap;
33 class DiagnosticOptions;
37 class StoredDiagnostic;
39 enum TokenKind : unsigned short;
42 /// \brief Annotates a diagnostic with some code that should be
43 /// inserted, removed, or replaced to fix the problem.
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
53 /// \brief Code that should be replaced to correct the error. Empty for an
55 CharSourceRange RemoveRange;
57 /// \brief Code in the specific range that should be inserted in the insertion
59 CharSourceRange InsertFromRange;
61 /// \brief The actual code to insert at the insertion location, as a
63 std::string CodeToInsert;
65 bool BeforePreviousInsertions;
67 /// \brief Empty code modification hint, indicating that no code
68 /// modification is known.
69 FixItHint() : BeforePreviousInsertions(false) { }
72 return !RemoveRange.isValid();
75 /// \brief Create a code modification hint that inserts the given
76 /// code string at a specific location.
77 static FixItHint CreateInsertion(SourceLocation InsertionLoc,
79 bool BeforePreviousInsertions = false) {
82 CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
83 Hint.CodeToInsert = Code;
84 Hint.BeforePreviousInsertions = BeforePreviousInsertions;
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) {
95 CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
96 Hint.InsertFromRange = FromRange;
97 Hint.BeforePreviousInsertions = BeforePreviousInsertions;
101 /// \brief Create a code modification hint that removes the given
103 static FixItHint CreateRemoval(CharSourceRange RemoveRange) {
105 Hint.RemoveRange = RemoveRange;
108 static FixItHint CreateRemoval(SourceRange RemoveRange) {
109 return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange));
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,
117 Hint.RemoveRange = RemoveRange;
118 Hint.CodeToInsert = Code;
122 static FixItHint CreateReplacement(SourceRange RemoveRange,
124 return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code);
128 /// \brief Concrete class used by the front-end to report problems and issues.
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
134 class DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> {
135 DiagnosticsEngine(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION;
136 void operator=(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION;
139 /// \brief The level of the diagnostic, after it has been through mapping.
141 Ignored = DiagnosticIDs::Ignored,
142 Note = DiagnosticIDs::Note,
143 Remark = DiagnosticIDs::Remark,
144 Warning = DiagnosticIDs::Warning,
145 Error = DiagnosticIDs::Error,
146 Fatal = DiagnosticIDs::Fatal
150 ak_std_string, ///< std::string
151 ak_c_string, ///< const char *
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>
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;
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,
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;
191 SourceManager *SourceMgr;
193 /// \brief Mapping information for diagnostics.
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.
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
205 llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap;
208 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator;
209 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator
212 void setMapping(diag::kind Diag, DiagnosticMapping Info) {
213 DiagMap[Diag] = Info;
216 DiagnosticMapping &getOrAddMapping(diag::kind Diag);
218 const_iterator begin() const { return DiagMap.begin(); }
219 const_iterator end() const { return DiagMap.end(); }
222 /// \brief Keeps and automatically disposes all DiagStates that we create.
223 std::list<DiagState> DiagStates;
225 /// \brief Represents a point in source where the diagnostic state was
226 /// modified because of a pragma.
228 /// 'Loc' can be null if the point represents the diagnostic state
229 /// modifications done through the command-line.
230 struct DiagStatePoint {
233 DiagStatePoint(DiagState *State, FullSourceLoc Loc)
234 : State(State), Loc(Loc) { }
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())
243 return Loc.isBeforeInTranslationUnitThan(RHS.Loc);
247 /// \brief A sorted vector of all DiagStatePoints representing changes in
248 /// diagnostic state due to diagnostic pragmas.
250 /// The vector is always sorted according to the SourceLocation of the
252 typedef std::vector<DiagStatePoint> DiagStatePointsTy;
253 mutable DiagStatePointsTy DiagStatePoints;
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;
259 DiagState *GetCurDiagState() const {
260 assert(!DiagStatePoints.empty());
261 return DiagStatePoints.back().State;
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));
275 /// \brief Finds the DiagStatePoint that contains the diagnostic state of
276 /// the given source location.
277 DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const;
279 /// \brief Sticky flag set to \c true when an error is emitted.
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;
286 /// \brief Sticky flag set to \c true when a fatal error is emitted.
287 bool FatalErrorOccurred;
289 /// \brief Indicates that an unrecoverable error has occurred.
290 bool UnrecoverableErrorOccurred;
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;
297 /// \brief The level of the last diagnostic emitted.
299 /// This is used to emit continuation diagnostics with the same level as the
300 /// diagnostic that they follow.
301 DiagnosticIDs::Level LastDiagLevel;
303 unsigned NumWarnings; ///< Number of warnings reported
304 unsigned NumErrors; ///< Number of errors reported
305 unsigned NumErrorsSuppressed; ///< Number of errors suppressed
307 /// \brief A function pointer that converts an opaque diagnostic
308 /// argument to a strings.
310 /// This takes the modifiers and argument that was present in the diagnostic.
312 /// The PrevArgs array indicates the previous arguments formatted for this
313 /// diagnostic. Implementations of this function can use this information to
314 /// avoid redundancy across arguments.
316 /// This is a hack to avoid a layering violation between libbasic and libsema.
317 typedef void (*ArgToStringFnTy)(
318 ArgumentKind Kind, intptr_t Val,
319 StringRef Modifier, StringRef Argument,
320 ArrayRef<ArgumentValue> PrevArgs,
321 SmallVectorImpl<char> &Output,
323 ArrayRef<intptr_t> QualTypeVals);
324 void *ArgToStringCookie;
325 ArgToStringFnTy ArgToStringFn;
327 /// \brief ID of the "delayed" diagnostic, which is a (typically
328 /// fatal) diagnostic that had to be delayed because it was found
329 /// while emitting another diagnostic.
330 unsigned DelayedDiagID;
332 /// \brief First string argument for the delayed diagnostic.
333 std::string DelayedDiagArg1;
335 /// \brief Second string argument for the delayed diagnostic.
336 std::string DelayedDiagArg2;
338 /// \brief Optional flag value.
340 /// Some flags accept values, for instance: -Wframe-larger-than=<value> and
341 /// -Rpass=<value>. The content of this string is emitted after the flag name
343 std::string FlagValue;
346 explicit DiagnosticsEngine(
347 const IntrusiveRefCntPtr<DiagnosticIDs> &Diags,
348 DiagnosticOptions *DiagOpts,
349 DiagnosticConsumer *client = nullptr,
350 bool ShouldOwnClient = true);
351 ~DiagnosticsEngine();
353 const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const {
357 /// \brief Retrieve the diagnostic options.
358 DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; }
360 typedef llvm::iterator_range<DiagState::const_iterator> diag_mapping_range;
362 /// \brief Get the current set of diagnostic mappings.
363 diag_mapping_range getDiagnosticMappings() const {
364 const DiagState &DS = *GetCurDiagState();
365 return diag_mapping_range(DS.begin(), DS.end());
368 DiagnosticConsumer *getClient() { return Client; }
369 const DiagnosticConsumer *getClient() const { return Client; }
371 /// \brief Determine whether this \c DiagnosticsEngine object own its client.
372 bool ownsClient() const { return OwnsDiagClient; }
374 /// \brief Return the current diagnostic client along with ownership of that
376 DiagnosticConsumer *takeClient() {
377 OwnsDiagClient = false;
381 bool hasSourceManager() const { return SourceMgr != nullptr; }
382 SourceManager &getSourceManager() const {
383 assert(SourceMgr && "SourceManager not set!");
386 void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; }
388 //===--------------------------------------------------------------------===//
389 // DiagnosticsEngine characterization methods, used by a client to customize
390 // how diagnostics are emitted.
393 /// \brief Copies the current DiagMappings and pushes the new copy
394 /// onto the top of the stack.
395 void pushMappings(SourceLocation Loc);
397 /// \brief Pops the current DiagMappings off the top of the stack,
398 /// causing the new top of the stack to be the active mappings.
400 /// \returns \c true if the pop happens, \c false if there is only one
401 /// DiagMapping on the stack.
402 bool popMappings(SourceLocation Loc);
404 /// \brief Set the diagnostic client associated with this diagnostic object.
406 /// \param ShouldOwnClient true if the diagnostic object should take
407 /// ownership of \c client.
408 void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true);
410 /// \brief Specify a limit for the number of errors we should
411 /// emit before giving up.
413 /// Zero disables the limit.
414 void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; }
416 /// \brief Specify the maximum number of template instantiation
417 /// notes to emit along with a given diagnostic.
418 void setTemplateBacktraceLimit(unsigned Limit) {
419 TemplateBacktraceLimit = Limit;
422 /// \brief Retrieve the maximum number of template instantiation
423 /// notes to emit along with a given diagnostic.
424 unsigned getTemplateBacktraceLimit() const {
425 return TemplateBacktraceLimit;
428 /// \brief Specify the maximum number of constexpr evaluation
429 /// notes to emit along with a given diagnostic.
430 void setConstexprBacktraceLimit(unsigned Limit) {
431 ConstexprBacktraceLimit = Limit;
434 /// \brief Retrieve the maximum number of constexpr evaluation
435 /// notes to emit along with a given diagnostic.
436 unsigned getConstexprBacktraceLimit() const {
437 return ConstexprBacktraceLimit;
440 /// \brief When set to true, any unmapped warnings are ignored.
442 /// If this and WarningsAsErrors are both set, then this one wins.
443 void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; }
444 bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; }
446 /// \brief When set to true, any unmapped ignored warnings are no longer
449 /// If this and IgnoreAllWarnings are both set, then that one wins.
450 void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; }
451 bool getEnableAllWarnings() const { return EnableAllWarnings; }
453 /// \brief When set to true, any warnings reported are issued as errors.
454 void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; }
455 bool getWarningsAsErrors() const { return WarningsAsErrors; }
457 /// \brief When set to true, any error reported is made a fatal error.
458 void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; }
459 bool getErrorsAsFatal() const { return ErrorsAsFatal; }
461 /// \brief When set to true mask warnings that come from system headers.
462 void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; }
463 bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; }
465 /// \brief Suppress all diagnostics, to silence the front end when we
466 /// know that we don't want any more diagnostics to be passed along to the
468 void setSuppressAllDiagnostics(bool Val = true) {
469 SuppressAllDiagnostics = Val;
471 bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; }
473 /// \brief Set type eliding, to skip outputting same types occurring in
475 void setElideType(bool Val = true) { ElideType = Val; }
476 bool getElideType() { return ElideType; }
478 /// \brief Set tree printing, to outputting the template difference in a
480 void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; }
481 bool getPrintTemplateTree() { return PrintTemplateTree; }
483 /// \brief Set color printing, so the type diffing will inject color markers
485 void setShowColors(bool Val = false) { ShowColors = Val; }
486 bool getShowColors() { return ShowColors; }
488 /// \brief Specify which overload candidates to show when overload resolution
491 /// By default, we show all candidates.
492 void setShowOverloads(OverloadsShown Val) {
495 OverloadsShown getShowOverloads() const { return ShowOverloads; }
497 /// \brief Pretend that the last diagnostic issued was ignored, so any
498 /// subsequent notes will be suppressed.
500 /// This can be used by clients who suppress diagnostics themselves.
501 void setLastDiagnosticIgnored() {
502 if (LastDiagLevel == DiagnosticIDs::Fatal)
503 FatalErrorOccurred = true;
504 LastDiagLevel = DiagnosticIDs::Ignored;
507 /// \brief Determine whether the previous diagnostic was ignored. This can
508 /// be used by clients that want to determine whether notes attached to a
509 /// diagnostic will be suppressed.
510 bool isLastDiagnosticIgnored() const {
511 return LastDiagLevel == DiagnosticIDs::Ignored;
514 /// \brief Controls whether otherwise-unmapped extension diagnostics are
515 /// mapped onto ignore/warning/error.
517 /// This corresponds to the GCC -pedantic and -pedantic-errors option.
518 void setExtensionHandlingBehavior(diag::Severity H) { ExtBehavior = H; }
519 diag::Severity getExtensionHandlingBehavior() const { return ExtBehavior; }
521 /// \brief Counter bumped when an __extension__ block is/ encountered.
523 /// When non-zero, all extension diagnostics are entirely silenced, no
524 /// matter how they are mapped.
525 void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; }
526 void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; }
527 bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; }
529 /// \brief This allows the client to specify that certain warnings are
532 /// Notes can never be mapped, errors can only be mapped to fatal, and
533 /// WARNINGs and EXTENSIONs can be mapped arbitrarily.
535 /// \param Loc The source location that this change of diagnostic state should
536 /// take affect. It can be null if we are setting the latest state.
537 void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc);
539 /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to
540 /// have the specified mapping.
542 /// \returns true (and ignores the request) if "Group" was unknown, false
545 /// \param Flavor The flavor of group to affect. -Rfoo does not affect the
546 /// state of the -Wfoo group and vice versa.
548 /// \param Loc The source location that this change of diagnostic state should
549 /// take affect. It can be null if we are setting the state from command-line.
550 bool setSeverityForGroup(diag::Flavor Flavor, StringRef Group,
552 SourceLocation Loc = SourceLocation());
554 /// \brief Set the warning-as-error flag for the given diagnostic group.
556 /// This function always only operates on the current diagnostic state.
558 /// \returns True if the given group is unknown, false otherwise.
559 bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled);
561 /// \brief Set the error-as-fatal flag for the given diagnostic group.
563 /// This function always only operates on the current diagnostic state.
565 /// \returns True if the given group is unknown, false otherwise.
566 bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled);
568 /// \brief Add the specified mapping to all diagnostics of the specified
571 /// Mainly to be used by -Wno-everything to disable all warnings but allow
572 /// subsequent -W options to enable specific warnings.
573 void setSeverityForAll(diag::Flavor Flavor, diag::Severity Map,
574 SourceLocation Loc = SourceLocation());
576 bool hasErrorOccurred() const { return ErrorOccurred; }
578 /// \brief Errors that actually prevent compilation, not those that are
579 /// upgraded from a warning by -Werror.
580 bool hasUncompilableErrorOccurred() const {
581 return UncompilableErrorOccurred;
583 bool hasFatalErrorOccurred() const { return FatalErrorOccurred; }
585 /// \brief Determine whether any kind of unrecoverable error has occurred.
586 bool hasUnrecoverableErrorOccurred() const {
587 return FatalErrorOccurred || UnrecoverableErrorOccurred;
590 unsigned getNumWarnings() const { return NumWarnings; }
592 void setNumWarnings(unsigned NumWarnings) {
593 this->NumWarnings = NumWarnings;
596 /// \brief Return an ID for a diagnostic with the specified format string and
599 /// If this is the first request for this diagnostic, it is registered and
600 /// created, otherwise the existing ID is returned.
602 /// \param FormatString A fixed diagnostic format string that will be hashed
603 /// and mapped to a unique DiagID.
604 template <unsigned N>
605 unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) {
606 return Diags->getCustomDiagID((DiagnosticIDs::Level)L,
607 StringRef(FormatString, N - 1));
610 /// \brief Converts a diagnostic argument (as an intptr_t) into the string
611 /// that represents it.
612 void ConvertArgToString(ArgumentKind Kind, intptr_t Val,
613 StringRef Modifier, StringRef Argument,
614 ArrayRef<ArgumentValue> PrevArgs,
615 SmallVectorImpl<char> &Output,
616 ArrayRef<intptr_t> QualTypeVals) const {
617 ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output,
618 ArgToStringCookie, QualTypeVals);
621 void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) {
623 ArgToStringCookie = Cookie;
626 /// \brief Note that the prior diagnostic was emitted by some other
627 /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic.
628 void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) {
629 LastDiagLevel = Other.LastDiagLevel;
632 /// \brief Reset the state of the diagnostic object to its initial
636 //===--------------------------------------------------------------------===//
637 // DiagnosticsEngine classification and reporting interfaces.
640 /// \brief Determine whether the diagnostic is known to be ignored.
642 /// This can be used to opportunistically avoid expensive checks when it's
643 /// known for certain that the diagnostic has been suppressed at the
644 /// specified location \p Loc.
646 /// \param Loc The source location we are interested in finding out the
647 /// diagnostic state. Can be null in order to query the latest state.
648 bool isIgnored(unsigned DiagID, SourceLocation Loc) const {
649 return Diags->getDiagnosticSeverity(DiagID, Loc, *this) ==
650 diag::Severity::Ignored;
653 /// \brief Based on the way the client configured the DiagnosticsEngine
654 /// object, classify the specified diagnostic ID into a Level, consumable by
655 /// the DiagnosticConsumer.
657 /// To preserve invariant assumptions, this function should not be used to
658 /// influence parse or semantic analysis actions. Instead consider using
661 /// \param Loc The source location we are interested in finding out the
662 /// diagnostic state. Can be null in order to query the latest state.
663 Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const {
664 return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this);
667 /// \brief Issue the message to the client.
669 /// This actually returns an instance of DiagnosticBuilder which emits the
670 /// diagnostics (through @c ProcessDiag) when it is destroyed.
672 /// \param DiagID A member of the @c diag::kind enum.
673 /// \param Loc Represents the source location associated with the diagnostic,
674 /// which can be an invalid location if no position information is available.
675 inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID);
676 inline DiagnosticBuilder Report(unsigned DiagID);
678 void Report(const StoredDiagnostic &storedDiag);
680 /// \brief Determine whethere there is already a diagnostic in flight.
681 bool isDiagnosticInFlight() const { return CurDiagID != ~0U; }
683 /// \brief Set the "delayed" diagnostic that will be emitted once
684 /// the current diagnostic completes.
686 /// If a diagnostic is already in-flight but the front end must
687 /// report a problem (e.g., with an inconsistent file system
688 /// state), this routine sets a "delayed" diagnostic that will be
689 /// emitted after the current diagnostic completes. This should
690 /// only be used for fatal errors detected at inconvenient
691 /// times. If emitting a delayed diagnostic causes a second delayed
692 /// diagnostic to be introduced, that second delayed diagnostic
695 /// \param DiagID The ID of the diagnostic being delayed.
697 /// \param Arg1 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.
701 /// \param Arg2 A string argument that will be provided to the
702 /// diagnostic. A copy of this string will be stored in the
703 /// DiagnosticsEngine object itself.
704 void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "",
705 StringRef Arg2 = "");
707 /// \brief Clear out the current diagnostic.
708 void Clear() { CurDiagID = ~0U; }
710 /// \brief Return the value associated with this diagnostic flag.
711 StringRef getFlagValue() const { return FlagValue; }
714 /// \brief Report the delayed diagnostic.
715 void ReportDelayed();
717 // This is private state used by DiagnosticBuilder. We put it here instead of
718 // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight
719 // object. This implementation choice means that we can only have one
720 // diagnostic "in flight" at a time, but this seems to be a reasonable
721 // tradeoff to keep these objects small. Assertions verify that only one
722 // diagnostic is in flight at a time.
723 friend class DiagnosticIDs;
724 friend class DiagnosticBuilder;
725 friend class Diagnostic;
726 friend class PartialDiagnostic;
727 friend class DiagnosticErrorTrap;
729 /// \brief The location of the current diagnostic that is in flight.
730 SourceLocation CurDiagLoc;
732 /// \brief The ID of the current diagnostic that is in flight.
734 /// This is set to ~0U when there is no diagnostic in flight.
738 /// \brief The maximum number of arguments we can hold.
740 /// We currently only support up to 10 arguments (%0-%9). A single
741 /// diagnostic with more than that almost certainly has to be simplified
746 /// \brief The number of entries in Arguments.
747 signed char NumDiagArgs;
749 /// \brief Specifies whether an argument is in DiagArgumentsStr or
750 /// in DiagArguments.
752 /// This is an array of ArgumentKind::ArgumentKind enum values, one for each
754 unsigned char DiagArgumentsKind[MaxArguments];
756 /// \brief Holds the values of each string argument for the current
759 /// This is only used when the corresponding ArgumentKind is ak_std_string.
760 std::string DiagArgumentsStr[MaxArguments];
762 /// \brief The values for the various substitution positions.
764 /// This is used when the argument is not an std::string. The specific
765 /// value is mangled into an intptr_t and the interpretation depends on
766 /// exactly what sort of argument kind it is.
767 intptr_t DiagArgumentsVal[MaxArguments];
769 /// \brief The list of ranges added to this diagnostic.
770 SmallVector<CharSourceRange, 8> DiagRanges;
772 /// \brief If valid, provides a hint with some code to insert, remove,
773 /// or modify at a particular position.
774 SmallVector<FixItHint, 8> DiagFixItHints;
776 DiagnosticMapping makeUserMapping(diag::Severity Map, SourceLocation L) {
777 bool isPragma = L.isValid();
778 DiagnosticMapping Mapping =
779 DiagnosticMapping::Make(Map, /*IsUser=*/true, isPragma);
781 // If this is a pragma mapping, then set the diagnostic mapping flags so
782 // that we override command line options.
784 Mapping.setNoWarningAsError(true);
785 Mapping.setNoErrorAsFatal(true);
791 /// \brief Used to report a diagnostic that is finally fully formed.
793 /// \returns true if the diagnostic was emitted, false if it was suppressed.
795 return Diags->ProcessDiag(*this);
798 /// @name Diagnostic Emission
801 // Sema requires access to the following functions because the current design
802 // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to
803 // access us directly to ensure we minimize the emitted code for the common
804 // Sema::Diag() patterns.
807 /// \brief Emit the current diagnostic and clear the diagnostic state.
809 /// \param Force Emit the diagnostic regardless of suppression settings.
810 bool EmitCurrentDiagnostic(bool Force = false);
812 unsigned getCurrentDiagID() const { return CurDiagID; }
814 SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; }
818 friend class ASTReader;
819 friend class ASTWriter;
822 /// \brief RAII class that determines when any errors have occurred
823 /// between the time the instance was created and the time it was
825 class DiagnosticErrorTrap {
826 DiagnosticsEngine &Diag;
828 unsigned NumUnrecoverableErrors;
831 explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag)
832 : Diag(Diag) { reset(); }
834 /// \brief Determine whether any errors have occurred since this
835 /// object instance was created.
836 bool hasErrorOccurred() const {
837 return Diag.TrapNumErrorsOccurred > NumErrors;
840 /// \brief Determine whether any unrecoverable errors have occurred since this
841 /// object instance was created.
842 bool hasUnrecoverableErrorOccurred() const {
843 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
846 /// \brief Set to initial state of "no errors occurred".
848 NumErrors = Diag.TrapNumErrorsOccurred;
849 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
853 //===----------------------------------------------------------------------===//
855 //===----------------------------------------------------------------------===//
857 /// \brief A little helper class used to produce diagnostics.
859 /// This is constructed by the DiagnosticsEngine::Report method, and
860 /// allows insertion of extra information (arguments and source ranges) into
861 /// the currently "in flight" diagnostic. When the temporary for the builder
862 /// is destroyed, the diagnostic is issued.
864 /// Note that many of these will be created as temporary objects (many call
865 /// sites), so we want them to be small and we never want their address taken.
866 /// This ensures that compilers with somewhat reasonable optimizers will promote
867 /// the common fields to registers, eliminating increments of the NumArgs field,
869 class DiagnosticBuilder {
870 mutable DiagnosticsEngine *DiagObj;
871 mutable unsigned NumArgs;
873 /// \brief Status variable indicating if this diagnostic is still active.
875 // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)),
876 // but LLVM is not currently smart enough to eliminate the null check that
877 // Emit() would end up with if we used that as our status variable.
878 mutable bool IsActive;
880 /// \brief Flag indicating that this diagnostic is being emitted via a
881 /// call to ForceEmit.
882 mutable bool IsForceEmit;
884 void operator=(const DiagnosticBuilder &) LLVM_DELETED_FUNCTION;
885 friend class DiagnosticsEngine;
888 : DiagObj(nullptr), NumArgs(0), IsActive(false), IsForceEmit(false) {}
890 explicit DiagnosticBuilder(DiagnosticsEngine *diagObj)
891 : DiagObj(diagObj), NumArgs(0), IsActive(true), IsForceEmit(false) {
892 assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!");
893 diagObj->DiagRanges.clear();
894 diagObj->DiagFixItHints.clear();
897 friend class PartialDiagnostic;
901 DiagObj->NumDiagArgs = NumArgs;
904 /// \brief Clear out the current diagnostic.
911 /// \brief Determine whether this diagnostic is still active.
912 bool isActive() const { return IsActive; }
914 /// \brief Force the diagnostic builder to emit the diagnostic now.
916 /// Once this function has been called, the DiagnosticBuilder object
917 /// should not be used again before it is destroyed.
919 /// \returns true if a diagnostic was emitted, false if the
920 /// diagnostic was suppressed.
922 // If this diagnostic is inactive, then its soul was stolen by the copy ctor
923 // (or by a subclass, as in SemaDiagnosticBuilder).
924 if (!isActive()) return false;
926 // When emitting diagnostics, we set the final argument count into
927 // the DiagnosticsEngine object.
930 // Process the diagnostic.
931 bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit);
933 // This diagnostic is dead.
940 /// Copy constructor. When copied, this "takes" the diagnostic info from the
941 /// input and neuters it.
942 DiagnosticBuilder(const DiagnosticBuilder &D) {
944 IsActive = D.IsActive;
945 IsForceEmit = D.IsForceEmit;
950 /// \brief Retrieve an empty diagnostic builder.
951 static DiagnosticBuilder getEmpty() {
952 return DiagnosticBuilder();
955 /// \brief Emits the diagnostic.
956 ~DiagnosticBuilder() {
960 /// \brief Forces the diagnostic to be emitted.
961 const DiagnosticBuilder &setForceEmit() const {
966 /// \brief Conversion of DiagnosticBuilder to bool always returns \c true.
968 /// This allows is to be used in boolean error contexts (where \c true is
969 /// used to indicate that an error has occurred), like:
971 /// return Diag(...);
973 operator bool() const { return true; }
975 void AddString(StringRef S) const {
976 assert(isActive() && "Clients must not add to cleared diagnostic!");
977 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
978 "Too many arguments to diagnostic!");
979 DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string;
980 DiagObj->DiagArgumentsStr[NumArgs++] = S;
983 void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const {
984 assert(isActive() && "Clients must not add to cleared diagnostic!");
985 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
986 "Too many arguments to diagnostic!");
987 DiagObj->DiagArgumentsKind[NumArgs] = Kind;
988 DiagObj->DiagArgumentsVal[NumArgs++] = V;
991 void AddSourceRange(const CharSourceRange &R) const {
992 assert(isActive() && "Clients must not add to cleared diagnostic!");
993 DiagObj->DiagRanges.push_back(R);
996 void AddFixItHint(const FixItHint &Hint) const {
997 assert(isActive() && "Clients must not add to cleared diagnostic!");
998 DiagObj->DiagFixItHints.push_back(Hint);
1001 void addFlagValue(StringRef V) const { DiagObj->FlagValue = V; }
1004 struct AddFlagValue {
1005 explicit AddFlagValue(StringRef V) : Val(V) {}
1009 /// \brief Register a value for the flag in the current diagnostic. This
1010 /// value will be shown as the suffix "=value" after the flag name. It is
1011 /// useful in cases where the diagnostic flag accepts values (e.g.,
1012 /// -Rpass or -Wframe-larger-than).
1013 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1014 const AddFlagValue V) {
1015 DB.addFlagValue(V.Val);
1019 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1025 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1027 DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str),
1028 DiagnosticsEngine::ak_c_string);
1032 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) {
1033 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1037 // We use enable_if here to prevent that this overload is selected for
1038 // pointers or other arguments that are implicitly convertible to bool.
1039 template <typename T>
1041 typename std::enable_if<std::is_same<T, bool>::value,
1042 const DiagnosticBuilder &>::type
1043 operator<<(const DiagnosticBuilder &DB, T I) {
1044 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1048 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1050 DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint);
1054 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1056 DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind);
1060 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1061 const IdentifierInfo *II) {
1062 DB.AddTaggedVal(reinterpret_cast<intptr_t>(II),
1063 DiagnosticsEngine::ak_identifierinfo);
1067 // Adds a DeclContext to the diagnostic. The enable_if template magic is here
1068 // so that we only match those arguments that are (statically) DeclContexts;
1069 // other arguments that derive from DeclContext (e.g., RecordDecls) will not
1071 template<typename T>
1073 typename std::enable_if<std::is_same<T, DeclContext>::value,
1074 const DiagnosticBuilder &>::type
1075 operator<<(const DiagnosticBuilder &DB, T *DC) {
1076 DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC),
1077 DiagnosticsEngine::ak_declcontext);
1081 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1082 const SourceRange &R) {
1083 DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1087 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1088 ArrayRef<SourceRange> Ranges) {
1089 for (const SourceRange &R: Ranges)
1090 DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1094 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1095 const CharSourceRange &R) {
1096 DB.AddSourceRange(R);
1100 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1101 const FixItHint &Hint) {
1103 DB.AddFixItHint(Hint);
1107 inline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc,
1109 assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!");
1113 return DiagnosticBuilder(this);
1116 inline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) {
1117 return Report(SourceLocation(), DiagID);
1120 //===----------------------------------------------------------------------===//
1122 //===----------------------------------------------------------------------===//
1124 /// A little helper class (which is basically a smart pointer that forwards
1125 /// info from DiagnosticsEngine) that allows clients to enquire about the
1126 /// currently in-flight diagnostic.
1128 const DiagnosticsEngine *DiagObj;
1129 StringRef StoredDiagMessage;
1131 explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {}
1132 Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
1133 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
1135 const DiagnosticsEngine *getDiags() const { return DiagObj; }
1136 unsigned getID() const { return DiagObj->CurDiagID; }
1137 const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; }
1138 bool hasSourceManager() const { return DiagObj->hasSourceManager(); }
1139 SourceManager &getSourceManager() const { return DiagObj->getSourceManager();}
1141 unsigned getNumArgs() const { return DiagObj->NumDiagArgs; }
1143 /// \brief Return the kind of the specified index.
1145 /// Based on the kind of argument, the accessors below can be used to get
1148 /// \pre Idx < getNumArgs()
1149 DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const {
1150 assert(Idx < getNumArgs() && "Argument index out of range!");
1151 return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx];
1154 /// \brief Return the provided argument string specified by \p Idx.
1155 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string
1156 const std::string &getArgStdStr(unsigned Idx) const {
1157 assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string &&
1158 "invalid argument accessor!");
1159 return DiagObj->DiagArgumentsStr[Idx];
1162 /// \brief Return the specified C string argument.
1163 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string
1164 const char *getArgCStr(unsigned Idx) const {
1165 assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string &&
1166 "invalid argument accessor!");
1167 return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]);
1170 /// \brief Return the specified signed integer argument.
1171 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint
1172 int getArgSInt(unsigned Idx) const {
1173 assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint &&
1174 "invalid argument accessor!");
1175 return (int)DiagObj->DiagArgumentsVal[Idx];
1178 /// \brief Return the specified unsigned integer argument.
1179 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint
1180 unsigned getArgUInt(unsigned Idx) const {
1181 assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint &&
1182 "invalid argument accessor!");
1183 return (unsigned)DiagObj->DiagArgumentsVal[Idx];
1186 /// \brief Return the specified IdentifierInfo argument.
1187 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo
1188 const IdentifierInfo *getArgIdentifier(unsigned Idx) const {
1189 assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo &&
1190 "invalid argument accessor!");
1191 return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]);
1194 /// \brief Return the specified non-string argument in an opaque form.
1195 /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string
1196 intptr_t getRawArg(unsigned Idx) const {
1197 assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string &&
1198 "invalid argument accessor!");
1199 return DiagObj->DiagArgumentsVal[Idx];
1202 /// \brief Return the number of source ranges associated with this diagnostic.
1203 unsigned getNumRanges() const {
1204 return DiagObj->DiagRanges.size();
1207 /// \pre Idx < getNumRanges()
1208 const CharSourceRange &getRange(unsigned Idx) const {
1209 assert(Idx < getNumRanges() && "Invalid diagnostic range index!");
1210 return DiagObj->DiagRanges[Idx];
1213 /// \brief Return an array reference for this diagnostic's ranges.
1214 ArrayRef<CharSourceRange> getRanges() const {
1215 return DiagObj->DiagRanges;
1218 unsigned getNumFixItHints() const {
1219 return DiagObj->DiagFixItHints.size();
1222 const FixItHint &getFixItHint(unsigned Idx) const {
1223 assert(Idx < getNumFixItHints() && "Invalid index!");
1224 return DiagObj->DiagFixItHints[Idx];
1227 ArrayRef<FixItHint> getFixItHints() const {
1228 return DiagObj->DiagFixItHints;
1231 /// \brief Format this diagnostic into a string, substituting the
1232 /// formal arguments into the %0 slots.
1234 /// The result is appended onto the \p OutStr array.
1235 void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const;
1237 /// \brief Format the given format-string into the output buffer using the
1238 /// arguments stored in this diagnostic.
1239 void FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
1240 SmallVectorImpl<char> &OutStr) const;
1244 * \brief Represents a diagnostic in a form that can be retained until its
1245 * corresponding source manager is destroyed.
1247 class StoredDiagnostic {
1249 DiagnosticsEngine::Level Level;
1251 std::string Message;
1252 std::vector<CharSourceRange> Ranges;
1253 std::vector<FixItHint> FixIts;
1257 StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info);
1258 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1260 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1261 StringRef Message, FullSourceLoc Loc,
1262 ArrayRef<CharSourceRange> Ranges,
1263 ArrayRef<FixItHint> Fixits);
1264 ~StoredDiagnostic();
1266 /// \brief Evaluates true when this object stores a diagnostic.
1267 LLVM_EXPLICIT operator bool() const { return Message.size() > 0; }
1269 unsigned getID() const { return ID; }
1270 DiagnosticsEngine::Level getLevel() const { return Level; }
1271 const FullSourceLoc &getLocation() const { return Loc; }
1272 StringRef getMessage() const { return Message; }
1274 void setLocation(FullSourceLoc Loc) { this->Loc = Loc; }
1276 typedef std::vector<CharSourceRange>::const_iterator range_iterator;
1277 range_iterator range_begin() const { return Ranges.begin(); }
1278 range_iterator range_end() const { return Ranges.end(); }
1279 unsigned range_size() const { return Ranges.size(); }
1281 ArrayRef<CharSourceRange> getRanges() const {
1282 return llvm::makeArrayRef(Ranges);
1286 typedef std::vector<FixItHint>::const_iterator fixit_iterator;
1287 fixit_iterator fixit_begin() const { return FixIts.begin(); }
1288 fixit_iterator fixit_end() const { return FixIts.end(); }
1289 unsigned fixit_size() const { return FixIts.size(); }
1291 ArrayRef<FixItHint> getFixIts() const {
1292 return llvm::makeArrayRef(FixIts);
1296 /// \brief Abstract interface, implemented by clients of the front-end, which
1297 /// formats and prints fully processed diagnostics.
1298 class DiagnosticConsumer {
1300 unsigned NumWarnings; ///< Number of warnings reported
1301 unsigned NumErrors; ///< Number of errors reported
1304 DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { }
1306 unsigned getNumErrors() const { return NumErrors; }
1307 unsigned getNumWarnings() const { return NumWarnings; }
1308 virtual void clear() { NumWarnings = NumErrors = 0; }
1310 virtual ~DiagnosticConsumer();
1312 /// \brief Callback to inform the diagnostic client that processing
1313 /// of a source file is beginning.
1315 /// Note that diagnostics may be emitted outside the processing of a source
1316 /// file, for example during the parsing of command line options. However,
1317 /// diagnostics with source range information are required to only be emitted
1318 /// in between BeginSourceFile() and EndSourceFile().
1320 /// \param LangOpts The language options for the source file being processed.
1321 /// \param PP The preprocessor object being used for the source; this is
1322 /// optional, e.g., it may not be present when processing AST source files.
1323 virtual void BeginSourceFile(const LangOptions &LangOpts,
1324 const Preprocessor *PP = nullptr) {}
1326 /// \brief Callback to inform the diagnostic client that processing
1327 /// of a source file has ended.
1329 /// The diagnostic client should assume that any objects made available via
1330 /// BeginSourceFile() are inaccessible.
1331 virtual void EndSourceFile() {}
1333 /// \brief Callback to inform the diagnostic client that processing of all
1334 /// source files has ended.
1335 virtual void finish() {}
1337 /// \brief Indicates whether the diagnostics handled by this
1338 /// DiagnosticConsumer should be included in the number of diagnostics
1339 /// reported by DiagnosticsEngine.
1341 /// The default implementation returns true.
1342 virtual bool IncludeInDiagnosticCounts() const;
1344 /// \brief Handle this diagnostic, reporting it to the user or
1345 /// capturing it to a log as needed.
1347 /// The default implementation just keeps track of the total number of
1348 /// warnings and errors.
1349 virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1350 const Diagnostic &Info);
1353 /// \brief A diagnostic client that ignores all diagnostics.
1354 class IgnoringDiagConsumer : public DiagnosticConsumer {
1355 virtual void anchor();
1356 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1357 const Diagnostic &Info) override {
1362 /// \brief Diagnostic consumer that forwards diagnostics along to an
1363 /// existing, already-initialized diagnostic consumer.
1365 class ForwardingDiagnosticConsumer : public DiagnosticConsumer {
1366 DiagnosticConsumer &Target;
1369 ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {}
1371 virtual ~ForwardingDiagnosticConsumer();
1373 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1374 const Diagnostic &Info) override;
1375 void clear() override;
1377 bool IncludeInDiagnosticCounts() const override;
1380 // Struct used for sending info about how a type should be printed.
1381 struct TemplateDiffTypes {
1384 unsigned PrintTree : 1;
1385 unsigned PrintFromType : 1;
1386 unsigned ElideType : 1;
1387 unsigned ShowColors : 1;
1388 // The printer sets this variable to true if the template diff was used.
1389 unsigned TemplateDiffUsed : 1;
1392 /// Special character that the diagnostic printer will use to toggle the bold
1393 /// attribute. The character itself will be not be printed.
1394 const char ToggleHighlight = 127;
1397 /// ProcessWarningOptions - Initialize the diagnostic client and process the
1398 /// warning options specified on the command line.
1399 void ProcessWarningOptions(DiagnosticsEngine &Diags,
1400 const DiagnosticOptions &Opts,
1401 bool ReportDiags = true);
1403 } // end namespace clang