clang::TemplateName Class Reference

Represents a C++ template name within the type system. More...

#include "clang/AST/TemplateName.h"

Public Types
enum	NameKind {   Template , OverloadedTemplate , AssumedTemplate , QualifiedTemplate ,   DependentTemplate , SubstTemplateTemplateParm , SubstTemplateTemplateParmPack , UsingTemplate ,   DeducedTemplate }
enum class	Qualified { None , AsWritten }

Public Member Functions
	TemplateName ()=default
	TemplateName (TemplateDecl *Template)
	TemplateName (OverloadedTemplateStorage *Storage)
	TemplateName (AssumedTemplateStorage *Storage)
	TemplateName (SubstTemplateTemplateParmStorage *Storage)
	TemplateName (SubstTemplateTemplateParmPackStorage *Storage)
	TemplateName (QualifiedTemplateName *Qual)
	TemplateName (DependentTemplateName *Dep)
	TemplateName (UsingShadowDecl *Using)
	TemplateName (DeducedTemplateStorage *Deduced)
bool	isNull () const
	Determine whether this template name is NULL.
NameKind	getKind () const
TemplateDecl *	getAsTemplateDecl (bool IgnoreDeduced=false) const
	Retrieve the underlying template declaration that this template name refers to, if known.
std::pair< TemplateDecl *, DefaultArguments >	getTemplateDeclAndDefaultArgs () const
	Retrieves the underlying template declaration that this template name refers to, along with the deduced default arguments, if any.
OverloadedTemplateStorage *	getAsOverloadedTemplate () const
	Retrieve the underlying, overloaded function template declarations that this template name refers to, if known.
AssumedTemplateStorage *	getAsAssumedTemplateName () const
	Retrieve information on a name that has been assumed to be a template-name in order to permit a call via ADL.
SubstTemplateTemplateParmStorage *	getAsSubstTemplateTemplateParm () const
	Retrieve the substituted template template parameter, if known.
SubstTemplateTemplateParmPackStorage *	getAsSubstTemplateTemplateParmPack () const
	Retrieve the substituted template template parameter pack, if known.
QualifiedTemplateName *	getAsQualifiedTemplateName () const
	Retrieve the underlying qualified template name structure, if any.
DependentTemplateName *	getAsDependentTemplateName () const
	Retrieve the underlying dependent template name structure, if any.
std::tuple< NestedNameSpecifier, bool >	getQualifierAndTemplateKeyword () const
NestedNameSpecifier	getQualifier () const
UsingShadowDecl *	getAsUsingShadowDecl () const
	Retrieve the using shadow declaration through which the underlying template declaration is introduced, if any.
DeducedTemplateStorage *	getAsDeducedTemplateName () const
	Retrieve the deduced template info, if any.
std::optional< TemplateName >	desugar (bool IgnoreDeduced) const
TemplateName	getUnderlying () const
TemplateNameDependence	getDependence () const
bool	isDependent () const
	Determines whether this is a dependent template name.
bool	isInstantiationDependent () const
	Determines whether this is a template name that somehow depends on a template parameter.
bool	containsUnexpandedParameterPack () const
	Determines whether this template name contains an unexpanded parameter pack (for C++0x variadic templates).
void	print (raw_ostream &OS, const PrintingPolicy &Policy, Qualified Qual=Qualified::AsWritten) const
	Print the template name.
void	dump (raw_ostream &OS, const ASTContext &Context) const
	Debugging aid that dumps the template name.
void	dump () const
	Debugging aid that dumps the template name to standard error.
void	Profile (llvm::FoldingSetNodeID &ID)
void *	getAsVoidPointer () const
	Retrieve the template name as a void pointer.
bool	operator== (TemplateName Other) const
	Structural equality.
bool	operator!= (TemplateName Other) const

Static Public Member Functions
static TemplateName	getFromVoidPointer (void *Ptr)
	Build a template name from a void pointer.

Detailed Description

Represents a C++ template name within the type system.

A C++ template name refers to a template within the C++ type system. In most cases, a template name is simply a reference to a class template, e.g.

template<typename T> class X { };
 
X<int> xi;

Here, the 'X' in X<int> is a template name that refers to the declaration of the class template X, above. Template names can also refer to function templates, C++0x template aliases, etc.

Some template names are dependent. For example, consider:

template<typename MetaFun, typename T1, typename T2> struct apply2 {
  typedef typename MetaFun::template apply<T1, T2>::type type;
};

