InitHeaderSearch.cpp revision c3ec9ae41335d4f8f1c21278ddfe7d37a9e0d551 
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/Frontend/HeaderSearchOptions.h"
18#include "clang/Lex/HeaderSearch.h"
19#include "llvm/ADT/SmallString.h"
20#include "llvm/ADT/SmallPtrSet.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/StringExtras.h"
23#include "llvm/ADT/Triple.h"
24#include "llvm/ADT/Twine.h"
25#include "llvm/Support/raw_ostream.h"
26#include "llvm/System/Path.h"
27#include "llvm/Config/config.h"
28#ifdef _MSC_VER
29  #define WIN32_LEAN_AND_MEAN 1
30  #include <windows.h>
31#endif
32using namespace clang;
33using namespace clang::frontend;
34
35namespace {
36
37/// InitHeaderSearch - This class makes it easier to set the search paths of
38///  a HeaderSearch object. InitHeaderSearch stores several search path lists
39///  internally, which can be sent to a HeaderSearch object in one swoop.
40class InitHeaderSearch {
41  std::vector<DirectoryLookup> IncludeGroup[4];
42  HeaderSearch& Headers;
43  bool Verbose;
44  std::string isysroot;
45
46public:
47
48  InitHeaderSearch(HeaderSearch &HS,
49      bool verbose = false, const std::string &iSysroot = "")
50    : Headers(HS), Verbose(verbose), isysroot(iSysroot) {}
51
52  /// AddPath - Add the specified path to the specified group list.
53  void AddPath(const llvm::Twine &Path, IncludeDirGroup Group,
54               bool isCXXAware, bool isUserSupplied,
55               bool isFramework, bool IgnoreSysRoot = false);
56
57  /// AddGnuCPlusPlusIncludePaths - Add the necessary paths to support a gnu
58  ///  libstdc++.
59  void AddGnuCPlusPlusIncludePaths(llvm::StringRef Base,
60                                   llvm::StringRef ArchDir,
61                                   llvm::StringRef Dir32,
62                                   llvm::StringRef Dir64,
63                                   const llvm::Triple &triple);
64
65  /// AddMinGWCPlusPlusIncludePaths - Add the necessary paths to suport a MinGW
66  ///  libstdc++.
67  void AddMinGWCPlusPlusIncludePaths(llvm::StringRef Base,
68                                     llvm::StringRef Arch,
69                                     llvm::StringRef Version);
70
71  /// AddDelimitedPaths - Add a list of paths delimited by the system PATH
72  /// separator. The processing follows that of the CPATH variable for gcc.
73  void AddDelimitedPaths(llvm::StringRef String);
74
75  // AddDefaultCIncludePaths - Add paths that should always be searched.
76  void AddDefaultCIncludePaths(const llvm::Triple &triple);
77
78  // AddDefaultCPlusPlusIncludePaths -  Add paths that should be searched when
79  //  compiling c++.
80  void AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple);
81
82  /// AddDefaultSystemIncludePaths - Adds the default system include paths so
83  ///  that e.g. stdio.h is found.
84  void AddDefaultSystemIncludePaths(const LangOptions &Lang,
85                                    const llvm::Triple &triple,
86                                    bool UseStandardCXXIncludes);
87
88  /// Realize - Merges all search path lists into one list and send it to
89  /// HeaderSearch.
90  void Realize();
91};
92
93}
94
95void InitHeaderSearch::AddPath(const llvm::Twine &Path,
96                               IncludeDirGroup Group, bool isCXXAware,
97                               bool isUserSupplied, bool isFramework,
98                               bool IgnoreSysRoot) {
99  assert(!Path.isTriviallyEmpty() && "can't handle empty path here");
100  FileManager &FM = Headers.getFileMgr();
101
102  // Compute the actual path, taking into consideration -isysroot.
103  llvm::SmallString<256> MappedPathStr;
104  llvm::raw_svector_ostream MappedPath(MappedPathStr);
105
106  // Handle isysroot.
107  if (Group == System && !IgnoreSysRoot) {
108    // FIXME: Portability.  This should be a sys::Path interface, this doesn't
109    // handle things like C:\ right, nor win32 \\network\device\blah.
110    if (isysroot.size() != 1 || isysroot[0] != '/') // Add isysroot if present.
111      MappedPath << isysroot;
112  }
113
114  Path.print(MappedPath);
115
116  // Compute the DirectoryLookup type.
117  SrcMgr::CharacteristicKind Type;
118  if (Group == Quoted || Group == Angled)
119    Type = SrcMgr::C_User;
120  else if (isCXXAware)
121    Type = SrcMgr::C_System;
122  else
123    Type = SrcMgr::C_ExternCSystem;
124
125
126  // If the directory exists, add it.
127  if (const DirectoryEntry *DE = FM.getDirectory(MappedPath.str())) {
128    IncludeGroup[Group].push_back(DirectoryLookup(DE, Type, isUserSupplied,
129                                                  isFramework));
130    return;
131  }
132
133  // Check to see if this is an apple-style headermap (which are not allowed to
134  // be frameworks).
135  if (!isFramework) {
136    if (const FileEntry *FE = FM.getFile(MappedPath.str())) {
137      if (const HeaderMap *HM = Headers.CreateHeaderMap(FE)) {
138        // It is a headermap, add it to the search path.
139        IncludeGroup[Group].push_back(DirectoryLookup(HM, Type,isUserSupplied));
140        return;
141      }
142    }
143  }
144
145  if (Verbose)
146    llvm::errs() << "ignoring nonexistent directory \""
147                 << MappedPath.str() << "\"\n";
148}
149
150
151void InitHeaderSearch::AddDelimitedPaths(llvm::StringRef at) {
152  if (at.empty()) // Empty string should not add '.' path.
153    return;
154
155  llvm::StringRef::size_type delim;
156  while ((delim = at.find(llvm::sys::PathSeparator)) != llvm::StringRef::npos) {
157    if (delim == 0)
158      AddPath(".", Angled, false, true, false);
159    else
160      AddPath(at.substr(0, delim), Angled, false, true, false);
161    at = at.substr(delim + 1);
162  }
163
164  if (at.empty())
165    AddPath(".", Angled, false, true, false);
166  else
167    AddPath(at, Angled, false, true, false);
168}
169
170void InitHeaderSearch::AddGnuCPlusPlusIncludePaths(llvm::StringRef Base,
171                                                   llvm::StringRef ArchDir,
172                                                   llvm::StringRef Dir32,
173                                                   llvm::StringRef Dir64,
174                                                   const llvm::Triple &triple) {
175  // Add the base dir
176  AddPath(Base, System, true, false, false);
177
178  // Add the multilib dirs
179  llvm::Triple::ArchType arch = triple.getArch();
180  bool is64bit = arch == llvm::Triple::ppc64 || arch == llvm::Triple::x86_64;
181  if (is64bit)
182    AddPath(Base + "/" + ArchDir + "/" + Dir64, System, true, false, false);
183  else
184    AddPath(Base + "/" + ArchDir + "/" + Dir32, System, true, false, false);
185
186  // Add the backward dir
187  AddPath(Base + "/backward", System, true, false, false);
188}
189
190void InitHeaderSearch::AddMinGWCPlusPlusIncludePaths(llvm::StringRef Base,
191                                                     llvm::StringRef Arch,
192                                                     llvm::StringRef Version) {
193  AddPath(Base + "/" + Arch + "/" + Version + "/include",
194          System, true, false, false);
195  AddPath(Base + "/" + Arch + "/" + Version + "/include/c++",
196          System, true, false, false);
197  AddPath(Base + "/" + Arch + "/" + Version + "/include/c++/backward",
198          System, true, false, false);
199}
200
201  // FIXME: This probably should goto to some platform utils place.
202#ifdef _MSC_VER
203
204  // Read registry string.
205  // This also supports a means to look for high-versioned keys by use
206  // of a $VERSION placeholder in the key path.
207  // $VERSION in the key path is a placeholder for the version number,
208  // causing the highest value path to be searched for and used.
209  // I.e. "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\VisualStudio\\$VERSION".
210  // There can be additional characters in the component.  Only the numberic
211  // characters are compared.
212static bool getSystemRegistryString(const char *keyPath, const char *valueName,
213                                    char *value, size_t maxLength) {
214  HKEY hRootKey = NULL;
215  HKEY hKey = NULL;
216  const char* subKey = NULL;
217  DWORD valueType;
218  DWORD valueSize = maxLength - 1;
219  long lResult;
220  bool returnValue = false;
221  if (strncmp(keyPath, "HKEY_CLASSES_ROOT\\", 18) == 0) {
222    hRootKey = HKEY_CLASSES_ROOT;
223    subKey = keyPath + 18;
224  }
225  else if (strncmp(keyPath, "HKEY_USERS\\", 11) == 0) {
226    hRootKey = HKEY_USERS;
227    subKey = keyPath + 11;
228  }
229  else if (strncmp(keyPath, "HKEY_LOCAL_MACHINE\\", 19) == 0) {
230    hRootKey = HKEY_LOCAL_MACHINE;
231    subKey = keyPath + 19;
232  }
233  else if (strncmp(keyPath, "HKEY_CURRENT_USER\\", 18) == 0) {
234    hRootKey = HKEY_CURRENT_USER;
235    subKey = keyPath + 18;
236  }
237  else
238    return(false);
239  const char *placeHolder = strstr(subKey, "$VERSION");
240  char bestName[256];
241  bestName[0] = '\0';
242  // If we have a $VERSION placeholder, do the highest-version search.
243  if (placeHolder) {
244    const char *keyEnd = placeHolder - 1;
245    const char *nextKey = placeHolder;
246    // Find end of previous key.
247    while ((keyEnd > subKey) && (*keyEnd != '\\'))
248      keyEnd--;
249    // Find end of key containing $VERSION.
250    while (*nextKey && (*nextKey != '\\'))
251      nextKey++;
252    size_t partialKeyLength = keyEnd - subKey;
253    char partialKey[256];
254    if (partialKeyLength > sizeof(partialKey))
255      partialKeyLength = sizeof(partialKey);
256    strncpy(partialKey, subKey, partialKeyLength);
257    partialKey[partialKeyLength] = '\0';
258    HKEY hTopKey = NULL;
259    lResult = RegOpenKeyEx(hRootKey, partialKey, 0, KEY_READ, &hTopKey);
260    if (lResult == ERROR_SUCCESS) {
261      char keyName[256];
262      int bestIndex = -1;
263      double bestValue = 0.0;
264      DWORD index, size = sizeof(keyName) - 1;
265      for (index = 0; RegEnumKeyEx(hTopKey, index, keyName, &size, NULL,
266          NULL, NULL, NULL) == ERROR_SUCCESS; index++) {
267        const char *sp = keyName;
268        while (*sp && !isdigit(*sp))
269          sp++;
270        if (!*sp)
271          continue;
272        const char *ep = sp + 1;
273        while (*ep && (isdigit(*ep) || (*ep == '.')))
274          ep++;
275        char numBuf[32];
276        strncpy(numBuf, sp, sizeof(numBuf) - 1);
277        numBuf[sizeof(numBuf) - 1] = '\0';
278        double value = strtod(numBuf, NULL);
279        if (value > bestValue) {
280          bestIndex = (int)index;
281          bestValue = value;
282          strcpy(bestName, keyName);
283        }
284        size = sizeof(keyName) - 1;
285      }
286      // If we found the highest versioned key, open the key and get the value.
287      if (bestIndex != -1) {
288        // Append rest of key.
289        strncat(bestName, nextKey, sizeof(bestName) - 1);
290        bestName[sizeof(bestName) - 1] = '\0';
291        // Open the chosen key path remainder.
292        lResult = RegOpenKeyEx(hTopKey, bestName, 0, KEY_READ, &hKey);
293        if (lResult == ERROR_SUCCESS) {
294          lResult = RegQueryValueEx(hKey, valueName, NULL, &valueType,
295            (LPBYTE)value, &valueSize);
296          if (lResult == ERROR_SUCCESS)
297            returnValue = true;
298          RegCloseKey(hKey);
299        }
300      }
301      RegCloseKey(hTopKey);
302    }
303  }
304  else {
305    lResult = RegOpenKeyEx(hRootKey, subKey, 0, KEY_READ, &hKey);
306    if (lResult == ERROR_SUCCESS) {
307      lResult = RegQueryValueEx(hKey, valueName, NULL, &valueType,
308        (LPBYTE)value, &valueSize);
309      if (lResult == ERROR_SUCCESS)
310        returnValue = true;
311      RegCloseKey(hKey);
312    }
313  }
314  return(returnValue);
315}
316#else // _MSC_VER
317  // Read registry string.
318static bool getSystemRegistryString(const char*, const char*, char*, size_t) {
319  return(false);
320}
321#endif // _MSC_VER
322
323  // Get Visual Studio installation directory.
324static bool getVisualStudioDir(std::string &path) {
325  char vsIDEInstallDir[256];
326  // Try the Windows registry first.
327  bool hasVCDir = getSystemRegistryString(
328    "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\VisualStudio\\$VERSION",
329    "InstallDir", vsIDEInstallDir, sizeof(vsIDEInstallDir) - 1);
330    // If we have both vc80 and vc90, pick version we were compiled with.
331  if (hasVCDir && vsIDEInstallDir[0]) {
332    char *p = (char*)strstr(vsIDEInstallDir, "\\Common7\\IDE");
333    if (p)
334      *p = '\0';
335    path = vsIDEInstallDir;
336    return(true);
337  }
338  else {
339    // Try the environment.
340    const char* vs90comntools = getenv("VS90COMNTOOLS");
341    const char* vs80comntools = getenv("VS80COMNTOOLS");
342    const char* vscomntools = NULL;
343      // If we have both vc80 and vc90, pick version we were compiled with.
344    if (vs90comntools && vs80comntools) {
345      #if (_MSC_VER >= 1500)  // VC90
346          vscomntools = vs90comntools;
347      #elif (_MSC_VER == 1400) // VC80
348          vscomntools = vs80comntools;
349      #else
350          vscomntools = vs90comntools;
351      #endif
352    }
353    else if (vs90comntools)
354      vscomntools = vs90comntools;
355    else if (vs80comntools)
356      vscomntools = vs80comntools;
357    if (vscomntools && *vscomntools) {
358      char *p = const_cast<char *>(strstr(vscomntools, "\\Common7\\Tools"));
359      if (p)
360        *p = '\0';
361      path = vscomntools;
362      return(true);
363    }
364    else
365      return(false);
366  }
367  return(false);
368}
369
370  // Get Windows SDK installation directory.
371static bool getWindowsSDKDir(std::string &path) {
372  char windowsSDKInstallDir[256];
373  // Try the Windows registry.
374  bool hasSDKDir = getSystemRegistryString(
375   "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Microsoft SDKs\\Windows\\$VERSION",
376    "InstallationFolder", windowsSDKInstallDir, sizeof(windowsSDKInstallDir) - 1);
377    // If we have both vc80 and vc90, pick version we were compiled with.
378  if (hasSDKDir && windowsSDKInstallDir[0]) {
379    path = windowsSDKInstallDir;
380    return(true);
381  }
382  return(false);
383}
384
385void InitHeaderSearch::AddDefaultCIncludePaths(const llvm::Triple &triple) {
386  // FIXME: temporary hack: hard-coded paths.
387  llvm::StringRef CIncludeDirs(C_INCLUDE_DIRS);
388  if (CIncludeDirs != "") {
389    llvm::SmallVector<llvm::StringRef, 5> dirs;
390    CIncludeDirs.split(dirs, ":");
391    for (llvm::SmallVectorImpl<llvm::StringRef>::iterator i = dirs.begin();
392         i != dirs.end();
393         ++i)
394      AddPath(*i, System, false, false, false);
395    return;
396  }
397  llvm::Triple::OSType os = triple.getOS();
398  switch (os) {
399  case llvm::Triple::Win32:
400    {
401      std::string VSDir;
402      std::string WindowsSDKDir;
403      if (getVisualStudioDir(VSDir)) {
404        AddPath(VSDir + "\\VC\\include", System, false, false, false);
405        if (getWindowsSDKDir(WindowsSDKDir))
406          AddPath(WindowsSDKDir, System, false, false, false);
407        else
408          AddPath(VSDir + "\\VC\\PlatformSDK\\Include",
409            System, false, false, false);
410      }
411      else {
412          // Default install paths.
413        AddPath("C:/Program Files/Microsoft Visual Studio 9.0/VC/include",
414          System, false, false, false);
415        AddPath(
416        "C:/Program Files/Microsoft Visual Studio 9.0/VC/PlatformSDK/Include",
417          System, false, false, false);
418        AddPath("C:/Program Files/Microsoft Visual Studio 8/VC/include",
419          System, false, false, false);
420        AddPath(
421        "C:/Program Files/Microsoft Visual Studio 8/VC/PlatformSDK/Include",
422          System, false, false, false);
423          // For some clang developers.
424        AddPath("G:/Program Files/Microsoft Visual Studio 9.0/VC/include",
425          System, false, false, false);
426        AddPath(
427        "G:/Program Files/Microsoft Visual Studio 9.0/VC/PlatformSDK/Include",
428          System, false, false, false);
429      }
430    }
431    break;
432  case llvm::Triple::Haiku:
433    AddPath("/boot/common/include", System, true, false, false);
434    AddPath("/boot/develop/headers/os", System, true, false, false);
435    AddPath("/boot/develop/headers/os/app", System, true, false, false);
436    AddPath("/boot/develop/headers/os/arch", System, true, false, false);
437    AddPath("/boot/develop/headers/os/device", System, true, false, false);
438    AddPath("/boot/develop/headers/os/drivers", System, true, false, false);
439    AddPath("/boot/develop/headers/os/game", System, true, false, false);
440    AddPath("/boot/develop/headers/os/interface", System, true, false, false);
441    AddPath("/boot/develop/headers/os/kernel", System, true, false, false);
442    AddPath("/boot/develop/headers/os/locale", System, true, false, false);
443    AddPath("/boot/develop/headers/os/mail", System, true, false, false);
444    AddPath("/boot/develop/headers/os/media", System, true, false, false);
445    AddPath("/boot/develop/headers/os/midi", System, true, false, false);
446    AddPath("/boot/develop/headers/os/midi2", System, true, false, false);
447    AddPath("/boot/develop/headers/os/net", System, true, false, false);
448    AddPath("/boot/develop/headers/os/storage", System, true, false, false);
449    AddPath("/boot/develop/headers/os/support", System, true, false, false);
450    AddPath("/boot/develop/headers/os/translation",
451      System, true, false, false);
452    AddPath("/boot/develop/headers/os/add-ons/graphics",
453      System, true, false, false);
454    AddPath("/boot/develop/headers/os/add-ons/input_server",
455      System, true, false, false);
456    AddPath("/boot/develop/headers/os/add-ons/screen_saver",
457      System, true, false, false);
458    AddPath("/boot/develop/headers/os/add-ons/tracker",
459      System, true, false, false);
460    AddPath("/boot/develop/headers/os/be_apps/Deskbar",
461      System, true, false, false);
462    AddPath("/boot/develop/headers/os/be_apps/NetPositive",
463      System, true, false, false);
464    AddPath("/boot/develop/headers/os/be_apps/Tracker",
465      System, true, false, false);
466    AddPath("/boot/develop/headers/cpp", System, true, false, false);
467    AddPath("/boot/develop/headers/cpp/i586-pc-haiku",
468      System, true, false, false);
469    AddPath("/boot/develop/headers/3rdparty", System, true, false, false);
470    AddPath("/boot/develop/headers/bsd", System, true, false, false);
471    AddPath("/boot/develop/headers/glibc", System, true, false, false);
472    AddPath("/boot/develop/headers/posix", System, true, false, false);
473    AddPath("/boot/develop/headers",  System, true, false, false);
474  	break;
475  case llvm::Triple::MinGW64:
476  case llvm::Triple::MinGW32:
477    AddPath("c:/mingw/include", System, true, false, false);
478    break;
479  default:
480    break;
481  }
482
483  AddPath("/usr/local/include", System, true, false, false);
484  AddPath("/usr/include", System, false, false, false);
485}
486
487void InitHeaderSearch::
488AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple) {
489  llvm::Triple::OSType os = triple.getOS();
490  llvm::StringRef CxxIncludeRoot(CXX_INCLUDE_ROOT);
491  if (CxxIncludeRoot != "") {
492    llvm::StringRef CxxIncludeArch(CXX_INCLUDE_ARCH);
493    if (CxxIncludeArch == "")
494      AddGnuCPlusPlusIncludePaths(CxxIncludeRoot, triple.str().c_str(),
495                                  CXX_INCLUDE_32BIT_DIR, CXX_INCLUDE_64BIT_DIR,
496                                  triple);
497    else
498      AddGnuCPlusPlusIncludePaths(CxxIncludeRoot, CXX_INCLUDE_ARCH,
499                                  CXX_INCLUDE_32BIT_DIR, CXX_INCLUDE_64BIT_DIR,
500                                  triple);
501    return;
502  }
503  // FIXME: temporary hack: hard-coded paths.
504  switch (os) {
505  case llvm::Triple::Cygwin:
506    AddPath("/lib/gcc/i686-pc-cygwin/3.4.4/include",
507        System, true, false, false);
508    AddPath("/lib/gcc/i686-pc-cygwin/3.4.4/include/c++",
509        System, true, false, false);
510    break;
511  case llvm::Triple::MinGW64:
512    // Try gcc 4.4.0
513    AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw64", "4.4.0");
514    // Try gcc 4.3.0
515    AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw64", "4.3.0");
516    // Fall through.
517  case llvm::Triple::MinGW32:
518    // Try gcc 4.4.0
519    AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.4.0");
520    // Try gcc 4.3.0
521    AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.3.0");
522    break;
523  case llvm::Triple::Darwin:
524    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
525                                "i686-apple-darwin10", "", "x86_64", triple);
526    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.0.0",
527                                "i686-apple-darwin8", "", "", triple);
528    break;
529  case llvm::Triple::DragonFly:
530    AddPath("/usr/include/c++/4.1", System, true, false, false);
531    break;
532  case llvm::Triple::Linux:
533    //===------------------------------------------------------------------===//
534    // Debian based distros.
535    // Note: these distros symlink /usr/include/c++/X.Y.Z -> X.Y
536    //===------------------------------------------------------------------===//
537    // Ubuntu 10.04 LTS "Lucid Lynx" -- gcc-4.4.3
538    // Ubuntu 9.10 "Karmic Koala"    -- gcc-4.4.1
539    // Debian 6.0 "squeeze"          -- gcc-4.4.2
540    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4",
541                                "x86_64-linux-gnu", "32", "", triple);
542    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4",
543                                "i486-linux-gnu", "", "64", triple);
544    // Ubuntu 9.04 "Jaunty Jackalope" -- gcc-4.3.3
545    // Ubuntu 8.10 "Intrepid Ibex"    -- gcc-4.3.2
546    // Debian 5.0 "lenny"             -- gcc-4.3.2
547    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3",
548                                "x86_64-linux-gnu", "32", "", triple);
549    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3",
550                                "i486-linux-gnu", "", "64", triple);
551    // Ubuntu 8.04.4 LTS "Hardy Heron"     -- gcc-4.2.4
552    // Ubuntu 8.04.[0-3] LTS "Hardy Heron" -- gcc-4.2.3
553    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2",
554                                "x86_64-linux-gnu", "32", "", triple);
555    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2",
556                                "i486-linux-gnu", "", "64", triple);
557    // Ubuntu 7.10 "Gutsy Gibbon" -- gcc-4.1.3
558    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.1",
559                                "x86_64-linux-gnu", "32", "", triple);
560    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.1",
561                                "i486-linux-gnu", "", "64", triple);
562
563    //===------------------------------------------------------------------===//
564    // Redhat based distros.
565    //===------------------------------------------------------------------===//
566    // Fedora 13
567    // Fedora 12
568    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.3",
569                                "x86_64-redhat-linux", "32", "", triple);
570    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.3",
571                                "i686-redhat-linux","", "", triple);
572    // Fedora 12 (pre-FEB-2010)
573    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.2",
574                                "x86_64-redhat-linux", "32", "", triple);
575    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.2",
576                                "i686-redhat-linux","", "", triple);
577    // Fedora 11
578    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.1",
579                                "x86_64-redhat-linux", "32", "", triple);
580    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.1",
581                                "i586-redhat-linux","", "", triple);
582    // Fedora 10
583    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.2",
584                                "x86_64-redhat-linux", "32", "", triple);
585    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.2",
586                                "i386-redhat-linux","", "", triple);
587    // Fedora 9
588    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.0",
589                                "x86_64-redhat-linux", "32", "", triple);
590    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.0",
591                                "i386-redhat-linux", "", "", triple);
592    // Fedora 8
593    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.1.2",
594                                "x86_64-redhat-linux", "", "", triple);
595    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.1.2",
596                                "i386-redhat-linux", "", "", triple);
597
598    //===------------------------------------------------------------------===//
599
600    // Exherbo (2010-01-25)
601    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.3",
602                                "x86_64-pc-linux-gnu", "32", "", triple);
603    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4.3",
604                                "i686-pc-linux-gnu", "", "", triple);
605
606    // openSUSE 11.1 32 bit
607    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3",
608                                "i586-suse-linux", "", "", triple);
609    // openSUSE 11.1 64 bit
610    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3",
611                                "x86_64-suse-linux", "32", "", triple);
612    // openSUSE 11.2
613    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4",
614                                "i586-suse-linux", "", "", triple);
615    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.4",
616                                "x86_64-suse-linux", "", "", triple);
617    // Arch Linux 2008-06-24
618    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.1",
619                                "i686-pc-linux-gnu", "", "", triple);
620    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.3.1",
621                                "x86_64-unknown-linux-gnu", "", "", triple);
622    // Gentoo x86 2009.1 stable
623    AddGnuCPlusPlusIncludePaths(
624      "/usr/lib/gcc/i686-pc-linux-gnu/4.3.4/include/g++-v4",
625      "i686-pc-linux-gnu", "", "", triple);
626    // Gentoo x86 2009.0 stable
627    AddGnuCPlusPlusIncludePaths(
628      "/usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4",
629      "i686-pc-linux-gnu", "", "", triple);
630    // Gentoo x86 2008.0 stable
631    AddGnuCPlusPlusIncludePaths(
632      "/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4",
633      "i686-pc-linux-gnu", "", "", triple);
634    // Gentoo amd64 stable
635    AddGnuCPlusPlusIncludePaths(
636        "/usr/lib/gcc/x86_64-pc-linux-gnu/4.1.2/include/g++-v4",
637        "i686-pc-linux-gnu", "", "", triple);
638
639    // Gentoo amd64 gcc 4.3.2
640    AddGnuCPlusPlusIncludePaths(
641        "/usr/lib/gcc/x86_64-pc-linux-gnu/4.3.2/include/g++-v4",
642        "x86_64-pc-linux-gnu", "", "", triple);
643
644    // Gentoo amd64 gcc 4.4.3
645    AddGnuCPlusPlusIncludePaths(
646        "/usr/lib/gcc/x86_64-pc-linux-gnu/4.4.3/include/g++-v4",
647        "x86_64-pc-linux-gnu", "32", "", triple);
648
649    break;
650  case llvm::Triple::FreeBSD:
651    // FreeBSD 8.0
652    // FreeBSD 7.3
653    AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2", "", "", "", triple);
654    break;
655  case llvm::Triple::Solaris:
656    // Solaris - Fall though..
657  case llvm::Triple::AuroraUX:
658    // AuroraUX
659    AddGnuCPlusPlusIncludePaths("/opt/gcc4/include/c++/4.2.4",
660                                "i386-pc-solaris2.11", "", "", triple);
661    break;
662  default:
663    break;
664  }
665}
666
667void InitHeaderSearch::AddDefaultSystemIncludePaths(const LangOptions &Lang,
668                                                    const llvm::Triple &triple,
669                                                  bool UseStandardCXXIncludes) {
670  if (Lang.CPlusPlus && UseStandardCXXIncludes)
671    AddDefaultCPlusPlusIncludePaths(triple);
672
673  AddDefaultCIncludePaths(triple);
674
675  // Add the default framework include paths on Darwin.
676  if (triple.getOS() == llvm::Triple::Darwin) {
677    AddPath("/System/Library/Frameworks", System, true, false, true);
678    AddPath("/Library/Frameworks", System, true, false, true);
679  }
680}
681
682/// RemoveDuplicates - If there are duplicate directory entries in the specified
683/// search list, remove the later (dead) ones.
684static void RemoveDuplicates(std::vector<DirectoryLookup> &SearchList,
685                             bool Verbose) {
686  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs;
687  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs;
688  llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps;
689  for (unsigned i = 0; i != SearchList.size(); ++i) {
690    unsigned DirToRemove = i;
691
692    const DirectoryLookup &CurEntry = SearchList[i];
693
694    if (CurEntry.isNormalDir()) {
695      // If this isn't the first time we've seen this dir, remove it.
696      if (SeenDirs.insert(CurEntry.getDir()))
697        continue;
698    } else if (CurEntry.isFramework()) {
699      // If this isn't the first time we've seen this framework dir, remove it.
700      if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir()))
701        continue;
702    } else {
703      assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
704      // If this isn't the first time we've seen this headermap, remove it.
705      if (SeenHeaderMaps.insert(CurEntry.getHeaderMap()))
706        continue;
707    }
708
709    // If we have a normal #include dir/framework/headermap that is shadowed
710    // later in the chain by a system include location, we actually want to
711    // ignore the user's request and drop the user dir... keeping the system
712    // dir.  This is weird, but required to emulate GCC's search path correctly.
713    //
714    // Since dupes of system dirs are rare, just rescan to find the original
715    // that we're nuking instead of using a DenseMap.
716    if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) {
717      // Find the dir that this is the same of.
718      unsigned FirstDir;
719      for (FirstDir = 0; ; ++FirstDir) {
720        assert(FirstDir != i && "Didn't find dupe?");
721
722        const DirectoryLookup &SearchEntry = SearchList[FirstDir];
723
724        // If these are different lookup types, then they can't be the dupe.
725        if (SearchEntry.getLookupType() != CurEntry.getLookupType())
726          continue;
727
728        bool isSame;
729        if (CurEntry.isNormalDir())
730          isSame = SearchEntry.getDir() == CurEntry.getDir();
731        else if (CurEntry.isFramework())
732          isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir();
733        else {
734          assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
735          isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap();
736        }
737
738        if (isSame)
739          break;
740      }
741
742      // If the first dir in the search path is a non-system dir, zap it
743      // instead of the system one.
744      if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User)
745        DirToRemove = FirstDir;
746    }
747
748    if (Verbose) {
749      llvm::errs() << "ignoring duplicate directory \""
750                   << CurEntry.getName() << "\"\n";
751      if (DirToRemove != i)
752        llvm::errs() << "  as it is a non-system directory that duplicates "
753                     << "a system directory\n";
754    }
755
756    // This is reached if the current entry is a duplicate.  Remove the
757    // DirToRemove (usually the current dir).
758    SearchList.erase(SearchList.begin()+DirToRemove);
759    --i;
760  }
761}
762
763
764void InitHeaderSearch::Realize() {
765  // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList.
766  std::vector<DirectoryLookup> SearchList;
767  SearchList = IncludeGroup[Angled];
768  SearchList.insert(SearchList.end(), IncludeGroup[System].begin(),
769                    IncludeGroup[System].end());
770  SearchList.insert(SearchList.end(), IncludeGroup[After].begin(),
771                    IncludeGroup[After].end());
772  RemoveDuplicates(SearchList, Verbose);
773  RemoveDuplicates(IncludeGroup[Quoted], Verbose);
774
775  // Prepend QUOTED list on the search list.
776  SearchList.insert(SearchList.begin(), IncludeGroup[Quoted].begin(),
777                    IncludeGroup[Quoted].end());
778
779
780  bool DontSearchCurDir = false;  // TODO: set to true if -I- is set?
781  Headers.SetSearchPaths(SearchList, IncludeGroup[Quoted].size(),
782                         DontSearchCurDir);
783
784  // If verbose, print the list of directories that will be searched.
785  if (Verbose) {
786    llvm::errs() << "#include \"...\" search starts here:\n";
787    unsigned QuotedIdx = IncludeGroup[Quoted].size();
788    for (unsigned i = 0, e = SearchList.size(); i != e; ++i) {
789      if (i == QuotedIdx)
790        llvm::errs() << "#include <...> search starts here:\n";
791      const char *Name = SearchList[i].getName();
792      const char *Suffix;
793      if (SearchList[i].isNormalDir())
794        Suffix = "";
795      else if (SearchList[i].isFramework())
796        Suffix = " (framework directory)";
797      else {
798        assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup");
799        Suffix = " (headermap)";
800      }
801      llvm::errs() << " " << Name << Suffix << "\n";
802    }
803    llvm::errs() << "End of search list.\n";
804  }
805}
806
807void clang::ApplyHeaderSearchOptions(HeaderSearch &HS,
808                                     const HeaderSearchOptions &HSOpts,
809                                     const LangOptions &Lang,
810                                     const llvm::Triple &Triple) {
811  InitHeaderSearch Init(HS, HSOpts.Verbose, HSOpts.Sysroot);
812
813  // Add the user defined entries.
814  for (unsigned i = 0, e = HSOpts.UserEntries.size(); i != e; ++i) {
815    const HeaderSearchOptions::Entry &E = HSOpts.UserEntries[i];
816    Init.AddPath(E.Path, E.Group, false, E.IsUserSupplied, E.IsFramework,
817                 false);
818  }
819
820  // Add entries from CPATH and friends.
821  Init.AddDelimitedPaths(HSOpts.EnvIncPath);
822  if (Lang.CPlusPlus && Lang.ObjC1)
823    Init.AddDelimitedPaths(HSOpts.ObjCXXEnvIncPath);
824  else if (Lang.CPlusPlus)
825    Init.AddDelimitedPaths(HSOpts.CXXEnvIncPath);
826  else if (Lang.ObjC1)
827    Init.AddDelimitedPaths(HSOpts.ObjCEnvIncPath);
828  else
829    Init.AddDelimitedPaths(HSOpts.CEnvIncPath);
830
831  if (HSOpts.UseBuiltinIncludes) {
832    // Ignore the sys root, we *always* look for clang headers relative to
833    // supplied path.
834    llvm::sys::Path P(HSOpts.ResourceDir);
835    P.appendComponent("include");
836    Init.AddPath(P.str(), System, false, false, false, /*IgnoreSysRoot=*/ true);
837  }
838
839  if (HSOpts.UseStandardIncludes)
840    Init.AddDefaultSystemIncludePaths(Lang, Triple,
841                                      HSOpts.UseStandardCXXIncludes);
842
843  if (HSOpts.UseStandardIncludes)
844    Init.AddDefaultSystemIncludePaths(Lang, Triple,
845                                      HSOpts.UseStandardCXXIncludes);
846
847  Init.Realize();
848}
849