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 static bool MacroBodyEndsInBackslash(StringRef MacroBody) {
33 while (!MacroBody.empty() && isWhitespace(MacroBody.back()))
34 MacroBody = MacroBody.drop_back();
35 return !MacroBody.empty() && MacroBody.back() == '\\';
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=".
41 static 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)
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");
59 Builder.defineMacro(MacroName, MacroBody);
61 // Push "macroname 1".
62 Builder.defineMacro(Macro);
66 /// AddImplicitInclude - Add an implicit \#include of the specified file to the
67 /// predefines buffer.
68 static void AddImplicitInclude(MacroBuilder &Builder, StringRef File,
69 FileManager &FileMgr) {
70 Builder.append(Twine("#include \"") +
71 HeaderSearch::NormalizeDashIncludePath(File, FileMgr) + "\"");
74 static void AddImplicitIncludeMacros(MacroBuilder &Builder,
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("##"); // ##?
83 /// AddImplicitIncludePTH - Add an implicit \#include using the original file
84 /// used to generate a PTH cache.
85 static 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;
92 PP.getDiagnostics().Report(diag::err_fe_pth_file_has_no_source_header)
93 << ImplicitIncludePTH;
97 AddImplicitInclude(Builder, OriginalFile, PP.getFileManager());
100 /// \brief Add an implicit \#include using the original file used to generate
102 static 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())
110 AddImplicitInclude(Builder, OriginalFile, PP.getFileManager());
113 /// PickFP - This is used to pick a value based on the FP semantics of the
114 /// specified FP model.
115 template <typename T>
116 static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
117 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
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);
131 static 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");
157 SmallString<32> DefPrefix;
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));
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);
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);
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).
183 static 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);
191 /// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
192 /// the width, suffix, and signedness of the given type
193 static 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);
199 static void DefineType(const Twine &MacroName, TargetInfo::IntType Ty,
200 MacroBuilder &Builder) {
201 Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
204 static void DefineTypeWidth(StringRef MacroName, TargetInfo::IntType Ty,
205 const TargetInfo &TI, MacroBuilder &Builder) {
206 Builder.defineMacro(MacroName, Twine(TI.getTypeWidth(Ty)));
209 static void DefineTypeSizeof(StringRef MacroName, unsigned BitWidth,
210 const TargetInfo &TI, MacroBuilder &Builder) {
211 Builder.defineMacro(MacroName,
212 Twine(BitWidth / TI.getCharWidth()));
215 static void DefineExactWidthIntType(TargetInfo::IntType Ty,
216 const TargetInfo &TI, MacroBuilder &Builder) {
217 int TypeWidth = TI.getTypeWidth(Ty);
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.
222 Ty = TI.getInt64Type();
224 DefineType("__INT" + Twine(TypeWidth) + "_TYPE__", Ty, Builder);
226 StringRef ConstSuffix(TargetInfo::getTypeConstantSuffix(Ty));
227 if (!ConstSuffix.empty())
228 Builder.defineMacro("__INT" + Twine(TypeWidth) + "_C_SUFFIX__",
232 /// Get the value the ATOMIC_*_LOCK_FREE macro should have for a type with
233 /// the specified properties.
234 static 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"
246 /// \brief Add definitions required for a smooth interaction between
247 /// Objective-C++ automated reference counting and libstdc++ (4.2).
248 static void AddObjCXXARCLibstdcxxDefines(const LangOptions &LangOpts,
249 MacroBuilder &Builder) {
250 Builder.defineMacro("_GLIBCXX_PREDEFINED_OBJC_ARC_IS_SCALAR");
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);
261 Out << "namespace std {\n"
263 << "struct __true_type;\n"
264 << "struct __false_type;\n"
267 Out << "template<typename _Tp> struct __is_scalar;\n"
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"
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"
286 Out << "template<typename _Tp>\n"
287 << "struct __is_scalar<__attribute__((objc_ownership(autoreleasing)))"
289 << " enum { __value = 0 };\n"
290 << " typedef __false_type __type;\n"
296 Builder.append(Result);
299 static 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");
308 Builder.defineMacro("__STDC_HOSTED__");
310 if (!LangOpts.CPlusPlus) {
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");
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.
330 Builder.defineMacro("__cplusplus", "199711L");
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");
342 Builder.defineMacro("__OBJC__");
344 // Not "standard" per se, but available even with the -undef flag.
345 if (LangOpts.AsmPreprocessor)
346 Builder.defineMacro("__ASSEMBLER__");
349 /// Initialize the predefined C++ language feature test macros defined in
350 /// ISO/IEC JTC1/SC22/WG21 (C++) SD-6: "SG10 Feature Test Recommendations".
351 static void InitializeCPlusPlusFeatureTestMacros(const LangOptions &LangOpts,
352 MacroBuilder &Builder) {
354 if (LangOpts.CPlusPlus11) {
355 Builder.defineMacro("__cpp_unicode_characters", "200704");
356 Builder.defineMacro("__cpp_raw_strings", "200710");
357 Builder.defineMacro("__cpp_unicode_literals", "200710");
358 Builder.defineMacro("__cpp_user_defined_literals", "200809");
359 Builder.defineMacro("__cpp_lambdas", "200907");
360 Builder.defineMacro("__cpp_constexpr",
361 LangOpts.CPlusPlus1y ? "201304" : "200704");
362 Builder.defineMacro("__cpp_static_assert", "200410");
363 Builder.defineMacro("__cpp_decltype", "200707");
364 Builder.defineMacro("__cpp_attributes", "200809");
365 Builder.defineMacro("__cpp_rvalue_references", "200610");
366 Builder.defineMacro("__cpp_variadic_templates", "200704");
370 if (LangOpts.CPlusPlus1y) {
371 Builder.defineMacro("__cpp_binary_literals", "201304");
372 Builder.defineMacro("__cpp_init_captures", "201304");
373 Builder.defineMacro("__cpp_generic_lambdas", "201304");
374 Builder.defineMacro("__cpp_decltype_auto", "201304");
375 Builder.defineMacro("__cpp_return_type_deduction", "201304");
376 Builder.defineMacro("__cpp_aggregate_nsdmi", "201304");
377 Builder.defineMacro("__cpp_variable_templates", "201304");
381 static void InitializePredefinedMacros(const TargetInfo &TI,
382 const LangOptions &LangOpts,
383 const FrontendOptions &FEOpts,
384 MacroBuilder &Builder) {
385 // Compiler version introspection macros.
386 Builder.defineMacro("__llvm__"); // LLVM Backend
387 Builder.defineMacro("__clang__"); // Clang Frontend
389 #define TOSTR(X) TOSTR2(X)
390 Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
391 Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
392 #ifdef CLANG_VERSION_PATCHLEVEL
393 Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
395 Builder.defineMacro("__clang_patchlevel__", "0");
397 Builder.defineMacro("__clang_version__",
398 "\"" CLANG_VERSION_STRING " "
399 + getClangFullRepositoryVersion() + "\"");
402 if (!LangOpts.MicrosoftMode) {
403 // Currently claim to be compatible with GCC 4.2.1-5621, but only if we're
404 // not compiling for MSVC compatibility
405 Builder.defineMacro("__GNUC_MINOR__", "2");
406 Builder.defineMacro("__GNUC_PATCHLEVEL__", "1");
407 Builder.defineMacro("__GNUC__", "4");
408 Builder.defineMacro("__GXX_ABI_VERSION", "1002");
411 // Define macros for the C11 / C++11 memory orderings
412 Builder.defineMacro("__ATOMIC_RELAXED", "0");
413 Builder.defineMacro("__ATOMIC_CONSUME", "1");
414 Builder.defineMacro("__ATOMIC_ACQUIRE", "2");
415 Builder.defineMacro("__ATOMIC_RELEASE", "3");
416 Builder.defineMacro("__ATOMIC_ACQ_REL", "4");
417 Builder.defineMacro("__ATOMIC_SEQ_CST", "5");
419 // Support for #pragma redefine_extname (Sun compatibility)
420 Builder.defineMacro("__PRAGMA_REDEFINE_EXTNAME", "1");
422 // As sad as it is, enough software depends on the __VERSION__ for version
423 // checks that it is necessary to report 4.2.1 (the base GCC version we claim
424 // compatibility with) first.
425 Builder.defineMacro("__VERSION__", "\"4.2.1 Compatible " +
426 Twine(getClangFullCPPVersion()) + "\"");
428 // Initialize language-specific preprocessor defines.
430 // Standard conforming mode?
431 if (!LangOpts.GNUMode)
432 Builder.defineMacro("__STRICT_ANSI__");
434 if (LangOpts.CPlusPlus11)
435 Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
437 if (LangOpts.ObjC1) {
438 if (LangOpts.ObjCRuntime.isNonFragile()) {
439 Builder.defineMacro("__OBJC2__");
441 if (LangOpts.ObjCExceptions)
442 Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
445 if (LangOpts.getGC() != LangOptions::NonGC)
446 Builder.defineMacro("__OBJC_GC__");
448 if (LangOpts.ObjCRuntime.isNeXTFamily())
449 Builder.defineMacro("__NEXT_RUNTIME__");
451 if (LangOpts.ObjCRuntime.getKind() == ObjCRuntime::ObjFW) {
452 VersionTuple tuple = LangOpts.ObjCRuntime.getVersion();
455 if (tuple.getMinor().hasValue())
456 minor = tuple.getMinor().getValue();
458 unsigned subminor = 0;
459 if (tuple.getSubminor().hasValue())
460 subminor = tuple.getSubminor().getValue();
462 Builder.defineMacro("__OBJFW_RUNTIME_ABI__",
463 Twine(tuple.getMajor() * 10000 + minor * 100 +
467 Builder.defineMacro("IBOutlet", "__attribute__((iboutlet))");
468 Builder.defineMacro("IBOutletCollection(ClassName)",
469 "__attribute__((iboutletcollection(ClassName)))");
470 Builder.defineMacro("IBAction", "void)__attribute__((ibaction)");
473 if (LangOpts.CPlusPlus)
474 InitializeCPlusPlusFeatureTestMacros(LangOpts, Builder);
476 // darwin_constant_cfstrings controls this. This is also dependent
477 // on other things like the runtime I believe. This is set even for C code.
478 if (!LangOpts.NoConstantCFStrings)
479 Builder.defineMacro("__CONSTANT_CFSTRINGS__");
482 Builder.defineMacro("OBJC_NEW_PROPERTIES");
484 if (LangOpts.PascalStrings)
485 Builder.defineMacro("__PASCAL_STRINGS__");
487 if (LangOpts.Blocks) {
488 Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
489 Builder.defineMacro("__BLOCKS__");
492 if (LangOpts.CXXExceptions)
493 Builder.defineMacro("__EXCEPTIONS");
495 Builder.defineMacro("__GXX_RTTI");
496 if (LangOpts.SjLjExceptions)
497 Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
499 if (LangOpts.Deprecated)
500 Builder.defineMacro("__DEPRECATED");
502 if (LangOpts.CPlusPlus) {
503 Builder.defineMacro("__GNUG__", "4");
504 Builder.defineMacro("__GXX_WEAK__");
505 Builder.defineMacro("__private_extern__", "extern");
508 if (LangOpts.MicrosoftExt) {
509 // Both __PRETTY_FUNCTION__ and __FUNCTION__ are GCC extensions, however
510 // VC++ appears to only like __FUNCTION__.
511 Builder.defineMacro("__PRETTY_FUNCTION__", "__FUNCTION__");
512 // Work around some issues with Visual C++ headers.
513 if (LangOpts.WChar) {
514 // wchar_t supported as a keyword.
515 Builder.defineMacro("_WCHAR_T_DEFINED");
516 Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
518 if (LangOpts.CPlusPlus) {
519 // FIXME: Support Microsoft's __identifier extension in the lexer.
520 Builder.append("#define __identifier(x) x");
521 Builder.append("class type_info;");
525 if (LangOpts.Optimize)
526 Builder.defineMacro("__OPTIMIZE__");
527 if (LangOpts.OptimizeSize)
528 Builder.defineMacro("__OPTIMIZE_SIZE__");
530 if (LangOpts.FastMath)
531 Builder.defineMacro("__FAST_MATH__");
533 // Initialize target-specific preprocessor defines.
535 // __BYTE_ORDER__ was added in GCC 4.6. It's analogous
536 // to the macro __BYTE_ORDER (no trailing underscores)
537 // from glibc's <endian.h> header.
538 // We don't support the PDP-11 as a target, but include
539 // the define so it can still be compared against.
540 Builder.defineMacro("__ORDER_LITTLE_ENDIAN__", "1234");
541 Builder.defineMacro("__ORDER_BIG_ENDIAN__", "4321");
542 Builder.defineMacro("__ORDER_PDP_ENDIAN__", "3412");
543 if (TI.isBigEndian())
544 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_BIG_ENDIAN__");
546 Builder.defineMacro("__BYTE_ORDER__", "__ORDER_LITTLE_ENDIAN__");
549 if (TI.getPointerWidth(0) == 64 && TI.getLongWidth() == 64
550 && TI.getIntWidth() == 32) {
551 Builder.defineMacro("_LP64");
552 Builder.defineMacro("__LP64__");
555 // Define type sizing macros based on the target properties.
556 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
557 Builder.defineMacro("__CHAR_BIT__", "8");
559 DefineTypeSize("__SCHAR_MAX__", TargetInfo::SignedChar, TI, Builder);
560 DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
561 DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
562 DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
563 DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
564 DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
565 DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
566 DefineTypeSize("__SIZE_MAX__", TI.getSizeType(), TI, Builder);
568 DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
569 DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
570 DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
571 DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
572 DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
573 DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
574 DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
575 DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
576 DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
577 TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
578 DefineTypeSizeof("__SIZEOF_SIZE_T__",
579 TI.getTypeWidth(TI.getSizeType()), TI, Builder);
580 DefineTypeSizeof("__SIZEOF_WCHAR_T__",
581 TI.getTypeWidth(TI.getWCharType()), TI, Builder);
582 DefineTypeSizeof("__SIZEOF_WINT_T__",
583 TI.getTypeWidth(TI.getWIntType()), TI, Builder);
584 if (TI.hasInt128Type())
585 DefineTypeSizeof("__SIZEOF_INT128__", 128, TI, Builder);
587 DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
588 DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
589 DefineTypeWidth("__INTMAX_WIDTH__", TI.getIntMaxType(), TI, Builder);
590 DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
591 DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
592 DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
593 DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
594 DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
595 DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
596 DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
597 DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
598 DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
599 DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
600 DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
601 DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
602 DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
604 DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat(), "F");
605 DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat(), "");
606 DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat(), "L");
608 // Define a __POINTER_WIDTH__ macro for stdint.h.
609 Builder.defineMacro("__POINTER_WIDTH__",
610 Twine((int)TI.getPointerWidth(0)));
612 if (!LangOpts.CharIsSigned)
613 Builder.defineMacro("__CHAR_UNSIGNED__");
615 if (!TargetInfo::isTypeSigned(TI.getWCharType()))
616 Builder.defineMacro("__WCHAR_UNSIGNED__");
618 if (!TargetInfo::isTypeSigned(TI.getWIntType()))
619 Builder.defineMacro("__WINT_UNSIGNED__");
621 // Define exact-width integer types for stdint.h
622 Builder.defineMacro("__INT" + Twine(TI.getCharWidth()) + "_TYPE__",
625 if (TI.getShortWidth() > TI.getCharWidth())
626 DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
628 if (TI.getIntWidth() > TI.getShortWidth())
629 DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
631 if (TI.getLongWidth() > TI.getIntWidth())
632 DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
634 if (TI.getLongLongWidth() > TI.getLongWidth())
635 DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
637 if (const char *Prefix = TI.getUserLabelPrefix())
638 Builder.defineMacro("__USER_LABEL_PREFIX__", Prefix);
640 if (LangOpts.FastMath || LangOpts.FiniteMathOnly)
641 Builder.defineMacro("__FINITE_MATH_ONLY__", "1");
643 Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
645 if (LangOpts.GNUInline)
646 Builder.defineMacro("__GNUC_GNU_INLINE__");
648 Builder.defineMacro("__GNUC_STDC_INLINE__");
650 // The value written by __atomic_test_and_set.
651 // FIXME: This is target-dependent.
652 Builder.defineMacro("__GCC_ATOMIC_TEST_AND_SET_TRUEVAL", "1");
654 // Used by libstdc++ to implement ATOMIC_<foo>_LOCK_FREE.
655 unsigned InlineWidthBits = TI.getMaxAtomicInlineWidth();
656 #define DEFINE_LOCK_FREE_MACRO(TYPE, Type) \
657 Builder.defineMacro("__GCC_ATOMIC_" #TYPE "_LOCK_FREE", \
658 getLockFreeValue(TI.get##Type##Width(), \
659 TI.get##Type##Align(), \
661 DEFINE_LOCK_FREE_MACRO(BOOL, Bool);
662 DEFINE_LOCK_FREE_MACRO(CHAR, Char);
663 DEFINE_LOCK_FREE_MACRO(CHAR16_T, Char16);
664 DEFINE_LOCK_FREE_MACRO(CHAR32_T, Char32);
665 DEFINE_LOCK_FREE_MACRO(WCHAR_T, WChar);
666 DEFINE_LOCK_FREE_MACRO(SHORT, Short);
667 DEFINE_LOCK_FREE_MACRO(INT, Int);
668 DEFINE_LOCK_FREE_MACRO(LONG, Long);
669 DEFINE_LOCK_FREE_MACRO(LLONG, LongLong);
670 Builder.defineMacro("__GCC_ATOMIC_POINTER_LOCK_FREE",
671 getLockFreeValue(TI.getPointerWidth(0),
672 TI.getPointerAlign(0),
674 #undef DEFINE_LOCK_FREE_MACRO
676 if (LangOpts.NoInlineDefine)
677 Builder.defineMacro("__NO_INLINE__");
679 if (unsigned PICLevel = LangOpts.PICLevel) {
680 Builder.defineMacro("__PIC__", Twine(PICLevel));
681 Builder.defineMacro("__pic__", Twine(PICLevel));
683 if (unsigned PIELevel = LangOpts.PIELevel) {
684 Builder.defineMacro("__PIE__", Twine(PIELevel));
685 Builder.defineMacro("__pie__", Twine(PIELevel));
688 // Macros to control C99 numerics and <float.h>
689 Builder.defineMacro("__FLT_EVAL_METHOD__", Twine(TI.getFloatEvalMethod()));
690 Builder.defineMacro("__FLT_RADIX__", "2");
691 int Dig = PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33, 36);
692 Builder.defineMacro("__DECIMAL_DIG__", Twine(Dig));
694 if (LangOpts.getStackProtector() == LangOptions::SSPOn)
695 Builder.defineMacro("__SSP__");
696 else if (LangOpts.getStackProtector() == LangOptions::SSPReq)
697 Builder.defineMacro("__SSP_ALL__", "2");
699 if (FEOpts.ProgramAction == frontend::RewriteObjC)
700 Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
702 // Define a macro that exists only when using the static analyzer.
703 if (FEOpts.ProgramAction == frontend::RunAnalysis)
704 Builder.defineMacro("__clang_analyzer__");
706 if (LangOpts.FastRelaxedMath)
707 Builder.defineMacro("__FAST_RELAXED_MATH__");
709 if (LangOpts.ObjCAutoRefCount) {
710 Builder.defineMacro("__weak", "__attribute__((objc_ownership(weak)))");
711 Builder.defineMacro("__strong", "__attribute__((objc_ownership(strong)))");
712 Builder.defineMacro("__autoreleasing",
713 "__attribute__((objc_ownership(autoreleasing)))");
714 Builder.defineMacro("__unsafe_unretained",
715 "__attribute__((objc_ownership(none)))");
719 if (LangOpts.OpenMP) {
721 // In implementations that support a preprocessor, the _OPENMP
722 // macro name is defined to have the decimal value yyyymm where
723 // yyyy and mm are the year and the month designations of the
724 // version of the OpenMP API that the implementation support.
725 Builder.defineMacro("_OPENMP", "201107");
728 // Get other target #defines.
729 TI.getTargetDefines(LangOpts, Builder);
732 // Initialize the remapping of files to alternative contents, e.g.,
733 // those specified through other files.
734 static void InitializeFileRemapping(DiagnosticsEngine &Diags,
735 SourceManager &SourceMgr,
736 FileManager &FileMgr,
737 const PreprocessorOptions &InitOpts) {
738 // Remap files in the source manager (with buffers).
739 for (PreprocessorOptions::const_remapped_file_buffer_iterator
740 Remap = InitOpts.remapped_file_buffer_begin(),
741 RemapEnd = InitOpts.remapped_file_buffer_end();
744 // Create the file entry for the file that we're mapping from.
745 const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
746 Remap->second->getBufferSize(),
749 Diags.Report(diag::err_fe_remap_missing_from_file)
751 if (!InitOpts.RetainRemappedFileBuffers)
752 delete Remap->second;
756 // Override the contents of the "from" file with the contents of
758 SourceMgr.overrideFileContents(FromFile, Remap->second,
759 InitOpts.RetainRemappedFileBuffers);
762 // Remap files in the source manager (with other files).
763 for (PreprocessorOptions::const_remapped_file_iterator
764 Remap = InitOpts.remapped_file_begin(),
765 RemapEnd = InitOpts.remapped_file_end();
768 // Find the file that we're mapping to.
769 const FileEntry *ToFile = FileMgr.getFile(Remap->second);
771 Diags.Report(diag::err_fe_remap_missing_to_file)
772 << Remap->first << Remap->second;
776 // Create the file entry for the file that we're mapping from.
777 const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
778 ToFile->getSize(), 0);
780 Diags.Report(diag::err_fe_remap_missing_from_file)
785 // Override the contents of the "from" file with the contents of
787 SourceMgr.overrideFileContents(FromFile, ToFile);
790 SourceMgr.setOverridenFilesKeepOriginalName(
791 InitOpts.RemappedFilesKeepOriginalName);
794 /// InitializePreprocessor - Initialize the preprocessor getting it and the
795 /// environment ready to process a single file. This returns true on error.
797 void clang::InitializePreprocessor(Preprocessor &PP,
798 const PreprocessorOptions &InitOpts,
799 const HeaderSearchOptions &HSOpts,
800 const FrontendOptions &FEOpts) {
801 const LangOptions &LangOpts = PP.getLangOpts();
802 std::string PredefineBuffer;
803 PredefineBuffer.reserve(4080);
804 llvm::raw_string_ostream Predefines(PredefineBuffer);
805 MacroBuilder Builder(Predefines);
807 InitializeFileRemapping(PP.getDiagnostics(), PP.getSourceManager(),
808 PP.getFileManager(), InitOpts);
810 // Emit line markers for various builtin sections of the file. We don't do
811 // this in asm preprocessor mode, because "# 4" is not a line marker directive
813 if (!PP.getLangOpts().AsmPreprocessor)
814 Builder.append("# 1 \"<built-in>\" 3");
816 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
817 if (InitOpts.UsePredefines) {
818 InitializePredefinedMacros(PP.getTargetInfo(), LangOpts, FEOpts, Builder);
820 // Install definitions to make Objective-C++ ARC work well with various
821 // C++ Standard Library implementations.
822 if (LangOpts.ObjC1 && LangOpts.CPlusPlus && LangOpts.ObjCAutoRefCount) {
823 switch (InitOpts.ObjCXXARCStandardLibrary) {
828 case ARCXX_libstdcxx:
829 AddObjCXXARCLibstdcxxDefines(LangOpts, Builder);
835 // Even with predefines off, some macros are still predefined.
836 // These should all be defined in the preprocessor according to the
837 // current language configuration.
838 InitializeStandardPredefinedMacros(PP.getTargetInfo(), PP.getLangOpts(),
841 // Add on the predefines from the driver. Wrap in a #line directive to report
842 // that they come from the command line.
843 if (!PP.getLangOpts().AsmPreprocessor)
844 Builder.append("# 1 \"<command line>\" 1");
846 // Process #define's and #undef's in the order they are given.
847 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
848 if (InitOpts.Macros[i].second) // isUndef
849 Builder.undefineMacro(InitOpts.Macros[i].first);
851 DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
852 PP.getDiagnostics());
855 // If -imacros are specified, include them now. These are processed before
856 // any -include directives.
857 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
858 AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i],
859 PP.getFileManager());
861 // Process -include-pch/-include-pth directives.
862 if (!InitOpts.ImplicitPCHInclude.empty())
863 AddImplicitIncludePCH(Builder, PP, InitOpts.ImplicitPCHInclude);
864 if (!InitOpts.ImplicitPTHInclude.empty())
865 AddImplicitIncludePTH(Builder, PP, InitOpts.ImplicitPTHInclude);
867 // Process -include directives.
868 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
869 const std::string &Path = InitOpts.Includes[i];
870 AddImplicitInclude(Builder, Path, PP.getFileManager());
873 // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
874 if (!PP.getLangOpts().AsmPreprocessor)
875 Builder.append("# 1 \"<built-in>\" 2");
877 // Instruct the preprocessor to skip the preamble.
878 PP.setSkipMainFilePreamble(InitOpts.PrecompiledPreambleBytes.first,
879 InitOpts.PrecompiledPreambleBytes.second);
881 // Copy PredefinedBuffer into the Preprocessor.
882 PP.setPredefines(Predefines.str());
884 // Initialize the header search object.
885 ApplyHeaderSearchOptions(PP.getHeaderSearchInfo(), HSOpts,
887 PP.getTargetInfo().getTriple());