contrib/llvm/tools/clang/include/clang/Lex/HeaderSearch.h

   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
  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"
  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.
  39 struct HeaderFileInfo {
  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.
  60   unsigned isCompilingModuleHeader : 1;
  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.
  86   unsigned ControllingMacroID;
  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.
  96   const IdentifierInfo *ControllingMacro;
  97
  98   /// \brief If this header came from a framework include, this is the name
  99   /// of the framework.
 100   StringRef Framework;
 101
 102   HeaderFileInfo()
 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)  {}
 107
 108   /// \brief Retrieve the controlling macro for this header file, if
 109   /// any.
 110   const IdentifierInfo *
 111   getControllingMacro(ExternalPreprocessorSource *External);
 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 {
 116     return isImport || isPragmaOnce || NumIncludes || ControllingMacro ||
 117       ControllingMacroID;
 118   }
 119 };
 120
 121 /// \brief An external source of header file information, which may supply
 122 /// information about header files already included.
 123 class ExternalHeaderFileInfoSource {
 124 public:
 125   virtual ~ExternalHeaderFileInfoSource();
 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.
 137 class HeaderSearch {
 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.
 150   std::shared_ptr<HeaderSearchOptions> HSOpts;
 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   // HeaderSearch doesn't support default or copy construction.
 245   HeaderSearch(const HeaderSearch&) = delete;
 246   void operator=(const HeaderSearch&) = delete;
 247
 248   friend class DirectoryLookup;
 249
 250 public:
 251   HeaderSearch(std::shared_ptr<HeaderSearchOptions> HSOpts,
 252                SourceManager &SourceMgr, DiagnosticsEngine &Diags,
 253                const LangOptions &LangOpts, const TargetInfo *Target);
 254   ~HeaderSearch();
 255
 256   /// \brief Retrieve the header-search options with which this header search
 257   /// was initialized.
 258   HeaderSearchOptions &getHeaderSearchOpts() const { return *HSOpts; }
 259
 260   FileManager &getFileMgr() const { return FileMgr; }
 261
 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");
 268     SearchDirs = dirs;
 269     AngledDirIdx = angledDirIdx;
 270     SystemDirIdx = systemDirIdx;
 271     NoCurDirSearch = noCurDirSearch;
 272     //LookupFileCache.clear();
 273   }
 274
 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);
 279     if (!isAngled)
 280       AngledDirIdx++;
 281     SystemDirIdx++;
 282   }
 283
 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());
 287   }
 288
 289   /// \brief Checks whether the map exists or not.
 290   bool HasIncludeAliasMap() const { return (bool)IncludeAliases; }
 291
 292   /// \brief Map the source include name to the dest include name.
 293   ///
 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) {
 297     if (!IncludeAliases)
 298       IncludeAliases.reset(new IncludeAliasMap);
 299     (*IncludeAliases)[Source] = Dest;
 300   }
 301
 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");
 308
 309     // Do any filename replacements before anything else
 310     IncludeAliasMap::const_iterator Iter = IncludeAliases->find(Source);
 311     if (Iter != IncludeAliases->end())
 312       return Iter->second;
 313     return StringRef();
 314   }
 315
 316   /// \brief Set the path to the module cache.
 317   void setModuleCachePath(StringRef CachePath) {
 318     ModuleCachePath = CachePath;
 319   }
 320
 321   /// \brief Retrieve the path to the module cache.
 322   StringRef getModuleCachePath() const { return ModuleCachePath; }
 323
 324   /// \brief Consider modules when including files from this directory.
 325   void setDirectoryHasModuleMap(const DirectoryEntry* Dir) {
 326     DirectoryHasModuleMap[Dir] = true;
 327   }
 328
 329   /// \brief Forget everything we know about headers so far.
 330   void ClearFileInfo() {
 331     FileInfo.clear();
 332   }
 333
 334   void SetExternalLookup(ExternalPreprocessorSource *EPS) {
 335     ExternalLookup = EPS;
 336   }
 337
 338   ExternalPreprocessorSource *getExternalLookup() const {
 339     return ExternalLookup;
 340   }
 341
 342   /// \brief Set the external source of header information.
 343   void SetExternalSource(ExternalHeaderFileInfoSource *ES) {
 344     ExternalSource = ES;
 345   }
 346
 347   /// \brief Set the target information for the header search, if not
 348   /// already known.
 349   void setTarget(const TargetInfo &Target);
 350
 351   /// \brief Given a "foo" or \<foo> reference, look up the indicated file,
 352   /// return null on failure.
 353   ///
 354   /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member
 355   /// the file was found in, or null if not applicable.
 356   ///
 357   /// \param IncludeLoc Used for diagnostics if valid.
 358   ///
 359   /// \param isAngled indicates whether the file reference is a <> reference.
 360   ///
 361   /// \param CurDir If non-null, the file was found in the specified directory
 362   /// search location.  This is used to implement \#include_next.
 363   ///
 364   /// \param Includers Indicates where the \#including file(s) are, in case
 365   /// relative searches are needed. In reverse order of inclusion.
 366   ///
 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.
 370   ///
 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.
 374   ///
 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   ///
 379   /// \param IsMapped If non-null, and the search involved header maps, set to
 380   /// true.
 381   const FileEntry *LookupFile(
 382       StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
 383       const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
 384       ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
 385       SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
 386       Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
 387       bool *IsMapped, bool SkipCache = false, bool BuildSystemModule = false);
 388
 389   /// \brief Look up a subframework for the specified \#include file.
 390   ///
 391   /// For example, if \#include'ing <HIToolbox/HIToolbox.h> from
 392   /// within ".../Carbon.framework/Headers/Carbon.h", check to see if
 393   /// HIToolbox is a subframework within Carbon.framework.  If so, return
 394   /// the FileEntry for the designated file, otherwise return null.
 395   const FileEntry *LookupSubframeworkHeader(
 396       StringRef Filename, const FileEntry *RelativeFileEnt,
 397       SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
 398       Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule);
 399
 400   /// \brief Look up the specified framework name in our framework cache.
 401   /// \returns The DirectoryEntry it is in if we know, null otherwise.
 402   FrameworkCacheEntry &LookupFrameworkCache(StringRef FWName) {
 403     return FrameworkMap[FWName];
 404   }
 405
 406   /// \brief Mark the specified file as a target of of a \#include,
 407   /// \#include_next, or \#import directive.
 408   ///
 409   /// \return false if \#including the file will have no effect or true
 410   /// if we should include it.
 411   bool ShouldEnterIncludeFile(Preprocessor &PP, const FileEntry *File,
 412                               bool isImport, bool ModulesEnabled,
 413                               Module *CorrespondingModule);
 414
 415   /// \brief Return whether the specified file is a normal header,
 416   /// a system header, or a C++ friendly system header.
 417   SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File) {
 418     return (SrcMgr::CharacteristicKind)getFileInfo(File).DirInfo;
 419   }
 420
 421   /// \brief Mark the specified file as a "once only" file, e.g. due to
 422   /// \#pragma once.
 423   void MarkFileIncludeOnce(const FileEntry *File) {
 424     HeaderFileInfo &FI = getFileInfo(File);
 425     FI.isImport = true;
 426     FI.isPragmaOnce = true;
 427   }
 428
 429   /// \brief Mark the specified file as a system header, e.g. due to
 430   /// \#pragma GCC system_header.
 431   void MarkFileSystemHeader(const FileEntry *File) {
 432     getFileInfo(File).DirInfo = SrcMgr::C_System;
 433   }
 434
 435   /// \brief Mark the specified file as part of a module.
 436   void MarkFileModuleHeader(const FileEntry *File,
 437                             ModuleMap::ModuleHeaderRole Role,
 438                             bool IsCompiledModuleHeader);
 439
 440   /// \brief Increment the count for the number of times the specified
 441   /// FileEntry has been entered.
 442   void IncrementIncludeCount(const FileEntry *File) {
 443     ++getFileInfo(File).NumIncludes;
 444   }
 445
 446   /// \brief Mark the specified file as having a controlling macro.
 447   ///
 448   /// This is used by the multiple-include optimization to eliminate
 449   /// no-op \#includes.
 450   void SetFileControllingMacro(const FileEntry *File,
 451                                const IdentifierInfo *ControllingMacro) {
 452     getFileInfo(File).ControllingMacro = ControllingMacro;
 453   }
 454
 455   /// \brief Return true if this is the first time encountering this header.
 456   bool FirstTimeLexingFile(const FileEntry *File) {
 457     return getFileInfo(File).NumIncludes == 1;
 458   }
 459
 460   /// \brief Determine whether this file is intended to be safe from
 461   /// multiple inclusions, e.g., it has \#pragma once or a controlling
 462   /// macro.
 463   ///
 464   /// This routine does not consider the effect of \#import
 465   bool isFileMultipleIncludeGuarded(const FileEntry *File);
 466
 467   /// CreateHeaderMap - This method returns a HeaderMap for the specified
 468   /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
 469   const HeaderMap *CreateHeaderMap(const FileEntry *FE);
 470
 471   /// \brief Get filenames for all registered header maps.
 472   void getHeaderMapFileNames(SmallVectorImpl<std::string> &Names) const;
 473
 474   /// \brief Retrieve the name of the module file that should be used to
 475   /// load the given module.
 476   ///
 477   /// \param Module The module whose module file name will be returned.
 478   ///
 479   /// \returns The name of the module file that corresponds to this module,
 480   /// or an empty string if this module does not correspond to any module file.
 481   std::string getModuleFileName(Module *Module);
 482
 483   /// \brief Retrieve the name of the module file that should be used to
 484   /// load a module with the given name.
 485   ///
 486   /// \param ModuleName The module whose module file name will be returned.
 487   ///
 488   /// \param ModuleMapPath A path that when combined with \c ModuleName
 489   /// uniquely identifies this module. See Module::ModuleMap.
 490   ///
 491   /// \param UsePrebuiltPath Whether we should use the prebuilt module path.
 492   ///
 493   /// \returns The name of the module file that corresponds to this module,
 494   /// or an empty string if this module does not correspond to any module file.
 495   std::string getModuleFileName(StringRef ModuleName, StringRef ModuleMapPath,
 496                                 bool UsePrebuiltPath);
 497
 498   /// \brief Lookup a module Search for a module with the given name.
 499   ///
 500   /// \param ModuleName The name of the module we're looking for.
 501   ///
 502   /// \param AllowSearch Whether we are allowed to search in the various
 503   /// search directories to produce a module definition. If not, this lookup
 504   /// will only return an already-known module.
 505   ///
 506   /// \returns The module with the given name.
 507   Module *lookupModule(StringRef ModuleName, bool AllowSearch = true);
 508
 509   /// \brief Try to find a module map file in the given directory, returning
 510   /// \c nullptr if none is found.
 511   const FileEntry *lookupModuleMapFile(const DirectoryEntry *Dir,
 512                                        bool IsFramework);
 513
 514   void IncrementFrameworkLookupCount() { ++NumFrameworkLookups; }
 515
 516   /// \brief Determine whether there is a module map that may map the header
 517   /// with the given file name to a (sub)module.
 518   /// Always returns false if modules are disabled.
 519   ///
 520   /// \param Filename The name of the file.
 521   ///
 522   /// \param Root The "root" directory, at which we should stop looking for
 523   /// module maps.
 524   ///
 525   /// \param IsSystem Whether the directories we're looking at are system
 526   /// header directories.
 527   bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root,
 528                     bool IsSystem);
 529
 530   /// \brief Retrieve the module that corresponds to the given file, if any.
 531   ///
 532   /// \param File The header that we wish to map to a module.
 533   /// \param AllowTextual Whether we want to find textual headers too.
 534   ModuleMap::KnownHeader findModuleForHeader(const FileEntry *File,
 535                                              bool AllowTextual = false) const;
 536
 537   /// \brief Read the contents of the given module map file.
 538   ///
 539   /// \param File The module map file.
 540   /// \param IsSystem Whether this file is in a system header directory.
 541   /// \param ID If the module map file is already mapped (perhaps as part of
 542   ///        processing a preprocessed module), the ID of the file.
 543   /// \param Offset [inout] An offset within ID to start parsing. On exit,
 544   ///        filled by the end of the parsed contents (either EOF or the
 545   ///        location of an end-of-module-map pragma).
 546   ///
 547   /// \returns true if an error occurred, false otherwise.
 548   bool loadModuleMapFile(const FileEntry *File, bool IsSystem,
 549                          FileID ID = FileID(), unsigned *Offset = nullptr);
 550
 551   /// \brief Collect the set of all known, top-level modules.
 552   ///
 553   /// \param Modules Will be filled with the set of known, top-level modules.
 554   void collectAllModules(SmallVectorImpl<Module *> &Modules);
 555
 556   /// \brief Load all known, top-level system modules.
 557   void loadTopLevelSystemModules();
 558
 559 private:
 560
 561   /// \brief Lookup a module with the given module name and search-name.
 562   ///
 563   /// \param ModuleName The name of the module we're looking for.
 564   ///
 565   /// \param SearchName The "search-name" to derive filesystem paths from
 566   /// when looking for the module map; this is usually equal to ModuleName,
 567   /// but for compatibility with some buggy frameworks, additional attempts
 568   /// may be made to find the module under a related-but-different search-name.
 569   ///
 570   /// \returns The module named ModuleName.
 571   Module *lookupModule(StringRef ModuleName, StringRef SearchName);
 572
 573   /// \brief Retrieve a module with the given name, which may be part of the
 574   /// given framework.
 575   ///
 576   /// \param Name The name of the module to retrieve.
 577   ///
 578   /// \param Dir The framework directory (e.g., ModuleName.framework).
 579   ///
 580   /// \param IsSystem Whether the framework directory is part of the system
 581   /// frameworks.
 582   ///
 583   /// \returns The module, if found; otherwise, null.
 584   Module *loadFrameworkModule(StringRef Name,
 585                               const DirectoryEntry *Dir,
 586                               bool IsSystem);
 587
 588   /// \brief Load all of the module maps within the immediate subdirectories
 589   /// of the given search directory.
 590   void loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir);
 591
 592   /// \brief Find and suggest a usable module for the given file.
 593   ///
 594   /// \return \c true if the file can be used, \c false if we are not permitted to
 595   ///         find this file due to requirements from \p RequestingModule.
 596   bool findUsableModuleForHeader(const FileEntry *File,
 597                                  const DirectoryEntry *Root,
 598                                  Module *RequestingModule,
 599                                  ModuleMap::KnownHeader *SuggestedModule,
 600                                  bool IsSystemHeaderDir);
 601
 602   /// \brief Find and suggest a usable module for the given file, which is part of
 603   /// the specified framework.
 604   ///
 605   /// \return \c true if the file can be used, \c false if we are not permitted to
 606   ///         find this file due to requirements from \p RequestingModule.
 607   bool findUsableModuleForFrameworkHeader(
 608       const FileEntry *File, StringRef FrameworkDir, Module *RequestingModule,
 609       ModuleMap::KnownHeader *SuggestedModule, bool IsSystemFramework);
 610
 611   /// \brief Look up the file with the specified name and determine its owning
 612   /// module.
 613   const FileEntry *
 614   getFileAndSuggestModule(StringRef FileName, SourceLocation IncludeLoc,
 615                           const DirectoryEntry *Dir, bool IsSystemHeaderDir,
 616                           Module *RequestingModule,
 617                           ModuleMap::KnownHeader *SuggestedModule);
 618
 619 public:
 620   /// \brief Retrieve the module map.
 621   ModuleMap &getModuleMap() { return ModMap; }
 622
 623   /// \brief Retrieve the module map.
 624   const ModuleMap &getModuleMap() const { return ModMap; }
 625
 626   unsigned header_file_size() const { return FileInfo.size(); }
 627
 628   /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
 629   /// in preparation for updating it in some way.
 630   HeaderFileInfo &getFileInfo(const FileEntry *FE);
 631
 632   /// \brief Return the HeaderFileInfo structure for the specified FileEntry,
 633   /// if it has ever been filled in.
 634   /// \param WantExternal Whether the caller wants purely-external header file
 635   ///        info (where \p External is true).
 636   const HeaderFileInfo *getExistingFileInfo(const FileEntry *FE,
 637                                             bool WantExternal = true) const;
 638
 639   // Used by external tools
 640   typedef std::vector<DirectoryLookup>::const_iterator search_dir_iterator;
 641   search_dir_iterator search_dir_begin() const { return SearchDirs.begin(); }
 642   search_dir_iterator search_dir_end() const { return SearchDirs.end(); }
 643   unsigned search_dir_size() const { return SearchDirs.size(); }
 644
 645   search_dir_iterator quoted_dir_begin() const {
 646     return SearchDirs.begin();
 647   }
 648   search_dir_iterator quoted_dir_end() const {
 649     return SearchDirs.begin() + AngledDirIdx;
 650   }
 651
 652   search_dir_iterator angled_dir_begin() const {
 653     return SearchDirs.begin() + AngledDirIdx;
 654   }
 655   search_dir_iterator angled_dir_end() const {
 656     return SearchDirs.begin() + SystemDirIdx;
 657   }
 658
 659   search_dir_iterator system_dir_begin() const {
 660     return SearchDirs.begin() + SystemDirIdx;
 661   }
 662   search_dir_iterator system_dir_end() const { return SearchDirs.end(); }
 663
 664   /// \brief Retrieve a uniqued framework name.
 665   StringRef getUniqueFrameworkName(StringRef Framework);
 666
 667   /// \brief Suggest a path by which the specified file could be found, for
 668   /// use in diagnostics to suggest a #include.
 669   ///
 670   /// \param IsSystem If non-null, filled in to indicate whether the suggested
 671   ///        path is relative to a system header directory.
 672   std::string suggestPathToFileForDiagnostics(const FileEntry *File,
 673                                               bool *IsSystem = nullptr);
 674
 675   void PrintStats();
 676
 677   size_t getTotalMemory() const;
 678
 679 private:
 680   /// \brief Describes what happened when we tried to load a module map file.
 681   enum LoadModuleMapResult {
 682     /// \brief The module map file had already been loaded.
 683     LMM_AlreadyLoaded,
 684     /// \brief The module map file was loaded by this invocation.
 685     LMM_NewlyLoaded,
 686     /// \brief There is was directory with the given name.
 687     LMM_NoDirectory,
 688     /// \brief There was either no module map file or the module map file was
 689     /// invalid.
 690     LMM_InvalidModuleMap
 691   };
 692
 693   LoadModuleMapResult loadModuleMapFileImpl(const FileEntry *File,
 694                                             bool IsSystem,
 695                                             const DirectoryEntry *Dir,
 696                                             FileID ID = FileID(),
 697                                             unsigned *Offset = nullptr);
 698
 699   /// \brief Try to load the module map file in the given directory.
 700   ///
 701   /// \param DirName The name of the directory where we will look for a module
 702   /// map file.
 703   /// \param IsSystem Whether this is a system header directory.
 704   /// \param IsFramework Whether this is a framework directory.
 705   ///
 706   /// \returns The result of attempting to load the module map file from the
 707   /// named directory.
 708   LoadModuleMapResult loadModuleMapFile(StringRef DirName, bool IsSystem,
 709                                         bool IsFramework);
 710
 711   /// \brief Try to load the module map file in the given directory.
 712   ///
 713   /// \param Dir The directory where we will look for a module map file.
 714   /// \param IsSystem Whether this is a system header directory.
 715   /// \param IsFramework Whether this is a framework directory.
 716   ///
 717   /// \returns The result of attempting to load the module map file from the
 718   /// named directory.
 719   LoadModuleMapResult loadModuleMapFile(const DirectoryEntry *Dir,
 720                                         bool IsSystem, bool IsFramework);
 721 };
 722
 723 }  // end namespace clang
 724
 725 #endif