clang  10.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
clang::TemplateParameterList Class Referencefinal

Stores a list of template parameters for a TemplateDecl and its derived classes. More...

#include "clang/AST/DeclTemplate.h"

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

Public Types

using iterator = NamedDecl **
 Iterates through the template parameters in this list. More...
 
using const_iterator = NamedDecl *const *
 Iterates through the template parameters in this list. More...
 
using FixedSizeStorageOwner = TrailingObjects::FixedSizeStorageOwner
 

Public Member Functions

iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
unsigned size () const
 
ArrayRef< NamedDecl * > asArray ()
 
ArrayRef< const NamedDecl * > asArray () const
 
NamedDecl * getParam (unsigned Idx)
 
const NamedDecl * getParam (unsigned Idx) const
 
unsigned getMinRequiredArguments () const
 Returns the minimum number of arguments needed to form a template specialization. More...
 
unsigned getDepth () const
 Get the depth of this template parameter list in the set of template parameter lists. More...
 
bool containsUnexpandedParameterPack () const
 Determine whether this template parameter list contains an unexpanded parameter pack. More...
 
Expr * getRequiresClause ()
 The constraint-expression of the associated requires-clause. More...
 
const Expr * getRequiresClause () const
 The constraint-expression of the associated requires-clause. More...
 
void getAssociatedConstraints (llvm::SmallVectorImpl< const Expr *> &AC) const
 All associated constraints derived from this template parameter list, including the requires clause and any constraints derived from constrained-parameters. More...
 
bool hasAssociatedConstraints () const
 
SourceLocation getTemplateLoc () const
 
SourceLocation getLAngleLoc () const
 
SourceLocation getRAngleLoc () const
 
SourceRange getSourceRange () const LLVM_READONLY
 
void print (raw_ostream &Out, const ASTContext &Context, bool OmitTemplateKW=false) const
 
void print (raw_ostream &Out, const ASTContext &Context, const PrintingPolicy &Policy, bool OmitTemplateKW=false) const
 

Static Public Member Functions

static TemplateParameterList * Create (const ASTContext &C, SourceLocation TemplateLoc, SourceLocation LAngleLoc, ArrayRef< NamedDecl *> Params, SourceLocation RAngleLoc, Expr *RequiresClause)
 

Public Attributes

friend TrailingObjects
 

Protected Member Functions

 TemplateParameterList (SourceLocation TemplateLoc, SourceLocation LAngleLoc, ArrayRef< NamedDecl *> Params, SourceLocation RAngleLoc, Expr *RequiresClause)
 
size_t numTrailingObjects (OverloadToken< NamedDecl *>) const
 
size_t numTrailingObjects (OverloadToken< Expr *>) const
 

Friends

template<size_t N, bool HasRequiresClause>
class FixedSizeTemplateParameterListStorage
 

Detailed Description

Stores a list of template parameters for a TemplateDecl and its derived classes.

Definition at line 67 of file DeclTemplate.h.

Member Typedef Documentation

◆ const_iterator

using clang::TemplateParameterList::const_iterator = NamedDecl * const *

Iterates through the template parameters in this list.

Definition at line 116 of file DeclTemplate.h.

◆ FixedSizeStorageOwner

using clang::TemplateParameterList::FixedSizeStorageOwner = TrailingObjects::FixedSizeStorageOwner

Definition at line 196 of file DeclTemplate.h.

◆ iterator

using clang::TemplateParameterList::iterator = NamedDecl **

Iterates through the template parameters in this list.

Definition at line 113 of file DeclTemplate.h.

Constructor & Destructor Documentation

◆ TemplateParameterList()

TemplateParameterList::TemplateParameterList ( SourceLocation  TemplateLoc,
SourceLocation  LAngleLoc,
ArrayRef< NamedDecl *>  Params,
SourceLocation  RAngleLoc,
Expr *  RequiresClause 
)
protected

Definition at line 46 of file DeclTemplate.cpp.

