contrib/llvm/tools/clang/lib/Lex/TokenLexer.cpp

   1 //===--- TokenLexer.cpp - Lex from a token stream -------------------------===//
   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 the TokenLexer interface.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "clang/Lex/TokenLexer.h"
  15 #include "clang/Basic/SourceManager.h"
  16 #include "clang/Lex/LexDiagnostic.h"
  17 #include "clang/Lex/MacroArgs.h"
  18 #include "clang/Lex/MacroInfo.h"
  19 #include "clang/Lex/Preprocessor.h"
  20 #include "llvm/ADT/SmallString.h"
  21
  22 using namespace clang;
  23
  24 /// Create a TokenLexer for the specified macro with the specified actual
  25 /// arguments.  Note that this ctor takes ownership of the ActualArgs pointer.
  26 void TokenLexer::Init(Token &Tok, SourceLocation ELEnd, MacroInfo *MI,
  27                       MacroArgs *Actuals) {
  28   // If the client is reusing a TokenLexer, make sure to free any memory
  29   // associated with it.
  30   destroy();
  31
  32   Macro = MI;
  33   ActualArgs = Actuals;
  34   CurToken = 0;
  35
  36   ExpandLocStart = Tok.getLocation();
  37   ExpandLocEnd = ELEnd;
  38   AtStartOfLine = Tok.isAtStartOfLine();
  39   HasLeadingSpace = Tok.hasLeadingSpace();
  40   NextTokGetsSpace = false;
  41   Tokens = &*Macro->tokens_begin();
  42   OwnsTokens = false;
  43   DisableMacroExpansion = false;
  44   NumTokens = Macro->tokens_end()-Macro->tokens_begin();
  45   MacroExpansionStart = SourceLocation();
  46
  47   SourceManager &SM = PP.getSourceManager();
  48   MacroStartSLocOffset = SM.getNextLocalOffset();
  49
  50   if (NumTokens > 0) {
  51     assert(Tokens[0].getLocation().isValid());
  52     assert((Tokens[0].getLocation().isFileID() || Tokens[0].is(tok::comment)) &&
  53            "Macro defined in macro?");
  54     assert(ExpandLocStart.isValid());
  55
  56     // Reserve a source location entry chunk for the length of the macro
  57     // definition. Tokens that get lexed directly from the definition will
  58     // have their locations pointing inside this chunk. This is to avoid
  59     // creating separate source location entries for each token.
  60     MacroDefStart = SM.getExpansionLoc(Tokens[0].getLocation());
  61     MacroDefLength = Macro->getDefinitionLength(SM);
  62     MacroExpansionStart = SM.createExpansionLoc(MacroDefStart,
  63                                                 ExpandLocStart,
  64                                                 ExpandLocEnd,
  65                                                 MacroDefLength);
  66   }
  67
  68   // If this is a function-like macro, expand the arguments and change
  69   // Tokens to point to the expanded tokens.
  70   if (Macro->isFunctionLike() && Macro->getNumArgs())
  71     ExpandFunctionArguments();
  72
  73   // Mark the macro as currently disabled, so that it is not recursively
  74   // expanded.  The macro must be disabled only after argument pre-expansion of
  75   // function-like macro arguments occurs.
  76   Macro->DisableMacro();
  77 }
  78
  79 /// Create a TokenLexer for the specified token stream.  This does not
  80 /// take ownership of the specified token vector.
  81 void TokenLexer::Init(const Token *TokArray, unsigned NumToks,
  82                       bool disableMacroExpansion, bool ownsTokens) {
  83   // If the client is reusing a TokenLexer, make sure to free any memory
  84   // associated with it.
  85   destroy();
  86
  87   Macro = nullptr;
  88   ActualArgs = nullptr;
  89   Tokens = TokArray;
  90   OwnsTokens = ownsTokens;
  91   DisableMacroExpansion = disableMacroExpansion;
  92   NumTokens = NumToks;
  93   CurToken = 0;
  94   ExpandLocStart = ExpandLocEnd = SourceLocation();
  95   AtStartOfLine = false;
  96   HasLeadingSpace = false;
  97   NextTokGetsSpace = false;
  98   MacroExpansionStart = SourceLocation();
  99
 100   // Set HasLeadingSpace/AtStartOfLine so that the first token will be
 101   // returned unmodified.
 102   if (NumToks != 0) {
 103     AtStartOfLine   = TokArray[0].isAtStartOfLine();
 104     HasLeadingSpace = TokArray[0].hasLeadingSpace();
 105   }
 106 }
 107
 108 void TokenLexer::destroy() {
 109   // If this was a function-like macro that actually uses its arguments, delete
 110   // the expanded tokens.
 111   if (OwnsTokens) {
 112     delete [] Tokens;
 113     Tokens = nullptr;
 114     OwnsTokens = false;
 115   }
 116
 117   // TokenLexer owns its formal arguments.
 118   if (ActualArgs) ActualArgs->destroy(PP);
 119 }
 120
 121 bool TokenLexer::MaybeRemoveCommaBeforeVaArgs(
 122     SmallVectorImpl<Token> &ResultToks, bool HasPasteOperator, MacroInfo *Macro,
 123     unsigned MacroArgNo, Preprocessor &PP) {
 124   // Is the macro argument __VA_ARGS__?
 125   if (!Macro->isVariadic() || MacroArgNo != Macro->getNumArgs()-1)
 126     return false;
 127
 128   // In Microsoft-compatibility mode, a comma is removed in the expansion
 129   // of " ... , __VA_ARGS__ " if __VA_ARGS__ is empty.  This extension is
 130   // not supported by gcc.
 131   if (!HasPasteOperator && !PP.getLangOpts().MSVCCompat)
 132     return false;
 133
 134   // GCC removes the comma in the expansion of " ... , ## __VA_ARGS__ " if
 135   // __VA_ARGS__ is empty, but not in strict C99 mode where there are no
 136   // named arguments, where it remains.  In all other modes, including C99
 137   // with GNU extensions, it is removed regardless of named arguments.
 138   // Microsoft also appears to support this extension, unofficially.
 139   if (PP.getLangOpts().C99 && !PP.getLangOpts().GNUMode
 140         && Macro->getNumArgs() < 2)
 141     return false;
 142
 143   // Is a comma available to be removed?
 144   if (ResultToks.empty() || !ResultToks.back().is(tok::comma))
 145     return false;
 146
 147   // Issue an extension diagnostic for the paste operator.
 148   if (HasPasteOperator)
 149     PP.Diag(ResultToks.back().getLocation(), diag::ext_paste_comma);
 150
 151   // Remove the comma.
 152   ResultToks.pop_back();
 153
 154   if (!ResultToks.empty()) {
 155     // If the comma was right after another paste (e.g. "X##,##__VA_ARGS__"),
 156     // then removal of the comma should produce a placemarker token (in C99
 157     // terms) which we model by popping off the previous ##, giving us a plain
 158     // "X" when __VA_ARGS__ is empty.
 159     if (ResultToks.back().is(tok::hashhash))
 160       ResultToks.pop_back();
 161
 162     // Remember that this comma was elided.
 163     ResultToks.back().setFlag(Token::CommaAfterElided);
 164   }
 165
 166   // Never add a space, even if the comma, ##, or arg had a space.
 167   NextTokGetsSpace = false;
 168   return true;
 169 }
 170
 171 /// Expand the arguments of a function-like macro so that we can quickly
 172 /// return preexpanded tokens from Tokens.
 173 void TokenLexer::ExpandFunctionArguments() {
 174   SmallVector<Token, 128> ResultToks;
 175
 176   // Loop through 'Tokens', expanding them into ResultToks.  Keep
 177   // track of whether we change anything.  If not, no need to keep them.  If so,
 178   // we install the newly expanded sequence as the new 'Tokens' list.
 179   bool MadeChange = false;
 180
 181   for (unsigned i = 0, e = NumTokens; i != e; ++i) {
 182     // If we found the stringify operator, get the argument stringified.  The
 183     // preprocessor already verified that the following token is a macro name
 184     // when the #define was parsed.
 185     const Token &CurTok = Tokens[i];
 186     if (i != 0 && !Tokens[i-1].is(tok::hashhash) && CurTok.hasLeadingSpace())
 187       NextTokGetsSpace = true;
 188
 189     if (CurTok.isOneOf(tok::hash, tok::hashat)) {
 190       int ArgNo = Macro->getArgumentNum(Tokens[i+1].getIdentifierInfo());
 191       assert(ArgNo != -1 && "Token following # is not an argument?");
 192
 193       SourceLocation ExpansionLocStart =
 194           getExpansionLocForMacroDefLoc(CurTok.getLocation());
 195       SourceLocation ExpansionLocEnd =
 196           getExpansionLocForMacroDefLoc(Tokens[i+1].getLocation());
 197
 198       Token Res;
 199       if (CurTok.is(tok::hash))  // Stringify
 200         Res = ActualArgs->getStringifiedArgument(ArgNo, PP,
 201                                                  ExpansionLocStart,
 202                                                  ExpansionLocEnd);
 203       else {
 204         // 'charify': don't bother caching these.
 205         Res = MacroArgs::StringifyArgument(ActualArgs->getUnexpArgument(ArgNo),
 206                                            PP, true,
 207                                            ExpansionLocStart,
 208                                            ExpansionLocEnd);
 209       }
 210       Res.setFlag(Token::StringifiedInMacro);
 211
 212       // The stringified/charified string leading space flag gets set to match
 213       // the #/#@ operator.
 214       if (NextTokGetsSpace)
 215         Res.setFlag(Token::LeadingSpace);
 216
 217       ResultToks.push_back(Res);
 218       MadeChange = true;
 219       ++i;  // Skip arg name.
 220       NextTokGetsSpace = false;
 221       continue;
 222     }
 223
 224     // Find out if there is a paste (##) operator before or after the token.
 225     bool NonEmptyPasteBefore =
 226       !ResultToks.empty() && ResultToks.back().is(tok::hashhash);
 227     bool PasteBefore = i != 0 && Tokens[i-1].is(tok::hashhash);
 228     bool PasteAfter = i+1 != e && Tokens[i+1].is(tok::hashhash);
 229     assert(!NonEmptyPasteBefore || PasteBefore);
 230
 231     // Otherwise, if this is not an argument token, just add the token to the
 232     // output buffer.
 233     IdentifierInfo *II = CurTok.getIdentifierInfo();
 234     int ArgNo = II ? Macro->getArgumentNum(II) : -1;
 235     if (ArgNo == -1) {
 236       // This isn't an argument, just add it.
 237       ResultToks.push_back(CurTok);
 238
 239       if (NextTokGetsSpace) {
 240         ResultToks.back().setFlag(Token::LeadingSpace);
 241         NextTokGetsSpace = false;
 242       } else if (PasteBefore && !NonEmptyPasteBefore)
 243         ResultToks.back().clearFlag(Token::LeadingSpace);
 244
 245       continue;
 246     }
 247
 248     // An argument is expanded somehow, the result is different than the
 249     // input.
 250     MadeChange = true;
 251
 252     // Otherwise, this is a use of the argument.
 253
 254     // In Microsoft mode, remove the comma before __VA_ARGS__ to ensure there
 255     // are no trailing commas if __VA_ARGS__ is empty.
 256     if (!PasteBefore && ActualArgs->isVarargsElidedUse() &&
 257         MaybeRemoveCommaBeforeVaArgs(ResultToks,
 258                                      /*HasPasteOperator=*/false,
 259                                      Macro, ArgNo, PP))
 260       continue;
 261
 262     // If it is not the LHS/RHS of a ## operator, we must pre-expand the
 263     // argument and substitute the expanded tokens into the result.  This is
 264     // C99 6.10.3.1p1.
 265     if (!PasteBefore && !PasteAfter) {
 266       const Token *ResultArgToks;
 267
 268       // Only preexpand the argument if it could possibly need it.  This
 269       // avoids some work in common cases.
 270       const Token *ArgTok = ActualArgs->getUnexpArgument(ArgNo);
 271       if (ActualArgs->ArgNeedsPreexpansion(ArgTok, PP))
 272         ResultArgToks = &ActualArgs->getPreExpArgument(ArgNo, Macro, PP)[0];
 273       else
 274         ResultArgToks = ArgTok;  // Use non-preexpanded tokens.
 275
 276       // If the arg token expanded into anything, append it.
 277       if (ResultArgToks->isNot(tok::eof)) {
 278         size_t FirstResult = ResultToks.size();
 279         unsigned NumToks = MacroArgs::getArgLength(ResultArgToks);
 280         ResultToks.append(ResultArgToks, ResultArgToks+NumToks);
 281
 282         // In Microsoft-compatibility mode, we follow MSVC's preprocessing
 283         // behavior by not considering single commas from nested macro
 284         // expansions as argument separators. Set a flag on the token so we can
 285         // test for this later when the macro expansion is processed.
 286         if (PP.getLangOpts().MSVCCompat && NumToks == 1 &&
 287             ResultToks.back().is(tok::comma))
 288           ResultToks.back().setFlag(Token::IgnoredComma);
 289
 290         // If the '##' came from expanding an argument, turn it into 'unknown'
 291         // to avoid pasting.
 292         for (Token &Tok : llvm::make_range(ResultToks.begin() + FirstResult,
 293                                            ResultToks.end())) {
 294           if (Tok.is(tok::hashhash))
 295             Tok.setKind(tok::unknown);
 296         }
 297
 298         if(ExpandLocStart.isValid()) {
 299           updateLocForMacroArgTokens(CurTok.getLocation(),
 300                                      ResultToks.begin()+FirstResult,
 301                                      ResultToks.end());
 302         }
 303
 304         // If any tokens were substituted from the argument, the whitespace
 305         // before the first token should match the whitespace of the arg
 306         // identifier.
 307         ResultToks[FirstResult].setFlagValue(Token::LeadingSpace,
 308                                              NextTokGetsSpace);
 309         ResultToks[FirstResult].setFlagValue(Token::StartOfLine, false);
 310         NextTokGetsSpace = false;
 311       }
 312       continue;
 313     }
 314
 315     // Okay, we have a token that is either the LHS or RHS of a paste (##)
 316     // argument.  It gets substituted as its non-pre-expanded tokens.
 317     const Token *ArgToks = ActualArgs->getUnexpArgument(ArgNo);
 318     unsigned NumToks = MacroArgs::getArgLength(ArgToks);
 319     if (NumToks) {  // Not an empty argument?
 320       // If this is the GNU ", ## __VA_ARGS__" extension, and we just learned
 321       // that __VA_ARGS__ expands to multiple tokens, avoid a pasting error when
 322       // the expander trys to paste ',' with the first token of the __VA_ARGS__
 323       // expansion.
 324       if (NonEmptyPasteBefore && ResultToks.size() >= 2 &&
 325           ResultToks[ResultToks.size()-2].is(tok::comma) &&
 326           (unsigned)ArgNo == Macro->getNumArgs()-1 &&
 327           Macro->isVariadic()) {
 328         // Remove the paste operator, report use of the extension.
 329         PP.Diag(ResultToks.pop_back_val().getLocation(), diag::ext_paste_comma);
 330       }
 331
 332       ResultToks.append(ArgToks, ArgToks+NumToks);
 333
 334       // If the '##' came from expanding an argument, turn it into 'unknown'
 335       // to avoid pasting.
 336       for (Token &Tok : llvm::make_range(ResultToks.end() - NumToks,
 337                                          ResultToks.end())) {
 338         if (Tok.is(tok::hashhash))
 339           Tok.setKind(tok::unknown);
 340       }
 341
 342       if (ExpandLocStart.isValid()) {
 343         updateLocForMacroArgTokens(CurTok.getLocation(),
 344                                    ResultToks.end()-NumToks, ResultToks.end());
 345       }
 346
 347       // If this token (the macro argument) was supposed to get leading
 348       // whitespace, transfer this information onto the first token of the
 349       // expansion.
 350       //
 351       // Do not do this if the paste operator occurs before the macro argument,
 352       // as in "A ## MACROARG".  In valid code, the first token will get
 353       // smooshed onto the preceding one anyway (forming AMACROARG).  In
 354       // assembler-with-cpp mode, invalid pastes are allowed through: in this
 355       // case, we do not want the extra whitespace to be added.  For example,
 356       // we want ". ## foo" -> ".foo" not ". foo".
 357       if (NextTokGetsSpace)
 358         ResultToks[ResultToks.size()-NumToks].setFlag(Token::LeadingSpace);
 359
 360       NextTokGetsSpace = false;
 361       continue;
 362     }
 363
 364     // If an empty argument is on the LHS or RHS of a paste, the standard (C99
 365     // 6.10.3.3p2,3) calls for a bunch of placemarker stuff to occur.  We
 366     // implement this by eating ## operators when a LHS or RHS expands to
 367     // empty.
 368     if (PasteAfter) {
 369       // Discard the argument token and skip (don't copy to the expansion
 370       // buffer) the paste operator after it.
 371       ++i;
 372       continue;
 373     }
 374
 375     // If this is on the RHS of a paste operator, we've already copied the
 376     // paste operator to the ResultToks list, unless the LHS was empty too.
 377     // Remove it.
 378     assert(PasteBefore);
 379     if (NonEmptyPasteBefore) {
 380       assert(ResultToks.back().is(tok::hashhash));
 381       ResultToks.pop_back();
 382     }
 383
 384     // If this is the __VA_ARGS__ token, and if the argument wasn't provided,
 385     // and if the macro had at least one real argument, and if the token before
 386     // the ## was a comma, remove the comma.  This is a GCC extension which is
 387     // disabled when using -std=c99.
 388     if (ActualArgs->isVarargsElidedUse())
 389       MaybeRemoveCommaBeforeVaArgs(ResultToks,
 390                                    /*HasPasteOperator=*/true,
 391                                    Macro, ArgNo, PP);
 392   }
 393
 394   // If anything changed, install this as the new Tokens list.
 395   if (MadeChange) {
 396     assert(!OwnsTokens && "This would leak if we already own the token list");
 397     // This is deleted in the dtor.
 398     NumTokens = ResultToks.size();
 399     // The tokens will be added to Preprocessor's cache and will be removed
 400     // when this TokenLexer finishes lexing them.
 401     Tokens = PP.cacheMacroExpandedTokens(this, ResultToks);
 402
 403     // The preprocessor cache of macro expanded tokens owns these tokens,not us.
 404     OwnsTokens = false;
 405   }
 406 }
 407
 408 /// \brief Checks if two tokens form wide string literal.
 409 static bool isWideStringLiteralFromMacro(const Token &FirstTok,
 410                                          const Token &SecondTok) {
 411   return FirstTok.is(tok::identifier) &&
 412          FirstTok.getIdentifierInfo()->isStr("L") && SecondTok.isLiteral() &&
 413          SecondTok.stringifiedInMacro();
 414 }
 415
 416 /// Lex - Lex and return a token from this macro stream.
 417 ///
 418 bool TokenLexer::Lex(Token &Tok) {
 419   // Lexing off the end of the macro, pop this macro off the expansion stack.
 420   if (isAtEnd()) {
 421     // If this is a macro (not a token stream), mark the macro enabled now
 422     // that it is no longer being expanded.
 423     if (Macro) Macro->EnableMacro();
 424
 425     Tok.startToken();
 426     Tok.setFlagValue(Token::StartOfLine , AtStartOfLine);
 427     Tok.setFlagValue(Token::LeadingSpace, HasLeadingSpace || NextTokGetsSpace);
 428     if (CurToken == 0)
 429       Tok.setFlag(Token::LeadingEmptyMacro);
 430     return PP.HandleEndOfTokenLexer(Tok);
 431   }
 432
 433   SourceManager &SM = PP.getSourceManager();
 434
 435   // If this is the first token of the expanded result, we inherit spacing
 436   // properties later.
 437   bool isFirstToken = CurToken == 0;
 438
 439   // Get the next token to return.
 440   Tok = Tokens[CurToken++];
 441
 442   bool TokenIsFromPaste = false;
 443
 444   // If this token is followed by a token paste (##) operator, paste the tokens!
 445   // Note that ## is a normal token when not expanding a macro.
 446   if (!isAtEnd() && Macro &&
 447       (Tokens[CurToken].is(tok::hashhash) ||
 448        // Special processing of L#x macros in -fms-compatibility mode.
 449        // Microsoft compiler is able to form a wide string literal from
 450        // 'L#macro_arg' construct in a function-like macro.
 451        (PP.getLangOpts().MSVCCompat &&
 452         isWideStringLiteralFromMacro(Tok, Tokens[CurToken])))) {
 453     // When handling the microsoft /##/ extension, the final token is
 454     // returned by PasteTokens, not the pasted token.
 455     if (PasteTokens(Tok))
 456       return true;
 457
 458     TokenIsFromPaste = true;
 459   }
 460
 461   // The token's current location indicate where the token was lexed from.  We
 462   // need this information to compute the spelling of the token, but any
 463   // diagnostics for the expanded token should appear as if they came from
 464   // ExpansionLoc.  Pull this information together into a new SourceLocation
 465   // that captures all of this.
 466   if (ExpandLocStart.isValid() &&   // Don't do this for token streams.
 467       // Check that the token's location was not already set properly.
 468       SM.isBeforeInSLocAddrSpace(Tok.getLocation(), MacroStartSLocOffset)) {
 469     SourceLocation instLoc;
 470     if (Tok.is(tok::comment)) {
 471       instLoc = SM.createExpansionLoc(Tok.getLocation(),
 472                                       ExpandLocStart,
 473                                       ExpandLocEnd,
 474                                       Tok.getLength());
 475     } else {
 476       instLoc = getExpansionLocForMacroDefLoc(Tok.getLocation());
 477     }
 478
 479     Tok.setLocation(instLoc);
 480   }
 481
 482   // If this is the first token, set the lexical properties of the token to
 483   // match the lexical properties of the macro identifier.
 484   if (isFirstToken) {
 485     Tok.setFlagValue(Token::StartOfLine , AtStartOfLine);
 486     Tok.setFlagValue(Token::LeadingSpace, HasLeadingSpace);
 487   } else {
 488     // If this is not the first token, we may still need to pass through
 489     // leading whitespace if we've expanded a macro.
 490     if (AtStartOfLine) Tok.setFlag(Token::StartOfLine);
 491     if (HasLeadingSpace) Tok.setFlag(Token::LeadingSpace);
 492   }
 493   AtStartOfLine = false;
 494   HasLeadingSpace = false;
 495
 496   // Handle recursive expansion!
 497   if (!Tok.isAnnotation() && Tok.getIdentifierInfo() != nullptr) {
 498     // Change the kind of this identifier to the appropriate token kind, e.g.
 499     // turning "for" into a keyword.
 500     IdentifierInfo *II = Tok.getIdentifierInfo();
 501     Tok.setKind(II->getTokenID());
 502
 503     // If this identifier was poisoned and from a paste, emit an error.  This
 504     // won't be handled by Preprocessor::HandleIdentifier because this is coming
 505     // from a macro expansion.
 506     if (II->isPoisoned() && TokenIsFromPaste) {
 507       PP.HandlePoisonedIdentifier(Tok);
 508     }
 509
 510     if (!DisableMacroExpansion && II->isHandleIdentifierCase())
 511       return PP.HandleIdentifier(Tok);
 512   }
 513
 514   // Otherwise, return a normal token.
 515   return true;
 516 }
 517
 518 /// PasteTokens - Tok is the LHS of a ## operator, and CurToken is the ##
 519 /// operator.  Read the ## and RHS, and paste the LHS/RHS together.  If there
 520 /// are more ## after it, chomp them iteratively.  Return the result as Tok.
 521 /// If this returns true, the caller should immediately return the token.
 522 bool TokenLexer::PasteTokens(Token &Tok) {
 523   // MSVC: If previous token was pasted, this must be a recovery from an invalid
 524   // paste operation. Ignore spaces before this token to mimic MSVC output.
 525   // Required for generating valid UUID strings in some MS headers.
 526   if (PP.getLangOpts().MicrosoftExt && (CurToken >= 2) &&
 527       Tokens[CurToken - 2].is(tok::hashhash))
 528     Tok.clearFlag(Token::LeadingSpace);
 529
 530   SmallString<128> Buffer;
 531   const char *ResultTokStrPtr = nullptr;
 532   SourceLocation StartLoc = Tok.getLocation();
 533   SourceLocation PasteOpLoc;
 534   do {
 535     // Consume the ## operator if any.
 536     PasteOpLoc = Tokens[CurToken].getLocation();
 537     if (Tokens[CurToken].is(tok::hashhash))
 538       ++CurToken;
 539     assert(!isAtEnd() && "No token on the RHS of a paste operator!");
 540
 541     // Get the RHS token.
 542     const Token &RHS = Tokens[CurToken];
 543
 544     // Allocate space for the result token.  This is guaranteed to be enough for
 545     // the two tokens.
 546     Buffer.resize(Tok.getLength() + RHS.getLength());
 547
 548     // Get the spelling of the LHS token in Buffer.
 549     const char *BufPtr = &Buffer[0];
 550     bool Invalid = false;
 551     unsigned LHSLen = PP.getSpelling(Tok, BufPtr, &Invalid);
 552     if (BufPtr != &Buffer[0])   // Really, we want the chars in Buffer!
 553       memcpy(&Buffer[0], BufPtr, LHSLen);
 554     if (Invalid)
 555       return true;
 556
 557     BufPtr = Buffer.data() + LHSLen;
 558     unsigned RHSLen = PP.getSpelling(RHS, BufPtr, &Invalid);
 559     if (Invalid)
 560       return true;
 561     if (RHSLen && BufPtr != &Buffer[LHSLen])
 562       // Really, we want the chars in Buffer!
 563       memcpy(&Buffer[LHSLen], BufPtr, RHSLen);
 564
 565     // Trim excess space.
 566     Buffer.resize(LHSLen+RHSLen);
 567
 568     // Plop the pasted result (including the trailing newline and null) into a
 569     // scratch buffer where we can lex it.
 570     Token ResultTokTmp;
 571     ResultTokTmp.startToken();
 572
 573     // Claim that the tmp token is a string_literal so that we can get the
 574     // character pointer back from CreateString in getLiteralData().
 575     ResultTokTmp.setKind(tok::string_literal);
 576     PP.CreateString(Buffer, ResultTokTmp);
 577     SourceLocation ResultTokLoc = ResultTokTmp.getLocation();
 578     ResultTokStrPtr = ResultTokTmp.getLiteralData();
 579
 580     // Lex the resultant pasted token into Result.
 581     Token Result;
 582
 583     if (Tok.isAnyIdentifier() && RHS.isAnyIdentifier()) {
 584       // Common paste case: identifier+identifier = identifier.  Avoid creating
 585       // a lexer and other overhead.
 586       PP.IncrementPasteCounter(true);
 587       Result.startToken();
 588       Result.setKind(tok::raw_identifier);
 589       Result.setRawIdentifierData(ResultTokStrPtr);
 590       Result.setLocation(ResultTokLoc);
 591       Result.setLength(LHSLen+RHSLen);
 592     } else {
 593       PP.IncrementPasteCounter(false);
 594
 595       assert(ResultTokLoc.isFileID() &&
 596              "Should be a raw location into scratch buffer");
 597       SourceManager &SourceMgr = PP.getSourceManager();
 598       FileID LocFileID = SourceMgr.getFileID(ResultTokLoc);
 599
 600       bool Invalid = false;
 601       const char *ScratchBufStart
 602         = SourceMgr.getBufferData(LocFileID, &Invalid).data();
 603       if (Invalid)
 604         return false;
 605
 606       // Make a lexer to lex this string from.  Lex just this one token.
 607       // Make a lexer object so that we lex and expand the paste result.
 608       Lexer TL(SourceMgr.getLocForStartOfFile(LocFileID),
 609                PP.getLangOpts(), ScratchBufStart,
 610                ResultTokStrPtr, ResultTokStrPtr+LHSLen+RHSLen);
 611
 612       // Lex a token in raw mode.  This way it won't look up identifiers
 613       // automatically, lexing off the end will return an eof token, and
 614       // warnings are disabled.  This returns true if the result token is the
 615       // entire buffer.
 616       bool isInvalid = !TL.LexFromRawLexer(Result);
 617
 618       // If we got an EOF token, we didn't form even ONE token.  For example, we
 619       // did "/ ## /" to get "//".
 620       isInvalid |= Result.is(tok::eof);
 621
 622       // If pasting the two tokens didn't form a full new token, this is an
 623       // error.  This occurs with "x ## +"  and other stuff.  Return with Tok
 624       // unmodified and with RHS as the next token to lex.
 625       if (isInvalid) {
 626         // Explicitly convert the token location to have proper expansion
 627         // information so that the user knows where it came from.
 628         SourceManager &SM = PP.getSourceManager();
 629         SourceLocation Loc =
 630           SM.createExpansionLoc(PasteOpLoc, ExpandLocStart, ExpandLocEnd, 2);
 631
 632         // Test for the Microsoft extension of /##/ turning into // here on the
 633         // error path.
 634         if (PP.getLangOpts().MicrosoftExt && Tok.is(tok::slash) &&
 635             RHS.is(tok::slash)) {
 636           HandleMicrosoftCommentPaste(Tok, Loc);
 637           return true;
 638         }
 639
 640         // Do not emit the error when preprocessing assembler code.
 641         if (!PP.getLangOpts().AsmPreprocessor) {
 642           // If we're in microsoft extensions mode, downgrade this from a hard
 643           // error to an extension that defaults to an error.  This allows
 644           // disabling it.
 645           PP.Diag(Loc, PP.getLangOpts().MicrosoftExt ? diag::ext_pp_bad_paste_ms
 646                                                      : diag::err_pp_bad_paste)
 647               << Buffer;
 648         }
 649
 650         // An error has occurred so exit loop.
 651         break;
 652       }
 653
 654       // Turn ## into 'unknown' to avoid # ## # from looking like a paste
 655       // operator.
 656       if (Result.is(tok::hashhash))
 657         Result.setKind(tok::unknown);
 658     }
 659
 660     // Transfer properties of the LHS over the Result.
 661     Result.setFlagValue(Token::StartOfLine , Tok.isAtStartOfLine());
 662     Result.setFlagValue(Token::LeadingSpace, Tok.hasLeadingSpace());
 663
 664     // Finally, replace LHS with the result, consume the RHS, and iterate.
 665     ++CurToken;
 666     Tok = Result;
 667   } while (!isAtEnd() && Tokens[CurToken].is(tok::hashhash));
 668
 669   SourceLocation EndLoc = Tokens[CurToken - 1].getLocation();
 670
 671   // The token's current location indicate where the token was lexed from.  We
 672   // need this information to compute the spelling of the token, but any
 673   // diagnostics for the expanded token should appear as if the token was
 674   // expanded from the full ## expression. Pull this information together into
 675   // a new SourceLocation that captures all of this.
 676   SourceManager &SM = PP.getSourceManager();
 677   if (StartLoc.isFileID())
 678     StartLoc = getExpansionLocForMacroDefLoc(StartLoc);
 679   if (EndLoc.isFileID())
 680     EndLoc = getExpansionLocForMacroDefLoc(EndLoc);
 681   FileID MacroFID = SM.getFileID(MacroExpansionStart);
 682   while (SM.getFileID(StartLoc) != MacroFID)
 683     StartLoc = SM.getImmediateExpansionRange(StartLoc).first;
 684   while (SM.getFileID(EndLoc) != MacroFID)
 685     EndLoc = SM.getImmediateExpansionRange(EndLoc).second;
 686
 687   Tok.setLocation(SM.createExpansionLoc(Tok.getLocation(), StartLoc, EndLoc,
 688                                         Tok.getLength()));
 689
 690   // Now that we got the result token, it will be subject to expansion.  Since
 691   // token pasting re-lexes the result token in raw mode, identifier information
 692   // isn't looked up.  As such, if the result is an identifier, look up id info.
 693   if (Tok.is(tok::raw_identifier)) {
 694     // Look up the identifier info for the token.  We disabled identifier lookup
 695     // by saying we're skipping contents, so we need to do this manually.
 696     PP.LookUpIdentifierInfo(Tok);
 697   }
 698   return false;
 699 }
 700
 701 /// isNextTokenLParen - If the next token lexed will pop this macro off the
 702 /// expansion stack, return 2.  If the next unexpanded token is a '(', return
 703 /// 1, otherwise return 0.
 704 unsigned TokenLexer::isNextTokenLParen() const {
 705   // Out of tokens?
 706   if (isAtEnd())
 707     return 2;
 708   return Tokens[CurToken].is(tok::l_paren);
 709 }
 710
 711 /// isParsingPreprocessorDirective - Return true if we are in the middle of a
 712 /// preprocessor directive.
 713 bool TokenLexer::isParsingPreprocessorDirective() const {
 714   return Tokens[NumTokens-1].is(tok::eod) && !isAtEnd();
 715 }
 716
 717 /// HandleMicrosoftCommentPaste - In microsoft compatibility mode, /##/ pastes
 718 /// together to form a comment that comments out everything in the current
 719 /// macro, other active macros, and anything left on the current physical
 720 /// source line of the expanded buffer.  Handle this by returning the
 721 /// first token on the next line.
 722 void TokenLexer::HandleMicrosoftCommentPaste(Token &Tok, SourceLocation OpLoc) {
 723   PP.Diag(OpLoc, diag::ext_comment_paste_microsoft);
 724
 725   // We 'comment out' the rest of this macro by just ignoring the rest of the
 726   // tokens that have not been lexed yet, if any.
 727
 728   // Since this must be a macro, mark the macro enabled now that it is no longer
 729   // being expanded.
 730   assert(Macro && "Token streams can't paste comments");
 731   Macro->EnableMacro();
 732
 733   PP.HandleMicrosoftCommentPaste(Tok);
 734 }
 735
 736 /// \brief If \arg loc is a file ID and points inside the current macro
 737 /// definition, returns the appropriate source location pointing at the
 738 /// macro expansion source location entry, otherwise it returns an invalid
 739 /// SourceLocation.
 740 SourceLocation
 741 TokenLexer::getExpansionLocForMacroDefLoc(SourceLocation loc) const {
 742   assert(ExpandLocStart.isValid() && MacroExpansionStart.isValid() &&
 743          "Not appropriate for token streams");
 744   assert(loc.isValid() && loc.isFileID());
 745
 746   SourceManager &SM = PP.getSourceManager();
 747   assert(SM.isInSLocAddrSpace(loc, MacroDefStart, MacroDefLength) &&
 748          "Expected loc to come from the macro definition");
 749
 750   unsigned relativeOffset = 0;
 751   SM.isInSLocAddrSpace(loc, MacroDefStart, MacroDefLength, &relativeOffset);
 752   return MacroExpansionStart.getLocWithOffset(relativeOffset);
 753 }
 754
 755 /// \brief Finds the tokens that are consecutive (from the same FileID)
 756 /// creates a single SLocEntry, and assigns SourceLocations to each token that
 757 /// point to that SLocEntry. e.g for
 758 ///   assert(foo == bar);
 759 /// There will be a single SLocEntry for the "foo == bar" chunk and locations
 760 /// for the 'foo', '==', 'bar' tokens will point inside that chunk.
 761 ///
 762 /// \arg begin_tokens will be updated to a position past all the found
 763 /// consecutive tokens.
 764 static void updateConsecutiveMacroArgTokens(SourceManager &SM,
 765                                             SourceLocation InstLoc,
 766                                             Token *&begin_tokens,
 767                                             Token * end_tokens) {
 768   assert(begin_tokens < end_tokens);
 769
 770   SourceLocation FirstLoc = begin_tokens->getLocation();
 771   SourceLocation CurLoc = FirstLoc;
 772
 773   // Compare the source location offset of tokens and group together tokens that
 774   // are close, even if their locations point to different FileIDs. e.g.
 775   //
 776   //  |bar    |  foo | cake   |  (3 tokens from 3 consecutive FileIDs)
 777   //  ^                    ^
 778   //  |bar       foo   cake|     (one SLocEntry chunk for all tokens)
 779   //
 780   // we can perform this "merge" since the token's spelling location depends
 781   // on the relative offset.
 782
 783   Token *NextTok = begin_tokens + 1;
 784   for (; NextTok < end_tokens; ++NextTok) {
 785     SourceLocation NextLoc = NextTok->getLocation();
 786     if (CurLoc.isFileID() != NextLoc.isFileID())
 787       break; // Token from different kind of FileID.
 788
 789     int RelOffs;
 790     if (!SM.isInSameSLocAddrSpace(CurLoc, NextLoc, &RelOffs))
 791       break; // Token from different local/loaded location.
 792     // Check that token is not before the previous token or more than 50
 793     // "characters" away.
 794     if (RelOffs < 0 || RelOffs > 50)
 795       break;
 796
 797     if (CurLoc.isMacroID() && !SM.isWrittenInSameFile(CurLoc, NextLoc))
 798       break; // Token from a different macro.
 799
 800     CurLoc = NextLoc;
 801   }
 802
 803   // For the consecutive tokens, find the length of the SLocEntry to contain
 804   // all of them.
 805   Token &LastConsecutiveTok = *(NextTok-1);
 806   int LastRelOffs = 0;
 807   SM.isInSameSLocAddrSpace(FirstLoc, LastConsecutiveTok.getLocation(),
 808                            &LastRelOffs);
 809   unsigned FullLength = LastRelOffs + LastConsecutiveTok.getLength();
 810
 811   // Create a macro expansion SLocEntry that will "contain" all of the tokens.
 812   SourceLocation Expansion =
 813       SM.createMacroArgExpansionLoc(FirstLoc, InstLoc,FullLength);
 814
 815   // Change the location of the tokens from the spelling location to the new
 816   // expanded location.
 817   for (; begin_tokens < NextTok; ++begin_tokens) {
 818     Token &Tok = *begin_tokens;
 819     int RelOffs = 0;
 820     SM.isInSameSLocAddrSpace(FirstLoc, Tok.getLocation(), &RelOffs);
 821     Tok.setLocation(Expansion.getLocWithOffset(RelOffs));
 822   }
 823 }
 824
 825 /// \brief Creates SLocEntries and updates the locations of macro argument
 826 /// tokens to their new expanded locations.
 827 ///
 828 /// \param ArgIdDefLoc the location of the macro argument id inside the macro
 829 /// definition.
 830 /// \param Tokens the macro argument tokens to update.
 831 void TokenLexer::updateLocForMacroArgTokens(SourceLocation ArgIdSpellLoc,
 832                                             Token *begin_tokens,
 833                                             Token *end_tokens) {
 834   SourceManager &SM = PP.getSourceManager();
 835
 836   SourceLocation InstLoc =
 837       getExpansionLocForMacroDefLoc(ArgIdSpellLoc);
 838
 839   while (begin_tokens < end_tokens) {
 840     // If there's only one token just create a SLocEntry for it.
 841     if (end_tokens - begin_tokens == 1) {
 842       Token &Tok = *begin_tokens;
 843       Tok.setLocation(SM.createMacroArgExpansionLoc(Tok.getLocation(),
 844                                                     InstLoc,
 845                                                     Tok.getLength()));
 846       return;
 847     }
 848
 849     updateConsecutiveMacroArgTokens(SM, InstLoc, begin_tokens, end_tokens);
 850   }
 851 }
 852
 853 void TokenLexer::PropagateLineStartLeadingSpaceInfo(Token &Result) {
 854   AtStartOfLine = Result.isAtStartOfLine();
 855   HasLeadingSpace = Result.hasLeadingSpace();
 856 }