Thanks to visit codestin.com
Credit goes to clang.llvm.org

clang 22.0.0git
Template.h
Go to the documentation of this file.
1//===- SemaTemplate.h - C++ Templates ---------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//===----------------------------------------------------------------------===//
7//
8// This file provides types used in the semantic analysis of C++ templates.
9//
10//===----------------------------------------------------------------------===//
11
12#ifndef LLVM_CLANG_SEMA_TEMPLATE_H
13#define LLVM_CLANG_SEMA_TEMPLATE_H
14
18#include "clang/AST/Type.h"
19#include "clang/Basic/LLVM.h"
20#include "clang/Sema/Sema.h"
21#include "llvm/ADT/ArrayRef.h"
22#include "llvm/ADT/DenseMap.h"
23#include "llvm/ADT/PointerUnion.h"
24#include "llvm/ADT/SmallVector.h"
25#include <cassert>
26#include <optional>
27#include <utility>
28
29namespace clang {
30
31class ASTContext;
32class BindingDecl;
33class CXXMethodDecl;
34class Decl;
35class DeclaratorDecl;
36class DeclContext;
37class EnumDecl;
38class FunctionDecl;
39class NamedDecl;
40class ParmVarDecl;
41class TagDecl;
42class TypedefNameDecl;
43class TypeSourceInfo;
44class VarDecl;
45
46/// The kind of template substitution being performed.
47enum class TemplateSubstitutionKind : char {
48 /// We are substituting template parameters for template arguments in order
49 /// to form a template specialization.
51 /// We are substituting template parameters for (typically) other template
52 /// parameters in order to rewrite a declaration as a different declaration
53 /// (for example, when forming a deduction guide from a constructor).
55};
56
57 /// Data structure that captures multiple levels of template argument
58 /// lists for use in template instantiation.
59 ///
60 /// Multiple levels of template arguments occur when instantiating the
61 /// definitions of member templates. For example:
62 ///
63 /// \code
64 /// template<typename T>
65 /// struct X {
66 /// template<T Value>
67 /// struct Y {
68 /// void f();
69 /// };
70 /// };
71 /// \endcode
72 ///
73 /// When instantiating X<int>::Y<17>::f, the multi-level template argument
74 /// list will contain a template argument list (int) at depth 0 and a
75 /// template argument list (17) at depth 1.
77 /// The template argument list at a certain template depth
78
79 using ArgList = ArrayRef<TemplateArgument>;
80 struct ArgumentListLevel {
81 llvm::PointerIntPair<Decl *, 1, bool> AssociatedDeclAndFinal;
82 ArgList Args;
83 };
84 using ContainerType = SmallVector<ArgumentListLevel, 4>;
85
86 using ArgListsIterator = ContainerType::iterator;
87 using ConstArgListsIterator = ContainerType::const_iterator;
88
89 /// The template argument lists, stored from the innermost template
90 /// argument list (first) to the outermost template argument list (last).
91 ContainerType TemplateArgumentLists;
92
93 /// The number of outer levels of template arguments that are not
94 /// being substituted.
95 unsigned NumRetainedOuterLevels = 0;
96
97 /// The kind of substitution described by this argument list.
99
100 public:
101 /// Construct an empty set of template argument lists.
103
104 /// Construct a single-level template argument list.
105 MultiLevelTemplateArgumentList(Decl *D, ArgList Args, bool Final) {
106 addOuterTemplateArguments(D, Args, Final);
107 }
108
109 void setKind(TemplateSubstitutionKind K) { Kind = K; }
110
111 /// Determine the kind of template substitution being performed.
112 TemplateSubstitutionKind getKind() const { return Kind; }
113
114 /// Determine whether we are rewriting template parameters rather than
115 /// substituting for them. If so, we should not leave references to the
116 /// original template parameters behind.
117 bool isRewrite() const {
119 }
120
121 /// Determine the number of levels in this template argument
122 /// list.
123 unsigned getNumLevels() const {
124 return TemplateArgumentLists.size() + NumRetainedOuterLevels;
125 }
126
127 /// Determine the number of substituted levels in this template
128 /// argument list.
129 unsigned getNumSubstitutedLevels() const {
130 return TemplateArgumentLists.size();
131 }
132
133 // Determine the number of substituted args at 'Depth'.
134 unsigned getNumSubsitutedArgs(unsigned Depth) const {
135 assert(NumRetainedOuterLevels <= Depth && Depth < getNumLevels());
136 return TemplateArgumentLists[getNumLevels() - Depth - 1].Args.size();
137 }
138
139 unsigned getNumRetainedOuterLevels() const {
140 return NumRetainedOuterLevels;
141 }
142
143 /// Determine how many of the \p OldDepth outermost template parameter
144 /// lists would be removed by substituting these arguments.
145 unsigned getNewDepth(unsigned OldDepth) const {
146 if (OldDepth < NumRetainedOuterLevels)
147 return OldDepth;
148 if (OldDepth < getNumLevels())
149 return NumRetainedOuterLevels;
150 return OldDepth - TemplateArgumentLists.size();
151 }
152
153 /// Retrieve the template argument at a given depth and index.
154 const TemplateArgument &operator()(unsigned Depth, unsigned Index) const {
155 assert(NumRetainedOuterLevels <= Depth && Depth < getNumLevels());
156 assert(Index <
157 TemplateArgumentLists[getNumLevels() - Depth - 1].Args.size());
158 return TemplateArgumentLists[getNumLevels() - Depth - 1].Args[Index];
159 }
160
161 /// A template-like entity which owns the whole pattern being substituted.
162 /// This will usually own a set of template parameters, or in some
163 /// cases might even be a template parameter itself.
164 std::pair<Decl *, bool> getAssociatedDecl(unsigned Depth) const {
165 assert(NumRetainedOuterLevels <= Depth && Depth < getNumLevels());
166 auto AD = TemplateArgumentLists[getNumLevels() - Depth - 1]
167 .AssociatedDeclAndFinal;
168 return {AD.getPointer(), AD.getInt()};
169 }
170
171 /// Determine whether there is a non-NULL template argument at the
172 /// given depth and index.
173 ///
174 /// There must exist a template argument list at the given depth.
175 bool hasTemplateArgument(unsigned Depth, unsigned Index) const {
176 assert(Depth < getNumLevels());
177
178 if (Depth < NumRetainedOuterLevels)
179 return false;
180
181 if (Index >=
182 TemplateArgumentLists[getNumLevels() - Depth - 1].Args.size())
183 return false;
184
185 return !(*this)(Depth, Index).isNull();
186 }
187
189 for (ArgumentListLevel ListLevel : TemplateArgumentLists)
190 for (const TemplateArgument &TA : ListLevel.Args)
192 return true;
193 return false;
194 }
195
196 /// Clear out a specific template argument.
197 void setArgument(unsigned Depth, unsigned Index,
198 TemplateArgument Arg) {
199 assert(NumRetainedOuterLevels <= Depth && Depth < getNumLevels());
200 assert(Index <
201 TemplateArgumentLists[getNumLevels() - Depth - 1].Args.size());
202 const_cast<TemplateArgument &>(
203 TemplateArgumentLists[getNumLevels() - Depth - 1].Args[Index]) = Arg;
204 }
205
206 /// Add a new outmost level to the multi-level template argument
207 /// list.
208 /// A 'Final' substitution means that Subst* nodes won't be built
209 /// for the replacements.
210 void addOuterTemplateArguments(Decl *AssociatedDecl, ArgList Args,
211 bool Final) {
212 assert(!NumRetainedOuterLevels &&
213 "substituted args outside retained args?");
215 TemplateArgumentLists.push_back(
216 {{AssociatedDecl ? AssociatedDecl->getCanonicalDecl() : nullptr,
217 Final},
218 Args});
219 }
220
221 void addOuterTemplateArguments(ArgList Args) {
222 assert(!NumRetainedOuterLevels &&
223 "substituted args outside retained args?");
225 TemplateArgumentLists.push_back({{}, Args});
226 }
227
228 void addOuterTemplateArguments(std::nullopt_t) {
229 assert(!NumRetainedOuterLevels &&
230 "substituted args outside retained args?");
231 TemplateArgumentLists.push_back({});
232 }
233
234 /// Replaces the current 'innermost' level with the provided argument list.
235 /// This is useful for type deduction cases where we need to get the entire
236 /// list from the AST, but then add the deduced innermost list.
237 void replaceInnermostTemplateArguments(Decl *AssociatedDecl, ArgList Args,
238 bool Final = false) {
239 assert((!TemplateArgumentLists.empty() || NumRetainedOuterLevels) &&
240 "Replacing in an empty list?");
241
242 if (!TemplateArgumentLists.empty()) {
243 TemplateArgumentLists[0].Args = Args;
244 return;
245 }
246 --NumRetainedOuterLevels;
247 TemplateArgumentLists.push_back(
248 {{AssociatedDecl, /*Final=*/Final}, Args});
249 }
250
251 void replaceOutermostTemplateArguments(Decl *AssociatedDecl, ArgList Args) {
252 assert((!TemplateArgumentLists.empty()) && "Replacing in an empty list?");
253 TemplateArgumentLists.back().AssociatedDeclAndFinal.setPointer(
254 AssociatedDecl);
255 TemplateArgumentLists.back().Args = Args;
256 }
257
258 /// Add an outermost level that we are not substituting. We have no
259 /// arguments at this level, and do not remove it from the depth of inner
260 /// template parameters that we instantiate.
262 ++NumRetainedOuterLevels;
263 }
265 NumRetainedOuterLevels += Num;
266 }
267
268 /// Retrieve the innermost template argument list.
269 const ArgList &getInnermost() const {
270 return TemplateArgumentLists.front().Args;
271 }
272 /// Retrieve the outermost template argument list.
273 const ArgList &getOutermost() const {
274 return TemplateArgumentLists.back().Args;
275 }
276 ArgListsIterator begin() { return TemplateArgumentLists.begin(); }
277 ConstArgListsIterator begin() const {
278 return TemplateArgumentLists.begin();
279 }
280 ArgListsIterator end() { return TemplateArgumentLists.end(); }
281 ConstArgListsIterator end() const { return TemplateArgumentLists.end(); }
282
283 LLVM_DUMP_METHOD void dump() const {
284 LangOptions LO;
285 LO.CPlusPlus = true;
286 LO.Bool = true;
287 PrintingPolicy PP(LO);
288 llvm::errs() << "NumRetainedOuterLevels: " << NumRetainedOuterLevels
289 << "\n";
290 for (unsigned Depth = NumRetainedOuterLevels; Depth < getNumLevels();
291 ++Depth) {
292 llvm::errs() << Depth << ": ";
293 printTemplateArgumentList(
294 llvm::errs(),
295 TemplateArgumentLists[getNumLevels() - Depth - 1].Args, PP);
296 llvm::errs() << "\n";
297 }
298 }
299 };
300
301 /// The context in which partial ordering of function templates occurs.
302 enum TPOC {
303 /// Partial ordering of function templates for a function call.
305
306 /// Partial ordering of function templates for a call to a
307 /// conversion function.
309
310 /// Partial ordering of function templates in other contexts, e.g.,
311 /// taking the address of a function template or matching a function
312 /// template specialization to a function template.
314 };
315
316 // This is lame but unavoidable in a world without forward
317 // declarations of enums. The alternatives are to either pollute
318 // Sema.h (by including this file) or sacrifice type safety (by
319 // making Sema.h declare things as enums).
321 TPOC Value;
322
323 public:
324 TemplatePartialOrderingContext(TPOC Value) : Value(Value) {}
325
326 operator TPOC() const { return Value; }
327 };
328
329 /// Captures a template argument whose value has been deduced
330 /// via c++ template argument deduction.
332 /// For a non-type template argument, whether the value was
333 /// deduced from an array bound.
334 bool DeducedFromArrayBound = false;
335
336 public:
338
340 bool DeducedFromArrayBound = false)
341 : TemplateArgument(Arg), DeducedFromArrayBound(DeducedFromArrayBound) {}
342
343 /// Construct an integral non-type template argument that
344 /// has been deduced, possibly from an array bound.
346 const llvm::APSInt &Value,
347 QualType ValueType,
348 bool DeducedFromArrayBound)
349 : TemplateArgument(Ctx, Value, ValueType),
350 DeducedFromArrayBound(DeducedFromArrayBound) {}
351
352 /// For a non-type template argument, determine whether the
353 /// template argument was deduced from an array bound.
354 bool wasDeducedFromArrayBound() const { return DeducedFromArrayBound; }
355
356 /// Specify whether the given non-type template argument
357 /// was deduced from an array bound.
358 void setDeducedFromArrayBound(bool Deduced) {
359 DeducedFromArrayBound = Deduced;
360 }
361 };
362
363 /// A stack-allocated class that identifies which local
364 /// variable declaration instantiations are present in this scope.
365 ///
366 /// A new instance of this class type will be created whenever we
367 /// instantiate a new function declaration, which will have its own
368 /// set of parameter declarations.
370 public:
371 /// A set of declarations.
373
374 private:
375 /// Reference to the semantic analysis that is performing
376 /// this template instantiation.
377 Sema &SemaRef;
378
379 using LocalDeclsMap =
380 llvm::SmallDenseMap<const Decl *,
381 llvm::PointerUnion<Decl *, DeclArgumentPack *>, 4>;
382
383 /// A mapping from local declarations that occur
384 /// within a template to their instantiations.
385 ///
386 /// This mapping is used during instantiation to keep track of,
387 /// e.g., function parameter and variable declarations. For example,
388 /// given:
389 ///
390 /// \code
391 /// template<typename T> T add(T x, T y) { return x + y; }
392 /// \endcode
393 ///
394 /// when we instantiate add<int>, we will introduce a mapping from
395 /// the ParmVarDecl for 'x' that occurs in the template to the
396 /// instantiated ParmVarDecl for 'x'.
397 ///
398 /// For a parameter pack, the local instantiation scope may contain a
399 /// set of instantiated parameters. This is stored as a DeclArgumentPack
400 /// pointer.
401 LocalDeclsMap LocalDecls;
402
403 /// The set of argument packs we've allocated.
405
406 /// The outer scope, which contains local variable
407 /// definitions from some other instantiation (that may not be
408 /// relevant to this particular scope).
410
411 /// Whether we have already exited this scope.
412 bool Exited = false;
413
414 /// Whether to combine this scope with the outer scope, such that
415 /// lookup will search our outer scope.
416 bool CombineWithOuterScope;
417
418 /// Whether this scope is being used to instantiate a lambda or block
419 /// expression, in which case it should be reused for instantiating the
420 /// lambda's FunctionProtoType.
421 bool InstantiatingLambdaOrBlock = false;
422
423 /// If non-NULL, the template parameter pack that has been
424 /// partially substituted per C++0x [temp.arg.explicit]p9.
425 NamedDecl *PartiallySubstitutedPack = nullptr;
426
427 /// If \c PartiallySubstitutedPack is non-null, the set of
428 /// explicitly-specified template arguments in that pack.
429 const TemplateArgument *ArgsInPartiallySubstitutedPack;
430
431 /// If \c PartiallySubstitutedPack, the number of
432 /// explicitly-specified template arguments in
433 /// ArgsInPartiallySubstitutedPack.
434 unsigned NumArgsInPartiallySubstitutedPack;
435
436 public:
437 LocalInstantiationScope(Sema &SemaRef, bool CombineWithOuterScope = false,
438 bool InstantiatingLambdaOrBlock = false)
439 : SemaRef(SemaRef), Outer(SemaRef.CurrentInstantiationScope),
440 CombineWithOuterScope(CombineWithOuterScope),
441 InstantiatingLambdaOrBlock(InstantiatingLambdaOrBlock) {
442 SemaRef.CurrentInstantiationScope = this;
443 }
444
448
452
453 const Sema &getSema() const { return SemaRef; }
454
455 /// Exit this local instantiation scope early.
456 void Exit() {
457 if (Exited)
458 return;
459
460 for (unsigned I = 0, N = ArgumentPacks.size(); I != N; ++I)
461 delete ArgumentPacks[I];
462
463 SemaRef.CurrentInstantiationScope = Outer;
464 Exited = true;
465 }
466
467 /// Clone this scope, and all outer scopes, down to the given
468 /// outermost scope.
470 if (this == Outermost) return this;
471
472 // Save the current scope from SemaRef since the LocalInstantiationScope
473 // will overwrite it on construction
474 LocalInstantiationScope *oldScope = SemaRef.CurrentInstantiationScope;
475
476 LocalInstantiationScope *newScope =
477 new LocalInstantiationScope(SemaRef, CombineWithOuterScope);
478
479 newScope->Outer = nullptr;
480 if (Outer)
481 newScope->Outer = Outer->cloneScopes(Outermost);
482
483 newScope->PartiallySubstitutedPack = PartiallySubstitutedPack;
484 newScope->ArgsInPartiallySubstitutedPack = ArgsInPartiallySubstitutedPack;
485 newScope->NumArgsInPartiallySubstitutedPack =
486 NumArgsInPartiallySubstitutedPack;
487
488 for (LocalDeclsMap::iterator I = LocalDecls.begin(), E = LocalDecls.end();
489 I != E; ++I) {
490 const Decl *D = I->first;
491 llvm::PointerUnion<Decl *, DeclArgumentPack *> &Stored =
492 newScope->LocalDecls[D];
493 if (auto *D2 = dyn_cast<Decl *>(I->second)) {
494 Stored = D2;
495 } else {
496 DeclArgumentPack *OldPack = cast<DeclArgumentPack *>(I->second);
497 DeclArgumentPack *NewPack = new DeclArgumentPack(*OldPack);
498 Stored = NewPack;
499 newScope->ArgumentPacks.push_back(NewPack);
500 }
501 }
502 // Restore the saved scope to SemaRef
503 SemaRef.CurrentInstantiationScope = oldScope;
504 return newScope;
505 }
506
507 /// deletes the given scope, and all outer scopes, down to the
508 /// given outermost scope.
510 LocalInstantiationScope *Outermost) {
511 while (Scope && Scope != Outermost) {
512 LocalInstantiationScope *Out = Scope->Outer;
513 delete Scope;
514 Scope = Out;
515 }
516 }
517
518 /// Find the instantiation of the declaration D within the current
519 /// instantiation scope.
520 ///
521 /// \param D The declaration whose instantiation we are searching for.
522 ///
523 /// \returns A pointer to the declaration or argument pack of declarations
524 /// to which the declaration \c D is instantiated, if found. Otherwise,
525 /// returns NULL.
526 llvm::PointerUnion<Decl *, DeclArgumentPack *> *
527 findInstantiationOf(const Decl *D);
528
529 /// Similar to \p findInstantiationOf(), but it wouldn't assert if the
530 /// instantiation was not found within the current instantiation scope. This
531 /// is helpful for on-demand declaration instantiation.
532 llvm::PointerUnion<Decl *, DeclArgumentPack *> *
534
535 void InstantiatedLocal(const Decl *D, Decl *Inst);
536 void InstantiatedLocalPackArg(const Decl *D, VarDecl *Inst);
537 void MakeInstantiatedLocalArgPack(const Decl *D);
538
539 /// Note that the given parameter pack has been partially substituted
540 /// via explicit specification of template arguments
541 /// (C++0x [temp.arg.explicit]p9).
542 ///
543 /// \param Pack The parameter pack, which will always be a template
544 /// parameter pack.
545 ///
546 /// \param ExplicitArgs The explicitly-specified template arguments provided
547 /// for this parameter pack.
548 ///
549 /// \param NumExplicitArgs The number of explicitly-specified template
550 /// arguments provided for this parameter pack.
552 const TemplateArgument *ExplicitArgs,
553 unsigned NumExplicitArgs);
554
555 /// Reset the partially-substituted pack when it is no longer of
556 /// interest.
558 assert(PartiallySubstitutedPack && "No partially-substituted pack");
559 PartiallySubstitutedPack = nullptr;
560 ArgsInPartiallySubstitutedPack = nullptr;
561 NumArgsInPartiallySubstitutedPack = 0;
562 }
563
564 /// Retrieve the partially-substitued template parameter pack.
565 ///
566 /// If there is no partially-substituted parameter pack, returns NULL.
567 NamedDecl *
568 getPartiallySubstitutedPack(const TemplateArgument **ExplicitArgs = nullptr,
569 unsigned *NumExplicitArgs = nullptr) const;
570
571 /// Determine whether D is a pack expansion created in this scope.
572 bool isLocalPackExpansion(const Decl *D);
573
574 /// Determine whether this scope is for instantiating a lambda or block.
575 bool isLambdaOrBlock() const { return InstantiatingLambdaOrBlock; }
576 };
577
579 : public DeclVisitor<TemplateDeclInstantiator, Decl *>
580 {
581 Sema &SemaRef;
583 DeclContext *Owner;
584 const MultiLevelTemplateArgumentList &TemplateArgs;
585 Sema::LateInstantiatedAttrVec* LateAttrs = nullptr;
586 LocalInstantiationScope *StartingScope = nullptr;
587 // Whether to evaluate the C++20 constraints or simply substitute into them.
588 bool EvaluateConstraints = true;
589
590 /// A list of out-of-line class template partial
591 /// specializations that will need to be instantiated after the
592 /// enclosing class's instantiation is complete.
593 SmallVector<std::pair<ClassTemplateDecl *,
595 1>
596 OutOfLinePartialSpecs;
597
598 /// A list of out-of-line variable template partial
599 /// specializations that will need to be instantiated after the
600 /// enclosing variable's instantiation is complete.
601 /// FIXME: Verify that this is needed.
603 std::pair<VarTemplateDecl *, VarTemplatePartialSpecializationDecl *>, 1>
604 OutOfLineVarPartialSpecs;
605
606 public:
608 const MultiLevelTemplateArgumentList &TemplateArgs)
609 : SemaRef(SemaRef), SubstIndex(SemaRef, SemaRef.ArgPackSubstIndex),
610 Owner(Owner), TemplateArgs(TemplateArgs) {}
611
613 EvaluateConstraints = B;
614 }
616 return EvaluateConstraints;
617 }
618
619// Define all the decl visitors using DeclNodes.inc
620#define DECL(DERIVED, BASE) \
621 Decl *Visit ## DERIVED ## Decl(DERIVED ## Decl *D);
622#define ABSTRACT_DECL(DECL)
623
624// Decls which never appear inside a class or function.
625#define OBJCCONTAINER(DERIVED, BASE)
626#define FILESCOPEASM(DERIVED, BASE)
627#define TOPLEVELSTMT(DERIVED, BASE)
628#define IMPORT(DERIVED, BASE)
629#define EXPORT(DERIVED, BASE)
630#define LINKAGESPEC(DERIVED, BASE)
631#define OBJCCOMPATIBLEALIAS(DERIVED, BASE)
632#define OBJCMETHOD(DERIVED, BASE)
633#define OBJCTYPEPARAM(DERIVED, BASE)
634#define OBJCIVAR(DERIVED, BASE)
635#define OBJCPROPERTY(DERIVED, BASE)
636#define OBJCPROPERTYIMPL(DERIVED, BASE)
637#define EMPTY(DERIVED, BASE)
638#define LIFETIMEEXTENDEDTEMPORARY(DERIVED, BASE)
639
640// Decls which never appear inside a template.
641#define OUTLINEDFUNCTION(DERIVED, BASE)
642
643// Decls which use special-case instantiation code.
644#define BLOCK(DERIVED, BASE)
645#define CAPTURED(DERIVED, BASE)
646#define IMPLICITPARAM(DERIVED, BASE)
647
648#include "clang/AST/DeclNodes.inc"
649
651
653 TypeSourceInfo *&TInfo,
654 DeclarationNameInfo &NameInfo);
655
656 // A few supplemental visitor functions.
658 TemplateParameterList *TemplateParams,
661 TemplateParameterList *TemplateParams,
663 Decl *VisitDecl(Decl *D);
664 Decl *VisitVarDecl(VarDecl *D, bool InstantiatingVarTemplate,
667 LookupResult *Lookup);
668
669 // Enable late instantiation of attributes. Late instantiated attributes
670 // will be stored in LA.
672 LateAttrs = LA;
673 StartingScope = SemaRef.CurrentInstantiationScope;
674 }
675
676 // Disable late instantiation of attributes.
678 LateAttrs = nullptr;
679 StartingScope = nullptr;
680 }
681
682 LocalInstantiationScope *getStartingScope() const { return StartingScope; }
683
686
689
690 /// Return an iterator to the beginning of the set of
691 /// "delayed" partial specializations, which must be passed to
692 /// InstantiateClassTemplatePartialSpecialization once the class
693 /// definition has been completed.
695 return OutOfLinePartialSpecs.begin();
696 }
697
699 return OutOfLineVarPartialSpecs.begin();
700 }
701
702 /// Return an iterator to the end of the set of
703 /// "delayed" partial specializations, which must be passed to
704 /// InstantiateClassTemplatePartialSpecialization once the class
705 /// definition has been completed.
707 return OutOfLinePartialSpecs.end();
708 }
709
711 return OutOfLineVarPartialSpecs.end();
712 }
713
714 // Helper functions for instantiating methods.
719
721
724
725 bool SubstQualifier(const DeclaratorDecl *OldDecl,
726 DeclaratorDecl *NewDecl);
727 bool SubstQualifier(const TagDecl *OldDecl,
728 TagDecl *NewDecl);
729
733 VarTemplateSpecializationDecl *PrevDecl = nullptr);
734
735 Decl *InstantiateTypedefNameDecl(TypedefNameDecl *D, bool IsTypeAlias);
739 ClassTemplateDecl *ClassTemplate,
746
747 private:
748 template<typename T>
749 Decl *instantiateUnresolvedUsingDecl(T *D,
750 bool InstantiatingPackElement = false);
751 };
752
753} // namespace clang
754
755#endif // LLVM_CLANG_SEMA_TEMPLATE_H
Defines the C++ template declaration subclasses.
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
llvm::SmallVector< std::pair< const MemRegion *, SVal >, 4 > Bindings
C Language Family Type Representation.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition ASTContext.h:220
Represents a C++ declaration that introduces decls from somewhere else.
Definition DeclCXX.h:3496
A binding in a decomposition declaration.
Definition DeclCXX.h:4185
Represents a static or instance method of a struct/union/class.
Definition DeclCXX.h:2129
Declaration of a class template.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition DeclBase.h:1449
A simple visitor class that helps create declaration visitors.
Definition DeclVisitor.h:68
Decl - This represents one declaration (or definition), e.g.
Definition DeclBase.h:86
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition DeclBase.h:978
Represents a ValueDecl that came out of a declarator.
Definition Decl.h:780
void setDeducedFromArrayBound(bool Deduced)
Specify whether the given non-type template argument was deduced from an array bound.
Definition Template.h:358
DeducedTemplateArgument(const TemplateArgument &Arg, bool DeducedFromArrayBound=false)
Definition Template.h:339
DeducedTemplateArgument(ASTContext &Ctx, const llvm::APSInt &Value, QualType ValueType, bool DeducedFromArrayBound)
Construct an integral non-type template argument that has been deduced, possibly from an array bound.
Definition Template.h:345
bool wasDeducedFromArrayBound() const
For a non-type template argument, determine whether the template argument was deduced from an array b...
Definition Template.h:354
Represents an enum.
Definition Decl.h:4007
Represents a function declaration or definition.
Definition Decl.h:2000
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
A stack-allocated class that identifies which local variable declaration instantiations are present i...
Definition Template.h:369
LocalInstantiationScope(Sema &SemaRef, bool CombineWithOuterScope=false, bool InstantiatingLambdaOrBlock=false)
Definition Template.h:437
LocalInstantiationScope & operator=(const LocalInstantiationScope &)=delete
LocalInstantiationScope(const LocalInstantiationScope &)=delete
void SetPartiallySubstitutedPack(NamedDecl *Pack, const TemplateArgument *ExplicitArgs, unsigned NumExplicitArgs)
Note that the given parameter pack has been partially substituted via explicit specification of templ...
NamedDecl * getPartiallySubstitutedPack(const TemplateArgument **ExplicitArgs=nullptr, unsigned *NumExplicitArgs=nullptr) const
Retrieve the partially-substitued template parameter pack.
void Exit()
Exit this local instantiation scope early.
Definition Template.h:456
bool isLocalPackExpansion(const Decl *D)
Determine whether D is a pack expansion created in this scope.
SmallVector< ValueDecl *, 4 > DeclArgumentPack
A set of declarations.
Definition Template.h:372
llvm::PointerUnion< Decl *, DeclArgumentPack * > * getInstantiationOfIfExists(const Decl *D)
Similar to findInstantiationOf(), but it wouldn't assert if the instantiation was not found within th...
static void deleteScopes(LocalInstantiationScope *Scope, LocalInstantiationScope *Outermost)
deletes the given scope, and all outer scopes, down to the given outermost scope.
Definition Template.h:509
const Sema & getSema() const
Definition Template.h:453
void InstantiatedLocal(const Decl *D, Decl *Inst)
void InstantiatedLocalPackArg(const Decl *D, VarDecl *Inst)
void ResetPartiallySubstitutedPack()
Reset the partially-substituted pack when it is no longer of interest.
Definition Template.h:557
bool isLambdaOrBlock() const
Determine whether this scope is for instantiating a lambda or block.
Definition Template.h:575
LocalInstantiationScope * cloneScopes(LocalInstantiationScope *Outermost)
Clone this scope, and all outer scopes, down to the given outermost scope.
Definition Template.h:469
llvm::PointerUnion< Decl *, DeclArgumentPack * > * findInstantiationOf(const Decl *D)
Find the instantiation of the declaration D within the current instantiation scope.
Represents the results of name lookup.
Definition Lookup.h:147
Data structure that captures multiple levels of template argument lists for use in template instantia...
Definition Template.h:76
bool hasTemplateArgument(unsigned Depth, unsigned Index) const
Determine whether there is a non-NULL template argument at the given depth and index.
Definition Template.h:175
ConstArgListsIterator end() const
Definition Template.h:281
const ArgList & getInnermost() const
Retrieve the innermost template argument list.
Definition Template.h:269
unsigned getNumSubsitutedArgs(unsigned Depth) const
Definition Template.h:134
std::pair< Decl *, bool > getAssociatedDecl(unsigned Depth) const
A template-like entity which owns the whole pattern being substituted.
Definition Template.h:164
void addOuterRetainedLevel()
Add an outermost level that we are not substituting.
Definition Template.h:261
ConstArgListsIterator begin() const
Definition Template.h:277
LLVM_DUMP_METHOD void dump() const
Definition Template.h:283
MultiLevelTemplateArgumentList(Decl *D, ArgList Args, bool Final)
Construct a single-level template argument list.
Definition Template.h:105
TemplateSubstitutionKind getKind() const
Determine the kind of template substitution being performed.
Definition Template.h:112
void addOuterTemplateArguments(Decl *AssociatedDecl, ArgList Args, bool Final)
Add a new outmost level to the multi-level template argument list.
Definition Template.h:210
unsigned getNumLevels() const
Determine the number of levels in this template argument list.
Definition Template.h:123
void setKind(TemplateSubstitutionKind K)
Definition Template.h:109
unsigned getNumSubstitutedLevels() const
Determine the number of substituted levels in this template argument list.
Definition Template.h:129
const TemplateArgument & operator()(unsigned Depth, unsigned Index) const
Retrieve the template argument at a given depth and index.
Definition Template.h:154
void replaceOutermostTemplateArguments(Decl *AssociatedDecl, ArgList Args)
Definition Template.h:251
const ArgList & getOutermost() const
Retrieve the outermost template argument list.
Definition Template.h:273
void addOuterRetainedLevels(unsigned Num)
Definition Template.h:264
MultiLevelTemplateArgumentList()=default
Construct an empty set of template argument lists.
unsigned getNumRetainedOuterLevels() const
Definition Template.h:139
unsigned getNewDepth(unsigned OldDepth) const
Determine how many of the OldDepth outermost template parameter lists would be removed by substitutin...
Definition Template.h:145
void setArgument(unsigned Depth, unsigned Index, TemplateArgument Arg)
Clear out a specific template argument.
Definition Template.h:197
void addOuterTemplateArguments(std::nullopt_t)
Definition Template.h:228
void replaceInnermostTemplateArguments(Decl *AssociatedDecl, ArgList Args, bool Final=false)
Replaces the current 'innermost' level with the provided argument list.
Definition Template.h:237
void addOuterTemplateArguments(ArgList Args)
Definition Template.h:221
bool isRewrite() const
Determine whether we are rewriting template parameters rather than substituting for them.
Definition Template.h:117
This represents a decl that may have a name.
Definition Decl.h:274
Represents a parameter to a function.
Definition Decl.h:1790
A (possibly-)qualified type.
Definition TypeBase.h:937
Scope - A scope is a transient data structure that is used while parsing the program.
Definition Scope.h:41
RAII object used to change the argument pack substitution index within a Sema object.
Definition Sema.h:13552
Sema - This implements semantic analysis and AST building for C.
Definition Sema.h:854
SmallVector< LateInstantiatedAttribute, 1 > LateInstantiatedAttrVec
Definition Sema.h:14025
Represents the declaration of a struct/union/class/enum.
Definition Decl.h:3717
Represents a template argument.
bool isInstantiationDependent() const
Whether this template argument is dependent on a template parameter.
constexpr TemplateArgument()
Construct an empty, invalid template argument.
void enableLateAttributeInstantiation(Sema::LateInstantiatedAttrVec *LA)
Definition Template.h:671
SmallVectorImpl< std::pair< ClassTemplateDecl *, ClassTemplatePartialSpecializationDecl * > >::iterator delayed_partial_spec_iterator
Definition Template.h:684
delayed_var_partial_spec_iterator delayed_var_partial_spec_end()
Definition Template.h:710
delayed_partial_spec_iterator delayed_partial_spec_begin()
Return an iterator to the beginning of the set of "delayed" partial specializations,...
Definition Template.h:694
void setEvaluateConstraints(bool B)
Definition Template.h:612
TemplateDeclInstantiator(Sema &SemaRef, DeclContext *Owner, const MultiLevelTemplateArgumentList &TemplateArgs)
Definition Template.h:607
VarTemplateSpecializationDecl * VisitVarTemplateSpecializationDecl(VarTemplateDecl *VarTemplate, VarDecl *FromVar, ArrayRef< TemplateArgument > Converted, VarTemplateSpecializationDecl *PrevDecl=nullptr)
Decl * VisitVarDecl(VarDecl *D, bool InstantiatingVarTemplate, ArrayRef< BindingDecl * > *Bindings=nullptr)
bool InitMethodInstantiation(CXXMethodDecl *New, CXXMethodDecl *Tmpl)
Initializes common fields of an instantiated method declaration (New) from the corresponding fields o...
LocalInstantiationScope * getStartingScope() const
Definition Template.h:682
bool InitFunctionInstantiation(FunctionDecl *New, FunctionDecl *Tmpl)
Initializes the common fields of an instantiation function declaration (New) from the corresponding f...
VarTemplatePartialSpecializationDecl * InstantiateVarTemplatePartialSpecialization(VarTemplateDecl *VarTemplate, VarTemplatePartialSpecializationDecl *PartialSpec)
Instantiate the declaration of a variable template partial specialization.
void adjustForRewrite(RewriteKind RK, FunctionDecl *Orig, QualType &T, TypeSourceInfo *&TInfo, DeclarationNameInfo &NameInfo)
TypeSourceInfo * SubstFunctionType(FunctionDecl *D, SmallVectorImpl< ParmVarDecl * > &Params)
void InstantiateEnumDefinition(EnumDecl *Enum, EnumDecl *Pattern)
Decl * VisitFunctionDecl(FunctionDecl *D, TemplateParameterList *TemplateParams, RewriteKind RK=RewriteKind::None)
Normal class members are of more specific types and therefore don't make it here.
Decl * VisitCXXMethodDecl(CXXMethodDecl *D, TemplateParameterList *TemplateParams, RewriteKind RK=RewriteKind::None)
SmallVectorImpl< std::pair< VarTemplateDecl *, VarTemplatePartialSpecializationDecl * > >::iterator delayed_var_partial_spec_iterator
Definition Template.h:687
Decl * InstantiateTypeAliasTemplateDecl(TypeAliasTemplateDecl *D)
delayed_partial_spec_iterator delayed_partial_spec_end()
Return an iterator to the end of the set of "delayed" partial specializations, which must be passed t...
Definition Template.h:706
Decl * VisitBaseUsingDecls(BaseUsingDecl *D, BaseUsingDecl *Inst, LookupResult *Lookup)
bool SubstQualifier(const DeclaratorDecl *OldDecl, DeclaratorDecl *NewDecl)
TemplateParameterList * SubstTemplateParams(TemplateParameterList *List)
Instantiates a nested template parameter list in the current instantiation context.
Decl * InstantiateTypedefNameDecl(TypedefNameDecl *D, bool IsTypeAlias)
delayed_var_partial_spec_iterator delayed_var_partial_spec_begin()
Definition Template.h:698
ClassTemplatePartialSpecializationDecl * InstantiateClassTemplatePartialSpecialization(ClassTemplateDecl *ClassTemplate, ClassTemplatePartialSpecializationDecl *PartialSpec)
Instantiate the declaration of a class template partial specialization.
bool SubstDefaultedFunction(FunctionDecl *New, FunctionDecl *Tmpl)
Stores a list of template parameters for a TemplateDecl and its derived classes.
Declaration of an alias template.
A container of type source information.
Definition TypeBase.h:8265
Base class for declarations which introduce a typedef-name.
Definition Decl.h:3562
Represents a variable declaration or definition.
Definition Decl.h:926
Declaration of a variable template.
Represents a variable template specialization, which refers to a variable template with a given set o...
The JSON file list parser is used to communicate input to InstallAPI.
TemplateSubstitutionKind
The kind of template substitution being performed.
Definition Template.h:47
@ Rewrite
We are substituting template parameters for (typically) other template parameters in order to rewrite...
Definition Template.h:54
@ Specialization
We are substituting template parameters for template arguments in order to form a template specializa...
Definition Template.h:50
const FunctionProtoType * T
@ VarTemplate
The name was classified as a variable template name.
Definition Sema.h:583
TPOC
The context in which partial ordering of function templates occurs.
Definition Template.h:302
@ TPOC_Conversion
Partial ordering of function templates for a call to a conversion function.
Definition Template.h:308
@ TPOC_Other
Partial ordering of function templates in other contexts, e.g., taking the address of a function temp...
Definition Template.h:313
@ TPOC_Call
Partial ordering of function templates for a function call.
Definition Template.h:304
U cast(CodeGen::Address addr)
Definition Address.h:327
@ Enum
The "enum" keyword introduces the elaborated-type-specifier.
Definition TypeBase.h:5879
DeclarationNameInfo - A collector data type for bundling together a DeclarationName and the correspon...
Describes how types, statements, expressions, and declarations should be printed.