1 //===- HeaderSearchOptions.h ------------------------------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H
10 #define LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H
12 #include "clang/Basic/LLVM.h"
13 #include "llvm/ADT/CachedHashString.h"
14 #include "llvm/ADT/Hashing.h"
15 #include "llvm/ADT/SetVector.h"
16 #include "llvm/ADT/StringRef.h"
26 /// IncludeDirGroup - Identifies the group an include Entry belongs to,
27 /// representing its relative positive in the search list.
28 /// \#include directives whose paths are enclosed by string quotes ("")
29 /// start searching at the Quoted group (specified by '-iquote'),
30 /// then search the Angled group, then the System group, etc.
31 enum IncludeDirGroup {
32 /// '\#include ""' paths, added by 'gcc -iquote'.
35 /// Paths for '\#include <>' added by '-I'.
38 /// Like Angled, but marks header maps used when building frameworks.
41 /// Like Angled, but marks system directories.
44 /// Like System, but headers are implicitly wrapped in extern "C".
47 /// Like System, but only used for C.
50 /// Like System, but only used for C++.
53 /// Like System, but only used for ObjC.
56 /// Like System, but only used for ObjC++.
59 /// Like System, but searched after the system directories.
63 } // namespace frontend
65 /// HeaderSearchOptions - Helper class for storing options related to the
66 /// initialization of the HeaderSearch object.
67 class HeaderSearchOptions {
71 frontend::IncludeDirGroup Group;
72 unsigned IsFramework : 1;
74 /// IgnoreSysRoot - This is false if an absolute path should be treated
75 /// relative to the sysroot, or true if it should always be the absolute
77 unsigned IgnoreSysRoot : 1;
79 Entry(StringRef path, frontend::IncludeDirGroup group, bool isFramework,
81 : Path(path), Group(group), IsFramework(isFramework),
82 IgnoreSysRoot(ignoreSysRoot) {}
85 struct SystemHeaderPrefix {
86 /// A prefix to be matched against paths in \#include directives.
89 /// True if paths beginning with this prefix should be treated as system
93 SystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader)
94 : Prefix(Prefix), IsSystemHeader(IsSystemHeader) {}
97 /// If non-empty, the directory to use as a "virtual system root" for include
101 /// User specified include entries.
102 std::vector<Entry> UserEntries;
104 /// User-specified system header prefixes.
105 std::vector<SystemHeaderPrefix> SystemHeaderPrefixes;
107 /// The directory which holds the compiler resource files (builtin includes,
109 std::string ResourceDir;
111 /// The directory used for the module cache.
112 std::string ModuleCachePath;
114 /// The directory used for a user build.
115 std::string ModuleUserBuildPath;
117 /// The mapping of module names to prebuilt module files.
118 std::map<std::string, std::string> PrebuiltModuleFiles;
120 /// The directories used to load prebuilt module files.
121 std::vector<std::string> PrebuiltModulePaths;
123 /// The module/pch container format.
124 std::string ModuleFormat;
126 /// Whether we should disable the use of the hash string within the
129 /// Note: Only used for testing!
130 unsigned DisableModuleHash : 1;
132 /// Implicit module maps. This option is enabld by default when
133 /// modules is enabled.
134 unsigned ImplicitModuleMaps : 1;
136 /// Set the 'home directory' of a module map file to the current
137 /// working directory (or the home directory of the module map file that
138 /// contained the 'extern module' directive importing this module map file
139 /// if any) rather than the directory containing the module map file.
141 /// The home directory is where we look for files named in the module map
143 unsigned ModuleMapFileHomeIsCwd : 1;
145 /// The interval (in seconds) between pruning operations.
147 /// This operation is expensive, because it requires Clang to walk through
148 /// the directory structure of the module cache, stat()'ing and removing
151 /// The default value is large, e.g., the operation runs once a week.
152 unsigned ModuleCachePruneInterval = 7 * 24 * 60 * 60;
154 /// The time (in seconds) after which an unused module file will be
155 /// considered unused and will, therefore, be pruned.
157 /// When the module cache is pruned, any module file that has not been
158 /// accessed in this many seconds will be removed. The default value is
159 /// large, e.g., a month, to avoid forcing infrequently-used modules to be
160 /// regenerated often.
161 unsigned ModuleCachePruneAfter = 31 * 24 * 60 * 60;
163 /// The time in seconds when the build session started.
165 /// This time is used by other optimizations in header search and module
167 uint64_t BuildSessionTimestamp = 0;
169 /// The set of macro names that should be ignored for the purposes
170 /// of computing the module hash.
171 llvm::SmallSetVector<llvm::CachedHashString, 16> ModulesIgnoreMacros;
173 /// The set of user-provided virtual filesystem overlay files.
174 std::vector<std::string> VFSOverlayFiles;
176 /// Include the compiler builtin includes.
177 unsigned UseBuiltinIncludes : 1;
179 /// Include the system standard include search directories.
180 unsigned UseStandardSystemIncludes : 1;
182 /// Include the system standard C++ library include search directories.
183 unsigned UseStandardCXXIncludes : 1;
185 /// Use libc++ instead of the default libstdc++.
186 unsigned UseLibcxx : 1;
188 /// Whether header search information should be output as for -v.
189 unsigned Verbose : 1;
191 /// If true, skip verifying input files used by modules if the
192 /// module was already verified during this build session (see
193 /// \c BuildSessionTimestamp).
194 unsigned ModulesValidateOncePerBuildSession : 1;
196 /// Whether to validate system input files when a module is loaded.
197 unsigned ModulesValidateSystemHeaders : 1;
199 // Whether the content of input files should be hashed and used to
200 // validate consistency.
201 unsigned ValidateASTInputFilesContent : 1;
203 /// Whether the module includes debug information (-gmodules).
204 unsigned UseDebugInfo : 1;
206 unsigned ModulesValidateDiagnosticOptions : 1;
208 unsigned ModulesHashContent : 1;
210 /// Whether we should include all things that could impact the module in the
213 /// This includes things like the full header search path, and enabled
215 unsigned ModulesStrictContextHash : 1;
217 HeaderSearchOptions(StringRef _Sysroot = "/")
218 : Sysroot(_Sysroot), ModuleFormat("raw"), DisableModuleHash(false),
219 ImplicitModuleMaps(false), ModuleMapFileHomeIsCwd(false),
220 UseBuiltinIncludes(true), UseStandardSystemIncludes(true),
221 UseStandardCXXIncludes(true), UseLibcxx(false), Verbose(false),
222 ModulesValidateOncePerBuildSession(false),
223 ModulesValidateSystemHeaders(false),
224 ValidateASTInputFilesContent(false), UseDebugInfo(false),
225 ModulesValidateDiagnosticOptions(true), ModulesHashContent(false),
226 ModulesStrictContextHash(false) {}
228 /// AddPath - Add the \p Path path to the specified \p Group list.
229 void AddPath(StringRef Path, frontend::IncludeDirGroup Group,
230 bool IsFramework, bool IgnoreSysRoot) {
231 UserEntries.emplace_back(Path, Group, IsFramework, IgnoreSysRoot);
234 /// AddSystemHeaderPrefix - Override whether \#include directives naming a
235 /// path starting with \p Prefix should be considered as naming a system
237 void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) {
238 SystemHeaderPrefixes.emplace_back(Prefix, IsSystemHeader);
241 void AddVFSOverlayFile(StringRef Name) {
242 VFSOverlayFiles.push_back(Name);
245 void AddPrebuiltModulePath(StringRef Name) {
246 PrebuiltModulePaths.push_back(Name);
250 inline llvm::hash_code hash_value(const HeaderSearchOptions::Entry &E) {
251 return llvm::hash_combine(E.Path, E.Group, E.IsFramework, E.IgnoreSysRoot);
254 inline llvm::hash_code
255 hash_value(const HeaderSearchOptions::SystemHeaderPrefix &SHP) {
256 return llvm::hash_combine(SHP.Prefix, SHP.IsSystemHeader);
261 #endif // LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H