Used for handling and querying diagnostic IDs. More...

#include "clang/Basic/DiagnosticIDs.h"

Inheritance diagram for clang::DiagnosticIDs:

Public Types
enum	Level { Ignored , Note , Remark , Warning , Error , Fatal }
	The level of the diagnostic, after it has been through mapping. More...

enum	SFINAEResponse { SFINAE_SubstitutionFailure , SFINAE_Suppress , SFINAE_Report , SFINAE_AccessControl }
	Enumeration describing how the emission of a diagnostic should be treated when it occurs during C++ template argument deduction. More...

Public Member Functions
	DiagnosticIDs ()

	~DiagnosticIDs ()

unsigned	getCustomDiagID (Level L, StringRef FormatString)
	Return an ID for a diagnostic with the specified format string and level.

StringRef	getDescription (unsigned DiagID) const
	Given a diagnostic ID, return a description of the issue.

bool	getDiagnosticsInGroup (diag::Flavor Flavor, StringRef Group, SmallVectorImpl< diag::kind > &Diags) const
	Get the set of all diagnostic IDs in the group with the given name.

Static Public Member Functions
static bool	isBuiltinWarningOrExtension (unsigned DiagID)
	Return true if the unmapped diagnostic levelof the specified diagnostic ID is a Warning or Extension.

static bool	isDefaultMappingAsError (unsigned DiagID)
	Return true if the specified diagnostic is mapped to errors by default.

static DiagnosticMapping	getDefaultMapping (unsigned DiagID)
	Get the default mapping for this diagnostic.

static bool	isBuiltinNote (unsigned DiagID)
	Determine whether the given built-in diagnostic ID is a Note.

static bool	isBuiltinExtensionDiag (unsigned DiagID)
	Determine whether the given built-in diagnostic ID is for an extension of some sort.

static bool	isBuiltinExtensionDiag (unsigned DiagID, bool &EnabledByDefault)
	Determine whether the given built-in diagnostic ID is for an extension of some sort, and whether it is enabled by default.

static StringRef	getWarningOptionForGroup (diag::Group)
	Given a group ID, returns the flag that toggles the group.

static StringRef	getWarningOptionDocumentation (diag::Group GroupID)
	Given a diagnostic group ID, return its documentation.

static std::optional< diag::Group >	getGroupForWarningOption (StringRef)
	Given a group ID, returns the flag that toggles the group.

static std::optional< diag::Group >	getGroupForDiag (unsigned DiagID)
	Return the lowest-level group that contains the specified diagnostic.

static StringRef	getWarningOptionForDiag (unsigned DiagID)
	Return the lowest-level warning option that enables the specified diagnostic.

static unsigned	getCategoryNumberForDiag (unsigned DiagID)
	Return the category number that a specified `DiagID` belongs to, or 0 if no category.

static unsigned	getNumberOfCategories ()
	Return the number of diagnostic categories.

static StringRef	getCategoryNameFromID (unsigned CategoryID)
	Given a category ID, return the name of the category.

static bool	isARCDiagnostic (unsigned DiagID)
	Return true if a given diagnostic falls into an ARC diagnostic category.

static bool	isCodegenABICheckDiagnostic (unsigned DiagID)
	Return true if a given diagnostic is a codegen-time ABI check.

static SFINAEResponse	getDiagnosticSFINAEResponse (unsigned DiagID)
	Determines whether the given built-in diagnostic ID is for an error that is suppressed if it occurs during C++ template argument deduction.

static bool	isDeferrable (unsigned DiagID)
	Whether the diagnostic message can be deferred.

static std::vector< std::string >	getDiagnosticFlags ()
	Get the string of all diagnostic flags.

static void	getAllDiagnostics (diag::Flavor Flavor, std::vector< diag::kind > &Diags)
	Get the set of all diagnostic IDs.

static StringRef	getNearestOption (diag::Flavor Flavor, StringRef Group)
	Get the diagnostic option with the closest edit distance to the given group name.

Friends
class	DiagnosticsEngine

Detailed Description

Used for handling and querying diagnostic IDs.

Can be used and shared by multiple Diagnostics for multiple translation units.

Definition at line 179 of file DiagnosticIDs.h.

Member Enumeration Documentation

◆ Level

enum clang::DiagnosticIDs::Level

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

Enumerator
Ignored
Note
Remark
Warning
Error
Fatal

Definition at line 182 of file DiagnosticIDs.h.

◆ SFINAEResponse

enum clang::DiagnosticIDs::SFINAEResponse

Enumeration describing how the emission of a diagnostic should be treated when it occurs during C++ template argument deduction.

