1 //===--- TemplateBase.cpp - Common template AST class implementation ------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements common classes used throughout C++ template
13 //===----------------------------------------------------------------------===//
15 #include "clang/AST/TemplateBase.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/DeclBase.h"
18 #include "clang/AST/DeclTemplate.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/Type.h"
22 #include "clang/AST/TypeLoc.h"
23 #include "clang/Basic/Diagnostic.h"
24 #include "llvm/ADT/FoldingSet.h"
25 #include "llvm/ADT/SmallString.h"
26 #include "llvm/Support/raw_ostream.h"
29 using namespace clang;
31 /// \brief Print a template integral argument value.
33 /// \param TemplArg the TemplateArgument instance to print.
35 /// \param Out the raw_ostream instance to use for printing.
37 /// \param Policy the printing policy for EnumConstantDecl printing.
38 static void printIntegral(const TemplateArgument &TemplArg,
39 raw_ostream &Out, const PrintingPolicy& Policy) {
40 const ::clang::Type *T = TemplArg.getIntegralType().getTypePtr();
41 const llvm::APSInt &Val = TemplArg.getAsIntegral();
43 if (const EnumType *ET = T->getAs<EnumType>()) {
44 for (const EnumConstantDecl* ECD : ET->getDecl()->enumerators()) {
45 // In Sema::CheckTemplateArugment, enum template arguments value are
46 // extended to the size of the integer underlying the enum type. This
47 // may create a size difference between the enum value and template
48 // argument value, requiring isSameValue here instead of operator==.
49 if (llvm::APSInt::isSameValue(ECD->getInitVal(), Val)) {
50 ECD->printQualifiedName(Out, Policy);
56 if (T->isBooleanType() && !Policy.MSVCFormatting) {
57 Out << (Val.getBoolValue() ? "true" : "false");
58 } else if (T->isCharType()) {
59 const char Ch = Val.getZExtValue();
60 Out << ((Ch == '\'') ? "'\\" : "'");
61 Out.write_escaped(StringRef(&Ch, 1), /*UseHexEscapes=*/ true);
68 //===----------------------------------------------------------------------===//
69 // TemplateArgument Implementation
70 //===----------------------------------------------------------------------===//
72 TemplateArgument::TemplateArgument(ASTContext &Ctx, const llvm::APSInt &Value,
74 Integer.Kind = Integral;
75 // Copy the APSInt value into our decomposed form.
76 Integer.BitWidth = Value.getBitWidth();
77 Integer.IsUnsigned = Value.isUnsigned();
78 // If the value is large, we have to get additional memory from the ASTContext
79 unsigned NumWords = Value.getNumWords();
81 void *Mem = Ctx.Allocate(NumWords * sizeof(uint64_t));
82 std::memcpy(Mem, Value.getRawData(), NumWords * sizeof(uint64_t));
83 Integer.pVal = static_cast<uint64_t *>(Mem);
85 Integer.VAL = Value.getZExtValue();
88 Integer.Type = Type.getAsOpaquePtr();
92 TemplateArgument::CreatePackCopy(ASTContext &Context,
93 ArrayRef<TemplateArgument> Args) {
95 return getEmptyPack();
97 return TemplateArgument(Args.copy(Context));
100 bool TemplateArgument::isDependent() const {
103 llvm_unreachable("Should not have a NULL template argument");
106 return getAsType()->isDependentType() ||
107 isa<PackExpansionType>(getAsType());
110 return getAsTemplate().isDependent();
112 case TemplateExpansion:
116 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
117 return DC->isDependentContext();
118 return getAsDecl()->getDeclContext()->isDependentContext();
128 return (getAsExpr()->isTypeDependent() || getAsExpr()->isValueDependent() ||
129 isa<PackExpansionExpr>(getAsExpr()));
132 for (const auto &P : pack_elements())
138 llvm_unreachable("Invalid TemplateArgument Kind!");
141 bool TemplateArgument::isInstantiationDependent() const {
144 llvm_unreachable("Should not have a NULL template argument");
147 return getAsType()->isInstantiationDependentType();
150 return getAsTemplate().isInstantiationDependent();
152 case TemplateExpansion:
156 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
157 return DC->isDependentContext();
158 return getAsDecl()->getDeclContext()->isDependentContext();
168 return getAsExpr()->isInstantiationDependent();
171 for (const auto &P : pack_elements())
172 if (P.isInstantiationDependent())
177 llvm_unreachable("Invalid TemplateArgument Kind!");
180 bool TemplateArgument::isPackExpansion() const {
190 case TemplateExpansion:
194 return isa<PackExpansionType>(getAsType());
197 return isa<PackExpansionExpr>(getAsExpr());
200 llvm_unreachable("Invalid TemplateArgument Kind!");
203 bool TemplateArgument::containsUnexpandedParameterPack() const {
208 case TemplateExpansion:
213 if (getAsType()->containsUnexpandedParameterPack())
218 if (getAsTemplate().containsUnexpandedParameterPack())
223 if (getAsExpr()->containsUnexpandedParameterPack())
228 for (const auto &P : pack_elements())
229 if (P.containsUnexpandedParameterPack())
238 Optional<unsigned> TemplateArgument::getNumTemplateExpansions() const {
239 assert(getKind() == TemplateExpansion);
240 if (TemplateArg.NumExpansions)
241 return TemplateArg.NumExpansions - 1;
246 QualType TemplateArgument::getNonTypeTemplateArgumentType() const {
248 case TemplateArgument::Null:
249 case TemplateArgument::Type:
250 case TemplateArgument::Template:
251 case TemplateArgument::TemplateExpansion:
252 case TemplateArgument::Pack:
255 case TemplateArgument::Integral:
256 return getIntegralType();
258 case TemplateArgument::Expression:
259 return getAsExpr()->getType();
261 case TemplateArgument::Declaration:
262 return getParamTypeForDecl();
264 case TemplateArgument::NullPtr:
265 return getNullPtrType();
268 llvm_unreachable("Invalid TemplateArgument Kind!");
271 void TemplateArgument::Profile(llvm::FoldingSetNodeID &ID,
272 const ASTContext &Context) const {
273 ID.AddInteger(getKind());
279 getAsType().Profile(ID);
283 getNullPtrType().Profile(ID);
287 ID.AddPointer(getAsDecl()? getAsDecl()->getCanonicalDecl() : nullptr);
291 case TemplateExpansion: {
292 TemplateName Template = getAsTemplateOrTemplatePattern();
293 if (TemplateTemplateParmDecl *TTP
294 = dyn_cast_or_null<TemplateTemplateParmDecl>(
295 Template.getAsTemplateDecl())) {
297 ID.AddInteger(TTP->getDepth());
298 ID.AddInteger(TTP->getPosition());
299 ID.AddBoolean(TTP->isParameterPack());
301 ID.AddBoolean(false);
302 ID.AddPointer(Context.getCanonicalTemplateName(Template)
303 .getAsVoidPointer());
309 getAsIntegral().Profile(ID);
310 getIntegralType().Profile(ID);
314 getAsExpr()->Profile(ID, Context, true);
318 ID.AddInteger(Args.NumArgs);
319 for (unsigned I = 0; I != Args.NumArgs; ++I)
320 Args.Args[I].Profile(ID, Context);
324 bool TemplateArgument::structurallyEquals(const TemplateArgument &Other) const {
325 if (getKind() != Other.getKind()) return false;
332 case TemplateExpansion:
334 return TypeOrValue.V == Other.TypeOrValue.V;
337 return getAsDecl() == Other.getAsDecl();
340 return getIntegralType() == Other.getIntegralType() &&
341 getAsIntegral() == Other.getAsIntegral();
344 if (Args.NumArgs != Other.Args.NumArgs) return false;
345 for (unsigned I = 0, E = Args.NumArgs; I != E; ++I)
346 if (!Args.Args[I].structurallyEquals(Other.Args.Args[I]))
351 llvm_unreachable("Invalid TemplateArgument Kind!");
354 TemplateArgument TemplateArgument::getPackExpansionPattern() const {
355 assert(isPackExpansion());
359 return getAsType()->getAs<PackExpansionType>()->getPattern();
362 return cast<PackExpansionExpr>(getAsExpr())->getPattern();
364 case TemplateExpansion:
365 return TemplateArgument(getAsTemplateOrTemplatePattern());
373 return TemplateArgument();
376 llvm_unreachable("Invalid TemplateArgument Kind!");
379 void TemplateArgument::print(const PrintingPolicy &Policy,
380 raw_ostream &Out) const {
387 PrintingPolicy SubPolicy(Policy);
388 SubPolicy.SuppressStrongLifetime = true;
389 getAsType().print(Out, SubPolicy);
394 NamedDecl *ND = cast<NamedDecl>(getAsDecl());
396 if (ND->getDeclName()) {
397 // FIXME: distinguish between pointer and reference args?
398 ND->printQualifiedName(Out);
400 Out << "(anonymous)";
410 getAsTemplate().print(Out, Policy);
413 case TemplateExpansion:
414 getAsTemplateOrTemplatePattern().print(Out, Policy);
419 printIntegral(*this, Out, Policy);
424 getAsExpr()->printPretty(Out, nullptr, Policy);
430 for (const auto &P : pack_elements()) {
436 P.print(Policy, Out);
443 void TemplateArgument::dump(raw_ostream &Out) const {
444 LangOptions LO; // FIXME! see also TemplateName::dump().
447 print(PrintingPolicy(LO), Out);
450 LLVM_DUMP_METHOD void TemplateArgument::dump() const { dump(llvm::errs()); }
452 //===----------------------------------------------------------------------===//
453 // TemplateArgumentLoc Implementation
454 //===----------------------------------------------------------------------===//
456 SourceRange TemplateArgumentLoc::getSourceRange() const {
457 switch (Argument.getKind()) {
458 case TemplateArgument::Expression:
459 return getSourceExpression()->getSourceRange();
461 case TemplateArgument::Declaration:
462 return getSourceDeclExpression()->getSourceRange();
464 case TemplateArgument::NullPtr:
465 return getSourceNullPtrExpression()->getSourceRange();
467 case TemplateArgument::Type:
468 if (TypeSourceInfo *TSI = getTypeSourceInfo())
469 return TSI->getTypeLoc().getSourceRange();
471 return SourceRange();
473 case TemplateArgument::Template:
474 if (getTemplateQualifierLoc())
475 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
476 getTemplateNameLoc());
477 return SourceRange(getTemplateNameLoc());
479 case TemplateArgument::TemplateExpansion:
480 if (getTemplateQualifierLoc())
481 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
482 getTemplateEllipsisLoc());
483 return SourceRange(getTemplateNameLoc(), getTemplateEllipsisLoc());
485 case TemplateArgument::Integral:
486 return getSourceIntegralExpression()->getSourceRange();
488 case TemplateArgument::Pack:
489 case TemplateArgument::Null:
490 return SourceRange();
493 llvm_unreachable("Invalid TemplateArgument Kind!");
496 const DiagnosticBuilder &clang::operator<<(const DiagnosticBuilder &DB,
497 const TemplateArgument &Arg) {
498 switch (Arg.getKind()) {
499 case TemplateArgument::Null:
500 // This is bad, but not as bad as crashing because of argument
502 return DB << "(null template argument)";
504 case TemplateArgument::Type:
505 return DB << Arg.getAsType();
507 case TemplateArgument::Declaration:
508 return DB << Arg.getAsDecl();
510 case TemplateArgument::NullPtr:
511 return DB << "nullptr";
513 case TemplateArgument::Integral:
514 return DB << Arg.getAsIntegral().toString(10);
516 case TemplateArgument::Template:
517 return DB << Arg.getAsTemplate();
519 case TemplateArgument::TemplateExpansion:
520 return DB << Arg.getAsTemplateOrTemplatePattern() << "...";
522 case TemplateArgument::Expression: {
523 // This shouldn't actually ever happen, so it's okay that we're
524 // regurgitating an expression here.
525 // FIXME: We're guessing at LangOptions!
527 llvm::raw_svector_ostream OS(Str);
528 LangOptions LangOpts;
529 LangOpts.CPlusPlus = true;
530 PrintingPolicy Policy(LangOpts);
531 Arg.getAsExpr()->printPretty(OS, nullptr, Policy);
532 return DB << OS.str();
535 case TemplateArgument::Pack: {
536 // FIXME: We're guessing at LangOptions!
538 llvm::raw_svector_ostream OS(Str);
539 LangOptions LangOpts;
540 LangOpts.CPlusPlus = true;
541 PrintingPolicy Policy(LangOpts);
542 Arg.print(Policy, OS);
543 return DB << OS.str();
547 llvm_unreachable("Invalid TemplateArgument Kind!");
550 const ASTTemplateArgumentListInfo *
551 ASTTemplateArgumentListInfo::Create(ASTContext &C,
552 const TemplateArgumentListInfo &List) {
553 std::size_t size = totalSizeToAlloc<TemplateArgumentLoc>(List.size());
554 void *Mem = C.Allocate(size, alignof(ASTTemplateArgumentListInfo));
555 return new (Mem) ASTTemplateArgumentListInfo(List);
558 ASTTemplateArgumentListInfo::ASTTemplateArgumentListInfo(
559 const TemplateArgumentListInfo &Info) {
560 LAngleLoc = Info.getLAngleLoc();
561 RAngleLoc = Info.getRAngleLoc();
562 NumTemplateArgs = Info.size();
564 TemplateArgumentLoc *ArgBuffer = getTrailingObjects<TemplateArgumentLoc>();
565 for (unsigned i = 0; i != NumTemplateArgs; ++i)
566 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
569 void ASTTemplateKWAndArgsInfo::initializeFrom(
570 SourceLocation TemplateKWLoc, const TemplateArgumentListInfo &Info,
571 TemplateArgumentLoc *OutArgArray) {
572 this->TemplateKWLoc = TemplateKWLoc;
573 LAngleLoc = Info.getLAngleLoc();
574 RAngleLoc = Info.getRAngleLoc();
575 NumTemplateArgs = Info.size();
577 for (unsigned i = 0; i != NumTemplateArgs; ++i)
578 new (&OutArgArray[i]) TemplateArgumentLoc(Info[i]);
581 void ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc) {
582 assert(TemplateKWLoc.isValid());
583 LAngleLoc = SourceLocation();
584 RAngleLoc = SourceLocation();
585 this->TemplateKWLoc = TemplateKWLoc;
589 void ASTTemplateKWAndArgsInfo::initializeFrom(
590 SourceLocation TemplateKWLoc, const TemplateArgumentListInfo &Info,
591 TemplateArgumentLoc *OutArgArray, bool &Dependent,
592 bool &InstantiationDependent, bool &ContainsUnexpandedParameterPack) {
593 this->TemplateKWLoc = TemplateKWLoc;
594 LAngleLoc = Info.getLAngleLoc();
595 RAngleLoc = Info.getRAngleLoc();
596 NumTemplateArgs = Info.size();
598 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
599 Dependent = Dependent || Info[i].getArgument().isDependent();
600 InstantiationDependent = InstantiationDependent ||
601 Info[i].getArgument().isInstantiationDependent();
602 ContainsUnexpandedParameterPack =
603 ContainsUnexpandedParameterPack ||
604 Info[i].getArgument().containsUnexpandedParameterPack();
606 new (&OutArgArray[i]) TemplateArgumentLoc(Info[i]);
610 void ASTTemplateKWAndArgsInfo::copyInto(const TemplateArgumentLoc *ArgArray,
611 TemplateArgumentListInfo &Info) const {
612 Info.setLAngleLoc(LAngleLoc);
613 Info.setRAngleLoc(RAngleLoc);
614 for (unsigned I = 0; I != NumTemplateArgs; ++I)
615 Info.addArgument(ArgArray[I]);