Base wrapper for a particular "section" of type source info. More...

#include "clang/AST/TypeLoc.h"

Inheritance diagram for clang::TypeLoc:

[legend]

Public Types
enum	TypeLocClass { Qualified }
	The kinds of TypeLocs. More...

Public Member Functions
	TypeLoc ()=default

	TypeLoc (QualType ty, void *opaqueData)

	TypeLoc (const Type ty, void opaqueData)

template<typename T >
T	castAs () const
	Convert to the specified TypeLoc type, asserting that this TypeLoc is of the desired type.

template<typename T >
T	getAs () const
	Convert to the specified TypeLoc type, returning a null TypeLoc if this TypeLoc is not of the desired type.

template<typename T >
T	getAsAdjusted () const
	Convert to the specified TypeLoc type, returning a null TypeLoc if this TypeLoc is not of the desired type.

TypeLocClass	getTypeLocClass () const

bool	isNull () const

	operator bool () const

QualType	getType () const
	Get the type for which this source info wrapper provides information.

const Type *	getTypePtr () const

void *	getOpaqueData () const
	Get the pointer where source information is stored.

SourceLocation	getBeginLoc () const
	Get the begin source location.

SourceLocation	getEndLoc () const
	Get the end source location.

SourceRange	getSourceRange () const LLVM_READONLY
	Get the full source range.

SourceRange	getLocalSourceRange () const
	Get the local source range.

unsigned	getFullDataSize () const
	Returns the size of the type source info data block.

TypeLoc	getNextTypeLoc () const
	Get the next TypeLoc pointed by this TypeLoc, e.g for "int*" the TypeLoc is a PointerLoc and next TypeLoc is for "int".

UnqualTypeLoc	getUnqualifiedLoc () const
	Skips past any qualifiers, if this is qualified.

TypeLoc	IgnoreParens () const

TypeLoc	findExplicitQualifierLoc () const
	Find a type with the location of an explicit type qualifier.

AutoTypeLoc	getContainedAutoTypeLoc () const
	Get the typeloc of an AutoType whose type will be deduced for a variable with an initializer of this type.

SourceLocation	getTemplateKeywordLoc () const
	Get the SourceLocation of the template keyword (if any).

void	initialize (ASTContext &Context, SourceLocation Loc) const
	Initializes this to state that every location in this type is the given location.

void	initializeFullCopy (TypeLoc Other)
	Initializes this by copying its information from another TypeLoc of the same type.

void	initializeFullCopy (TypeLoc Other, unsigned Size)
	Initializes this by copying its information from another TypeLoc of the same type.

void	copy (TypeLoc other)
	Copies the other type loc into this one.

SourceLocation	findNullabilityLoc () const
	Find the location of the nullability specifier (__nonnull, __nullable, or __null_unspecifier), if there is one.

void	dump () const

void	dump (llvm::raw_ostream &, const ASTContext &) const

Static Public Member Functions
static unsigned	getFullDataSizeForType (QualType Ty)
	Returns the size of type source info data block for the given type.

static unsigned	getLocalAlignmentForType (QualType Ty)
	Returns the alignment of type source info data block for the given type.

Protected Attributes
const void *	Ty = nullptr

void *	Data = nullptr

Friends
bool	operator== (const TypeLoc &LHS, const TypeLoc &RHS)

bool	operator!= (const TypeLoc &LHS, const TypeLoc &RHS)

Detailed Description

Base wrapper for a particular "section" of type source info.

A client should use the TypeLoc subclasses through castAs()/getAs() in order to get at the actual information.

Definition at line 59 of file TypeLoc.h.

Member Enumeration Documentation

◆ TypeLocClass

enum clang::TypeLoc::TypeLocClass

The kinds of TypeLocs.

Equivalent to the Type::TypeClass enum, except it also defines a Qualified enum that corresponds to the QualifiedLoc class.

Enumerator
Qualified

Definition at line 108 of file TypeLoc.h.

Constructor & Destructor Documentation

◆ TypeLoc() [1/3]

clang::TypeLoc::TypeLoc ( )

default

Referenced by getEndLoc(), and getLocalAlignmentForType().

◆ TypeLoc() [2/3]

clang::TypeLoc::TypeLoc	(	QualType	ty,
		void *	opaqueData
	)

inline

Definition at line 68 of file TypeLoc.h.

◆ TypeLoc() [3/3]

clang::TypeLoc::TypeLoc	(	const Type *	ty,
		void *	opaqueData
	)

inline

Definition at line 70 of file TypeLoc.h.

Member Function Documentation

◆ castAs()

template<typename T >

T clang::TypeLoc::castAs ( ) const

inline

Convert to the specified TypeLoc type, asserting that this TypeLoc is of the desired type.

Precondition: T::isKind(*this)

Definition at line 78 of file TypeLoc.h.

