Declaration of a class template. More...

#include <DeclTemplate.h>

Inheritance diagram for clang::ClassTemplateDecl:

Collaboration diagram for clang::ClassTemplateDecl:

Classes
struct	Common
	Data that is common to all of the declarations of a given class template. More...
Public Types
typedef SpecIterator < ClassTemplateSpecializationDecl >	spec_iterator
typedef SpecIterator < ClassTemplatePartialSpecializationDecl >	partial_spec_iterator
Public Member Functions
CXXRecordDecl *	getTemplatedDecl () const
	Get the underlying class declarations of the template.
bool	isThisDeclarationADefinition () const
	Returns whether this template declaration defines the primary class pattern.
ClassTemplateSpecializationDecl *	findSpecialization (const TemplateArgument Args, unsigned NumArgs, void &InsertPos)
	Return the specialization with the provided arguments if it exists, otherwise return the insertion point.
void	AddSpecialization (ClassTemplateSpecializationDecl D, void InsertPos)
	Insert the specified specialization knowing that it is not already in. InsertPos must be obtained from findSpecialization.
ClassTemplateDecl *	getCanonicalDecl ()
	Retrieves the canonical declaration of this template.
const ClassTemplateDecl *	getCanonicalDecl () const
ClassTemplateDecl *	getPreviousDecl ()
	Retrieve the previous declaration of this class template, or NULL if no such declaration exists.
const ClassTemplateDecl *	getPreviousDecl () const
	Retrieve the previous declaration of this class template, or NULL if no such declaration exists.
ClassTemplateDecl *	getInstantiatedFromMemberTemplate ()
ClassTemplatePartialSpecializationDecl *	findPartialSpecialization (const TemplateArgument Args, unsigned NumArgs, void &InsertPos)
	Return the partial specialization with the provided arguments if it exists, otherwise return the insertion point.
void	AddPartialSpecialization (ClassTemplatePartialSpecializationDecl D, void InsertPos)
	Insert the specified partial specialization knowing that it is not already in. InsertPos must be obtained from findPartialSpecialization.
unsigned	getNextPartialSpecSequenceNumber ()
	Return the next partial specialization sequence number.
void	getPartialSpecializations (SmallVectorImpl< ClassTemplatePartialSpecializationDecl * > &PS)
	Retrieve the partial specializations as an ordered list.
ClassTemplatePartialSpecializationDecl *	findPartialSpecialization (QualType T)
	Find a class template partial specialization with the given type T.
ClassTemplatePartialSpecializationDecl *	findPartialSpecInstantiatedFromMember (ClassTemplatePartialSpecializationDecl *D)
	Find a class template partial specialization which was instantiated from the given member partial specialization.
QualType	getInjectedClassNameSpecialization ()
	Retrieve the template specialization type of the injected-class-name for this class template.
spec_iterator	spec_begin () const
spec_iterator	spec_end () const
partial_spec_iterator	partial_spec_begin ()
partial_spec_iterator	partial_spec_end ()
Static Public Member Functions
static ClassTemplateDecl *	Create (ASTContext &C, DeclContext DC, SourceLocation L, DeclarationName Name, TemplateParameterList Params, NamedDecl Decl, ClassTemplateDecl PrevDecl)
	Create a class template node.
static ClassTemplateDecl *	CreateDeserialized (ASTContext &C, unsigned ID)
	Create an empty class template node.
static bool	classof (const Decl *D)
static bool	classofKind (Kind K)
Protected Member Functions
void	LoadLazySpecializations () const
	Load any lazily-loaded specializations from the external source.
llvm::FoldingSetVector < ClassTemplateSpecializationDecl > &	getSpecializations () const
	Retrieve the set of specializations of this class template.
llvm::FoldingSetVector < ClassTemplatePartialSpecializationDecl > &	getPartialSpecializations ()
	Retrieve the set of partial specializations of this class template.
	ClassTemplateDecl (DeclContext DC, SourceLocation L, DeclarationName Name, TemplateParameterList Params, NamedDecl *Decl)
	ClassTemplateDecl (EmptyShell Empty)
CommonBase *	newCommon (ASTContext &C) const
Common *	getCommonPtr () const
	Retrieves the "common" pointer shared by all (re-)declarations of the same template. Calling this routine may implicitly allocate memory for the common pointer.
Friends
class	ASTDeclReader
class	ASTDeclWriter

Detailed Description

Declaration of a class template.

Definition at line 1802 of file DeclTemplate.h.

Member Typedef Documentation