Enumerator
SFINAE_SubstitutionFailure	The diagnostic should not be reported, but it should cause template argument deduction to fail. The vast majority of errors that occur during template argument deduction fall into this category.
SFINAE_Suppress	The diagnostic should be suppressed entirely. Warnings generally fall into this category.
SFINAE_Report	The diagnostic should be reported. The diagnostic should be reported. Various fatal errors (e.g., template instantiation depth exceeded) fall into this category.
SFINAE_AccessControl	The diagnostic is an access-control diagnostic, which will be substitution failures in some contexts and reported in others.

Definition at line 286 of file DiagnosticIDs.h.

Constructor & Destructor Documentation

◆ DiagnosticIDs()

DiagnosticIDs::DiagnosticIDs ( )

Definition at line 405 of file DiagnosticIDs.cpp.

◆ ~DiagnosticIDs()

DiagnosticIDs::~DiagnosticIDs ( )

Definition at line 407 of file DiagnosticIDs.cpp.

Member Function Documentation

◆ getAllDiagnostics()

void DiagnosticIDs::getAllDiagnostics	(	diag::Flavor	Flavor,
		std::vector< diag::kind > &	Diags
	)

static

Get the set of all diagnostic IDs.

Definition at line 711 of file DiagnosticIDs.cpp.

References StaticDiagInfoSize.

Referenced by clang::DiagnosticsEngine::setSeverityForAll().

◆ getCategoryNameFromID()

StringRef DiagnosticIDs::getCategoryNameFromID ( unsigned CategoryID )

static

Given a category ID, return the name of the category.

getCategoryNameFromID - Given a category ID, return the name of the category, an empty string if CategoryID is zero, or null if CategoryID is invalid.

Definition at line 325 of file DiagnosticIDs.cpp.

References CategoryNameTable, and getNumberOfCategories().

Referenced by isARCDiagnostic(), isCodegenABICheckDiagnostic(), PrintDiagnosticCategories(), printDiagnosticOptions(), and clang::arcmt::writeARCDiagsToPlist().

◆ getCategoryNumberForDiag()

unsigned DiagnosticIDs::getCategoryNumberForDiag ( unsigned DiagID )

static

Return the category number that a specified DiagID belongs to, or 0 if no category.

getCategoryNumberForDiag - Return the category number that a specified DiagID belongs to, or 0 if no category.

Definition at line 291 of file DiagnosticIDs.cpp.

References GetDiagInfo().

Referenced by isARCDiagnostic(), isCodegenABICheckDiagnostic(), printDiagnosticOptions(), and clang::arcmt::writeARCDiagsToPlist().

◆ getCustomDiagID()

unsigned DiagnosticIDs::getCustomDiagID	(	Level	L,
		StringRef	FormatString
	)

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

getCustomDiagID - Return an ID for a diagnostic with the specified message and level.

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

Parameters

FormatString A fixed diagnostic format string that will be hashed and mapped to a unique DiagID.

Definition at line 415 of file DiagnosticIDs.cpp.

◆ getDefaultMapping()

DiagnosticMapping DiagnosticIDs::getDefaultMapping ( unsigned DiagID )

static

Get the default mapping for this diagnostic.

Definition at line 272 of file DiagnosticIDs.cpp.

References clang::diag::Fatal, GetDiagInfo(), clang::DiagnosticMapping::getSeverity(), clang::DiagnosticMapping::Make(), clang::DiagnosticMapping::setNoWarningAsError(), clang::DiagnosticMapping::setSeverity(), and clang::diag::Warning.

Referenced by isBuiltinExtensionDiag(), and isDefaultMappingAsError().

◆ getDescription()

StringRef DiagnosticIDs::getDescription ( unsigned DiagID ) const

Given a diagnostic ID, return a description of the issue.

getDescription - Given a diagnostic ID, return a description of the issue.

Definition at line 463 of file DiagnosticIDs.cpp.

References GetDiagInfo().

◆ getDiagnosticFlags()

std::vector< std::string > DiagnosticIDs::getDiagnosticFlags ( )

static

Get the string of all diagnostic flags.

Returns: A list of all diagnostics flags as they would be written in a command line invocation including their no- variants. For example: {"-Wempty-body", "-Wno-empty-body", ...}

Definition at line 660 of file DiagnosticIDs.cpp.

References Diag().

Referenced by clang::driver::Driver::HandleAutocompletions(), and clang::driver::Driver::HandleImmediateArgs().

◆ getDiagnosticSFINAEResponse()