References begin(), clang::Expr::containsUnexpandedParameterPack(), clang::Decl::isTemplateParameterPack(), and P.

Referenced by Create().

Member Function Documentation

◆ asArray() [1/2]

ArrayRef<NamedDecl*> clang::TemplateParameterList::asArray ( )
inline

Definition at line 125 of file DeclTemplate.h.

References begin(), and end().

Referenced by clang::ODRHash::AddTemplateParameterList(), and getMinRequiredArguments().

◆ asArray() [2/2]

ArrayRef<const NamedDecl*> clang::TemplateParameterList::asArray ( ) const
inline

Definition at line 128 of file DeclTemplate.h.

References begin(), and size().

◆ begin() [1/2]

iterator clang::TemplateParameterList::begin ( )
inline

Definition at line 118 of file DeclTemplate.h.

Referenced by asArray(), clang::Sema::CheckTemplateArgumentList(), clang::Sema::CheckTemplateParameterList(), end(), clang::for(), clang::ASTContext::getCommentForDecl(), getParam(), TemplateParameterList(), and clang::Sema::TemplateParameterListsAreEqual().

◆ begin() [2/2]

const_iterator clang::TemplateParameterList::begin ( ) const
inline

Definition at line 119 of file DeclTemplate.h.

◆ containsUnexpandedParameterPack()

bool clang::TemplateParameterList::containsUnexpandedParameterPack ( ) const
inline

Determine whether this template parameter list contains an unexpanded parameter pack.

Definition at line 157 of file DeclTemplate.h.

◆ Create()

TemplateParameterList * TemplateParameterList::Create ( const ASTContext &  C,
SourceLocation  TemplateLoc,
SourceLocation  LAngleLoc,
ArrayRef< NamedDecl *>  Params,
SourceLocation  RAngleLoc,
Expr *  RequiresClause 
)
static

Definition at line 79 of file DeclTemplate.cpp.

References clang::ASTContext::Allocate(), and TemplateParameterList().

Referenced by clang::Sema::ActOnTemplateParameterList(), createMakeIntegerSeqParameterList(), clang::ASTContext::getCommentForDecl(), getGenericLambdaTemplateParameterList(), clang::TypeAliasTemplateDecl::getInstantiatedFromMemberTemplate(), clang::ASTNodeImporter::import(), clang::ClassTemplateDecl::isThisDeclarationADefinition(), clang::VarTemplateDecl::isThisDeclarationADefinition(), clang::ASTReader::ReadTemplateParameterList(), clang::FunctionTemplateDecl::spec_end(), and clang::TemplateDeclInstantiator::SubstTemplateParams().

◆ end() [1/2]

iterator clang::TemplateParameterList::end ( )
inline

Definition at line 120 of file DeclTemplate.h.

References begin().

Referenced by asArray(), clang::Sema::CheckTemplateArgumentList(), clang::Sema::CheckTemplateParameterList(), clang::for(), clang::ASTContext::getCommentForDecl(), and clang::Sema::TemplateParameterListsAreEqual().

◆ end() [2/2]

const_iterator clang::TemplateParameterList::end ( ) const
inline

Definition at line 121 of file DeclTemplate.h.

References begin().

◆ getAssociatedConstraints()

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

All associated constraints derived from this template parameter list, including the requires clause and any constraints derived from constrained-parameters.

The constraints in the resulting list are to be treated as if in a conjunction ("and").

Definition at line 142 of file DeclTemplate.cpp.

References getRequiresClause().

Referenced by AdoptTemplateParameterList(), clang::TemplateDecl::getAssociatedConstraints(), clang::ClassTemplatePartialSpecializationDecl::getAssociatedConstraints(), clang::VarTemplatePartialSpecializationDecl::getAssociatedConstraints(), getRequiresClause(), and clang::TemplateDecl::getTemplateParameters().

◆ getDepth()

unsigned TemplateParameterList::getDepth ( ) const

