1 //===- Diagnostic.h - C Language Family Diagnostic Handling -----*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
10 /// Defines the Diagnostic-related interfaces.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_BASIC_DIAGNOSTIC_H
15 #define LLVM_CLANG_BASIC_DIAGNOSTIC_H
17 #include "clang/Basic/DiagnosticIDs.h"
18 #include "clang/Basic/DiagnosticOptions.h"
19 #include "clang/Basic/SourceLocation.h"
20 #include "clang/Basic/Specifiers.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/IntrusiveRefCntPtr.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/ADT/iterator_range.h"
27 #include "llvm/Support/Compiler.h"
28 #include "llvm/Support/Error.h"
36 #include <type_traits>
43 class DiagnosticBuilder;
44 class DiagnosticConsumer;
49 class StoredDiagnostic;
53 enum TokenKind : unsigned short;
57 /// Annotates a diagnostic with some code that should be
58 /// inserted, removed, or replaced to fix the problem.
60 /// This kind of hint should be used when we are certain that the
61 /// introduction, removal, or modification of a particular (small!)
62 /// amount of code will correct a compilation error. The compiler
63 /// should also provide full recovery from such errors, such that
64 /// suppressing the diagnostic output can still result in successful
68 /// Code that should be replaced to correct the error. Empty for an
70 CharSourceRange RemoveRange;
72 /// Code in the specific range that should be inserted in the insertion
74 CharSourceRange InsertFromRange;
76 /// The actual code to insert at the insertion location, as a
78 std::string CodeToInsert;
80 bool BeforePreviousInsertions = false;
82 /// Empty code modification hint, indicating that no code
83 /// modification is known.
84 FixItHint() = default;
87 return !RemoveRange.isValid();
90 /// Create a code modification hint that inserts the given
91 /// code string at a specific location.
92 static FixItHint CreateInsertion(SourceLocation InsertionLoc,
94 bool BeforePreviousInsertions = false) {
97 CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
98 Hint.CodeToInsert = Code;
99 Hint.BeforePreviousInsertions = BeforePreviousInsertions;
103 /// Create a code modification hint that inserts the given
104 /// code from \p FromRange at a specific location.
105 static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc,
106 CharSourceRange FromRange,
107 bool BeforePreviousInsertions = false) {
110 CharSourceRange::getCharRange(InsertionLoc, InsertionLoc);
111 Hint.InsertFromRange = FromRange;
112 Hint.BeforePreviousInsertions = BeforePreviousInsertions;
116 /// Create a code modification hint that removes the given
118 static FixItHint CreateRemoval(CharSourceRange RemoveRange) {
120 Hint.RemoveRange = RemoveRange;
123 static FixItHint CreateRemoval(SourceRange RemoveRange) {
124 return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange));
127 /// Create a code modification hint that replaces the given
128 /// source range with the given code string.
129 static FixItHint CreateReplacement(CharSourceRange RemoveRange,
132 Hint.RemoveRange = RemoveRange;
133 Hint.CodeToInsert = Code;
137 static FixItHint CreateReplacement(SourceRange RemoveRange,
139 return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code);
143 /// Concrete class used by the front-end to report problems and issues.
145 /// This massages the diagnostics (e.g. handling things like "report warnings
146 /// as errors" and passes them off to the DiagnosticConsumer for reporting to
147 /// the user. DiagnosticsEngine is tied to one translation unit and one
149 class DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> {
151 /// The level of the diagnostic, after it has been through mapping.
153 Ignored = DiagnosticIDs::Ignored,
154 Note = DiagnosticIDs::Note,
155 Remark = DiagnosticIDs::Remark,
156 Warning = DiagnosticIDs::Warning,
157 Error = DiagnosticIDs::Error,
158 Fatal = DiagnosticIDs::Fatal
174 /// enum TokenKind : unsigned
192 /// NestedNameSpecifier *
198 /// pair<QualType, QualType>
205 /// Represents on argument value, which is a union discriminated
206 /// by ArgumentKind, with a value.
207 using ArgumentValue = std::pair<ArgumentKind, intptr_t>;
210 // Used by __extension__
211 unsigned char AllExtensionsSilenced = 0;
213 // Treat fatal errors like errors.
214 bool FatalsAsError = false;
216 // Suppress all diagnostics.
217 bool SuppressAllDiagnostics = false;
219 // Elide common types of templates.
220 bool ElideType = true;
222 // Print a tree when comparing templates.
223 bool PrintTemplateTree = false;
225 // Color printing is enabled.
226 bool ShowColors = false;
228 // Which overload candidates to show.
229 OverloadsShown ShowOverloads = Ovl_All;
231 // Cap of # errors emitted, 0 -> no limit.
232 unsigned ErrorLimit = 0;
234 // Cap on depth of template backtrace stack, 0 -> no limit.
235 unsigned TemplateBacktraceLimit = 0;
237 // Cap on depth of constexpr evaluation backtrace stack, 0 -> no limit.
238 unsigned ConstexprBacktraceLimit = 0;
240 IntrusiveRefCntPtr<DiagnosticIDs> Diags;
241 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
242 DiagnosticConsumer *Client = nullptr;
243 std::unique_ptr<DiagnosticConsumer> Owner;
244 SourceManager *SourceMgr = nullptr;
246 /// Mapping information for diagnostics.
248 /// Mapping info is packed into four bits per diagnostic. The low three
249 /// bits are the mapping (an instance of diag::Severity), or zero if unset.
250 /// The high bit is set when the mapping was established as a user mapping.
251 /// If the high bit is clear, then the low bits are set to the default
252 /// value, and should be mapped with -pedantic, -Werror, etc.
254 /// A new DiagState is created and kept around when diagnostic pragmas modify
255 /// the state so that we know what is the diagnostic state at any given
258 llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap;
261 // "Global" configuration state that can actually vary between modules.
263 // Ignore all warnings: -w
264 unsigned IgnoreAllWarnings : 1;
266 // Enable all warnings.
267 unsigned EnableAllWarnings : 1;
269 // Treat warnings like errors.
270 unsigned WarningsAsErrors : 1;
272 // Treat errors like fatal errors.
273 unsigned ErrorsAsFatal : 1;
275 // Suppress warnings in system headers.
276 unsigned SuppressSystemWarnings : 1;
278 // Map extensions to warnings or errors?
279 diag::Severity ExtBehavior = diag::Severity::Ignored;
282 : IgnoreAllWarnings(false), EnableAllWarnings(false),
283 WarningsAsErrors(false), ErrorsAsFatal(false),
284 SuppressSystemWarnings(false) {}
286 using iterator = llvm::DenseMap<unsigned, DiagnosticMapping>::iterator;
287 using const_iterator =
288 llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator;
290 void setMapping(diag::kind Diag, DiagnosticMapping Info) {
291 DiagMap[Diag] = Info;
294 DiagnosticMapping lookupMapping(diag::kind Diag) const {
295 return DiagMap.lookup(Diag);
298 DiagnosticMapping &getOrAddMapping(diag::kind Diag);
300 const_iterator begin() const { return DiagMap.begin(); }
301 const_iterator end() const { return DiagMap.end(); }
304 /// Keeps and automatically disposes all DiagStates that we create.
305 std::list<DiagState> DiagStates;
307 /// A mapping from files to the diagnostic states for those files. Lazily
308 /// built on demand for files in which the diagnostic state has not changed.
311 /// Add an initial diagnostic state.
312 void appendFirst(DiagState *State);
314 /// Add a new latest state point.
315 void append(SourceManager &SrcMgr, SourceLocation Loc, DiagState *State);
317 /// Look up the diagnostic state at a given source location.
318 DiagState *lookup(SourceManager &SrcMgr, SourceLocation Loc) const;
320 /// Determine whether this map is empty.
321 bool empty() const { return Files.empty(); }
323 /// Clear out this map.
326 FirstDiagState = CurDiagState = nullptr;
327 CurDiagStateLoc = SourceLocation();
330 /// Produce a debugging dump of the diagnostic state.
331 LLVM_DUMP_METHOD void dump(SourceManager &SrcMgr,
332 StringRef DiagName = StringRef()) const;
334 /// Grab the most-recently-added state point.
335 DiagState *getCurDiagState() const { return CurDiagState; }
337 /// Get the location at which a diagnostic state was last added.
338 SourceLocation getCurDiagStateLoc() const { return CurDiagStateLoc; }
341 friend class ASTReader;
342 friend class ASTWriter;
344 /// Represents a point in source where the diagnostic state was
345 /// modified because of a pragma.
347 /// 'Loc' can be null if the point represents the diagnostic state
348 /// modifications done through the command-line.
349 struct DiagStatePoint {
353 DiagStatePoint(DiagState *State, unsigned Offset)
354 : State(State), Offset(Offset) {}
357 /// Description of the diagnostic states and state transitions for a
358 /// particular FileID.
360 /// The diagnostic state for the parent file. This is strictly redundant,
361 /// as looking up the DecomposedIncludedLoc for the FileID in the Files
362 /// map would give us this, but we cache it here for performance.
363 File *Parent = nullptr;
365 /// The offset of this file within its parent.
366 unsigned ParentOffset = 0;
368 /// Whether this file has any local (not imported from an AST file)
369 /// diagnostic state transitions.
370 bool HasLocalTransitions = false;
372 /// The points within the file where the state changes. There will always
373 /// be at least one of these (the state on entry to the file).
374 llvm::SmallVector<DiagStatePoint, 4> StateTransitions;
376 DiagState *lookup(unsigned Offset) const;
379 /// The diagnostic states for each file.
380 mutable std::map<FileID, File> Files;
382 /// The initial diagnostic state.
383 DiagState *FirstDiagState;
385 /// The current diagnostic state.
386 DiagState *CurDiagState;
388 /// The location at which the current diagnostic state was established.
389 SourceLocation CurDiagStateLoc;
391 /// Get the diagnostic state information for a file.
392 File *getFile(SourceManager &SrcMgr, FileID ID) const;
395 DiagStateMap DiagStatesByLoc;
397 /// Keeps the DiagState that was active during each diagnostic 'push'
398 /// so we can get back at it when we 'pop'.
399 std::vector<DiagState *> DiagStateOnPushStack;
401 DiagState *GetCurDiagState() const {
402 return DiagStatesByLoc.getCurDiagState();
405 void PushDiagStatePoint(DiagState *State, SourceLocation L);
407 /// Finds the DiagStatePoint that contains the diagnostic state of
408 /// the given source location.
409 DiagState *GetDiagStateForLoc(SourceLocation Loc) const {
410 return SourceMgr ? DiagStatesByLoc.lookup(*SourceMgr, Loc)
411 : DiagStatesByLoc.getCurDiagState();
414 /// Sticky flag set to \c true when an error is emitted.
417 /// Sticky flag set to \c true when an "uncompilable error" occurs.
418 /// I.e. an error that was not upgraded from a warning by -Werror.
419 bool UncompilableErrorOccurred;
421 /// Sticky flag set to \c true when a fatal error is emitted.
422 bool FatalErrorOccurred;
424 /// Indicates that an unrecoverable error has occurred.
425 bool UnrecoverableErrorOccurred;
427 /// Counts for DiagnosticErrorTrap to check whether an error occurred
428 /// during a parsing section, e.g. during parsing a function.
429 unsigned TrapNumErrorsOccurred;
430 unsigned TrapNumUnrecoverableErrorsOccurred;
432 /// The level of the last diagnostic emitted.
434 /// This is used to emit continuation diagnostics with the same level as the
435 /// diagnostic that they follow.
436 DiagnosticIDs::Level LastDiagLevel;
438 /// Number of warnings reported
439 unsigned NumWarnings;
441 /// Number of errors reported
444 /// A function pointer that converts an opaque diagnostic
445 /// argument to a strings.
447 /// This takes the modifiers and argument that was present in the diagnostic.
449 /// The PrevArgs array indicates the previous arguments formatted for this
450 /// diagnostic. Implementations of this function can use this information to
451 /// avoid redundancy across arguments.
453 /// This is a hack to avoid a layering violation between libbasic and libsema.
454 using ArgToStringFnTy = void (*)(
455 ArgumentKind Kind, intptr_t Val,
456 StringRef Modifier, StringRef Argument,
457 ArrayRef<ArgumentValue> PrevArgs,
458 SmallVectorImpl<char> &Output,
460 ArrayRef<intptr_t> QualTypeVals);
462 void *ArgToStringCookie = nullptr;
463 ArgToStringFnTy ArgToStringFn;
465 /// ID of the "delayed" diagnostic, which is a (typically
466 /// fatal) diagnostic that had to be delayed because it was found
467 /// while emitting another diagnostic.
468 unsigned DelayedDiagID;
470 /// First string argument for the delayed diagnostic.
471 std::string DelayedDiagArg1;
473 /// Second string argument for the delayed diagnostic.
474 std::string DelayedDiagArg2;
476 /// Optional flag value.
478 /// Some flags accept values, for instance: -Wframe-larger-than=<value> and
479 /// -Rpass=<value>. The content of this string is emitted after the flag name
481 std::string FlagValue;
484 explicit DiagnosticsEngine(IntrusiveRefCntPtr<DiagnosticIDs> Diags,
485 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
486 DiagnosticConsumer *client = nullptr,
487 bool ShouldOwnClient = true);
488 DiagnosticsEngine(const DiagnosticsEngine &) = delete;
489 DiagnosticsEngine &operator=(const DiagnosticsEngine &) = delete;
490 ~DiagnosticsEngine();
492 LLVM_DUMP_METHOD void dump() const;
493 LLVM_DUMP_METHOD void dump(StringRef DiagName) const;
495 const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const {
499 /// Retrieve the diagnostic options.
500 DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; }
502 using diag_mapping_range = llvm::iterator_range<DiagState::const_iterator>;
504 /// Get the current set of diagnostic mappings.
505 diag_mapping_range getDiagnosticMappings() const {
506 const DiagState &DS = *GetCurDiagState();
507 return diag_mapping_range(DS.begin(), DS.end());
510 DiagnosticConsumer *getClient() { return Client; }
511 const DiagnosticConsumer *getClient() const { return Client; }
513 /// Determine whether this \c DiagnosticsEngine object own its client.
514 bool ownsClient() const { return Owner != nullptr; }
516 /// Return the current diagnostic client along with ownership of that
518 std::unique_ptr<DiagnosticConsumer> takeClient() { return std::move(Owner); }
520 bool hasSourceManager() const { return SourceMgr != nullptr; }
522 SourceManager &getSourceManager() const {
523 assert(SourceMgr && "SourceManager not set!");
527 void setSourceManager(SourceManager *SrcMgr) {
528 assert(DiagStatesByLoc.empty() &&
529 "Leftover diag state from a different SourceManager.");
533 //===--------------------------------------------------------------------===//
534 // DiagnosticsEngine characterization methods, used by a client to customize
535 // how diagnostics are emitted.
538 /// Copies the current DiagMappings and pushes the new copy
539 /// onto the top of the stack.
540 void pushMappings(SourceLocation Loc);
542 /// Pops the current DiagMappings off the top of the stack,
543 /// causing the new top of the stack to be the active mappings.
545 /// \returns \c true if the pop happens, \c false if there is only one
546 /// DiagMapping on the stack.
547 bool popMappings(SourceLocation Loc);
549 /// Set the diagnostic client associated with this diagnostic object.
551 /// \param ShouldOwnClient true if the diagnostic object should take
552 /// ownership of \c client.
553 void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true);
555 /// Specify a limit for the number of errors we should
556 /// emit before giving up.
558 /// Zero disables the limit.
559 void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; }
561 /// Specify the maximum number of template instantiation
562 /// notes to emit along with a given diagnostic.
563 void setTemplateBacktraceLimit(unsigned Limit) {
564 TemplateBacktraceLimit = Limit;
567 /// Retrieve the maximum number of template instantiation
568 /// notes to emit along with a given diagnostic.
569 unsigned getTemplateBacktraceLimit() const {
570 return TemplateBacktraceLimit;
573 /// Specify the maximum number of constexpr evaluation
574 /// notes to emit along with a given diagnostic.
575 void setConstexprBacktraceLimit(unsigned Limit) {
576 ConstexprBacktraceLimit = Limit;
579 /// Retrieve the maximum number of constexpr evaluation
580 /// notes to emit along with a given diagnostic.
581 unsigned getConstexprBacktraceLimit() const {
582 return ConstexprBacktraceLimit;
585 /// When set to true, any unmapped warnings are ignored.
587 /// If this and WarningsAsErrors are both set, then this one wins.
588 void setIgnoreAllWarnings(bool Val) {
589 GetCurDiagState()->IgnoreAllWarnings = Val;
591 bool getIgnoreAllWarnings() const {
592 return GetCurDiagState()->IgnoreAllWarnings;
595 /// When set to true, any unmapped ignored warnings are no longer
598 /// If this and IgnoreAllWarnings are both set, then that one wins.
599 void setEnableAllWarnings(bool Val) {
600 GetCurDiagState()->EnableAllWarnings = Val;
602 bool getEnableAllWarnings() const {
603 return GetCurDiagState()->EnableAllWarnings;
606 /// When set to true, any warnings reported are issued as errors.
607 void setWarningsAsErrors(bool Val) {
608 GetCurDiagState()->WarningsAsErrors = Val;
610 bool getWarningsAsErrors() const {
611 return GetCurDiagState()->WarningsAsErrors;
614 /// When set to true, any error reported is made a fatal error.
615 void setErrorsAsFatal(bool Val) { GetCurDiagState()->ErrorsAsFatal = Val; }
616 bool getErrorsAsFatal() const { return GetCurDiagState()->ErrorsAsFatal; }
618 /// \brief When set to true, any fatal error reported is made an error.
620 /// This setting takes precedence over the setErrorsAsFatal setting above.
621 void setFatalsAsError(bool Val) { FatalsAsError = Val; }
622 bool getFatalsAsError() const { return FatalsAsError; }
624 /// When set to true mask warnings that come from system headers.
625 void setSuppressSystemWarnings(bool Val) {
626 GetCurDiagState()->SuppressSystemWarnings = Val;
628 bool getSuppressSystemWarnings() const {
629 return GetCurDiagState()->SuppressSystemWarnings;
632 /// Suppress all diagnostics, to silence the front end when we
633 /// know that we don't want any more diagnostics to be passed along to the
635 void setSuppressAllDiagnostics(bool Val) { SuppressAllDiagnostics = Val; }
636 bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; }
638 /// Set type eliding, to skip outputting same types occurring in
640 void setElideType(bool Val) { ElideType = Val; }
641 bool getElideType() { return ElideType; }
643 /// Set tree printing, to outputting the template difference in a
645 void setPrintTemplateTree(bool Val) { PrintTemplateTree = Val; }
646 bool getPrintTemplateTree() { return PrintTemplateTree; }
648 /// Set color printing, so the type diffing will inject color markers
650 void setShowColors(bool Val) { ShowColors = Val; }
651 bool getShowColors() { return ShowColors; }
653 /// Specify which overload candidates to show when overload resolution
656 /// By default, we show all candidates.
657 void setShowOverloads(OverloadsShown Val) {
660 OverloadsShown getShowOverloads() const { return ShowOverloads; }
662 /// Pretend that the last diagnostic issued was ignored, so any
663 /// subsequent notes will be suppressed, or restore a prior ignoring
664 /// state after ignoring some diagnostics and their notes, possibly in
665 /// the middle of another diagnostic.
667 /// This can be used by clients who suppress diagnostics themselves.
668 void setLastDiagnosticIgnored(bool Ignored) {
669 if (LastDiagLevel == DiagnosticIDs::Fatal)
670 FatalErrorOccurred = true;
671 LastDiagLevel = Ignored ? DiagnosticIDs::Ignored : DiagnosticIDs::Warning;
674 /// Determine whether the previous diagnostic was ignored. This can
675 /// be used by clients that want to determine whether notes attached to a
676 /// diagnostic will be suppressed.
677 bool isLastDiagnosticIgnored() const {
678 return LastDiagLevel == DiagnosticIDs::Ignored;
681 /// Controls whether otherwise-unmapped extension diagnostics are
682 /// mapped onto ignore/warning/error.
684 /// This corresponds to the GCC -pedantic and -pedantic-errors option.
685 void setExtensionHandlingBehavior(diag::Severity H) {
686 GetCurDiagState()->ExtBehavior = H;
688 diag::Severity getExtensionHandlingBehavior() const {
689 return GetCurDiagState()->ExtBehavior;
692 /// Counter bumped when an __extension__ block is/ encountered.
694 /// When non-zero, all extension diagnostics are entirely silenced, no
695 /// matter how they are mapped.
696 void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; }
697 void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; }
698 bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; }
700 /// This allows the client to specify that certain warnings are
703 /// Notes can never be mapped, errors can only be mapped to fatal, and
704 /// WARNINGs and EXTENSIONs can be mapped arbitrarily.
706 /// \param Loc The source location that this change of diagnostic state should
707 /// take affect. It can be null if we are setting the latest state.
708 void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc);
710 /// Change an entire diagnostic group (e.g. "unknown-pragmas") to
711 /// have the specified mapping.
713 /// \returns true (and ignores the request) if "Group" was unknown, false
716 /// \param Flavor The flavor of group to affect. -Rfoo does not affect the
717 /// state of the -Wfoo group and vice versa.
719 /// \param Loc The source location that this change of diagnostic state should
720 /// take affect. It can be null if we are setting the state from command-line.
721 bool setSeverityForGroup(diag::Flavor Flavor, StringRef Group,
723 SourceLocation Loc = SourceLocation());
725 /// Set the warning-as-error flag for the given diagnostic group.
727 /// This function always only operates on the current diagnostic state.
729 /// \returns True if the given group is unknown, false otherwise.
730 bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled);
732 /// Set the error-as-fatal flag for the given diagnostic group.
734 /// This function always only operates on the current diagnostic state.
736 /// \returns True if the given group is unknown, false otherwise.
737 bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled);
739 /// Add the specified mapping to all diagnostics of the specified
742 /// Mainly to be used by -Wno-everything to disable all warnings but allow
743 /// subsequent -W options to enable specific warnings.
744 void setSeverityForAll(diag::Flavor Flavor, diag::Severity Map,
745 SourceLocation Loc = SourceLocation());
747 bool hasErrorOccurred() const { return ErrorOccurred; }
749 /// Errors that actually prevent compilation, not those that are
750 /// upgraded from a warning by -Werror.
751 bool hasUncompilableErrorOccurred() const {
752 return UncompilableErrorOccurred;
754 bool hasFatalErrorOccurred() const { return FatalErrorOccurred; }
756 /// Determine whether any kind of unrecoverable error has occurred.
757 bool hasUnrecoverableErrorOccurred() const {
758 return FatalErrorOccurred || UnrecoverableErrorOccurred;
761 unsigned getNumWarnings() const { return NumWarnings; }
763 void setNumWarnings(unsigned NumWarnings) {
764 this->NumWarnings = NumWarnings;
767 /// Return an ID for a diagnostic with the specified format string and
770 /// If this is the first request for this diagnostic, it is registered and
771 /// created, otherwise the existing ID is returned.
773 /// \param FormatString A fixed diagnostic format string that will be hashed
774 /// and mapped to a unique DiagID.
775 template <unsigned N>
776 unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) {
777 return Diags->getCustomDiagID((DiagnosticIDs::Level)L,
778 StringRef(FormatString, N - 1));
781 /// Converts a diagnostic argument (as an intptr_t) into the string
782 /// that represents it.
783 void ConvertArgToString(ArgumentKind Kind, intptr_t Val,
784 StringRef Modifier, StringRef Argument,
785 ArrayRef<ArgumentValue> PrevArgs,
786 SmallVectorImpl<char> &Output,
787 ArrayRef<intptr_t> QualTypeVals) const {
788 ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output,
789 ArgToStringCookie, QualTypeVals);
792 void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) {
794 ArgToStringCookie = Cookie;
797 /// Note that the prior diagnostic was emitted by some other
798 /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic.
799 void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) {
800 LastDiagLevel = Other.LastDiagLevel;
803 /// Reset the state of the diagnostic object to its initial
807 //===--------------------------------------------------------------------===//
808 // DiagnosticsEngine classification and reporting interfaces.
811 /// Determine whether the diagnostic is known to be ignored.
813 /// This can be used to opportunistically avoid expensive checks when it's
814 /// known for certain that the diagnostic has been suppressed at the
815 /// specified location \p Loc.
817 /// \param Loc The source location we are interested in finding out the
818 /// diagnostic state. Can be null in order to query the latest state.
819 bool isIgnored(unsigned DiagID, SourceLocation Loc) const {
820 return Diags->getDiagnosticSeverity(DiagID, Loc, *this) ==
821 diag::Severity::Ignored;
824 /// Based on the way the client configured the DiagnosticsEngine
825 /// object, classify the specified diagnostic ID into a Level, consumable by
826 /// the DiagnosticConsumer.
828 /// To preserve invariant assumptions, this function should not be used to
829 /// influence parse or semantic analysis actions. Instead consider using
832 /// \param Loc The source location we are interested in finding out the
833 /// diagnostic state. Can be null in order to query the latest state.
834 Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const {
835 return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this);
838 /// Issue the message to the client.
840 /// This actually returns an instance of DiagnosticBuilder which emits the
841 /// diagnostics (through @c ProcessDiag) when it is destroyed.
843 /// \param DiagID A member of the @c diag::kind enum.
844 /// \param Loc Represents the source location associated with the diagnostic,
845 /// which can be an invalid location if no position information is available.
846 inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID);
847 inline DiagnosticBuilder Report(unsigned DiagID);
849 void Report(const StoredDiagnostic &storedDiag);
851 /// Determine whethere there is already a diagnostic in flight.
852 bool isDiagnosticInFlight() const {
853 return CurDiagID != std::numeric_limits<unsigned>::max();
856 /// Set the "delayed" diagnostic that will be emitted once
857 /// the current diagnostic completes.
859 /// If a diagnostic is already in-flight but the front end must
860 /// report a problem (e.g., with an inconsistent file system
861 /// state), this routine sets a "delayed" diagnostic that will be
862 /// emitted after the current diagnostic completes. This should
863 /// only be used for fatal errors detected at inconvenient
864 /// times. If emitting a delayed diagnostic causes a second delayed
865 /// diagnostic to be introduced, that second delayed diagnostic
868 /// \param DiagID The ID of the diagnostic being delayed.
870 /// \param Arg1 A string argument that will be provided to the
871 /// diagnostic. A copy of this string will be stored in the
872 /// DiagnosticsEngine object itself.
874 /// \param Arg2 A string argument that will be provided to the
875 /// diagnostic. A copy of this string will be stored in the
876 /// DiagnosticsEngine object itself.
877 void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "",
878 StringRef Arg2 = "");
880 /// Clear out the current diagnostic.
881 void Clear() { CurDiagID = std::numeric_limits<unsigned>::max(); }
883 /// Return the value associated with this diagnostic flag.
884 StringRef getFlagValue() const { return FlagValue; }
887 // This is private state used by DiagnosticBuilder. We put it here instead of
888 // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight
889 // object. This implementation choice means that we can only have one
890 // diagnostic "in flight" at a time, but this seems to be a reasonable
891 // tradeoff to keep these objects small. Assertions verify that only one
892 // diagnostic is in flight at a time.
893 friend class Diagnostic;
894 friend class DiagnosticBuilder;
895 friend class DiagnosticErrorTrap;
896 friend class DiagnosticIDs;
897 friend class PartialDiagnostic;
899 /// Report the delayed diagnostic.
900 void ReportDelayed();
902 /// The location of the current diagnostic that is in flight.
903 SourceLocation CurDiagLoc;
905 /// The ID of the current diagnostic that is in flight.
907 /// This is set to std::numeric_limits<unsigned>::max() when there is no
908 /// diagnostic in flight.
912 /// The maximum number of arguments we can hold.
914 /// We currently only support up to 10 arguments (%0-%9). A single
915 /// diagnostic with more than that almost certainly has to be simplified
920 /// The number of entries in Arguments.
921 signed char NumDiagArgs;
923 /// Specifies whether an argument is in DiagArgumentsStr or
924 /// in DiagArguments.
926 /// This is an array of ArgumentKind::ArgumentKind enum values, one for each
928 unsigned char DiagArgumentsKind[MaxArguments];
930 /// Holds the values of each string argument for the current
933 /// This is only used when the corresponding ArgumentKind is ak_std_string.
934 std::string DiagArgumentsStr[MaxArguments];
936 /// The values for the various substitution positions.
938 /// This is used when the argument is not an std::string. The specific
939 /// value is mangled into an intptr_t and the interpretation depends on
940 /// exactly what sort of argument kind it is.
941 intptr_t DiagArgumentsVal[MaxArguments];
943 /// The list of ranges added to this diagnostic.
944 SmallVector<CharSourceRange, 8> DiagRanges;
946 /// If valid, provides a hint with some code to insert, remove,
947 /// or modify at a particular position.
948 SmallVector<FixItHint, 8> DiagFixItHints;
950 DiagnosticMapping makeUserMapping(diag::Severity Map, SourceLocation L) {
951 bool isPragma = L.isValid();
952 DiagnosticMapping Mapping =
953 DiagnosticMapping::Make(Map, /*IsUser=*/true, isPragma);
955 // If this is a pragma mapping, then set the diagnostic mapping flags so
956 // that we override command line options.
958 Mapping.setNoWarningAsError(true);
959 Mapping.setNoErrorAsFatal(true);
965 /// Used to report a diagnostic that is finally fully formed.
967 /// \returns true if the diagnostic was emitted, false if it was suppressed.
969 return Diags->ProcessDiag(*this);
972 /// @name Diagnostic Emission
975 friend class ASTReader;
976 friend class ASTWriter;
978 // Sema requires access to the following functions because the current design
979 // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to
980 // access us directly to ensure we minimize the emitted code for the common
981 // Sema::Diag() patterns.
984 /// Emit the current diagnostic and clear the diagnostic state.
986 /// \param Force Emit the diagnostic regardless of suppression settings.
987 bool EmitCurrentDiagnostic(bool Force = false);
989 unsigned getCurrentDiagID() const { return CurDiagID; }
991 SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; }
996 /// RAII class that determines when any errors have occurred
997 /// between the time the instance was created and the time it was
999 class DiagnosticErrorTrap {
1000 DiagnosticsEngine &Diag;
1002 unsigned NumUnrecoverableErrors;
1005 explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag)
1006 : Diag(Diag) { reset(); }
1008 /// Determine whether any errors have occurred since this
1009 /// object instance was created.
1010 bool hasErrorOccurred() const {
1011 return Diag.TrapNumErrorsOccurred > NumErrors;
1014 /// Determine whether any unrecoverable errors have occurred since this
1015 /// object instance was created.
1016 bool hasUnrecoverableErrorOccurred() const {
1017 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
1020 /// Set to initial state of "no errors occurred".
1022 NumErrors = Diag.TrapNumErrorsOccurred;
1023 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
1027 //===----------------------------------------------------------------------===//
1028 // DiagnosticBuilder
1029 //===----------------------------------------------------------------------===//
1031 /// A little helper class used to produce diagnostics.
1033 /// This is constructed by the DiagnosticsEngine::Report method, and
1034 /// allows insertion of extra information (arguments and source ranges) into
1035 /// the currently "in flight" diagnostic. When the temporary for the builder
1036 /// is destroyed, the diagnostic is issued.
1038 /// Note that many of these will be created as temporary objects (many call
1039 /// sites), so we want them to be small and we never want their address taken.
1040 /// This ensures that compilers with somewhat reasonable optimizers will promote
1041 /// the common fields to registers, eliminating increments of the NumArgs field,
1043 class DiagnosticBuilder {
1044 friend class DiagnosticsEngine;
1045 friend class PartialDiagnostic;
1047 mutable DiagnosticsEngine *DiagObj = nullptr;
1048 mutable unsigned NumArgs = 0;
1050 /// Status variable indicating if this diagnostic is still active.
1052 // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)),
1053 // but LLVM is not currently smart enough to eliminate the null check that
1054 // Emit() would end up with if we used that as our status variable.
1055 mutable bool IsActive = false;
1057 /// Flag indicating that this diagnostic is being emitted via a
1058 /// call to ForceEmit.
1059 mutable bool IsForceEmit = false;
1061 DiagnosticBuilder() = default;
1063 explicit DiagnosticBuilder(DiagnosticsEngine *diagObj)
1064 : DiagObj(diagObj), IsActive(true) {
1065 assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!");
1066 diagObj->DiagRanges.clear();
1067 diagObj->DiagFixItHints.clear();
1071 void FlushCounts() {
1072 DiagObj->NumDiagArgs = NumArgs;
1075 /// Clear out the current diagnostic.
1076 void Clear() const {
1079 IsForceEmit = false;
1082 /// Determine whether this diagnostic is still active.
1083 bool isActive() const { return IsActive; }
1085 /// Force the diagnostic builder to emit the diagnostic now.
1087 /// Once this function has been called, the DiagnosticBuilder object
1088 /// should not be used again before it is destroyed.
1090 /// \returns true if a diagnostic was emitted, false if the
1091 /// diagnostic was suppressed.
1093 // If this diagnostic is inactive, then its soul was stolen by the copy ctor
1094 // (or by a subclass, as in SemaDiagnosticBuilder).
1095 if (!isActive()) return false;
1097 // When emitting diagnostics, we set the final argument count into
1098 // the DiagnosticsEngine object.
1101 // Process the diagnostic.
1102 bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit);
1104 // This diagnostic is dead.
1111 /// Copy constructor. When copied, this "takes" the diagnostic info from the
1112 /// input and neuters it.
1113 DiagnosticBuilder(const DiagnosticBuilder &D) {
1114 DiagObj = D.DiagObj;
1115 IsActive = D.IsActive;
1116 IsForceEmit = D.IsForceEmit;
1118 NumArgs = D.NumArgs;
1121 DiagnosticBuilder &operator=(const DiagnosticBuilder &) = delete;
1123 /// Emits the diagnostic.
1124 ~DiagnosticBuilder() {
1128 /// Forces the diagnostic to be emitted.
1129 const DiagnosticBuilder &setForceEmit() const {
1134 /// Conversion of DiagnosticBuilder to bool always returns \c true.
1136 /// This allows is to be used in boolean error contexts (where \c true is
1137 /// used to indicate that an error has occurred), like:
1139 /// return Diag(...);
1141 operator bool() const { return true; }
1143 void AddString(StringRef S) const {
1144 assert(isActive() && "Clients must not add to cleared diagnostic!");
1145 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
1146 "Too many arguments to diagnostic!");
1147 DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string;
1148 DiagObj->DiagArgumentsStr[NumArgs++] = S;
1151 void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const {
1152 assert(isActive() && "Clients must not add to cleared diagnostic!");
1153 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
1154 "Too many arguments to diagnostic!");
1155 DiagObj->DiagArgumentsKind[NumArgs] = Kind;
1156 DiagObj->DiagArgumentsVal[NumArgs++] = V;
1159 void AddSourceRange(const CharSourceRange &R) const {
1160 assert(isActive() && "Clients must not add to cleared diagnostic!");
1161 DiagObj->DiagRanges.push_back(R);
1164 void AddFixItHint(const FixItHint &Hint) const {
1165 assert(isActive() && "Clients must not add to cleared diagnostic!");
1167 DiagObj->DiagFixItHints.push_back(Hint);
1170 void addFlagValue(StringRef V) const { DiagObj->FlagValue = V; }
1173 struct AddFlagValue {
1176 explicit AddFlagValue(StringRef V) : Val(V) {}
1179 /// Register a value for the flag in the current diagnostic. This
1180 /// value will be shown as the suffix "=value" after the flag name. It is
1181 /// useful in cases where the diagnostic flag accepts values (e.g.,
1182 /// -Rpass or -Wframe-larger-than).
1183 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1184 const AddFlagValue V) {
1185 DB.addFlagValue(V.Val);
1189 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1195 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1197 DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str),
1198 DiagnosticsEngine::ak_c_string);
1202 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) {
1203 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1207 // We use enable_if here to prevent that this overload is selected for
1208 // pointers or other arguments that are implicitly convertible to bool.
1209 template <typename T>
1211 typename std::enable_if<std::is_same<T, bool>::value,
1212 const DiagnosticBuilder &>::type
1213 operator<<(const DiagnosticBuilder &DB, T I) {
1214 DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
1218 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1220 DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint);
1224 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1226 DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind);
1230 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1231 const IdentifierInfo *II) {
1232 DB.AddTaggedVal(reinterpret_cast<intptr_t>(II),
1233 DiagnosticsEngine::ak_identifierinfo);
1237 // Adds a DeclContext to the diagnostic. The enable_if template magic is here
1238 // so that we only match those arguments that are (statically) DeclContexts;
1239 // other arguments that derive from DeclContext (e.g., RecordDecls) will not
1241 template <typename T>
1242 inline typename std::enable_if<
1243 std::is_same<typename std::remove_const<T>::type, DeclContext>::value,
1244 const DiagnosticBuilder &>::type
1245 operator<<(const DiagnosticBuilder &DB, T *DC) {
1246 DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC),
1247 DiagnosticsEngine::ak_declcontext);
1251 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1253 DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1257 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1258 ArrayRef<SourceRange> Ranges) {
1259 for (SourceRange R : Ranges)
1260 DB.AddSourceRange(CharSourceRange::getTokenRange(R));
1264 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1265 const CharSourceRange &R) {
1266 DB.AddSourceRange(R);
1270 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1271 const FixItHint &Hint) {
1272 DB.AddFixItHint(Hint);
1276 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1277 ArrayRef<FixItHint> Hints) {
1278 for (const FixItHint &Hint : Hints)
1279 DB.AddFixItHint(Hint);
1283 /// A nullability kind paired with a bit indicating whether it used a
1284 /// context-sensitive keyword.
1285 using DiagNullabilityKind = std::pair<NullabilityKind, bool>;
1287 const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1288 DiagNullabilityKind nullability);
1290 inline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc,
1292 assert(CurDiagID == std::numeric_limits<unsigned>::max() &&
1293 "Multiple diagnostics in flight at once!");
1297 return DiagnosticBuilder(this);
1300 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1302 DB.AddString(toString(std::move(E)));
1306 inline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) {
1307 return Report(SourceLocation(), DiagID);
1310 //===----------------------------------------------------------------------===//
1312 //===----------------------------------------------------------------------===//
1314 /// A little helper class (which is basically a smart pointer that forwards
1315 /// info from DiagnosticsEngine) that allows clients to enquire about the
1316 /// currently in-flight diagnostic.
1318 const DiagnosticsEngine *DiagObj;
1319 StringRef StoredDiagMessage;
1322 explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {}
1323 Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
1324 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
1326 const DiagnosticsEngine *getDiags() const { return DiagObj; }
1327 unsigned getID() const { return DiagObj->CurDiagID; }
1328 const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; }
1329 bool hasSourceManager() const { return DiagObj->hasSourceManager(); }
1330 SourceManager &getSourceManager() const { return DiagObj->getSourceManager();}
1332 unsigned getNumArgs() const { return DiagObj->NumDiagArgs; }
1334 /// Return the kind of the specified index.
1336 /// Based on the kind of argument, the accessors below can be used to get
1339 /// \pre Idx < getNumArgs()
1340 DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const {
1341 assert(Idx < getNumArgs() && "Argument index out of range!");
1342 return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx];
1345 /// Return the provided argument string specified by \p Idx.
1346 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string
1347 const std::string &getArgStdStr(unsigned Idx) const {
1348 assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string &&
1349 "invalid argument accessor!");
1350 return DiagObj->DiagArgumentsStr[Idx];
1353 /// Return the specified C string argument.
1354 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string
1355 const char *getArgCStr(unsigned Idx) const {
1356 assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string &&
1357 "invalid argument accessor!");
1358 return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]);
1361 /// Return the specified signed integer argument.
1362 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint
1363 int getArgSInt(unsigned Idx) const {
1364 assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint &&
1365 "invalid argument accessor!");
1366 return (int)DiagObj->DiagArgumentsVal[Idx];
1369 /// Return the specified unsigned integer argument.
1370 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint
1371 unsigned getArgUInt(unsigned Idx) const {
1372 assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint &&
1373 "invalid argument accessor!");
1374 return (unsigned)DiagObj->DiagArgumentsVal[Idx];
1377 /// Return the specified IdentifierInfo argument.
1378 /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo
1379 const IdentifierInfo *getArgIdentifier(unsigned Idx) const {
1380 assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo &&
1381 "invalid argument accessor!");
1382 return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]);
1385 /// Return the specified non-string argument in an opaque form.
1386 /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string
1387 intptr_t getRawArg(unsigned Idx) const {
1388 assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string &&
1389 "invalid argument accessor!");
1390 return DiagObj->DiagArgumentsVal[Idx];
1393 /// Return the number of source ranges associated with this diagnostic.
1394 unsigned getNumRanges() const {
1395 return DiagObj->DiagRanges.size();
1398 /// \pre Idx < getNumRanges()
1399 const CharSourceRange &getRange(unsigned Idx) const {
1400 assert(Idx < getNumRanges() && "Invalid diagnostic range index!");
1401 return DiagObj->DiagRanges[Idx];
1404 /// Return an array reference for this diagnostic's ranges.
1405 ArrayRef<CharSourceRange> getRanges() const {
1406 return DiagObj->DiagRanges;
1409 unsigned getNumFixItHints() const {
1410 return DiagObj->DiagFixItHints.size();
1413 const FixItHint &getFixItHint(unsigned Idx) const {
1414 assert(Idx < getNumFixItHints() && "Invalid index!");
1415 return DiagObj->DiagFixItHints[Idx];
1418 ArrayRef<FixItHint> getFixItHints() const {
1419 return DiagObj->DiagFixItHints;
1422 /// Format this diagnostic into a string, substituting the
1423 /// formal arguments into the %0 slots.
1425 /// The result is appended onto the \p OutStr array.
1426 void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const;
1428 /// Format the given format-string into the output buffer using the
1429 /// arguments stored in this diagnostic.
1430 void FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
1431 SmallVectorImpl<char> &OutStr) const;
1435 * Represents a diagnostic in a form that can be retained until its
1436 * corresponding source manager is destroyed.
1438 class StoredDiagnostic {
1440 DiagnosticsEngine::Level Level;
1442 std::string Message;
1443 std::vector<CharSourceRange> Ranges;
1444 std::vector<FixItHint> FixIts;
1447 StoredDiagnostic() = default;
1448 StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info);
1449 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1451 StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1452 StringRef Message, FullSourceLoc Loc,
1453 ArrayRef<CharSourceRange> Ranges,
1454 ArrayRef<FixItHint> Fixits);
1456 /// Evaluates true when this object stores a diagnostic.
1457 explicit operator bool() const { return !Message.empty(); }
1459 unsigned getID() const { return ID; }
1460 DiagnosticsEngine::Level getLevel() const { return Level; }
1461 const FullSourceLoc &getLocation() const { return Loc; }
1462 StringRef getMessage() const { return Message; }
1464 void setLocation(FullSourceLoc Loc) { this->Loc = Loc; }
1466 using range_iterator = std::vector<CharSourceRange>::const_iterator;
1468 range_iterator range_begin() const { return Ranges.begin(); }
1469 range_iterator range_end() const { return Ranges.end(); }
1470 unsigned range_size() const { return Ranges.size(); }
1472 ArrayRef<CharSourceRange> getRanges() const {
1473 return llvm::makeArrayRef(Ranges);
1476 using fixit_iterator = std::vector<FixItHint>::const_iterator;
1478 fixit_iterator fixit_begin() const { return FixIts.begin(); }
1479 fixit_iterator fixit_end() const { return FixIts.end(); }
1480 unsigned fixit_size() const { return FixIts.size(); }
1482 ArrayRef<FixItHint> getFixIts() const {
1483 return llvm::makeArrayRef(FixIts);
1487 /// Abstract interface, implemented by clients of the front-end, which
1488 /// formats and prints fully processed diagnostics.
1489 class DiagnosticConsumer {
1491 unsigned NumWarnings = 0; ///< Number of warnings reported
1492 unsigned NumErrors = 0; ///< Number of errors reported
1495 DiagnosticConsumer() = default;
1496 virtual ~DiagnosticConsumer();
1498 unsigned getNumErrors() const { return NumErrors; }
1499 unsigned getNumWarnings() const { return NumWarnings; }
1500 virtual void clear() { NumWarnings = NumErrors = 0; }
1502 /// Callback to inform the diagnostic client that processing
1503 /// of a source file is beginning.
1505 /// Note that diagnostics may be emitted outside the processing of a source
1506 /// file, for example during the parsing of command line options. However,
1507 /// diagnostics with source range information are required to only be emitted
1508 /// in between BeginSourceFile() and EndSourceFile().
1510 /// \param LangOpts The language options for the source file being processed.
1511 /// \param PP The preprocessor object being used for the source; this is
1512 /// optional, e.g., it may not be present when processing AST source files.
1513 virtual void BeginSourceFile(const LangOptions &LangOpts,
1514 const Preprocessor *PP = nullptr) {}
1516 /// Callback to inform the diagnostic client that processing
1517 /// of a source file has ended.
1519 /// The diagnostic client should assume that any objects made available via
1520 /// BeginSourceFile() are inaccessible.
1521 virtual void EndSourceFile() {}
1523 /// Callback to inform the diagnostic client that processing of all
1524 /// source files has ended.
1525 virtual void finish() {}
1527 /// Indicates whether the diagnostics handled by this
1528 /// DiagnosticConsumer should be included in the number of diagnostics
1529 /// reported by DiagnosticsEngine.
1531 /// The default implementation returns true.
1532 virtual bool IncludeInDiagnosticCounts() const;
1534 /// Handle this diagnostic, reporting it to the user or
1535 /// capturing it to a log as needed.
1537 /// The default implementation just keeps track of the total number of
1538 /// warnings and errors.
1539 virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1540 const Diagnostic &Info);
1543 /// A diagnostic client that ignores all diagnostics.
1544 class IgnoringDiagConsumer : public DiagnosticConsumer {
1545 virtual void anchor();
1547 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1548 const Diagnostic &Info) override {
1553 /// Diagnostic consumer that forwards diagnostics along to an
1554 /// existing, already-initialized diagnostic consumer.
1556 class ForwardingDiagnosticConsumer : public DiagnosticConsumer {
1557 DiagnosticConsumer &Target;
1560 ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {}
1561 ~ForwardingDiagnosticConsumer() override;
1563 void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1564 const Diagnostic &Info) override;
1565 void clear() override;
1567 bool IncludeInDiagnosticCounts() const override;
1570 // Struct used for sending info about how a type should be printed.
1571 struct TemplateDiffTypes {
1574 unsigned PrintTree : 1;
1575 unsigned PrintFromType : 1;
1576 unsigned ElideType : 1;
1577 unsigned ShowColors : 1;
1579 // The printer sets this variable to true if the template diff was used.
1580 unsigned TemplateDiffUsed : 1;
1583 /// Special character that the diagnostic printer will use to toggle the bold
1584 /// attribute. The character itself will be not be printed.
1585 const char ToggleHighlight = 127;
1587 /// ProcessWarningOptions - Initialize the diagnostic client and process the
1588 /// warning options specified on the command line.
1589 void ProcessWarningOptions(DiagnosticsEngine &Diags,
1590 const DiagnosticOptions &Opts,
1591 bool ReportDiags = true);
1593 } // namespace clang
1595 #endif // LLVM_CLANG_BASIC_DIAGNOSTIC_H