References clang::T.

Referenced by clang::SemaObjC::actOnObjCProtocolQualifierType(), clang::SemaObjC::actOnObjCTypeArgsAndProtocolQualifiers(), clang::Sema::ActOnTemplatedFriendTag(), clang::TemplateDeclInstantiator::adjustForRewrite(), clang::Sema::BuildMemInitializer(), clang::Sema::CheckTypenameType(), clang::Sema::findInheritingConstructor(), FixInvalidVariablyModifiedTypeLoc(), getBeginLoc(), getEndLoc(), getPointeeTypeText(), clang::Sema::getTemplateArgumentPackExpansionPattern(), clang::ASTContext::getTemplateSpecializationTypeInfo(), GetTypeSourceInfoForDeclarator(), NeedsInstantiationAsFunctionType(), clang::TypeLocBuilder::push(), clang::TypeLocBuilder::pushTypeSpec(), clang::TemplateDeclInstantiator::SubstFunctionType(), clang::TreeTransform< Derived >::TransformFunctionTypeParam(), clang::TreeTransform< Derived >::TransformFunctionTypeParams(), and clang::TreeTransform< Derived >::TransformTypeWithDeducedTST().

◆ copy()

void TypeLoc::copy ( TypeLoc other )

Copies the other type loc into this one.

Definition at line 168 of file TypeLoc.cpp.

References Data, getFullDataSize(), getNextTypeLoc(), getType(), memcpy(), and TypeLocMaxDataAlign.

Referenced by initializeFullCopy().

◆ dump() [1/2]

LLVM_DUMP_METHOD void TypeLoc::dump ( ) const

Definition at line 205 of file ASTDumper.cpp.

References clang::ASTNodeTraverser< Derived, NodeDelegateType >::Visit().

◆ dump() [2/2]

LLVM_DUMP_METHOD void TypeLoc::dump	(	llvm::raw_ostream &	OS,
		const ASTContext &	Context
	)		const

Definition at line 209 of file ASTDumper.cpp.

References clang::ASTContext::getDiagnostics(), clang::DiagnosticsEngine::getShowColors(), and clang::ASTNodeTraverser< Derived, NodeDelegateType >::Visit().

◆ findExplicitQualifierLoc()

TypeLoc TypeLoc::findExplicitQualifierLoc ( ) const

Find a type with the location of an explicit type qualifier.

The result, if non-null, will be one of: QualifiedTypeLoc AtomicTypeLoc AttributedTypeLoc, for those type attributes that behave as qualifiers

Definition at line 463 of file TypeLoc.cpp.

References clang::ast_matchers::attr, getAs(), and IgnoreParens().

Referenced by clang::SemaObjC::actOnObjCTypeParam(), and clang::applyObjCTypeArgs().

◆ findNullabilityLoc()

SourceLocation TypeLoc::findNullabilityLoc ( ) const

Find the location of the nullability specifier (__nonnull, __nullable, or __null_unspecifier), if there is one.

Definition at line 452 of file TypeLoc.cpp.

References clang::Attr::getLocation().

◆ getAs()

template<typename T >

T clang::TypeLoc::getAs ( ) const

inline

Convert to the specified TypeLoc type, returning a null TypeLoc if this TypeLoc is not of the desired type.

Definition at line 89 of file TypeLoc.h.

