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

#include "clang/AST/DeclTemplate.h"

Inheritance diagram for clang::NonTypeTemplateParmDecl:

[legend]

Collaboration diagram for clang::NonTypeTemplateParmDecl:

[legend]

Public Member Functions
SourceRange	getSourceRange () const override LLVM_READONLY
	Source range that this declaration covers.

const DefArgStorage &	getDefaultArgStorage () const

bool	hasDefaultArgument () const
	Determine whether this template parameter has a default argument.

Expr *	getDefaultArgument () const
	Retrieve the default argument, if any.

SourceLocation	getDefaultArgumentLoc () const
	Retrieve the location of the default argument, if any.

bool	defaultArgumentWasInherited () const
	Determines whether the default argument was inherited from a previous declaration of this template.

void	setDefaultArgument (Expr *DefArg)
	Set the default argument for this template parameter, and whether that default argument was inherited from another declaration.

void	setInheritedDefaultArgument (const ASTContext &C, NonTypeTemplateParmDecl *Parm)

void	removeDefaultArgument ()
	Removes the default argument of this template parameter.

bool	isParameterPack () const
	Whether this parameter is a non-type template parameter pack.

bool	isPackExpansion () const
	Whether this parameter pack is a pack expansion.

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

unsigned	getNumExpansionTypes () const
	Retrieves the number of expansion types in an expanded parameter pack.

QualType	getExpansionType (unsigned I) const
	Retrieve a particular expansion type within an expanded parameter pack.

TypeSourceInfo *	getExpansionTypeSourceInfo (unsigned I) const
	Retrieve a particular expansion type source info within an expanded parameter pack.

Expr *	getPlaceholderTypeConstraint () const
	Return the constraint introduced by the placeholder type of this non-type template parameter (if any).

void	setPlaceholderTypeConstraint (Expr *E)

bool	hasPlaceholderTypeConstraint () const
	Determine whether this non-type template parameter's type has a placeholder with a type-constraint.

void	getAssociatedConstraints (llvm::SmallVectorImpl< const Expr * > &AC) const
	Get the associated-constraints of this template parameter.

unsigned	getDepth () const
	Get the nesting depth of the template parameter.

void	setDepth (unsigned D)

unsigned	getPosition () const
	Get the position of the template parameter within its parameter list.

void	setPosition (unsigned P)

unsigned	getIndex () const
	Get the index of the template parameter within its parameter list.

Public Member Functions inherited from clang::DeclaratorDecl
TypeSourceInfo *	getTypeSourceInfo () const

void	setTypeSourceInfo (TypeSourceInfo *TI)

SourceLocation	getInnerLocStart () const
	Return start of source range ignoring outer template declarations.

void	setInnerLocStart (SourceLocation L)

SourceLocation	getOuterLocStart () const
	Return start of source range taking into account any outer template declarations.

SourceRange	getSourceRange () const override LLVM_READONLY
	Source range that this declaration covers.

SourceLocation	getBeginLoc () const LLVM_READONLY

NestedNameSpecifier *	getQualifier () const
	Retrieve the nested-name-specifier that qualifies the name of this declaration, if it was present in the source.

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.

void	setQualifierInfo (NestedNameSpecifierLoc QualifierLoc)

Expr *	getTrailingRequiresClause ()
	Get the constraint-expression introduced by the trailing requires-clause in the function/member declaration, or null if no requires-clause was provided.

const Expr *	getTrailingRequiresClause () const

void	setTrailingRequiresClause (Expr *TrailingRequiresClause)

unsigned	getNumTemplateParameterLists () const

TemplateParameterList *	getTemplateParameterList (unsigned index) const

void	setTemplateParameterListsInfo (ASTContext &Context, ArrayRef< TemplateParameterList * > TPLists)

SourceLocation	getTypeSpecStartLoc () const

SourceLocation	getTypeSpecEndLoc () 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.

bool	isInitCapture () const
	Whether this variable is the implicit variable for a lambda init-capture.

VarDecl *	getPotentiallyDecomposedVarDecl ()

const VarDecl *	getPotentiallyDecomposedVarDecl () const

Public Member Functions inherited from clang::NamedDecl
IdentifierInfo *	getIdentifier () const
	Get the identifier that names this declaration, if there is one.

StringRef	getName () const
	Get the name of identifier for this declaration as a StringRef.

std::string	getNameAsString () const
	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).

