InitPreprocessor.cpp revision 17aaf043b494268cda3be5cc9bcf2ee686ed3777 
1//===--- InitPreprocessor.cpp - PP initialization code. ---------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the clang::InitializePreprocessor function.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Basic/Version.h"
15#include "clang/Frontend/Utils.h"
16#include "clang/Basic/MacroBuilder.h"
17#include "clang/Basic/TargetInfo.h"
18#include "clang/Frontend/FrontendDiagnostic.h"
19#include "clang/Frontend/FrontendOptions.h"
20#include "clang/Frontend/PreprocessorOptions.h"
21#include "clang/Lex/Preprocessor.h"
22#include "clang/Basic/FileManager.h"
23#include "clang/Basic/SourceManager.h"
24#include "llvm/ADT/APFloat.h"
25#include "llvm/Support/MemoryBuffer.h"
26#include "llvm/System/Path.h"
27using namespace clang;
28
29// Append a #define line to Buf for Macro.  Macro should be of the form XXX,
30// in which case we emit "#define XXX 1" or "XXX=Y z W" in which case we emit
31// "#define XXX Y z W".  To get a #define with no value, use "XXX=".
32static void DefineBuiltinMacro(MacroBuilder &Builder, llvm::StringRef Macro,
33                               Diagnostic &Diags) {
34  std::pair<llvm::StringRef, llvm::StringRef> MacroPair = Macro.split('=');
35  llvm::StringRef MacroName = MacroPair.first;
36  llvm::StringRef MacroBody = MacroPair.second;
37  if (MacroName.size() != Macro.size()) {
38    // Per GCC -D semantics, the macro ends at \n if it exists.
39    llvm::StringRef::size_type End = MacroBody.find_first_of("\n\r");
40    if (End != llvm::StringRef::npos)
41      Diags.Report(diag::warn_fe_macro_contains_embedded_newline)
42        << MacroName;
43    Builder.defineMacro(MacroName, MacroBody.substr(0, End));
44  } else {
45    // Push "macroname 1".
46    Builder.defineMacro(Macro);
47  }
48}
49
50std::string clang::NormalizeDashIncludePath(llvm::StringRef File) {
51  // Implicit include paths should be resolved relative to the current
52  // working directory first, and then use the regular header search
53  // mechanism. The proper way to handle this is to have the
54  // predefines buffer located at the current working directory, but
55  // it has not file entry. For now, workaround this by using an
56  // absolute path if we find the file here, and otherwise letting
57  // header search handle it.
58  llvm::sys::Path Path(File);
59  Path.makeAbsolute();
60  if (!Path.exists())
61    Path = File;
62
63  return Lexer::Stringify(Path.str());
64}
65
66/// AddImplicitInclude - Add an implicit #include of the specified file to the
67/// predefines buffer.
68static void AddImplicitInclude(MacroBuilder &Builder, llvm::StringRef File) {
69  Builder.append("#include \"" +
70                 llvm::Twine(NormalizeDashIncludePath(File)) + "\"");
71}
72
73static void AddImplicitIncludeMacros(MacroBuilder &Builder,
74                                     llvm::StringRef File) {
75  Builder.append("#__include_macros \"" +
76                 llvm::Twine(NormalizeDashIncludePath(File)) + "\"");
77  // Marker token to stop the __include_macros fetch loop.
78  Builder.append("##"); // ##?
79}
80
81/// AddImplicitIncludePTH - Add an implicit #include using the original file
82///  used to generate a PTH cache.
83static void AddImplicitIncludePTH(MacroBuilder &Builder, Preprocessor &PP,
84                                  llvm::StringRef ImplicitIncludePTH) {
85  PTHManager *P = PP.getPTHManager();
86  // Null check 'P' in the corner case where it couldn't be created.
87  const char *OriginalFile = P ? P->getOriginalSourceFile() : 0;
88
89  if (!OriginalFile) {
90    PP.getDiagnostics().Report(diag::err_fe_pth_file_has_no_source_header)
91      << ImplicitIncludePTH;
92    return;
93  }
94
95  AddImplicitInclude(Builder, OriginalFile);
96}
97
98/// PickFP - This is used to pick a value based on the FP semantics of the
99/// specified FP model.
100template <typename T>
101static T PickFP(const llvm::fltSemantics *Sem, T IEEESingleVal,
102                T IEEEDoubleVal, T X87DoubleExtendedVal, T PPCDoubleDoubleVal,
103                T IEEEQuadVal) {
104  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEsingle)
105    return IEEESingleVal;
106  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEdouble)
107    return IEEEDoubleVal;
108  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::x87DoubleExtended)
109    return X87DoubleExtendedVal;
110  if (Sem == (const llvm::fltSemantics*)&llvm::APFloat::PPCDoubleDouble)
111    return PPCDoubleDoubleVal;
112  assert(Sem == (const llvm::fltSemantics*)&llvm::APFloat::IEEEquad);
113  return IEEEQuadVal;
114}
115
116static void DefineFloatMacros(MacroBuilder &Builder, llvm::StringRef Prefix,
117                              const llvm::fltSemantics *Sem) {
118  const char *DenormMin, *Epsilon, *Max, *Min;
119  DenormMin = PickFP(Sem, "1.40129846e-45F", "4.9406564584124654e-324",
120                     "3.64519953188247460253e-4951L",
121                     "4.94065645841246544176568792868221e-324L",
122                     "6.47517511943802511092443895822764655e-4966L");
123  int Digits = PickFP(Sem, 6, 15, 18, 31, 33);
124  Epsilon = PickFP(Sem, "1.19209290e-7F", "2.2204460492503131e-16",
125                   "1.08420217248550443401e-19L",
126                   "4.94065645841246544176568792868221e-324L",
127                   "1.92592994438723585305597794258492732e-34L");
128  int MantissaDigits = PickFP(Sem, 24, 53, 64, 106, 113);
129  int Min10Exp = PickFP(Sem, -37, -307, -4931, -291, -4931);
130  int Max10Exp = PickFP(Sem, 38, 308, 4932, 308, 4932);
131  int MinExp = PickFP(Sem, -125, -1021, -16381, -968, -16381);
132  int MaxExp = PickFP(Sem, 128, 1024, 16384, 1024, 16384);
133  Min = PickFP(Sem, "1.17549435e-38F", "2.2250738585072014e-308",
134               "3.36210314311209350626e-4932L",
135               "2.00416836000897277799610805135016e-292L",
136               "3.36210314311209350626267781732175260e-4932L");
137  Max = PickFP(Sem, "3.40282347e+38F", "1.7976931348623157e+308",
138               "1.18973149535723176502e+4932L",
139               "1.79769313486231580793728971405301e+308L",
140               "1.18973149535723176508575932662800702e+4932L");
141
142  llvm::SmallString<32> DefPrefix;
143  DefPrefix = "__";
144  DefPrefix += Prefix;
145  DefPrefix += "_";
146
147  Builder.defineMacro(DefPrefix + "DENORM_MIN__", DenormMin);
148  Builder.defineMacro(DefPrefix + "HAS_DENORM__");
149  Builder.defineMacro(DefPrefix + "DIG__", llvm::Twine(Digits));
150  Builder.defineMacro(DefPrefix + "EPSILON__", llvm::Twine(Epsilon));
151  Builder.defineMacro(DefPrefix + "HAS_INFINITY__");
152  Builder.defineMacro(DefPrefix + "HAS_QUIET_NAN__");
153  Builder.defineMacro(DefPrefix + "MANT_DIG__", llvm::Twine(MantissaDigits));
154
155  Builder.defineMacro(DefPrefix + "MAX_10_EXP__", llvm::Twine(Max10Exp));
156  Builder.defineMacro(DefPrefix + "MAX_EXP__", llvm::Twine(MaxExp));
157  Builder.defineMacro(DefPrefix + "MAX__", llvm::Twine(Max));
158
159  Builder.defineMacro(DefPrefix + "MIN_10_EXP__","("+llvm::Twine(Min10Exp)+")");
160  Builder.defineMacro(DefPrefix + "MIN_EXP__", "("+llvm::Twine(MinExp)+")");
161  Builder.defineMacro(DefPrefix + "MIN__", llvm::Twine(Min));
162}
163
164
165/// DefineTypeSize - Emit a macro to the predefines buffer that declares a macro
166/// named MacroName with the max value for a type with width 'TypeWidth' a
167/// signedness of 'isSigned' and with a value suffix of 'ValSuffix' (e.g. LL).
168static void DefineTypeSize(llvm::StringRef MacroName, unsigned TypeWidth,
169                           llvm::StringRef ValSuffix, bool isSigned,
170                           MacroBuilder& Builder) {
171  long long MaxVal;
172  if (isSigned)
173    MaxVal = (1LL << (TypeWidth - 1)) - 1;
174  else
175    MaxVal = ~0LL >> (64-TypeWidth);
176
177  Builder.defineMacro(MacroName, llvm::Twine(MaxVal) + ValSuffix);
178}
179
180/// DefineTypeSize - An overloaded helper that uses TargetInfo to determine
181/// the width, suffix, and signedness of the given type
182static void DefineTypeSize(llvm::StringRef MacroName, TargetInfo::IntType Ty,
183                           const TargetInfo &TI, MacroBuilder &Builder) {
184  DefineTypeSize(MacroName, TI.getTypeWidth(Ty), TI.getTypeConstantSuffix(Ty),
185                 TI.isTypeSigned(Ty), Builder);
186}
187
188static void DefineType(const llvm::Twine &MacroName, TargetInfo::IntType Ty,
189                       MacroBuilder &Builder) {
190  Builder.defineMacro(MacroName, TargetInfo::getTypeName(Ty));
191}
192
193static void DefineTypeWidth(llvm::StringRef MacroName, TargetInfo::IntType Ty,
194                            const TargetInfo &TI, MacroBuilder &Builder) {
195  Builder.defineMacro(MacroName, llvm::Twine(TI.getTypeWidth(Ty)));
196}
197
198static void DefineTypeSizeof(llvm::StringRef MacroName, unsigned BitWidth,
199                             const TargetInfo &TI, MacroBuilder &Builder) {
200  Builder.defineMacro(MacroName,
201                      llvm::Twine(BitWidth / TI.getCharWidth()));
202}
203
204static void DefineExactWidthIntType(TargetInfo::IntType Ty,
205                               const TargetInfo &TI, MacroBuilder &Builder) {
206  int TypeWidth = TI.getTypeWidth(Ty);
207  DefineType("__INT" + llvm::Twine(TypeWidth) + "_TYPE__", Ty, Builder);
208
209  llvm::StringRef ConstSuffix(TargetInfo::getTypeConstantSuffix(Ty));
210  if (!ConstSuffix.empty())
211    Builder.defineMacro("__INT" + llvm::Twine(TypeWidth) + "_C_SUFFIX__",
212                        ConstSuffix);
213}
214
215static void InitializePredefinedMacros(const TargetInfo &TI,
216                                       const LangOptions &LangOpts,
217                                       const FrontendOptions &FEOpts,
218                                       MacroBuilder &Builder) {
219  // Compiler version introspection macros.
220  Builder.defineMacro("__llvm__");  // LLVM Backend
221  Builder.defineMacro("__clang__"); // Clang Frontend
222#define TOSTR2(X) #X
223#define TOSTR(X) TOSTR2(X)
224  Builder.defineMacro("__clang_major__", TOSTR(CLANG_VERSION_MAJOR));
225  Builder.defineMacro("__clang_minor__", TOSTR(CLANG_VERSION_MINOR));
226#ifdef CLANG_VERSION_PATCHLEVEL
227  Builder.defineMacro("__clang_patchlevel__", TOSTR(CLANG_VERSION_PATCHLEVEL));
228#else
229  Builder.defineMacro("__clang_patchlevel__", "0");
230#endif
231  Builder.defineMacro("__clang_version__",
232                      "\"" CLANG_VERSION_STRING " ("
233                      + getClangFullRepositoryVersion() + ")\"");
234#undef TOSTR
235#undef TOSTR2
236  // Currently claim to be compatible with GCC 4.2.1-5621.
237  Builder.defineMacro("__GNUC_MINOR__", "2");
238  Builder.defineMacro("__GNUC_PATCHLEVEL__", "1");
239  Builder.defineMacro("__GNUC__", "4");
240  Builder.defineMacro("__GXX_ABI_VERSION", "1002");
241  Builder.defineMacro("__VERSION__", "\"4.2.1 Compatible Clang Compiler\"");
242
243  // Initialize language-specific preprocessor defines.
244
245  // These should all be defined in the preprocessor according to the
246  // current language configuration.
247  if (!LangOpts.Microsoft)
248    Builder.defineMacro("__STDC__");
249  if (LangOpts.AsmPreprocessor)
250    Builder.defineMacro("__ASSEMBLER__");
251
252  if (!LangOpts.CPlusPlus) {
253    if (LangOpts.C99)
254      Builder.defineMacro("__STDC_VERSION__", "199901L");
255    else if (!LangOpts.GNUMode && LangOpts.Digraphs)
256      Builder.defineMacro("__STDC_VERSION__", "199409L");
257  }
258
259  // Standard conforming mode?
260  if (!LangOpts.GNUMode)
261    Builder.defineMacro("__STRICT_ANSI__");
262
263  if (LangOpts.CPlusPlus0x)
264    Builder.defineMacro("__GXX_EXPERIMENTAL_CXX0X__");
265
266  if (LangOpts.Freestanding)
267    Builder.defineMacro("__STDC_HOSTED__", "0");
268  else
269    Builder.defineMacro("__STDC_HOSTED__");
270
271  if (LangOpts.ObjC1) {
272    Builder.defineMacro("__OBJC__");
273    if (LangOpts.ObjCNonFragileABI) {
274      Builder.defineMacro("__OBJC2__");
275      Builder.defineMacro("OBJC_ZEROCOST_EXCEPTIONS");
276    }
277
278    if (LangOpts.getGCMode() != LangOptions::NonGC)
279      Builder.defineMacro("__OBJC_GC__");
280
281    if (LangOpts.NeXTRuntime)
282      Builder.defineMacro("__NEXT_RUNTIME__");
283  }
284
285  // darwin_constant_cfstrings controls this. This is also dependent
286  // on other things like the runtime I believe.  This is set even for C code.
287  Builder.defineMacro("__CONSTANT_CFSTRINGS__");
288
289  if (LangOpts.ObjC2)
290    Builder.defineMacro("OBJC_NEW_PROPERTIES");
291
292  if (LangOpts.PascalStrings)
293    Builder.defineMacro("__PASCAL_STRINGS__");
294
295  if (LangOpts.Blocks) {
296    Builder.defineMacro("__block", "__attribute__((__blocks__(byref)))");
297    Builder.defineMacro("__BLOCKS__");
298  }
299
300  if (LangOpts.Exceptions)
301    Builder.defineMacro("__EXCEPTIONS");
302  if (LangOpts.RTTI)
303    Builder.defineMacro("__GXX_RTTI");
304  if (LangOpts.SjLjExceptions)
305    Builder.defineMacro("__USING_SJLJ_EXCEPTIONS__");
306
307  if (LangOpts.CPlusPlus) {
308    Builder.defineMacro("__DEPRECATED");
309    Builder.defineMacro("__GNUG__", "4");
310    Builder.defineMacro("__GXX_WEAK__");
311    if (LangOpts.GNUMode)
312      Builder.defineMacro("__cplusplus");
313    else
314      // C++ [cpp.predefined]p1:
315      //   The name_ _cplusplusis defined to the value199711Lwhen compiling a
316      //   C++ translation unit.
317      Builder.defineMacro("__cplusplus", "199711L");
318    Builder.defineMacro("__private_extern__", "extern");
319  }
320
321  if (LangOpts.Microsoft) {
322    // Filter out some microsoft extensions when trying to parse in ms-compat
323    // mode.
324    Builder.defineMacro("__int8", "__INT8_TYPE__");
325    Builder.defineMacro("__int16", "__INT16_TYPE__");
326    Builder.defineMacro("__int32", "__INT32_TYPE__");
327    Builder.defineMacro("__int64", "__INT64_TYPE__");
328    // Both __PRETTY_FUNCTION__ and __FUNCTION__ are GCC extensions, however
329    // VC++ appears to only like __FUNCTION__.
330    Builder.defineMacro("__PRETTY_FUNCTION__", "__FUNCTION__");
331    // Work around some issues with Visual C++ headerws.
332    if (LangOpts.CPlusPlus) {
333      // Since we define wchar_t in C++ mode.
334      Builder.defineMacro("_WCHAR_T_DEFINED");
335      Builder.defineMacro("_NATIVE_WCHAR_T_DEFINED");
336      // FIXME:  This should be temporary until we have a __pragma
337      // solution, to avoid some errors flagged in VC++ headers.
338      Builder.defineMacro("_CRT_SECURE_CPP_OVERLOAD_SECURE_NAMES", "0");
339    }
340  }
341
342  if (LangOpts.Optimize)
343    Builder.defineMacro("__OPTIMIZE__");
344  if (LangOpts.OptimizeSize)
345    Builder.defineMacro("__OPTIMIZE_SIZE__");
346
347  // Initialize target-specific preprocessor defines.
348
349  // Define type sizing macros based on the target properties.
350  assert(TI.getCharWidth() == 8 && "Only support 8-bit char so far");
351  Builder.defineMacro("__CHAR_BIT__", "8");
352
353  DefineTypeSize("__SCHAR_MAX__", TI.getCharWidth(), "", true, Builder);
354  DefineTypeSize("__SHRT_MAX__", TargetInfo::SignedShort, TI, Builder);
355  DefineTypeSize("__INT_MAX__", TargetInfo::SignedInt, TI, Builder);
356  DefineTypeSize("__LONG_MAX__", TargetInfo::SignedLong, TI, Builder);
357  DefineTypeSize("__LONG_LONG_MAX__", TargetInfo::SignedLongLong, TI, Builder);
358  DefineTypeSize("__WCHAR_MAX__", TI.getWCharType(), TI, Builder);
359  DefineTypeSize("__INTMAX_MAX__", TI.getIntMaxType(), TI, Builder);
360
361  DefineTypeSizeof("__SIZEOF_DOUBLE__", TI.getDoubleWidth(), TI, Builder);
362  DefineTypeSizeof("__SIZEOF_FLOAT__", TI.getFloatWidth(), TI, Builder);
363  DefineTypeSizeof("__SIZEOF_INT__", TI.getIntWidth(), TI, Builder);
364  DefineTypeSizeof("__SIZEOF_LONG__", TI.getLongWidth(), TI, Builder);
365  DefineTypeSizeof("__SIZEOF_LONG_DOUBLE__",TI.getLongDoubleWidth(),TI,Builder);
366  DefineTypeSizeof("__SIZEOF_LONG_LONG__", TI.getLongLongWidth(), TI, Builder);
367  DefineTypeSizeof("__SIZEOF_POINTER__", TI.getPointerWidth(0), TI, Builder);
368  DefineTypeSizeof("__SIZEOF_SHORT__", TI.getShortWidth(), TI, Builder);
369  DefineTypeSizeof("__SIZEOF_PTRDIFF_T__",
370                   TI.getTypeWidth(TI.getPtrDiffType(0)), TI, Builder);
371  DefineTypeSizeof("__SIZEOF_SIZE_T__",
372                   TI.getTypeWidth(TI.getSizeType()), TI, Builder);
373  DefineTypeSizeof("__SIZEOF_WCHAR_T__",
374                   TI.getTypeWidth(TI.getWCharType()), TI, Builder);
375  DefineTypeSizeof("__SIZEOF_WINT_T__",
376                   TI.getTypeWidth(TI.getWIntType()), TI, Builder);
377
378  DefineType("__INTMAX_TYPE__", TI.getIntMaxType(), Builder);
379  DefineType("__UINTMAX_TYPE__", TI.getUIntMaxType(), Builder);
380  DefineTypeWidth("__INTMAX_WIDTH__",  TI.getIntMaxType(), TI, Builder);
381  DefineType("__PTRDIFF_TYPE__", TI.getPtrDiffType(0), Builder);
382  DefineTypeWidth("__PTRDIFF_WIDTH__", TI.getPtrDiffType(0), TI, Builder);
383  DefineType("__INTPTR_TYPE__", TI.getIntPtrType(), Builder);
384  DefineTypeWidth("__INTPTR_WIDTH__", TI.getIntPtrType(), TI, Builder);
385  DefineType("__SIZE_TYPE__", TI.getSizeType(), Builder);
386  DefineTypeWidth("__SIZE_WIDTH__", TI.getSizeType(), TI, Builder);
387  DefineType("__WCHAR_TYPE__", TI.getWCharType(), Builder);
388  DefineTypeWidth("__WCHAR_WIDTH__", TI.getWCharType(), TI, Builder);
389  DefineType("__WINT_TYPE__", TI.getWIntType(), Builder);
390  DefineTypeWidth("__WINT_WIDTH__", TI.getWIntType(), TI, Builder);
391  DefineTypeWidth("__SIG_ATOMIC_WIDTH__", TI.getSigAtomicType(), TI, Builder);
392  DefineType("__CHAR16_TYPE__", TI.getChar16Type(), Builder);
393  DefineType("__CHAR32_TYPE__", TI.getChar32Type(), Builder);
394
395  DefineFloatMacros(Builder, "FLT", &TI.getFloatFormat());
396  DefineFloatMacros(Builder, "DBL", &TI.getDoubleFormat());
397  DefineFloatMacros(Builder, "LDBL", &TI.getLongDoubleFormat());
398
399  // Define a __POINTER_WIDTH__ macro for stdint.h.
400  Builder.defineMacro("__POINTER_WIDTH__",
401                      llvm::Twine((int)TI.getPointerWidth(0)));
402
403  if (!LangOpts.CharIsSigned)
404    Builder.defineMacro("__CHAR_UNSIGNED__");
405
406  // Define exact-width integer types for stdint.h
407  Builder.defineMacro("__INT" + llvm::Twine(TI.getCharWidth()) + "_TYPE__",
408                      "char");
409
410  if (TI.getShortWidth() > TI.getCharWidth())
411    DefineExactWidthIntType(TargetInfo::SignedShort, TI, Builder);
412
413  if (TI.getIntWidth() > TI.getShortWidth())
414    DefineExactWidthIntType(TargetInfo::SignedInt, TI, Builder);
415
416  if (TI.getLongWidth() > TI.getIntWidth())
417    DefineExactWidthIntType(TargetInfo::SignedLong, TI, Builder);
418
419  if (TI.getLongLongWidth() > TI.getLongWidth())
420    DefineExactWidthIntType(TargetInfo::SignedLongLong, TI, Builder);
421
422  // Add __builtin_va_list typedef.
423  Builder.append(TI.getVAListDeclaration());
424
425  if (const char *Prefix = TI.getUserLabelPrefix())
426    Builder.defineMacro("__USER_LABEL_PREFIX__", Prefix);
427
428  // Build configuration options.  FIXME: these should be controlled by
429  // command line options or something.
430  Builder.defineMacro("__FINITE_MATH_ONLY__", "0");
431
432  if (LangOpts.GNUInline)
433    Builder.defineMacro("__GNUC_GNU_INLINE__");
434  else
435    Builder.defineMacro("__GNUC_STDC_INLINE__");
436
437  if (LangOpts.NoInline)
438    Builder.defineMacro("__NO_INLINE__");
439
440  if (unsigned PICLevel = LangOpts.PICLevel) {
441    Builder.defineMacro("__PIC__", llvm::Twine(PICLevel));
442    Builder.defineMacro("__pic__", llvm::Twine(PICLevel));
443  }
444
445  // Macros to control C99 numerics and <float.h>
446  Builder.defineMacro("__FLT_EVAL_METHOD__", "0");
447  Builder.defineMacro("__FLT_RADIX__", "2");
448  int Dig = PickFP(&TI.getLongDoubleFormat(), -1/*FIXME*/, 17, 21, 33, 36);
449  Builder.defineMacro("__DECIMAL_DIG__", llvm::Twine(Dig));
450
451  if (LangOpts.getStackProtectorMode() == LangOptions::SSPOn)
452    Builder.defineMacro("__SSP__");
453  else if (LangOpts.getStackProtectorMode() == LangOptions::SSPReq)
454    Builder.defineMacro("__SSP_ALL__", "2");
455
456  if (FEOpts.ProgramAction == frontend::RewriteObjC)
457    Builder.defineMacro("__weak", "__attribute__((objc_gc(weak)))");
458
459  // Define a macro that exists only when using the static analyzer.
460  if (FEOpts.ProgramAction == frontend::RunAnalysis)
461    Builder.defineMacro("__clang_analyzer__");
462
463  // Get other target #defines.
464  TI.getTargetDefines(LangOpts, Builder);
465}
466
467// Initialize the remapping of files to alternative contents, e.g.,
468// those specified through other files.
469static void InitializeFileRemapping(Diagnostic &Diags,
470                                    SourceManager &SourceMgr,
471                                    FileManager &FileMgr,
472                                    const PreprocessorOptions &InitOpts) {
473  // Remap files in the source manager (with buffers).
474  for (PreprocessorOptions::remapped_file_buffer_iterator
475         Remap = InitOpts.remapped_file_buffer_begin(),
476         RemapEnd = InitOpts.remapped_file_buffer_end();
477       Remap != RemapEnd;
478       ++Remap) {
479    // Create the file entry for the file that we're mapping from.
480    const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
481                                                Remap->second->getBufferSize(),
482                                                       0);
483    if (!FromFile) {
484      Diags.Report(diag::err_fe_remap_missing_from_file)
485        << Remap->first;
486      delete Remap->second;
487      continue;
488    }
489
490    // Override the contents of the "from" file with the contents of
491    // the "to" file.
492    SourceMgr.overrideFileContents(FromFile, Remap->second);
493  }
494
495  // Remap files in the source manager (with other files).
496  for (PreprocessorOptions::remapped_file_iterator
497       Remap = InitOpts.remapped_file_begin(),
498       RemapEnd = InitOpts.remapped_file_end();
499       Remap != RemapEnd;
500       ++Remap) {
501    // Find the file that we're mapping to.
502    const FileEntry *ToFile = FileMgr.getFile(Remap->second);
503    if (!ToFile) {
504      Diags.Report(diag::err_fe_remap_missing_to_file)
505      << Remap->first << Remap->second;
506      continue;
507    }
508
509    // Create the file entry for the file that we're mapping from.
510    const FileEntry *FromFile = FileMgr.getVirtualFile(Remap->first,
511                                                       ToFile->getSize(),
512                                                       0);
513    if (!FromFile) {
514      Diags.Report(diag::err_fe_remap_missing_from_file)
515      << Remap->first;
516      continue;
517    }
518
519    // Load the contents of the file we're mapping to.
520    std::string ErrorStr;
521    const llvm::MemoryBuffer *Buffer
522    = llvm::MemoryBuffer::getFile(ToFile->getName(), &ErrorStr);
523    if (!Buffer) {
524      Diags.Report(diag::err_fe_error_opening)
525        << Remap->second << ErrorStr;
526      continue;
527    }
528
529    // Override the contents of the "from" file with the contents of
530    // the "to" file.
531    SourceMgr.overrideFileContents(FromFile, Buffer);
532  }
533}
534
535/// InitializePreprocessor - Initialize the preprocessor getting it and the
536/// environment ready to process a single file. This returns true on error.
537///
538void clang::InitializePreprocessor(Preprocessor &PP,
539                                   const PreprocessorOptions &InitOpts,
540                                   const HeaderSearchOptions &HSOpts,
541                                   const FrontendOptions &FEOpts) {
542  std::string PredefineBuffer;
543  PredefineBuffer.reserve(4080);
544  llvm::raw_string_ostream Predefines(PredefineBuffer);
545  MacroBuilder Builder(Predefines);
546
547  InitializeFileRemapping(PP.getDiagnostics(), PP.getSourceManager(),
548                          PP.getFileManager(), InitOpts);
549
550  // Emit line markers for various builtin sections of the file.  We don't do
551  // this in asm preprocessor mode, because "# 4" is not a line marker directive
552  // in this mode.
553  if (!PP.getLangOptions().AsmPreprocessor)
554    Builder.append("# 1 \"<built-in>\" 3");
555
556  // Install things like __POWERPC__, __GNUC__, etc into the macro table.
557  if (InitOpts.UsePredefines)
558    InitializePredefinedMacros(PP.getTargetInfo(), PP.getLangOptions(),
559                               FEOpts, Builder);
560
561  // Add on the predefines from the driver.  Wrap in a #line directive to report
562  // that they come from the command line.
563  if (!PP.getLangOptions().AsmPreprocessor)
564    Builder.append("# 1 \"<command line>\" 1");
565
566  // Process #define's and #undef's in the order they are given.
567  for (unsigned i = 0, e = InitOpts.Macros.size(); i != e; ++i) {
568    if (InitOpts.Macros[i].second)  // isUndef
569      Builder.undefineMacro(InitOpts.Macros[i].first);
570    else
571      DefineBuiltinMacro(Builder, InitOpts.Macros[i].first,
572                         PP.getDiagnostics());
573  }
574
575  // If -imacros are specified, include them now.  These are processed before
576  // any -include directives.
577  for (unsigned i = 0, e = InitOpts.MacroIncludes.size(); i != e; ++i)
578    AddImplicitIncludeMacros(Builder, InitOpts.MacroIncludes[i]);
579
580  // Process -include directives.
581  for (unsigned i = 0, e = InitOpts.Includes.size(); i != e; ++i) {
582    const std::string &Path = InitOpts.Includes[i];
583    if (Path == InitOpts.ImplicitPTHInclude)
584      AddImplicitIncludePTH(Builder, PP, Path);
585    else
586      AddImplicitInclude(Builder, Path);
587  }
588
589  // Exit the command line and go back to <built-in> (2 is LC_LEAVE).
590  if (!PP.getLangOptions().AsmPreprocessor)
591    Builder.append("# 1 \"<built-in>\" 2");
592
593  // Copy PredefinedBuffer into the Preprocessor.
594  PP.setPredefines(Predefines.str());
595
596  // Initialize the header search object.
597  ApplyHeaderSearchOptions(PP.getHeaderSearchInfo(), HSOpts,
598                           PP.getLangOptions(),
599                           PP.getTargetInfo().getTriple());
600}
601