References clang::T.

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::SemaObjC::actOnObjCTypeArgsAndProtocolQualifiers(), clang::SemaObjC::actOnObjCTypeParam(), clang::Sema::ActOnTemplateTypeArgument(), addFunctionPointerConversion(), checkAllAtProps(), clang::Sema::CheckEquivalentExceptionSpec(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::checkThisInStaticMemberFunctionExceptionSpec(), clang::Sema::checkThisInStaticMemberFunctionType(), convertTypeTemplateArgumentToTemplate(), clang::Sema::createLambdaInitCaptureVarDecl(), DiagnoseCalleeStaticArrayParam(), findExplicitQualifierLoc(), findTypeLocationForBlockDecl(), FixInvalidVariablyModifiedTypeLoc(), getAsAdjusted(), getContainedAutoTypeLoc(), clang::FunctionDecl::getFunctionTypeLoc(), clang::comments::getFunctionTypeLoc(), GetTypeSourceInfoForDeclarator(), isEnableIf(), clang::Decl::isFlexibleArrayMemberLike(), clang::comments::lookThroughTypedefOrTypeAliasLocs(), NeedsInstantiationAsFunctionType(), clang::InitializationSequence::Perform(), clang::Sema::SubstFunctionDeclType(), clang::TemplateDeclInstantiator::SubstFunctionType(), clang::Sema::SubstParmVarDecl(), clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc(), and clang::TreeTransform< Derived >::TransformTypeWithDeducedTST().

◆ getAsAdjusted()

template<typename T >

T clang::TypeLoc::getAsAdjusted

inline

Convert to the specified TypeLoc type, returning a null TypeLoc if this TypeLoc is not of the desired type.

It will consider type adjustments from a type that was written as a T to another type that is still canonically a T (ignores parens, attributes, elaborated types, etc).

Definition at line 2716 of file TypeLoc.h.

References getAs(), and clang::T.

Referenced by clang::Sema::ActOnBlockArguments(), clang::TemplateDeclInstantiator::adjustForRewrite(), clang::Sema::CheckDeductionGuideDeclarator(), checkLifetimeBoundAttr(), clang::Sema::checkLifetimeCaptureBy(), findTypeLocationForBlockDecl(), clang::Sema::getReturnTypeLoc(), clang::sema::implicitObjectParamIsLifetimeBound(), clang::Decl::isFlexibleArrayMemberLike(), clang::Sema::LazyProcessLifetimeCaptureByParams(), and clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc().

◆ getBeginLoc()

SourceLocation TypeLoc::getBeginLoc ( ) const

Get the begin source location.

Definition at line 192 of file TypeLoc.cpp.

References castAs(), clang::SourceRange::getBegin(), getLocalSourceRange(), getNextTypeLoc(), getTypeLocClass(), clang::InheritingConcreteTypeLoc< Base, Derived, TypeClass >::getTypePtr(), clang::FunctionProtoType::hasTrailingReturn(), isNull(), clang::SourceLocation::isValid(), and Qualified.

Referenced by clang::Sema::ActOnAliasDeclaration(), clang::Sema::ActOnCXXTypeConstructExpr(), clang::Sema::ActOnFriendTypeDecl(), clang::SemaObjC::ActOnMethodParmDeclaration(), clang::SemaObjC::actOnObjCTypeParam(), clang::SemaOpenMP::ActOnOMPIteratorExpr(), clang::Sema::ActOnTag(), clang::Sema::ActOnTemplateTypeArgument(), clang::Sema::ActOnVariableDeclarator(), clang::applyObjCTypeArgs(), clang::Sema::AttachTypeConstraint(), clang::Sema::BuildBaseInitializer(), clang::Sema::BuildBuiltinBitCastExpr(), clang::Sema::BuildCXXTypeConstructExpr(), clang::Sema::BuildPseudoDestructorExpr(), clang::Sema::BuildVAArgExpr(), clang::Sema::CheckBaseSpecifier(), CheckConstexprDeclStmt(), CheckConvertibilityForTypeTraits(), clang::Sema::CheckDeductionGuideDeclarator(), clang::Sema::CheckEnumUnderlyingType(), clang::SemaObjC::CreatePropertyDecl(), clang::Sema::DeduceTemplateSpecializationFromInitializer(), clang::Sema::deduceVarTypeFromInitializer(), EvaluateBinaryTypeTrait(), EvaluateUnaryTypeTrait(), clang::CXXScopeSpec::Extend(), clang::CXXBaseSpecifier::getBaseTypeLoc(), clang::CXXFunctionalCastExpr::getBeginLoc(), clang::CXXTemporaryObjectExpr::getBeginLoc(), GetFullTypeForDeclarator(), clang::NestedNameSpecifierLoc::getLocalSourceRange(), clang::DependentNameTypeLoc::getLocalSourceRange(), clang::DependentTemplateSpecializationTypeLoc::getLocalSourceRange(), getPointeeTypeText(), getSourceRange(), clang::DeclaratorDecl::getTypeSpecStartLoc(), handleAlignedAttr(), handlePreferredTypeAttr(), clang::SemaHLSL::handleResourceTypeAttr(), clang::ASTImporter::Import(), clang::Sema::IsPointerInterconvertibleBaseOf(), clang::PseudoDestructorTypeStorage::PseudoDestructorTypeStorage(), clang::TreeTransform< Derived >::RebuildQualifiedType(), ReplaceWithClasstype(), ReplaceWithInstancetype(), clang::TreeTransform< Derived >::TransformFunctionProtoType(), clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc(), clang::TreeTransform< Derived >::TransformType(), clang::TreeTransform< Derived >::TransformTypeWithDeducedTST(), and clang::tooling::RecursiveSymbolVisitor< T >::VisitTypedefTypeLoc().

◆ getContainedAutoTypeLoc()

AutoTypeLoc TypeLoc::getContainedAutoTypeLoc ( ) const

Get the typeloc of an AutoType whose type will be deduced for a variable with an initializer of this type.

This looks through declarators like pointer types, but not through decltype or typedefs.

Definition at line 749 of file TypeLoc.cpp.

References getAs(), and isNull().

Referenced by clang::Sema::ActOnNonTypeTemplateParameter(), clang::Sema::ActOnTypeName(), clang::Sema::ActOnVariableDeclarator(), and InventTemplateParameter().

◆ getEndLoc()

SourceLocation TypeLoc::getEndLoc ( ) const

Get the end source location.

Definition at line 235 of file TypeLoc.cpp.

References castAs(), getNextTypeLoc(), clang::ObjCObjectPointerTypeLoc::getStarLoc(), getTypeLocClass(), clang::InheritingConcreteTypeLoc< Base, Derived, TypeClass >::getTypePtr(), clang::FunctionProtoType::hasTrailingReturn(), clang::SourceLocation::isInvalid(), clang::Last, Paren, Pointer, Qualified, and TypeLoc().

Referenced by clang::SemaObjC::actOnObjCTypeParam(), clang::SemaObjC::ActOnSuperClassOfClassInterface(), clang::Sema::BuildBuiltinBitCastExpr(), clang::Sema::CheckConversionDeclarator(), clang::Sema::CheckParameter(), clang::SemaObjC::CreatePropertyDecl(), clang::Sema::DeduceTemplateSpecializationFromInitializer(), GetFullTypeForDeclarator(), clang::ElaboratedTypeLoc::getLocalSourceRange(), getPointeeTypeText(), getSourceRange(), clang::DeclaratorDecl::getTypeSpecEndLoc(), ReplaceWithClasstype(), ReplaceWithInstancetype(), and clang::Sema::SubstExceptionSpec().

◆ getFullDataSize()

unsigned clang::TypeLoc::getFullDataSize ( ) const

inline

Returns the size of the type source info data block.

Definition at line 164 of file TypeLoc.h.

References getFullDataSizeForType(), and getType().

Referenced by clang::AutoTypeLoc::copy(), clang::DependentNameTypeLoc::copy(), clang::DependentTemplateSpecializationTypeLoc::copy(), clang::ElaboratedTypeLoc::copy(), clang::TemplateSpecializationTypeLoc::copy(), copy(), GetTypeSourceInfoForDeclarator(), initializeFullCopy(), clang::TypeLocBuilder::pushFullCopy(), clang::Sema::SubstFunctionDeclType(), clang::Sema::SubstType(), clang::TreeTransform< Derived >::TransformFunctionTypeParam(), clang::TreeTransform< Derived >::TransformType(), and clang::TreeTransform< Derived >::TransformTypeWithDeducedTST().

◆ getFullDataSizeForType()

unsigned TypeLoc::getFullDataSizeForType ( QualType Ty )

static

Returns the size of type source info data block for the given type.

Returns the size of the type source info data block.

Definition at line 94 of file TypeLoc.cpp.

References getLocalAlignmentForType(), getNextTypeLoc(), getType(), isNull(), and Ty.

Referenced by clang::ASTContext::adjustExceptionSpec(), clang::ASTContext::CreateTypeSourceInfo(), and getFullDataSize().

◆ getLocalAlignmentForType()

unsigned TypeLoc::getLocalAlignmentForType ( QualType Ty )

static

Returns the alignment of type source info data block for the given type.

Returns the alignment of the type source info data block.

Definition at line 74 of file TypeLoc.cpp.

References Ty, and TypeLoc().

Referenced by getFullDataSizeForType(), and clang::QualifiedTypeLoc::getUnqualifiedLoc().

◆ getLocalSourceRange()

SourceRange clang::TypeLoc::getLocalSourceRange ( ) const

inline

Get the local source range.

Definition at line 159 of file TypeLoc.h.

Referenced by clang::Sema::BuildBaseInitializer(), clang::Sema::BuildBuiltinOffsetOf(), CheckDeducedPlaceholderConstraints(), getBeginLoc(), and clang::MacroQualifiedTypeLoc::getLocalSourceRange().

◆ getNextTypeLoc()

TypeLoc clang::TypeLoc::getNextTypeLoc ( ) const

inline

Get the next TypeLoc pointed by this TypeLoc, e.g for "int*" the TypeLoc is a PointerLoc and next TypeLoc is for "int".

Definition at line 170 of file TypeLoc.h.

Referenced by

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ TypeLocClass

Constructor & Destructor Documentation

◆ TypeLoc() [1/3]

◆ TypeLoc() [2/3]

◆ TypeLoc() [3/3]

Member Function Documentation

◆ castAs()

◆ copy()

◆ dump() [1/2]

◆ dump() [2/2]

◆ findExplicitQualifierLoc()

◆ findNullabilityLoc()

◆ getAs()

◆ getAsAdjusted()

◆ getBeginLoc()

◆ getContainedAutoTypeLoc()

◆ getEndLoc()

◆ getFullDataSize()

◆ getFullDataSizeForType()

◆ getLocalAlignmentForType()

◆ getLocalSourceRange()

◆ getNextTypeLoc()