clang  14.0.0git
Public Member Functions | List of all members
clang::MultiLevelTemplateArgumentList Class Reference

Data structure that captures multiple levels of template argument lists for use in template instantiation. More...

#include "clang/Sema/Template.h"

Public Member Functions

 MultiLevelTemplateArgumentList ()=default
 Construct an empty set of template argument lists. More...
 
 MultiLevelTemplateArgumentList (const TemplateArgumentList &TemplateArgs)
 Construct a single-level template argument list. More...
 
void setKind (TemplateSubstitutionKind K)
 
TemplateSubstitutionKind getKind () const
 Determine the kind of template substitution being performed. More...
 
bool isRewrite () const
 Determine whether we are rewriting template parameters rather than substituting for them. More...
 
unsigned getNumLevels () const
 Determine the number of levels in this template argument list. More...
 
unsigned getNumSubstitutedLevels () const
 Determine the number of substituted levels in this template argument list. More...
 
unsigned getNumRetainedOuterLevels () const
 
unsigned getNewDepth (unsigned OldDepth) const
 Determine how many of the OldDepth outermost template parameter lists would be removed by substituting these arguments. More...
 
const TemplateArgumentoperator() (unsigned Depth, unsigned Index) const
 Retrieve the template argument at a given depth and index. More...
 
bool hasTemplateArgument (unsigned Depth, unsigned Index) const
 Determine whether there is a non-NULL template argument at the given depth and index. More...
 
void setArgument (unsigned Depth, unsigned Index, TemplateArgument Arg)
 Clear out a specific template argument. More...
 
void addOuterTemplateArguments (const TemplateArgumentList *TemplateArgs)
 Add a new outermost level to the multi-level template argument list. More...
 
void addOuterTemplateArguments (ArgList Args)
 Add a new outmost level to the multi-level template argument list. More...
 
void addOuterRetainedLevel ()
 Add an outermost level that we are not substituting. More...
 
void addOuterRetainedLevels (unsigned Num)
 
const ArgListgetInnermost () const
 Retrieve the innermost template argument list. More...
 

Detailed Description

Data structure that captures multiple levels of template argument lists for use in template instantiation.

Multiple levels of template arguments occur when instantiating the definitions of member templates. For example:

template<typename T>
struct X {
template<T Value>
struct Y {
void f();
};
};

When instantiating X<int>::Y<17>::f, the multi-level template argument list will contain a template argument list (int) at depth 0 and a template argument list (17) at depth 1.

Definition at line 75 of file Template.h.

Constructor & Destructor Documentation

◆ MultiLevelTemplateArgumentList() [1/2]

clang::MultiLevelTemplateArgumentList::MultiLevelTemplateArgumentList ( )
default

Construct an empty set of template argument lists.

◆ MultiLevelTemplateArgumentList() [2/2]

clang::MultiLevelTemplateArgumentList::MultiLevelTemplateArgumentList ( const TemplateArgumentList TemplateArgs)
inlineexplicit

Construct a single-level template argument list.

Definition at line 96 of file Template.h.

References addOuterTemplateArguments().

Member Function Documentation

◆ addOuterRetainedLevel()

void clang::MultiLevelTemplateArgumentList::addOuterRetainedLevel ( )
inline

Add an outermost level that we are not substituting.

We have no arguments at this level, and do not remove it from the depth of inner template parameters that we instantiate.

Definition at line 189 of file Template.h.

◆ addOuterRetainedLevels()

void clang::MultiLevelTemplateArgumentList::addOuterRetainedLevels ( unsigned  Num)
inline

Definition at line 192 of file Template.h.

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

◆ addOuterTemplateArguments() [1/2]

void clang::MultiLevelTemplateArgumentList::addOuterTemplateArguments ( ArgList  Args)
inline

Add a new outmost level to the multi-level template argument list.

Definition at line 180 of file Template.h.

◆ addOuterTemplateArguments() [2/2]

void clang::MultiLevelTemplateArgumentList::addOuterTemplateArguments ( const TemplateArgumentList TemplateArgs)
inline

Add a new outermost level to the multi-level template argument list.

Definition at line 173 of file Template.h.

References clang::TemplateArgumentList::data(), and clang::TemplateArgumentList::size().

Referenced by clang::Sema::BuildVarTemplateInstantiation(), MultiLevelTemplateArgumentList(), and SubstDefaultTemplateArgument().

◆ getInnermost()

const ArgList& clang::MultiLevelTemplateArgumentList::getInnermost ( ) const
inline

◆ getKind()

TemplateSubstitutionKind clang::MultiLevelTemplateArgumentList::getKind ( ) const
inline

Determine the kind of template substitution being performed.

Definition at line 103 of file Template.h.

◆ getNewDepth()

unsigned clang::MultiLevelTemplateArgumentList::getNewDepth ( unsigned  OldDepth) const
inline

Determine how many of the OldDepth outermost template parameter lists would be removed by substituting these arguments.

Definition at line 130 of file Template.h.

References getNumLevels().

◆ getNumLevels()

unsigned clang::MultiLevelTemplateArgumentList::getNumLevels ( ) const
inline

Determine the number of levels in this template argument list.

Definition at line 114 of file Template.h.

Referenced by getNewDepth().

◆ getNumRetainedOuterLevels()

unsigned clang::MultiLevelTemplateArgumentList::getNumRetainedOuterLevels ( ) const
inline

Definition at line 124 of file Template.h.

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

◆ getNumSubstitutedLevels()

unsigned clang::MultiLevelTemplateArgumentList::getNumSubstitutedLevels ( ) const
inline

Determine the number of substituted levels in this template argument list.

Definition at line 120 of file Template.h.

◆ hasTemplateArgument()

bool clang::MultiLevelTemplateArgumentList::hasTemplateArgument ( unsigned  Depth,
unsigned  Index 
) const
inline

Determine whether there is a non-NULL template argument at the given depth and index.

There must exist a template argument list at the given depth.

Definition at line 149 of file Template.h.

◆ isRewrite()

bool clang::MultiLevelTemplateArgumentList::isRewrite ( ) const
inline

Determine whether we are rewriting template parameters rather than substituting for them.

If so, we should not leave references to the original template parameters behind.

Definition at line 108 of file Template.h.

References clang::Rewrite.

◆ operator()()

const TemplateArgument& clang::MultiLevelTemplateArgumentList::operator() ( unsigned  Depth,
unsigned  Index 
) const
inline

Retrieve the template argument at a given depth and index.

Definition at line 139 of file Template.h.

◆ setArgument()

void clang::MultiLevelTemplateArgumentList::setArgument ( unsigned  Depth,
unsigned  Index,
TemplateArgument  Arg 
)
inline

Clear out a specific template argument.

Definition at line 162 of file Template.h.

◆ setKind()

void clang::MultiLevelTemplateArgumentList::setKind ( TemplateSubstitutionKind  K)
inline

Definition at line 100 of file Template.h.

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


The documentation for this class was generated from the following file:
clang::tooling::X
static ToolExecutorPluginRegistry::Add< AllTUsToolExecutorPlugin > X("all-TUs", "Runs FrontendActions on all TUs in the compilation database. " "Tool results are stored in memory.")