blob: 3357791b6cb617fad93d94c0a65e2fffa1a54304 [file] [log] [blame]
Chris Lattner4b009652007-07-25 00:24:17 +00001//===--- Preprocess.cpp - C Language Family Preprocessor Implementation ---===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner959e5be2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner4b009652007-07-25 00:24:17 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the Preprocessor interface.
11//
12//===----------------------------------------------------------------------===//
13//
14// Options to support:
15// -H - Print the name of each header file used.
16// -d[MDNI] - Dump various things.
17// -fworking-directory - #line's with preprocessor's working dir.
18// -fpreprocessed
19// -dependency-file,-M,-MM,-MF,-MG,-MP,-MT,-MQ,-MD,-MMD
20// -W*
21// -w
22//
23// Messages to emit:
24// "Multiple include guards may be useful for:\n"
25//
26//===----------------------------------------------------------------------===//
27
28#include "clang/Lex/Preprocessor.h"
29#include "clang/Lex/HeaderSearch.h"
30#include "clang/Lex/MacroInfo.h"
Chris Lattner4b009652007-07-25 00:24:17 +000031#include "clang/Lex/Pragma.h"
32#include "clang/Lex/ScratchBuffer.h"
33#include "clang/Basic/Diagnostic.h"
Chris Lattner4b009652007-07-25 00:24:17 +000034#include "clang/Basic/SourceManager.h"
35#include "clang/Basic/TargetInfo.h"
Chris Lattnercbed2992008-10-05 20:40:30 +000036#include "llvm/ADT/APFloat.h"
Chris Lattner4b009652007-07-25 00:24:17 +000037#include "llvm/ADT/SmallVector.h"
38#include "llvm/Support/MemoryBuffer.h"
Ted Kremenekce4c64e2008-01-14 16:44:48 +000039#include "llvm/Support/Streams.h"
Chris Lattner4b009652007-07-25 00:24:17 +000040using namespace clang;
41
42//===----------------------------------------------------------------------===//
43
Ted Kremenek5ab36b02008-04-17 21:23:07 +000044PreprocessorFactory::~PreprocessorFactory() {}
45
Chris Lattner4b009652007-07-25 00:24:17 +000046Preprocessor::Preprocessor(Diagnostic &diags, const LangOptions &opts,
47 TargetInfo &target, SourceManager &SM,
48 HeaderSearch &Headers)
49 : Diags(diags), Features(opts), Target(target), FileMgr(Headers.getFileMgr()),
50 SourceMgr(SM), HeaderInfo(Headers), Identifiers(opts),
Chris Lattner5b54ed92008-03-09 02:26:03 +000051 CurLexer(0), CurDirLookup(0), CurTokenLexer(0), Callbacks(0) {
Chris Lattner4b009652007-07-25 00:24:17 +000052 ScratchBuf = new ScratchBuffer(SourceMgr);
53
54 // Clear stats.
55 NumDirectives = NumDefined = NumUndefined = NumPragma = 0;
56 NumIf = NumElse = NumEndif = 0;
57 NumEnteredSourceFiles = 0;
58 NumMacroExpanded = NumFnMacroExpanded = NumBuiltinMacroExpanded = 0;
59 NumFastMacroExpanded = NumTokenPaste = NumFastTokenPaste = 0;
60 MaxIncludeStackDepth = 0;
61 NumSkipped = 0;
62
63 // Default to discarding comments.
64 KeepComments = false;
65 KeepMacroComments = false;
66
67 // Macro expansion is enabled.
68 DisableMacroExpansion = false;
69 InMacroArgs = false;
Chris Lattner5b54ed92008-03-09 02:26:03 +000070 NumCachedTokenLexers = 0;
Chris Lattner4b009652007-07-25 00:24:17 +000071
Argiris Kirtzidisf55b1102008-08-10 13:15:22 +000072 CacheTokens = false;
73 CachedLexPos = 0;
74
Chris Lattner4b009652007-07-25 00:24:17 +000075 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
76 // This gets unpoisoned where it is allowed.
77 (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned();
78
79 // Initialize the pragma handlers.
80 PragmaHandlers = new PragmaNamespace(0);
81 RegisterBuiltinPragmas();
82
83 // Initialize builtin macros like __LINE__ and friends.
84 RegisterBuiltinMacros();
85}
86
87Preprocessor::~Preprocessor() {
Argiris Kirtzidis1370cf12008-08-23 12:12:06 +000088 assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!");
89
Chris Lattner4b009652007-07-25 00:24:17 +000090 while (!IncludeMacroStack.empty()) {
91 delete IncludeMacroStack.back().TheLexer;
Chris Lattner5b54ed92008-03-09 02:26:03 +000092 delete IncludeMacroStack.back().TheTokenLexer;
Chris Lattner4b009652007-07-25 00:24:17 +000093 IncludeMacroStack.pop_back();
94 }
Chris Lattner7a1b0882007-10-07 08:44:20 +000095
96 // Free any macro definitions.
97 for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I =
98 Macros.begin(), E = Macros.end(); I != E; ++I) {
99 // Free the macro definition.
100 delete I->second;
101 I->second = 0;
102 I->first->setHasMacroDefinition(false);
103 }
Chris Lattner4b009652007-07-25 00:24:17 +0000104
105 // Free any cached macro expanders.
Chris Lattner5b54ed92008-03-09 02:26:03 +0000106 for (unsigned i = 0, e = NumCachedTokenLexers; i != e; ++i)
107 delete TokenLexerCache[i];
Chris Lattner4b009652007-07-25 00:24:17 +0000108
109 // Release pragma information.
110 delete PragmaHandlers;
111
112 // Delete the scratch buffer info.
113 delete ScratchBuf;
Chris Lattner65829812008-03-14 06:07:05 +0000114
115 delete Callbacks;
Chris Lattner4b009652007-07-25 00:24:17 +0000116}
117
Chris Lattner4b009652007-07-25 00:24:17 +0000118/// Diag - Forwarding function for diagnostics. This emits a diagnostic at
119/// the specified Token's location, translating the token's start
120/// position in the current buffer into a SourcePosition object for rendering.
121void Preprocessor::Diag(SourceLocation Loc, unsigned DiagID) {
Ted Kremenekd7f64cd2007-12-12 22:39:36 +0000122 Diags.Report(getFullLoc(Loc), DiagID);
Chris Lattner4b009652007-07-25 00:24:17 +0000123}
124
125void Preprocessor::Diag(SourceLocation Loc, unsigned DiagID,
126 const std::string &Msg) {
Chris Lattner6948ae62008-11-18 07:04:44 +0000127 Diags.Report(getFullLoc(Loc), DiagID) << Msg;
Chris Lattner4b009652007-07-25 00:24:17 +0000128}
129
Chris Lattnerbef45c52008-05-05 06:45:50 +0000130void Preprocessor::Diag(SourceLocation Loc, unsigned DiagID,
131 const std::string &Msg,
132 const SourceRange &R1, const SourceRange &R2) {
Chris Lattner6948ae62008-11-18 07:04:44 +0000133 Diags.Report(getFullLoc(Loc), DiagID) << Msg << R1 << R2;
Chris Lattnerbef45c52008-05-05 06:45:50 +0000134}
135
136
137void Preprocessor::Diag(SourceLocation Loc, unsigned DiagID,
138 const SourceRange &R) {
Chris Lattner6948ae62008-11-18 07:04:44 +0000139 Diags.Report(getFullLoc(Loc), DiagID) << R;
Chris Lattnerbef45c52008-05-05 06:45:50 +0000140}
141
142void Preprocessor::Diag(SourceLocation Loc, unsigned DiagID,
143 const SourceRange &R1, const SourceRange &R2) {
Chris Lattner6948ae62008-11-18 07:04:44 +0000144 Diags.Report(getFullLoc(Loc), DiagID) << R1 << R2;
Chris Lattnerbef45c52008-05-05 06:45:50 +0000145}
146
147
Chris Lattner4b009652007-07-25 00:24:17 +0000148void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const {
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000149 llvm::cerr << tok::getTokenName(Tok.getKind()) << " '"
150 << getSpelling(Tok) << "'";
Chris Lattner4b009652007-07-25 00:24:17 +0000151
152 if (!DumpFlags) return;
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000153
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000154 llvm::cerr << "\t";
Chris Lattner4b009652007-07-25 00:24:17 +0000155 if (Tok.isAtStartOfLine())
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000156 llvm::cerr << " [StartOfLine]";
Chris Lattner4b009652007-07-25 00:24:17 +0000157 if (Tok.hasLeadingSpace())
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000158 llvm::cerr << " [LeadingSpace]";
Chris Lattner4b009652007-07-25 00:24:17 +0000159 if (Tok.isExpandDisabled())
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000160 llvm::cerr << " [ExpandDisabled]";
Chris Lattner4b009652007-07-25 00:24:17 +0000161 if (Tok.needsCleaning()) {
162 const char *Start = SourceMgr.getCharacterData(Tok.getLocation());
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000163 llvm::cerr << " [UnClean='" << std::string(Start, Start+Tok.getLength())
164 << "']";
Chris Lattner4b009652007-07-25 00:24:17 +0000165 }
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000166
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000167 llvm::cerr << "\tLoc=<";
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000168 DumpLocation(Tok.getLocation());
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000169 llvm::cerr << ">";
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000170}
171
172void Preprocessor::DumpLocation(SourceLocation Loc) const {
173 SourceLocation LogLoc = SourceMgr.getLogicalLoc(Loc);
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000174 llvm::cerr << SourceMgr.getSourceName(LogLoc) << ':'
175 << SourceMgr.getLineNumber(LogLoc) << ':'
Ted Kremenek79882742008-07-19 19:10:04 +0000176 << SourceMgr.getColumnNumber(LogLoc);
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000177
178 SourceLocation PhysLoc = SourceMgr.getPhysicalLoc(Loc);
179 if (PhysLoc != LogLoc) {
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000180 llvm::cerr << " <PhysLoc=";
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000181 DumpLocation(PhysLoc);
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000182 llvm::cerr << ">";
Chris Lattnerc0f7c512007-12-09 20:31:55 +0000183 }
Chris Lattner4b009652007-07-25 00:24:17 +0000184}
185
186void Preprocessor::DumpMacro(const MacroInfo &MI) const {
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000187 llvm::cerr << "MACRO: ";
Chris Lattner4b009652007-07-25 00:24:17 +0000188 for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) {
189 DumpToken(MI.getReplacementToken(i));
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000190 llvm::cerr << " ";
Chris Lattner4b009652007-07-25 00:24:17 +0000191 }
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000192 llvm::cerr << "\n";
Chris Lattner4b009652007-07-25 00:24:17 +0000193}
194
195void Preprocessor::PrintStats() {
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000196 llvm::cerr << "\n*** Preprocessor Stats:\n";
197 llvm::cerr << NumDirectives << " directives found:\n";
198 llvm::cerr << " " << NumDefined << " #define.\n";
199 llvm::cerr << " " << NumUndefined << " #undef.\n";
200 llvm::cerr << " #include/#include_next/#import:\n";
201 llvm::cerr << " " << NumEnteredSourceFiles << " source files entered.\n";
202 llvm::cerr << " " << MaxIncludeStackDepth << " max include stack depth\n";
203 llvm::cerr << " " << NumIf << " #if/#ifndef/#ifdef.\n";
204 llvm::cerr << " " << NumElse << " #else/#elif.\n";
205 llvm::cerr << " " << NumEndif << " #endif.\n";
206 llvm::cerr << " " << NumPragma << " #pragma.\n";
207 llvm::cerr << NumSkipped << " #if/#ifndef#ifdef regions skipped\n";
Chris Lattner4b009652007-07-25 00:24:17 +0000208
Ted Kremenekce4c64e2008-01-14 16:44:48 +0000209 llvm::cerr << NumMacroExpanded << "/" << NumFnMacroExpanded << "/"
210 << NumBuiltinMacroExpanded << " obj/fn/builtin macros expanded, "
211 << NumFastMacroExpanded << " on the fast path.\n";
212 llvm::cerr << (NumFastTokenPaste+NumTokenPaste)
213 << " token paste (##) operations performed, "
214 << NumFastTokenPaste << " on the fast path.\n";
Chris Lattner4b009652007-07-25 00:24:17 +0000215}
216
217//===----------------------------------------------------------------------===//
218// Token Spelling
219//===----------------------------------------------------------------------===//
220
221
222/// getSpelling() - Return the 'spelling' of this token. The spelling of a
223/// token are the characters used to represent the token in the source file
224/// after trigraph expansion and escaped-newline folding. In particular, this
225/// wants to get the true, uncanonicalized, spelling of things like digraphs
226/// UCNs, etc.
227std::string Preprocessor::getSpelling(const Token &Tok) const {
228 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
229
230 // If this token contains nothing interesting, return it directly.
231 const char *TokStart = SourceMgr.getCharacterData(Tok.getLocation());
232 if (!Tok.needsCleaning())
233 return std::string(TokStart, TokStart+Tok.getLength());
234
235 std::string Result;
236 Result.reserve(Tok.getLength());
237
238 // Otherwise, hard case, relex the characters into the string.
239 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
240 Ptr != End; ) {
241 unsigned CharSize;
242 Result.push_back(Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features));
243 Ptr += CharSize;
244 }
245 assert(Result.size() != unsigned(Tok.getLength()) &&
246 "NeedsCleaning flag set on something that didn't need cleaning!");
247 return Result;
248}
249
250/// getSpelling - This method is used to get the spelling of a token into a
251/// preallocated buffer, instead of as an std::string. The caller is required
252/// to allocate enough space for the token, which is guaranteed to be at least
253/// Tok.getLength() bytes long. The actual length of the token is returned.
254///
255/// Note that this method may do two possible things: it may either fill in
256/// the buffer specified with characters, or it may *change the input pointer*
257/// to point to a constant buffer with the data already in it (avoiding a
258/// copy). The caller is not allowed to modify the returned buffer pointer
259/// if an internal buffer is returned.
260unsigned Preprocessor::getSpelling(const Token &Tok,
261 const char *&Buffer) const {
262 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
263
264 // If this token is an identifier, just return the string from the identifier
265 // table, which is very quick.
266 if (const IdentifierInfo *II = Tok.getIdentifierInfo()) {
267 Buffer = II->getName();
268
269 // Return the length of the token. If the token needed cleaning, don't
270 // include the size of the newlines or trigraphs in it.
271 if (!Tok.needsCleaning())
272 return Tok.getLength();
273 else
274 return strlen(Buffer);
275 }
276
277 // Otherwise, compute the start of the token in the input lexer buffer.
278 const char *TokStart = SourceMgr.getCharacterData(Tok.getLocation());
279
280 // If this token contains nothing interesting, return it directly.
281 if (!Tok.needsCleaning()) {
282 Buffer = TokStart;
283 return Tok.getLength();
284 }
285 // Otherwise, hard case, relex the characters into the string.
286 char *OutBuf = const_cast<char*>(Buffer);
287 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
288 Ptr != End; ) {
289 unsigned CharSize;
290 *OutBuf++ = Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features);
291 Ptr += CharSize;
292 }
293 assert(unsigned(OutBuf-Buffer) != Tok.getLength() &&
294 "NeedsCleaning flag set on something that didn't need cleaning!");
295
296 return OutBuf-Buffer;
297}
298
299
300/// CreateString - Plop the specified string into a scratch buffer and return a
301/// location for it. If specified, the source location provides a source
302/// location for the token.
303SourceLocation Preprocessor::
304CreateString(const char *Buf, unsigned Len, SourceLocation SLoc) {
305 if (SLoc.isValid())
306 return ScratchBuf->getToken(Buf, Len, SLoc);
307 return ScratchBuf->getToken(Buf, Len);
308}
309
310
311/// AdvanceToTokenCharacter - Given a location that specifies the start of a
312/// token, return a new location that specifies a character within the token.
313SourceLocation Preprocessor::AdvanceToTokenCharacter(SourceLocation TokStart,
314 unsigned CharNo) {
315 // If they request the first char of the token, we're trivially done. If this
316 // is a macro expansion, it doesn't make sense to point to a character within
317 // the instantiation point (the name). We could point to the source
318 // character, but without also pointing to instantiation info, this is
319 // confusing.
320 if (CharNo == 0 || TokStart.isMacroID()) return TokStart;
321
322 // Figure out how many physical characters away the specified logical
323 // character is. This needs to take into consideration newlines and
324 // trigraphs.
325 const char *TokPtr = SourceMgr.getCharacterData(TokStart);
326 unsigned PhysOffset = 0;
327
328 // The usual case is that tokens don't contain anything interesting. Skip
329 // over the uninteresting characters. If a token only consists of simple
330 // chars, this method is extremely fast.
331 while (CharNo && Lexer::isObviouslySimpleCharacter(*TokPtr))
332 ++TokPtr, --CharNo, ++PhysOffset;
333
334 // If we have a character that may be a trigraph or escaped newline, create a
335 // lexer to parse it correctly.
336 if (CharNo != 0) {
337 // Create a lexer starting at this token position.
338 Lexer TheLexer(TokStart, *this, TokPtr);
339 Token Tok;
340 // Skip over characters the remaining characters.
341 const char *TokStartPtr = TokPtr;
342 for (; CharNo; --CharNo)
343 TheLexer.getAndAdvanceChar(TokPtr, Tok);
344
345 PhysOffset += TokPtr-TokStartPtr;
346 }
347
348 return TokStart.getFileLocWithOffset(PhysOffset);
349}
350
351
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000352//===----------------------------------------------------------------------===//
353// Preprocessor Initialization Methods
354//===----------------------------------------------------------------------===//
355
356// Append a #define line to Buf for Macro. Macro should be of the form XXX,
357// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
358// "#define XXX Y z W". To get a #define with no value, use "XXX=".
359static void DefineBuiltinMacro(std::vector<char> &Buf, const char *Macro,
360 const char *Command = "#define ") {
361 Buf.insert(Buf.end(), Command, Command+strlen(Command));
362 if (const char *Equal = strchr(Macro, '=')) {
363 // Turn the = into ' '.
364 Buf.insert(Buf.end(), Macro, Equal);
365 Buf.push_back(' ');
366 Buf.insert(Buf.end(), Equal+1, Equal+strlen(Equal));
367 } else {
368 // Push "macroname 1".
369 Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
370 Buf.push_back(' ');
371 Buf.push_back('1');
372 }
373 Buf.push_back('\n');
374}
375
Chris Lattnercbed2992008-10-05 20:40:30 +0000376/// PickFP - This is used to pick a value based on the FP semantics of the
377/// specified FP model.
378template <typename T>
379static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
380 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal) {
381 if (Sem == &llvm::APFloat::IEEEsingle)
382 return IEEESingleVal;
383 if (Sem == &llvm::APFloat::IEEEdouble)
384 return IEEEDoubleVal;
385 if (Sem == &llvm::APFloat::x87DoubleExtended)
386 return X87DoubleExtendedVal;
387 assert(Sem == &llvm::APFloat::PPCDoubleDouble);
388 return PPCDoubleDoubleVal;
389}
390
391static void DefineFloatMacros(std::vector<char> &Buf, const char *Prefix,
392 const llvm::fltSemantics *Sem) {
Chris Lattner5c8f64a2008-10-05 21:40:58 +0000393 const char *DenormMin, *Epsilon, *Max, *Min;
394 DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
395 "3.64519953188247460253e-4951L",
396 "4.94065645841246544176568792868221e-324L");
397 int Digits = PickFP(Sem, 6, 15, 18, 31);
398 Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
399 "1.08420217248550443401e-19L",
400 "4.94065645841246544176568792868221e-324L");
401 int HasInifinity = 1, HasQuietNaN = 1;
402 int MantissaDigits = PickFP(Sem, 24, 53, 64, 106);
403 int Min10Exp = PickFP(Sem, -37, -307, -4931, -291);
404 int Max10Exp = PickFP(Sem, 38, 308, 4932, 308);
405 int MinExp = PickFP(Sem, -125, -1021, -16381, -968);
406 int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024);
407 Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
408 "3.36210314311209350626e-4932L",
409 "2.00416836000897277799610805135016e-292L");
410 Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
411 "1.18973149535723176502e+4932L",
412 "1.79769313486231580793728971405301e+308L");
Chris Lattnercbed2992008-10-05 20:40:30 +0000413
414 char MacroBuf[60];
415 sprintf(MacroBuf, "__%s_DENORM_MIN__=%s", Prefix, DenormMin);
416 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner5c8f64a2008-10-05 21:40:58 +0000417 sprintf(MacroBuf, "__%s_DIG__=%d", Prefix, Digits);
418 DefineBuiltinMacro(Buf, MacroBuf);
419 sprintf(MacroBuf, "__%s_EPSILON__=%s", Prefix, Epsilon);
420 DefineBuiltinMacro(Buf, MacroBuf);
421 sprintf(MacroBuf, "__%s_HAS_INFINITY__=%d", Prefix, HasInifinity);
422 DefineBuiltinMacro(Buf, MacroBuf);
423 sprintf(MacroBuf, "__%s_HAS_QUIET_NAN__=%d", Prefix, HasQuietNaN);
424 DefineBuiltinMacro(Buf, MacroBuf);
425 sprintf(MacroBuf, "__%s_MANT_DIG__=%d", Prefix, MantissaDigits);
426 DefineBuiltinMacro(Buf, MacroBuf);
427 sprintf(MacroBuf, "__%s_MAX_10_EXP__=%d", Prefix, Max10Exp);
428 DefineBuiltinMacro(Buf, MacroBuf);
429 sprintf(MacroBuf, "__%s_MAX_EXP__=%d", Prefix, MaxExp);
430 DefineBuiltinMacro(Buf, MacroBuf);
431 sprintf(MacroBuf, "__%s_MAX__=%s", Prefix, Max);
432 DefineBuiltinMacro(Buf, MacroBuf);
433 sprintf(MacroBuf, "__%s_MIN_10_EXP__=(%d)", Prefix, Min10Exp);
434 DefineBuiltinMacro(Buf, MacroBuf);
435 sprintf(MacroBuf, "__%s_MIN_EXP__=(%d)", Prefix, MinExp);
436 DefineBuiltinMacro(Buf, MacroBuf);
437 sprintf(MacroBuf, "__%s_MIN__=%s", Prefix, Min);
438 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattnercbed2992008-10-05 20:40:30 +0000439}
440
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000441
442static void InitializePredefinedMacros(Preprocessor &PP,
443 std::vector<char> &Buf) {
Chris Lattnera023ec52008-10-05 19:32:22 +0000444 // Compiler version introspection macros.
445 DefineBuiltinMacro(Buf, "__llvm__=1"); // LLVM Backend
446 DefineBuiltinMacro(Buf, "__clang__=1"); // Clang Frontend
447
448 // Currently claim to be compatible with GCC 4.2.1-5621.
449 DefineBuiltinMacro(Buf, "__APPLE_CC__=5621");
450 DefineBuiltinMacro(Buf, "__GNUC_MINOR__=2");
451 DefineBuiltinMacro(Buf, "__GNUC_PATCHLEVEL__=1");
452 DefineBuiltinMacro(Buf, "__GNUC__=4");
453 DefineBuiltinMacro(Buf, "__GXX_ABI_VERSION=1002");
454 DefineBuiltinMacro(Buf, "__VERSION__=\"4.2.1 (Apple Computer, Inc. "
455 "build 5621) (dot 3)\"");
456
457
458 // Initialize language-specific preprocessor defines.
459
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000460 // FIXME: Implement magic like cpp_init_builtins for things like __STDC__
461 // and __DATE__ etc.
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000462 // These should all be defined in the preprocessor according to the
463 // current language configuration.
464 DefineBuiltinMacro(Buf, "__STDC__=1");
465 //DefineBuiltinMacro(Buf, "__ASSEMBLER__=1");
466 if (PP.getLangOptions().C99 && !PP.getLangOptions().CPlusPlus)
467 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199901L");
468 else if (0) // STDC94 ?
469 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199409L");
470
471 DefineBuiltinMacro(Buf, "__STDC_HOSTED__=1");
Daniel Dunbar428e6762008-08-12 00:21:46 +0000472 if (PP.getLangOptions().ObjC1) {
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000473 DefineBuiltinMacro(Buf, "__OBJC__=1");
Daniel Dunbar428e6762008-08-12 00:21:46 +0000474
475 if (PP.getLangOptions().getGCMode() == LangOptions::NonGC) {
476 DefineBuiltinMacro(Buf, "__weak=");
477 DefineBuiltinMacro(Buf, "__strong=");
478 } else {
479 DefineBuiltinMacro(Buf, "__weak=__attribute__((objc_gc(weak)))");
480 DefineBuiltinMacro(Buf, "__strong=__attribute__((objc_gc(strong)))");
481 DefineBuiltinMacro(Buf, "__OBJC_GC__=1");
482 }
483
484 if (PP.getLangOptions().NeXTRuntime)
485 DefineBuiltinMacro(Buf, "__NEXT_RUNTIME__=1");
Daniel Dunbar428e6762008-08-12 00:21:46 +0000486 }
Chris Lattner5edfe012008-10-05 19:44:25 +0000487
Chris Lattnerd5e60992008-10-06 07:43:09 +0000488 // darwin_constant_cfstrings controls this. This is also dependent
489 // on other things like the runtime I believe. This is set even for C code.
490 DefineBuiltinMacro(Buf, "__CONSTANT_CFSTRINGS__=1");
491
Steve Naroffb3cd9ac2008-05-15 21:12:10 +0000492 if (PP.getLangOptions().ObjC2)
493 DefineBuiltinMacro(Buf, "OBJC_NEW_PROPERTIES");
Steve Naroffae84af82007-10-31 18:42:27 +0000494
Chris Lattner9b96b152008-09-30 00:48:48 +0000495 if (PP.getLangOptions().PascalStrings)
496 DefineBuiltinMacro(Buf, "__PASCAL_STRINGS__");
497
Chris Lattnera023ec52008-10-05 19:32:22 +0000498 if (PP.getLangOptions().Blocks) {
499 DefineBuiltinMacro(Buf, "__block=__attribute__((__blocks__(byref)))");
500 DefineBuiltinMacro(Buf, "__BLOCKS__=1");
Chris Lattnerce296f82008-10-05 19:32:52 +0000501 }
Chris Lattnera023ec52008-10-05 19:32:22 +0000502
503 if (PP.getLangOptions().CPlusPlus) {
504 DefineBuiltinMacro(Buf, "__DEPRECATED=1");
505 DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
506 DefineBuiltinMacro(Buf, "__GNUG__=4");
507 DefineBuiltinMacro(Buf, "__GXX_WEAK__=1");
508 DefineBuiltinMacro(Buf, "__cplusplus=1");
509 DefineBuiltinMacro(Buf, "__private_extern__=extern");
510 }
511
512 // Filter out some microsoft extensions when trying to parse in ms-compat
513 // mode.
514 if (PP.getLangOptions().Microsoft) {
515 DefineBuiltinMacro(Buf, "__stdcall=");
516 DefineBuiltinMacro(Buf, "__cdecl=");
517 DefineBuiltinMacro(Buf, "_cdecl=");
518 DefineBuiltinMacro(Buf, "__ptr64=");
519 DefineBuiltinMacro(Buf, "__w64=");
520 DefineBuiltinMacro(Buf, "__forceinline=");
521 DefineBuiltinMacro(Buf, "__int8=char");
522 DefineBuiltinMacro(Buf, "__int16=short");
523 DefineBuiltinMacro(Buf, "__int32=int");
524 DefineBuiltinMacro(Buf, "__int64=long long");
525 DefineBuiltinMacro(Buf, "__declspec(X)=");
526 }
527
528
529 // Initialize target-specific preprocessor defines.
Chris Lattner5edfe012008-10-05 19:44:25 +0000530 const TargetInfo &TI = PP.getTargetInfo();
531
532 // Define type sizing macros based on the target properties.
533 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
534 DefineBuiltinMacro(Buf, "__CHAR_BIT__=8");
535 DefineBuiltinMacro(Buf, "__SCHAR_MAX__=127");
Chris Lattnercbed2992008-10-05 20:40:30 +0000536
537 assert(TI.getWCharWidth() == 32 && "Only support 32-bit wchar so far");
538 DefineBuiltinMacro(Buf, "__WCHAR_MAX__=2147483647");
539 DefineBuiltinMacro(Buf, "__WCHAR_TYPE__=int");
540 DefineBuiltinMacro(Buf, "__WINT_TYPE__=int");
Chris Lattner5edfe012008-10-05 19:44:25 +0000541
542 assert(TI.getShortWidth() == 16 && "Only support 16-bit short so far");
Chris Lattner5edfe012008-10-05 19:44:25 +0000543 DefineBuiltinMacro(Buf, "__SHRT_MAX__=32767");
544
Chris Lattner1be8bb92008-10-05 20:06:37 +0000545 if (TI.getIntWidth() == 32)
546 DefineBuiltinMacro(Buf, "__INT_MAX__=2147483647");
547 else if (TI.getIntWidth() == 16)
548 DefineBuiltinMacro(Buf, "__INT_MAX__=32767");
549 else
550 assert(0 && "Unknown integer size");
Sanjiv Guptafa451432008-10-31 09:52:39 +0000551
552 if (TI.getLongLongWidth() == 64)
553 DefineBuiltinMacro(Buf, "__LONG_LONG_MAX__=9223372036854775807LL");
554 else if (TI.getLongLongWidth() == 32)
555 DefineBuiltinMacro(Buf, "__LONG_LONG_MAX__=2147483647L");
Chris Lattner5edfe012008-10-05 19:44:25 +0000556
Chris Lattner1be8bb92008-10-05 20:06:37 +0000557 if (TI.getLongWidth() == 32)
558 DefineBuiltinMacro(Buf, "__LONG_MAX__=2147483647L");
559 else if (TI.getLongWidth() == 64)
560 DefineBuiltinMacro(Buf, "__LONG_MAX__=9223372036854775807L");
561 else if (TI.getLongWidth() == 16)
562 DefineBuiltinMacro(Buf, "__LONG_MAX__=32767L");
563 else
564 assert(0 && "Unknown long size");
Sanjiv Guptafa451432008-10-31 09:52:39 +0000565 char MacroBuf[60];
566 sprintf(MacroBuf, "__INTMAX_MAX__=%lld",
567 (TI.getIntMaxType() == TargetInfo::UnsignedLongLong?
Sanjiv Guptaf9bfd002008-10-31 10:24:31 +0000568 (1LL << (TI.getLongLongWidth() - 1)) :
569 ((1LL << (TI.getLongLongWidth() - 2)) - 1)));
Sanjiv Guptafa451432008-10-31 09:52:39 +0000570 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner1be8bb92008-10-05 20:06:37 +0000571
Sanjiv Guptafa451432008-10-31 09:52:39 +0000572 if (TI.getIntMaxType() == TargetInfo::UnsignedLongLong)
573 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned long long int");
574 else if (TI.getIntMaxType() == TargetInfo::SignedLongLong)
Chris Lattner1be8bb92008-10-05 20:06:37 +0000575 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=long long int");
Sanjiv Guptafa451432008-10-31 09:52:39 +0000576 else if (TI.getIntMaxType() == TargetInfo::UnsignedLong)
577 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned long int");
578 else if (TI.getIntMaxType() == TargetInfo::SignedLong)
579 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=long int");
580 else if (TI.getIntMaxType() == TargetInfo::UnsignedInt)
581 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned int");
582 else
583 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=int");
Chris Lattner1be8bb92008-10-05 20:06:37 +0000584
Sanjiv Guptafa451432008-10-31 09:52:39 +0000585 if (TI.getUIntMaxType() == TargetInfo::UnsignedLongLong)
586 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned long long int");
587 else if (TI.getUIntMaxType() == TargetInfo::SignedLongLong)
588 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=long long int");
589 else if (TI.getUIntMaxType() == TargetInfo::UnsignedLong)
590 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned long int");
591 else if (TI.getUIntMaxType() == TargetInfo::SignedLong)
592 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=long int");
593 else if (TI.getUIntMaxType() == TargetInfo::UnsignedInt)
594 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned int");
595 else
596 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=int");
597
598 if (TI.getPtrDiffType(0) == TargetInfo::UnsignedLongLong)
599 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned long long int");
600 else if (TI.getPtrDiffType(0) == TargetInfo::SignedLongLong)
601 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=long long int");
602 else if (TI.getPtrDiffType(0) == TargetInfo::UnsignedLong)
603 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned long int");
604 else if (TI.getPtrDiffType(0) == TargetInfo::SignedLong)
605 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=long int");
606 else if (TI.getPtrDiffType(0) == TargetInfo::UnsignedInt)
607 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned int");
608 else
609 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=int");
610
611 if (TI.getSizeType() == TargetInfo::UnsignedLongLong)
612 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned long long int");
613 else if (TI.getSizeType() == TargetInfo::SignedLongLong)
614 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=long long int");
615 else if (TI.getSizeType() == TargetInfo::UnsignedLong)
616 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned long int");
617 else if (TI.getSizeType() == TargetInfo::SignedLong)
618 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=long int");
619 else if (TI.getSizeType() == TargetInfo::UnsignedInt)
620 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned int");
621 else if (TI.getSizeType() == TargetInfo::SignedInt)
622 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=int");
623 else
624 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned short");
625
Chris Lattnercbed2992008-10-05 20:40:30 +0000626 DefineFloatMacros(Buf, "FLT", &TI.getFloatFormat());
627 DefineFloatMacros(Buf, "DBL", &TI.getDoubleFormat());
628 DefineFloatMacros(Buf, "LDBL", &TI.getLongDoubleFormat());
Chris Lattner1be8bb92008-10-05 20:06:37 +0000629
Chris Lattner9b96b152008-09-30 00:48:48 +0000630
Chris Lattner77cec472007-10-10 17:48:53 +0000631 // Add __builtin_va_list typedef.
632 {
Chris Lattner5edfe012008-10-05 19:44:25 +0000633 const char *VAList = TI.getVAListDeclaration();
Chris Lattner77cec472007-10-10 17:48:53 +0000634 Buf.insert(Buf.end(), VAList, VAList+strlen(VAList));
635 Buf.push_back('\n');
636 }
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000637
Chris Lattner5edfe012008-10-05 19:44:25 +0000638 if (const char *Prefix = TI.getUserLabelPrefix()) {
Chris Lattner3da35682008-10-05 21:49:27 +0000639 sprintf(MacroBuf, "__USER_LABEL_PREFIX__=%s", Prefix);
640 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner3f6d8cf2008-10-05 19:22:37 +0000641 }
642
Chris Lattner5edfe012008-10-05 19:44:25 +0000643 // Build configuration options. FIXME: these should be controlled by
644 // command line options or something.
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000645 DefineBuiltinMacro(Buf, "__DYNAMIC__=1");
646 DefineBuiltinMacro(Buf, "__FINITE_MATH_ONLY__=0");
647 DefineBuiltinMacro(Buf, "__NO_INLINE__=1");
648 DefineBuiltinMacro(Buf, "__PIC__=1");
Chris Lattner5edfe012008-10-05 19:44:25 +0000649
Chris Lattner3da35682008-10-05 21:49:27 +0000650 // Macros to control C99 numerics and <float.h>
651 DefineBuiltinMacro(Buf, "__FLT_EVAL_METHOD__=0");
652 DefineBuiltinMacro(Buf, "__FLT_RADIX__=2");
653 sprintf(MacroBuf, "__DECIMAL_DIG__=%d",
654 PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33));
655 DefineBuiltinMacro(Buf, MacroBuf);
656
Chris Lattner5edfe012008-10-05 19:44:25 +0000657 // Get other target #defines.
658 TI.getTargetDefines(Buf);
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000659
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000660 // FIXME: Should emit a #line directive here.
661}
662
663
664/// EnterMainSourceFile - Enter the specified FileID as the main source file,
Nate Begeman886bf132008-01-07 04:01:26 +0000665/// which implicitly adds the builtin defines etc.
Ted Kremenek17861c52007-12-19 22:51:13 +0000666void Preprocessor::EnterMainSourceFile() {
667
668 unsigned MainFileID = SourceMgr.getMainFileID();
669
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000670 // Enter the main file source buffer.
671 EnterSourceFile(MainFileID, 0);
672
Chris Lattnerb45f05c2007-11-15 19:07:47 +0000673 // Tell the header info that the main file was entered. If the file is later
674 // #imported, it won't be re-entered.
675 if (const FileEntry *FE =
676 SourceMgr.getFileEntryForLoc(SourceLocation::getFileLoc(MainFileID, 0)))
677 HeaderInfo.IncrementIncludeCount(FE);
678
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000679 std::vector<char> PrologFile;
680 PrologFile.reserve(4080);
681
682 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
683 InitializePredefinedMacros(*this, PrologFile);
684
685 // Add on the predefines from the driver.
Chris Lattner47b6a162008-04-19 23:09:31 +0000686 PrologFile.insert(PrologFile.end(), Predefines.begin(), Predefines.end());
Chris Lattnerd1f21e12007-10-09 22:10:18 +0000687
688 // Memory buffer must end with a null byte!
689 PrologFile.push_back(0);
690
691 // Now that we have emitted the predefined macros, #includes, etc into
692 // PrologFile, preprocess it to populate the initial preprocessor state.
693 llvm::MemoryBuffer *SB =
694 llvm::MemoryBuffer::getMemBufferCopy(&PrologFile.front(),&PrologFile.back(),
695 "<predefines>");
696 assert(SB && "Cannot fail to create predefined source buffer");
697 unsigned FileID = SourceMgr.createFileIDForMemBuffer(SB);
698 assert(FileID && "Could not create FileID for predefines?");
699
700 // Start parsing the predefines.
701 EnterSourceFile(FileID, 0);
702}
Chris Lattner4b009652007-07-25 00:24:17 +0000703
Chris Lattner4b009652007-07-25 00:24:17 +0000704
705//===----------------------------------------------------------------------===//
706// Lexer Event Handling.
707//===----------------------------------------------------------------------===//
708
709/// LookUpIdentifierInfo - Given a tok::identifier token, look up the
710/// identifier information for the token and install it into the token.
711IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier,
712 const char *BufPtr) {
Chris Lattnercb8e41c2007-10-09 18:02:16 +0000713 assert(Identifier.is(tok::identifier) && "Not an identifier!");
Chris Lattner4b009652007-07-25 00:24:17 +0000714 assert(Identifier.getIdentifierInfo() == 0 && "Identinfo already exists!");
715
716 // Look up this token, see if it is a macro, or if it is a language keyword.
717 IdentifierInfo *II;
718 if (BufPtr && !Identifier.needsCleaning()) {
719 // No cleaning needed, just use the characters from the lexed buffer.
720 II = getIdentifierInfo(BufPtr, BufPtr+Identifier.getLength());
721 } else {
722 // Cleaning needed, alloca a buffer, clean into it, then use the buffer.
723 llvm::SmallVector<char, 64> IdentifierBuffer;
724 IdentifierBuffer.resize(Identifier.getLength());
725 const char *TmpBuf = &IdentifierBuffer[0];
726 unsigned Size = getSpelling(Identifier, TmpBuf);
727 II = getIdentifierInfo(TmpBuf, TmpBuf+Size);
728 }
729 Identifier.setIdentifierInfo(II);
730 return II;
731}
732
733
734/// HandleIdentifier - This callback is invoked when the lexer reads an
735/// identifier. This callback looks up the identifier in the map and/or
736/// potentially macro expands it or turns it into a named token (like 'for').
737void Preprocessor::HandleIdentifier(Token &Identifier) {
738 assert(Identifier.getIdentifierInfo() &&
739 "Can't handle identifiers without identifier info!");
740
741 IdentifierInfo &II = *Identifier.getIdentifierInfo();
742
743 // If this identifier was poisoned, and if it was not produced from a macro
744 // expansion, emit an error.
745 if (II.isPoisoned() && CurLexer) {
746 if (&II != Ident__VA_ARGS__) // We warn about __VA_ARGS__ with poisoning.
747 Diag(Identifier, diag::err_pp_used_poisoned_id);
748 else
749 Diag(Identifier, diag::ext_pp_bad_vaargs_use);
750 }
751
752 // If this is a macro to be expanded, do it.
Chris Lattner7a1b0882007-10-07 08:44:20 +0000753 if (MacroInfo *MI = getMacroInfo(&II)) {
Chris Lattner4b009652007-07-25 00:24:17 +0000754 if (!DisableMacroExpansion && !Identifier.isExpandDisabled()) {
755 if (MI->isEnabled()) {
756 if (!HandleMacroExpandedIdentifier(Identifier, MI))
757 return;
758 } else {
759 // C99 6.10.3.4p2 says that a disabled macro may never again be
760 // expanded, even if it's in a context where it could be expanded in the
761 // future.
762 Identifier.setFlag(Token::DisableExpand);
763 }
764 }
Chris Lattner4b009652007-07-25 00:24:17 +0000765 }
766
767 // C++ 2.11p2: If this is an alternative representation of a C++ operator,
768 // then we act as if it is the actual operator and not the textual
769 // representation of it.
770 if (II.isCPlusPlusOperatorKeyword())
771 Identifier.setIdentifierInfo(0);
772
773 // Change the kind of this identifier to the appropriate token kind, e.g.
774 // turning "for" into a keyword.
775 Identifier.setKind(II.getTokenID());
776
777 // If this is an extension token, diagnose its use.
Steve Naroff892bc0e2008-09-02 18:50:17 +0000778 // We avoid diagnosing tokens that originate from macro definitions.
779 if (II.isExtensionToken() && Features.C99 && !DisableMacroExpansion)
Chris Lattner4b009652007-07-25 00:24:17 +0000780 Diag(Identifier, diag::ext_token_used);
781}