clang  3.9.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
clang::RedeclarableTemplateDecl Class Referenceabstract

Declaration of a redeclarable template. More...

#include <DeclTemplate.h>

Inheritance diagram for clang::RedeclarableTemplateDecl:
[legend]
Collaboration diagram for clang::RedeclarableTemplateDecl:
[legend]

Classes

struct  CommonBase
 
struct  SpecEntryTraits
 
struct  SpecEntryTraits< FunctionTemplateSpecializationInfo >
 
struct  SpecIterator
 

Public Types

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

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 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

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...
 
virtual CommonBasenewCommon (ASTContext &C) const =0
 
 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
 

Static Protected Member Functions

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

CommonBaseCommon
 Pointer to the common data shared by all declarations of this template. More...
 
- Protected Attributes inherited from clang::TemplateDecl
llvm::PointerIntPair
< NamedDecl *, 1, bool
TemplatedDecl
 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
 

Friends

template<class decl_type >
class RedeclarableTemplate
 
class ASTReader
 
class ASTDeclReader
 
class ASTDeclWriter
 

Detailed Description

Declaration of a redeclarable template.

Definition at line 629 of file DeclTemplate.h.

Member Typedef Documentation

typedef redeclarable_base::redecl_iterator clang::RedeclarableTemplateDecl::redecl_iterator

Definition at line 805 of file DeclTemplate.h.

Definition at line 804 of file DeclTemplate.h.

Constructor & Destructor Documentation

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

Definition at line 713 of file DeclTemplate.h.

Member Function Documentation

template<class Derived , class EntryType >
void RedeclarableTemplateDecl::addSpecializationImpl ( llvm::FoldingSetVector< EntryType > &  Specs,
EntryType *  Entry,
void *  InsertPos 
)
protected

Definition at line 174 of file DeclTemplate.cpp.

References findSpecializationImpl().

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

Definition at line 814 of file DeclTemplate.h.

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

Definition at line 815 of file DeclTemplate.h.

template<class EntryType >
RedeclarableTemplateDecl::SpecEntryTraits< EntryType >::DeclType * RedeclarableTemplateDecl::findSpecializationImpl ( llvm::FoldingSetVector< EntryType > &  Specs,
ArrayRef< TemplateArgument Args,
void *&  InsertPos 
)
protected
RedeclarableTemplateDecl* clang::RedeclarableTemplateDecl::getCanonicalDecl ( )
inlineoverride
const RedeclarableTemplateDecl* clang::RedeclarableTemplateDecl::getCanonicalDecl ( ) const
inline

Definition at line 726 of file DeclTemplate.h.

RedeclarableTemplateDecl::CommonBase * RedeclarableTemplateDecl::getCommonPtr ( ) const
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.

Definition at line 129 of file DeclTemplate.cpp.

References Common, clang::Redeclarable< RedeclarableTemplateDecl >::getPreviousDecl(), clang::Redeclarable< decl_type >::getPreviousDecl(), and newCommon().

Referenced by clang::FunctionTemplateDecl::getCommonPtr(), clang::ClassTemplateDecl::getCommonPtr(), clang::TypeAliasTemplateDecl::getCommonPtr(), and clang::VarTemplateDecl::getCommonPtr().

RedeclarableTemplateDecl* clang::RedeclarableTemplateDecl::getInstantiatedFromMemberTemplate ( ) const
inline

Retrieve the member template from which this template was instantiated, or NULL if this template was not instantiated from a member template.

A template is instantiated from a member template when the member template itself is part of a class template (or member thereof). For example, given

template<typename T>
struct X {
template<typename U> void f(T, U);
};
void test(X<int> x) {
x.f(1, 'a');
};

X<int>::f is a FunctionTemplateDecl that describes the function template

template<typename U> void X<int>::f(int, U);

which was itself created during the instantiation of X<int>. Calling getInstantiatedFromMemberTemplate() on this FunctionTemplateDecl will retrieve the FunctionTemplateDecl for the original template f within the class template X<T>, i.e.,

template<typename T>
template<typename U>
void X<T>::f(T, U);

Definition at line 795 of file DeclTemplate.h.

Referenced by clang::FunctionTemplateDecl::getInstantiatedFromMemberTemplate(), clang::ClassTemplateDecl::getInstantiatedFromMemberTemplate(), clang::TypeAliasTemplateDecl::getInstantiatedFromMemberTemplate(), clang::VarTemplateDecl::getInstantiatedFromMemberTemplate(), and clang::ASTDeclWriter::VisitRedeclarableTemplateDecl().

bool clang::RedeclarableTemplateDecl::isMemberSpecialization ( ) const
inline

Determines whether this template was a specialization of a member template.

In the following example, the function template X<int>::f and the member template X<int>::Inner are member specializations.

template<typename T>
struct X {
template<typename U> void f(T, U);
template<typename U> struct Inner;
};
template<> template<typename T>
void X<int>::f(int, T);
template<> template<typename T>
struct X<int>::Inner { /* ... */ };

Definition at line 748 of file DeclTemplate.h.

Referenced by clang::Sema::getTemplateInstantiationArgs(), clang::Sema::InstantiateClassTemplateSpecialization(), clang::Sema::InstantiateVariableDefinition(), isExplicitMemberSpecialization(), and clang::ASTDeclWriter::VisitRedeclarableTemplateDecl().

template<typename EntryType >
static SpecIterator<EntryType> clang::RedeclarableTemplateDecl::makeSpecIterator ( llvm::FoldingSetVector< EntryType > &  Specs,
bool  isEnd 
)
inlinestaticprotected
virtual CommonBase* clang::RedeclarableTemplateDecl::newCommon ( ASTContext C) const
protectedpure virtual
void clang::RedeclarableTemplateDecl::setInstantiatedFromMemberTemplate ( RedeclarableTemplateDecl TD)
inline
void clang::RedeclarableTemplateDecl::setMemberSpecialization ( )
inline

Friends And Related Function Documentation

friend class ASTDeclReader
friend

Definition at line 820 of file DeclTemplate.h.

friend class ASTDeclWriter
friend

Definition at line 821 of file DeclTemplate.h.

friend class ASTReader
friend

Definition at line 819 of file DeclTemplate.h.

template<class decl_type >
friend class RedeclarableTemplate
friend

Definition at line 720 of file DeclTemplate.h.

Member Data Documentation

CommonBase* clang::RedeclarableTemplateDecl::Common
mutableprotected

Pointer to the common data shared by all declarations of this template.

Definition at line 703 of file DeclTemplate.h.

Referenced by getCommonPtr(), and clang::ASTDeclReader::VisitRedeclarableTemplateDecl().


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