blob: ad070cdb4773384c5ab6c35ba173d3c86a01fff8 [file] [log] [blame]
//===--- InitHeaderSearch.cpp - Initialize header search paths ----------*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
// This file implements the InitHeaderSearch class.
#include "clang/Frontend/InitHeaderSearch.h"
#include "clang/Lex/HeaderSearch.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/LangOptions.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/System/Path.h"
#include "llvm/Config/config.h"
#include <cstdio>
#include <vector>
using namespace clang;
void InitHeaderSearch::AddPath(const std::string &Path, IncludeDirGroup Group,
bool isCXXAware, bool isUserSupplied,
bool isFramework, bool IgnoreSysRoot) {
assert(!Path.empty() && "can't handle empty path here");
FileManager &FM = Headers.getFileMgr();
// Compute the actual path, taking into consideration -isysroot.
llvm::SmallString<256> MappedPath;
// Handle isysroot.
if (Group == System && !IgnoreSysRoot) {
// FIXME: Portability. This should be a sys::Path interface, this doesn't
// handle things like C:\ right, nor win32 \\network\device\blah.
if (isysroot.size() != 1 || isysroot[0] != '/') // Add isysroot if present.
MappedPath.append(isysroot.begin(), isysroot.end());
MappedPath.append(Path.begin(), Path.end());
// Compute the DirectoryLookup type.
SrcMgr::CharacteristicKind Type;
if (Group == Quoted || Group == Angled)
Type = SrcMgr::C_User;
else if (isCXXAware)
Type = SrcMgr::C_System;
Type = SrcMgr::C_ExternCSystem;
// If the directory exists, add it.
if (const DirectoryEntry *DE = FM.getDirectory(&MappedPath[0],
MappedPath.size())) {
IncludeGroup[Group].push_back(DirectoryLookup(DE, Type, isUserSupplied,
// Check to see if this is an apple-style headermap (which are not allowed to
// be frameworks).
if (!isFramework) {
if (const FileEntry *FE = FM.getFile(&MappedPath[0],
&MappedPath[0]+MappedPath.size())) {
if (const HeaderMap *HM = Headers.CreateHeaderMap(FE)) {
// It is a headermap, add it to the search path.
IncludeGroup[Group].push_back(DirectoryLookup(HM, Type,isUserSupplied));
if (Verbose)
llvm::errs() << "ignoring nonexistent directory \""
<< MappedPath.str() << "\"\n";
void InitHeaderSearch::AddEnvVarPaths(const char *Name) {
const char* at = getenv(Name);
if (!at || *at == 0) // Empty string should not add '.' path.
const char* delim = strchr(at, llvm::sys::PathSeparator);
while (delim != 0) {
if (delim-at == 0)
AddPath(".", Angled, false, true, false);
AddPath(std::string(at, std::string::size_type(delim-at)), Angled, false,
true, false);
at = delim + 1;
delim = strchr(at, llvm::sys::PathSeparator);
if (*at == 0)
AddPath(".", Angled, false, true, false);
AddPath(at, Angled, false, true, false);
void InitHeaderSearch::AddDefaultSystemIncludePaths(const LangOptions &Lang) {
// FIXME: temporary hack: hard-coded paths.
// FIXME: get these from the target?
#ifdef LLVM_ON_WIN32
if (Lang.CPlusPlus) {
// Mingw32 GCC version 4
System, true, false, false);
System, true, false, false);
System, true, false, false);
// Mingw32 GCC version 4
AddPath("C:/mingw/include", System, false, false, false);
if (Lang.CPlusPlus) {
AddPath("/usr/include/c++/4.2.1", System, true, false, false);
AddPath("/usr/include/c++/4.2.1/i686-apple-darwin10", System, true, false,
AddPath("/usr/include/c++/4.2.1/backward", System, true, false, false);
AddPath("/usr/include/c++/4.0.0", System, true, false, false);
AddPath("/usr/include/c++/4.0.0/i686-apple-darwin8", System, true, false,
AddPath("/usr/include/c++/4.0.0/backward", System, true, false, false);
// Ubuntu 7.10 - Gutsy Gibbon
AddPath("/usr/include/c++/4.1.3", System, true, false, false);
AddPath("/usr/include/c++/4.1.3/i486-linux-gnu", System, true, false,
AddPath("/usr/include/c++/4.1.3/backward", System, true, false, false);
// Ubuntu 9.04
AddPath("/usr/include/c++/4.3.3", System, true, false, false);
AddPath("/usr/include/c++/4.3.3/x86_64-linux-gnu/", System, true, false,
AddPath("/usr/include/c++/4.3.3/backward", System, true, false, false);
// Fedora 8
AddPath("/usr/include/c++/4.1.2", System, true, false, false);
AddPath("/usr/include/c++/4.1.2/i386-redhat-linux", System, true, false,
AddPath("/usr/include/c++/4.1.2/backward", System, true, false, false);
// Fedora 9
AddPath("/usr/include/c++/4.3.0", System, true, false, false);
AddPath("/usr/include/c++/4.3.0/i386-redhat-linux", System, true, false,
AddPath("/usr/include/c++/4.3.0/backward", System, true, false, false);
// Fedora 10
AddPath("/usr/include/c++/4.3.2", System, true, false, false);
AddPath("/usr/include/c++/4.3.2/i386-redhat-linux", System, true, false,
AddPath("/usr/include/c++/4.3.2/backward", System, true, false, false);
// openSUSE 11.1
AddPath("/usr/include/c++/4.3", System, true, false, false);
AddPath("/usr/include/c++/4.3/i586-suse-linux", System, true, false,
AddPath("/usr/include/c++/4.3/x86_64-suse-linux", System, true, false,
AddPath("/usr/include/c++/4.3/backward", System, true, false, false);
// openSUSE 11.2
AddPath("/usr/include/c++/4.4", System, true, false, false);
AddPath("/usr/include/c++/4.4/i586-suse-linux", System, true, false,
AddPath("/usr/include/c++/4.4/x86_64-suse-linux", System, true, false,
AddPath("/usr/include/c++/4.4/backward", System, true, false, false);
// Arch Linux 2008-06-24
AddPath("/usr/include/c++/4.3.1", System, true, false, false);
AddPath("/usr/include/c++/4.3.1/i686-pc-linux-gnu", System, true, false,
AddPath("/usr/include/c++/4.3.1/backward", System, true, false, false);
AddPath("/usr/include/c++/4.3.1/x86_64-unknown-linux-gnu", System, true,
false, false);
// Gentoo x86 2009.0 stable
AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4", System,
true, false, false);
"i686-pc-linux-gnu", System, true, false, false);
AddPath(" /usr/lib/gcc/i686-pc-linux-gnu/4.3.2/include/g++-v4/backward",
System, true, false, false);
// Gentoo x86 2008.0 stable
AddPath("/usr/lib/gcc/i686-pc-linux-gnu/4.1.2/include/g++-v4", System,
true, false, false);
"i686-pc-linux-gnu", System, true, false, false);
System, true, false, false);
// Ubuntu 8.10
AddPath("/usr/include/c++/4.3/i486-linux-gnu", System, true, false, false);
// Gentoo amd64 stable
AddPath("/usr/lib/gcc/x86_64-pc-linux-gnu/4.1.2/include/g++-v4", System,
true, false, false);
"i686-pc-linux-gnu", System, true, false, false);
System, true, false, false);
// DragonFly
AddPath("/usr/include/c++/4.1", System, true, false, false);
// FreeBSD
AddPath("/usr/include/c++/4.2", System, true, false, false);
// AuroraUX
AddPath("/opt/gcc4/include/c++/4.2.4", System, true, false, false);
AddPath("/opt/gcc4/include/c++/4.2.4/i386-pc-solaris2.11", System, true, false, false);
AddPath("/usr/local/include", System, false, false, false);
AddPath("/usr/include", System, false, false, false);
AddPath("/System/Library/Frameworks", System, true, false, true);
AddPath("/Library/Frameworks", System, true, false, true);
void InitHeaderSearch::AddDefaultEnvVarPaths(const LangOptions &Lang) {
if (Lang.CPlusPlus && Lang.ObjC1)
else if (Lang.CPlusPlus)
else if (Lang.ObjC1)
/// RemoveDuplicates - If there are duplicate directory entries in the specified
/// search list, remove the later (dead) ones.
static void RemoveDuplicates(std::vector<DirectoryLookup> &SearchList,
bool Verbose) {
llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs;
llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs;
llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps;
for (unsigned i = 0; i != SearchList.size(); ++i) {
unsigned DirToRemove = i;
const DirectoryLookup &CurEntry = SearchList[i];
if (CurEntry.isNormalDir()) {
// If this isn't the first time we've seen this dir, remove it.
if (SeenDirs.insert(CurEntry.getDir()))
} else if (CurEntry.isFramework()) {
// If this isn't the first time we've seen this framework dir, remove it.
if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir()))
} else {
assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
// If this isn't the first time we've seen this headermap, remove it.
if (SeenHeaderMaps.insert(CurEntry.getHeaderMap()))
// If we have a normal #include dir/framework/headermap that is shadowed
// later in the chain by a system include location, we actually want to
// ignore the user's request and drop the user dir... keeping the system
// dir. This is weird, but required to emulate GCC's search path correctly.
// Since dupes of system dirs are rare, just rescan to find the original
// that we're nuking instead of using a DenseMap.
if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) {
// Find the dir that this is the same of.
unsigned FirstDir;
for (FirstDir = 0; ; ++FirstDir) {
assert(FirstDir != i && "Didn't find dupe?");
const DirectoryLookup &SearchEntry = SearchList[FirstDir];
// If these are different lookup types, then they can't be the dupe.
if (SearchEntry.getLookupType() != CurEntry.getLookupType())
bool isSame;
if (CurEntry.isNormalDir())
isSame = SearchEntry.getDir() == CurEntry.getDir();
else if (CurEntry.isFramework())
isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir();
else {
assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap();
if (isSame)
// If the first dir in the search path is a non-system dir, zap it
// instead of the system one.
if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User)
DirToRemove = FirstDir;
if (Verbose) {
fprintf(stderr, "ignoring duplicate directory \"%s\"\n",
if (DirToRemove != i)
fprintf(stderr, " as it is a non-system directory that duplicates"
" a system directory\n");
// This is reached if the current entry is a duplicate. Remove the
// DirToRemove (usually the current dir).
void InitHeaderSearch::Realize() {
// Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList.
std::vector<DirectoryLookup> SearchList;
SearchList = IncludeGroup[Angled];
SearchList.insert(SearchList.end(), IncludeGroup[System].begin(),
SearchList.insert(SearchList.end(), IncludeGroup[After].begin(),
RemoveDuplicates(SearchList, Verbose);
RemoveDuplicates(IncludeGroup[Quoted], Verbose);
// Prepend QUOTED list on the search list.
SearchList.insert(SearchList.begin(), IncludeGroup[Quoted].begin(),
bool DontSearchCurDir = false; // TODO: set to true if -I- is set?
Headers.SetSearchPaths(SearchList, IncludeGroup[Quoted].size(),
// If verbose, print the list of directories that will be searched.
if (Verbose) {
fprintf(stderr, "#include \"...\" search starts here:\n");
unsigned QuotedIdx = IncludeGroup[Quoted].size();
for (unsigned i = 0, e = SearchList.size(); i != e; ++i) {
if (i == QuotedIdx)
fprintf(stderr, "#include <...> search starts here:\n");
const char *Name = SearchList[i].getName();
const char *Suffix;
if (SearchList[i].isNormalDir())
Suffix = "";
else if (SearchList[i].isFramework())
Suffix = " (framework directory)";
else {
assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup");
Suffix = " (headermap)";
fprintf(stderr, " %s%s\n", Name, Suffix);
fprintf(stderr, "End of search list.\n");