typedef SpecIterator<ClassTemplatePartialSpecializationDecl> clang::ClassTemplateDecl::partial_spec_iterator

Definition at line 1987 of file DeclTemplate.h.

typedef SpecIterator<ClassTemplateSpecializationDecl> clang::ClassTemplateDecl::spec_iterator

Definition at line 1976 of file DeclTemplate.h.

Constructor & Destructor Documentation

clang::ClassTemplateDecl::ClassTemplateDecl	(	DeclContext *	DC,
		SourceLocation	L,
		DeclarationName	Name,
		TemplateParameterList *	Params,
		NamedDecl *	Decl
	)		`[inline, protected]`

Definition at line 1843 of file DeclTemplate.h.

Referenced by Create(), and CreateDeserialized().

clang::ClassTemplateDecl::ClassTemplateDecl ( EmptyShell Empty ) [inline, protected]

Definition at line 1847 of file DeclTemplate.h.

Member Function Documentation

void ClassTemplateDecl::AddPartialSpecialization	(	ClassTemplatePartialSpecializationDecl *	D,
		void *	InsertPos
	)

Insert the specified partial specialization knowing that it is not already in. InsertPos must be obtained from findPartialSpecialization.

Definition at line 362 of file DeclTemplate.cpp.

References clang::Decl::getASTMutationListener(), getPartialSpecializations(), and clang::Decl::isCanonicalDecl().

void ClassTemplateDecl::AddSpecialization	(	ClassTemplateSpecializationDecl *	D,
		void *	InsertPos
	)

Insert the specified specialization knowing that it is not already in. InsertPos must be obtained from findSpecialization.

Definition at line 340 of file DeclTemplate.cpp.

References clang::Decl::getASTMutationListener(), getSpecializations(), and clang::Decl::isCanonicalDecl().

static bool clang::ClassTemplateDecl::classof ( const Decl * D ) [inline, static]

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 1998 of file DeclTemplate.h.

References classofKind(), and clang::Decl::getKind().

static bool clang::ClassTemplateDecl::classofKind ( Kind K ) [inline, static]

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 1999 of file DeclTemplate.h.

Referenced by classof().

ClassTemplateDecl * ClassTemplateDecl::Create	(	ASTContext &	C,
		DeclContext *	DC,
		SourceLocation	L,
		DeclarationName	Name,
		TemplateParameterList *	Params,
		NamedDecl *	Decl,
		ClassTemplateDecl *	PrevDecl
	)		`[static]`

Create a class template node.

Definition at line 285 of file DeclTemplate.cpp.

References AdoptTemplateParameterList(), ClassTemplateDecl(), and clang::Redeclarable< decl_type >::setPreviousDeclaration().

Referenced by clang::Sema::CheckClassTemplate(), clang::ASTNodeImporter::VisitClassTemplateDecl(), and clang::TemplateDeclInstantiator::VisitClassTemplateDecl().

ClassTemplateDecl * ClassTemplateDecl::CreateDeserialized	(	ASTContext &	C,
		unsigned	ID
	)		`[static]`

Create an empty class template node.

Definition at line 298 of file DeclTemplate.cpp.

References clang::Decl::AllocateDeserializedDecl(), and ClassTemplateDecl().

ClassTemplatePartialSpecializationDecl * ClassTemplateDecl::findPartialSpecialization	(	const TemplateArgument *	Args,
		unsigned	NumArgs,
		void *&	InsertPos
	)

Return the partial specialization with the provided arguments if it exists, otherwise return the insertion point.

Definition at line 355 of file DeclTemplate.cpp.

References clang::RedeclarableTemplateDecl::findSpecializationImpl(), and getPartialSpecializations().

Referenced by clang::TemplateDeclInstantiator::InstantiateClassTemplatePartialSpecialization().

ClassTemplatePartialSpecializationDecl * ClassTemplateDecl::findPartialSpecialization ( QualType T )

Find a class template partial specialization with the given type T.

Parameters:

T	a dependent type that names a specialization of this class template.

Returns:: the class template partial specialization that exactly matches the type T, or NULL if no such partial specialization exists.

Definition at line 393 of file DeclTemplate.cpp.

References Context, clang::Decl::getASTContext(), getPartialSpecializations(), clang::ASTContext::hasSameType(), and P.

ClassTemplatePartialSpecializationDecl * ClassTemplateDecl::findPartialSpecInstantiatedFromMember ( ClassTemplatePartialSpecializationDecl * D )

Find a class template partial specialization which was instantiated from the given member partial specialization.

Parameters:

D	a member class template partial specialization.

