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/Decl.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/DeclTemplate.h"
20 #include "clang/AST/Expr.h"
21 #include "clang/AST/ExprCXX.h"
22 #include "clang/AST/PrettyPrinter.h"
23 #include "clang/AST/TemplateName.h"
24 #include "clang/AST/Type.h"
25 #include "clang/AST/TypeLoc.h"
26 #include "clang/Basic/Diagnostic.h"
27 #include "clang/Basic/LLVM.h"
28 #include "clang/Basic/LangOptions.h"
29 #include "clang/Basic/SourceLocation.h"
30 #include "llvm/ADT/APSInt.h"
31 #include "llvm/ADT/FoldingSet.h"
32 #include "llvm/ADT/None.h"
33 #include "llvm/ADT/SmallString.h"
34 #include "llvm/ADT/StringRef.h"
35 #include "llvm/Support/Casting.h"
36 #include "llvm/Support/Compiler.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/raw_ostream.h"
44 using namespace clang;
46 /// \brief Print a template integral argument value.
48 /// \param TemplArg the TemplateArgument instance to print.
50 /// \param Out the raw_ostream instance to use for printing.
52 /// \param Policy the printing policy for EnumConstantDecl printing.
53 static void printIntegral(const TemplateArgument &TemplArg,
54 raw_ostream &Out, const PrintingPolicy& Policy) {
55 const Type *T = TemplArg.getIntegralType().getTypePtr();
56 const llvm::APSInt &Val = TemplArg.getAsIntegral();
58 if (const EnumType *ET = T->getAs<EnumType>()) {
59 for (const EnumConstantDecl* ECD : ET->getDecl()->enumerators()) {
60 // In Sema::CheckTemplateArugment, enum template arguments value are
61 // extended to the size of the integer underlying the enum type. This
62 // may create a size difference between the enum value and template
63 // argument value, requiring isSameValue here instead of operator==.
64 if (llvm::APSInt::isSameValue(ECD->getInitVal(), Val)) {
65 ECD->printQualifiedName(Out, Policy);
71 if (T->isBooleanType() && !Policy.MSVCFormatting) {
72 Out << (Val.getBoolValue() ? "true" : "false");
73 } else if (T->isCharType()) {
74 const char Ch = Val.getZExtValue();
75 Out << ((Ch == '\'') ? "'\\" : "'");
76 Out.write_escaped(StringRef(&Ch, 1), /*UseHexEscapes=*/ true);
83 //===----------------------------------------------------------------------===//
84 // TemplateArgument Implementation
85 //===----------------------------------------------------------------------===//
87 TemplateArgument::TemplateArgument(ASTContext &Ctx, const llvm::APSInt &Value,
89 Integer.Kind = Integral;
90 // Copy the APSInt value into our decomposed form.
91 Integer.BitWidth = Value.getBitWidth();
92 Integer.IsUnsigned = Value.isUnsigned();
93 // If the value is large, we have to get additional memory from the ASTContext
94 unsigned NumWords = Value.getNumWords();
96 void *Mem = Ctx.Allocate(NumWords * sizeof(uint64_t));
97 std::memcpy(Mem, Value.getRawData(), NumWords * sizeof(uint64_t));
98 Integer.pVal = static_cast<uint64_t *>(Mem);
100 Integer.VAL = Value.getZExtValue();
103 Integer.Type = Type.getAsOpaquePtr();
107 TemplateArgument::CreatePackCopy(ASTContext &Context,
108 ArrayRef<TemplateArgument> Args) {
110 return getEmptyPack();
112 return TemplateArgument(Args.copy(Context));
115 bool TemplateArgument::isDependent() const {
118 llvm_unreachable("Should not have a NULL template argument");
121 return getAsType()->isDependentType() ||
122 isa<PackExpansionType>(getAsType());
125 return getAsTemplate().isDependent();
127 case TemplateExpansion:
131 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
132 return DC->isDependentContext();
133 return getAsDecl()->getDeclContext()->isDependentContext();
143 return (getAsExpr()->isTypeDependent() || getAsExpr()->isValueDependent() ||
144 isa<PackExpansionExpr>(getAsExpr()));
147 for (const auto &P : pack_elements())
153 llvm_unreachable("Invalid TemplateArgument Kind!");
156 bool TemplateArgument::isInstantiationDependent() const {
159 llvm_unreachable("Should not have a NULL template argument");
162 return getAsType()->isInstantiationDependentType();
165 return getAsTemplate().isInstantiationDependent();
167 case TemplateExpansion:
171 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
172 return DC->isDependentContext();
173 return getAsDecl()->getDeclContext()->isDependentContext();
183 return getAsExpr()->isInstantiationDependent();
186 for (const auto &P : pack_elements())
187 if (P.isInstantiationDependent())
192 llvm_unreachable("Invalid TemplateArgument Kind!");
195 bool TemplateArgument::isPackExpansion() const {
205 case TemplateExpansion:
209 return isa<PackExpansionType>(getAsType());
212 return isa<PackExpansionExpr>(getAsExpr());
215 llvm_unreachable("Invalid TemplateArgument Kind!");
218 bool TemplateArgument::containsUnexpandedParameterPack() const {
223 case TemplateExpansion:
228 if (getAsType()->containsUnexpandedParameterPack())
233 if (getAsTemplate().containsUnexpandedParameterPack())
238 if (getAsExpr()->containsUnexpandedParameterPack())
243 for (const auto &P : pack_elements())
244 if (P.containsUnexpandedParameterPack())
253 Optional<unsigned> TemplateArgument::getNumTemplateExpansions() const {
254 assert(getKind() == TemplateExpansion);
255 if (TemplateArg.NumExpansions)
256 return TemplateArg.NumExpansions - 1;
261 QualType TemplateArgument::getNonTypeTemplateArgumentType() const {
263 case TemplateArgument::Null:
264 case TemplateArgument::Type:
265 case TemplateArgument::Template:
266 case TemplateArgument::TemplateExpansion:
267 case TemplateArgument::Pack:
270 case TemplateArgument::Integral:
271 return getIntegralType();
273 case TemplateArgument::Expression:
274 return getAsExpr()->getType();
276 case TemplateArgument::Declaration:
277 return getParamTypeForDecl();
279 case TemplateArgument::NullPtr:
280 return getNullPtrType();
283 llvm_unreachable("Invalid TemplateArgument Kind!");
286 void TemplateArgument::Profile(llvm::FoldingSetNodeID &ID,
287 const ASTContext &Context) const {
288 ID.AddInteger(getKind());
294 getAsType().Profile(ID);
298 getNullPtrType().Profile(ID);
302 ID.AddPointer(getAsDecl()? getAsDecl()->getCanonicalDecl() : nullptr);
306 case TemplateExpansion: {
307 TemplateName Template = getAsTemplateOrTemplatePattern();
308 if (TemplateTemplateParmDecl *TTP
309 = dyn_cast_or_null<TemplateTemplateParmDecl>(
310 Template.getAsTemplateDecl())) {
312 ID.AddInteger(TTP->getDepth());
313 ID.AddInteger(TTP->getPosition());
314 ID.AddBoolean(TTP->isParameterPack());
316 ID.AddBoolean(false);
317 ID.AddPointer(Context.getCanonicalTemplateName(Template)
318 .getAsVoidPointer());
324 getAsIntegral().Profile(ID);
325 getIntegralType().Profile(ID);
329 getAsExpr()->Profile(ID, Context, true);
333 ID.AddInteger(Args.NumArgs);
334 for (unsigned I = 0; I != Args.NumArgs; ++I)
335 Args.Args[I].Profile(ID, Context);
339 bool TemplateArgument::structurallyEquals(const TemplateArgument &Other) const {
340 if (getKind() != Other.getKind()) return false;
347 case TemplateExpansion:
349 return TypeOrValue.V == Other.TypeOrValue.V;
352 return getAsDecl() == Other.getAsDecl();
355 return getIntegralType() == Other.getIntegralType() &&
356 getAsIntegral() == Other.getAsIntegral();
359 if (Args.NumArgs != Other.Args.NumArgs) return false;
360 for (unsigned I = 0, E = Args.NumArgs; I != E; ++I)
361 if (!Args.Args[I].structurallyEquals(Other.Args.Args[I]))
366 llvm_unreachable("Invalid TemplateArgument Kind!");
369 TemplateArgument TemplateArgument::getPackExpansionPattern() const {
370 assert(isPackExpansion());
374 return getAsType()->getAs<PackExpansionType>()->getPattern();
377 return cast<PackExpansionExpr>(getAsExpr())->getPattern();
379 case TemplateExpansion:
380 return TemplateArgument(getAsTemplateOrTemplatePattern());
388 return TemplateArgument();
391 llvm_unreachable("Invalid TemplateArgument Kind!");
394 void TemplateArgument::print(const PrintingPolicy &Policy,
395 raw_ostream &Out) const {
402 PrintingPolicy SubPolicy(Policy);
403 SubPolicy.SuppressStrongLifetime = true;
404 getAsType().print(Out, SubPolicy);
409 NamedDecl *ND = cast<NamedDecl>(getAsDecl());
411 if (ND->getDeclName()) {
412 // FIXME: distinguish between pointer and reference args?
413 ND->printQualifiedName(Out);
415 Out << "(anonymous)";
425 getAsTemplate().print(Out, Policy);
428 case TemplateExpansion:
429 getAsTemplateOrTemplatePattern().print(Out, Policy);
434 printIntegral(*this, Out, Policy);
438 getAsExpr()->printPretty(Out, nullptr, Policy);
444 for (const auto &P : pack_elements()) {
450 P.print(Policy, Out);
457 void TemplateArgument::dump(raw_ostream &Out) const {
458 LangOptions LO; // FIXME! see also TemplateName::dump().
461 print(PrintingPolicy(LO), Out);
464 LLVM_DUMP_METHOD void TemplateArgument::dump() const { dump(llvm::errs()); }
466 //===----------------------------------------------------------------------===//
467 // TemplateArgumentLoc Implementation
468 //===----------------------------------------------------------------------===//
470 SourceRange TemplateArgumentLoc::getSourceRange() const {
471 switch (Argument.getKind()) {
472 case TemplateArgument::Expression:
473 return getSourceExpression()->getSourceRange();
475 case TemplateArgument::Declaration:
476 return getSourceDeclExpression()->getSourceRange();
478 case TemplateArgument::NullPtr:
479 return getSourceNullPtrExpression()->getSourceRange();
481 case TemplateArgument::Type:
482 if (TypeSourceInfo *TSI = getTypeSourceInfo())
483 return TSI->getTypeLoc().getSourceRange();
485 return SourceRange();
487 case TemplateArgument::Template:
488 if (getTemplateQualifierLoc())
489 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
490 getTemplateNameLoc());
491 return SourceRange(getTemplateNameLoc());
493 case TemplateArgument::TemplateExpansion:
494 if (getTemplateQualifierLoc())
495 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
496 getTemplateEllipsisLoc());
497 return SourceRange(getTemplateNameLoc(), getTemplateEllipsisLoc());
499 case TemplateArgument::Integral:
500 return getSourceIntegralExpression()->getSourceRange();
502 case TemplateArgument::Pack:
503 case TemplateArgument::Null:
504 return SourceRange();
507 llvm_unreachable("Invalid TemplateArgument Kind!");
510 const DiagnosticBuilder &clang::operator<<(const DiagnosticBuilder &DB,
511 const TemplateArgument &Arg) {
512 switch (Arg.getKind()) {
513 case TemplateArgument::Null:
514 // This is bad, but not as bad as crashing because of argument
516 return DB << "(null template argument)";
518 case TemplateArgument::Type:
519 return DB << Arg.getAsType();
521 case TemplateArgument::Declaration:
522 return DB << Arg.getAsDecl();
524 case TemplateArgument::NullPtr:
525 return DB << "nullptr";
527 case TemplateArgument::Integral:
528 return DB << Arg.getAsIntegral().toString(10);
530 case TemplateArgument::Template:
531 return DB << Arg.getAsTemplate();
533 case TemplateArgument::TemplateExpansion:
534 return DB << Arg.getAsTemplateOrTemplatePattern() << "...";
536 case TemplateArgument::Expression: {
537 // This shouldn't actually ever happen, so it's okay that we're
538 // regurgitating an expression here.
539 // FIXME: We're guessing at LangOptions!
541 llvm::raw_svector_ostream OS(Str);
542 LangOptions LangOpts;
543 LangOpts.CPlusPlus = true;
544 PrintingPolicy Policy(LangOpts);
545 Arg.getAsExpr()->printPretty(OS, nullptr, Policy);
546 return DB << OS.str();
549 case TemplateArgument::Pack: {
550 // FIXME: We're guessing at LangOptions!
552 llvm::raw_svector_ostream OS(Str);
553 LangOptions LangOpts;
554 LangOpts.CPlusPlus = true;
555 PrintingPolicy Policy(LangOpts);
556 Arg.print(Policy, OS);
557 return DB << OS.str();
561 llvm_unreachable("Invalid TemplateArgument Kind!");
564 const ASTTemplateArgumentListInfo *
565 ASTTemplateArgumentListInfo::Create(ASTContext &C,
566 const TemplateArgumentListInfo &List) {
567 std::size_t size = totalSizeToAlloc<TemplateArgumentLoc>(List.size());
568 void *Mem = C.Allocate(size, alignof(ASTTemplateArgumentListInfo));
569 return new (Mem) ASTTemplateArgumentListInfo(List);
572 ASTTemplateArgumentListInfo::ASTTemplateArgumentListInfo(
573 const TemplateArgumentListInfo &Info) {
574 LAngleLoc = Info.getLAngleLoc();
575 RAngleLoc = Info.getRAngleLoc();
576 NumTemplateArgs = Info.size();
578 TemplateArgumentLoc *ArgBuffer = getTrailingObjects<TemplateArgumentLoc>();
579 for (unsigned i = 0; i != NumTemplateArgs; ++i)
580 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
583 void ASTTemplateKWAndArgsInfo::initializeFrom(
584 SourceLocation TemplateKWLoc, const TemplateArgumentListInfo &Info,
585 TemplateArgumentLoc *OutArgArray) {
586 this->TemplateKWLoc = TemplateKWLoc;
587 LAngleLoc = Info.getLAngleLoc();
588 RAngleLoc = Info.getRAngleLoc();
589 NumTemplateArgs = Info.size();
591 for (unsigned i = 0; i != NumTemplateArgs; ++i)
592 new (&OutArgArray[i]) TemplateArgumentLoc(Info[i]);
595 void ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc) {
596 assert(TemplateKWLoc.isValid());
597 LAngleLoc = SourceLocation();
598 RAngleLoc = SourceLocation();
599 this->TemplateKWLoc = TemplateKWLoc;
603 void ASTTemplateKWAndArgsInfo::initializeFrom(
604 SourceLocation TemplateKWLoc, const TemplateArgumentListInfo &Info,
605 TemplateArgumentLoc *OutArgArray, bool &Dependent,
606 bool &InstantiationDependent, bool &ContainsUnexpandedParameterPack) {
607 this->TemplateKWLoc = TemplateKWLoc;
608 LAngleLoc = Info.getLAngleLoc();
609 RAngleLoc = Info.getRAngleLoc();
610 NumTemplateArgs = Info.size();
612 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
613 Dependent = Dependent || Info[i].getArgument().isDependent();
614 InstantiationDependent = InstantiationDependent ||
615 Info[i].getArgument().isInstantiationDependent();
616 ContainsUnexpandedParameterPack =
617 ContainsUnexpandedParameterPack ||
618 Info[i].getArgument().containsUnexpandedParameterPack();
620 new (&OutArgArray[i]) TemplateArgumentLoc(Info[i]);
624 void ASTTemplateKWAndArgsInfo::copyInto(const TemplateArgumentLoc *ArgArray,
625 TemplateArgumentListInfo &Info) const {
626 Info.setLAngleLoc(LAngleLoc);
627 Info.setRAngleLoc(RAngleLoc);
628 for (unsigned I = 0; I != NumTemplateArgs; ++I)
629 Info.addArgument(ArgArray[I]);