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