DiagnosticIDs::SFINAEResponse DiagnosticIDs::getDiagnosticSFINAEResponse ( unsigned DiagID )

static

Determines whether the given built-in diagnostic ID is for an error that is suppressed if it occurs during C++ template argument deduction.

When an error is suppressed due to SFINAE, the template argument deduction fails but no diagnostic is emitted. Certain classes of errors, such as those errors that involve C++ access control, are not SFINAE errors.

Definition at line 334 of file DiagnosticIDs.cpp.

References GetDiagInfo(), and SFINAE_Report.

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

◆ getDiagnosticsInGroup()

bool DiagnosticIDs::getDiagnosticsInGroup	(	diag::Flavor	Flavor,
		StringRef	Group,
		SmallVectorImpl< diag::kind > &	Diags
	)		const

Get the set of all diagnostic IDs in the group with the given name.

Parameters

[out] Diags - On return, the diagnostics in the group.

Returns: true if the given group is unknown, false otherwise.

Definition at line 703 of file DiagnosticIDs.cpp.

References getGroupForWarningOption(), and OptionTable.

Referenced by getNearestOption().

◆ getGroupForDiag()

std::optional< diag::Group > DiagnosticIDs::getGroupForDiag ( unsigned DiagID )

static

Return the lowest-level group that contains the specified diagnostic.

Definition at line 645 of file DiagnosticIDs.cpp.

References GetDiagInfo().

Referenced by getWarningOptionForDiag().

◆ getGroupForWarningOption()

std::optional< diag::Group > DiagnosticIDs::getGroupForWarningOption ( StringRef Name )

static

Given a group ID, returns the flag that toggles the group.

For example, for "deprecated-declarations", returns Group::DeprecatedDeclarations.

Definition at line 637 of file DiagnosticIDs.cpp.

References clang::Found, and OptionTable.

Referenced by getDiagnosticsInGroup().

◆ getNearestOption()

StringRef DiagnosticIDs::getNearestOption	(	diag::Flavor	Flavor,
		StringRef	Group
	)

static

Get the diagnostic option with the closest edit distance to the given group name.

Definition at line 718 of file DiagnosticIDs.cpp.

References getDiagnosticsInGroup(), and OptionTable.

Referenced by EmitUnknownDiagWarning().

◆ getNumberOfCategories()

unsigned DiagnosticIDs::getNumberOfCategories ( )

static

Return the number of diagnostic categories.

getNumberOfCategories - Return the number of categories

Definition at line 318 of file DiagnosticIDs.cpp.

References CategoryNameTable.

Referenced by getCategoryNameFromID(), and PrintDiagnosticCategories().

◆ getWarningOptionDocumentation()

StringRef DiagnosticIDs::getWarningOptionDocumentation ( diag::Group GroupID )

static

Given a diagnostic group ID, return its documentation.

Definition at line 628 of file DiagnosticIDs.cpp.

References OptionTable.

◆ getWarningOptionForDiag()

StringRef DiagnosticIDs::getWarningOptionForDiag ( unsigned DiagID )

static

Return the lowest-level warning option that enables the specified diagnostic.

getWarningOptionForDiag - Return the lowest-level warning option that enables the specified diagnostic.

If there is no -Wfoo flag that controls the diagnostic, this returns null.

Definition at line 654 of file DiagnosticIDs.cpp.

References getGroupForDiag(), and getWarningOptionForGroup().

Referenced by clang::LogDiagnosticPrinter::HandleDiagnostic(), and printDiagnosticOptions().

◆ getWarningOptionForGroup()

StringRef DiagnosticIDs::getWarningOptionForGroup ( diag::Group Group )

static

Given a group ID, returns the flag that toggles the group.

For example, for Group::DeprecatedDeclarations, returns "deprecated-declarations".

Definition at line 632 of file DiagnosticIDs.cpp.

References getName(), and OptionTable.

Referenced by clang::driver::tools::Clang::ConstructJob(), and getWarningOptionForDiag().

◆ isARCDiagnostic()

bool DiagnosticIDs::isARCDiagnostic ( unsigned DiagID )

static

Return true if a given diagnostic falls into an ARC diagnostic category.

Definition at line 870 of file DiagnosticIDs.cpp.

References getCategoryNameFromID(), and getCategoryNumberForDiag().

◆ isBuiltinExtensionDiag() [1/2]

static bool clang::DiagnosticIDs::isBuiltinExtensionDiag ( unsigned DiagID )

inlinestatic

Determine whether the given built-in diagnostic ID is for an extension of some sort.

Definition at line 231 of file DiagnosticIDs.h.

References isBuiltinExtensionDiag().

