clang  3.9.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
clang::ClassTemplateDecl Class Reference

Declaration of a class template. More...

#include <DeclTemplate.h>

Inheritance diagram for clang::ClassTemplateDecl:
Inheritance graph
[legend]
Collaboration diagram for clang::ClassTemplateDecl:
Collaboration graph
[legend]

Classes

struct  Common
 Data that is common to all of the declarations of a given class template. More...
 

Public Types

typedef SpecIterator< ClassTemplateSpecializationDeclspec_iterator
 
typedef llvm::iterator_range< spec_iteratorspec_range
 
- Public Types inherited from clang::RedeclarableTemplateDecl
typedef redeclarable_base::redecl_range redecl_range
 
typedef redeclarable_base::redecl_iterator redecl_iterator
 
- Public Types inherited from clang::NamedDecl
enum  ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }
 Kinds of explicit visibility. More...
 
- Public Types inherited from clang::Redeclarable< RedeclarableTemplateDecl >
typedef llvm::iterator_range< redecl_iterator > redecl_range
 

Public Member Functions

void LoadLazySpecializations () const
 Load any lazily-loaded specializations from the external source. More...
 
CXXRecordDeclgetTemplatedDecl () const
 Get the underlying class declarations of the template. More...
 
bool isThisDeclarationADefinition () const
 Returns whether this template declaration defines the primary class pattern. More...
 
ClassTemplateSpecializationDeclfindSpecialization (ArrayRef< TemplateArgument > Args, void *&InsertPos)
 Return the specialization with the provided arguments if it exists, otherwise return the insertion point. More...
 
void AddSpecialization (ClassTemplateSpecializationDecl *D, void *InsertPos)
 Insert the specified specialization knowing that it is not already in. More...
 
ClassTemplateDeclgetCanonicalDecl () override
 
const ClassTemplateDeclgetCanonicalDecl () const
 
ClassTemplateDeclgetPreviousDecl ()
 Retrieve the previous declaration of this class template, or NULL if no such declaration exists. More...
 
const ClassTemplateDeclgetPreviousDecl () const
 Retrieve the previous declaration of this class template, or NULL if no such declaration exists. More...
 
ClassTemplateDeclgetMostRecentDecl ()
 
const ClassTemplateDeclgetMostRecentDecl () const
 
ClassTemplateDeclgetInstantiatedFromMemberTemplate () const
 
ClassTemplatePartialSpecializationDeclfindPartialSpecialization (ArrayRef< TemplateArgument > Args, void *&InsertPos)
 Return the partial specialization with the provided arguments if it exists, otherwise return the insertion point. More...
 
void AddPartialSpecialization (ClassTemplatePartialSpecializationDecl *D, void *InsertPos)
 Insert the specified partial specialization knowing that it is not already in. More...
 
void getPartialSpecializations (SmallVectorImpl< ClassTemplatePartialSpecializationDecl * > &PS)
 Retrieve the partial specializations as an ordered list. More...
 
ClassTemplatePartialSpecializationDeclfindPartialSpecialization (QualType T)
 Find a class template partial specialization with the given type T. More...
 
ClassTemplatePartialSpecializationDeclfindPartialSpecInstantiatedFromMember (ClassTemplatePartialSpecializationDecl *D)
 Find a class template partial specialization which was instantiated from the given member partial specialization. More...
 
QualType getInjectedClassNameSpecialization ()
 Retrieve the template specialization type of the injected-class-name for this class template. More...
 
spec_range specializations () const
 
spec_iterator spec_begin () const
 
spec_iterator spec_end () const
 
- Public Member Functions inherited from clang::RedeclarableTemplateDecl
RedeclarableTemplateDeclgetCanonicalDecl () override
 Retrieves the canonical declaration of this template. More...
 
const RedeclarableTemplateDeclgetCanonicalDecl () const
 
bool isMemberSpecialization () const
 Determines whether this template was a specialization of a member template. More...
 
void setMemberSpecialization ()
 Note that this member template is a specialization. More...
 
RedeclarableTemplateDeclgetInstantiatedFromMemberTemplate () const
 Retrieve the member template from which this template was instantiated, or NULL if this template was not instantiated from a member template. More...
 
void setInstantiatedFromMemberTemplate (RedeclarableTemplateDecl *TD)
 
- Public Member Functions inherited from clang::TemplateDecl
TemplateParameterListgetTemplateParameters () const
 Get the list of template parameters. More...
 
NamedDeclgetTemplatedDecl () const
 Get the underlying, templated declaration. More...
 
SourceRange getSourceRange () const override LLVM_READONLY
 
