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" 26 #include "llvm/ADT/SmallVector.h" 27 #include "llvm/ADT/StringRef.h" 35 #include <type_traits> 42 class DiagnosticBuilder;
43 class DiagnosticConsumer;
47 class StoredDiagnostic;
92 bool BeforePreviousInsertions =
false) {
105 bool BeforePreviousInsertions =
false) {
180 unsigned char AllExtensionsSilenced;
181 bool SuppressAfterFatalError;
182 bool SuppressAllDiagnostics;
184 bool PrintTemplateTree;
188 unsigned TemplateBacktraceLimit;
190 unsigned ConstexprBacktraceLimit;
195 std::unique_ptr<DiagnosticConsumer> Owner;
210 llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap;
214 unsigned IgnoreAllWarnings : 1;
215 unsigned EnableAllWarnings : 1;
216 unsigned WarningsAsErrors : 1;
217 unsigned ErrorsAsFatal : 1;
218 unsigned SuppressSystemWarnings : 1;
222 : IgnoreAllWarnings(
false), EnableAllWarnings(
false),
223 WarningsAsErrors(
false), ErrorsAsFatal(
false),
226 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator;
227 typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator
231 DiagMap[
Diag] = Info;
234 return DiagMap.lookup(Diag);
239 const_iterator begin()
const {
return DiagMap.begin(); }
240 const_iterator end()
const {
return DiagMap.end(); }
244 std::list<DiagState> DiagStates;
251 void appendFirst(DiagState *
State);
257 bool empty()
const {
return Files.empty(); }
261 FirstDiagState = CurDiagState =
nullptr;
266 DiagState *getCurDiagState()
const {
return CurDiagState; }
268 SourceLocation getCurDiagStateLoc()
const {
return CurDiagStateLoc; }
276 struct DiagStatePoint {
279 DiagStatePoint(DiagState *State,
unsigned Offset)
291 unsigned ParentOffset = 0;
294 bool HasLocalTransitions =
false;
299 DiagState *lookup(
unsigned Offset)
const;
303 mutable std::map<FileID, File> Files;
306 DiagState *FirstDiagState;
308 DiagState *CurDiagState;
319 DiagStateMap DiagStatesByLoc;
323 std::vector<DiagState *> DiagStateOnPushStack;
325 DiagState *GetCurDiagState()
const {
326 return DiagStatesByLoc.getCurDiagState();
334 return SourceMgr ? DiagStatesByLoc.lookup(*SourceMgr, Loc)
335 : DiagStatesByLoc.getCurDiagState();
343 bool UncompilableErrorOccurred;
346 bool FatalErrorOccurred;
349 bool UnrecoverableErrorOccurred;
353 unsigned TrapNumErrorsOccurred;
354 unsigned TrapNumUnrecoverableErrorsOccurred;
362 unsigned NumWarnings;
375 typedef void (*ArgToStringFnTy)(
377 StringRef
Modifier, StringRef Argument,
382 void *ArgToStringCookie;
383 ArgToStringFnTy ArgToStringFn;
388 unsigned DelayedDiagID;
391 std::string DelayedDiagArg1;
394 std::string DelayedDiagArg2;
401 std::string FlagValue;
407 bool ShouldOwnClient =
true);
423 const DiagState &DS = *GetCurDiagState();
424 return diag_mapping_range(DS.begin(), DS.end());
435 std::unique_ptr<DiagnosticConsumer>
takeClient() {
return std::move(Owner); }
439 assert(SourceMgr &&
"SourceManager not set!");
443 assert(DiagStatesByLoc.empty() &&
444 "Leftover diag state from a different SourceManager.");
479 TemplateBacktraceLimit = Limit;
485 return TemplateBacktraceLimit;
491 ConstexprBacktraceLimit = Limit;
497 return ConstexprBacktraceLimit;
504 GetCurDiagState()->IgnoreAllWarnings = Val;
507 return GetCurDiagState()->IgnoreAllWarnings;
515 GetCurDiagState()->EnableAllWarnings = Val;
518 return GetCurDiagState()->EnableAllWarnings;
523 GetCurDiagState()->WarningsAsErrors = Val;
526 return GetCurDiagState()->WarningsAsErrors;
539 GetCurDiagState()->SuppressSystemWarnings = Val;
542 return GetCurDiagState()->SuppressSystemWarnings;
549 SuppressAllDiagnostics = Val;
585 FatalErrorOccurred =
true;
601 GetCurDiagState()->ExtBehavior = H;
604 return GetCurDiagState()->ExtBehavior;
645 bool setDiagnosticGroupWarningAsError(StringRef Group,
bool Enabled);
652 bool setDiagnosticGroupErrorAsFatal(StringRef Group,
bool Enabled);
667 return UncompilableErrorOccurred;
673 return FatalErrorOccurred || UnrecoverableErrorOccurred;
679 this->NumWarnings = NumWarnings;
690 template <
unsigned N>
693 StringRef(FormatString, N - 1));
699 StringRef Modifier, StringRef Argument,
703 ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output,
704 ArgToStringCookie, QualTypeVals);
709 ArgToStringCookie = Cookie;
715 LastDiagLevel = Other.LastDiagLevel;
735 return Diags->getDiagnosticSeverity(DiagID, Loc, *
this) ==
750 return (
Level)Diags->getDiagnosticLevel(DiagID, Loc, *
this);
790 void SetDelayedDiagnostic(
unsigned DiagID, StringRef Arg1 =
"",
791 StringRef Arg2 =
"");
801 void ReportDelayed();
833 signed char NumDiagArgs;
840 unsigned char DiagArgumentsKind[MaxArguments];
846 std::string DiagArgumentsStr[MaxArguments];
853 intptr_t DiagArgumentsVal[MaxArguments];
881 return Diags->ProcessDiag(*
this);
896 bool EmitCurrentDiagnostic(
bool Force =
false);
914 unsigned NumUnrecoverableErrors;
918 : Diag(Diag) { reset(); }
923 return Diag.TrapNumErrorsOccurred > NumErrors;
929 return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
934 NumErrors = Diag.TrapNumErrorsOccurred;
935 NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
957 mutable unsigned NumArgs = 0;
964 mutable bool IsActive =
false;
968 mutable bool IsForceEmit =
false;
975 : DiagObj(diagObj), IsActive(
true) {
976 assert(diagObj &&
"DiagnosticBuilder requires a valid DiagnosticsEngine!");
977 diagObj->DiagRanges.clear();
978 diagObj->DiagFixItHints.clear();
985 DiagObj->NumDiagArgs = NumArgs;
1008 if (!isActive())
return false;
1027 DiagObj = D.DiagObj;
1028 IsActive = D.IsActive;
1029 IsForceEmit = D.IsForceEmit;
1031 NumArgs = D.NumArgs;
1059 operator bool()
const {
return true; }
1062 assert(isActive() &&
"Clients must not add to cleared diagnostic!");
1063 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
1064 "Too many arguments to diagnostic!");
1066 DiagObj->DiagArgumentsStr[NumArgs++] = S;
1070 assert(isActive() &&
"Clients must not add to cleared diagnostic!");
1071 assert(NumArgs < DiagnosticsEngine::MaxArguments &&
1072 "Too many arguments to diagnostic!");
1073 DiagObj->DiagArgumentsKind[NumArgs] =
Kind;
1074 DiagObj->DiagArgumentsVal[NumArgs++] = V;
1078 assert(isActive() &&
"Clients must not add to cleared diagnostic!");
1079 DiagObj->DiagRanges.push_back(R);
1083 assert(isActive() &&
"Clients must not add to cleared diagnostic!");
1085 DiagObj->DiagFixItHints.push_back(Hint);
1126 template <
typename T>
1128 typename std::enable_if<std::is_same<T, bool>::value,
1158 template <
typename T>
1159 inline typename std::enable_if<
1205 DiagNullabilityKind nullability);
1209 assert(CurDiagID == ~0U &&
"Multiple diagnostics in flight at once!");
1229 StringRef StoredDiagMessage;
1234 : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
1237 unsigned getID()
const {
return DiagObj->CurDiagID; }
1251 assert(Idx < getNumArgs() &&
"Argument index out of range!");
1259 "invalid argument accessor!");
1260 return DiagObj->DiagArgumentsStr[Idx];
1267 "invalid argument accessor!");
1268 return reinterpret_cast<const char*
>(DiagObj->DiagArgumentsVal[Idx]);
1275 "invalid argument accessor!");
1276 return (
int)DiagObj->DiagArgumentsVal[Idx];
1283 "invalid argument accessor!");
1284 return (
unsigned)DiagObj->DiagArgumentsVal[Idx];
1291 "invalid argument accessor!");
1292 return reinterpret_cast<IdentifierInfo*
>(DiagObj->DiagArgumentsVal[Idx]);
1299 "invalid argument accessor!");
1300 return DiagObj->DiagArgumentsVal[Idx];
1305 return DiagObj->DiagRanges.size();
1310 assert(Idx < getNumRanges() &&
"Invalid diagnostic range index!");
1311 return DiagObj->DiagRanges[Idx];
1316 return DiagObj->DiagRanges;
1320 return DiagObj->DiagFixItHints.size();
1324 assert(Idx < getNumFixItHints() &&
"Invalid index!");
1325 return DiagObj->DiagFixItHints[Idx];
1329 return DiagObj->DiagFixItHints;
1340 void FormatDiagnostic(
const char *DiagStr,
const char *DiagEnd,
1352 std::string Message;
1353 std::vector<CharSourceRange> Ranges;
1354 std::vector<FixItHint> FixIts;
1367 explicit operator bool()
const {
return !Message.empty(); }
1382 return llvm::makeArrayRef(Ranges);
1391 return llvm::makeArrayRef(FixIts);
1399 unsigned NumWarnings = 0;
1400 unsigned NumErrors = 0;
1409 virtual void clear() { NumWarnings = NumErrors = 0; }
1441 virtual bool IncludeInDiagnosticCounts()
const;
1454 virtual void anchor();
1475 void clear()
override;
1477 bool IncludeInDiagnosticCounts()
const override;
1501 bool ReportDiags =
true);
1505 #endif // LLVM_CLANG_BASIC_DIAGNOSTIC_H
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
unsigned getTemplateBacktraceLimit() const
Retrieve the maximum number of template instantiation notes to emit along with a given diagnostic...
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.
std::vector< CharSourceRange >::const_iterator range_iterator
static FixItHint CreateRemoval(SourceRange RemoveRange)
bool hasErrorOccurred() const
DiagnosticConsumer * getClient()
unsigned fixit_size() const
fixit_iterator fixit_end() const
void setShowColors(bool Val=false)
Set color printing, so the type diffing will inject color markers into the output.
void AddFixItHint(const FixItHint &Hint) const
SourceManager & getSourceManager() const
bool getEnableAllWarnings() const
range_iterator range_begin() const
static CharSourceRange getTokenRange(SourceRange R)
void setShowOverloads(OverloadsShown Val)
Specify which overload candidates to show when overload resolution fails.
~DiagnosticBuilder()
Emits the diagnostic.
Represents a diagnostic in a form that can be retained until its corresponding source manager is dest...
const DiagnosticBuilder & operator<<(const DiagnosticBuilder &DB, const Attr *At)
std::string CodeToInsert
The actual code to insert at the insertion location, as a string.
const DiagnosticBuilder & setForceEmit() const
Forces the diagnostic to be emitted.
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...
DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const
Return the kind of the specified index.
unsigned range_size() const
range_iterator range_end() const
bool getSuppressSystemWarnings() const
std::unique_ptr< DiagnosticConsumer > takeClient()
Return the current diagnostic client along with ownership of that client.
diag::Severity getExtensionHandlingBehavior() const
const std::string & getArgStdStr(unsigned Idx) const
Return the provided argument string specified by Idx.
virtual void EndSourceFile()
Callback to inform the diagnostic client that processing of a source file has ended.
Severity
Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs to either Ignore (nothing)...
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 setTemplateBacktraceLimit(unsigned Limit)
Specify the maximum number of template instantiation notes to emit along with a given diagnostic...
bool hasSourceManager() const
const DiagnosticsEngine * getDiags() const
void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const
One of these records is kept for each identifier that is lexed.
unsigned getCurrentDiagID() const
const DiagnosticConsumer * getClient() const
void IncrementAllExtensionsSilenced()
Counter bumped when an extension block is/ encountered.
unsigned getNumErrors() const
const FixItHint & getFixItHint(unsigned Idx) const
void setExtensionHandlingBehavior(diag::Severity H)
Controls whether otherwise-unmapped extension diagnostics are mapped onto ignore/warning/error.
ForwardingDiagnosticConsumer(DiagnosticConsumer &Target)
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
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
A nullability kind paired with a bit indicating whether it used a context-sensitive keyword...
void setSuppressAfterFatalError(bool Val)
When set to true (the default), suppress further diagnostics after a fatal error. ...
void setSourceManager(SourceManager *SrcMgr)
unsigned getArgUInt(unsigned Idx) const
Return the specified unsigned integer argument.
bool isActive() const
Determine whether this diagnostic is still active.
StringRef getFlagValue() const
Return the value associated with this diagnostic flag.
const SourceLocation & getLocation() const
Concrete class used by the front-end to report problems and issues.
bool hasUnrecoverableErrorOccurred() const
Determine whether any kind of unrecoverable error has occurred.
bool hasAllExtensionsSilenced()
bool isDiagnosticInFlight() const
Determine whethere there is already a diagnostic in flight.
intptr_t getRawArg(unsigned Idx) const
Return the specified non-string argument in an opaque form.
ArrayRef< CharSourceRange > getRanges() const
llvm::iterator_range< DiagState::const_iterator > diag_mapping_range
DiagnosticBuilder(const DiagnosticBuilder &D)
Copy constructor.
SourceLocation getCurrentDiagLoc() const
__INTPTR_TYPE__ intptr_t
A signed integer type with the property that any valid pointer to void can be converted to this type...
StringRef getMessage() const
Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
bool EmitCurrentDiagnostic(bool Force=false)
Emit the current diagnostic and clear the diagnostic state.
Sema - This implements semantic analysis and AST building for C.
A little helper class used to produce diagnostics.
Represents a character-granular source range.
DiagnosticsEngine::Level getLevel() const
DiagnosticErrorTrap(DiagnosticsEngine &Diag)
bool hasUncompilableErrorOccurred() const
Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror...
const FunctionProtoType * T
unsigned getNumRanges() const
Return the number of source ranges associated with this diagnostic.
ArrayRef< FixItHint > getFixIts() const
void addFlagValue(StringRef V) const
const char * getArgCStr(unsigned Idx) const
Return the specified C string argument.
void setElideType(bool Val=true)
Set type eliding, to skip outputting same types occurring in template types.
unsigned TemplateDiffUsed
const IdentifierInfo * getArgIdentifier(unsigned Idx) const
Return the specified IdentifierInfo argument.
AddFlagValue(StringRef V)
std::pair< ArgumentKind, intptr_t > ArgumentValue
Represents on argument value, which is a union discriminated by ArgumentKind, with a value...
void Clear()
Clear out the current diagnostic.
bool BeforePreviousInsertions
void setEnableAllWarnings(bool Val)
When set to true, any unmapped ignored warnings are no longer ignored.
fixit_iterator fixit_begin() const
OverloadsShown getShowOverloads() const
CharSourceRange InsertFromRange
Code in the specific range that should be inserted in the insertion location.
unsigned getNumWarnings() const
static CharSourceRange getCharRange(SourceRange R)
CharSourceRange RemoveRange
Code that should be replaced to correct the error.
void AddSourceRange(const CharSourceRange &R) const
void Clear() const
Clear out the current diagnostic.
const CharSourceRange & getRange(unsigned Idx) const
void setSuppressSystemWarnings(bool Val)
When set to true mask warnings that come from system headers.
Encodes a location in the source.
bool hasErrorOccurred() const
Determine whether any errors have occurred since this object instance was created.
bool isLastDiagnosticIgnored() const
Determine whether the previous diagnostic was ignored.
unsigned getNumWarnings() const
Options for controlling the compiler diagnostics engine.
diag_mapping_range getDiagnosticMappings() const
Get the current set of diagnostic mappings.
virtual void finish()
Callback to inform the diagnostic client that processing of all source files has ended.
bool getPrintTemplateTree()
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.
const char ToggleHighlight
Special character that the diagnostic printer will use to toggle the bold attribute.
Diagnostic consumer that forwards diagnostics along to an existing, already-initialized diagnostic co...
void ProcessWarningOptions(DiagnosticsEngine &Diags, const DiagnosticOptions &Opts, bool ReportDiags=true)
ProcessWarningOptions - Initialize the diagnostic client and process the warning options specified on...
void reset()
Set to initial state of "no errors occurred".
void AddString(StringRef S) const
OpenMPLinearClauseKind Modifier
Modifier of 'linear' clause.
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie)
void setNoErrorAsFatal(bool Value)
Flavor
Flavors of diagnostics we can emit.
SourceManager & getSourceManager() const
unsigned getCustomDiagID(Level L, const char(&FormatString)[N])
Return an ID for a diagnostic with the specified format string and level.
void setNumWarnings(unsigned NumWarnings)
static DiagnosticMapping Make(diag::Severity Severity, bool IsUser, bool IsPragma)
void setLastDiagnosticIgnored(bool Ignored=true)
Pretend that the last diagnostic issued was ignored, so any subsequent notes will be suppressed...
bool getIgnoreAllWarnings() const
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.
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Dataflow Directional Tag Classes.
A diagnostic client that ignores all diagnostics.
Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const
Based on the way the client configured the DiagnosticsEngine object, classify the specified diagnosti...
bool isValid() const
Return true if this is a valid SourceLocation object.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Reads an AST files chain containing the contents of a translation unit.
const FullSourceLoc & getLocation() const
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 hasUnrecoverableErrorOccurred() const
Determine whether any unrecoverable errors have occurred since this object instance was created...
DiagnosticOptions & getDiagnosticOptions() const
Retrieve the diagnostic options.
void setErrorsAsFatal(bool Val)
When set to true, any error reported is made a fatal error.
std::vector< FixItHint >::const_iterator fixit_iterator
void setWarningsAsErrors(bool Val)
When set to true, any warnings reported are issued as errors.
unsigned getNumFixItHints() const
void setConstexprBacktraceLimit(unsigned Limit)
Specify the maximum number of constexpr evaluation notes to emit along with a given diagnostic...
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.
Diagnostic(const DiagnosticsEngine *DO)
unsigned getConstexprBacktraceLimit() const
Retrieve the maximum number of constexpr evaluation notes to emit along with a given diagnostic...
bool hasFatalErrorOccurred() const
void DecrementAllExtensionsSilenced()
int getArgSInt(unsigned Idx) const
Return the specified signed integer argument.
const IntrusiveRefCntPtr< DiagnosticIDs > & getDiagnosticIDs() const
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.
ArrayRef< CharSourceRange > getRanges() const
Return an array reference for this diagnostic's ranges.
ArrayRef< FixItHint > getFixItHints() const
OverloadsShown
Specifies which overload candidates to display when overload resolution fails.
Level
The level of the diagnostic, after it has been through mapping.
Do not present this diagnostic, ignore it.
bool hasSourceManager() const
unsigned kind
All of the diagnostics that can be emitted by the frontend.
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.
unsigned getNumArgs() const
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
A SourceLocation and its associated SourceManager.
Defines the Diagnostic IDs-related interfaces.
bool getErrorsAsFatal() const
bool isIgnored(unsigned DiagID, SourceLocation Loc) const
Determine whether the diagnostic is known to be ignored.
Annotates a diagnostic with some code that should be inserted, removed, or replaced to fix the proble...
void setNoWarningAsError(bool Value)
bool getWarningsAsErrors() const
bool Emit()
Force the diagnostic builder to emit the diagnostic now.
A trivial tuple used to represent a source range.
void setLocation(FullSourceLoc Loc)
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.
This class handles loading and caching of source files into memory.
bool getSuppressAllDiagnostics() const
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
bool ownsClient() const
Determine whether this DiagnosticsEngine object own its client.
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...