1 //===--- ModuleMap.h - Describe the layout of modules -----------*- 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 ModuleMap interface, which describes the layout of a
11 // module as it relates to headers.
13 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_LEX_MODULEMAP_H
17 #define LLVM_CLANG_LEX_MODULEMAP_H
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"
34 class DiagnosticConsumer;
35 class DiagnosticsEngine;
37 class ModuleMapParser;
39 /// \brief A mechanism to observe the actions of the module map parser as it
40 /// reads module map files.
41 class ModuleMapCallbacks {
43 virtual ~ModuleMapCallbacks() {}
45 /// \brief Called when a module map file has been read.
47 /// \param FileStart A SourceLocation referring to the start of the file's
49 /// \param File The file itself.
50 /// \param IsSystem Whether this is a module map from a system include path.
51 virtual void moduleMapFileRead(SourceLocation FileStart,
52 const FileEntry &File, bool IsSystem) {}
56 SourceManager &SourceMgr;
57 DiagnosticsEngine &Diags;
58 const LangOptions &LangOpts;
59 const TargetInfo *Target;
60 HeaderSearch &HeaderInfo;
62 llvm::SmallVector<std::unique_ptr<ModuleMapCallbacks>, 1> Callbacks;
64 /// \brief The directory used for Clang-supplied, builtin include headers,
65 /// such as "stdint.h".
66 const DirectoryEntry *BuiltinIncludeDir;
68 /// \brief Language options used to parse the module map itself.
70 /// These are always simple C language options.
71 LangOptions MMapLangOpts;
73 // The module that we are building; related to \c LangOptions::CurrentModule.
74 Module *CompilingModule;
77 // The module that the .cc source file is associated with.
79 std::string SourceModuleName;
82 /// \brief The top-level modules that are known.
83 llvm::StringMap<Module *> Modules;
85 /// \brief The number of modules we have created in total.
86 unsigned NumCreatedModules;
89 /// \brief Flags describing the role of a module header.
90 enum ModuleHeaderRole {
91 /// \brief This header is normally included in the module.
93 /// \brief This header is included but private.
95 /// \brief This header is part of the module (for layering purposes) but
96 /// should be textually included.
98 // Caution: Adding an enumerator needs other changes.
99 // Adjust the number of bits for KnownHeader::Storage.
100 // Adjust the bitfield HeaderFileInfo::HeaderRole size.
101 // Adjust the HeaderFileInfoTrait::ReadData streaming.
102 // Adjust the HeaderFileInfoTrait::EmitData streaming.
103 // Adjust ModuleMap::addHeader.
106 /// \brief A header that is known to reside within a given module,
107 /// whether it was included or excluded.
109 llvm::PointerIntPair<Module *, 2, ModuleHeaderRole> Storage;
112 KnownHeader() : Storage(nullptr, NormalHeader) { }
113 KnownHeader(Module *M, ModuleHeaderRole Role) : Storage(M, Role) { }
115 friend bool operator==(const KnownHeader &A, const KnownHeader &B) {
116 return A.Storage == B.Storage;
118 friend bool operator!=(const KnownHeader &A, const KnownHeader &B) {
119 return A.Storage != B.Storage;
122 /// \brief Retrieve the module the header is stored in.
123 Module *getModule() const { return Storage.getPointer(); }
125 /// \brief The role of this header within the module.
126 ModuleHeaderRole getRole() const { return Storage.getInt(); }
128 /// \brief Whether this header is available in the module.
129 bool isAvailable() const {
130 return getModule()->isAvailable();
133 // \brief Whether this known header is valid (i.e., it has an
134 // associated module).
135 explicit operator bool() const {
136 return Storage.getPointer() != nullptr;
140 typedef llvm::SmallPtrSet<const FileEntry *, 1> AdditionalModMapsSet;
143 typedef llvm::DenseMap<const FileEntry *, SmallVector<KnownHeader, 1> >
146 /// \brief Mapping from each header to the module that owns the contents of
150 /// \brief Mapping from directories with umbrella headers to the module
151 /// that is generated from the umbrella header.
153 /// This mapping is used to map headers that haven't explicitly been named
154 /// in the module map over to the module that includes them via its umbrella
156 llvm::DenseMap<const DirectoryEntry *, Module *> UmbrellaDirs;
158 /// \brief The set of attributes that can be attached to a module.
160 Attributes() : IsSystem(), IsExternC(), IsExhaustive() {}
162 /// \brief Whether this is a system module.
163 unsigned IsSystem : 1;
165 /// \brief Whether this is an extern "C" module.
166 unsigned IsExternC : 1;
168 /// \brief Whether this is an exhaustive set of configuration macros.
169 unsigned IsExhaustive : 1;
172 /// \brief A directory for which framework modules can be inferred.
173 struct InferredDirectory {
174 InferredDirectory() : InferModules() {}
176 /// \brief Whether to infer modules from this directory.
177 unsigned InferModules : 1;
179 /// \brief The attributes to use for inferred modules.
182 /// \brief If \c InferModules is non-zero, the module map file that allowed
183 /// inferred modules. Otherwise, nullptr.
184 const FileEntry *ModuleMapFile;
186 /// \brief The names of modules that cannot be inferred within this
188 SmallVector<std::string, 2> ExcludedModules;
191 /// \brief A mapping from directories to information about inferring
192 /// framework modules from within those directories.
193 llvm::DenseMap<const DirectoryEntry *, InferredDirectory> InferredDirectories;
195 /// A mapping from an inferred module to the module map that allowed the
197 llvm::DenseMap<const Module *, const FileEntry *> InferredModuleAllowedBy;
199 llvm::DenseMap<const Module *, AdditionalModMapsSet> AdditionalModMaps;
201 /// \brief Describes whether we haved parsed a particular file as a module
203 llvm::DenseMap<const FileEntry *, bool> ParsedModuleMap;
205 friend class ModuleMapParser;
207 /// \brief Resolve the given export declaration into an actual export
210 /// \param Mod The module in which we're resolving the export declaration.
212 /// \param Unresolved The export declaration to resolve.
214 /// \param Complain Whether this routine should complain about unresolvable
217 /// \returns The resolved export declaration, which will have a NULL pointer
218 /// if the export could not be resolved.
220 resolveExport(Module *Mod, const Module::UnresolvedExportDecl &Unresolved,
221 bool Complain) const;
223 /// \brief Resolve the given module id to an actual module.
225 /// \param Id The module-id to resolve.
227 /// \param Mod The module in which we're resolving the module-id.
229 /// \param Complain Whether this routine should complain about unresolvable
232 /// \returns The resolved module, or null if the module-id could not be
234 Module *resolveModuleId(const ModuleId &Id, Module *Mod, bool Complain) const;
236 /// \brief Looks up the modules that \p File corresponds to.
238 /// If \p File represents a builtin header within Clang's builtin include
239 /// directory, this also loads all of the module maps to see if it will get
240 /// associated with a specific module (e.g. in /usr/include).
241 HeadersMap::iterator findKnownHeader(const FileEntry *File);
243 /// \brief Searches for a module whose umbrella directory contains \p File.
245 /// \param File The header to search for.
247 /// \param IntermediateDirs On success, contains the set of directories
248 /// searched before finding \p File.
249 KnownHeader findHeaderInUmbrellaDirs(const FileEntry *File,
250 SmallVectorImpl<const DirectoryEntry *> &IntermediateDirs);
252 /// \brief Given that \p File is not in the Headers map, look it up within
253 /// umbrella directories and find or create a module for it.
254 KnownHeader findOrCreateModuleForHeaderInUmbrellaDir(const FileEntry *File);
256 /// \brief A convenience method to determine if \p File is (possibly nested)
257 /// in an umbrella directory.
258 bool isHeaderInUmbrellaDirs(const FileEntry *File) {
259 SmallVector<const DirectoryEntry *, 2> IntermediateDirs;
260 return static_cast<bool>(findHeaderInUmbrellaDirs(File, IntermediateDirs));
263 Module *inferFrameworkModule(const DirectoryEntry *FrameworkDir,
264 Attributes Attrs, Module *Parent);
267 /// \brief Construct a new module map.
269 /// \param SourceMgr The source manager used to find module files and headers.
270 /// This source manager should be shared with the header-search mechanism,
271 /// since they will refer to the same headers.
273 /// \param Diags A diagnostic engine used for diagnostics.
275 /// \param LangOpts Language options for this translation unit.
277 /// \param Target The target for this translation unit.
278 ModuleMap(SourceManager &SourceMgr, DiagnosticsEngine &Diags,
279 const LangOptions &LangOpts, const TargetInfo *Target,
280 HeaderSearch &HeaderInfo);
282 /// \brief Destroy the module map.
286 /// \brief Set the target information.
287 void setTarget(const TargetInfo &Target);
289 /// \brief Set the directory that contains Clang-supplied include
290 /// files, such as our stdarg.h or tgmath.h.
291 void setBuiltinIncludeDir(const DirectoryEntry *Dir) {
292 BuiltinIncludeDir = Dir;
295 /// \brief Add a module map callback.
296 void addModuleMapCallbacks(std::unique_ptr<ModuleMapCallbacks> Callback) {
297 Callbacks.push_back(std::move(Callback));
300 /// \brief Retrieve the module that owns the given header file, if any.
302 /// \param File The header file that is likely to be included.
304 /// \returns The module KnownHeader, which provides the module that owns the
305 /// given header file. The KnownHeader is default constructed to indicate
306 /// that no module owns this header file.
307 KnownHeader findModuleForHeader(const FileEntry *File);
309 /// \brief Retrieve all the modules that contain the given header file. This
310 /// may not include umbrella modules, nor information from external sources,
311 /// if they have not yet been inferred / loaded.
313 /// Typically, \ref findModuleForHeader should be used instead, as it picks
314 /// the preferred module for the header.
315 ArrayRef<KnownHeader> findAllModulesForHeader(const FileEntry *File) const;
317 /// \brief Reports errors if a module must not include a specific file.
319 /// \param RequestingModule The module including a file.
321 /// \param FilenameLoc The location of the inclusion's filename.
323 /// \param Filename The included filename as written.
325 /// \param File The included file.
326 void diagnoseHeaderInclusion(Module *RequestingModule,
327 SourceLocation FilenameLoc, StringRef Filename,
328 const FileEntry *File);
330 /// \brief Determine whether the given header is part of a module
331 /// marked 'unavailable'.
332 bool isHeaderInUnavailableModule(const FileEntry *Header) const;
334 /// \brief Determine whether the given header is unavailable as part
335 /// of the specified module.
336 bool isHeaderUnavailableInModule(const FileEntry *Header,
337 const Module *RequestingModule) const;
339 /// \brief Retrieve a module with the given name.
341 /// \param Name The name of the module to look up.
343 /// \returns The named module, if known; otherwise, returns null.
344 Module *findModule(StringRef Name) const;
346 /// \brief Retrieve a module with the given name using lexical name lookup,
347 /// starting at the given context.
349 /// \param Name The name of the module to look up.
351 /// \param Context The module context, from which we will perform lexical
354 /// \returns The named module, if known; otherwise, returns null.
355 Module *lookupModuleUnqualified(StringRef Name, Module *Context) const;
357 /// \brief Retrieve a module with the given name within the given context,
358 /// using direct (qualified) name lookup.
360 /// \param Name The name of the module to look up.
362 /// \param Context The module for which we will look for a submodule. If
363 /// null, we will look for a top-level module.
365 /// \returns The named submodule, if known; otherwose, returns null.
366 Module *lookupModuleQualified(StringRef Name, Module *Context) const;
368 /// \brief Find a new module or submodule, or create it if it does not already
371 /// \param Name The name of the module to find or create.
373 /// \param Parent The module that will act as the parent of this submodule,
374 /// or NULL to indicate that this is a top-level module.
376 /// \param IsFramework Whether this is a framework module.
378 /// \param IsExplicit Whether this is an explicit submodule.
380 /// \returns The found or newly-created module, along with a boolean value
381 /// that will be true if the module is newly-created.
382 std::pair<Module *, bool> findOrCreateModule(StringRef Name, Module *Parent,
386 /// \brief Infer the contents of a framework module map from the given
387 /// framework directory.
388 Module *inferFrameworkModule(const DirectoryEntry *FrameworkDir,
389 bool IsSystem, Module *Parent);
391 /// \brief Retrieve the module map file containing the definition of the given
394 /// \param Module The module whose module map file will be returned, if known.
396 /// \returns The file entry for the module map file containing the given
397 /// module, or NULL if the module definition was inferred.
398 const FileEntry *getContainingModuleMapFile(const Module *Module) const;
400 /// \brief Get the module map file that (along with the module name) uniquely
401 /// identifies this module.
403 /// The particular module that \c Name refers to may depend on how the module
404 /// was found in header search. However, the combination of \c Name and
405 /// this module map will be globally unique for top-level modules. In the case
406 /// of inferred modules, returns the module map that allowed the inference
407 /// (e.g. contained 'module *'). Otherwise, returns
408 /// getContainingModuleMapFile().
409 const FileEntry *getModuleMapFileForUniquing(const Module *M) const;
411 void setInferredModuleAllowedBy(Module *M, const FileEntry *ModuleMap);
413 /// \brief Get any module map files other than getModuleMapFileForUniquing(M)
414 /// that define submodules of a top-level module \p M. This is cheaper than
415 /// getting the module map file for each submodule individually, since the
416 /// expected number of results is very small.
417 AdditionalModMapsSet *getAdditionalModuleMapFiles(const Module *M) {
418 auto I = AdditionalModMaps.find(M);
419 if (I == AdditionalModMaps.end())
424 void addAdditionalModuleMapFile(const Module *M, const FileEntry *ModuleMap) {
425 AdditionalModMaps[M].insert(ModuleMap);
428 /// \brief Resolve all of the unresolved exports in the given module.
430 /// \param Mod The module whose exports should be resolved.
432 /// \param Complain Whether to emit diagnostics for failures.
434 /// \returns true if any errors were encountered while resolving exports,
436 bool resolveExports(Module *Mod, bool Complain);
438 /// \brief Resolve all of the unresolved uses in the given module.
440 /// \param Mod The module whose uses should be resolved.
442 /// \param Complain Whether to emit diagnostics for failures.
444 /// \returns true if any errors were encountered while resolving uses,
446 bool resolveUses(Module *Mod, bool Complain);
448 /// \brief Resolve all of the unresolved conflicts in the given module.
450 /// \param Mod The module whose conflicts should be resolved.
452 /// \param Complain Whether to emit diagnostics for failures.
454 /// \returns true if any errors were encountered while resolving conflicts,
456 bool resolveConflicts(Module *Mod, bool Complain);
458 /// \brief Infers the (sub)module based on the given source location and
461 /// \param Loc The location within the source that we are querying, along
462 /// with its source manager.
464 /// \returns The module that owns this source location, or null if no
465 /// module owns this source location.
466 Module *inferModuleFromLocation(FullSourceLoc Loc);
468 /// \brief Sets the umbrella header of the given module to the given
470 void setUmbrellaHeader(Module *Mod, const FileEntry *UmbrellaHeader,
471 Twine NameAsWritten);
473 /// \brief Sets the umbrella directory of the given module to the given
475 void setUmbrellaDir(Module *Mod, const DirectoryEntry *UmbrellaDir,
476 Twine NameAsWritten);
478 /// \brief Adds this header to the given module.
479 /// \param Role The role of the header wrt the module.
480 void addHeader(Module *Mod, Module::Header Header,
481 ModuleHeaderRole Role, bool Imported = false);
483 /// \brief Marks this header as being excluded from the given module.
484 void excludeHeader(Module *Mod, Module::Header Header);
486 /// \brief Parse the given module map file, and record any modules we
489 /// \param File The file to be parsed.
491 /// \param IsSystem Whether this module map file is in a system header
492 /// directory, and therefore should be considered a system module.
494 /// \param HomeDir The directory in which relative paths within this module
495 /// map file will be resolved.
497 /// \param ExternModuleLoc The location of the "extern module" declaration
498 /// that caused us to load this module map file, if any.
500 /// \returns true if an error occurred, false otherwise.
501 bool parseModuleMapFile(const FileEntry *File, bool IsSystem,
502 const DirectoryEntry *HomeDir,
503 SourceLocation ExternModuleLoc = SourceLocation());
505 /// \brief Dump the contents of the module map, for debugging purposes.
508 typedef llvm::StringMap<Module *>::const_iterator module_iterator;
509 module_iterator module_begin() const { return Modules.begin(); }
510 module_iterator module_end() const { return Modules.end(); }