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.
36 static void printIntegral(const TemplateArgument &TemplArg,
38 const ::clang::Type *T = TemplArg.getIntegralType().getTypePtr();
39 const llvm::APSInt &Val = TemplArg.getAsIntegral();
41 if (T->isBooleanType()) {
42 Out << (Val.getBoolValue() ? "true" : "false");
43 } else if (T->isCharType()) {
44 const char Ch = Val.getZExtValue();
45 Out << ((Ch == '\'') ? "'\\" : "'");
46 Out.write_escaped(StringRef(&Ch, 1), /*UseHexEscapes=*/ true);
53 //===----------------------------------------------------------------------===//
54 // TemplateArgument Implementation
55 //===----------------------------------------------------------------------===//
57 TemplateArgument::TemplateArgument(ASTContext &Ctx, const llvm::APSInt &Value,
60 // Copy the APSInt value into our decomposed form.
61 Integer.BitWidth = Value.getBitWidth();
62 Integer.IsUnsigned = Value.isUnsigned();
63 // If the value is large, we have to get additional memory from the ASTContext
64 unsigned NumWords = Value.getNumWords();
66 void *Mem = Ctx.Allocate(NumWords * sizeof(uint64_t));
67 std::memcpy(Mem, Value.getRawData(), NumWords * sizeof(uint64_t));
68 Integer.pVal = static_cast<uint64_t *>(Mem);
70 Integer.VAL = Value.getZExtValue();
73 Integer.Type = Type.getAsOpaquePtr();
76 TemplateArgument TemplateArgument::CreatePackCopy(ASTContext &Context,
77 const TemplateArgument *Args,
80 return getEmptyPack();
82 TemplateArgument *Storage = new (Context) TemplateArgument [NumArgs];
83 std::copy(Args, Args + NumArgs, Storage);
84 return TemplateArgument(Storage, NumArgs);
87 bool TemplateArgument::isDependent() const {
90 llvm_unreachable("Should not have a NULL template argument");
93 return getAsType()->isDependentType();
96 return getAsTemplate().isDependent();
98 case TemplateExpansion:
102 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
103 return DC->isDependentContext();
104 return getAsDecl()->getDeclContext()->isDependentContext();
114 return (getAsExpr()->isTypeDependent() || getAsExpr()->isValueDependent());
117 for (pack_iterator P = pack_begin(), PEnd = pack_end(); P != PEnd; ++P) {
118 if (P->isDependent())
125 llvm_unreachable("Invalid TemplateArgument Kind!");
128 bool TemplateArgument::isInstantiationDependent() const {
131 llvm_unreachable("Should not have a NULL template argument");
134 return getAsType()->isInstantiationDependentType();
137 return getAsTemplate().isInstantiationDependent();
139 case TemplateExpansion:
143 if (DeclContext *DC = dyn_cast<DeclContext>(getAsDecl()))
144 return DC->isDependentContext();
145 return getAsDecl()->getDeclContext()->isDependentContext();
155 return getAsExpr()->isInstantiationDependent();
158 for (pack_iterator P = pack_begin(), PEnd = pack_end(); P != PEnd; ++P) {
159 if (P->isInstantiationDependent())
166 llvm_unreachable("Invalid TemplateArgument Kind!");
169 bool TemplateArgument::isPackExpansion() const {
179 case TemplateExpansion:
183 return isa<PackExpansionType>(getAsType());
186 return isa<PackExpansionExpr>(getAsExpr());
189 llvm_unreachable("Invalid TemplateArgument Kind!");
192 bool TemplateArgument::containsUnexpandedParameterPack() const {
197 case TemplateExpansion:
202 if (getAsType()->containsUnexpandedParameterPack())
207 if (getAsTemplate().containsUnexpandedParameterPack())
212 if (getAsExpr()->containsUnexpandedParameterPack())
217 for (pack_iterator P = pack_begin(), PEnd = pack_end(); P != PEnd; ++P)
218 if (P->containsUnexpandedParameterPack())
227 Optional<unsigned> TemplateArgument::getNumTemplateExpansions() const {
228 assert(Kind == TemplateExpansion);
229 if (TemplateArg.NumExpansions)
230 return TemplateArg.NumExpansions - 1;
235 void TemplateArgument::Profile(llvm::FoldingSetNodeID &ID,
236 const ASTContext &Context) const {
243 getAsType().Profile(ID);
247 ID.AddPointer(getAsDecl()? getAsDecl()->getCanonicalDecl() : 0);
251 case TemplateExpansion: {
252 TemplateName Template = getAsTemplateOrTemplatePattern();
253 if (TemplateTemplateParmDecl *TTP
254 = dyn_cast_or_null<TemplateTemplateParmDecl>(
255 Template.getAsTemplateDecl())) {
257 ID.AddInteger(TTP->getDepth());
258 ID.AddInteger(TTP->getPosition());
259 ID.AddBoolean(TTP->isParameterPack());
261 ID.AddBoolean(false);
262 ID.AddPointer(Context.getCanonicalTemplateName(Template)
263 .getAsVoidPointer());
269 getAsIntegral().Profile(ID);
270 getIntegralType().Profile(ID);
274 getAsExpr()->Profile(ID, Context, true);
278 ID.AddInteger(Args.NumArgs);
279 for (unsigned I = 0; I != Args.NumArgs; ++I)
280 Args.Args[I].Profile(ID, Context);
284 bool TemplateArgument::structurallyEquals(const TemplateArgument &Other) const {
285 if (getKind() != Other.getKind()) return false;
292 case TemplateExpansion:
294 return TypeOrValue == Other.TypeOrValue;
297 return getAsDecl() == Other.getAsDecl() &&
298 isDeclForReferenceParam() && Other.isDeclForReferenceParam();
301 return getIntegralType() == Other.getIntegralType() &&
302 getAsIntegral() == Other.getAsIntegral();
305 if (Args.NumArgs != Other.Args.NumArgs) return false;
306 for (unsigned I = 0, E = Args.NumArgs; I != E; ++I)
307 if (!Args.Args[I].structurallyEquals(Other.Args.Args[I]))
312 llvm_unreachable("Invalid TemplateArgument Kind!");
315 TemplateArgument TemplateArgument::getPackExpansionPattern() const {
316 assert(isPackExpansion());
320 return getAsType()->getAs<PackExpansionType>()->getPattern();
323 return cast<PackExpansionExpr>(getAsExpr())->getPattern();
325 case TemplateExpansion:
326 return TemplateArgument(getAsTemplateOrTemplatePattern());
334 return TemplateArgument();
337 llvm_unreachable("Invalid TemplateArgument Kind!");
340 void TemplateArgument::print(const PrintingPolicy &Policy,
341 raw_ostream &Out) const {
348 PrintingPolicy SubPolicy(Policy);
349 SubPolicy.SuppressStrongLifetime = true;
350 getAsType().print(Out, SubPolicy);
355 NamedDecl *ND = cast<NamedDecl>(getAsDecl());
356 if (ND->getDeclName()) {
357 // FIXME: distinguish between pointer and reference args?
360 Out << "<anonymous>";
370 getAsTemplate().print(Out, Policy);
373 case TemplateExpansion:
374 getAsTemplateOrTemplatePattern().print(Out, Policy);
379 printIntegral(*this, Out);
384 getAsExpr()->printPretty(Out, 0, Policy);
390 for (TemplateArgument::pack_iterator P = pack_begin(), PEnd = pack_end();
397 P->print(Policy, Out);
404 //===----------------------------------------------------------------------===//
405 // TemplateArgumentLoc Implementation
406 //===----------------------------------------------------------------------===//
408 TemplateArgumentLocInfo::TemplateArgumentLocInfo() {
409 memset((void*)this, 0, sizeof(TemplateArgumentLocInfo));
412 SourceRange TemplateArgumentLoc::getSourceRange() const {
413 switch (Argument.getKind()) {
414 case TemplateArgument::Expression:
415 return getSourceExpression()->getSourceRange();
417 case TemplateArgument::Declaration:
418 return getSourceDeclExpression()->getSourceRange();
420 case TemplateArgument::NullPtr:
421 return getSourceNullPtrExpression()->getSourceRange();
423 case TemplateArgument::Type:
424 if (TypeSourceInfo *TSI = getTypeSourceInfo())
425 return TSI->getTypeLoc().getSourceRange();
427 return SourceRange();
429 case TemplateArgument::Template:
430 if (getTemplateQualifierLoc())
431 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
432 getTemplateNameLoc());
433 return SourceRange(getTemplateNameLoc());
435 case TemplateArgument::TemplateExpansion:
436 if (getTemplateQualifierLoc())
437 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
438 getTemplateEllipsisLoc());
439 return SourceRange(getTemplateNameLoc(), getTemplateEllipsisLoc());
441 case TemplateArgument::Integral:
442 return getSourceIntegralExpression()->getSourceRange();
444 case TemplateArgument::Pack:
445 case TemplateArgument::Null:
446 return SourceRange();
449 llvm_unreachable("Invalid TemplateArgument Kind!");
452 TemplateArgumentLoc TemplateArgumentLoc::getPackExpansionPattern(
453 SourceLocation &Ellipsis, Optional<unsigned> &NumExpansions,
454 ASTContext &Context) const {
455 assert(Argument.isPackExpansion());
457 switch (Argument.getKind()) {
458 case TemplateArgument::Type: {
459 // FIXME: We shouldn't ever have to worry about missing
461 TypeSourceInfo *ExpansionTSInfo = getTypeSourceInfo();
462 if (!ExpansionTSInfo)
463 ExpansionTSInfo = Context.getTrivialTypeSourceInfo(
464 getArgument().getAsType(),
466 PackExpansionTypeLoc Expansion =
467 ExpansionTSInfo->getTypeLoc().castAs<PackExpansionTypeLoc>();
468 Ellipsis = Expansion.getEllipsisLoc();
470 TypeLoc Pattern = Expansion.getPatternLoc();
471 NumExpansions = Expansion.getTypePtr()->getNumExpansions();
473 // FIXME: This is horrible. We know where the source location data is for
474 // the pattern, and we have the pattern's type, but we are forced to copy
475 // them into an ASTContext because TypeSourceInfo bundles them together
476 // and TemplateArgumentLoc traffics in TypeSourceInfo pointers.
477 TypeSourceInfo *PatternTSInfo
478 = Context.CreateTypeSourceInfo(Pattern.getType(),
479 Pattern.getFullDataSize());
480 memcpy(PatternTSInfo->getTypeLoc().getOpaqueData(),
481 Pattern.getOpaqueData(), Pattern.getFullDataSize());
482 return TemplateArgumentLoc(TemplateArgument(Pattern.getType()),
486 case TemplateArgument::Expression: {
487 PackExpansionExpr *Expansion
488 = cast<PackExpansionExpr>(Argument.getAsExpr());
489 Expr *Pattern = Expansion->getPattern();
490 Ellipsis = Expansion->getEllipsisLoc();
491 NumExpansions = Expansion->getNumExpansions();
492 return TemplateArgumentLoc(Pattern, Pattern);
495 case TemplateArgument::TemplateExpansion:
496 Ellipsis = getTemplateEllipsisLoc();
497 NumExpansions = Argument.getNumTemplateExpansions();
498 return TemplateArgumentLoc(Argument.getPackExpansionPattern(),
499 getTemplateQualifierLoc(),
500 getTemplateNameLoc());
502 case TemplateArgument::Declaration:
503 case TemplateArgument::NullPtr:
504 case TemplateArgument::Template:
505 case TemplateArgument::Integral:
506 case TemplateArgument::Pack:
507 case TemplateArgument::Null:
508 return TemplateArgumentLoc();
511 llvm_unreachable("Invalid TemplateArgument Kind!");
514 const DiagnosticBuilder &clang::operator<<(const DiagnosticBuilder &DB,
515 const TemplateArgument &Arg) {
516 switch (Arg.getKind()) {
517 case TemplateArgument::Null:
518 // This is bad, but not as bad as crashing because of argument
520 return DB << "(null template argument)";
522 case TemplateArgument::Type:
523 return DB << Arg.getAsType();
525 case TemplateArgument::Declaration:
526 return DB << Arg.getAsDecl();
528 case TemplateArgument::NullPtr:
529 return DB << "nullptr";
531 case TemplateArgument::Integral:
532 return DB << Arg.getAsIntegral().toString(10);
534 case TemplateArgument::Template:
535 return DB << Arg.getAsTemplate();
537 case TemplateArgument::TemplateExpansion:
538 return DB << Arg.getAsTemplateOrTemplatePattern() << "...";
540 case TemplateArgument::Expression: {
541 // This shouldn't actually ever happen, so it's okay that we're
542 // regurgitating an expression here.
543 // FIXME: We're guessing at LangOptions!
545 llvm::raw_svector_ostream OS(Str);
546 LangOptions LangOpts;
547 LangOpts.CPlusPlus = true;
548 PrintingPolicy Policy(LangOpts);
549 Arg.getAsExpr()->printPretty(OS, 0, Policy);
550 return DB << OS.str();
553 case TemplateArgument::Pack: {
554 // FIXME: We're guessing at LangOptions!
556 llvm::raw_svector_ostream OS(Str);
557 LangOptions LangOpts;
558 LangOpts.CPlusPlus = true;
559 PrintingPolicy Policy(LangOpts);
560 Arg.print(Policy, OS);
561 return DB << OS.str();
565 llvm_unreachable("Invalid TemplateArgument Kind!");
568 const ASTTemplateArgumentListInfo *
569 ASTTemplateArgumentListInfo::Create(ASTContext &C,
570 const TemplateArgumentListInfo &List) {
571 std::size_t size = ASTTemplateArgumentListInfo::sizeFor(List.size());
572 void *Mem = C.Allocate(size, llvm::alignOf<ASTTemplateArgumentListInfo>());
573 ASTTemplateArgumentListInfo *TAI = new (Mem) ASTTemplateArgumentListInfo();
574 TAI->initializeFrom(List);
578 void ASTTemplateArgumentListInfo::initializeFrom(
579 const TemplateArgumentListInfo &Info) {
580 LAngleLoc = Info.getLAngleLoc();
581 RAngleLoc = Info.getRAngleLoc();
582 NumTemplateArgs = Info.size();
584 TemplateArgumentLoc *ArgBuffer = getTemplateArgs();
585 for (unsigned i = 0; i != NumTemplateArgs; ++i)
586 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
589 void ASTTemplateArgumentListInfo::initializeFrom(
590 const TemplateArgumentListInfo &Info,
592 bool &InstantiationDependent,
593 bool &ContainsUnexpandedParameterPack) {
594 LAngleLoc = Info.getLAngleLoc();
595 RAngleLoc = Info.getRAngleLoc();
596 NumTemplateArgs = Info.size();
598 TemplateArgumentLoc *ArgBuffer = getTemplateArgs();
599 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
600 Dependent = Dependent || Info[i].getArgument().isDependent();
601 InstantiationDependent = InstantiationDependent ||
602 Info[i].getArgument().isInstantiationDependent();
603 ContainsUnexpandedParameterPack
604 = ContainsUnexpandedParameterPack ||
605 Info[i].getArgument().containsUnexpandedParameterPack();
607 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
611 void ASTTemplateArgumentListInfo::copyInto(
612 TemplateArgumentListInfo &Info) const {
613 Info.setLAngleLoc(LAngleLoc);
614 Info.setRAngleLoc(RAngleLoc);
615 for (unsigned I = 0; I != NumTemplateArgs; ++I)
616 Info.addArgument(getTemplateArgs()[I]);
619 std::size_t ASTTemplateArgumentListInfo::sizeFor(unsigned NumTemplateArgs) {
620 return sizeof(ASTTemplateArgumentListInfo) +
621 sizeof(TemplateArgumentLoc) * NumTemplateArgs;
625 ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc,
626 const TemplateArgumentListInfo &Info) {
627 Base::initializeFrom(Info);
628 setTemplateKeywordLoc(TemplateKWLoc);
632 ASTTemplateKWAndArgsInfo
633 ::initializeFrom(SourceLocation TemplateKWLoc,
634 const TemplateArgumentListInfo &Info,
636 bool &InstantiationDependent,
637 bool &ContainsUnexpandedParameterPack) {
638 Base::initializeFrom(Info, Dependent, InstantiationDependent,
639 ContainsUnexpandedParameterPack);
640 setTemplateKeywordLoc(TemplateKWLoc);
644 ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc) {
645 // No explicit template arguments, but template keyword loc is valid.
646 assert(TemplateKWLoc.isValid());
647 LAngleLoc = SourceLocation();
648 RAngleLoc = SourceLocation();
650 setTemplateKeywordLoc(TemplateKWLoc);
654 ASTTemplateKWAndArgsInfo::sizeFor(unsigned NumTemplateArgs) {
655 // Add space for the template keyword location.
656 // FIXME: There's room for this in the padding before the template args in
658 return Base::sizeFor(NumTemplateArgs) + sizeof(SourceLocation);