clang  3.9.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::NonTypeTemplateParmDecl Class Referencefinal

NonTypeTemplateParmDecl - Declares a non-type template parameter, e.g., "Size" in. More...

#include <DeclTemplate.h>

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

Public Member Functions

SourceRange getSourceRange () const override LLVM_READONLY
 
const DefArgStoragegetDefaultArgStorage () const
 
bool hasDefaultArgument () const
 Determine whether this template parameter has a default argument. More...
 
ExprgetDefaultArgument () const
 Retrieve the default argument, if any. More...
 
SourceLocation getDefaultArgumentLoc () const
 Retrieve the location of the default argument, if any. More...
 
bool defaultArgumentWasInherited () const
 Determines whether the default argument was inherited from a previous declaration of this template. More...
 
void setDefaultArgument (Expr *DefArg)
 Set the default argument for this template parameter, and whether that default argument was inherited from another declaration. More...
 
void setInheritedDefaultArgument (const ASTContext &C, NonTypeTemplateParmDecl *Parm)
 
void removeDefaultArgument ()
 Removes the default argument of this template parameter. More...
 
bool isParameterPack () const
 Whether this parameter is a non-type template parameter pack. More...
 
bool isPackExpansion () const
 Whether this parameter pack is a pack expansion. More...
 
bool isExpandedParameterPack () const
 Whether this parameter is a non-type template parameter pack that has a known list of different types at different positions. More...
 
unsigned getNumExpansionTypes () const
 Retrieves the number of expansion types in an expanded parameter pack. More...
 
QualType getExpansionType (unsigned I) const
 Retrieve a particular expansion type within an expanded parameter pack. More...
 
TypeSourceInfogetExpansionTypeSourceInfo (unsigned I) const
 Retrieve a particular expansion type source info within an expanded parameter pack. More...
 
- Public Member Functions inherited from clang::DeclaratorDecl
TypeSourceInfogetTypeSourceInfo () const
 
void setTypeSourceInfo (TypeSourceInfo *TI)
 
SourceLocation getInnerLocStart () const
 getInnerLocStart - Return SourceLocation representing start of source range ignoring outer template declarations. More...
 
void setInnerLocStart (SourceLocation L)
 
SourceLocation getOuterLocStart () const
 getOuterLocStart - Return SourceLocation representing start of source range taking into account any outer template declarations. More...
 
SourceRange getSourceRange () const override LLVM_READONLY
 
SourceLocation getLocStart () const LLVM_READONLY
 
NestedNameSpecifiergetQualifier () const
 Retrieve the nested-name-specifier that qualifies the name of this declaration, if it was present in the source. More...
 
NestedNameSpecifierLoc getQualifierLoc () const
 Retrieve the nested-name-specifier (with source-location information) that qualifies the name of this declaration, if it was present in the source. More...
 
void setQualifierInfo (NestedNameSpecifierLoc QualifierLoc)
 
unsigned getNumTemplateParameterLists () const
 
TemplateParameterListgetTemplateParameterList (unsigned index) const
 
void setTemplateParameterListsInfo (ASTContext &Context, ArrayRef< TemplateParameterList * > TPLists)
 
SourceLocation getTypeSpecStartLoc () const
 
- Public Member Functions inherited from clang::ValueDecl
QualType getType () const
 
void setType (QualType newType)
 
bool isWeak () const
 Determine whether this symbol is weakly-imported, or declared with the weak or weak-ref attr. 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
 

Static Public Member Functions

static NonTypeTemplateParmDeclCreate (const ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc, unsigned D, unsigned P, IdentifierInfo *Id, QualType T, bool ParameterPack, TypeSourceInfo *TInfo)
 
static NonTypeTemplateParmDeclCreate (const ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc, unsigned D, unsigned P, IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo, ArrayRef< QualType > ExpandedTypes, ArrayRef< TypeSourceInfo * > ExpandedTInfos)
 
static NonTypeTemplateParmDeclCreateDeserialized (ASTContext &C, unsigned ID)
 
static NonTypeTemplateParmDeclCreateDeserialized (ASTContext &C, unsigned ID, unsigned NumExpandedTypes)
 
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::DeclaratorDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::ValueDecl
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)
 

Friends

class ASTDeclReader
 

Additional Inherited Members

- Public Types inherited from clang::NamedDecl
enum  ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }
 Kinds of explicit visibility. More...
 
- Protected Member Functions inherited from clang::DeclaratorDecl
 DeclaratorDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T, TypeSourceInfo *TInfo, SourceLocation StartL)
 
- Protected Member Functions inherited from clang::ValueDecl
 ValueDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T)
 
- Protected Member Functions inherited from clang::NamedDecl
 NamedDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
 
- Protected Member Functions inherited from clang::TemplateParmPosition
 TemplateParmPosition (unsigned D, unsigned P)
 
unsigned getDepth () const
 Get the nesting depth of the template parameter. More...
 
void setDepth (unsigned D)
 
unsigned getPosition () const
 Get the position of the template parameter within its parameter list. More...
 
void setPosition (unsigned P)
 
unsigned getIndex () const
 Get the index of the template parameter within its parameter list. More...
 
- Protected Attributes inherited from clang::TemplateParmPosition
unsigned Depth
 
unsigned Position
 

Detailed Description

NonTypeTemplateParmDecl - Declares a non-type template parameter, e.g., "Size" in.

template<int Size> class array { };

Definition at line 1140 of file DeclTemplate.h.

Member Function Documentation

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

Definition at line 1316 of file DeclTemplate.h.

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

Definition at line 1317 of file DeclTemplate.h.

NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::Create ( const ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
SourceLocation  IdLoc,
unsigned  D,
unsigned  P,
IdentifierInfo Id,
QualType  T,
bool  ParameterPack,
TypeSourceInfo TInfo 
)
static
NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::Create ( const ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
SourceLocation  IdLoc,
unsigned  D,
unsigned  P,
IdentifierInfo Id,
QualType  T,
TypeSourceInfo TInfo,
ArrayRef< QualType ExpandedTypes,
ArrayRef< TypeSourceInfo * >  ExpandedTInfos 
)
static

Definition at line 547 of file DeclTemplate.cpp.

NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::CreateDeserialized ( ASTContext C,
unsigned  ID 
)
static

Definition at line 560 of file DeclTemplate.cpp.

References ID.

NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::CreateDeserialized ( ASTContext C,
unsigned  ID,
unsigned  NumExpandedTypes 
)
static

Definition at line 567 of file DeclTemplate.cpp.

References ID, and clang::None.

bool clang::NonTypeTemplateParmDecl::defaultArgumentWasInherited ( ) const
inline

Determines whether the default argument was inherited from a previous declaration of this template.

Definition at line 1228 of file DeclTemplate.h.

Referenced by getSourceRange(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

const DefArgStorage& clang::NonTypeTemplateParmDecl::getDefaultArgStorage ( ) const
inline

Definition at line 1214 of file DeclTemplate.h.

Expr* clang::NonTypeTemplateParmDecl::getDefaultArgument ( ) const
inline

Retrieve the default argument, if any.

Definition at line 1221 of file DeclTemplate.h.

Referenced by getDefaultArgumentLoc(), getSourceRange(), SubstDefaultTemplateArgument(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

SourceLocation NonTypeTemplateParmDecl::getDefaultArgumentLoc ( ) const

Retrieve the location of the default argument, if any.

Definition at line 586 of file DeclTemplate.cpp.

References getDefaultArgument(), and hasDefaultArgument().

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

QualType clang::NonTypeTemplateParmDecl::getExpansionType ( unsigned  I) const
inline

Retrieve a particular expansion type within an expanded parameter pack.

Definition at line 1299 of file DeclTemplate.h.

References I.

Referenced by clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

TypeSourceInfo* clang::NonTypeTemplateParmDecl::getExpansionTypeSourceInfo ( unsigned  I) const
inline

Retrieve a particular expansion type source info within an expanded parameter pack.

Definition at line 1308 of file DeclTemplate.h.

References I.

Referenced by clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

unsigned clang::NonTypeTemplateParmDecl::getNumExpansionTypes ( ) const
inline

Retrieves the number of expansion types in an expanded parameter pack.

Definition at line 1292 of file DeclTemplate.h.

Referenced by clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclReader::VisitNonTypeTemplateParmDecl().

SourceRange NonTypeTemplateParmDecl::getSourceRange ( ) const
override
bool clang::NonTypeTemplateParmDecl::hasDefaultArgument ( ) const
inline

Determine whether this template parameter has a default argument.

Definition at line 1218 of file DeclTemplate.h.

Referenced by clang::Sema::CheckTemplateParameterList(), getDefaultArgumentLoc(), getSourceRange(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

bool clang::NonTypeTemplateParmDecl::isExpandedParameterPack ( ) const
inline

Whether this parameter is a non-type template parameter pack that has a known list of different types at different positions.

A parameter pack is an expanded parameter pack when the original parameter pack's type was itself a pack expansion, and that expansion has already been expanded. For example, given:

template<typename ...Types>
struct X {
template<Types ...Values>
struct Y { /* ... */ };
};

The parameter pack Values has a PackExpansionType as its type, which expands Types. When Types is supplied with template arguments by instantiating X, the instantiation of Values becomes an expanded parameter pack. For example, instantiating X<int, unsigned int> results in Values being an expanded parameter pack with expansion types int and unsigned int.

The getExpansionType() and getExpansionTypeSourceInfo() functions return the expansion types.

Definition at line 1288 of file DeclTemplate.h.

Referenced by clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclReader::VisitNonTypeTemplateParmDecl().

bool clang::NonTypeTemplateParmDecl::isPackExpansion ( ) const
inline

Whether this parameter pack is a pack expansion.

A non-type template parameter pack is a pack expansion if its type contains an unexpanded parameter pack. In this case, we will have built a PackExpansionType wrapping the type.

Definition at line 1260 of file DeclTemplate.h.

bool clang::NonTypeTemplateParmDecl::isParameterPack ( ) const
inline

Whether this parameter is a non-type template parameter pack.

If the parameter is a parameter pack, the type may be a PackExpansionType. In the following example, the Dims parameter is a parameter pack (whose type is 'unsigned').

template<typename T, unsigned ...Dims> struct multi_array;

Definition at line 1253 of file DeclTemplate.h.

Referenced by isSameTemplateParameter(), IsStructurallyEquivalent(), clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl(), and clang::ASTNodeImporter::VisitNonTypeTemplateParmDecl().

void clang::NonTypeTemplateParmDecl::removeDefaultArgument ( )
inline

Removes the default argument of this template parameter.

Definition at line 1242 of file DeclTemplate.h.

void clang::NonTypeTemplateParmDecl::setDefaultArgument ( Expr DefArg)
inline

Set the default argument for this template parameter, and whether that default argument was inherited from another declaration.

Definition at line 1235 of file DeclTemplate.h.

Referenced by clang::Sema::ActOnNonTypeTemplateParameter(), and clang::ASTDeclReader::VisitNonTypeTemplateParmDecl().

void clang::NonTypeTemplateParmDecl::setInheritedDefaultArgument ( const ASTContext C,
NonTypeTemplateParmDecl Parm 
)
inline

Definition at line 1236 of file DeclTemplate.h.

Friends And Related Function Documentation

friend class ASTDeclReader
friend

Definition at line 1185 of file DeclTemplate.h.


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