1 //===------- SemaTemplateInstantiate.cpp - C++ Template Instantiation ------===/
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 implements C++ template instantiation.
9 //
10 //===----------------------------------------------------------------------===/
11 
12 #include "TreeTransform.h"
13 #include "clang/AST/ASTConsumer.h"
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/ASTLambda.h"
16 #include "clang/AST/ASTMutationListener.h"
17 #include "clang/AST/DeclTemplate.h"
18 #include "clang/AST/Expr.h"
19 #include "clang/AST/PrettyDeclStackTrace.h"
20 #include "clang/AST/TypeVisitor.h"
21 #include "clang/Basic/LangOptions.h"
22 #include "clang/Basic/Stack.h"
23 #include "clang/Basic/TargetInfo.h"
24 #include "clang/Sema/DeclSpec.h"
25 #include "clang/Sema/Initialization.h"
26 #include "clang/Sema/Lookup.h"
27 #include "clang/Sema/SemaConcept.h"
28 #include "clang/Sema/SemaInternal.h"
29 #include "clang/Sema/Template.h"
30 #include "clang/Sema/TemplateDeduction.h"
31 #include "clang/Sema/TemplateInstCallback.h"
32 #include "llvm/Support/TimeProfiler.h"
33 
34 using namespace clang;
35 using namespace sema;
36 
37 //===----------------------------------------------------------------------===/
38 // Template Instantiation Support
39 //===----------------------------------------------------------------------===/
40 
41 /// Retrieve the template argument list(s) that should be used to
42 /// instantiate the definition of the given declaration.
43 ///
44 /// \param D the declaration for which we are computing template instantiation
45 /// arguments.
46 ///
47 /// \param Innermost if non-NULL, the innermost template argument list.
48 ///
49 /// \param RelativeToPrimary true if we should get the template
50 /// arguments relative to the primary template, even when we're
51 /// dealing with a specialization. This is only relevant for function
52 /// template specializations.
53 ///
54 /// \param Pattern If non-NULL, indicates the pattern from which we will be
55 /// instantiating the definition of the given declaration, \p D. This is
56 /// used to determine the proper set of template instantiation arguments for
57 /// friend function template specializations.
58 MultiLevelTemplateArgumentList
getTemplateInstantiationArgs(NamedDecl * D,const TemplateArgumentList * Innermost,bool RelativeToPrimary,const FunctionDecl * Pattern)59 Sema::getTemplateInstantiationArgs(NamedDecl *D,
60                                    const TemplateArgumentList *Innermost,
61                                    bool RelativeToPrimary,
62                                    const FunctionDecl *Pattern) {
63   // Accumulate the set of template argument lists in this structure.
64   MultiLevelTemplateArgumentList Result;
65 
66   if (Innermost)
67     Result.addOuterTemplateArguments(Innermost);
68 
69   DeclContext *Ctx = dyn_cast<DeclContext>(D);
70   if (!Ctx) {
71     Ctx = D->getDeclContext();
72 
73     // Add template arguments from a variable template instantiation. For a
74     // class-scope explicit specialization, there are no template arguments
75     // at this level, but there may be enclosing template arguments.
76     VarTemplateSpecializationDecl *Spec =
77         dyn_cast<VarTemplateSpecializationDecl>(D);
78     if (Spec && !Spec->isClassScopeExplicitSpecialization()) {
79       // We're done when we hit an explicit specialization.
80       if (Spec->getSpecializationKind() == TSK_ExplicitSpecialization &&
81           !isa<VarTemplatePartialSpecializationDecl>(Spec))
82         return Result;
83 
84       Result.addOuterTemplateArguments(&Spec->getTemplateInstantiationArgs());
85 
86       // If this variable template specialization was instantiated from a
87       // specialized member that is a variable template, we're done.
88       assert(Spec->getSpecializedTemplate() && "No variable template?");
89       llvm::PointerUnion<VarTemplateDecl*,
90                          VarTemplatePartialSpecializationDecl*> Specialized
91                              = Spec->getSpecializedTemplateOrPartial();
92       if (VarTemplatePartialSpecializationDecl *Partial =
93               Specialized.dyn_cast<VarTemplatePartialSpecializationDecl *>()) {
94         if (Partial->isMemberSpecialization())
95           return Result;
96       } else {
97         VarTemplateDecl *Tmpl = Specialized.get<VarTemplateDecl *>();
98         if (Tmpl->isMemberSpecialization())
99           return Result;
100       }
101     }
102 
103     // If we have a template template parameter with translation unit context,
104     // then we're performing substitution into a default template argument of
105     // this template template parameter before we've constructed the template
106     // that will own this template template parameter. In this case, we
107     // use empty template parameter lists for all of the outer templates
108     // to avoid performing any substitutions.
109     if (Ctx->isTranslationUnit()) {
110       if (TemplateTemplateParmDecl *TTP
111                                       = dyn_cast<TemplateTemplateParmDecl>(D)) {
112         for (unsigned I = 0, N = TTP->getDepth() + 1; I != N; ++I)
113           Result.addOuterTemplateArguments(None);
114         return Result;
115       }
116     }
117   }
118 
119   while (!Ctx->isFileContext()) {
120     // Add template arguments from a class template instantiation.
121     ClassTemplateSpecializationDecl *Spec
122           = dyn_cast<ClassTemplateSpecializationDecl>(Ctx);
123     if (Spec && !Spec->isClassScopeExplicitSpecialization()) {
124       // We're done when we hit an explicit specialization.
125       if (Spec->getSpecializationKind() == TSK_ExplicitSpecialization &&
126           !isa<ClassTemplatePartialSpecializationDecl>(Spec))
127         break;
128 
129       Result.addOuterTemplateArguments(&Spec->getTemplateInstantiationArgs());
130 
131       // If this class template specialization was instantiated from a
132       // specialized member that is a class template, we're done.
133       assert(Spec->getSpecializedTemplate() && "No class template?");
134       if (Spec->getSpecializedTemplate()->isMemberSpecialization())
135         break;
136     }
137     // Add template arguments from a function template specialization.
138     else if (FunctionDecl *Function = dyn_cast<FunctionDecl>(Ctx)) {
139       if (!RelativeToPrimary &&
140           Function->getTemplateSpecializationKindForInstantiation() ==
141               TSK_ExplicitSpecialization)
142         break;
143 
144       if (!RelativeToPrimary && Function->getTemplateSpecializationKind() ==
145                                     TSK_ExplicitSpecialization) {
146         // This is an implicit instantiation of an explicit specialization. We
147         // don't get any template arguments from this function but might get
148         // some from an enclosing template.
149       } else if (const TemplateArgumentList *TemplateArgs
150             = Function->getTemplateSpecializationArgs()) {
151         // Add the template arguments for this specialization.
152         Result.addOuterTemplateArguments(TemplateArgs);
153 
154         // If this function was instantiated from a specialized member that is
155         // a function template, we're done.
156         assert(Function->getPrimaryTemplate() && "No function template?");
157         if (Function->getPrimaryTemplate()->isMemberSpecialization())
158           break;
159 
160         // If this function is a generic lambda specialization, we are done.
161         if (isGenericLambdaCallOperatorOrStaticInvokerSpecialization(Function))
162           break;
163 
164       } else if (FunctionTemplateDecl *FunTmpl
165                                    = Function->getDescribedFunctionTemplate()) {
166         // Add the "injected" template arguments.
167         Result.addOuterTemplateArguments(FunTmpl->getInjectedTemplateArgs());
168       }
169 
170       // If this is a friend declaration and it declares an entity at
171       // namespace scope, take arguments from its lexical parent
172       // instead of its semantic parent, unless of course the pattern we're
173       // instantiating actually comes from the file's context!
174       if (Function->getFriendObjectKind() &&
175           Function->getDeclContext()->isFileContext() &&
176           (!Pattern || !Pattern->getLexicalDeclContext()->isFileContext())) {
177         Ctx = Function->getLexicalDeclContext();
178         RelativeToPrimary = false;
179         continue;
180       }
181     } else if (CXXRecordDecl *Rec = dyn_cast<CXXRecordDecl>(Ctx)) {
182       if (ClassTemplateDecl *ClassTemplate = Rec->getDescribedClassTemplate()) {
183         QualType T = ClassTemplate->getInjectedClassNameSpecialization();
184         const TemplateSpecializationType *TST =
185             cast<TemplateSpecializationType>(Context.getCanonicalType(T));
186         Result.addOuterTemplateArguments(
187             llvm::makeArrayRef(TST->getArgs(), TST->getNumArgs()));
188         if (ClassTemplate->isMemberSpecialization())
189           break;
190       }
191     }
192 
193     Ctx = Ctx->getParent();
194     RelativeToPrimary = false;
195   }
196 
197   return Result;
198 }
199 
isInstantiationRecord() const200 bool Sema::CodeSynthesisContext::isInstantiationRecord() const {
201   switch (Kind) {
202   case TemplateInstantiation:
203   case ExceptionSpecInstantiation:
204   case DefaultTemplateArgumentInstantiation:
205   case DefaultFunctionArgumentInstantiation:
206   case ExplicitTemplateArgumentSubstitution:
207   case DeducedTemplateArgumentSubstitution:
208   case PriorTemplateArgumentSubstitution:
209   case ConstraintsCheck:
210   case NestedRequirementConstraintsCheck:
211     return true;
212 
213   case RequirementInstantiation:
214   case DefaultTemplateArgumentChecking:
215   case DeclaringSpecialMember:
216   case DeclaringImplicitEqualityComparison:
217   case DefiningSynthesizedFunction:
218   case ExceptionSpecEvaluation:
219   case ConstraintSubstitution:
220   case ParameterMappingSubstitution:
221   case ConstraintNormalization:
222   case RewritingOperatorAsSpaceship:
223   case InitializingStructuredBinding:
224   case MarkingClassDllexported:
225     return false;
226 
227   // This function should never be called when Kind's value is Memoization.
228   case Memoization:
229     break;
230   }
231 
232   llvm_unreachable("Invalid SynthesisKind!");
233 }
234 
InstantiatingTemplate(Sema & SemaRef,CodeSynthesisContext::SynthesisKind Kind,SourceLocation PointOfInstantiation,SourceRange InstantiationRange,Decl * Entity,NamedDecl * Template,ArrayRef<TemplateArgument> TemplateArgs,sema::TemplateDeductionInfo * DeductionInfo)235 Sema::InstantiatingTemplate::InstantiatingTemplate(
236     Sema &SemaRef, CodeSynthesisContext::SynthesisKind Kind,
237     SourceLocation PointOfInstantiation, SourceRange InstantiationRange,
238     Decl *Entity, NamedDecl *Template, ArrayRef<TemplateArgument> TemplateArgs,
239     sema::TemplateDeductionInfo *DeductionInfo)
240     : SemaRef(SemaRef) {
241   // Don't allow further instantiation if a fatal error and an uncompilable
242   // error have occurred. Any diagnostics we might have raised will not be
243   // visible, and we do not need to construct a correct AST.
244   if (SemaRef.Diags.hasFatalErrorOccurred() &&
245       SemaRef.hasUncompilableErrorOccurred()) {
246     Invalid = true;
247     return;
248   }
249   Invalid = CheckInstantiationDepth(PointOfInstantiation, InstantiationRange);
250   if (!Invalid) {
251     CodeSynthesisContext Inst;
252     Inst.Kind = Kind;
253     Inst.PointOfInstantiation = PointOfInstantiation;
254     Inst.Entity = Entity;
255     Inst.Template = Template;
256     Inst.TemplateArgs = TemplateArgs.data();
257     Inst.NumTemplateArgs = TemplateArgs.size();
258     Inst.DeductionInfo = DeductionInfo;
259     Inst.InstantiationRange = InstantiationRange;
260     SemaRef.pushCodeSynthesisContext(Inst);
261 
262     AlreadyInstantiating = !Inst.Entity ? false :
263         !SemaRef.InstantiatingSpecializations
264              .insert(std::make_pair(Inst.Entity->getCanonicalDecl(), Inst.Kind))
265              .second;
266     atTemplateBegin(SemaRef.TemplateInstCallbacks, SemaRef, Inst);
267   }
268 }
269 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,Decl * Entity,SourceRange InstantiationRange)270 Sema::InstantiatingTemplate::InstantiatingTemplate(
271     Sema &SemaRef, SourceLocation PointOfInstantiation, Decl *Entity,
272     SourceRange InstantiationRange)
273     : InstantiatingTemplate(SemaRef,
274                             CodeSynthesisContext::TemplateInstantiation,
275                             PointOfInstantiation, InstantiationRange, Entity) {}
276 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,FunctionDecl * Entity,ExceptionSpecification,SourceRange InstantiationRange)277 Sema::InstantiatingTemplate::InstantiatingTemplate(
278     Sema &SemaRef, SourceLocation PointOfInstantiation, FunctionDecl *Entity,
279     ExceptionSpecification, SourceRange InstantiationRange)
280     : InstantiatingTemplate(
281           SemaRef, CodeSynthesisContext::ExceptionSpecInstantiation,
282           PointOfInstantiation, InstantiationRange, Entity) {}
283 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,TemplateParameter Param,TemplateDecl * Template,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)284 Sema::InstantiatingTemplate::InstantiatingTemplate(
285     Sema &SemaRef, SourceLocation PointOfInstantiation, TemplateParameter Param,
286     TemplateDecl *Template, ArrayRef<TemplateArgument> TemplateArgs,
287     SourceRange InstantiationRange)
288     : InstantiatingTemplate(
289           SemaRef,
290           CodeSynthesisContext::DefaultTemplateArgumentInstantiation,
291           PointOfInstantiation, InstantiationRange, getAsNamedDecl(Param),
292           Template, TemplateArgs) {}
293 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,FunctionTemplateDecl * FunctionTemplate,ArrayRef<TemplateArgument> TemplateArgs,CodeSynthesisContext::SynthesisKind Kind,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)294 Sema::InstantiatingTemplate::InstantiatingTemplate(
295     Sema &SemaRef, SourceLocation PointOfInstantiation,
296     FunctionTemplateDecl *FunctionTemplate,
297     ArrayRef<TemplateArgument> TemplateArgs,
298     CodeSynthesisContext::SynthesisKind Kind,
299     sema::TemplateDeductionInfo &DeductionInfo, SourceRange InstantiationRange)
300     : InstantiatingTemplate(SemaRef, Kind, PointOfInstantiation,
301                             InstantiationRange, FunctionTemplate, nullptr,
302                             TemplateArgs, &DeductionInfo) {
303   assert(
304     Kind == CodeSynthesisContext::ExplicitTemplateArgumentSubstitution ||
305     Kind == CodeSynthesisContext::DeducedTemplateArgumentSubstitution);
306 }
307 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,TemplateDecl * Template,ArrayRef<TemplateArgument> TemplateArgs,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)308 Sema::InstantiatingTemplate::InstantiatingTemplate(
309     Sema &SemaRef, SourceLocation PointOfInstantiation,
310     TemplateDecl *Template,
311     ArrayRef<TemplateArgument> TemplateArgs,
312     sema::TemplateDeductionInfo &DeductionInfo, SourceRange InstantiationRange)
313     : InstantiatingTemplate(
314           SemaRef,
315           CodeSynthesisContext::DeducedTemplateArgumentSubstitution,
316           PointOfInstantiation, InstantiationRange, Template, nullptr,
317           TemplateArgs, &DeductionInfo) {}
318 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ClassTemplatePartialSpecializationDecl * PartialSpec,ArrayRef<TemplateArgument> TemplateArgs,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)319 Sema::InstantiatingTemplate::InstantiatingTemplate(
320     Sema &SemaRef, SourceLocation PointOfInstantiation,
321     ClassTemplatePartialSpecializationDecl *PartialSpec,
322     ArrayRef<TemplateArgument> TemplateArgs,
323     sema::TemplateDeductionInfo &DeductionInfo, SourceRange InstantiationRange)
324     : InstantiatingTemplate(
325           SemaRef,
326           CodeSynthesisContext::DeducedTemplateArgumentSubstitution,
327           PointOfInstantiation, InstantiationRange, PartialSpec, nullptr,
328           TemplateArgs, &DeductionInfo) {}
329 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,VarTemplatePartialSpecializationDecl * PartialSpec,ArrayRef<TemplateArgument> TemplateArgs,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)330 Sema::InstantiatingTemplate::InstantiatingTemplate(
331     Sema &SemaRef, SourceLocation PointOfInstantiation,
332     VarTemplatePartialSpecializationDecl *PartialSpec,
333     ArrayRef<TemplateArgument> TemplateArgs,
334     sema::TemplateDeductionInfo &DeductionInfo, SourceRange InstantiationRange)
335     : InstantiatingTemplate(
336           SemaRef,
337           CodeSynthesisContext::DeducedTemplateArgumentSubstitution,
338           PointOfInstantiation, InstantiationRange, PartialSpec, nullptr,
339           TemplateArgs, &DeductionInfo) {}
340 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ParmVarDecl * Param,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)341 Sema::InstantiatingTemplate::InstantiatingTemplate(
342     Sema &SemaRef, SourceLocation PointOfInstantiation, ParmVarDecl *Param,
343     ArrayRef<TemplateArgument> TemplateArgs, SourceRange InstantiationRange)
344     : InstantiatingTemplate(
345           SemaRef,
346           CodeSynthesisContext::DefaultFunctionArgumentInstantiation,
347           PointOfInstantiation, InstantiationRange, Param, nullptr,
348           TemplateArgs) {}
349 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,NamedDecl * Template,NonTypeTemplateParmDecl * Param,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)350 Sema::InstantiatingTemplate::InstantiatingTemplate(
351     Sema &SemaRef, SourceLocation PointOfInstantiation, NamedDecl *Template,
352     NonTypeTemplateParmDecl *Param, ArrayRef<TemplateArgument> TemplateArgs,
353     SourceRange InstantiationRange)
354     : InstantiatingTemplate(
355           SemaRef,
356           CodeSynthesisContext::PriorTemplateArgumentSubstitution,
357           PointOfInstantiation, InstantiationRange, Param, Template,
358           TemplateArgs) {}
359 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,NamedDecl * Template,TemplateTemplateParmDecl * Param,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)360 Sema::InstantiatingTemplate::InstantiatingTemplate(
361     Sema &SemaRef, SourceLocation PointOfInstantiation, NamedDecl *Template,
362     TemplateTemplateParmDecl *Param, ArrayRef<TemplateArgument> TemplateArgs,
363     SourceRange InstantiationRange)
364     : InstantiatingTemplate(
365           SemaRef,
366           CodeSynthesisContext::PriorTemplateArgumentSubstitution,
367           PointOfInstantiation, InstantiationRange, Param, Template,
368           TemplateArgs) {}
369 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,TemplateDecl * Template,NamedDecl * Param,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)370 Sema::InstantiatingTemplate::InstantiatingTemplate(
371     Sema &SemaRef, SourceLocation PointOfInstantiation, TemplateDecl *Template,
372     NamedDecl *Param, ArrayRef<TemplateArgument> TemplateArgs,
373     SourceRange InstantiationRange)
374     : InstantiatingTemplate(
375           SemaRef, CodeSynthesisContext::DefaultTemplateArgumentChecking,
376           PointOfInstantiation, InstantiationRange, Param, Template,
377           TemplateArgs) {}
378 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,concepts::Requirement * Req,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)379 Sema::InstantiatingTemplate::InstantiatingTemplate(
380     Sema &SemaRef, SourceLocation PointOfInstantiation,
381     concepts::Requirement *Req, sema::TemplateDeductionInfo &DeductionInfo,
382     SourceRange InstantiationRange)
383     : InstantiatingTemplate(
384           SemaRef, CodeSynthesisContext::RequirementInstantiation,
385           PointOfInstantiation, InstantiationRange, /*Entity=*/nullptr,
386           /*Template=*/nullptr, /*TemplateArgs=*/None, &DeductionInfo) {}
387 
388 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,concepts::NestedRequirement * Req,ConstraintsCheck,SourceRange InstantiationRange)389 Sema::InstantiatingTemplate::InstantiatingTemplate(
390     Sema &SemaRef, SourceLocation PointOfInstantiation,
391     concepts::NestedRequirement *Req, ConstraintsCheck,
392     SourceRange InstantiationRange)
393     : InstantiatingTemplate(
394           SemaRef, CodeSynthesisContext::NestedRequirementConstraintsCheck,
395           PointOfInstantiation, InstantiationRange, /*Entity=*/nullptr,
396           /*Template=*/nullptr, /*TemplateArgs=*/None) {}
397 
398 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ConstraintsCheck,NamedDecl * Template,ArrayRef<TemplateArgument> TemplateArgs,SourceRange InstantiationRange)399 Sema::InstantiatingTemplate::InstantiatingTemplate(
400     Sema &SemaRef, SourceLocation PointOfInstantiation,
401     ConstraintsCheck, NamedDecl *Template,
402     ArrayRef<TemplateArgument> TemplateArgs, SourceRange InstantiationRange)
403     : InstantiatingTemplate(
404           SemaRef, CodeSynthesisContext::ConstraintsCheck,
405           PointOfInstantiation, InstantiationRange, Template, nullptr,
406           TemplateArgs) {}
407 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ConstraintSubstitution,NamedDecl * Template,sema::TemplateDeductionInfo & DeductionInfo,SourceRange InstantiationRange)408 Sema::InstantiatingTemplate::InstantiatingTemplate(
409     Sema &SemaRef, SourceLocation PointOfInstantiation,
410     ConstraintSubstitution, NamedDecl *Template,
411     sema::TemplateDeductionInfo &DeductionInfo, SourceRange InstantiationRange)
412     : InstantiatingTemplate(
413           SemaRef, CodeSynthesisContext::ConstraintSubstitution,
414           PointOfInstantiation, InstantiationRange, Template, nullptr,
415           {}, &DeductionInfo) {}
416 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ConstraintNormalization,NamedDecl * Template,SourceRange InstantiationRange)417 Sema::InstantiatingTemplate::InstantiatingTemplate(
418     Sema &SemaRef, SourceLocation PointOfInstantiation,
419     ConstraintNormalization, NamedDecl *Template,
420     SourceRange InstantiationRange)
421     : InstantiatingTemplate(
422           SemaRef, CodeSynthesisContext::ConstraintNormalization,
423           PointOfInstantiation, InstantiationRange, Template) {}
424 
InstantiatingTemplate(Sema & SemaRef,SourceLocation PointOfInstantiation,ParameterMappingSubstitution,NamedDecl * Template,SourceRange InstantiationRange)425 Sema::InstantiatingTemplate::InstantiatingTemplate(
426     Sema &SemaRef, SourceLocation PointOfInstantiation,
427     ParameterMappingSubstitution, NamedDecl *Template,
428     SourceRange InstantiationRange)
429     : InstantiatingTemplate(
430           SemaRef, CodeSynthesisContext::ParameterMappingSubstitution,
431           PointOfInstantiation, InstantiationRange, Template) {}
432 
pushCodeSynthesisContext(CodeSynthesisContext Ctx)433 void Sema::pushCodeSynthesisContext(CodeSynthesisContext Ctx) {
434   Ctx.SavedInNonInstantiationSFINAEContext = InNonInstantiationSFINAEContext;
435   InNonInstantiationSFINAEContext = false;
436 
437   CodeSynthesisContexts.push_back(Ctx);
438 
439   if (!Ctx.isInstantiationRecord())
440     ++NonInstantiationEntries;
441 
442   // Check to see if we're low on stack space. We can't do anything about this
443   // from here, but we can at least warn the user.
444   if (isStackNearlyExhausted())
445     warnStackExhausted(Ctx.PointOfInstantiation);
446 }
447 
popCodeSynthesisContext()448 void Sema::popCodeSynthesisContext() {
449   auto &Active = CodeSynthesisContexts.back();
450   if (!Active.isInstantiationRecord()) {
451     assert(NonInstantiationEntries > 0);
452     --NonInstantiationEntries;
453   }
454 
455   InNonInstantiationSFINAEContext = Active.SavedInNonInstantiationSFINAEContext;
456 
457   // Name lookup no longer looks in this template's defining module.
458   assert(CodeSynthesisContexts.size() >=
459              CodeSynthesisContextLookupModules.size() &&
460          "forgot to remove a lookup module for a template instantiation");
461   if (CodeSynthesisContexts.size() ==
462       CodeSynthesisContextLookupModules.size()) {
463     if (Module *M = CodeSynthesisContextLookupModules.back())
464       LookupModulesCache.erase(M);
465     CodeSynthesisContextLookupModules.pop_back();
466   }
467 
468   // If we've left the code synthesis context for the current context stack,
469   // stop remembering that we've emitted that stack.
470   if (CodeSynthesisContexts.size() ==
471       LastEmittedCodeSynthesisContextDepth)
472     LastEmittedCodeSynthesisContextDepth = 0;
473 
474   CodeSynthesisContexts.pop_back();
475 }
476 
Clear()477 void Sema::InstantiatingTemplate::Clear() {
478   if (!Invalid) {
479     if (!AlreadyInstantiating) {
480       auto &Active = SemaRef.CodeSynthesisContexts.back();
481       if (Active.Entity)
482         SemaRef.InstantiatingSpecializations.erase(
483             std::make_pair(Active.Entity, Active.Kind));
484     }
485 
486     atTemplateEnd(SemaRef.TemplateInstCallbacks, SemaRef,
487                   SemaRef.CodeSynthesisContexts.back());
488 
489     SemaRef.popCodeSynthesisContext();
490     Invalid = true;
491   }
492 }
493 
CheckInstantiationDepth(SourceLocation PointOfInstantiation,SourceRange InstantiationRange)494 bool Sema::InstantiatingTemplate::CheckInstantiationDepth(
495                                         SourceLocation PointOfInstantiation,
496                                            SourceRange InstantiationRange) {
497   assert(SemaRef.NonInstantiationEntries <=
498          SemaRef.CodeSynthesisContexts.size());
499   if ((SemaRef.CodeSynthesisContexts.size() -
500           SemaRef.NonInstantiationEntries)
501         <= SemaRef.getLangOpts().InstantiationDepth)
502     return false;
503 
504   SemaRef.Diag(PointOfInstantiation,
505                diag::err_template_recursion_depth_exceeded)
506     << SemaRef.getLangOpts().InstantiationDepth
507     << InstantiationRange;
508   SemaRef.Diag(PointOfInstantiation, diag::note_template_recursion_depth)
509     << SemaRef.getLangOpts().InstantiationDepth;
510   return true;
511 }
512 
513 /// Prints the current instantiation stack through a series of
514 /// notes.
PrintInstantiationStack()515 void Sema::PrintInstantiationStack() {
516   // Determine which template instantiations to skip, if any.
517   unsigned SkipStart = CodeSynthesisContexts.size(), SkipEnd = SkipStart;
518   unsigned Limit = Diags.getTemplateBacktraceLimit();
519   if (Limit && Limit < CodeSynthesisContexts.size()) {
520     SkipStart = Limit / 2 + Limit % 2;
521     SkipEnd = CodeSynthesisContexts.size() - Limit / 2;
522   }
523 
524   // FIXME: In all of these cases, we need to show the template arguments
525   unsigned InstantiationIdx = 0;
526   for (SmallVectorImpl<CodeSynthesisContext>::reverse_iterator
527          Active = CodeSynthesisContexts.rbegin(),
528          ActiveEnd = CodeSynthesisContexts.rend();
529        Active != ActiveEnd;
530        ++Active, ++InstantiationIdx) {
531     // Skip this instantiation?
532     if (InstantiationIdx >= SkipStart && InstantiationIdx < SkipEnd) {
533       if (InstantiationIdx == SkipStart) {
534         // Note that we're skipping instantiations.
535         Diags.Report(Active->PointOfInstantiation,
536                      diag::note_instantiation_contexts_suppressed)
537           << unsigned(CodeSynthesisContexts.size() - Limit);
538       }
539       continue;
540     }
541 
542     switch (Active->Kind) {
543     case CodeSynthesisContext::TemplateInstantiation: {
544       Decl *D = Active->Entity;
545       if (CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(D)) {
546         unsigned DiagID = diag::note_template_member_class_here;
547         if (isa<ClassTemplateSpecializationDecl>(Record))
548           DiagID = diag::note_template_class_instantiation_here;
549         Diags.Report(Active->PointOfInstantiation, DiagID)
550           << Record << Active->InstantiationRange;
551       } else if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
552         unsigned DiagID;
553         if (Function->getPrimaryTemplate())
554           DiagID = diag::note_function_template_spec_here;
555         else
556           DiagID = diag::note_template_member_function_here;
557         Diags.Report(Active->PointOfInstantiation, DiagID)
558           << Function
559           << Active->InstantiationRange;
560       } else if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
561         Diags.Report(Active->PointOfInstantiation,
562                      VD->isStaticDataMember()?
563                        diag::note_template_static_data_member_def_here
564                      : diag::note_template_variable_def_here)
565           << VD
566           << Active->InstantiationRange;
567       } else if (EnumDecl *ED = dyn_cast<EnumDecl>(D)) {
568         Diags.Report(Active->PointOfInstantiation,
569                      diag::note_template_enum_def_here)
570           << ED
571           << Active->InstantiationRange;
572       } else if (FieldDecl *FD = dyn_cast<FieldDecl>(D)) {
573         Diags.Report(Active->PointOfInstantiation,
574                      diag::note_template_nsdmi_here)
575             << FD << Active->InstantiationRange;
576       } else {
577         Diags.Report(Active->PointOfInstantiation,
578                      diag::note_template_type_alias_instantiation_here)
579           << cast<TypeAliasTemplateDecl>(D)
580           << Active->InstantiationRange;
581       }
582       break;
583     }
584 
585     case CodeSynthesisContext::DefaultTemplateArgumentInstantiation: {
586       TemplateDecl *Template = cast<TemplateDecl>(Active->Template);
587       SmallString<128> TemplateArgsStr;
588       llvm::raw_svector_ostream OS(TemplateArgsStr);
589       Template->printName(OS);
590       printTemplateArgumentList(OS, Active->template_arguments(),
591                                 getPrintingPolicy());
592       Diags.Report(Active->PointOfInstantiation,
593                    diag::note_default_arg_instantiation_here)
594         << OS.str()
595         << Active->InstantiationRange;
596       break;
597     }
598 
599     case CodeSynthesisContext::ExplicitTemplateArgumentSubstitution: {
600       FunctionTemplateDecl *FnTmpl = cast<FunctionTemplateDecl>(Active->Entity);
601       Diags.Report(Active->PointOfInstantiation,
602                    diag::note_explicit_template_arg_substitution_here)
603         << FnTmpl
604         << getTemplateArgumentBindingsText(FnTmpl->getTemplateParameters(),
605                                            Active->TemplateArgs,
606                                            Active->NumTemplateArgs)
607         << Active->InstantiationRange;
608       break;
609     }
610 
611     case CodeSynthesisContext::DeducedTemplateArgumentSubstitution: {
612       if (FunctionTemplateDecl *FnTmpl =
613               dyn_cast<FunctionTemplateDecl>(Active->Entity)) {
614         Diags.Report(Active->PointOfInstantiation,
615                      diag::note_function_template_deduction_instantiation_here)
616           << FnTmpl
617           << getTemplateArgumentBindingsText(FnTmpl->getTemplateParameters(),
618                                              Active->TemplateArgs,
619                                              Active->NumTemplateArgs)
620           << Active->InstantiationRange;
621       } else {
622         bool IsVar = isa<VarTemplateDecl>(Active->Entity) ||
623                      isa<VarTemplateSpecializationDecl>(Active->Entity);
624         bool IsTemplate = false;
625         TemplateParameterList *Params;
626         if (auto *D = dyn_cast<TemplateDecl>(Active->Entity)) {
627           IsTemplate = true;
628           Params = D->getTemplateParameters();
629         } else if (auto *D = dyn_cast<ClassTemplatePartialSpecializationDecl>(
630                        Active->Entity)) {
631           Params = D->getTemplateParameters();
632         } else if (auto *D = dyn_cast<VarTemplatePartialSpecializationDecl>(
633                        Active->Entity)) {
634           Params = D->getTemplateParameters();
635         } else {
636           llvm_unreachable("unexpected template kind");
637         }
638 
639         Diags.Report(Active->PointOfInstantiation,
640                      diag::note_deduced_template_arg_substitution_here)
641           << IsVar << IsTemplate << cast<NamedDecl>(Active->Entity)
642           << getTemplateArgumentBindingsText(Params, Active->TemplateArgs,
643                                              Active->NumTemplateArgs)
644           << Active->InstantiationRange;
645       }
646       break;
647     }
648 
649     case CodeSynthesisContext::DefaultFunctionArgumentInstantiation: {
650       ParmVarDecl *Param = cast<ParmVarDecl>(Active->Entity);
651       FunctionDecl *FD = cast<FunctionDecl>(Param->getDeclContext());
652 
653       SmallString<128> TemplateArgsStr;
654       llvm::raw_svector_ostream OS(TemplateArgsStr);
655       FD->printName(OS);
656       printTemplateArgumentList(OS, Active->template_arguments(),
657                                 getPrintingPolicy());
658       Diags.Report(Active->PointOfInstantiation,
659                    diag::note_default_function_arg_instantiation_here)
660         << OS.str()
661         << Active->InstantiationRange;
662       break;
663     }
664 
665     case CodeSynthesisContext::PriorTemplateArgumentSubstitution: {
666       NamedDecl *Parm = cast<NamedDecl>(Active->Entity);
667       std::string Name;
668       if (!Parm->getName().empty())
669         Name = std::string(" '") + Parm->getName().str() + "'";
670 
671       TemplateParameterList *TemplateParams = nullptr;
672       if (TemplateDecl *Template = dyn_cast<TemplateDecl>(Active->Template))
673         TemplateParams = Template->getTemplateParameters();
674       else
675         TemplateParams =
676           cast<ClassTemplatePartialSpecializationDecl>(Active->Template)
677                                                       ->getTemplateParameters();
678       Diags.Report(Active->PointOfInstantiation,
679                    diag::note_prior_template_arg_substitution)
680         << isa<TemplateTemplateParmDecl>(Parm)
681         << Name
682         << getTemplateArgumentBindingsText(TemplateParams,
683                                            Active->TemplateArgs,
684                                            Active->NumTemplateArgs)
685         << Active->InstantiationRange;
686       break;
687     }
688 
689     case CodeSynthesisContext::DefaultTemplateArgumentChecking: {
690       TemplateParameterList *TemplateParams = nullptr;
691       if (TemplateDecl *Template = dyn_cast<TemplateDecl>(Active->Template))
692         TemplateParams = Template->getTemplateParameters();
693       else
694         TemplateParams =
695           cast<ClassTemplatePartialSpecializationDecl>(Active->Template)
696                                                       ->getTemplateParameters();
697 
698       Diags.Report(Active->PointOfInstantiation,
699                    diag::note_template_default_arg_checking)
700         << getTemplateArgumentBindingsText(TemplateParams,
701                                            Active->TemplateArgs,
702                                            Active->NumTemplateArgs)
703         << Active->InstantiationRange;
704       break;
705     }
706 
707     case CodeSynthesisContext::ExceptionSpecEvaluation:
708       Diags.Report(Active->PointOfInstantiation,
709                    diag::note_evaluating_exception_spec_here)
710           << cast<FunctionDecl>(Active->Entity);
711       break;
712 
713     case CodeSynthesisContext::ExceptionSpecInstantiation:
714       Diags.Report(Active->PointOfInstantiation,
715                    diag::note_template_exception_spec_instantiation_here)
716         << cast<FunctionDecl>(Active->Entity)
717         << Active->InstantiationRange;
718       break;
719 
720     case CodeSynthesisContext::RequirementInstantiation:
721       Diags.Report(Active->PointOfInstantiation,
722                    diag::note_template_requirement_instantiation_here)
723         << Active->InstantiationRange;
724       break;
725 
726     case CodeSynthesisContext::NestedRequirementConstraintsCheck:
727       Diags.Report(Active->PointOfInstantiation,
728                    diag::note_nested_requirement_here)
729         << Active->InstantiationRange;
730       break;
731 
732     case CodeSynthesisContext::DeclaringSpecialMember:
733       Diags.Report(Active->PointOfInstantiation,
734                    diag::note_in_declaration_of_implicit_special_member)
735         << cast<CXXRecordDecl>(Active->Entity) << Active->SpecialMember;
736       break;
737 
738     case CodeSynthesisContext::DeclaringImplicitEqualityComparison:
739       Diags.Report(Active->Entity->getLocation(),
740                    diag::note_in_declaration_of_implicit_equality_comparison);
741       break;
742 
743     case CodeSynthesisContext::DefiningSynthesizedFunction: {
744       // FIXME: For synthesized functions that are not defaulted,
745       // produce a note.
746       auto *FD = dyn_cast<FunctionDecl>(Active->Entity);
747       DefaultedFunctionKind DFK =
748           FD ? getDefaultedFunctionKind(FD) : DefaultedFunctionKind();
749       if (DFK.isSpecialMember()) {
750         auto *MD = cast<CXXMethodDecl>(FD);
751         Diags.Report(Active->PointOfInstantiation,
752                      diag::note_member_synthesized_at)
753             << MD->isExplicitlyDefaulted() << DFK.asSpecialMember()
754             << Context.getTagDeclType(MD->getParent());
755       } else if (DFK.isComparison()) {
756         Diags.Report(Active->PointOfInstantiation,
757                      diag::note_comparison_synthesized_at)
758             << (int)DFK.asComparison()
759             << Context.getTagDeclType(
760                    cast<CXXRecordDecl>(FD->getLexicalDeclContext()));
761       }
762       break;
763     }
764 
765     case CodeSynthesisContext::RewritingOperatorAsSpaceship:
766       Diags.Report(Active->Entity->getLocation(),
767                    diag::note_rewriting_operator_as_spaceship);
768       break;
769 
770     case CodeSynthesisContext::InitializingStructuredBinding:
771       Diags.Report(Active->PointOfInstantiation,
772                    diag::note_in_binding_decl_init)
773           << cast<BindingDecl>(Active->Entity);
774       break;
775 
776     case CodeSynthesisContext::MarkingClassDllexported:
777       Diags.Report(Active->PointOfInstantiation,
778                    diag::note_due_to_dllexported_class)
779           << cast<CXXRecordDecl>(Active->Entity) << !getLangOpts().CPlusPlus11;
780       break;
781 
782     case CodeSynthesisContext::Memoization:
783       break;
784 
785     case CodeSynthesisContext::ConstraintsCheck: {
786       unsigned DiagID = 0;
787       if (!Active->Entity) {
788         Diags.Report(Active->PointOfInstantiation,
789                      diag::note_nested_requirement_here)
790           << Active->InstantiationRange;
791         break;
792       }
793       if (isa<ConceptDecl>(Active->Entity))
794         DiagID = diag::note_concept_specialization_here;
795       else if (isa<TemplateDecl>(Active->Entity))
796         DiagID = diag::note_checking_constraints_for_template_id_here;
797       else if (isa<VarTemplatePartialSpecializationDecl>(Active->Entity))
798         DiagID = diag::note_checking_constraints_for_var_spec_id_here;
799       else if (isa<ClassTemplatePartialSpecializationDecl>(Active->Entity))
800         DiagID = diag::note_checking_constraints_for_class_spec_id_here;
801       else {
802         assert(isa<FunctionDecl>(Active->Entity));
803         DiagID = diag::note_checking_constraints_for_function_here;
804       }
805       SmallString<128> TemplateArgsStr;
806       llvm::raw_svector_ostream OS(TemplateArgsStr);
807       cast<NamedDecl>(Active->Entity)->printName(OS);
808       if (!isa<FunctionDecl>(Active->Entity))
809         printTemplateArgumentList(OS, Active->template_arguments(),
810                                   getPrintingPolicy());
811       Diags.Report(Active->PointOfInstantiation, DiagID) << OS.str()
812         << Active->InstantiationRange;
813       break;
814     }
815     case CodeSynthesisContext::ConstraintSubstitution:
816       Diags.Report(Active->PointOfInstantiation,
817                    diag::note_constraint_substitution_here)
818           << Active->InstantiationRange;
819       break;
820     case CodeSynthesisContext::ConstraintNormalization:
821       Diags.Report(Active->PointOfInstantiation,
822                    diag::note_constraint_normalization_here)
823           << cast<NamedDecl>(Active->Entity)->getName()
824           << Active->InstantiationRange;
825       break;
826     case CodeSynthesisContext::ParameterMappingSubstitution:
827       Diags.Report(Active->PointOfInstantiation,
828                    diag::note_parameter_mapping_substitution_here)
829           << Active->InstantiationRange;
830       break;
831     }
832   }
833 }
834 
isSFINAEContext() const835 Optional<TemplateDeductionInfo *> Sema::isSFINAEContext() const {
836   if (InNonInstantiationSFINAEContext)
837     return Optional<TemplateDeductionInfo *>(nullptr);
838 
839   for (SmallVectorImpl<CodeSynthesisContext>::const_reverse_iterator
840          Active = CodeSynthesisContexts.rbegin(),
841          ActiveEnd = CodeSynthesisContexts.rend();
842        Active != ActiveEnd;
843        ++Active)
844   {
845     switch (Active->Kind) {
846     case CodeSynthesisContext::TemplateInstantiation:
847       // An instantiation of an alias template may or may not be a SFINAE
848       // context, depending on what else is on the stack.
849       if (isa<TypeAliasTemplateDecl>(Active->Entity))
850         break;
851       LLVM_FALLTHROUGH;
852     case CodeSynthesisContext::DefaultFunctionArgumentInstantiation:
853     case CodeSynthesisContext::ExceptionSpecInstantiation:
854     case CodeSynthesisContext::ConstraintsCheck:
855     case CodeSynthesisContext::ParameterMappingSubstitution:
856     case CodeSynthesisContext::ConstraintNormalization:
857     case CodeSynthesisContext::NestedRequirementConstraintsCheck:
858       // This is a template instantiation, so there is no SFINAE.
859       return None;
860 
861     case CodeSynthesisContext::DefaultTemplateArgumentInstantiation:
862     case CodeSynthesisContext::PriorTemplateArgumentSubstitution:
863     case CodeSynthesisContext::DefaultTemplateArgumentChecking:
864     case CodeSynthesisContext::RewritingOperatorAsSpaceship:
865       // A default template argument instantiation and substitution into
866       // template parameters with arguments for prior parameters may or may
867       // not be a SFINAE context; look further up the stack.
868       break;
869 
870     case CodeSynthesisContext::ExplicitTemplateArgumentSubstitution:
871     case CodeSynthesisContext::DeducedTemplateArgumentSubstitution:
872     case CodeSynthesisContext::ConstraintSubstitution:
873     case CodeSynthesisContext::RequirementInstantiation:
874       // We're either substituting explicitly-specified template arguments,
875       // deduced template arguments, a constraint expression or a requirement
876       // in a requires expression, so SFINAE applies.
877       assert(Active->DeductionInfo && "Missing deduction info pointer");
878       return Active->DeductionInfo;
879 
880     case CodeSynthesisContext::DeclaringSpecialMember:
881     case CodeSynthesisContext::DeclaringImplicitEqualityComparison:
882     case CodeSynthesisContext::DefiningSynthesizedFunction:
883     case CodeSynthesisContext::InitializingStructuredBinding:
884     case CodeSynthesisContext::MarkingClassDllexported:
885       // This happens in a context unrelated to template instantiation, so
886       // there is no SFINAE.
887       return None;
888 
889     case CodeSynthesisContext::ExceptionSpecEvaluation:
890       // FIXME: This should not be treated as a SFINAE context, because
891       // we will cache an incorrect exception specification. However, clang
892       // bootstrap relies this! See PR31692.
893       break;
894 
895     case CodeSynthesisContext::Memoization:
896       break;
897     }
898 
899     // The inner context was transparent for SFINAE. If it occurred within a
900     // non-instantiation SFINAE context, then SFINAE applies.
901     if (Active->SavedInNonInstantiationSFINAEContext)
902       return Optional<TemplateDeductionInfo *>(nullptr);
903   }
904 
905   return None;
906 }
907 
908 //===----------------------------------------------------------------------===/
909 // Template Instantiation for Types
910 //===----------------------------------------------------------------------===/
911 namespace {
912   class TemplateInstantiator : public TreeTransform<TemplateInstantiator> {
913     const MultiLevelTemplateArgumentList &TemplateArgs;
914     SourceLocation Loc;
915     DeclarationName Entity;
916 
917   public:
918     typedef TreeTransform<TemplateInstantiator> inherited;
919 
TemplateInstantiator(Sema & SemaRef,const MultiLevelTemplateArgumentList & TemplateArgs,SourceLocation Loc,DeclarationName Entity)920     TemplateInstantiator(Sema &SemaRef,
921                          const MultiLevelTemplateArgumentList &TemplateArgs,
922                          SourceLocation Loc,
923                          DeclarationName Entity)
924       : inherited(SemaRef), TemplateArgs(TemplateArgs), Loc(Loc),
925         Entity(Entity) { }
926 
927     /// Determine whether the given type \p T has already been
928     /// transformed.
929     ///
930     /// For the purposes of template instantiation, a type has already been
931     /// transformed if it is NULL or if it is not dependent.
932     bool AlreadyTransformed(QualType T);
933 
934     /// Returns the location of the entity being instantiated, if known.
getBaseLocation()935     SourceLocation getBaseLocation() { return Loc; }
936 
937     /// Returns the name of the entity being instantiated, if any.
getBaseEntity()938     DeclarationName getBaseEntity() { return Entity; }
939 
940     /// Sets the "base" location and entity when that
941     /// information is known based on another transformation.
setBase(SourceLocation Loc,DeclarationName Entity)942     void setBase(SourceLocation Loc, DeclarationName Entity) {
943       this->Loc = Loc;
944       this->Entity = Entity;
945     }
946 
TransformTemplateDepth(unsigned Depth)947     unsigned TransformTemplateDepth(unsigned Depth) {
948       return TemplateArgs.getNewDepth(Depth);
949     }
950 
TryExpandParameterPacks(SourceLocation EllipsisLoc,SourceRange PatternRange,ArrayRef<UnexpandedParameterPack> Unexpanded,bool & ShouldExpand,bool & RetainExpansion,Optional<unsigned> & NumExpansions)951     bool TryExpandParameterPacks(SourceLocation EllipsisLoc,
952                                  SourceRange PatternRange,
953                                  ArrayRef<UnexpandedParameterPack> Unexpanded,
954                                  bool &ShouldExpand, bool &RetainExpansion,
955                                  Optional<unsigned> &NumExpansions) {
956       return getSema().CheckParameterPacksForExpansion(EllipsisLoc,
957                                                        PatternRange, Unexpanded,
958                                                        TemplateArgs,
959                                                        ShouldExpand,
960                                                        RetainExpansion,
961                                                        NumExpansions);
962     }
963 
ExpandingFunctionParameterPack(ParmVarDecl * Pack)964     void ExpandingFunctionParameterPack(ParmVarDecl *Pack) {
965       SemaRef.CurrentInstantiationScope->MakeInstantiatedLocalArgPack(Pack);
966     }
967 
ForgetPartiallySubstitutedPack()968     TemplateArgument ForgetPartiallySubstitutedPack() {
969       TemplateArgument Result;
970       if (NamedDecl *PartialPack
971             = SemaRef.CurrentInstantiationScope->getPartiallySubstitutedPack()){
972         MultiLevelTemplateArgumentList &TemplateArgs
973           = const_cast<MultiLevelTemplateArgumentList &>(this->TemplateArgs);
974         unsigned Depth, Index;
975         std::tie(Depth, Index) = getDepthAndIndex(PartialPack);
976         if (TemplateArgs.hasTemplateArgument(Depth, Index)) {
977           Result = TemplateArgs(Depth, Index);
978           TemplateArgs.setArgument(Depth, Index, TemplateArgument());
979         }
980       }
981 
982       return Result;
983     }
984 
RememberPartiallySubstitutedPack(TemplateArgument Arg)985     void RememberPartiallySubstitutedPack(TemplateArgument Arg) {
986       if (Arg.isNull())
987         return;
988 
989       if (NamedDecl *PartialPack
990             = SemaRef.CurrentInstantiationScope->getPartiallySubstitutedPack()){
991         MultiLevelTemplateArgumentList &TemplateArgs
992         = const_cast<MultiLevelTemplateArgumentList &>(this->TemplateArgs);
993         unsigned Depth, Index;
994         std::tie(Depth, Index) = getDepthAndIndex(PartialPack);
995         TemplateArgs.setArgument(Depth, Index, Arg);
996       }
997     }
998 
999     /// Transform the given declaration by instantiating a reference to
1000     /// this declaration.
1001     Decl *TransformDecl(SourceLocation Loc, Decl *D);
1002 
transformAttrs(Decl * Old,Decl * New)1003     void transformAttrs(Decl *Old, Decl *New) {
1004       SemaRef.InstantiateAttrs(TemplateArgs, Old, New);
1005     }
1006 
transformedLocalDecl(Decl * Old,ArrayRef<Decl * > NewDecls)1007     void transformedLocalDecl(Decl *Old, ArrayRef<Decl *> NewDecls) {
1008       if (Old->isParameterPack()) {
1009         SemaRef.CurrentInstantiationScope->MakeInstantiatedLocalArgPack(Old);
1010         for (auto *New : NewDecls)
1011           SemaRef.CurrentInstantiationScope->InstantiatedLocalPackArg(
1012               Old, cast<VarDecl>(New));
1013         return;
1014       }
1015 
1016       assert(NewDecls.size() == 1 &&
1017              "should only have multiple expansions for a pack");
1018       Decl *New = NewDecls.front();
1019 
1020       // If we've instantiated the call operator of a lambda or the call
1021       // operator template of a generic lambda, update the "instantiation of"
1022       // information.
1023       auto *NewMD = dyn_cast<CXXMethodDecl>(New);
1024       if (NewMD && isLambdaCallOperator(NewMD)) {
1025         auto *OldMD = dyn_cast<CXXMethodDecl>(Old);
1026         if (auto *NewTD = NewMD->getDescribedFunctionTemplate())
1027           NewTD->setInstantiatedFromMemberTemplate(
1028               OldMD->getDescribedFunctionTemplate());
1029         else
1030           NewMD->setInstantiationOfMemberFunction(OldMD,
1031                                                   TSK_ImplicitInstantiation);
1032       }
1033 
1034       SemaRef.CurrentInstantiationScope->InstantiatedLocal(Old, New);
1035 
1036       // We recreated a local declaration, but not by instantiating it. There
1037       // may be pending dependent diagnostics to produce.
1038       if (auto *DC = dyn_cast<DeclContext>(Old))
1039         SemaRef.PerformDependentDiagnostics(DC, TemplateArgs);
1040     }
1041 
1042     /// Transform the definition of the given declaration by
1043     /// instantiating it.
1044     Decl *TransformDefinition(SourceLocation Loc, Decl *D);
1045 
1046     /// Transform the first qualifier within a scope by instantiating the
1047     /// declaration.
1048     NamedDecl *TransformFirstQualifierInScope(NamedDecl *D, SourceLocation Loc);
1049 
1050     /// Rebuild the exception declaration and register the declaration
1051     /// as an instantiated local.
1052     VarDecl *RebuildExceptionDecl(VarDecl *ExceptionDecl,
1053                                   TypeSourceInfo *Declarator,
1054                                   SourceLocation StartLoc,
1055                                   SourceLocation NameLoc,
1056                                   IdentifierInfo *Name);
1057 
1058     /// Rebuild the Objective-C exception declaration and register the
1059     /// declaration as an instantiated local.
1060     VarDecl *RebuildObjCExceptionDecl(VarDecl *ExceptionDecl,
1061                                       TypeSourceInfo *TSInfo, QualType T);
1062 
1063     /// Check for tag mismatches when instantiating an
1064     /// elaborated type.
1065     QualType RebuildElaboratedType(SourceLocation KeywordLoc,
1066                                    ElaboratedTypeKeyword Keyword,
1067                                    NestedNameSpecifierLoc QualifierLoc,
1068                                    QualType T);
1069 
1070     TemplateName
1071     TransformTemplateName(CXXScopeSpec &SS, TemplateName Name,
1072                           SourceLocation NameLoc,
1073                           QualType ObjectType = QualType(),
1074                           NamedDecl *FirstQualifierInScope = nullptr,
1075                           bool AllowInjectedClassName = false);
1076 
1077     const LoopHintAttr *TransformLoopHintAttr(const LoopHintAttr *LH);
1078 
1079     ExprResult TransformPredefinedExpr(PredefinedExpr *E);
1080     ExprResult TransformDeclRefExpr(DeclRefExpr *E);
1081     ExprResult TransformCXXDefaultArgExpr(CXXDefaultArgExpr *E);
1082 
1083     ExprResult TransformTemplateParmRefExpr(DeclRefExpr *E,
1084                                             NonTypeTemplateParmDecl *D);
1085     ExprResult TransformSubstNonTypeTemplateParmPackExpr(
1086                                            SubstNonTypeTemplateParmPackExpr *E);
1087     ExprResult TransformSubstNonTypeTemplateParmExpr(
1088                                            SubstNonTypeTemplateParmExpr *E);
1089 
1090     /// Rebuild a DeclRefExpr for a VarDecl reference.
1091     ExprResult RebuildVarDeclRefExpr(VarDecl *PD, SourceLocation Loc);
1092 
1093     /// Transform a reference to a function or init-capture parameter pack.
1094     ExprResult TransformFunctionParmPackRefExpr(DeclRefExpr *E, VarDecl *PD);
1095 
1096     /// Transform a FunctionParmPackExpr which was built when we couldn't
1097     /// expand a function parameter pack reference which refers to an expanded
1098     /// pack.
1099     ExprResult TransformFunctionParmPackExpr(FunctionParmPackExpr *E);
1100 
TransformFunctionProtoType(TypeLocBuilder & TLB,FunctionProtoTypeLoc TL)1101     QualType TransformFunctionProtoType(TypeLocBuilder &TLB,
1102                                         FunctionProtoTypeLoc TL) {
1103       // Call the base version; it will forward to our overridden version below.
1104       return inherited::TransformFunctionProtoType(TLB, TL);
1105     }
1106 
1107     template<typename Fn>
1108     QualType TransformFunctionProtoType(TypeLocBuilder &TLB,
1109                                         FunctionProtoTypeLoc TL,
1110                                         CXXRecordDecl *ThisContext,
1111                                         Qualifiers ThisTypeQuals,
1112                                         Fn TransformExceptionSpec);
1113 
1114     ParmVarDecl *TransformFunctionTypeParam(ParmVarDecl *OldParm,
1115                                             int indexAdjustment,
1116                                             Optional<unsigned> NumExpansions,
1117                                             bool ExpectParameterPack);
1118 
1119     /// Transforms a template type parameter type by performing
1120     /// substitution of the corresponding template type argument.
1121     QualType TransformTemplateTypeParmType(TypeLocBuilder &TLB,
1122                                            TemplateTypeParmTypeLoc TL);
1123 
1124     /// Transforms an already-substituted template type parameter pack
1125     /// into either itself (if we aren't substituting into its pack expansion)
1126     /// or the appropriate substituted argument.
1127     QualType TransformSubstTemplateTypeParmPackType(TypeLocBuilder &TLB,
1128                                            SubstTemplateTypeParmPackTypeLoc TL);
1129 
TransformLambdaExpr(LambdaExpr * E)1130     ExprResult TransformLambdaExpr(LambdaExpr *E) {
1131       LocalInstantiationScope Scope(SemaRef, /*CombineWithOuterScope=*/true);
1132       return TreeTransform<TemplateInstantiator>::TransformLambdaExpr(E);
1133     }
1134 
TransformRequiresExpr(RequiresExpr * E)1135     ExprResult TransformRequiresExpr(RequiresExpr *E) {
1136       LocalInstantiationScope Scope(SemaRef, /*CombineWithOuterScope=*/true);
1137       return TreeTransform<TemplateInstantiator>::TransformRequiresExpr(E);
1138     }
1139 
TransformRequiresExprRequirements(ArrayRef<concepts::Requirement * > Reqs,SmallVectorImpl<concepts::Requirement * > & Transformed)1140     bool TransformRequiresExprRequirements(
1141         ArrayRef<concepts::Requirement *> Reqs,
1142         SmallVectorImpl<concepts::Requirement *> &Transformed) {
1143       bool SatisfactionDetermined = false;
1144       for (concepts::Requirement *Req : Reqs) {
1145         concepts::Requirement *TransReq = nullptr;
1146         if (!SatisfactionDetermined) {
1147           if (auto *TypeReq = dyn_cast<concepts::TypeRequirement>(Req))
1148             TransReq = TransformTypeRequirement(TypeReq);
1149           else if (auto *ExprReq = dyn_cast<concepts::ExprRequirement>(Req))
1150             TransReq = TransformExprRequirement(ExprReq);
1151           else
1152             TransReq = TransformNestedRequirement(
1153                 cast<concepts::NestedRequirement>(Req));
1154           if (!TransReq)
1155             return true;
1156           if (!TransReq->isDependent() && !TransReq->isSatisfied())
1157             // [expr.prim.req]p6
1158             //   [...]  The substitution and semantic constraint checking
1159             //   proceeds in lexical order and stops when a condition that
1160             //   determines the result of the requires-expression is
1161             //   encountered. [..]
1162             SatisfactionDetermined = true;
1163         } else
1164           TransReq = Req;
1165         Transformed.push_back(TransReq);
1166       }
1167       return false;
1168     }
1169 
TransformTemplateParameterList(TemplateParameterList * OrigTPL)1170     TemplateParameterList *TransformTemplateParameterList(
1171                               TemplateParameterList *OrigTPL)  {
1172       if (!OrigTPL || !OrigTPL->size()) return OrigTPL;
1173 
1174       DeclContext *Owner = OrigTPL->getParam(0)->getDeclContext();
1175       TemplateDeclInstantiator  DeclInstantiator(getSema(),
1176                         /* DeclContext *Owner */ Owner, TemplateArgs);
1177       return DeclInstantiator.SubstTemplateParams(OrigTPL);
1178     }
1179 
1180     concepts::TypeRequirement *
1181     TransformTypeRequirement(concepts::TypeRequirement *Req);
1182     concepts::ExprRequirement *
1183     TransformExprRequirement(concepts::ExprRequirement *Req);
1184     concepts::NestedRequirement *
1185     TransformNestedRequirement(concepts::NestedRequirement *Req);
1186 
1187   private:
1188     ExprResult transformNonTypeTemplateParmRef(NonTypeTemplateParmDecl *parm,
1189                                                SourceLocation loc,
1190                                                TemplateArgument arg);
1191   };
1192 }
1193 
AlreadyTransformed(QualType T)1194 bool TemplateInstantiator::AlreadyTransformed(QualType T) {
1195   if (T.isNull())
1196     return true;
1197 
1198   if (T->isInstantiationDependentType() || T->isVariablyModifiedType())
1199     return false;
1200 
1201   getSema().MarkDeclarationsReferencedInType(Loc, T);
1202   return true;
1203 }
1204 
1205 static TemplateArgument
getPackSubstitutedTemplateArgument(Sema & S,TemplateArgument Arg)1206 getPackSubstitutedTemplateArgument(Sema &S, TemplateArgument Arg) {
1207   assert(S.ArgumentPackSubstitutionIndex >= 0);
1208   assert(S.ArgumentPackSubstitutionIndex < (int)Arg.pack_size());
1209   Arg = Arg.pack_begin()[S.ArgumentPackSubstitutionIndex];
1210   if (Arg.isPackExpansion())
1211     Arg = Arg.getPackExpansionPattern();
1212   return Arg;
1213 }
1214 
TransformDecl(SourceLocation Loc,Decl * D)1215 Decl *TemplateInstantiator::TransformDecl(SourceLocation Loc, Decl *D) {
1216   if (!D)
1217     return nullptr;
1218 
1219   if (TemplateTemplateParmDecl *TTP = dyn_cast<TemplateTemplateParmDecl>(D)) {
1220     if (TTP->getDepth() < TemplateArgs.getNumLevels()) {
1221       // If the corresponding template argument is NULL or non-existent, it's
1222       // because we are performing instantiation from explicitly-specified
1223       // template arguments in a function template, but there were some
1224       // arguments left unspecified.
1225       if (!TemplateArgs.hasTemplateArgument(TTP->getDepth(),
1226                                             TTP->getPosition()))
1227         return D;
1228 
1229       TemplateArgument Arg = TemplateArgs(TTP->getDepth(), TTP->getPosition());
1230 
1231       if (TTP->isParameterPack()) {
1232         assert(Arg.getKind() == TemplateArgument::Pack &&
1233                "Missing argument pack");
1234         Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1235       }
1236 
1237       TemplateName Template = Arg.getAsTemplate().getNameToSubstitute();
1238       assert(!Template.isNull() && Template.getAsTemplateDecl() &&
1239              "Wrong kind of template template argument");
1240       return Template.getAsTemplateDecl();
1241     }
1242 
1243     // Fall through to find the instantiated declaration for this template
1244     // template parameter.
1245   }
1246 
1247   return SemaRef.FindInstantiatedDecl(Loc, cast<NamedDecl>(D), TemplateArgs);
1248 }
1249 
TransformDefinition(SourceLocation Loc,Decl * D)1250 Decl *TemplateInstantiator::TransformDefinition(SourceLocation Loc, Decl *D) {
1251   Decl *Inst = getSema().SubstDecl(D, getSema().CurContext, TemplateArgs);
1252   if (!Inst)
1253     return nullptr;
1254 
1255   getSema().CurrentInstantiationScope->InstantiatedLocal(D, Inst);
1256   return Inst;
1257 }
1258 
1259 NamedDecl *
TransformFirstQualifierInScope(NamedDecl * D,SourceLocation Loc)1260 TemplateInstantiator::TransformFirstQualifierInScope(NamedDecl *D,
1261                                                      SourceLocation Loc) {
1262   // If the first part of the nested-name-specifier was a template type
1263   // parameter, instantiate that type parameter down to a tag type.
1264   if (TemplateTypeParmDecl *TTPD = dyn_cast_or_null<TemplateTypeParmDecl>(D)) {
1265     const TemplateTypeParmType *TTP
1266       = cast<TemplateTypeParmType>(getSema().Context.getTypeDeclType(TTPD));
1267 
1268     if (TTP->getDepth() < TemplateArgs.getNumLevels()) {
1269       // FIXME: This needs testing w/ member access expressions.
1270       TemplateArgument Arg = TemplateArgs(TTP->getDepth(), TTP->getIndex());
1271 
1272       if (TTP->isParameterPack()) {
1273         assert(Arg.getKind() == TemplateArgument::Pack &&
1274                "Missing argument pack");
1275 
1276         if (getSema().ArgumentPackSubstitutionIndex == -1)
1277           return nullptr;
1278 
1279         Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1280       }
1281 
1282       QualType T = Arg.getAsType();
1283       if (T.isNull())
1284         return cast_or_null<NamedDecl>(TransformDecl(Loc, D));
1285 
1286       if (const TagType *Tag = T->getAs<TagType>())
1287         return Tag->getDecl();
1288 
1289       // The resulting type is not a tag; complain.
1290       getSema().Diag(Loc, diag::err_nested_name_spec_non_tag) << T;
1291       return nullptr;
1292     }
1293   }
1294 
1295   return cast_or_null<NamedDecl>(TransformDecl(Loc, D));
1296 }
1297 
1298 VarDecl *
RebuildExceptionDecl(VarDecl * ExceptionDecl,TypeSourceInfo * Declarator,SourceLocation StartLoc,SourceLocation NameLoc,IdentifierInfo * Name)1299 TemplateInstantiator::RebuildExceptionDecl(VarDecl *ExceptionDecl,
1300                                            TypeSourceInfo *Declarator,
1301                                            SourceLocation StartLoc,
1302                                            SourceLocation NameLoc,
1303                                            IdentifierInfo *Name) {
1304   VarDecl *Var = inherited::RebuildExceptionDecl(ExceptionDecl, Declarator,
1305                                                  StartLoc, NameLoc, Name);
1306   if (Var)
1307     getSema().CurrentInstantiationScope->InstantiatedLocal(ExceptionDecl, Var);
1308   return Var;
1309 }
1310 
RebuildObjCExceptionDecl(VarDecl * ExceptionDecl,TypeSourceInfo * TSInfo,QualType T)1311 VarDecl *TemplateInstantiator::RebuildObjCExceptionDecl(VarDecl *ExceptionDecl,
1312                                                         TypeSourceInfo *TSInfo,
1313                                                         QualType T) {
1314   VarDecl *Var = inherited::RebuildObjCExceptionDecl(ExceptionDecl, TSInfo, T);
1315   if (Var)
1316     getSema().CurrentInstantiationScope->InstantiatedLocal(ExceptionDecl, Var);
1317   return Var;
1318 }
1319 
1320 QualType
RebuildElaboratedType(SourceLocation KeywordLoc,ElaboratedTypeKeyword Keyword,NestedNameSpecifierLoc QualifierLoc,QualType T)1321 TemplateInstantiator::RebuildElaboratedType(SourceLocation KeywordLoc,
1322                                             ElaboratedTypeKeyword Keyword,
1323                                             NestedNameSpecifierLoc QualifierLoc,
1324                                             QualType T) {
1325   if (const TagType *TT = T->getAs<TagType>()) {
1326     TagDecl* TD = TT->getDecl();
1327 
1328     SourceLocation TagLocation = KeywordLoc;
1329 
1330     IdentifierInfo *Id = TD->getIdentifier();
1331 
1332     // TODO: should we even warn on struct/class mismatches for this?  Seems
1333     // like it's likely to produce a lot of spurious errors.
1334     if (Id && Keyword != ETK_None && Keyword != ETK_Typename) {
1335       TagTypeKind Kind = TypeWithKeyword::getTagTypeKindForKeyword(Keyword);
1336       if (!SemaRef.isAcceptableTagRedeclaration(TD, Kind, /*isDefinition*/false,
1337                                                 TagLocation, Id)) {
1338         SemaRef.Diag(TagLocation, diag::err_use_with_wrong_tag)
1339           << Id
1340           << FixItHint::CreateReplacement(SourceRange(TagLocation),
1341                                           TD->getKindName());
1342         SemaRef.Diag(TD->getLocation(), diag::note_previous_use);
1343       }
1344     }
1345   }
1346 
1347   return TreeTransform<TemplateInstantiator>::RebuildElaboratedType(KeywordLoc,
1348                                                                     Keyword,
1349                                                                   QualifierLoc,
1350                                                                     T);
1351 }
1352 
TransformTemplateName(CXXScopeSpec & SS,TemplateName Name,SourceLocation NameLoc,QualType ObjectType,NamedDecl * FirstQualifierInScope,bool AllowInjectedClassName)1353 TemplateName TemplateInstantiator::TransformTemplateName(
1354     CXXScopeSpec &SS, TemplateName Name, SourceLocation NameLoc,
1355     QualType ObjectType, NamedDecl *FirstQualifierInScope,
1356     bool AllowInjectedClassName) {
1357   if (TemplateTemplateParmDecl *TTP
1358        = dyn_cast_or_null<TemplateTemplateParmDecl>(Name.getAsTemplateDecl())) {
1359     if (TTP->getDepth() < TemplateArgs.getNumLevels()) {
1360       // If the corresponding template argument is NULL or non-existent, it's
1361       // because we are performing instantiation from explicitly-specified
1362       // template arguments in a function template, but there were some
1363       // arguments left unspecified.
1364       if (!TemplateArgs.hasTemplateArgument(TTP->getDepth(),
1365                                             TTP->getPosition()))
1366         return Name;
1367 
1368       TemplateArgument Arg = TemplateArgs(TTP->getDepth(), TTP->getPosition());
1369 
1370       if (TemplateArgs.isRewrite()) {
1371         // We're rewriting the template parameter as a reference to another
1372         // template parameter.
1373         if (Arg.getKind() == TemplateArgument::Pack) {
1374           assert(Arg.pack_size() == 1 && Arg.pack_begin()->isPackExpansion() &&
1375                  "unexpected pack arguments in template rewrite");
1376           Arg = Arg.pack_begin()->getPackExpansionPattern();
1377         }
1378         assert(Arg.getKind() == TemplateArgument::Template &&
1379                "unexpected nontype template argument kind in template rewrite");
1380         return Arg.getAsTemplate();
1381       }
1382 
1383       if (TTP->isParameterPack()) {
1384         assert(Arg.getKind() == TemplateArgument::Pack &&
1385                "Missing argument pack");
1386 
1387         if (getSema().ArgumentPackSubstitutionIndex == -1) {
1388           // We have the template argument pack to substitute, but we're not
1389           // actually expanding the enclosing pack expansion yet. So, just
1390           // keep the entire argument pack.
1391           return getSema().Context.getSubstTemplateTemplateParmPack(TTP, Arg);
1392         }
1393 
1394         Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1395       }
1396 
1397       TemplateName Template = Arg.getAsTemplate().getNameToSubstitute();
1398       assert(!Template.isNull() && "Null template template argument");
1399       assert(!Template.getAsQualifiedTemplateName() &&
1400              "template decl to substitute is qualified?");
1401 
1402       Template = getSema().Context.getSubstTemplateTemplateParm(TTP, Template);
1403       return Template;
1404     }
1405   }
1406 
1407   if (SubstTemplateTemplateParmPackStorage *SubstPack
1408       = Name.getAsSubstTemplateTemplateParmPack()) {
1409     if (getSema().ArgumentPackSubstitutionIndex == -1)
1410       return Name;
1411 
1412     TemplateArgument Arg = SubstPack->getArgumentPack();
1413     Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1414     return Arg.getAsTemplate().getNameToSubstitute();
1415   }
1416 
1417   return inherited::TransformTemplateName(SS, Name, NameLoc, ObjectType,
1418                                           FirstQualifierInScope,
1419                                           AllowInjectedClassName);
1420 }
1421 
1422 ExprResult
TransformPredefinedExpr(PredefinedExpr * E)1423 TemplateInstantiator::TransformPredefinedExpr(PredefinedExpr *E) {
1424   if (!E->isTypeDependent())
1425     return E;
1426 
1427   return getSema().BuildPredefinedExpr(E->getLocation(), E->getIdentKind());
1428 }
1429 
1430 ExprResult
TransformTemplateParmRefExpr(DeclRefExpr * E,NonTypeTemplateParmDecl * NTTP)1431 TemplateInstantiator::TransformTemplateParmRefExpr(DeclRefExpr *E,
1432                                                NonTypeTemplateParmDecl *NTTP) {
1433   // If the corresponding template argument is NULL or non-existent, it's
1434   // because we are performing instantiation from explicitly-specified
1435   // template arguments in a function template, but there were some
1436   // arguments left unspecified.
1437   if (!TemplateArgs.hasTemplateArgument(NTTP->getDepth(),
1438                                         NTTP->getPosition()))
1439     return E;
1440 
1441   TemplateArgument Arg = TemplateArgs(NTTP->getDepth(), NTTP->getPosition());
1442 
1443   if (TemplateArgs.isRewrite()) {
1444     // We're rewriting the template parameter as a reference to another
1445     // template parameter.
1446     if (Arg.getKind() == TemplateArgument::Pack) {
1447       assert(Arg.pack_size() == 1 && Arg.pack_begin()->isPackExpansion() &&
1448              "unexpected pack arguments in template rewrite");
1449       Arg = Arg.pack_begin()->getPackExpansionPattern();
1450     }
1451     assert(Arg.getKind() == TemplateArgument::Expression &&
1452            "unexpected nontype template argument kind in template rewrite");
1453     // FIXME: This can lead to the same subexpression appearing multiple times
1454     // in a complete expression.
1455     return Arg.getAsExpr();
1456   }
1457 
1458   if (NTTP->isParameterPack()) {
1459     assert(Arg.getKind() == TemplateArgument::Pack &&
1460            "Missing argument pack");
1461 
1462     if (getSema().ArgumentPackSubstitutionIndex == -1) {
1463       // We have an argument pack, but we can't select a particular argument
1464       // out of it yet. Therefore, we'll build an expression to hold on to that
1465       // argument pack.
1466       QualType TargetType = SemaRef.SubstType(NTTP->getType(), TemplateArgs,
1467                                               E->getLocation(),
1468                                               NTTP->getDeclName());
1469       if (TargetType.isNull())
1470         return ExprError();
1471 
1472       QualType ExprType = TargetType.getNonLValueExprType(SemaRef.Context);
1473       if (TargetType->isRecordType())
1474         ExprType.addConst();
1475 
1476       return new (SemaRef.Context) SubstNonTypeTemplateParmPackExpr(
1477           ExprType, TargetType->isReferenceType() ? VK_LValue : VK_RValue, NTTP,
1478           E->getLocation(), Arg);
1479     }
1480 
1481     Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1482   }
1483 
1484   return transformNonTypeTemplateParmRef(NTTP, E->getLocation(), Arg);
1485 }
1486 
1487 const LoopHintAttr *
TransformLoopHintAttr(const LoopHintAttr * LH)1488 TemplateInstantiator::TransformLoopHintAttr(const LoopHintAttr *LH) {
1489   Expr *TransformedExpr = getDerived().TransformExpr(LH->getValue()).get();
1490 
1491   if (TransformedExpr == LH->getValue())
1492     return LH;
1493 
1494   // Generate error if there is a problem with the value.
1495   if (getSema().CheckLoopHintExpr(TransformedExpr, LH->getLocation()))
1496     return LH;
1497 
1498   // Create new LoopHintValueAttr with integral expression in place of the
1499   // non-type template parameter.
1500   return LoopHintAttr::CreateImplicit(getSema().Context, LH->getOption(),
1501                                       LH->getState(), TransformedExpr, *LH);
1502 }
1503 
transformNonTypeTemplateParmRef(NonTypeTemplateParmDecl * parm,SourceLocation loc,TemplateArgument arg)1504 ExprResult TemplateInstantiator::transformNonTypeTemplateParmRef(
1505                                                  NonTypeTemplateParmDecl *parm,
1506                                                  SourceLocation loc,
1507                                                  TemplateArgument arg) {
1508   ExprResult result;
1509 
1510   // Determine the substituted parameter type. We can usually infer this from
1511   // the template argument, but not always.
1512   auto SubstParamType = [&] {
1513     QualType T;
1514     if (parm->isExpandedParameterPack())
1515       T = parm->getExpansionType(SemaRef.ArgumentPackSubstitutionIndex);
1516     else
1517       T = parm->getType();
1518     if (parm->isParameterPack() && isa<PackExpansionType>(T))
1519       T = cast<PackExpansionType>(T)->getPattern();
1520     return SemaRef.SubstType(T, TemplateArgs, loc, parm->getDeclName());
1521   };
1522 
1523   bool refParam = false;
1524 
1525   // The template argument itself might be an expression, in which case we just
1526   // return that expression. This happens when substituting into an alias
1527   // template.
1528   if (arg.getKind() == TemplateArgument::Expression) {
1529     Expr *argExpr = arg.getAsExpr();
1530     result = argExpr;
1531     if (argExpr->isLValue()) {
1532       if (argExpr->getType()->isRecordType()) {
1533         // Check whether the parameter was actually a reference.
1534         QualType paramType = SubstParamType();
1535         if (paramType.isNull())
1536           return ExprError();
1537         refParam = paramType->isReferenceType();
1538       } else {
1539         refParam = true;
1540       }
1541     }
1542   } else if (arg.getKind() == TemplateArgument::Declaration ||
1543              arg.getKind() == TemplateArgument::NullPtr) {
1544     ValueDecl *VD;
1545     if (arg.getKind() == TemplateArgument::Declaration) {
1546       VD = arg.getAsDecl();
1547 
1548       // Find the instantiation of the template argument.  This is
1549       // required for nested templates.
1550       VD = cast_or_null<ValueDecl>(
1551              getSema().FindInstantiatedDecl(loc, VD, TemplateArgs));
1552       if (!VD)
1553         return ExprError();
1554     } else {
1555       // Propagate NULL template argument.
1556       VD = nullptr;
1557     }
1558 
1559     QualType paramType = VD ? arg.getParamTypeForDecl() : arg.getNullPtrType();
1560     assert(!paramType.isNull() && "type substitution failed for param type");
1561     assert(!paramType->isDependentType() && "param type still dependent");
1562     result = SemaRef.BuildExpressionFromDeclTemplateArgument(arg, paramType, loc);
1563     refParam = paramType->isReferenceType();
1564   } else {
1565     result = SemaRef.BuildExpressionFromIntegralTemplateArgument(arg, loc);
1566     assert(result.isInvalid() ||
1567            SemaRef.Context.hasSameType(result.get()->getType(),
1568                                        arg.getIntegralType()));
1569   }
1570 
1571   if (result.isInvalid())
1572     return ExprError();
1573 
1574   Expr *resultExpr = result.get();
1575   return new (SemaRef.Context) SubstNonTypeTemplateParmExpr(
1576       resultExpr->getType(), resultExpr->getValueKind(), loc, parm, refParam,
1577       resultExpr);
1578 }
1579 
1580 ExprResult
TransformSubstNonTypeTemplateParmPackExpr(SubstNonTypeTemplateParmPackExpr * E)1581 TemplateInstantiator::TransformSubstNonTypeTemplateParmPackExpr(
1582                                           SubstNonTypeTemplateParmPackExpr *E) {
1583   if (getSema().ArgumentPackSubstitutionIndex == -1) {
1584     // We aren't expanding the parameter pack, so just return ourselves.
1585     return E;
1586   }
1587 
1588   TemplateArgument Arg = E->getArgumentPack();
1589   Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1590   return transformNonTypeTemplateParmRef(E->getParameterPack(),
1591                                          E->getParameterPackLocation(),
1592                                          Arg);
1593 }
1594 
1595 ExprResult
TransformSubstNonTypeTemplateParmExpr(SubstNonTypeTemplateParmExpr * E)1596 TemplateInstantiator::TransformSubstNonTypeTemplateParmExpr(
1597                                           SubstNonTypeTemplateParmExpr *E) {
1598   ExprResult SubstReplacement = TransformExpr(E->getReplacement());
1599   if (SubstReplacement.isInvalid())
1600     return true;
1601   QualType SubstType = TransformType(E->getParameterType(getSema().Context));
1602   if (SubstType.isNull())
1603     return true;
1604   // The type may have been previously dependent and not now, which means we
1605   // might have to implicit cast the argument to the new type, for example:
1606   // template<auto T, decltype(T) U>
1607   // concept C = sizeof(U) == 4;
1608   // void foo() requires C<2, 'a'> { }
1609   // When normalizing foo(), we first form the normalized constraints of C:
1610   // AtomicExpr(sizeof(U) == 4,
1611   //            U=SubstNonTypeTemplateParmExpr(Param=U,
1612   //                                           Expr=DeclRef(U),
1613   //                                           Type=decltype(T)))
1614   // Then we substitute T = 2, U = 'a' into the parameter mapping, and need to
1615   // produce:
1616   // AtomicExpr(sizeof(U) == 4,
1617   //            U=SubstNonTypeTemplateParmExpr(Param=U,
1618   //                                           Expr=ImpCast(
1619   //                                               decltype(2),
1620   //                                               SubstNTTPE(Param=U, Expr='a',
1621   //                                                          Type=char)),
1622   //                                           Type=decltype(2)))
1623   // The call to CheckTemplateArgument here produces the ImpCast.
1624   TemplateArgument Converted;
1625   if (SemaRef.CheckTemplateArgument(E->getParameter(), SubstType,
1626                                     SubstReplacement.get(),
1627                                     Converted).isInvalid())
1628     return true;
1629   return transformNonTypeTemplateParmRef(E->getParameter(),
1630                                          E->getExprLoc(), Converted);
1631 }
1632 
RebuildVarDeclRefExpr(VarDecl * PD,SourceLocation Loc)1633 ExprResult TemplateInstantiator::RebuildVarDeclRefExpr(VarDecl *PD,
1634                                                        SourceLocation Loc) {
1635   DeclarationNameInfo NameInfo(PD->getDeclName(), Loc);
1636   return getSema().BuildDeclarationNameExpr(CXXScopeSpec(), NameInfo, PD);
1637 }
1638 
1639 ExprResult
TransformFunctionParmPackExpr(FunctionParmPackExpr * E)1640 TemplateInstantiator::TransformFunctionParmPackExpr(FunctionParmPackExpr *E) {
1641   if (getSema().ArgumentPackSubstitutionIndex != -1) {
1642     // We can expand this parameter pack now.
1643     VarDecl *D = E->getExpansion(getSema().ArgumentPackSubstitutionIndex);
1644     VarDecl *VD = cast_or_null<VarDecl>(TransformDecl(E->getExprLoc(), D));
1645     if (!VD)
1646       return ExprError();
1647     return RebuildVarDeclRefExpr(VD, E->getExprLoc());
1648   }
1649 
1650   QualType T = TransformType(E->getType());
1651   if (T.isNull())
1652     return ExprError();
1653 
1654   // Transform each of the parameter expansions into the corresponding
1655   // parameters in the instantiation of the function decl.
1656   SmallVector<VarDecl *, 8> Vars;
1657   Vars.reserve(E->getNumExpansions());
1658   for (FunctionParmPackExpr::iterator I = E->begin(), End = E->end();
1659        I != End; ++I) {
1660     VarDecl *D = cast_or_null<VarDecl>(TransformDecl(E->getExprLoc(), *I));
1661     if (!D)
1662       return ExprError();
1663     Vars.push_back(D);
1664   }
1665 
1666   auto *PackExpr =
1667       FunctionParmPackExpr::Create(getSema().Context, T, E->getParameterPack(),
1668                                    E->getParameterPackLocation(), Vars);
1669   getSema().MarkFunctionParmPackReferenced(PackExpr);
1670   return PackExpr;
1671 }
1672 
1673 ExprResult
TransformFunctionParmPackRefExpr(DeclRefExpr * E,VarDecl * PD)1674 TemplateInstantiator::TransformFunctionParmPackRefExpr(DeclRefExpr *E,
1675                                                        VarDecl *PD) {
1676   typedef LocalInstantiationScope::DeclArgumentPack DeclArgumentPack;
1677   llvm::PointerUnion<Decl *, DeclArgumentPack *> *Found
1678     = getSema().CurrentInstantiationScope->findInstantiationOf(PD);
1679   assert(Found && "no instantiation for parameter pack");
1680 
1681   Decl *TransformedDecl;
1682   if (DeclArgumentPack *Pack = Found->dyn_cast<DeclArgumentPack *>()) {
1683     // If this is a reference to a function parameter pack which we can
1684     // substitute but can't yet expand, build a FunctionParmPackExpr for it.
1685     if (getSema().ArgumentPackSubstitutionIndex == -1) {
1686       QualType T = TransformType(E->getType());
1687       if (T.isNull())
1688         return ExprError();
1689       auto *PackExpr = FunctionParmPackExpr::Create(getSema().Context, T, PD,
1690                                                     E->getExprLoc(), *Pack);
1691       getSema().MarkFunctionParmPackReferenced(PackExpr);
1692       return PackExpr;
1693     }
1694 
1695     TransformedDecl = (*Pack)[getSema().ArgumentPackSubstitutionIndex];
1696   } else {
1697     TransformedDecl = Found->get<Decl*>();
1698   }
1699 
1700   // We have either an unexpanded pack or a specific expansion.
1701   return RebuildVarDeclRefExpr(cast<VarDecl>(TransformedDecl), E->getExprLoc());
1702 }
1703 
1704 ExprResult
TransformDeclRefExpr(DeclRefExpr * E)1705 TemplateInstantiator::TransformDeclRefExpr(DeclRefExpr *E) {
1706   NamedDecl *D = E->getDecl();
1707 
1708   // Handle references to non-type template parameters and non-type template
1709   // parameter packs.
1710   if (NonTypeTemplateParmDecl *NTTP = dyn_cast<NonTypeTemplateParmDecl>(D)) {
1711     if (NTTP->getDepth() < TemplateArgs.getNumLevels())
1712       return TransformTemplateParmRefExpr(E, NTTP);
1713 
1714     // We have a non-type template parameter that isn't fully substituted;
1715     // FindInstantiatedDecl will find it in the local instantiation scope.
1716   }
1717 
1718   // Handle references to function parameter packs.
1719   if (VarDecl *PD = dyn_cast<VarDecl>(D))
1720     if (PD->isParameterPack())
1721       return TransformFunctionParmPackRefExpr(E, PD);
1722 
1723   return TreeTransform<TemplateInstantiator>::TransformDeclRefExpr(E);
1724 }
1725 
TransformCXXDefaultArgExpr(CXXDefaultArgExpr * E)1726 ExprResult TemplateInstantiator::TransformCXXDefaultArgExpr(
1727     CXXDefaultArgExpr *E) {
1728   assert(!cast<FunctionDecl>(E->getParam()->getDeclContext())->
1729              getDescribedFunctionTemplate() &&
1730          "Default arg expressions are never formed in dependent cases.");
1731   return SemaRef.BuildCXXDefaultArgExpr(E->getUsedLocation(),
1732                            cast<FunctionDecl>(E->getParam()->getDeclContext()),
1733                                         E->getParam());
1734 }
1735 
1736 template<typename Fn>
TransformFunctionProtoType(TypeLocBuilder & TLB,FunctionProtoTypeLoc TL,CXXRecordDecl * ThisContext,Qualifiers ThisTypeQuals,Fn TransformExceptionSpec)1737 QualType TemplateInstantiator::TransformFunctionProtoType(TypeLocBuilder &TLB,
1738                                  FunctionProtoTypeLoc TL,
1739                                  CXXRecordDecl *ThisContext,
1740                                  Qualifiers ThisTypeQuals,
1741                                  Fn TransformExceptionSpec) {
1742   // We need a local instantiation scope for this function prototype.
1743   LocalInstantiationScope Scope(SemaRef, /*CombineWithOuterScope=*/true);
1744   return inherited::TransformFunctionProtoType(
1745       TLB, TL, ThisContext, ThisTypeQuals, TransformExceptionSpec);
1746 }
1747 
1748 ParmVarDecl *
TransformFunctionTypeParam(ParmVarDecl * OldParm,int indexAdjustment,Optional<unsigned> NumExpansions,bool ExpectParameterPack)1749 TemplateInstantiator::TransformFunctionTypeParam(ParmVarDecl *OldParm,
1750                                                  int indexAdjustment,
1751                                                Optional<unsigned> NumExpansions,
1752                                                  bool ExpectParameterPack) {
1753   auto NewParm =
1754       SemaRef.SubstParmVarDecl(OldParm, TemplateArgs, indexAdjustment,
1755                                NumExpansions, ExpectParameterPack);
1756   if (NewParm && SemaRef.getLangOpts().OpenCL)
1757     SemaRef.deduceOpenCLAddressSpace(NewParm);
1758   return NewParm;
1759 }
1760 
1761 QualType
TransformTemplateTypeParmType(TypeLocBuilder & TLB,TemplateTypeParmTypeLoc TL)1762 TemplateInstantiator::TransformTemplateTypeParmType(TypeLocBuilder &TLB,
1763                                                 TemplateTypeParmTypeLoc TL) {
1764   const TemplateTypeParmType *T = TL.getTypePtr();
1765   if (T->getDepth() < TemplateArgs.getNumLevels()) {
1766     // Replace the template type parameter with its corresponding
1767     // template argument.
1768 
1769     // If the corresponding template argument is NULL or doesn't exist, it's
1770     // because we are performing instantiation from explicitly-specified
1771     // template arguments in a function template class, but there were some
1772     // arguments left unspecified.
1773     if (!TemplateArgs.hasTemplateArgument(T->getDepth(), T->getIndex())) {
1774       TemplateTypeParmTypeLoc NewTL
1775         = TLB.push<TemplateTypeParmTypeLoc>(TL.getType());
1776       NewTL.setNameLoc(TL.getNameLoc());
1777       return TL.getType();
1778     }
1779 
1780     TemplateArgument Arg = TemplateArgs(T->getDepth(), T->getIndex());
1781 
1782     if (TemplateArgs.isRewrite()) {
1783       // We're rewriting the template parameter as a reference to another
1784       // template parameter.
1785       if (Arg.getKind() == TemplateArgument::Pack) {
1786         assert(Arg.pack_size() == 1 && Arg.pack_begin()->isPackExpansion() &&
1787                "unexpected pack arguments in template rewrite");
1788         Arg = Arg.pack_begin()->getPackExpansionPattern();
1789       }
1790       assert(Arg.getKind() == TemplateArgument::Type &&
1791              "unexpected nontype template argument kind in template rewrite");
1792       QualType NewT = Arg.getAsType();
1793       assert(isa<TemplateTypeParmType>(NewT) &&
1794              "type parm not rewritten to type parm");
1795       auto NewTL = TLB.push<TemplateTypeParmTypeLoc>(NewT);
1796       NewTL.setNameLoc(TL.getNameLoc());
1797       return NewT;
1798     }
1799 
1800     if (T->isParameterPack()) {
1801       assert(Arg.getKind() == TemplateArgument::Pack &&
1802              "Missing argument pack");
1803 
1804       if (getSema().ArgumentPackSubstitutionIndex == -1) {
1805         // We have the template argument pack, but we're not expanding the
1806         // enclosing pack expansion yet. Just save the template argument
1807         // pack for later substitution.
1808         QualType Result
1809           = getSema().Context.getSubstTemplateTypeParmPackType(T, Arg);
1810         SubstTemplateTypeParmPackTypeLoc NewTL
1811           = TLB.push<SubstTemplateTypeParmPackTypeLoc>(Result);
1812         NewTL.setNameLoc(TL.getNameLoc());
1813         return Result;
1814       }
1815 
1816       Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1817     }
1818 
1819     assert(Arg.getKind() == TemplateArgument::Type &&
1820            "Template argument kind mismatch");
1821 
1822     QualType Replacement = Arg.getAsType();
1823 
1824     // TODO: only do this uniquing once, at the start of instantiation.
1825     QualType Result
1826       = getSema().Context.getSubstTemplateTypeParmType(T, Replacement);
1827     SubstTemplateTypeParmTypeLoc NewTL
1828       = TLB.push<SubstTemplateTypeParmTypeLoc>(Result);
1829     NewTL.setNameLoc(TL.getNameLoc());
1830     return Result;
1831   }
1832 
1833   // The template type parameter comes from an inner template (e.g.,
1834   // the template parameter list of a member template inside the
1835   // template we are instantiating). Create a new template type
1836   // parameter with the template "level" reduced by one.
1837   TemplateTypeParmDecl *NewTTPDecl = nullptr;
1838   if (TemplateTypeParmDecl *OldTTPDecl = T->getDecl())
1839     NewTTPDecl = cast_or_null<TemplateTypeParmDecl>(
1840                                   TransformDecl(TL.getNameLoc(), OldTTPDecl));
1841 
1842   QualType Result = getSema().Context.getTemplateTypeParmType(
1843       T->getDepth() - TemplateArgs.getNumSubstitutedLevels(), T->getIndex(),
1844       T->isParameterPack(), NewTTPDecl);
1845   TemplateTypeParmTypeLoc NewTL = TLB.push<TemplateTypeParmTypeLoc>(Result);
1846   NewTL.setNameLoc(TL.getNameLoc());
1847   return Result;
1848 }
1849 
1850 QualType
TransformSubstTemplateTypeParmPackType(TypeLocBuilder & TLB,SubstTemplateTypeParmPackTypeLoc TL)1851 TemplateInstantiator::TransformSubstTemplateTypeParmPackType(
1852                                                             TypeLocBuilder &TLB,
1853                                          SubstTemplateTypeParmPackTypeLoc TL) {
1854   if (getSema().ArgumentPackSubstitutionIndex == -1) {
1855     // We aren't expanding the parameter pack, so just return ourselves.
1856     SubstTemplateTypeParmPackTypeLoc NewTL
1857       = TLB.push<SubstTemplateTypeParmPackTypeLoc>(TL.getType());
1858     NewTL.setNameLoc(TL.getNameLoc());
1859     return TL.getType();
1860   }
1861 
1862   TemplateArgument Arg = TL.getTypePtr()->getArgumentPack();
1863   Arg = getPackSubstitutedTemplateArgument(getSema(), Arg);
1864   QualType Result = Arg.getAsType();
1865 
1866   Result = getSema().Context.getSubstTemplateTypeParmType(
1867                                       TL.getTypePtr()->getReplacedParameter(),
1868                                                           Result);
1869   SubstTemplateTypeParmTypeLoc NewTL
1870     = TLB.push<SubstTemplateTypeParmTypeLoc>(Result);
1871   NewTL.setNameLoc(TL.getNameLoc());
1872   return Result;
1873 }
1874 
1875 template<typename EntityPrinter>
1876 static concepts::Requirement::SubstitutionDiagnostic *
createSubstDiag(Sema & S,TemplateDeductionInfo & Info,EntityPrinter Printer)1877 createSubstDiag(Sema &S, TemplateDeductionInfo &Info, EntityPrinter Printer) {
1878   SmallString<128> Message;
1879   SourceLocation ErrorLoc;
1880   if (Info.hasSFINAEDiagnostic()) {
1881     PartialDiagnosticAt PDA(SourceLocation(),
1882                             PartialDiagnostic::NullDiagnostic{});
1883     Info.takeSFINAEDiagnostic(PDA);
1884     PDA.second.EmitToString(S.getDiagnostics(), Message);
1885     ErrorLoc = PDA.first;
1886   } else {
1887     ErrorLoc = Info.getLocation();
1888   }
1889   char *MessageBuf = new (S.Context) char[Message.size()];
1890   std::copy(Message.begin(), Message.end(), MessageBuf);
1891   SmallString<128> Entity;
1892   llvm::raw_svector_ostream OS(Entity);
1893   Printer(OS);
1894   char *EntityBuf = new (S.Context) char[Entity.size()];
1895   std::copy(Entity.begin(), Entity.end(), EntityBuf);
1896   return new (S.Context) concepts::Requirement::SubstitutionDiagnostic{
1897       StringRef(EntityBuf, Entity.size()), ErrorLoc,
1898       StringRef(MessageBuf, Message.size())};
1899 }
1900 
1901 concepts::TypeRequirement *
TransformTypeRequirement(concepts::TypeRequirement * Req)1902 TemplateInstantiator::TransformTypeRequirement(concepts::TypeRequirement *Req) {
1903   if (!Req->isDependent() && !AlwaysRebuild())
1904     return Req;
1905   if (Req->isSubstitutionFailure()) {
1906     if (AlwaysRebuild())
1907       return RebuildTypeRequirement(
1908               Req->getSubstitutionDiagnostic());
1909     return Req;
1910   }
1911 
1912   Sema::SFINAETrap Trap(SemaRef);
1913   TemplateDeductionInfo Info(Req->getType()->getTypeLoc().getBeginLoc());
1914   Sema::InstantiatingTemplate TypeInst(SemaRef,
1915       Req->getType()->getTypeLoc().getBeginLoc(), Req, Info,
1916       Req->getType()->getTypeLoc().getSourceRange());
1917   if (TypeInst.isInvalid())
1918     return nullptr;
1919   TypeSourceInfo *TransType = TransformType(Req->getType());
1920   if (!TransType || Trap.hasErrorOccurred())
1921     return RebuildTypeRequirement(createSubstDiag(SemaRef, Info,
1922         [&] (llvm::raw_ostream& OS) {
1923             Req->getType()->getType().print(OS, SemaRef.getPrintingPolicy());
1924         }));
1925   return RebuildTypeRequirement(TransType);
1926 }
1927 
1928 concepts::ExprRequirement *
TransformExprRequirement(concepts::ExprRequirement * Req)1929 TemplateInstantiator::TransformExprRequirement(concepts::ExprRequirement *Req) {
1930   if (!Req->isDependent() && !AlwaysRebuild())
1931     return Req;
1932 
1933   Sema::SFINAETrap Trap(SemaRef);
1934   TemplateDeductionInfo Info(Req->getExpr()->getBeginLoc());
1935 
1936   llvm::PointerUnion<Expr *, concepts::Requirement::SubstitutionDiagnostic *>
1937       TransExpr;
1938   if (Req->isExprSubstitutionFailure())
1939     TransExpr = Req->getExprSubstitutionDiagnostic();
1940   else {
1941     Sema::InstantiatingTemplate ExprInst(SemaRef, Req->getExpr()->getBeginLoc(),
1942                                          Req, Info,
1943                                          Req->getExpr()->getSourceRange());
1944     if (ExprInst.isInvalid())
1945       return nullptr;
1946     ExprResult TransExprRes = TransformExpr(Req->getExpr());
1947     if (TransExprRes.isInvalid() || Trap.hasErrorOccurred())
1948       TransExpr = createSubstDiag(SemaRef, Info,
1949           [&] (llvm::raw_ostream& OS) {
1950               Req->getExpr()->printPretty(OS, nullptr,
1951                                           SemaRef.getPrintingPolicy());
1952           });
1953     else
1954       TransExpr = TransExprRes.get();
1955   }
1956 
1957   llvm::Optional<concepts::ExprRequirement::ReturnTypeRequirement> TransRetReq;
1958   const auto &RetReq = Req->getReturnTypeRequirement();
1959   if (RetReq.isEmpty())
1960     TransRetReq.emplace();
1961   else if (RetReq.isSubstitutionFailure())
1962     TransRetReq.emplace(RetReq.getSubstitutionDiagnostic());
1963   else if (RetReq.isTypeConstraint()) {
1964     TemplateParameterList *OrigTPL =
1965         RetReq.getTypeConstraintTemplateParameterList();
1966     Sema::InstantiatingTemplate TPLInst(SemaRef, OrigTPL->getTemplateLoc(),
1967                                         Req, Info, OrigTPL->getSourceRange());
1968     if (TPLInst.isInvalid())
1969       return nullptr;
1970     TemplateParameterList *TPL =
1971         TransformTemplateParameterList(OrigTPL);
1972     if (!TPL)
1973       TransRetReq.emplace(createSubstDiag(SemaRef, Info,
1974           [&] (llvm::raw_ostream& OS) {
1975               RetReq.getTypeConstraint()->getImmediatelyDeclaredConstraint()
1976                   ->printPretty(OS, nullptr, SemaRef.getPrintingPolicy());
1977           }));
1978     else {
1979       TPLInst.Clear();
1980       TransRetReq.emplace(TPL);
1981     }
1982   }
1983   assert(TransRetReq.hasValue() &&
1984          "All code paths leading here must set TransRetReq");
1985   if (Expr *E = TransExpr.dyn_cast<Expr *>())
1986     return RebuildExprRequirement(E, Req->isSimple(), Req->getNoexceptLoc(),
1987                                   std::move(*TransRetReq));
1988   return RebuildExprRequirement(
1989       TransExpr.get<concepts::Requirement::SubstitutionDiagnostic *>(),
1990       Req->isSimple(), Req->getNoexceptLoc(), std::move(*TransRetReq));
1991 }
1992 
1993 concepts::NestedRequirement *
TransformNestedRequirement(concepts::NestedRequirement * Req)1994 TemplateInstantiator::TransformNestedRequirement(
1995     concepts::NestedRequirement *Req) {
1996   if (!Req->isDependent() && !AlwaysRebuild())
1997     return Req;
1998   if (Req->isSubstitutionFailure()) {
1999     if (AlwaysRebuild())
2000       return RebuildNestedRequirement(
2001           Req->getSubstitutionDiagnostic());
2002     return Req;
2003   }
2004   Sema::InstantiatingTemplate ReqInst(SemaRef,
2005       Req->getConstraintExpr()->getBeginLoc(), Req,
2006       Sema::InstantiatingTemplate::ConstraintsCheck{},
2007       Req->getConstraintExpr()->getSourceRange());
2008 
2009   ExprResult TransConstraint;
2010   TemplateDeductionInfo Info(Req->getConstraintExpr()->getBeginLoc());
2011   {
2012     EnterExpressionEvaluationContext ContextRAII(
2013         SemaRef, Sema::ExpressionEvaluationContext::ConstantEvaluated);
2014     Sema::SFINAETrap Trap(SemaRef);
2015     Sema::InstantiatingTemplate ConstrInst(SemaRef,
2016         Req->getConstraintExpr()->getBeginLoc(), Req, Info,
2017         Req->getConstraintExpr()->getSourceRange());
2018     if (ConstrInst.isInvalid())
2019       return nullptr;
2020     TransConstraint = TransformExpr(Req->getConstraintExpr());
2021     if (TransConstraint.isInvalid() || Trap.hasErrorOccurred())
2022       return RebuildNestedRequirement(createSubstDiag(SemaRef, Info,
2023           [&] (llvm::raw_ostream& OS) {
2024               Req->getConstraintExpr()->printPretty(OS, nullptr,
2025                                                     SemaRef.getPrintingPolicy());
2026           }));
2027   }
2028   return RebuildNestedRequirement(TransConstraint.get());
2029 }
2030 
2031 
2032 /// Perform substitution on the type T with a given set of template
2033 /// arguments.
2034 ///
2035 /// This routine substitutes the given template arguments into the
2036 /// type T and produces the instantiated type.
2037 ///
2038 /// \param T the type into which the template arguments will be
2039 /// substituted. If this type is not dependent, it will be returned
2040 /// immediately.
2041 ///
2042 /// \param Args the template arguments that will be
2043 /// substituted for the top-level template parameters within T.
2044 ///
2045 /// \param Loc the location in the source code where this substitution
2046 /// is being performed. It will typically be the location of the
2047 /// declarator (if we're instantiating the type of some declaration)
2048 /// or the location of the type in the source code (if, e.g., we're
2049 /// instantiating the type of a cast expression).
2050 ///
2051 /// \param Entity the name of the entity associated with a declaration
2052 /// being instantiated (if any). May be empty to indicate that there
2053 /// is no such entity (if, e.g., this is a type that occurs as part of
2054 /// a cast expression) or that the entity has no name (e.g., an
2055 /// unnamed function parameter).
2056 ///
2057 /// \param AllowDeducedTST Whether a DeducedTemplateSpecializationType is
2058 /// acceptable as the top level type of the result.
2059 ///
2060 /// \returns If the instantiation succeeds, the instantiated
2061 /// type. Otherwise, produces diagnostics and returns a NULL type.
SubstType(TypeSourceInfo * T,const MultiLevelTemplateArgumentList & Args,SourceLocation Loc,DeclarationName Entity,bool AllowDeducedTST)2062 TypeSourceInfo *Sema::SubstType(TypeSourceInfo *T,
2063                                 const MultiLevelTemplateArgumentList &Args,
2064                                 SourceLocation Loc,
2065                                 DeclarationName Entity,
2066                                 bool AllowDeducedTST) {
2067   assert(!CodeSynthesisContexts.empty() &&
2068          "Cannot perform an instantiation without some context on the "
2069          "instantiation stack");
2070 
2071   if (!T->getType()->isInstantiationDependentType() &&
2072       !T->getType()->isVariablyModifiedType())
2073     return T;
2074 
2075   TemplateInstantiator Instantiator(*this, Args, Loc, Entity);
2076   return AllowDeducedTST ? Instantiator.TransformTypeWithDeducedTST(T)
2077                          : Instantiator.TransformType(T);
2078 }
2079 
SubstType(TypeLoc TL,const MultiLevelTemplateArgumentList & Args,SourceLocation Loc,DeclarationName Entity)2080 TypeSourceInfo *Sema::SubstType(TypeLoc TL,
2081                                 const MultiLevelTemplateArgumentList &Args,
2082                                 SourceLocation Loc,
2083                                 DeclarationName Entity) {
2084   assert(!CodeSynthesisContexts.empty() &&
2085          "Cannot perform an instantiation without some context on the "
2086          "instantiation stack");
2087 
2088   if (TL.getType().isNull())
2089     return nullptr;
2090 
2091   if (!TL.getType()->isInstantiationDependentType() &&
2092       !TL.getType()->isVariablyModifiedType()) {
2093     // FIXME: Make a copy of the TypeLoc data here, so that we can
2094     // return a new TypeSourceInfo. Inefficient!
2095     TypeLocBuilder TLB;
2096     TLB.pushFullCopy(TL);
2097     return TLB.getTypeSourceInfo(Context, TL.getType());
2098   }
2099 
2100   TemplateInstantiator Instantiator(*this, Args, Loc, Entity);
2101   TypeLocBuilder TLB;
2102   TLB.reserve(TL.getFullDataSize());
2103   QualType Result = Instantiator.TransformType(TLB, TL);
2104   if (Result.isNull())
2105     return nullptr;
2106 
2107   return TLB.getTypeSourceInfo(Context, Result);
2108 }
2109 
2110 /// Deprecated form of the above.
SubstType(QualType T,const MultiLevelTemplateArgumentList & TemplateArgs,SourceLocation Loc,DeclarationName Entity)2111 QualType Sema::SubstType(QualType T,
2112                          const MultiLevelTemplateArgumentList &TemplateArgs,
2113                          SourceLocation Loc, DeclarationName Entity) {
2114   assert(!CodeSynthesisContexts.empty() &&
2115          "Cannot perform an instantiation without some context on the "
2116          "instantiation stack");
2117 
2118   // If T is not a dependent type or a variably-modified type, there
2119   // is nothing to do.
2120   if (!T->isInstantiationDependentType() && !T->isVariablyModifiedType())
2121     return T;
2122 
2123   TemplateInstantiator Instantiator(*this, TemplateArgs, Loc, Entity);
2124   return Instantiator.TransformType(T);
2125 }
2126 
NeedsInstantiationAsFunctionType(TypeSourceInfo * T)2127 static bool NeedsInstantiationAsFunctionType(TypeSourceInfo *T) {
2128   if (T->getType()->isInstantiationDependentType() ||
2129       T->getType()->isVariablyModifiedType())
2130     return true;
2131 
2132   TypeLoc TL = T->getTypeLoc().IgnoreParens();
2133   if (!TL.getAs<FunctionProtoTypeLoc>())
2134     return false;
2135 
2136   FunctionProtoTypeLoc FP = TL.castAs<FunctionProtoTypeLoc>();
2137   for (ParmVarDecl *P : FP.getParams()) {
2138     // This must be synthesized from a typedef.
2139     if (!P) continue;
2140 
2141     // If there are any parameters, a new TypeSourceInfo that refers to the
2142     // instantiated parameters must be built.
2143     return true;
2144   }
2145 
2146   return false;
2147 }
2148 
2149 /// A form of SubstType intended specifically for instantiating the
2150 /// type of a FunctionDecl.  Its purpose is solely to force the
2151 /// instantiation of default-argument expressions and to avoid
2152 /// instantiating an exception-specification.
SubstFunctionDeclType(TypeSourceInfo * T,const MultiLevelTemplateArgumentList & Args,SourceLocation Loc,DeclarationName Entity,CXXRecordDecl * ThisContext,Qualifiers ThisTypeQuals)2153 TypeSourceInfo *Sema::SubstFunctionDeclType(TypeSourceInfo *T,
2154                                 const MultiLevelTemplateArgumentList &Args,
2155                                 SourceLocation Loc,
2156                                 DeclarationName Entity,
2157                                 CXXRecordDecl *ThisContext,
2158                                 Qualifiers ThisTypeQuals) {
2159   assert(!CodeSynthesisContexts.empty() &&
2160          "Cannot perform an instantiation without some context on the "
2161          "instantiation stack");
2162 
2163   if (!NeedsInstantiationAsFunctionType(T))
2164     return T;
2165 
2166   TemplateInstantiator Instantiator(*this, Args, Loc, Entity);
2167 
2168   TypeLocBuilder TLB;
2169 
2170   TypeLoc TL = T->getTypeLoc();
2171   TLB.reserve(TL.getFullDataSize());
2172 
2173   QualType Result;
2174 
2175   if (FunctionProtoTypeLoc Proto =
2176           TL.IgnoreParens().getAs<FunctionProtoTypeLoc>()) {
2177     // Instantiate the type, other than its exception specification. The
2178     // exception specification is instantiated in InitFunctionInstantiation
2179     // once we've built the FunctionDecl.
2180     // FIXME: Set the exception specification to EST_Uninstantiated here,
2181     // instead of rebuilding the function type again later.
2182     Result = Instantiator.TransformFunctionProtoType(
2183         TLB, Proto, ThisContext, ThisTypeQuals,
2184         [](FunctionProtoType::ExceptionSpecInfo &ESI,
2185            bool &Changed) { return false; });
2186   } else {
2187     Result = Instantiator.TransformType(TLB, TL);
2188   }
2189   if (Result.isNull())
2190     return nullptr;
2191 
2192   return TLB.getTypeSourceInfo(Context, Result);
2193 }
2194 
SubstExceptionSpec(SourceLocation Loc,FunctionProtoType::ExceptionSpecInfo & ESI,SmallVectorImpl<QualType> & ExceptionStorage,const MultiLevelTemplateArgumentList & Args)2195 bool Sema::SubstExceptionSpec(SourceLocation Loc,
2196                               FunctionProtoType::ExceptionSpecInfo &ESI,
2197                               SmallVectorImpl<QualType> &ExceptionStorage,
2198                               const MultiLevelTemplateArgumentList &Args) {
2199   assert(ESI.Type != EST_Uninstantiated);
2200 
2201   bool Changed = false;
2202   TemplateInstantiator Instantiator(*this, Args, Loc, DeclarationName());
2203   return Instantiator.TransformExceptionSpec(Loc, ESI, ExceptionStorage,
2204                                              Changed);
2205 }
2206 
SubstExceptionSpec(FunctionDecl * New,const FunctionProtoType * Proto,const MultiLevelTemplateArgumentList & Args)2207 void Sema::SubstExceptionSpec(FunctionDecl *New, const FunctionProtoType *Proto,
2208                               const MultiLevelTemplateArgumentList &Args) {
2209   FunctionProtoType::ExceptionSpecInfo ESI =
2210       Proto->getExtProtoInfo().ExceptionSpec;
2211 
2212   SmallVector<QualType, 4> ExceptionStorage;
2213   if (SubstExceptionSpec(New->getTypeSourceInfo()->getTypeLoc().getEndLoc(),
2214                          ESI, ExceptionStorage, Args))
2215     // On error, recover by dropping the exception specification.
2216     ESI.Type = EST_None;
2217 
2218   UpdateExceptionSpec(New, ESI);
2219 }
2220 
2221 namespace {
2222 
2223   struct GetContainedInventedTypeParmVisitor :
2224     public TypeVisitor<GetContainedInventedTypeParmVisitor,
2225                        TemplateTypeParmDecl *> {
2226     using TypeVisitor<GetContainedInventedTypeParmVisitor,
2227                       TemplateTypeParmDecl *>::Visit;
2228 
Visit__anond2391fa50811::GetContainedInventedTypeParmVisitor2229     TemplateTypeParmDecl *Visit(QualType T) {
2230       if (T.isNull())
2231         return nullptr;
2232       return Visit(T.getTypePtr());
2233     }
2234     // The deduced type itself.
VisitTemplateTypeParmType__anond2391fa50811::GetContainedInventedTypeParmVisitor2235     TemplateTypeParmDecl *VisitTemplateTypeParmType(
2236         const TemplateTypeParmType *T) {
2237       if (!T->getDecl() || !T->getDecl()->isImplicit())
2238         return nullptr;
2239       return T->getDecl();
2240     }
2241 
2242     // Only these types can contain 'auto' types, and subsequently be replaced
2243     // by references to invented parameters.
2244 
VisitElaboratedType__anond2391fa50811::GetContainedInventedTypeParmVisitor2245     TemplateTypeParmDecl *VisitElaboratedType(const ElaboratedType *T) {
2246       return Visit(T->getNamedType());
2247     }
2248 
VisitPointerType__anond2391fa50811::GetContainedInventedTypeParmVisitor2249     TemplateTypeParmDecl *VisitPointerType(const PointerType *T) {
2250       return Visit(T->getPointeeType());
2251     }
2252 
VisitBlockPointerType__anond2391fa50811::GetContainedInventedTypeParmVisitor2253     TemplateTypeParmDecl *VisitBlockPointerType(const BlockPointerType *T) {
2254       return Visit(T->getPointeeType());
2255     }
2256 
VisitReferenceType__anond2391fa50811::GetContainedInventedTypeParmVisitor2257     TemplateTypeParmDecl *VisitReferenceType(const ReferenceType *T) {
2258       return Visit(T->getPointeeTypeAsWritten());
2259     }
2260 
VisitMemberPointerType__anond2391fa50811::GetContainedInventedTypeParmVisitor2261     TemplateTypeParmDecl *VisitMemberPointerType(const MemberPointerType *T) {
2262       return Visit(T->getPointeeType());
2263     }
2264 
VisitArrayType__anond2391fa50811::GetContainedInventedTypeParmVisitor2265     TemplateTypeParmDecl *VisitArrayType(const ArrayType *T) {
2266       return Visit(T->getElementType());
2267     }
2268 
VisitDependentSizedExtVectorType__anond2391fa50811::GetContainedInventedTypeParmVisitor2269     TemplateTypeParmDecl *VisitDependentSizedExtVectorType(
2270       const DependentSizedExtVectorType *T) {
2271       return Visit(T->getElementType());
2272     }
2273 
VisitVectorType__anond2391fa50811::GetContainedInventedTypeParmVisitor2274     TemplateTypeParmDecl *VisitVectorType(const VectorType *T) {
2275       return Visit(T->getElementType());
2276     }
2277 
VisitFunctionProtoType__anond2391fa50811::GetContainedInventedTypeParmVisitor2278     TemplateTypeParmDecl *VisitFunctionProtoType(const FunctionProtoType *T) {
2279       return VisitFunctionType(T);
2280     }
2281 
VisitFunctionType__anond2391fa50811::GetContainedInventedTypeParmVisitor2282     TemplateTypeParmDecl *VisitFunctionType(const FunctionType *T) {
2283       return Visit(T->getReturnType());
2284     }
2285 
VisitParenType__anond2391fa50811::GetContainedInventedTypeParmVisitor2286     TemplateTypeParmDecl *VisitParenType(const ParenType *T) {
2287       return Visit(T->getInnerType());
2288     }
2289 
VisitAttributedType__anond2391fa50811::GetContainedInventedTypeParmVisitor2290     TemplateTypeParmDecl *VisitAttributedType(const AttributedType *T) {
2291       return Visit(T->getModifiedType());
2292     }
2293 
VisitMacroQualifiedType__anond2391fa50811::GetContainedInventedTypeParmVisitor2294     TemplateTypeParmDecl *VisitMacroQualifiedType(const MacroQualifiedType *T) {
2295       return Visit(T->getUnderlyingType());
2296     }
2297 
VisitAdjustedType__anond2391fa50811::GetContainedInventedTypeParmVisitor2298     TemplateTypeParmDecl *VisitAdjustedType(const AdjustedType *T) {
2299       return Visit(T->getOriginalType());
2300     }
2301 
VisitPackExpansionType__anond2391fa50811::GetContainedInventedTypeParmVisitor2302     TemplateTypeParmDecl *VisitPackExpansionType(const PackExpansionType *T) {
2303       return Visit(T->getPattern());
2304     }
2305   };
2306 
2307 } // namespace
2308 
SubstParmVarDecl(ParmVarDecl * OldParm,const MultiLevelTemplateArgumentList & TemplateArgs,int indexAdjustment,Optional<unsigned> NumExpansions,bool ExpectParameterPack)2309 ParmVarDecl *Sema::SubstParmVarDecl(ParmVarDecl *OldParm,
2310                             const MultiLevelTemplateArgumentList &TemplateArgs,
2311                                     int indexAdjustment,
2312                                     Optional<unsigned> NumExpansions,
2313                                     bool ExpectParameterPack) {
2314   TypeSourceInfo *OldDI = OldParm->getTypeSourceInfo();
2315   TypeSourceInfo *NewDI = nullptr;
2316 
2317   TypeLoc OldTL = OldDI->getTypeLoc();
2318   if (PackExpansionTypeLoc ExpansionTL = OldTL.getAs<PackExpansionTypeLoc>()) {
2319 
2320     // We have a function parameter pack. Substitute into the pattern of the
2321     // expansion.
2322     NewDI = SubstType(ExpansionTL.getPatternLoc(), TemplateArgs,
2323                       OldParm->getLocation(), OldParm->getDeclName());
2324     if (!NewDI)
2325       return nullptr;
2326 
2327     if (NewDI->getType()->containsUnexpandedParameterPack()) {
2328       // We still have unexpanded parameter packs, which means that
2329       // our function parameter is still a function parameter pack.
2330       // Therefore, make its type a pack expansion type.
2331       NewDI = CheckPackExpansion(NewDI, ExpansionTL.getEllipsisLoc(),
2332                                  NumExpansions);
2333     } else if (ExpectParameterPack) {
2334       // We expected to get a parameter pack but didn't (because the type
2335       // itself is not a pack expansion type), so complain. This can occur when
2336       // the substitution goes through an alias template that "loses" the
2337       // pack expansion.
2338       Diag(OldParm->getLocation(),
2339            diag::err_function_parameter_pack_without_parameter_packs)
2340         << NewDI->getType();
2341       return nullptr;
2342     }
2343   } else {
2344     NewDI = SubstType(OldDI, TemplateArgs, OldParm->getLocation(),
2345                       OldParm->getDeclName());
2346   }
2347 
2348   if (!NewDI)
2349     return nullptr;
2350 
2351   if (NewDI->getType()->isVoidType()) {
2352     Diag(OldParm->getLocation(), diag::err_param_with_void_type);
2353     return nullptr;
2354   }
2355 
2356   // In abbreviated templates, TemplateTypeParmDecls with possible
2357   // TypeConstraints are created when the parameter list is originally parsed.
2358   // The TypeConstraints can therefore reference other functions parameters in
2359   // the abbreviated function template, which is why we must instantiate them
2360   // here, when the instantiated versions of those referenced parameters are in
2361   // scope.
2362   if (TemplateTypeParmDecl *TTP =
2363           GetContainedInventedTypeParmVisitor().Visit(OldDI->getType())) {
2364     if (const TypeConstraint *TC = TTP->getTypeConstraint()) {
2365       auto *Inst = cast_or_null<TemplateTypeParmDecl>(
2366           FindInstantiatedDecl(TTP->getLocation(), TTP, TemplateArgs));
2367       // We will first get here when instantiating the abbreviated function
2368       // template's described function, but we might also get here later.
2369       // Make sure we do not instantiate the TypeConstraint more than once.
2370       if (Inst && !Inst->getTypeConstraint()) {
2371         // TODO: Concepts: do not instantiate the constraint (delayed constraint
2372         // substitution)
2373         const ASTTemplateArgumentListInfo *TemplArgInfo
2374           = TC->getTemplateArgsAsWritten();
2375         TemplateArgumentListInfo InstArgs;
2376 
2377         if (TemplArgInfo) {
2378           InstArgs.setLAngleLoc(TemplArgInfo->LAngleLoc);
2379           InstArgs.setRAngleLoc(TemplArgInfo->RAngleLoc);
2380           if (Subst(TemplArgInfo->getTemplateArgs(),
2381                     TemplArgInfo->NumTemplateArgs, InstArgs, TemplateArgs))
2382             return nullptr;
2383         }
2384         if (AttachTypeConstraint(
2385                 TC->getNestedNameSpecifierLoc(), TC->getConceptNameInfo(),
2386                 TC->getNamedConcept(), &InstArgs, Inst,
2387                 TTP->isParameterPack()
2388                     ? cast<CXXFoldExpr>(TC->getImmediatelyDeclaredConstraint())
2389                         ->getEllipsisLoc()
2390                     : SourceLocation()))
2391           return nullptr;
2392       }
2393     }
2394   }
2395 
2396   ParmVarDecl *NewParm = CheckParameter(Context.getTranslationUnitDecl(),
2397                                         OldParm->getInnerLocStart(),
2398                                         OldParm->getLocation(),
2399                                         OldParm->getIdentifier(),
2400                                         NewDI->getType(), NewDI,
2401                                         OldParm->getStorageClass());
2402   if (!NewParm)
2403     return nullptr;
2404 
2405   // Mark the (new) default argument as uninstantiated (if any).
2406   if (OldParm->hasUninstantiatedDefaultArg()) {
2407     Expr *Arg = OldParm->getUninstantiatedDefaultArg();
2408     NewParm->setUninstantiatedDefaultArg(Arg);
2409   } else if (OldParm->hasUnparsedDefaultArg()) {
2410     NewParm->setUnparsedDefaultArg();
2411     UnparsedDefaultArgInstantiations[OldParm].push_back(NewParm);
2412   } else if (Expr *Arg = OldParm->getDefaultArg()) {
2413     FunctionDecl *OwningFunc = cast<FunctionDecl>(OldParm->getDeclContext());
2414     if (OwningFunc->isInLocalScopeForInstantiation()) {
2415       // Instantiate default arguments for methods of local classes (DR1484)
2416       // and non-defining declarations.
2417       Sema::ContextRAII SavedContext(*this, OwningFunc);
2418       LocalInstantiationScope Local(*this, true);
2419       ExprResult NewArg = SubstExpr(Arg, TemplateArgs);
2420       if (NewArg.isUsable()) {
2421         // It would be nice if we still had this.
2422         SourceLocation EqualLoc = NewArg.get()->getBeginLoc();
2423         ExprResult Result =
2424             ConvertParamDefaultArgument(NewParm, NewArg.get(), EqualLoc);
2425         if (Result.isInvalid())
2426           return nullptr;
2427 
2428         SetParamDefaultArgument(NewParm, Result.getAs<Expr>(), EqualLoc);
2429       }
2430     } else {
2431       // FIXME: if we non-lazily instantiated non-dependent default args for
2432       // non-dependent parameter types we could remove a bunch of duplicate
2433       // conversion warnings for such arguments.
2434       NewParm->setUninstantiatedDefaultArg(Arg);
2435     }
2436   }
2437 
2438   NewParm->setHasInheritedDefaultArg(OldParm->hasInheritedDefaultArg());
2439 
2440   if (OldParm->isParameterPack() && !NewParm->isParameterPack()) {
2441     // Add the new parameter to the instantiated parameter pack.
2442     CurrentInstantiationScope->InstantiatedLocalPackArg(OldParm, NewParm);
2443   } else {
2444     // Introduce an Old -> New mapping
2445     CurrentInstantiationScope->InstantiatedLocal(OldParm, NewParm);
2446   }
2447 
2448   // FIXME: OldParm may come from a FunctionProtoType, in which case CurContext
2449   // can be anything, is this right ?
2450   NewParm->setDeclContext(CurContext);
2451 
2452   NewParm->setScopeInfo(OldParm->getFunctionScopeDepth(),
2453                         OldParm->getFunctionScopeIndex() + indexAdjustment);
2454 
2455   InstantiateAttrs(TemplateArgs, OldParm, NewParm);
2456 
2457   return NewParm;
2458 }
2459 
2460 /// Substitute the given template arguments into the given set of
2461 /// parameters, producing the set of parameter types that would be generated
2462 /// from such a substitution.
SubstParmTypes(SourceLocation Loc,ArrayRef<ParmVarDecl * > Params,const FunctionProtoType::ExtParameterInfo * ExtParamInfos,const MultiLevelTemplateArgumentList & TemplateArgs,SmallVectorImpl<QualType> & ParamTypes,SmallVectorImpl<ParmVarDecl * > * OutParams,ExtParameterInfoBuilder & ParamInfos)2463 bool Sema::SubstParmTypes(
2464     SourceLocation Loc, ArrayRef<ParmVarDecl *> Params,
2465     const FunctionProtoType::ExtParameterInfo *ExtParamInfos,
2466     const MultiLevelTemplateArgumentList &TemplateArgs,
2467     SmallVectorImpl<QualType> &ParamTypes,
2468     SmallVectorImpl<ParmVarDecl *> *OutParams,
2469     ExtParameterInfoBuilder &ParamInfos) {
2470   assert(!CodeSynthesisContexts.empty() &&
2471          "Cannot perform an instantiation without some context on the "
2472          "instantiation stack");
2473 
2474   TemplateInstantiator Instantiator(*this, TemplateArgs, Loc,
2475                                     DeclarationName());
2476   return Instantiator.TransformFunctionTypeParams(
2477       Loc, Params, nullptr, ExtParamInfos, ParamTypes, OutParams, ParamInfos);
2478 }
2479 
2480 /// Perform substitution on the base class specifiers of the
2481 /// given class template specialization.
2482 ///
2483 /// Produces a diagnostic and returns true on error, returns false and
2484 /// attaches the instantiated base classes to the class template
2485 /// specialization if successful.
2486 bool
SubstBaseSpecifiers(CXXRecordDecl * Instantiation,CXXRecordDecl * Pattern,const MultiLevelTemplateArgumentList & TemplateArgs)2487 Sema::SubstBaseSpecifiers(CXXRecordDecl *Instantiation,
2488                           CXXRecordDecl *Pattern,
2489                           const MultiLevelTemplateArgumentList &TemplateArgs) {
2490   bool Invalid = false;
2491   SmallVector<CXXBaseSpecifier*, 4> InstantiatedBases;
2492   for (const auto &Base : Pattern->bases()) {
2493     if (!Base.getType()->isDependentType()) {
2494       if (const CXXRecordDecl *RD = Base.getType()->getAsCXXRecordDecl()) {
2495         if (RD->isInvalidDecl())
2496           Instantiation->setInvalidDecl();
2497       }
2498       InstantiatedBases.push_back(new (Context) CXXBaseSpecifier(Base));
2499       continue;
2500     }
2501 
2502     SourceLocation EllipsisLoc;
2503     TypeSourceInfo *BaseTypeLoc;
2504     if (Base.isPackExpansion()) {
2505       // This is a pack expansion. See whether we should expand it now, or
2506       // wait until later.
2507       SmallVector<UnexpandedParameterPack, 2> Unexpanded;
2508       collectUnexpandedParameterPacks(Base.getTypeSourceInfo()->getTypeLoc(),
2509                                       Unexpanded);
2510       bool ShouldExpand = false;
2511       bool RetainExpansion = false;
2512       Optional<unsigned> NumExpansions;
2513       if (CheckParameterPacksForExpansion(Base.getEllipsisLoc(),
2514                                           Base.getSourceRange(),
2515                                           Unexpanded,
2516                                           TemplateArgs, ShouldExpand,
2517                                           RetainExpansion,
2518                                           NumExpansions)) {
2519         Invalid = true;
2520         continue;
2521       }
2522 
2523       // If we should expand this pack expansion now, do so.
2524       if (ShouldExpand) {
2525         for (unsigned I = 0; I != *NumExpansions; ++I) {
2526             Sema::ArgumentPackSubstitutionIndexRAII SubstIndex(*this, I);
2527 
2528           TypeSourceInfo *BaseTypeLoc = SubstType(Base.getTypeSourceInfo(),
2529                                                   TemplateArgs,
2530                                               Base.getSourceRange().getBegin(),
2531                                                   DeclarationName());
2532           if (!BaseTypeLoc) {
2533             Invalid = true;
2534             continue;
2535           }
2536 
2537           if (CXXBaseSpecifier *InstantiatedBase
2538                 = CheckBaseSpecifier(Instantiation,
2539                                      Base.getSourceRange(),
2540                                      Base.isVirtual(),
2541                                      Base.getAccessSpecifierAsWritten(),
2542                                      BaseTypeLoc,
2543                                      SourceLocation()))
2544             InstantiatedBases.push_back(InstantiatedBase);
2545           else
2546             Invalid = true;
2547         }
2548 
2549         continue;
2550       }
2551 
2552       // The resulting base specifier will (still) be a pack expansion.
2553       EllipsisLoc = Base.getEllipsisLoc();
2554       Sema::ArgumentPackSubstitutionIndexRAII SubstIndex(*this, -1);
2555       BaseTypeLoc = SubstType(Base.getTypeSourceInfo(),
2556                               TemplateArgs,
2557                               Base.getSourceRange().getBegin(),
2558                               DeclarationName());
2559     } else {
2560       BaseTypeLoc = SubstType(Base.getTypeSourceInfo(),
2561                               TemplateArgs,
2562                               Base.getSourceRange().getBegin(),
2563                               DeclarationName());
2564     }
2565 
2566     if (!BaseTypeLoc) {
2567       Invalid = true;
2568       continue;
2569     }
2570 
2571     if (CXXBaseSpecifier *InstantiatedBase
2572           = CheckBaseSpecifier(Instantiation,
2573                                Base.getSourceRange(),
2574                                Base.isVirtual(),
2575                                Base.getAccessSpecifierAsWritten(),
2576                                BaseTypeLoc,
2577                                EllipsisLoc))
2578       InstantiatedBases.push_back(InstantiatedBase);
2579     else
2580       Invalid = true;
2581   }
2582 
2583   if (!Invalid && AttachBaseSpecifiers(Instantiation, InstantiatedBases))
2584     Invalid = true;
2585 
2586   return Invalid;
2587 }
2588 
2589 // Defined via #include from SemaTemplateInstantiateDecl.cpp
2590 namespace clang {
2591   namespace sema {
2592     Attr *instantiateTemplateAttribute(const Attr *At, ASTContext &C, Sema &S,
2593                             const MultiLevelTemplateArgumentList &TemplateArgs);
2594     Attr *instantiateTemplateAttributeForDecl(
2595         const Attr *At, ASTContext &C, Sema &S,
2596         const MultiLevelTemplateArgumentList &TemplateArgs);
2597   }
2598 }
2599 
2600 /// Instantiate the definition of a class from a given pattern.
2601 ///
2602 /// \param PointOfInstantiation The point of instantiation within the
2603 /// source code.
2604 ///
2605 /// \param Instantiation is the declaration whose definition is being
2606 /// instantiated. This will be either a class template specialization
2607 /// or a member class of a class template specialization.
2608 ///
2609 /// \param Pattern is the pattern from which the instantiation
2610 /// occurs. This will be either the declaration of a class template or
2611 /// the declaration of a member class of a class template.
2612 ///
2613 /// \param TemplateArgs The template arguments to be substituted into
2614 /// the pattern.
2615 ///
2616 /// \param TSK the kind of implicit or explicit instantiation to perform.
2617 ///
2618 /// \param Complain whether to complain if the class cannot be instantiated due
2619 /// to the lack of a definition.
2620 ///
2621 /// \returns true if an error occurred, false otherwise.
2622 bool
InstantiateClass(SourceLocation PointOfInstantiation,CXXRecordDecl * Instantiation,CXXRecordDecl * Pattern,const MultiLevelTemplateArgumentList & TemplateArgs,TemplateSpecializationKind TSK,bool Complain)2623 Sema::InstantiateClass(SourceLocation PointOfInstantiation,
2624                        CXXRecordDecl *Instantiation, CXXRecordDecl *Pattern,
2625                        const MultiLevelTemplateArgumentList &TemplateArgs,
2626                        TemplateSpecializationKind TSK,
2627                        bool Complain) {
2628   CXXRecordDecl *PatternDef
2629     = cast_or_null<CXXRecordDecl>(Pattern->getDefinition());
2630   if (DiagnoseUninstantiableTemplate(PointOfInstantiation, Instantiation,
2631                                 Instantiation->getInstantiatedFromMemberClass(),
2632                                      Pattern, PatternDef, TSK, Complain))
2633     return true;
2634 
2635   llvm::TimeTraceScope TimeScope("InstantiateClass", [&]() {
2636     std::string Name;
2637     llvm::raw_string_ostream OS(Name);
2638     Instantiation->getNameForDiagnostic(OS, getPrintingPolicy(),
2639                                         /*Qualified=*/true);
2640     return Name;
2641   });
2642 
2643   Pattern = PatternDef;
2644 
2645   // Record the point of instantiation.
2646   if (MemberSpecializationInfo *MSInfo
2647         = Instantiation->getMemberSpecializationInfo()) {
2648     MSInfo->setTemplateSpecializationKind(TSK);
2649     MSInfo->setPointOfInstantiation(PointOfInstantiation);
2650   } else if (ClassTemplateSpecializationDecl *Spec
2651         = dyn_cast<ClassTemplateSpecializationDecl>(Instantiation)) {
2652     Spec->setTemplateSpecializationKind(TSK);
2653     Spec->setPointOfInstantiation(PointOfInstantiation);
2654   }
2655 
2656   InstantiatingTemplate Inst(*this, PointOfInstantiation, Instantiation);
2657   if (Inst.isInvalid())
2658     return true;
2659   assert(!Inst.isAlreadyInstantiating() && "should have been caught by caller");
2660   PrettyDeclStackTraceEntry CrashInfo(Context, Instantiation, SourceLocation(),
2661                                       "instantiating class definition");
2662 
2663   // Enter the scope of this instantiation. We don't use
2664   // PushDeclContext because we don't have a scope.
2665   ContextRAII SavedContext(*this, Instantiation);
2666   EnterExpressionEvaluationContext EvalContext(
2667       *this, Sema::ExpressionEvaluationContext::PotentiallyEvaluated);
2668 
2669   // If this is an instantiation of a local class, merge this local
2670   // instantiation scope with the enclosing scope. Otherwise, every
2671   // instantiation of a class has its own local instantiation scope.
2672   bool MergeWithParentScope = !Instantiation->isDefinedOutsideFunctionOrMethod();
2673   LocalInstantiationScope Scope(*this, MergeWithParentScope);
2674 
2675   // Some class state isn't processed immediately but delayed till class
2676   // instantiation completes. We may not be ready to handle any delayed state
2677   // already on the stack as it might correspond to a different class, so save
2678   // it now and put it back later.
2679   SavePendingParsedClassStateRAII SavedPendingParsedClassState(*this);
2680 
2681   // Pull attributes from the pattern onto the instantiation.
2682   InstantiateAttrs(TemplateArgs, Pattern, Instantiation);
2683 
2684   // Start the definition of this instantiation.
2685   Instantiation->startDefinition();
2686 
2687   // The instantiation is visible here, even if it was first declared in an
2688   // unimported module.
2689   Instantiation->setVisibleDespiteOwningModule();
2690 
2691   // FIXME: This loses the as-written tag kind for an explicit instantiation.
2692   Instantiation->setTagKind(Pattern->getTagKind());
2693 
2694   // Do substitution on the base class specifiers.
2695   if (SubstBaseSpecifiers(Instantiation, Pattern, TemplateArgs))
2696     Instantiation->setInvalidDecl();
2697 
2698   TemplateDeclInstantiator Instantiator(*this, Instantiation, TemplateArgs);
2699   SmallVector<Decl*, 4> Fields;
2700   // Delay instantiation of late parsed attributes.
2701   LateInstantiatedAttrVec LateAttrs;
2702   Instantiator.enableLateAttributeInstantiation(&LateAttrs);
2703 
2704   bool MightHaveConstexprVirtualFunctions = false;
2705   for (auto *Member : Pattern->decls()) {
2706     // Don't instantiate members not belonging in this semantic context.
2707     // e.g. for:
2708     // @code
2709     //    template <int i> class A {
2710     //      class B *g;
2711     //    };
2712     // @endcode
2713     // 'class B' has the template as lexical context but semantically it is
2714     // introduced in namespace scope.
2715     if (Member->getDeclContext() != Pattern)
2716       continue;
2717 
2718     // BlockDecls can appear in a default-member-initializer. They must be the
2719     // child of a BlockExpr, so we only know how to instantiate them from there.
2720     // Similarly, lambda closure types are recreated when instantiating the
2721     // corresponding LambdaExpr.
2722     if (isa<BlockDecl>(Member) ||
2723         (isa<CXXRecordDecl>(Member) && cast<CXXRecordDecl>(Member)->isLambda()))
2724       continue;
2725 
2726     if (Member->isInvalidDecl()) {
2727       Instantiation->setInvalidDecl();
2728       continue;
2729     }
2730 
2731     Decl *NewMember = Instantiator.Visit(Member);
2732     if (NewMember) {
2733       if (FieldDecl *Field = dyn_cast<FieldDecl>(NewMember)) {
2734         Fields.push_back(Field);
2735       } else if (EnumDecl *Enum = dyn_cast<EnumDecl>(NewMember)) {
2736         // C++11 [temp.inst]p1: The implicit instantiation of a class template
2737         // specialization causes the implicit instantiation of the definitions
2738         // of unscoped member enumerations.
2739         // Record a point of instantiation for this implicit instantiation.
2740         if (TSK == TSK_ImplicitInstantiation && !Enum->isScoped() &&
2741             Enum->isCompleteDefinition()) {
2742           MemberSpecializationInfo *MSInfo =Enum->getMemberSpecializationInfo();
2743           assert(MSInfo && "no spec info for member enum specialization");
2744           MSInfo->setTemplateSpecializationKind(TSK_ImplicitInstantiation);
2745           MSInfo->setPointOfInstantiation(PointOfInstantiation);
2746         }
2747       } else if (StaticAssertDecl *SA = dyn_cast<StaticAssertDecl>(NewMember)) {
2748         if (SA->isFailed()) {
2749           // A static_assert failed. Bail out; instantiating this
2750           // class is probably not meaningful.
2751           Instantiation->setInvalidDecl();
2752           break;
2753         }
2754       } else if (CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(NewMember)) {
2755         if (MD->isConstexpr() && !MD->getFriendObjectKind() &&
2756             (MD->isVirtualAsWritten() || Instantiation->getNumBases()))
2757           MightHaveConstexprVirtualFunctions = true;
2758       }
2759 
2760       if (NewMember->isInvalidDecl())
2761         Instantiation->setInvalidDecl();
2762     } else {
2763       // FIXME: Eventually, a NULL return will mean that one of the
2764       // instantiations was a semantic disaster, and we'll want to mark the
2765       // declaration invalid.
2766       // For now, we expect to skip some members that we can't yet handle.
2767     }
2768   }
2769 
2770   // Finish checking fields.
2771   ActOnFields(nullptr, Instantiation->getLocation(), Instantiation, Fields,
2772               SourceLocation(), SourceLocation(), ParsedAttributesView());
2773   CheckCompletedCXXClass(nullptr, Instantiation);
2774 
2775   // Default arguments are parsed, if not instantiated. We can go instantiate
2776   // default arg exprs for default constructors if necessary now. Unless we're
2777   // parsing a class, in which case wait until that's finished.
2778   if (ParsingClassDepth == 0)
2779     ActOnFinishCXXNonNestedClass();
2780 
2781   // Instantiate late parsed attributes, and attach them to their decls.
2782   // See Sema::InstantiateAttrs
2783   for (LateInstantiatedAttrVec::iterator I = LateAttrs.begin(),
2784        E = LateAttrs.end(); I != E; ++I) {
2785     assert(CurrentInstantiationScope == Instantiator.getStartingScope());
2786     CurrentInstantiationScope = I->Scope;
2787 
2788     // Allow 'this' within late-parsed attributes.
2789     NamedDecl *ND = dyn_cast<NamedDecl>(I->NewDecl);
2790     CXXRecordDecl *ThisContext =
2791         dyn_cast_or_null<CXXRecordDecl>(ND->getDeclContext());
2792     CXXThisScopeRAII ThisScope(*this, ThisContext, Qualifiers(),
2793                                ND && ND->isCXXInstanceMember());
2794 
2795     Attr *NewAttr =
2796       instantiateTemplateAttribute(I->TmplAttr, Context, *this, TemplateArgs);
2797     I->NewDecl->addAttr(NewAttr);
2798     LocalInstantiationScope::deleteScopes(I->Scope,
2799                                           Instantiator.getStartingScope());
2800   }
2801   Instantiator.disableLateAttributeInstantiation();
2802   LateAttrs.clear();
2803 
2804   ActOnFinishDelayedMemberInitializers(Instantiation);
2805 
2806   // FIXME: We should do something similar for explicit instantiations so they
2807   // end up in the right module.
2808   if (TSK == TSK_ImplicitInstantiation) {
2809     Instantiation->setLocation(Pattern->getLocation());
2810     Instantiation->setLocStart(Pattern->getInnerLocStart());
2811     Instantiation->setBraceRange(Pattern->getBraceRange());
2812   }
2813 
2814   if (!Instantiation->isInvalidDecl()) {
2815     // Perform any dependent diagnostics from the pattern.
2816     PerformDependentDiagnostics(Pattern, TemplateArgs);
2817 
2818     // Instantiate any out-of-line class template partial
2819     // specializations now.
2820     for (TemplateDeclInstantiator::delayed_partial_spec_iterator
2821               P = Instantiator.delayed_partial_spec_begin(),
2822            PEnd = Instantiator.delayed_partial_spec_end();
2823          P != PEnd; ++P) {
2824       if (!Instantiator.InstantiateClassTemplatePartialSpecialization(
2825               P->first, P->second)) {
2826         Instantiation->setInvalidDecl();
2827         break;
2828       }
2829     }
2830 
2831     // Instantiate any out-of-line variable template partial
2832     // specializations now.
2833     for (TemplateDeclInstantiator::delayed_var_partial_spec_iterator
2834               P = Instantiator.delayed_var_partial_spec_begin(),
2835            PEnd = Instantiator.delayed_var_partial_spec_end();
2836          P != PEnd; ++P) {
2837       if (!Instantiator.InstantiateVarTemplatePartialSpecialization(
2838               P->first, P->second)) {
2839         Instantiation->setInvalidDecl();
2840         break;
2841       }
2842     }
2843   }
2844 
2845   // Exit the scope of this instantiation.
2846   SavedContext.pop();
2847 
2848   if (!Instantiation->isInvalidDecl()) {
2849     Consumer.HandleTagDeclDefinition(Instantiation);
2850 
2851     // Always emit the vtable for an explicit instantiation definition
2852     // of a polymorphic class template specialization. Otherwise, eagerly
2853     // instantiate only constexpr virtual functions in preparation for their use
2854     // in constant evaluation.
2855     if (TSK == TSK_ExplicitInstantiationDefinition)
2856       MarkVTableUsed(PointOfInstantiation, Instantiation, true);
2857     else if (MightHaveConstexprVirtualFunctions)
2858       MarkVirtualMembersReferenced(PointOfInstantiation, Instantiation,
2859                                    /*ConstexprOnly*/ true);
2860   }
2861 
2862   return Instantiation->isInvalidDecl();
2863 }
2864 
2865 /// Instantiate the definition of an enum from a given pattern.
2866 ///
2867 /// \param PointOfInstantiation The point of instantiation within the
2868 ///        source code.
2869 /// \param Instantiation is the declaration whose definition is being
2870 ///        instantiated. This will be a member enumeration of a class
2871 ///        temploid specialization, or a local enumeration within a
2872 ///        function temploid specialization.
2873 /// \param Pattern The templated declaration from which the instantiation
2874 ///        occurs.
2875 /// \param TemplateArgs The template arguments to be substituted into
2876 ///        the pattern.
2877 /// \param TSK The kind of implicit or explicit instantiation to perform.
2878 ///
2879 /// \return \c true if an error occurred, \c false otherwise.
InstantiateEnum(SourceLocation PointOfInstantiation,EnumDecl * Instantiation,EnumDecl * Pattern,const MultiLevelTemplateArgumentList & TemplateArgs,TemplateSpecializationKind TSK)2880 bool Sema::InstantiateEnum(SourceLocation PointOfInstantiation,
2881                            EnumDecl *Instantiation, EnumDecl *Pattern,
2882                            const MultiLevelTemplateArgumentList &TemplateArgs,
2883                            TemplateSpecializationKind TSK) {
2884   EnumDecl *PatternDef = Pattern->getDefinition();
2885   if (DiagnoseUninstantiableTemplate(PointOfInstantiation, Instantiation,
2886                                  Instantiation->getInstantiatedFromMemberEnum(),
2887                                      Pattern, PatternDef, TSK,/*Complain*/true))
2888     return true;
2889   Pattern = PatternDef;
2890 
2891   // Record the point of instantiation.
2892   if (MemberSpecializationInfo *MSInfo
2893         = Instantiation->getMemberSpecializationInfo()) {
2894     MSInfo->setTemplateSpecializationKind(TSK);
2895     MSInfo->setPointOfInstantiation(PointOfInstantiation);
2896   }
2897 
2898   InstantiatingTemplate Inst(*this, PointOfInstantiation, Instantiation);
2899   if (Inst.isInvalid())
2900     return true;
2901   if (Inst.isAlreadyInstantiating())
2902     return false;
2903   PrettyDeclStackTraceEntry CrashInfo(Context, Instantiation, SourceLocation(),
2904                                       "instantiating enum definition");
2905 
2906   // The instantiation is visible here, even if it was first declared in an
2907   // unimported module.
2908   Instantiation->setVisibleDespiteOwningModule();
2909 
2910   // Enter the scope of this instantiation. We don't use
2911   // PushDeclContext because we don't have a scope.
2912   ContextRAII SavedContext(*this, Instantiation);
2913   EnterExpressionEvaluationContext EvalContext(
2914       *this, Sema::ExpressionEvaluationContext::PotentiallyEvaluated);
2915 
2916   LocalInstantiationScope Scope(*this, /*MergeWithParentScope*/true);
2917 
2918   // Pull attributes from the pattern onto the instantiation.
2919   InstantiateAttrs(TemplateArgs, Pattern, Instantiation);
2920 
2921   TemplateDeclInstantiator Instantiator(*this, Instantiation, TemplateArgs);
2922   Instantiator.InstantiateEnumDefinition(Instantiation, Pattern);
2923 
2924   // Exit the scope of this instantiation.
2925   SavedContext.pop();
2926 
2927   return Instantiation->isInvalidDecl();
2928 }
2929 
2930 
2931 /// Instantiate the definition of a field from the given pattern.
2932 ///
2933 /// \param PointOfInstantiation The point of instantiation within the
2934 ///        source code.
2935 /// \param Instantiation is the declaration whose definition is being
2936 ///        instantiated. This will be a class of a class temploid
2937 ///        specialization, or a local enumeration within a function temploid
2938 ///        specialization.
2939 /// \param Pattern The templated declaration from which the instantiation
2940 ///        occurs.
2941 /// \param TemplateArgs The template arguments to be substituted into
2942 ///        the pattern.
2943 ///
2944 /// \return \c true if an error occurred, \c false otherwise.
InstantiateInClassInitializer(SourceLocation PointOfInstantiation,FieldDecl * Instantiation,FieldDecl * Pattern,const MultiLevelTemplateArgumentList & TemplateArgs)2945 bool Sema::InstantiateInClassInitializer(
2946     SourceLocation PointOfInstantiation, FieldDecl *Instantiation,
2947     FieldDecl *Pattern, const MultiLevelTemplateArgumentList &TemplateArgs) {
2948   // If there is no initializer, we don't need to do anything.
2949   if (!Pattern->hasInClassInitializer())
2950     return false;
2951 
2952   assert(Instantiation->getInClassInitStyle() ==
2953              Pattern->getInClassInitStyle() &&
2954          "pattern and instantiation disagree about init style");
2955 
2956   // Error out if we haven't parsed the initializer of the pattern yet because
2957   // we are waiting for the closing brace of the outer class.
2958   Expr *OldInit = Pattern->getInClassInitializer();
2959   if (!OldInit) {
2960     RecordDecl *PatternRD = Pattern->getParent();
2961     RecordDecl *OutermostClass = PatternRD->getOuterLexicalRecordContext();
2962     Diag(PointOfInstantiation,
2963          diag::err_default_member_initializer_not_yet_parsed)
2964         << OutermostClass << Pattern;
2965     Diag(Pattern->getEndLoc(),
2966          diag::note_default_member_initializer_not_yet_parsed);
2967     Instantiation->setInvalidDecl();
2968     return true;
2969   }
2970 
2971   InstantiatingTemplate Inst(*this, PointOfInstantiation, Instantiation);
2972   if (Inst.isInvalid())
2973     return true;
2974   if (Inst.isAlreadyInstantiating()) {
2975     // Error out if we hit an instantiation cycle for this initializer.
2976     Diag(PointOfInstantiation, diag::err_default_member_initializer_cycle)
2977       << Instantiation;
2978     return true;
2979   }
2980   PrettyDeclStackTraceEntry CrashInfo(Context, Instantiation, SourceLocation(),
2981                                       "instantiating default member init");
2982 
2983   // Enter the scope of this instantiation. We don't use PushDeclContext because
2984   // we don't have a scope.
2985   ContextRAII SavedContext(*this, Instantiation->getParent());
2986   EnterExpressionEvaluationContext EvalContext(
2987       *this, Sema::ExpressionEvaluationContext::PotentiallyEvaluated);
2988 
2989   LocalInstantiationScope Scope(*this, true);
2990 
2991   // Instantiate the initializer.
2992   ActOnStartCXXInClassMemberInitializer();
2993   CXXThisScopeRAII ThisScope(*this, Instantiation->getParent(), Qualifiers());
2994 
2995   ExprResult NewInit = SubstInitializer(OldInit, TemplateArgs,
2996                                         /*CXXDirectInit=*/false);
2997   Expr *Init = NewInit.get();
2998   assert((!Init || !isa<ParenListExpr>(Init)) && "call-style init in class");
2999   ActOnFinishCXXInClassMemberInitializer(
3000       Instantiation, Init ? Init->getBeginLoc() : SourceLocation(), Init);
3001 
3002   if (auto *L = getASTMutationListener())
3003     L->DefaultMemberInitializerInstantiated(Instantiation);
3004 
3005   // Return true if the in-class initializer is still missing.
3006   return !Instantiation->getInClassInitializer();
3007 }
3008 
3009 namespace {
3010   /// A partial specialization whose template arguments have matched
3011   /// a given template-id.
3012   struct PartialSpecMatchResult {
3013     ClassTemplatePartialSpecializationDecl *Partial;
3014     TemplateArgumentList *Args;
3015   };
3016 }
3017 
usesPartialOrExplicitSpecialization(SourceLocation Loc,ClassTemplateSpecializationDecl * ClassTemplateSpec)3018 bool Sema::usesPartialOrExplicitSpecialization(
3019     SourceLocation Loc, ClassTemplateSpecializationDecl *ClassTemplateSpec) {
3020   if (ClassTemplateSpec->getTemplateSpecializationKind() ==
3021       TSK_ExplicitSpecialization)
3022     return true;
3023 
3024   SmallVector<ClassTemplatePartialSpecializationDecl *, 4> PartialSpecs;
3025   ClassTemplateSpec->getSpecializedTemplate()
3026                    ->getPartialSpecializations(PartialSpecs);
3027   for (unsigned I = 0, N = PartialSpecs.size(); I != N; ++I) {
3028     TemplateDeductionInfo Info(Loc);
3029     if (!DeduceTemplateArguments(PartialSpecs[I],
3030                                  ClassTemplateSpec->getTemplateArgs(), Info))
3031       return true;
3032   }
3033 
3034   return false;
3035 }
3036 
3037 /// Get the instantiation pattern to use to instantiate the definition of a
3038 /// given ClassTemplateSpecializationDecl (either the pattern of the primary
3039 /// template or of a partial specialization).
3040 static CXXRecordDecl *
getPatternForClassTemplateSpecialization(Sema & S,SourceLocation PointOfInstantiation,ClassTemplateSpecializationDecl * ClassTemplateSpec,TemplateSpecializationKind TSK,bool Complain)3041 getPatternForClassTemplateSpecialization(
3042     Sema &S, SourceLocation PointOfInstantiation,
3043     ClassTemplateSpecializationDecl *ClassTemplateSpec,
3044     TemplateSpecializationKind TSK, bool Complain) {
3045   Sema::InstantiatingTemplate Inst(S, PointOfInstantiation, ClassTemplateSpec);
3046   if (Inst.isInvalid() || Inst.isAlreadyInstantiating())
3047     return nullptr;
3048 
3049   llvm::PointerUnion<ClassTemplateDecl *,
3050                      ClassTemplatePartialSpecializationDecl *>
3051       Specialized = ClassTemplateSpec->getSpecializedTemplateOrPartial();
3052   if (!Specialized.is<ClassTemplatePartialSpecializationDecl *>()) {
3053     // Find best matching specialization.
3054     ClassTemplateDecl *Template = ClassTemplateSpec->getSpecializedTemplate();
3055 
3056     // C++ [temp.class.spec.match]p1:
3057     //   When a class template is used in a context that requires an
3058     //   instantiation of the class, it is necessary to determine
3059     //   whether the instantiation is to be generated using the primary
3060     //   template or one of the partial specializations. This is done by
3061     //   matching the template arguments of the class template
3062     //   specialization with the template argument lists of the partial
3063     //   specializations.
3064     typedef PartialSpecMatchResult MatchResult;
3065     SmallVector<MatchResult, 4> Matched;
3066     SmallVector<ClassTemplatePartialSpecializationDecl *, 4> PartialSpecs;
3067     Template->getPartialSpecializations(PartialSpecs);
3068     TemplateSpecCandidateSet FailedCandidates(PointOfInstantiation);
3069     for (unsigned I = 0, N = PartialSpecs.size(); I != N; ++I) {
3070       ClassTemplatePartialSpecializationDecl *Partial = PartialSpecs[I];
3071       TemplateDeductionInfo Info(FailedCandidates.getLocation());
3072       if (Sema::TemplateDeductionResult Result = S.DeduceTemplateArguments(
3073               Partial, ClassTemplateSpec->getTemplateArgs(), Info)) {
3074         // Store the failed-deduction information for use in diagnostics, later.
3075         // TODO: Actually use the failed-deduction info?
3076         FailedCandidates.addCandidate().set(
3077             DeclAccessPair::make(Template, AS_public), Partial,
3078             MakeDeductionFailureInfo(S.Context, Result, Info));
3079         (void)Result;
3080       } else {
3081         Matched.push_back(PartialSpecMatchResult());
3082         Matched.back().Partial = Partial;
3083         Matched.back().Args = Info.take();
3084       }
3085     }
3086 
3087     // If we're dealing with a member template where the template parameters
3088     // have been instantiated, this provides the original template parameters
3089     // from which the member template's parameters were instantiated.
3090 
3091     if (Matched.size() >= 1) {
3092       SmallVectorImpl<MatchResult>::iterator Best = Matched.begin();
3093       if (Matched.size() == 1) {
3094         //   -- If exactly one matching specialization is found, the
3095         //      instantiation is generated from that specialization.
3096         // We don't need to do anything for this.
3097       } else {
3098         //   -- If more than one matching specialization is found, the
3099         //      partial order rules (14.5.4.2) are used to determine
3100         //      whether one of the specializations is more specialized
3101         //      than the others. If none of the specializations is more
3102         //      specialized than all of the other matching
3103         //      specializations, then the use of the class template is
3104         //      ambiguous and the program is ill-formed.
3105         for (SmallVectorImpl<MatchResult>::iterator P = Best + 1,
3106                                                  PEnd = Matched.end();
3107              P != PEnd; ++P) {
3108           if (S.getMoreSpecializedPartialSpecialization(
3109                   P->Partial, Best->Partial, PointOfInstantiation) ==
3110               P->Partial)
3111             Best = P;
3112         }
3113 
3114         // Determine if the best partial specialization is more specialized than
3115         // the others.
3116         bool Ambiguous = false;
3117         for (SmallVectorImpl<MatchResult>::iterator P = Matched.begin(),
3118                                                  PEnd = Matched.end();
3119              P != PEnd; ++P) {
3120           if (P != Best && S.getMoreSpecializedPartialSpecialization(
3121                                P->Partial, Best->Partial,
3122                                PointOfInstantiation) != Best->Partial) {
3123             Ambiguous = true;
3124             break;
3125           }
3126         }
3127 
3128         if (Ambiguous) {
3129           // Partial ordering did not produce a clear winner. Complain.
3130           Inst.Clear();
3131           ClassTemplateSpec->setInvalidDecl();
3132           S.Diag(PointOfInstantiation,
3133                  diag::err_partial_spec_ordering_ambiguous)
3134               << ClassTemplateSpec;
3135 
3136           // Print the matching partial specializations.
3137           for (SmallVectorImpl<MatchResult>::iterator P = Matched.begin(),
3138                                                    PEnd = Matched.end();
3139                P != PEnd; ++P)
3140             S.Diag(P->Partial->getLocation(), diag::note_partial_spec_match)
3141                 << S.getTemplateArgumentBindingsText(
3142                        P->Partial->getTemplateParameters(), *P->Args);
3143 
3144           return nullptr;
3145         }
3146       }
3147 
3148       ClassTemplateSpec->setInstantiationOf(Best->Partial, Best->Args);
3149     } else {
3150       //   -- If no matches are found, the instantiation is generated
3151       //      from the primary template.
3152     }
3153   }
3154 
3155   CXXRecordDecl *Pattern = nullptr;
3156   Specialized = ClassTemplateSpec->getSpecializedTemplateOrPartial();
3157   if (auto *PartialSpec =
3158           Specialized.dyn_cast<ClassTemplatePartialSpecializationDecl *>()) {
3159     // Instantiate using the best class template partial specialization.
3160     while (PartialSpec->getInstantiatedFromMember()) {
3161       // If we've found an explicit specialization of this class template,
3162       // stop here and use that as the pattern.
3163       if (PartialSpec->isMemberSpecialization())
3164         break;
3165 
3166       PartialSpec = PartialSpec->getInstantiatedFromMember();
3167     }
3168     Pattern = PartialSpec;
3169   } else {
3170     ClassTemplateDecl *Template = ClassTemplateSpec->getSpecializedTemplate();
3171     while (Template->getInstantiatedFromMemberTemplate()) {
3172       // If we've found an explicit specialization of this class template,
3173       // stop here and use that as the pattern.
3174       if (Template->isMemberSpecialization())
3175         break;
3176 
3177       Template = Template->getInstantiatedFromMemberTemplate();
3178     }
3179     Pattern = Template->getTemplatedDecl();
3180   }
3181 
3182   return Pattern;
3183 }
3184 
InstantiateClassTemplateSpecialization(SourceLocation PointOfInstantiation,ClassTemplateSpecializationDecl * ClassTemplateSpec,TemplateSpecializationKind TSK,bool Complain)3185 bool Sema::InstantiateClassTemplateSpecialization(
3186     SourceLocation PointOfInstantiation,
3187     ClassTemplateSpecializationDecl *ClassTemplateSpec,
3188     TemplateSpecializationKind TSK, bool Complain) {
3189   // Perform the actual instantiation on the canonical declaration.
3190   ClassTemplateSpec = cast<ClassTemplateSpecializationDecl>(
3191       ClassTemplateSpec->getCanonicalDecl());
3192   if (ClassTemplateSpec->isInvalidDecl())
3193     return true;
3194 
3195   CXXRecordDecl *Pattern = getPatternForClassTemplateSpecialization(
3196       *this, PointOfInstantiation, ClassTemplateSpec, TSK, Complain);
3197   if (!Pattern)
3198     return true;
3199 
3200   return InstantiateClass(PointOfInstantiation, ClassTemplateSpec, Pattern,
3201                           getTemplateInstantiationArgs(ClassTemplateSpec), TSK,
3202                           Complain);
3203 }
3204 
3205 /// Instantiates the definitions of all of the member
3206 /// of the given class, which is an instantiation of a class template
3207 /// or a member class of a template.
3208 void
InstantiateClassMembers(SourceLocation PointOfInstantiation,CXXRecordDecl * Instantiation,const MultiLevelTemplateArgumentList & TemplateArgs,TemplateSpecializationKind TSK)3209 Sema::InstantiateClassMembers(SourceLocation PointOfInstantiation,
3210                               CXXRecordDecl *Instantiation,
3211                         const MultiLevelTemplateArgumentList &TemplateArgs,
3212                               TemplateSpecializationKind TSK) {
3213   // FIXME: We need to notify the ASTMutationListener that we did all of these
3214   // things, in case we have an explicit instantiation definition in a PCM, a
3215   // module, or preamble, and the declaration is in an imported AST.
3216   assert(
3217       (TSK == TSK_ExplicitInstantiationDefinition ||
3218        TSK == TSK_ExplicitInstantiationDeclaration ||
3219        (TSK == TSK_ImplicitInstantiation && Instantiation->isLocalClass())) &&
3220       "Unexpected template specialization kind!");
3221   for (auto *D : Instantiation->decls()) {
3222     bool SuppressNew = false;
3223     if (auto *Function = dyn_cast<FunctionDecl>(D)) {
3224       if (FunctionDecl *Pattern =
3225               Function->getInstantiatedFromMemberFunction()) {
3226 
3227         if (Function->hasAttr<ExcludeFromExplicitInstantiationAttr>())
3228           continue;
3229 
3230         MemberSpecializationInfo *MSInfo =
3231             Function->getMemberSpecializationInfo();
3232         assert(MSInfo && "No member specialization information?");
3233         if (MSInfo->getTemplateSpecializationKind()
3234                                                  == TSK_ExplicitSpecialization)
3235           continue;
3236 
3237         if (CheckSpecializationInstantiationRedecl(PointOfInstantiation, TSK,
3238                                                    Function,
3239                                         MSInfo->getTemplateSpecializationKind(),
3240                                               MSInfo->getPointOfInstantiation(),
3241                                                    SuppressNew) ||
3242             SuppressNew)
3243           continue;
3244 
3245         // C++11 [temp.explicit]p8:
3246         //   An explicit instantiation definition that names a class template
3247         //   specialization explicitly instantiates the class template
3248         //   specialization and is only an explicit instantiation definition
3249         //   of members whose definition is visible at the point of
3250         //   instantiation.
3251         if (TSK == TSK_ExplicitInstantiationDefinition && !Pattern->isDefined())
3252           continue;
3253 
3254         Function->setTemplateSpecializationKind(TSK, PointOfInstantiation);
3255 
3256         if (Function->isDefined()) {
3257           // Let the ASTConsumer know that this function has been explicitly
3258           // instantiated now, and its linkage might have changed.
3259           Consumer.HandleTopLevelDecl(DeclGroupRef(Function));
3260         } else if (TSK == TSK_ExplicitInstantiationDefinition) {
3261           InstantiateFunctionDefinition(PointOfInstantiation, Function);
3262         } else if (TSK == TSK_ImplicitInstantiation) {
3263           PendingLocalImplicitInstantiations.push_back(
3264               std::make_pair(Function, PointOfInstantiation));
3265         }
3266       }
3267     } else if (auto *Var = dyn_cast<VarDecl>(D)) {
3268       if (isa<VarTemplateSpecializationDecl>(Var))
3269         continue;
3270 
3271       if (Var->isStaticDataMember()) {
3272         if (Var->hasAttr<ExcludeFromExplicitInstantiationAttr>())
3273           continue;
3274 
3275         MemberSpecializationInfo *MSInfo = Var->getMemberSpecializationInfo();
3276         assert(MSInfo && "No member specialization information?");
3277         if (MSInfo->getTemplateSpecializationKind()
3278                                                  == TSK_ExplicitSpecialization)
3279           continue;
3280 
3281         if (CheckSpecializationInstantiationRedecl(PointOfInstantiation, TSK,
3282                                                    Var,
3283                                         MSInfo->getTemplateSpecializationKind(),
3284                                               MSInfo->getPointOfInstantiation(),
3285                                                    SuppressNew) ||
3286             SuppressNew)
3287           continue;
3288 
3289         if (TSK == TSK_ExplicitInstantiationDefinition) {
3290           // C++0x [temp.explicit]p8:
3291           //   An explicit instantiation definition that names a class template
3292           //   specialization explicitly instantiates the class template
3293           //   specialization and is only an explicit instantiation definition
3294           //   of members whose definition is visible at the point of
3295           //   instantiation.
3296           if (!Var->getInstantiatedFromStaticDataMember()->getDefinition())
3297             continue;
3298 
3299           Var->setTemplateSpecializationKind(TSK, PointOfInstantiation);
3300           InstantiateVariableDefinition(PointOfInstantiation, Var);
3301         } else {
3302           Var->setTemplateSpecializationKind(TSK, PointOfInstantiation);
3303         }
3304       }
3305     } else if (auto *Record = dyn_cast<CXXRecordDecl>(D)) {
3306       if (Record->hasAttr<ExcludeFromExplicitInstantiationAttr>())
3307         continue;
3308 
3309       // Always skip the injected-class-name, along with any
3310       // redeclarations of nested classes, since both would cause us
3311       // to try to instantiate the members of a class twice.
3312       // Skip closure types; they'll get instantiated when we instantiate
3313       // the corresponding lambda-expression.
3314       if (Record->isInjectedClassName() || Record->getPreviousDecl() ||
3315           Record->isLambda())
3316         continue;
3317 
3318       MemberSpecializationInfo *MSInfo = Record->getMemberSpecializationInfo();
3319       assert(MSInfo && "No member specialization information?");
3320 
3321       if (MSInfo->getTemplateSpecializationKind()
3322                                                 == TSK_ExplicitSpecialization)
3323         continue;
3324 
3325       if (Context.getTargetInfo().getTriple().isOSWindows() &&
3326           TSK == TSK_ExplicitInstantiationDeclaration) {
3327         // On Windows, explicit instantiation decl of the outer class doesn't
3328         // affect the inner class. Typically extern template declarations are
3329         // used in combination with dll import/export annotations, but those
3330         // are not propagated from the outer class templates to inner classes.
3331         // Therefore, do not instantiate inner classes on this platform, so
3332         // that users don't end up with undefined symbols during linking.
3333         continue;
3334       }
3335 
3336       if (CheckSpecializationInstantiationRedecl(PointOfInstantiation, TSK,
3337                                                  Record,
3338                                         MSInfo->getTemplateSpecializationKind(),
3339                                               MSInfo->getPointOfInstantiation(),
3340                                                  SuppressNew) ||
3341           SuppressNew)
3342         continue;
3343 
3344       CXXRecordDecl *Pattern = Record->getInstantiatedFromMemberClass();
3345       assert(Pattern && "Missing instantiated-from-template information");
3346 
3347       if (!Record->getDefinition()) {
3348         if (!Pattern->getDefinition()) {
3349           // C++0x [temp.explicit]p8:
3350           //   An explicit instantiation definition that names a class template
3351           //   specialization explicitly instantiates the class template
3352           //   specialization and is only an explicit instantiation definition
3353           //   of members whose definition is visible at the point of
3354           //   instantiation.
3355           if (TSK == TSK_ExplicitInstantiationDeclaration) {
3356             MSInfo->setTemplateSpecializationKind(TSK);
3357             MSInfo->setPointOfInstantiation(PointOfInstantiation);
3358           }
3359 
3360           continue;
3361         }
3362 
3363         InstantiateClass(PointOfInstantiation, Record, Pattern,
3364                          TemplateArgs,
3365                          TSK);
3366       } else {
3367         if (TSK == TSK_ExplicitInstantiationDefinition &&
3368             Record->getTemplateSpecializationKind() ==
3369                 TSK_ExplicitInstantiationDeclaration) {
3370           Record->setTemplateSpecializationKind(TSK);
3371           MarkVTableUsed(PointOfInstantiation, Record, true);
3372         }
3373       }
3374 
3375       Pattern = cast_or_null<CXXRecordDecl>(Record->getDefinition());
3376       if (Pattern)
3377         InstantiateClassMembers(PointOfInstantiation, Pattern, TemplateArgs,
3378                                 TSK);
3379     } else if (auto *Enum = dyn_cast<EnumDecl>(D)) {
3380       MemberSpecializationInfo *MSInfo = Enum->getMemberSpecializationInfo();
3381       assert(MSInfo && "No member specialization information?");
3382 
3383       if (MSInfo->getTemplateSpecializationKind()
3384             == TSK_ExplicitSpecialization)
3385         continue;
3386 
3387       if (CheckSpecializationInstantiationRedecl(
3388             PointOfInstantiation, TSK, Enum,
3389             MSInfo->getTemplateSpecializationKind(),
3390             MSInfo->getPointOfInstantiation(), SuppressNew) ||
3391           SuppressNew)
3392         continue;
3393 
3394       if (Enum->getDefinition())
3395         continue;
3396 
3397       EnumDecl *Pattern = Enum->getTemplateInstantiationPattern();
3398       assert(Pattern && "Missing instantiated-from-template information");
3399 
3400       if (TSK == TSK_ExplicitInstantiationDefinition) {
3401         if (!Pattern->getDefinition())
3402           continue;
3403 
3404         InstantiateEnum(PointOfInstantiation, Enum, Pattern, TemplateArgs, TSK);
3405       } else {
3406         MSInfo->setTemplateSpecializationKind(TSK);
3407         MSInfo->setPointOfInstantiation(PointOfInstantiation);
3408       }
3409     } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3410       // No need to instantiate in-class initializers during explicit
3411       // instantiation.
3412       if (Field->hasInClassInitializer() && TSK == TSK_ImplicitInstantiation) {
3413         CXXRecordDecl *ClassPattern =
3414             Instantiation->getTemplateInstantiationPattern();
3415         DeclContext::lookup_result Lookup =
3416             ClassPattern->lookup(Field->getDeclName());
3417         FieldDecl *Pattern = cast<FieldDecl>(Lookup.front());
3418         InstantiateInClassInitializer(PointOfInstantiation, Field, Pattern,
3419                                       TemplateArgs);
3420       }
3421     }
3422   }
3423 }
3424 
3425 /// Instantiate the definitions of all of the members of the
3426 /// given class template specialization, which was named as part of an
3427 /// explicit instantiation.
3428 void
InstantiateClassTemplateSpecializationMembers(SourceLocation PointOfInstantiation,ClassTemplateSpecializationDecl * ClassTemplateSpec,TemplateSpecializationKind TSK)3429 Sema::InstantiateClassTemplateSpecializationMembers(
3430                                            SourceLocation PointOfInstantiation,
3431                             ClassTemplateSpecializationDecl *ClassTemplateSpec,
3432                                                TemplateSpecializationKind TSK) {
3433   // C++0x [temp.explicit]p7:
3434   //   An explicit instantiation that names a class template
3435   //   specialization is an explicit instantion of the same kind
3436   //   (declaration or definition) of each of its members (not
3437   //   including members inherited from base classes) that has not
3438   //   been previously explicitly specialized in the translation unit
3439   //   containing the explicit instantiation, except as described
3440   //   below.
3441   InstantiateClassMembers(PointOfInstantiation, ClassTemplateSpec,
3442                           getTemplateInstantiationArgs(ClassTemplateSpec),
3443                           TSK);
3444 }
3445 
3446 StmtResult
SubstStmt(Stmt * S,const MultiLevelTemplateArgumentList & TemplateArgs)3447 Sema::SubstStmt(Stmt *S, const MultiLevelTemplateArgumentList &TemplateArgs) {
3448   if (!S)
3449     return S;
3450 
3451   TemplateInstantiator Instantiator(*this, TemplateArgs,
3452                                     SourceLocation(),
3453                                     DeclarationName());
3454   return Instantiator.TransformStmt(S);
3455 }
3456 
SubstTemplateArguments(ArrayRef<TemplateArgumentLoc> Args,const MultiLevelTemplateArgumentList & TemplateArgs,TemplateArgumentListInfo & Out)3457 bool Sema::SubstTemplateArguments(
3458     ArrayRef<TemplateArgumentLoc> Args,
3459     const MultiLevelTemplateArgumentList &TemplateArgs,
3460     TemplateArgumentListInfo &Out) {
3461   TemplateInstantiator Instantiator(*this, TemplateArgs,
3462                                     SourceLocation(),
3463                                     DeclarationName());
3464   return Instantiator.TransformTemplateArguments(Args.begin(), Args.end(),
3465                                                  Out);
3466 }
3467 
3468 ExprResult
SubstExpr(Expr * E,const MultiLevelTemplateArgumentList & TemplateArgs)3469 Sema::SubstExpr(Expr *E, const MultiLevelTemplateArgumentList &TemplateArgs) {
3470   if (!E)
3471     return E;
3472 
3473   TemplateInstantiator Instantiator(*this, TemplateArgs,
3474                                     SourceLocation(),
3475                                     DeclarationName());
3476   return Instantiator.TransformExpr(E);
3477 }
3478 
SubstInitializer(Expr * Init,const MultiLevelTemplateArgumentList & TemplateArgs,bool CXXDirectInit)3479 ExprResult Sema::SubstInitializer(Expr *Init,
3480                           const MultiLevelTemplateArgumentList &TemplateArgs,
3481                           bool CXXDirectInit) {
3482   TemplateInstantiator Instantiator(*this, TemplateArgs,
3483                                     SourceLocation(),
3484                                     DeclarationName());
3485   return Instantiator.TransformInitializer(Init, CXXDirectInit);
3486 }
3487 
SubstExprs(ArrayRef<Expr * > Exprs,bool IsCall,const MultiLevelTemplateArgumentList & TemplateArgs,SmallVectorImpl<Expr * > & Outputs)3488 bool Sema::SubstExprs(ArrayRef<Expr *> Exprs, bool IsCall,
3489                       const MultiLevelTemplateArgumentList &TemplateArgs,
3490                       SmallVectorImpl<Expr *> &Outputs) {
3491   if (Exprs.empty())
3492     return false;
3493 
3494   TemplateInstantiator Instantiator(*this, TemplateArgs,
3495                                     SourceLocation(),
3496                                     DeclarationName());
3497   return Instantiator.TransformExprs(Exprs.data(), Exprs.size(),
3498                                      IsCall, Outputs);
3499 }
3500 
3501 NestedNameSpecifierLoc
SubstNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,const MultiLevelTemplateArgumentList & TemplateArgs)3502 Sema::SubstNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
3503                         const MultiLevelTemplateArgumentList &TemplateArgs) {
3504   if (!NNS)
3505     return NestedNameSpecifierLoc();
3506 
3507   TemplateInstantiator Instantiator(*this, TemplateArgs, NNS.getBeginLoc(),
3508                                     DeclarationName());
3509   return Instantiator.TransformNestedNameSpecifierLoc(NNS);
3510 }
3511 
3512 /// Do template substitution on declaration name info.
3513 DeclarationNameInfo
SubstDeclarationNameInfo(const DeclarationNameInfo & NameInfo,const MultiLevelTemplateArgumentList & TemplateArgs)3514 Sema::SubstDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
3515                          const MultiLevelTemplateArgumentList &TemplateArgs) {
3516   TemplateInstantiator Instantiator(*this, TemplateArgs, NameInfo.getLoc(),
3517                                     NameInfo.getName());
3518   return Instantiator.TransformDeclarationNameInfo(NameInfo);
3519 }
3520 
3521 TemplateName
SubstTemplateName(NestedNameSpecifierLoc QualifierLoc,TemplateName Name,SourceLocation Loc,const MultiLevelTemplateArgumentList & TemplateArgs)3522 Sema::SubstTemplateName(NestedNameSpecifierLoc QualifierLoc,
3523                         TemplateName Name, SourceLocation Loc,
3524                         const MultiLevelTemplateArgumentList &TemplateArgs) {
3525   TemplateInstantiator Instantiator(*this, TemplateArgs, Loc,
3526                                     DeclarationName());
3527   CXXScopeSpec SS;
3528   SS.Adopt(QualifierLoc);
3529   return Instantiator.TransformTemplateName(SS, Name, Loc);
3530 }
3531 
Subst(const TemplateArgumentLoc * Args,unsigned NumArgs,TemplateArgumentListInfo & Result,const MultiLevelTemplateArgumentList & TemplateArgs)3532 bool Sema::Subst(const TemplateArgumentLoc *Args, unsigned NumArgs,
3533                  TemplateArgumentListInfo &Result,
3534                  const MultiLevelTemplateArgumentList &TemplateArgs) {
3535   TemplateInstantiator Instantiator(*this, TemplateArgs, SourceLocation(),
3536                                     DeclarationName());
3537 
3538   return Instantiator.TransformTemplateArguments(Args, NumArgs, Result);
3539 }
3540 
getCanonicalParmVarDecl(const Decl * D)3541 static const Decl *getCanonicalParmVarDecl(const Decl *D) {
3542   // When storing ParmVarDecls in the local instantiation scope, we always
3543   // want to use the ParmVarDecl from the canonical function declaration,
3544   // since the map is then valid for any redeclaration or definition of that
3545   // function.
3546   if (const ParmVarDecl *PV = dyn_cast<ParmVarDecl>(D)) {
3547     if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(PV->getDeclContext())) {
3548       unsigned i = PV->getFunctionScopeIndex();
3549       // This parameter might be from a freestanding function type within the
3550       // function and isn't necessarily referring to one of FD's parameters.
3551       if (i < FD->getNumParams() && FD->getParamDecl(i) == PV)
3552         return FD->getCanonicalDecl()->getParamDecl(i);
3553     }
3554   }
3555   return D;
3556 }
3557 
3558 
3559 llvm::PointerUnion<Decl *, LocalInstantiationScope::DeclArgumentPack *> *
findInstantiationOf(const Decl * D)3560 LocalInstantiationScope::findInstantiationOf(const Decl *D) {
3561   D = getCanonicalParmVarDecl(D);
3562   for (LocalInstantiationScope *Current = this; Current;
3563        Current = Current->Outer) {
3564 
3565     // Check if we found something within this scope.
3566     const Decl *CheckD = D;
3567     do {
3568       LocalDeclsMap::iterator Found = Current->LocalDecls.find(CheckD);
3569       if (Found != Current->LocalDecls.end())
3570         return &Found->second;
3571 
3572       // If this is a tag declaration, it's possible that we need to look for
3573       // a previous declaration.
3574       if (const TagDecl *Tag = dyn_cast<TagDecl>(CheckD))
3575         CheckD = Tag->getPreviousDecl();
3576       else
3577         CheckD = nullptr;
3578     } while (CheckD);
3579 
3580     // If we aren't combined with our outer scope, we're done.
3581     if (!Current->CombineWithOuterScope)
3582       break;
3583   }
3584 
3585   // If we're performing a partial substitution during template argument
3586   // deduction, we may not have values for template parameters yet.
3587   if (isa<NonTypeTemplateParmDecl>(D) || isa<TemplateTypeParmDecl>(D) ||
3588       isa<TemplateTemplateParmDecl>(D))
3589     return nullptr;
3590 
3591   // Local types referenced prior to definition may require instantiation.
3592   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
3593     if (RD->isLocalClass())
3594       return nullptr;
3595 
3596   // Enumeration types referenced prior to definition may appear as a result of
3597   // error recovery.
3598   if (isa<EnumDecl>(D))
3599     return nullptr;
3600 
3601   // Materialized typedefs/type alias for implicit deduction guides may require
3602   // instantiation.
3603   if (isa<TypedefNameDecl>(D) &&
3604       isa<CXXDeductionGuideDecl>(D->getDeclContext()))
3605     return nullptr;
3606 
3607   // If we didn't find the decl, then we either have a sema bug, or we have a
3608   // forward reference to a label declaration.  Return null to indicate that
3609   // we have an uninstantiated label.
3610   assert(isa<LabelDecl>(D) && "declaration not instantiated in this scope");
3611   return nullptr;
3612 }
3613 
InstantiatedLocal(const Decl * D,Decl * Inst)3614 void LocalInstantiationScope::InstantiatedLocal(const Decl *D, Decl *Inst) {
3615   D = getCanonicalParmVarDecl(D);
3616   llvm::PointerUnion<Decl *, DeclArgumentPack *> &Stored = LocalDecls[D];
3617   if (Stored.isNull()) {
3618 #ifndef NDEBUG
3619     // It should not be present in any surrounding scope either.
3620     LocalInstantiationScope *Current = this;
3621     while (Current->CombineWithOuterScope && Current->Outer) {
3622       Current = Current->Outer;
3623       assert(Current->LocalDecls.find(D) == Current->LocalDecls.end() &&
3624              "Instantiated local in inner and outer scopes");
3625     }
3626 #endif
3627     Stored = Inst;
3628   } else if (DeclArgumentPack *Pack = Stored.dyn_cast<DeclArgumentPack *>()) {
3629     Pack->push_back(cast<VarDecl>(Inst));
3630   } else {
3631     assert(Stored.get<Decl *>() == Inst && "Already instantiated this local");
3632   }
3633 }
3634 
InstantiatedLocalPackArg(const Decl * D,VarDecl * Inst)3635 void LocalInstantiationScope::InstantiatedLocalPackArg(const Decl *D,
3636                                                        VarDecl *Inst) {
3637   D = getCanonicalParmVarDecl(D);
3638   DeclArgumentPack *Pack = LocalDecls[D].get<DeclArgumentPack *>();
3639   Pack->push_back(Inst);
3640 }
3641 
MakeInstantiatedLocalArgPack(const Decl * D)3642 void LocalInstantiationScope::MakeInstantiatedLocalArgPack(const Decl *D) {
3643 #ifndef NDEBUG
3644   // This should be the first time we've been told about this decl.
3645   for (LocalInstantiationScope *Current = this;
3646        Current && Current->CombineWithOuterScope; Current = Current->Outer)
3647     assert(Current->LocalDecls.find(D) == Current->LocalDecls.end() &&
3648            "Creating local pack after instantiation of local");
3649 #endif
3650 
3651   D = getCanonicalParmVarDecl(D);
3652   llvm::PointerUnion<Decl *, DeclArgumentPack *> &Stored = LocalDecls[D];
3653   DeclArgumentPack *Pack = new DeclArgumentPack;
3654   Stored = Pack;
3655   ArgumentPacks.push_back(Pack);
3656 }
3657 
isLocalPackExpansion(const Decl * D)3658 bool LocalInstantiationScope::isLocalPackExpansion(const Decl *D) {
3659   for (DeclArgumentPack *Pack : ArgumentPacks)
3660     if (std::find(Pack->begin(), Pack->end(), D) != Pack->end())
3661       return true;
3662   return false;
3663 }
3664 
SetPartiallySubstitutedPack(NamedDecl * Pack,const TemplateArgument * ExplicitArgs,unsigned NumExplicitArgs)3665 void LocalInstantiationScope::SetPartiallySubstitutedPack(NamedDecl *Pack,
3666                                           const TemplateArgument *ExplicitArgs,
3667                                                     unsigned NumExplicitArgs) {
3668   assert((!PartiallySubstitutedPack || PartiallySubstitutedPack == Pack) &&
3669          "Already have a partially-substituted pack");
3670   assert((!PartiallySubstitutedPack
3671           || NumArgsInPartiallySubstitutedPack == NumExplicitArgs) &&
3672          "Wrong number of arguments in partially-substituted pack");
3673   PartiallySubstitutedPack = Pack;
3674   ArgsInPartiallySubstitutedPack = ExplicitArgs;
3675   NumArgsInPartiallySubstitutedPack = NumExplicitArgs;
3676 }
3677 
getPartiallySubstitutedPack(const TemplateArgument ** ExplicitArgs,unsigned * NumExplicitArgs) const3678 NamedDecl *LocalInstantiationScope::getPartiallySubstitutedPack(
3679                                          const TemplateArgument **ExplicitArgs,
3680                                               unsigned *NumExplicitArgs) const {
3681   if (ExplicitArgs)
3682     *ExplicitArgs = nullptr;
3683   if (NumExplicitArgs)
3684     *NumExplicitArgs = 0;
3685 
3686   for (const LocalInstantiationScope *Current = this; Current;
3687        Current = Current->Outer) {
3688     if (Current->PartiallySubstitutedPack) {
3689       if (ExplicitArgs)
3690         *ExplicitArgs = Current->ArgsInPartiallySubstitutedPack;
3691       if (NumExplicitArgs)
3692         *NumExplicitArgs = Current->NumArgsInPartiallySubstitutedPack;
3693 
3694       return Current->PartiallySubstitutedPack;
3695     }
3696 
3697     if (!Current->CombineWithOuterScope)
3698       break;
3699   }
3700 
3701   return nullptr;
3702 }
3703