Here, "apply" is treated as a template name within the typename specifier in the typedef. "apply" is a nested template, and can only be understood in the context of a template instantiation, hence is represented as a dependent template name.

Definition at line 222 of file TemplateName.h.

Member Enumeration Documentation

NameKind

enum clang::TemplateName::NameKind

Enumerator
Template	A single template declaration.
OverloadedTemplate	A set of overloaded template declarations.
AssumedTemplate	An unqualified-id that has been assumed to name a function template that will be found by ADL.
QualifiedTemplate	A qualified template name, where the qualification is kept to describe the source code as written.
DependentTemplate	A dependent template name that has not been resolved to a template (or set of templates).
SubstTemplateTemplateParm	A template template parameter that has been substituted for some other template name.
SubstTemplateTemplateParmPack	A template template parameter pack that has been substituted for a template template argument pack, but has not yet been expanded into individual arguments.
UsingTemplate	A template name that refers to a template declaration found through a specific using shadow declaration.
DeducedTemplate	A template name that refers to another TemplateName with deduced default arguments.

Definition at line 237 of file TemplateName.h.

Qualified

enum class clang::TemplateName::Qualified

strong

Enumerator
None
AsWritten

Definition at line 374 of file TemplateName.h.

Constructor & Destructor Documentation

TemplateName() [1/10]

clang::TemplateName::TemplateName ( )

default

Referenced by desugar().

TemplateName() [2/10]

TemplateName::TemplateName ( TemplateDecl *  Template )

explicit

Definition at line 156 of file TemplateName.cpp.

TemplateName() [3/10]

TemplateName::TemplateName ( OverloadedTemplateStorage *  Storage )

explicit

Definition at line 157 of file TemplateName.cpp.

TemplateName() [4/10]

TemplateName::TemplateName ( AssumedTemplateStorage *  Storage )

explicit

Definition at line 159 of file TemplateName.cpp.

TemplateName() [5/10]

TemplateName::TemplateName ( SubstTemplateTemplateParmStorage *  Storage )

explicit

Definition at line 161 of file TemplateName.cpp.

TemplateName() [6/10]

TemplateName::TemplateName ( SubstTemplateTemplateParmPackStorage *  Storage )

explicit

Definition at line 163 of file TemplateName.cpp.

TemplateName() [7/10]

TemplateName::TemplateName ( QualifiedTemplateName *  Qual )

explicit

Definition at line 165 of file TemplateName.cpp.

TemplateName() [8/10]

TemplateName::TemplateName ( DependentTemplateName *  Dep )

explicit

Definition at line 166 of file TemplateName.cpp.

TemplateName() [9/10]

TemplateName::TemplateName ( UsingShadowDecl *  Using )

explicit

Definition at line 167 of file TemplateName.cpp.

TemplateName() [10/10]

TemplateName::TemplateName ( DeducedTemplateStorage *  Deduced )

explicit

Definition at line 168 of file TemplateName.cpp.

Member Function Documentation

containsUnexpandedParameterPack()

bool TemplateName::containsUnexpandedParameterPack

(

)

const

Determines whether this template name contains an unexpanded parameter pack (for C++0x variadic templates).

Definition at line 416 of file TemplateName.cpp.

References getDependence().

Referenced by clang::Sema::ActOnPackExpansion().

desugar()

std::optional< TemplateName > TemplateName::desugar

(

bool

IgnoreDeduced

)

const

Definition at line 238 of file TemplateName.cpp.

References D, getAsDeducedTemplateName(), getAsQualifiedTemplateName(), getAsSubstTemplateTemplateParm(), and TemplateName().

dump() [1/2]

LLVM_DUMP_METHOD void TemplateName::dump

(

)

const

Debugging aid that dumps the template name to standard error.

Definition at line 372 of file ASTDumper.cpp.

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

dump() [2/2]

void clang::TemplateName::dump	(	raw_ostream &	OS,
		const ASTContext &	Context
	)		const

Debugging aid that dumps the template name.

getAsAssumedTemplateName()

AssumedTemplateStorage * TemplateName::getAsAssumedTemplateName

(

)

const

Retrieve information on a name that has been assumed to be a template-name in order to permit a call via ADL.

Definition at line 262 of file TemplateName.cpp.

References clang::UncommonTemplateNameStorage::getAsAssumedTemplateName().

Referenced by clang::ASTImporter::Import(), IsStructurallyEquivalent(), and print().

