blob: f16d83c5a2e2c46fe198f4d6f2c3b0737d214ac0 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- Preprocess.cpp - C Language Family Preprocessor Implementation ---===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +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.
Chris Lattnerf73903a2009-02-06 06:45:26 +000016// -d[DNI] - Dump various things.
Reid Spencer5f016e22007-07-11 17:01:13 +000017// -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"
Reid Spencer5f016e22007-07-11 17:01:13 +000031#include "clang/Lex/Pragma.h"
32#include "clang/Lex/ScratchBuffer.h"
Chris Lattner500d3292009-01-29 05:15:15 +000033#include "clang/Lex/LexDiagnostic.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000034#include "clang/Basic/SourceManager.h"
Ted Kremenek337edcd2009-02-12 03:26:59 +000035#include "clang/Basic/FileManager.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000036#include "clang/Basic/TargetInfo.h"
Chris Lattner2db78dd2008-10-05 20:40:30 +000037#include "llvm/ADT/APFloat.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000038#include "llvm/ADT/SmallVector.h"
Chris Lattner97ba77c2007-07-16 06:48:38 +000039#include "llvm/Support/MemoryBuffer.h"
Ted Kremenekbdd30c22008-01-14 16:44:48 +000040#include "llvm/Support/Streams.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000041using namespace clang;
42
43//===----------------------------------------------------------------------===//
44
Ted Kremenekec6c5742008-04-17 21:23:07 +000045PreprocessorFactory::~PreprocessorFactory() {}
46
Reid Spencer5f016e22007-07-11 17:01:13 +000047Preprocessor::Preprocessor(Diagnostic &diags, const LangOptions &opts,
48 TargetInfo &target, SourceManager &SM,
Ted Kremenek72b1b152009-01-15 18:47:46 +000049 HeaderSearch &Headers,
50 IdentifierInfoLookup* IILookup)
Reid Spencer5f016e22007-07-11 17:01:13 +000051 : Diags(diags), Features(opts), Target(target), FileMgr(Headers.getFileMgr()),
Ted Kremenek72b1b152009-01-15 18:47:46 +000052 SourceMgr(SM), HeaderInfo(Headers), Identifiers(opts, IILookup),
Ted Kremenek4b71e3e2008-11-19 00:44:06 +000053 CurPPLexer(0), CurDirLookup(0), Callbacks(0) {
Reid Spencer5f016e22007-07-11 17:01:13 +000054 ScratchBuf = new ScratchBuffer(SourceMgr);
Chris Lattner9594acf2007-07-15 00:25:26 +000055
Reid Spencer5f016e22007-07-11 17:01:13 +000056 // Clear stats.
57 NumDirectives = NumDefined = NumUndefined = NumPragma = 0;
58 NumIf = NumElse = NumEndif = 0;
59 NumEnteredSourceFiles = 0;
60 NumMacroExpanded = NumFnMacroExpanded = NumBuiltinMacroExpanded = 0;
61 NumFastMacroExpanded = NumTokenPaste = NumFastTokenPaste = 0;
62 MaxIncludeStackDepth = 0;
63 NumSkipped = 0;
64
65 // Default to discarding comments.
66 KeepComments = false;
67 KeepMacroComments = false;
68
69 // Macro expansion is enabled.
70 DisableMacroExpansion = false;
71 InMacroArgs = false;
Chris Lattner6cfe7592008-03-09 02:26:03 +000072 NumCachedTokenLexers = 0;
Reid Spencer5f016e22007-07-11 17:01:13 +000073
Argyrios Kyrtzidis03db1b32008-08-10 13:15:22 +000074 CachedLexPos = 0;
75
Reid Spencer5f016e22007-07-11 17:01:13 +000076 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
77 // This gets unpoisoned where it is allowed.
78 (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned();
79
80 // Initialize the pragma handlers.
81 PragmaHandlers = new PragmaNamespace(0);
82 RegisterBuiltinPragmas();
83
84 // Initialize builtin macros like __LINE__ and friends.
85 RegisterBuiltinMacros();
86}
87
88Preprocessor::~Preprocessor() {
Argyrios Kyrtzidis2174a4f2008-08-23 12:12:06 +000089 assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!");
90
Reid Spencer5f016e22007-07-11 17:01:13 +000091 while (!IncludeMacroStack.empty()) {
92 delete IncludeMacroStack.back().TheLexer;
Chris Lattner6cfe7592008-03-09 02:26:03 +000093 delete IncludeMacroStack.back().TheTokenLexer;
Reid Spencer5f016e22007-07-11 17:01:13 +000094 IncludeMacroStack.pop_back();
95 }
Chris Lattnercc1a8752007-10-07 08:44:20 +000096
97 // Free any macro definitions.
98 for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I =
99 Macros.begin(), E = Macros.end(); I != E; ++I) {
Ted Kremenek0ea76722008-12-15 19:56:42 +0000100 // We don't need to free the MacroInfo objects directly. These
101 // will be released when the BumpPtrAllocator 'BP' object gets
Ted Kremenek9ee7d452009-01-19 07:45:44 +0000102 // destroyed. We still need to run the dstor, however, to free
103 // memory alocated by MacroInfo.
104 I->second->~MacroInfo();
Chris Lattnercc1a8752007-10-07 08:44:20 +0000105 I->first->setHasMacroDefinition(false);
106 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000107
Chris Lattner9594acf2007-07-15 00:25:26 +0000108 // Free any cached macro expanders.
Chris Lattner6cfe7592008-03-09 02:26:03 +0000109 for (unsigned i = 0, e = NumCachedTokenLexers; i != e; ++i)
110 delete TokenLexerCache[i];
Chris Lattner9594acf2007-07-15 00:25:26 +0000111
Reid Spencer5f016e22007-07-11 17:01:13 +0000112 // Release pragma information.
113 delete PragmaHandlers;
114
115 // Delete the scratch buffer info.
116 delete ScratchBuf;
Chris Lattnereb50ed82008-03-14 06:07:05 +0000117
118 delete Callbacks;
Reid Spencer5f016e22007-07-11 17:01:13 +0000119}
120
Ted Kremenek337edcd2009-02-12 03:26:59 +0000121void Preprocessor::setPTHManager(PTHManager* pm) {
122 PTH.reset(pm);
123 FileMgr.setStatCache(PTH->createStatCache());
124}
125
Chris Lattnerd2177732007-07-20 16:59:19 +0000126void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000127 llvm::cerr << tok::getTokenName(Tok.getKind()) << " '"
128 << getSpelling(Tok) << "'";
Reid Spencer5f016e22007-07-11 17:01:13 +0000129
130 if (!DumpFlags) return;
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000131
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000132 llvm::cerr << "\t";
Reid Spencer5f016e22007-07-11 17:01:13 +0000133 if (Tok.isAtStartOfLine())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000134 llvm::cerr << " [StartOfLine]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000135 if (Tok.hasLeadingSpace())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000136 llvm::cerr << " [LeadingSpace]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000137 if (Tok.isExpandDisabled())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000138 llvm::cerr << " [ExpandDisabled]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000139 if (Tok.needsCleaning()) {
140 const char *Start = SourceMgr.getCharacterData(Tok.getLocation());
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000141 llvm::cerr << " [UnClean='" << std::string(Start, Start+Tok.getLength())
142 << "']";
Reid Spencer5f016e22007-07-11 17:01:13 +0000143 }
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000144
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000145 llvm::cerr << "\tLoc=<";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000146 DumpLocation(Tok.getLocation());
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000147 llvm::cerr << ">";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000148}
149
150void Preprocessor::DumpLocation(SourceLocation Loc) const {
Chris Lattnerb9c3f962009-01-27 07:57:44 +0000151 Loc.dump(SourceMgr);
Reid Spencer5f016e22007-07-11 17:01:13 +0000152}
153
154void Preprocessor::DumpMacro(const MacroInfo &MI) const {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000155 llvm::cerr << "MACRO: ";
Reid Spencer5f016e22007-07-11 17:01:13 +0000156 for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) {
157 DumpToken(MI.getReplacementToken(i));
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000158 llvm::cerr << " ";
Reid Spencer5f016e22007-07-11 17:01:13 +0000159 }
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000160 llvm::cerr << "\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000161}
162
163void Preprocessor::PrintStats() {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000164 llvm::cerr << "\n*** Preprocessor Stats:\n";
165 llvm::cerr << NumDirectives << " directives found:\n";
166 llvm::cerr << " " << NumDefined << " #define.\n";
167 llvm::cerr << " " << NumUndefined << " #undef.\n";
168 llvm::cerr << " #include/#include_next/#import:\n";
169 llvm::cerr << " " << NumEnteredSourceFiles << " source files entered.\n";
170 llvm::cerr << " " << MaxIncludeStackDepth << " max include stack depth\n";
171 llvm::cerr << " " << NumIf << " #if/#ifndef/#ifdef.\n";
172 llvm::cerr << " " << NumElse << " #else/#elif.\n";
173 llvm::cerr << " " << NumEndif << " #endif.\n";
174 llvm::cerr << " " << NumPragma << " #pragma.\n";
175 llvm::cerr << NumSkipped << " #if/#ifndef#ifdef regions skipped\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000176
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000177 llvm::cerr << NumMacroExpanded << "/" << NumFnMacroExpanded << "/"
178 << NumBuiltinMacroExpanded << " obj/fn/builtin macros expanded, "
179 << NumFastMacroExpanded << " on the fast path.\n";
180 llvm::cerr << (NumFastTokenPaste+NumTokenPaste)
181 << " token paste (##) operations performed, "
182 << NumFastTokenPaste << " on the fast path.\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000183}
184
185//===----------------------------------------------------------------------===//
186// Token Spelling
187//===----------------------------------------------------------------------===//
188
189
190/// getSpelling() - Return the 'spelling' of this token. The spelling of a
191/// token are the characters used to represent the token in the source file
192/// after trigraph expansion and escaped-newline folding. In particular, this
193/// wants to get the true, uncanonicalized, spelling of things like digraphs
194/// UCNs, etc.
Chris Lattnerd2177732007-07-20 16:59:19 +0000195std::string Preprocessor::getSpelling(const Token &Tok) const {
Reid Spencer5f016e22007-07-11 17:01:13 +0000196 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
Ted Kremenek277faca2009-01-27 00:01:05 +0000197
Reid Spencer5f016e22007-07-11 17:01:13 +0000198 // If this token contains nothing interesting, return it directly.
Ted Kremenek277faca2009-01-27 00:01:05 +0000199 const char* TokStart = SourceMgr.getCharacterData(Tok.getLocation());
Reid Spencer5f016e22007-07-11 17:01:13 +0000200 if (!Tok.needsCleaning())
201 return std::string(TokStart, TokStart+Tok.getLength());
202
203 std::string Result;
204 Result.reserve(Tok.getLength());
205
206 // Otherwise, hard case, relex the characters into the string.
207 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
208 Ptr != End; ) {
209 unsigned CharSize;
210 Result.push_back(Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features));
211 Ptr += CharSize;
212 }
213 assert(Result.size() != unsigned(Tok.getLength()) &&
214 "NeedsCleaning flag set on something that didn't need cleaning!");
215 return Result;
216}
217
218/// getSpelling - This method is used to get the spelling of a token into a
219/// preallocated buffer, instead of as an std::string. The caller is required
220/// to allocate enough space for the token, which is guaranteed to be at least
221/// Tok.getLength() bytes long. The actual length of the token is returned.
222///
223/// Note that this method may do two possible things: it may either fill in
224/// the buffer specified with characters, or it may *change the input pointer*
225/// to point to a constant buffer with the data already in it (avoiding a
226/// copy). The caller is not allowed to modify the returned buffer pointer
227/// if an internal buffer is returned.
Chris Lattnerd2177732007-07-20 16:59:19 +0000228unsigned Preprocessor::getSpelling(const Token &Tok,
Reid Spencer5f016e22007-07-11 17:01:13 +0000229 const char *&Buffer) const {
230 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
231
232 // If this token is an identifier, just return the string from the identifier
233 // table, which is very quick.
234 if (const IdentifierInfo *II = Tok.getIdentifierInfo()) {
235 Buffer = II->getName();
Chris Lattnere1dccae2009-01-05 19:44:41 +0000236 return II->getLength();
Reid Spencer5f016e22007-07-11 17:01:13 +0000237 }
Ted Kremenekb70e3da2009-01-08 02:47:16 +0000238
Reid Spencer5f016e22007-07-11 17:01:13 +0000239 // Otherwise, compute the start of the token in the input lexer buffer.
Chris Lattner47246be2009-01-26 19:29:26 +0000240 const char *TokStart = 0;
241
242 if (Tok.isLiteral())
243 TokStart = Tok.getLiteralData();
244
245 if (TokStart == 0)
246 TokStart = SourceMgr.getCharacterData(Tok.getLocation());
Reid Spencer5f016e22007-07-11 17:01:13 +0000247
248 // If this token contains nothing interesting, return it directly.
249 if (!Tok.needsCleaning()) {
250 Buffer = TokStart;
251 return Tok.getLength();
252 }
Chris Lattner47246be2009-01-26 19:29:26 +0000253
Reid Spencer5f016e22007-07-11 17:01:13 +0000254 // Otherwise, hard case, relex the characters into the string.
255 char *OutBuf = const_cast<char*>(Buffer);
256 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
257 Ptr != End; ) {
258 unsigned CharSize;
259 *OutBuf++ = Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features);
260 Ptr += CharSize;
261 }
262 assert(unsigned(OutBuf-Buffer) != Tok.getLength() &&
263 "NeedsCleaning flag set on something that didn't need cleaning!");
264
265 return OutBuf-Buffer;
266}
267
268
269/// CreateString - Plop the specified string into a scratch buffer and return a
270/// location for it. If specified, the source location provides a source
271/// location for the token.
Chris Lattner47246be2009-01-26 19:29:26 +0000272void Preprocessor::CreateString(const char *Buf, unsigned Len, Token &Tok,
273 SourceLocation InstantiationLoc) {
274 Tok.setLength(Len);
275
276 const char *DestPtr;
277 SourceLocation Loc = ScratchBuf->getToken(Buf, Len, DestPtr);
278
279 if (InstantiationLoc.isValid())
280 Loc = SourceMgr.createInstantiationLoc(Loc, InstantiationLoc, Len);
281 Tok.setLocation(Loc);
282
283 // If this is a literal token, set the pointer data.
284 if (Tok.isLiteral())
285 Tok.setLiteralData(DestPtr);
Reid Spencer5f016e22007-07-11 17:01:13 +0000286}
287
288
Chris Lattner97ba77c2007-07-16 06:48:38 +0000289/// AdvanceToTokenCharacter - Given a location that specifies the start of a
290/// token, return a new location that specifies a character within the token.
291SourceLocation Preprocessor::AdvanceToTokenCharacter(SourceLocation TokStart,
292 unsigned CharNo) {
Chris Lattner9dc1f532007-07-20 16:37:10 +0000293 // If they request the first char of the token, we're trivially done. If this
294 // is a macro expansion, it doesn't make sense to point to a character within
295 // the instantiation point (the name). We could point to the source
296 // character, but without also pointing to instantiation info, this is
297 // confusing.
298 if (CharNo == 0 || TokStart.isMacroID()) return TokStart;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000299
Chris Lattnerf7cf85b2009-01-16 07:36:28 +0000300 // Figure out how many physical characters away the specified instantiation
Chris Lattner97ba77c2007-07-16 06:48:38 +0000301 // character is. This needs to take into consideration newlines and
302 // trigraphs.
Chris Lattner9dc1f532007-07-20 16:37:10 +0000303 const char *TokPtr = SourceMgr.getCharacterData(TokStart);
304 unsigned PhysOffset = 0;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000305
306 // The usual case is that tokens don't contain anything interesting. Skip
307 // over the uninteresting characters. If a token only consists of simple
308 // chars, this method is extremely fast.
309 while (CharNo && Lexer::isObviouslySimpleCharacter(*TokPtr))
Chris Lattner9dc1f532007-07-20 16:37:10 +0000310 ++TokPtr, --CharNo, ++PhysOffset;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000311
Chris Lattner28c90ad2009-01-17 07:57:25 +0000312 // If we have a character that may be a trigraph or escaped newline, use a
Chris Lattner97ba77c2007-07-16 06:48:38 +0000313 // lexer to parse it correctly.
Chris Lattner97ba77c2007-07-16 06:48:38 +0000314 if (CharNo != 0) {
Chris Lattner97ba77c2007-07-16 06:48:38 +0000315 // Skip over characters the remaining characters.
Chris Lattner28c90ad2009-01-17 07:57:25 +0000316 for (; CharNo; --CharNo) {
317 unsigned Size;
318 Lexer::getCharAndSizeNoWarn(TokPtr, Size, Features);
319 TokPtr += Size;
320 PhysOffset += Size;
321 }
Chris Lattner97ba77c2007-07-16 06:48:38 +0000322 }
Chris Lattner9dc1f532007-07-20 16:37:10 +0000323
324 return TokStart.getFileLocWithOffset(PhysOffset);
Chris Lattner97ba77c2007-07-16 06:48:38 +0000325}
326
327
Chris Lattner53b0dab2007-10-09 22:10:18 +0000328//===----------------------------------------------------------------------===//
329// Preprocessor Initialization Methods
330//===----------------------------------------------------------------------===//
331
332// Append a #define line to Buf for Macro. Macro should be of the form XXX,
333// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
334// "#define XXX Y z W". To get a #define with no value, use "XXX=".
335static void DefineBuiltinMacro(std::vector<char> &Buf, const char *Macro,
336 const char *Command = "#define ") {
337 Buf.insert(Buf.end(), Command, Command+strlen(Command));
338 if (const char *Equal = strchr(Macro, '=')) {
339 // Turn the = into ' '.
340 Buf.insert(Buf.end(), Macro, Equal);
341 Buf.push_back(' ');
342 Buf.insert(Buf.end(), Equal+1, Equal+strlen(Equal));
343 } else {
344 // Push "macroname 1".
345 Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
346 Buf.push_back(' ');
347 Buf.push_back('1');
348 }
349 Buf.push_back('\n');
350}
351
Chris Lattner2db78dd2008-10-05 20:40:30 +0000352/// PickFP - This is used to pick a value based on the FP semantics of the
353/// specified FP model.
354template <typename T>
355static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
356 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal) {
357 if (Sem == &llvm::APFloat::IEEEsingle)
358 return IEEESingleVal;
359 if (Sem == &llvm::APFloat::IEEEdouble)
360 return IEEEDoubleVal;
361 if (Sem == &llvm::APFloat::x87DoubleExtended)
362 return X87DoubleExtendedVal;
363 assert(Sem == &llvm::APFloat::PPCDoubleDouble);
364 return PPCDoubleDoubleVal;
365}
366
367static void DefineFloatMacros(std::vector<char> &Buf, const char *Prefix,
368 const llvm::fltSemantics *Sem) {
Chris Lattnere9863ca2008-10-05 21:40:58 +0000369 const char *DenormMin, *Epsilon, *Max, *Min;
370 DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
371 "3.64519953188247460253e-4951L",
372 "4.94065645841246544176568792868221e-324L");
373 int Digits = PickFP(Sem, 6, 15, 18, 31);
374 Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
375 "1.08420217248550443401e-19L",
376 "4.94065645841246544176568792868221e-324L");
377 int HasInifinity = 1, HasQuietNaN = 1;
378 int MantissaDigits = PickFP(Sem, 24, 53, 64, 106);
379 int Min10Exp = PickFP(Sem, -37, -307, -4931, -291);
380 int Max10Exp = PickFP(Sem, 38, 308, 4932, 308);
381 int MinExp = PickFP(Sem, -125, -1021, -16381, -968);
382 int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024);
383 Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
384 "3.36210314311209350626e-4932L",
385 "2.00416836000897277799610805135016e-292L");
386 Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
387 "1.18973149535723176502e+4932L",
388 "1.79769313486231580793728971405301e+308L");
Chris Lattner2db78dd2008-10-05 20:40:30 +0000389
390 char MacroBuf[60];
391 sprintf(MacroBuf, "__%s_DENORM_MIN__=%s", Prefix, DenormMin);
392 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattnere9863ca2008-10-05 21:40:58 +0000393 sprintf(MacroBuf, "__%s_DIG__=%d", Prefix, Digits);
394 DefineBuiltinMacro(Buf, MacroBuf);
395 sprintf(MacroBuf, "__%s_EPSILON__=%s", Prefix, Epsilon);
396 DefineBuiltinMacro(Buf, MacroBuf);
397 sprintf(MacroBuf, "__%s_HAS_INFINITY__=%d", Prefix, HasInifinity);
398 DefineBuiltinMacro(Buf, MacroBuf);
399 sprintf(MacroBuf, "__%s_HAS_QUIET_NAN__=%d", Prefix, HasQuietNaN);
400 DefineBuiltinMacro(Buf, MacroBuf);
401 sprintf(MacroBuf, "__%s_MANT_DIG__=%d", Prefix, MantissaDigits);
402 DefineBuiltinMacro(Buf, MacroBuf);
403 sprintf(MacroBuf, "__%s_MAX_10_EXP__=%d", Prefix, Max10Exp);
404 DefineBuiltinMacro(Buf, MacroBuf);
405 sprintf(MacroBuf, "__%s_MAX_EXP__=%d", Prefix, MaxExp);
406 DefineBuiltinMacro(Buf, MacroBuf);
407 sprintf(MacroBuf, "__%s_MAX__=%s", Prefix, Max);
408 DefineBuiltinMacro(Buf, MacroBuf);
409 sprintf(MacroBuf, "__%s_MIN_10_EXP__=(%d)", Prefix, Min10Exp);
410 DefineBuiltinMacro(Buf, MacroBuf);
411 sprintf(MacroBuf, "__%s_MIN_EXP__=(%d)", Prefix, MinExp);
412 DefineBuiltinMacro(Buf, MacroBuf);
413 sprintf(MacroBuf, "__%s_MIN__=%s", Prefix, Min);
414 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattnerd427ad42009-02-05 07:19:24 +0000415 sprintf(MacroBuf, "__%s_HAS_DENORM__=1", Prefix);
416 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner2db78dd2008-10-05 20:40:30 +0000417}
418
Chris Lattner53b0dab2007-10-09 22:10:18 +0000419
Chris Lattner996fecc2009-02-06 04:50:25 +0000420/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
421/// named MacroName with the max value for a type with width 'TypeWidth' a
422/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
423static void DefineTypeSize(const char *MacroName, unsigned TypeWidth,
424 const char *ValSuffix, bool isSigned,
425 std::vector<char> &Buf) {
426 char MacroBuf[60];
427 uint64_t MaxVal;
428 if (isSigned)
429 MaxVal = (1LL << (TypeWidth - 1)) - 1;
430 else
431 MaxVal = ~0LL >> (64-TypeWidth);
432
433 sprintf(MacroBuf, "%s=%llu%s", MacroName, MaxVal, ValSuffix);
434 DefineBuiltinMacro(Buf, MacroBuf);
435}
436
Chris Lattner2b5abf52009-02-06 05:04:11 +0000437static void DefineType(const char *MacroName, TargetInfo::IntType Ty,
438 std::vector<char> &Buf) {
439 char MacroBuf[60];
440 sprintf(MacroBuf, "%s=%s", MacroName, TargetInfo::getTypeName(Ty));
441 DefineBuiltinMacro(Buf, MacroBuf);
442}
443
444
Chris Lattner53b0dab2007-10-09 22:10:18 +0000445static void InitializePredefinedMacros(Preprocessor &PP,
446 std::vector<char> &Buf) {
Chris Lattner03c97272009-02-06 22:59:26 +0000447 char MacroBuf[60];
Chris Lattner62213d92008-10-05 19:32:22 +0000448 // Compiler version introspection macros.
449 DefineBuiltinMacro(Buf, "__llvm__=1"); // LLVM Backend
450 DefineBuiltinMacro(Buf, "__clang__=1"); // Clang Frontend
451
452 // Currently claim to be compatible with GCC 4.2.1-5621.
453 DefineBuiltinMacro(Buf, "__APPLE_CC__=5621");
454 DefineBuiltinMacro(Buf, "__GNUC_MINOR__=2");
455 DefineBuiltinMacro(Buf, "__GNUC_PATCHLEVEL__=1");
456 DefineBuiltinMacro(Buf, "__GNUC__=4");
457 DefineBuiltinMacro(Buf, "__GXX_ABI_VERSION=1002");
458 DefineBuiltinMacro(Buf, "__VERSION__=\"4.2.1 (Apple Computer, Inc. "
459 "build 5621) (dot 3)\"");
460
461
462 // Initialize language-specific preprocessor defines.
463
Chris Lattner53b0dab2007-10-09 22:10:18 +0000464 // FIXME: Implement magic like cpp_init_builtins for things like __STDC__
465 // and __DATE__ etc.
Chris Lattner53b0dab2007-10-09 22:10:18 +0000466 // These should all be defined in the preprocessor according to the
467 // current language configuration.
Steve Naroff7e0fbb22008-12-18 22:37:25 +0000468 if (!PP.getLangOptions().Microsoft)
469 DefineBuiltinMacro(Buf, "__STDC__=1");
Daniel Dunbarc1571452008-12-01 18:55:22 +0000470 if (PP.getLangOptions().AsmPreprocessor)
471 DefineBuiltinMacro(Buf, "__ASSEMBLER__=1");
Chris Lattner53b0dab2007-10-09 22:10:18 +0000472 if (PP.getLangOptions().C99 && !PP.getLangOptions().CPlusPlus)
473 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199901L");
474 else if (0) // STDC94 ?
475 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199409L");
476
477 DefineBuiltinMacro(Buf, "__STDC_HOSTED__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000478 if (PP.getLangOptions().ObjC1) {
Chris Lattner53b0dab2007-10-09 22:10:18 +0000479 DefineBuiltinMacro(Buf, "__OBJC__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000480
481 if (PP.getLangOptions().getGCMode() == LangOptions::NonGC) {
482 DefineBuiltinMacro(Buf, "__weak=");
483 DefineBuiltinMacro(Buf, "__strong=");
484 } else {
485 DefineBuiltinMacro(Buf, "__weak=__attribute__((objc_gc(weak)))");
486 DefineBuiltinMacro(Buf, "__strong=__attribute__((objc_gc(strong)))");
487 DefineBuiltinMacro(Buf, "__OBJC_GC__=1");
488 }
489
490 if (PP.getLangOptions().NeXTRuntime)
491 DefineBuiltinMacro(Buf, "__NEXT_RUNTIME__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000492 }
Chris Lattner9b533162008-10-05 19:44:25 +0000493
Chris Lattnereb52b442008-10-06 07:43:09 +0000494 // darwin_constant_cfstrings controls this. This is also dependent
495 // on other things like the runtime I believe. This is set even for C code.
496 DefineBuiltinMacro(Buf, "__CONSTANT_CFSTRINGS__=1");
497
Steve Naroff73b17cd2008-05-15 21:12:10 +0000498 if (PP.getLangOptions().ObjC2)
499 DefineBuiltinMacro(Buf, "OBJC_NEW_PROPERTIES");
Steve Naroff8ee529b2007-10-31 18:42:27 +0000500
Chris Lattner048dd942008-09-30 00:48:48 +0000501 if (PP.getLangOptions().PascalStrings)
502 DefineBuiltinMacro(Buf, "__PASCAL_STRINGS__");
503
Chris Lattner62213d92008-10-05 19:32:22 +0000504 if (PP.getLangOptions().Blocks) {
505 DefineBuiltinMacro(Buf, "__block=__attribute__((__blocks__(byref)))");
506 DefineBuiltinMacro(Buf, "__BLOCKS__=1");
Chris Lattner2b43ad92008-10-05 19:32:52 +0000507 }
Chris Lattner62213d92008-10-05 19:32:22 +0000508
509 if (PP.getLangOptions().CPlusPlus) {
510 DefineBuiltinMacro(Buf, "__DEPRECATED=1");
511 DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
512 DefineBuiltinMacro(Buf, "__GNUG__=4");
513 DefineBuiltinMacro(Buf, "__GXX_WEAK__=1");
514 DefineBuiltinMacro(Buf, "__cplusplus=1");
515 DefineBuiltinMacro(Buf, "__private_extern__=extern");
516 }
517
518 // Filter out some microsoft extensions when trying to parse in ms-compat
519 // mode.
520 if (PP.getLangOptions().Microsoft) {
Steve Naroff239f0732008-12-25 14:16:32 +0000521 DefineBuiltinMacro(Buf, "_cdecl=__cdecl");
Chris Lattner03c97272009-02-06 22:59:26 +0000522 DefineBuiltinMacro(Buf, "__int8=__INT8_TYPE__");
523 DefineBuiltinMacro(Buf, "__int16=__INT16_TYPE__");
524 DefineBuiltinMacro(Buf, "__int32=__INT32_TYPE__");
525 DefineBuiltinMacro(Buf, "__int64=__INT64_TYPE__");
Chris Lattner62213d92008-10-05 19:32:22 +0000526 }
527
Chris Lattner62213d92008-10-05 19:32:22 +0000528 // Initialize target-specific preprocessor defines.
Chris Lattner9b533162008-10-05 19:44:25 +0000529 const TargetInfo &TI = PP.getTargetInfo();
530
531 // Define type sizing macros based on the target properties.
532 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
533 DefineBuiltinMacro(Buf, "__CHAR_BIT__=8");
Chris Lattner2db78dd2008-10-05 20:40:30 +0000534
Chris Lattner659dc142009-02-05 07:27:41 +0000535 unsigned IntMaxWidth;
536 const char *IntMaxSuffix;
537 if (TI.getIntMaxType() == TargetInfo::SignedLongLong) {
538 IntMaxWidth = TI.getLongLongWidth();
539 IntMaxSuffix = "LL";
540 } else if (TI.getIntMaxType() == TargetInfo::SignedLong) {
541 IntMaxWidth = TI.getLongWidth();
542 IntMaxSuffix = "L";
543 } else {
544 assert(TI.getIntMaxType() == TargetInfo::SignedInt);
545 IntMaxWidth = TI.getIntWidth();
546 IntMaxSuffix = "";
547 }
548
Chris Lattner86d85b82009-02-06 04:55:18 +0000549 DefineTypeSize("__SCHAR_MAX__", TI.getCharWidth(), "", true, Buf);
550 DefineTypeSize("__SHRT_MAX__", TI.getShortWidth(), "", true, Buf);
551 DefineTypeSize("__INT_MAX__", TI.getIntWidth(), "", true, Buf);
552 DefineTypeSize("__LONG_MAX__", TI.getLongWidth(), "L", true, Buf);
553 DefineTypeSize("__LONG_LONG_MAX__", TI.getLongLongWidth(), "LL", true, Buf);
554 DefineTypeSize("__WCHAR_MAX__", TI.getWCharWidth(), "", true, Buf);
Chris Lattner996fecc2009-02-06 04:50:25 +0000555 DefineTypeSize("__INTMAX_MAX__", IntMaxWidth, IntMaxSuffix, true, Buf);
556
Chris Lattner2b5abf52009-02-06 05:04:11 +0000557 DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Buf);
558 DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Buf);
559 DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Buf);
560 DefineType("__SIZE_TYPE__", TI.getSizeType(), Buf);
Chris Lattner3c3b1552009-02-06 05:06:07 +0000561 DefineType("__WCHAR_TYPE__", TI.getWCharType(), Buf);
562 // FIXME: TargetInfo hookize __WINT_TYPE__.
563 DefineBuiltinMacro(Buf, "__WINT_TYPE__=int");
564
Chris Lattner2db78dd2008-10-05 20:40:30 +0000565 DefineFloatMacros(Buf, "FLT", &TI.getFloatFormat());
566 DefineFloatMacros(Buf, "DBL", &TI.getDoubleFormat());
567 DefineFloatMacros(Buf, "LDBL", &TI.getLongDoubleFormat());
Chris Lattner03c97272009-02-06 22:59:26 +0000568
569 // Define a __POINTER_WIDTH__ macro for stdint.h.
570 sprintf(MacroBuf, "__POINTER_WIDTH__=%d", (int)TI.getPointerWidth(0));
571 DefineBuiltinMacro(Buf, MacroBuf);
572
573 if (!TI.isCharSigned())
574 DefineBuiltinMacro(Buf, "__CHAR_UNSIGNED__");
575
576 // Define fixed-sized integer types for stdint.h
577 assert(TI.getCharWidth() == 8 && "unsupported target types");
578 assert(TI.getShortWidth() == 16 && "unsupported target types");
579 DefineBuiltinMacro(Buf, "__INT8_TYPE__=char");
580 DefineBuiltinMacro(Buf, "__INT16_TYPE__=short");
581
582 if (TI.getIntWidth() == 32)
583 DefineBuiltinMacro(Buf, "__INT32_TYPE__=int");
584 else {
585 assert(TI.getLongLongWidth() == 32 && "unsupported target types");
586 DefineBuiltinMacro(Buf, "__INT32_TYPE__=long long");
587 }
588
589 // 16-bit targets doesn't necessarily have a 64-bit type.
590 if (TI.getLongLongWidth() == 64)
591 DefineBuiltinMacro(Buf, "__INT64_TYPE__=long long");
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000592
Chris Lattnerd19144b2007-10-10 17:48:53 +0000593 // Add __builtin_va_list typedef.
594 {
Chris Lattner9b533162008-10-05 19:44:25 +0000595 const char *VAList = TI.getVAListDeclaration();
Chris Lattnerd19144b2007-10-10 17:48:53 +0000596 Buf.insert(Buf.end(), VAList, VAList+strlen(VAList));
597 Buf.push_back('\n');
598 }
Chris Lattner53b0dab2007-10-09 22:10:18 +0000599
Chris Lattner9b533162008-10-05 19:44:25 +0000600 if (const char *Prefix = TI.getUserLabelPrefix()) {
Chris Lattner12f09262008-10-05 21:49:27 +0000601 sprintf(MacroBuf, "__USER_LABEL_PREFIX__=%s", Prefix);
602 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner3fdf4672008-10-05 19:22:37 +0000603 }
604
Chris Lattner9b533162008-10-05 19:44:25 +0000605 // Build configuration options. FIXME: these should be controlled by
606 // command line options or something.
Chris Lattner53b0dab2007-10-09 22:10:18 +0000607 DefineBuiltinMacro(Buf, "__DYNAMIC__=1");
608 DefineBuiltinMacro(Buf, "__FINITE_MATH_ONLY__=0");
609 DefineBuiltinMacro(Buf, "__NO_INLINE__=1");
610 DefineBuiltinMacro(Buf, "__PIC__=1");
Chris Lattner9b533162008-10-05 19:44:25 +0000611
Chris Lattner12f09262008-10-05 21:49:27 +0000612 // Macros to control C99 numerics and <float.h>
613 DefineBuiltinMacro(Buf, "__FLT_EVAL_METHOD__=0");
614 DefineBuiltinMacro(Buf, "__FLT_RADIX__=2");
615 sprintf(MacroBuf, "__DECIMAL_DIG__=%d",
616 PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33));
617 DefineBuiltinMacro(Buf, MacroBuf);
618
Chris Lattner9b533162008-10-05 19:44:25 +0000619 // Get other target #defines.
620 TI.getTargetDefines(Buf);
Chris Lattner53b0dab2007-10-09 22:10:18 +0000621
Chris Lattner53b0dab2007-10-09 22:10:18 +0000622 // FIXME: Should emit a #line directive here.
623}
624
625
626/// EnterMainSourceFile - Enter the specified FileID as the main source file,
Nate Begeman6b616022008-01-07 04:01:26 +0000627/// which implicitly adds the builtin defines etc.
Ted Kremenek95041a22007-12-19 22:51:13 +0000628void Preprocessor::EnterMainSourceFile() {
Chris Lattner05db4272009-02-13 19:33:24 +0000629 // We do not allow the preprocessor to reenter the main file. Doing so will
630 // cause FileID's to accumulate information from both runs (e.g. #line
631 // information) and predefined macros aren't guaranteed to be set properly.
632 assert(NumEnteredSourceFiles == 0 && "Cannot reenter the main file!");
Chris Lattner2b2453a2009-01-17 06:22:33 +0000633 FileID MainFileID = SourceMgr.getMainFileID();
Ted Kremenek95041a22007-12-19 22:51:13 +0000634
Chris Lattner53b0dab2007-10-09 22:10:18 +0000635 // Enter the main file source buffer.
636 EnterSourceFile(MainFileID, 0);
637
Chris Lattnerb2832982007-11-15 19:07:47 +0000638 // Tell the header info that the main file was entered. If the file is later
639 // #imported, it won't be re-entered.
Chris Lattner2b2453a2009-01-17 06:22:33 +0000640 if (const FileEntry *FE = SourceMgr.getFileEntryForID(MainFileID))
Chris Lattnerb2832982007-11-15 19:07:47 +0000641 HeaderInfo.IncrementIncludeCount(FE);
642
Chris Lattner53b0dab2007-10-09 22:10:18 +0000643 std::vector<char> PrologFile;
644 PrologFile.reserve(4080);
645
646 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
647 InitializePredefinedMacros(*this, PrologFile);
648
649 // Add on the predefines from the driver.
Chris Lattneraa391972008-04-19 23:09:31 +0000650 PrologFile.insert(PrologFile.end(), Predefines.begin(), Predefines.end());
Chris Lattner53b0dab2007-10-09 22:10:18 +0000651
652 // Memory buffer must end with a null byte!
653 PrologFile.push_back(0);
654
655 // Now that we have emitted the predefined macros, #includes, etc into
656 // PrologFile, preprocess it to populate the initial preprocessor state.
657 llvm::MemoryBuffer *SB =
658 llvm::MemoryBuffer::getMemBufferCopy(&PrologFile.front(),&PrologFile.back(),
659 "<predefines>");
660 assert(SB && "Cannot fail to create predefined source buffer");
Chris Lattner2b2453a2009-01-17 06:22:33 +0000661 FileID FID = SourceMgr.createFileIDForMemBuffer(SB);
662 assert(!FID.isInvalid() && "Could not create FileID for predefines?");
Chris Lattner53b0dab2007-10-09 22:10:18 +0000663
664 // Start parsing the predefines.
Chris Lattner2b2453a2009-01-17 06:22:33 +0000665 EnterSourceFile(FID, 0);
Chris Lattner53b0dab2007-10-09 22:10:18 +0000666}
Chris Lattner97ba77c2007-07-16 06:48:38 +0000667
Reid Spencer5f016e22007-07-11 17:01:13 +0000668
669//===----------------------------------------------------------------------===//
670// Lexer Event Handling.
671//===----------------------------------------------------------------------===//
672
673/// LookUpIdentifierInfo - Given a tok::identifier token, look up the
674/// identifier information for the token and install it into the token.
Chris Lattnerd2177732007-07-20 16:59:19 +0000675IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier,
Reid Spencer5f016e22007-07-11 17:01:13 +0000676 const char *BufPtr) {
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000677 assert(Identifier.is(tok::identifier) && "Not an identifier!");
Reid Spencer5f016e22007-07-11 17:01:13 +0000678 assert(Identifier.getIdentifierInfo() == 0 && "Identinfo already exists!");
679
680 // Look up this token, see if it is a macro, or if it is a language keyword.
681 IdentifierInfo *II;
682 if (BufPtr && !Identifier.needsCleaning()) {
683 // No cleaning needed, just use the characters from the lexed buffer.
684 II = getIdentifierInfo(BufPtr, BufPtr+Identifier.getLength());
685 } else {
686 // Cleaning needed, alloca a buffer, clean into it, then use the buffer.
Chris Lattnerc35717a2007-07-13 17:10:38 +0000687 llvm::SmallVector<char, 64> IdentifierBuffer;
688 IdentifierBuffer.resize(Identifier.getLength());
689 const char *TmpBuf = &IdentifierBuffer[0];
Reid Spencer5f016e22007-07-11 17:01:13 +0000690 unsigned Size = getSpelling(Identifier, TmpBuf);
691 II = getIdentifierInfo(TmpBuf, TmpBuf+Size);
692 }
693 Identifier.setIdentifierInfo(II);
694 return II;
695}
696
697
698/// HandleIdentifier - This callback is invoked when the lexer reads an
699/// identifier. This callback looks up the identifier in the map and/or
700/// potentially macro expands it or turns it into a named token (like 'for').
Chris Lattner6a170eb2009-01-21 07:43:11 +0000701///
702/// Note that callers of this method are guarded by checking the
703/// IdentifierInfo's 'isHandleIdentifierCase' bit. If this method changes, the
704/// IdentifierInfo methods that compute these properties will need to change to
705/// match.
Chris Lattnerd2177732007-07-20 16:59:19 +0000706void Preprocessor::HandleIdentifier(Token &Identifier) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000707 assert(Identifier.getIdentifierInfo() &&
708 "Can't handle identifiers without identifier info!");
709
710 IdentifierInfo &II = *Identifier.getIdentifierInfo();
711
712 // If this identifier was poisoned, and if it was not produced from a macro
713 // expansion, emit an error.
Ted Kremenek1a531572008-11-19 22:43:49 +0000714 if (II.isPoisoned() && CurPPLexer) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000715 if (&II != Ident__VA_ARGS__) // We warn about __VA_ARGS__ with poisoning.
716 Diag(Identifier, diag::err_pp_used_poisoned_id);
717 else
718 Diag(Identifier, diag::ext_pp_bad_vaargs_use);
719 }
720
721 // If this is a macro to be expanded, do it.
Chris Lattnercc1a8752007-10-07 08:44:20 +0000722 if (MacroInfo *MI = getMacroInfo(&II)) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000723 if (!DisableMacroExpansion && !Identifier.isExpandDisabled()) {
724 if (MI->isEnabled()) {
725 if (!HandleMacroExpandedIdentifier(Identifier, MI))
726 return;
727 } else {
728 // C99 6.10.3.4p2 says that a disabled macro may never again be
729 // expanded, even if it's in a context where it could be expanded in the
730 // future.
Chris Lattnerd2177732007-07-20 16:59:19 +0000731 Identifier.setFlag(Token::DisableExpand);
Reid Spencer5f016e22007-07-11 17:01:13 +0000732 }
733 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000734 }
735
736 // C++ 2.11p2: If this is an alternative representation of a C++ operator,
737 // then we act as if it is the actual operator and not the textual
738 // representation of it.
739 if (II.isCPlusPlusOperatorKeyword())
740 Identifier.setIdentifierInfo(0);
741
Reid Spencer5f016e22007-07-11 17:01:13 +0000742 // If this is an extension token, diagnose its use.
Steve Naroffb4eaf9c2008-09-02 18:50:17 +0000743 // We avoid diagnosing tokens that originate from macro definitions.
744 if (II.isExtensionToken() && Features.C99 && !DisableMacroExpansion)
Reid Spencer5f016e22007-07-11 17:01:13 +0000745 Diag(Identifier, diag::ext_token_used);
746}