clang  3.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::TemplateDecl Class Reference

The base class of all kinds of template declarations (e.g., class, function, etc.). More...

#include <DeclTemplate.h>

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

Public Member Functions

TemplateParameterListgetTemplateParameters () const
 Get the list of template parameters. More...
 
NamedDeclgetTemplatedDecl () const
 Get the underlying, templated declaration. More...
 
SourceRange getSourceRange () const override LLVM_READONLY
 Source range that this declaration covers. More...
 
void init (NamedDecl *templatedDecl, TemplateParameterList *templateParams)
 Initialize the underlying templated declaration and template parameters. More...
 
- Public Member Functions inherited from clang::NamedDecl
IdentifierInfogetIdentifier () const
 
StringRef getName () const
 
std::string getNameAsString () const
 
void printName (raw_ostream &os) const
 
DeclarationName getDeclName () const
 
void setDeclName (DeclarationName N)
 Set the name of this declaration. More...
 
void printQualifiedName (raw_ostream &OS) const
 
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
 
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. A declaration will replace another declaration if, for example, it is a redeclaration of the same variable or function, but not if it is a declaration of a different kind (function vs. class) or an overloaded function. 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. This is not the linkage as defined by the standard or the codegen notion of linkage. It is just an implementation detail that is used to compute those. More...
 
Linkage getFormalLinkage () const
 Get the linkage from a semantic point of view. Entities in anonymous namespaces are external (in c++98). 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. Used for consistency checking. Should always return true. 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::Decl
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
SourceLocation getLocation () const
 
void setLocation (SourceLocation L)
 
Kind getKind () const
 
const char * getDeclKindName () const
 
DeclgetNextDeclInContext ()
 
const DeclgetNextDeclInContext () const
 
DeclContextgetDeclContext ()
 
const DeclContextgetDeclContext () const
 
DeclgetNonClosureContext ()
 
const DeclgetNonClosureContext () const
 
TranslationUnitDeclgetTranslationUnitDecl ()
 
const TranslationUnitDeclgetTranslationUnitDecl () const
 
bool isInAnonymousNamespace () const
 
bool isInStdNamespace () const
 
ASTContextgetASTContext () const LLVM_READONLY
 
void setAccess (AccessSpecifier AS)
 
AccessSpecifier getAccess () const
 
AccessSpecifier getAccessUnsafe () const
 Retrieve the access specifier for this declaration, even though it may not yet have been properly set. More...
 
bool hasAttrs () const
 
void setAttrs (const AttrVec &Attrs)
 
AttrVecgetAttrs ()
 
const AttrVecgetAttrs () const
 
void dropAttrs ()
 
void addAttr (Attr *A)
 
attr_range attrs () const
 
attr_iterator attr_begin () const
 
attr_iterator attr_end () const
 
template<typename T >
void dropAttr ()
 
template<typename T >
llvm::iterator_range
< specific_attr_iterator< T > > 
specific_attrs () const
 
template<typename T >
specific_attr_iterator< T > specific_attr_begin () const
 
template<typename T >
specific_attr_iterator< T > specific_attr_end () const
 
template<typename T >
T * getAttr () const
 
template<typename T >
bool hasAttr () const
 
unsigned getMaxAlignment () const
 
void setInvalidDecl (bool Invalid=true)
 
bool isInvalidDecl () const
 
bool isImplicit () const
 
void setImplicit (bool I=true)
 
bool isUsed (bool CheckUsedAttr=true) const
 Whether this declaration was used, meaning that a definition is required. More...
 
void setIsUsed ()
 Set whether the declaration is used, in the sense of odr-use. More...
 
void markUsed (ASTContext &C)
 Mark the declaration used, in the sense of odr-use. More...
 
bool isReferenced () const
 Whether any declaration of this entity was referenced. More...
 
bool isThisDeclarationReferenced () const
 Whether this declaration was referenced. This should not be relied upon for anything other than debugging. More...
 
void setReferenced (bool R=true)
 
bool isTopLevelDeclInObjCContainer () const
 Whether this declaration is a top-level declaration (function, global variable, etc.) that is lexically inside an objc container definition. More...
 
void setTopLevelDeclInObjCContainer (bool V=true)
 
bool isModulePrivate () const
 Whether this declaration was marked as being private to the module in which it was defined. More...
 
