clang  6.0.0svn
Classes | Public Types | Public Member Functions | Friends | List of all members
clang::DiagnosticsEngine Class Reference

Concrete class used by the front-end to report problems and issues. More...

#include "clang/Basic/Diagnostic.h"

Inheritance diagram for clang::DiagnosticsEngine:
Inheritance graph
[legend]
Collaboration diagram for clang::DiagnosticsEngine:
Collaboration graph
[legend]

Public Types

enum  Level {
  Ignored = DiagnosticIDs::Ignored, Note = DiagnosticIDs::Note, Remark = DiagnosticIDs::Remark, Warning = DiagnosticIDs::Warning,
  Error = DiagnosticIDs::Error, Fatal = DiagnosticIDs::Fatal
}
 The level of the diagnostic, after it has been through mapping. More...
 
enum  ArgumentKind {
  ak_std_string, ak_c_string, ak_sint, ak_uint,
  ak_tokenkind, ak_identifierinfo, ak_qualtype, ak_declarationname,
  ak_nameddecl, ak_nestednamespec, ak_declcontext, ak_qualtype_pair,
  ak_attr
}
 
typedef std::pair< ArgumentKind, intptr_tArgumentValue
 Represents on argument value, which is a union discriminated by ArgumentKind, with a value. More...
 
typedef llvm::iterator_range< DiagState::const_iterator > diag_mapping_range
 

Public Member Functions

 DiagnosticsEngine (IntrusiveRefCntPtr< DiagnosticIDs > Diags, DiagnosticOptions *DiagOpts, DiagnosticConsumer *client=nullptr, bool ShouldOwnClient=true)
 
 DiagnosticsEngine (const DiagnosticsEngine &)=delete
 
DiagnosticsEngineoperator= (const DiagnosticsEngine &)=delete
 
 ~DiagnosticsEngine ()
 
const IntrusiveRefCntPtr< DiagnosticIDs > & getDiagnosticIDs () const
 
DiagnosticOptionsgetDiagnosticOptions () const
 Retrieve the diagnostic options. More...
 
diag_mapping_range getDiagnosticMappings () const
 Get the current set of diagnostic mappings. More...
 
DiagnosticConsumergetClient ()
 
const DiagnosticConsumergetClient () const
 
bool ownsClient () const
 Determine whether this DiagnosticsEngine object own its client. More...
 
std::unique_ptr< DiagnosticConsumertakeClient ()
 Return the current diagnostic client along with ownership of that client. More...
 
bool hasSourceManager () const
 
SourceManagergetSourceManager () const
 
void setSourceManager (SourceManager *SrcMgr)
 
void pushMappings (SourceLocation Loc)
 Copies the current DiagMappings and pushes the new copy onto the top of the stack. More...
 
bool popMappings (SourceLocation Loc)
 Pops the current DiagMappings off the top of the stack, causing the new top of the stack to be the active mappings. More...
 
void setClient (DiagnosticConsumer *client, bool ShouldOwnClient=true)
 Set the diagnostic client associated with this diagnostic object. More...
 
void setErrorLimit (unsigned Limit)
 Specify a limit for the number of errors we should emit before giving up. More...
 
void setTemplateBacktraceLimit (unsigned Limit)
 Specify the maximum number of template instantiation notes to emit along with a given diagnostic. More...
 
unsigned getTemplateBacktraceLimit () const
 Retrieve the maximum number of template instantiation notes to emit along with a given diagnostic. More...
 
void setConstexprBacktraceLimit (unsigned Limit)
 Specify the maximum number of constexpr evaluation notes to emit along with a given diagnostic. More...
 
unsigned getConstexprBacktraceLimit () const
 Retrieve the maximum number of constexpr evaluation notes to emit along with a given diagnostic. More...
 
void setIgnoreAllWarnings (bool Val)
 When set to true, any unmapped warnings are ignored. More...
 
bool getIgnoreAllWarnings () const
 
void setEnableAllWarnings (bool Val)
 When set to true, any unmapped ignored warnings are no longer ignored. More...
 
bool getEnableAllWarnings () const
 
void setWarningsAsErrors (bool Val)
 When set to true, any warnings reported are issued as errors. More...
 
bool getWarningsAsErrors () const
 
void setErrorsAsFatal (bool Val)
 When set to true, any error reported is made a fatal error. More...
 
bool getErrorsAsFatal () const
 
void setSuppressAfterFatalError (bool Val)
 When set to true (the default), suppress further diagnostics after a fatal error. More...
 
void setSuppressSystemWarnings (bool Val)
 When set to true mask warnings that come from system headers. More...
 
bool getSuppressSystemWarnings () const
 
void setSuppressAllDiagnostics (bool Val=true)
 Suppress all diagnostics, to silence the front end when we know that we don't want any more diagnostics to be passed along to the client. More...
 
bool getSuppressAllDiagnostics () const
 
void setElideType (bool Val=true)
 Set type eliding, to skip outputting same types occurring in template types. More...
 
bool getElideType ()
 
void setPrintTemplateTree (bool Val=false)
 Set tree printing, to outputting the template difference in a tree format. More...
 
bool getPrintTemplateTree ()
 
void setShowColors (bool Val=false)
 Set color printing, so the type diffing will inject color markers into the output. More...
 
bool getShowColors ()
 