Returns:: the class template partial specialization which was instantiated from the given member partial specialization, or NULL if no such partial specialization exists.

Definition at line 409 of file DeclTemplate.cpp.

References clang::CXXRecordDecl::getCanonicalDecl(), getPartialSpecializations(), and P.

Referenced by clang::TemplateDeclInstantiator::VisitClassTemplatePartialSpecializationDecl().

ClassTemplateSpecializationDecl * ClassTemplateDecl::findSpecialization	(	const TemplateArgument *	Args,
		unsigned	NumArgs,
		void *&	InsertPos
	)

Return the specialization with the provided arguments if it exists, otherwise return the insertion point.

Definition at line 335 of file DeclTemplate.cpp.

References clang::RedeclarableTemplateDecl::findSpecializationImpl(), and getSpecializations().

Referenced by clang::ASTNodeImporter::VisitClassTemplateSpecializationDecl().

ClassTemplateDecl* clang::ClassTemplateDecl::getCanonicalDecl ( ) [inline, virtual]

Retrieves the canonical declaration of this template.

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 1890 of file DeclTemplate.h.

Referenced by clang::ASTWriter::AddedCXXTemplateSpecialization(), clang::Sema::FindInstantiatedDecl(), getCanonicalDecl(), isInstantiationOf(), MatchesFriend(), and clang::ASTDeclWriter::VisitClassTemplateSpecializationDecl().

const ClassTemplateDecl* clang::ClassTemplateDecl::getCanonicalDecl ( ) const [inline]

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 1894 of file DeclTemplate.h.

References getCanonicalDecl().

Common* clang::ClassTemplateDecl::getCommonPtr ( ) const [inline, protected]

Retrieves the "common" pointer shared by all (re-)declarations of the same template. Calling this routine may implicitly allocate memory for the common pointer.

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 1853 of file DeclTemplate.h.

Referenced by getInjectedClassNameSpecialization(), getPartialSpecializations(), getSpecializations(), LoadLazySpecializations(), clang::ASTDeclWriter::VisitClassTemplateDecl(), clang::ASTDeclReader::VisitClassTemplateDecl(), and clang::ASTDeclReader::VisitClassTemplateSpecializationDecl().

QualType ClassTemplateDecl::getInjectedClassNameSpecialization ( )

Retrieve the template specialization type of the injected-class-name for this class template.

The injected-class-name for a class template X is X<template-args>, where template-args is formed from the template arguments that correspond to the template parameters of X. For example:

 template<typename T, int N>
 struct array {
   typedef array this_type; // "array" is equivalent to "array<T, N>"
 };

Definition at line 424 of file DeclTemplate.cpp.

References Context, GenerateInjectedTemplateArgs(), clang::Decl::getASTContext(), getCommonPtr(), clang::TemplateDecl::getTemplateParameters(), clang::ASTContext::getTemplateSpecializationType(), clang::ClassTemplateDecl::Common::InjectedClassNameType, clang::QualType::isNull(), and clang::TemplateParameterList::size().

Referenced by clang::Sema::CheckClassTemplate(), and clang::TemplateDeclInstantiator::VisitClassTemplateDecl().

ClassTemplateDecl* clang::ClassTemplateDecl::getInstantiatedFromMemberTemplate ( ) [inline]

Definition at line 1913 of file DeclTemplate.h.

Referenced by clang::Sema::CheckClassTemplate(), clang::Sema::InstantiateClassTemplateSpecialization(), and isInstantiationOf().

unsigned clang::ClassTemplateDecl::getNextPartialSpecSequenceNumber ( ) [inline]

Return the next partial specialization sequence number.

Definition at line 1930 of file DeclTemplate.h.

References getPartialSpecializations().

llvm::FoldingSetVector< ClassTemplatePartialSpecializationDecl > & ClassTemplateDecl::getPartialSpecializations ( ) [protected]

Retrieve the set of partial specializations of this class template.

Definition at line 322 of file DeclTemplate.cpp.

References getCommonPtr(), LoadLazySpecializations(), and clang::ClassTemplateDecl::Common::PartialSpecializations.

Referenced by AddPartialSpecialization(), findPartialSpecialization(), findPartialSpecInstantiatedFromMember(), getNextPartialSpecSequenceNumber(), getPartialSpecializations(), clang::Sema::InstantiateClassTemplateSpecialization(), partial_spec_begin(), partial_spec_end(), clang::ASTDeclWriter::VisitClassTemplateDecl(), and clang::TemplateDeclInstantiator::VisitClassTemplateDecl().

