clang 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
clang::TypeLoc Class Reference

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

#include "clang/AST/TypeLoc.h"

Inheritance diagram for clang::TypeLoc:
Inheritance graph
[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 TypegetTypePtr () 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

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

◆ 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

◆ 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

◆ dump() [2/2]

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

◆ 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 459 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 448 of file TypeLoc.cpp.

References clang::Attr::getLocation().

◆ getAs()

template<typename T >
T clang::TypeLoc::getAs ( ) const
inline

◆ 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 2684 of file TypeLoc.h.

References getAs(), and clang::T.

Referenced by clang::Sema::ActOnBlockArguments(), clang::TemplateDeclInstantiator::adjustForRewrite(), checkAttributesAfterMerging(), clang::Sema::CheckDeductionGuideDeclarator(), findTypeLocationForBlockDecl(), clang::Sema::getReturnTypeLoc(), implicitObjectParamIsLifetimeBound(), clang::Decl::isFlexibleArrayMemberLike(), 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::ActOnMethodDeclaration(), clang::SemaObjC::ActOnObjCForCollectionStmt(), clang::SemaObjC::actOnObjCTypeParam(), clang::SemaOpenMP::ActOnOMPIteratorExpr(), clang::Sema::ActOnTag(), clang::Sema::ActOnTemplateTypeArgument(), clang::applyObjCTypeArgs(), clang::Sema::AttachTypeConstraint(), clang::Sema::BuildBaseInitializer(), clang::Sema::BuildBuiltinBitCastExpr(), clang::Sema::BuildCXXTypeConstructExpr(), clang::Sema::BuildDeclaratorGroup(), 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(), 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::ASTImporter::Import(), clang::Sema::IsPointerInterconvertibleBaseOf(), clang::PseudoDestructorTypeStorage::PseudoDestructorTypeStorage(), clang::TreeTransform< Derived >::RebuildQualifiedType(), ReplaceWithClasstype(), ReplaceWithInstancetype(), clang::TreeTransform< Derived >::TransformAttributedType(), 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 740 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

◆ getFullDataSize()

unsigned clang::TypeLoc::getFullDataSize ( ) const
inline

◆ 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

◆ getNextTypeLoc()

TypeLoc clang::TypeLoc::getNextTypeLoc ( ) const
inline

◆ getOpaqueData()

void * clang::TypeLoc::getOpaqueData ( ) const
inline

◆ getSourceRange()

SourceRange clang::TypeLoc::getSourceRange ( ) const
inline

Get the full source range.

Definition at line 153 of file TypeLoc.h.

References getBeginLoc(), and getEndLoc().

Referenced by clang::Sema::ActOnConversionDeclarator(), clang::SemaObjC::actOnObjCTypeArgsAndProtocolQualifiers(), clang::Sema::AddAlignedAttr(), clang::SemaObjC::AdjustParameterTypeForObjCAutoRefCount(), AnalyzeBitFieldAssignment(), clang::applyObjCTypeArgs(), clang::Sema::AttachTypeConstraint(), clang::Sema::BuildBaseInitializer(), clang::SemaObjC::BuildClassMessage(), clang::Sema::BuildCStyleCastExpr(), clang::Sema::BuildCXXFunctionalCastExpr(), clang::Sema::BuildCXXNew(), clang::Sema::BuildDelegatingInitializer(), clang::SemaObjC::BuildObjCBridgedCast(), clang::Sema::BuildPseudoDestructorExpr(), clang::Sema::BuildVAArgExpr(), clang::Sema::CheckBaseSpecifier(), CheckConstexprDeclStmt(), clang::Sema::CheckConversionDeclarator(), clang::Sema::CheckDeductionGuideDeclarator(), clang::Sema::CheckPackExpansion(), clang::Sema::CheckParameter(), clang::Sema::CheckTemplateArgument(), checkTypeParamListConsistency(), clang::Sema::CreateGenericSelectionExpr(), clang::Sema::DeduceTemplateSpecializationFromInitializer(), clang::Sema::diagnoseQualifiedDeclaration(), findTemplateParameter(), getPointeeTypeText(), clang::Sema::getPrintable(), getRangeOfTypeInNestedNameSpecifier(), clang::ObjCMessageExpr::getReceiverRange(), clang::FunctionDecl::getReturnTypeSourceRange(), getTypeRange(), clang::Sema::InstantiateMemInitializers(), clang::TreeTransform< Derived >::TransformFunctionTypeParam(), clang::JSONNodeDumper::Visit(), and clang::TextNodeDumper::Visit().

◆ getTemplateKeywordLoc()

SourceLocation TypeLoc::getTemplateKeywordLoc ( ) const

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

Definition at line 747 of file TypeLoc.cpp.

Referenced by clang::Sema::diagnoseQualifiedDeclaration(), and clang::TreeTransform< Derived >::TransformNestedNameSpecifierLoc().

◆ getType()

QualType clang::TypeLoc::getType ( ) const
inline

◆ getTypeLocClass()

TypeLocClass clang::TypeLoc::getTypeLocClass ( ) const
inline

◆ getTypePtr()

const Type * clang::TypeLoc::getTypePtr ( ) const
inline

◆ getUnqualifiedLoc()

UnqualTypeLoc clang::TypeLoc::getUnqualifiedLoc ( ) const
inline

◆ IgnoreParens()

TypeLoc clang::TypeLoc::IgnoreParens ( ) const
inline

◆ initialize()

void clang::TypeLoc::initialize ( ASTContext Context,
SourceLocation  Loc 
) const
inline

Initializes this to state that every location in this type is the given location.

This method exists to provide a simple transition for code that relies on location-less types.

Definition at line 200 of file TypeLoc.h.

References Loc.

Referenced by clang::ASTContext::getTrivialTypeSourceInfo().

◆ initializeFullCopy() [1/2]

void clang::TypeLoc::initializeFullCopy ( TypeLoc  Other)
inline

Initializes this by copying its information from another TypeLoc of the same type.

Definition at line 206 of file TypeLoc.h.

References copy(), getType(), and clang::Other.

Referenced by clang::Sema::ActOnBlockArguments(), and FixInvalidVariablyModifiedTypeLoc().

◆ initializeFullCopy() [2/2]

void clang::TypeLoc::initializeFullCopy ( TypeLoc  Other,
unsigned  Size 
)
inline

Initializes this by copying its information from another TypeLoc of the same type.

The given size must be the full data size.

Definition at line 214 of file TypeLoc.h.

References copy(), getFullDataSize(), getType(), and clang::Other.

◆ isNull()

bool clang::TypeLoc::isNull ( ) const
inline

◆ operator bool()

clang::TypeLoc::operator bool ( ) const
inlineexplicit

Definition at line 122 of file TypeLoc.h.

References Ty.

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 227 of file TypeLoc.h.

◆ operator==

bool operator== ( const TypeLoc LHS,
const TypeLoc RHS 
)
friend

Definition at line 223 of file TypeLoc.h.

Member Data Documentation

◆ Data

void* clang::TypeLoc::Data = nullptr
protected

Definition at line 64 of file TypeLoc.h.

Referenced by copy(), getOpaqueData(), and clang::QualifiedTypeLoc::getUnqualifiedLoc().

◆ Ty

const void* clang::TypeLoc::Ty = nullptr
protected

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