bool isConcept () const
 Whether this is a (C++ Concepts TS) function or variable concept. More...
 
void setConcept ()
 
void init (NamedDecl *templatedDecl, TemplateParameterList *templateParams)
 Initialize the underlying templated declaration and template parameters. More...
 
- Public Member Functions inherited from clang::NamedDecl
IdentifierInfogetIdentifier () const
 getIdentifier - Get the identifier that names this declaration, if there is one. More...
 
StringRef getName () const
 getName - Get the name of identifier for this declaration as a StringRef. More...
 
std::string getNameAsString () const
 getNameAsString - Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ constructor, Objective-C selector, etc). More...
 
void printName (raw_ostream &os) const
 
DeclarationName getDeclName () const
 getDeclName - Get the actual, stored name of the declaration, which may be a special name. More...
 
void setDeclName (DeclarationName N)
 Set the name of this declaration. More...
 
void printQualifiedName (raw_ostream &OS) const
 printQualifiedName - Returns human-readable qualified name for declaration, like A::B::i, for i being member of namespace A::B. More...
 
void printQualifiedName (raw_ostream &OS, const PrintingPolicy &Policy) const
 
std::string getQualifiedNameAsString () const
 
virtual void getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
 getNameForDiagnostic - Appends a human-readable name for this declaration into the given stream. More...
 
bool declarationReplaces (NamedDecl *OldD, bool IsKnownNewer=true) const
 Determine whether this declaration, if known to be well-formed within its context, will replace the declaration OldD if introduced into scope. More...
 
bool hasLinkage () const
 Determine whether this declaration has linkage. More...
 
bool isHidden () const
 Determine whether this declaration is hidden from name lookup. More...
 
void setHidden (bool Hide)
 Set whether this declaration is hidden from name lookup. More...
 
bool isCXXClassMember () const
 Determine whether this declaration is a C++ class member. More...
 
bool isCXXInstanceMember () const
 Determine whether the given declaration is an instance member of a C++ class. More...
 
Linkage getLinkageInternal () const
 Determine what kind of linkage this entity has. More...
 
Linkage getFormalLinkage () const
 Get the linkage from a semantic point of view. More...
 
bool hasExternalFormalLinkage () const
 True if this decl has external linkage. More...
 
bool isExternallyVisible () const
 
Visibility getVisibility () const
 Determines the visibility of this entity. More...
 
LinkageInfo getLinkageAndVisibility () const
 Determines the linkage and visibility of this entity. More...
 
Optional< VisibilitygetExplicitVisibility (ExplicitVisibilityKind kind) const
 If visibility was explicitly specified for this declaration, return that visibility. More...
 
bool isLinkageValid () const
 True if the computed linkage is valid. More...
 
bool hasLinkageBeenComputed () const
 True if something has required us to compute the linkage of this declaration. More...
 
NamedDeclgetUnderlyingDecl ()
 Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl. More...
 
const NamedDeclgetUnderlyingDecl () const
 
NamedDeclgetMostRecentDecl ()
 
const NamedDeclgetMostRecentDecl () const
 
ObjCStringFormatFamily getObjCFStringFormattingFamily () const
 
- Public Member Functions inherited from clang::Redeclarable< RedeclarableTemplateDecl >
 Redeclarable (const ASTContext &Ctx)
 
RedeclarableTemplateDeclgetPreviousDecl ()
 Return the previous declaration of this declaration or NULL if this is the first declaration. More...
 
const RedeclarableTemplateDeclgetPreviousDecl () const
 
RedeclarableTemplateDeclgetFirstDecl ()
 Return the first declaration of this declaration or itself if this is the only declaration. More...
 
const RedeclarableTemplateDeclgetFirstDecl () const
 Return the first declaration of this declaration or itself if this is the only declaration. More...
 
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain. More...
 
RedeclarableTemplateDeclgetMostRecentDecl ()
 Returns the most recent (re)declaration of this declaration. More...
 
const RedeclarableTemplateDeclgetMostRecentDecl () const
 Returns the most recent (re)declaration of this declaration. More...
 
void setPreviousDecl (RedeclarableTemplateDecl *PrevDecl)
 Set the previous declaration. More...
 
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl. More...
 
redecl_iterator redecls_begin () const
 
redecl_iterator redecls_end () const
 

Static Public Member Functions

static ClassTemplateDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation L, DeclarationName Name, TemplateParameterList *Params, NamedDecl *Decl, ClassTemplateDecl *PrevDecl)
 Create a class template node. More...
 
static ClassTemplateDeclCreateDeserialized (ASTContext &C, unsigned ID)
 Create an empty class template node. More...
 
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::RedeclarableTemplateDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::TemplateDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::NamedDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 

