blob: 3fa76fa1615abdaceec3d7574fdd7b4db42a944a [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.
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"
Reid Spencer5f016e22007-07-11 17:01:13 +000031#include "clang/Lex/Pragma.h"
32#include "clang/Lex/ScratchBuffer.h"
33#include "clang/Basic/Diagnostic.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000034#include "clang/Basic/SourceManager.h"
35#include "clang/Basic/TargetInfo.h"
Chris Lattner2db78dd2008-10-05 20:40:30 +000036#include "llvm/ADT/APFloat.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000037#include "llvm/ADT/SmallVector.h"
Chris Lattner97ba77c2007-07-16 06:48:38 +000038#include "llvm/Support/MemoryBuffer.h"
Ted Kremenekbdd30c22008-01-14 16:44:48 +000039#include "llvm/Support/Streams.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000040using namespace clang;
41
42//===----------------------------------------------------------------------===//
43
Ted Kremenekec6c5742008-04-17 21:23:07 +000044PreprocessorFactory::~PreprocessorFactory() {}
45
Reid Spencer5f016e22007-07-11 17:01:13 +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),
Ted Kremenek4b71e3e2008-11-19 00:44:06 +000051 CurPPLexer(0), CurDirLookup(0), Callbacks(0) {
Reid Spencer5f016e22007-07-11 17:01:13 +000052 ScratchBuf = new ScratchBuffer(SourceMgr);
Chris Lattner9594acf2007-07-15 00:25:26 +000053
Reid Spencer5f016e22007-07-11 17:01:13 +000054 // 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 Lattner6cfe7592008-03-09 02:26:03 +000070 NumCachedTokenLexers = 0;
Reid Spencer5f016e22007-07-11 17:01:13 +000071
Argyrios Kyrtzidis03db1b32008-08-10 13:15:22 +000072 CachedLexPos = 0;
73
Reid Spencer5f016e22007-07-11 17:01:13 +000074 // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
75 // This gets unpoisoned where it is allowed.
76 (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned();
77
78 // Initialize the pragma handlers.
79 PragmaHandlers = new PragmaNamespace(0);
80 RegisterBuiltinPragmas();
81
82 // Initialize builtin macros like __LINE__ and friends.
83 RegisterBuiltinMacros();
84}
85
86Preprocessor::~Preprocessor() {
Argyrios Kyrtzidis2174a4f2008-08-23 12:12:06 +000087 assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!");
88
Reid Spencer5f016e22007-07-11 17:01:13 +000089 while (!IncludeMacroStack.empty()) {
90 delete IncludeMacroStack.back().TheLexer;
Chris Lattner6cfe7592008-03-09 02:26:03 +000091 delete IncludeMacroStack.back().TheTokenLexer;
Reid Spencer5f016e22007-07-11 17:01:13 +000092 IncludeMacroStack.pop_back();
93 }
Chris Lattnercc1a8752007-10-07 08:44:20 +000094
95 // Free any macro definitions.
96 for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I =
97 Macros.begin(), E = Macros.end(); I != E; ++I) {
Ted Kremenek0ea76722008-12-15 19:56:42 +000098 // We don't need to free the MacroInfo objects directly. These
99 // will be released when the BumpPtrAllocator 'BP' object gets
100 // destroyed.
Chris Lattnercc1a8752007-10-07 08:44:20 +0000101 I->first->setHasMacroDefinition(false);
102 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000103
Chris Lattner9594acf2007-07-15 00:25:26 +0000104 // Free any cached macro expanders.
Chris Lattner6cfe7592008-03-09 02:26:03 +0000105 for (unsigned i = 0, e = NumCachedTokenLexers; i != e; ++i)
106 delete TokenLexerCache[i];
Chris Lattner9594acf2007-07-15 00:25:26 +0000107
Reid Spencer5f016e22007-07-11 17:01:13 +0000108 // Release pragma information.
109 delete PragmaHandlers;
110
111 // Delete the scratch buffer info.
112 delete ScratchBuf;
Chris Lattnereb50ed82008-03-14 06:07:05 +0000113
114 delete Callbacks;
Reid Spencer5f016e22007-07-11 17:01:13 +0000115}
116
Chris Lattnerd2177732007-07-20 16:59:19 +0000117void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000118 llvm::cerr << tok::getTokenName(Tok.getKind()) << " '"
119 << getSpelling(Tok) << "'";
Reid Spencer5f016e22007-07-11 17:01:13 +0000120
121 if (!DumpFlags) return;
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000122
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000123 llvm::cerr << "\t";
Reid Spencer5f016e22007-07-11 17:01:13 +0000124 if (Tok.isAtStartOfLine())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000125 llvm::cerr << " [StartOfLine]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000126 if (Tok.hasLeadingSpace())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000127 llvm::cerr << " [LeadingSpace]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000128 if (Tok.isExpandDisabled())
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000129 llvm::cerr << " [ExpandDisabled]";
Reid Spencer5f016e22007-07-11 17:01:13 +0000130 if (Tok.needsCleaning()) {
131 const char *Start = SourceMgr.getCharacterData(Tok.getLocation());
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000132 llvm::cerr << " [UnClean='" << std::string(Start, Start+Tok.getLength())
133 << "']";
Reid Spencer5f016e22007-07-11 17:01:13 +0000134 }
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000135
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000136 llvm::cerr << "\tLoc=<";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000137 DumpLocation(Tok.getLocation());
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000138 llvm::cerr << ">";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000139}
140
141void Preprocessor::DumpLocation(SourceLocation Loc) const {
142 SourceLocation LogLoc = SourceMgr.getLogicalLoc(Loc);
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000143 llvm::cerr << SourceMgr.getSourceName(LogLoc) << ':'
144 << SourceMgr.getLineNumber(LogLoc) << ':'
Ted Kremenek109949a2008-07-19 19:10:04 +0000145 << SourceMgr.getColumnNumber(LogLoc);
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000146
147 SourceLocation PhysLoc = SourceMgr.getPhysicalLoc(Loc);
148 if (PhysLoc != LogLoc) {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000149 llvm::cerr << " <PhysLoc=";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000150 DumpLocation(PhysLoc);
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000151 llvm::cerr << ">";
Chris Lattnerc3d8d572007-12-09 20:31:55 +0000152 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000153}
154
155void Preprocessor::DumpMacro(const MacroInfo &MI) const {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000156 llvm::cerr << "MACRO: ";
Reid Spencer5f016e22007-07-11 17:01:13 +0000157 for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) {
158 DumpToken(MI.getReplacementToken(i));
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000159 llvm::cerr << " ";
Reid Spencer5f016e22007-07-11 17:01:13 +0000160 }
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000161 llvm::cerr << "\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000162}
163
164void Preprocessor::PrintStats() {
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000165 llvm::cerr << "\n*** Preprocessor Stats:\n";
166 llvm::cerr << NumDirectives << " directives found:\n";
167 llvm::cerr << " " << NumDefined << " #define.\n";
168 llvm::cerr << " " << NumUndefined << " #undef.\n";
169 llvm::cerr << " #include/#include_next/#import:\n";
170 llvm::cerr << " " << NumEnteredSourceFiles << " source files entered.\n";
171 llvm::cerr << " " << MaxIncludeStackDepth << " max include stack depth\n";
172 llvm::cerr << " " << NumIf << " #if/#ifndef/#ifdef.\n";
173 llvm::cerr << " " << NumElse << " #else/#elif.\n";
174 llvm::cerr << " " << NumEndif << " #endif.\n";
175 llvm::cerr << " " << NumPragma << " #pragma.\n";
176 llvm::cerr << NumSkipped << " #if/#ifndef#ifdef regions skipped\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000177
Ted Kremenekbdd30c22008-01-14 16:44:48 +0000178 llvm::cerr << NumMacroExpanded << "/" << NumFnMacroExpanded << "/"
179 << NumBuiltinMacroExpanded << " obj/fn/builtin macros expanded, "
180 << NumFastMacroExpanded << " on the fast path.\n";
181 llvm::cerr << (NumFastTokenPaste+NumTokenPaste)
182 << " token paste (##) operations performed, "
183 << NumFastTokenPaste << " on the fast path.\n";
Reid Spencer5f016e22007-07-11 17:01:13 +0000184}
185
186//===----------------------------------------------------------------------===//
187// Token Spelling
188//===----------------------------------------------------------------------===//
189
190
191/// getSpelling() - Return the 'spelling' of this token. The spelling of a
192/// token are the characters used to represent the token in the source file
193/// after trigraph expansion and escaped-newline folding. In particular, this
194/// wants to get the true, uncanonicalized, spelling of things like digraphs
195/// UCNs, etc.
Chris Lattnerd2177732007-07-20 16:59:19 +0000196std::string Preprocessor::getSpelling(const Token &Tok) const {
Reid Spencer5f016e22007-07-11 17:01:13 +0000197 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
198
199 // If this token contains nothing interesting, return it directly.
200 const char *TokStart = SourceMgr.getCharacterData(Tok.getLocation());
201 if (!Tok.needsCleaning())
202 return std::string(TokStart, TokStart+Tok.getLength());
203
204 std::string Result;
205 Result.reserve(Tok.getLength());
206
207 // Otherwise, hard case, relex the characters into the string.
208 for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
209 Ptr != End; ) {
210 unsigned CharSize;
211 Result.push_back(Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features));
212 Ptr += CharSize;
213 }
214 assert(Result.size() != unsigned(Tok.getLength()) &&
215 "NeedsCleaning flag set on something that didn't need cleaning!");
216 return Result;
217}
218
219/// getSpelling - This method is used to get the spelling of a token into a
220/// preallocated buffer, instead of as an std::string. The caller is required
221/// to allocate enough space for the token, which is guaranteed to be at least
222/// Tok.getLength() bytes long. The actual length of the token is returned.
223///
224/// Note that this method may do two possible things: it may either fill in
225/// the buffer specified with characters, or it may *change the input pointer*
226/// to point to a constant buffer with the data already in it (avoiding a
227/// copy). The caller is not allowed to modify the returned buffer pointer
228/// if an internal buffer is returned.
Chris Lattnerd2177732007-07-20 16:59:19 +0000229unsigned Preprocessor::getSpelling(const Token &Tok,
Reid Spencer5f016e22007-07-11 17:01:13 +0000230 const char *&Buffer) const {
231 assert((int)Tok.getLength() >= 0 && "Token character range is bogus!");
232
233 // If this token is an identifier, just return the string from the identifier
234 // table, which is very quick.
235 if (const IdentifierInfo *II = Tok.getIdentifierInfo()) {
236 Buffer = II->getName();
Chris Lattner0f670322007-07-22 22:50:09 +0000237
238 // Return the length of the token. If the token needed cleaning, don't
239 // include the size of the newlines or trigraphs in it.
240 if (!Tok.needsCleaning())
241 return Tok.getLength();
242 else
243 return strlen(Buffer);
Reid Spencer5f016e22007-07-11 17:01:13 +0000244 }
245
246 // Otherwise, compute the start of the token in the input lexer buffer.
247 const char *TokStart = SourceMgr.getCharacterData(Tok.getLocation());
248
249 // If this token contains nothing interesting, return it directly.
250 if (!Tok.needsCleaning()) {
251 Buffer = TokStart;
252 return Tok.getLength();
253 }
254 // 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.
272SourceLocation Preprocessor::
273CreateString(const char *Buf, unsigned Len, SourceLocation SLoc) {
274 if (SLoc.isValid())
275 return ScratchBuf->getToken(Buf, Len, SLoc);
276 return ScratchBuf->getToken(Buf, Len);
277}
278
279
Chris Lattner97ba77c2007-07-16 06:48:38 +0000280/// AdvanceToTokenCharacter - Given a location that specifies the start of a
281/// token, return a new location that specifies a character within the token.
282SourceLocation Preprocessor::AdvanceToTokenCharacter(SourceLocation TokStart,
283 unsigned CharNo) {
Chris Lattner9dc1f532007-07-20 16:37:10 +0000284 // If they request the first char of the token, we're trivially done. If this
285 // is a macro expansion, it doesn't make sense to point to a character within
286 // the instantiation point (the name). We could point to the source
287 // character, but without also pointing to instantiation info, this is
288 // confusing.
289 if (CharNo == 0 || TokStart.isMacroID()) return TokStart;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000290
291 // Figure out how many physical characters away the specified logical
292 // character is. This needs to take into consideration newlines and
293 // trigraphs.
Chris Lattner9dc1f532007-07-20 16:37:10 +0000294 const char *TokPtr = SourceMgr.getCharacterData(TokStart);
295 unsigned PhysOffset = 0;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000296
297 // The usual case is that tokens don't contain anything interesting. Skip
298 // over the uninteresting characters. If a token only consists of simple
299 // chars, this method is extremely fast.
300 while (CharNo && Lexer::isObviouslySimpleCharacter(*TokPtr))
Chris Lattner9dc1f532007-07-20 16:37:10 +0000301 ++TokPtr, --CharNo, ++PhysOffset;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000302
303 // If we have a character that may be a trigraph or escaped newline, create a
304 // lexer to parse it correctly.
Chris Lattner97ba77c2007-07-16 06:48:38 +0000305 if (CharNo != 0) {
306 // Create a lexer starting at this token position.
Chris Lattner25bdb512007-07-20 16:52:03 +0000307 Lexer TheLexer(TokStart, *this, TokPtr);
Chris Lattnerd2177732007-07-20 16:59:19 +0000308 Token Tok;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000309 // Skip over characters the remaining characters.
Chris Lattner9dc1f532007-07-20 16:37:10 +0000310 const char *TokStartPtr = TokPtr;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000311 for (; CharNo; --CharNo)
312 TheLexer.getAndAdvanceChar(TokPtr, Tok);
Chris Lattner9dc1f532007-07-20 16:37:10 +0000313
314 PhysOffset += TokPtr-TokStartPtr;
Chris Lattner97ba77c2007-07-16 06:48:38 +0000315 }
Chris Lattner9dc1f532007-07-20 16:37:10 +0000316
317 return TokStart.getFileLocWithOffset(PhysOffset);
Chris Lattner97ba77c2007-07-16 06:48:38 +0000318}
319
320
Chris Lattner53b0dab2007-10-09 22:10:18 +0000321//===----------------------------------------------------------------------===//
322// Preprocessor Initialization Methods
323//===----------------------------------------------------------------------===//
324
325// Append a #define line to Buf for Macro. Macro should be of the form XXX,
326// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
327// "#define XXX Y z W". To get a #define with no value, use "XXX=".
328static void DefineBuiltinMacro(std::vector<char> &Buf, const char *Macro,
329 const char *Command = "#define ") {
330 Buf.insert(Buf.end(), Command, Command+strlen(Command));
331 if (const char *Equal = strchr(Macro, '=')) {
332 // Turn the = into ' '.
333 Buf.insert(Buf.end(), Macro, Equal);
334 Buf.push_back(' ');
335 Buf.insert(Buf.end(), Equal+1, Equal+strlen(Equal));
336 } else {
337 // Push "macroname 1".
338 Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
339 Buf.push_back(' ');
340 Buf.push_back('1');
341 }
342 Buf.push_back('\n');
343}
344
Chris Lattner2db78dd2008-10-05 20:40:30 +0000345/// PickFP - This is used to pick a value based on the FP semantics of the
346/// specified FP model.
347template <typename T>
348static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
349 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal) {
350 if (Sem == &llvm::APFloat::IEEEsingle)
351 return IEEESingleVal;
352 if (Sem == &llvm::APFloat::IEEEdouble)
353 return IEEEDoubleVal;
354 if (Sem == &llvm::APFloat::x87DoubleExtended)
355 return X87DoubleExtendedVal;
356 assert(Sem == &llvm::APFloat::PPCDoubleDouble);
357 return PPCDoubleDoubleVal;
358}
359
360static void DefineFloatMacros(std::vector<char> &Buf, const char *Prefix,
361 const llvm::fltSemantics *Sem) {
Chris Lattnere9863ca2008-10-05 21:40:58 +0000362 const char *DenormMin, *Epsilon, *Max, *Min;
363 DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
364 "3.64519953188247460253e-4951L",
365 "4.94065645841246544176568792868221e-324L");
366 int Digits = PickFP(Sem, 6, 15, 18, 31);
367 Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
368 "1.08420217248550443401e-19L",
369 "4.94065645841246544176568792868221e-324L");
370 int HasInifinity = 1, HasQuietNaN = 1;
371 int MantissaDigits = PickFP(Sem, 24, 53, 64, 106);
372 int Min10Exp = PickFP(Sem, -37, -307, -4931, -291);
373 int Max10Exp = PickFP(Sem, 38, 308, 4932, 308);
374 int MinExp = PickFP(Sem, -125, -1021, -16381, -968);
375 int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024);
376 Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
377 "3.36210314311209350626e-4932L",
378 "2.00416836000897277799610805135016e-292L");
379 Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
380 "1.18973149535723176502e+4932L",
381 "1.79769313486231580793728971405301e+308L");
Chris Lattner2db78dd2008-10-05 20:40:30 +0000382
383 char MacroBuf[60];
384 sprintf(MacroBuf, "__%s_DENORM_MIN__=%s", Prefix, DenormMin);
385 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattnere9863ca2008-10-05 21:40:58 +0000386 sprintf(MacroBuf, "__%s_DIG__=%d", Prefix, Digits);
387 DefineBuiltinMacro(Buf, MacroBuf);
388 sprintf(MacroBuf, "__%s_EPSILON__=%s", Prefix, Epsilon);
389 DefineBuiltinMacro(Buf, MacroBuf);
390 sprintf(MacroBuf, "__%s_HAS_INFINITY__=%d", Prefix, HasInifinity);
391 DefineBuiltinMacro(Buf, MacroBuf);
392 sprintf(MacroBuf, "__%s_HAS_QUIET_NAN__=%d", Prefix, HasQuietNaN);
393 DefineBuiltinMacro(Buf, MacroBuf);
394 sprintf(MacroBuf, "__%s_MANT_DIG__=%d", Prefix, MantissaDigits);
395 DefineBuiltinMacro(Buf, MacroBuf);
396 sprintf(MacroBuf, "__%s_MAX_10_EXP__=%d", Prefix, Max10Exp);
397 DefineBuiltinMacro(Buf, MacroBuf);
398 sprintf(MacroBuf, "__%s_MAX_EXP__=%d", Prefix, MaxExp);
399 DefineBuiltinMacro(Buf, MacroBuf);
400 sprintf(MacroBuf, "__%s_MAX__=%s", Prefix, Max);
401 DefineBuiltinMacro(Buf, MacroBuf);
402 sprintf(MacroBuf, "__%s_MIN_10_EXP__=(%d)", Prefix, Min10Exp);
403 DefineBuiltinMacro(Buf, MacroBuf);
404 sprintf(MacroBuf, "__%s_MIN_EXP__=(%d)", Prefix, MinExp);
405 DefineBuiltinMacro(Buf, MacroBuf);
406 sprintf(MacroBuf, "__%s_MIN__=%s", Prefix, Min);
407 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner2db78dd2008-10-05 20:40:30 +0000408}
409
Chris Lattner53b0dab2007-10-09 22:10:18 +0000410
411static void InitializePredefinedMacros(Preprocessor &PP,
412 std::vector<char> &Buf) {
Chris Lattner62213d92008-10-05 19:32:22 +0000413 // Compiler version introspection macros.
414 DefineBuiltinMacro(Buf, "__llvm__=1"); // LLVM Backend
415 DefineBuiltinMacro(Buf, "__clang__=1"); // Clang Frontend
416
417 // Currently claim to be compatible with GCC 4.2.1-5621.
418 DefineBuiltinMacro(Buf, "__APPLE_CC__=5621");
419 DefineBuiltinMacro(Buf, "__GNUC_MINOR__=2");
420 DefineBuiltinMacro(Buf, "__GNUC_PATCHLEVEL__=1");
421 DefineBuiltinMacro(Buf, "__GNUC__=4");
422 DefineBuiltinMacro(Buf, "__GXX_ABI_VERSION=1002");
423 DefineBuiltinMacro(Buf, "__VERSION__=\"4.2.1 (Apple Computer, Inc. "
424 "build 5621) (dot 3)\"");
425
426
427 // Initialize language-specific preprocessor defines.
428
Chris Lattner53b0dab2007-10-09 22:10:18 +0000429 // FIXME: Implement magic like cpp_init_builtins for things like __STDC__
430 // and __DATE__ etc.
Chris Lattner53b0dab2007-10-09 22:10:18 +0000431 // These should all be defined in the preprocessor according to the
432 // current language configuration.
433 DefineBuiltinMacro(Buf, "__STDC__=1");
Daniel Dunbarc1571452008-12-01 18:55:22 +0000434 if (PP.getLangOptions().AsmPreprocessor)
435 DefineBuiltinMacro(Buf, "__ASSEMBLER__=1");
Chris Lattner53b0dab2007-10-09 22:10:18 +0000436 if (PP.getLangOptions().C99 && !PP.getLangOptions().CPlusPlus)
437 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199901L");
438 else if (0) // STDC94 ?
439 DefineBuiltinMacro(Buf, "__STDC_VERSION__=199409L");
440
441 DefineBuiltinMacro(Buf, "__STDC_HOSTED__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000442 if (PP.getLangOptions().ObjC1) {
Chris Lattner53b0dab2007-10-09 22:10:18 +0000443 DefineBuiltinMacro(Buf, "__OBJC__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000444
445 if (PP.getLangOptions().getGCMode() == LangOptions::NonGC) {
446 DefineBuiltinMacro(Buf, "__weak=");
447 DefineBuiltinMacro(Buf, "__strong=");
448 } else {
449 DefineBuiltinMacro(Buf, "__weak=__attribute__((objc_gc(weak)))");
450 DefineBuiltinMacro(Buf, "__strong=__attribute__((objc_gc(strong)))");
451 DefineBuiltinMacro(Buf, "__OBJC_GC__=1");
452 }
453
454 if (PP.getLangOptions().NeXTRuntime)
455 DefineBuiltinMacro(Buf, "__NEXT_RUNTIME__=1");
Daniel Dunbarfba5cb12008-08-12 00:21:46 +0000456 }
Chris Lattner9b533162008-10-05 19:44:25 +0000457
Chris Lattnereb52b442008-10-06 07:43:09 +0000458 // darwin_constant_cfstrings controls this. This is also dependent
459 // on other things like the runtime I believe. This is set even for C code.
460 DefineBuiltinMacro(Buf, "__CONSTANT_CFSTRINGS__=1");
461
Steve Naroff73b17cd2008-05-15 21:12:10 +0000462 if (PP.getLangOptions().ObjC2)
463 DefineBuiltinMacro(Buf, "OBJC_NEW_PROPERTIES");
Steve Naroff8ee529b2007-10-31 18:42:27 +0000464
Chris Lattner048dd942008-09-30 00:48:48 +0000465 if (PP.getLangOptions().PascalStrings)
466 DefineBuiltinMacro(Buf, "__PASCAL_STRINGS__");
467
Chris Lattner62213d92008-10-05 19:32:22 +0000468 if (PP.getLangOptions().Blocks) {
469 DefineBuiltinMacro(Buf, "__block=__attribute__((__blocks__(byref)))");
470 DefineBuiltinMacro(Buf, "__BLOCKS__=1");
Chris Lattner2b43ad92008-10-05 19:32:52 +0000471 }
Chris Lattner62213d92008-10-05 19:32:22 +0000472
473 if (PP.getLangOptions().CPlusPlus) {
474 DefineBuiltinMacro(Buf, "__DEPRECATED=1");
475 DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
476 DefineBuiltinMacro(Buf, "__GNUG__=4");
477 DefineBuiltinMacro(Buf, "__GXX_WEAK__=1");
478 DefineBuiltinMacro(Buf, "__cplusplus=1");
479 DefineBuiltinMacro(Buf, "__private_extern__=extern");
480 }
481
482 // Filter out some microsoft extensions when trying to parse in ms-compat
483 // mode.
484 if (PP.getLangOptions().Microsoft) {
485 DefineBuiltinMacro(Buf, "__stdcall=");
486 DefineBuiltinMacro(Buf, "__cdecl=");
487 DefineBuiltinMacro(Buf, "_cdecl=");
488 DefineBuiltinMacro(Buf, "__ptr64=");
489 DefineBuiltinMacro(Buf, "__w64=");
490 DefineBuiltinMacro(Buf, "__forceinline=");
491 DefineBuiltinMacro(Buf, "__int8=char");
492 DefineBuiltinMacro(Buf, "__int16=short");
493 DefineBuiltinMacro(Buf, "__int32=int");
494 DefineBuiltinMacro(Buf, "__int64=long long");
495 DefineBuiltinMacro(Buf, "__declspec(X)=");
496 }
497
498
499 // Initialize target-specific preprocessor defines.
Chris Lattner9b533162008-10-05 19:44:25 +0000500 const TargetInfo &TI = PP.getTargetInfo();
501
502 // Define type sizing macros based on the target properties.
503 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
504 DefineBuiltinMacro(Buf, "__CHAR_BIT__=8");
505 DefineBuiltinMacro(Buf, "__SCHAR_MAX__=127");
Chris Lattner2db78dd2008-10-05 20:40:30 +0000506
507 assert(TI.getWCharWidth() == 32 && "Only support 32-bit wchar so far");
508 DefineBuiltinMacro(Buf, "__WCHAR_MAX__=2147483647");
509 DefineBuiltinMacro(Buf, "__WCHAR_TYPE__=int");
510 DefineBuiltinMacro(Buf, "__WINT_TYPE__=int");
Chris Lattner9b533162008-10-05 19:44:25 +0000511
512 assert(TI.getShortWidth() == 16 && "Only support 16-bit short so far");
Chris Lattner9b533162008-10-05 19:44:25 +0000513 DefineBuiltinMacro(Buf, "__SHRT_MAX__=32767");
514
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000515 if (TI.getIntWidth() == 32)
516 DefineBuiltinMacro(Buf, "__INT_MAX__=2147483647");
517 else if (TI.getIntWidth() == 16)
518 DefineBuiltinMacro(Buf, "__INT_MAX__=32767");
519 else
520 assert(0 && "Unknown integer size");
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000521
522 if (TI.getLongLongWidth() == 64)
523 DefineBuiltinMacro(Buf, "__LONG_LONG_MAX__=9223372036854775807LL");
524 else if (TI.getLongLongWidth() == 32)
525 DefineBuiltinMacro(Buf, "__LONG_LONG_MAX__=2147483647L");
Chris Lattner9b533162008-10-05 19:44:25 +0000526
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000527 if (TI.getLongWidth() == 32)
528 DefineBuiltinMacro(Buf, "__LONG_MAX__=2147483647L");
529 else if (TI.getLongWidth() == 64)
530 DefineBuiltinMacro(Buf, "__LONG_MAX__=9223372036854775807L");
531 else if (TI.getLongWidth() == 16)
532 DefineBuiltinMacro(Buf, "__LONG_MAX__=32767L");
533 else
534 assert(0 && "Unknown long size");
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000535 char MacroBuf[60];
536 sprintf(MacroBuf, "__INTMAX_MAX__=%lld",
537 (TI.getIntMaxType() == TargetInfo::UnsignedLongLong?
Sanjiv Gupta73608a82008-10-31 10:24:31 +0000538 (1LL << (TI.getLongLongWidth() - 1)) :
539 ((1LL << (TI.getLongLongWidth() - 2)) - 1)));
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000540 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000541
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000542 if (TI.getIntMaxType() == TargetInfo::UnsignedLongLong)
543 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned long long int");
544 else if (TI.getIntMaxType() == TargetInfo::SignedLongLong)
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000545 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=long long int");
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000546 else if (TI.getIntMaxType() == TargetInfo::UnsignedLong)
547 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned long int");
548 else if (TI.getIntMaxType() == TargetInfo::SignedLong)
549 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=long int");
550 else if (TI.getIntMaxType() == TargetInfo::UnsignedInt)
551 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=unsigned int");
552 else
553 DefineBuiltinMacro(Buf, "__INTMAX_TYPE__=int");
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000554
Sanjiv Gupta31fc07d2008-10-31 09:52:39 +0000555 if (TI.getUIntMaxType() == TargetInfo::UnsignedLongLong)
556 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned long long int");
557 else if (TI.getUIntMaxType() == TargetInfo::SignedLongLong)
558 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=long long int");
559 else if (TI.getUIntMaxType() == TargetInfo::UnsignedLong)
560 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned long int");
561 else if (TI.getUIntMaxType() == TargetInfo::SignedLong)
562 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=long int");
563 else if (TI.getUIntMaxType() == TargetInfo::UnsignedInt)
564 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=unsigned int");
565 else
566 DefineBuiltinMacro(Buf, "__UINTMAX_TYPE__=int");
567
568 if (TI.getPtrDiffType(0) == TargetInfo::UnsignedLongLong)
569 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned long long int");
570 else if (TI.getPtrDiffType(0) == TargetInfo::SignedLongLong)
571 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=long long int");
572 else if (TI.getPtrDiffType(0) == TargetInfo::UnsignedLong)
573 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned long int");
574 else if (TI.getPtrDiffType(0) == TargetInfo::SignedLong)
575 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=long int");
576 else if (TI.getPtrDiffType(0) == TargetInfo::UnsignedInt)
577 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=unsigned int");
578 else
579 DefineBuiltinMacro(Buf, "__PTRDIFF_TYPE__=int");
580
581 if (TI.getSizeType() == TargetInfo::UnsignedLongLong)
582 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned long long int");
583 else if (TI.getSizeType() == TargetInfo::SignedLongLong)
584 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=long long int");
585 else if (TI.getSizeType() == TargetInfo::UnsignedLong)
586 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned long int");
587 else if (TI.getSizeType() == TargetInfo::SignedLong)
588 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=long int");
589 else if (TI.getSizeType() == TargetInfo::UnsignedInt)
590 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned int");
591 else if (TI.getSizeType() == TargetInfo::SignedInt)
592 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=int");
593 else
594 DefineBuiltinMacro(Buf, "__SIZE_TYPE__=unsigned short");
595
Chris Lattner2db78dd2008-10-05 20:40:30 +0000596 DefineFloatMacros(Buf, "FLT", &TI.getFloatFormat());
597 DefineFloatMacros(Buf, "DBL", &TI.getDoubleFormat());
598 DefineFloatMacros(Buf, "LDBL", &TI.getLongDoubleFormat());
Chris Lattner0e5d4ef2008-10-05 20:06:37 +0000599
Chris Lattner048dd942008-09-30 00:48:48 +0000600
Chris Lattnerd19144b2007-10-10 17:48:53 +0000601 // Add __builtin_va_list typedef.
602 {
Chris Lattner9b533162008-10-05 19:44:25 +0000603 const char *VAList = TI.getVAListDeclaration();
Chris Lattnerd19144b2007-10-10 17:48:53 +0000604 Buf.insert(Buf.end(), VAList, VAList+strlen(VAList));
605 Buf.push_back('\n');
606 }
Chris Lattner53b0dab2007-10-09 22:10:18 +0000607
Chris Lattner9b533162008-10-05 19:44:25 +0000608 if (const char *Prefix = TI.getUserLabelPrefix()) {
Chris Lattner12f09262008-10-05 21:49:27 +0000609 sprintf(MacroBuf, "__USER_LABEL_PREFIX__=%s", Prefix);
610 DefineBuiltinMacro(Buf, MacroBuf);
Chris Lattner3fdf4672008-10-05 19:22:37 +0000611 }
612
Chris Lattner9b533162008-10-05 19:44:25 +0000613 // Build configuration options. FIXME: these should be controlled by
614 // command line options or something.
Chris Lattner53b0dab2007-10-09 22:10:18 +0000615 DefineBuiltinMacro(Buf, "__DYNAMIC__=1");
616 DefineBuiltinMacro(Buf, "__FINITE_MATH_ONLY__=0");
617 DefineBuiltinMacro(Buf, "__NO_INLINE__=1");
618 DefineBuiltinMacro(Buf, "__PIC__=1");
Chris Lattner9b533162008-10-05 19:44:25 +0000619
Chris Lattner12f09262008-10-05 21:49:27 +0000620 // Macros to control C99 numerics and <float.h>
621 DefineBuiltinMacro(Buf, "__FLT_EVAL_METHOD__=0");
622 DefineBuiltinMacro(Buf, "__FLT_RADIX__=2");
623 sprintf(MacroBuf, "__DECIMAL_DIG__=%d",
624 PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33));
625 DefineBuiltinMacro(Buf, MacroBuf);
626
Chris Lattner9b533162008-10-05 19:44:25 +0000627 // Get other target #defines.
628 TI.getTargetDefines(Buf);
Chris Lattner53b0dab2007-10-09 22:10:18 +0000629
Chris Lattner53b0dab2007-10-09 22:10:18 +0000630 // FIXME: Should emit a #line directive here.
631}
632
633
634/// EnterMainSourceFile - Enter the specified FileID as the main source file,
Nate Begeman6b616022008-01-07 04:01:26 +0000635/// which implicitly adds the builtin defines etc.
Ted Kremenek95041a22007-12-19 22:51:13 +0000636void Preprocessor::EnterMainSourceFile() {
637
638 unsigned MainFileID = SourceMgr.getMainFileID();
639
Chris Lattner53b0dab2007-10-09 22:10:18 +0000640 // Enter the main file source buffer.
641 EnterSourceFile(MainFileID, 0);
642
Chris Lattnerb2832982007-11-15 19:07:47 +0000643 // Tell the header info that the main file was entered. If the file is later
644 // #imported, it won't be re-entered.
645 if (const FileEntry *FE =
646 SourceMgr.getFileEntryForLoc(SourceLocation::getFileLoc(MainFileID, 0)))
647 HeaderInfo.IncrementIncludeCount(FE);
648
Chris Lattner53b0dab2007-10-09 22:10:18 +0000649 std::vector<char> PrologFile;
650 PrologFile.reserve(4080);
651
652 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
653 InitializePredefinedMacros(*this, PrologFile);
654
655 // Add on the predefines from the driver.
Chris Lattneraa391972008-04-19 23:09:31 +0000656 PrologFile.insert(PrologFile.end(), Predefines.begin(), Predefines.end());
Chris Lattner53b0dab2007-10-09 22:10:18 +0000657
658 // Memory buffer must end with a null byte!
659 PrologFile.push_back(0);
660
661 // Now that we have emitted the predefined macros, #includes, etc into
662 // PrologFile, preprocess it to populate the initial preprocessor state.
663 llvm::MemoryBuffer *SB =
664 llvm::MemoryBuffer::getMemBufferCopy(&PrologFile.front(),&PrologFile.back(),
665 "<predefines>");
666 assert(SB && "Cannot fail to create predefined source buffer");
667 unsigned FileID = SourceMgr.createFileIDForMemBuffer(SB);
668 assert(FileID && "Could not create FileID for predefines?");
669
670 // Start parsing the predefines.
671 EnterSourceFile(FileID, 0);
672}
Chris Lattner97ba77c2007-07-16 06:48:38 +0000673
Reid Spencer5f016e22007-07-11 17:01:13 +0000674
675//===----------------------------------------------------------------------===//
676// Lexer Event Handling.
677//===----------------------------------------------------------------------===//
678
679/// LookUpIdentifierInfo - Given a tok::identifier token, look up the
680/// identifier information for the token and install it into the token.
Chris Lattnerd2177732007-07-20 16:59:19 +0000681IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier,
Reid Spencer5f016e22007-07-11 17:01:13 +0000682 const char *BufPtr) {
Chris Lattner22f6bbc2007-10-09 18:02:16 +0000683 assert(Identifier.is(tok::identifier) && "Not an identifier!");
Reid Spencer5f016e22007-07-11 17:01:13 +0000684 assert(Identifier.getIdentifierInfo() == 0 && "Identinfo already exists!");
685
686 // Look up this token, see if it is a macro, or if it is a language keyword.
687 IdentifierInfo *II;
688 if (BufPtr && !Identifier.needsCleaning()) {
689 // No cleaning needed, just use the characters from the lexed buffer.
690 II = getIdentifierInfo(BufPtr, BufPtr+Identifier.getLength());
691 } else {
692 // Cleaning needed, alloca a buffer, clean into it, then use the buffer.
Chris Lattnerc35717a2007-07-13 17:10:38 +0000693 llvm::SmallVector<char, 64> IdentifierBuffer;
694 IdentifierBuffer.resize(Identifier.getLength());
695 const char *TmpBuf = &IdentifierBuffer[0];
Reid Spencer5f016e22007-07-11 17:01:13 +0000696 unsigned Size = getSpelling(Identifier, TmpBuf);
697 II = getIdentifierInfo(TmpBuf, TmpBuf+Size);
698 }
699 Identifier.setIdentifierInfo(II);
700 return II;
701}
702
703
704/// HandleIdentifier - This callback is invoked when the lexer reads an
705/// identifier. This callback looks up the identifier in the map and/or
706/// potentially macro expands it or turns it into a named token (like 'for').
Chris Lattnerd2177732007-07-20 16:59:19 +0000707void Preprocessor::HandleIdentifier(Token &Identifier) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000708 assert(Identifier.getIdentifierInfo() &&
709 "Can't handle identifiers without identifier info!");
710
711 IdentifierInfo &II = *Identifier.getIdentifierInfo();
712
713 // If this identifier was poisoned, and if it was not produced from a macro
714 // expansion, emit an error.
Ted Kremenek1a531572008-11-19 22:43:49 +0000715 if (II.isPoisoned() && CurPPLexer) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000716 if (&II != Ident__VA_ARGS__) // We warn about __VA_ARGS__ with poisoning.
717 Diag(Identifier, diag::err_pp_used_poisoned_id);
718 else
719 Diag(Identifier, diag::ext_pp_bad_vaargs_use);
720 }
721
722 // If this is a macro to be expanded, do it.
Chris Lattnercc1a8752007-10-07 08:44:20 +0000723 if (MacroInfo *MI = getMacroInfo(&II)) {
Reid Spencer5f016e22007-07-11 17:01:13 +0000724 if (!DisableMacroExpansion && !Identifier.isExpandDisabled()) {
725 if (MI->isEnabled()) {
726 if (!HandleMacroExpandedIdentifier(Identifier, MI))
727 return;
728 } else {
729 // C99 6.10.3.4p2 says that a disabled macro may never again be
730 // expanded, even if it's in a context where it could be expanded in the
731 // future.
Chris Lattnerd2177732007-07-20 16:59:19 +0000732 Identifier.setFlag(Token::DisableExpand);
Reid Spencer5f016e22007-07-11 17:01:13 +0000733 }
734 }
Reid Spencer5f016e22007-07-11 17:01:13 +0000735 }
736
737 // C++ 2.11p2: If this is an alternative representation of a C++ operator,
738 // then we act as if it is the actual operator and not the textual
739 // representation of it.
740 if (II.isCPlusPlusOperatorKeyword())
741 Identifier.setIdentifierInfo(0);
742
743 // Change the kind of this identifier to the appropriate token kind, e.g.
744 // turning "for" into a keyword.
745 Identifier.setKind(II.getTokenID());
746
747 // If this is an extension token, diagnose its use.
Steve Naroffb4eaf9c2008-09-02 18:50:17 +0000748 // We avoid diagnosing tokens that originate from macro definitions.
749 if (II.isExtensionToken() && Features.C99 && !DisableMacroExpansion)
Reid Spencer5f016e22007-07-11 17:01:13 +0000750 Diag(Identifier, diag::ext_token_used);
751}