clang  3.7.0
Public Member Functions | List of all members
clang::Diagnostic Class Reference

#include <Diagnostic.h>

Public Member Functions

 Diagnostic (const DiagnosticsEngine *DO)
 
 Diagnostic (const DiagnosticsEngine *DO, StringRef storedDiagMessage)
 
const DiagnosticsEnginegetDiags () const
 
unsigned getID () const
 
const SourceLocationgetLocation () const
 
bool hasSourceManager () const
 
SourceManagergetSourceManager () 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...
 
int getArgSInt (unsigned Idx) const
 Return the specified signed integer argument. More...
 
unsigned getArgUInt (unsigned Idx) const
 Return the specified unsigned integer argument. More...
 
const IdentifierInfogetArgIdentifier (unsigned Idx) const
 Return the specified IdentifierInfo argument. More...
 
intptr_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 CharSourceRangegetRange (unsigned Idx) const
 
ArrayRef< CharSourceRangegetRanges () const
 Return an array reference for this diagnostic's ranges. More...
 
unsigned getNumFixItHints () const
 
const FixItHintgetFixItHint (unsigned Idx) const
 
ArrayRef< FixItHintgetFixItHints () 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 1138 of file Diagnostic.h.

Constructor & Destructor Documentation

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

Definition at line 1142 of file Diagnostic.h.

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

Definition at line 1143 of file Diagnostic.h.

Member Function Documentation

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

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

The result is appended onto the OutStr array.

FormatDiagnostic - Format this diagnostic into a string, substituting the formal arguments into the %0 slots. The result is appended onto the Str array.

Definition at line 630 of file Diagnostic.cpp.

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

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

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 643 of file Diagnostic.cpp.

References clang::DiagnosticsEngine::ak_attr, clang::DiagnosticsEngine::ak_c_string, clang::DiagnosticsEngine::ak_declarationname, clang::DiagnosticsEngine::ak_declcontext, clang::DiagnosticsEngine::ak_nameddecl, clang::DiagnosticsEngine::ak_nestednamespec, clang::DiagnosticsEngine::ak_qualtype, clang::DiagnosticsEngine::ak_qualtype_pair, clang::DiagnosticsEngine::ak_sint, clang::DiagnosticsEngine::ak_std_string, clang::DiagnosticsEngine::ak_tokenkind, clang::DiagnosticsEngine::ak_uint, clang::DiagnosticsEngine::ConvertArgToString(), clang::TemplateDiffTypes::ElideType, clang::threadSafety::sx::equals(), FormatDiagnostic(), clang::TemplateDiffTypes::FromType, getArgCStr(), getArgKind(), getArgSInt(), getArgStdStr(), getArgUInt(), getDiags(), clang::tok::getKeywordSpelling(), getNumArgs(), clang::tok::getPunctuatorSpelling(), getRawArg(), getTokenDescForDiagnostic(), clang::tok::getTokenName(), HandleIntegerSModifier(), HandleOrdinalModifier(), HandlePluralModifier(), HandleSelectModifier(), clang::isDigit(), clang::isPunctuation(), ModifierIs(), clang::TemplateDiffTypes::PrintFromType, clang::TemplateDiffTypes::PrintTree, S, ScanFormat(), clang::TemplateDiffTypes::ShowColors, clang::TemplateDiffTypes::TemplateDiffUsed, and clang::TemplateDiffTypes::ToType.

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 1175 of file Diagnostic.h.

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

Referenced by FormatDiagnostic().

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

Return the specified IdentifierInfo argument.

Precondition
getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo

Definition at line 1199 of file Diagnostic.h.

References clang::DiagnosticsEngine::ak_identifierinfo, and 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 1160 of file Diagnostic.h.

References getNumArgs().

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

int clang::Diagnostic::getArgSInt ( unsigned  Idx) const
inline

Return the specified signed integer argument.

Precondition
getArgKind(Idx) == DiagnosticsEngine::ak_sint

Definition at line 1183 of file Diagnostic.h.

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

Referenced by FormatDiagnostic().

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 1167 of file Diagnostic.h.

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

Referenced by FormatDiagnostic(), and clang::PartialDiagnostic::PartialDiagnostic().

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

Return the specified unsigned integer argument.

Precondition
getArgKind(Idx) == DiagnosticsEngine::ak_uint

Definition at line 1191 of file Diagnostic.h.

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

Referenced by FormatDiagnostic().

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

Definition at line 1146 of file Diagnostic.h.

Referenced by FormatDiagnostic(), and printDiagnosticOptions().

const FixItHint& clang::Diagnostic::getFixItHint ( unsigned  Idx) const
inline
ArrayRef<FixItHint> clang::Diagnostic::getFixItHints ( ) const
inline
unsigned clang::Diagnostic::getID ( ) const
inline
const SourceLocation& clang::Diagnostic::getLocation ( ) const
inline
unsigned clang::Diagnostic::getNumArgs ( ) const
inline
unsigned clang::Diagnostic::getNumFixItHints ( ) const
inline
unsigned clang::Diagnostic::getNumRanges ( ) const
inline

Return the number of source ranges associated with this diagnostic.

Definition at line 1214 of file Diagnostic.h.

Referenced by getRange(), and clang::PartialDiagnostic::PartialDiagnostic().

const CharSourceRange& clang::Diagnostic::getRange ( unsigned  Idx) const
inline
Precondition
Idx < getNumRanges()

Definition at line 1219 of file Diagnostic.h.

References getNumRanges().

Referenced by clang::PartialDiagnostic::PartialDiagnostic().

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

Return an array reference for this diagnostic's ranges.

Definition at line 1225 of file Diagnostic.h.

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

intptr_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 1207 of file Diagnostic.h.

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

Referenced by FormatDiagnostic(), and clang::PartialDiagnostic::PartialDiagnostic().

SourceManager& clang::Diagnostic::getSourceManager ( ) const
inline
bool clang::Diagnostic::hasSourceManager ( ) const
inline

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