virtual void	printName (raw_ostream &OS, const PrintingPolicy &Policy) const
	Pretty-print the unqualified name of this declaration.

void	printName (raw_ostream &OS) const
	Calls printName() with the ASTContext printing policy from the decl.

DeclarationName	getDeclName () const
	Get the actual, stored name of the declaration, which may be a special name.

void	setDeclName (DeclarationName N)
	Set the name of this declaration.

void	printQualifiedName (raw_ostream &OS) const
	Returns a human-readable qualified name for this declaration, like A::B::i, for i being member of namespace A::B.

void	printQualifiedName (raw_ostream &OS, const PrintingPolicy &Policy) const

void	printNestedNameSpecifier (raw_ostream &OS) const
	Print only the nested name specifier part of a fully-qualified name, including the '::' at the end.

void	printNestedNameSpecifier (raw_ostream &OS, const PrintingPolicy &Policy) const

std::string	getQualifiedNameAsString () const

virtual void	getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
	Appends a human-readable name for this declaration into the given stream.

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.

bool	hasLinkage () const
	Determine whether this declaration has linkage.

bool	isCXXClassMember () const
	Determine whether this declaration is a C++ class member.

bool	isCXXInstanceMember () const
	Determine whether the given declaration is an instance member of a C++ class.

ReservedIdentifierStatus	isReserved (const LangOptions &LangOpts) const
	Determine if the declaration obeys the reserved identifier rules of the given language.

Linkage	getLinkageInternal () const
	Determine what kind of linkage this entity has.

Linkage	getFormalLinkage () const
	Get the linkage from a semantic point of view.

bool	hasExternalFormalLinkage () const
	True if this decl has external linkage.

bool	isExternallyVisible () const

bool	isExternallyDeclarable () const
	Determine whether this declaration can be redeclared in a different translation unit.

Visibility	getVisibility () const
	Determines the visibility of this entity.

LinkageInfo	getLinkageAndVisibility () const
	Determines the linkage and visibility of this entity.

std::optional< Visibility >	getExplicitVisibility (ExplicitVisibilityKind kind) const
	If visibility was explicitly specified for this declaration, return that visibility.

bool	isLinkageValid () const
	True if the computed linkage is valid.

bool	hasLinkageBeenComputed () const
	True if something has required us to compute the linkage of this declaration.

NamedDecl *	getUnderlyingDecl ()
	Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl.

const NamedDecl *	getUnderlyingDecl () const

NamedDecl *	getMostRecentDecl ()

const NamedDecl *	getMostRecentDecl () const

ObjCStringFormatFamily	getObjCFStringFormattingFamily () const

bool	isModulePrivate () const
	Whether this declaration was marked as being private to the module in which it was defined.

void	setModulePrivate ()
	Specify that this declaration was marked as being private to the module in which it was defined.

Public Member Functions inherited from clang::Decl
	Decl ()=delete

	Decl (const Decl &)=delete

	Decl (Decl &&)=delete

Decl &	operator= (const Decl &)=delete

Decl &	operator= (Decl &&)=delete

virtual SourceRange	getSourceRange () const LLVM_READONLY
	Source range that this declaration covers.

SourceLocation	getBeginLoc () const LLVM_READONLY

SourceLocation	getEndLoc () const LLVM_READONLY

SourceLocation	getLocation () const

void	setLocation (SourceLocation L)

Kind	getKind () const

const char *	getDeclKindName () const

Decl *	getNextDeclInContext ()

const Decl *	getNextDeclInContext () const

DeclContext *	getDeclContext ()

const DeclContext *	getDeclContext () const

DeclContext *	getNonTransparentDeclContext ()
	Return the non transparent context.

const DeclContext *	getNonTransparentDeclContext () const

Decl *	getNonClosureContext ()
	Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc.

const Decl *	getNonClosureContext () const

TranslationUnitDecl *	getTranslationUnitDecl ()

const TranslationUnitDecl *	getTranslationUnitDecl () const

bool	isInAnonymousNamespace () const

bool	isInStdNamespace () const

bool	isFileContextDecl () const

ASTContext &	getASTContext () const LLVM_READONLY

const LangOptions &	getLangOpts () const LLVM_READONLY
	Helper to get the language options from the ASTContext.

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.

bool	hasAttrs () const

void	setAttrs (const AttrVec &Attrs)

AttrVec &	getAttrs ()

