blob: 18dcfb25e7d32926b39e1e9ec4419346feac2e10 [file] [log] [blame]
Chris Lattnera3b605e2008-03-09 03:13:06 +00001//===--- MacroExpansion.cpp - Top level Macro Expansion -------------------===//
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 top level handling of macro expasion for the
11// preprocessor.
12//
13//===----------------------------------------------------------------------===//
14
15#include "clang/Lex/Preprocessor.h"
16#include "MacroArgs.h"
17#include "clang/Lex/MacroInfo.h"
18#include "clang/Basic/SourceManager.h"
19#include "clang/Basic/FileManager.h"
Chris Lattner500d3292009-01-29 05:15:15 +000020#include "clang/Lex/LexDiagnostic.h"
Chris Lattner3daed522009-03-02 22:20:04 +000021#include <cstdio>
Chris Lattnerf90a2482008-03-18 05:59:11 +000022#include <ctime>
Chris Lattnera3b605e2008-03-09 03:13:06 +000023using namespace clang;
24
25/// setMacroInfo - Specify a macro for this identifier.
26///
27void Preprocessor::setMacroInfo(IdentifierInfo *II, MacroInfo *MI) {
Chris Lattner555589d2009-04-10 21:17:07 +000028 if (MI) {
Chris Lattnera3b605e2008-03-09 03:13:06 +000029 Macros[II] = MI;
30 II->setHasMacroDefinition(true);
Chris Lattner555589d2009-04-10 21:17:07 +000031 } else if (II->hasMacroDefinition()) {
32 Macros.erase(II);
33 II->setHasMacroDefinition(false);
Chris Lattnera3b605e2008-03-09 03:13:06 +000034 }
35}
36
37/// RegisterBuiltinMacro - Register the specified identifier in the identifier
38/// table and mark it as a builtin macro to be expanded.
39IdentifierInfo *Preprocessor::RegisterBuiltinMacro(const char *Name) {
40 // Get the identifier.
41 IdentifierInfo *Id = getIdentifierInfo(Name);
42
43 // Mark it as being a macro that is builtin.
Ted Kremenek0ea76722008-12-15 19:56:42 +000044 MacroInfo *MI = AllocateMacroInfo(SourceLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +000045 MI->setIsBuiltinMacro();
46 setMacroInfo(Id, MI);
47 return Id;
48}
49
50
51/// RegisterBuiltinMacros - Register builtin macros, such as __LINE__ with the
52/// identifier table.
53void Preprocessor::RegisterBuiltinMacros() {
54 Ident__LINE__ = RegisterBuiltinMacro("__LINE__");
55 Ident__FILE__ = RegisterBuiltinMacro("__FILE__");
56 Ident__DATE__ = RegisterBuiltinMacro("__DATE__");
57 Ident__TIME__ = RegisterBuiltinMacro("__TIME__");
Chris Lattnerc1f9d822009-04-13 01:29:17 +000058 Ident__COUNTER__ = RegisterBuiltinMacro("__COUNTER__");
Chris Lattnera3b605e2008-03-09 03:13:06 +000059 Ident_Pragma = RegisterBuiltinMacro("_Pragma");
60
61 // GCC Extensions.
62 Ident__BASE_FILE__ = RegisterBuiltinMacro("__BASE_FILE__");
63 Ident__INCLUDE_LEVEL__ = RegisterBuiltinMacro("__INCLUDE_LEVEL__");
64 Ident__TIMESTAMP__ = RegisterBuiltinMacro("__TIMESTAMP__");
65}
66
67/// isTrivialSingleTokenExpansion - Return true if MI, which has a single token
68/// in its expansion, currently expands to that token literally.
69static bool isTrivialSingleTokenExpansion(const MacroInfo *MI,
70 const IdentifierInfo *MacroIdent,
71 Preprocessor &PP) {
72 IdentifierInfo *II = MI->getReplacementToken(0).getIdentifierInfo();
73
74 // If the token isn't an identifier, it's always literally expanded.
75 if (II == 0) return true;
76
77 // If the identifier is a macro, and if that macro is enabled, it may be
78 // expanded so it's not a trivial expansion.
79 if (II->hasMacroDefinition() && PP.getMacroInfo(II)->isEnabled() &&
80 // Fast expanding "#define X X" is ok, because X would be disabled.
81 II != MacroIdent)
82 return false;
83
84 // If this is an object-like macro invocation, it is safe to trivially expand
85 // it.
86 if (MI->isObjectLike()) return true;
87
88 // If this is a function-like macro invocation, it's safe to trivially expand
89 // as long as the identifier is not a macro argument.
90 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
91 I != E; ++I)
92 if (*I == II)
93 return false; // Identifier is a macro argument.
94
95 return true;
96}
97
98
99/// isNextPPTokenLParen - Determine whether the next preprocessor token to be
100/// lexed is a '('. If so, consume the token and return true, if not, this
101/// method should have no observable side-effect on the lexed tokens.
102bool Preprocessor::isNextPPTokenLParen() {
103 // Do some quick tests for rejection cases.
104 unsigned Val;
105 if (CurLexer)
106 Val = CurLexer->isNextPPTokenLParen();
Ted Kremenek1a531572008-11-19 22:43:49 +0000107 else if (CurPTHLexer)
108 Val = CurPTHLexer->isNextPPTokenLParen();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000109 else
110 Val = CurTokenLexer->isNextTokenLParen();
111
112 if (Val == 2) {
113 // We have run off the end. If it's a source file we don't
114 // examine enclosing ones (C99 5.1.1.2p4). Otherwise walk up the
115 // macro stack.
Ted Kremenek17ff58a2008-11-19 22:21:33 +0000116 if (CurPPLexer)
Chris Lattnera3b605e2008-03-09 03:13:06 +0000117 return false;
118 for (unsigned i = IncludeMacroStack.size(); i != 0; --i) {
119 IncludeStackInfo &Entry = IncludeMacroStack[i-1];
120 if (Entry.TheLexer)
121 Val = Entry.TheLexer->isNextPPTokenLParen();
Ted Kremenekdd95d6c2008-11-20 16:46:54 +0000122 else if (Entry.ThePTHLexer)
123 Val = Entry.ThePTHLexer->isNextPPTokenLParen();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000124 else
125 Val = Entry.TheTokenLexer->isNextTokenLParen();
126
127 if (Val != 2)
128 break;
129
130 // Ran off the end of a source file?
Ted Kremenekdd95d6c2008-11-20 16:46:54 +0000131 if (Entry.ThePPLexer)
Chris Lattnera3b605e2008-03-09 03:13:06 +0000132 return false;
133 }
134 }
135
136 // Okay, if we know that the token is a '(', lex it and return. Otherwise we
137 // have found something that isn't a '(' or we found the end of the
138 // translation unit. In either case, return false.
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000139 return Val == 1;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000140}
141
142/// HandleMacroExpandedIdentifier - If an identifier token is read that is to be
143/// expanded as a macro, handle it and return the next token as 'Identifier'.
144bool Preprocessor::HandleMacroExpandedIdentifier(Token &Identifier,
145 MacroInfo *MI) {
Chris Lattnerba9eee32009-03-12 17:31:43 +0000146 if (Callbacks) Callbacks->MacroExpands(Identifier, MI);
147
Chris Lattnera3b605e2008-03-09 03:13:06 +0000148 // If this is a macro exapnsion in the "#if !defined(x)" line for the file,
149 // then the macro could expand to different things in other contexts, we need
150 // to disable the optimization in this case.
Ted Kremenek68a91d52008-11-18 01:12:54 +0000151 if (CurPPLexer) CurPPLexer->MIOpt.ExpandedMacro();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000152
153 // If this is a builtin macro, like __LINE__ or _Pragma, handle it specially.
154 if (MI->isBuiltinMacro()) {
155 ExpandBuiltinMacro(Identifier);
156 return false;
157 }
158
159 /// Args - If this is a function-like macro expansion, this contains,
160 /// for each macro argument, the list of tokens that were provided to the
161 /// invocation.
162 MacroArgs *Args = 0;
163
Chris Lattnere7fb4842009-02-15 20:52:18 +0000164 // Remember where the end of the instantiation occurred. For an object-like
165 // macro, this is the identifier. For a function-like macro, this is the ')'.
166 SourceLocation InstantiationEnd = Identifier.getLocation();
167
Chris Lattnera3b605e2008-03-09 03:13:06 +0000168 // If this is a function-like macro, read the arguments.
169 if (MI->isFunctionLike()) {
170 // C99 6.10.3p10: If the preprocessing token immediately after the the macro
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000171 // name isn't a '(', this macro should not be expanded.
Chris Lattnera3b605e2008-03-09 03:13:06 +0000172 if (!isNextPPTokenLParen())
173 return true;
174
175 // Remember that we are now parsing the arguments to a macro invocation.
176 // Preprocessor directives used inside macro arguments are not portable, and
177 // this enables the warning.
178 InMacroArgs = true;
Chris Lattnere7fb4842009-02-15 20:52:18 +0000179 Args = ReadFunctionLikeMacroArgs(Identifier, MI, InstantiationEnd);
Chris Lattnera3b605e2008-03-09 03:13:06 +0000180
181 // Finished parsing args.
182 InMacroArgs = false;
183
184 // If there was an error parsing the arguments, bail out.
185 if (Args == 0) return false;
186
187 ++NumFnMacroExpanded;
188 } else {
189 ++NumMacroExpanded;
190 }
191
192 // Notice that this macro has been used.
193 MI->setIsUsed(true);
194
195 // If we started lexing a macro, enter the macro expansion body.
196
197 // If this macro expands to no tokens, don't bother to push it onto the
198 // expansion stack, only to take it right back off.
199 if (MI->getNumTokens() == 0) {
200 // No need for arg info.
201 if (Args) Args->destroy();
202
203 // Ignore this macro use, just return the next token in the current
204 // buffer.
205 bool HadLeadingSpace = Identifier.hasLeadingSpace();
206 bool IsAtStartOfLine = Identifier.isAtStartOfLine();
207
208 Lex(Identifier);
209
210 // If the identifier isn't on some OTHER line, inherit the leading
211 // whitespace/first-on-a-line property of this token. This handles
212 // stuff like "! XX," -> "! ," and " XX," -> " ,", when XX is
213 // empty.
214 if (!Identifier.isAtStartOfLine()) {
215 if (IsAtStartOfLine) Identifier.setFlag(Token::StartOfLine);
216 if (HadLeadingSpace) Identifier.setFlag(Token::LeadingSpace);
217 }
218 ++NumFastMacroExpanded;
219 return false;
220
221 } else if (MI->getNumTokens() == 1 &&
222 isTrivialSingleTokenExpansion(MI, Identifier.getIdentifierInfo(),
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000223 *this)) {
Chris Lattnera3b605e2008-03-09 03:13:06 +0000224 // Otherwise, if this macro expands into a single trivially-expanded
225 // token: expand it now. This handles common cases like
226 // "#define VAL 42".
Sam Bishop9a4939f2008-03-21 07:13:02 +0000227
228 // No need for arg info.
229 if (Args) Args->destroy();
230
Chris Lattnera3b605e2008-03-09 03:13:06 +0000231 // Propagate the isAtStartOfLine/hasLeadingSpace markers of the macro
232 // identifier to the expanded token.
233 bool isAtStartOfLine = Identifier.isAtStartOfLine();
234 bool hasLeadingSpace = Identifier.hasLeadingSpace();
235
236 // Remember where the token is instantiated.
237 SourceLocation InstantiateLoc = Identifier.getLocation();
238
239 // Replace the result token.
240 Identifier = MI->getReplacementToken(0);
241
242 // Restore the StartOfLine/LeadingSpace markers.
243 Identifier.setFlagValue(Token::StartOfLine , isAtStartOfLine);
244 Identifier.setFlagValue(Token::LeadingSpace, hasLeadingSpace);
245
Chris Lattnerf7cf85b2009-01-16 07:36:28 +0000246 // Update the tokens location to include both its instantiation and physical
Chris Lattnera3b605e2008-03-09 03:13:06 +0000247 // locations.
248 SourceLocation Loc =
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000249 SourceMgr.createInstantiationLoc(Identifier.getLocation(), InstantiateLoc,
Chris Lattnere7fb4842009-02-15 20:52:18 +0000250 InstantiationEnd,Identifier.getLength());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000251 Identifier.setLocation(Loc);
252
253 // If this is #define X X, we must mark the result as unexpandible.
254 if (IdentifierInfo *NewII = Identifier.getIdentifierInfo())
255 if (getMacroInfo(NewII) == MI)
256 Identifier.setFlag(Token::DisableExpand);
257
258 // Since this is not an identifier token, it can't be macro expanded, so
259 // we're done.
260 ++NumFastMacroExpanded;
261 return false;
262 }
263
264 // Start expanding the macro.
Chris Lattnere7fb4842009-02-15 20:52:18 +0000265 EnterMacro(Identifier, InstantiationEnd, Args);
Chris Lattnera3b605e2008-03-09 03:13:06 +0000266
267 // Now that the macro is at the top of the include stack, ask the
268 // preprocessor to read the next token from it.
269 Lex(Identifier);
270 return false;
271}
272
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000273/// ReadFunctionLikeMacroArgs - After reading "MACRO" and knowing that the next
274/// token is the '(' of the macro, this method is invoked to read all of the
275/// actual arguments specified for the macro invocation. This returns null on
276/// error.
Chris Lattnera3b605e2008-03-09 03:13:06 +0000277MacroArgs *Preprocessor::ReadFunctionLikeMacroArgs(Token &MacroName,
Chris Lattnere7fb4842009-02-15 20:52:18 +0000278 MacroInfo *MI,
279 SourceLocation &MacroEnd) {
Chris Lattnera3b605e2008-03-09 03:13:06 +0000280 // The number of fixed arguments to parse.
281 unsigned NumFixedArgsLeft = MI->getNumArgs();
282 bool isVariadic = MI->isVariadic();
283
284 // Outer loop, while there are more arguments, keep reading them.
285 Token Tok;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000286
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000287 // Read arguments as unexpanded tokens. This avoids issues, e.g., where
288 // an argument value in a macro could expand to ',' or '(' or ')'.
289 LexUnexpandedToken(Tok);
290 assert(Tok.is(tok::l_paren) && "Error computing l-paren-ness?");
291
Chris Lattnera3b605e2008-03-09 03:13:06 +0000292 // ArgTokens - Build up a list of tokens that make up each argument. Each
293 // argument is separated by an EOF token. Use a SmallVector so we can avoid
294 // heap allocations in the common case.
295 llvm::SmallVector<Token, 64> ArgTokens;
296
297 unsigned NumActuals = 0;
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000298 while (Tok.isNot(tok::r_paren)) {
299 assert((Tok.is(tok::l_paren) || Tok.is(tok::comma)) &&
300 "only expect argument separators here");
301
302 unsigned ArgTokenStart = ArgTokens.size();
303 SourceLocation ArgStartLoc = Tok.getLocation();
304
Chris Lattnera3b605e2008-03-09 03:13:06 +0000305 // C99 6.10.3p11: Keep track of the number of l_parens we have seen. Note
306 // that we already consumed the first one.
307 unsigned NumParens = 0;
308
309 while (1) {
310 // Read arguments as unexpanded tokens. This avoids issues, e.g., where
311 // an argument value in a macro could expand to ',' or '(' or ')'.
312 LexUnexpandedToken(Tok);
313
314 if (Tok.is(tok::eof) || Tok.is(tok::eom)) { // "#if f(<eof>" & "#if f(\n"
315 Diag(MacroName, diag::err_unterm_macro_invoc);
316 // Do not lose the EOF/EOM. Return it to the client.
317 MacroName = Tok;
318 return 0;
319 } else if (Tok.is(tok::r_paren)) {
320 // If we found the ) token, the macro arg list is done.
Chris Lattnere7fb4842009-02-15 20:52:18 +0000321 if (NumParens-- == 0) {
322 MacroEnd = Tok.getLocation();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000323 break;
Chris Lattnere7fb4842009-02-15 20:52:18 +0000324 }
Chris Lattnera3b605e2008-03-09 03:13:06 +0000325 } else if (Tok.is(tok::l_paren)) {
326 ++NumParens;
327 } else if (Tok.is(tok::comma) && NumParens == 0) {
328 // Comma ends this argument if there are more fixed arguments expected.
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000329 // However, if this is a variadic macro, and this is part of the
330 // variadic part, then the comma is just an argument token.
331 if (!isVariadic) break;
332 if (NumFixedArgsLeft > 1)
Chris Lattnera3b605e2008-03-09 03:13:06 +0000333 break;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000334 } else if (Tok.is(tok::comment) && !KeepMacroComments) {
335 // If this is a comment token in the argument list and we're just in
336 // -C mode (not -CC mode), discard the comment.
337 continue;
Chris Lattner5c497a82009-04-18 06:44:18 +0000338 } else if (Tok.getIdentifierInfo() != 0) {
Chris Lattnera3b605e2008-03-09 03:13:06 +0000339 // Reading macro arguments can cause macros that we are currently
340 // expanding from to be popped off the expansion stack. Doing so causes
341 // them to be reenabled for expansion. Here we record whether any
342 // identifiers we lex as macro arguments correspond to disabled macros.
343 // If so, we mark the token as noexpand. This is a subtle aspect of
344 // C99 6.10.3.4p2.
345 if (MacroInfo *MI = getMacroInfo(Tok.getIdentifierInfo()))
346 if (!MI->isEnabled())
347 Tok.setFlag(Token::DisableExpand);
348 }
Chris Lattnera3b605e2008-03-09 03:13:06 +0000349 ArgTokens.push_back(Tok);
350 }
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000351
352 // If this was an empty argument list foo(), don't add this as an empty
353 // argument.
354 if (ArgTokens.empty() && Tok.getKind() == tok::r_paren)
355 break;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000356
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000357 // If this is not a variadic macro, and too many args were specified, emit
358 // an error.
359 if (!isVariadic && NumFixedArgsLeft == 0) {
360 if (ArgTokens.size() != ArgTokenStart)
361 ArgStartLoc = ArgTokens[ArgTokenStart].getLocation();
362
363 // Emit the diagnostic at the macro name in case there is a missing ).
364 // Emitting it at the , could be far away from the macro name.
365 Diag(ArgStartLoc, diag::err_too_many_args_in_macro_invoc);
366 return 0;
367 }
368
Chris Lattnera3b605e2008-03-09 03:13:06 +0000369 // Empty arguments are standard in C99 and supported as an extension in
370 // other modes.
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000371 if (ArgTokens.size() == ArgTokenStart && !Features.C99)
Chris Lattnera3b605e2008-03-09 03:13:06 +0000372 Diag(Tok, diag::ext_empty_fnmacro_arg);
373
374 // Add a marker EOF token to the end of the token list for this argument.
375 Token EOFTok;
376 EOFTok.startToken();
377 EOFTok.setKind(tok::eof);
Chris Lattnere7689882009-01-26 20:24:53 +0000378 EOFTok.setLocation(Tok.getLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000379 EOFTok.setLength(0);
380 ArgTokens.push_back(EOFTok);
381 ++NumActuals;
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000382 assert(NumFixedArgsLeft != 0 && "Too many arguments parsed");
Chris Lattnera3b605e2008-03-09 03:13:06 +0000383 --NumFixedArgsLeft;
Chris Lattnere7fb4842009-02-15 20:52:18 +0000384 }
Chris Lattnera3b605e2008-03-09 03:13:06 +0000385
386 // Okay, we either found the r_paren. Check to see if we parsed too few
387 // arguments.
388 unsigned MinArgsExpected = MI->getNumArgs();
389
390 // See MacroArgs instance var for description of this.
391 bool isVarargsElided = false;
392
393 if (NumActuals < MinArgsExpected) {
394 // There are several cases where too few arguments is ok, handle them now.
Chris Lattner97e2de12009-04-20 21:08:10 +0000395 if (NumActuals == 0 && MinArgsExpected == 1) {
396 // #define A(X) or #define A(...) ---> A()
397
398 // If there is exactly one argument, and that argument is missing,
399 // then we have an empty "()" argument empty list. This is fine, even if
400 // the macro expects one argument (the argument is just empty).
401 isVarargsElided = MI->isVariadic();
402 } else if (MI->isVariadic() &&
403 (NumActuals+1 == MinArgsExpected || // A(x, ...) -> A(X)
404 (NumActuals == 0 && MinArgsExpected == 2))) {// A(x,...) -> A()
Chris Lattnera3b605e2008-03-09 03:13:06 +0000405 // Varargs where the named vararg parameter is missing: ok as extension.
406 // #define A(x, ...)
407 // A("blah")
408 Diag(Tok, diag::ext_missing_varargs_arg);
409
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000410 // Remember this occurred, allowing us to elide the comma when used for
Chris Lattner63bc0352008-05-08 05:10:33 +0000411 // cases like:
412 // #define A(x, foo...) blah(a, ## foo)
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000413 // #define B(x, ...) blah(a, ## __VA_ARGS__)
414 // #define C(...) blah(a, ## __VA_ARGS__)
415 // A(x) B(x) C()
Chris Lattner97e2de12009-04-20 21:08:10 +0000416 isVarargsElided = true;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000417 } else {
418 // Otherwise, emit the error.
419 Diag(Tok, diag::err_too_few_args_in_macro_invoc);
420 return 0;
421 }
422
423 // Add a marker EOF token to the end of the token list for this argument.
424 SourceLocation EndLoc = Tok.getLocation();
425 Tok.startToken();
426 Tok.setKind(tok::eof);
427 Tok.setLocation(EndLoc);
428 Tok.setLength(0);
429 ArgTokens.push_back(Tok);
Chris Lattner9fc9e772009-05-13 00:55:26 +0000430
431 // If we expect two arguments, add both as empty.
432 if (NumActuals == 0 && MinArgsExpected == 2)
433 ArgTokens.push_back(Tok);
434
Chris Lattner0a4f1b92009-04-18 01:13:56 +0000435 } else if (NumActuals > MinArgsExpected && !MI->isVariadic()) {
436 // Emit the diagnostic at the macro name in case there is a missing ).
437 // Emitting it at the , could be far away from the macro name.
438 Diag(MacroName, diag::err_too_many_args_in_macro_invoc);
439 return 0;
Chris Lattnera3b605e2008-03-09 03:13:06 +0000440 }
441
442 return MacroArgs::create(MI, &ArgTokens[0], ArgTokens.size(),isVarargsElided);
443}
444
445/// ComputeDATE_TIME - Compute the current time, enter it into the specified
446/// scratch buffer, then return DATELoc/TIMELoc locations with the position of
447/// the identifier tokens inserted.
448static void ComputeDATE_TIME(SourceLocation &DATELoc, SourceLocation &TIMELoc,
449 Preprocessor &PP) {
450 time_t TT = time(0);
451 struct tm *TM = localtime(&TT);
452
453 static const char * const Months[] = {
454 "Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"
455 };
456
457 char TmpBuffer[100];
458 sprintf(TmpBuffer, "\"%s %2d %4d\"", Months[TM->tm_mon], TM->tm_mday,
459 TM->tm_year+1900);
Chris Lattner47246be2009-01-26 19:29:26 +0000460
461 Token TmpTok;
462 TmpTok.startToken();
463 PP.CreateString(TmpBuffer, strlen(TmpBuffer), TmpTok);
464 DATELoc = TmpTok.getLocation();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000465
466 sprintf(TmpBuffer, "\"%02d:%02d:%02d\"", TM->tm_hour, TM->tm_min, TM->tm_sec);
Chris Lattner47246be2009-01-26 19:29:26 +0000467 PP.CreateString(TmpBuffer, strlen(TmpBuffer), TmpTok);
468 TIMELoc = TmpTok.getLocation();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000469}
470
471/// ExpandBuiltinMacro - If an identifier token is read that is to be expanded
472/// as a builtin macro, handle it and return the next token as 'Tok'.
473void Preprocessor::ExpandBuiltinMacro(Token &Tok) {
474 // Figure out which token this is.
475 IdentifierInfo *II = Tok.getIdentifierInfo();
476 assert(II && "Can't be a macro without id info!");
477
478 // If this is an _Pragma directive, expand it, invoke the pragma handler, then
479 // lex the token after it.
480 if (II == Ident_Pragma)
481 return Handle_Pragma(Tok);
482
483 ++NumBuiltinMacroExpanded;
484
485 char TmpBuffer[100];
486
487 // Set up the return result.
488 Tok.setIdentifierInfo(0);
489 Tok.clearFlag(Token::NeedsCleaning);
490
491 if (II == Ident__LINE__) {
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000492 // C99 6.10.8: "__LINE__: The presumed line number (within the current
493 // source file) of the current source line (an integer constant)". This can
494 // be affected by #line.
Chris Lattner081927b2009-02-15 21:06:39 +0000495 SourceLocation Loc = Tok.getLocation();
496
Chris Lattnerdff070f2009-04-18 22:29:33 +0000497 // Advance to the location of the first _, this might not be the first byte
498 // of the token if it starts with an escaped newline.
499 Loc = AdvanceToTokenCharacter(Loc, 0);
500
Chris Lattner081927b2009-02-15 21:06:39 +0000501 // One wrinkle here is that GCC expands __LINE__ to location of the *end* of
502 // a macro instantiation. This doesn't matter for object-like macros, but
503 // can matter for a function-like macro that expands to contain __LINE__.
504 // Skip down through instantiation points until we find a file loc for the
505 // end of the instantiation history.
Chris Lattner66781332009-02-15 21:26:50 +0000506 Loc = SourceMgr.getInstantiationRange(Loc).second;
Chris Lattner081927b2009-02-15 21:06:39 +0000507 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Loc);
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000508
Chris Lattner1fa49532009-03-08 08:08:45 +0000509 // __LINE__ expands to a simple numeric value.
510 sprintf(TmpBuffer, "%u", PLoc.getLine());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000511 Tok.setKind(tok::numeric_constant);
Chris Lattner1fa49532009-03-08 08:08:45 +0000512 CreateString(TmpBuffer, strlen(TmpBuffer), Tok, Tok.getLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000513 } else if (II == Ident__FILE__ || II == Ident__BASE_FILE__) {
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000514 // C99 6.10.8: "__FILE__: The presumed name of the current source file (a
515 // character string literal)". This can be affected by #line.
516 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation());
517
518 // __BASE_FILE__ is a GNU extension that returns the top of the presumed
519 // #include stack instead of the current file.
Chris Lattnera3b605e2008-03-09 03:13:06 +0000520 if (II == Ident__BASE_FILE__) {
521 Diag(Tok, diag::ext_pp_base_file);
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000522 SourceLocation NextLoc = PLoc.getIncludeLoc();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000523 while (NextLoc.isValid()) {
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000524 PLoc = SourceMgr.getPresumedLoc(NextLoc);
525 NextLoc = PLoc.getIncludeLoc();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000526 }
527 }
528
529 // Escape this filename. Turn '\' -> '\\' '"' -> '\"'
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000530 std::string FN = PLoc.getFilename();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000531 FN = '"' + Lexer::Stringify(FN) + '"';
532 Tok.setKind(tok::string_literal);
Chris Lattner47246be2009-01-26 19:29:26 +0000533 CreateString(&FN[0], FN.size(), Tok, Tok.getLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000534 } else if (II == Ident__DATE__) {
535 if (!DATELoc.isValid())
536 ComputeDATE_TIME(DATELoc, TIMELoc, *this);
537 Tok.setKind(tok::string_literal);
538 Tok.setLength(strlen("\"Mmm dd yyyy\""));
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000539 Tok.setLocation(SourceMgr.createInstantiationLoc(DATELoc, Tok.getLocation(),
Chris Lattnere7fb4842009-02-15 20:52:18 +0000540 Tok.getLocation(),
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000541 Tok.getLength()));
Chris Lattnera3b605e2008-03-09 03:13:06 +0000542 } else if (II == Ident__TIME__) {
543 if (!TIMELoc.isValid())
544 ComputeDATE_TIME(DATELoc, TIMELoc, *this);
545 Tok.setKind(tok::string_literal);
546 Tok.setLength(strlen("\"hh:mm:ss\""));
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000547 Tok.setLocation(SourceMgr.createInstantiationLoc(TIMELoc, Tok.getLocation(),
Chris Lattnere7fb4842009-02-15 20:52:18 +0000548 Tok.getLocation(),
Chris Lattnerde7aeef2009-01-26 00:43:02 +0000549 Tok.getLength()));
Chris Lattnera3b605e2008-03-09 03:13:06 +0000550 } else if (II == Ident__INCLUDE_LEVEL__) {
551 Diag(Tok, diag::ext_pp_include_level);
552
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000553 // Compute the presumed include depth of this token. This can be affected
554 // by GNU line markers.
Chris Lattnera3b605e2008-03-09 03:13:06 +0000555 unsigned Depth = 0;
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000556
557 PresumedLoc PLoc = SourceMgr.getPresumedLoc(Tok.getLocation());
558 PLoc = SourceMgr.getPresumedLoc(PLoc.getIncludeLoc());
559 for (; PLoc.isValid(); ++Depth)
560 PLoc = SourceMgr.getPresumedLoc(PLoc.getIncludeLoc());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000561
Chris Lattner1fa49532009-03-08 08:08:45 +0000562 // __INCLUDE_LEVEL__ expands to a simple numeric value.
563 sprintf(TmpBuffer, "%u", Depth);
Chris Lattnera3b605e2008-03-09 03:13:06 +0000564 Tok.setKind(tok::numeric_constant);
Chris Lattner1fa49532009-03-08 08:08:45 +0000565 CreateString(TmpBuffer, strlen(TmpBuffer), Tok, Tok.getLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000566 } else if (II == Ident__TIMESTAMP__) {
567 // MSVC, ICC, GCC, VisualAge C++ extension. The generated string should be
568 // of the form "Ddd Mmm dd hh::mm::ss yyyy", which is returned by asctime.
569 Diag(Tok, diag::ext_pp_timestamp);
570
571 // Get the file that we are lexing out of. If we're currently lexing from
572 // a macro, dig into the include stack.
573 const FileEntry *CurFile = 0;
Ted Kremeneka275a192008-11-20 01:35:24 +0000574 PreprocessorLexer *TheLexer = getCurrentFileLexer();
Chris Lattnera3b605e2008-03-09 03:13:06 +0000575
576 if (TheLexer)
Ted Kremenekac80c6e2008-11-19 22:55:25 +0000577 CurFile = SourceMgr.getFileEntryForID(TheLexer->getFileID());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000578
579 // If this file is older than the file it depends on, emit a diagnostic.
580 const char *Result;
581 if (CurFile) {
582 time_t TT = CurFile->getModificationTime();
583 struct tm *TM = localtime(&TT);
584 Result = asctime(TM);
585 } else {
586 Result = "??? ??? ?? ??:??:?? ????\n";
587 }
588 TmpBuffer[0] = '"';
589 strcpy(TmpBuffer+1, Result);
590 unsigned Len = strlen(TmpBuffer);
Chris Lattner1fa49532009-03-08 08:08:45 +0000591 TmpBuffer[Len] = '"'; // Replace the newline with a quote.
Chris Lattnera3b605e2008-03-09 03:13:06 +0000592 Tok.setKind(tok::string_literal);
Chris Lattner47246be2009-01-26 19:29:26 +0000593 CreateString(TmpBuffer, Len+1, Tok, Tok.getLocation());
Chris Lattnerc1f9d822009-04-13 01:29:17 +0000594 } else if (II == Ident__COUNTER__) {
595 Diag(Tok, diag::ext_pp_counter);
596
597 // __COUNTER__ expands to a simple numeric value.
598 sprintf(TmpBuffer, "%u", CounterValue++);
599 Tok.setKind(tok::numeric_constant);
600 CreateString(TmpBuffer, strlen(TmpBuffer), Tok, Tok.getLocation());
Chris Lattnera3b605e2008-03-09 03:13:06 +0000601 } else {
602 assert(0 && "Unknown identifier!");
603 }
604}