AvailabilityResult getAvailability (std::string *Message=nullptr) const
 Determine the availability of the given declaration. More...
 
bool isDeprecated (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'deprecated'. More...
 
bool isUnavailable (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'unavailable'. More...
 
bool isWeakImported () const
 Determine whether this is a weak-imported symbol. More...
 
bool canBeWeakImported (bool &IsDefinition) const
 Determines whether this symbol can be weak-imported, e.g., whether it would be well-formed to add the weak_import attribute. More...
 
bool isFromASTFile () const
 Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed. More...
 
unsigned getGlobalID () const
 Retrieve the global declaration ID associated with this declaration, which specifies where in the. More...
 
unsigned getOwningModuleID () const
 Retrieve the global ID of the module that owns this particular declaration. More...
 
ModulegetImportedOwningModule () const
 Get the imported owning module, if this decl is from an imported (non-local) module. More...
 
ModulegetLocalOwningModule () const
 Get the local owning module, if known. Returns nullptr if owner is not yet known or declaration is not from a module. More...
 
void setLocalOwningModule (Module *M)
 
unsigned getIdentifierNamespace () const
 
bool isInIdentifierNamespace (unsigned NS) const
 
bool hasTagIdentifierNamespace () const
 
DeclContextgetLexicalDeclContext ()
 
const DeclContextgetLexicalDeclContext () const
 
virtual bool isOutOfLine () const
 
void setDeclContext (DeclContext *DC)
 
void setLexicalDeclContext (DeclContext *DC)
 
bool isDefinedOutsideFunctionOrMethod () const
 
const DeclContextgetParentFunctionOrMethod () const
 If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null. More...
 
DeclContextgetParentFunctionOrMethod ()
 
virtual DeclgetCanonicalDecl ()
 Retrieves the "canonical" declaration of the given declaration. More...
 
const DeclgetCanonicalDecl () const
 
bool isCanonicalDecl () const
 Whether this particular Decl is a canonical one. More...
 
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl. It will iterate at least once (when this decl is the only one). More...
 
redecl_iterator redecls_begin () const
 
redecl_iterator redecls_end () const
 
DeclgetPreviousDecl ()
 Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
 
const DeclgetPreviousDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
 
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain. More...
 
DeclgetMostRecentDecl ()
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
const DeclgetMostRecentDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
virtual StmtgetBody () const
 
virtual bool hasBody () const
 Returns true if this Decl represents a declaration for a body of code, such as a function or method definition. Note that hasBody can also return true if any redeclaration of this Decl represents a declaration for a body of code. More...
 
SourceLocation getBodyRBrace () const
 
bool isTemplateParameter () const
 
bool isTemplateParameterPack () const
 
bool isParameterPack () const
 Whether this declaration is a parameter pack. More...
 
bool isTemplateDecl () const
 returns true if this declaration is a template More...
 
bool isFunctionOrFunctionTemplate () const
 Whether this declaration is a function or function template. More...
 
FunctionDeclgetAsFunction () LLVM_READONLY
 Returns the function itself, or the templated function if this is a function template. More...
 
const FunctionDeclgetAsFunction () const
 
void setLocalExternDecl ()
 Changes the namespace of this declaration to reflect that it's a function-local extern declaration. More...
 
bool isLocalExternDecl ()
 Determine whether this is a block-scope declaration with linkage. This will either be a local variable declaration declared 'extern', or a local function declaration. More...
 
void setObjectOfFriendDecl (bool PerformFriendInjection=false)
 Changes the namespace of this declaration to reflect that it's the object of a friend declaration. More...
 
FriendObjectKind getFriendObjectKind () const
 Determines whether this declaration is the object of a friend declaration and, if so, what kind. More...
 
void setNonMemberOperator ()
 Specifies that this declaration is a C++ overloaded non-member. More...
 
void print (raw_ostream &Out, unsigned Indentation=0, bool PrintInstantiation=false) const
 
void print (raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0, bool PrintInstantiation=false) const
 
void dump () const
 
void dumpColor () const
 
void dump (raw_ostream &Out) const
 
const FunctionTypegetFunctionType (bool BlocksToo=true) const
 Looks through the Decl's underlying type to extract a FunctionType when possible. Will return null if the type underlying the Decl does not have a FunctionType. More...
 

Static Public Member Functions

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)
 
- Static Public Member Functions inherited from clang::Decl
static unsigned getIdentifierNamespaceForKind (Kind DK)
 
static bool isTagIdentifierNamespace (unsigned NS)
 
static void add (Kind k)
 
static void EnableStatistics ()
 
static void PrintStats ()
 
static bool classofKind (Kind K)
 
static DeclContextcastToDeclContext (const Decl *)
 
static DeclcastFromDeclContext (const DeclContext *)
 
static void printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)
 

