contrib/llvm/tools/clang/lib/Parse/ParseTemplate.cpp

   1 //===--- ParseTemplate.cpp - Template Parsing -----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file implements parsing of C++ templates.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "clang/AST/ASTContext.h"
  15 #include "clang/AST/DeclTemplate.h"
  16 #include "clang/Parse/ParseDiagnostic.h"
  17 #include "clang/Parse/Parser.h"
  18 #include "clang/Parse/RAIIObjectsForParser.h"
  19 #include "clang/Sema/DeclSpec.h"
  20 #include "clang/Sema/ParsedTemplate.h"
  21 #include "clang/Sema/Scope.h"
  22 using namespace clang;
  23
  24 /// \brief Parse a template declaration, explicit instantiation, or
  25 /// explicit specialization.
  26 Decl *
  27 Parser::ParseDeclarationStartingWithTemplate(unsigned Context,
  28                                              SourceLocation &DeclEnd,
  29                                              AccessSpecifier AS,
  30                                              AttributeList *AccessAttrs) {
  31   ObjCDeclContextSwitch ObjCDC(*this);
  32
  33   if (Tok.is(tok::kw_template) && NextToken().isNot(tok::less)) {
  34     return ParseExplicitInstantiation(Context,
  35                                       SourceLocation(), ConsumeToken(),
  36                                       DeclEnd, AS);
  37   }
  38   return ParseTemplateDeclarationOrSpecialization(Context, DeclEnd, AS,
  39                                                   AccessAttrs);
  40 }
  41
  42
  43
  44 /// \brief Parse a template declaration or an explicit specialization.
  45 ///
  46 /// Template declarations include one or more template parameter lists
  47 /// and either the function or class template declaration. Explicit
  48 /// specializations contain one or more 'template < >' prefixes
  49 /// followed by a (possibly templated) declaration. Since the
  50 /// syntactic form of both features is nearly identical, we parse all
  51 /// of the template headers together and let semantic analysis sort
  52 /// the declarations from the explicit specializations.
  53 ///
  54 ///       template-declaration: [C++ temp]
  55 ///         'export'[opt] 'template' '<' template-parameter-list '>' declaration
  56 ///
  57 ///       explicit-specialization: [ C++ temp.expl.spec]
  58 ///         'template' '<' '>' declaration
  59 Decl *
  60 Parser::ParseTemplateDeclarationOrSpecialization(unsigned Context,
  61                                                  SourceLocation &DeclEnd,
  62                                                  AccessSpecifier AS,
  63                                                  AttributeList *AccessAttrs) {
  64   assert(Tok.isOneOf(tok::kw_export, tok::kw_template) &&
  65          "Token does not start a template declaration.");
  66
  67   // Enter template-parameter scope.
  68   ParseScope TemplateParmScope(this, Scope::TemplateParamScope);
  69
  70   // Tell the action that names should be checked in the context of
  71   // the declaration to come.
  72   ParsingDeclRAIIObject
  73     ParsingTemplateParams(*this, ParsingDeclRAIIObject::NoParent);
  74
  75   // Parse multiple levels of template headers within this template
  76   // parameter scope, e.g.,
  77   //
  78   //   template<typename T>
  79   //     template<typename U>
  80   //       class A<T>::B { ... };
  81   //
  82   // We parse multiple levels non-recursively so that we can build a
  83   // single data structure containing all of the template parameter
  84   // lists to easily differentiate between the case above and:
  85   //
  86   //   template<typename T>
  87   //   class A {
  88   //     template<typename U> class B;
  89   //   };
  90   //
  91   // In the first case, the action for declaring A<T>::B receives
  92   // both template parameter lists. In the second case, the action for
  93   // defining A<T>::B receives just the inner template parameter list
  94   // (and retrieves the outer template parameter list from its
  95   // context).
  96   bool isSpecialization = true;
  97   bool LastParamListWasEmpty = false;
  98   TemplateParameterLists ParamLists;
  99   TemplateParameterDepthRAII CurTemplateDepthTracker(TemplateParameterDepth);
 100
 101   do {
 102     // Consume the 'export', if any.
 103     SourceLocation ExportLoc;
 104     TryConsumeToken(tok::kw_export, ExportLoc);
 105
 106     // Consume the 'template', which should be here.
 107     SourceLocation TemplateLoc;
 108     if (!TryConsumeToken(tok::kw_template, TemplateLoc)) {
 109       Diag(Tok.getLocation(), diag::err_expected_template);
 110       return nullptr;
 111     }
 112
 113     // Parse the '<' template-parameter-list '>'
 114     SourceLocation LAngleLoc, RAngleLoc;
 115     SmallVector<Decl*, 4> TemplateParams;
 116     if (ParseTemplateParameters(CurTemplateDepthTracker.getDepth(),
 117                                 TemplateParams, LAngleLoc, RAngleLoc)) {
 118       // Skip until the semi-colon or a '}'.
 119       SkipUntil(tok::r_brace, StopAtSemi | StopBeforeMatch);
 120       TryConsumeToken(tok::semi);
 121       return nullptr;
 122     }
 123
 124     ExprResult OptionalRequiresClauseConstraintER;
 125     if (!TemplateParams.empty()) {
 126       isSpecialization = false;
 127       ++CurTemplateDepthTracker;
 128
 129       if (TryConsumeToken(tok::kw_requires)) {
 130         OptionalRequiresClauseConstraintER =
 131             Actions.CorrectDelayedTyposInExpr(ParseConstraintExpression());
 132         if (!OptionalRequiresClauseConstraintER.isUsable()) {
 133           // Skip until the semi-colon or a '}'.
 134           SkipUntil(tok::r_brace, StopAtSemi | StopBeforeMatch);
 135           TryConsumeToken(tok::semi);
 136           return nullptr;
 137         }
 138       }
 139     } else {
 140       LastParamListWasEmpty = true;
 141     }
 142
 143     ParamLists.push_back(Actions.ActOnTemplateParameterList(
 144         CurTemplateDepthTracker.getDepth(), ExportLoc, TemplateLoc, LAngleLoc,
 145         TemplateParams, RAngleLoc, OptionalRequiresClauseConstraintER.get()));
 146   } while (Tok.isOneOf(tok::kw_export, tok::kw_template));
 147
 148   unsigned NewFlags = getCurScope()->getFlags() & ~Scope::TemplateParamScope;
 149   ParseScopeFlags TemplateScopeFlags(this, NewFlags, isSpecialization);
 150
 151   // Parse the actual template declaration.
 152   return ParseSingleDeclarationAfterTemplate(Context,
 153                                              ParsedTemplateInfo(&ParamLists,
 154                                                              isSpecialization,
 155                                                          LastParamListWasEmpty),
 156                                              ParsingTemplateParams,
 157                                              DeclEnd, AS, AccessAttrs);
 158 }
 159
 160 /// \brief Parse a single declaration that declares a template,
 161 /// template specialization, or explicit instantiation of a template.
 162 ///
 163 /// \param DeclEnd will receive the source location of the last token
 164 /// within this declaration.
 165 ///
 166 /// \param AS the access specifier associated with this
 167 /// declaration. Will be AS_none for namespace-scope declarations.
 168 ///
 169 /// \returns the new declaration.
 170 Decl *
 171 Parser::ParseSingleDeclarationAfterTemplate(
 172                                        unsigned Context,
 173                                        const ParsedTemplateInfo &TemplateInfo,
 174                                        ParsingDeclRAIIObject &DiagsFromTParams,
 175                                        SourceLocation &DeclEnd,
 176                                        AccessSpecifier AS,
 177                                        AttributeList *AccessAttrs) {
 178   assert(TemplateInfo.Kind != ParsedTemplateInfo::NonTemplate &&
 179          "Template information required");
 180
 181   if (Tok.is(tok::kw_static_assert)) {
 182     // A static_assert declaration may not be templated.
 183     Diag(Tok.getLocation(), diag::err_templated_invalid_declaration)
 184       << TemplateInfo.getSourceRange();
 185     // Parse the static_assert declaration to improve error recovery.
 186     return ParseStaticAssertDeclaration(DeclEnd);
 187   }
 188
 189   if (Context == Declarator::MemberContext) {
 190     // We are parsing a member template.
 191     ParseCXXClassMemberDeclaration(AS, AccessAttrs, TemplateInfo,
 192                                    &DiagsFromTParams);
 193     return nullptr;
 194   }
 195
 196   ParsedAttributesWithRange prefixAttrs(AttrFactory);
 197   MaybeParseCXX11Attributes(prefixAttrs);
 198
 199   if (Tok.is(tok::kw_using)) {
 200     // FIXME: We should return the DeclGroup to the caller.
 201     ParseUsingDirectiveOrDeclaration(Context, TemplateInfo, DeclEnd,
 202                                      prefixAttrs);
 203     return nullptr;
 204   }
 205
 206   // Parse the declaration specifiers, stealing any diagnostics from
 207   // the template parameters.
 208   ParsingDeclSpec DS(*this, &DiagsFromTParams);
 209
 210   ParseDeclarationSpecifiers(DS, TemplateInfo, AS,
 211                              getDeclSpecContextFromDeclaratorContext(Context));
 212
 213   if (Tok.is(tok::semi)) {
 214     ProhibitAttributes(prefixAttrs);
 215     DeclEnd = ConsumeToken();
 216     RecordDecl *AnonRecord = nullptr;
 217     Decl *Decl = Actions.ParsedFreeStandingDeclSpec(
 218         getCurScope(), AS, DS,
 219         TemplateInfo.TemplateParams ? *TemplateInfo.TemplateParams
 220                                     : MultiTemplateParamsArg(),
 221         TemplateInfo.Kind == ParsedTemplateInfo::ExplicitInstantiation,
 222         AnonRecord);
 223     assert(!AnonRecord &&
 224            "Anonymous unions/structs should not be valid with template");
 225     DS.complete(Decl);
 226     return Decl;
 227   }
 228
 229   // Move the attributes from the prefix into the DS.
 230   if (TemplateInfo.Kind == ParsedTemplateInfo::ExplicitInstantiation)
 231     ProhibitAttributes(prefixAttrs);
 232   else
 233     DS.takeAttributesFrom(prefixAttrs);
 234
 235   // Parse the declarator.
 236   ParsingDeclarator DeclaratorInfo(*this, DS, (Declarator::TheContext)Context);
 237   ParseDeclarator(DeclaratorInfo);
 238   // Error parsing the declarator?
 239   if (!DeclaratorInfo.hasName()) {
 240     // If so, skip until the semi-colon or a }.
 241     SkipUntil(tok::r_brace, StopAtSemi | StopBeforeMatch);
 242     if (Tok.is(tok::semi))
 243       ConsumeToken();
 244     return nullptr;
 245   }
 246
 247   LateParsedAttrList LateParsedAttrs(true);
 248   if (DeclaratorInfo.isFunctionDeclarator())
 249     MaybeParseGNUAttributes(DeclaratorInfo, &LateParsedAttrs);
 250
 251   if (DeclaratorInfo.isFunctionDeclarator() &&
 252       isStartOfFunctionDefinition(DeclaratorInfo)) {
 253
 254     // Function definitions are only allowed at file scope and in C++ classes.
 255     // The C++ inline method definition case is handled elsewhere, so we only
 256     // need to handle the file scope definition case.
 257     if (Context != Declarator::FileContext) {
 258       Diag(Tok, diag::err_function_definition_not_allowed);
 259       SkipMalformedDecl();
 260       return nullptr;
 261     }
 262
 263     if (DS.getStorageClassSpec() == DeclSpec::SCS_typedef) {
 264       // Recover by ignoring the 'typedef'. This was probably supposed to be
 265       // the 'typename' keyword, which we should have already suggested adding
 266       // if it's appropriate.
 267       Diag(DS.getStorageClassSpecLoc(), diag::err_function_declared_typedef)
 268         << FixItHint::CreateRemoval(DS.getStorageClassSpecLoc());
 269       DS.ClearStorageClassSpecs();
 270     }
 271
 272     if (TemplateInfo.Kind == ParsedTemplateInfo::ExplicitInstantiation) {
 273       if (DeclaratorInfo.getName().getKind() != UnqualifiedId::IK_TemplateId) {
 274         // If the declarator-id is not a template-id, issue a diagnostic and
 275         // recover by ignoring the 'template' keyword.
 276         Diag(Tok, diag::err_template_defn_explicit_instantiation) << 0;
 277         return ParseFunctionDefinition(DeclaratorInfo, ParsedTemplateInfo(),
 278                                        &LateParsedAttrs);
 279       } else {
 280         SourceLocation LAngleLoc
 281           = PP.getLocForEndOfToken(TemplateInfo.TemplateLoc);
 282         Diag(DeclaratorInfo.getIdentifierLoc(),
 283              diag::err_explicit_instantiation_with_definition)
 284             << SourceRange(TemplateInfo.TemplateLoc)
 285             << FixItHint::CreateInsertion(LAngleLoc, "<>");
 286
 287         // Recover as if it were an explicit specialization.
 288         TemplateParameterLists FakedParamLists;
 289         FakedParamLists.push_back(Actions.ActOnTemplateParameterList(
 290             0, SourceLocation(), TemplateInfo.TemplateLoc, LAngleLoc, None,
 291             LAngleLoc, nullptr));
 292
 293         return ParseFunctionDefinition(
 294             DeclaratorInfo, ParsedTemplateInfo(&FakedParamLists,
 295                                                /*isSpecialization=*/true,
 296                                                /*LastParamListWasEmpty=*/true),
 297             &LateParsedAttrs);
 298       }
 299     }
 300     return ParseFunctionDefinition(DeclaratorInfo, TemplateInfo,
 301                                    &LateParsedAttrs);
 302   }
 303
 304   // Parse this declaration.
 305   Decl *ThisDecl = ParseDeclarationAfterDeclarator(DeclaratorInfo,
 306                                                    TemplateInfo);
 307
 308   if (Tok.is(tok::comma)) {
 309     Diag(Tok, diag::err_multiple_template_declarators)
 310       << (int)TemplateInfo.Kind;
 311     SkipUntil(tok::semi);
 312     return ThisDecl;
 313   }
 314
 315   // Eat the semi colon after the declaration.
 316   ExpectAndConsumeSemi(diag::err_expected_semi_declaration);
 317   if (LateParsedAttrs.size() > 0)
 318     ParseLexedAttributeList(LateParsedAttrs, ThisDecl, true, false);
 319   DeclaratorInfo.complete(ThisDecl);
 320   return ThisDecl;
 321 }
 322
 323 /// ParseTemplateParameters - Parses a template-parameter-list enclosed in
 324 /// angle brackets. Depth is the depth of this template-parameter-list, which
 325 /// is the number of template headers directly enclosing this template header.
 326 /// TemplateParams is the current list of template parameters we're building.
 327 /// The template parameter we parse will be added to this list. LAngleLoc and
 328 /// RAngleLoc will receive the positions of the '<' and '>', respectively,
 329 /// that enclose this template parameter list.
 330 ///
 331 /// \returns true if an error occurred, false otherwise.
 332 bool Parser::ParseTemplateParameters(unsigned Depth,
 333                                SmallVectorImpl<Decl*> &TemplateParams,
 334                                      SourceLocation &LAngleLoc,
 335                                      SourceLocation &RAngleLoc) {
 336   // Get the template parameter list.
 337   if (!TryConsumeToken(tok::less, LAngleLoc)) {
 338     Diag(Tok.getLocation(), diag::err_expected_less_after) << "template";
 339     return true;
 340   }
 341
 342   // Try to parse the template parameter list.
 343   bool Failed = false;
 344   if (!Tok.is(tok::greater) && !Tok.is(tok::greatergreater))
 345     Failed = ParseTemplateParameterList(Depth, TemplateParams);
 346
 347   if (Tok.is(tok::greatergreater)) {
 348     // No diagnostic required here: a template-parameter-list can only be
 349     // followed by a declaration or, for a template template parameter, the
 350     // 'class' keyword. Therefore, the second '>' will be diagnosed later.
 351     // This matters for elegant diagnosis of:
 352     //   template<template<typename>> struct S;
 353     Tok.setKind(tok::greater);
 354     RAngleLoc = Tok.getLocation();
 355     Tok.setLocation(Tok.getLocation().getLocWithOffset(1));
 356   } else if (!TryConsumeToken(tok::greater, RAngleLoc) && Failed) {
 357     Diag(Tok.getLocation(), diag::err_expected) << tok::greater;
 358     return true;
 359   }
 360   return false;
 361 }
 362
 363 /// ParseTemplateParameterList - Parse a template parameter list. If
 364 /// the parsing fails badly (i.e., closing bracket was left out), this
 365 /// will try to put the token stream in a reasonable position (closing
 366 /// a statement, etc.) and return false.
 367 ///
 368 ///       template-parameter-list:    [C++ temp]
 369 ///         template-parameter
 370 ///         template-parameter-list ',' template-parameter
 371 bool
 372 Parser::ParseTemplateParameterList(unsigned Depth,
 373                              SmallVectorImpl<Decl*> &TemplateParams) {
 374   while (1) {
 375     if (Decl *TmpParam
 376           = ParseTemplateParameter(Depth, TemplateParams.size())) {
 377       TemplateParams.push_back(TmpParam);
 378     } else {
 379       // If we failed to parse a template parameter, skip until we find
 380       // a comma or closing brace.
 381       SkipUntil(tok::comma, tok::greater, tok::greatergreater,
 382                 StopAtSemi | StopBeforeMatch);
 383     }
 384
 385     // Did we find a comma or the end of the template parameter list?
 386     if (Tok.is(tok::comma)) {
 387       ConsumeToken();
 388     } else if (Tok.isOneOf(tok::greater, tok::greatergreater)) {
 389       // Don't consume this... that's done by template parser.
 390       break;
 391     } else {
 392       // Somebody probably forgot to close the template. Skip ahead and
 393       // try to get out of the expression. This error is currently
 394       // subsumed by whatever goes on in ParseTemplateParameter.
 395       Diag(Tok.getLocation(), diag::err_expected_comma_greater);
 396       SkipUntil(tok::comma, tok::greater, tok::greatergreater,
 397                 StopAtSemi | StopBeforeMatch);
 398       return false;
 399     }
 400   }
 401   return true;
 402 }
 403
 404 /// \brief Determine whether the parser is at the start of a template
 405 /// type parameter.
 406 bool Parser::isStartOfTemplateTypeParameter() {
 407   if (Tok.is(tok::kw_class)) {
 408     // "class" may be the start of an elaborated-type-specifier or a
 409     // type-parameter. Per C++ [temp.param]p3, we prefer the type-parameter.
 410     switch (NextToken().getKind()) {
 411     case tok::equal:
 412     case tok::comma:
 413     case tok::greater:
 414     case tok::greatergreater:
 415     case tok::ellipsis:
 416       return true;
 417
 418     case tok::identifier:
 419       // This may be either a type-parameter or an elaborated-type-specifier.
 420       // We have to look further.
 421       break;
 422
 423     default:
 424       return false;
 425     }
 426
 427     switch (GetLookAheadToken(2).getKind()) {
 428     case tok::equal:
 429     case tok::comma:
 430     case tok::greater:
 431     case tok::greatergreater:
 432       return true;
 433
 434     default:
 435       return false;
 436     }
 437   }
 438
 439   if (Tok.isNot(tok::kw_typename))
 440     return false;
 441
 442   // C++ [temp.param]p2:
 443   //   There is no semantic difference between class and typename in a
 444   //   template-parameter. typename followed by an unqualified-id
 445   //   names a template type parameter. typename followed by a
 446   //   qualified-id denotes the type in a non-type
 447   //   parameter-declaration.
 448   Token Next = NextToken();
 449
 450   // If we have an identifier, skip over it.
 451   if (Next.getKind() == tok::identifier)
 452     Next = GetLookAheadToken(2);
 453
 454   switch (Next.getKind()) {
 455   case tok::equal:
 456   case tok::comma:
 457   case tok::greater:
 458   case tok::greatergreater:
 459   case tok::ellipsis:
 460     return true;
 461
 462   default:
 463     return false;
 464   }
 465 }
 466
 467 /// ParseTemplateParameter - Parse a template-parameter (C++ [temp.param]).
 468 ///
 469 ///       template-parameter: [C++ temp.param]
 470 ///         type-parameter
 471 ///         parameter-declaration
 472 ///
 473 ///       type-parameter: (see below)
 474 ///         'class' ...[opt] identifier[opt]
 475 ///         'class' identifier[opt] '=' type-id
 476 ///         'typename' ...[opt] identifier[opt]
 477 ///         'typename' identifier[opt] '=' type-id
 478 ///         'template' '<' template-parameter-list '>'
 479 ///               'class' ...[opt] identifier[opt]
 480 ///         'template' '<' template-parameter-list '>' 'class' identifier[opt]
 481 ///               = id-expression
 482 Decl *Parser::ParseTemplateParameter(unsigned Depth, unsigned Position) {
 483   if (isStartOfTemplateTypeParameter())
 484     return ParseTypeParameter(Depth, Position);
 485
 486   if (Tok.is(tok::kw_template))
 487     return ParseTemplateTemplateParameter(Depth, Position);
 488
 489   // If it's none of the above, then it must be a parameter declaration.
 490   // NOTE: This will pick up errors in the closure of the template parameter
 491   // list (e.g., template < ; Check here to implement >> style closures.
 492   return ParseNonTypeTemplateParameter(Depth, Position);
 493 }
 494
 495 /// ParseTypeParameter - Parse a template type parameter (C++ [temp.param]).
 496 /// Other kinds of template parameters are parsed in
 497 /// ParseTemplateTemplateParameter and ParseNonTypeTemplateParameter.
 498 ///
 499 ///       type-parameter:     [C++ temp.param]
 500 ///         'class' ...[opt][C++0x] identifier[opt]
 501 ///         'class' identifier[opt] '=' type-id
 502 ///         'typename' ...[opt][C++0x] identifier[opt]
 503 ///         'typename' identifier[opt] '=' type-id
 504 Decl *Parser::ParseTypeParameter(unsigned Depth, unsigned Position) {
 505   assert(Tok.isOneOf(tok::kw_class, tok::kw_typename) &&
 506          "A type-parameter starts with 'class' or 'typename'");
 507
 508   // Consume the 'class' or 'typename' keyword.
 509   bool TypenameKeyword = Tok.is(tok::kw_typename);
 510   SourceLocation KeyLoc = ConsumeToken();
 511
 512   // Grab the ellipsis (if given).
 513   SourceLocation EllipsisLoc;
 514   if (TryConsumeToken(tok::ellipsis, EllipsisLoc)) {
 515     Diag(EllipsisLoc,
 516          getLangOpts().CPlusPlus11
 517            ? diag::warn_cxx98_compat_variadic_templates
 518            : diag::ext_variadic_templates);
 519   }
 520
 521   // Grab the template parameter name (if given)
 522   SourceLocation NameLoc;
 523   IdentifierInfo *ParamName = nullptr;
 524   if (Tok.is(tok::identifier)) {
 525     ParamName = Tok.getIdentifierInfo();
 526     NameLoc = ConsumeToken();
 527   } else if (Tok.isOneOf(tok::equal, tok::comma, tok::greater,
 528                          tok::greatergreater)) {
 529     // Unnamed template parameter. Don't have to do anything here, just
 530     // don't consume this token.
 531   } else {
 532     Diag(Tok.getLocation(), diag::err_expected) << tok::identifier;
 533     return nullptr;
 534   }
 535
 536   // Recover from misplaced ellipsis.
 537   bool AlreadyHasEllipsis = EllipsisLoc.isValid();
 538   if (TryConsumeToken(tok::ellipsis, EllipsisLoc))
 539     DiagnoseMisplacedEllipsis(EllipsisLoc, NameLoc, AlreadyHasEllipsis, true);
 540
 541   // Grab a default argument (if available).
 542   // Per C++0x [basic.scope.pdecl]p9, we parse the default argument before
 543   // we introduce the type parameter into the local scope.
 544   SourceLocation EqualLoc;
 545   ParsedType DefaultArg;
 546   if (TryConsumeToken(tok::equal, EqualLoc))
 547     DefaultArg = ParseTypeName(/*Range=*/nullptr,
 548                                Declarator::TemplateTypeArgContext).get();
 549
 550   return Actions.ActOnTypeParameter(getCurScope(), TypenameKeyword, EllipsisLoc,
 551                                     KeyLoc, ParamName, NameLoc, Depth, Position,
 552                                     EqualLoc, DefaultArg);
 553 }
 554
 555 /// ParseTemplateTemplateParameter - Handle the parsing of template
 556 /// template parameters.
 557 ///
 558 ///       type-parameter:    [C++ temp.param]
 559 ///         'template' '<' template-parameter-list '>' type-parameter-key
 560 ///                  ...[opt] identifier[opt]
 561 ///         'template' '<' template-parameter-list '>' type-parameter-key
 562 ///                  identifier[opt] = id-expression
 563 ///       type-parameter-key:
 564 ///         'class'
 565 ///         'typename'       [C++1z]
 566 Decl *
 567 Parser::ParseTemplateTemplateParameter(unsigned Depth, unsigned Position) {
 568   assert(Tok.is(tok::kw_template) && "Expected 'template' keyword");
 569
 570   // Handle the template <...> part.
 571   SourceLocation TemplateLoc = ConsumeToken();
 572   SmallVector<Decl*,8> TemplateParams;
 573   SourceLocation LAngleLoc, RAngleLoc;
 574   {
 575     ParseScope TemplateParmScope(this, Scope::TemplateParamScope);
 576     if (ParseTemplateParameters(Depth + 1, TemplateParams, LAngleLoc,
 577                                RAngleLoc)) {
 578       return nullptr;
 579     }
 580   }
 581
 582   // Provide an ExtWarn if the C++1z feature of using 'typename' here is used.
 583   // Generate a meaningful error if the user forgot to put class before the
 584   // identifier, comma, or greater. Provide a fixit if the identifier, comma,
 585   // or greater appear immediately or after 'struct'. In the latter case,
 586   // replace the keyword with 'class'.
 587   if (!TryConsumeToken(tok::kw_class)) {
 588     bool Replace = Tok.isOneOf(tok::kw_typename, tok::kw_struct);
 589     const Token &Next = Tok.is(tok::kw_struct) ? NextToken() : Tok;
 590     if (Tok.is(tok::kw_typename)) {
 591       Diag(Tok.getLocation(),
 592            getLangOpts().CPlusPlus1z
 593                ? diag::warn_cxx14_compat_template_template_param_typename
 594                : diag::ext_template_template_param_typename)
 595         << (!getLangOpts().CPlusPlus1z
 596                 ? FixItHint::CreateReplacement(Tok.getLocation(), "class")
 597                 : FixItHint());
 598     } else if (Next.isOneOf(tok::identifier, tok::comma, tok::greater,
 599                             tok::greatergreater, tok::ellipsis)) {
 600       Diag(Tok.getLocation(), diag::err_class_on_template_template_param)
 601         << (Replace ? FixItHint::CreateReplacement(Tok.getLocation(), "class")
 602                     : FixItHint::CreateInsertion(Tok.getLocation(), "class "));
 603     } else
 604       Diag(Tok.getLocation(), diag::err_class_on_template_template_param);
 605
 606     if (Replace)
 607       ConsumeToken();
 608   }
 609
 610   // Parse the ellipsis, if given.
 611   SourceLocation EllipsisLoc;
 612   if (TryConsumeToken(tok::ellipsis, EllipsisLoc))
 613     Diag(EllipsisLoc,
 614          getLangOpts().CPlusPlus11
 615            ? diag::warn_cxx98_compat_variadic_templates
 616            : diag::ext_variadic_templates);
 617
 618   // Get the identifier, if given.
 619   SourceLocation NameLoc;
 620   IdentifierInfo *ParamName = nullptr;
 621   if (Tok.is(tok::identifier)) {
 622     ParamName = Tok.getIdentifierInfo();
 623     NameLoc = ConsumeToken();
 624   } else if (Tok.isOneOf(tok::equal, tok::comma, tok::greater,
 625                          tok::greatergreater)) {
 626     // Unnamed template parameter. Don't have to do anything here, just
 627     // don't consume this token.
 628   } else {
 629     Diag(Tok.getLocation(), diag::err_expected) << tok::identifier;
 630     return nullptr;
 631   }
 632
 633   // Recover from misplaced ellipsis.
 634   bool AlreadyHasEllipsis = EllipsisLoc.isValid();
 635   if (TryConsumeToken(tok::ellipsis, EllipsisLoc))
 636     DiagnoseMisplacedEllipsis(EllipsisLoc, NameLoc, AlreadyHasEllipsis, true);
 637
 638   TemplateParameterList *ParamList =
 639     Actions.ActOnTemplateParameterList(Depth, SourceLocation(),
 640                                        TemplateLoc, LAngleLoc,
 641                                        TemplateParams,
 642                                        RAngleLoc, nullptr);
 643
 644   // Grab a default argument (if available).
 645   // Per C++0x [basic.scope.pdecl]p9, we parse the default argument before
 646   // we introduce the template parameter into the local scope.
 647   SourceLocation EqualLoc;
 648   ParsedTemplateArgument DefaultArg;
 649   if (TryConsumeToken(tok::equal, EqualLoc)) {
 650     DefaultArg = ParseTemplateTemplateArgument();
 651     if (DefaultArg.isInvalid()) {
 652       Diag(Tok.getLocation(),
 653            diag::err_default_template_template_parameter_not_template);
 654       SkipUntil(tok::comma, tok::greater, tok::greatergreater,
 655                 StopAtSemi | StopBeforeMatch);
 656     }
 657   }
 658
 659   return Actions.ActOnTemplateTemplateParameter(getCurScope(), TemplateLoc,
 660                                                 ParamList, EllipsisLoc,
 661                                                 ParamName, NameLoc, Depth,
 662                                                 Position, EqualLoc, DefaultArg);
 663 }
 664
 665 /// ParseNonTypeTemplateParameter - Handle the parsing of non-type
 666 /// template parameters (e.g., in "template<int Size> class array;").
 667 ///
 668 ///       template-parameter:
 669 ///         ...
 670 ///         parameter-declaration
 671 Decl *
 672 Parser::ParseNonTypeTemplateParameter(unsigned Depth, unsigned Position) {
 673   // Parse the declaration-specifiers (i.e., the type).
 674   // FIXME: The type should probably be restricted in some way... Not all
 675   // declarators (parts of declarators?) are accepted for parameters.
 676   DeclSpec DS(AttrFactory);
 677   ParseDeclarationSpecifiers(DS);
 678
 679   // Parse this as a typename.
 680   Declarator ParamDecl(DS, Declarator::TemplateParamContext);
 681   ParseDeclarator(ParamDecl);
 682   if (DS.getTypeSpecType() == DeclSpec::TST_unspecified) {
 683     Diag(Tok.getLocation(), diag::err_expected_template_parameter);
 684     return nullptr;
 685   }
 686
 687   // Recover from misplaced ellipsis.
 688   SourceLocation EllipsisLoc;
 689   if (TryConsumeToken(tok::ellipsis, EllipsisLoc))
 690     DiagnoseMisplacedEllipsisInDeclarator(EllipsisLoc, ParamDecl);
 691
 692   // If there is a default value, parse it.
 693   // Per C++0x [basic.scope.pdecl]p9, we parse the default argument before
 694   // we introduce the template parameter into the local scope.
 695   SourceLocation EqualLoc;
 696   ExprResult DefaultArg;
 697   if (TryConsumeToken(tok::equal, EqualLoc)) {
 698     // C++ [temp.param]p15:
 699     //   When parsing a default template-argument for a non-type
 700     //   template-parameter, the first non-nested > is taken as the
 701     //   end of the template-parameter-list rather than a greater-than
 702     //   operator.
 703     GreaterThanIsOperatorScope G(GreaterThanIsOperator, false);
 704     EnterExpressionEvaluationContext ConstantEvaluated(
 705         Actions, Sema::ExpressionEvaluationContext::ConstantEvaluated);
 706
 707     DefaultArg = Actions.CorrectDelayedTyposInExpr(ParseAssignmentExpression());
 708     if (DefaultArg.isInvalid())
 709       SkipUntil(tok::comma, tok::greater, StopAtSemi | StopBeforeMatch);
 710   }
 711
 712   // Create the parameter.
 713   return Actions.ActOnNonTypeTemplateParameter(getCurScope(), ParamDecl,
 714                                                Depth, Position, EqualLoc,
 715                                                DefaultArg.get());
 716 }
 717
 718 void Parser::DiagnoseMisplacedEllipsis(SourceLocation EllipsisLoc,
 719                                        SourceLocation CorrectLoc,
 720                                        bool AlreadyHasEllipsis,
 721                                        bool IdentifierHasName) {
 722   FixItHint Insertion;
 723   if (!AlreadyHasEllipsis)
 724     Insertion = FixItHint::CreateInsertion(CorrectLoc, "...");
 725   Diag(EllipsisLoc, diag::err_misplaced_ellipsis_in_declaration)
 726       << FixItHint::CreateRemoval(EllipsisLoc) << Insertion
 727       << !IdentifierHasName;
 728 }
 729
 730 void Parser::DiagnoseMisplacedEllipsisInDeclarator(SourceLocation EllipsisLoc,
 731                                                    Declarator &D) {
 732   assert(EllipsisLoc.isValid());
 733   bool AlreadyHasEllipsis = D.getEllipsisLoc().isValid();
 734   if (!AlreadyHasEllipsis)
 735     D.setEllipsisLoc(EllipsisLoc);
 736   DiagnoseMisplacedEllipsis(EllipsisLoc, D.getIdentifierLoc(),
 737                             AlreadyHasEllipsis, D.hasName());
 738 }
 739
 740 /// \brief Parses a '>' at the end of a template list.
 741 ///
 742 /// If this function encounters '>>', '>>>', '>=', or '>>=', it tries
 743 /// to determine if these tokens were supposed to be a '>' followed by
 744 /// '>', '>>', '>=', or '>='. It emits an appropriate diagnostic if necessary.
 745 ///
 746 /// \param RAngleLoc the location of the consumed '>'.
 747 ///
 748 /// \param ConsumeLastToken if true, the '>' is consumed.
 749 ///
 750 /// \param ObjCGenericList if true, this is the '>' closing an Objective-C
 751 /// type parameter or type argument list, rather than a C++ template parameter
 752 /// or argument list.
 753 ///
 754 /// \returns true, if current token does not start with '>', false otherwise.
 755 bool Parser::ParseGreaterThanInTemplateList(SourceLocation &RAngleLoc,
 756                                             bool ConsumeLastToken,
 757                                             bool ObjCGenericList) {
 758   // What will be left once we've consumed the '>'.
 759   tok::TokenKind RemainingToken;
 760   const char *ReplacementStr = "> >";
 761
 762   switch (Tok.getKind()) {
 763   default:
 764     Diag(Tok.getLocation(), diag::err_expected) << tok::greater;
 765     return true;
 766
 767   case tok::greater:
 768     // Determine the location of the '>' token. Only consume this token
 769     // if the caller asked us to.
 770     RAngleLoc = Tok.getLocation();
 771     if (ConsumeLastToken)
 772       ConsumeToken();
 773     return false;
 774
 775   case tok::greatergreater:
 776     RemainingToken = tok::greater;
 777     break;
 778
 779   case tok::greatergreatergreater:
 780     RemainingToken = tok::greatergreater;
 781     break;
 782
 783   case tok::greaterequal:
 784     RemainingToken = tok::equal;
 785     ReplacementStr = "> =";
 786     break;
 787
 788   case tok::greatergreaterequal:
 789     RemainingToken = tok::greaterequal;
 790     break;
 791   }
 792
 793   // This template-id is terminated by a token which starts with a '>'. Outside
 794   // C++11, this is now error recovery, and in C++11, this is error recovery if
 795   // the token isn't '>>' or '>>>'.
 796   // '>>>' is for CUDA, where this sequence of characters is parsed into
 797   // tok::greatergreatergreater, rather than two separate tokens.
 798   //
 799   // We always allow this for Objective-C type parameter and type argument
 800   // lists.
 801   RAngleLoc = Tok.getLocation();
 802   Token Next = NextToken();
 803   if (!ObjCGenericList) {
 804     // The source range of the '>>' or '>=' at the start of the token.
 805     CharSourceRange ReplacementRange =
 806         CharSourceRange::getCharRange(RAngleLoc,
 807             Lexer::AdvanceToTokenCharacter(RAngleLoc, 2, PP.getSourceManager(),
 808                                            getLangOpts()));
 809
 810     // A hint to put a space between the '>>'s. In order to make the hint as
 811     // clear as possible, we include the characters either side of the space in
 812     // the replacement, rather than just inserting a space at SecondCharLoc.
 813     FixItHint Hint1 = FixItHint::CreateReplacement(ReplacementRange,
 814                                                    ReplacementStr);
 815
 816     // A hint to put another space after the token, if it would otherwise be
 817     // lexed differently.
 818     FixItHint Hint2;
 819     if ((RemainingToken == tok::greater ||
 820          RemainingToken == tok::greatergreater) &&
 821         (Next.isOneOf(tok::greater, tok::greatergreater,
 822                       tok::greatergreatergreater, tok::equal,
 823                       tok::greaterequal, tok::greatergreaterequal,
 824                       tok::equalequal)) &&
 825         areTokensAdjacent(Tok, Next))
 826       Hint2 = FixItHint::CreateInsertion(Next.getLocation(), " ");
 827
 828     unsigned DiagId = diag::err_two_right_angle_brackets_need_space;
 829     if (getLangOpts().CPlusPlus11 &&
 830         (Tok.is(tok::greatergreater) || Tok.is(tok::greatergreatergreater)))
 831       DiagId = diag::warn_cxx98_compat_two_right_angle_brackets;
 832     else if (Tok.is(tok::greaterequal))
 833       DiagId = diag::err_right_angle_bracket_equal_needs_space;
 834     Diag(Tok.getLocation(), DiagId) << Hint1 << Hint2;
 835   }
 836
 837   // Strip the initial '>' from the token.
 838   Token PrevTok = Tok;
 839   if (RemainingToken == tok::equal && Next.is(tok::equal) &&
 840       areTokensAdjacent(Tok, Next)) {
 841     // Join two adjacent '=' tokens into one, for cases like:
 842     //   void (*p)() = f<int>;
 843     //   return f<int>==p;
 844     ConsumeToken();
 845     Tok.setKind(tok::equalequal);
 846     Tok.setLength(Tok.getLength() + 1);
 847   } else {
 848     Tok.setKind(RemainingToken);
 849     Tok.setLength(Tok.getLength() - 1);
 850   }
 851   Tok.setLocation(Lexer::AdvanceToTokenCharacter(RAngleLoc, 1,
 852                                                  PP.getSourceManager(),
 853                                                  getLangOpts()));
 854
 855   // The advance from '>>' to '>' in a ObjectiveC template argument list needs
 856   // to be properly reflected in the token cache to allow correct interaction
 857   // between annotation and backtracking.
 858   if (ObjCGenericList && PrevTok.getKind() == tok::greatergreater &&
 859       RemainingToken == tok::greater && PP.IsPreviousCachedToken(PrevTok)) {
 860     PrevTok.setKind(RemainingToken);
 861     PrevTok.setLength(1);
 862     // Break tok::greatergreater into two tok::greater but only add the second
 863     // one in case the client asks to consume the last token.
 864     if (ConsumeLastToken)
 865       PP.ReplacePreviousCachedToken({PrevTok, Tok});
 866     else
 867       PP.ReplacePreviousCachedToken({PrevTok});
 868   }
 869
 870   if (!ConsumeLastToken) {
 871     // Since we're not supposed to consume the '>' token, we need to push
 872     // this token and revert the current token back to the '>'.
 873     PP.EnterToken(Tok);
 874     Tok.setKind(tok::greater);
 875     Tok.setLength(1);
 876     Tok.setLocation(RAngleLoc);
 877   }
 878   return false;
 879 }
 880
 881
 882 /// \brief Parses a template-id that after the template name has
 883 /// already been parsed.
 884 ///
 885 /// This routine takes care of parsing the enclosed template argument
 886 /// list ('<' template-parameter-list [opt] '>') and placing the
 887 /// results into a form that can be transferred to semantic analysis.
 888 ///
 889 /// \param ConsumeLastToken if true, then we will consume the last
 890 /// token that forms the template-id. Otherwise, we will leave the
 891 /// last token in the stream (e.g., so that it can be replaced with an
 892 /// annotation token).
 893 bool
 894 Parser::ParseTemplateIdAfterTemplateName(bool ConsumeLastToken,
 895                                          SourceLocation &LAngleLoc,
 896                                          TemplateArgList &TemplateArgs,
 897                                          SourceLocation &RAngleLoc) {
 898   assert(Tok.is(tok::less) && "Must have already parsed the template-name");
 899
 900   // Consume the '<'.
 901   LAngleLoc = ConsumeToken();
 902
 903   // Parse the optional template-argument-list.
 904   bool Invalid = false;
 905   {
 906     GreaterThanIsOperatorScope G(GreaterThanIsOperator, false);
 907     if (Tok.isNot(tok::greater) && Tok.isNot(tok::greatergreater))
 908       Invalid = ParseTemplateArgumentList(TemplateArgs);
 909
 910     if (Invalid) {
 911       // Try to find the closing '>'.
 912       if (ConsumeLastToken)
 913         SkipUntil(tok::greater, StopAtSemi);
 914       else
 915         SkipUntil(tok::greater, StopAtSemi | StopBeforeMatch);
 916       return true;
 917     }
 918   }
 919
 920   return ParseGreaterThanInTemplateList(RAngleLoc, ConsumeLastToken,
 921                                         /*ObjCGenericList=*/false);
 922 }
 923
 924 /// \brief Replace the tokens that form a simple-template-id with an
 925 /// annotation token containing the complete template-id.
 926 ///
 927 /// The first token in the stream must be the name of a template that
 928 /// is followed by a '<'. This routine will parse the complete
 929 /// simple-template-id and replace the tokens with a single annotation
 930 /// token with one of two different kinds: if the template-id names a
 931 /// type (and \p AllowTypeAnnotation is true), the annotation token is
 932 /// a type annotation that includes the optional nested-name-specifier
 933 /// (\p SS). Otherwise, the annotation token is a template-id
 934 /// annotation that does not include the optional
 935 /// nested-name-specifier.
 936 ///
 937 /// \param Template  the declaration of the template named by the first
 938 /// token (an identifier), as returned from \c Action::isTemplateName().
 939 ///
 940 /// \param TNK the kind of template that \p Template
 941 /// refers to, as returned from \c Action::isTemplateName().
 942 ///
 943 /// \param SS if non-NULL, the nested-name-specifier that precedes
 944 /// this template name.
 945 ///
 946 /// \param TemplateKWLoc if valid, specifies that this template-id
 947 /// annotation was preceded by the 'template' keyword and gives the
 948 /// location of that keyword. If invalid (the default), then this
 949 /// template-id was not preceded by a 'template' keyword.
 950 ///
 951 /// \param AllowTypeAnnotation if true (the default), then a
 952 /// simple-template-id that refers to a class template, template
 953 /// template parameter, or other template that produces a type will be
 954 /// replaced with a type annotation token. Otherwise, the
 955 /// simple-template-id is always replaced with a template-id
 956 /// annotation token.
 957 ///
 958 /// If an unrecoverable parse error occurs and no annotation token can be
 959 /// formed, this function returns true.
 960 ///
 961 bool Parser::AnnotateTemplateIdToken(TemplateTy Template, TemplateNameKind TNK,
 962                                      CXXScopeSpec &SS,
 963                                      SourceLocation TemplateKWLoc,
 964                                      UnqualifiedId &TemplateName,
 965                                      bool AllowTypeAnnotation) {
 966   assert(getLangOpts().CPlusPlus && "Can only annotate template-ids in C++");
 967   assert(Template && Tok.is(tok::less) &&
 968          "Parser isn't at the beginning of a template-id");
 969
 970   // Consume the template-name.
 971   SourceLocation TemplateNameLoc = TemplateName.getSourceRange().getBegin();
 972
 973   // Parse the enclosed template argument list.
 974   SourceLocation LAngleLoc, RAngleLoc;
 975   TemplateArgList TemplateArgs;
 976   bool Invalid = ParseTemplateIdAfterTemplateName(false, LAngleLoc,
 977                                                   TemplateArgs,
 978                                                   RAngleLoc);
 979
 980   if (Invalid) {
 981     // If we failed to parse the template ID but skipped ahead to a >, we're not
 982     // going to be able to form a token annotation.  Eat the '>' if present.
 983     TryConsumeToken(tok::greater);
 984     return true;
 985   }
 986
 987   ASTTemplateArgsPtr TemplateArgsPtr(TemplateArgs);
 988
 989   // Build the annotation token.
 990   if (TNK == TNK_Type_template && AllowTypeAnnotation) {
 991     TypeResult Type = Actions.ActOnTemplateIdType(
 992         SS, TemplateKWLoc, Template, TemplateName.Identifier,
 993         TemplateNameLoc, LAngleLoc, TemplateArgsPtr, RAngleLoc);
 994     if (Type.isInvalid()) {
 995       // If we failed to parse the template ID but skipped ahead to a >, we're
 996       // not going to be able to form a token annotation.  Eat the '>' if
 997       // present.
 998       TryConsumeToken(tok::greater);
 999       return true;
1000     }
1001
1002     Tok.setKind(tok::annot_typename);
1003     setTypeAnnotation(Tok, Type.get());
1004     if (SS.isNotEmpty())
1005       Tok.setLocation(SS.getBeginLoc());
1006     else if (TemplateKWLoc.isValid())
1007       Tok.setLocation(TemplateKWLoc);
1008     else
1009       Tok.setLocation(TemplateNameLoc);
1010   } else {
1011     // Build a template-id annotation token that can be processed
1012     // later.
1013     Tok.setKind(tok::annot_template_id);
1014
1015     IdentifierInfo *TemplateII =
1016         TemplateName.getKind() == UnqualifiedId::IK_Identifier
1017             ? TemplateName.Identifier
1018             : nullptr;
1019
1020     OverloadedOperatorKind OpKind =
1021         TemplateName.getKind() == UnqualifiedId::IK_Identifier
1022             ? OO_None
1023             : TemplateName.OperatorFunctionId.Operator;
1024
1025     TemplateIdAnnotation *TemplateId = TemplateIdAnnotation::Create(\r
1026       SS, TemplateKWLoc, TemplateNameLoc, TemplateII, OpKind, Template, TNK,\r
1027       LAngleLoc, RAngleLoc, TemplateArgs, TemplateIds);
1028
1029     Tok.setAnnotationValue(TemplateId);
1030     if (TemplateKWLoc.isValid())
1031       Tok.setLocation(TemplateKWLoc);
1032     else
1033       Tok.setLocation(TemplateNameLoc);
1034   }
1035
1036   // Common fields for the annotation token
1037   Tok.setAnnotationEndLoc(RAngleLoc);
1038
1039   // In case the tokens were cached, have Preprocessor replace them with the
1040   // annotation token.
1041   PP.AnnotateCachedTokens(Tok);
1042   return false;
1043 }
1044
1045 /// \brief Replaces a template-id annotation token with a type
1046 /// annotation token.
1047 ///
1048 /// If there was a failure when forming the type from the template-id,
1049 /// a type annotation token will still be created, but will have a
1050 /// NULL type pointer to signify an error.
1051 ///
1052 /// \param IsClassName Is this template-id appearing in a context where we
1053 /// know it names a class, such as in an elaborated-type-specifier or
1054 /// base-specifier? ('typename' and 'template' are unneeded and disallowed
1055 /// in those contexts.)
1056 void Parser::AnnotateTemplateIdTokenAsType(bool IsClassName) {
1057   assert(Tok.is(tok::annot_template_id) && "Requires template-id tokens");
1058
1059   TemplateIdAnnotation *TemplateId = takeTemplateIdAnnotation(Tok);
1060   assert((TemplateId->Kind == TNK_Type_template ||
1061           TemplateId->Kind == TNK_Dependent_template_name) &&
1062          "Only works for type and dependent templates");
1063
1064   ASTTemplateArgsPtr TemplateArgsPtr(TemplateId->getTemplateArgs(),
1065                                      TemplateId->NumArgs);
1066
1067   TypeResult Type
1068     = Actions.ActOnTemplateIdType(TemplateId->SS,
1069                                   TemplateId->TemplateKWLoc,
1070                                   TemplateId->Template,
1071                                   TemplateId->Name,
1072                                   TemplateId->TemplateNameLoc,
1073                                   TemplateId->LAngleLoc,
1074                                   TemplateArgsPtr,
1075                                   TemplateId->RAngleLoc,
1076                                   /*IsCtorOrDtorName*/false,
1077                                   IsClassName);
1078   // Create the new "type" annotation token.
1079   Tok.setKind(tok::annot_typename);
1080   setTypeAnnotation(Tok, Type.isInvalid() ? nullptr : Type.get());
1081   if (TemplateId->SS.isNotEmpty()) // it was a C++ qualified type name.
1082     Tok.setLocation(TemplateId->SS.getBeginLoc());
1083   // End location stays the same
1084
1085   // Replace the template-id annotation token, and possible the scope-specifier
1086   // that precedes it, with the typename annotation token.
1087   PP.AnnotateCachedTokens(Tok);
1088 }
1089
1090 /// \brief Determine whether the given token can end a template argument.
1091 static bool isEndOfTemplateArgument(Token Tok) {
1092   return Tok.isOneOf(tok::comma, tok::greater, tok::greatergreater);
1093 }
1094
1095 /// \brief Parse a C++ template template argument.
1096 ParsedTemplateArgument Parser::ParseTemplateTemplateArgument() {
1097   if (!Tok.is(tok::identifier) && !Tok.is(tok::coloncolon) &&
1098       !Tok.is(tok::annot_cxxscope))
1099     return ParsedTemplateArgument();
1100
1101   // C++0x [temp.arg.template]p1:
1102   //   A template-argument for a template template-parameter shall be the name
1103   //   of a class template or an alias template, expressed as id-expression.
1104   //
1105   // We parse an id-expression that refers to a class template or alias
1106   // template. The grammar we parse is:
1107   //
1108   //   nested-name-specifier[opt] template[opt] identifier ...[opt]
1109   //
1110   // followed by a token that terminates a template argument, such as ',',
1111   // '>', or (in some cases) '>>'.
1112   CXXScopeSpec SS; // nested-name-specifier, if present
1113   ParseOptionalCXXScopeSpecifier(SS, nullptr,
1114                                  /*EnteringContext=*/false);
1115
1116   ParsedTemplateArgument Result;
1117   SourceLocation EllipsisLoc;
1118   if (SS.isSet() && Tok.is(tok::kw_template)) {
1119     // Parse the optional 'template' keyword following the
1120     // nested-name-specifier.
1121     SourceLocation TemplateKWLoc = ConsumeToken();
1122
1123     if (Tok.is(tok::identifier)) {
1124       // We appear to have a dependent template name.
1125       UnqualifiedId Name;
1126       Name.setIdentifier(Tok.getIdentifierInfo(), Tok.getLocation());
1127       ConsumeToken(); // the identifier
1128
1129       TryConsumeToken(tok::ellipsis, EllipsisLoc);
1130
1131       // If the next token signals the end of a template argument,
1132       // then we have a dependent template name that could be a template
1133       // template argument.
1134       TemplateTy Template;
1135       if (isEndOfTemplateArgument(Tok) &&
1136           Actions.ActOnDependentTemplateName(
1137               getCurScope(), SS, TemplateKWLoc, Name,
1138               /*ObjectType=*/nullptr,
1139               /*EnteringContext=*/false, Template))
1140         Result = ParsedTemplateArgument(SS, Template, Name.StartLocation);
1141     }
1142   } else if (Tok.is(tok::identifier)) {
1143     // We may have a (non-dependent) template name.
1144     TemplateTy Template;
1145     UnqualifiedId Name;
1146     Name.setIdentifier(Tok.getIdentifierInfo(), Tok.getLocation());
1147     ConsumeToken(); // the identifier
1148
1149     TryConsumeToken(tok::ellipsis, EllipsisLoc);
1150
1151     if (isEndOfTemplateArgument(Tok)) {
1152       bool MemberOfUnknownSpecialization;
1153       TemplateNameKind TNK = Actions.isTemplateName(
1154           getCurScope(), SS,
1155           /*hasTemplateKeyword=*/false, Name,
1156           /*ObjectType=*/nullptr,
1157           /*EnteringContext=*/false, Template, MemberOfUnknownSpecialization);
1158       if (TNK == TNK_Dependent_template_name || TNK == TNK_Type_template) {
1159         // We have an id-expression that refers to a class template or
1160         // (C++0x) alias template.
1161         Result = ParsedTemplateArgument(SS, Template, Name.StartLocation);
1162       }
1163     }
1164   }
1165
1166   // If this is a pack expansion, build it as such.
1167   if (EllipsisLoc.isValid() && !Result.isInvalid())
1168     Result = Actions.ActOnPackExpansion(Result, EllipsisLoc);
1169
1170   return Result;
1171 }
1172
1173 /// ParseTemplateArgument - Parse a C++ template argument (C++ [temp.names]).
1174 ///
1175 ///       template-argument: [C++ 14.2]
1176 ///         constant-expression
1177 ///         type-id
1178 ///         id-expression
1179 ParsedTemplateArgument Parser::ParseTemplateArgument() {
1180   // C++ [temp.arg]p2:
1181   //   In a template-argument, an ambiguity between a type-id and an
1182   //   expression is resolved to a type-id, regardless of the form of
1183   //   the corresponding template-parameter.
1184   //
1185   // Therefore, we initially try to parse a type-id - and isCXXTypeId might look
1186   // up and annotate an identifier as an id-expression during disambiguation,
1187   // so enter the appropriate context for a constant expression template
1188   // argument before trying to disambiguate.
1189
1190   EnterExpressionEvaluationContext EnterConstantEvaluated(
1191       Actions, Sema::ExpressionEvaluationContext::ConstantEvaluated);
1192   if (isCXXTypeId(TypeIdAsTemplateArgument)) {
1193     SourceLocation Loc = Tok.getLocation();
1194     TypeResult TypeArg = ParseTypeName(/*Range=*/nullptr,
1195                                        Declarator::TemplateTypeArgContext);
1196     if (TypeArg.isInvalid())
1197       return ParsedTemplateArgument();
1198
1199     return ParsedTemplateArgument(ParsedTemplateArgument::Type,
1200                                   TypeArg.get().getAsOpaquePtr(),
1201                                   Loc);
1202   }
1203
1204   // Try to parse a template template argument.
1205   {
1206     TentativeParsingAction TPA(*this);
1207
1208     ParsedTemplateArgument TemplateTemplateArgument
1209       = ParseTemplateTemplateArgument();
1210     if (!TemplateTemplateArgument.isInvalid()) {
1211       TPA.Commit();
1212       return TemplateTemplateArgument;
1213     }
1214
1215     // Revert this tentative parse to parse a non-type template argument.
1216     TPA.Revert();
1217   }
1218
1219   // Parse a non-type template argument.
1220   SourceLocation Loc = Tok.getLocation();
1221   ExprResult ExprArg = ParseConstantExpressionInExprEvalContext(MaybeTypeCast);
1222   if (ExprArg.isInvalid() || !ExprArg.get())
1223     return ParsedTemplateArgument();
1224
1225   return ParsedTemplateArgument(ParsedTemplateArgument::NonType,
1226                                 ExprArg.get(), Loc);
1227 }
1228
1229 /// \brief Determine whether the current tokens can only be parsed as a
1230 /// template argument list (starting with the '<') and never as a '<'
1231 /// expression.
1232 bool Parser::IsTemplateArgumentList(unsigned Skip) {
1233   struct AlwaysRevertAction : TentativeParsingAction {
1234     AlwaysRevertAction(Parser &P) : TentativeParsingAction(P) { }
1235     ~AlwaysRevertAction() { Revert(); }
1236   } Tentative(*this);
1237
1238   while (Skip) {
1239     ConsumeAnyToken();
1240     --Skip;
1241   }
1242
1243   // '<'
1244   if (!TryConsumeToken(tok::less))
1245     return false;
1246
1247   // An empty template argument list.
1248   if (Tok.is(tok::greater))
1249     return true;
1250
1251   // See whether we have declaration specifiers, which indicate a type.
1252   while (isCXXDeclarationSpecifier() == TPResult::True)
1253     ConsumeAnyToken();
1254
1255   // If we have a '>' or a ',' then this is a template argument list.
1256   return Tok.isOneOf(tok::greater, tok::comma);
1257 }
1258
1259 /// ParseTemplateArgumentList - Parse a C++ template-argument-list
1260 /// (C++ [temp.names]). Returns true if there was an error.
1261 ///
1262 ///       template-argument-list: [C++ 14.2]
1263 ///         template-argument
1264 ///         template-argument-list ',' template-argument
1265 bool
1266 Parser::ParseTemplateArgumentList(TemplateArgList &TemplateArgs) {
1267
1268   ColonProtectionRAIIObject ColonProtection(*this, false);
1269
1270   do {
1271     ParsedTemplateArgument Arg = ParseTemplateArgument();
1272     SourceLocation EllipsisLoc;
1273     if (TryConsumeToken(tok::ellipsis, EllipsisLoc))
1274       Arg = Actions.ActOnPackExpansion(Arg, EllipsisLoc);
1275
1276     if (Arg.isInvalid()) {
1277       SkipUntil(tok::comma, tok::greater, StopAtSemi | StopBeforeMatch);
1278       return true;
1279     }
1280
1281     // Save this template argument.
1282     TemplateArgs.push_back(Arg);
1283
1284     // If the next token is a comma, consume it and keep reading
1285     // arguments.
1286   } while (TryConsumeToken(tok::comma));
1287
1288   return false;
1289 }
1290
1291 /// \brief Parse a C++ explicit template instantiation
1292 /// (C++ [temp.explicit]).
1293 ///
1294 ///       explicit-instantiation:
1295 ///         'extern' [opt] 'template' declaration
1296 ///
1297 /// Note that the 'extern' is a GNU extension and C++11 feature.
1298 Decl *Parser::ParseExplicitInstantiation(unsigned Context,
1299                                          SourceLocation ExternLoc,
1300                                          SourceLocation TemplateLoc,
1301                                          SourceLocation &DeclEnd,
1302                                          AccessSpecifier AS) {
1303   // This isn't really required here.
1304   ParsingDeclRAIIObject
1305     ParsingTemplateParams(*this, ParsingDeclRAIIObject::NoParent);
1306
1307   return ParseSingleDeclarationAfterTemplate(Context,
1308                                              ParsedTemplateInfo(ExternLoc,
1309                                                                 TemplateLoc),
1310                                              ParsingTemplateParams,
1311                                              DeclEnd, AS);
1312 }
1313
1314 SourceRange Parser::ParsedTemplateInfo::getSourceRange() const {
1315   if (TemplateParams)
1316     return getTemplateParamsRange(TemplateParams->data(),
1317                                   TemplateParams->size());
1318
1319   SourceRange R(TemplateLoc);
1320   if (ExternLoc.isValid())
1321     R.setBegin(ExternLoc);
1322   return R;
1323 }
1324
1325 void Parser::LateTemplateParserCallback(void *P, LateParsedTemplate &LPT) {
1326   ((Parser *)P)->ParseLateTemplatedFuncDef(LPT);
1327 }
1328
1329 /// \brief Late parse a C++ function template in Microsoft mode.
1330 void Parser::ParseLateTemplatedFuncDef(LateParsedTemplate &LPT) {
1331   if (!LPT.D)
1332      return;
1333
1334   // Get the FunctionDecl.
1335   FunctionDecl *FunD = LPT.D->getAsFunction();
1336   // Track template parameter depth.
1337   TemplateParameterDepthRAII CurTemplateDepthTracker(TemplateParameterDepth);
1338
1339   // To restore the context after late parsing.
1340   Sema::ContextRAII GlobalSavedContext(
1341       Actions, Actions.Context.getTranslationUnitDecl());
1342
1343   SmallVector<ParseScope*, 4> TemplateParamScopeStack;
1344
1345   // Get the list of DeclContexts to reenter.
1346   SmallVector<DeclContext*, 4> DeclContextsToReenter;
1347   DeclContext *DD = FunD;
1348   while (DD && !DD->isTranslationUnit()) {
1349     DeclContextsToReenter.push_back(DD);
1350     DD = DD->getLexicalParent();
1351   }
1352
1353   // Reenter template scopes from outermost to innermost.
1354   SmallVectorImpl<DeclContext *>::reverse_iterator II =
1355       DeclContextsToReenter.rbegin();
1356   for (; II != DeclContextsToReenter.rend(); ++II) {
1357     TemplateParamScopeStack.push_back(new ParseScope(this,
1358           Scope::TemplateParamScope));
1359     unsigned NumParamLists =
1360       Actions.ActOnReenterTemplateScope(getCurScope(), cast<Decl>(*II));
1361     CurTemplateDepthTracker.addDepth(NumParamLists);
1362     if (*II != FunD) {
1363       TemplateParamScopeStack.push_back(new ParseScope(this, Scope::DeclScope));
1364       Actions.PushDeclContext(Actions.getCurScope(), *II);
1365     }
1366   }
1367
1368   assert(!LPT.Toks.empty() && "Empty body!");
1369
1370   // Append the current token at the end of the new token stream so that it
1371   // doesn't get lost.
1372   LPT.Toks.push_back(Tok);
1373   PP.EnterTokenStream(LPT.Toks, true);
1374
1375   // Consume the previously pushed token.
1376   ConsumeAnyToken(/*ConsumeCodeCompletionTok=*/true);
1377   assert(Tok.isOneOf(tok::l_brace, tok::colon, tok::kw_try) &&
1378          "Inline method not starting with '{', ':' or 'try'");
1379
1380   // Parse the method body. Function body parsing code is similar enough
1381   // to be re-used for method bodies as well.
1382   ParseScope FnScope(this, Scope::FnScope|Scope::DeclScope);
1383
1384   // Recreate the containing function DeclContext.
1385   Sema::ContextRAII FunctionSavedContext(Actions,
1386                                          Actions.getContainingDC(FunD));
1387
1388   Actions.ActOnStartOfFunctionDef(getCurScope(), FunD);
1389
1390   if (Tok.is(tok::kw_try)) {
1391     ParseFunctionTryBlock(LPT.D, FnScope);
1392   } else {
1393     if (Tok.is(tok::colon))
1394       ParseConstructorInitializer(LPT.D);
1395     else
1396       Actions.ActOnDefaultCtorInitializers(LPT.D);
1397
1398     if (Tok.is(tok::l_brace)) {
1399       assert((!isa<FunctionTemplateDecl>(LPT.D) ||
1400               cast<FunctionTemplateDecl>(LPT.D)
1401                       ->getTemplateParameters()
1402                       ->getDepth() == TemplateParameterDepth - 1) &&
1403              "TemplateParameterDepth should be greater than the depth of "
1404              "current template being instantiated!");
1405       ParseFunctionStatementBody(LPT.D, FnScope);
1406       Actions.UnmarkAsLateParsedTemplate(FunD);
1407     } else
1408       Actions.ActOnFinishFunctionBody(LPT.D, nullptr);
1409   }
1410
1411   // Exit scopes.
1412   FnScope.Exit();
1413   SmallVectorImpl<ParseScope *>::reverse_iterator I =
1414    TemplateParamScopeStack.rbegin();
1415   for (; I != TemplateParamScopeStack.rend(); ++I)
1416     delete *I;
1417 }
1418
1419 /// \brief Lex a delayed template function for late parsing.
1420 void Parser::LexTemplateFunctionForLateParsing(CachedTokens &Toks) {
1421   tok::TokenKind kind = Tok.getKind();
1422   if (!ConsumeAndStoreFunctionPrologue(Toks)) {
1423     // Consume everything up to (and including) the matching right brace.
1424     ConsumeAndStoreUntil(tok::r_brace, Toks, /*StopAtSemi=*/false);
1425   }
1426
1427   // If we're in a function-try-block, we need to store all the catch blocks.
1428   if (kind == tok::kw_try) {
1429     while (Tok.is(tok::kw_catch)) {
1430       ConsumeAndStoreUntil(tok::l_brace, Toks, /*StopAtSemi=*/false);
1431       ConsumeAndStoreUntil(tok::r_brace, Toks, /*StopAtSemi=*/false);
1432     }
1433   }
1434 }