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

   1 //===--- ModuleMap.h - Describe the layout of modules -----------*- 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 ModuleMap interface, which describes the layout of a
  11 // module as it relates to headers.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15
  16 #ifndef LLVM_CLANG_LEX_MODULEMAP_H
  17 #define LLVM_CLANG_LEX_MODULEMAP_H
  18
  19 #include "clang/Basic/LangOptions.h"
  20 #include "clang/Basic/Module.h"
  21 #include "clang/Basic/SourceManager.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/ADT/StringMap.h"
  26 #include "llvm/ADT/StringRef.h"
  27 #include <string>
  28
  29 namespace clang {
  30
  31 class DirectoryEntry;
  32 class FileEntry;
  33 class FileManager;
  34 class DiagnosticConsumer;
  35 class DiagnosticsEngine;
  36 class HeaderSearch;
  37 class ModuleMapParser;
  38
  39 class ModuleMap {
  40   SourceManager *SourceMgr;
  41   IntrusiveRefCntPtr<DiagnosticsEngine> Diags;
  42   const LangOptions &LangOpts;
  43   const TargetInfo *Target;
  44   HeaderSearch &HeaderInfo;
  45
  46   /// \brief The directory used for Clang-supplied, builtin include headers,
  47   /// such as "stdint.h".
  48   const DirectoryEntry *BuiltinIncludeDir;
  49
  50   /// \brief Language options used to parse the module map itself.
  51   ///
  52   /// These are always simple C language options.
  53   LangOptions MMapLangOpts;
  54
  55   /// \brief The top-level modules that are known.
  56   llvm::StringMap<Module *> Modules;
  57
  58   /// \brief A header that is known to reside within a given module,
  59   /// whether it was included or excluded.
  60   class KnownHeader {
  61     llvm::PointerIntPair<Module *, 1, bool> Storage;
  62
  63   public:
  64     KnownHeader() : Storage(0, false) { }
  65     KnownHeader(Module *M, bool Excluded) : Storage(M, Excluded) { }
  66
  67     /// \brief Retrieve the module the header is stored in.
  68     Module *getModule() const { return Storage.getPointer(); }
  69
  70     /// \brief Whether this header is explicitly excluded from the module.
  71     bool isExcluded() const { return Storage.getInt(); }
  72
  73     /// \brief Whether this header is available in the module.
  74     bool isAvailable() const {
  75       return !isExcluded() && getModule()->isAvailable();
  76     }
  77
  78     // \brief Whether this known header is valid (i.e., it has an
  79     // associated module).
  80     operator bool() const { return Storage.getPointer() != 0; }
  81   };
  82
  83   typedef llvm::DenseMap<const FileEntry *, KnownHeader> HeadersMap;
  84
  85   /// \brief Mapping from each header to the module that owns the contents of the
  86   /// that header.
  87   HeadersMap Headers;
  88
  89   /// \brief Mapping from directories with umbrella headers to the module
  90   /// that is generated from the umbrella header.
  91   ///
  92   /// This mapping is used to map headers that haven't explicitly been named
  93   /// in the module map over to the module that includes them via its umbrella
  94   /// header.
  95   llvm::DenseMap<const DirectoryEntry *, Module *> UmbrellaDirs;
  96
  97   /// \brief A directory for which framework modules can be inferred.
  98   struct InferredDirectory {
  99     InferredDirectory() : InferModules(), InferSystemModules() { }
 100
 101     /// \brief Whether to infer modules from this directory.
 102     unsigned InferModules : 1;
 103
 104     /// \brief Whether the modules we infer are [system] modules.
 105     unsigned InferSystemModules : 1;
 106
 107     /// \brief The names of modules that cannot be inferred within this
 108     /// directory.
 109     SmallVector<std::string, 2> ExcludedModules;
 110   };
 111
 112   /// \brief A mapping from directories to information about inferring
 113   /// framework modules from within those directories.
 114   llvm::DenseMap<const DirectoryEntry *, InferredDirectory> InferredDirectories;
 115
 116   /// \brief Describes whether we haved parsed a particular file as a module
 117   /// map.
 118   llvm::DenseMap<const FileEntry *, bool> ParsedModuleMap;
 119
 120   friend class ModuleMapParser;
 121
 122   /// \brief Resolve the given export declaration into an actual export
 123   /// declaration.
 124   ///
 125   /// \param Mod The module in which we're resolving the export declaration.
 126   ///
 127   /// \param Unresolved The export declaration to resolve.
 128   ///
 129   /// \param Complain Whether this routine should complain about unresolvable
 130   /// exports.
 131   ///
 132   /// \returns The resolved export declaration, which will have a NULL pointer
 133   /// if the export could not be resolved.
 134   Module::ExportDecl
 135   resolveExport(Module *Mod, const Module::UnresolvedExportDecl &Unresolved,
 136                 bool Complain) const;
 137
 138   /// \brief Resolve the given module id to an actual module.
 139   ///
 140   /// \param Id The module-id to resolve.
 141   ///
 142   /// \param Mod The module in which we're resolving the module-id.
 143   ///
 144   /// \param Complain Whether this routine should complain about unresolvable
 145   /// module-ids.
 146   ///
 147   /// \returns The resolved module, or null if the module-id could not be
 148   /// resolved.
 149   Module *resolveModuleId(const ModuleId &Id, Module *Mod, bool Complain) const;
 150
 151 public:
 152   /// \brief Construct a new module map.
 153   ///
 154   /// \param FileMgr The file manager used to find module files and headers.
 155   /// This file manager should be shared with the header-search mechanism, since
 156   /// they will refer to the same headers.
 157   ///
 158   /// \param DC A diagnostic consumer that will be cloned for use in generating
 159   /// diagnostics.
 160   ///
 161   /// \param LangOpts Language options for this translation unit.
 162   ///
 163   /// \param Target The target for this translation unit.
 164   ModuleMap(FileManager &FileMgr, DiagnosticConsumer &DC,
 165             const LangOptions &LangOpts, const TargetInfo *Target,
 166             HeaderSearch &HeaderInfo);
 167
 168   /// \brief Destroy the module map.
 169   ///
 170   ~ModuleMap();
 171
 172   /// \brief Set the target information.
 173   void setTarget(const TargetInfo &Target);
 174
 175   /// \brief Set the directory that contains Clang-supplied include
 176   /// files, such as our stdarg.h or tgmath.h.
 177   void setBuiltinIncludeDir(const DirectoryEntry *Dir) {
 178     BuiltinIncludeDir = Dir;
 179   }
 180
 181   /// \brief Retrieve the module that owns the given header file, if any.
 182   ///
 183   /// \param File The header file that is likely to be included.
 184   ///
 185   /// \returns The module that owns the given header file, or null to indicate
 186   /// that no module owns this header file.
 187   Module *findModuleForHeader(const FileEntry *File);
 188
 189   /// \brief Determine whether the given header is part of a module
 190   /// marked 'unavailable'.
 191   bool isHeaderInUnavailableModule(const FileEntry *Header) const;
 192
 193   /// \brief Retrieve a module with the given name.
 194   ///
 195   /// \param Name The name of the module to look up.
 196   ///
 197   /// \returns The named module, if known; otherwise, returns null.
 198   Module *findModule(StringRef Name) const;
 199
 200   /// \brief Retrieve a module with the given name using lexical name lookup,
 201   /// starting at the given context.
 202   ///
 203   /// \param Name The name of the module to look up.
 204   ///
 205   /// \param Context The module context, from which we will perform lexical
 206   /// name lookup.
 207   ///
 208   /// \returns The named module, if known; otherwise, returns null.
 209   Module *lookupModuleUnqualified(StringRef Name, Module *Context) const;
 210
 211   /// \brief Retrieve a module with the given name within the given context,
 212   /// using direct (qualified) name lookup.
 213   ///
 214   /// \param Name The name of the module to look up.
 215   ///
 216   /// \param Context The module for which we will look for a submodule. If
 217   /// null, we will look for a top-level module.
 218   ///
 219   /// \returns The named submodule, if known; otherwose, returns null.
 220   Module *lookupModuleQualified(StringRef Name, Module *Context) const;
 221
 222   /// \brief Find a new module or submodule, or create it if it does not already
 223   /// exist.
 224   ///
 225   /// \param Name The name of the module to find or create.
 226   ///
 227   /// \param Parent The module that will act as the parent of this submodule,
 228   /// or NULL to indicate that this is a top-level module.
 229   ///
 230   /// \param IsFramework Whether this is a framework module.
 231   ///
 232   /// \param IsExplicit Whether this is an explicit submodule.
 233   ///
 234   /// \returns The found or newly-created module, along with a boolean value
 235   /// that will be true if the module is newly-created.
 236   std::pair<Module *, bool> findOrCreateModule(StringRef Name, Module *Parent,
 237                                                bool IsFramework,
 238                                                bool IsExplicit);
 239
 240   /// \brief Determine whether we can infer a framework module a framework
 241   /// with the given name in the given
 242   ///
 243   /// \param ParentDir The directory that is the parent of the framework
 244   /// directory.
 245   ///
 246   /// \param Name The name of the module.
 247   ///
 248   /// \param IsSystem Will be set to 'true' if the inferred module must be a
 249   /// system module.
 250   ///
 251   /// \returns true if we are allowed to infer a framework module, and false
 252   /// otherwise.
 253   bool canInferFrameworkModule(const DirectoryEntry *ParentDir,
 254                                StringRef Name, bool &IsSystem) const;
 255
 256   /// \brief Infer the contents of a framework module map from the given
 257   /// framework directory.
 258   Module *inferFrameworkModule(StringRef ModuleName,
 259                                const DirectoryEntry *FrameworkDir,
 260                                bool IsSystem, Module *Parent);
 261
 262   /// \brief Retrieve the module map file containing the definition of the given
 263   /// module.
 264   ///
 265   /// \param Module The module whose module map file will be returned, if known.
 266   ///
 267   /// \returns The file entry for the module map file containing the given
 268   /// module, or NULL if the module definition was inferred.
 269   const FileEntry *getContainingModuleMapFile(Module *Module) const;
 270
 271   /// \brief Resolve all of the unresolved exports in the given module.
 272   ///
 273   /// \param Mod The module whose exports should be resolved.
 274   ///
 275   /// \param Complain Whether to emit diagnostics for failures.
 276   ///
 277   /// \returns true if any errors were encountered while resolving exports,
 278   /// false otherwise.
 279   bool resolveExports(Module *Mod, bool Complain);
 280
 281   /// \brief Resolve all of the unresolved conflicts in the given module.
 282   ///
 283   /// \param Mod The module whose conflicts should be resolved.
 284   ///
 285   /// \param Complain Whether to emit diagnostics for failures.
 286   ///
 287   /// \returns true if any errors were encountered while resolving conflicts,
 288   /// false otherwise.
 289   bool resolveConflicts(Module *Mod, bool Complain);
 290
 291   /// \brief Infers the (sub)module based on the given source location and
 292   /// source manager.
 293   ///
 294   /// \param Loc The location within the source that we are querying, along
 295   /// with its source manager.
 296   ///
 297   /// \returns The module that owns this source location, or null if no
 298   /// module owns this source location.
 299   Module *inferModuleFromLocation(FullSourceLoc Loc);
 300
 301   /// \brief Sets the umbrella header of the given module to the given
 302   /// header.
 303   void setUmbrellaHeader(Module *Mod, const FileEntry *UmbrellaHeader);
 304
 305   /// \brief Sets the umbrella directory of the given module to the given
 306   /// directory.
 307   void setUmbrellaDir(Module *Mod, const DirectoryEntry *UmbrellaDir);
 308
 309   /// \brief Adds this header to the given module.
 310   /// \param Excluded Whether this header is explicitly excluded from the
 311   /// module; otherwise, it's included in the module.
 312   void addHeader(Module *Mod, const FileEntry *Header, bool Excluded);
 313
 314   /// \brief Parse the given module map file, and record any modules we
 315   /// encounter.
 316   ///
 317   /// \param File The file to be parsed.
 318   ///
 319   /// \returns true if an error occurred, false otherwise.
 320   bool parseModuleMapFile(const FileEntry *File);
 321
 322   /// \brief Dump the contents of the module map, for debugging purposes.
 323   void dump();
 324
 325   typedef llvm::StringMap<Module *>::const_iterator module_iterator;
 326   module_iterator module_begin() const { return Modules.begin(); }
 327   module_iterator module_end()   const { return Modules.end(); }
 328 };
 329
 330 }
 331 #endif