Warning: That file was not part of the compilation database. It may have many parsing errors.

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/CachedHashString.h"
15#include "llvm/ADT/SetVector.h"
16#include "llvm/ADT/StringRef.h"
17#include <cstdint>
18#include <string>
19#include <vector>
20#include <map>
21
22namespace clang {
23
24namespace frontend {
25
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.
31enum IncludeDirGroup {
32 /// '\#include ""' paths, added by 'gcc -iquote'.
33 Quoted = 0,
34
35 /// Paths for '\#include <>' added by '-I'.
36 Angled,
37
38 /// Like Angled, but marks header maps used when building frameworks.
39 IndexHeaderMap,
40
41 /// Like Angled, but marks system directories.
42 System,
43
44 /// Like System, but headers are implicitly wrapped in extern "C".
45 ExternCSystem,
46
47 /// Like System, but only used for C.
48 CSystem,
49
50 /// Like System, but only used for C++.
51 CXXSystem,
52
53 /// Like System, but only used for ObjC.
54 ObjCSystem,
55
56 /// Like System, but only used for ObjC++.
57 ObjCXXSystem,
58
59 /// Like System, but searched after the system directories.
60 After
61};
62
63} // namespace frontend
64
65/// HeaderSearchOptions - Helper class for storing options related to the
66/// initialization of the HeaderSearch object.
67class HeaderSearchOptions {
68public:
69 struct Entry {
70 std::string Path;
71 frontend::IncludeDirGroup Group;
72 unsigned IsFramework : 1;
73
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
76 /// path.
77 unsigned IgnoreSysRoot : 1;
78
79 Entry(StringRef path, frontend::IncludeDirGroup group, bool isFramework,
80 bool ignoreSysRoot)
81 : Path(path), Group(group), IsFramework(isFramework),
82 IgnoreSysRoot(ignoreSysRoot) {}
83 };
84
85 struct SystemHeaderPrefix {
86 /// A prefix to be matched against paths in \#include directives.
87 std::string Prefix;
88
89 /// True if paths beginning with this prefix should be treated as system
90 /// headers.
91 bool IsSystemHeader;
92
93 SystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader)
94 : Prefix(Prefix), IsSystemHeader(IsSystemHeader) {}
95 };
96
97 /// If non-empty, the directory to use as a "virtual system root" for include
98 /// paths.
99 std::string Sysroot;
100
101 /// User specified include entries.
102 std::vector<Entry> UserEntries;
103
104 /// User-specified system header prefixes.
105 std::vector<SystemHeaderPrefix> SystemHeaderPrefixes;
106
107 /// The directory which holds the compiler resource files (builtin includes,
108 /// etc.).
109 std::string ResourceDir;
110
111 /// The directory used for the module cache.
112 std::string ModuleCachePath;
113
114 /// The directory used for a user build.
115 std::string ModuleUserBuildPath;
116
117 /// The mapping of module names to prebuilt module files.
118 std::map<std::string, std::string> PrebuiltModuleFiles;
119
120 /// The directories used to load prebuilt module files.
121 std::vector<std::string> PrebuiltModulePaths;
122
123 /// The module/pch container format.
124 std::string ModuleFormat;
125
126 /// Whether we should disable the use of the hash string within the
127 /// module cache.
128 ///
129 /// Note: Only used for testing!
130 unsigned DisableModuleHash : 1;
131
132 /// Implicit module maps. This option is enabld by default when
133 /// modules is enabled.
134 unsigned ImplicitModuleMaps : 1;
135
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.
140 //
141 /// The home directory is where we look for files named in the module map
142 /// file.
143 unsigned ModuleMapFileHomeIsCwd : 1;
144
145 /// The interval (in seconds) between pruning operations.
146 ///
147 /// This operation is expensive, because it requires Clang to walk through
148 /// the directory structure of the module cache, stat()'ing and removing
149 /// files.
150 ///
151 /// The default value is large, e.g., the operation runs once a week.
152 unsigned ModuleCachePruneInterval = 7 * 24 * 60 * 60;
153
154 /// The time (in seconds) after which an unused module file will be
155 /// considered unused and will, therefore, be pruned.
156 ///
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;
162
163 /// The time in seconds when the build session started.
164 ///
165 /// This time is used by other optimizations in header search and module
166 /// loading.
167 uint64_t BuildSessionTimestamp = 0;
168
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;
172
173 /// The set of user-provided virtual filesystem overlay files.
174 std::vector<std::string> VFSOverlayFiles;
175
176 /// Include the compiler builtin includes.
177 unsigned UseBuiltinIncludes : 1;
178
179 /// Include the system standard include search directories.
180 unsigned UseStandardSystemIncludes : 1;
181
182 /// Include the system standard C++ library include search directories.
183 unsigned UseStandardCXXIncludes : 1;
184
185 /// Use libc++ instead of the default libstdc++.
186 unsigned UseLibcxx : 1;
187
188 /// Whether header search information should be output as for -v.
189 unsigned Verbose : 1;
190
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;
195
196 /// Whether to validate system input files when a module is loaded.
197 unsigned ModulesValidateSystemHeaders : 1;
198
199 /// Whether the module includes debug information (-gmodules).
200 unsigned UseDebugInfo : 1;
201
202 unsigned ModulesValidateDiagnosticOptions : 1;
203
204 unsigned ModulesHashContent : 1;
205
206 HeaderSearchOptions(StringRef _Sysroot = "/")
207 : Sysroot(_Sysroot), ModuleFormat("raw"), DisableModuleHash(false),
208 ImplicitModuleMaps(false), ModuleMapFileHomeIsCwd(false),
209 UseBuiltinIncludes(true), UseStandardSystemIncludes(true),
210 UseStandardCXXIncludes(true), UseLibcxx(false), Verbose(false),
211 ModulesValidateOncePerBuildSession(false),
212 ModulesValidateSystemHeaders(false), UseDebugInfo(false),
213 ModulesValidateDiagnosticOptions(true), ModulesHashContent(false) {}
214
215 /// AddPath - Add the \p Path path to the specified \p Group list.
216 void AddPath(StringRef Path, frontend::IncludeDirGroup Group,
217 bool IsFramework, bool IgnoreSysRoot) {
218 UserEntries.emplace_back(Path, Group, IsFramework, IgnoreSysRoot);
219 }
220
221 /// AddSystemHeaderPrefix - Override whether \#include directives naming a
222 /// path starting with \p Prefix should be considered as naming a system
223 /// header.
224 void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) {
225 SystemHeaderPrefixes.emplace_back(Prefix, IsSystemHeader);
226 }
227
228 void AddVFSOverlayFile(StringRef Name) {
229 VFSOverlayFiles.push_back(Name);
230 }
231
232 void AddPrebuiltModulePath(StringRef Name) {
233 PrebuiltModulePaths.push_back(Name);
234 }
235};
236
237} // namespace clang
238
239#endif // LLVM_CLANG_LEX_HEADERSEARCHOPTIONS_H
240

Warning: That file was not part of the compilation database. It may have many parsing errors.