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