const AttrVec &	getAttrs () 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
	getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none.

void	setInvalidDecl (bool Invalid=true)
	setInvalidDecl - Indicates the Decl had a semantic error.

bool	isInvalidDecl () const

bool	isImplicit () const
	isImplicit - Indicates whether the declaration was implicitly generated by the implementation.

void	setImplicit (bool I=true)

bool	isUsed (bool CheckUsedAttr=true) const
	Whether any (re-)declaration of the entity was used, meaning that a definition is required.

void	setIsUsed ()
	Set whether the declaration is used, in the sense of odr-use.

void	markUsed (ASTContext &C)
	Mark the declaration used, in the sense of odr-use.

bool	isReferenced () const
	Whether any declaration of this entity was referenced.

bool	isThisDeclarationReferenced () const
	Whether this declaration was referenced.

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.

void	setTopLevelDeclInObjCContainer (bool V=true)

ExternalSourceSymbolAttr *	getExternalSourceSymbolAttr () const
	Looks on this and related declarations for an applicable external source symbol attribute.

bool	isModulePrivate () const
	Whether this declaration was marked as being private to the module in which it was defined.

bool	isInExportDeclContext () const
	Whether this declaration was exported in a lexical context.

bool	isInvisibleOutsideTheOwningModule () const

bool	isDiscardedInGlobalModuleFragment () const
	FIXME: Implement discarding declarations actually in global module fragment.

bool	hasDefiningAttr () const
	Return true if this declaration has an attribute which acts as definition of the entity, such as 'alias' or 'ifunc'.

const Attr *	getDefiningAttr () const
	Return this declaration's defining attribute if it has one.

void	setFromASTFile ()
	Set the FromASTFile flag.

void	setOwningModuleID (unsigned ID)
	Set the owning module ID.

AvailabilityResult	getAvailability (std::string Message=nullptr, VersionTuple EnclosingVersion=VersionTuple(), StringRef RealizedPlatform=nullptr) const
	Determine the availability of the given declaration.

VersionTuple	getVersionIntroduced () const
	Retrieve the version of the target platform in which this declaration was introduced.

bool	isDeprecated (std::string *Message=nullptr) const
	Determine whether this declaration is marked 'deprecated'.

bool	isUnavailable (std::string *Message=nullptr) const
	Determine whether this declaration is marked 'unavailable'.

bool	isWeakImported () const
	Determine whether this is a weak-imported symbol.

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.

bool	isFromASTFile () const
	Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed.

unsigned	getGlobalID () const
	Retrieve the global declaration ID associated with this declaration, which specifies where this Decl was loaded from.

unsigned	getOwningModuleID () const
	Retrieve the global ID of the module that owns this particular declaration.

Module *	getImportedOwningModule () const
	Get the imported owning module, if this decl is from an imported (non-local) module.

Module *	getLocalOwningModule () const
	Get the local owning module, if known.

void	setLocalOwningModule (Module *M)

bool	hasOwningModule () const
	Is this declaration owned by some module?

Module *	getOwningModule () const
	Get the module that owns this declaration (for visibility purposes).

Module *	getOwningModuleForLinkage (bool IgnoreLinkage=false) const
	Get the module that owns this declaration for linkage purposes.

bool	isUnconditionallyVisible () const
	Determine whether this declaration is definitely visible to name lookup, independent of whether the owning module is visible.

bool	isReachable () const

void	setVisibleDespiteOwningModule ()
	Set that this declaration is globally visible, even if it came from a module that is not visible.

ModuleOwnershipKind	getModuleOwnershipKind () const
	Get the kind of module ownership for this declaration.

void	setModuleOwnershipKind (ModuleOwnershipKind MOK)
	Set whether this declaration is hidden from name lookup.

unsigned	getIdentifierNamespace () const

bool	isInIdentifierNamespace (unsigned NS) const

bool	hasTagIdentifierNamespace () const

DeclContext *	getLexicalDeclContext ()
	getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC).

const DeclContext *	getLexicalDeclContext () const

virtual bool	isOutOfLine () const
	Determine whether this declaration is declared out of line (outside its semantic context).

void	setDeclContext (DeclContext *DC)
	setDeclContext - Set both the semantic and lexical DeclContext to DC.

void	setLexicalDeclContext (DeclContext *DC)