void ClassTemplateDecl::getPartialSpecializations ( SmallVectorImpl< ClassTemplatePartialSpecializationDecl * > & PS )

Retrieve the partial specializations as an ordered list.

Definition at line 378 of file DeclTemplate.cpp.

References getPartialSpecializations(), and P.

ClassTemplateDecl* clang::ClassTemplateDecl::getPreviousDecl ( ) [inline]

Retrieve the previous declaration of this class template, or NULL if no such declaration exists.

Reimplemented from clang::Redeclarable< RedeclarableTemplateDecl >.

Definition at line 1901 of file DeclTemplate.h.

Referenced by getPreviousDecl().

const ClassTemplateDecl* clang::ClassTemplateDecl::getPreviousDecl ( ) const [inline]

Retrieve the previous declaration of this class template, or NULL if no such declaration exists.

Reimplemented from clang::Redeclarable< RedeclarableTemplateDecl >.

Definition at line 1908 of file DeclTemplate.h.

References getPreviousDecl().

llvm::FoldingSetVector< ClassTemplateSpecializationDecl > & ClassTemplateDecl::getSpecializations ( ) const [protected]

Retrieve the set of specializations of this class template.

Definition at line 316 of file DeclTemplate.cpp.

References getCommonPtr(), LoadLazySpecializations(), and clang::ClassTemplateDecl::Common::Specializations.

Referenced by AddSpecialization(), findSpecialization(), spec_begin(), spec_end(), and clang::ASTDeclWriter::VisitClassTemplateDecl().

CXXRecordDecl* clang::ClassTemplateDecl::getTemplatedDecl ( ) const [inline]

Get the underlying class declarations of the template.

Reimplemented from clang::TemplateDecl.

Definition at line 1859 of file DeclTemplate.h.

References clang::TemplateDecl::TemplatedDecl.

Referenced by clang::Sema::CheckClassTemplate(), getLVForClassMember(), clang::Sema::InstantiateClassTemplateSpecialization(), clang::Sema::isStdInitializerList(), IsStructurallyEquivalent(), isThisDeclarationADefinition(), clang::ASTNodeImporter::VisitClassTemplateDecl(), and clang::TemplateDeclInstantiator::VisitClassTemplateDecl().

bool clang::ClassTemplateDecl::isThisDeclarationADefinition ( ) const [inline]

Returns whether this template declaration defines the primary class pattern.

Definition at line 1865 of file DeclTemplate.h.

References getTemplatedDecl(), and clang::TagDecl::isThisDeclarationADefinition().

void ClassTemplateDecl::LoadLazySpecializations ( ) const [protected]

Load any lazily-loaded specializations from the external source.

Definition at line 304 of file DeclTemplate.cpp.

References Context, clang::Decl::getASTContext(), getCommonPtr(), clang::ExternalASTSource::GetExternalDecl(), clang::ASTContext::getExternalSource(), and clang::ClassTemplateDecl::Common::LazySpecializations.

Referenced by getPartialSpecializations(), and getSpecializations().

RedeclarableTemplateDecl::CommonBase * ClassTemplateDecl::newCommon ( ASTContext & C ) const [protected, virtual]

Implements clang::RedeclarableTemplateDecl.

Definition at line 328 of file DeclTemplate.cpp.

References clang::ASTContext::AddDeallocation().

partial_spec_iterator clang::ClassTemplateDecl::partial_spec_begin ( ) [inline]

Definition at line 1989 of file DeclTemplate.h.

References getPartialSpecializations(), and clang::RedeclarableTemplateDecl::makeSpecIterator().

partial_spec_iterator clang::ClassTemplateDecl::partial_spec_end ( ) [inline]

Definition at line 1993 of file DeclTemplate.h.

References getPartialSpecializations(), and clang::RedeclarableTemplateDecl::makeSpecIterator().

spec_iterator clang::ClassTemplateDecl::spec_begin ( ) const [inline]

Definition at line 1978 of file DeclTemplate.h.

References getSpecializations(), and clang::RedeclarableTemplateDecl::makeSpecIterator().

spec_iterator clang::ClassTemplateDecl::spec_end ( ) const [inline]

Definition at line 1982 of file DeclTemplate.h.

References getSpecializations(), and clang::RedeclarableTemplateDecl::makeSpecIterator().

Friends And Related Function Documentation

friend class ASTDeclReader [friend]

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 2001 of file DeclTemplate.h.

friend class ASTDeclWriter [friend]

Reimplemented from clang::RedeclarableTemplateDecl.

Definition at line 2002 of file DeclTemplate.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation