InitHeaderSearch.cpp revision 193326
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/System/Path.h" 21#include "llvm/Config/config.h" 22#include <cstdio> 23#include <vector> 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 fprintf(stderr, "ignoring nonexistent directory \"%s\"\n", 79 MappedPath.c_str()); 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 // Fedora 8 142 AddPath("/usr/include/c++/4.1.2", System, true, false, false); 143 AddPath("/usr/include/c++/4.1.2/i386-redhat-linux", System, true, false, 144 false); 145 AddPath("/usr/include/c++/4.1.2/backward", System, true, false, false); 146 147 // Fedora 9 148 AddPath("/usr/include/c++/4.3.0", System, true, false, false); 149 AddPath("/usr/include/c++/4.3.0/i386-redhat-linux", System, true, false, 150 false); 151 AddPath("/usr/include/c++/4.3.0/backward", System, true, false, false); 152 153 // Fedora 10 154 AddPath("/usr/include/c++/4.3.2", System, true, false, false); 155 AddPath("/usr/include/c++/4.3.2/i386-redhat-linux", System, true, false, 156 false); 157 AddPath("/usr/include/c++/4.3.2/backward", System, true, false, false); 158 159 // Arch Linux 2008-06-24 160 AddPath("/usr/include/c++/4.3.1", System, true, false, false); 161 AddPath("/usr/include/c++/4.3.1/i686-pc-linux-gnu", System, true, false, 162 false); 163 AddPath("/usr/include/c++/4.3.1/backward", System, true, false, false); 164 AddPath("/usr/include/c++/4.3.1/x86_64-unknown-linux-gnu", System, true, 165 false, false); 166 167 // Gentoo x86 stable 168 AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4", System, 169 true, false, false); 170 AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4/" 171 "i686-pc-linux-gnu", System, true, false, false); 172 AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4/backward", 173 System, true, false, false); 174 175 // DragonFly 176 AddPath("/usr/include/c++/4.1", System, true, false, false); 177 178 // FreeBSD 179 AddPath("/usr/include/c++/4.2", System, true, false, false); 180 } 181 182 AddPath("/usr/local/include", System, false, false, false); 183 184 AddPath("/usr/include", System, false, false, false); 185 AddPath("/System/Library/Frameworks", System, true, false, true); 186 AddPath("/Library/Frameworks", System, true, false, true); 187#endif 188} 189 190void InitHeaderSearch::AddDefaultEnvVarPaths(const LangOptions &Lang) { 191 AddEnvVarPaths("CPATH"); 192 if (Lang.CPlusPlus && Lang.ObjC1) 193 AddEnvVarPaths("OBJCPLUS_INCLUDE_PATH"); 194 else if (Lang.CPlusPlus) 195 AddEnvVarPaths("CPLUS_INCLUDE_PATH"); 196 else if (Lang.ObjC1) 197 AddEnvVarPaths("OBJC_INCLUDE_PATH"); 198 else 199 AddEnvVarPaths("C_INCLUDE_PATH"); 200} 201 202 203/// RemoveDuplicates - If there are duplicate directory entries in the specified 204/// search list, remove the later (dead) ones. 205static void RemoveDuplicates(std::vector<DirectoryLookup> &SearchList, 206 bool Verbose) { 207 llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs; 208 llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs; 209 llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps; 210 for (unsigned i = 0; i != SearchList.size(); ++i) { 211 unsigned DirToRemove = i; 212 213 const DirectoryLookup &CurEntry = SearchList[i]; 214 215 if (CurEntry.isNormalDir()) { 216 // If this isn't the first time we've seen this dir, remove it. 217 if (SeenDirs.insert(CurEntry.getDir())) 218 continue; 219 } else if (CurEntry.isFramework()) { 220 // If this isn't the first time we've seen this framework dir, remove it. 221 if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir())) 222 continue; 223 } else { 224 assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?"); 225 // If this isn't the first time we've seen this headermap, remove it. 226 if (SeenHeaderMaps.insert(CurEntry.getHeaderMap())) 227 continue; 228 } 229 230 // If we have a normal #include dir/framework/headermap that is shadowed 231 // later in the chain by a system include location, we actually want to 232 // ignore the user's request and drop the user dir... keeping the system 233 // dir. This is weird, but required to emulate GCC's search path correctly. 234 // 235 // Since dupes of system dirs are rare, just rescan to find the original 236 // that we're nuking instead of using a DenseMap. 237 if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) { 238 // Find the dir that this is the same of. 239 unsigned FirstDir; 240 for (FirstDir = 0; ; ++FirstDir) { 241 assert(FirstDir != i && "Didn't find dupe?"); 242 243 const DirectoryLookup &SearchEntry = SearchList[FirstDir]; 244 245 // If these are different lookup types, then they can't be the dupe. 246 if (SearchEntry.getLookupType() != CurEntry.getLookupType()) 247 continue; 248 249 bool isSame; 250 if (CurEntry.isNormalDir()) 251 isSame = SearchEntry.getDir() == CurEntry.getDir(); 252 else if (CurEntry.isFramework()) 253 isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir(); 254 else { 255 assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?"); 256 isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap(); 257 } 258 259 if (isSame) 260 break; 261 } 262 263 // If the first dir in the search path is a non-system dir, zap it 264 // instead of the system one. 265 if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User) 266 DirToRemove = FirstDir; 267 } 268 269 if (Verbose) { 270 fprintf(stderr, "ignoring duplicate directory \"%s\"\n", 271 CurEntry.getName()); 272 if (DirToRemove != i) 273 fprintf(stderr, " as it is a non-system directory that duplicates" 274 " a system directory\n"); 275 } 276 277 // This is reached if the current entry is a duplicate. Remove the 278 // DirToRemove (usually the current dir). 279 SearchList.erase(SearchList.begin()+DirToRemove); 280 --i; 281 } 282} 283 284 285void InitHeaderSearch::Realize() { 286 // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList. 287 std::vector<DirectoryLookup> SearchList; 288 SearchList = IncludeGroup[Angled]; 289 SearchList.insert(SearchList.end(), IncludeGroup[System].begin(), 290 IncludeGroup[System].end()); 291 SearchList.insert(SearchList.end(), IncludeGroup[After].begin(), 292 IncludeGroup[After].end()); 293 RemoveDuplicates(SearchList, Verbose); 294 RemoveDuplicates(IncludeGroup[Quoted], Verbose); 295 296 // Prepend QUOTED list on the search list. 297 SearchList.insert(SearchList.begin(), IncludeGroup[Quoted].begin(), 298 IncludeGroup[Quoted].end()); 299 300 301 bool DontSearchCurDir = false; // TODO: set to true if -I- is set? 302 Headers.SetSearchPaths(SearchList, IncludeGroup[Quoted].size(), 303 DontSearchCurDir); 304 305 // If verbose, print the list of directories that will be searched. 306 if (Verbose) { 307 fprintf(stderr, "#include \"...\" search starts here:\n"); 308 unsigned QuotedIdx = IncludeGroup[Quoted].size(); 309 for (unsigned i = 0, e = SearchList.size(); i != e; ++i) { 310 if (i == QuotedIdx) 311 fprintf(stderr, "#include <...> search starts here:\n"); 312 const char *Name = SearchList[i].getName(); 313 const char *Suffix; 314 if (SearchList[i].isNormalDir()) 315 Suffix = ""; 316 else if (SearchList[i].isFramework()) 317 Suffix = " (framework directory)"; 318 else { 319 assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup"); 320 Suffix = " (headermap)"; 321 } 322 fprintf(stderr, " %s%s\n", Name, Suffix); 323 } 324 fprintf(stderr, "End of search list.\n"); 325 } 326} 327 328