Get the depth of this template parameter list in the set of template parameter lists.

The first template parameter list in a declaration will have depth 0, the second template parameter list will have depth 1, etc.

Definition at line 118 of file DeclTemplate.cpp.

References getParam(), and size().

Referenced by getParam(), hasDeducibleTemplateParameters(), isAtLeastAsSpecializedAs(), isSameAsPrimaryTemplate(), clang::Sema::MarkDeducedTemplateParameters(), and clang::TemplateTypeParmDecl::setDeclaredWithTypename().

◆ getLAngleLoc()

SourceLocation clang::TemplateParameterList::getLAngleLoc ( ) const
inline

Definition at line 182 of file DeclTemplate.h.

Referenced by clang::ASTRecordWriter::AddTemplateParameterList(), and clang::ASTNodeImporter::import().

◆ getMinRequiredArguments()

unsigned TemplateParameterList::getMinRequiredArguments ( ) const

Returns the minimum number of arguments needed to form a template specialization.

This may be fewer than the number of template parameters, if some of the parameters have default arguments or if there is a parameter pack.

Definition at line 90 of file DeclTemplate.cpp.

References asArray(), and P.

Referenced by getParam(), clang::Sema::isStdInitializerList(), and LookupStdInitializerList().

◆ getParam() [1/2]

NamedDecl* clang::TemplateParameterList::getParam ( unsigned  Idx)
inline

Definition at line 132 of file DeclTemplate.h.

References begin(), and size().

Referenced by checkLiteralOperatorTemplateParameterList(), clang::Sema::CheckTemplatePartialSpecializationArgs(), checkTupleLikeDecomposition(), getDepth(), clang::comments::TParamCommandComment::getParamName(), clang::Sema::getTemplateArgumentBindingsText(), isSameAsPrimaryTemplate(), isSameTemplateParameterList(), clang::Sema::isStdInitializerList(), LookupStdInitializerList(), noteNonDeducibleParameters(), and clang::Sema::RebuildTemplateParamsInCurrentInstantiation().

◆ getParam() [2/2]

const NamedDecl* clang::TemplateParameterList::getParam ( unsigned  Idx) const
inline

Definition at line 136 of file DeclTemplate.h.

References begin(), getDepth(), getMinRequiredArguments(), and size().

◆ getRAngleLoc()

SourceLocation clang::TemplateParameterList::getRAngleLoc ( ) const
inline

Definition at line 183 of file DeclTemplate.h.

Referenced by clang::ASTRecordWriter::AddTemplateParameterList(), DiagnoseTemplateParameterListArityMismatch(), and clang::ASTNodeImporter::import().

◆ getRequiresClause() [1/2]

Expr* clang::TemplateParameterList::getRequiresClause ( )
inline

The constraint-expression of the associated requires-clause.

Definition at line 162 of file DeclTemplate.h.

Referenced by getAssociatedConstraints(), clang::ASTContext::getCommentForDecl(), clang::ASTNodeImporter::import(), and clang::Sema::TemplateParameterListsAreEqual().

◆ getRequiresClause() [2/2]

const Expr* clang::TemplateParameterList::getRequiresClause ( ) const
inline

The constraint-expression of the associated requires-clause.

Definition at line 167 of file DeclTemplate.h.

References getAssociatedConstraints(), and hasAssociatedConstraints().

◆ getSourceRange()

SourceRange clang::TemplateParameterList::getSourceRange ( ) const
inline

Definition at line 185 of file DeclTemplate.h.

References print().

Referenced by checkLiteralOperatorTemplateParameterList(), clang::Sema::CheckTemplateDeclScope(), diagnoseMissingArgument(), clang::ClassTemplateSpecializationDecl::getTemplateKeywordLoc(), and clang::TemplateTypeParmDecl::setDeclaredWithTypename().

◆ getTemplateLoc()

SourceLocation clang::TemplateParameterList::getTemplateLoc ( ) const
inline

Definition at line 181 of file DeclTemplate.h.

