A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) that allows clients to enquire about the currently in-flight diagnostic. More...

#include "clang/Basic/Diagnostic.h"

Public Member Functions
	Diagnostic (const DiagnosticsEngine *DO)

	Diagnostic (const DiagnosticsEngine *DO, StringRef storedDiagMessage)

const DiagnosticsEngine *	getDiags () const

unsigned	getID () const

const SourceLocation &	getLocation () const

bool	hasSourceManager () const

SourceManager &	getSourceManager () const

unsigned	getNumArgs () const

DiagnosticsEngine::ArgumentKind	getArgKind (unsigned Idx) const
	Return the kind of the specified index. More...

const std::string &	getArgStdStr (unsigned Idx) const
	Return the provided argument string specified by `Idx`. More...

const char *	getArgCStr (unsigned Idx) const
	Return the specified C string argument. More...

int64_t	getArgSInt (unsigned Idx) const
	Return the specified signed integer argument. More...

uint64_t	getArgUInt (unsigned Idx) const
	Return the specified unsigned integer argument. More...

const IdentifierInfo *	getArgIdentifier (unsigned Idx) const
	Return the specified IdentifierInfo argument. More...

uint64_t	getRawArg (unsigned Idx) const
	Return the specified non-string argument in an opaque form. More...

unsigned	getNumRanges () const
	Return the number of source ranges associated with this diagnostic. More...

const CharSourceRange &	getRange (unsigned Idx) const

ArrayRef< CharSourceRange >	getRanges () const
	Return an array reference for this diagnostic's ranges. More...

unsigned	getNumFixItHints () const

const FixItHint &	getFixItHint (unsigned Idx) const

ArrayRef< FixItHint >	getFixItHints () const

void	FormatDiagnostic (SmallVectorImpl< char > &OutStr) const
	Format this diagnostic into a string, substituting the formal arguments into the %0 slots. More...

void	FormatDiagnostic (const char DiagStr, const char DiagEnd, SmallVectorImpl< char > &OutStr) const
	Format the given format-string into the output buffer using the arguments stored in this diagnostic. More...

Detailed Description

A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) that allows clients to enquire about the currently in-flight diagnostic.

Definition at line 1577 of file Diagnostic.h.

Constructor & Destructor Documentation

◆ Diagnostic() [1/2]

clang::Diagnostic::Diagnostic ( const DiagnosticsEngine * DO )

inlineexplicit

Definition at line 1582 of file Diagnostic.h.

◆ Diagnostic() [2/2]

clang::Diagnostic::Diagnostic	(	const DiagnosticsEngine *	DO,
		StringRef	storedDiagMessage
	)

inline

Definition at line 1583 of file Diagnostic.h.

Member Function Documentation

◆ FormatDiagnostic() [1/2]

void Diagnostic::FormatDiagnostic	(	const char *	DiagStr,
		const char *	DiagEnd,
		SmallVectorImpl< char > &	OutStr
	)		const

Format the given format-string into the output buffer using the arguments stored in this diagnostic.

FormattedArgs - Keep track of all of the arguments formatted by ConvertArgToString and pass them into subsequent calls to ConvertArgToString, allowing the implementation to avoid redundancies in obvious cases.

QualTypeVals - Pass a vector of arrays so that QualType names can be compared to see if more information is needed to be printed.

Definition at line 848 of file Diagnostic.cpp.

References clang::DiagnosticsEngine::ak_std_string, and getArgKind().

◆ FormatDiagnostic() [2/2]

void Diagnostic::FormatDiagnostic ( SmallVectorImpl< char > & OutStr ) const

Format this diagnostic into a string, substituting the formal arguments into the %0 slots.

FormatDiagnostic - Format this diagnostic into a string, substituting the formal arguments into the %0 slots.

The result is appended onto the OutStr array.

The result is appended onto the Str array.

Definition at line 790 of file Diagnostic.cpp.

References Diag(), clang::DiagnosticsEngine::getDiagnosticIDs(), getDiags(), and getID().