bool	isTemplated () const
	Determine whether this declaration is a templated entity (whether it is.

unsigned	getTemplateDepth () const
	Determine the number of levels of template parameter surrounding this declaration.

bool	isDefinedOutsideFunctionOrMethod () const
	isDefinedOutsideFunctionOrMethod - This predicate returns true if this scoped decl is defined outside the current function or method.

bool	isInLocalScopeForInstantiation () const
	Determine whether a substitution into this declaration would occur as part of a substitution into a dependent local scope.

const DeclContext *	getParentFunctionOrMethod (bool LexicalParent=false) const
	If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null.

DeclContext *	getParentFunctionOrMethod (bool LexicalParent=false)

virtual Decl *	getCanonicalDecl ()
	Retrieves the "canonical" declaration of the given declaration.

const Decl *	getCanonicalDecl () const

bool	isCanonicalDecl () const
	Whether this particular Decl is a canonical one.

redecl_range	redecls () const
	Returns an iterator range for all the redeclarations of the same decl.

redecl_iterator	redecls_begin () const

redecl_iterator	redecls_end () const

Decl *	getPreviousDecl ()
	Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration.

const Decl *	getPreviousDecl () const
	Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration.

bool	isFirstDecl () const
	True if this is the first declaration in its redeclaration chain.

Decl *	getMostRecentDecl ()
	Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).

const Decl *	getMostRecentDecl () const
	Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).

virtual Stmt *	getBody () const
	getBody - If this Decl represents a declaration for a body of code, such as a function or method definition, this method returns the top-level Stmt* of that body.

virtual bool	hasBody () const
	Returns true if this `Decl` represents a declaration for a body of code, such as a function or method definition.

SourceLocation	getBodyRBrace () const
	getBodyRBrace - Gets the right brace of the body, if a body exists.

bool	isTemplateParameter () const
	isTemplateParameter - Determines whether this declaration is a template parameter.

bool	isTemplateParameterPack () const
	isTemplateParameter - Determines whether this declaration is a template parameter pack.

bool	isParameterPack () const
	Whether this declaration is a parameter pack.

bool	isTemplateDecl () const
	returns true if this declaration is a template

bool	isFunctionOrFunctionTemplate () const
	Whether this declaration is a function or function template.

TemplateDecl *	getDescribedTemplate () const
	If this is a declaration that describes some template, this method returns that template declaration.

const TemplateParameterList *	getDescribedTemplateParams () const
	If this is a declaration that describes some template or partial specialization, this returns the corresponding template parameter list.

FunctionDecl *	getAsFunction () LLVM_READONLY
	Returns the function itself, or the templated function if this is a function template.

const FunctionDecl *	getAsFunction () const

void	setLocalExternDecl ()
	Changes the namespace of this declaration to reflect that it's a function-local extern declaration.

bool	isLocalExternDecl () const
	Determine whether this is a block-scope declaration with linkage.

void	setObjectOfFriendDecl (bool PerformFriendInjection=false)
	Changes the namespace of this declaration to reflect that it's the object of a friend declaration.

FriendObjectKind	getFriendObjectKind () const
	Determines whether this declaration is the object of a friend declaration and, if so, what kind.

void	setNonMemberOperator ()
	Specifies that this declaration is a C++ overloaded non-member.

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, bool Deserialize=false, ASTDumpOutputFormat OutputFormat=ADOF_Default) const

int64_t	getID () const

const FunctionType *	getFunctionType (bool BlocksToo=true) const
	Looks through the Decl's underlying type to extract a FunctionType when possible.

bool	isFunctionPointerType () const

Static Public Member Functions
static 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 *	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 NonTypeTemplateParmDecl *	CreateDeserialized (ASTContext &C, unsigned ID, bool HasTypeConstraint)

static NonTypeTemplateParmDecl *	CreateDeserialized (ASTContext &C, unsigned ID, unsigned NumExpandedTypes, bool HasTypeConstraint)

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)

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 DeclContext *	castToDeclContext (const Decl *)

static Decl *	castFromDeclContext (const DeclContext *)

static void	printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)

Friends
class	ASTDeclReader

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 , IDNS_OMPReduction = 0x1000 , IDNS_OMPMapper = 0x2000 }
	IdentifierNamespace - The different namespaces in which declarations may appear. More...

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 }
	ObjCDeclQualifier - 'Qualifiers' written next to the return and parameter types in method declarations. More...

