#include "clang/AST/FormatString.h"

Public Types
enum	Kind { UnknownTy , InvalidTy , UnsupportedTy , SpecificTy , ObjCPointerTy , CPointerTy , AnyCharTy , CStrTy , WCStrTy , WIntTy }
enum	MatchKind { NoMatch = 0 , Match = 1 , MatchPromotion , NoMatchPromotionTypeConfusion , NoMatchPedantic , NoMatchSignedness , NoMatchTypeConfusion }
	How well a given conversion specifier matches its argument. More...

Public Member Functions
	ArgType (Kind K=UnknownTy, const char *N=nullptr)
	ArgType (QualType T, const char *N=nullptr)
	ArgType (CanQualType T)
bool	isValid () const
bool	isUnsupported () const
bool	isSizeT () const
bool	isPtrdiffT () const
MatchKind	matchesType (ASTContext &C, QualType argTy) const
MatchKind	matchesArgType (ASTContext &C, const ArgType &other) const
QualType	getRepresentativeType (ASTContext &C) const
ArgType	makeVectorType (ASTContext &C, unsigned NumElts) const
std::string	getRepresentativeTypeName (ASTContext &C) const

Static Public Member Functions
static ArgType	Invalid ()
static ArgType	Unsupported (const char *N)
static ArgType	PtrTo (const ArgType &A)
	Create an ArgType which corresponds to the type pointer to A.
static ArgType	makeSizeT (const ArgType &A)
	Create an ArgType which corresponds to the size_t/ssize_t type.
static ArgType	makePtrdiffT (const ArgType &A)
	Create an ArgType which corresponds to the ptrdiff_t/unsigned ptrdiff_t type.
static ArgType	makeIntNType (ASTContext &Ctx, const LengthModifier &LengthMod, bool Signed)

Detailed Description

Definition at line 278 of file FormatString.h.

Member Enumeration Documentation

◆ Kind

enum clang::analyze_format_string::ArgType::Kind

Enumerator
UnknownTy
InvalidTy
UnsupportedTy
SpecificTy
ObjCPointerTy
CPointerTy
AnyCharTy
CStrTy
WCStrTy
WIntTy

Definition at line 280 of file FormatString.h.

◆ MatchKind

enum clang::analyze_format_string::ArgType::MatchKind

How well a given conversion specifier matches its argument.

Enumerator
NoMatch	The conversion specifier and the argument types are incompatible. For instance, "%d" and float.
Match	The conversion specifier and the argument type are compatible. For instance, "%d" and int.
MatchPromotion	The conversion specifier and the argument type are compatible because of default argument promotions. For instance, "%hhd" and int.
NoMatchPromotionTypeConfusion	The conversion specifier and the argument type are compatible but still seems likely to be an error. For instanace, "%hhd" and short.
NoMatchPedantic	The conversion specifier and the argument type are disallowed by the C standard, but are in practice harmless. For instance, "%p" and int*.
NoMatchSignedness	The conversion specifier and the argument type have different sign.
NoMatchTypeConfusion	The conversion specifier and the argument type are compatible, but still seems likely to be an error. For instance, "%hd" and _Bool.

Definition at line 294 of file FormatString.h.

Constructor & Destructor Documentation

◆ ArgType() [1/3]

clang::analyze_format_string::ArgType::ArgType	(	Kind	K = UnknownTy,
		const char *	N = nullptr )

inline

Definition at line 337 of file FormatString.h.

References UnknownTy.

Referenced by Invalid(), makeIntNType(), makePtrdiffT(), makeSizeT(), makeVectorType(), matchesArgType(), PtrTo(), and Unsupported().

◆ ArgType() [2/3]

clang::analyze_format_string::ArgType::ArgType	(	QualType	T,
		const char *	N = nullptr )

inline

Definition at line 338 of file FormatString.h.

References SpecificTy.

◆ ArgType() [3/3]

clang::analyze_format_string::ArgType::ArgType ( CanQualType T )

inline

Definition at line 339 of file FormatString.h.

References SpecificTy.

Member Function Documentation

◆ getRepresentativeType()

QualType ArgType::getRepresentativeType ( ASTContext & C ) const

Definition at line 852 of file FormatString.cpp.

References AnyCharTy, clang::C, CPointerTy, CStrTy, clang::Type::getCanonicalTypeInternal(), InvalidTy, ObjCPointerTy, SpecificTy, UnknownTy, UnsupportedTy, WCStrTy, and WIntTy.

Referenced by getRepresentativeTypeName().

◆ getRepresentativeTypeName()

std::string ArgType::getRepresentativeTypeName ( ASTContext & C ) const

Definition at line 894 of file FormatString.cpp.

References clang::C, clang::QualType::getAsString(), getRepresentativeType(), and UnsupportedTy.

◆ Invalid()

ArgType clang::analyze_format_string::ArgType::Invalid ( )

inlinestatic

Definition at line 341 of file FormatString.h.

References ArgType(), and InvalidTy.

Referenced by makeIntNType(), and makeVectorType().

◆ isPtrdiffT()

bool clang::analyze_format_string::ArgType::isPtrdiffT ( ) const

inline