Protected Member Functions

llvm::FoldingSetVector< ClassTemplateSpecializationDecl > & getSpecializations () const
 Retrieve the set of specializations of this class template. More...
 
llvm::FoldingSetVector< ClassTemplatePartialSpecializationDecl > & getPartialSpecializations ()
 Retrieve the set of partial specializations of this class template. More...
 
 ClassTemplateDecl (ASTContext &C, DeclContext *DC, SourceLocation L, DeclarationName Name, TemplateParameterList *Params, NamedDecl *Decl)
 
CommonBasenewCommon (ASTContext &C) const override
 
CommongetCommonPtr () const
 
- Protected Member Functions inherited from clang::RedeclarableTemplateDecl
template<class EntryType >
SpecEntryTraits< EntryType >::DeclType * findSpecializationImpl (llvm::FoldingSetVector< EntryType > &Specs, ArrayRef< TemplateArgument > Args, void *&InsertPos)
 
template<class Derived , class EntryType >
void addSpecializationImpl (llvm::FoldingSetVector< EntryType > &Specs, EntryType *Entry, void *InsertPos)
 
CommonBasegetCommonPtr () const
 Retrieves the "common" pointer shared by all (re-)declarations of the same template. More...
 
 RedeclarableTemplateDecl (Kind DK, ASTContext &C, DeclContext *DC, SourceLocation L, DeclarationName Name, TemplateParameterList *Params, NamedDecl *Decl)
 
- Protected Member Functions inherited from clang::TemplateDecl
 TemplateDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName Name)
 
 TemplateDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName Name, TemplateParameterList *Params)
 
 TemplateDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName Name, TemplateParameterList *Params, NamedDecl *Decl)
 
- Protected Member Functions inherited from clang::NamedDecl
 NamedDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
 
- Protected Member Functions inherited from clang::Redeclarable< RedeclarableTemplateDecl >
RedeclarableTemplateDeclgetNextRedeclaration () const
 

Friends

class ASTDeclReader
 
class ASTDeclWriter
 

Additional Inherited Members

- Static Protected Member Functions inherited from clang::RedeclarableTemplateDecl
template<typename EntryType >
static SpecIterator< EntryType > makeSpecIterator (llvm::FoldingSetVector< EntryType > &Specs, bool isEnd)
 
- Static Protected Member Functions inherited from clang::Redeclarable< RedeclarableTemplateDecl >
static DeclLink PreviousDeclLink (RedeclarableTemplateDecl *D)
 
static DeclLink LatestDeclLink (const ASTContext &Ctx)
 
- Protected Attributes inherited from clang::RedeclarableTemplateDecl
CommonBaseCommon
 Pointer to the common data shared by all declarations of this template. More...
 
- Protected Attributes inherited from clang::TemplateDecl
llvm::PointerIntPair< NamedDecl *, 1, boolTemplatedDecl
 The named declaration from which this template was instantiated. More...
 
TemplateParameterListTemplateParams
 
- Protected Attributes inherited from clang::Redeclarable< RedeclarableTemplateDecl >
DeclLink RedeclLink
 Points to the next redeclaration in the chain. More...
 
RedeclarableTemplateDeclFirst
 

Detailed Description

Declaration of a class template.

Definition at line 1944 of file DeclTemplate.h.

Member Typedef Documentation

Definition at line 2117 of file DeclTemplate.h.

typedef llvm::iterator_range<spec_iterator> clang::ClassTemplateDecl::spec_range

Definition at line 2118 of file DeclTemplate.h.

Constructor & Destructor Documentation

clang::ClassTemplateDecl::ClassTemplateDecl ( ASTContext C,
DeclContext DC,
SourceLocation  L,
DeclarationName  Name,
TemplateParameterList Params,
NamedDecl Decl 
)
inlineprotected

Definition at line 1982 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 402 of file DeclTemplate.cpp.

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 391 of file DeclTemplate.cpp.

Referenced by collectUnexpandedParameterPacks().

static bool clang::ClassTemplateDecl::classof ( const Decl D)
inlinestatic

Definition at line 2133 of file DeclTemplate.h.

static bool clang::ClassTemplateDecl::classofKind ( Kind  K)
inlinestatic

Definition at line 2134 of file DeclTemplate.h.

ClassTemplateDecl * ClassTemplateDecl::Create ( ASTContext C,
DeclContext DC,
SourceLocation  L,
DeclarationName  Name,
TemplateParameterList Params,
NamedDecl Decl,
ClassTemplateDecl PrevDecl 
)
static
ClassTemplateDecl * ClassTemplateDecl::CreateDeserialized ( ASTContext C,
unsigned  ID 
)
static

