1 //===--- Module.h - Describe a module ---------------------------*- 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 //===----------------------------------------------------------------------===//
11 /// \brief Defines the clang::Module class, which describes a module in the
14 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_BASIC_MODULE_H
16 #define LLVM_CLANG_BASIC_MODULE_H
18 #include "clang/Basic/FileManager.h"
19 #include "clang/Basic/SourceLocation.h"
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/DenseSet.h"
22 #include "llvm/ADT/PointerIntPair.h"
23 #include "llvm/ADT/PointerUnion.h"
24 #include "llvm/ADT/SetVector.h"
25 #include "llvm/ADT/SmallVector.h"
26 #include "llvm/ADT/STLExtras.h"
27 #include "llvm/ADT/StringMap.h"
28 #include "llvm/ADT/StringRef.h"
43 /// \brief Describes the name of a module.
44 typedef SmallVector<std::pair<std::string, SourceLocation>, 2> ModuleId;
46 /// \brief Describes a module or submodule.
49 /// \brief The name of this module.
52 /// \brief The location of the module definition.
53 SourceLocation DefinitionLoc;
55 /// \brief The parent of this module. This will be NULL for the top-level
59 /// \brief The build directory of this module. This is the directory in
60 /// which the module is notionally built, and relative to which its headers
62 const DirectoryEntry *Directory;
64 /// \brief The umbrella header or directory.
65 llvm::PointerUnion<const DirectoryEntry *, const FileEntry *> Umbrella;
67 /// \brief The module signature.
70 /// \brief The name of the umbrella entry, as written in the module map.
71 std::string UmbrellaAsWritten;
74 /// \brief The submodules of this module, indexed by name.
75 std::vector<Module *> SubModules;
77 /// \brief A mapping from the submodule name to the index into the
78 /// \c SubModules vector at which that submodule resides.
79 llvm::StringMap<unsigned> SubModuleIndex;
81 /// \brief The AST file if this is a top-level module which has a
82 /// corresponding serialized AST file, or null otherwise.
83 const FileEntry *ASTFile;
85 /// \brief The top-level headers associated with this module.
86 llvm::SmallSetVector<const FileEntry *, 2> TopHeaders;
88 /// \brief top-level header filenames that aren't resolved to FileEntries yet.
89 std::vector<std::string> TopHeaderNames;
91 /// \brief Cache of modules visible to lookup in this module.
92 mutable llvm::DenseSet<const Module*> VisibleModulesCache;
94 /// The ID used when referencing this module within a VisibleModuleSet.
95 unsigned VisibilityID;
105 static const int NumHeaderKinds = HK_Excluded + 1;
107 /// \brief Information about a header directive as found in the module map
110 std::string NameAsWritten;
111 const FileEntry *Entry;
113 explicit operator bool() { return Entry; }
116 /// \brief Information about a directory name as found in the module map
118 struct DirectoryName {
119 std::string NameAsWritten;
120 const DirectoryEntry *Entry;
122 explicit operator bool() { return Entry; }
125 /// \brief The headers that are part of this module.
126 SmallVector<Header, 2> Headers[5];
128 /// \brief Stored information about a header directive that was found in the
129 /// module map file but has not been resolved to a file.
130 struct UnresolvedHeaderDirective {
131 SourceLocation FileNameLoc;
132 std::string FileName;
136 /// \brief Headers that are mentioned in the module map file but could not be
137 /// found on the file system.
138 SmallVector<UnresolvedHeaderDirective, 1> MissingHeaders;
140 /// \brief An individual requirement: a feature name and a flag indicating
141 /// the required state of that feature.
142 typedef std::pair<std::string, bool> Requirement;
144 /// \brief The set of language features required to use this module.
146 /// If any of these requirements are not available, the \c IsAvailable bit
147 /// will be false to indicate that this (sub)module is not available.
148 SmallVector<Requirement, 2> Requirements;
150 /// \brief Whether this module is missing a feature from \c Requirements.
151 unsigned IsMissingRequirement : 1;
153 /// \brief Whether we tried and failed to load a module file for this module.
154 unsigned HasIncompatibleModuleFile : 1;
156 /// \brief Whether this module is available in the current translation unit.
158 /// If the module is missing headers or does not meet all requirements then
159 /// this bit will be 0.
160 unsigned IsAvailable : 1;
162 /// \brief Whether this module was loaded from a module file.
163 unsigned IsFromModuleFile : 1;
165 /// \brief Whether this is a framework module.
166 unsigned IsFramework : 1;
168 /// \brief Whether this is an explicit submodule.
169 unsigned IsExplicit : 1;
171 /// \brief Whether this is a "system" module (which assumes that all
172 /// headers in it are system headers).
173 unsigned IsSystem : 1;
175 /// \brief Whether this is an 'extern "C"' module (which implicitly puts all
176 /// headers in it within an 'extern "C"' block, and allows the module to be
177 /// imported within such a block).
178 unsigned IsExternC : 1;
180 /// \brief Whether this is an inferred submodule (module * { ... }).
181 unsigned IsInferred : 1;
183 /// \brief Whether we should infer submodules for this module based on
186 /// Submodules can only be inferred for modules with an umbrella header.
187 unsigned InferSubmodules : 1;
189 /// \brief Whether, when inferring submodules, the inferred submodules
190 /// should be explicit.
191 unsigned InferExplicitSubmodules : 1;
193 /// \brief Whether, when inferring submodules, the inferr submodules should
194 /// export all modules they import (e.g., the equivalent of "export *").
195 unsigned InferExportWildcard : 1;
197 /// \brief Whether the set of configuration macros is exhaustive.
199 /// When the set of configuration macros is exhaustive, meaning
200 /// that no identifier not in this list should affect how the module is
202 unsigned ConfigMacrosExhaustive : 1;
204 /// \brief Whether files in this module can only include non-modular headers
205 /// and headers from used modules.
206 unsigned NoUndeclaredIncludes : 1;
208 /// \brief Describes the visibility of the various names within a
209 /// particular module.
210 enum NameVisibilityKind {
211 /// \brief All of the names in this module are hidden.
213 /// \brief All of the names in this module are visible.
217 /// \brief The visibility of names within this particular module.
218 NameVisibilityKind NameVisibility;
220 /// \brief The location of the inferred submodule.
221 SourceLocation InferredSubmoduleLoc;
223 /// \brief The set of modules imported by this module, and on which this
225 llvm::SmallSetVector<Module *, 2> Imports;
227 /// \brief Describes an exported module.
229 /// The pointer is the module being re-exported, while the bit will be true
230 /// to indicate that this is a wildcard export.
231 typedef llvm::PointerIntPair<Module *, 1, bool> ExportDecl;
233 /// \brief The set of export declarations.
234 SmallVector<ExportDecl, 2> Exports;
236 /// \brief Describes an exported module that has not yet been resolved
237 /// (perhaps because the module it refers to has not yet been loaded).
238 struct UnresolvedExportDecl {
239 /// \brief The location of the 'export' keyword in the module map file.
240 SourceLocation ExportLoc;
242 /// \brief The name of the module.
245 /// \brief Whether this export declaration ends in a wildcard, indicating
246 /// that all of its submodules should be exported (rather than the named
251 /// \brief The set of export declarations that have yet to be resolved.
252 SmallVector<UnresolvedExportDecl, 2> UnresolvedExports;
254 /// \brief The directly used modules.
255 SmallVector<Module *, 2> DirectUses;
257 /// \brief The set of use declarations that have yet to be resolved.
258 SmallVector<ModuleId, 2> UnresolvedDirectUses;
260 /// \brief A library or framework to link against when an entity from this
263 LinkLibrary() : IsFramework(false) { }
264 LinkLibrary(const std::string &Library, bool IsFramework)
265 : Library(Library), IsFramework(IsFramework) { }
267 /// \brief The library to link against.
269 /// This will typically be a library or framework name, but can also
270 /// be an absolute path to the library or framework.
273 /// \brief Whether this is a framework rather than a library.
277 /// \brief The set of libraries or frameworks to link against when
278 /// an entity from this module is used.
279 llvm::SmallVector<LinkLibrary, 2> LinkLibraries;
281 /// \brief The set of "configuration macros", which are macros that
282 /// (intentionally) change how this module is built.
283 std::vector<std::string> ConfigMacros;
285 /// \brief An unresolved conflict with another module.
286 struct UnresolvedConflict {
287 /// \brief The (unresolved) module id.
290 /// \brief The message provided to the user when there is a conflict.
294 /// \brief The list of conflicts for which the module-id has not yet been
296 std::vector<UnresolvedConflict> UnresolvedConflicts;
298 /// \brief A conflict between two modules.
300 /// \brief The module that this module conflicts with.
303 /// \brief The message provided to the user when there is a conflict.
307 /// \brief The list of conflicts.
308 std::vector<Conflict> Conflicts;
310 /// \brief Construct a new module or submodule.
311 Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent,
312 bool IsFramework, bool IsExplicit, unsigned VisibilityID);
316 /// \brief Determine whether this module is available for use within the
317 /// current translation unit.
318 bool isAvailable() const { return IsAvailable; }
320 /// \brief Determine whether this module is available for use within the
321 /// current translation unit.
323 /// \param LangOpts The language options used for the current
324 /// translation unit.
326 /// \param Target The target options used for the current translation unit.
328 /// \param Req If this module is unavailable, this parameter
329 /// will be set to one of the requirements that is not met for use of
331 bool isAvailable(const LangOptions &LangOpts,
332 const TargetInfo &Target,
334 UnresolvedHeaderDirective &MissingHeader) const;
336 /// \brief Determine whether this module is a submodule.
337 bool isSubModule() const { return Parent != nullptr; }
339 /// \brief Determine whether this module is a submodule of the given other
341 bool isSubModuleOf(const Module *Other) const;
343 /// \brief Determine whether this module is a part of a framework,
344 /// either because it is a framework module or because it is a submodule
345 /// of a framework module.
346 bool isPartOfFramework() const {
347 for (const Module *Mod = this; Mod; Mod = Mod->Parent)
348 if (Mod->IsFramework)
354 /// \brief Determine whether this module is a subframework of another
356 bool isSubFramework() const {
357 return IsFramework && Parent && Parent->isPartOfFramework();
360 /// \brief Retrieve the full name of this module, including the path from
361 /// its top-level module.
362 std::string getFullModuleName() const;
364 /// \brief Whether the full name of this module is equal to joining
365 /// \p nameParts with "."s.
367 /// This is more efficient than getFullModuleName().
368 bool fullModuleNameIs(ArrayRef<StringRef> nameParts) const;
370 /// \brief Retrieve the top-level module for this (sub)module, which may
372 Module *getTopLevelModule() {
373 return const_cast<Module *>(
374 const_cast<const Module *>(this)->getTopLevelModule());
377 /// \brief Retrieve the top-level module for this (sub)module, which may
379 const Module *getTopLevelModule() const;
381 /// \brief Retrieve the name of the top-level module.
383 StringRef getTopLevelModuleName() const {
384 return getTopLevelModule()->Name;
387 /// \brief The serialized AST file for this module, if one was created.
388 const FileEntry *getASTFile() const {
389 return getTopLevelModule()->ASTFile;
392 /// \brief Set the serialized AST file for the top-level module of this module.
393 void setASTFile(const FileEntry *File) {
394 assert((File == nullptr || getASTFile() == nullptr ||
395 getASTFile() == File) && "file path changed");
396 getTopLevelModule()->ASTFile = File;
399 /// \brief Retrieve the directory for which this module serves as the
401 DirectoryName getUmbrellaDir() const;
403 /// \brief Retrieve the header that serves as the umbrella header for this
405 Header getUmbrellaHeader() const {
406 if (auto *E = Umbrella.dyn_cast<const FileEntry *>())
407 return Header{UmbrellaAsWritten, E};
411 /// \brief Determine whether this module has an umbrella directory that is
412 /// not based on an umbrella header.
413 bool hasUmbrellaDir() const {
414 return Umbrella && Umbrella.is<const DirectoryEntry *>();
417 /// \brief Add a top-level header associated with this module.
418 void addTopHeader(const FileEntry *File) {
420 TopHeaders.insert(File);
423 /// \brief Add a top-level header filename associated with this module.
424 void addTopHeaderFilename(StringRef Filename) {
425 TopHeaderNames.push_back(Filename);
428 /// \brief The top-level headers associated with this module.
429 ArrayRef<const FileEntry *> getTopHeaders(FileManager &FileMgr);
431 /// \brief Determine whether this module has declared its intention to
432 /// directly use another module.
433 bool directlyUses(const Module *Requested) const;
435 /// \brief Add the given feature requirement to the list of features
436 /// required by this module.
438 /// \param Feature The feature that is required by this module (and
441 /// \param RequiredState The required state of this feature: \c true
442 /// if it must be present, \c false if it must be absent.
444 /// \param LangOpts The set of language options that will be used to
445 /// evaluate the availability of this feature.
447 /// \param Target The target options that will be used to evaluate the
448 /// availability of this feature.
449 void addRequirement(StringRef Feature, bool RequiredState,
450 const LangOptions &LangOpts,
451 const TargetInfo &Target);
453 /// \brief Mark this module and all of its submodules as unavailable.
454 void markUnavailable(bool MissingRequirement = false);
456 /// \brief Find the submodule with the given name.
458 /// \returns The submodule if found, or NULL otherwise.
459 Module *findSubmodule(StringRef Name) const;
461 /// \brief Determine whether the specified module would be visible to
462 /// a lookup at the end of this module.
464 /// FIXME: This may return incorrect results for (submodules of) the
465 /// module currently being built, if it's queried before we see all
467 bool isModuleVisible(const Module *M) const {
468 if (VisibleModulesCache.empty())
469 buildVisibleModulesCache();
470 return VisibleModulesCache.count(M);
473 unsigned getVisibilityID() const { return VisibilityID; }
475 typedef std::vector<Module *>::iterator submodule_iterator;
476 typedef std::vector<Module *>::const_iterator submodule_const_iterator;
478 submodule_iterator submodule_begin() { return SubModules.begin(); }
479 submodule_const_iterator submodule_begin() const {return SubModules.begin();}
480 submodule_iterator submodule_end() { return SubModules.end(); }
481 submodule_const_iterator submodule_end() const { return SubModules.end(); }
483 llvm::iterator_range<submodule_iterator> submodules() {
484 return llvm::make_range(submodule_begin(), submodule_end());
486 llvm::iterator_range<submodule_const_iterator> submodules() const {
487 return llvm::make_range(submodule_begin(), submodule_end());
490 /// \brief Appends this module's list of exported modules to \p Exported.
492 /// This provides a subset of immediately imported modules (the ones that are
493 /// directly exported), not the complete set of exported modules.
494 void getExportedModules(SmallVectorImpl<Module *> &Exported) const;
496 static StringRef getModuleInputBufferName() {
497 return "<module-includes>";
500 /// \brief Print the module map for this module to the given stream.
502 void print(raw_ostream &OS, unsigned Indent = 0) const;
504 /// \brief Dump the contents of this module to the given output stream.
508 void buildVisibleModulesCache() const;
511 /// \brief A set of visible modules.
512 class VisibleModuleSet {
514 VisibleModuleSet() : Generation(0) {}
515 VisibleModuleSet(VisibleModuleSet &&O)
516 : ImportLocs(std::move(O.ImportLocs)), Generation(O.Generation ? 1 : 0) {
517 O.ImportLocs.clear();
521 /// Move from another visible modules set. Guaranteed to leave the source
522 /// empty and bump the generation on both.
523 VisibleModuleSet &operator=(VisibleModuleSet &&O) {
524 ImportLocs = std::move(O.ImportLocs);
525 O.ImportLocs.clear();
531 /// \brief Get the current visibility generation. Incremented each time the
532 /// set of visible modules changes in any way.
533 unsigned getGeneration() const { return Generation; }
535 /// \brief Determine whether a module is visible.
536 bool isVisible(const Module *M) const {
537 return getImportLoc(M).isValid();
540 /// \brief Get the location at which the import of a module was triggered.
541 SourceLocation getImportLoc(const Module *M) const {
542 return M->getVisibilityID() < ImportLocs.size()
543 ? ImportLocs[M->getVisibilityID()]
547 /// \brief A callback to call when a module is made visible (directly or
548 /// indirectly) by a call to \ref setVisible.
549 typedef llvm::function_ref<void(Module *M)> VisibleCallback;
550 /// \brief A callback to call when a module conflict is found. \p Path
551 /// consists of a sequence of modules from the conflicting module to the one
552 /// made visible, where each was exported by the next.
553 typedef llvm::function_ref<void(ArrayRef<Module *> Path,
554 Module *Conflict, StringRef Message)>
556 /// \brief Make a specific module visible.
557 void setVisible(Module *M, SourceLocation Loc,
558 VisibleCallback Vis = [](Module *) {},
559 ConflictCallback Cb = [](ArrayRef<Module *>, Module *,
563 /// Import locations for each visible module. Indexed by the module's
565 std::vector<SourceLocation> ImportLocs;
566 /// Visibility generation, bumped every time the visibility state changes.
570 } // end namespace clang
573 #endif // LLVM_CLANG_BASIC_MODULE_H