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 unsigned External : 1;
55 /// \brief Whether this header is part of a module.
56 unsigned isModuleHeader : 1;
58 /// \brief Whether this header is part of the module that we are building.
59 unsigned isCompilingModuleHeader : 1;
61 /// \brief Whether this header is part of the module that we are building.
62 /// This is an instance of ModuleMap::ModuleHeaderRole.
63 unsigned HeaderRole : 2;
65 /// \brief Whether this structure is considered to already have been
66 /// "resolved", meaning that it was loaded from the external source.
67 unsigned Resolved : 1;
69 /// \brief Whether this is a header inside a framework that is currently
72 /// When a framework is being built, the headers have not yet been placed
73 /// into the appropriate framework subdirectories, and therefore are
74 /// provided via a header map. This bit indicates when this is one of
75 /// those framework headers.
76 unsigned IndexHeaderMapHeader : 1;
78 /// \brief Whether this file had been looked up as a header.
81 /// \brief The number of times the file has been included already.
82 unsigned short NumIncludes;
84 /// \brief The ID number of the controlling macro.
86 /// This ID number will be non-zero when there is a controlling
87 /// macro whose IdentifierInfo may not yet have been loaded from
89 unsigned ControllingMacroID;
91 /// If this file has a \#ifndef XXX (or equivalent) guard that
92 /// protects the entire contents of the file, this is the identifier
93 /// for the macro that controls whether or not it has any effect.
95 /// Note: Most clients should use getControllingMacro() to access
96 /// the controlling macro of this header, since
97 /// getControllingMacro() is able to load a controlling macro from
99 const IdentifierInfo *ControllingMacro;
101 /// \brief If this header came from a framework include, this is the name
102 /// of the framework.
106 : isImport(false), isPragmaOnce(false), DirInfo(SrcMgr::C_User),
107 External(false), isModuleHeader(false), isCompilingModuleHeader(false),
108 HeaderRole(ModuleMap::NormalHeader),
109 Resolved(false), IndexHeaderMapHeader(false), IsValid(0),
110 NumIncludes(0), ControllingMacroID(0), ControllingMacro(nullptr) {}
112 /// \brief Retrieve the controlling macro for this header file, if
114 const IdentifierInfo *
115 getControllingMacro(ExternalPreprocessorSource *External);
117 /// \brief Determine whether this is a non-default header file info, e.g.,
118 /// it corresponds to an actual header we've included or tried to include.
119 bool isNonDefault() const {
120 return isImport || isPragmaOnce || NumIncludes || ControllingMacro ||
124 /// \brief Get the HeaderRole properly typed.
125 ModuleMap::ModuleHeaderRole getHeaderRole() const {
126 return static_cast<ModuleMap::ModuleHeaderRole>(HeaderRole);
129 /// \brief Set the HeaderRole properly typed.
130 void setHeaderRole(ModuleMap::ModuleHeaderRole Role) {
135 /// \brief An external source of header file information, which may supply
136 /// information about header files already included.
137 class ExternalHeaderFileInfoSource {
139 virtual ~ExternalHeaderFileInfoSource();
141 /// \brief Retrieve the header file information for the given file entry.
143 /// \returns Header file information for the given file entry, with the
144 /// \c External bit set. If the file entry is not known, return a
145 /// default-constructed \c HeaderFileInfo.
146 virtual HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) = 0;
149 /// \brief Encapsulates the information needed to find the file referenced
150 /// by a \#include or \#include_next, (sub-)framework lookup, etc.
152 /// This structure is used to record entries in our framework cache.
153 struct FrameworkCacheEntry {
154 /// The directory entry which should be used for the cached framework.
155 const DirectoryEntry *Directory;
157 /// Whether this framework has been "user-specified" to be treated as if it
158 /// were a system framework (even if it was found outside a system framework
160 bool IsUserSpecifiedSystemFramework;
163 /// \brief Header-search options used to initialize this header search.
164 IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts;
166 DiagnosticsEngine &Diags;
167 FileManager &FileMgr;
168 /// \#include search path information. Requests for \#include "x" search the
169 /// directory of the \#including file first, then each directory in SearchDirs
170 /// consecutively. Requests for <x> search the current dir first, then each
171 /// directory in SearchDirs, starting at AngledDirIdx, consecutively. If
172 /// NoCurDirSearch is true, then the check for the file in the current
173 /// directory is suppressed.
174 std::vector<DirectoryLookup> SearchDirs;
175 unsigned AngledDirIdx;
176 unsigned SystemDirIdx;
179 /// \brief \#include prefixes for which the 'system header' property is
182 /// For a \#include "x" or \#include \<x> directive, the last string in this
183 /// list which is a prefix of 'x' determines whether the file is treated as
185 std::vector<std::pair<std::string, bool> > SystemHeaderPrefixes;
187 /// \brief The path to the module cache.
188 std::string ModuleCachePath;
190 /// \brief All of the preprocessor-specific data about files that are
191 /// included, indexed by the FileEntry's UID.
192 std::vector<HeaderFileInfo> FileInfo;
194 /// Keeps track of each lookup performed by LookupFile.
195 struct LookupFileCacheInfo {
196 /// Starting index in SearchDirs that the cached search was performed from.
197 /// If there is a hit and this value doesn't match the current query, the
198 /// cache has to be ignored.
200 /// The entry in SearchDirs that satisfied the query.
202 /// This is non-null if the original filename was mapped to a framework
203 /// include via a headermap.
204 const char *MappedName;
206 /// Default constructor -- Initialize all members with zero.
207 LookupFileCacheInfo(): StartIdx(0), HitIdx(0), MappedName(nullptr) {}
209 void reset(unsigned StartIdx) {
210 this->StartIdx = StartIdx;
211 this->MappedName = nullptr;
214 llvm::StringMap<LookupFileCacheInfo, llvm::BumpPtrAllocator> LookupFileCache;
216 /// \brief Collection mapping a framework or subframework
217 /// name like "Carbon" to the Carbon.framework directory.
218 llvm::StringMap<FrameworkCacheEntry, llvm::BumpPtrAllocator> FrameworkMap;
220 /// IncludeAliases - maps include file names (including the quotes or
221 /// angle brackets) to other include file names. This is used to support the
222 /// include_alias pragma for Microsoft compatibility.
223 typedef llvm::StringMap<std::string, llvm::BumpPtrAllocator>
225 std::unique_ptr<IncludeAliasMap> IncludeAliases;
227 /// HeaderMaps - This is a mapping from FileEntry -> HeaderMap, uniquing
228 /// headermaps. This vector owns the headermap.
229 std::vector<std::pair<const FileEntry*, const HeaderMap*> > HeaderMaps;
231 /// \brief The mapping between modules and headers.
232 mutable ModuleMap ModMap;
234 /// \brief Describes whether a given directory has a module map in it.
235 llvm::DenseMap<const DirectoryEntry *, bool> DirectoryHasModuleMap;
237 /// \brief Set of module map files we've already loaded, and a flag indicating
238 /// whether they were valid or not.
239 llvm::DenseMap<const FileEntry *, bool> LoadedModuleMaps;
241 /// \brief Uniqued set of framework names, which is used to track which
242 /// headers were included as framework headers.
243 llvm::StringSet<llvm::BumpPtrAllocator> FrameworkNames;
245 /// \brief Entity used to resolve the identifier IDs of controlling
246 /// macros into IdentifierInfo pointers, and keep the identifire up to date,
248 ExternalPreprocessorSource *ExternalLookup;
250 /// \brief Entity used to look up stored header file information.
251 ExternalHeaderFileInfoSource *ExternalSource;
253 // Various statistics we track for performance analysis.
254 unsigned NumIncluded;
255 unsigned NumMultiIncludeFileOptzn;
256 unsigned NumFrameworkLookups, NumSubFrameworkLookups;
258 const LangOptions &LangOpts;
260 // HeaderSearch doesn't support default or copy construction.
261 HeaderSearch(const HeaderSearch&) = delete;
262 void operator=(const HeaderSearch&) = delete;
264 friend class DirectoryLookup;
267 HeaderSearch(IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
268 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
269 const LangOptions &LangOpts, const TargetInfo *Target);
272 /// \brief Retrieve the header-search options with which this header search
274 HeaderSearchOptions &getHeaderSearchOpts() const { return *HSOpts; }
276 FileManager &getFileMgr() const { return FileMgr; }
278 /// \brief Interface for setting the file search paths.
279 void SetSearchPaths(const std::vector<DirectoryLookup> &dirs,
280 unsigned angledDirIdx, unsigned systemDirIdx,
281 bool noCurDirSearch) {
282 assert(angledDirIdx <= systemDirIdx && systemDirIdx <= dirs.size() &&
283 "Directory indicies are unordered");
285 AngledDirIdx = angledDirIdx;
286 SystemDirIdx = systemDirIdx;
287 NoCurDirSearch = noCurDirSearch;
288 //LookupFileCache.clear();
291 /// \brief Add an additional search path.
292 void AddSearchPath(const DirectoryLookup &dir, bool isAngled) {
293 unsigned idx = isAngled ? SystemDirIdx : AngledDirIdx;
294 SearchDirs.insert(SearchDirs.begin() + idx, dir);
300 /// \brief Set the list of system header prefixes.
301 void SetSystemHeaderPrefixes(ArrayRef<std::pair<std::string, bool> > P) {
302 SystemHeaderPrefixes.assign(P.begin(), P.end());
305 /// \brief Checks whether the map exists or not.
306 bool HasIncludeAliasMap() const { return (bool)IncludeAliases; }
308 /// \brief Map the source include name to the dest include name.
310 /// The Source should include the angle brackets or quotes, the dest
311 /// should not. This allows for distinction between <> and "" headers.
312 void AddIncludeAlias(StringRef Source, StringRef Dest) {
314 IncludeAliases.reset(new IncludeAliasMap);
315 (*IncludeAliases)[Source] = Dest;
318 /// MapHeaderToIncludeAlias - Maps one header file name to a different header
319 /// file name, for use with the include_alias pragma. Note that the source
320 /// file name should include the angle brackets or quotes. Returns StringRef
321 /// as null if the header cannot be mapped.
322 StringRef MapHeaderToIncludeAlias(StringRef Source) {
323 assert(IncludeAliases && "Trying to map headers when there's no map");
325 // Do any filename replacements before anything else
326 IncludeAliasMap::const_iterator Iter = IncludeAliases->find(Source);
327 if (Iter != IncludeAliases->end())
332 /// \brief Set the path to the module cache.
333 void setModuleCachePath(StringRef CachePath) {
334 ModuleCachePath = CachePath;
337 /// \brief Retrieve the path to the module cache.
338 StringRef getModuleCachePath() const { return ModuleCachePath; }
340 /// \brief Consider modules when including files from this directory.
341 void setDirectoryHasModuleMap(const DirectoryEntry* Dir) {
342 DirectoryHasModuleMap[Dir] = true;
345 /// \brief Forget everything we know about headers so far.
346 void ClearFileInfo() {
350 void SetExternalLookup(ExternalPreprocessorSource *EPS) {
351 ExternalLookup = EPS;
354 ExternalPreprocessorSource *getExternalLookup() const {
355 return ExternalLookup;
358 /// \brief Set the external source of header information.
359 void SetExternalSource(ExternalHeaderFileInfoSource *ES) {
363 /// \brief Set the target information for the header search, if not
365 void setTarget(const TargetInfo &Target);
367 /// \brief Given a "foo" or \<foo> reference, look up the indicated file,
368 /// return null on failure.
370 /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member
371 /// the file was found in, or null if not applicable.
373 /// \param IncludeLoc Used for diagnostics if valid.
375 /// \param isAngled indicates whether the file reference is a <> reference.
377 /// \param CurDir If non-null, the file was found in the specified directory
378 /// search location. This is used to implement \#include_next.
380 /// \param Includers Indicates where the \#including file(s) are, in case
381 /// relative searches are needed. In reverse order of inclusion.
383 /// \param SearchPath If non-null, will be set to the search path relative
384 /// to which the file was found. If the include path is absolute, SearchPath
385 /// will be set to an empty string.
387 /// \param RelativePath If non-null, will be set to the path relative to
388 /// SearchPath at which the file was found. This only differs from the
389 /// Filename for framework includes.
391 /// \param SuggestedModule If non-null, and the file found is semantically
392 /// part of a known module, this will be set to the module that should
393 /// be imported instead of preprocessing/parsing the file found.
394 const FileEntry *LookupFile(
395 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
396 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
397 ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
398 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
399 ModuleMap::KnownHeader *SuggestedModule, bool SkipCache = false);
401 /// \brief Look up a subframework for the specified \#include file.
403 /// For example, if \#include'ing <HIToolbox/HIToolbox.h> from
404 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if
405 /// HIToolbox is a subframework within Carbon.framework. If so, return
406 /// the FileEntry for the designated file, otherwise return null.
407 const FileEntry *LookupSubframeworkHeader(
409 const FileEntry *RelativeFileEnt,
410 SmallVectorImpl<char> *SearchPath,
411 SmallVectorImpl<char> *RelativePath,
412 ModuleMap::KnownHeader *SuggestedModule);
414 /// \brief Look up the specified framework name in our framework cache.
415 /// \returns The DirectoryEntry it is in if we know, null otherwise.
416 FrameworkCacheEntry &LookupFrameworkCache(StringRef FWName) {
417 return FrameworkMap[FWName];
420 /// \brief Mark the specified file as a target of of a \#include,
421 /// \#include_next, or \#import directive.
423 /// \return false if \#including the file will have no effect or true
424 /// if we should include it.
425 bool ShouldEnterIncludeFile(Preprocessor &PP, const FileEntry *File,
426 bool isImport, Module *CorrespondingModule);
428 /// \brief Return whether the specified file is a normal header,
429 /// a system header, or a C++ friendly system header.
430 SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File) {
431 return (SrcMgr::CharacteristicKind)getFileInfo(File).DirInfo;
434 /// \brief Mark the specified file as a "once only" file, e.g. due to
436 void MarkFileIncludeOnce(const FileEntry *File) {
437 HeaderFileInfo &FI = getFileInfo(File);
439 FI.isPragmaOnce = true;
442 /// \brief Mark the specified file as a system header, e.g. due to
443 /// \#pragma GCC system_header.
444 void MarkFileSystemHeader(const FileEntry *File) {
445 getFileInfo(File).DirInfo = SrcMgr::C_System;
448 /// \brief Mark the specified file as part of a module.
449 void MarkFileModuleHeader(const FileEntry *File,
450 ModuleMap::ModuleHeaderRole Role,
451 bool IsCompiledModuleHeader);
453 /// \brief Increment the count for the number of times the specified
454 /// FileEntry has been entered.
455 void IncrementIncludeCount(const FileEntry *File) {
456 ++getFileInfo(File).NumIncludes;
459 /// \brief Mark the specified file as having a controlling macro.
461 /// This is used by the multiple-include optimization to eliminate
462 /// no-op \#includes.
463 void SetFileControllingMacro(const FileEntry *File,
464 const IdentifierInfo *ControllingMacro) {
465 getFileInfo(File).ControllingMacro = ControllingMacro;
468 /// \brief Return true if this is the first time encountering this header.
469 bool FirstTimeLexingFile(const FileEntry *File) {
470 return getFileInfo(File).NumIncludes == 1;
473 /// \brief Determine whether this file is intended to be safe from
474 /// multiple inclusions, e.g., it has \#pragma once or a controlling
477 /// This routine does not consider the effect of \#import
478 bool isFileMultipleIncludeGuarded(const FileEntry *File);
480 /// CreateHeaderMap - This method returns a HeaderMap for the specified
481 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
482 const HeaderMap *CreateHeaderMap(const FileEntry *FE);
484 /// \brief Retrieve the name of the module file that should be used to
485 /// load the given module.
487 /// \param Module The module whose module file name will be returned.
489 /// \returns The name of the module file that corresponds to this module,
490 /// or an empty string if this module does not correspond to any module file.
491 std::string getModuleFileName(Module *Module);
493 /// \brief Retrieve the name of the module file that should be used to
494 /// load a module with the given name.
496 /// \param ModuleName The module whose module file name will be returned.
498 /// \param ModuleMapPath A path that when combined with \c ModuleName
499 /// uniquely identifies this module. See Module::ModuleMap.
501 /// \returns The name of the module file that corresponds to this module,
502 /// or an empty string if this module does not correspond to any module file.
503 std::string getModuleFileName(StringRef ModuleName, StringRef ModuleMapPath);
505 /// \brief Lookup a module Search for a module with the given name.
507 /// \param ModuleName The name of the module we're looking for.
509 /// \param AllowSearch Whether we are allowed to search in the various
510 /// search directories to produce a module definition. If not, this lookup
511 /// will only return an already-known module.
513 /// \returns The module with the given name.
514 Module *lookupModule(StringRef ModuleName, bool AllowSearch = true);
516 /// \brief Try to find a module map file in the given directory, returning
517 /// \c nullptr if none is found.
518 const FileEntry *lookupModuleMapFile(const DirectoryEntry *Dir,
521 void IncrementFrameworkLookupCount() { ++NumFrameworkLookups; }
523 /// \brief Determine whether there is a module map that may map the header
524 /// with the given file name to a (sub)module.
525 /// Always returns false if modules are disabled.
527 /// \param Filename The name of the file.
529 /// \param Root The "root" directory, at which we should stop looking for
532 /// \param IsSystem Whether the directories we're looking at are system
533 /// header directories.
534 bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root,
537 /// \brief Retrieve the module that corresponds to the given file, if any.
539 /// \param File The header that we wish to map to a module.
540 ModuleMap::KnownHeader findModuleForHeader(const FileEntry *File) const;
542 /// \brief Read the contents of the given module map file.
544 /// \param File The module map file.
545 /// \param IsSystem Whether this file is in a system header directory.
547 /// \returns true if an error occurred, false otherwise.
548 bool loadModuleMapFile(const FileEntry *File, bool IsSystem);
550 /// \brief Collect the set of all known, top-level modules.
552 /// \param Modules Will be filled with the set of known, top-level modules.
553 void collectAllModules(SmallVectorImpl<Module *> &Modules);
555 /// \brief Load all known, top-level system modules.
556 void loadTopLevelSystemModules();
559 /// \brief Retrieve a module with the given name, which may be part of the
562 /// \param Name The name of the module to retrieve.
564 /// \param Dir The framework directory (e.g., ModuleName.framework).
566 /// \param IsSystem Whether the framework directory is part of the system
569 /// \returns The module, if found; otherwise, null.
570 Module *loadFrameworkModule(StringRef Name,
571 const DirectoryEntry *Dir,
574 /// \brief Load all of the module maps within the immediate subdirectories
575 /// of the given search directory.
576 void loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir);
578 /// \brief Return the HeaderFileInfo structure for the specified FileEntry.
579 const HeaderFileInfo &getFileInfo(const FileEntry *FE) const {
580 return const_cast<HeaderSearch*>(this)->getFileInfo(FE);
584 /// \brief Retrieve the module map.
585 ModuleMap &getModuleMap() { return ModMap; }
587 unsigned header_file_size() const { return FileInfo.size(); }
589 /// \brief Get a \c HeaderFileInfo structure for the specified \c FileEntry,
591 bool tryGetFileInfo(const FileEntry *FE, HeaderFileInfo &Result) const;
593 // Used by external tools
594 typedef std::vector<DirectoryLookup>::const_iterator search_dir_iterator;
595 search_dir_iterator search_dir_begin() const { return SearchDirs.begin(); }
596 search_dir_iterator search_dir_end() const { return SearchDirs.end(); }
597 unsigned search_dir_size() const { return SearchDirs.size(); }
599 search_dir_iterator quoted_dir_begin() const {
600 return SearchDirs.begin();
602 search_dir_iterator quoted_dir_end() const {
603 return SearchDirs.begin() + AngledDirIdx;
606 search_dir_iterator angled_dir_begin() const {
607 return SearchDirs.begin() + AngledDirIdx;
609 search_dir_iterator angled_dir_end() const {
610 return SearchDirs.begin() + SystemDirIdx;
613 search_dir_iterator system_dir_begin() const {
614 return SearchDirs.begin() + SystemDirIdx;
616 search_dir_iterator system_dir_end() const { return SearchDirs.end(); }
618 /// \brief Retrieve a uniqued framework name.
619 StringRef getUniqueFrameworkName(StringRef Framework);
623 size_t getTotalMemory() const;
625 static std::string NormalizeDashIncludePath(StringRef File,
626 FileManager &FileMgr);
629 /// \brief Describes what happened when we tried to load a module map file.
630 enum LoadModuleMapResult {
631 /// \brief The module map file had already been loaded.
633 /// \brief The module map file was loaded by this invocation.
635 /// \brief There is was directory with the given name.
637 /// \brief There was either no module map file or the module map file was
642 LoadModuleMapResult loadModuleMapFileImpl(const FileEntry *File,
644 const DirectoryEntry *Dir);
646 /// \brief Try to load the module map file in the given directory.
648 /// \param DirName The name of the directory where we will look for a module
650 /// \param IsSystem Whether this is a system header directory.
651 /// \param IsFramework Whether this is a framework directory.
653 /// \returns The result of attempting to load the module map file from the
655 LoadModuleMapResult loadModuleMapFile(StringRef DirName, bool IsSystem,
658 /// \brief Try to load the module map file in the given directory.
660 /// \param Dir The directory where we will look for a module map file.
661 /// \param IsSystem Whether this is a system header directory.
662 /// \param IsFramework Whether this is a framework directory.
664 /// \returns The result of attempting to load the module map file from the
666 LoadModuleMapResult loadModuleMapFile(const DirectoryEntry *Dir,
667 bool IsSystem, bool IsFramework);
669 /// \brief Return the HeaderFileInfo structure for the specified FileEntry.
670 HeaderFileInfo &getFileInfo(const FileEntry *FE);
673 } // end namespace clang