Referenced by isBuiltinExtensionDiag().

◆ isBuiltinExtensionDiag() [2/2]

bool DiagnosticIDs::isBuiltinExtensionDiag	(	unsigned	DiagID,
		bool &	EnabledByDefault
	)

static

Determine whether the given built-in diagnostic ID is for an extension of some sort, and whether it is enabled by default.

isBuiltinExtensionDiag - Determine whether the given built-in diagnostic ID is for an extension of some sort.

This also returns EnabledByDefault, which is set to indicate whether the diagnostic is ignored by default (in which case -pedantic enables it) or treated as a warning/error by default.

Definition at line 443 of file DiagnosticIDs.cpp.

References clang::diag::DIAG_UPPER_LIMIT, getBuiltinDiagClass(), getDefaultMapping(), clang::DiagnosticMapping::getSeverity(), and clang::diag::Ignored.

◆ isBuiltinNote()

bool DiagnosticIDs::isBuiltinNote ( unsigned DiagID )

static

Determine whether the given built-in diagnostic ID is a Note.

Definition at line 433 of file DiagnosticIDs.cpp.

References clang::diag::DIAG_UPPER_LIMIT, and getBuiltinDiagClass().

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

◆ isBuiltinWarningOrExtension()

bool DiagnosticIDs::isBuiltinWarningOrExtension ( unsigned DiagID )

static

Return true if the unmapped diagnostic levelof the specified diagnostic ID is a Warning or Extension.

isBuiltinWarningOrExtension - Return true if the unmapped diagnostic level of the specified diagnostic ID is a Warning or Extension.

This only works on builtin diagnostics, not custom ones, and is not legal to call on NOTEs.

Definition at line 426 of file DiagnosticIDs.cpp.

References clang::diag::DIAG_UPPER_LIMIT, and getBuiltinDiagClass().

Referenced by printDiagnosticOptions().

◆ isCodegenABICheckDiagnostic()

bool DiagnosticIDs::isCodegenABICheckDiagnostic ( unsigned DiagID )

static

Return true if a given diagnostic is a codegen-time ABI check.

Definition at line 875 of file DiagnosticIDs.cpp.

References getCategoryNameFromID(), and getCategoryNumberForDiag().

◆ isDefaultMappingAsError()

bool DiagnosticIDs::isDefaultMappingAsError ( unsigned DiagID )

static

Return true if the specified diagnostic is mapped to errors by default.

Definition at line 454 of file DiagnosticIDs.cpp.

References clang::diag::DIAG_UPPER_LIMIT, clang::diag::Error, getDefaultMapping(), and clang::DiagnosticMapping::getSeverity().

Referenced by clang::Sema::hasUncompilableErrorOccurred(), and printDiagnosticOptions().

◆ isDeferrable()

bool DiagnosticIDs::isDeferrable ( unsigned DiagID )

static

Whether the diagnostic message can be deferred.

For single source offloading languages, a diagnostic message occurred in a device host function may be deferred until the function is sure to be emitted.

Definition at line 340 of file DiagnosticIDs.cpp.

References GetDiagInfo().

Referenced by clang::SemaBase::Diag().

Friends And Related Function Documentation

◆ DiagnosticsEngine

friend class DiagnosticsEngine

friend

Definition at line 380 of file DiagnosticIDs.h.

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

include/clang/Basic/DiagnosticIDs.h
lib/Basic/DiagnosticIDs.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ Level

◆ SFINAEResponse

Constructor & Destructor Documentation

◆ DiagnosticIDs()

◆ ~DiagnosticIDs()

Member Function Documentation

◆ getAllDiagnostics()

◆ getCategoryNameFromID()

◆ getCategoryNumberForDiag()

◆ getCustomDiagID()

◆ getDefaultMapping()

◆ getDescription()

◆ getDiagnosticFlags()

◆ getDiagnosticSFINAEResponse()

◆ getDiagnosticsInGroup()

◆ getGroupForDiag()

◆ getGroupForWarningOption()

◆ getNearestOption()

◆ getNumberOfCategories()

◆ getWarningOptionDocumentation()

◆ getWarningOptionForDiag()

◆ getWarningOptionForGroup()

◆ isARCDiagnostic()

◆ isBuiltinExtensionDiag() [1/2]

◆ isBuiltinExtensionDiag() [2/2]

◆ isBuiltinNote()

◆ isBuiltinWarningOrExtension()

◆ isCodegenABICheckDiagnostic()

◆ isDefaultMappingAsError()

◆ isDeferrable()

Friends And Related Function Documentation

◆ DiagnosticsEngine