1//===--- InitHeaderSearch.cpp - Initialize header search paths ------------===//
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 InitHeaderSearch class.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Frontend/Utils.h"
15#include "clang/Basic/FileManager.h"
16#include "clang/Basic/LangOptions.h"
17#include "clang/Config/config.h" // C_INCLUDE_DIRS
18#include "clang/Lex/HeaderSearch.h"
19#include "clang/Lex/HeaderSearchOptions.h"
20#include "llvm/ADT/SmallPtrSet.h"
21#include "llvm/ADT/SmallString.h"
22#include "llvm/ADT/SmallVector.h"
23#include "llvm/ADT/StringExtras.h"
24#include "llvm/ADT/Triple.h"
25#include "llvm/ADT/Twine.h"
26#include "llvm/Support/ErrorHandling.h"
27#include "llvm/Support/FileSystem.h"
28#include "llvm/Support/Path.h"
29#include "llvm/Support/raw_ostream.h"
30
31using namespace clang;
32using namespace clang::frontend;
33
34namespace {
35
36/// InitHeaderSearch - This class makes it easier to set the search paths of
37///  a HeaderSearch object. InitHeaderSearch stores several search path lists
38///  internally, which can be sent to a HeaderSearch object in one swoop.
39class InitHeaderSearch {
40  std::vector<std::pair<IncludeDirGroup, DirectoryLookup> > IncludePath;
41  typedef std::vector<std::pair<IncludeDirGroup,
42                      DirectoryLookup> >::const_iterator path_iterator;
43  std::vector<std::pair<std::string, bool> > SystemHeaderPrefixes;
44  HeaderSearch &Headers;
45  bool Verbose;
46  std::string IncludeSysroot;
47  bool HasSysroot;
48
49public:
50
51  InitHeaderSearch(HeaderSearch &HS, bool verbose, StringRef sysroot)
52    : Headers(HS), Verbose(verbose), IncludeSysroot(sysroot),
53      HasSysroot(!(sysroot.empty() || sysroot == "/")) {
54  }
55
56  /// AddPath - Add the specified path to the specified group list, prefixing
57  /// the sysroot if used.
58  void AddPath(const Twine &Path, IncludeDirGroup Group, bool isFramework);
59
60  /// AddUnmappedPath - Add the specified path to the specified group list,
61  /// without performing any sysroot remapping.
62  void AddUnmappedPath(const Twine &Path, IncludeDirGroup Group,
63                       bool isFramework);
64
65  /// AddSystemHeaderPrefix - Add the specified prefix to the system header
66  /// prefix list.
67  void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) {
68    SystemHeaderPrefixes.push_back(std::make_pair(Prefix, IsSystemHeader));
69  }
70
71  /// AddGnuCPlusPlusIncludePaths - Add the necessary paths to support a gnu
72  ///  libstdc++.
73  void AddGnuCPlusPlusIncludePaths(StringRef Base,
74                                   StringRef ArchDir,
75                                   StringRef Dir32,
76                                   StringRef Dir64,
77                                   const llvm::Triple &triple);
78
79  /// AddMinGWCPlusPlusIncludePaths - Add the necessary paths to support a MinGW
80  ///  libstdc++.
81  void AddMinGWCPlusPlusIncludePaths(StringRef Base,
82                                     StringRef Arch,
83                                     StringRef Version);
84
85  /// AddMinGW64CXXPaths - Add the necessary paths to support
86  /// libstdc++ of x86_64-w64-mingw32 aka mingw-w64.
87  void AddMinGW64CXXPaths(StringRef Base,
88                          StringRef Version);
89
90  // AddDefaultCIncludePaths - Add paths that should always be searched.
91  void AddDefaultCIncludePaths(const llvm::Triple &triple,
92                               const HeaderSearchOptions &HSOpts);
93
94  // AddDefaultCPlusPlusIncludePaths -  Add paths that should be searched when
95  //  compiling c++.
96  void AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple,
97                                       const HeaderSearchOptions &HSOpts);
98
99  /// AddDefaultSystemIncludePaths - Adds the default system include paths so
100  ///  that e.g. stdio.h is found.
101  void AddDefaultIncludePaths(const LangOptions &Lang,
102                              const llvm::Triple &triple,
103                              const HeaderSearchOptions &HSOpts);
104
105  /// Realize - Merges all search path lists into one list and send it to
106  /// HeaderSearch.
107  void Realize(const LangOptions &Lang);
108};
109
110}  // end anonymous namespace.
111
112static bool CanPrefixSysroot(StringRef Path) {
113#if defined(LLVM_ON_WIN32)
114  return !Path.empty() && llvm::sys::path::is_separator(Path[0]);
115#else
116  return llvm::sys::path::is_absolute(Path);
117#endif
118}
119
120void InitHeaderSearch::AddPath(const Twine &Path, IncludeDirGroup Group,
121                               bool isFramework) {
122  // Add the path with sysroot prepended, if desired and this is a system header
123  // group.
124  if (HasSysroot) {
125    SmallString<256> MappedPathStorage;
126    StringRef MappedPathStr = Path.toStringRef(MappedPathStorage);
127    if (CanPrefixSysroot(MappedPathStr)) {
128      AddUnmappedPath(IncludeSysroot + Path, Group, isFramework);
129      return;
130    }
131  }
132
133  AddUnmappedPath(Path, Group, isFramework);
134}
135
136void InitHeaderSearch::AddUnmappedPath(const Twine &Path, IncludeDirGroup Group,
137                                       bool isFramework) {
138  assert(!Path.isTriviallyEmpty() && "can't handle empty path here");
139
140  FileManager &FM = Headers.getFileMgr();
141  SmallString<256> MappedPathStorage;
142  StringRef MappedPathStr = Path.toStringRef(MappedPathStorage);
143
144  // Compute the DirectoryLookup type.
145  SrcMgr::CharacteristicKind Type;
146  if (Group == Quoted || Group == Angled || Group == IndexHeaderMap) {
147    Type = SrcMgr::C_User;
148  } else if (Group == ExternCSystem) {
149    Type = SrcMgr::C_ExternCSystem;
150  } else {
151    Type = SrcMgr::C_System;
152  }
153
154  // If the directory exists, add it.
155  if (const DirectoryEntry *DE = FM.getDirectory(MappedPathStr)) {
156    IncludePath.push_back(
157      std::make_pair(Group, DirectoryLookup(DE, Type, isFramework)));
158    return;
159  }
160
161  // Check to see if this is an apple-style headermap (which are not allowed to
162  // be frameworks).
163  if (!isFramework) {
164    if (const FileEntry *FE = FM.getFile(MappedPathStr)) {
165      if (const HeaderMap *HM = Headers.CreateHeaderMap(FE)) {
166        // It is a headermap, add it to the search path.
167        IncludePath.push_back(
168          std::make_pair(Group,
169                         DirectoryLookup(HM, Type, Group == IndexHeaderMap)));
170        return;
171      }
172    }
173  }
174
175  if (Verbose)
176    llvm::errs() << "ignoring nonexistent directory \""
177                 << MappedPathStr << "\"\n";
178}
179
180void InitHeaderSearch::AddGnuCPlusPlusIncludePaths(StringRef Base,
181                                                   StringRef ArchDir,
182                                                   StringRef Dir32,
183                                                   StringRef Dir64,
184                                                   const llvm::Triple &triple) {
185  // Add the base dir
186  AddPath(Base, CXXSystem, false);
187
188  // Add the multilib dirs
189  llvm::Triple::ArchType arch = triple.getArch();
190  bool is64bit = arch == llvm::Triple::ppc64 || arch == llvm::Triple::x86_64;
191  if (is64bit)
192    AddPath(Base + "/" + ArchDir + "/" + Dir64, CXXSystem, false);
193  else
194    AddPath(Base + "/" + ArchDir + "/" + Dir32, CXXSystem, false);
195
196  // Add the backward dir
197  AddPath(Base + "/backward", CXXSystem, false);
198}
199
200void InitHeaderSearch::AddMinGWCPlusPlusIncludePaths(StringRef Base,
201                                                     StringRef Arch,
202                                                     StringRef Version) {
203  AddPath(Base + "/" + Arch + "/" + Version + "/include/c++",
204          CXXSystem, false);
205  AddPath(Base + "/" + Arch + "/" + Version + "/include/c++/" + Arch,
206          CXXSystem, false);
207  AddPath(Base + "/" + Arch + "/" + Version + "/include/c++/backward",
208          CXXSystem, false);
209}
210
211void InitHeaderSearch::AddMinGW64CXXPaths(StringRef Base,
212                                          StringRef Version) {
213  // Assumes Base is HeaderSearchOpts' ResourceDir
214  AddPath(Base + "/../../../include/c++/" + Version,
215          CXXSystem, false);
216  AddPath(Base + "/../../../include/c++/" + Version + "/x86_64-w64-mingw32",
217          CXXSystem, false);
218  AddPath(Base + "/../../../include/c++/" + Version + "/i686-w64-mingw32",
219          CXXSystem, false);
220  AddPath(Base + "/../../../include/c++/" + Version + "/backward",
221          CXXSystem, false);
222}
223
224void InitHeaderSearch::AddDefaultCIncludePaths(const llvm::Triple &triple,
225                                            const HeaderSearchOptions &HSOpts) {
226  llvm::Triple::OSType os = triple.getOS();
227
228  if (HSOpts.UseStandardSystemIncludes) {
229    switch (os) {
230    case llvm::Triple::FreeBSD:
231    case llvm::Triple::NetBSD:
232    case llvm::Triple::OpenBSD:
233    case llvm::Triple::Bitrig:
234      break;
235    default:
236      // FIXME: temporary hack: hard-coded paths.
237      AddPath("/usr/local/include", System, false);
238      break;
239    }
240  }
241
242  // Builtin includes use #include_next directives and should be positioned
243  // just prior C include dirs.
244  if (HSOpts.UseBuiltinIncludes) {
245    // Ignore the sys root, we *always* look for clang headers relative to
246    // supplied path.
247    SmallString<128> P = StringRef(HSOpts.ResourceDir);
248    llvm::sys::path::append(P, "include");
249    AddUnmappedPath(P.str(), ExternCSystem, false);
250  }
251
252  // All remaining additions are for system include directories, early exit if
253  // we aren't using them.
254  if (!HSOpts.UseStandardSystemIncludes)
255    return;
256
257  // Add dirs specified via 'configure --with-c-include-dirs'.
258  StringRef CIncludeDirs(C_INCLUDE_DIRS);
259  if (CIncludeDirs != "") {
260    SmallVector<StringRef, 5> dirs;
261    CIncludeDirs.split(dirs, ":");
262    for (SmallVectorImpl<StringRef>::iterator i = dirs.begin();
263         i != dirs.end();
264         ++i)
265      AddPath(*i, ExternCSystem, false);
266    return;
267  }
268
269  switch (os) {
270  case llvm::Triple::Linux:
271    llvm_unreachable("Include management is handled in the driver.");
272
273  case llvm::Triple::Haiku:
274    AddPath("/boot/common/include", System, false);
275    AddPath("/boot/develop/headers/os", System, false);
276    AddPath("/boot/develop/headers/os/app", System, false);
277    AddPath("/boot/develop/headers/os/arch", System, false);
278    AddPath("/boot/develop/headers/os/device", System, false);
279    AddPath("/boot/develop/headers/os/drivers", System, false);
280    AddPath("/boot/develop/headers/os/game", System, false);
281    AddPath("/boot/develop/headers/os/interface", System, false);
282    AddPath("/boot/develop/headers/os/kernel", System, false);
283    AddPath("/boot/develop/headers/os/locale", System, false);
284    AddPath("/boot/develop/headers/os/mail", System, false);
285    AddPath("/boot/develop/headers/os/media", System, false);
286    AddPath("/boot/develop/headers/os/midi", System, false);
287    AddPath("/boot/develop/headers/os/midi2", System, false);
288    AddPath("/boot/develop/headers/os/net", System, false);
289    AddPath("/boot/develop/headers/os/storage", System, false);
290    AddPath("/boot/develop/headers/os/support", System, false);
291    AddPath("/boot/develop/headers/os/translation", System, false);
292    AddPath("/boot/develop/headers/os/add-ons/graphics", System, false);
293    AddPath("/boot/develop/headers/os/add-ons/input_server", System, false);
294    AddPath("/boot/develop/headers/os/add-ons/screen_saver", System, false);
295    AddPath("/boot/develop/headers/os/add-ons/tracker", System, false);
296    AddPath("/boot/develop/headers/os/be_apps/Deskbar", System, false);
297    AddPath("/boot/develop/headers/os/be_apps/NetPositive", System, false);
298    AddPath("/boot/develop/headers/os/be_apps/Tracker", System, false);
299    AddPath("/boot/develop/headers/cpp", System, false);
300    AddPath("/boot/develop/headers/cpp/i586-pc-haiku", System, false);
301    AddPath("/boot/develop/headers/3rdparty", System, false);
302    AddPath("/boot/develop/headers/bsd", System, false);
303    AddPath("/boot/develop/headers/glibc", System, false);
304    AddPath("/boot/develop/headers/posix", System, false);
305    AddPath("/boot/develop/headers",  System, false);
306    break;
307  case llvm::Triple::RTEMS:
308    break;
309  case llvm::Triple::Win32:
310    switch (triple.getEnvironment()) {
311    default: llvm_unreachable("Include management is handled in the driver.");
312    case llvm::Triple::Cygnus:
313      AddPath("/usr/include/w32api", System, false);
314      break;
315    case llvm::Triple::GNU:
316      // mingw-w64 crt include paths
317      // <sysroot>/i686-w64-mingw32/include
318      SmallString<128> P = StringRef(HSOpts.ResourceDir);
319      llvm::sys::path::append(P, "../../../i686-w64-mingw32/include");
320      AddPath(P.str(), System, false);
321
322      // <sysroot>/x86_64-w64-mingw32/include
323      P.resize(HSOpts.ResourceDir.size());
324      llvm::sys::path::append(P, "../../../x86_64-w64-mingw32/include");
325      AddPath(P.str(), System, false);
326
327      // mingw.org crt include paths
328      // <sysroot>/include
329      P.resize(HSOpts.ResourceDir.size());
330      llvm::sys::path::append(P, "../../../include");
331      AddPath(P.str(), System, false);
332      AddPath("/mingw/include", System, false);
333#if defined(LLVM_ON_WIN32)
334      AddPath("c:/mingw/include", System, false);
335#endif
336      break;
337    }
338    break;
339  default:
340    break;
341  }
342
343  if ( os != llvm::Triple::RTEMS )
344    AddPath("/usr/include", ExternCSystem, false);
345}
346
347void InitHeaderSearch::
348AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple, const HeaderSearchOptions &HSOpts) {
349  llvm::Triple::OSType os = triple.getOS();
350  // FIXME: temporary hack: hard-coded paths.
351
352  if (triple.isOSDarwin()) {
353    switch (triple.getArch()) {
354    default: break;
355
356    case llvm::Triple::ppc:
357    case llvm::Triple::ppc64:
358      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
359                                  "powerpc-apple-darwin10", "", "ppc64",
360                                  triple);
361      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.0.0",
362                                  "powerpc-apple-darwin10", "", "ppc64",
363                                  triple);
364      break;
365
366    case llvm::Triple::x86:
367    case llvm::Triple::x86_64:
368      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
369                                  "i686-apple-darwin10", "", "x86_64", triple);
370      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.0.0",
371                                  "i686-apple-darwin8", "", "", triple);
372      break;
373
374    case llvm::Triple::arm:
375    case llvm::Triple::thumb:
376      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
377                                  "arm-apple-darwin10", "v7", "", triple);
378      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
379                                  "arm-apple-darwin10", "v6", "", triple);
380      break;
381
382    case llvm::Triple::aarch64:
383    case llvm::Triple::arm64:
384      AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
385                                  "arm64-apple-darwin10", "", "", triple);
386      break;
387    }
388    return;
389  }
390
391  switch (os) {
392  case llvm::Triple::Linux:
393    llvm_unreachable("Include management is handled in the driver.");
394
395  case llvm::Triple::Win32:
396    switch (triple.getEnvironment()) {
397    default: llvm_unreachable("Include management is handled in the driver.");
398    case llvm::Triple::Cygnus:
399      // Cygwin-1.7
400      AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.7.3");
401      AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.5.3");
402      AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.3.4");
403      // g++-4 / Cygwin-1.5
404      AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.3.2");
405      break;
406    case llvm::Triple::GNU:
407      // mingw-w64 C++ include paths (i686-w64-mingw32 and x86_64-w64-mingw32)
408      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.0");
409      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.1");
410      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.2");
411      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.3");
412      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.0");
413      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.1");
414      AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.2");
415      // mingw.org C++ include paths
416#if defined(LLVM_ON_WIN32)
417      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.0");
418      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.1");
419      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.2");
420      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.3");
421      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.0");
422      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.1");
423      AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.2");
424#endif
425      break;
426    }
427  case llvm::Triple::DragonFly:
428    if (llvm::sys::fs::exists("/usr/lib/gcc47"))
429      AddPath("/usr/include/c++/4.7", CXXSystem, false);
430    else
431      AddPath("/usr/include/c++/4.4", CXXSystem, false);
432    break;
433  case llvm::Triple::OpenBSD: {
434    std::string t = triple.getTriple();
435    if (t.substr(0, 6) == "x86_64")
436      t.replace(0, 6, "amd64");
437    AddGnuCPlusPlusIncludePaths("/usr/include/g++",
438                                t, "", "", triple);
439    break;
440  }
441  case llvm::Triple::Minix:
442    AddGnuCPlusPlusIncludePaths("/usr/gnu/include/c++/4.4.3",
443                                "", "", "", triple);
444    break;
445  case llvm::Triple::Solaris:
446    AddGnuCPlusPlusIncludePaths("/usr/gcc/4.5/include/c++/4.5.2/",
447                                "i386-pc-solaris2.11", "", "", triple);
448    // Solaris - Fall though..
449  case llvm::Triple::AuroraUX:
450    // AuroraUX
451    AddGnuCPlusPlusIncludePaths("/opt/gcc4/include/c++/4.2.4",
452                                "i386-pc-solaris2.11", "", "", triple);
453    break;
454  default:
455    break;
456  }
457}
458
459void InitHeaderSearch::AddDefaultIncludePaths(const LangOptions &Lang,
460                                              const llvm::Triple &triple,
461                                            const HeaderSearchOptions &HSOpts) {
462  // NB: This code path is going away. All of the logic is moving into the
463  // driver which has the information necessary to do target-specific
464  // selections of default include paths. Each target which moves there will be
465  // exempted from this logic here until we can delete the entire pile of code.
466  switch (triple.getOS()) {
467  default:
468    break; // Everything else continues to use this routine's logic.
469
470  case llvm::Triple::Linux:
471    return;
472
473  case llvm::Triple::Win32:
474    if (triple.getEnvironment() == llvm::Triple::MSVC ||
475        triple.getEnvironment() == llvm::Triple::Itanium ||
476        triple.getObjectFormat() == llvm::Triple::MachO)
477      return;
478    break;
479  }
480
481  if (Lang.CPlusPlus && HSOpts.UseStandardCXXIncludes &&
482      HSOpts.UseStandardSystemIncludes) {
483    if (HSOpts.UseLibcxx) {
484      if (triple.isOSDarwin()) {
485        // On Darwin, libc++ may be installed alongside the compiler in
486        // include/c++/v1.
487        if (!HSOpts.ResourceDir.empty()) {
488          // Remove version from foo/lib/clang/version
489          StringRef NoVer = llvm::sys::path::parent_path(HSOpts.ResourceDir);
490          // Remove clang from foo/lib/clang
491          StringRef Lib = llvm::sys::path::parent_path(NoVer);
492          // Remove lib from foo/lib
493          SmallString<128> P = llvm::sys::path::parent_path(Lib);
494
495          // Get foo/include/c++/v1
496          llvm::sys::path::append(P, "include", "c++", "v1");
497          AddUnmappedPath(P.str(), CXXSystem, false);
498        }
499      }
500      // On Solaris, include the support directory for things like xlocale and
501      // fudged system headers.
502      if (triple.getOS() == llvm::Triple::Solaris)
503        AddPath("/usr/include/c++/v1/support/solaris", CXXSystem, false);
504
505      AddPath("/usr/include/c++/v1", CXXSystem, false);
506    } else {
507      AddDefaultCPlusPlusIncludePaths(triple, HSOpts);
508    }
509  }
510
511  AddDefaultCIncludePaths(triple, HSOpts);
512
513  // Add the default framework include paths on Darwin.
514  if (HSOpts.UseStandardSystemIncludes) {
515    if (triple.isOSDarwin()) {
516      AddPath("/System/Library/Frameworks", System, true);
517      AddPath("/Library/Frameworks", System, true);
518    }
519  }
520}
521
522/// RemoveDuplicates - If there are duplicate directory entries in the specified
523/// search list, remove the later (dead) ones.  Returns the number of non-system
524/// headers removed, which is used to update NumAngled.
525static unsigned RemoveDuplicates(std::vector<DirectoryLookup> &SearchList,
526                                 unsigned First, bool Verbose) {
527  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs;
528  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs;
529  llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps;
530  unsigned NonSystemRemoved = 0;
531  for (unsigned i = First; i != SearchList.size(); ++i) {
532    unsigned DirToRemove = i;
533
534    const DirectoryLookup &CurEntry = SearchList[i];
535
536    if (CurEntry.isNormalDir()) {
537      // If this isn't the first time we've seen this dir, remove it.
538      if (SeenDirs.insert(CurEntry.getDir()))
539        continue;
540    } else if (CurEntry.isFramework()) {
541      // If this isn't the first time we've seen this framework dir, remove it.
542      if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir()))
543        continue;
544    } else {
545      assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
546      // If this isn't the first time we've seen this headermap, remove it.
547      if (SeenHeaderMaps.insert(CurEntry.getHeaderMap()))
548        continue;
549    }
550
551    // If we have a normal #include dir/framework/headermap that is shadowed
552    // later in the chain by a system include location, we actually want to
553    // ignore the user's request and drop the user dir... keeping the system
554    // dir.  This is weird, but required to emulate GCC's search path correctly.
555    //
556    // Since dupes of system dirs are rare, just rescan to find the original
557    // that we're nuking instead of using a DenseMap.
558    if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) {
559      // Find the dir that this is the same of.
560      unsigned FirstDir;
561      for (FirstDir = 0; ; ++FirstDir) {
562        assert(FirstDir != i && "Didn't find dupe?");
563
564        const DirectoryLookup &SearchEntry = SearchList[FirstDir];
565
566        // If these are different lookup types, then they can't be the dupe.
567        if (SearchEntry.getLookupType() != CurEntry.getLookupType())
568          continue;
569
570        bool isSame;
571        if (CurEntry.isNormalDir())
572          isSame = SearchEntry.getDir() == CurEntry.getDir();
573        else if (CurEntry.isFramework())
574          isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir();
575        else {
576          assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
577          isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap();
578        }
579
580        if (isSame)
581          break;
582      }
583
584      // If the first dir in the search path is a non-system dir, zap it
585      // instead of the system one.
586      if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User)
587        DirToRemove = FirstDir;
588    }
589
590    if (Verbose) {
591      llvm::errs() << "ignoring duplicate directory \""
592                   << CurEntry.getName() << "\"\n";
593      if (DirToRemove != i)
594        llvm::errs() << "  as it is a non-system directory that duplicates "
595                     << "a system directory\n";
596    }
597    if (DirToRemove != i)
598      ++NonSystemRemoved;
599
600    // This is reached if the current entry is a duplicate.  Remove the
601    // DirToRemove (usually the current dir).
602    SearchList.erase(SearchList.begin()+DirToRemove);
603    --i;
604  }
605  return NonSystemRemoved;
606}
607
608
609void InitHeaderSearch::Realize(const LangOptions &Lang) {
610  // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList.
611  std::vector<DirectoryLookup> SearchList;
612  SearchList.reserve(IncludePath.size());
613
614  // Quoted arguments go first.
615  for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
616       it != ie; ++it) {
617    if (it->first == Quoted)
618      SearchList.push_back(it->second);
619  }
620  // Deduplicate and remember index.
621  RemoveDuplicates(SearchList, 0, Verbose);
622  unsigned NumQuoted = SearchList.size();
623
624  for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
625       it != ie; ++it) {
626    if (it->first == Angled || it->first == IndexHeaderMap)
627      SearchList.push_back(it->second);
628  }
629
630  RemoveDuplicates(SearchList, NumQuoted, Verbose);
631  unsigned NumAngled = SearchList.size();
632
633  for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
634       it != ie; ++it) {
635    if (it->first == System || it->first == ExternCSystem ||
636        (!Lang.ObjC1 && !Lang.CPlusPlus && it->first == CSystem)    ||
637        (/*FIXME !Lang.ObjC1 && */Lang.CPlusPlus  && it->first == CXXSystem)  ||
638        (Lang.ObjC1  && !Lang.CPlusPlus && it->first == ObjCSystem) ||
639        (Lang.ObjC1  && Lang.CPlusPlus  && it->first == ObjCXXSystem))
640      SearchList.push_back(it->second);
641  }
642
643  for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
644       it != ie; ++it) {
645    if (it->first == After)
646      SearchList.push_back(it->second);
647  }
648
649  // Remove duplicates across both the Angled and System directories.  GCC does
650  // this and failing to remove duplicates across these two groups breaks
651  // #include_next.
652  unsigned NonSystemRemoved = RemoveDuplicates(SearchList, NumQuoted, Verbose);
653  NumAngled -= NonSystemRemoved;
654
655  bool DontSearchCurDir = false;  // TODO: set to true if -I- is set?
656  Headers.SetSearchPaths(SearchList, NumQuoted, NumAngled, DontSearchCurDir);
657
658  Headers.SetSystemHeaderPrefixes(SystemHeaderPrefixes);
659
660  // If verbose, print the list of directories that will be searched.
661  if (Verbose) {
662    llvm::errs() << "#include \"...\" search starts here:\n";
663    for (unsigned i = 0, e = SearchList.size(); i != e; ++i) {
664      if (i == NumQuoted)
665        llvm::errs() << "#include <...> search starts here:\n";
666      const char *Name = SearchList[i].getName();
667      const char *Suffix;
668      if (SearchList[i].isNormalDir())
669        Suffix = "";
670      else if (SearchList[i].isFramework())
671        Suffix = " (framework directory)";
672      else {
673        assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup");
674        Suffix = " (headermap)";
675      }
676      llvm::errs() << " " << Name << Suffix << "\n";
677    }
678    llvm::errs() << "End of search list.\n";
679  }
680}
681
682void clang::ApplyHeaderSearchOptions(HeaderSearch &HS,
683                                     const HeaderSearchOptions &HSOpts,
684                                     const LangOptions &Lang,
685                                     const llvm::Triple &Triple) {
686  InitHeaderSearch Init(HS, HSOpts.Verbose, HSOpts.Sysroot);
687
688  // Add the user defined entries.
689  for (unsigned i = 0, e = HSOpts.UserEntries.size(); i != e; ++i) {
690    const HeaderSearchOptions::Entry &E = HSOpts.UserEntries[i];
691    if (E.IgnoreSysRoot) {
692      Init.AddUnmappedPath(E.Path, E.Group, E.IsFramework);
693    } else {
694      Init.AddPath(E.Path, E.Group, E.IsFramework);
695    }
696  }
697
698  Init.AddDefaultIncludePaths(Lang, Triple, HSOpts);
699
700  for (unsigned i = 0, e = HSOpts.SystemHeaderPrefixes.size(); i != e; ++i)
701    Init.AddSystemHeaderPrefix(HSOpts.SystemHeaderPrefixes[i].Prefix,
702                               HSOpts.SystemHeaderPrefixes[i].IsSystemHeader);
703
704  if (HSOpts.UseBuiltinIncludes) {
705    // Set up the builtin include directory in the module map.
706    SmallString<128> P = StringRef(HSOpts.ResourceDir);
707    llvm::sys::path::append(P, "include");
708    if (const DirectoryEntry *Dir = HS.getFileMgr().getDirectory(P.str()))
709      HS.getModuleMap().setBuiltinIncludeDir(Dir);
710  }
711
712  Init.Realize(Lang);
713}
714