InitHeaderSearch.cpp revision 31bc304905ece1072f5029eb821e309aecaf88f4 
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/InitHeaderSearch.h"
15#include "clang/Lex/HeaderSearch.h"
16#include "clang/Basic/FileManager.h"
17#include "clang/Basic/LangOptions.h"
18#include "llvm/ADT/SmallString.h"
19#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/Support/raw_ostream.h"
21#include "llvm/System/Path.h"
22#include "llvm/Config/config.h"
23#include <cstdio>
24using namespace clang;
25
26void InitHeaderSearch::AddPath(const std::string &Path, IncludeDirGroup Group,
27                               bool isCXXAware, bool isUserSupplied,
28                               bool isFramework, bool IgnoreSysRoot) {
29  assert(!Path.empty() && "can't handle empty path here");
30  FileManager &FM = Headers.getFileMgr();
31
32  // Compute the actual path, taking into consideration -isysroot.
33  llvm::SmallString<256> MappedPath;
34
35  // Handle isysroot.
36  if (Group == System && !IgnoreSysRoot) {
37    // FIXME: Portability.  This should be a sys::Path interface, this doesn't
38    // handle things like C:\ right, nor win32 \\network\device\blah.
39    if (isysroot.size() != 1 || isysroot[0] != '/') // Add isysroot if present.
40      MappedPath.append(isysroot.begin(), isysroot.end());
41  }
42
43  MappedPath.append(Path.begin(), Path.end());
44
45  // Compute the DirectoryLookup type.
46  SrcMgr::CharacteristicKind Type;
47  if (Group == Quoted || Group == Angled)
48    Type = SrcMgr::C_User;
49  else if (isCXXAware)
50    Type = SrcMgr::C_System;
51  else
52    Type = SrcMgr::C_ExternCSystem;
53
54
55  // If the directory exists, add it.
56  if (const DirectoryEntry *DE = FM.getDirectory(&MappedPath[0],
57                                                 &MappedPath[0]+
58                                                 MappedPath.size())) {
59    IncludeGroup[Group].push_back(DirectoryLookup(DE, Type, isUserSupplied,
60                                                  isFramework));
61    return;
62  }
63
64  // Check to see if this is an apple-style headermap (which are not allowed to
65  // be frameworks).
66  if (!isFramework) {
67    if (const FileEntry *FE = FM.getFile(&MappedPath[0],
68                                         &MappedPath[0]+MappedPath.size())) {
69      if (const HeaderMap *HM = Headers.CreateHeaderMap(FE)) {
70        // It is a headermap, add it to the search path.
71        IncludeGroup[Group].push_back(DirectoryLookup(HM, Type,isUserSupplied));
72        return;
73      }
74    }
75  }
76
77  if (Verbose)
78    llvm::errs() << "ignoring nonexistent directory \""
79                 << MappedPath.str() << "\"\n";
80}
81
82
83void InitHeaderSearch::AddEnvVarPaths(const char *Name) {
84  const char* at = getenv(Name);
85  if (!at || *at == 0) // Empty string should not add '.' path.
86    return;
87
88  const char* delim = strchr(at, llvm::sys::PathSeparator);
89  while (delim != 0) {
90    if (delim-at == 0)
91      AddPath(".", Angled, false, true, false);
92    else
93      AddPath(std::string(at, std::string::size_type(delim-at)), Angled, false,
94              true, false);
95    at = delim + 1;
96    delim = strchr(at, llvm::sys::PathSeparator);
97  }
98  if (*at == 0)
99    AddPath(".", Angled, false, true, false);
100  else
101    AddPath(at, Angled, false, true, false);
102}
103
104
105void InitHeaderSearch::AddDefaultSystemIncludePaths(const LangOptions &Lang) {
106  // FIXME: temporary hack: hard-coded paths.
107  // FIXME: get these from the target?
108
109#ifdef LLVM_ON_WIN32
110  if (Lang.CPlusPlus) {
111    // Mingw32 GCC version 4
112    AddPath("c:/mingw/lib/gcc/mingw32/4.3.0/include/c++",
113            System, true, false, false);
114    AddPath("c:/mingw/lib/gcc/mingw32/4.3.0/include/c++/mingw32",
115            System, true, false, false);
116    AddPath("c:/mingw/lib/gcc/mingw32/4.3.0/include/c++/backward",
117            System, true, false, false);
118  }
119
120  // Mingw32 GCC version 4
121  AddPath("C:/mingw/include", System, false, false, false);
122#else
123
124  if (Lang.CPlusPlus) {
125    AddPath("/usr/include/c++/4.2.1", System, true, false, false);
126    AddPath("/usr/include/c++/4.2.1/i686-apple-darwin10", System, true, false,
127        false);
128    AddPath("/usr/include/c++/4.2.1/backward", System, true, false, false);
129
130    AddPath("/usr/include/c++/4.0.0", System, true, false, false);
131    AddPath("/usr/include/c++/4.0.0/i686-apple-darwin8", System, true, false,
132        false);
133    AddPath("/usr/include/c++/4.0.0/backward", System, true, false, false);
134
135    // Ubuntu 7.10 - Gutsy Gibbon
136    AddPath("/usr/include/c++/4.1.3", System, true, false, false);
137    AddPath("/usr/include/c++/4.1.3/i486-linux-gnu", System, true, false,
138        false);
139    AddPath("/usr/include/c++/4.1.3/backward", System, true, false, false);
140
141    // Ubuntu 9.04
142    AddPath("/usr/include/c++/4.3.3", System, true, false, false);
143    AddPath("/usr/include/c++/4.3.3/x86_64-linux-gnu/", System, true, false,
144        false);
145    AddPath("/usr/include/c++/4.3.3/backward", System, true, false, false);
146
147    // Fedora 8
148    AddPath("/usr/include/c++/4.1.2", System, true, false, false);
149    AddPath("/usr/include/c++/4.1.2/i386-redhat-linux", System, true, false,
150        false);
151    AddPath("/usr/include/c++/4.1.2/backward", System, true, false, false);
152
153    // Fedora 9
154    AddPath("/usr/include/c++/4.3.0", System, true, false, false);
155    AddPath("/usr/include/c++/4.3.0/i386-redhat-linux", System, true, false,
156        false);
157    AddPath("/usr/include/c++/4.3.0/backward", System, true, false, false);
158
159    // Fedora 10
160    AddPath("/usr/include/c++/4.3.2", System, true, false, false);
161    AddPath("/usr/include/c++/4.3.2/i386-redhat-linux", System, true, false,
162        false);
163    AddPath("/usr/include/c++/4.3.2/backward", System, true, false, false);
164
165    // openSUSE 11.1
166    AddPath("/usr/include/c++/4.3", System, true, false, false);
167    AddPath("/usr/include/c++/4.3/i586-suse-linux", System, true, false,
168        false);
169    AddPath("/usr/include/c++/4.3/x86_64-suse-linux", System, true, false,
170        false);
171    AddPath("/usr/include/c++/4.3/backward", System, true, false, false);
172
173    // openSUSE 11.2
174    AddPath("/usr/include/c++/4.4", System, true, false, false);
175    AddPath("/usr/include/c++/4.4/i586-suse-linux", System, true, false,
176        false);
177    AddPath("/usr/include/c++/4.4/x86_64-suse-linux", System, true, false,
178        false);
179    AddPath("/usr/include/c++/4.4/backward", System, true, false, false);
180
181    // Arch Linux 2008-06-24
182    AddPath("/usr/include/c++/4.3.1", System, true, false, false);
183    AddPath("/usr/include/c++/4.3.1/i686-pc-linux-gnu", System, true, false,
184        false);
185    AddPath("/usr/include/c++/4.3.1/backward", System, true, false, false);
186    AddPath("/usr/include/c++/4.3.1/x86_64-unknown-linux-gnu", System, true,
187        false, false);
188
189    // Gentoo x86 2009.0 stable
190    AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4", System,
191            true, false, false);
192    AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4/"
193            "i686-pc-linux-gnu", System, true, false, false);
194    AddPath(" /usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4/backward",
195            System, true, false, false);
196
197    // Gentoo x86 2008.0 stable
198    AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4", System,
199            true, false, false);
200    AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4/"
201            "i686-pc-linux-gnu", System, true, false, false);
202    AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4/backward",
203            System, true, false, false);
204
205    // Ubuntu 8.10
206    AddPath("/usr/include/c++/4.3/i486-linux-gnu", System, true, false, false);
207
208    // Gentoo amd64 stable
209    AddPath("/usr/lib/gcc/x86_64-pc-linux-gnu/4.1.2/include/g++-v4", System,
210            true, false, false);
211    AddPath("/usr/lib/gcc/x86_64-pc-linux-gnu/4.1.2/include/g++-v4/"
212            "i686-pc-linux-gnu", System, true, false, false);
213    AddPath("/usr/lib/gcc/x86_64-pc-linux-gnu/4.1.2/include/g++-v4/backward",
214            System, true, false, false);
215
216    // DragonFly
217    AddPath("/usr/include/c++/4.1", System, true, false, false);
218
219    // FreeBSD
220    AddPath("/usr/include/c++/4.2", System, true, false, false);
221
222    // AuroraUX
223    AddPath("/opt/gcc4/include/c++/4.2.4", System, true, false, false);
224    AddPath("/opt/gcc4/include/c++/4.2.4/i386-pc-solaris2.11", System, true, false, false);
225  }
226
227  AddPath("/usr/local/include", System, false, false, false);
228
229  AddPath("/usr/include", System, false, false, false);
230  AddPath("/System/Library/Frameworks", System, true, false, true);
231  AddPath("/Library/Frameworks", System, true, false, true);
232#endif
233}
234
235void InitHeaderSearch::AddDefaultEnvVarPaths(const LangOptions &Lang) {
236  AddEnvVarPaths("CPATH");
237  if (Lang.CPlusPlus && Lang.ObjC1)
238    AddEnvVarPaths("OBJCPLUS_INCLUDE_PATH");
239  else if (Lang.CPlusPlus)
240    AddEnvVarPaths("CPLUS_INCLUDE_PATH");
241  else if (Lang.ObjC1)
242    AddEnvVarPaths("OBJC_INCLUDE_PATH");
243  else
244    AddEnvVarPaths("C_INCLUDE_PATH");
245}
246
247
248/// RemoveDuplicates - If there are duplicate directory entries in the specified
249/// search list, remove the later (dead) ones.
250static void RemoveDuplicates(std::vector<DirectoryLookup> &SearchList,
251                             bool Verbose) {
252  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs;
253  llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs;
254  llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps;
255  for (unsigned i = 0; i != SearchList.size(); ++i) {
256    unsigned DirToRemove = i;
257
258    const DirectoryLookup &CurEntry = SearchList[i];
259
260    if (CurEntry.isNormalDir()) {
261      // If this isn't the first time we've seen this dir, remove it.
262      if (SeenDirs.insert(CurEntry.getDir()))
263        continue;
264    } else if (CurEntry.isFramework()) {
265      // If this isn't the first time we've seen this framework dir, remove it.
266      if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir()))
267        continue;
268    } else {
269      assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
270      // If this isn't the first time we've seen this headermap, remove it.
271      if (SeenHeaderMaps.insert(CurEntry.getHeaderMap()))
272        continue;
273    }
274
275    // If we have a normal #include dir/framework/headermap that is shadowed
276    // later in the chain by a system include location, we actually want to
277    // ignore the user's request and drop the user dir... keeping the system
278    // dir.  This is weird, but required to emulate GCC's search path correctly.
279    //
280    // Since dupes of system dirs are rare, just rescan to find the original
281    // that we're nuking instead of using a DenseMap.
282    if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) {
283      // Find the dir that this is the same of.
284      unsigned FirstDir;
285      for (FirstDir = 0; ; ++FirstDir) {
286        assert(FirstDir != i && "Didn't find dupe?");
287
288        const DirectoryLookup &SearchEntry = SearchList[FirstDir];
289
290        // If these are different lookup types, then they can't be the dupe.
291        if (SearchEntry.getLookupType() != CurEntry.getLookupType())
292          continue;
293
294        bool isSame;
295        if (CurEntry.isNormalDir())
296          isSame = SearchEntry.getDir() == CurEntry.getDir();
297        else if (CurEntry.isFramework())
298          isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir();
299        else {
300          assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
301          isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap();
302        }
303
304        if (isSame)
305          break;
306      }
307
308      // If the first dir in the search path is a non-system dir, zap it
309      // instead of the system one.
310      if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User)
311        DirToRemove = FirstDir;
312    }
313
314    if (Verbose) {
315      fprintf(stderr, "ignoring duplicate directory \"%s\"\n",
316              CurEntry.getName());
317      if (DirToRemove != i)
318        fprintf(stderr, "  as it is a non-system directory that duplicates"
319                " a system directory\n");
320    }
321
322    // This is reached if the current entry is a duplicate.  Remove the
323    // DirToRemove (usually the current dir).
324    SearchList.erase(SearchList.begin()+DirToRemove);
325    --i;
326  }
327}
328
329
330void InitHeaderSearch::Realize() {
331  // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList.
332  std::vector<DirectoryLookup> SearchList;
333  SearchList = IncludeGroup[Angled];
334  SearchList.insert(SearchList.end(), IncludeGroup[System].begin(),
335                    IncludeGroup[System].end());
336  SearchList.insert(SearchList.end(), IncludeGroup[After].begin(),
337                    IncludeGroup[After].end());
338  RemoveDuplicates(SearchList, Verbose);
339  RemoveDuplicates(IncludeGroup[Quoted], Verbose);
340
341  // Prepend QUOTED list on the search list.
342  SearchList.insert(SearchList.begin(), IncludeGroup[Quoted].begin(),
343                    IncludeGroup[Quoted].end());
344
345
346  bool DontSearchCurDir = false;  // TODO: set to true if -I- is set?
347  Headers.SetSearchPaths(SearchList, IncludeGroup[Quoted].size(),
348                         DontSearchCurDir);
349
350  // If verbose, print the list of directories that will be searched.
351  if (Verbose) {
352    fprintf(stderr, "#include \"...\" search starts here:\n");
353    unsigned QuotedIdx = IncludeGroup[Quoted].size();
354    for (unsigned i = 0, e = SearchList.size(); i != e; ++i) {
355      if (i == QuotedIdx)
356        fprintf(stderr, "#include <...> search starts here:\n");
357      const char *Name = SearchList[i].getName();
358      const char *Suffix;
359      if (SearchList[i].isNormalDir())
360        Suffix = "";
361      else if (SearchList[i].isFramework())
362        Suffix = " (framework directory)";
363      else {
364        assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup");
365        Suffix = " (headermap)";
366      }
367      fprintf(stderr, " %s%s\n", Name, Suffix);
368    }
369    fprintf(stderr, "End of search list.\n");
370  }
371}
372
373