Protected Member Functions

 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::Decl
void * operator new (std::size_t Size, const ASTContext &Ctx, unsigned ID, std::size_t Extra=0)
 Allocate memory for a deserialized declaration. More...
 
void * operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)
 Allocate memory for a non-deserialized declaration. More...
 
 Decl (Kind DK, DeclContext *DC, SourceLocation L)
 
 Decl (Kind DK, EmptyShell Empty)
 
virtual ~Decl ()
 
void updateOutOfDate (IdentifierInfo &II) const
 Update a potentially out-of-date declaration. More...
 
Linkage getCachedLinkage () const
 
void setCachedLinkage (Linkage L) const
 
bool hasCachedLinkage () const
 
void setModulePrivate (bool MP=true)
 Specify whether this declaration was marked as being private to the module in which it was defined. More...
 
void setOwningModuleID (unsigned ID)
 Set the owning module ID. More...
 
bool hasLocalOwningModuleStorage () const
 
virtual DeclgetNextRedeclarationImpl ()
 Returns the next redeclaration or itself if this is the only decl. More...
 
virtual DeclgetPreviousDeclImpl ()
 Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
virtual DeclgetMostRecentDeclImpl ()
 Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
ASTMutationListenergetASTMutationListener () const
 

Protected Attributes

NamedDeclTemplatedDecl
 
TemplateParameterListTemplateParams
 
- Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl
*, 2, unsigned
NextInContextAndBits
 The next declaration within the same lexical DeclContext. These pointers form the linked list that is traversed via DeclContext's decls_begin()/decls_end(). More...
 
unsigned Access: 2
 Access - Used by C++ decls for the access specifier. More...
 
unsigned FromASTFile: 1
 Whether this declaration was loaded from an AST file. More...
 
unsigned Hidden: 1
 Whether this declaration is hidden from normal name lookup, e.g., because it is was loaded from an AST file is either module-private or because its submodule has not been made visible. More...
 
unsigned IdentifierNamespace: 12
 IdentifierNamespace - This specifies what IDNS_* namespace this lives in. More...
 
unsigned CacheValidAndLinkage: 3
 If 0, we have not computed the linkage of this declaration. Otherwise, it is the linkage + 1. More...
 

Additional Inherited Members

- Public Types inherited from clang::NamedDecl
enum  ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }
 Kinds of explicit visibility. More...
 
- Public Types inherited from clang::Decl
enum  Kind
 Lists the kind of concrete classes of Decl. More...
 
enum  IdentifierNamespace {
  IDNS_Label = 0x0001, IDNS_Tag = 0x0002, IDNS_Type = 0x0004, IDNS_Member = 0x0008,
  IDNS_Namespace = 0x0010, IDNS_Ordinary = 0x0020, IDNS_ObjCProtocol = 0x0040, IDNS_OrdinaryFriend = 0x0080,
  IDNS_TagFriend = 0x0100, IDNS_Using = 0x0200, IDNS_NonMemberOperator = 0x0400, IDNS_LocalExtern = 0x0800
}
 
enum  ObjCDeclQualifier {
  OBJC_TQ_None = 0x0, OBJC_TQ_In = 0x1, OBJC_TQ_Inout = 0x2, OBJC_TQ_Out = 0x4,
  OBJC_TQ_Bycopy = 0x8, OBJC_TQ_Byref = 0x10, OBJC_TQ_Oneway = 0x20, OBJC_TQ_CSNullability = 0x40
}
 
enum  FriendObjectKind { FOK_None, FOK_Declared, FOK_Undeclared }
 
typedef AttrVec::const_iterator attr_iterator
 
typedef llvm::iterator_range
< attr_iterator
attr_range
 
typedef llvm::iterator_range
< redecl_iterator
redecl_range
 
