1 //===--- HeaderSearch.h - Resolve Header File Locations ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the HeaderSearch interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_LEX_HEADERSEARCH_H
15 #define LLVM_CLANG_LEX_HEADERSEARCH_H
17 #include "clang/Lex/DirectoryLookup.h"
18 #include "clang/Lex/ModuleMap.h"
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/IntrusiveRefCntPtr.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/StringSet.h"
23 #include "llvm/Support/Allocator.h"
29 class DiagnosticsEngine;
30 class ExternalPreprocessorSource;
33 class HeaderSearchOptions;
37 /// \brief The preprocessor keeps track of this information for each
38 /// file that is \#included.
39 struct HeaderFileInfo {
40 /// \brief True if this is a \#import'd or \#pragma once file.
41 unsigned isImport : 1;
43 /// \brief True if this is a \#pragma once file.
44 unsigned isPragmaOnce : 1;
46 /// DirInfo - Keep track of whether this is a system header, and if so,
47 /// whether it is C++ clean or not. This can be set by the include paths or
48 /// by \#pragma gcc system_header. This is an instance of
49 /// SrcMgr::CharacteristicKind.
52 /// \brief Whether this header file info was supplied by an external source,
53 /// and has not changed since.
54 unsigned External : 1;
56 /// \brief Whether this header is part of a module.
57 unsigned isModuleHeader : 1;
59 /// \brief Whether this header is part of the module that we are building.
60 unsigned isCompilingModuleHeader : 1;
62 /// \brief Whether this structure is considered to already have been
63 /// "resolved", meaning that it was loaded from the external source.
64 unsigned Resolved : 1;
66 /// \brief Whether this is a header inside a framework that is currently
69 /// When a framework is being built, the headers have not yet been placed
70 /// into the appropriate framework subdirectories, and therefore are
71 /// provided via a header map. This bit indicates when this is one of
72 /// those framework headers.
73 unsigned IndexHeaderMapHeader : 1;
75 /// \brief Whether this file has been looked up as a header.
78 /// \brief The number of times the file has been included already.
79 unsigned short NumIncludes;
81 /// \brief The ID number of the controlling macro.
83 /// This ID number will be non-zero when there is a controlling
84 /// macro whose IdentifierInfo may not yet have been loaded from
86 unsigned ControllingMacroID;
88 /// If this file has a \#ifndef XXX (or equivalent) guard that
89 /// protects the entire contents of the file, this is the identifier
90 /// for the macro that controls whether or not it has any effect.
92 /// Note: Most clients should use getControllingMacro() to access
93 /// the controlling macro of this header, since
94 /// getControllingMacro() is able to load a controlling macro from
96 const IdentifierInfo *ControllingMacro;
98 /// \brief If this header came from a framework include, this is the name
103 : isImport(false), isPragmaOnce(false), DirInfo(SrcMgr::C_User),
104 External(false), isModuleHeader(false), isCompilingModuleHeader(false),
105 Resolved(false), IndexHeaderMapHeader(false), IsValid(0),
106 NumIncludes(0), ControllingMacroID(0), ControllingMacro(nullptr) {}
108 /// \brief Retrieve the controlling macro for this header file, if
110 const IdentifierInfo *
111 getControllingMacro(ExternalPreprocessorSource *External);
113 /// \brief Determine whether this is a non-default header file info, e.g.,
114 /// it corresponds to an actual header we've included or tried to include.
115 bool isNonDefault() const {
116 return isImport || isPragmaOnce || NumIncludes || ControllingMacro ||
121 /// \brief An external source of header file information, which may supply
122 /// information about header files already included.
123 class ExternalHeaderFileInfoSource {
125 virtual ~ExternalHeaderFileInfoSource();
127 /// \brief Retrieve the header file information for the given file entry.
129 /// \returns Header file information for the given file entry, with the
130 /// \c External bit set. If the file entry is not known, return a
131 /// default-constructed \c HeaderFileInfo.
132 virtual HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) = 0;
135 /// \brief Encapsulates the information needed to find the file referenced
136 /// by a \#include or \#include_next, (sub-)framework lookup, etc.
138 /// This structure is used to record entries in our framework cache.
139 struct FrameworkCacheEntry {
140 /// The directory entry which should be used for the cached framework.
141 const DirectoryEntry *Directory;
143 /// Whether this framework has been "user-specified" to be treated as if it
144 /// were a system framework (even if it was found outside a system framework
146 bool IsUserSpecifiedSystemFramework;
149 /// \brief Header-search options used to initialize this header search.
150 std::shared_ptr<HeaderSearchOptions> HSOpts;
152 DiagnosticsEngine &Diags;
153 FileManager &FileMgr;
154 /// \#include search path information. Requests for \#include "x" search the
155 /// directory of the \#including file first, then each directory in SearchDirs
156 /// consecutively. Requests for <x> search the current dir first, then each
157 /// directory in SearchDirs, starting at AngledDirIdx, consecutively. If
158 /// NoCurDirSearch is true, then the check for the file in the current
159 /// directory is suppressed.
160 std::vector<DirectoryLookup> SearchDirs;
161 unsigned AngledDirIdx;
162 unsigned SystemDirIdx;
165 /// \brief \#include prefixes for which the 'system header' property is
168 /// For a \#include "x" or \#include \<x> directive, the last string in this
169 /// list which is a prefix of 'x' determines whether the file is treated as
171 std::vector<std::pair<std::string, bool> > SystemHeaderPrefixes;
173 /// \brief The path to the module cache.
174 std::string ModuleCachePath;
176 /// \brief All of the preprocessor-specific data about files that are
177 /// included, indexed by the FileEntry's UID.
178 mutable std::vector<HeaderFileInfo> FileInfo;
180 /// Keeps track of each lookup performed by LookupFile.
181 struct LookupFileCacheInfo {
182 /// Starting index in SearchDirs that the cached search was performed from.
183 /// If there is a hit and this value doesn't match the current query, the
184 /// cache has to be ignored.
186 /// The entry in SearchDirs that satisfied the query.
188 /// This is non-null if the original filename was mapped to a framework
189 /// include via a headermap.
190 const char *MappedName;
192 /// Default constructor -- Initialize all members with zero.
193 LookupFileCacheInfo(): StartIdx(0), HitIdx(0), MappedName(nullptr) {}
195 void reset(unsigned StartIdx) {
196 this->StartIdx = StartIdx;
197 this->MappedName = nullptr;
200 llvm::StringMap<LookupFileCacheInfo, llvm::BumpPtrAllocator> LookupFileCache;
202 /// \brief Collection mapping a framework or subframework
203 /// name like "Carbon" to the Carbon.framework directory.
204 llvm::StringMap<FrameworkCacheEntry, llvm::BumpPtrAllocator> FrameworkMap;
206 /// IncludeAliases - maps include file names (including the quotes or
207 /// angle brackets) to other include file names. This is used to support the
208 /// include_alias pragma for Microsoft compatibility.
209 typedef llvm::StringMap<std::string, llvm::BumpPtrAllocator>
211 std::unique_ptr<IncludeAliasMap> IncludeAliases;
213 /// HeaderMaps - This is a mapping from FileEntry -> HeaderMap, uniquing
214 /// headermaps. This vector owns the headermap.
215 std::vector<std::pair<const FileEntry*, const HeaderMap*> > HeaderMaps;
217 /// \brief The mapping between modules and headers.
218 mutable ModuleMap ModMap;
220 /// \brief Describes whether a given directory has a module map in it.
221 llvm::DenseMap<const DirectoryEntry *, bool> DirectoryHasModuleMap;
223 /// \brief Set of module map files we've already loaded, and a flag indicating
224 /// whether they were valid or not.
225 llvm::DenseMap<const FileEntry *, bool> LoadedModuleMaps;
227 /// \brief Uniqued set of framework names, which is used to track which
228 /// headers were included as framework headers.
229 llvm::StringSet<llvm::BumpPtrAllocator> FrameworkNames;
231 /// \brief Entity used to resolve the identifier IDs of controlling
232 /// macros into IdentifierInfo pointers, and keep the identifire up to date,
234 ExternalPreprocessorSource *ExternalLookup;
236 /// \brief Entity used to look up stored header file information.
237 ExternalHeaderFileInfoSource *ExternalSource;
239 // Various statistics we track for performance analysis.
240 unsigned NumIncluded;
241 unsigned NumMultiIncludeFileOptzn;
242 unsigned NumFrameworkLookups, NumSubFrameworkLookups;
244 // HeaderSearch doesn't support default or copy construction.
245 HeaderSearch(const HeaderSearch&) = delete;
246 void operator=(const HeaderSearch&) = delete;
248 friend class DirectoryLookup;
251 HeaderSearch(std::shared_ptr<HeaderSearchOptions> HSOpts,
252 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
253 const LangOptions &LangOpts, const TargetInfo *Target);
256 /// \brief Retrieve the header-search options with which this header search
258 HeaderSearchOptions &getHeaderSearchOpts() const { return *HSOpts; }
260 FileManager &getFileMgr() const { return FileMgr; }
262 /// \brief Interface for setting the file search paths.
263 void SetSearchPaths(const std::vector<DirectoryLookup> &dirs,
264 unsigned angledDirIdx, unsigned systemDirIdx,
265 bool noCurDirSearch) {
266 assert(angledDirIdx <= systemDirIdx && systemDirIdx <= dirs.size() &&
267 "Directory indicies are unordered");
269 AngledDirIdx = angledDirIdx;
270 SystemDirIdx = systemDirIdx;
271 NoCurDirSearch = noCurDirSearch;
272 //LookupFileCache.clear();
275 /// \brief Add an additional search path.
276 void AddSearchPath(const DirectoryLookup &dir, bool isAngled) {
277 unsigned idx = isAngled ? SystemDirIdx : AngledDirIdx;
278 SearchDirs.insert(SearchDirs.begin() + idx, dir);
284 /// \brief Set the list of system header prefixes.
285 void SetSystemHeaderPrefixes(ArrayRef<std::pair<std::string, bool> > P) {
286 SystemHeaderPrefixes.assign(P.begin(), P.end());
289 /// \brief Checks whether the map exists or not.
290 bool HasIncludeAliasMap() const { return (bool)IncludeAliases; }
292 /// \brief Map the source include name to the dest include name.
294 /// The Source should include the angle brackets or quotes, the dest
295 /// should not. This allows for distinction between <> and "" headers.
296 void AddIncludeAlias(StringRef Source, StringRef Dest) {
298 IncludeAliases.reset(new IncludeAliasMap);
299 (*IncludeAliases)[Source] = Dest;
302 /// MapHeaderToIncludeAlias - Maps one header file name to a different header
303 /// file name, for use with the include_alias pragma. Note that the source
304 /// file name should include the angle brackets or quotes. Returns StringRef
305 /// as null if the header cannot be mapped.
306 StringRef MapHeaderToIncludeAlias(StringRef Source) {
307 assert(IncludeAliases && "Trying to map headers when there's no map");
309 // Do any filename replacements before anything else
310 IncludeAliasMap::const_iterator Iter = IncludeAliases->find(Source);
311 if (Iter != IncludeAliases->end())
316 /// \brief Set the path to the module cache.
317 void setModuleCachePath(StringRef CachePath) {
318 ModuleCachePath = CachePath;
321 /// \brief Retrieve the path to the module cache.
322 StringRef getModuleCachePath() const { return ModuleCachePath; }
324 /// \brief Consider modules when including files from this directory.
325 void setDirectoryHasModuleMap(const DirectoryEntry* Dir) {
326 DirectoryHasModuleMap[Dir] = true;
329 /// \brief Forget everything we know about headers so far.
330 void ClearFileInfo() {
334 void SetExternalLookup(ExternalPreprocessorSource *EPS) {
335 ExternalLookup = EPS;
338 ExternalPreprocessorSource *getExternalLookup() const {
339 return ExternalLookup;
342 /// \brief Set the external source of header information.
343 void SetExternalSource(ExternalHeaderFileInfoSource *ES) {
347 /// \brief Set the target information for the header search, if not
349 void setTarget(const TargetInfo &Target);
351 /// \brief Given a "foo" or \<foo> reference, look up the indicated file,
352 /// return null on failure.
354 /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member
355 /// the file was found in, or null if not applicable.
357 /// \param IncludeLoc Used for diagnostics if valid.
359 /// \param isAngled indicates whether the file reference is a <> reference.
361 /// \param CurDir If non-null, the file was found in the specified directory
362 /// search location. This is used to implement \#include_next.
364 /// \param Includers Indicates where the \#including file(s) are, in case
365 /// relative searches are needed. In reverse order of inclusion.
367 /// \param SearchPath If non-null, will be set to the search path relative
368 /// to which the file was found. If the include path is absolute, SearchPath
369 /// will be set to an empty string.
371 /// \param RelativePath If non-null, will be set to the path relative to
372 /// SearchPath at which the file was found. This only differs from the
373 /// Filename for framework includes.
375 /// \param SuggestedModule If non-null, and the file found is semantically
376 /// part of a known module, this will be set to the module that should
377 /// be imported instead of preprocessing/parsing the file found.
378 const FileEntry *LookupFile(
379 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
380 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
381 ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
382 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
383 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
384 bool SkipCache = false, bool BuildSystemModule = false);
386 /// \brief Look up a subframework for the specified \#include file.
388 /// For example, if \#include'ing <HIToolbox/HIToolbox.h> from
389 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if
390 /// HIToolbox is a subframework within Carbon.framework. If so, return
391 /// the FileEntry for the designated file, otherwise return null.
392 const FileEntry *LookupSubframeworkHeader(
393 StringRef Filename, const FileEntry *RelativeFileEnt,
394 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
395 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule);
397 /// \brief Look up the specified framework name in our framework cache.
398 /// \returns The DirectoryEntry it is in if we know, null otherwise.
399 FrameworkCacheEntry &LookupFrameworkCache(StringRef FWName) {
400 return FrameworkMap[FWName];
403 /// \brief Mark the specified file as a target of of a \#include,
404 /// \#include_next, or \#import directive.
406 /// \return false if \#including the file will have no effect or true
407 /// if we should include it.
408 bool ShouldEnterIncludeFile(Preprocessor &PP, const FileEntry *File,
409 bool isImport, bool ModulesEnabled,
410 Module *CorrespondingModule);
412 /// \brief Return whether the specified file is a normal header,
413 /// a system header, or a C++ friendly system header.
414 SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File) {
415 return (SrcMgr::CharacteristicKind)getFileInfo(File).DirInfo;
418 /// \brief Mark the specified file as a "once only" file, e.g. due to
420 void MarkFileIncludeOnce(const FileEntry *File) {
421 HeaderFileInfo &FI = getFileInfo(File);
423 FI.isPragmaOnce = true;
426 /// \brief Mark the specified file as a system header, e.g. due to
427 /// \#pragma GCC system_header.
428 void MarkFileSystemHeader(const FileEntry *File) {
429 getFileInfo(File).DirInfo = SrcMgr::C_System;
432 /// \brief Mark the specified file as part of a module.
433 void MarkFileModuleHeader(const FileEntry *File,
434 ModuleMap::ModuleHeaderRole Role,
435 bool IsCompiledModuleHeader);
437 /// \brief Increment the count for the number of times the specified
438 /// FileEntry has been entered.
439 void IncrementIncludeCount(const FileEntry *File) {
440 ++getFileInfo(File).NumIncludes;
443 /// \brief Mark the specified file as having a controlling macro.
445 /// This is used by the multiple-include optimization to eliminate
446 /// no-op \#includes.
447 void SetFileControllingMacro(const FileEntry *File,
448 const IdentifierInfo *ControllingMacro) {
449 getFileInfo(File).ControllingMacro = ControllingMacro;
452 /// \brief Return true if this is the first time encountering this header.
453 bool FirstTimeLexingFile(const FileEntry *File) {
454 return getFileInfo(File).NumIncludes == 1;
457 /// \brief Determine whether this file is intended to be safe from
458 /// multiple inclusions, e.g., it has \#pragma once or a controlling
461 /// This routine does not consider the effect of \#import
462 bool isFileMultipleIncludeGuarded(const FileEntry *File);
464 /// CreateHeaderMap - This method returns a HeaderMap for the specified
465 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
466 const HeaderMap *CreateHeaderMap(const FileEntry *FE);
468 /// \brief Get filenames for all registered header maps.
469 void getHeaderMapFileNames(SmallVectorImpl<std::string> &Names) const;
471 /// \brief Retrieve the name of the module file that should be used to
472 /// load the given module.
474 /// \param Module The module whose module file name will be returned.
476 /// \returns The name of the module file that corresponds to this module,
477 /// or an empty string if this module does not correspond to any module file.
478 std::string getModuleFileName(Module *Module);
480 /// \brief Retrieve the name of the module file that should be used to
481 /// load a module with the given name.
483 /// \param ModuleName The module whose module file name will be returned.
485 /// \param ModuleMapPath A path that when combined with \c ModuleName
486 /// uniquely identifies this module. See Module::ModuleMap.
488 /// \param UsePrebuiltPath Whether we should use the prebuilt module path.
490 /// \returns The name of the module file that corresponds to this module,
491 /// or an empty string if this module does not correspond to any module file.
492 std::string getModuleFileName(StringRef ModuleName, StringRef ModuleMapPath,
493 bool UsePrebuiltPath);
495 /// \brief Lookup a module Search for a module with the given name.
497 /// \param ModuleName The name of the module we're looking for.
499 /// \param AllowSearch Whether we are allowed to search in the various
500 /// search directories to produce a module definition. If not, this lookup
501 /// will only return an already-known module.
503 /// \returns The module with the given name.
504 Module *lookupModule(StringRef ModuleName, bool AllowSearch = true);
506 /// \brief Try to find a module map file in the given directory, returning
507 /// \c nullptr if none is found.
508 const FileEntry *lookupModuleMapFile(const DirectoryEntry *Dir,
511 void IncrementFrameworkLookupCount() { ++NumFrameworkLookups; }
513 /// \brief Determine whether there is a module map that may map the header
514 /// with the given file name to a (sub)module.
515 /// Always returns false if modules are disabled.
517 /// \param Filename The name of the file.
519 /// \param Root The "root" directory, at which we should stop looking for
522 /// \param IsSystem Whether the directories we're looking at are system
523 /// header directories.
524 bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root,
527 /// \brief Retrieve the module that corresponds to the given file, if any.
529 /// \param File The header that we wish to map to a module.
530 /// \param AllowTextual Whether we want to find textual headers too.
531 ModuleMap::KnownHeader findModuleForHeader(const FileEntry *File,
532 bool AllowTextual = false) const;
534 /// \brief Read the contents of the given module map file.
536 /// \param File The module map file.
537 /// \param IsSystem Whether this file is in a system header directory.
539 /// \returns true if an error occurred, false otherwise.
540 bool loadModuleMapFile(const FileEntry *File, bool IsSystem);
542 /// \brief Collect the set of all known, top-level modules.
544 /// \param Modules Will be filled with the set of known, top-level modules.
545 void collectAllModules(SmallVectorImpl<Module *> &Modules);
547 /// \brief Load all known, top-level system modules.
548 void loadTopLevelSystemModules();
552 /// \brief Lookup a module with the given module name and search-name.
554 /// \param ModuleName The name of the module we're looking for.
556 /// \param SearchName The "search-name" to derive filesystem paths from
557 /// when looking for the module map; this is usually equal to ModuleName,
558 /// but for compatibility with some buggy frameworks, additional attempts
559 /// may be made to find the module under a related-but-different search-name.
561 /// \returns The module named ModuleName.
562 Module *lookupModule(StringRef ModuleName, StringRef SearchName);
564 /// \brief Retrieve a module with the given name, which may be part of the
567 /// \param Name The name of the module to retrieve.
569 /// \param Dir The framework directory (e.g., ModuleName.framework).
571 /// \param IsSystem Whether the framework directory is part of the system
574 /// \returns The module, if found; otherwise, null.
575 Module *loadFrameworkModule(StringRef Name,
576 const DirectoryEntry *Dir,
579 /// \brief Load all of the module maps within the immediate subdirectories
580 /// of the given search directory.
581 void loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir);
583 /// \brief Find and suggest a usable module for the given file.
585 /// \return \c true if the file can be used, \c false if we are not permitted to
586 /// find this file due to requirements from \p RequestingModule.
587 bool findUsableModuleForHeader(const FileEntry *File,
588 const DirectoryEntry *Root,
589 Module *RequestingModule,
590 ModuleMap::KnownHeader *SuggestedModule,
591 bool IsSystemHeaderDir);
593 /// \brief Find and suggest a usable module for the given file, which is part of
594 /// the specified framework.
596 /// \return \c true if the file can be used, \c false if we are not permitted to
597 /// find this file due to requirements from \p RequestingModule.
598 bool findUsableModuleForFrameworkHeader(
599 const FileEntry *File, StringRef FrameworkDir, Module *RequestingModule,
600 ModuleMap::KnownHeader *SuggestedModule, bool IsSystemFramework);
602 /// \brief Look up the file with the specified name and determine its owning
605 getFileAndSuggestModule(StringRef FileName, SourceLocation IncludeLoc,
606 const DirectoryEntry *Dir, bool IsSystemHeaderDir,
607 Module *RequestingModule,
608 ModuleMap::KnownHeader *SuggestedModule);
611 /// \brief Retrieve the module map.
612 ModuleMap &getModuleMap() { return ModMap; }
614 /// \brief Retrieve the module map.
615 const ModuleMap &getModuleMap() const { return ModMap; }
617 unsigned header_file_size() const { return FileInfo.size(); }
619 /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
620 /// in preparation for updating it in some way.
621 HeaderFileInfo &getFileInfo(const FileEntry *FE);
623 /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
624 /// if it has ever been filled in.
625 /// \param WantExternal Whether the caller wants purely-external header file
626 /// info (where \p External is true).
627 const HeaderFileInfo *getExistingFileInfo(const FileEntry *FE,
628 bool WantExternal = true) const;
630 // Used by external tools
631 typedef std::vector<DirectoryLookup>::const_iterator search_dir_iterator;
632 search_dir_iterator search_dir_begin() const { return SearchDirs.begin(); }
633 search_dir_iterator search_dir_end() const { return SearchDirs.end(); }
634 unsigned search_dir_size() const { return SearchDirs.size(); }
636 search_dir_iterator quoted_dir_begin() const {
637 return SearchDirs.begin();
639 search_dir_iterator quoted_dir_end() const {
640 return SearchDirs.begin() + AngledDirIdx;
643 search_dir_iterator angled_dir_begin() const {
644 return SearchDirs.begin() + AngledDirIdx;
646 search_dir_iterator angled_dir_end() const {
647 return SearchDirs.begin() + SystemDirIdx;
650 search_dir_iterator system_dir_begin() const {
651 return SearchDirs.begin() + SystemDirIdx;
653 search_dir_iterator system_dir_end() const { return SearchDirs.end(); }
655 /// \brief Retrieve a uniqued framework name.
656 StringRef getUniqueFrameworkName(StringRef Framework);
658 /// \brief Suggest a path by which the specified file could be found, for
659 /// use in diagnostics to suggest a #include.
661 /// \param IsSystem If non-null, filled in to indicate whether the suggested
662 /// path is relative to a system header directory.
663 std::string suggestPathToFileForDiagnostics(const FileEntry *File,
664 bool *IsSystem = nullptr);
668 size_t getTotalMemory() const;
671 /// \brief Describes what happened when we tried to load a module map file.
672 enum LoadModuleMapResult {
673 /// \brief The module map file had already been loaded.
675 /// \brief The module map file was loaded by this invocation.
677 /// \brief There is was directory with the given name.
679 /// \brief There was either no module map file or the module map file was
684 LoadModuleMapResult loadModuleMapFileImpl(const FileEntry *File,
686 const DirectoryEntry *Dir);
688 /// \brief Try to load the module map file in the given directory.
690 /// \param DirName The name of the directory where we will look for a module
692 /// \param IsSystem Whether this is a system header directory.
693 /// \param IsFramework Whether this is a framework directory.
695 /// \returns The result of attempting to load the module map file from the
697 LoadModuleMapResult loadModuleMapFile(StringRef DirName, bool IsSystem,
700 /// \brief Try to load the module map file in the given directory.
702 /// \param Dir The directory where we will look for a module map file.
703 /// \param IsSystem Whether this is a system header directory.
704 /// \param IsFramework Whether this is a framework directory.
706 /// \returns The result of attempting to load the module map file from the
708 LoadModuleMapResult loadModuleMapFile(const DirectoryEntry *Dir,
709 bool IsSystem, bool IsFramework);
712 } // end namespace clang