getAsDeducedTemplateName()

DeducedTemplateStorage * TemplateName::getAsDeducedTemplateName

(

)

const

Retrieve the deduced template info, if any.

Definition at line 347 of file TemplateName.cpp.

References clang::UncommonTemplateNameStorage::getAsDeducedTemplateName().

Referenced by desugar(), clang::TextNodeDumper::dumpBareTemplateName(), getDependence(), and print().

getAsDependentTemplateName()

DependentTemplateName * TemplateName::getAsDependentTemplateName

(

)

const

Retrieve the underlying dependent template name structure, if any.

Definition at line 292 of file TemplateName.cpp.

Referenced by clang::Sema::CheckTemplateArgument(), clang::TextNodeDumper::dumpBareTemplateName(), getDependence(), clang::ASTImporter::Import(), IsStructurallyEquivalent(), and print().

getAsOverloadedTemplate()

OverloadedTemplateStorage * TemplateName::getAsOverloadedTemplate

(

)

const

Retrieve the underlying, overloaded function template declarations that this template name refers to, if known.

Returns

The set of overloaded function templates that this template name refers to, if known. If the template name does not refer to a specific set of function templates because it is a dependent name or refers to a single template, returns NULL.

Definition at line 254 of file TemplateName.cpp.

References clang::UncommonTemplateNameStorage::getAsOverloadedStorage().

Referenced by clang::ASTImporter::Import(), IsStructurallyEquivalent(), and print().

getAsQualifiedTemplateName()

QualifiedTemplateName * TemplateName::getAsQualifiedTemplateName

(

)

const

Retrieve the underlying qualified template name structure, if any.

Definition at line 288 of file TemplateName.cpp.

Referenced by clang::Sema::CheckDeductionGuideDeclarator(), desugar(), clang::TextNodeDumper::dumpBareTemplateName(), getAsUsingShadowDecl(), getDependence(), clang::TypeName::getFullyQualifiedTemplateName(), clang::ASTImporter::Import(), and print().

getAsSubstTemplateTemplateParm()

SubstTemplateTemplateParmStorage * TemplateName::getAsSubstTemplateTemplateParm

(

)

const

Retrieve the substituted template template parameter, if known.

Returns

The storage for the substituted template template parameter, if known. Otherwise, returns NULL.

Definition at line 271 of file TemplateName.cpp.

References clang::UncommonTemplateNameStorage::getAsSubstTemplateTemplateParm().

Referenced by desugar(), clang::TextNodeDumper::dumpBareTemplateName(), getDependence(), clang::ASTImporter::Import(), and print().

getAsSubstTemplateTemplateParmPack()

SubstTemplateTemplateParmPackStorage * TemplateName::getAsSubstTemplateTemplateParmPack

(

)

const

Retrieve the substituted template template parameter pack, if known.

Returns

The storage for the substituted template template parameter pack, if known. Otherwise, returns NULL.

Definition at line 280 of file TemplateName.cpp.

References clang::UncommonTemplateNameStorage::getAsSubstTemplateTemplateParmPack().

Referenced by clang::Sema::getFullyPackExpandedSize(), clang::ASTImporter::Import(), IsStructurallyEquivalent(), and print().

getAsTemplateDecl()

TemplateDecl * TemplateName::getAsTemplateDecl

(

bool

IgnoreDeduced = false

)

const

Retrieve the underlying template declaration that this template name refers to, if known.

Returns

The template declaration that this template name refers to, if any. If the template name does not refer to a specific declaration because it is a dependent name, or if it refers to a set of function templates, returns NULL.

Definition at line 201 of file TemplateName.cpp.

Referenced by clang::Sema::ActOnTemplateTemplateArgument(), clang::Sema::BuildTypeConstraint(), clang::Sema::CheckDeductionGuideDeclarator(), clang::Sema::CheckTypeConstraint(), DeduceTemplateArguments(), DeduceTemplateSpecArguments(), clang::Sema::DeduceTemplateSpecializationFromInitializer(), DiagnoseBadDeduction(), clang::TextNodeDumper::dumpBareTemplateName(), clang::ASTContext::getCanonicalTemplateName(), GetDeclSpecTypeForDeclarator(), getDependence(), clang::TypeName::getFullyQualifiedTemplateName(), clang::Sema::GetNameFromUnqualifiedId(), getTemplateDeclAndDefaultArgs(), clang::ASTImporter::Import(), InventTemplateParameter(), isEnableIf(), clang::isPackProducingBuiltinTemplateName(), IsSmallVector(), IsStdVector(), IsStructurallyEquivalent(), isSubstitutedTemplateArgument(), isTemplateArgumentTemplateParameter(), CXXNameMangler::TemplateArgManglingInfo::needToMangleTemplateParam(), print(), and CXXNameMangler::TemplateArgManglingInfo::TemplateArgManglingInfo().

