clang  3.8.0
HeaderSearch.h
Go to the documentation of this file.
1 //===--- HeaderSearch.h - Resolve Header File Locations ---------*- 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 // This file defines the HeaderSearch interface.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LEX_HEADERSEARCH_H
15 #define LLVM_CLANG_LEX_HEADERSEARCH_H
16 
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"
24 #include <memory>
25 #include <vector>
26 
27 namespace clang {
28 
29 class DiagnosticsEngine;
30 class ExternalPreprocessorSource;
31 class FileEntry;
32 class FileManager;
33 class HeaderSearchOptions;
34 class IdentifierInfo;
35 class Preprocessor;
36 
37 /// \brief The preprocessor keeps track of this information for each
38 /// file that is \#included.
40  /// \brief True if this is a \#import'd or \#pragma once file.
41  unsigned isImport : 1;
42 
43  /// \brief True if this is a \#pragma once file.
44  unsigned isPragmaOnce : 1;
45 
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.
50  unsigned DirInfo : 2;
51 
52  /// \brief Whether this header file info was supplied by an external source,
53  /// and has not changed since.
54  unsigned External : 1;
55 
56  /// \brief Whether this header is part of a module.
57  unsigned isModuleHeader : 1;
58 
59  /// \brief Whether this header is part of the module that we are building.
61 
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;
65 
66  /// \brief Whether this is a header inside a framework that is currently
67  /// being built.
68  ///
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;
74 
75  /// \brief Whether this file has been looked up as a header.
76  unsigned IsValid : 1;
77 
78  /// \brief The number of times the file has been included already.
79  unsigned short NumIncludes;
80 
81  /// \brief The ID number of the controlling macro.
82  ///
83  /// This ID number will be non-zero when there is a controlling
84  /// macro whose IdentifierInfo may not yet have been loaded from
85  /// external storage.
87 
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.
91  ///
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
95  /// external storage.
97 
98  /// \brief If this header came from a framework include, this is the name
99  /// of the framework.
100  StringRef Framework;
101 
103  : isImport(false), isPragmaOnce(false), DirInfo(SrcMgr::C_User),
107 
108  /// \brief Retrieve the controlling macro for this header file, if
109  /// any.
110  const IdentifierInfo *
112 
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 {
118  }
119 };
120 
121 /// \brief An external source of header file information, which may supply
122 /// information about header files already included.
124 public:
126 
127  /// \brief Retrieve the header file information for the given file entry.
128  ///
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;
133 };
134 
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;
142 
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
145  /// directory).
146  bool IsUserSpecifiedSystemFramework;
147  };
148 
149  /// \brief Header-search options used to initialize this header search.
151 
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;
163  bool NoCurDirSearch;
164 
165  /// \brief \#include prefixes for which the 'system header' property is
166  /// overridden.
167  ///
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
170  /// a system header.
171  std::vector<std::pair<std::string, bool> > SystemHeaderPrefixes;
172 
173  /// \brief The path to the module cache.
174  std::string ModuleCachePath;
175 
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;
179 
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.
185  unsigned StartIdx;
186  /// The entry in SearchDirs that satisfied the query.
187  unsigned HitIdx;
188  /// This is non-null if the original filename was mapped to a framework
189  /// include via a headermap.
190  const char *MappedName;
191 
192  /// Default constructor -- Initialize all members with zero.
193  LookupFileCacheInfo(): StartIdx(0), HitIdx(0), MappedName(nullptr) {}
194 
195  void reset(unsigned StartIdx) {
196  this->StartIdx = StartIdx;
197  this->MappedName = nullptr;
198  }
199  };
200  llvm::StringMap<LookupFileCacheInfo, llvm::BumpPtrAllocator> LookupFileCache;
201 
202  /// \brief Collection mapping a framework or subframework
203  /// name like "Carbon" to the Carbon.framework directory.
204  llvm::StringMap<FrameworkCacheEntry, llvm::BumpPtrAllocator> FrameworkMap;
205 
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>
210  IncludeAliasMap;
211  std::unique_ptr<IncludeAliasMap> IncludeAliases;
212 
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;
216 
217  /// \brief The mapping between modules and headers.
218  mutable ModuleMap ModMap;
219 
220  /// \brief Describes whether a given directory has a module map in it.
221  llvm::DenseMap<const DirectoryEntry *, bool> DirectoryHasModuleMap;
222 
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;
226 
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;
230 
231  /// \brief Entity used to resolve the identifier IDs of controlling
232  /// macros into IdentifierInfo pointers, and keep the identifire up to date,
233  /// as needed.
234  ExternalPreprocessorSource *ExternalLookup;
235 
236  /// \brief Entity used to look up stored header file information.
237  ExternalHeaderFileInfoSource *ExternalSource;
238 
239  // Various statistics we track for performance analysis.
240  unsigned NumIncluded;
241  unsigned NumMultiIncludeFileOptzn;
242  unsigned NumFrameworkLookups, NumSubFrameworkLookups;
243 
244  const LangOptions &LangOpts;
245 
246  // HeaderSearch doesn't support default or copy construction.
247  HeaderSearch(const HeaderSearch&) = delete;
248  void operator=(const HeaderSearch&) = delete;
249 
250  friend class DirectoryLookup;
251 
252 public:
255  const LangOptions &LangOpts, const TargetInfo *Target);
256  ~HeaderSearch();
257 
258  /// \brief Retrieve the header-search options with which this header search
259  /// was initialized.
260  HeaderSearchOptions &getHeaderSearchOpts() const { return *HSOpts; }
261 
262  FileManager &getFileMgr() const { return FileMgr; }
263 
264  /// \brief Interface for setting the file search paths.
265  void SetSearchPaths(const std::vector<DirectoryLookup> &dirs,
266  unsigned angledDirIdx, unsigned systemDirIdx,
267  bool noCurDirSearch) {
268  assert(angledDirIdx <= systemDirIdx && systemDirIdx <= dirs.size() &&
269  "Directory indicies are unordered");
270  SearchDirs = dirs;
271  AngledDirIdx = angledDirIdx;
272  SystemDirIdx = systemDirIdx;
273  NoCurDirSearch = noCurDirSearch;
274  //LookupFileCache.clear();
275  }
276 
277  /// \brief Add an additional search path.
278  void AddSearchPath(const DirectoryLookup &dir, bool isAngled) {
279  unsigned idx = isAngled ? SystemDirIdx : AngledDirIdx;
280  SearchDirs.insert(SearchDirs.begin() + idx, dir);
281  if (!isAngled)
282  AngledDirIdx++;
283  SystemDirIdx++;
284  }
285 
286  /// \brief Set the list of system header prefixes.
287  void SetSystemHeaderPrefixes(ArrayRef<std::pair<std::string, bool> > P) {
288  SystemHeaderPrefixes.assign(P.begin(), P.end());
289  }
290 
291  /// \brief Checks whether the map exists or not.
292  bool HasIncludeAliasMap() const { return (bool)IncludeAliases; }
293 
294  /// \brief Map the source include name to the dest include name.
295  ///
296  /// The Source should include the angle brackets or quotes, the dest
297  /// should not. This allows for distinction between <> and "" headers.
298  void AddIncludeAlias(StringRef Source, StringRef Dest) {
299  if (!IncludeAliases)
300  IncludeAliases.reset(new IncludeAliasMap);
301  (*IncludeAliases)[Source] = Dest;
302  }
303 
304  /// MapHeaderToIncludeAlias - Maps one header file name to a different header
305  /// file name, for use with the include_alias pragma. Note that the source
306  /// file name should include the angle brackets or quotes. Returns StringRef
307  /// as null if the header cannot be mapped.
308  StringRef MapHeaderToIncludeAlias(StringRef Source) {
309  assert(IncludeAliases && "Trying to map headers when there's no map");
310 
311  // Do any filename replacements before anything else
312  IncludeAliasMap::const_iterator Iter = IncludeAliases->find(Source);
313  if (Iter != IncludeAliases->end())
314  return Iter->second;
315  return StringRef();
316  }
317 
318  /// \brief Set the path to the module cache.
319  void setModuleCachePath(StringRef CachePath) {
320  ModuleCachePath = CachePath;
321  }
322 
323  /// \brief Retrieve the path to the module cache.
324  StringRef getModuleCachePath() const { return ModuleCachePath; }
325 
326  /// \brief Consider modules when including files from this directory.
328  DirectoryHasModuleMap[Dir] = true;
329  }
330 
331  /// \brief Forget everything we know about headers so far.
332  void ClearFileInfo() {
333  FileInfo.clear();
334  }
335 
337  ExternalLookup = EPS;
338  }
339 
341  return ExternalLookup;
342  }
343 
344  /// \brief Set the external source of header information.
346  ExternalSource = ES;
347  }
348 
349  /// \brief Set the target information for the header search, if not
350  /// already known.
351  void setTarget(const TargetInfo &Target);
352 
353  /// \brief Given a "foo" or <foo> reference, look up the indicated file,
354  /// return null on failure.
355  ///
356  /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member
357  /// the file was found in, or null if not applicable.
358  ///
359  /// \param IncludeLoc Used for diagnostics if valid.
360  ///
361  /// \param isAngled indicates whether the file reference is a <> reference.
362  ///
363  /// \param CurDir If non-null, the file was found in the specified directory
364  /// search location. This is used to implement \#include_next.
365  ///
366  /// \param Includers Indicates where the \#including file(s) are, in case
367  /// relative searches are needed. In reverse order of inclusion.
368  ///
369  /// \param SearchPath If non-null, will be set to the search path relative
370  /// to which the file was found. If the include path is absolute, SearchPath
371  /// will be set to an empty string.
372  ///
373  /// \param RelativePath If non-null, will be set to the path relative to
374  /// SearchPath at which the file was found. This only differs from the
375  /// Filename for framework includes.
376  ///
377  /// \param SuggestedModule If non-null, and the file found is semantically
378  /// part of a known module, this will be set to the module that should
379  /// be imported instead of preprocessing/parsing the file found.
380  const FileEntry *LookupFile(
381  StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
382  const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
383  ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
384  SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
385  Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
386  bool SkipCache = false);
387 
388  /// \brief Look up a subframework for the specified \#include file.
389  ///
390  /// For example, if \#include'ing <HIToolbox/HIToolbox.h> from
391  /// within ".../Carbon.framework/Headers/Carbon.h", check to see if
392  /// HIToolbox is a subframework within Carbon.framework. If so, return
393  /// the FileEntry for the designated file, otherwise return null.
395  StringRef Filename, const FileEntry *RelativeFileEnt,
396  SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
397  Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule);
398 
399  /// \brief Look up the specified framework name in our framework cache.
400  /// \returns The DirectoryEntry it is in if we know, null otherwise.
401  FrameworkCacheEntry &LookupFrameworkCache(StringRef FWName) {
402  return FrameworkMap[FWName];
403  }
404 
405  /// \brief Mark the specified file as a target of of a \#include,
406  /// \#include_next, or \#import directive.
407  ///
408  /// \return false if \#including the file will have no effect or true
409  /// if we should include it.
410  bool ShouldEnterIncludeFile(Preprocessor &PP, const FileEntry *File,
411  bool isImport, Module *CorrespondingModule);
412 
413  /// \brief Return whether the specified file is a normal header,
414  /// a system header, or a C++ friendly system header.
417  }
418 
419  /// \brief Mark the specified file as a "once only" file, e.g. due to
420  /// \#pragma once.
421  void MarkFileIncludeOnce(const FileEntry *File) {
422  HeaderFileInfo &FI = getFileInfo(File);
423  FI.isImport = true;
424  FI.isPragmaOnce = true;
425  }
426 
427  /// \brief Mark the specified file as a system header, e.g. due to
428  /// \#pragma GCC system_header.
429  void MarkFileSystemHeader(const FileEntry *File) {
431  }
432 
433  /// \brief Mark the specified file as part of a module.
434  void MarkFileModuleHeader(const FileEntry *File,
436  bool IsCompiledModuleHeader);
437 
438  /// \brief Increment the count for the number of times the specified
439  /// FileEntry has been entered.
440  void IncrementIncludeCount(const FileEntry *File) {
441  ++getFileInfo(File).NumIncludes;
442  }
443 
444  /// \brief Mark the specified file as having a controlling macro.
445  ///
446  /// This is used by the multiple-include optimization to eliminate
447  /// no-op \#includes.
449  const IdentifierInfo *ControllingMacro) {
450  getFileInfo(File).ControllingMacro = ControllingMacro;
451  }
452 
453  /// \brief Return true if this is the first time encountering this header.
454  bool FirstTimeLexingFile(const FileEntry *File) {
455  return getFileInfo(File).NumIncludes == 1;
456  }
457 
458  /// \brief Determine whether this file is intended to be safe from
459  /// multiple inclusions, e.g., it has \#pragma once or a controlling
460  /// macro.
461  ///
462  /// This routine does not consider the effect of \#import
463  bool isFileMultipleIncludeGuarded(const FileEntry *File);
464 
465  /// CreateHeaderMap - This method returns a HeaderMap for the specified
466  /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
467  const HeaderMap *CreateHeaderMap(const FileEntry *FE);
468 
469  /// \brief Retrieve the name of the module file that should be used to
470  /// load the given module.
471  ///
472  /// \param Module The module whose module file name will be returned.
473  ///
474  /// \returns The name of the module file that corresponds to this module,
475  /// or an empty string if this module does not correspond to any module file.
476  std::string getModuleFileName(Module *Module);
477 
478  /// \brief Retrieve the name of the module file that should be used to
479  /// load a module with the given name.
480  ///
481  /// \param ModuleName The module whose module file name will be returned.
482  ///
483  /// \param ModuleMapPath A path that when combined with \c ModuleName
484  /// uniquely identifies this module. See Module::ModuleMap.
485  ///
486  /// \returns The name of the module file that corresponds to this module,
487  /// or an empty string if this module does not correspond to any module file.
488  std::string getModuleFileName(StringRef ModuleName, StringRef ModuleMapPath);
489 
490  /// \brief Lookup a module Search for a module with the given name.
491  ///
492  /// \param ModuleName The name of the module we're looking for.
493  ///
494  /// \param AllowSearch Whether we are allowed to search in the various
495  /// search directories to produce a module definition. If not, this lookup
496  /// will only return an already-known module.
497  ///
498  /// \returns The module with the given name.
499  Module *lookupModule(StringRef ModuleName, bool AllowSearch = true);
500 
501  /// \brief Try to find a module map file in the given directory, returning
502  /// \c nullptr if none is found.
503  const FileEntry *lookupModuleMapFile(const DirectoryEntry *Dir,
504  bool IsFramework);
505 
506  void IncrementFrameworkLookupCount() { ++NumFrameworkLookups; }
507 
508  /// \brief Determine whether there is a module map that may map the header
509  /// with the given file name to a (sub)module.
510  /// Always returns false if modules are disabled.
511  ///
512  /// \param Filename The name of the file.
513  ///
514  /// \param Root The "root" directory, at which we should stop looking for
515  /// module maps.
516  ///
517  /// \param IsSystem Whether the directories we're looking at are system
518  /// header directories.
519  bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root,
520  bool IsSystem);
521 
522  /// \brief Retrieve the module that corresponds to the given file, if any.
523  ///
524  /// \param File The header that we wish to map to a module.
526 
527  /// \brief Read the contents of the given module map file.
528  ///
529  /// \param File The module map file.
530  /// \param IsSystem Whether this file is in a system header directory.
531  ///
532  /// \returns true if an error occurred, false otherwise.
533  bool loadModuleMapFile(const FileEntry *File, bool IsSystem);
534 
535  /// \brief Collect the set of all known, top-level modules.
536  ///
537  /// \param Modules Will be filled with the set of known, top-level modules.
539 
540  /// \brief Load all known, top-level system modules.
542 
543 private:
544  /// \brief Retrieve a module with the given name, which may be part of the
545  /// given framework.
546  ///
547  /// \param Name The name of the module to retrieve.
548  ///
549  /// \param Dir The framework directory (e.g., ModuleName.framework).
550  ///
551  /// \param IsSystem Whether the framework directory is part of the system
552  /// frameworks.
553  ///
554  /// \returns The module, if found; otherwise, null.
555  Module *loadFrameworkModule(StringRef Name,
556  const DirectoryEntry *Dir,
557  bool IsSystem);
558 
559  /// \brief Load all of the module maps within the immediate subdirectories
560  /// of the given search directory.
561  void loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir);
562 
563  /// \brief Find and suggest a usable module for the given file.
564  ///
565  /// \return \c true if the file can be used, \c false if we are not permitted to
566  /// find this file due to requirements from \p RequestingModule.
567  bool findUsableModuleForHeader(const FileEntry *File,
568  const DirectoryEntry *Root,
569  Module *RequestingModule,
570  ModuleMap::KnownHeader *SuggestedModule,
571  bool IsSystemHeaderDir);
572 
573  /// \brief Find and suggest a usable module for the given file, which is part of
574  /// the specified framework.
575  ///
576  /// \return \c true if the file can be used, \c false if we are not permitted to
577  /// find this file due to requirements from \p RequestingModule.
578  bool findUsableModuleForFrameworkHeader(
579  const FileEntry *File, StringRef FrameworkDir, Module *RequestingModule,
580  ModuleMap::KnownHeader *SuggestedModule, bool IsSystemFramework);
581 
582  /// \brief Look up the file with the specified name and determine its owning
583  /// module.
584  const FileEntry *
585  getFileAndSuggestModule(StringRef FileName, const DirectoryEntry *Dir,
586  bool IsSystemHeaderDir, Module *RequestingModule,
587  ModuleMap::KnownHeader *SuggestedModule);
588 
589 public:
590  /// \brief Retrieve the module map.
591  ModuleMap &getModuleMap() { return ModMap; }
592 
593  /// \brief Retrieve the module map.
594  const ModuleMap &getModuleMap() const { return ModMap; }
595 
596  unsigned header_file_size() const { return FileInfo.size(); }
597 
598  /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
599  /// in preparation for updating it in some way.
601 
602  /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
603  /// if it has ever been filled in.
604  /// \param WantExternal Whether the caller wants purely-external header file
605  /// info (where \p External is true).
607  bool WantExternal = true) const;
608 
609  // Used by external tools
610  typedef std::vector<DirectoryLookup>::const_iterator search_dir_iterator;
611  search_dir_iterator search_dir_begin() const { return SearchDirs.begin(); }
612  search_dir_iterator search_dir_end() const { return SearchDirs.end(); }
613  unsigned search_dir_size() const { return SearchDirs.size(); }
614 
616  return SearchDirs.begin();
617  }
619  return SearchDirs.begin() + AngledDirIdx;
620  }
621 
623  return SearchDirs.begin() + AngledDirIdx;
624  }
626  return SearchDirs.begin() + SystemDirIdx;
627  }
628 
630  return SearchDirs.begin() + SystemDirIdx;
631  }
632  search_dir_iterator system_dir_end() const { return SearchDirs.end(); }
633 
634  /// \brief Retrieve a uniqued framework name.
635  StringRef getUniqueFrameworkName(StringRef Framework);
636 
637  void PrintStats();
638 
639  size_t getTotalMemory() const;
640 
641  static std::string NormalizeDashIncludePath(StringRef File,
642  FileManager &FileMgr);
643 
644 private:
645  /// \brief Describes what happened when we tried to load a module map file.
646  enum LoadModuleMapResult {
647  /// \brief The module map file had already been loaded.
648  LMM_AlreadyLoaded,
649  /// \brief The module map file was loaded by this invocation.
650  LMM_NewlyLoaded,
651  /// \brief There is was directory with the given name.
652  LMM_NoDirectory,
653  /// \brief There was either no module map file or the module map file was
654  /// invalid.
655  LMM_InvalidModuleMap
656  };
657 
658  LoadModuleMapResult loadModuleMapFileImpl(const FileEntry *File,
659  bool IsSystem,
660  const DirectoryEntry *Dir);
661 
662  /// \brief Try to load the module map file in the given directory.
663  ///
664  /// \param DirName The name of the directory where we will look for a module
665  /// map file.
666  /// \param IsSystem Whether this is a system header directory.
667  /// \param IsFramework Whether this is a framework directory.
668  ///
669  /// \returns The result of attempting to load the module map file from the
670  /// named directory.
671  LoadModuleMapResult loadModuleMapFile(StringRef DirName, bool IsSystem,
672  bool IsFramework);
673 
674  /// \brief Try to load the module map file in the given directory.
675  ///
676  /// \param Dir The directory where we will look for a module map file.
677  /// \param IsSystem Whether this is a system header directory.
678  /// \param IsFramework Whether this is a framework directory.
679  ///
680  /// \returns The result of attempting to load the module map file from the
681  /// named directory.
682  LoadModuleMapResult loadModuleMapFile(const DirectoryEntry *Dir,
683  bool IsSystem, bool IsFramework);
684 };
685 
686 } // end namespace clang
687 
688 #endif
search_dir_iterator search_dir_begin() const
Definition: HeaderSearch.h:611
unsigned DirInfo
DirInfo - Keep track of whether this is a system header, and if so, whether it is C++ clean or not...
Definition: HeaderSearch.h:50
search_dir_iterator quoted_dir_end() const
Definition: HeaderSearch.h:618
Implements support for file system lookup, file system caching, and directory search management...
Definition: FileManager.h:115
unsigned isPragmaOnce
True if this is a #pragma once file.
Definition: HeaderSearch.h:44
void loadTopLevelSystemModules()
Load all known, top-level system modules.
void SetSearchPaths(const std::vector< DirectoryLookup > &dirs, unsigned angledDirIdx, unsigned systemDirIdx, bool noCurDirSearch)
Interface for setting the file search paths.
Definition: HeaderSearch.h:265
std::string getModuleFileName(Module *Module)
Retrieve the name of the module file that should be used to load the given module.
bool isFileMultipleIncludeGuarded(const FileEntry *File)
Determine whether this file is intended to be safe from multiple inclusions, e.g., it has #pragma once or a controlling macro.
void MarkFileModuleHeader(const FileEntry *File, ModuleMap::ModuleHeaderRole Role, bool IsCompiledModuleHeader)
Mark the specified file as part of a module.
FrameworkCacheEntry & LookupFrameworkCache(StringRef FWName)
Look up the specified framework name in our framework cache.
Definition: HeaderSearch.h:401
const FileEntry * lookupModuleMapFile(const DirectoryEntry *Dir, bool IsFramework)
Try to find a module map file in the given directory, returning nullptr if none is found...
const FileEntry * LookupFile(StringRef Filename, SourceLocation IncludeLoc, bool isAngled, const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir, ArrayRef< std::pair< const FileEntry *, const DirectoryEntry * >> Includers, SmallVectorImpl< char > *SearchPath, SmallVectorImpl< char > *RelativePath, Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule, bool SkipCache=false)
Given a "foo" or <foo> reference, look up the indicated file, return null on failure.
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
Definition: SourceManager.h:79
ModuleMap & getModuleMap()
Retrieve the module map.
Definition: HeaderSearch.h:591
unsigned isCompilingModuleHeader
Whether this header is part of the module that we are building.
Definition: HeaderSearch.h:60
unsigned isImport
True if this is a #import'd or #pragma once file.
Definition: HeaderSearch.h:41
void ClearFileInfo()
Forget everything we know about headers so far.
Definition: HeaderSearch.h:332
One of these records is kept for each identifier that is lexed.
search_dir_iterator system_dir_end() const
Definition: HeaderSearch.h:632
StringRef getModuleCachePath() const
Retrieve the path to the module cache.
Definition: HeaderSearch.h:324
class LLVM_ALIGNAS(8) DependentTemplateSpecializationType const IdentifierInfo * Name
Represents a template specialization type whose template cannot be resolved, e.g. ...
Definition: Type.h:4381
This class represents an Apple concept known as a 'header map'.
Definition: HeaderMap.h:34
bool HasIncludeAliasMap() const
Checks whether the map exists or not.
Definition: HeaderSearch.h:292
const FileEntry * LookupSubframeworkHeader(StringRef Filename, const FileEntry *RelativeFileEnt, SmallVectorImpl< char > *SearchPath, SmallVectorImpl< char > *RelativePath, Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule)
Look up a subframework for the specified #include file.
void setTarget(const TargetInfo &Target)
Set the target information for the header search, if not already known.
const IdentifierInfo * getControllingMacro(ExternalPreprocessorSource *External)
Retrieve the controlling macro for this header file, if any.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:48
Describes a module or submodule.
Definition: Basic/Module.h:47
unsigned External
Whether this header file info was supplied by an external source, and has not changed since...
Definition: HeaderSearch.h:54
search_dir_iterator angled_dir_end() const
Definition: HeaderSearch.h:625
void AddIncludeAlias(StringRef Source, StringRef Dest)
Map the source include name to the dest include name.
Definition: HeaderSearch.h:298
unsigned search_dir_size() const
Definition: HeaderSearch.h:613
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:135
unsigned short NumIncludes
The number of times the file has been included already.
Definition: HeaderSearch.h:79
unsigned Resolved
Whether this structure is considered to already have been "resolved", meaning that it was loaded from...
Definition: HeaderSearch.h:64
search_dir_iterator angled_dir_begin() const
Definition: HeaderSearch.h:622
virtual HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE)=0
Retrieve the header file information for the given file entry.
The preprocessor keeps track of this information for each file that is #included. ...
Definition: HeaderSearch.h:39
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc.
Definition: HeaderSearch.h:137
AnnotatingParser & P
HeaderFileInfo & getFileInfo(const FileEntry *FE)
Return the HeaderFileInfo structure for the specified FileEntry, in preparation for updating it in so...
size_t getTotalMemory() const
ModuleHeaderRole
Flags describing the role of a module header.
Definition: ModuleMap.h:90
StringRef Filename
Definition: Format.cpp:1723
ModuleMap::KnownHeader findModuleForHeader(const FileEntry *File) const
Retrieve the module that corresponds to the given file, if any.
Exposes information about the current target.
void SetSystemHeaderPrefixes(ArrayRef< std::pair< std::string, bool > > P)
Set the list of system header prefixes.
Definition: HeaderSearch.h:287
Abstract interface for external sources of preprocessor information.
HeaderSearchOptions & getHeaderSearchOpts() const
Retrieve the header-search options with which this header search was initialized. ...
Definition: HeaderSearch.h:260
SourceManager & SourceMgr
Definition: Format.cpp:1352
bool loadModuleMapFile(const FileEntry *File, bool IsSystem)
Read the contents of the given module map file.
unsigned header_file_size() const
Definition: HeaderSearch.h:596
void IncrementIncludeCount(const FileEntry *File)
Increment the count for the number of times the specified FileEntry has been entered.
Definition: HeaderSearch.h:440
Module * lookupModule(StringRef ModuleName, bool AllowSearch=true)
Lookup a module Search for a module with the given name.
DirectoryLookup - This class represents one entry in the search list that specifies the search order ...
const HeaderFileInfo * getExistingFileInfo(const FileEntry *FE, bool WantExternal=true) const
Return the HeaderFileInfo structure for the specified FileEntry, if it has ever been filled in...
SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File)
Return whether the specified file is a normal header, a system header, or a C++ friendly system heade...
Definition: HeaderSearch.h:415
void collectAllModules(SmallVectorImpl< Module * > &Modules)
Collect the set of all known, top-level modules.
unsigned isModuleHeader
Whether this header is part of a module.
Definition: HeaderSearch.h:57
#define false
Definition: stdbool.h:33
Encodes a location in the source.
ExternalPreprocessorSource * getExternalLookup() const
Definition: HeaderSearch.h:340
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:53
FileManager & getFileMgr() const
Definition: HeaderSearch.h:262
const IdentifierInfo * ControllingMacro
If this file has a #ifndef XXX (or equivalent) guard that protects the entire contents of the file...
Definition: HeaderSearch.h:96
std::vector< DirectoryLookup >::const_iterator search_dir_iterator
Definition: HeaderSearch.h:610
search_dir_iterator system_dir_begin() const
Definition: HeaderSearch.h:629
unsigned ControllingMacroID
The ID number of the controlling macro.
Definition: HeaderSearch.h:86
An external source of header file information, which may supply information about header files alread...
Definition: HeaderSearch.h:123
void SetExternalSource(ExternalHeaderFileInfoSource *ES)
Set the external source of header information.
Definition: HeaderSearch.h:345
void IncrementFrameworkLookupCount()
Definition: HeaderSearch.h:506
const ModuleMap & getModuleMap() const
Retrieve the module map.
Definition: HeaderSearch.h:594
bool isNonDefault() const
Determine whether this is a non-default header file info, e.g., it corresponds to an actual header we...
Definition: HeaderSearch.h:115
void AddSearchPath(const DirectoryLookup &dir, bool isAngled)
Add an additional search path.
Definition: HeaderSearch.h:278
Cached information about one directory (either on disk or in the virtual file system).
Definition: FileManager.h:40
StringRef Framework
If this header came from a framework include, this is the name of the framework.
Definition: HeaderSearch.h:100
bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root, bool IsSystem)
Determine whether there is a module map that may map the header with the given file name to a (sub)mo...
search_dir_iterator search_dir_end() const
Definition: HeaderSearch.h:612
bool ShouldEnterIncludeFile(Preprocessor &PP, const FileEntry *File, bool isImport, Module *CorrespondingModule)
Mark the specified file as a target of of a #include, #include_next, or #import directive.
void setDirectoryHasModuleMap(const DirectoryEntry *Dir)
Consider modules when including files from this directory.
Definition: HeaderSearch.h:327
const HeaderMap * CreateHeaderMap(const FileEntry *FE)
CreateHeaderMap - This method returns a HeaderMap for the specified FileEntry, uniquing them through ...
search_dir_iterator quoted_dir_begin() const
Definition: HeaderSearch.h:615
HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSea...
StringRef MapHeaderToIncludeAlias(StringRef Source)
MapHeaderToIncludeAlias - Maps one header file name to a different header file name, for use with the include_alias pragma.
Definition: HeaderSearch.h:308
static std::string NormalizeDashIncludePath(StringRef File, FileManager &FileMgr)
bool FirstTimeLexingFile(const FileEntry *File)
Return true if this is the first time encountering this header.
Definition: HeaderSearch.h:454
void SetExternalLookup(ExternalPreprocessorSource *EPS)
Definition: HeaderSearch.h:336
unsigned IndexHeaderMapHeader
Whether this is a header inside a framework that is currently being built.
Definition: HeaderSearch.h:73
unsigned IsValid
Whether this file has been looked up as a header.
Definition: HeaderSearch.h:76
void MarkFileSystemHeader(const FileEntry *File)
Mark the specified file as a system header, e.g.
Definition: HeaderSearch.h:429
A header that is known to reside within a given module, whether it was included or excluded...
Definition: ModuleMap.h:108
void MarkFileIncludeOnce(const FileEntry *File)
Mark the specified file as a "once only" file, e.g.
Definition: HeaderSearch.h:421
void setModuleCachePath(StringRef CachePath)
Set the path to the module cache.
Definition: HeaderSearch.h:319
This class handles loading and caching of source files into memory.
StringRef getUniqueFrameworkName(StringRef Framework)
Retrieve a uniqued framework name.
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:96
void SetFileControllingMacro(const FileEntry *File, const IdentifierInfo *ControllingMacro)
Mark the specified file as having a controlling macro.
Definition: HeaderSearch.h:448