1 //===--- HeaderSearchOptions.h ----------------------------------*- C++ -*-===// 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 #ifndef LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H 11 #define LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H 12 13 #include "clang/Basic/LLVM.h" 14 #include "llvm/ADT/IntrusiveRefCntPtr.h" 15 #include "llvm/ADT/SetVector.h" 16 #include "llvm/ADT/StringRef.h" 17 #include <string> 18 #include <vector> 19 20 namespace clang { 21 22 namespace frontend { 23 /// IncludeDirGroup - Identifiers the group a include entry belongs to, which 24 /// represents its relative positive in the search list. A \#include of a "" 25 /// path starts at the -iquote group, then searches the Angled group, then 26 /// searches the system group, etc. 27 enum IncludeDirGroup { 28 Quoted = 0, ///< '\#include ""' paths, added by 'gcc -iquote'. 29 Angled, ///< Paths for '\#include <>' added by '-I'. 30 IndexHeaderMap, ///< Like Angled, but marks header maps used when 31 /// building frameworks. 32 System, ///< Like Angled, but marks system directories. 33 ExternCSystem, ///< Like System, but headers are implicitly wrapped in 34 /// extern "C". 35 CSystem, ///< Like System, but only used for C. 36 CXXSystem, ///< Like System, but only used for C++. 37 ObjCSystem, ///< Like System, but only used for ObjC. 38 ObjCXXSystem, ///< Like System, but only used for ObjC++. 39 After ///< Like System, but searched after the system directories. 40 }; 41 } 42 43 /// HeaderSearchOptions - Helper class for storing options related to the 44 /// initialization of the HeaderSearch object. 45 class HeaderSearchOptions : public RefCountedBase<HeaderSearchOptions> { 46 public: 47 struct Entry { 48 std::string Path; 49 frontend::IncludeDirGroup Group; 50 unsigned IsFramework : 1; 51 52 /// IgnoreSysRoot - This is false if an absolute path should be treated 53 /// relative to the sysroot, or true if it should always be the absolute 54 /// path. 55 unsigned IgnoreSysRoot : 1; 56 EntryEntry57 Entry(StringRef path, frontend::IncludeDirGroup group, bool isFramework, 58 bool ignoreSysRoot) 59 : Path(path), Group(group), IsFramework(isFramework), 60 IgnoreSysRoot(ignoreSysRoot) {} 61 }; 62 63 struct SystemHeaderPrefix { 64 /// A prefix to be matched against paths in \#include directives. 65 std::string Prefix; 66 67 /// True if paths beginning with this prefix should be treated as system 68 /// headers. 69 bool IsSystemHeader; 70 SystemHeaderPrefixSystemHeaderPrefix71 SystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) 72 : Prefix(Prefix), IsSystemHeader(IsSystemHeader) {} 73 }; 74 75 /// If non-empty, the directory to use as a "virtual system root" for include 76 /// paths. 77 std::string Sysroot; 78 79 /// User specified include entries. 80 std::vector<Entry> UserEntries; 81 82 /// User-specified system header prefixes. 83 std::vector<SystemHeaderPrefix> SystemHeaderPrefixes; 84 85 /// The directory which holds the compiler resource files (builtin includes, 86 /// etc.). 87 std::string ResourceDir; 88 89 /// \brief The directory used for the module cache. 90 std::string ModuleCachePath; 91 92 /// \brief The directory used for a user build. 93 std::string ModuleUserBuildPath; 94 95 /// \brief Whether we should disable the use of the hash string within the 96 /// module cache. 97 /// 98 /// Note: Only used for testing! 99 unsigned DisableModuleHash : 1; 100 101 /// \brief Interpret module maps. This option is implied by full modules. 102 unsigned ModuleMaps : 1; 103 104 /// \brief The interval (in seconds) between pruning operations. 105 /// 106 /// This operation is expensive, because it requires Clang to walk through 107 /// the directory structure of the module cache, stat()'ing and removing 108 /// files. 109 /// 110 /// The default value is large, e.g., the operation runs once a week. 111 unsigned ModuleCachePruneInterval; 112 113 /// \brief The time (in seconds) after which an unused module file will be 114 /// considered unused and will, therefore, be pruned. 115 /// 116 /// When the module cache is pruned, any module file that has not been 117 /// accessed in this many seconds will be removed. The default value is 118 /// large, e.g., a month, to avoid forcing infrequently-used modules to be 119 /// regenerated often. 120 unsigned ModuleCachePruneAfter; 121 122 /// \brief The time in seconds when the build session started. 123 /// 124 /// This time is used by other optimizations in header search and module 125 /// loading. 126 uint64_t BuildSessionTimestamp; 127 128 /// \brief The set of macro names that should be ignored for the purposes 129 /// of computing the module hash. 130 llvm::SetVector<std::string> ModulesIgnoreMacros; 131 132 /// \brief The set of user-provided module-map-files. 133 llvm::SetVector<std::string> ModuleMapFiles; 134 135 /// \brief The set of user-provided virtual filesystem overlay files. 136 std::vector<std::string> VFSOverlayFiles; 137 138 /// Include the compiler builtin includes. 139 unsigned UseBuiltinIncludes : 1; 140 141 /// Include the system standard include search directories. 142 unsigned UseStandardSystemIncludes : 1; 143 144 /// Include the system standard C++ library include search directories. 145 unsigned UseStandardCXXIncludes : 1; 146 147 /// Use libc++ instead of the default libstdc++. 148 unsigned UseLibcxx : 1; 149 150 /// Whether header search information should be output as for -v. 151 unsigned Verbose : 1; 152 153 /// \brief If true, skip verifying input files used by modules if the 154 /// module was already verified during this build session (see 155 /// \c BuildSessionTimestamp). 156 unsigned ModulesValidateOncePerBuildSession : 1; 157 158 /// \brief Whether to validate system input files when a module is loaded. 159 unsigned ModulesValidateSystemHeaders : 1; 160 161 public: 162 HeaderSearchOptions(StringRef _Sysroot = "/") Sysroot(_Sysroot)163 : Sysroot(_Sysroot), DisableModuleHash(0), ModuleMaps(0), 164 ModuleCachePruneInterval(7*24*60*60), 165 ModuleCachePruneAfter(31*24*60*60), 166 BuildSessionTimestamp(0), 167 UseBuiltinIncludes(true), 168 UseStandardSystemIncludes(true), UseStandardCXXIncludes(true), 169 UseLibcxx(false), Verbose(false), 170 ModulesValidateOncePerBuildSession(false), 171 ModulesValidateSystemHeaders(false) {} 172 173 /// AddPath - Add the \p Path path to the specified \p Group list. AddPath(StringRef Path,frontend::IncludeDirGroup Group,bool IsFramework,bool IgnoreSysRoot)174 void AddPath(StringRef Path, frontend::IncludeDirGroup Group, 175 bool IsFramework, bool IgnoreSysRoot) { 176 UserEntries.push_back(Entry(Path, Group, IsFramework, IgnoreSysRoot)); 177 } 178 179 /// AddSystemHeaderPrefix - Override whether \#include directives naming a 180 /// path starting with \p Prefix should be considered as naming a system 181 /// header. AddSystemHeaderPrefix(StringRef Prefix,bool IsSystemHeader)182 void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) { 183 SystemHeaderPrefixes.push_back(SystemHeaderPrefix(Prefix, IsSystemHeader)); 184 } 185 AddVFSOverlayFile(StringRef Name)186 void AddVFSOverlayFile(StringRef Name) { 187 VFSOverlayFiles.push_back(Name); 188 } 189 }; 190 191 } // end namespace clang 192 193 #endif 194