enum class	ModuleOwnershipKind : unsigned { Unowned , Visible , VisibleWhenImported , ReachableWhenImported , ModulePrivate }
	The kind of ownership a declaration has, for visibility purposes. More...

enum	FriendObjectKind { FOK_None , FOK_Declared , FOK_Undeclared }

using	attr_iterator = AttrVec::const_iterator

using	attr_range = llvm::iterator_range< attr_iterator >

using	redecl_range = llvm::iterator_range< redecl_iterator >

Protected Types inherited from clang::TemplateParmPosition
enum	{ DepthWidth = 20 , PositionWidth = 12 }

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::Decl
void *	operator new (std::size_t Size, const ASTContext &Ctx, unsigned ID, std::size_t Extra=0)
	Allocate memory for a deserialized declaration.

void *	operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)
	Allocate memory for a non-deserialized declaration.

	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.

Linkage	getCachedLinkage () const

void	setCachedLinkage (Linkage L) const

bool	hasCachedLinkage () const

void	setModulePrivate ()
	Specify that this declaration was marked as being private to the module in which it was defined.

bool	hasLocalOwningModuleStorage () const

virtual Decl *	getNextRedeclarationImpl ()
	Returns the next redeclaration or itself if this is the only decl.

virtual Decl *	getPreviousDeclImpl ()
	Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.

virtual Decl *	getMostRecentDeclImpl ()
	Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain.

ASTMutationListener *	getASTMutationListener () const

Protected Member Functions inherited from clang::TemplateParmPosition
	TemplateParmPosition (unsigned D, unsigned P)

	TemplateParmPosition ()=delete

unsigned	getDepth () const
	Get the nesting depth of the template parameter.

void	setDepth (unsigned D)

unsigned	getPosition () const
	Get the position of the template parameter within its parameter list.

void	setPosition (unsigned P)

unsigned	getIndex () const
	Get the index of the template parameter within its parameter list.

Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl *, 3, ModuleOwnershipKind >	NextInContextAndBits
	The next declaration within the same lexical DeclContext.

unsigned	Access: 2
	Access - Used by C++ decls for the access specifier.

unsigned	FromASTFile: 1
	Whether this declaration was loaded from an AST file.

unsigned	IdentifierNamespace: 14
	IdentifierNamespace - This specifies what IDNS_* namespace this lives in.

unsigned	CacheValidAndLinkage: 3
	If 0, we have not computed the linkage of this declaration.

Protected Attributes inherited from clang::TemplateParmPosition
unsigned	Depth: DepthWidth

unsigned	Position: PositionWidth

Static Protected Attributes inherited from clang::TemplateParmPosition
static constexpr unsigned	MaxDepth = (1U << DepthWidth) - 1

static constexpr unsigned	MaxPosition = (1U << PositionWidth) - 1

Detailed Description

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

template<int Size> class array { };

Definition at line 1407 of file DeclTemplate.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 1613 of file DeclTemplate.h.

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

◆ classofKind()

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

inlinestatic

Definition at line 1614 of file DeclTemplate.h.

Referenced by classof().

◆ Create() [1/2]

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

Definition at line 737 of file DeclTemplate.cpp.

References clang::C, clang::Type::getContainedAutoType(), Id, clang::AutoType::isConstrained(), and P.

Referenced by clang::Sema::ActOnNonTypeTemplateParameter(), createMakeIntegerSeqParameterList(), and createTypePackElementParameterList().

◆ Create() [2/2]

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

References clang::C, clang::Type::getContainedAutoType(), clang::TypeSourceInfo::getType(), Id, clang::AutoType::isConstrained(), and P.

◆ CreateDeserialized() [1/2]

NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::CreateDeserialized	(	ASTContext &	C,
		unsigned	ID,
		bool	HasTypeConstraint
	)

static

Definition at line 767 of file DeclTemplate.cpp.

References clang::C.

◆ CreateDeserialized() [2/2]

NonTypeTemplateParmDecl * NonTypeTemplateParmDecl::CreateDeserialized	(	ASTContext &	C,
		unsigned	ID,
		unsigned	NumExpandedTypes,
		bool	HasTypeConstraint
	)

static

Definition at line 778 of file DeclTemplate.cpp.

References clang::C.

◆ defaultArgumentWasInherited()

bool clang::NonTypeTemplateParmDecl::defaultArgumentWasInherited ( ) const

inline

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

Definition at line 1496 of file DeclTemplate.h.