Create an empty class template node.

Definition at line 345 of file DeclTemplate.cpp.

Referenced by clang::ASTDeclReader::markIncompleteDeclChainImpl().

ClassTemplatePartialSpecializationDecl * ClassTemplateDecl::findPartialSpecialization ( ArrayRef< TemplateArgument Args,
void *&  InsertPos 
)

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

Definition at line 397 of file DeclTemplate.cpp.

Referenced by clang::Sema::ActOnClassTemplateSpecialization(), and clang::TemplateDeclInstantiator::InstantiateClassTemplatePartialSpecialization().

ClassTemplatePartialSpecializationDecl * ClassTemplateDecl::findPartialSpecialization ( QualType  T)

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

Parameters
Ta 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 431 of file DeclTemplate.cpp.

References clang::TemplateParameterList::begin(), clang::TemplateParameterList::end(), 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
Da 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 447 of file DeclTemplate.cpp.

References clang::TemplateParameterList::begin(), clang::TemplateParameterList::end(), clang::CXXRecordDecl::getCanonicalDecl(), and P.

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

ClassTemplateSpecializationDecl * ClassTemplateDecl::findSpecialization ( ArrayRef< TemplateArgument Args,
void *&  InsertPos 
)

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

Definition at line 386 of file DeclTemplate.cpp.

Referenced by clang::Sema::ActOnClassTemplateSpecialization(), clang::Sema::ActOnExplicitInstantiation(), collectUnexpandedParameterPacks(), and clang::ASTNodeImporter::VisitClassTemplateSpecializationDecl().

ClassTemplateDecl* clang::ClassTemplateDecl::getCanonicalDecl ( )
inlineoverride
const ClassTemplateDecl* clang::ClassTemplateDecl::getCanonicalDecl ( ) const
inline
Common* clang::ClassTemplateDecl::getCommonPtr ( ) const
inlineprotected
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 462 of file DeclTemplate.cpp.

References GenerateInjectedTemplateArgs(), clang::ASTContext::getTemplateSpecializationType(), clang::ClassTemplateDecl::Common::InjectedClassNameType, clang::QualType::isNull(), and clang::TemplateParameterList::size().

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

ClassTemplateDecl* clang::ClassTemplateDecl::getInstantiatedFromMemberTemplate ( ) const
inline
ClassTemplateDecl* clang::ClassTemplateDecl::getMostRecentDecl ( )
inline

Definition at line 2052 of file DeclTemplate.h.

const ClassTemplateDecl* clang::ClassTemplateDecl::getMostRecentDecl ( ) const
inline

Definition at line 2056 of file DeclTemplate.h.

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

Retrieve the set of partial specializations of this class template.

Definition at line 373 of file DeclTemplate.cpp.

Referenced by clang::Sema::InstantiateClassTemplateSpecialization(), and clang::TemplateDeclInstantiator::InstantiateEnumDefinition().

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

Retrieve the partial specializations as an ordered list.

Definition at line 418 of file DeclTemplate.cpp.

References P.

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

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

Definition at line 2039 of file DeclTemplate.h.

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

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

Definition at line 2046 of file DeclTemplate.h.

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

Retrieve the set of specializations of this class template.

Definition at line 367 of file DeclTemplate.cpp.

CXXRecordDecl* clang::ClassTemplateDecl::getTemplatedDecl ( ) const
inline
bool clang::ClassTemplateDecl::isThisDeclarationADefinition ( ) const
inline

Returns whether this template declaration defines the primary class pattern.

Definition at line 2004 of file DeclTemplate.h.

References clang::TemplateParameterList::Create().

void ClassTemplateDecl::LoadLazySpecializations ( ) const

Load any lazily-loaded specializations from the external source.

Definition at line 351 of file DeclTemplate.cpp.

References clang::ExternalASTSource::GetExternalDecl(), clang::ASTContext::getExternalSource(), and clang::ClassTemplateDecl::Common::LazySpecializations.

RedeclarableTemplateDecl::CommonBase * ClassTemplateDecl::newCommon ( ASTContext C) const
overrideprotectedvirtual
spec_iterator clang::ClassTemplateDecl::spec_begin ( ) const
inline

Definition at line 2124 of file DeclTemplate.h.

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

Definition at line 2128 of file DeclTemplate.h.

spec_range clang::ClassTemplateDecl::specializations ( ) const
inline

Friends And Related Function Documentation

friend class ASTDeclReader
friend

Definition at line 2136 of file DeclTemplate.h.

friend class ASTDeclWriter
friend

Definition at line 2137 of file DeclTemplate.h.


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