Definition at line 352 of file FormatString.h.

◆ isSizeT()

bool clang::analyze_format_string::ArgType::isSizeT ( ) const

inline

Definition at line 350 of file FormatString.h.

◆ isUnsupported()

bool clang::analyze_format_string::ArgType::isUnsupported ( ) const

inline

Definition at line 348 of file FormatString.h.

References UnsupportedTy.

◆ isValid()

bool clang::analyze_format_string::ArgType::isValid ( ) const

inline

Definition at line 347 of file FormatString.h.

References InvalidTy.

Referenced by clang::analyze_printf::PrintfSpecifier::fixType(), clang::analyze_scanf::ScanfSpecifier::fixType(), and clang::analyze_printf::PrintfSpecifier::getArgType().

◆ makeIntNType()

ArgType ArgType::makeIntNType	(	ASTContext &	Ctx,
		const LengthModifier &	LengthMod,
		bool	Signed )

static

Definition at line 836 of file FormatString.cpp.

References ArgType(), clang::analyze_format_string::LengthModifier::AsFastIntN, clang::analyze_format_string::LengthModifier::getBitWidth(), clang::ASTContext::getIntTypeForBitwidth(), clang::analyze_format_string::LengthModifier::getKind(), clang::ASTContext::getLeastIntTypeForBitwidth(), Invalid(), clang::QualType::isNull(), and clang::Signed.

◆ makePtrdiffT()

ArgType clang::analyze_format_string::ArgType::makePtrdiffT ( const ArgType & A )

inlinestatic

Create an ArgType which corresponds to the ptrdiff_t/unsigned ptrdiff_t type.

Definition at line 371 of file FormatString.h.

References ArgType().

◆ makeSizeT()

ArgType clang::analyze_format_string::ArgType::makeSizeT ( const ArgType & A )

inlinestatic

Create an ArgType which corresponds to the size_t/ssize_t type.

Definition at line 363 of file FormatString.h.

References ArgType().

◆ makeVectorType()

ArgType ArgType::makeVectorType	(	ASTContext &	C,
		unsigned	NumElts ) const

Definition at line 827 of file FormatString.cpp.

References ArgType(), clang::C, and Invalid().

Referenced by clang::analyze_printf::PrintfSpecifier::getArgType().

◆ matchesArgType()

analyze_format_string::ArgType::MatchKind ArgType::matchesArgType	(	ASTContext &	C,
		const ArgType &	other ) const

Definition at line 745 of file FormatString.cpp.

References ArgType(), clang::C, clang::Type::getAs(), integerTypeMatch(), clang::BuiltinType::isInteger(), Match, matchesSizeTPtrdiffT(), NoMatch, and clang::Other.

◆ matchesType()

clang::analyze_format_string::ArgType::MatchKind ArgType::matchesType	(	ASTContext &	C,
		QualType	argTy ) const

Definition at line 445 of file FormatString.cpp.

References AnyCharTy, clang::C, clang::Type::canDecayToPointerType(), CPointerTy, CStrTy, clang::Type::getAs(), clang::Type::getAsEnumDecl(), clang::PointerType::getPointeeType(), clang::Type::getPointeeType(), clang::Type::hasSignedIntegerRepresentation(), InvalidTy, clang::Type::isBlockPointerType(), clang::Type::isCharType(), clang::QualType::isConstQualified(), clang::Type::isNullPtrType(), clang::Type::isObjCObjectPointerType(), clang::Type::isSaturatedFixedPointType(), clang::Type::isStructureType(), clang::Type::isVoidType(), Match, matchesSizeTPtrdiffT(), MatchPromotion, NoMatch, NoMatchPedantic, NoMatchPromotionTypeConfusion, NoMatchSignedness, NoMatchTypeConfusion, ObjCPointerTy, SpecificTy, UnknownTy, UnsupportedTy, WCStrTy, and WIntTy.

Referenced by clang::analyze_printf::PrintfSpecifier::fixType(), and clang::analyze_scanf::ScanfSpecifier::fixType().

◆ PtrTo()

ArgType clang::analyze_format_string::ArgType::PtrTo ( const ArgType & A )

inlinestatic

Create an ArgType which corresponds to the type pointer to A.

Definition at line 355 of file FormatString.h.

References ArgType(), and InvalidTy.

◆ Unsupported()

ArgType clang::analyze_format_string::ArgType::Unsupported ( const char * N )

inlinestatic

Definition at line 342 of file FormatString.h.

References ArgType(), and UnsupportedTy.

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

include/clang/AST/FormatString.h
lib/AST/FormatString.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Kind

◆ MatchKind

Constructor & Destructor Documentation

◆ ArgType() [1/3]

◆ ArgType() [2/3]

◆ ArgType() [3/3]

Member Function Documentation

◆ getRepresentativeType()

◆ getRepresentativeTypeName()

◆ Invalid()

◆ isPtrdiffT()

◆ isSizeT()

◆ isUnsupported()

◆ isValid()

◆ makeIntNType()

◆ makePtrdiffT()

◆ makeSizeT()

◆ makeVectorType()

◆ matchesArgType()

◆ matchesType()

◆ PtrTo()

◆ Unsupported()