Referenced by clang::PartialDiagnostic::EmitToString(), clang::LogDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticBuffer::HandleDiagnostic(), clang::format::FatalDiagnosticConsumer::HandleDiagnostic(), clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), HandlePluralModifier(), HandleSelectModifier(), and clang::StoredDiagnostic::StoredDiagnostic().

◆ getArgCStr()

const char* clang::Diagnostic::getArgCStr ( unsigned Idx ) const

inline

Return the specified C string argument.

Precondition: getArgKind(Idx) == DiagnosticsEngine::ak_c_string

Definition at line 1616 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_c_string, clang::DiagnosticStorage::DiagArgumentsVal, and getArgKind().

◆ getArgIdentifier()

const IdentifierInfo* clang::Diagnostic::getArgIdentifier ( unsigned Idx ) const

inline

Return the specified IdentifierInfo argument.

Precondition: getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo

Definition at line 1641 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_identifierinfo, clang::DiagnosticStorage::DiagArgumentsVal, and getArgKind().

◆ getArgKind()

DiagnosticsEngine::ArgumentKind clang::Diagnostic::getArgKind ( unsigned Idx ) const

inline

Return the kind of the specified index.

Based on the kind of argument, the accessors below can be used to get the value.

Precondition: Idx < getNumArgs()

Definition at line 1600 of file Diagnostic.h.

References clang::DiagnosticStorage::DiagArgumentsKind, and getNumArgs().

Referenced by FormatDiagnostic(), getArgCStr(), getArgIdentifier(), getArgSInt(), getArgStdStr(), getArgUInt(), and getRawArg().

◆ getArgSInt()

int64_t clang::Diagnostic::getArgSInt ( unsigned Idx ) const

inline

Return the specified signed integer argument.

Precondition: getArgKind(Idx) == DiagnosticsEngine::ak_sint

Definition at line 1625 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_sint, clang::DiagnosticStorage::DiagArgumentsVal, and getArgKind().

◆ getArgStdStr()

const std::string& clang::Diagnostic::getArgStdStr ( unsigned Idx ) const

inline

Return the provided argument string specified by Idx.

Precondition: getArgKind(Idx) == DiagnosticsEngine::ak_std_string

Definition at line 1608 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_std_string, clang::DiagnosticStorage::DiagArgumentsStr, and getArgKind().

◆ getArgUInt()

uint64_t clang::Diagnostic::getArgUInt ( unsigned Idx ) const

inline

Return the specified unsigned integer argument.

Precondition: getArgKind(Idx) == DiagnosticsEngine::ak_uint

Definition at line 1633 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_uint, clang::DiagnosticStorage::DiagArgumentsVal, and getArgKind().

◆ getDiags()

const DiagnosticsEngine* clang::Diagnostic::getDiags ( ) const

inline

Definition at line 1586 of file Diagnostic.h.

Referenced by FormatDiagnostic(), and printDiagnosticOptions().

◆ getFixItHint()

const FixItHint& clang::Diagnostic::getFixItHint ( unsigned Idx ) const

inline

Definition at line 1676 of file Diagnostic.h.

References clang::DiagnosticStorage::FixItHints, and getNumFixItHints().

Referenced by clang::FixItRewriter::HandleDiagnostic().

◆ getFixItHints()

ArrayRef<FixItHint> clang::Diagnostic::getFixItHints ( ) const

inline

Definition at line 1681 of file Diagnostic.h.

References clang::DiagnosticStorage::FixItHints.

Referenced by clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), and clang::StoredDiagnostic::StoredDiagnostic().

◆ getID()

unsigned clang::Diagnostic::getID ( ) const

inline

Definition at line 1587 of file Diagnostic.h.

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

◆ getLocation()

const SourceLocation& clang::Diagnostic::getLocation ( ) const

inline

Definition at line 1588 of file Diagnostic.h.

