Preprocessor.cpp revision dbf15cb5709067b3d23b3cdd8d014610ba4a8783
1//===--- Preprocess.cpp - C Language Family Preprocessor Implementation ---===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file implements the Preprocessor interface.
11//
12//===----------------------------------------------------------------------===//
13//
14// Options to support:
15//   -H       - Print the name of each header file used.
16//   -d[DNI] - 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"
31#include "clang/Lex/Pragma.h"
32#include "clang/Lex/ScratchBuffer.h"
33#include "clang/Lex/LexDiagnostic.h"
34#include "clang/Basic/SourceManager.h"
35#include "clang/Basic/FileManager.h"
36#include "clang/Basic/TargetInfo.h"
37#include "llvm/ADT/APFloat.h"
38#include "llvm/ADT/SmallVector.h"
39#include "llvm/Support/MemoryBuffer.h"
40#include "llvm/Support/Streams.h"
41#include <cstdio>
42using namespace clang;
43
44//===----------------------------------------------------------------------===//
45
46PreprocessorFactory::~PreprocessorFactory() {}
47
48Preprocessor::Preprocessor(Diagnostic &diags, const LangOptions &opts,
49                           TargetInfo &target, SourceManager &SM,
50                           HeaderSearch &Headers,
51                           IdentifierInfoLookup* IILookup)
52  : Diags(&diags), Features(opts), Target(target),FileMgr(Headers.getFileMgr()),
53    SourceMgr(SM), HeaderInfo(Headers), Identifiers(opts, IILookup),
54    CurPPLexer(0), CurDirLookup(0), Callbacks(0) {
55  ScratchBuf = new ScratchBuffer(SourceMgr);
56
57  // Clear stats.
58  NumDirectives = NumDefined = NumUndefined = NumPragma = 0;
59  NumIf = NumElse = NumEndif = 0;
60  NumEnteredSourceFiles = 0;
61  NumMacroExpanded = NumFnMacroExpanded = NumBuiltinMacroExpanded = 0;
62  NumFastMacroExpanded = NumTokenPaste = NumFastTokenPaste = 0;
63  MaxIncludeStackDepth = 0;
64  NumSkipped = 0;
65
66  // Default to discarding comments.
67  KeepComments = false;
68  KeepMacroComments = false;
69
70  // Macro expansion is enabled.
71  DisableMacroExpansion = false;
72  InMacroArgs = false;
73  NumCachedTokenLexers = 0;
74
75  CachedLexPos = 0;
76
77  // "Poison" __VA_ARGS__, which can only appear in the expansion of a macro.
78  // This gets unpoisoned where it is allowed.
79  (Ident__VA_ARGS__ = getIdentifierInfo("__VA_ARGS__"))->setIsPoisoned();
80
81  // Initialize the pragma handlers.
82  PragmaHandlers = new PragmaNamespace(0);
83  RegisterBuiltinPragmas();
84
85  // Initialize builtin macros like __LINE__ and friends.
86  RegisterBuiltinMacros();
87}
88
89Preprocessor::~Preprocessor() {
90  assert(BacktrackPositions.empty() && "EnableBacktrack/Backtrack imbalance!");
91
92  while (!IncludeMacroStack.empty()) {
93    delete IncludeMacroStack.back().TheLexer;
94    delete IncludeMacroStack.back().TheTokenLexer;
95    IncludeMacroStack.pop_back();
96  }
97
98  // Free any macro definitions.
99  for (llvm::DenseMap<IdentifierInfo*, MacroInfo*>::iterator I =
100       Macros.begin(), E = Macros.end(); I != E; ++I) {
101    // We don't need to free the MacroInfo objects directly.  These
102    // will be released when the BumpPtrAllocator 'BP' object gets
103    // destroyed. We still need to run the dstor, however, to free
104    // memory alocated by MacroInfo.
105    I->second->Destroy(BP);
106    I->first->setHasMacroDefinition(false);
107  }
108
109  // Free any cached macro expanders.
110  for (unsigned i = 0, e = NumCachedTokenLexers; i != e; ++i)
111    delete TokenLexerCache[i];
112
113  // Release pragma information.
114  delete PragmaHandlers;
115
116  // Delete the scratch buffer info.
117  delete ScratchBuf;
118
119  delete Callbacks;
120}
121
122void Preprocessor::setPTHManager(PTHManager* pm) {
123  PTH.reset(pm);
124  FileMgr.setStatCache(PTH->createStatCache());
125}
126
127void Preprocessor::DumpToken(const Token &Tok, bool DumpFlags) const {
128  llvm::cerr << tok::getTokenName(Tok.getKind()) << " '"
129             << getSpelling(Tok) << "'";
130
131  if (!DumpFlags) return;
132
133  llvm::cerr << "\t";
134  if (Tok.isAtStartOfLine())
135    llvm::cerr << " [StartOfLine]";
136  if (Tok.hasLeadingSpace())
137    llvm::cerr << " [LeadingSpace]";
138  if (Tok.isExpandDisabled())
139    llvm::cerr << " [ExpandDisabled]";
140  if (Tok.needsCleaning()) {
141    const char *Start = SourceMgr.getCharacterData(Tok.getLocation());
142    llvm::cerr << " [UnClean='" << std::string(Start, Start+Tok.getLength())
143               << "']";
144  }
145
146  llvm::cerr << "\tLoc=<";
147  DumpLocation(Tok.getLocation());
148  llvm::cerr << ">";
149}
150
151void Preprocessor::DumpLocation(SourceLocation Loc) const {
152  Loc.dump(SourceMgr);
153}
154
155void Preprocessor::DumpMacro(const MacroInfo &MI) const {
156  llvm::cerr << "MACRO: ";
157  for (unsigned i = 0, e = MI.getNumTokens(); i != e; ++i) {
158    DumpToken(MI.getReplacementToken(i));
159    llvm::cerr << "  ";
160  }
161  llvm::cerr << "\n";
162}
163
164void Preprocessor::PrintStats() {
165  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";
177
178  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";
184}
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.
196std::string Preprocessor::getSpelling(const Token &Tok) const {
197  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.
229unsigned Preprocessor::getSpelling(const Token &Tok,
230                                   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();
237    return II->getLength();
238  }
239
240  // Otherwise, compute the start of the token in the input lexer buffer.
241  const char *TokStart = 0;
242
243  if (Tok.isLiteral())
244    TokStart = Tok.getLiteralData();
245
246  if (TokStart == 0)
247    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
255  // Otherwise, hard case, relex the characters into the string.
256  char *OutBuf = const_cast<char*>(Buffer);
257  for (const char *Ptr = TokStart, *End = TokStart+Tok.getLength();
258       Ptr != End; ) {
259    unsigned CharSize;
260    *OutBuf++ = Lexer::getCharAndSizeNoWarn(Ptr, CharSize, Features);
261    Ptr += CharSize;
262  }
263  assert(unsigned(OutBuf-Buffer) != Tok.getLength() &&
264         "NeedsCleaning flag set on something that didn't need cleaning!");
265
266  return OutBuf-Buffer;
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.
272void 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,
281                                           InstantiationLoc, Len);
282  Tok.setLocation(Loc);
283
284  // If this is a literal token, set the pointer data.
285  if (Tok.isLiteral())
286    Tok.setLiteralData(DestPtr);
287}
288
289
290/// AdvanceToTokenCharacter - Given a location that specifies the start of a
291/// token, return a new location that specifies a character within the token.
292SourceLocation Preprocessor::AdvanceToTokenCharacter(SourceLocation TokStart,
293                                                     unsigned CharNo) {
294  // If they request the first char of the token, we're trivially done.
295  if (CharNo == 0) return TokStart;
296
297  // Figure out how many physical characters away the specified instantiation
298  // character is.  This needs to take into consideration newlines and
299  // trigraphs.
300  const char *TokPtr = SourceMgr.getCharacterData(TokStart);
301  unsigned PhysOffset = 0;
302
303  // The usual case is that tokens don't contain anything interesting.  Skip
304  // over the uninteresting characters.  If a token only consists of simple
305  // chars, this method is extremely fast.
306  while (CharNo && Lexer::isObviouslySimpleCharacter(*TokPtr))
307    ++TokPtr, --CharNo, ++PhysOffset;
308
309  // If we have a character that may be a trigraph or escaped newline, use a
310  // lexer to parse it correctly.
311  if (CharNo != 0) {
312    // Skip over characters the remaining characters.
313    for (; CharNo; --CharNo) {
314      unsigned Size;
315      Lexer::getCharAndSizeNoWarn(TokPtr, Size, Features);
316      TokPtr += Size;
317      PhysOffset += Size;
318    }
319  }
320
321  return TokStart.getFileLocWithOffset(PhysOffset);
322}
323
324/// \brief Computes the source location just past the end of the
325/// token at this source location.
326///
327/// This routine can be used to produce a source location that
328/// points just past the end of the token referenced by \p Loc, and
329/// is generally used when a diagnostic needs to point just after a
330/// token where it expected something different that it received. If
331/// the returned source location would not be meaningful (e.g., if
332/// it points into a macro), this routine returns an invalid
333/// source location.
334SourceLocation Preprocessor::getLocForEndOfToken(SourceLocation Loc) {
335  if (Loc.isInvalid() || !Loc.isFileID())
336    return SourceLocation();
337
338  unsigned Len = Lexer::MeasureTokenLength(Loc, getSourceManager());
339  return AdvanceToTokenCharacter(Loc, Len);
340}
341
342
343
344//===----------------------------------------------------------------------===//
345// Preprocessor Initialization Methods
346//===----------------------------------------------------------------------===//
347
348// Append a #define line to Buf for Macro.  Macro should be of the form XXX,
349// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
350// "#define XXX Y z W".  To get a #define with no value, use "XXX=".
351static void DefineBuiltinMacro(std::vector<char> &Buf, const char *Macro,
352                               const char *Command = "#define ") {
353  Buf.insert(Buf.end(), Command, Command+strlen(Command));
354  if (const char *Equal = strchr(Macro, '=')) {
355    // Turn the = into ' '.
356    Buf.insert(Buf.end(), Macro, Equal);
357    Buf.push_back(' ');
358    Buf.insert(Buf.end(), Equal+1, Equal+strlen(Equal));
359  } else {
360    // Push "macroname 1".
361    Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
362    Buf.push_back(' ');
363    Buf.push_back('1');
364  }
365  Buf.push_back('\n');
366}
367
368/// PickFP - This is used to pick a value based on the FP semantics of the
369/// specified FP model.
370template <typename T>
371static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
372                T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal) {
373  if (Sem == &llvm::APFloat::IEEEsingle)
374    return IEEESingleVal;
375  if (Sem == &llvm::APFloat::IEEEdouble)
376    return IEEEDoubleVal;
377  if (Sem == &llvm::APFloat::x87DoubleExtended)
378    return X87DoubleExtendedVal;
379  assert(Sem == &llvm::APFloat::PPCDoubleDouble);
380  return PPCDoubleDoubleVal;
381}
382
383static void DefineFloatMacros(std::vector<char> &Buf, const char *Prefix,
384                              const llvm::fltSemantics *Sem) {
385  const char *DenormMin, *Epsilon, *Max, *Min;
386  DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
387                     "3.64519953188247460253e-4951L",
388                     "4.94065645841246544176568792868221e-324L");
389  int Digits = PickFP(Sem, 6, 15, 18, 31);
390  Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
391                   "1.08420217248550443401e-19L",
392                   "4.94065645841246544176568792868221e-324L");
393  int HasInifinity = 1, HasQuietNaN = 1;
394  int MantissaDigits = PickFP(Sem, 24, 53, 64, 106);
395  int Min10Exp = PickFP(Sem, -37, -307, -4931, -291);
396  int Max10Exp = PickFP(Sem, 38, 308, 4932, 308);
397  int MinExp = PickFP(Sem, -125, -1021, -16381, -968);
398  int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024);
399  Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
400               "3.36210314311209350626e-4932L",
401               "2.00416836000897277799610805135016e-292L");
402  Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
403               "1.18973149535723176502e+4932L",
404               "1.79769313486231580793728971405301e+308L");
405
406  char MacroBuf[60];
407  sprintf(MacroBuf, "__%s_DENORM_MIN__=%s", Prefix, DenormMin);
408  DefineBuiltinMacro(Buf, MacroBuf);
409  sprintf(MacroBuf, "__%s_DIG__=%d", Prefix, Digits);
410  DefineBuiltinMacro(Buf, MacroBuf);
411  sprintf(MacroBuf, "__%s_EPSILON__=%s", Prefix, Epsilon);
412  DefineBuiltinMacro(Buf, MacroBuf);
413  sprintf(MacroBuf, "__%s_HAS_INFINITY__=%d", Prefix, HasInifinity);
414  DefineBuiltinMacro(Buf, MacroBuf);
415  sprintf(MacroBuf, "__%s_HAS_QUIET_NAN__=%d", Prefix, HasQuietNaN);
416  DefineBuiltinMacro(Buf, MacroBuf);
417  sprintf(MacroBuf, "__%s_MANT_DIG__=%d", Prefix, MantissaDigits);
418  DefineBuiltinMacro(Buf, MacroBuf);
419  sprintf(MacroBuf, "__%s_MAX_10_EXP__=%d", Prefix, Max10Exp);
420  DefineBuiltinMacro(Buf, MacroBuf);
421  sprintf(MacroBuf, "__%s_MAX_EXP__=%d", Prefix, MaxExp);
422  DefineBuiltinMacro(Buf, MacroBuf);
423  sprintf(MacroBuf, "__%s_MAX__=%s", Prefix, Max);
424  DefineBuiltinMacro(Buf, MacroBuf);
425  sprintf(MacroBuf, "__%s_MIN_10_EXP__=(%d)", Prefix, Min10Exp);
426  DefineBuiltinMacro(Buf, MacroBuf);
427  sprintf(MacroBuf, "__%s_MIN_EXP__=(%d)", Prefix, MinExp);
428  DefineBuiltinMacro(Buf, MacroBuf);
429  sprintf(MacroBuf, "__%s_MIN__=%s", Prefix, Min);
430  DefineBuiltinMacro(Buf, MacroBuf);
431  sprintf(MacroBuf, "__%s_HAS_DENORM__=1", Prefix);
432  DefineBuiltinMacro(Buf, MacroBuf);
433}
434
435
436/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
437/// named MacroName with the max value for a type with width 'TypeWidth' a
438/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
439static void DefineTypeSize(const char *MacroName, unsigned TypeWidth,
440                           const char *ValSuffix, bool isSigned,
441                           std::vector<char> &Buf) {
442  char MacroBuf[60];
443  long long MaxVal;
444  if (isSigned)
445    MaxVal = (1LL << (TypeWidth - 1)) - 1;
446  else
447    MaxVal = ~0LL >> (64-TypeWidth);
448
449  sprintf(MacroBuf, "%s=%llu%s", MacroName, MaxVal, ValSuffix);
450  DefineBuiltinMacro(Buf, MacroBuf);
451}
452
453static void DefineType(const char *MacroName, TargetInfo::IntType Ty,
454                       std::vector<char> &Buf) {
455  char MacroBuf[60];
456  sprintf(MacroBuf, "%s=%s", MacroName, TargetInfo::getTypeName(Ty));
457  DefineBuiltinMacro(Buf, MacroBuf);
458}
459
460
461static void InitializePredefinedMacros(Preprocessor &PP,
462                                       std::vector<char> &Buf) {
463  char MacroBuf[60];
464  // Compiler version introspection macros.
465  DefineBuiltinMacro(Buf, "__llvm__=1");   // LLVM Backend
466  DefineBuiltinMacro(Buf, "__clang__=1");  // Clang Frontend
467
468  // Currently claim to be compatible with GCC 4.2.1-5621.
469  DefineBuiltinMacro(Buf, "__APPLE_CC__=5621");
470  DefineBuiltinMacro(Buf, "__GNUC_MINOR__=2");
471  DefineBuiltinMacro(Buf, "__GNUC_PATCHLEVEL__=1");
472  DefineBuiltinMacro(Buf, "__GNUC__=4");
473  DefineBuiltinMacro(Buf, "__GXX_ABI_VERSION=1002");
474  DefineBuiltinMacro(Buf, "__VERSION__=\"4.2.1 Compatible Clang Compiler\"");
475
476
477  // Initialize language-specific preprocessor defines.
478
479  // These should all be defined in the preprocessor according to the
480  // current language configuration.
481  if (!PP.getLangOptions().Microsoft)
482    DefineBuiltinMacro(Buf, "__STDC__=1");
483  if (PP.getLangOptions().AsmPreprocessor)
484    DefineBuiltinMacro(Buf, "__ASSEMBLER__=1");
485  if (PP.getLangOptions().C99 && !PP.getLangOptions().CPlusPlus)
486    DefineBuiltinMacro(Buf, "__STDC_VERSION__=199901L");
487  else if (0) // STDC94 ?
488    DefineBuiltinMacro(Buf, "__STDC_VERSION__=199409L");
489
490  if (PP.getLangOptions().CPlusPlus0x)
491    DefineBuiltinMacro(Buf, "__GXX_EXPERIMENTAL_CXX0X__");
492
493  if (PP.getLangOptions().Freestanding)
494    DefineBuiltinMacro(Buf, "__STDC_HOSTED__=0");
495  else
496    DefineBuiltinMacro(Buf, "__STDC_HOSTED__=1");
497
498  if (PP.getLangOptions().ObjC1) {
499    DefineBuiltinMacro(Buf, "__OBJC__=1");
500#if 0
501// FIXME. This flag controls declaration of ivars which is
502// needed since we do not support synthesize ivars yet.
503    if (PP.getLangOptions().ObjCNonFragileABI)
504      DefineBuiltinMacro(Buf, "__OBJC2__=1");
505#endif
506
507    if (PP.getLangOptions().getGCMode() == LangOptions::NonGC) {
508      DefineBuiltinMacro(Buf, "__weak=");
509      DefineBuiltinMacro(Buf, "__strong=");
510    } else {
511      DefineBuiltinMacro(Buf, "__weak=__attribute__((objc_gc(weak)))");
512      DefineBuiltinMacro(Buf, "__strong=__attribute__((objc_gc(strong)))");
513      DefineBuiltinMacro(Buf, "__OBJC_GC__=1");
514    }
515
516    if (PP.getLangOptions().NeXTRuntime)
517      DefineBuiltinMacro(Buf, "__NEXT_RUNTIME__=1");
518  }
519
520  // darwin_constant_cfstrings controls this. This is also dependent
521  // on other things like the runtime I believe.  This is set even for C code.
522  DefineBuiltinMacro(Buf, "__CONSTANT_CFSTRINGS__=1");
523
524  if (PP.getLangOptions().ObjC2)
525    DefineBuiltinMacro(Buf, "OBJC_NEW_PROPERTIES");
526
527  if (PP.getLangOptions().PascalStrings)
528    DefineBuiltinMacro(Buf, "__PASCAL_STRINGS__");
529
530  if (PP.getLangOptions().Blocks) {
531    DefineBuiltinMacro(Buf, "__block=__attribute__((__blocks__(byref)))");
532    DefineBuiltinMacro(Buf, "__BLOCKS__=1");
533  }
534
535  if (PP.getLangOptions().CPlusPlus) {
536    DefineBuiltinMacro(Buf, "__DEPRECATED=1");
537    DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
538    DefineBuiltinMacro(Buf, "__GNUG__=4");
539    DefineBuiltinMacro(Buf, "__GXX_WEAK__=1");
540    DefineBuiltinMacro(Buf, "__cplusplus=1");
541    DefineBuiltinMacro(Buf, "__private_extern__=extern");
542  }
543
544  // Filter out some microsoft extensions when trying to parse in ms-compat
545  // mode.
546  if (PP.getLangOptions().Microsoft) {
547    DefineBuiltinMacro(Buf, "_cdecl=__cdecl");
548    DefineBuiltinMacro(Buf, "__int8=__INT8_TYPE__");
549    DefineBuiltinMacro(Buf, "__int16=__INT16_TYPE__");
550    DefineBuiltinMacro(Buf, "__int32=__INT32_TYPE__");
551    DefineBuiltinMacro(Buf, "__int64=__INT64_TYPE__");
552  }
553
554  // Initialize target-specific preprocessor defines.
555  const TargetInfo &TI = PP.getTargetInfo();
556
557  // Define type sizing macros based on the target properties.
558  assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
559  DefineBuiltinMacro(Buf, "__CHAR_BIT__=8");
560
561  unsigned IntMaxWidth;
562  const char *IntMaxSuffix;
563  if (TI.getIntMaxType() == TargetInfo::SignedLongLong) {
564    IntMaxWidth = TI.getLongLongWidth();
565    IntMaxSuffix = "LL";
566  } else if (TI.getIntMaxType() == TargetInfo::SignedLong) {
567    IntMaxWidth = TI.getLongWidth();
568    IntMaxSuffix = "L";
569  } else {
570    assert(TI.getIntMaxType() == TargetInfo::SignedInt);
571    IntMaxWidth = TI.getIntWidth();
572    IntMaxSuffix = "";
573  }
574
575  DefineTypeSize("__SCHAR_MAX__", TI.getCharWidth(), "", true, Buf);
576  DefineTypeSize("__SHRT_MAX__", TI.getShortWidth(), "", true, Buf);
577  DefineTypeSize("__INT_MAX__", TI.getIntWidth(), "", true, Buf);
578  DefineTypeSize("__LONG_MAX__", TI.getLongWidth(), "L", true, Buf);
579  DefineTypeSize("__LONG_LONG_MAX__", TI.getLongLongWidth(), "LL", true, Buf);
580  DefineTypeSize("__WCHAR_MAX__", TI.getWCharWidth(), "", true, Buf);
581  DefineTypeSize("__INTMAX_MAX__", IntMaxWidth, IntMaxSuffix, true, Buf);
582
583  DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Buf);
584  DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Buf);
585  DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Buf);
586  DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Buf);
587  DefineType("__SIZE_TYPE__", TI.getSizeType(), Buf);
588  DefineType("__WCHAR_TYPE__", TI.getWCharType(), Buf);
589  // FIXME: TargetInfo hookize __WINT_TYPE__.
590  DefineBuiltinMacro(Buf, "__WINT_TYPE__=int");
591
592  DefineFloatMacros(Buf, "FLT", &TI.getFloatFormat());
593  DefineFloatMacros(Buf, "DBL", &TI.getDoubleFormat());
594  DefineFloatMacros(Buf, "LDBL", &TI.getLongDoubleFormat());
595
596  // Define a __POINTER_WIDTH__ macro for stdint.h.
597  sprintf(MacroBuf, "__POINTER_WIDTH__=%d", (int)TI.getPointerWidth(0));
598  DefineBuiltinMacro(Buf, MacroBuf);
599
600  if (!TI.isCharSigned())
601    DefineBuiltinMacro(Buf, "__CHAR_UNSIGNED__");
602
603  // Define fixed-sized integer types for stdint.h
604  assert(TI.getCharWidth() == 8 && "unsupported target types");
605  assert(TI.getShortWidth() == 16 && "unsupported target types");
606  DefineBuiltinMacro(Buf, "__INT8_TYPE__=char");
607  DefineBuiltinMacro(Buf, "__INT16_TYPE__=short");
608
609  if (TI.getIntWidth() == 32)
610    DefineBuiltinMacro(Buf, "__INT32_TYPE__=int");
611  else {
612    assert(TI.getLongLongWidth() == 32 && "unsupported target types");
613    DefineBuiltinMacro(Buf, "__INT32_TYPE__=long long");
614  }
615
616  // 16-bit targets doesn't necessarily have a 64-bit type.
617  if (TI.getLongLongWidth() == 64)
618    DefineBuiltinMacro(Buf, "__INT64_TYPE__=long long");
619
620  // Add __builtin_va_list typedef.
621  {
622    const char *VAList = TI.getVAListDeclaration();
623    Buf.insert(Buf.end(), VAList, VAList+strlen(VAList));
624    Buf.push_back('\n');
625  }
626
627  if (const char *Prefix = TI.getUserLabelPrefix()) {
628    sprintf(MacroBuf, "__USER_LABEL_PREFIX__=%s", Prefix);
629    DefineBuiltinMacro(Buf, MacroBuf);
630  }
631
632  // Build configuration options.  FIXME: these should be controlled by
633  // command line options or something.
634  DefineBuiltinMacro(Buf, "__DYNAMIC__=1");
635  DefineBuiltinMacro(Buf, "__FINITE_MATH_ONLY__=0");
636  DefineBuiltinMacro(Buf, "__NO_INLINE__=1");
637  DefineBuiltinMacro(Buf, "__PIC__=1");
638
639  // Macros to control C99 numerics and <float.h>
640  DefineBuiltinMacro(Buf, "__FLT_EVAL_METHOD__=0");
641  DefineBuiltinMacro(Buf, "__FLT_RADIX__=2");
642  sprintf(MacroBuf, "__DECIMAL_DIG__=%d",
643          PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33));
644  DefineBuiltinMacro(Buf, MacroBuf);
645
646  // Get other target #defines.
647  TI.getTargetDefines(PP.getLangOptions(), Buf);
648}
649
650
651/// EnterMainSourceFile - Enter the specified FileID as the main source file,
652/// which implicitly adds the builtin defines etc.
653void Preprocessor::EnterMainSourceFile() {
654  // We do not allow the preprocessor to reenter the main file.  Doing so will
655  // cause FileID's to accumulate information from both runs (e.g. #line
656  // information) and predefined macros aren't guaranteed to be set properly.
657  assert(NumEnteredSourceFiles == 0 && "Cannot reenter the main file!");
658  FileID MainFileID = SourceMgr.getMainFileID();
659
660  // Enter the main file source buffer.
661  EnterSourceFile(MainFileID, 0);
662
663  // Tell the header info that the main file was entered.  If the file is later
664  // #imported, it won't be re-entered.
665  if (const FileEntry *FE = SourceMgr.getFileEntryForID(MainFileID))
666    HeaderInfo.IncrementIncludeCount(FE);
667
668  std::vector<char> PrologFile;
669  PrologFile.reserve(4080);
670
671  // Install things like __POWERPC__, __GNUC__, etc into the macro table.
672  InitializePredefinedMacros(*this, PrologFile);
673
674  // Add on the predefines from the driver.  Wrap in a #line directive to report
675  // that they come from the command line.
676  const char *LineDirective = "# 1 \"<command line>\" 1\n";
677  PrologFile.insert(PrologFile.end(),
678                    LineDirective, LineDirective+strlen(LineDirective));
679
680  PrologFile.insert(PrologFile.end(), Predefines.begin(), Predefines.end());
681
682  LineDirective = "# 2 \"<built-in>\" 2\n";
683  PrologFile.insert(PrologFile.end(),
684                    LineDirective, LineDirective+strlen(LineDirective));
685
686  // Memory buffer must end with a null byte!
687  PrologFile.push_back(0);
688
689  // Now that we have emitted the predefined macros, #includes, etc into
690  // PrologFile, preprocess it to populate the initial preprocessor state.
691  llvm::MemoryBuffer *SB =
692    llvm::MemoryBuffer::getMemBufferCopy(&PrologFile.front(),&PrologFile.back(),
693                                         "<built-in>");
694  assert(SB && "Cannot fail to create predefined source buffer");
695  FileID FID = SourceMgr.createFileIDForMemBuffer(SB);
696  assert(!FID.isInvalid() && "Could not create FileID for predefines?");
697
698  // Start parsing the predefines.
699  EnterSourceFile(FID, 0);
700}
701
702
703//===----------------------------------------------------------------------===//
704// Lexer Event Handling.
705//===----------------------------------------------------------------------===//
706
707/// LookUpIdentifierInfo - Given a tok::identifier token, look up the
708/// identifier information for the token and install it into the token.
709IdentifierInfo *Preprocessor::LookUpIdentifierInfo(Token &Identifier,
710                                                   const char *BufPtr) {
711  assert(Identifier.is(tok::identifier) && "Not an identifier!");
712  assert(Identifier.getIdentifierInfo() == 0 && "Identinfo already exists!");
713
714  // Look up this token, see if it is a macro, or if it is a language keyword.
715  IdentifierInfo *II;
716  if (BufPtr && !Identifier.needsCleaning()) {
717    // No cleaning needed, just use the characters from the lexed buffer.
718    II = getIdentifierInfo(BufPtr, BufPtr+Identifier.getLength());
719  } else {
720    // Cleaning needed, alloca a buffer, clean into it, then use the buffer.
721    llvm::SmallVector<char, 64> IdentifierBuffer;
722    IdentifierBuffer.resize(Identifier.getLength());
723    const char *TmpBuf = &IdentifierBuffer[0];
724    unsigned Size = getSpelling(Identifier, TmpBuf);
725    II = getIdentifierInfo(TmpBuf, TmpBuf+Size);
726  }
727  Identifier.setIdentifierInfo(II);
728  return II;
729}
730
731
732/// HandleIdentifier - This callback is invoked when the lexer reads an
733/// identifier.  This callback looks up the identifier in the map and/or
734/// potentially macro expands it or turns it into a named token (like 'for').
735///
736/// Note that callers of this method are guarded by checking the
737/// IdentifierInfo's 'isHandleIdentifierCase' bit.  If this method changes, the
738/// IdentifierInfo methods that compute these properties will need to change to
739/// match.
740void Preprocessor::HandleIdentifier(Token &Identifier) {
741  assert(Identifier.getIdentifierInfo() &&
742         "Can't handle identifiers without identifier info!");
743
744  IdentifierInfo &II = *Identifier.getIdentifierInfo();
745
746  // If this identifier was poisoned, and if it was not produced from a macro
747  // expansion, emit an error.
748  if (II.isPoisoned() && CurPPLexer) {
749    if (&II != Ident__VA_ARGS__)   // We warn about __VA_ARGS__ with poisoning.
750      Diag(Identifier, diag::err_pp_used_poisoned_id);
751    else
752      Diag(Identifier, diag::ext_pp_bad_vaargs_use);
753  }
754
755  // If this is a macro to be expanded, do it.
756  if (MacroInfo *MI = getMacroInfo(&II)) {
757    if (!DisableMacroExpansion && !Identifier.isExpandDisabled()) {
758      if (MI->isEnabled()) {
759        if (!HandleMacroExpandedIdentifier(Identifier, MI))
760          return;
761      } else {
762        // C99 6.10.3.4p2 says that a disabled macro may never again be
763        // expanded, even if it's in a context where it could be expanded in the
764        // future.
765        Identifier.setFlag(Token::DisableExpand);
766      }
767    }
768  }
769
770  // C++ 2.11p2: If this is an alternative representation of a C++ operator,
771  // then we act as if it is the actual operator and not the textual
772  // representation of it.
773  if (II.isCPlusPlusOperatorKeyword())
774    Identifier.setIdentifierInfo(0);
775
776  // If this is an extension token, diagnose its use.
777  // We avoid diagnosing tokens that originate from macro definitions.
778  if (II.isExtensionToken() && Features.C99 && !DisableMacroExpansion)
779    Diag(Identifier, diag::ext_token_used);
780}
781