InitPreprocessor.cpp revision 5ada7a5e9747e03e8c3725b1b4d00e2a9f448e9e 
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/Utils.h"
15#include "clang/Basic/FileManager.h"
16#include "clang/Basic/MacroBuilder.h"
17#include "clang/Basic/SourceManager.h"
18#include "clang/Basic/TargetInfo.h"
19#include "clang/Basic/Version.h"
20#include "clang/Frontend/FrontendDiagnostic.h"
21#include "clang/Frontend/FrontendOptions.h"
22#include "clang/Lex/HeaderSearch.h"
23#include "clang/Lex/Preprocessor.h"
24#include "clang/Lex/PreprocessorOptions.h"
25#include "clang/Serialization/ASTReader.h"
26#include "llvm/ADT/APFloat.h"
27#include "llvm/Support/FileSystem.h"
28#include "llvm/Support/MemoryBuffer.h"
29#include "llvm/Support/Path.h"
30using namespace clang;
31
32static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
33  while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
34    MacroBody = MacroBody.drop_back();
35  return !MacroBody.empty() && MacroBody.back() == '\\';
36}
37
38// Append a #define line to Buf for Macro.  Macro should be of the form XXX,
39// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
40// "#define XXX Y z W".  To get a #define with no value, use "XXX=".
41static void DefineBuiltinMacro(MacroBuilder &Builder, StringRef Macro,
42                               DiagnosticsEngine &Diags) {
43  std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
44  StringRef MacroName = MacroPair.first;
45  StringRef MacroBody = MacroPair.second;
46  if (MacroName.size() != Macro.size()) {
47    // Per GCC -D semantics, the macro ends at \n if it exists.
48    StringRef::size_type End = MacroBody.find_first_of("\n\r");
49    if (End != StringRef::npos)
50      Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
51        << MacroName;
52    MacroBody = MacroBody.substr(0, End);
53    // We handle macro bodies which end in a backslash by appending an extra
54    // backslash+newline.  This makes sure we don't accidentally treat the
55    // backslash as a line continuation marker.
56    if (MacroBodyEndsInBackslash(MacroBody))
57      Builder.defineMacro(MacroName, Twine(MacroBody) + "\\\n");
58    else
59      Builder.defineMacro(MacroName, MacroBody);
60  } else {
61    // Push "macroname 1".
62    Builder.defineMacro(Macro);
63  }
64}
65
66/// AddImplicitInclude - Add an implicit \#include of the specified file to the
67/// predefines buffer.
68static void AddImplicitInclude(MacroBuilder &Builder, StringRef File,
69                               FileManager &FileMgr) {
70  Builder.append(Twine("#include \"") +
71                 HeaderSearch::NormalizeDashIncludePath(File, FileMgr) + "\"");
72}
73
74static void AddImplicitIncludeMacros(MacroBuilder &Builder,
75                                     StringRef File,
76                                     FileManager &FileMgr) {
77  Builder.append(Twine("#__include_macros \"") +
78                 HeaderSearch::NormalizeDashIncludePath(File, FileMgr) + "\"");
79  // Marker token to stop the __include_macros fetch loop.
80  Builder.append("##"); // ##?
81}
82
83/// AddImplicitIncludePTH - Add an implicit \#include using the original file
84/// used to generate a PTH cache.
85static void AddImplicitIncludePTH(MacroBuilder &Builder, Preprocessor &PP,
86                                  StringRef ImplicitIncludePTH) {
87  PTHManager *P = PP.getPTHManager();
88  // Null check 'P' in the corner case where it couldn't be created.
89  const char *OriginalFile = P ? P->getOriginalSourceFile() : 0;
90
91  if (!OriginalFile) {
92    PP.getDiagnostics().Report(diag::err_fe_pth_file_has_no_source_header)
93      << ImplicitIncludePTH;
94    return;
95  }
96
97  AddImplicitInclude(Builder, OriginalFile, PP.getFileManager());
98}
99
100/// \brief Add an implicit \#include using the original file used to generate
101/// a PCH file.
102static void AddImplicitIncludePCH(MacroBuilder &Builder, Preprocessor &PP,
103                                  StringRef ImplicitIncludePCH) {
104  std::string OriginalFile =
105    ASTReader::getOriginalSourceFile(ImplicitIncludePCH, PP.getFileManager(),
106                                     PP.getDiagnostics());
107  if (OriginalFile.empty())
108    return;
109
110  AddImplicitInclude(Builder, OriginalFile, PP.getFileManager());
111}
112
113/// PickFP - This is used to pick a value based on the FP semantics of the
114/// specified FP model.
115template <typename T>
116static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
117                T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
118                T IEEEQuadVal) {
119  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle)
120    return IEEESingleVal;
121  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble)
122    return IEEEDoubleVal;
123  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended)
124    return X87DoubleExtendedVal;
125  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble)
126    return PPCDoubleDoubleVal;
127  assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad);
128  return IEEEQuadVal;
129}
130
131static void DefineFloatMacros(MacroBuilder &Builder, StringRef Prefix,
132                              const llvm::fltSemantics *Sem, StringRef Ext) {
133  const char *DenormMin, *Epsilon, *Max, *Min;
134  DenormMin = PickFP(Sem, "1.40129846e-45", "4.9406564584124654e-324",
135                     "3.64519953188247460253e-4951",
136                     "4.94065645841246544176568792868221e-324",
137                     "6.47517511943802511092443895822764655e-4966");
138  int Digits = PickFP(Sem, 6, 15, 18, 31, 33);
139  Epsilon = PickFP(Sem, "1.19209290e-7", "2.2204460492503131e-16",
140                   "1.08420217248550443401e-19",
141                   "4.94065645841246544176568792868221e-324",
142                   "1.92592994438723585305597794258492732e-34");
143  int MantissaDigits = PickFP(Sem, 24, 53, 64, 106, 113);
144  int Min10Exp = PickFP(Sem, -37, -307, -4931, -291, -4931);
145  int Max10Exp = PickFP(Sem, 38, 308, 4932, 308, 4932);
146  int MinExp = PickFP(Sem, -125, -1021, -16381, -968, -16381);
147  int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024, 16384);
148  Min = PickFP(Sem, "1.17549435e-38", "2.2250738585072014e-308",
149               "3.36210314311209350626e-4932",
150               "2.00416836000897277799610805135016e-292",
151               "3.36210314311209350626267781732175260e-4932");
152  Max = PickFP(Sem, "3.40282347e+38", "1.7976931348623157e+308",
153               "1.18973149535723176502e+4932",
154               "1.79769313486231580793728971405301e+308",
155               "1.18973149535723176508575932662800702e+4932");
156
157  SmallString<32> DefPrefix;
158  DefPrefix = "__";
159  DefPrefix += Prefix;
160  DefPrefix += "_";
161
162  Builder.defineMacro(DefPrefix + "DENORM_MIN__", Twine(DenormMin)+Ext);
163  Builder.defineMacro(DefPrefix + "HAS_DENORM__");
164  Builder.defineMacro(DefPrefix + "DIG__", Twine(Digits));
165  Builder.defineMacro(DefPrefix + "EPSILON__", Twine(Epsilon)+Ext);
166  Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
167  Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
168  Builder.defineMacro(DefPrefix + "MANT_DIG__", Twine(MantissaDigits));
169
170  Builder.defineMacro(DefPrefix + "MAX_10_EXP__", Twine(Max10Exp));
171  Builder.defineMacro(DefPrefix + "MAX_EXP__", Twine(MaxExp));
172  Builder.defineMacro(DefPrefix + "MAX__", Twine(Max)+Ext);
173
174  Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+Twine(Min10Exp)+")");
175  Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+Twine(MinExp)+")");
176  Builder.defineMacro(DefPrefix + "MIN__", Twine(Min)+Ext);
177}
178
179
180/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
181/// named MacroName with the max value for a type with width 'TypeWidth' a
182/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
183static void DefineTypeSize(StringRef MacroName, unsigned TypeWidth,
184                           StringRef ValSuffix, bool isSigned,
185                           MacroBuilder &Builder) {
186  llvm::APInt MaxVal = isSigned ? llvm::APInt::getSignedMaxValue(TypeWidth)
187                                : llvm::APInt::getMaxValue(TypeWidth);
188  Builder.defineMacro(MacroName, MaxVal.toString(10, isSigned) + ValSuffix);
189}
190
191/// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
192/// the width, suffix, and signedness of the given type
193static void DefineTypeSize(StringRef MacroName, TargetInfo::IntType Ty,
194                           const TargetInfo &TI, MacroBuilder &Builder) {
195  DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
196                 TI.isTypeSigned(Ty), Builder);
197}
198
199static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
200                       MacroBuilder &Builder) {
201  Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
202}
203
204static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty,
205                            const TargetInfo &TI, MacroBuilder &Builder) {
206  Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
207}
208
209static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
210                             const TargetInfo &TI, MacroBuilder &Builder) {
211  Builder.defineMacro(MacroName,
212                      Twine(BitWidth / TI.getCharWidth()));
213}
214
215static void DefineExactWidthIntType(TargetInfo::IntType Ty,
216                               const TargetInfo &TI, MacroBuilder &Builder) {
217  int TypeWidth = TI.getTypeWidth(Ty);
218
219  // Use the target specified int64 type, when appropriate, so that [u]int64_t
220  // ends up being defined in terms of the correct type.
221  if (TypeWidth == 64)
222    Ty = TI.getInt64Type();
223
224  DefineType("__INT" + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
225
226  StringRef ConstSuffix(TargetInfo::getTypeConstantSuffix(Ty));
227  if (!ConstSuffix.empty())
228    Builder.defineMacro("__INT" + Twine(TypeWidth) + "_C_SUFFIX__",
229                        ConstSuffix);
230}
231
232/// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
233/// the specified properties.
234static const char *getLockFreeValue(unsigned TypeWidth, unsigned TypeAlign,
235                                    unsigned InlineWidth) {
236  // Fully-aligned, power-of-2 sizes no larger than the inline
237  // width will be inlined as lock-free operations.
238  if (TypeWidth == TypeAlign && (TypeWidth & (TypeWidth - 1)) == 0 &&
239      TypeWidth <= InlineWidth)
240    return "2"; // "always lock free"
241  // We cannot be certain what operations the lib calls might be
242  // able to implement as lock-free on future processors.
243  return "1"; // "sometimes lock free"
244}
245
246/// \brief Add definitions required for a smooth interaction between
247/// Objective-C++ automated reference counting and libstdc++ (4.2).
248static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
249                                         MacroBuilder &Builder) {
250  Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
251
252  std::string Result;
253  {
254    // Provide specializations for the __is_scalar type trait so that
255    // lifetime-qualified objects are not considered "scalar" types, which
256    // libstdc++ uses as an indicator of the presence of trivial copy, assign,
257    // default-construct, and destruct semantics (none of which hold for
258    // lifetime-qualified objects in ARC).
259    llvm::raw_string_ostream Out(Result);
260
261    Out << "namespace std {\n"
262        << "\n"
263        << "struct __true_type;\n"
264        << "struct __false_type;\n"
265        << "\n";
266
267    Out << "template<typename _Tp> struct __is_scalar;\n"
268        << "\n";
269
270    Out << "template<typename _Tp>\n"
271        << "struct __is_scalar<__attribute__((objc_ownership(strong))) _Tp> {\n"
272        << "  enum { __value = 0 };\n"
273        << "  typedef __false_type __type;\n"
274        << "};\n"
275        << "\n";
276
277    if (LangOpts.ObjCARCWeak) {
278      Out << "template<typename _Tp>\n"
279          << "struct __is_scalar<__attribute__((objc_ownership(weak))) _Tp> {\n"
280          << "  enum { __value = 0 };\n"
281          << "  typedef __false_type __type;\n"
282          << "};\n"
283          << "\n";
284    }
285
286    Out << "template<typename _Tp>\n"
287        << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
288        << " _Tp> {\n"
289        << "  enum { __value = 0 };\n"
290        << "  typedef __false_type __type;\n"
291        << "};\n"
292        << "\n";
293
294    Out << "}\n";
295  }
296  Builder.append(Result);
297}
298
299static void InitializeStandardPredefinedMacros(const TargetInfo &TI,
300                                               const LangOptions &LangOpts,
301                                               const FrontendOptions &FEOpts,
302                                               MacroBuilder &Builder) {
303  if (!LangOpts.MicrosoftMode && !LangOpts.TraditionalCPP)
304    Builder.defineMacro("__STDC__");
305  if (LangOpts.Freestanding)
306    Builder.defineMacro("__STDC_HOSTED__", "0");
307  else
308    Builder.defineMacro("__STDC_HOSTED__");
309
310  if (!LangOpts.CPlusPlus) {
311    if (LangOpts.C11)
312      Builder.defineMacro("__STDC_VERSION__", "201112L");
313    else if (LangOpts.C99)
314      Builder.defineMacro("__STDC_VERSION__", "199901L");
315    else if (!LangOpts.GNUMode && LangOpts.Digraphs)
316      Builder.defineMacro("__STDC_VERSION__", "199409L");
317  } else {
318    // FIXME: Use the right value for __cplusplus for C++1y once one is chosen.
319    if (LangOpts.CPlusPlus1y)
320      Builder.defineMacro("__cplusplus", "201305L");
321    // C++11 [cpp.predefined]p1:
322    //   The name __cplusplus is defined to the value 201103L when compiling a
323    //   C++ translation unit.
324    else if (LangOpts.CPlusPlus11)
325      Builder.defineMacro("__cplusplus", "201103L");
326    // C++03 [cpp.predefined]p1:
327    //   The name __cplusplus is defined to the value 199711L when compiling a
328    //   C++ translation unit.
329    else
330      Builder.defineMacro("__cplusplus", "199711L");
331  }
332
333  // In C11 these are environment macros. In C++11 they are only defined
334  // as part of <cuchar>. To prevent breakage when mixing C and C++
335  // code, define these macros unconditionally. We can define them
336  // unconditionally, as Clang always uses UTF-16 and UTF-32 for 16-bit
337  // and 32-bit character literals.
338  Builder.defineMacro("__STDC_UTF_16__", "1");
339  Builder.defineMacro("__STDC_UTF_32__", "1");
340
341  if (LangOpts.ObjC1)
342    Builder.defineMacro("__OBJC__");
343
344  // Not "standard" per se, but available even with the -undef flag.
345  if (LangOpts.AsmPreprocessor)
346    Builder.defineMacro("__ASSEMBLER__");
347}
348
349static void InitializePredefinedMacros(const TargetInfo &TI,
350                                       const LangOptions &LangOpts,
351                                       const FrontendOptions &FEOpts,
352                                       MacroBuilder &Builder) {
353  // Compiler version introspection macros.
354  Builder.defineMacro("__llvm__");  // LLVM Backend
355  Builder.defineMacro("__clang__"); // Clang Frontend
356#define TOSTR2(X) #X
357#define TOSTR(X) TOSTR2(X)
358  Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
359  Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
360#ifdef CLANG_VERSION_PATCHLEVEL
361  Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
362#else
363  Builder.defineMacro("__clang_patchlevel__", "0");
364#endif
365  Builder.defineMacro("__clang_version__",
366                      "\"" CLANG_VERSION_STRING " "
367                      + getClangFullRepositoryVersion() + "\"");
368#undef TOSTR
369#undef TOSTR2
370  if (!LangOpts.MicrosoftMode) {
371    // Currently claim to be compatible with GCC 4.2.1-5621, but only if we're
372    // not compiling for MSVC compatibility
373    Builder.defineMacro("__GNUC_MINOR__", "2");
374    Builder.defineMacro("__GNUC_PATCHLEVEL__", "1");
375    Builder.defineMacro("__GNUC__", "4");
376    Builder.defineMacro("__GXX_ABI_VERSION", "1002");
377  }
378
379  // Define macros for the C11 / C++11 memory orderings
380  Builder.defineMacro("__ATOMIC_RELAXED", "0");
381  Builder.defineMacro("__ATOMIC_CONSUME", "1");
382  Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
383  Builder.defineMacro("__ATOMIC_RELEASE", "3");
384  Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
385  Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
386
387  // Support for #pragma redefine_extname (Sun compatibility)
388  Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
389
390  // As sad as it is, enough software depends on the __VERSION__ for version
391  // checks that it is necessary to report 4.2.1 (the base GCC version we claim
392  // compatibility with) first.
393  Builder.defineMacro("__VERSION__", "\"4.2.1 Compatible " +
394                      Twine(getClangFullCPPVersion()) + "\"");
395
396  // Initialize language-specific preprocessor defines.
397
398  // Standard conforming mode?
399  if (!LangOpts.GNUMode)
400    Builder.defineMacro("__STRICT_ANSI__");
401
402  if (LangOpts.CPlusPlus11)
403    Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
404
405  if (LangOpts.ObjC1) {
406    if (LangOpts.ObjCRuntime.isNonFragile()) {
407      Builder.defineMacro("__OBJC2__");
408
409      if (LangOpts.ObjCExceptions)
410        Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
411    }
412
413    if (LangOpts.getGC() != LangOptions::NonGC)
414      Builder.defineMacro("__OBJC_GC__");
415
416    if (LangOpts.ObjCRuntime.isNeXTFamily())
417      Builder.defineMacro("__NEXT_RUNTIME__");
418
419    if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
420      VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
421
422      unsigned minor = 0;
423      if (tuple.getMinor().hasValue())
424        minor = tuple.getMinor().getValue();
425
426      unsigned subminor = 0;
427      if (tuple.getSubminor().hasValue())
428        subminor = tuple.getSubminor().getValue();
429
430      Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
431                          Twine(tuple.getMajor() * 10000 + minor * 100 +
432                                subminor));
433    }
434
435    Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
436    Builder.defineMacro("IBOutletCollection(ClassName)",
437                        "__attribute__((iboutletcollection(ClassName)))");
438    Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
439  }
440
441  // darwin_constant_cfstrings controls this. This is also dependent
442  // on other things like the runtime I believe.  This is set even for C code.
443  if (!LangOpts.NoConstantCFStrings)
444      Builder.defineMacro("__CONSTANT_CFSTRINGS__");
445
446  if (LangOpts.ObjC2)
447    Builder.defineMacro("OBJC_NEW_PROPERTIES");
448
449  if (LangOpts.PascalStrings)
450    Builder.defineMacro("__PASCAL_STRINGS__");
451
452  if (LangOpts.Blocks) {
453    Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
454    Builder.defineMacro("__BLOCKS__");
455  }
456
457  if (LangOpts.CXXExceptions)
458    Builder.defineMacro("__EXCEPTIONS");
459  if (LangOpts.RTTI)
460    Builder.defineMacro("__GXX_RTTI");
461  if (LangOpts.SjLjExceptions)
462    Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
463
464  if (LangOpts.Deprecated)
465    Builder.defineMacro("__DEPRECATED");
466
467  if (LangOpts.CPlusPlus) {
468    Builder.defineMacro("__GNUG__", "4");
469    Builder.defineMacro("__GXX_WEAK__");
470    Builder.defineMacro("__private_extern__", "extern");
471  }
472
473  if (LangOpts.MicrosoftExt) {
474    // Both __PRETTY_FUNCTION__ and __FUNCTION__ are GCC extensions, however
475    // VC++ appears to only like __FUNCTION__.
476    Builder.defineMacro("__PRETTY_FUNCTION__", "__FUNCTION__");
477    // Work around some issues with Visual C++ headers.
478    if (LangOpts.WChar) {
479      // wchar_t supported as a keyword.
480      Builder.defineMacro("_WCHAR_T_DEFINED");
481      Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
482    }
483    if (LangOpts.CPlusPlus) {
484      // FIXME: Support Microsoft's __identifier extension in the lexer.
485      Builder.append("#define __identifier(x) x");
486      Builder.append("class type_info;");
487    }
488  }
489
490  if (LangOpts.Optimize)
491    Builder.defineMacro("__OPTIMIZE__");
492  if (LangOpts.OptimizeSize)
493    Builder.defineMacro("__OPTIMIZE_SIZE__");
494
495  if (LangOpts.FastMath)
496    Builder.defineMacro("__FAST_MATH__");
497
498  // Initialize target-specific preprocessor defines.
499
500  // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
501  // to the macro __BYTE_ORDER (no trailing underscores)
502  // from glibc's <endian.h> header.
503  // We don't support the PDP-11 as a target, but include
504  // the define so it can still be compared against.
505  Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
506  Builder.defineMacro("__ORDER_BIG_ENDIAN__",    "4321");
507  Builder.defineMacro("__ORDER_PDP_ENDIAN__",    "3412");
508  if (TI.isBigEndian())
509    Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
510  else
511    Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
512
513
514  if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
515      && TI.getIntWidth() == 32) {
516    Builder.defineMacro("_LP64");
517    Builder.defineMacro("__LP64__");
518  }
519
520  // Define type sizing macros based on the target properties.
521  assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
522  Builder.defineMacro("__CHAR_BIT__", "8");
523
524  DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
525  DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
526  DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
527  DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
528  DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
529  DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
530  DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
531  DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
532
533  DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
534  DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
535  DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
536  DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
537  DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
538  DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
539  DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
540  DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
541  DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
542                   TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
543  DefineTypeSizeof("__SIZEOF_SIZE_T__",
544                   TI.getTypeWidth(TI.getSizeType()), TI, Builder);
545  DefineTypeSizeof("__SIZEOF_WCHAR_T__",
546                   TI.getTypeWidth(TI.getWCharType()), TI, Builder);
547  DefineTypeSizeof("__SIZEOF_WINT_T__",
548                   TI.getTypeWidth(TI.getWIntType()), TI, Builder);
549  if (TI.hasInt128Type())
550    DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
551
552  DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
553  DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
554  DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
555  DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
556  DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
557  DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
558  DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
559  DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
560  DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
561  DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
562  DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
563  DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
564  DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
565  DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
566  DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
567  DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
568
569  DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
570  DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
571  DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
572
573  // Define a __POINTER_WIDTH__ macro for stdint.h.
574  Builder.defineMacro("__POINTER_WIDTH__",
575                      Twine((int)TI.getPointerWidth(0)));
576
577  if (!LangOpts.CharIsSigned)
578    Builder.defineMacro("__CHAR_UNSIGNED__");
579
580  if (!TargetInfo::isTypeSigned(TI.getWCharType()))
581    Builder.defineMacro("__WCHAR_UNSIGNED__");
582
583  if (!TargetInfo::isTypeSigned(TI.getWIntType()))
584    Builder.defineMacro("__WINT_UNSIGNED__");
585
586  // Define exact-width integer types for stdint.h
587  Builder.defineMacro("__INT" + Twine(TI.getCharWidth()) + "_TYPE__",
588                      "char");
589
590  if (TI.getShortWidth() > TI.getCharWidth())
591    DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
592
593  if (TI.getIntWidth() > TI.getShortWidth())
594    DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
595
596  if (TI.getLongWidth() > TI.getIntWidth())
597    DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
598
599  if (TI.getLongLongWidth() > TI.getLongWidth())
600    DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
601
602  if (const char *Prefix = TI.getUserLabelPrefix())
603    Builder.defineMacro("__USER_LABEL_PREFIX__", Prefix);
604
605  if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
606    Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
607  else
608    Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
609
610  if (LangOpts.GNUInline)
611    Builder.defineMacro("__GNUC_GNU_INLINE__");
612  else
613    Builder.defineMacro("__GNUC_STDC_INLINE__");
614
615  // The value written by __atomic_test_and_set.
616  // FIXME: This is target-dependent.
617  Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
618
619  // Used by libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
620  unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
621#define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \
622  Builder.defineMacro("__GCC_ATOMIC_" #TYPE "_LOCK_FREE", \
623                      getLockFreeValue(TI.get##Type##Width(), \
624                                       TI.get##Type##Align(), \
625                                       InlineWidthBits));
626  DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
627  DEFINE_LOCK_FREE_MACRO(CHAR, Char);
628  DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
629  DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
630  DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
631  DEFINE_LOCK_FREE_MACRO(SHORT, Short);
632  DEFINE_LOCK_FREE_MACRO(INT, Int);
633  DEFINE_LOCK_FREE_MACRO(LONG, Long);
634  DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
635  Builder.defineMacro("__GCC_ATOMIC_POINTER_LOCK_FREE",
636                      getLockFreeValue(TI.getPointerWidth(0),
637                                       TI.getPointerAlign(0),
638                                       InlineWidthBits));
639#undef DEFINE_LOCK_FREE_MACRO
640
641  if (LangOpts.NoInlineDefine)
642    Builder.defineMacro("__NO_INLINE__");
643
644  if (unsigned PICLevel = LangOpts.PICLevel) {
645    Builder.defineMacro("__PIC__", Twine(PICLevel));
646    Builder.defineMacro("__pic__", Twine(PICLevel));
647  }
648  if (unsigned PIELevel = LangOpts.PIELevel) {
649    Builder.defineMacro("__PIE__", Twine(PIELevel));
650    Builder.defineMacro("__pie__", Twine(PIELevel));
651  }
652
653  // Macros to control C99 numerics and <float.h>
654  Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
655  Builder.defineMacro("__FLT_RADIX__", "2");
656  int Dig = PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33, 36);
657  Builder.defineMacro("__DECIMAL_DIG__", Twine(Dig));
658
659  if (LangOpts.getStackProtector() == LangOptions::SSPOn)
660    Builder.defineMacro("__SSP__");
661  else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
662    Builder.defineMacro("__SSP_ALL__", "2");
663
664  if (FEOpts.ProgramAction == frontend::RewriteObjC)
665    Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
666
667  // Define a macro that exists only when using the static analyzer.
668  if (FEOpts.ProgramAction == frontend::RunAnalysis)
669    Builder.defineMacro("__clang_analyzer__");
670
671  if (LangOpts.FastRelaxedMath)
672    Builder.defineMacro("__FAST_RELAXED_MATH__");
673
674  if (LangOpts.ObjCAutoRefCount) {
675    Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
676    Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
677    Builder.defineMacro("__autoreleasing",
678                        "__attribute__((objc_ownership(autoreleasing)))");
679    Builder.defineMacro("__unsafe_unretained",
680                        "__attribute__((objc_ownership(none)))");
681  }
682
683  // OpenMP definition
684  if (LangOpts.OpenMP) {
685    // OpenMP 2.2:
686    //   In implementations that support a preprocessor, the _OPENMP
687    //   macro name is defined to have the decimal value yyyymm where
688    //   yyyy and mm are the year and the month designations of the
689    //   version of the OpenMP API that the implementation support.
690    Builder.defineMacro("_OPENMP", "201107");
691  }
692
693  // Get other target #defines.
694  TI.getTargetDefines(LangOpts, Builder);
695}
696
697// Initialize the remapping of files to alternative contents, e.g.,
698// those specified through other files.
699static void InitializeFileRemapping(DiagnosticsEngine &Diags,
700                                    SourceManager &SourceMgr,
701                                    FileManager &FileMgr,
702                                    const PreprocessorOptions &InitOpts) {
703  // Remap files in the source manager (with buffers).
704  for (PreprocessorOptions::const_remapped_file_buffer_iterator
705         Remap = InitOpts.remapped_file_buffer_begin(),
706         RemapEnd = InitOpts.remapped_file_buffer_end();
707       Remap != RemapEnd;
708       ++Remap) {
709    // Create the file entry for the file that we're mapping from.
710    const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
711                                                Remap->second->getBufferSize(),
712                                                       0);
713    if (!FromFile) {
714      Diags.Report(diag::err_fe_remap_missing_from_file)
715        << Remap->first;
716      if (!InitOpts.RetainRemappedFileBuffers)
717        delete Remap->second;
718      continue;
719    }
720
721    // Override the contents of the "from" file with the contents of
722    // the "to" file.
723    SourceMgr.overrideFileContents(FromFile, Remap->second,
724                                   InitOpts.RetainRemappedFileBuffers);
725  }
726
727  // Remap files in the source manager (with other files).
728  for (PreprocessorOptions::const_remapped_file_iterator
729         Remap = InitOpts.remapped_file_begin(),
730         RemapEnd = InitOpts.remapped_file_end();
731       Remap != RemapEnd;
732       ++Remap) {
733    // Find the file that we're mapping to.
734    const FileEntry *ToFile = FileMgr.getFile(Remap->second);
735    if (!ToFile) {
736      Diags.Report(diag::err_fe_remap_missing_to_file)
737      << Remap->first << Remap->second;
738      continue;
739    }
740
741    // Create the file entry for the file that we're mapping from.
742    const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
743                                                       ToFile->getSize(), 0);
744    if (!FromFile) {
745      Diags.Report(diag::err_fe_remap_missing_from_file)
746      << Remap->first;
747      continue;
748    }
749
750    // Override the contents of the "from" file with the contents of
751    // the "to" file.
752    SourceMgr.overrideFileContents(FromFile, ToFile);
753  }
754
755  SourceMgr.setOverridenFilesKeepOriginalName(
756                                        InitOpts.RemappedFilesKeepOriginalName);
757}
758
759/// InitializePreprocessor - Initialize the preprocessor getting it and the
760/// environment ready to process a single file. This returns true on error.
761///
762void clang::InitializePreprocessor(Preprocessor &PP,
763                                   const PreprocessorOptions &InitOpts,
764                                   const HeaderSearchOptions &HSOpts,
765                                   const FrontendOptions &FEOpts) {
766  const LangOptions &LangOpts = PP.getLangOpts();
767  std::string PredefineBuffer;
768  PredefineBuffer.reserve(4080);
769  llvm::raw_string_ostream Predefines(PredefineBuffer);
770  MacroBuilder Builder(Predefines);
771
772  InitializeFileRemapping(PP.getDiagnostics(), PP.getSourceManager(),
773                          PP.getFileManager(), InitOpts);
774
775  // Emit line markers for various builtin sections of the file.  We don't do
776  // this in asm preprocessor mode, because "# 4" is not a line marker directive
777  // in this mode.
778  if (!PP.getLangOpts().AsmPreprocessor)
779    Builder.append("# 1 \"<built-in>\" 3");
780
781  // Install things like __POWERPC__, __GNUC__, etc into the macro table.
782  if (InitOpts.UsePredefines) {
783    InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, Builder);
784
785    // Install definitions to make Objective-C++ ARC work well with various
786    // C++ Standard Library implementations.
787    if (LangOpts.ObjC1 && LangOpts.CPlusPlus && LangOpts.ObjCAutoRefCount) {
788      switch (InitOpts.ObjCXXARCStandardLibrary) {
789      case ARCXX_nolib:
790        case ARCXX_libcxx:
791        break;
792
793      case ARCXX_libstdcxx:
794        AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
795        break;
796      }
797    }
798  }
799
800  // Even with predefines off, some macros are still predefined.
801  // These should all be defined in the preprocessor according to the
802  // current language configuration.
803  InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
804                                     FEOpts, Builder);
805
806  // Add on the predefines from the driver.  Wrap in a #line directive to report
807  // that they come from the command line.
808  if (!PP.getLangOpts().AsmPreprocessor)
809    Builder.append("# 1 \"<command line>\" 1");
810
811  // Process #define's and #undef's in the order they are given.
812  for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
813    if (InitOpts.Macros[i].second)  // isUndef
814      Builder.undefineMacro(InitOpts.Macros[i].first);
815    else
816      DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
817                         PP.getDiagnostics());
818  }
819
820  // If -imacros are specified, include them now.  These are processed before
821  // any -include directives.
822  for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
823    AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i],
824                             PP.getFileManager());
825
826  // Process -include-pch/-include-pth directives.
827  if (!InitOpts.ImplicitPCHInclude.empty())
828    AddImplicitIncludePCH(Builder, PP, InitOpts.ImplicitPCHInclude);
829  if (!InitOpts.ImplicitPTHInclude.empty())
830    AddImplicitIncludePTH(Builder, PP, InitOpts.ImplicitPTHInclude);
831
832  // Process -include directives.
833  for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
834    const std::string &Path = InitOpts.Includes[i];
835    AddImplicitInclude(Builder, Path, PP.getFileManager());
836  }
837
838  // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
839  if (!PP.getLangOpts().AsmPreprocessor)
840    Builder.append("# 1 \"<built-in>\" 2");
841
842  // Instruct the preprocessor to skip the preamble.
843  PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
844                             InitOpts.PrecompiledPreambleBytes.second);
845
846  // Copy PredefinedBuffer into the Preprocessor.
847  PP.setPredefines(Predefines.str());
848
849  // Initialize the header search object.
850  ApplyHeaderSearchOptions(PP.getHeaderSearchInfo(), HSOpts,
851                           PP.getLangOpts(),
852                           PP.getTargetInfo().getTriple());
853}
854