15 #ifndef LLVM_CLANG_BASIC_DIAGNOSTIC_H
16 #define LLVM_CLANG_BASIC_DIAGNOSTIC_H
22 #include "llvm/ADT/ArrayRef.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/IntrusiveRefCntPtr.h"
25 #include "llvm/ADT/iterator_range.h"
31 class DiagnosticBuilder;
32 class DiagnosticConsumer;
33 class DiagnosticErrorTrap;
34 class DiagnosticOptions;
38 class StoredDiagnostic;
171 unsigned char AllExtensionsSilenced;
172 bool IgnoreAllWarnings;
173 bool WarningsAsErrors;
174 bool EnableAllWarnings;
176 bool SuppressSystemWarnings;
177 bool SuppressAllDiagnostics;
179 bool PrintTemplateTree;
183 unsigned TemplateBacktraceLimit;
185 unsigned ConstexprBacktraceLimit;
191 std::unique_ptr<DiagnosticConsumer> Owner;
206 llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap;
209 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator;
210 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator
214 DiagMap[
Diag] = Info;
219 const_iterator begin()
const {
return DiagMap.begin(); }
220 const_iterator end()
const {
return DiagMap.end(); }
224 std::list<DiagState> DiagStates;
231 struct DiagStatePoint {
235 : State(State), Loc(Loc) { }
237 bool operator<(
const DiagStatePoint &RHS)
const {
240 if (RHS.Loc.isInvalid())
244 return Loc.isBeforeInTranslationUnitThan(RHS.Loc);
253 typedef std::vector<DiagStatePoint> DiagStatePointsTy;
254 mutable DiagStatePointsTy DiagStatePoints;
258 std::vector<DiagState *> DiagStateOnPushStack;
260 DiagState *GetCurDiagState()
const {
261 assert(!DiagStatePoints.empty());
262 return DiagStatePoints.back().State;
265 void PushDiagStatePoint(DiagState *
State, SourceLocation L) {
268 assert(Loc.isValid() &&
"Adding invalid loc point");
269 assert(!DiagStatePoints.empty() &&
270 (DiagStatePoints.back().Loc.isInvalid() ||
271 DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) &&
272 "Previous point loc comes after or is the same as new one");
273 DiagStatePoints.push_back(DiagStatePoint(State, Loc));
278 DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc)
const;
285 bool UncompilableErrorOccurred;
288 bool FatalErrorOccurred;
291 bool UnrecoverableErrorOccurred;
295 unsigned TrapNumErrorsOccurred;
296 unsigned TrapNumUnrecoverableErrorsOccurred;
304 unsigned NumWarnings;
317 typedef void (*ArgToStringFnTy)(
319 StringRef Modifier, StringRef Argument,
320 ArrayRef<ArgumentValue> PrevArgs,
321 SmallVectorImpl<char> &Output,
323 ArrayRef<intptr_t> QualTypeVals);
324 void *ArgToStringCookie;
325 ArgToStringFnTy ArgToStringFn;
330 unsigned DelayedDiagID;
333 std::string DelayedDiagArg1;
336 std::string DelayedDiagArg2;
343 std::string FlagValue;
346 explicit DiagnosticsEngine(
347 const IntrusiveRefCntPtr<DiagnosticIDs> &Diags,
348 DiagnosticOptions *DiagOpts,
349 DiagnosticConsumer *client =
nullptr,
350 bool ShouldOwnClient =
true);
364 const DiagState &DS = *GetCurDiagState();
376 std::unique_ptr<DiagnosticConsumer>
takeClient() {
return std::move(Owner); }
380 assert(SourceMgr &&
"SourceManager not set!");
416 TemplateBacktraceLimit = Limit;
422 return TemplateBacktraceLimit;
428 ConstexprBacktraceLimit = Limit;
434 return ConstexprBacktraceLimit;
466 SuppressAllDiagnostics = Val;
500 FatalErrorOccurred =
true;
578 return UncompilableErrorOccurred;
584 return FatalErrorOccurred || UnrecoverableErrorOccurred;
590 this->NumWarnings = NumWarnings;
601 template <
unsigned N>
604 StringRef(FormatString, N - 1));
610 StringRef Modifier, StringRef Argument,
614 ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output,
615 ArgToStringCookie, QualTypeVals);
620 ArgToStringCookie = Cookie;
626 LastDiagLevel = Other.LastDiagLevel;
646 return Diags->getDiagnosticSeverity(DiagID, Loc, *
this) ==
661 return (
Level)Diags->getDiagnosticLevel(DiagID, Loc, *
this);
702 StringRef Arg2 =
"");
712 void ReportDelayed();
744 signed char NumDiagArgs;
751 unsigned char DiagArgumentsKind[MaxArguments];
757 std::string DiagArgumentsStr[MaxArguments];
764 intptr_t DiagArgumentsVal[MaxArguments];
792 return Diags->ProcessDiag(*
this);
825 unsigned NumUnrecoverableErrors;
829 : Diag(Diag) {
reset(); }
834 return Diag.TrapNumErrorsOccurred > NumErrors;
840 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
845 NumErrors = Diag.TrapNumErrorsOccurred;
846 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
868 mutable unsigned NumArgs;
875 mutable bool IsActive;
879 mutable bool IsForceEmit;
885 : DiagObj(nullptr), NumArgs(0), IsActive(
false), IsForceEmit(
false) {}
888 : DiagObj(diagObj), NumArgs(0), IsActive(
true), IsForceEmit(
false) {
889 assert(diagObj &&
"DiagnosticBuilder requires a valid DiagnosticsEngine!");
890 diagObj->DiagRanges.clear();
891 diagObj->DiagFixItHints.clear();
898 DiagObj->NumDiagArgs = NumArgs;
941 IsActive = D.IsActive;
942 IsForceEmit = D.IsForceEmit;
970 operator bool()
const {
return true; }
973 assert(
isActive() &&
"Clients must not add to cleared diagnostic!");
974 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
975 "Too many arguments to diagnostic!");
977 DiagObj->DiagArgumentsStr[NumArgs++] =
S;
981 assert(
isActive() &&
"Clients must not add to cleared diagnostic!");
982 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
983 "Too many arguments to diagnostic!");
984 DiagObj->DiagArgumentsKind[NumArgs] =
Kind;
985 DiagObj->DiagArgumentsVal[NumArgs++] = V;
989 assert(
isActive() &&
"Clients must not add to cleared diagnostic!");
990 DiagObj->DiagRanges.push_back(R);
994 assert(
isActive() &&
"Clients must not add to cleared diagnostic!");
996 DiagObj->DiagFixItHints.push_back(Hint);
1037 template <
typename T>
1039 typename std::enable_if<std::is_same<T, bool>::value,
1040 const DiagnosticBuilder &>
::type
1069 template<
typename T>
1071 typename std::enable_if<std::is_same<T, DeclContext>::value,
1072 const DiagnosticBuilder &>
::type
1120 assert(CurDiagID == ~0U &&
"Multiple diagnostics in flight at once!");
1140 StringRef StoredDiagMessage;
1144 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
1147 unsigned getID()
const {
return DiagObj->CurDiagID; }
1161 assert(Idx <
getNumArgs() &&
"Argument index out of range!");
1169 "invalid argument accessor!");
1170 return DiagObj->DiagArgumentsStr[Idx];
1177 "invalid argument accessor!");
1178 return reinterpret_cast<const char*
>(DiagObj->DiagArgumentsVal[Idx]);
1185 "invalid argument accessor!");
1186 return (
int)DiagObj->DiagArgumentsVal[Idx];
1193 "invalid argument accessor!");
1194 return (
unsigned)DiagObj->DiagArgumentsVal[Idx];
1201 "invalid argument accessor!");
1202 return reinterpret_cast<IdentifierInfo*
>(DiagObj->DiagArgumentsVal[Idx]);
1209 "invalid argument accessor!");
1210 return DiagObj->DiagArgumentsVal[Idx];
1215 return DiagObj->DiagRanges.size();
1220 assert(Idx <
getNumRanges() &&
"Invalid diagnostic range index!");
1221 return DiagObj->DiagRanges[Idx];
1226 return DiagObj->DiagRanges;
1230 return DiagObj->DiagFixItHints.size();
1235 return DiagObj->DiagFixItHints[Idx];
1239 return DiagObj->DiagFixItHints;
1262 std::string Message;
1263 std::vector<CharSourceRange> Ranges;
1264 std::vector<FixItHint> FixIts;
1278 explicit operator bool()
const {
return Message.size() > 0; }
1293 return llvm::makeArrayRef(Ranges);
1303 return llvm::makeArrayRef(FixIts);
1366 virtual void anchor();
1386 void clear()
override;
1412 bool ReportDiags =
true);
void setSeverityForAll(diag::Flavor Flavor, diag::Severity Map, SourceLocation Loc=SourceLocation())
Add the specified mapping to all diagnostics of the specified flavor.
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
unsigned getNumWarnings() const
std::vector< CharSourceRange >::const_iterator range_iterator
static FixItHint CreateRemoval(SourceRange RemoveRange)
DiagnosticConsumer * getClient()
bool isActive() const
Determine whether this diagnostic is still active.
void setShowColors(bool Val=false)
Set color printing, so the type diffing will inject color markers into the output.
void pushMappings(SourceLocation Loc)
Copies the current DiagMappings and pushes the new copy onto the top of the stack.
unsigned getNumArgs() const
unsigned getTemplateBacktraceLimit() const
Retrieve the maximum number of template instantiation notes to emit along with a given diagnostic...
StringRef getFlagValue() const
Return the value associated with this diagnostic flag.
bool getIgnoreAllWarnings() const
unsigned NumErrors
Number of errors reported.
static CharSourceRange getTokenRange(SourceRange R)
void setShowOverloads(OverloadsShown Val)
Specify which overload candidates to show when overload resolution fails.
StringRef getMessage() const
const std::string & getArgStdStr(unsigned Idx) const
Return the provided argument string specified by Idx.
~DiagnosticBuilder()
Emits the diagnostic.
Represents a diagnostic in a form that can be retained until its corresponding source manager is dest...
bool hasErrorOccurred() const
const DiagnosticBuilder & operator<<(const DiagnosticBuilder &DB, const Attr *At)
void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info) override
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
const FullSourceLoc & getLocation() const
std::string CodeToInsert
The actual code to insert at the insertion location, as a string.
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, CharSourceRange FromRange, bool BeforePreviousInsertions=false)
Create a code modification hint that inserts the given code from FromRange at a specific location...
void ConvertArgToString(ArgumentKind Kind, intptr_t Val, StringRef Modifier, StringRef Argument, ArrayRef< ArgumentValue > PrevArgs, SmallVectorImpl< char > &Output, ArrayRef< intptr_t > QualTypeVals) const
Converts a diagnostic argument (as an intptr_t) into the string that represents it.
bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled)
Set the warning-as-error flag for the given diagnostic group.
std::unique_ptr< DiagnosticConsumer > takeClient()
Return the current diagnostic client along with ownership of that client.
bool hasErrorOccurred() const
Determine whether any errors have occurred since this object instance was created.
bool getWarningsAsErrors() const
virtual void EndSourceFile()
Callback to inform the diagnostic client that processing of a source file has ended.
Abstract interface, implemented by clients of the front-end, which formats and prints fully processed...
RAII class that determines when any errors have occurred between the time the instance was created an...
void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1="", StringRef Arg2="")
Set the "delayed" diagnostic that will be emitted once the current diagnostic completes.
void setTemplateBacktraceLimit(unsigned Limit)
Specify the maximum number of template instantiation notes to emit along with a given diagnostic...
void Clear() const
Clear out the current diagnostic.
fixit_iterator fixit_end() const
void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const
unsigned getNumWarnings() const
void setClient(DiagnosticConsumer *client, bool ShouldOwnClient=true)
Set the diagnostic client associated with this diagnostic object.
void IncrementAllExtensionsSilenced()
Counter bumped when an extension block is/ encountered.
const DiagnosticsEngine * getDiags() const
bool isDiagnosticInFlight() const
Determine whethere there is already a diagnostic in flight.
bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled)
Set the error-as-fatal flag for the given diagnostic group.
int getArgSInt(unsigned Idx) const
Return the specified signed integer argument.
void setExtensionHandlingBehavior(diag::Severity H)
Controls whether otherwise-unmapped extension diagnostics are mapped onto ignore/warning/error.
ForwardingDiagnosticConsumer(DiagnosticConsumer &Target)
void addFlagValue(StringRef V) const
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
SourceManager & getSourceManager() const
static DiagnosticBuilder getEmpty()
Retrieve an empty diagnostic builder.
void setPrintTemplateTree(bool Val=false)
Set tree printing, to outputting the template difference in a tree format.
std::pair< NullabilityKind, bool > DiagNullabilityKind
void setSourceManager(SourceManager *SrcMgr)
bool hasUnrecoverableErrorOccurred() const
Determine whether any kind of unrecoverable error has occurred.
bool hasUnrecoverableErrorOccurred() const
Determine whether any unrecoverable errors have occurred since this object instance was created...
bool isLastDiagnosticIgnored() const
Determine whether the previous diagnostic was ignored. This can be used by clients that want to deter...
const SourceLocation & getLocation() const
unsigned getNumRanges() const
Return the number of source ranges associated with this diagnostic.
virtual bool IncludeInDiagnosticCounts() const
Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number...
Concrete class used by the front-end to report problems and issues.
bool hasAllExtensionsSilenced()
bool setSeverityForGroup(diag::Flavor Flavor, StringRef Group, diag::Severity Map, SourceLocation Loc=SourceLocation())
Change an entire diagnostic group (e.g. "unknown-pragmas") to have the specified mapping.
llvm::iterator_range< DiagState::const_iterator > diag_mapping_range
fixit_iterator fixit_begin() const
DiagnosticBuilder(const DiagnosticBuilder &D)
const char * getArgCStr(unsigned Idx) const
Return the specified C string argument.
const IntrusiveRefCntPtr< DiagnosticIDs > & getDiagnosticIDs() const
void Reset()
Reset the state of the diagnostic object to its initial configuration.
bool IncludeInDiagnosticCounts() const override
Indicates whether the diagnostics handled by this DiagnosticConsumer should be included in the number...
Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
const IdentifierInfo * getArgIdentifier(unsigned Idx) const
Return the specified IdentifierInfo argument.
bool EmitCurrentDiagnostic(bool Force=false)
Emit the current diagnostic and clear the diagnostic state.
const DiagnosticConsumer * getClient() const
void setLastDiagnosticIgnored()
Pretend that the last diagnostic issued was ignored, so any subsequent notes will be suppressed...
Sema - This implements semantic analysis and AST building for C.
diag::Severity getExtensionHandlingBehavior() const
A little helper class used to produce diagnostics.
unsigned getCurrentDiagID() const
virtual ~DiagnosticConsumer()
friend class DiagnosticBuilder
Represents a character-granular source range.
bool hasFatalErrorOccurred() const
DiagnosticErrorTrap(DiagnosticsEngine &Diag)
range_iterator range_begin() const
void setElideType(bool Val=true)
Set type eliding, to skip outputting same types occurring in template types.
unsigned TemplateDiffUsed
intptr_t getRawArg(unsigned Idx) const
Return the specified non-string argument in an opaque form.
diag_mapping_range getDiagnosticMappings() const
Get the current set of diagnostic mappings.
AddFlagValue(StringRef V)
std::pair< ArgumentKind, intptr_t > ArgumentValue
Represents on argument value, which is a union discriminated by ArgumentKind, with a value...
unsigned getConstexprBacktraceLimit() const
Retrieve the maximum number of constexpr evaluation notes to emit along with a given diagnostic...
void AddString(StringRef S) const
void Clear()
Clear out the current diagnostic.
void AddSourceRange(const CharSourceRange &R) const
bool BeforePreviousInsertions
void setEnableAllWarnings(bool Val)
When set to true, any unmapped ignored warnings are no longer ignored.
The result type of a method or function.
CharSourceRange InsertFromRange
Code in the specific range that should be inserted in the insertion location.
static CharSourceRange getCharRange(SourceRange R)
void AddFixItHint(const FixItHint &Hint) const
bool getSuppressSystemWarnings() const
CharSourceRange RemoveRange
Code that should be replaced to correct the error. Empty for an insertion hint.
ArrayRef< FixItHint > getFixIts() const
void setSuppressSystemWarnings(bool Val)
When set to true mask warnings that come from system headers.
Encodes a location in the source. The SourceManager can decode this to get at the full include stack...
bool isValid() const
Return true if this is a valid SourceLocation object.
Options for controlling the compiler diagnostics engine.
virtual void finish()
Callback to inform the diagnostic client that processing of all source files has ended.
bool getSuppressAllDiagnostics() const
bool getPrintTemplateTree()
const char ToggleHighlight
Diagnostic consumer that forwards diagnostics along to an existing, already-initialized diagnostic co...
void ProcessWarningOptions(DiagnosticsEngine &Diags, const DiagnosticOptions &Opts, bool ReportDiags=true)
void reset()
Set to initial state of "no errors occurred".
unsigned range_size() const
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie)
unsigned NumWarnings
Number of warnings reported.
void setNoErrorAsFatal(bool Value)
DiagnosticOptions & getDiagnosticOptions() const
Retrieve the diagnostic options.
~ForwardingDiagnosticConsumer() override
virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info)
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
unsigned getCustomDiagID(Level L, const char(&FormatString)[N])
Return an ID for a diagnostic with the specified format string and level.
bool operator<(DeclarationName LHS, DeclarationName RHS)
bool getEnableAllWarnings() const
void setNumWarnings(unsigned NumWarnings)
static DiagnosticMapping Make(diag::Severity Severity, bool IsUser, bool IsPragma)
bool isIgnored(unsigned DiagID, SourceLocation Loc) const
Determine whether the diagnostic is known to be ignored.
const DiagnosticBuilder & setForceEmit() const
Forces the diagnostic to be emitted.
DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const
Return the kind of the specified index.
Defines various enumerations that describe declaration and type specifiers.
void setErrorLimit(unsigned Limit)
Specify a limit for the number of errors we should emit before giving up.
void setIgnoreAllWarnings(bool Val)
When set to true, any unmapped warnings are ignored.
A diagnostic client that ignores all diagnostics.
range_iterator range_end() const
bool hasSourceManager() const
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
Reads an AST files chain containing the contents of a translation unit.
static FixItHint CreateRemoval(CharSourceRange RemoveRange)
Create a code modification hint that removes the given source range.
Level
The level of the diagnostic, after it has been through mapping.
Used for handling and querying diagnostic IDs.
bool getErrorsAsFatal() const
void setErrorsAsFatal(bool Val)
When set to true, any error reported is made a fatal error.
ArrayRef< CharSourceRange > getRanges() const
Return an array reference for this diagnostic's ranges.
const FixItHint & getFixItHint(unsigned Idx) const
std::vector< FixItHint >::const_iterator fixit_iterator
bool hasSourceManager() const
void setWarningsAsErrors(bool Val)
When set to true, any warnings reported are issued as errors.
SourceManager & getSourceManager() const
void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc)
This allows the client to specify that certain warnings are ignored.
bool popMappings(SourceLocation Loc)
Pops the current DiagMappings off the top of the stack, causing the new top of the stack to be the ac...
void setConstexprBacktraceLimit(unsigned Limit)
Specify the maximum number of constexpr evaluation notes to emit along with a given diagnostic...
unsigned fixit_size() const
static FixItHint CreateInsertion(SourceLocation InsertionLoc, StringRef Code, bool BeforePreviousInsertions=false)
Create a code modification hint that inserts the given code string at a specific location.
ArrayRef< CharSourceRange > getRanges() const
Diagnostic(const DiagnosticsEngine *DO)
void DecrementAllExtensionsSilenced()
void setSuppressAllDiagnostics(bool Val=true)
Suppress all diagnostics, to silence the front end when we know that we don't want any more diagnosti...
static FixItHint CreateReplacement(SourceRange RemoveRange, StringRef Code)
Defines the clang::SourceLocation class and associated facilities.
OverloadsShown
Specifies which overload candidates to display when overload resolution fails.
OverloadsShown getShowOverloads() const
Level
The level of the diagnostic, after it has been through mapping.
Do not present this diagnostic, ignore it.
static FixItHint CreateReplacement(CharSourceRange RemoveRange, StringRef Code)
Create a code modification hint that replaces the given source range with the given code string...
Writes an AST file containing the contents of a translation unit.
const CharSourceRange & getRange(unsigned Idx) const
unsigned getNumFixItHints() const
DiagnosticsEngine::Level getLevel() const
A SourceLocation and its associated SourceManager.
Defines the Diagnostic IDs-related interfaces.
unsigned getNumErrors() const
unsigned getArgUInt(unsigned Idx) const
Return the specified unsigned integer argument.
Annotates a diagnostic with some code that should be inserted, removed, or replaced to fix the proble...
SourceLocation getCurrentDiagLoc() const
void setNoWarningAsError(bool Value)
bool Emit()
Force the diagnostic builder to emit the diagnostic now.
bool ownsClient() const
Determine whether this DiagnosticsEngine object own its client.
A trivial tuple used to represent a source range.
void setLocation(FullSourceLoc Loc)
void FormatDiagnostic(SmallVectorImpl< char > &OutStr) const
Format this diagnostic into a string, substituting the formal arguments into the %0 slots...
Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const
Based on the way the client configured the DiagnosticsEngine object, classify the specified diagnosti...
virtual void BeginSourceFile(const LangOptions &LangOpts, const Preprocessor *PP=nullptr)
Callback to inform the diagnostic client that processing of a source file is beginning.
FixItHint()
Empty code modification hint, indicating that no code modification is known.
bool hasUncompilableErrorOccurred() const
Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror...
This class handles loading and caching of source files into memory.
ArrayRef< FixItHint > getFixItHints() const
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
enum TokenKind : unsigned
void notePriorDiagnosticFrom(const DiagnosticsEngine &Other)
Note that the prior diagnostic was emitted by some other DiagnosticsEngine, and we may be attaching a...