InitPreprocessor.cpp revision 194711 
1//===--- InitPreprocessor.cpp - PP initialization code. ---------*- C++ -*-===//
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 clang::InitializePreprocessor function.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Frontend/InitPreprocessor.h"
15#include "clang/Basic/TargetInfo.h"
16#include "clang/Lex/Preprocessor.h"
17#include "llvm/ADT/StringExtras.h"
18#include "llvm/ADT/STLExtras.h"
19#include "llvm/System/Path.h"
20
21namespace clang {
22
23// Append a #define line to Buf for Macro.  Macro should be of the form XXX,
24// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
25// "#define XXX Y z W".  To get a #define with no value, use "XXX=".
26static void DefineBuiltinMacro(std::vector<char> &Buf, const char *Macro) {
27  const char *Command = "#define ";
28  Buf.insert(Buf.end(), Command, Command+strlen(Command));
29  if (const char *Equal = strchr(Macro, '=')) {
30    // Turn the = into ' '.
31    Buf.insert(Buf.end(), Macro, Equal);
32    Buf.push_back(' ');
33
34    // Per GCC -D semantics, the macro ends at \n if it exists.
35    const char *End = strpbrk(Equal, "\n\r");
36    if (End) {
37      fprintf(stderr, "warning: macro '%s' contains embedded newline, text "
38              "after the newline is ignored.\n",
39              std::string(Macro, Equal).c_str());
40    } else {
41      End = Equal+strlen(Equal);
42    }
43
44    Buf.insert(Buf.end(), Equal+1, End);
45  } else {
46    // Push "macroname 1".
47    Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
48    Buf.push_back(' ');
49    Buf.push_back('1');
50  }
51  Buf.push_back('\n');
52}
53
54// Append a #undef line to Buf for Macro.  Macro should be of the form XXX
55// and we emit "#undef XXX".
56static void UndefineBuiltinMacro(std::vector<char> &Buf, const char *Macro) {
57  // Push "macroname".
58  const char *Command = "#undef ";
59  Buf.insert(Buf.end(), Command, Command+strlen(Command));
60  Buf.insert(Buf.end(), Macro, Macro+strlen(Macro));
61  Buf.push_back('\n');
62}
63
64/// Add the quoted name of an implicit include file.
65static void AddQuotedIncludePath(std::vector<char> &Buf,
66                                 const std::string &File) {
67  // Implicit include paths should be resolved relative to the current
68  // working directory first, and then use the regular header search
69  // mechanism. The proper way to handle this is to have the
70  // predefines buffer located at the current working directory, but
71  // it has not file entry. For now, workaround this by using an
72  // absolute path if we find the file here, and otherwise letting
73  // header search handle it.
74  llvm::sys::Path Path(File);
75  Path.makeAbsolute();
76  if (!Path.exists())
77    Path = File;
78
79  // Escape double quotes etc.
80  Buf.push_back('"');
81  std::string EscapedFile = Lexer::Stringify(Path.toString());
82  Buf.insert(Buf.end(), EscapedFile.begin(), EscapedFile.end());
83  Buf.push_back('"');
84}
85
86/// AddImplicitInclude - Add an implicit #include of the specified file to the
87/// predefines buffer.
88static void AddImplicitInclude(std::vector<char> &Buf,
89                               const std::string &File) {
90  const char *Inc = "#include ";
91  Buf.insert(Buf.end(), Inc, Inc+strlen(Inc));
92  AddQuotedIncludePath(Buf, File);
93  Buf.push_back('\n');
94}
95
96static void AddImplicitIncludeMacros(std::vector<char> &Buf,
97                                     const std::string &File) {
98  const char *Inc = "#__include_macros ";
99  Buf.insert(Buf.end(), Inc, Inc+strlen(Inc));
100  AddQuotedIncludePath(Buf, File);
101  Buf.push_back('\n');
102  // Marker token to stop the __include_macros fetch loop.
103  const char *Marker = "##\n"; // ##?
104  Buf.insert(Buf.end(), Marker, Marker+strlen(Marker));
105}
106
107/// AddImplicitIncludePTH - Add an implicit #include using the original file
108///  used to generate a PTH cache.
109static void AddImplicitIncludePTH(std::vector<char> &Buf, Preprocessor &PP,
110  const std::string& ImplicitIncludePTH) {
111  PTHManager *P = PP.getPTHManager();
112  assert(P && "No PTHManager.");
113  const char *OriginalFile = P->getOriginalSourceFile();
114
115  if (!OriginalFile) {
116    assert(!ImplicitIncludePTH.empty());
117    fprintf(stderr, "error: PTH file '%s' does not designate an original "
118            "source header file for -include-pth\n",
119            ImplicitIncludePTH.c_str());
120    exit (1);
121  }
122
123  AddImplicitInclude(Buf, OriginalFile);
124}
125
126/// PickFP - This is used to pick a value based on the FP semantics of the
127/// specified FP model.
128template <typename T>
129static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
130                T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
131                T IEEEQuadVal) {
132  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle)
133    return IEEESingleVal;
134  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble)
135    return IEEEDoubleVal;
136  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended)
137    return X87DoubleExtendedVal;
138  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble)
139    return PPCDoubleDoubleVal;
140  assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad);
141  return IEEEQuadVal;
142}
143
144static void DefineFloatMacros(std::vector<char> &Buf, const char *Prefix,
145                              const llvm::fltSemantics *Sem) {
146  const char *DenormMin, *Epsilon, *Max, *Min;
147  DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
148                     "3.64519953188247460253e-4951L",
149                     "4.94065645841246544176568792868221e-324L",
150                     "6.47517511943802511092443895822764655e-4966L");
151  int Digits = PickFP(Sem, 6, 15, 18, 31, 33);
152  Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
153                   "1.08420217248550443401e-19L",
154                   "4.94065645841246544176568792868221e-324L",
155                   "1.92592994438723585305597794258492732e-34L");
156  int HasInifinity = 1, HasQuietNaN = 1;
157  int MantissaDigits = PickFP(Sem, 24, 53, 64, 106, 113);
158  int Min10Exp = PickFP(Sem, -37, -307, -4931, -291, -4931);
159  int Max10Exp = PickFP(Sem, 38, 308, 4932, 308, 4932);
160  int MinExp = PickFP(Sem, -125, -1021, -16381, -968, -16381);
161  int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024, 16384);
162  Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
163               "3.36210314311209350626e-4932L",
164               "2.00416836000897277799610805135016e-292L",
165               "3.36210314311209350626267781732175260e-4932L");
166  Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
167               "1.18973149535723176502e+4932L",
168               "1.79769313486231580793728971405301e+308L",
169               "1.18973149535723176508575932662800702e+4932L");
170
171  char MacroBuf[100];
172  sprintf(MacroBuf, "__%s_DENORM_MIN__=%s", Prefix, DenormMin);
173  DefineBuiltinMacro(Buf, MacroBuf);
174  sprintf(MacroBuf, "__%s_DIG__=%d", Prefix, Digits);
175  DefineBuiltinMacro(Buf, MacroBuf);
176  sprintf(MacroBuf, "__%s_EPSILON__=%s", Prefix, Epsilon);
177  DefineBuiltinMacro(Buf, MacroBuf);
178  sprintf(MacroBuf, "__%s_HAS_INFINITY__=%d", Prefix, HasInifinity);
179  DefineBuiltinMacro(Buf, MacroBuf);
180  sprintf(MacroBuf, "__%s_HAS_QUIET_NAN__=%d", Prefix, HasQuietNaN);
181  DefineBuiltinMacro(Buf, MacroBuf);
182  sprintf(MacroBuf, "__%s_MANT_DIG__=%d", Prefix, MantissaDigits);
183  DefineBuiltinMacro(Buf, MacroBuf);
184  sprintf(MacroBuf, "__%s_MAX_10_EXP__=%d", Prefix, Max10Exp);
185  DefineBuiltinMacro(Buf, MacroBuf);
186  sprintf(MacroBuf, "__%s_MAX_EXP__=%d", Prefix, MaxExp);
187  DefineBuiltinMacro(Buf, MacroBuf);
188  sprintf(MacroBuf, "__%s_MAX__=%s", Prefix, Max);
189  DefineBuiltinMacro(Buf, MacroBuf);
190  sprintf(MacroBuf, "__%s_MIN_10_EXP__=(%d)", Prefix, Min10Exp);
191  DefineBuiltinMacro(Buf, MacroBuf);
192  sprintf(MacroBuf, "__%s_MIN_EXP__=(%d)", Prefix, MinExp);
193  DefineBuiltinMacro(Buf, MacroBuf);
194  sprintf(MacroBuf, "__%s_MIN__=%s", Prefix, Min);
195  DefineBuiltinMacro(Buf, MacroBuf);
196  sprintf(MacroBuf, "__%s_HAS_DENORM__=1", Prefix);
197  DefineBuiltinMacro(Buf, MacroBuf);
198}
199
200
201/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
202/// named MacroName with the max value for a type with width 'TypeWidth' a
203/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
204static void DefineTypeSize(const char *MacroName, unsigned TypeWidth,
205                           const char *ValSuffix, bool isSigned,
206                           std::vector<char> &Buf) {
207  char MacroBuf[60];
208  long long MaxVal;
209  if (isSigned)
210    MaxVal = (1LL << (TypeWidth - 1)) - 1;
211  else
212    MaxVal = ~0LL >> (64-TypeWidth);
213
214  sprintf(MacroBuf, "%s=%llu%s", MacroName, MaxVal, ValSuffix);
215  DefineBuiltinMacro(Buf, MacroBuf);
216}
217
218static void DefineType(const char *MacroName, TargetInfo::IntType Ty,
219                       std::vector<char> &Buf) {
220  char MacroBuf[60];
221  sprintf(MacroBuf, "%s=%s", MacroName, TargetInfo::getTypeName(Ty));
222  DefineBuiltinMacro(Buf, MacroBuf);
223}
224
225
226static void InitializePredefinedMacros(const TargetInfo &TI,
227                                       const LangOptions &LangOpts,
228                                       std::vector<char> &Buf) {
229  char MacroBuf[60];
230  // Compiler version introspection macros.
231  DefineBuiltinMacro(Buf, "__llvm__=1");   // LLVM Backend
232  DefineBuiltinMacro(Buf, "__clang__=1");  // Clang Frontend
233
234  // Currently claim to be compatible with GCC 4.2.1-5621.
235  DefineBuiltinMacro(Buf, "__GNUC_MINOR__=2");
236  DefineBuiltinMacro(Buf, "__GNUC_PATCHLEVEL__=1");
237  DefineBuiltinMacro(Buf, "__GNUC__=4");
238  DefineBuiltinMacro(Buf, "__GXX_ABI_VERSION=1002");
239  DefineBuiltinMacro(Buf, "__VERSION__=\"4.2.1 Compatible Clang Compiler\"");
240
241
242  // Initialize language-specific preprocessor defines.
243
244  // These should all be defined in the preprocessor according to the
245  // current language configuration.
246  if (!LangOpts.Microsoft)
247    DefineBuiltinMacro(Buf, "__STDC__=1");
248  if (LangOpts.AsmPreprocessor)
249    DefineBuiltinMacro(Buf, "__ASSEMBLER__=1");
250  if (LangOpts.C99 && !LangOpts.CPlusPlus)
251    DefineBuiltinMacro(Buf, "__STDC_VERSION__=199901L");
252  else if (0) // STDC94 ?
253    DefineBuiltinMacro(Buf, "__STDC_VERSION__=199409L");
254
255  // Standard conforming mode?
256  if (!LangOpts.GNUMode)
257    DefineBuiltinMacro(Buf, "__STRICT_ANSI__=1");
258
259  if (LangOpts.CPlusPlus0x)
260    DefineBuiltinMacro(Buf, "__GXX_EXPERIMENTAL_CXX0X__");
261
262  if (LangOpts.Freestanding)
263    DefineBuiltinMacro(Buf, "__STDC_HOSTED__=0");
264  else
265    DefineBuiltinMacro(Buf, "__STDC_HOSTED__=1");
266
267  if (LangOpts.ObjC1) {
268    DefineBuiltinMacro(Buf, "__OBJC__=1");
269    if (LangOpts.ObjCNonFragileABI) {
270      DefineBuiltinMacro(Buf, "__OBJC2__=1");
271      DefineBuiltinMacro(Buf, "OBJC_ZEROCOST_EXCEPTIONS=1");
272      DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
273    }
274
275    if (LangOpts.getGCMode() != LangOptions::NonGC)
276      DefineBuiltinMacro(Buf, "__OBJC_GC__=1");
277
278    if (LangOpts.NeXTRuntime)
279      DefineBuiltinMacro(Buf, "__NEXT_RUNTIME__=1");
280  }
281
282  // darwin_constant_cfstrings controls this. This is also dependent
283  // on other things like the runtime I believe.  This is set even for C code.
284  DefineBuiltinMacro(Buf, "__CONSTANT_CFSTRINGS__=1");
285
286  if (LangOpts.ObjC2)
287    DefineBuiltinMacro(Buf, "OBJC_NEW_PROPERTIES");
288
289  if (LangOpts.ObjCSenderDispatch)
290    DefineBuiltinMacro(Buf, "__OBJC_SENDER_AWARE_DISPATCH__");
291
292  if (LangOpts.PascalStrings)
293    DefineBuiltinMacro(Buf, "__PASCAL_STRINGS__");
294
295  if (LangOpts.Blocks) {
296    DefineBuiltinMacro(Buf, "__block=__attribute__((__blocks__(byref)))");
297    DefineBuiltinMacro(Buf, "__BLOCKS__=1");
298  }
299
300  if (LangOpts.CPlusPlus) {
301    DefineBuiltinMacro(Buf, "__DEPRECATED=1");
302    DefineBuiltinMacro(Buf, "__EXCEPTIONS=1");
303    DefineBuiltinMacro(Buf, "__GNUG__=4");
304    DefineBuiltinMacro(Buf, "__GXX_WEAK__=1");
305    DefineBuiltinMacro(Buf, "__cplusplus=1");
306    DefineBuiltinMacro(Buf, "__private_extern__=extern");
307  }
308
309  // Filter out some microsoft extensions when trying to parse in ms-compat
310  // mode.
311  if (LangOpts.Microsoft) {
312    DefineBuiltinMacro(Buf, "__int8=__INT8_TYPE__");
313    DefineBuiltinMacro(Buf, "__int16=__INT16_TYPE__");
314    DefineBuiltinMacro(Buf, "__int32=__INT32_TYPE__");
315    DefineBuiltinMacro(Buf, "__int64=__INT64_TYPE__");
316  }
317
318  if (LangOpts.Optimize)
319    DefineBuiltinMacro(Buf, "__OPTIMIZE__=1");
320  if (LangOpts.OptimizeSize)
321    DefineBuiltinMacro(Buf, "__OPTIMIZE_SIZE__=1");
322
323  // Initialize target-specific preprocessor defines.
324
325  // Define type sizing macros based on the target properties.
326  assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
327  DefineBuiltinMacro(Buf, "__CHAR_BIT__=8");
328
329  unsigned IntMaxWidth;
330  const char *IntMaxSuffix;
331  if (TI.getIntMaxType() == TargetInfo::SignedLongLong) {
332    IntMaxWidth = TI.getLongLongWidth();
333    IntMaxSuffix = "LL";
334  } else if (TI.getIntMaxType() == TargetInfo::SignedLong) {
335    IntMaxWidth = TI.getLongWidth();
336    IntMaxSuffix = "L";
337  } else {
338    assert(TI.getIntMaxType() == TargetInfo::SignedInt);
339    IntMaxWidth = TI.getIntWidth();
340    IntMaxSuffix = "";
341  }
342
343  DefineTypeSize("__SCHAR_MAX__", TI.getCharWidth(), "", true, Buf);
344  DefineTypeSize("__SHRT_MAX__", TI.getShortWidth(), "", true, Buf);
345  DefineTypeSize("__INT_MAX__", TI.getIntWidth(), "", true, Buf);
346  DefineTypeSize("__LONG_MAX__", TI.getLongWidth(), "L", true, Buf);
347  DefineTypeSize("__LONG_LONG_MAX__", TI.getLongLongWidth(), "LL", true, Buf);
348  DefineTypeSize("__WCHAR_MAX__", TI.getWCharWidth(), "", true, Buf);
349  DefineTypeSize("__INTMAX_MAX__", IntMaxWidth, IntMaxSuffix, true, Buf);
350
351  DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Buf);
352  DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Buf);
353  DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Buf);
354  DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Buf);
355  DefineType("__SIZE_TYPE__", TI.getSizeType(), Buf);
356  DefineType("__WCHAR_TYPE__", TI.getWCharType(), Buf);
357  // FIXME: TargetInfo hookize __WINT_TYPE__.
358  DefineBuiltinMacro(Buf, "__WINT_TYPE__=int");
359
360  DefineFloatMacros(Buf, "FLT", &TI.getFloatFormat());
361  DefineFloatMacros(Buf, "DBL", &TI.getDoubleFormat());
362  DefineFloatMacros(Buf, "LDBL", &TI.getLongDoubleFormat());
363
364  // Define a __POINTER_WIDTH__ macro for stdint.h.
365  sprintf(MacroBuf, "__POINTER_WIDTH__=%d", (int)TI.getPointerWidth(0));
366  DefineBuiltinMacro(Buf, MacroBuf);
367
368  if (!LangOpts.CharIsSigned)
369    DefineBuiltinMacro(Buf, "__CHAR_UNSIGNED__");
370
371  // Define fixed-sized integer types for stdint.h
372  assert(TI.getCharWidth() == 8 && "unsupported target types");
373  assert(TI.getShortWidth() == 16 && "unsupported target types");
374  DefineBuiltinMacro(Buf, "__INT8_TYPE__=char");
375  DefineBuiltinMacro(Buf, "__INT16_TYPE__=short");
376
377  if (TI.getIntWidth() == 32)
378    DefineBuiltinMacro(Buf, "__INT32_TYPE__=int");
379  else {
380    assert(TI.getLongLongWidth() == 32 && "unsupported target types");
381    DefineBuiltinMacro(Buf, "__INT32_TYPE__=long long");
382  }
383
384  // 16-bit targets doesn't necessarily have a 64-bit type.
385  if (TI.getLongLongWidth() == 64)
386    DefineBuiltinMacro(Buf, "__INT64_TYPE__=long long");
387
388  // Add __builtin_va_list typedef.
389  {
390    const char *VAList = TI.getVAListDeclaration();
391    Buf.insert(Buf.end(), VAList, VAList+strlen(VAList));
392    Buf.push_back('\n');
393  }
394
395  if (const char *Prefix = TI.getUserLabelPrefix()) {
396    sprintf(MacroBuf, "__USER_LABEL_PREFIX__=%s", Prefix);
397    DefineBuiltinMacro(Buf, MacroBuf);
398  }
399
400  // Build configuration options.  FIXME: these should be controlled by
401  // command line options or something.
402  DefineBuiltinMacro(Buf, "__FINITE_MATH_ONLY__=0");
403
404  if (LangOpts.GNUInline)
405    DefineBuiltinMacro(Buf, "__GNUC_GNU_INLINE__=1");
406  else
407    DefineBuiltinMacro(Buf, "__GNUC_STDC_INLINE__=1");
408
409  if (LangOpts.NoInline)
410    DefineBuiltinMacro(Buf, "__NO_INLINE__=1");
411
412  if (unsigned PICLevel = LangOpts.PICLevel) {
413    sprintf(MacroBuf, "__PIC__=%d", PICLevel);
414    DefineBuiltinMacro(Buf, MacroBuf);
415
416    sprintf(MacroBuf, "__pic__=%d", PICLevel);
417    DefineBuiltinMacro(Buf, MacroBuf);
418  }
419
420  // Macros to control C99 numerics and <float.h>
421  DefineBuiltinMacro(Buf, "__FLT_EVAL_METHOD__=0");
422  DefineBuiltinMacro(Buf, "__FLT_RADIX__=2");
423  sprintf(MacroBuf, "__DECIMAL_DIG__=%d",
424          PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33, 36));
425  DefineBuiltinMacro(Buf, MacroBuf);
426
427  // Get other target #defines.
428  TI.getTargetDefines(LangOpts, Buf);
429}
430
431/// InitializePreprocessor - Initialize the preprocessor getting it and the
432/// environment ready to process a single file. This returns true on error.
433///
434bool InitializePreprocessor(Preprocessor &PP,
435                            const PreprocessorInitOptions& InitOpts) {
436  std::vector<char> PredefineBuffer;
437
438  const char *LineDirective = "# 1 \"<built-in>\" 3\n";
439  PredefineBuffer.insert(PredefineBuffer.end(),
440                         LineDirective, LineDirective+strlen(LineDirective));
441
442  // Install things like __POWERPC__, __GNUC__, etc into the macro table.
443  InitializePredefinedMacros(PP.getTargetInfo(), PP.getLangOptions(),
444                             PredefineBuffer);
445
446  // Add on the predefines from the driver.  Wrap in a #line directive to report
447  // that they come from the command line.
448  LineDirective = "# 1 \"<command line>\" 1\n";
449  PredefineBuffer.insert(PredefineBuffer.end(),
450                         LineDirective, LineDirective+strlen(LineDirective));
451
452  // Process #define's and #undef's in the order they are given.
453  for (PreprocessorInitOptions::macro_iterator I = InitOpts.macro_begin(),
454       E = InitOpts.macro_end(); I != E; ++I) {
455    if (I->second)  // isUndef
456      UndefineBuiltinMacro(PredefineBuffer, I->first.c_str());
457    else
458      DefineBuiltinMacro(PredefineBuffer, I->first.c_str());
459  }
460
461  // If -imacros are specified, include them now.  These are processed before
462  // any -include directives.
463  for (PreprocessorInitOptions::imacro_iterator I = InitOpts.imacro_begin(),
464       E = InitOpts.imacro_end(); I != E; ++I)
465    AddImplicitIncludeMacros(PredefineBuffer, *I);
466
467  // Process -include directives.
468  for (PreprocessorInitOptions::include_iterator I = InitOpts.include_begin(),
469       E = InitOpts.include_end(); I != E; ++I) {
470    if (I->second) // isPTH
471      AddImplicitIncludePTH(PredefineBuffer, PP, I->first);
472    else
473      AddImplicitInclude(PredefineBuffer, I->first);
474  }
475
476  // Null terminate PredefinedBuffer and add it.
477  PredefineBuffer.push_back(0);
478  PP.setPredefines(&PredefineBuffer[0]);
479
480  // Once we've read this, we're done.
481  return false;
482}
483
484} // namespace clang
485