getAsUsingShadowDecl()

UsingShadowDecl * TemplateName::getAsUsingShadowDecl

(

)

const

Retrieve the using shadow declaration through which the underlying template declaration is introduced, if any.

Definition at line 311 of file TemplateName.cpp.

References D, and getAsQualifiedTemplateName().

Referenced by clang::Sema::BuildTypeConstraint(), clang::TextNodeDumper::dumpBareTemplateName(), clang::TypeName::getFullyQualifiedTemplateName(), clang::ASTImporter::Import(), and InventTemplateParameter().

getAsVoidPointer()

void * clang::TemplateName::getAsVoidPointer ( ) const

inline

Retrieve the template name as a void pointer.

Definition at line 398 of file TemplateName.h.

Referenced by llvm::PointerLikeTypeTraits< clang::TemplateName >::getAsVoidPointer(), getCommonSugarTypeNode(), getCommonTemplateArgument(), getCommonTemplateName(), getCommonTemplateNameChecked(), and clang::QualifiedTemplateName::Profile().

getDependence()

TemplateNameDependence TemplateName::getDependence

(

)

const

Definition at line 355 of file TemplateName.cpp.

References clang::DefaultArguments::Args, AssumedTemplate, D, DeducedTemplate, DependentTemplate, getAsDeducedTemplateName(), getAsDependentTemplateName(), getAsQualifiedTemplateName(), getAsSubstTemplateTemplateParm(), getAsTemplateDecl(), clang::DeducedTemplateStorage::getDefaultArguments(), getDependence(), getKind(), clang::DeducedTemplateStorage::getUnderlying(), OverloadedTemplate, QualifiedTemplate, SubstTemplateTemplateParm, SubstTemplateTemplateParmPack, Template, clang::toTemplateNameDependence(), and UsingTemplate.

Referenced by containsUnexpandedParameterPack(), getDependence(), isDependent(), and isInstantiationDependent().

getFromVoidPointer()

static TemplateName clang::TemplateName::getFromVoidPointer ( void *  Ptr )

inlinestatic

Build a template name from a void pointer.

Definition at line 401 of file TemplateName.h.

Referenced by clang::TemplateArgument::getAsTemplate(), clang::TemplateArgument::getAsTemplateOrTemplatePattern(), and llvm::PointerLikeTypeTraits< clang::TemplateName >::getFromVoidPointer().

getKind()

TemplateName::NameKind TemplateName::getKind

(

)

const

Definition at line 173 of file TemplateName.cpp.

References AssumedTemplate, DeducedTemplate, DependentTemplate, clang::UncommonTemplateNameStorage::getAsAssumedTemplateName(), clang::UncommonTemplateNameStorage::getAsDeducedTemplateName(), clang::UncommonTemplateNameStorage::getAsOverloadedStorage(), clang::UncommonTemplateNameStorage::getAsSubstTemplateTemplateParm(), clang::UncommonTemplateNameStorage::getAsSubstTemplateTemplateParmPack(), OverloadedTemplate, QualifiedTemplate, SubstTemplateTemplateParm, SubstTemplateTemplateParmPack, Template, and UsingTemplate.

Referenced by DiagnoseBadDeduction(), clang::TextNodeDumper::dumpBareTemplateName(), getDependence(), clang::ASTImporter::Import(), IsStructurallyEquivalent(), and print().

getQualifier()

NestedNameSpecifier clang::TemplateName::getQualifier ( ) const

inline

Definition at line 346 of file TemplateName.h.

Referenced by clang::TemplateSpecializationTypeLoc::getQualifierLoc(), clang::DeducedTemplateSpecializationTypeLoc::getQualifierLoc(), clang::TemplateArgumentLoc::getTemplateQualifierLoc(), clang::TemplateArgumentLoc::TemplateArgumentLoc(), and clang::TreeTransform< Derived >::TransformTemplateName().

getQualifierAndTemplateKeyword()