Referenced by clang::DiagnosticsEngine::EmitCurrentDiagnostic(), clang::Sema::EmitCurrentDiagnostic(), clang::LogDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticBuffer::HandleDiagnostic(), clang::VerifyDiagnosticConsumer::HandleDiagnostic(), clang::FixItRewriter::HandleDiagnostic(), clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), isInMainFile(), and clang::StoredDiagnostic::StoredDiagnostic().

◆ getNumArgs()

unsigned clang::Diagnostic::getNumArgs ( ) const

inline

Definition at line 1592 of file Diagnostic.h.

References clang::DiagnosticStorage::NumDiagArgs.

Referenced by getArgKind().

◆ getNumFixItHints()

unsigned clang::Diagnostic::getNumFixItHints ( ) const

inline

Definition at line 1672 of file Diagnostic.h.

References clang::DiagnosticStorage::FixItHints.

Referenced by getFixItHint(), and clang::FixItRewriter::HandleDiagnostic().

◆ getNumRanges()

unsigned clang::Diagnostic::getNumRanges ( ) const

inline

Return the number of source ranges associated with this diagnostic.

Definition at line 1657 of file Diagnostic.h.

References clang::DiagnosticStorage::DiagRanges.

Referenced by getRange().

◆ getRange()

const CharSourceRange& clang::Diagnostic::getRange ( unsigned Idx ) const

inline

Precondition: Idx < getNumRanges()

Definition at line 1662 of file Diagnostic.h.

References clang::DiagnosticStorage::DiagRanges, and getNumRanges().

◆ getRanges()

ArrayRef<CharSourceRange> clang::Diagnostic::getRanges ( ) const

inline

Return an array reference for this diagnostic's ranges.

Definition at line 1668 of file Diagnostic.h.

References clang::DiagnosticStorage::DiagRanges.

Referenced by clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), and clang::StoredDiagnostic::StoredDiagnostic().

◆ getRawArg()

uint64_t clang::Diagnostic::getRawArg ( unsigned Idx ) const

inline

Return the specified non-string argument in an opaque form.

Precondition: getArgKind(Idx) != DiagnosticsEngine::ak_std_string

Definition at line 1650 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_std_string, clang::DiagnosticStorage::DiagArgumentsVal, and getArgKind().

◆ getSourceManager()

SourceManager& clang::Diagnostic::getSourceManager ( ) const

inline

Definition at line 1590 of file Diagnostic.h.

References clang::DiagnosticsEngine::getSourceManager().

Referenced by clang::LogDiagnosticPrinter::HandleDiagnostic(), clang::VerifyDiagnosticConsumer::HandleDiagnostic(), clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), isInMainFile(), and clang::StoredDiagnostic::StoredDiagnostic().

◆ hasSourceManager()

bool clang::Diagnostic::hasSourceManager ( ) const

inline

Definition at line 1589 of file Diagnostic.h.

References clang::DiagnosticsEngine::hasSourceManager().

Referenced by clang::LogDiagnosticPrinter::HandleDiagnostic(), clang::VerifyDiagnosticConsumer::HandleDiagnostic(), clang::SARIFDiagnosticPrinter::HandleDiagnostic(), clang::TextDiagnosticPrinter::HandleDiagnostic(), isInMainFile(), and clang::StoredDiagnostic::StoredDiagnostic().

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Diagnostic() [1/2]

◆ Diagnostic() [2/2]

Member Function Documentation

◆ FormatDiagnostic() [1/2]

◆ FormatDiagnostic() [2/2]

◆ getArgCStr()

◆ getArgIdentifier()

◆ getArgKind()

◆ getArgSInt()

◆ getArgStdStr()

◆ getArgUInt()

◆ getDiags()

◆ getFixItHint()

◆ getFixItHints()

◆ getID()

◆ getLocation()

◆ getNumArgs()

◆ getNumFixItHints()

◆ getNumRanges()

◆ getRange()

◆ getRanges()

◆ getRawArg()

◆ getSourceManager()

◆ hasSourceManager()