Referenced by clang::ASTRecordWriter::AddTemplateParameterList(), clang::Sema::CheckTemplateDeclScope(), DiagnoseTemplateParameterListArityMismatch(), DiagnoseTemplateParameterListRequiresClauseMismatch(), clang::TemplateDecl::getSourceRange(), clang::TemplateTemplateParmDecl::getSourceRange(), clang::ConceptDecl::getSourceRange(), and clang::ASTNodeImporter::import().

◆ hasAssociatedConstraints()

bool TemplateParameterList::hasAssociatedConstraints ( ) const

Definition at line 148 of file DeclTemplate.cpp.

Referenced by getRequiresClause(), clang::TemplateDecl::getTemplateParameters(), clang::TemplateDecl::hasAssociatedConstraints(), clang::ClassTemplatePartialSpecializationDecl::hasAssociatedConstraints(), and clang::VarTemplatePartialSpecializationDecl::hasAssociatedConstraints().

◆ numTrailingObjects() [1/2]

size_t clang::TemplateParameterList::numTrailingObjects ( OverloadToken< NamedDecl *>  ) const
inlineprotected

Definition at line 92 of file DeclTemplate.h.

Referenced by clang::FunctionTemplateSpecializationInfo::getMemberSpecializationInfo().

◆ numTrailingObjects() [2/2]

size_t clang::TemplateParameterList::numTrailingObjects ( OverloadToken< Expr *>  ) const
inlineprotected

Definition at line 96 of file DeclTemplate.h.

◆ print() [1/2]

void TemplateParameterList::print ( raw_ostream &  Out,
const ASTContext &  Context,
bool  OmitTemplateKW = false 
) const

Definition at line 131 of file DeclPrinter.cpp.

Referenced by getSourceRange().

◆ print() [2/2]

void TemplateParameterList::print ( raw_ostream &  Out,
const ASTContext &  Context,
const PrintingPolicy &  Policy,
bool  OmitTemplateKW = false 
) const

Definition at line 136 of file DeclPrinter.cpp.

◆ size()

unsigned clang::TemplateParameterList::size ( ) const
inline

Definition at line 123 of file DeclTemplate.h.

Referenced by clang::ODRHash::AddTemplateParameterList(), clang::ASTRecordWriter::AddTemplateParameterList(), asArray(), clang::TemplateArgumentList::asArray(), checkLiteralOperatorTemplateParameterList(), clang::Sema::CheckTemplatePartialSpecializationArgs(), checkTupleLikeDecomposition(), clang::Sema::DeduceTemplateArguments(), DiagnoseTemplateParameterListArityMismatch(), clang::Sema::FindInstantiatedDecl(), clang::ASTContext::getCommentForDecl(), getDepth(), getFirstInnerIndex(), clang::ASTContext::getInjectedTemplateArgs(), getParam(), clang::Sema::getTemplateArgumentBindingsText(), hasDeducibleTemplateParameters(), clang::ASTNodeImporter::import(), isAtLeastAsSpecializedAs(), isSameAsPrimaryTemplate(), isSameTemplateParameterList(), clang::Sema::MarkDeducedTemplateParameters(), clang::Sema::RebuildTemplateParamsInCurrentInstantiation(), ResolveOverloadForDeduction(), clang::TemplateDeclInstantiator::SubstTemplateParams(), and clang::Sema::TemplateParameterListsAreEqual().

Friends And Related Function Documentation

◆ FixedSizeTemplateParameterListStorage

template<size_t N, bool HasRequiresClause>
friend class FixedSizeTemplateParameterListStorage
friend

Definition at line 102 of file DeclTemplate.h.

Member Data Documentation

◆ TrailingObjects

friend clang::TemplateParameterList::TrailingObjects

Definition at line 103 of file DeclTemplate.h.

The documentation for this class was generated from the following files:
Generated on Mon Nov 4 2019 00:56:00 for clang by   doxygen 1.8.13