- Protected Types inherited from clang::Decl
enum  { TopLevelDeclInObjCContainerFlag = 0x01, ModulePrivateFlag = 0x02 }
 

Detailed Description

The base class of all kinds of template declarations (e.g., class, function, etc.).

The TemplateDecl class stores the list of template parameters and a reference to the templated scoped declaration: the underlying AST node.

Definition at line 311 of file DeclTemplate.h.

Constructor & Destructor Documentation

clang::TemplateDecl::TemplateDecl ( Kind  DK,
DeclContext DC,
SourceLocation  L,
DeclarationName  Name 
)
inlineprotected

Definition at line 315 of file DeclTemplate.h.

clang::TemplateDecl::TemplateDecl ( Kind  DK,
DeclContext DC,
SourceLocation  L,
DeclarationName  Name,
TemplateParameterList Params 
)
inlineprotected

Definition at line 322 of file DeclTemplate.h.

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

Definition at line 328 of file DeclTemplate.h.

Member Function Documentation

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

Definition at line 343 of file DeclTemplate.h.

References clang::Decl::getKind().

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

Definition at line 344 of file DeclTemplate.h.

SourceRange clang::TemplateDecl::getSourceRange ( ) const
inlineoverridevirtual

Source range that this declaration covers.

Reimplemented from clang::Decl.

Reimplemented in clang::TemplateTemplateParmDecl.

Definition at line 348 of file DeclTemplate.h.

Referenced by clang::Sema::FinishTemplateArgumentDeduction(), and clang::ClassTemplateSpecializationDecl::getSourceRange().

NamedDecl* clang::TemplateDecl::getTemplatedDecl ( ) const
inline
TemplateParameterList* clang::TemplateDecl::getTemplateParameters ( ) const
inline

Get the list of template parameters.

Definition at line 335 of file DeclTemplate.h.

Referenced by clang::Sema::ActOnAliasDeclaration(), clang::Sema::ActOnClassTemplateSpecialization(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnVariableDeclarator(), clang::Sema::ActOnVarTemplateSpecialization(), addFunctionPointerConversion(), AddTemplateParameterChunks(), clang::Sema::CheckClassTemplate(), clang::Sema::CheckLiteralOperatorDeclaration(), clang::Sema::CheckTemplateArgument(), clang::Sema::CheckTemplateArgumentList(), clang::PredefinedExpr::ComputeName(), clang::Sema::DeduceTemplateArguments(), diagnoseArityMismatch(), DiagnoseUnexpandedParameterPacks(), clang::comments::DeclInfo::fill(), FinishTemplateArgumentDeduction(), clang::Sema::FinishTemplateArgumentDeduction(), clang::ClassTemplateDecl::getInjectedClassNameSpecialization(), clang::FunctionTemplateDecl::getInjectedTemplateArgs(), getLVForTemplateParameterList(), hasDeducibleTemplateParameters(), inheritDefaultTemplateArguments(), isAtLeastAsSpecializedAs(), clang::Sema::IsOverload(), isSameEntity(), isSameTemplateParameter(), clang::Sema::isStdInitializerList(), IsStructurallyEquivalent(), LookupStdInitializerList(), clang::Sema::MarkDeducedTemplateParameters(), MatchTemplateParameterKind(), mergeTemplateLV(), clang::Sema::MergeVarDecl(), clang::Sema::PrintInstantiationStack(), clang::Sema::SubstituteExplicitTemplateArguments(), clang::ASTNodeImporter::VisitClassTemplateDecl(), clang::ASTDeclWriter::VisitTemplateDecl(), clang::ASTNodeImporter::VisitTemplateTemplateParmDecl(), and clang::ASTNodeImporter::VisitVarTemplateDecl().

void clang::TemplateDecl::init ( NamedDecl templatedDecl,
TemplateParameterList templateParams 
)
inline

Initialize the underlying templated declaration and template parameters.

Definition at line 360 of file DeclTemplate.h.

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

Member Data Documentation

NamedDecl* clang::TemplateDecl::TemplatedDecl
protected

Definition at line 354 of file DeclTemplate.h.

Referenced by clang::VarTemplateDecl::getTemplatedDecl().

TemplateParameterList* clang::TemplateDecl::TemplateParams
protected

Definition at line 355 of file DeclTemplate.h.


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