void setShowOverloads (OverloadsShown Val)
 Specify which overload candidates to show when overload resolution fails. More...
 
OverloadsShown getShowOverloads () const
 
void setLastDiagnosticIgnored ()
 Pretend that the last diagnostic issued was ignored, so any subsequent notes will be suppressed. More...
 
bool isLastDiagnosticIgnored () const
 Determine whether the previous diagnostic was ignored. More...
 
void setExtensionHandlingBehavior (diag::Severity H)
 Controls whether otherwise-unmapped extension diagnostics are mapped onto ignore/warning/error. More...
 
diag::Severity getExtensionHandlingBehavior () const
 
void IncrementAllExtensionsSilenced ()
 Counter bumped when an extension block is/ encountered. More...
 
void DecrementAllExtensionsSilenced ()
 
bool hasAllExtensionsSilenced ()
 
void setSeverity (diag::kind Diag, diag::Severity Map, SourceLocation Loc)
 This allows the client to specify that certain warnings are ignored. More...
 
bool setSeverityForGroup (diag::Flavor Flavor, StringRef Group, diag::Severity Map, SourceLocation Loc=SourceLocation())
 Change an entire diagnostic group (e.g. More...
 
bool setDiagnosticGroupWarningAsError (StringRef Group, bool Enabled)
 Set the warning-as-error flag for the given diagnostic group. More...
 
bool setDiagnosticGroupErrorAsFatal (StringRef Group, bool Enabled)
 Set the error-as-fatal flag for the given diagnostic group. More...
 
void setSeverityForAll (diag::Flavor Flavor, diag::Severity Map, SourceLocation Loc=SourceLocation())
 Add the specified mapping to all diagnostics of the specified flavor. More...
 
bool hasErrorOccurred () const
 
bool hasUncompilableErrorOccurred () const
 Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror. More...
 
bool hasFatalErrorOccurred () const
 
bool hasUnrecoverableErrorOccurred () const
 Determine whether any kind of unrecoverable error has occurred. More...
 
unsigned getNumWarnings () const
 
void setNumWarnings (unsigned NumWarnings)
 
template<unsigned N>
unsigned getCustomDiagID (Level L, const char(&FormatString)[N])
 Return an ID for a diagnostic with the specified format string and level. More...
 
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. More...
 
void SetArgToStringFn (ArgToStringFnTy Fn, void *Cookie)
 
void notePriorDiagnosticFrom (const DiagnosticsEngine &Other)
 Note that the prior diagnostic was emitted by some other DiagnosticsEngine, and we may be attaching a note to that diagnostic. More...
 
void Reset ()
 Reset the state of the diagnostic object to its initial configuration. More...
 
bool isIgnored (unsigned DiagID, SourceLocation Loc) const
 Determine whether the diagnostic is known to be ignored. More...
 
Level getDiagnosticLevel (unsigned DiagID, SourceLocation Loc) const
 Based on the way the client configured the DiagnosticsEngine object, classify the specified diagnostic ID into a Level, consumable by the DiagnosticConsumer. More...
 
DiagnosticBuilder Report (SourceLocation Loc, unsigned DiagID)
 Issue the message to the client. More...
 
DiagnosticBuilder Report (unsigned DiagID)
 
void Report (const StoredDiagnostic &storedDiag)
 
bool isDiagnosticInFlight () const
 Determine whethere there is already a diagnostic in flight. More...
 
void SetDelayedDiagnostic (unsigned DiagID, StringRef Arg1="", StringRef Arg2="")
 Set the "delayed" diagnostic that will be emitted once the current diagnostic completes. More...
 
void Clear ()
 Clear out the current diagnostic. More...
 
StringRef getFlagValue () const
 Return the value associated with this diagnostic flag. More...
 

Friends

class DiagnosticIDs
 
class DiagnosticBuilder
 
class Diagnostic
 
class PartialDiagnostic
 
class DiagnosticErrorTrap
 
class ASTReader
 
class ASTWriter
 

Diagnostic Emission

class Sema
 
bool EmitCurrentDiagnostic (bool Force=false)
 Emit the current diagnostic and clear the diagnostic state. More...
 
unsigned getCurrentDiagID () const
 
SourceLocation getCurrentDiagLoc () const
 

Detailed Description

Concrete class used by the front-end to report problems and issues.

This massages the diagnostics (e.g. handling things like "report warnings as errors" and passes them off to the DiagnosticConsumer for reporting to the user. DiagnosticsEngine is tied to one translation unit and one SourceManager.

Definition at line 147 of file Diagnostic.h.

Member Typedef Documentation

◆ ArgumentValue

Represents on argument value, which is a union discriminated by ArgumentKind, with a value.

Definition at line 177 of file Diagnostic.h.

◆ diag_mapping_range

typedef llvm::iterator_range<DiagState::const_iterator> clang::DiagnosticsEngine::diag_mapping_range

Definition at line 419 of file Diagnostic.h.

Member Enumeration Documentation

◆ ArgumentKind

Enumerator
ak_std_string 

std::string

ak_c_string 

const char *

ak_sint 

int

ak_uint 

unsigned

ak_tokenkind 

enum TokenKind : unsigned

ak_identifierinfo 

IdentifierInfo.

ak_qualtype 

QualType.

ak_declarationname 

DeclarationName.

ak_nameddecl 

NamedDecl *.

ak_nestednamespec 

NestedNameSpecifier *.

ak_declcontext 

DeclContext *.

ak_qualtype_pair 

pair<QualType, QualType>

ak_attr 

Attr *.

Definition at line 159 of file Diagnostic.h.

◆ Level

The level of the diagnostic, after it has been through mapping.

Enumerator
Ignored 
Note 
Remark 
Warning 
Error 
Fatal 

Definition at line 150 of file Diagnostic.h.

Constructor & Destructor Documentation

◆ DiagnosticsEngine() [1/2]

DiagnosticsEngine::DiagnosticsEngine ( IntrusiveRefCntPtr< DiagnosticIDs Diags,
DiagnosticOptions DiagOpts,
DiagnosticConsumer client = nullptr,
bool  ShouldOwnClient = true 
)
explicit

Definition at line 59 of file Diagnostic.cpp.

References DummyArgToStringFn(), clang::Ovl_All, Reset(), and setClient().

◆ DiagnosticsEngine() [2/2]

clang::DiagnosticsEngine::DiagnosticsEngine ( const DiagnosticsEngine )
delete

◆ ~DiagnosticsEngine()

DiagnosticsEngine::~DiagnosticsEngine ( )

Definition at line 84 of file Diagnostic.cpp.

References setClient().

Member Function Documentation

◆ Clear()

void clang::DiagnosticsEngine::Clear ( )
inline

Clear out the current diagnostic.

Definition at line 792 of file Diagnostic.h.

Referenced by EmitCurrentDiagnostic(), clang::Sema::EmitCurrentDiagnostic(), and clang::PartialDiagnostic::EmitToString().

◆ ConvertArgToString()

void clang::DiagnosticsEngine::ConvertArgToString ( ArgumentKind  Kind,
intptr_t  Val,
StringRef  Modifier,
StringRef  Argument,
ArrayRef< ArgumentValue PrevArgs,
SmallVectorImpl< char > &  Output,
ArrayRef< intptr_t QualTypeVals 
) const
inline

Converts a diagnostic argument (as an intptr_t) into the string that represents it.

Definition at line 696 of file Diagnostic.h.

◆ DecrementAllExtensionsSilenced()

void clang::DiagnosticsEngine::DecrementAllExtensionsSilenced ( )
inline

Definition at line 610 of file Diagnostic.h.

Referenced by clang::ExtensionRAIIObject::~ExtensionRAIIObject().

◆ EmitCurrentDiagnostic()

bool DiagnosticsEngine::EmitCurrentDiagnostic ( bool  Force = false)
protected

Emit the current diagnostic and clear the diagnostic state.

Parameters
ForceEmit the diagnostic regardless of suppression settings.

Definition at line 399 of file Diagnostic.cpp.

References Clear(), getClient(), clang::Diagnostic::getID(), clang::Diagnostic::getLocation(), and clang::DiagnosticIDs::Ignored.

Referenced by clang::Sema::EmitCurrentDiagnostic().

◆ getClient() [1/2]

DiagnosticConsumer* clang::DiagnosticsEngine::getClient ( )
inline

◆ getClient() [2/2]

const DiagnosticConsumer* clang::DiagnosticsEngine::getClient ( ) const
inline

Definition at line 428 of file Diagnostic.h.

◆ getConstexprBacktraceLimit()

unsigned clang::DiagnosticsEngine::getConstexprBacktraceLimit ( ) const
inline

Retrieve the maximum number of constexpr evaluation notes to emit along with a given diagnostic.

Definition at line 496 of file Diagnostic.h.

◆ getCurrentDiagID()

unsigned clang::DiagnosticsEngine::getCurrentDiagID ( ) const
inlineprotected

Definition at line 896 of file Diagnostic.h.

Referenced by clang::Sema::EmitCurrentDiagnostic().

◆ getCurrentDiagLoc()

SourceLocation clang::DiagnosticsEngine::getCurrentDiagLoc ( ) const
inlineprotected

Definition at line 898 of file Diagnostic.h.

Referenced by clang::Sema::EmitCurrentDiagnostic().

◆ getCustomDiagID()

template<unsigned N>
unsigned clang::DiagnosticsEngine::getCustomDiagID ( Level  L,
const char(&)  FormatString[N] 
)
inline

Return an ID for a diagnostic with the specified format string and level.

If this is the first request for this diagnostic, it is registered and created, otherwise the existing ID is returned.

Parameters
FormatStringA fixed diagnostic format string that will be hashed and mapped to a unique DiagID.

Definition at line 689 of file Diagnostic.h.

Referenced by clang::CodeGen::CodeGenModule::Error(), clang::CodeGen::CodeGenModule::ErrorUnsupported(), clang::TextDiagnosticBuffer::FlushDiagnostics(), InvalidPTH(), IsHeaderFile(), reportDiag(), rewriteToNumericBoxedExpression(), and clang::TemplateDeclInstantiator::VisitVarTemplateSpecializationDecl().

◆ getDiagnosticIDs()

const IntrusiveRefCntPtr<DiagnosticIDs>& clang::DiagnosticsEngine::getDiagnosticIDs ( ) const
inline

◆ getDiagnosticLevel()

Level clang::DiagnosticsEngine::getDiagnosticLevel ( unsigned  DiagID,
SourceLocation  Loc 
) const
inline

Based on the way the client configured the DiagnosticsEngine object, classify the specified diagnostic ID into a Level, consumable by the DiagnosticConsumer.

To preserve invariant assumptions, this function should not be used to influence parse or semantic analysis actions. Instead consider using isIgnored().

Parameters
LocThe source location we are interested in finding out the diagnostic state. Can be null in order to query the latest state.

Definition at line 747 of file Diagnostic.h.

Referenced by checkDiagnosticGroupMappings(), EmitDeferredDiags(), clang::driver::Driver::ParseArgStrings(), and clang::Sema::CUDADiagBuilder::~CUDADiagBuilder().

◆ getDiagnosticMappings()

diag_mapping_range clang::DiagnosticsEngine::getDiagnosticMappings ( ) const
inline

Get the current set of diagnostic mappings.

Definition at line 422 of file Diagnostic.h.

◆ getDiagnosticOptions()

DiagnosticOptions& clang::DiagnosticsEngine::getDiagnosticOptions ( ) const
inline

Retrieve the diagnostic options.

Definition at line 417 of file Diagnostic.h.

Referenced by CheckResults(), and clang::html::HighlightMacros().

◆ getElideType()

bool clang::DiagnosticsEngine::getElideType ( )
inline

Definition at line 556 of file Diagnostic.h.

◆ getEnableAllWarnings()

bool clang::DiagnosticsEngine::getEnableAllWarnings ( ) const
inline

Definition at line 517 of file Diagnostic.h.

Referenced by checkDiagnosticMappings().

◆ getErrorsAsFatal()

bool clang::DiagnosticsEngine::getErrorsAsFatal ( ) const
inline

Definition at line 531 of file Diagnostic.h.

◆ getExtensionHandlingBehavior()

diag::Severity clang::DiagnosticsEngine::getExtensionHandlingBehavior ( ) const
inline

Definition at line 601 of file Diagnostic.h.

Referenced by HasExtension(), and isExtHandlingFromDiagsError().

◆ getFlagValue()

StringRef clang::DiagnosticsEngine::getFlagValue ( ) const
inline

Return the value associated with this diagnostic flag.

Definition at line 795 of file Diagnostic.h.

Referenced by printDiagnosticOptions().

◆ getIgnoreAllWarnings()

bool clang::DiagnosticsEngine::getIgnoreAllWarnings ( ) const
inline

Definition at line 506 of file Diagnostic.h.

◆ getNumWarnings()

unsigned clang::DiagnosticsEngine::getNumWarnings ( ) const
inline

Definition at line 674 of file Diagnostic.h.

Referenced by makeStandaloneDiagnostic().

◆ getPrintTemplateTree()

bool clang::DiagnosticsEngine::getPrintTemplateTree ( )
inline

Definition at line 561 of file Diagnostic.h.

◆ getShowColors()

bool clang::DiagnosticsEngine::getShowColors ( )
inline

Definition at line 566 of file Diagnostic.h.

◆ getShowOverloads()

OverloadsShown clang::DiagnosticsEngine::getShowOverloads ( ) const
inline

Definition at line 575 of file Diagnostic.h.

Referenced by clang::TemplateSpecCandidateSet::NoteCandidates().

◆ getSourceManager()

SourceManager& clang::DiagnosticsEngine::getSourceManager ( ) const
inline

Definition at line 438 of file Diagnostic.h.

Referenced by clang::Diagnostic::getSourceManager(), and toLevel().

◆ getSuppressAllDiagnostics()

bool clang::DiagnosticsEngine::getSuppressAllDiagnostics ( ) const
inline

Definition at line 551 of file Diagnostic.h.

Referenced by BuildCounterUpdate().

◆ getSuppressSystemWarnings()

bool clang::DiagnosticsEngine::getSuppressSystemWarnings ( ) const
inline

◆ getTemplateBacktraceLimit()

unsigned clang::DiagnosticsEngine::getTemplateBacktraceLimit ( ) const
inline

Retrieve the maximum number of template instantiation notes to emit along with a given diagnostic.

Definition at line 484 of file Diagnostic.h.

Referenced by clang::Sema::PrintInstantiationStack().

◆ getWarningsAsErrors()

bool clang::DiagnosticsEngine::getWarningsAsErrors ( ) const
inline

Definition at line 525 of file Diagnostic.h.

Referenced by checkDiagnosticMappings(), and isExtHandlingFromDiagsError().

◆ hasAllExtensionsSilenced()

bool clang::DiagnosticsEngine::hasAllExtensionsSilenced ( )
inline

Definition at line 611 of file Diagnostic.h.

References Diag().

Referenced by isPipeDeclerator().

◆ hasErrorOccurred()

bool clang::DiagnosticsEngine::hasErrorOccurred ( ) const
inline

◆ hasFatalErrorOccurred()

bool clang::DiagnosticsEngine::hasFatalErrorOccurred ( ) const
inline

◆ hasSourceManager()

bool clang::DiagnosticsEngine::hasSourceManager ( ) const
inline

Definition at line 437 of file Diagnostic.h.

Referenced by clang::Diagnostic::hasSourceManager().

◆ hasUncompilableErrorOccurred()

bool clang::DiagnosticsEngine::hasUncompilableErrorOccurred ( ) const
inline

Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror.

Definition at line 664 of file Diagnostic.h.

Referenced by clang::PCHGenerator::HandleTranslationUnit(), clang::Sema::CodeSynthesisContext::isInstantiationRecord(), clang::sema::AnalysisBasedWarnings::IssueWarnings(), and clang::ASTUnit::serialize().

◆ hasUnrecoverableErrorOccurred()

bool clang::DiagnosticsEngine::hasUnrecoverableErrorOccurred ( ) const
inline

Determine whether any kind of unrecoverable error has occurred.

Definition at line 670 of file Diagnostic.h.

Referenced by clang::arcmt::TransformActions::hasReportedErrors().

◆ IncrementAllExtensionsSilenced()

void clang::DiagnosticsEngine::IncrementAllExtensionsSilenced ( )
inline

Counter bumped when an extension block is/ encountered.

When non-zero, all extension diagnostics are entirely silenced, no matter how they are mapped.

Definition at line 609 of file Diagnostic.h.

Referenced by clang::ExtensionRAIIObject::ExtensionRAIIObject().

◆ isDiagnosticInFlight()

bool clang::DiagnosticsEngine::isDiagnosticInFlight ( ) const
inline

Determine whethere there is already a diagnostic in flight.

Definition at line 765 of file Diagnostic.h.

Referenced by clang::SrcMgr::ContentCache::getBuffer().

◆ isIgnored()

bool clang::DiagnosticsEngine::isIgnored ( unsigned  DiagID,
SourceLocation  Loc 
) const
inline

Determine whether the diagnostic is known to be ignored.

This can be used to opportunistically avoid expensive checks when it's known for certain that the diagnostic has been suppressed at the specified location Loc.

Parameters
LocThe source location we are interested in finding out the diagnostic state. Can be null in order to query the latest state.

Definition at line 732 of file Diagnostic.h.

References clang::diag::Ignored.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), CheckCommaOperands(), CheckCXX98CompatAccessibleCopy(), checkNullabilityConsistency(), DiagnoseBadFunctionCast(), DiagnoseBaseOrMemInitializerOrder(), DiagnoseCallingConvCast(), DiagnoseForRangeVariableCopies(), DiagnoseMismatchedNewDelete(), clang::Sema::DiagnoseMultipleMethodInGlobalPool(), isEnabled(), clang::sema::AnalysisBasedWarnings::IssueWarnings(), clang::HeaderSearch::LookupFile(), LookupMemberExpr(), LookupMethodInReceiverType(), maybeDiagnoseIDCharCompat(), ParseAlignPragma(), clang::Lexer::ReadToEndOfLine(), and shouldWarnIfShadowedDecl().

◆ isLastDiagnosticIgnored()

bool clang::DiagnosticsEngine::isLastDiagnosticIgnored ( ) const
inline

Determine whether the previous diagnostic was ignored.

This can be used by clients that want to determine whether notes attached to a diagnostic will be suppressed.

Definition at line 590 of file Diagnostic.h.

References clang::DiagnosticIDs::Ignored.

◆ notePriorDiagnosticFrom()

void clang::DiagnosticsEngine::notePriorDiagnosticFrom ( const DiagnosticsEngine Other)
inline

Note that the prior diagnostic was emitted by some other DiagnosticsEngine, and we may be attaching a note to that diagnostic.

Definition at line 712 of file Diagnostic.h.

Referenced by clang::ASTImporter::FromDiag(), and clang::ASTImporter::ToDiag().

◆ operator=()

DiagnosticsEngine& clang::DiagnosticsEngine::operator= ( const DiagnosticsEngine )
delete

◆ ownsClient()

bool clang::DiagnosticsEngine::ownsClient ( ) const
inline

Determine whether this DiagnosticsEngine object own its client.

Definition at line 431 of file Diagnostic.h.

Referenced by SetUpDiagnosticLog(), SetupSerializedDiagnostics(), and clang::VerifyDiagnosticConsumer::~VerifyDiagnosticConsumer().

◆ popMappings()

bool DiagnosticsEngine::popMappings ( SourceLocation  Loc)

Pops the current DiagMappings off the top of the stack, causing the new top of the stack to be the active mappings.

Returns
true if the pop happens, false if there is only one DiagMapping on the stack.

Definition at line 100 of file Diagnostic.cpp.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ pushMappings()

void DiagnosticsEngine::pushMappings ( SourceLocation  Loc)

Copies the current DiagMappings and pushes the new copy onto the top of the stack.

Definition at line 96 of file Diagnostic.cpp.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ Report() [1/3]

DiagnosticBuilder clang::DiagnosticsEngine::Report ( SourceLocation  Loc,
unsigned  DiagID 
)
inline

Issue the message to the client.

This actually returns an instance of DiagnosticBuilder which emits the diagnostics (through ProcessDiag) when it is destroyed.

Parameters
DiagIDA member of the diag::kind enum.
LocRepresents the source location associated with the diagnostic, which can be an invalid location if no position information is available.

Definition at line 1205 of file Diagnostic.h.

Referenced by clang::AttachHeaderIncludeGen(), clang::driver::Driver::BuildCompilation(), checkDiagnosticGroupMappings(), checkDiagnosticMappings(), checkHeaderSearchOptions(), checkLanguageOptions(), clang::Preprocessor::checkModuleIsAvailable(), checkMSVCHeaderSearch(), checkTargetOptions(), clang::CompilerInstance::clearOutputFiles(), collectModuleHeaderIncludes(), compileAndLoadModule(), clang::GeneratePCHAction::ComputeASTConsumerArguments(), computeKeyFunction(), clang::PTHManager::Create(), clang::DependencyFileGenerator::CreateAndAttachToPreprocessor(), clang::CodeGenAction::CreateASTConsumer(), clang::ento::createCheckerManager(), clang::CompilerInstance::createCodeCompletionConsumer(), clang::TestModuleFileExtension::createExtensionReader(), clang::CompilerInvocation::CreateFromArgs(), clang::CompilerInstance::createOutputFile(), clang::TargetInfo::CreateTargetInfo(), Diag(), clang::driver::Driver::Diag(), clang::Parser::Diag(), clang::Sema::Diag(), clang::Preprocessor::Diag(), clang::ModuleMap::diagnoseHeaderInclusion(), clang::PartialDiagnostic::EmitToString(), EmitUnknownDiagWarning(), EnableCodeCompletion(), clang::CodeGen::CodeGenModule::Error(), clang::CodeGen::CodeGenModule::ErrorUnsupported(), clang::CodeGenAction::ExecuteAction(), clang::ExecuteCompilerInvocation(), clang::TextDiagnosticBuffer::FlushDiagnostics(), clang::ASTImporter::FromDiag(), GenerateOptimizationRemarkRegex(), getAliasedGlobal(), clang::SrcMgr::ContentCache::getBuffer(), clang::tooling::getCC1Arguments(), getCodeModel(), getInputBufferForModule(), clang::getLastArgIntValueImpl(), getRelocModel(), clang::targets::ARMTargetInfo::handleTargetFeatures(), clang::targets::X86TargetInfo::handleTargetFeatures(), clang::Rewriter::IncreaseIndentation(), InitializeFileRemapping(), InvalidPTH(), clang::CodeGen::CodeGenModule::isTypeConstant(), clang::CompilerInstance::loadModule(), clang::CompilerInstance::loadModuleFromSource(), mapToLevel(), maybeDiagnoseIDCharCompat(), clang::driver::Driver::ParseArgStrings(), ParseCodeGenArgs(), parseDiagnosticLevelMask(), ParseFrontendArgs(), ParseLangArgs(), ParsePreprocessorArgs(), parseShowColorsArgs(), ParseTargetArgs(), parseVisibility(), ppcUserFeaturesCheck(), prepareToBuildModule(), PrintExpected(), clang::Sema::PrintInstantiationStack(), clang::Sema::PrintPragmaAttributeInstantiationPoint(), clang::ProcessWarningOptions(), clang::arcmt::TransformActions::report(), reportDiag(), clang::CodeGen::InstrProfStats::reportDiagnostics(), rewriteToNumericBoxedExpression(), setCommandLineOpts(), SetDelayedDiagnostic(), SetUpDiagnosticLog(), clang::StringLiteralParser::StringLiteralParser(), clang::ASTImporter::ToDiag(), clang::ento::CheckerRegistry::validateCheckerOptions(), clang::targets::MipsTargetInfo::validateTarget(), and Write_RethrowObject().

◆ Report() [2/3]

DiagnosticBuilder clang::DiagnosticsEngine::Report ( unsigned  DiagID)
inline

Definition at line 1214 of file Diagnostic.h.

◆ Report() [3/3]

void DiagnosticsEngine::Report ( const StoredDiagnostic storedDiag)

◆ Reset()

void DiagnosticsEngine::Reset ( )

Reset the state of the diagnostic object to its initial configuration.

Definition at line 112 of file Diagnostic.cpp.

References clang::DiagnosticIDs::Ignored.

Referenced by clang::FixItRecompile::BeginInvocation(), clang::PrecompiledPreamble::Build(), DiagnosticsEngine(), makeStandaloneDiagnostic(), and clang::ASTUnit::Reparse().

◆ SetArgToStringFn()

void clang::DiagnosticsEngine::SetArgToStringFn ( ArgToStringFnTy  Fn,
void *  Cookie 
)
inline

Definition at line 705 of file Diagnostic.h.

Referenced by clang::ASTMergeAction::ExecuteAction().

◆ setClient()

void DiagnosticsEngine::setClient ( DiagnosticConsumer client,
bool  ShouldOwnClient = true 
)

Set the diagnostic client associated with this diagnostic object.

Parameters
ShouldOwnClienttrue if the diagnostic object should take ownership of client.

Definition at line 90 of file Diagnostic.cpp.

Referenced by DiagnosticsEngine(), clang::FixItRewriter::FixItRewriter(), SetUpDiagnosticLog(), SetupSerializedDiagnostics(), ~DiagnosticsEngine(), and clang::FixItRewriter::~FixItRewriter().

◆ setConstexprBacktraceLimit()

void clang::DiagnosticsEngine::setConstexprBacktraceLimit ( unsigned  Limit)
inline

Specify the maximum number of constexpr evaluation notes to emit along with a given diagnostic.

Definition at line 490 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ SetDelayedDiagnostic()

void DiagnosticsEngine::SetDelayedDiagnostic ( unsigned  DiagID,
StringRef  Arg1 = "",
StringRef  Arg2 = "" 
)

Set the "delayed" diagnostic that will be emitted once the current diagnostic completes.

If a diagnostic is already in-flight but the front end must report a problem (e.g., with an inconsistent file system state), this routine sets a "delayed" diagnostic that will be emitted after the current diagnostic completes. This should only be used for fatal errors detected at inconvenient times. If emitting a delayed diagnostic causes a second delayed diagnostic to be introduced, that second delayed diagnostic will be ignored.

Parameters
DiagIDThe ID of the diagnostic being delayed.
Arg1A string argument that will be provided to the diagnostic. A copy of this string will be stored in the DiagnosticsEngine object itself.
Arg2A string argument that will be provided to the diagnostic. A copy of this string will be stored in the DiagnosticsEngine object itself.

Definition at line 138 of file Diagnostic.cpp.

References clang::SourceManager::getDecomposedIncludedLoc(), clang::SourceManager::getDecomposedLoc(), clang::FileID::isValid(), clang::SourceLocation::isValid(), P, Report(), and State.

Referenced by clang::SrcMgr::ContentCache::getBuffer(), and clang::DiagnosticIDs::getNearestOption().

◆ setDiagnosticGroupErrorAsFatal()

bool DiagnosticsEngine::setDiagnosticGroupErrorAsFatal ( StringRef  Group,
bool  Enabled 
)

Set the error-as-fatal flag for the given diagnostic group.

This function always only operates on the current diagnostic state.

Returns
True if the given group is unknown, false otherwise.

Definition at line 331 of file Diagnostic.cpp.

References Diag(), clang::diag::Error, clang::diag::Fatal, clang::DiagnosticMapping::getSeverity(), clang::DiagnosticMapping::setNoErrorAsFatal(), clang::DiagnosticMapping::setSeverity(), setSeverityForGroup(), and clang::diag::WarningOrError.

Referenced by clang::ProcessWarningOptions().

◆ setDiagnosticGroupWarningAsError()

bool DiagnosticsEngine::setDiagnosticGroupWarningAsError ( StringRef  Group,
bool  Enabled 
)

Set the warning-as-error flag for the given diagnostic group.

This function always only operates on the current diagnostic state.

Returns
True if the given group is unknown, false otherwise.

Definition at line 300 of file Diagnostic.cpp.

References Diag(), clang::diag::Error, clang::diag::Fatal, clang::DiagnosticMapping::getSeverity(), clang::DiagnosticMapping::setNoWarningAsError(), clang::DiagnosticMapping::setSeverity(), setSeverityForGroup(), clang::diag::Warning, and clang::diag::WarningOrError.

Referenced by clang::ProcessWarningOptions().

◆ setElideType()

void clang::DiagnosticsEngine::setElideType ( bool  Val = true)
inline

Set type eliding, to skip outputting same types occurring in template types.

Definition at line 555 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setEnableAllWarnings()

void clang::DiagnosticsEngine::setEnableAllWarnings ( bool  Val)
inline

When set to true, any unmapped ignored warnings are no longer ignored.

If this and IgnoreAllWarnings are both set, then that one wins.

Definition at line 514 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setErrorLimit()

void clang::DiagnosticsEngine::setErrorLimit ( unsigned  Limit)
inline

Specify a limit for the number of errors we should emit before giving up.

Zero disables the limit.

Definition at line 474 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setErrorsAsFatal()

void clang::DiagnosticsEngine::setErrorsAsFatal ( bool  Val)
inline

When set to true, any error reported is made a fatal error.

Definition at line 530 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setExtensionHandlingBehavior()

void clang::DiagnosticsEngine::setExtensionHandlingBehavior ( diag::Severity  H)
inline

Controls whether otherwise-unmapped extension diagnostics are mapped onto ignore/warning/error.

This corresponds to the GCC -pedantic and -pedantic-errors option.

Definition at line 598 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setIgnoreAllWarnings()

void clang::DiagnosticsEngine::setIgnoreAllWarnings ( bool  Val)
inline

◆ setLastDiagnosticIgnored()

void clang::DiagnosticsEngine::setLastDiagnosticIgnored ( )
inline

Pretend that the last diagnostic issued was ignored, so any subsequent notes will be suppressed.

This can be used by clients who suppress diagnostics themselves.

Definition at line 581 of file Diagnostic.h.

References clang::DiagnosticIDs::Fatal, and clang::DiagnosticIDs::Ignored.

Referenced by clang::Sema::EmitCurrentDiagnostic().

◆ setNumWarnings()

void clang::DiagnosticsEngine::setNumWarnings ( unsigned  NumWarnings)
inline

Definition at line 676 of file Diagnostic.h.

Referenced by makeStandaloneDiagnostic(), and clang::ASTUnit::Reparse().

◆ setPrintTemplateTree()

void clang::DiagnosticsEngine::setPrintTemplateTree ( bool  Val = false)
inline

Set tree printing, to outputting the template difference in a tree format.

Definition at line 560 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setSeverity()

void DiagnosticsEngine::setSeverity ( diag::kind  Diag,
diag::Severity  Map,
SourceLocation  Loc 
)

This allows the client to specify that certain warnings are ignored.

Notes can never be mapped, errors can only be mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily.

Parameters
LocThe source location that this change of diagnostic state should take affect. It can be null if we are setting the latest state.

Definition at line 244 of file Diagnostic.cpp.

References clang::diag::DIAG_UPPER_LIMIT, clang::diag::Error, clang::diag::Fatal, clang::DiagnosticMapping::getSeverity(), clang::SourceLocation::isInvalid(), clang::DiagnosticMapping::setUpgradedFromWarning(), and clang::diag::Warning.

Referenced by ParseAlignPragma(), setSeverityForAll(), and setSeverityForGroup().

◆ setSeverityForAll()

void DiagnosticsEngine::setSeverityForAll ( diag::Flavor  Flavor,
diag::Severity  Map,
SourceLocation  Loc = SourceLocation() 
)

Add the specified mapping to all diagnostics of the specified flavor.

Mainly to be used by -Wno-everything to disable all warnings but allow subsequent -W options to enable specific warnings.

Definition at line 361 of file Diagnostic.cpp.

References Diag(), and setSeverity().

Referenced by clang::Preprocessor::LexOnOffSwitch(), and clang::ProcessWarningOptions().

◆ setSeverityForGroup()

bool DiagnosticsEngine::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.

Returns
true (and ignores the request) if "Group" was unknown, false otherwise.
Parameters
FlavorThe flavor of group to affect. -Rfoo does not affect the state of the -Wfoo group and vice versa.
LocThe source location that this change of diagnostic state should take affect. It can be null if we are setting the state from command-line.

Definition at line 285 of file Diagnostic.cpp.

References Diag(), and setSeverity().

Referenced by clang::Preprocessor::LexOnOffSwitch(), clang::ProcessWarningOptions(), setDiagnosticGroupErrorAsFatal(), and setDiagnosticGroupWarningAsError().

◆ setShowColors()

void clang::DiagnosticsEngine::setShowColors ( bool  Val = false)
inline

Set color printing, so the type diffing will inject color markers into the output.

Definition at line 565 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setShowOverloads()

void clang::DiagnosticsEngine::setShowOverloads ( OverloadsShown  Val)
inline

Specify which overload candidates to show when overload resolution fails.

By default, we show all candidates.

Definition at line 572 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setSourceManager()

void clang::DiagnosticsEngine::setSourceManager ( SourceManager SrcMgr)
inline

Definition at line 442 of file Diagnostic.h.

Referenced by clang::SourceManager::SourceManager().

◆ setSuppressAfterFatalError()

void clang::DiagnosticsEngine::setSuppressAfterFatalError ( bool  Val)
inline

When set to true (the default), suppress further diagnostics after a fatal error.

Definition at line 535 of file Diagnostic.h.

◆ setSuppressAllDiagnostics()

void clang::DiagnosticsEngine::setSuppressAllDiagnostics ( bool  Val = true)
inline

Suppress all diagnostics, to silence the front end when we know that we don't want any more diagnostics to be passed along to the client.

Definition at line 548 of file Diagnostic.h.

Referenced by BuildCounterUpdate().

◆ setSuppressSystemWarnings()

void clang::DiagnosticsEngine::setSuppressSystemWarnings ( bool  Val)
inline

When set to true mask warnings that come from system headers.

Definition at line 538 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setTemplateBacktraceLimit()

void clang::DiagnosticsEngine::setTemplateBacktraceLimit ( unsigned  Limit)
inline

Specify the maximum number of template instantiation notes to emit along with a given diagnostic.

Definition at line 478 of file Diagnostic.h.

Referenced by clang::ProcessWarningOptions().

◆ setWarningsAsErrors()

void clang::DiagnosticsEngine::setWarningsAsErrors ( bool  Val)
inline

When set to true, any warnings reported are issued as errors.

Definition at line 522 of file Diagnostic.h.

Referenced by clang::ento::CreateAnalysisConsumer(), and clang::ProcessWarningOptions().

◆ takeClient()

std::unique_ptr<DiagnosticConsumer> clang::DiagnosticsEngine::takeClient ( )
inline

Return the current diagnostic client along with ownership of that client.

Definition at line 435 of file Diagnostic.h.

Referenced by clang::FixItRewriter::FixItRewriter(), SetUpDiagnosticLog(), and SetupSerializedDiagnostics().

Friends And Related Function Documentation

◆ ASTReader

friend class ASTReader
friend

Definition at line 902 of file Diagnostic.h.

◆ ASTWriter

friend class ASTWriter
friend

Definition at line 903 of file Diagnostic.h.

◆ Diagnostic

friend class Diagnostic
friend

Definition at line 809 of file Diagnostic.h.

◆ DiagnosticBuilder

friend class DiagnosticBuilder
friend

Definition at line 808 of file Diagnostic.h.

◆ DiagnosticErrorTrap

friend class DiagnosticErrorTrap
friend

Definition at line 811 of file Diagnostic.h.

◆ DiagnosticIDs

friend class DiagnosticIDs
friend

Definition at line 807 of file Diagnostic.h.

◆ PartialDiagnostic

friend class PartialDiagnostic
friend

Definition at line 810 of file Diagnostic.h.

◆ Sema

friend class Sema
friend

Definition at line 889 of file Diagnostic.h.


The documentation for this class was generated from the following files: