blob: b8abedfa8b0f7c33fb22075b943af47fff3330ff [file] [log] [blame]
Chris Lattner2f5693f2009-04-21 05:40:52 +00001//===--- 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
Daniel Dunbar00f8a392009-11-07 04:20:15 +000014#include "clang/Frontend/Utils.h"
Chris Lattner2f5693f2009-04-21 05:40:52 +000015#include "clang/Basic/TargetInfo.h"
Douglas Gregor6ae34ab2009-12-02 16:32:41 +000016#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar00f8a392009-11-07 04:20:15 +000017#include "clang/Frontend/PreprocessorOptions.h"
Chris Lattner2f5693f2009-04-21 05:40:52 +000018#include "clang/Lex/Preprocessor.h"
Douglas Gregor6ae34ab2009-12-02 16:32:41 +000019#include "clang/Basic/FileManager.h"
20#include "clang/Basic/SourceManager.h"
Benjamin Kramerf65e9592010-01-09 16:17:37 +000021#include "llvm/ADT/APFloat.h"
Kovarththanan Rajaratnam2f146192010-01-09 09:27:11 +000022#include "llvm/ADT/StringRef.h"
Benjamin Kramerf65e9592010-01-09 16:17:37 +000023#include "llvm/ADT/Twine.h"
Douglas Gregor6ae34ab2009-12-02 16:32:41 +000024#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramerf65e9592010-01-09 16:17:37 +000025#include "llvm/Support/raw_ostream.h"
Chris Lattner2f5693f2009-04-21 05:40:52 +000026#include "llvm/System/Path.h"
Chris Lattner3fab58d2009-11-02 21:48:09 +000027using namespace clang;
Chris Lattner2f5693f2009-04-21 05:40:52 +000028
Benjamin Kramerf65e9592010-01-09 16:17:37 +000029namespace {
30class MacroBuilder {
31 llvm::raw_ostream &Out;
32public:
33 MacroBuilder(llvm::raw_ostream &Output) : Out(Output) {}
34
35 /// Append a #define line for Macro of the form "#define Name 1\n".
36 void DefineMacro(const llvm::Twine &Name) {
37 Out << "#define " << Name << " 1\n";
38 }
39
40 /// Append a #define line for Macro of the form "#define Name Value\n".
41 void DefineMacro(const llvm::Twine &Name, const llvm::Twine &Value) {
42 Out << "#define " << Name << ' ' << Value << '\n';
43 }
44
45 /// Append a #undef line for Macro. Macro should be of the form XXX
46 /// and we emit "#undef XXX".
47 void UndefineMacro(const llvm::Twine &Name) {
48 Out << "#undef " << Name << '\n';
49 }
50
51 /// Directly append Str and a newline to the underlying buffer.
52 void Append(const llvm::Twine& Str) {
53 Out << Str << '\n';
54 }
55
56 // FIXME: deprecated
57 void AppendVector(const std::vector<char> &v) {
58 Out << llvm::StringRef(&v[0], v.size());
59 }
60};
61} // end anonymous namespace
62
Chris Lattner2f5693f2009-04-21 05:40:52 +000063// Append a #define line to Buf for Macro. Macro should be of the form XXX,
64// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
65// "#define XXX Y z W". To get a #define with no value, use "XXX=".
Benjamin Kramerf65e9592010-01-09 16:17:37 +000066static void DefineBuiltinMacro(MacroBuilder &Builder, llvm::StringRef Macro,
Daniel Dunbar6dac9352009-12-03 09:14:12 +000067 Diagnostic *Diags = 0) {
Kovarththanan Rajaratnam2f146192010-01-09 09:27:11 +000068 std::pair<llvm::StringRef, llvm::StringRef> MacroPair = Macro.split('=');
69 llvm::StringRef MacroName = MacroPair.first;
70 llvm::StringRef MacroBody = MacroPair.second;
71 if (!MacroBody.empty()) {
Chris Lattner2f5693f2009-04-21 05:40:52 +000072 // Per GCC -D semantics, the macro ends at \n if it exists.
Benjamin Kramerf65e9592010-01-09 16:17:37 +000073 llvm::StringRef::size_type End = MacroBody.find_first_of("\n\r");
74 if (End != llvm::StringRef::npos) {
Daniel Dunbar6dac9352009-12-03 09:14:12 +000075 assert(Diags && "Unexpected macro with embedded newline!");
76 Diags->Report(diag::warn_fe_macro_contains_embedded_newline)
Kovarththanan Rajaratnam2f146192010-01-09 09:27:11 +000077 << MacroName;
Chris Lattner2f5693f2009-04-21 05:40:52 +000078 }
Mike Stump11289f42009-09-09 15:08:12 +000079
Benjamin Kramerf65e9592010-01-09 16:17:37 +000080 Builder.DefineMacro(MacroName, MacroBody.substr(0, End));
Chris Lattner2f5693f2009-04-21 05:40:52 +000081 } else {
82 // Push "macroname 1".
Benjamin Kramerf65e9592010-01-09 16:17:37 +000083 Builder.DefineMacro(Macro);
Chris Lattner2f5693f2009-04-21 05:40:52 +000084 }
Chris Lattner4579b762009-05-15 16:08:43 +000085}
86
Daniel Dunbar732ef8a2009-11-11 23:58:53 +000087std::string clang::NormalizeDashIncludePath(llvm::StringRef File) {
Daniel Dunbar66cb0132009-04-22 08:53:01 +000088 // Implicit include paths should be resolved relative to the current
89 // working directory first, and then use the regular header search
90 // mechanism. The proper way to handle this is to have the
91 // predefines buffer located at the current working directory, but
92 // it has not file entry. For now, workaround this by using an
93 // absolute path if we find the file here, and otherwise letting
94 // header search handle it.
Chris Lattner2f5693f2009-04-21 05:40:52 +000095 llvm::sys::Path Path(File);
96 Path.makeAbsolute();
Daniel Dunbar66cb0132009-04-22 08:53:01 +000097 if (!Path.exists())
98 Path = File;
Mike Stump11289f42009-09-09 15:08:12 +000099
Daniel Dunbar732ef8a2009-11-11 23:58:53 +0000100 return Lexer::Stringify(Path.str());
101}
102
Chris Lattner2f5693f2009-04-21 05:40:52 +0000103/// AddImplicitInclude - Add an implicit #include of the specified file to the
104/// predefines buffer.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000105static void AddImplicitInclude(MacroBuilder &Builder, llvm::StringRef File) {
106 Builder.Append("#include \"" +
107 llvm::Twine(NormalizeDashIncludePath(File)) + "\"");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000108}
109
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000110static void AddImplicitIncludeMacros(MacroBuilder &Builder,
111 llvm::StringRef File) {
112 Builder.Append("#__include_macros \"" +
113 llvm::Twine(NormalizeDashIncludePath(File)) + "\"");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000114 // Marker token to stop the __include_macros fetch loop.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000115 Builder.Append("##"); // ##?
Chris Lattner2f5693f2009-04-21 05:40:52 +0000116}
117
118/// AddImplicitIncludePTH - Add an implicit #include using the original file
119/// used to generate a PTH cache.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000120static void AddImplicitIncludePTH(MacroBuilder &Builder, Preprocessor &PP,
121 llvm::StringRef ImplicitIncludePTH) {
Chris Lattner2f5693f2009-04-21 05:40:52 +0000122 PTHManager *P = PP.getPTHManager();
123 assert(P && "No PTHManager.");
124 const char *OriginalFile = P->getOriginalSourceFile();
Mike Stump11289f42009-09-09 15:08:12 +0000125
Chris Lattner2f5693f2009-04-21 05:40:52 +0000126 if (!OriginalFile) {
Daniel Dunbar6dac9352009-12-03 09:14:12 +0000127 PP.getDiagnostics().Report(diag::err_fe_pth_file_has_no_source_header)
128 << ImplicitIncludePTH;
129 return;
Chris Lattner2f5693f2009-04-21 05:40:52 +0000130 }
Mike Stump11289f42009-09-09 15:08:12 +0000131
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000132 AddImplicitInclude(Builder, OriginalFile);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000133}
134
135/// PickFP - This is used to pick a value based on the FP semantics of the
136/// specified FP model.
137template <typename T>
138static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
Eli Friedman57406b22009-05-23 03:50:01 +0000139 T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
140 T IEEEQuadVal) {
Duncan Sandsf4063512009-06-03 14:28:20 +0000141 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle)
Chris Lattner2f5693f2009-04-21 05:40:52 +0000142 return IEEESingleVal;
Duncan Sandsf4063512009-06-03 14:28:20 +0000143 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble)
Chris Lattner2f5693f2009-04-21 05:40:52 +0000144 return IEEEDoubleVal;
Duncan Sandsf4063512009-06-03 14:28:20 +0000145 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended)
Chris Lattner2f5693f2009-04-21 05:40:52 +0000146 return X87DoubleExtendedVal;
Duncan Sandsf4063512009-06-03 14:28:20 +0000147 if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble)
Eli Friedman57406b22009-05-23 03:50:01 +0000148 return PPCDoubleDoubleVal;
Duncan Sandsf4063512009-06-03 14:28:20 +0000149 assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad);
Eli Friedman57406b22009-05-23 03:50:01 +0000150 return IEEEQuadVal;
Chris Lattner2f5693f2009-04-21 05:40:52 +0000151}
152
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000153static void DefineFloatMacros(MacroBuilder &Builder, llvm::StringRef Prefix,
Chris Lattner2f5693f2009-04-21 05:40:52 +0000154 const llvm::fltSemantics *Sem) {
155 const char *DenormMin, *Epsilon, *Max, *Min;
Mike Stump11289f42009-09-09 15:08:12 +0000156 DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
Chris Lattner2f5693f2009-04-21 05:40:52 +0000157 "3.64519953188247460253e-4951L",
Eli Friedman57406b22009-05-23 03:50:01 +0000158 "4.94065645841246544176568792868221e-324L",
159 "6.47517511943802511092443895822764655e-4966L");
160 int Digits = PickFP(Sem, 6, 15, 18, 31, 33);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000161 Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
162 "1.08420217248550443401e-19L",
Eli Friedman57406b22009-05-23 03:50:01 +0000163 "4.94065645841246544176568792868221e-324L",
164 "1.92592994438723585305597794258492732e-34L");
Eli Friedman57406b22009-05-23 03:50:01 +0000165 int MantissaDigits = PickFP(Sem, 24, 53, 64, 106, 113);
166 int Min10Exp = PickFP(Sem, -37, -307, -4931, -291, -4931);
167 int Max10Exp = PickFP(Sem, 38, 308, 4932, 308, 4932);
168 int MinExp = PickFP(Sem, -125, -1021, -16381, -968, -16381);
169 int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024, 16384);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000170 Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
171 "3.36210314311209350626e-4932L",
Eli Friedman57406b22009-05-23 03:50:01 +0000172 "2.00416836000897277799610805135016e-292L",
173 "3.36210314311209350626267781732175260e-4932L");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000174 Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
175 "1.18973149535723176502e+4932L",
Eli Friedman57406b22009-05-23 03:50:01 +0000176 "1.79769313486231580793728971405301e+308L",
177 "1.18973149535723176508575932662800702e+4932L");
Mike Stump11289f42009-09-09 15:08:12 +0000178
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000179 llvm::Twine DefPrefix = "__" + Prefix + "_";
180
181 Builder.DefineMacro(DefPrefix + "DENORM_MIN__", DenormMin);
182 Builder.DefineMacro(DefPrefix + "HAS_DENORM__");
183 Builder.DefineMacro(DefPrefix + "DIG__", llvm::Twine(Digits));
184 Builder.DefineMacro(DefPrefix + "EPSILON__", llvm::Twine(Epsilon));
185 Builder.DefineMacro(DefPrefix + "HAS_INFINITY__");
186 Builder.DefineMacro(DefPrefix + "HAS_QUIET_NAN__");
187 Builder.DefineMacro(DefPrefix + "MANT_DIG__", llvm::Twine(MantissaDigits));
188
189 Builder.DefineMacro(DefPrefix + "MAX_10_EXP__", llvm::Twine(Max10Exp));
190 Builder.DefineMacro(DefPrefix + "MAX_EXP__", llvm::Twine(MaxExp));
191 Builder.DefineMacro(DefPrefix + "MAX__", llvm::Twine(Max));
192
193 Builder.DefineMacro(DefPrefix + "MIN_10_EXP__","("+llvm::Twine(Min10Exp)+")");
194 Builder.DefineMacro(DefPrefix + "MIN_EXP__", "("+llvm::Twine(MinExp)+")");
195 Builder.DefineMacro(DefPrefix + "MIN__", llvm::Twine(Min));
Chris Lattner2f5693f2009-04-21 05:40:52 +0000196}
197
198
199/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
200/// named MacroName with the max value for a type with width 'TypeWidth' a
201/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000202static void DefineTypeSize(llvm::StringRef MacroName, unsigned TypeWidth,
203 llvm::StringRef ValSuffix, bool isSigned,
204 MacroBuilder& Builder) {
Chris Lattner2f5693f2009-04-21 05:40:52 +0000205 long long MaxVal;
206 if (isSigned)
207 MaxVal = (1LL << (TypeWidth - 1)) - 1;
208 else
209 MaxVal = ~0LL >> (64-TypeWidth);
Mike Stump11289f42009-09-09 15:08:12 +0000210
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000211 Builder.DefineMacro(MacroName, llvm::Twine(MaxVal) + ValSuffix);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000212}
213
Chris Lattnere4a8c642009-11-05 21:21:32 +0000214/// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
215/// the width, suffix, and signedness of the given type
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000216static void DefineTypeSize(llvm::StringRef MacroName, TargetInfo::IntType Ty,
217 const TargetInfo &TI, MacroBuilder &Builder) {
Chris Lattnere4a8c642009-11-05 21:21:32 +0000218 DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000219 TI.isTypeSigned(Ty), Builder);
Chris Lattnere4a8c642009-11-05 21:21:32 +0000220}
221
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000222static void DefineType(const llvm::Twine &MacroName, TargetInfo::IntType Ty,
223 MacroBuilder &Builder) {
224 Builder.DefineMacro(MacroName, TargetInfo::getTypeName(Ty));
Chris Lattner2f5693f2009-04-21 05:40:52 +0000225}
226
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000227static void DefineTypeWidth(llvm::StringRef MacroName, TargetInfo::IntType Ty,
228 const TargetInfo &TI, MacroBuilder &Builder) {
229 Builder.DefineMacro(MacroName, llvm::Twine(TI.getTypeWidth(Ty)));
Ken Dyckc0c98292009-11-18 13:52:57 +0000230}
231
Chris Lattner55c98772009-11-12 08:08:27 +0000232static void DefineExactWidthIntType(TargetInfo::IntType Ty,
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000233 const TargetInfo &TI, MacroBuilder &Builder) {
Ken Dyck2dc8d5f2009-11-16 16:36:33 +0000234 int TypeWidth = TI.getTypeWidth(Ty);
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000235 DefineType("__INT" + llvm::Twine(TypeWidth) + "_TYPE__", Ty, Builder);
Ken Dyck2dc8d5f2009-11-16 16:36:33 +0000236
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000237 llvm::StringRef ConstSuffix(TargetInfo::getTypeConstantSuffix(Ty));
238 if (!ConstSuffix.empty())
239 Builder.DefineMacro("__INT" + llvm::Twine(TypeWidth) + "_C_SUFFIX__",
240 ConstSuffix);
Chris Lattner55c98772009-11-12 08:08:27 +0000241}
Chris Lattner2f5693f2009-04-21 05:40:52 +0000242
243static void InitializePredefinedMacros(const TargetInfo &TI,
244 const LangOptions &LangOpts,
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000245 MacroBuilder &Builder) {
Chris Lattner2f5693f2009-04-21 05:40:52 +0000246 // Compiler version introspection macros.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000247 Builder.DefineMacro("__llvm__"); // LLVM Backend
248 Builder.DefineMacro("__clang__"); // Clang Frontend
Mike Stump11289f42009-09-09 15:08:12 +0000249
Chris Lattner2f5693f2009-04-21 05:40:52 +0000250 // Currently claim to be compatible with GCC 4.2.1-5621.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000251 Builder.DefineMacro("__GNUC_MINOR__", "2");
252 Builder.DefineMacro("__GNUC_PATCHLEVEL__", "1");
253 Builder.DefineMacro("__GNUC__", "4");
254 Builder.DefineMacro("__GXX_ABI_VERSION", "1002");
255 Builder.DefineMacro("__VERSION__", "\"4.2.1 Compatible Clang Compiler\"");
Mike Stump11289f42009-09-09 15:08:12 +0000256
Chris Lattner2f5693f2009-04-21 05:40:52 +0000257 // Initialize language-specific preprocessor defines.
Mike Stump11289f42009-09-09 15:08:12 +0000258
Chris Lattner2f5693f2009-04-21 05:40:52 +0000259 // These should all be defined in the preprocessor according to the
260 // current language configuration.
261 if (!LangOpts.Microsoft)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000262 Builder.DefineMacro("__STDC__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000263 if (LangOpts.AsmPreprocessor)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000264 Builder.DefineMacro("__ASSEMBLER__");
Ryan Flynned73cac2009-07-21 00:07:02 +0000265
266 if (!LangOpts.CPlusPlus) {
267 if (LangOpts.C99)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000268 Builder.DefineMacro("__STDC_VERSION__", "199901L");
Ryan Flynned73cac2009-07-21 00:07:02 +0000269 else if (!LangOpts.GNUMode && LangOpts.Digraphs)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000270 Builder.DefineMacro("__STDC_VERSION__", "199409L");
Ryan Flynned73cac2009-07-21 00:07:02 +0000271 }
Chris Lattner2f5693f2009-04-21 05:40:52 +0000272
273 // Standard conforming mode?
274 if (!LangOpts.GNUMode)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000275 Builder.DefineMacro("__STRICT_ANSI__");
Mike Stump11289f42009-09-09 15:08:12 +0000276
Chris Lattner2f5693f2009-04-21 05:40:52 +0000277 if (LangOpts.CPlusPlus0x)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000278 Builder.DefineMacro("__GXX_EXPERIMENTAL_CXX0X__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000279
280 if (LangOpts.Freestanding)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000281 Builder.DefineMacro("__STDC_HOSTED__", "0");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000282 else
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000283 Builder.DefineMacro("__STDC_HOSTED__");
Mike Stump11289f42009-09-09 15:08:12 +0000284
Chris Lattner2f5693f2009-04-21 05:40:52 +0000285 if (LangOpts.ObjC1) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000286 Builder.DefineMacro("__OBJC__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000287 if (LangOpts.ObjCNonFragileABI) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000288 Builder.DefineMacro("__OBJC2__");
289 Builder.DefineMacro("OBJC_ZEROCOST_EXCEPTIONS");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000290 }
291
292 if (LangOpts.getGCMode() != LangOptions::NonGC)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000293 Builder.DefineMacro("__OBJC_GC__");
Mike Stump11289f42009-09-09 15:08:12 +0000294
Chris Lattner2f5693f2009-04-21 05:40:52 +0000295 if (LangOpts.NeXTRuntime)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000296 Builder.DefineMacro("__NEXT_RUNTIME__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000297 }
Mike Stump11289f42009-09-09 15:08:12 +0000298
Chris Lattner2f5693f2009-04-21 05:40:52 +0000299 // darwin_constant_cfstrings controls this. This is also dependent
300 // on other things like the runtime I believe. This is set even for C code.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000301 Builder.DefineMacro("__CONSTANT_CFSTRINGS__");
Mike Stump11289f42009-09-09 15:08:12 +0000302
Chris Lattner2f5693f2009-04-21 05:40:52 +0000303 if (LangOpts.ObjC2)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000304 Builder.DefineMacro("OBJC_NEW_PROPERTIES");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000305
306 if (LangOpts.PascalStrings)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000307 Builder.DefineMacro("__PASCAL_STRINGS__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000308
309 if (LangOpts.Blocks) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000310 Builder.DefineMacro("__block", "__attribute__((__blocks__(byref)))");
311 Builder.DefineMacro("__BLOCKS__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000312 }
Mike Stump11289f42009-09-09 15:08:12 +0000313
Rafael Espindola00a66572009-10-01 13:33:33 +0000314 if (LangOpts.Exceptions)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000315 Builder.DefineMacro("__EXCEPTIONS");
Rafael Espindola00a66572009-10-01 13:33:33 +0000316
Chris Lattner2f5693f2009-04-21 05:40:52 +0000317 if (LangOpts.CPlusPlus) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000318 Builder.DefineMacro("__DEPRECATED");
319 Builder.DefineMacro("__GNUG__", "4");
320 Builder.DefineMacro("__GXX_WEAK__");
Douglas Gregor3f4d51b2009-08-06 04:09:28 +0000321 if (LangOpts.GNUMode)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000322 Builder.DefineMacro("__cplusplus");
Mike Stump11289f42009-09-09 15:08:12 +0000323 else
Douglas Gregor3f4d51b2009-08-06 04:09:28 +0000324 // C++ [cpp.predefined]p1:
Mike Stump11289f42009-09-09 15:08:12 +0000325 // The name_ _cplusplusis defined to the value199711Lwhen compiling a
Douglas Gregor3f4d51b2009-08-06 04:09:28 +0000326 // C++ translation unit.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000327 Builder.DefineMacro("__cplusplus", "199711L");
328 Builder.DefineMacro("__private_extern__", "extern");
Eli Friedman80110172009-08-27 22:01:41 +0000329 // Ugly hack to work with GNU libstdc++.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000330 Builder.DefineMacro("_GNU_SOURCE");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000331 }
Mike Stump11289f42009-09-09 15:08:12 +0000332
Chris Lattner2f5693f2009-04-21 05:40:52 +0000333 if (LangOpts.Microsoft) {
John Thompson1faca9e2009-10-16 01:12:00 +0000334 // Filter out some microsoft extensions when trying to parse in ms-compat
335 // mode.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000336 Builder.DefineMacro("__int8", "__INT8_TYPE__");
337 Builder.DefineMacro("__int16", "__INT16_TYPE__");
338 Builder.DefineMacro("__int32", "__INT32_TYPE__");
339 Builder.DefineMacro("__int64", "__INT64_TYPE__");
Steve Narofff0df20a2009-12-04 21:29:41 +0000340 // Both __PRETTY_FUNCTION__ and __FUNCTION__ are GCC extensions, however
341 // VC++ appears to only like __FUNCTION__.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000342 Builder.DefineMacro("__PRETTY_FUNCTION__", "__FUNCTION__");
John Thompson1faca9e2009-10-16 01:12:00 +0000343 // Work around some issues with Visual C++ headerws.
344 if (LangOpts.CPlusPlus) {
345 // Since we define wchar_t in C++ mode.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000346 Builder.DefineMacro("_WCHAR_T_DEFINED");
347 Builder.DefineMacro("_NATIVE_WCHAR_T_DEFINED");
John Thompson1faca9e2009-10-16 01:12:00 +0000348 // FIXME: This should be temporary until we have a __pragma
349 // solution, to avoid some errors flagged in VC++ headers.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000350 Builder.DefineMacro("_CRT_SECURE_CPP_OVERLOAD_SECURE_NAMES", "0");
John Thompson1faca9e2009-10-16 01:12:00 +0000351 }
Chris Lattner2f5693f2009-04-21 05:40:52 +0000352 }
Mike Stump11289f42009-09-09 15:08:12 +0000353
Chris Lattner2f5693f2009-04-21 05:40:52 +0000354 if (LangOpts.Optimize)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000355 Builder.DefineMacro("__OPTIMIZE__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000356 if (LangOpts.OptimizeSize)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000357 Builder.DefineMacro("__OPTIMIZE_SIZE__");
Mike Stump11289f42009-09-09 15:08:12 +0000358
Chris Lattner2f5693f2009-04-21 05:40:52 +0000359 // Initialize target-specific preprocessor defines.
Mike Stump11289f42009-09-09 15:08:12 +0000360
Chris Lattner2f5693f2009-04-21 05:40:52 +0000361 // Define type sizing macros based on the target properties.
362 assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000363 Builder.DefineMacro("__CHAR_BIT__", "8");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000364
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000365 DefineTypeSize("__SCHAR_MAX__", TI.getCharWidth(), "", true, Builder);
366 DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
367 DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
368 DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
369 DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
370 DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
371 DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000372
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000373 DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
374 DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
375 DefineTypeWidth("__INTMAX_WIDTH__", TI.getIntMaxType(), TI, Builder);
376 DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
377 DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
378 DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
379 DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
380 DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
381 DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
382 DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
383 DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
384 DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
385 DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
386 DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
Mike Stump11289f42009-09-09 15:08:12 +0000387
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000388 DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat());
389 DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat());
390 DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat());
Chris Lattner2f5693f2009-04-21 05:40:52 +0000391
392 // Define a __POINTER_WIDTH__ macro for stdint.h.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000393 Builder.DefineMacro("__POINTER_WIDTH__",
394 llvm::Twine((int)TI.getPointerWidth(0)));
Mike Stump11289f42009-09-09 15:08:12 +0000395
Eli Friedman9ffd4a92009-06-05 07:05:05 +0000396 if (!LangOpts.CharIsSigned)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000397 Builder.DefineMacro("__CHAR_UNSIGNED__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000398
Chris Lattner55c98772009-11-12 08:08:27 +0000399 // Define exact-width integer types for stdint.h
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000400 Builder.DefineMacro("__INT" + llvm::Twine(TI.getCharWidth()) + "_TYPE__",
401 "char");
Mike Stump11289f42009-09-09 15:08:12 +0000402
Chris Lattner55c98772009-11-12 08:08:27 +0000403 if (TI.getShortWidth() > TI.getCharWidth())
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000404 DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
Mike Stump11289f42009-09-09 15:08:12 +0000405
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000406 if (TI.getIntWidth() > TI.getShortWidth())
407 DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
408
409 if (TI.getLongWidth() > TI.getIntWidth())
410 DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
411
412 if (TI.getLongLongWidth() > TI.getLongWidth())
413 DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
414
415 // Add __builtin_va_list typedef.
416 Builder.Append(TI.getVAListDeclaration());
417
418 if (const char *Prefix = TI.getUserLabelPrefix())
419 Builder.DefineMacro("__USER_LABEL_PREFIX__", Prefix);
Mike Stump11289f42009-09-09 15:08:12 +0000420
Chris Lattner2f5693f2009-04-21 05:40:52 +0000421 // Build configuration options. FIXME: these should be controlled by
422 // command line options or something.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000423 Builder.DefineMacro("__FINITE_MATH_ONLY__", "0");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000424
Chris Lattner2f5693f2009-04-21 05:40:52 +0000425 if (LangOpts.GNUInline)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000426 Builder.DefineMacro("__GNUC_GNU_INLINE__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000427 else
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000428 Builder.DefineMacro("__GNUC_STDC_INLINE__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000429
430 if (LangOpts.NoInline)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000431 Builder.DefineMacro("__NO_INLINE__");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000432
433 if (unsigned PICLevel = LangOpts.PICLevel) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000434 Builder.DefineMacro("__PIC__", llvm::Twine(PICLevel));
435 Builder.DefineMacro("__pic__", llvm::Twine(PICLevel));
Chris Lattner2f5693f2009-04-21 05:40:52 +0000436 }
437
438 // Macros to control C99 numerics and <float.h>
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000439 Builder.DefineMacro("__FLT_EVAL_METHOD__", "0");
440 Builder.DefineMacro("__FLT_RADIX__", "2");
441 int Dig = PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33, 36);
442 Builder.DefineMacro("__DECIMAL_DIG__", llvm::Twine(Dig));
Bill Wendlingd63bbad2009-06-28 07:36:13 +0000443
Bill Wendling18351072009-06-28 23:01:01 +0000444 if (LangOpts.getStackProtectorMode() == LangOptions::SSPOn)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000445 Builder.DefineMacro("__SSP__");
Bill Wendling18351072009-06-28 23:01:01 +0000446 else if (LangOpts.getStackProtectorMode() == LangOptions::SSPReq)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000447 Builder.DefineMacro("__SSP_ALL__", "2");
Bill Wendlingd63bbad2009-06-28 07:36:13 +0000448
Chris Lattner2f5693f2009-04-21 05:40:52 +0000449 // Get other target #defines.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000450 // FIXME: avoid temporary vector.
451 std::vector<char> Buf;
Chris Lattner2f5693f2009-04-21 05:40:52 +0000452 TI.getTargetDefines(LangOpts, Buf);
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000453 Builder.AppendVector(Buf);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000454}
455
Douglas Gregor6ae34ab2009-12-02 16:32:41 +0000456// Initialize the remapping of files to alternative contents, e.g.,
457// those specified through other files.
458static void InitializeFileRemapping(Diagnostic &Diags,
459 SourceManager &SourceMgr,
460 FileManager &FileMgr,
461 const PreprocessorOptions &InitOpts) {
462 // Remap files in the source manager.
463 for (PreprocessorOptions::remapped_file_iterator
464 Remap = InitOpts.remapped_file_begin(),
465 RemapEnd = InitOpts.remapped_file_end();
466 Remap != RemapEnd;
467 ++Remap) {
468 // Find the file that we're mapping to.
469 const FileEntry *ToFile = FileMgr.getFile(Remap->second);
470 if (!ToFile) {
471 Diags.Report(diag::err_fe_remap_missing_to_file)
472 << Remap->first << Remap->second;
473 continue;
474 }
475
Douglas Gregor407e2122009-12-02 18:12:28 +0000476 // Create the file entry for the file that we're mapping from.
477 const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
478 ToFile->getSize(),
479 0);
Douglas Gregor6ae34ab2009-12-02 16:32:41 +0000480 if (!FromFile) {
Douglas Gregor6ae34ab2009-12-02 16:32:41 +0000481 Diags.Report(diag::err_fe_remap_missing_from_file)
482 << Remap->first;
483 continue;
484 }
485
486 // Load the contents of the file we're mapping to.
487 std::string ErrorStr;
488 const llvm::MemoryBuffer *Buffer
489 = llvm::MemoryBuffer::getFile(ToFile->getName(), &ErrorStr);
490 if (!Buffer) {
491 Diags.Report(diag::err_fe_error_opening)
492 << Remap->second << ErrorStr;
493 continue;
494 }
495
496 // Override the contents of the "from" file with the contents of
497 // the "to" file.
498 SourceMgr.overrideFileContents(FromFile, Buffer);
499 }
500}
501
Chris Lattner2f5693f2009-04-21 05:40:52 +0000502/// InitializePreprocessor - Initialize the preprocessor getting it and the
503/// environment ready to process a single file. This returns true on error.
504///
Daniel Dunbar181aaee2009-11-04 21:13:15 +0000505void clang::InitializePreprocessor(Preprocessor &PP,
Daniel Dunbar2856ae442009-11-11 21:44:42 +0000506 const PreprocessorOptions &InitOpts,
507 const HeaderSearchOptions &HSOpts) {
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000508 std::string PredefineBuffer;
509 PredefineBuffer.reserve(4080);
510 llvm::raw_string_ostream Predefines(PredefineBuffer);
511 MacroBuilder Builder(Predefines);
Mike Stump11289f42009-09-09 15:08:12 +0000512
Douglas Gregor6ae34ab2009-12-02 16:32:41 +0000513 InitializeFileRemapping(PP.getDiagnostics(), PP.getSourceManager(),
514 PP.getFileManager(), InitOpts);
515
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000516 Builder.Append("# 1 \"<built-in>\" 3");
Mike Stump11289f42009-09-09 15:08:12 +0000517
Chris Lattner2f5693f2009-04-21 05:40:52 +0000518 // Install things like __POWERPC__, __GNUC__, etc into the macro table.
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000519 if (InitOpts.UsePredefines)
Chris Lattnere9d7d782009-11-03 19:50:27 +0000520 InitializePredefinedMacros(PP.getTargetInfo(), PP.getLangOptions(),
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000521 Builder);
Mike Stump11289f42009-09-09 15:08:12 +0000522
Chris Lattner2f5693f2009-04-21 05:40:52 +0000523 // Add on the predefines from the driver. Wrap in a #line directive to report
524 // that they come from the command line.
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000525 Builder.Append("# 1 \"<command line>\" 1");
Chris Lattner2f5693f2009-04-21 05:40:52 +0000526
527 // Process #define's and #undef's in the order they are given.
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000528 for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
529 if (InitOpts.Macros[i].second) // isUndef
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000530 Builder.UndefineMacro(InitOpts.Macros[i].first);
Chris Lattnere08c43a2009-04-21 06:00:24 +0000531 else
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000532 DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
Daniel Dunbar6dac9352009-12-03 09:14:12 +0000533 &PP.getDiagnostics());
Chris Lattner2f5693f2009-04-21 05:40:52 +0000534 }
535
536 // If -imacros are specified, include them now. These are processed before
537 // any -include directives.
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000538 for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000539 AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
Chris Lattner2f5693f2009-04-21 05:40:52 +0000540
541 // Process -include directives.
Daniel Dunbard6ea9022009-11-17 05:52:41 +0000542 for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
543 const std::string &Path = InitOpts.Includes[i];
544 if (Path == InitOpts.ImplicitPTHInclude)
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000545 AddImplicitIncludePTH(Builder, PP, Path);
Chris Lattnere08c43a2009-04-21 06:00:24 +0000546 else
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000547 AddImplicitInclude(Builder, Path);
Eli Friedmanb1884552009-06-15 09:57:52 +0000548 }
Chris Lattner2f5693f2009-04-21 05:40:52 +0000549
Rafael Espindolaf8a04a12009-12-01 18:28:16 +0000550 // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000551 Builder.Append("# 1 \"<built-in>\" 2");
Rafael Espindolaf8a04a12009-12-01 18:28:16 +0000552
Benjamin Kramerf65e9592010-01-09 16:17:37 +0000553 // Copy PredefinedBuffer into the Preprocessor.
554 PP.setPredefines(Predefines.str());
Daniel Dunbar2856ae442009-11-11 21:44:42 +0000555
556 // Initialize the header search object.
557 ApplyHeaderSearchOptions(PP.getHeaderSearchInfo(), HSOpts,
558 PP.getLangOptions(),
559 PP.getTargetInfo().getTriple());
Chris Lattner2f5693f2009-04-21 05:40:52 +0000560}