std::tuple< NestedNameSpecifier, bool > TemplateName::getQualifierAndTemplateKeyword

(

)

const

Definition at line 297 of file TemplateName.cpp.

Referenced by clang::TemplateSpecializationTypeLoc::initializeLocal().

getTemplateDeclAndDefaultArgs()

std::pair< TemplateDecl *, DefaultArguments > TemplateName::getTemplateDeclAndDefaultArgs

(

)

const

Retrieves the underlying template declaration that this template name refers to, along with the deduced default arguments, if any.

Definition at line 217 of file TemplateName.cpp.

References clang::DefaultArguments::Args, DeducedTemplate, getAsTemplateDecl(), clang::DeducedTemplateStorage::getDefaultArguments(), clang::TemplateDecl::getTemplateParameters(), clang::DeducedTemplateStorage::getUnderlying(), clang::TemplateParameterList::size(), and clang::DefaultArguments::StartPos.

Referenced by CXXNameMangler::TemplateArgManglingInfo::needToMangleTemplateParam().

getUnderlying()

TemplateName clang::TemplateName::getUnderlying ( ) const

inline

Definition at line 485 of file TemplateName.h.

References clang::UncommonTemplateNameStorage::getAsSubstTemplateTemplateParm(), and getUnderlying().

Referenced by getUnderlying().

isDependent()

bool TemplateName::isDependent

(

)

const

Determines whether this is a dependent template name.

Definition at line 408 of file TemplateName.cpp.

References getDependence().

Referenced by clang::Sema::DeduceTemplateSpecializationFromInitializer().

isInstantiationDependent()

bool TemplateName::isInstantiationDependent

(

)

const

Determines whether this is a template name that somehow depends on a template parameter.

Definition at line 412 of file TemplateName.cpp.

References getDependence().

isNull()

bool TemplateName::isNull

(

)

const

Determine whether this template name is NULL.

Definition at line 171 of file TemplateName.cpp.

Referenced by clang::Sema::ActOnTemplateTemplateParameter(), clang::Sema::SubstDefaultTemplateArgumentIfAvailable(), clang::TreeTransform< Derived >::TransformNamedTemplateTemplateArgument(), and clang::TreeTransform< Derived >::TransformTemplateName().

operator!=()

bool clang::TemplateName::operator!= ( TemplateName  Other ) const

inline

Definition at line 407 of file TemplateName.h.

References clang::operator==(), and clang::Other.

operator==()

bool clang::TemplateName::operator== ( TemplateName  Other ) const

inline

Structural equality.

Definition at line 406 of file TemplateName.h.

References clang::Other.

print()

void TemplateName::print	(	raw_ostream &	OS,
		const PrintingPolicy &	Policy,
		Qualified	Qual = Qualified::AsWritten
	)		const

Print the template name.

Parameters

OS	the output stream to which the template name will be printed.
Qual	print the (Qualified::None) simple name, (Qualified::AsWritten) any written (possibly partial) qualifier, or (Qualified::Fully) the fully qualified name.

Definition at line 420 of file TemplateName.cpp.

References clang::DefaultArguments::Args, clang::OverloadedTemplateStorage::begin(), clang::PrintingPolicy::CleanUglifiedParameters, getAsAssumedTemplateName(), getAsDeducedTemplateName(), getAsDependentTemplateName(), getAsOverloadedTemplate(), getAsQualifiedTemplateName(), getAsSubstTemplateTemplateParm(), getAsSubstTemplateTemplateParmPack(), getAsTemplateDecl(), getKind(), None, OverloadedTemplate, clang::Decl::print(), clang::PrintingPolicy::PrintAsCanonical, clang::printTemplateArgumentList(), clang::DefaultArguments::StartPos, clang::PrintingPolicy::SuppressScope, clang::PrintingPolicy::SuppressUnwrittenScope, Template, and UsingTemplate.

Referenced by clang::TextNodeDumper::dumpTemplateName(), clang::operator<<(), clang::TemplateArgument::print(), and clang::JSONNodeDumper::VisitTemplateSpecializationType().

Profile()

void clang::TemplateName::Profile ( llvm::FoldingSetNodeID &  ID )

inline

Definition at line 393 of file TemplateName.h.

References ID.

Referenced by clang::DeducedTemplateStorage::Profile().

---

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

• include/clang/AST/TemplateName.h
• lib/AST/ASTDumper.cpp
• lib/AST/TemplateName.cpp