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,
59 Integer.Kind = Integral;
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(getKind() == TemplateExpansion);
229 if (TemplateArg.NumExpansions)
230 return TemplateArg.NumExpansions - 1;
235 void TemplateArgument::Profile(llvm::FoldingSetNodeID &ID,
236 const ASTContext &Context) const {
237 ID.AddInteger(getKind());
243 getAsType().Profile(ID);
247 getNullPtrType().Profile(ID);
251 ID.AddPointer(getAsDecl()? getAsDecl()->getCanonicalDecl() : 0);
255 case TemplateExpansion: {
256 TemplateName Template = getAsTemplateOrTemplatePattern();
257 if (TemplateTemplateParmDecl *TTP
258 = dyn_cast_or_null<TemplateTemplateParmDecl>(
259 Template.getAsTemplateDecl())) {
261 ID.AddInteger(TTP->getDepth());
262 ID.AddInteger(TTP->getPosition());
263 ID.AddBoolean(TTP->isParameterPack());
265 ID.AddBoolean(false);
266 ID.AddPointer(Context.getCanonicalTemplateName(Template)
267 .getAsVoidPointer());
273 getAsIntegral().Profile(ID);
274 getIntegralType().Profile(ID);
278 getAsExpr()->Profile(ID, Context, true);
282 ID.AddInteger(Args.NumArgs);
283 for (unsigned I = 0; I != Args.NumArgs; ++I)
284 Args.Args[I].Profile(ID, Context);
288 bool TemplateArgument::structurallyEquals(const TemplateArgument &Other) const {
289 if (getKind() != Other.getKind()) return false;
296 case TemplateExpansion:
298 return TypeOrValue.V == Other.TypeOrValue.V;
301 return getAsDecl() == Other.getAsDecl() &&
302 isDeclForReferenceParam() && Other.isDeclForReferenceParam();
305 return getIntegralType() == Other.getIntegralType() &&
306 getAsIntegral() == Other.getAsIntegral();
309 if (Args.NumArgs != Other.Args.NumArgs) return false;
310 for (unsigned I = 0, E = Args.NumArgs; I != E; ++I)
311 if (!Args.Args[I].structurallyEquals(Other.Args.Args[I]))
316 llvm_unreachable("Invalid TemplateArgument Kind!");
319 TemplateArgument TemplateArgument::getPackExpansionPattern() const {
320 assert(isPackExpansion());
324 return getAsType()->getAs<PackExpansionType>()->getPattern();
327 return cast<PackExpansionExpr>(getAsExpr())->getPattern();
329 case TemplateExpansion:
330 return TemplateArgument(getAsTemplateOrTemplatePattern());
338 return TemplateArgument();
341 llvm_unreachable("Invalid TemplateArgument Kind!");
344 void TemplateArgument::print(const PrintingPolicy &Policy,
345 raw_ostream &Out) const {
352 PrintingPolicy SubPolicy(Policy);
353 SubPolicy.SuppressStrongLifetime = true;
354 getAsType().print(Out, SubPolicy);
359 NamedDecl *ND = cast<NamedDecl>(getAsDecl());
361 if (ND->getDeclName()) {
362 // FIXME: distinguish between pointer and reference args?
363 ND->printQualifiedName(Out);
365 Out << "<anonymous>";
375 getAsTemplate().print(Out, Policy);
378 case TemplateExpansion:
379 getAsTemplateOrTemplatePattern().print(Out, Policy);
384 printIntegral(*this, Out);
389 getAsExpr()->printPretty(Out, 0, Policy);
395 for (TemplateArgument::pack_iterator P = pack_begin(), PEnd = pack_end();
402 P->print(Policy, Out);
409 //===----------------------------------------------------------------------===//
410 // TemplateArgumentLoc Implementation
411 //===----------------------------------------------------------------------===//
413 TemplateArgumentLocInfo::TemplateArgumentLocInfo() {
414 memset((void*)this, 0, sizeof(TemplateArgumentLocInfo));
417 SourceRange TemplateArgumentLoc::getSourceRange() const {
418 switch (Argument.getKind()) {
419 case TemplateArgument::Expression:
420 return getSourceExpression()->getSourceRange();
422 case TemplateArgument::Declaration:
423 return getSourceDeclExpression()->getSourceRange();
425 case TemplateArgument::NullPtr:
426 return getSourceNullPtrExpression()->getSourceRange();
428 case TemplateArgument::Type:
429 if (TypeSourceInfo *TSI = getTypeSourceInfo())
430 return TSI->getTypeLoc().getSourceRange();
432 return SourceRange();
434 case TemplateArgument::Template:
435 if (getTemplateQualifierLoc())
436 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
437 getTemplateNameLoc());
438 return SourceRange(getTemplateNameLoc());
440 case TemplateArgument::TemplateExpansion:
441 if (getTemplateQualifierLoc())
442 return SourceRange(getTemplateQualifierLoc().getBeginLoc(),
443 getTemplateEllipsisLoc());
444 return SourceRange(getTemplateNameLoc(), getTemplateEllipsisLoc());
446 case TemplateArgument::Integral:
447 return getSourceIntegralExpression()->getSourceRange();
449 case TemplateArgument::Pack:
450 case TemplateArgument::Null:
451 return SourceRange();
454 llvm_unreachable("Invalid TemplateArgument Kind!");
457 const DiagnosticBuilder &clang::operator<<(const DiagnosticBuilder &DB,
458 const TemplateArgument &Arg) {
459 switch (Arg.getKind()) {
460 case TemplateArgument::Null:
461 // This is bad, but not as bad as crashing because of argument
463 return DB << "(null template argument)";
465 case TemplateArgument::Type:
466 return DB << Arg.getAsType();
468 case TemplateArgument::Declaration:
469 return DB << Arg.getAsDecl();
471 case TemplateArgument::NullPtr:
472 return DB << "nullptr";
474 case TemplateArgument::Integral:
475 return DB << Arg.getAsIntegral().toString(10);
477 case TemplateArgument::Template:
478 return DB << Arg.getAsTemplate();
480 case TemplateArgument::TemplateExpansion:
481 return DB << Arg.getAsTemplateOrTemplatePattern() << "...";
483 case TemplateArgument::Expression: {
484 // This shouldn't actually ever happen, so it's okay that we're
485 // regurgitating an expression here.
486 // FIXME: We're guessing at LangOptions!
488 llvm::raw_svector_ostream OS(Str);
489 LangOptions LangOpts;
490 LangOpts.CPlusPlus = true;
491 PrintingPolicy Policy(LangOpts);
492 Arg.getAsExpr()->printPretty(OS, 0, Policy);
493 return DB << OS.str();
496 case TemplateArgument::Pack: {
497 // FIXME: We're guessing at LangOptions!
499 llvm::raw_svector_ostream OS(Str);
500 LangOptions LangOpts;
501 LangOpts.CPlusPlus = true;
502 PrintingPolicy Policy(LangOpts);
503 Arg.print(Policy, OS);
504 return DB << OS.str();
508 llvm_unreachable("Invalid TemplateArgument Kind!");
511 const ASTTemplateArgumentListInfo *
512 ASTTemplateArgumentListInfo::Create(ASTContext &C,
513 const TemplateArgumentListInfo &List) {
514 std::size_t size = ASTTemplateArgumentListInfo::sizeFor(List.size());
515 void *Mem = C.Allocate(size, llvm::alignOf<ASTTemplateArgumentListInfo>());
516 ASTTemplateArgumentListInfo *TAI = new (Mem) ASTTemplateArgumentListInfo();
517 TAI->initializeFrom(List);
521 void ASTTemplateArgumentListInfo::initializeFrom(
522 const TemplateArgumentListInfo &Info) {
523 LAngleLoc = Info.getLAngleLoc();
524 RAngleLoc = Info.getRAngleLoc();
525 NumTemplateArgs = Info.size();
527 TemplateArgumentLoc *ArgBuffer = getTemplateArgs();
528 for (unsigned i = 0; i != NumTemplateArgs; ++i)
529 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
532 void ASTTemplateArgumentListInfo::initializeFrom(
533 const TemplateArgumentListInfo &Info,
535 bool &InstantiationDependent,
536 bool &ContainsUnexpandedParameterPack) {
537 LAngleLoc = Info.getLAngleLoc();
538 RAngleLoc = Info.getRAngleLoc();
539 NumTemplateArgs = Info.size();
541 TemplateArgumentLoc *ArgBuffer = getTemplateArgs();
542 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
543 Dependent = Dependent || Info[i].getArgument().isDependent();
544 InstantiationDependent = InstantiationDependent ||
545 Info[i].getArgument().isInstantiationDependent();
546 ContainsUnexpandedParameterPack
547 = ContainsUnexpandedParameterPack ||
548 Info[i].getArgument().containsUnexpandedParameterPack();
550 new (&ArgBuffer[i]) TemplateArgumentLoc(Info[i]);
554 void ASTTemplateArgumentListInfo::copyInto(
555 TemplateArgumentListInfo &Info) const {
556 Info.setLAngleLoc(LAngleLoc);
557 Info.setRAngleLoc(RAngleLoc);
558 for (unsigned I = 0; I != NumTemplateArgs; ++I)
559 Info.addArgument(getTemplateArgs()[I]);
562 std::size_t ASTTemplateArgumentListInfo::sizeFor(unsigned NumTemplateArgs) {
563 return sizeof(ASTTemplateArgumentListInfo) +
564 sizeof(TemplateArgumentLoc) * NumTemplateArgs;
568 ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc,
569 const TemplateArgumentListInfo &Info) {
570 Base::initializeFrom(Info);
571 setTemplateKeywordLoc(TemplateKWLoc);
575 ASTTemplateKWAndArgsInfo
576 ::initializeFrom(SourceLocation TemplateKWLoc,
577 const TemplateArgumentListInfo &Info,
579 bool &InstantiationDependent,
580 bool &ContainsUnexpandedParameterPack) {
581 Base::initializeFrom(Info, Dependent, InstantiationDependent,
582 ContainsUnexpandedParameterPack);
583 setTemplateKeywordLoc(TemplateKWLoc);
587 ASTTemplateKWAndArgsInfo::initializeFrom(SourceLocation TemplateKWLoc) {
588 // No explicit template arguments, but template keyword loc is valid.
589 assert(TemplateKWLoc.isValid());
590 LAngleLoc = SourceLocation();
591 RAngleLoc = SourceLocation();
593 setTemplateKeywordLoc(TemplateKWLoc);
597 ASTTemplateKWAndArgsInfo::sizeFor(unsigned NumTemplateArgs) {
598 // Add space for the template keyword location.
599 // FIXME: There's room for this in the padding before the template args in
601 return Base::sizeFor(NumTemplateArgs) + sizeof(SourceLocation);