References clang::DefaultArgStorage< ParmDecl, ArgType >::isInherited().

Referenced by clang::ODRDiagsEmitter::diagnoseMismatch(), getSourceRange(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitNonTypeTemplateParmDecl(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ getAssociatedConstraints()

void clang::NonTypeTemplateParmDecl::getAssociatedConstraints ( llvm::SmallVectorImpl< const Expr * > & AC ) const

inline

Get the associated-constraints of this template parameter.

This will either be a vector of size 1 containing the immediately-declared constraint introduced by the placeholder type, or an empty vector.

Use this instead of getPlaceholderImmediatelyDeclaredConstraint for concepts APIs that accept an ArrayRef of constraint expressions.

Definition at line 1607 of file DeclTemplate.h.

References getPlaceholderTypeConstraint().

◆ getDefaultArgStorage()

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

inline

Definition at line 1482 of file DeclTemplate.h.

Referenced by clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitNonTypeTemplateParmDecl(), and clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl().

◆ getDefaultArgument()

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

inline

Retrieve the default argument, if any.

Definition at line 1489 of file DeclTemplate.h.

References clang::DefaultArgStorage< ParmDecl, ArgType >::get().

Referenced by clang::ODRDiagsEmitter::diagnoseMismatch(), getDefaultArgumentLoc(), getSourceRange(), SubstDefaultTemplateArgument(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitNonTypeTemplateParmDecl(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), clang::ASTNodeImporter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ getDefaultArgumentLoc()

SourceLocation NonTypeTemplateParmDecl::getDefaultArgumentLoc ( ) const

Retrieve the location of the default argument, if any.

Definition at line 799 of file DeclTemplate.cpp.

References clang::SourceRange::getBegin(), getDefaultArgument(), clang::Stmt::getSourceRange(), and hasDefaultArgument().

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

◆ getDepth()

unsigned clang::TemplateParmPosition::getDepth ( ) const

inline

Get the nesting depth of the template parameter.

Definition at line 1179 of file DeclTemplate.h.

Referenced by CheckNonTypeTemplatePartialSpecializationArgs(), clang::Sema::CheckTemplateArgument(), DeduceNonTypeTemplateArgument(), DeduceTemplateArgumentsByTypeMatch(), isTemplateArgumentTemplateParameter(), MarkUsedTemplateParameters(), SubstDefaultTemplateArgument(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), clang::TextNodeDumper::VisitNonTypeTemplateParmDecl(), clang::ASTNodeImporter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ getExpansionType()

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

inline

Retrieve a particular expansion type within an expanded parameter pack.

Definition at line 1567 of file DeclTemplate.h.

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

◆ getExpansionTypeSourceInfo()

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

inline

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

Definition at line 1576 of file DeclTemplate.h.

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

◆ getIndex()

unsigned clang::TemplateParmPosition::getIndex ( ) const

inline

Get the index of the template parameter within its parameter list.

Definition at line 1195 of file DeclTemplate.h.

Referenced by DeduceNonTypeTemplateArgument(), isTemplateArgumentTemplateParameter(), MarkUsedTemplateParameters(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), and clang::TextNodeDumper::VisitNonTypeTemplateParmDecl().

◆ getNumExpansionTypes()

unsigned clang::NonTypeTemplateParmDecl::getNumExpansionTypes ( ) const

inline

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

Definition at line 1560 of file DeclTemplate.h.

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

◆ getPlaceholderTypeConstraint()

Expr * clang::NonTypeTemplateParmDecl::getPlaceholderTypeConstraint ( ) const

inline

Return the constraint introduced by the placeholder type of this non-type template parameter (if any).

Definition at line 1585 of file DeclTemplate.h.

References hasPlaceholderTypeConstraint().

Referenced by getAssociatedConstraints(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ getPosition()

unsigned clang::TemplateParmPosition::getPosition ( ) const

inline

Get the position of the template parameter within its parameter list.

Definition at line 1187 of file DeclTemplate.h.

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

◆ getSourceRange()

SourceRange NonTypeTemplateParmDecl::getSourceRange ( ) const

overridevirtual

Source range that this declaration covers.

Reimplemented from clang::DeclaratorDecl.

Definition at line 792 of file DeclTemplate.cpp.

References defaultArgumentWasInherited(), getDefaultArgument(), clang::DeclaratorDecl::getOuterLocStart(), clang::DeclaratorDecl::getSourceRange(), getSourceRange(), and hasDefaultArgument().

Referenced by getSourceRange().

◆ hasDefaultArgument()

bool clang::NonTypeTemplateParmDecl::hasDefaultArgument ( ) const

inline

Determine whether this template parameter has a default argument.

Definition at line 1486 of file DeclTemplate.h.

References clang::DefaultArgStorage< ParmDecl, ArgType >::isSet().

Referenced by clang::Sema::CheckTemplateParameterList(), clang::ODRDiagsEmitter::diagnoseMismatch(), getDefaultArgumentLoc(), getSourceRange(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitNonTypeTemplateParmDecl(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), clang::ASTNodeImporter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ hasPlaceholderTypeConstraint()

bool clang::NonTypeTemplateParmDecl::hasPlaceholderTypeConstraint ( ) const

inline

Determine whether this non-type template parameter's type has a placeholder with a type-constraint.

Definition at line 1596 of file DeclTemplate.h.

References clang::Type::getContainedAutoType(), clang::ValueDecl::getType(), and clang::AutoType::isConstrained().

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

◆ isExpandedParameterPack()

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 1556 of file DeclTemplate.h.

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

◆ isPackExpansion()

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 1528 of file DeclTemplate.h.

References clang::Type::getAs(), and clang::ValueDecl::getType().

◆ isParameterPack()

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 1521 of file DeclTemplate.h.

Referenced by clang::Sema::ActOnNonTypeTemplateParameter(), clang::ODRDiagsEmitter::diagnoseMismatch(), IsStructurallyEquivalent(), clang::JSONNodeDumper::VisitNonTypeTemplateParmDecl(), clang::TextNodeDumper::VisitNonTypeTemplateParmDecl(), clang::ASTNodeImporter::VisitNonTypeTemplateParmDecl(), and clang::ASTDeclWriter::VisitNonTypeTemplateParmDecl().

◆ removeDefaultArgument()

void clang::NonTypeTemplateParmDecl::removeDefaultArgument ( )

inline

Removes the default argument of this template parameter.

Definition at line 1510 of file DeclTemplate.h.

References clang::DefaultArgStorage< ParmDecl, ArgType >::clear().

◆ setDefaultArgument()

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 1503 of file DeclTemplate.h.

References clang::DefaultArgStorage< ParmDecl, ArgType >::set().

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

◆ setDepth()

void clang::TemplateParmPosition::setDepth ( unsigned D )

inline

Definition at line 1180 of file DeclTemplate.h.

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

◆ setInheritedDefaultArgument()

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

inline

Definition at line 1504 of file DeclTemplate.h.

References clang::C, and clang::DefaultArgStorage< ParmDecl, ArgType >::setInherited().

◆ setPlaceholderTypeConstraint()

void clang::NonTypeTemplateParmDecl::setPlaceholderTypeConstraint ( Expr * E )

inline

Definition at line 1590 of file DeclTemplate.h.

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

◆ setPosition()

void clang::TemplateParmPosition::setPosition ( unsigned P )

inline

Definition at line 1188 of file DeclTemplate.h.

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

Friends And Related Function Documentation

◆ ASTDeclReader

friend class ASTDeclReader

friend

Definition at line 1413 of file DeclTemplate.h.

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

include/clang/AST/DeclTemplate.h
lib/AST/DeclTemplate.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ classofKind()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateDeserialized() [1/2]

◆ CreateDeserialized() [2/2]

◆ defaultArgumentWasInherited()

◆ getAssociatedConstraints()

◆ getDefaultArgStorage()

◆ getDefaultArgument()

◆ getDefaultArgumentLoc()

◆ getDepth()

◆ getExpansionType()

◆ getExpansionTypeSourceInfo()

◆ getIndex()

◆ getNumExpansionTypes()

◆ getPlaceholderTypeConstraint()

◆ getPosition()

◆ getSourceRange()

◆ hasDefaultArgument()

◆ hasPlaceholderTypeConstraint()

◆ isExpandedParameterPack()

◆ isPackExpansion()

◆ isParameterPack()

◆ removeDefaultArgument()

◆ setDefaultArgument()

◆ setDepth()

◆ setInheritedDefaultArgument()

◆ setPlaceholderTypeConstraint()

◆ setPosition()

Friends And Related Function Documentation

◆ ASTDeclReader