clang  14.0.0git
Module.h
Go to the documentation of this file.
1 //===- Module.h - Describe a module -----------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// Defines the clang::Module class, which describes a module in the
11 /// source code.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_BASIC_MODULE_H
16 #define LLVM_CLANG_BASIC_MODULE_H
17 
19 #include "clang/Basic/FileEntry.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/DenseSet.h"
23 #include "llvm/ADT/Optional.h"
24 #include "llvm/ADT/PointerIntPair.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/ADT/SetVector.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/ADT/StringMap.h"
29 #include "llvm/ADT/StringRef.h"
30 #include "llvm/ADT/iterator_range.h"
31 #include <array>
32 #include <cassert>
33 #include <cstdint>
34 #include <ctime>
35 #include <iterator>
36 #include <string>
37 #include <utility>
38 #include <vector>
39 
40 namespace llvm {
41 
42 class raw_ostream;
43 
44 } // namespace llvm
45 
46 namespace clang {
47 
48 class FileManager;
49 class LangOptions;
50 class TargetInfo;
51 
52 /// Describes the name of a module.
54 
55 /// The signature of a module, which is a hash of the AST content.
56 struct ASTFileSignature : std::array<uint8_t, 20> {
57  using BaseT = std::array<uint8_t, 20>;
58 
59  static constexpr size_t size = std::tuple_size<BaseT>::value;
60 
61  ASTFileSignature(BaseT S = {{0}}) : BaseT(std::move(S)) {}
62 
63  explicit operator bool() const { return *this != BaseT({{0}}); }
64 
65  /// Returns the value truncated to the size of an uint64_t.
66  uint64_t truncatedValue() const {
67  uint64_t Value = 0;
68  static_assert(sizeof(*this) >= sizeof(uint64_t), "No need to truncate.");
69  for (unsigned I = 0; I < sizeof(uint64_t); ++I)
70  Value |= static_cast<uint64_t>((*this)[I]) << (I * 8);
71  return Value;
72  }
73 
74  static ASTFileSignature create(StringRef Bytes) {
75  return create(Bytes.bytes_begin(), Bytes.bytes_end());
76  }
77 
79  ASTFileSignature Sentinel;
80  Sentinel.fill(0xFF);
81  return Sentinel;
82  }
83 
84  template <typename InputIt>
85  static ASTFileSignature create(InputIt First, InputIt Last) {
86  assert(std::distance(First, Last) == size &&
87  "Wrong amount of bytes to create an ASTFileSignature");
88 
89  ASTFileSignature Signature;
90  std::copy(First, Last, Signature.begin());
91  return Signature;
92  }
93 };
94 
95 /// Describes a module or submodule.
96 class Module {
97 public:
98  /// The name of this module.
100 
101  /// The location of the module definition.
103 
104  enum ModuleKind {
105  /// This is a module that was defined by a module map and built out
106  /// of header files.
108 
109  /// This is a C++ Modules TS module interface unit.
111 
112  /// This is a fragment of the global module within some C++ module.
114 
115  /// This is the private module fragment within some C++ module.
117  };
118 
119  /// The kind of this module.
121 
122  /// The parent of this module. This will be NULL for the top-level
123  /// module.
125 
126  /// The build directory of this module. This is the directory in
127  /// which the module is notionally built, and relative to which its headers
128  /// are found.
129  const DirectoryEntry *Directory = nullptr;
130 
131  /// The presumed file name for the module map defining this module.
132  /// Only non-empty when building from preprocessed source.
134 
135  /// The umbrella header or directory.
136  llvm::PointerUnion<const FileEntry *, const DirectoryEntry *> Umbrella;
137 
138  /// The module signature.
140 
141  /// The name of the umbrella entry, as written in the module map.
143 
144  // The path to the umbrella entry relative to the root module's \c Directory.
146 
147  /// The module through which entities defined in this module will
148  /// eventually be exposed, for use in "private" modules.
150 
151  /// Does this Module scope describe part of the purview of a named C++ module?
152  bool isModulePurview() const {
154  }
155 
156  /// Does this Module scope describe a fragment of the global module within
157  /// some C++ module.
158  bool isGlobalModule() const { return Kind == GlobalModuleFragment; }
159 
160 private:
161  /// The submodules of this module, indexed by name.
162  std::vector<Module *> SubModules;
163 
164  /// A mapping from the submodule name to the index into the
165  /// \c SubModules vector at which that submodule resides.
166  llvm::StringMap<unsigned> SubModuleIndex;
167 
168  /// The AST file if this is a top-level module which has a
169  /// corresponding serialized AST file, or null otherwise.
170  Optional<FileEntryRef> ASTFile;
171 
172  /// The top-level headers associated with this module.
174 
175  /// top-level header filenames that aren't resolved to FileEntries yet.
176  std::vector<std::string> TopHeaderNames;
177 
178  /// Cache of modules visible to lookup in this module.
179  mutable llvm::DenseSet<const Module*> VisibleModulesCache;
180 
181  /// The ID used when referencing this module within a VisibleModuleSet.
182  unsigned VisibilityID;
183 
184 public:
185  enum HeaderKind {
191  };
192  static const int NumHeaderKinds = HK_Excluded + 1;
193 
194  /// Information about a header directive as found in the module map
195  /// file.
196  struct Header {
199  const FileEntry *Entry;
200 
201  explicit operator bool() { return Entry; }
202  };
203 
204  /// Information about a directory name as found in the module map
205  /// file.
206  struct DirectoryName {
210 
211  explicit operator bool() { return Entry; }
212  };
213 
214  /// The headers that are part of this module.
216 
217  /// Stored information about a header directive that was found in the
218  /// module map file but has not been resolved to a file.
223  bool IsUmbrella = false;
224  bool HasBuiltinHeader = false;
227  };
228 
229  /// Headers that are mentioned in the module map file but that we have not
230  /// yet attempted to resolve to a file on the file system.
232 
233  /// Headers that are mentioned in the module map file but could not be
234  /// found on the file system.
236 
237  /// An individual requirement: a feature name and a flag indicating
238  /// the required state of that feature.
239  using Requirement = std::pair<std::string, bool>;
240 
241  /// The set of language features required to use this module.
242  ///
243  /// If any of these requirements are not available, the \c IsAvailable bit
244  /// will be false to indicate that this (sub)module is not available.
246 
247  /// A module with the same name that shadows this module.
249 
250  /// Whether this module has declared itself unimportable, either because
251  /// it's missing a requirement from \p Requirements or because it's been
252  /// shadowed by another module.
253  unsigned IsUnimportable : 1;
254 
255  /// Whether we tried and failed to load a module file for this module.
257 
258  /// Whether this module is available in the current translation unit.
259  ///
260  /// If the module is missing headers or does not meet all requirements then
261  /// this bit will be 0.
262  unsigned IsAvailable : 1;
263 
264  /// Whether this module was loaded from a module file.
265  unsigned IsFromModuleFile : 1;
266 
267  /// Whether this is a framework module.
268  unsigned IsFramework : 1;
269 
270  /// Whether this is an explicit submodule.
271  unsigned IsExplicit : 1;
272 
273  /// Whether this is a "system" module (which assumes that all
274  /// headers in it are system headers).
275  unsigned IsSystem : 1;
276 
277  /// Whether this is an 'extern "C"' module (which implicitly puts all
278  /// headers in it within an 'extern "C"' block, and allows the module to be
279  /// imported within such a block).
280  unsigned IsExternC : 1;
281 
282  /// Whether this is an inferred submodule (module * { ... }).
283  unsigned IsInferred : 1;
284 
285  /// Whether we should infer submodules for this module based on
286  /// the headers.
287  ///
288  /// Submodules can only be inferred for modules with an umbrella header.
289  unsigned InferSubmodules : 1;
290 
291  /// Whether, when inferring submodules, the inferred submodules
292  /// should be explicit.
294 
295  /// Whether, when inferring submodules, the inferr submodules should
296  /// export all modules they import (e.g., the equivalent of "export *").
297  unsigned InferExportWildcard : 1;
298 
299  /// Whether the set of configuration macros is exhaustive.
300  ///
301  /// When the set of configuration macros is exhaustive, meaning
302  /// that no identifier not in this list should affect how the module is
303  /// built.
305 
306  /// Whether files in this module can only include non-modular headers
307  /// and headers from used modules.
308  unsigned NoUndeclaredIncludes : 1;
309 
310  /// Whether this module came from a "private" module map, found next
311  /// to a regular (public) module map.
312  unsigned ModuleMapIsPrivate : 1;
313 
314  /// Describes the visibility of the various names within a
315  /// particular module.
317  /// All of the names in this module are hidden.
319  /// All of the names in this module are visible.
321  };
322 
323  /// The visibility of names within this particular module.
325 
326  /// The location of the inferred submodule.
328 
329  /// The set of modules imported by this module, and on which this
330  /// module depends.
332 
333  /// Describes an exported module.
334  ///
335  /// The pointer is the module being re-exported, while the bit will be true
336  /// to indicate that this is a wildcard export.
337  using ExportDecl = llvm::PointerIntPair<Module *, 1, bool>;
338 
339  /// The set of export declarations.
341 
342  /// Describes an exported module that has not yet been resolved
343  /// (perhaps because the module it refers to has not yet been loaded).
345  /// The location of the 'export' keyword in the module map file.
347 
348  /// The name of the module.
350 
351  /// Whether this export declaration ends in a wildcard, indicating
352  /// that all of its submodules should be exported (rather than the named
353  /// module itself).
354  bool Wildcard;
355  };
356 
357  /// The set of export declarations that have yet to be resolved.
359 
360  /// The directly used modules.
362 
363  /// The set of use declarations that have yet to be resolved.
365 
366  /// A library or framework to link against when an entity from this
367  /// module is used.
368  struct LinkLibrary {
369  LinkLibrary() = default;
372 
373  /// The library to link against.
374  ///
375  /// This will typically be a library or framework name, but can also
376  /// be an absolute path to the library or framework.
378 
379  /// Whether this is a framework rather than a library.
380  bool IsFramework = false;
381  };
382 
383  /// The set of libraries or frameworks to link against when
384  /// an entity from this module is used.
386 
387  /// Autolinking uses the framework name for linking purposes
388  /// when this is false and the export_as name otherwise.
390 
391  /// The set of "configuration macros", which are macros that
392  /// (intentionally) change how this module is built.
393  std::vector<std::string> ConfigMacros;
394 
395  /// An unresolved conflict with another module.
397  /// The (unresolved) module id.
399 
400  /// The message provided to the user when there is a conflict.
402  };
403 
404  /// The list of conflicts for which the module-id has not yet been
405  /// resolved.
406  std::vector<UnresolvedConflict> UnresolvedConflicts;
407 
408  /// A conflict between two modules.
409  struct Conflict {
410  /// The module that this module conflicts with.
412 
413  /// The message provided to the user when there is a conflict.
415  };
416 
417  /// The list of conflicts.
418  std::vector<Conflict> Conflicts;
419 
420  /// Construct a new module or submodule.
422  bool IsFramework, bool IsExplicit, unsigned VisibilityID);
423 
424  ~Module();
425 
426  /// Determine whether this module has been declared unimportable.
427  bool isUnimportable() const { return IsUnimportable; }
428 
429  /// Determine whether this module has been declared unimportable.
430  ///
431  /// \param LangOpts The language options used for the current
432  /// translation unit.
433  ///
434  /// \param Target The target options used for the current translation unit.
435  ///
436  /// \param Req If this module is unimportable because of a missing
437  /// requirement, this parameter will be set to one of the requirements that
438  /// is not met for use of this module.
439  ///
440  /// \param ShadowingModule If this module is unimportable because it is
441  /// shadowed, this parameter will be set to the shadowing module.
442  bool isUnimportable(const LangOptions &LangOpts, const TargetInfo &Target,
443  Requirement &Req, Module *&ShadowingModule) const;
444 
445  /// Determine whether this module is available for use within the
446  /// current translation unit.
447  bool isAvailable() const { return IsAvailable; }
448 
449  /// Determine whether this module is available for use within the
450  /// current translation unit.
451  ///
452  /// \param LangOpts The language options used for the current
453  /// translation unit.
454  ///
455  /// \param Target The target options used for the current translation unit.
456  ///
457  /// \param Req If this module is unavailable because of a missing requirement,
458  /// this parameter will be set to one of the requirements that is not met for
459  /// use of this module.
460  ///
461  /// \param MissingHeader If this module is unavailable because of a missing
462  /// header, this parameter will be set to one of the missing headers.
463  ///
464  /// \param ShadowingModule If this module is unavailable because it is
465  /// shadowed, this parameter will be set to the shadowing module.
466  bool isAvailable(const LangOptions &LangOpts,
467  const TargetInfo &Target,
468  Requirement &Req,
469  UnresolvedHeaderDirective &MissingHeader,
470  Module *&ShadowingModule) const;
471 
472  /// Determine whether this module is a submodule.
473  bool isSubModule() const { return Parent != nullptr; }
474 
475  /// Check if this module is a (possibly transitive) submodule of \p Other.
476  ///
477  /// The 'A is a submodule of B' relation is a partial order based on the
478  /// the parent-child relationship between individual modules.
479  ///
480  /// Returns \c false if \p Other is \c nullptr.
481  bool isSubModuleOf(const Module *Other) const;
482 
483  /// Determine whether this module is a part of a framework,
484  /// either because it is a framework module or because it is a submodule
485  /// of a framework module.
486  bool isPartOfFramework() const {
487  for (const Module *Mod = this; Mod; Mod = Mod->Parent)
488  if (Mod->IsFramework)
489  return true;
490 
491  return false;
492  }
493 
494  /// Determine whether this module is a subframework of another
495  /// framework.
496  bool isSubFramework() const {
497  return IsFramework && Parent && Parent->isPartOfFramework();
498  }
499 
500  /// Set the parent of this module. This should only be used if the parent
501  /// could not be set during module creation.
502  void setParent(Module *M) {
503  assert(!Parent);
504  Parent = M;
505  Parent->SubModuleIndex[Name] = Parent->SubModules.size();
506  Parent->SubModules.push_back(this);
507  }
508 
509  /// Retrieve the full name of this module, including the path from
510  /// its top-level module.
511  /// \param AllowStringLiterals If \c true, components that might not be
512  /// lexically valid as identifiers will be emitted as string literals.
513  std::string getFullModuleName(bool AllowStringLiterals = false) const;
514 
515  /// Whether the full name of this module is equal to joining
516  /// \p nameParts with "."s.
517  ///
518  /// This is more efficient than getFullModuleName().
519  bool fullModuleNameIs(ArrayRef<StringRef> nameParts) const;
520 
521  /// Retrieve the top-level module for this (sub)module, which may
522  /// be this module.
524  return const_cast<Module *>(
525  const_cast<const Module *>(this)->getTopLevelModule());
526  }
527 
528  /// Retrieve the top-level module for this (sub)module, which may
529  /// be this module.
530  const Module *getTopLevelModule() const;
531 
532  /// Retrieve the name of the top-level module.
533  StringRef getTopLevelModuleName() const {
534  return getTopLevelModule()->Name;
535  }
536 
537  /// The serialized AST file for this module, if one was created.
539  return getTopLevelModule()->ASTFile;
540  }
541 
542  /// Set the serialized AST file for the top-level module of this module.
544  assert((!File || !getASTFile() || getASTFile() == File) &&
545  "file path changed");
546  getTopLevelModule()->ASTFile = File;
547  }
548 
549  /// Retrieve the directory for which this module serves as the
550  /// umbrella.
551  DirectoryName getUmbrellaDir() const;
552 
553  /// Retrieve the header that serves as the umbrella header for this
554  /// module.
556  if (auto *FE = Umbrella.dyn_cast<const FileEntry *>())
558  FE};
559  return Header{};
560  }
561 
562  /// Determine whether this module has an umbrella directory that is
563  /// not based on an umbrella header.
564  bool hasUmbrellaDir() const {
565  return Umbrella && Umbrella.is<const DirectoryEntry *>();
566  }
567 
568  /// Add a top-level header associated with this module.
569  void addTopHeader(const FileEntry *File);
570 
571  /// Add a top-level header filename associated with this module.
572  void addTopHeaderFilename(StringRef Filename) {
573  TopHeaderNames.push_back(std::string(Filename));
574  }
575 
576  /// The top-level headers associated with this module.
578 
579  /// Determine whether this module has declared its intention to
580  /// directly use another module.
581  bool directlyUses(const Module *Requested) const;
582 
583  /// Add the given feature requirement to the list of features
584  /// required by this module.
585  ///
586  /// \param Feature The feature that is required by this module (and
587  /// its submodules).
588  ///
589  /// \param RequiredState The required state of this feature: \c true
590  /// if it must be present, \c false if it must be absent.
591  ///
592  /// \param LangOpts The set of language options that will be used to
593  /// evaluate the availability of this feature.
594  ///
595  /// \param Target The target options that will be used to evaluate the
596  /// availability of this feature.
597  void addRequirement(StringRef Feature, bool RequiredState,
598  const LangOptions &LangOpts,
599  const TargetInfo &Target);
600 
601  /// Mark this module and all of its submodules as unavailable.
602  void markUnavailable(bool Unimportable);
603 
604  /// Find the submodule with the given name.
605  ///
606  /// \returns The submodule if found, or NULL otherwise.
607  Module *findSubmodule(StringRef Name) const;
608  Module *findOrInferSubmodule(StringRef Name);
609 
610  /// Determine whether the specified module would be visible to
611  /// a lookup at the end of this module.
612  ///
613  /// FIXME: This may return incorrect results for (submodules of) the
614  /// module currently being built, if it's queried before we see all
615  /// of its imports.
616  bool isModuleVisible(const Module *M) const {
617  if (VisibleModulesCache.empty())
618  buildVisibleModulesCache();
619  return VisibleModulesCache.count(M);
620  }
621 
622  unsigned getVisibilityID() const { return VisibilityID; }
623 
624  using submodule_iterator = std::vector<Module *>::iterator;
625  using submodule_const_iterator = std::vector<Module *>::const_iterator;
626 
627  submodule_iterator submodule_begin() { return SubModules.begin(); }
628  submodule_const_iterator submodule_begin() const {return SubModules.begin();}
629  submodule_iterator submodule_end() { return SubModules.end(); }
630  submodule_const_iterator submodule_end() const { return SubModules.end(); }
631 
632  llvm::iterator_range<submodule_iterator> submodules() {
633  return llvm::make_range(submodule_begin(), submodule_end());
634  }
635  llvm::iterator_range<submodule_const_iterator> submodules() const {
636  return llvm::make_range(submodule_begin(), submodule_end());
637  }
638 
639  /// Appends this module's list of exported modules to \p Exported.
640  ///
641  /// This provides a subset of immediately imported modules (the ones that are
642  /// directly exported), not the complete set of exported modules.
643  void getExportedModules(SmallVectorImpl<Module *> &Exported) const;
644 
645  static StringRef getModuleInputBufferName() {
646  return "<module-includes>";
647  }
648 
649  /// Print the module map for this module to the given stream.
650  void print(raw_ostream &OS, unsigned Indent = 0, bool Dump = false) const;
651 
652  /// Dump the contents of this module to the given output stream.
653  void dump() const;
654 
655 private:
656  void buildVisibleModulesCache() const;
657 };
658 
659 /// A set of visible modules.
661 public:
662  VisibleModuleSet() = default;
664  : ImportLocs(std::move(O.ImportLocs)), Generation(O.Generation ? 1 : 0) {
665  O.ImportLocs.clear();
666  ++O.Generation;
667  }
668 
669  /// Move from another visible modules set. Guaranteed to leave the source
670  /// empty and bump the generation on both.
672  ImportLocs = std::move(O.ImportLocs);
673  O.ImportLocs.clear();
674  ++O.Generation;
675  ++Generation;
676  return *this;
677  }
678 
679  /// Get the current visibility generation. Incremented each time the
680  /// set of visible modules changes in any way.
681  unsigned getGeneration() const { return Generation; }
682 
683  /// Determine whether a module is visible.
684  bool isVisible(const Module *M) const {
685  return getImportLoc(M).isValid();
686  }
687 
688  /// Get the location at which the import of a module was triggered.
690  return M->getVisibilityID() < ImportLocs.size()
691  ? ImportLocs[M->getVisibilityID()]
692  : SourceLocation();
693  }
694 
695  /// A callback to call when a module is made visible (directly or
696  /// indirectly) by a call to \ref setVisible.
697  using VisibleCallback = llvm::function_ref<void(Module *M)>;
698 
699  /// A callback to call when a module conflict is found. \p Path
700  /// consists of a sequence of modules from the conflicting module to the one
701  /// made visible, where each was exported by the next.
702  using ConflictCallback =
703  llvm::function_ref<void(ArrayRef<Module *> Path, Module *Conflict,
704  StringRef Message)>;
705 
706  /// Make a specific module visible.
707  void setVisible(Module *M, SourceLocation Loc,
708  VisibleCallback Vis = [](Module *) {},
710  StringRef) {});
711 
712 private:
713  /// Import locations for each visible module. Indexed by the module's
714  /// VisibilityID.
715  std::vector<SourceLocation> ImportLocs;
716 
717  /// Visibility generation, bumped every time the visibility state changes.
718  unsigned Generation = 0;
719 };
720 
721 /// Abstracts clang modules and precompiled header files and holds
722 /// everything needed to generate debug info for an imported module
723 /// or PCH.
725  StringRef PCHModuleName;
726  StringRef Path;
727  StringRef ASTFile;
728  ASTFileSignature Signature;
729  Module *ClangModule = nullptr;
730 
731 public:
732  ASTSourceDescriptor() = default;
733  ASTSourceDescriptor(StringRef Name, StringRef Path, StringRef ASTFile,
734  ASTFileSignature Signature)
735  : PCHModuleName(std::move(Name)), Path(std::move(Path)),
736  ASTFile(std::move(ASTFile)), Signature(Signature) {}
738 
739  std::string getModuleName() const;
740  StringRef getPath() const { return Path; }
741  StringRef getASTFile() const { return ASTFile; }
742  ASTFileSignature getSignature() const { return Signature; }
743  Module *getModuleOrNull() const { return ClangModule; }
744 };
745 
746 
747 } // namespace clang
748 
749 #endif // LLVM_CLANG_BASIC_MODULE_H
clang::Module::DirectUses
SmallVector< Module *, 2 > DirectUses
The directly used modules.
Definition: Module.h:361
clang::Module::directlyUses
bool directlyUses(const Module *Requested) const
Determine whether this module has declared its intention to directly use another module.
Definition: Module.cpp:270
clang::Module::Requirement
std::pair< std::string, bool > Requirement
An individual requirement: a feature name and a flag indicating the required state of that feature.
Definition: Module.h:239
clang::Module::getTopLevelModule
Module * getTopLevelModule()
Retrieve the top-level module for this (sub)module, which may be this module.
Definition: Module.h:523
clang::Module::LinkLibrary::LinkLibrary
LinkLibrary(const std::string &Library, bool IsFramework)
Definition: Module.h:370
llvm
YAML serialization mapping.
Definition: Dominators.h:30
clang::Module::InferSubmodules
unsigned InferSubmodules
Whether we should infer submodules for this module based on the headers.
Definition: Module.h:289
clang::ASTFileSignature::create
static ASTFileSignature create(InputIt First, InputIt Last)
Definition: Module.h:85
clang::Module::Header::PathRelativeToRootModuleDirectory
std::string PathRelativeToRootModuleDirectory
Definition: Module.h:198
clang::Module::Requirements
SmallVector< Requirement, 2 > Requirements
The set of language features required to use this module.
Definition: Module.h:245
clang::Module::fullModuleNameIs
bool fullModuleNameIs(ArrayRef< StringRef > nameParts) const
Whether the full name of this module is equal to joining nameParts with "."s.
Definition: Module.cpp:235
clang::DeclaratorContext::File
@ File
clang::Module::getUmbrellaDir
DirectoryName getUmbrellaDir() const
Retrieve the directory for which this module serves as the umbrella.
Definition: Module.cpp:244
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::Module::HasIncompatibleModuleFile
unsigned HasIncompatibleModuleFile
Whether we tried and failed to load a module file for this module.
Definition: Module.h:256
llvm::SmallVector< std::pair< std::string, SourceLocation >, 2 >
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:86
clang::Module::UnresolvedExportDecl::Wildcard
bool Wildcard
Whether this export declaration ends in a wildcard, indicating that all of its submodules should be e...
Definition: Module.h:354
clang::Module::Conflict::Other
Module * Other
The module that this module conflicts with.
Definition: Module.h:411
clang::Module::getFullModuleName
std::string getFullModuleName(bool AllowStringLiterals=false) const
Retrieve the full name of this module, including the path from its top-level module.
Definition: Module.cpp:219
clang::Module::UnresolvedConflict::Id
ModuleId Id
The (unresolved) module id.
Definition: Module.h:398
clang::Module::hasUmbrellaDir
bool hasUmbrellaDir() const
Determine whether this module has an umbrella directory that is not based on an umbrella header.
Definition: Module.h:564
clang::Module::HK_PrivateTextual
@ HK_PrivateTextual
Definition: Module.h:189
clang::Module::submodule_begin
submodule_iterator submodule_begin()
Definition: Module.h:627
clang::Module::setParent
void setParent(Module *M)
Set the parent of this module.
Definition: Module.h:502
clang::Module::Header::Entry
const FileEntry * Entry
Definition: Module.h:199
clang::Module::DirectoryName::Entry
const DirectoryEntry * Entry
Definition: Module.h:209
Filename
StringRef Filename
Definition: Format.cpp:2429
clang::Module::Module
Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent, bool IsFramework, bool IsExplicit, unsigned VisibilityID)
Construct a new module or submodule.
Definition: Module.cpp:37
clang::TargetInfo
Exposes information about the current target.
Definition: TargetInfo.h:186
clang::Module::NameVisibilityKind
NameVisibilityKind
Describes the visibility of the various names within a particular module.
Definition: Module.h:316
clang::Module::Name
std::string Name
The name of this module.
Definition: Module.h:99
clang::Module::ModuleMapModule
@ ModuleMapModule
This is a module that was defined by a module map and built out of header files.
Definition: Module.h:107
distance
float __ovld __cnfn distance(float p0, float p1)
Returns the distance between p0 and p1.
llvm::Optional< FileEntryRef >
clang::ComparisonCategoryType::First
@ First
DirectoryEntry.h
clang::OptionalFileEntryRefDegradesToFileEntryPtr
Wrapper around Optional<FileEntryRef> that degrades to 'const FileEntry*', facilitating incremental p...
Definition: FileEntry.h:280
clang::Module::InferExportWildcard
unsigned InferExportWildcard
Whether, when inferring submodules, the inferr submodules should export all modules they import (e....
Definition: Module.h:297
clang::Module::submodules
llvm::iterator_range< submodule_const_iterator > submodules() const
Definition: Module.h:635
clang::Module::findSubmodule
Module * findSubmodule(StringRef Name) const
Find the submodule with the given name.
Definition: Module.cpp:328
clang::Module::ModuleMapIsPrivate
unsigned ModuleMapIsPrivate
Whether this module came from a "private" module map, found next to a regular (public) module map.
Definition: Module.h:312
clang::VisibleModuleSet::isVisible
bool isVisible(const Module *M) const
Determine whether a module is visible.
Definition: Module.h:684
clang::ASTFileSignature::create
static ASTFileSignature create(StringRef Bytes)
Definition: Module.h:74
clang::Module::NameVisibility
NameVisibilityKind NameVisibility
The visibility of names within this particular module.
Definition: Module.h:324
clang::Module::isAvailable
bool isAvailable() const
Determine whether this module is available for use within the current translation unit.
Definition: Module.h:447
clang::Module::~Module
~Module()
Definition: Module.cpp:61
clang::Module::InferredSubmoduleLoc
SourceLocation InferredSubmoduleLoc
The location of the inferred submodule.
Definition: Module.h:327
clang::Module::UnresolvedExports
SmallVector< UnresolvedExportDecl, 2 > UnresolvedExports
The set of export declarations that have yet to be resolved.
Definition: Module.h:358
clang::Module::UnresolvedConflict::Message
std::string Message
The message provided to the user when there is a conflict.
Definition: Module.h:401
clang::Module::UnresolvedDirectUses
SmallVector< ModuleId, 2 > UnresolvedDirectUses
The set of use declarations that have yet to be resolved.
Definition: Module.h:364
clang::Module::Signature
ASTFileSignature Signature
The module signature.
Definition: Module.h:139
clang::Module::isModuleVisible
bool isModuleVisible(const Module *M) const
Determine whether the specified module would be visible to a lookup at the end of this module.
Definition: Module.h:616
clang::Module::submodule_end
submodule_const_iterator submodule_end() const
Definition: Module.h:630
FileEntry.h
clang::Module::NoUndeclaredIncludes
unsigned NoUndeclaredIncludes
Whether files in this module can only include non-modular headers and headers from used modules.
Definition: Module.h:308
clang::Module::getTopHeaders
ArrayRef< const FileEntry * > getTopHeaders(FileManager &FileMgr)
The top-level headers associated with this module.
Definition: Module.cpp:257
clang::Module::submodule_const_iterator
std::vector< Module * >::const_iterator submodule_const_iterator
Definition: Module.h:625
clang::Module::isUnimportable
bool isUnimportable() const
Determine whether this module has been declared unimportable.
Definition: Module.h:427
clang::Module::getVisibilityID
unsigned getVisibilityID() const
Definition: Module.h:622
clang::Module
Describes a module or submodule.
Definition: Module.h:96
clang::Module::Hidden
@ Hidden
All of the names in this module are hidden.
Definition: Module.h:318
clang::Module::findOrInferSubmodule
Module * findOrInferSubmodule(StringRef Name)
Definition: Module.cpp:336
clang::Module::UnresolvedExportDecl::ExportLoc
SourceLocation ExportLoc
The location of the 'export' keyword in the module map file.
Definition: Module.h:346
clang::VisibleModuleSet::getImportLoc
SourceLocation getImportLoc(const Module *M) const
Get the location at which the import of a module was triggered.
Definition: Module.h:689
clang::Module::isSubModule
bool isSubModule() const
Determine whether this module is a submodule.
Definition: Module.h:473
clang::DirectoryEntry
Cached information about one directory (either on disk or in the virtual file system).
Definition: DirectoryEntry.h:33
clang::ASTSourceDescriptor::getModuleOrNull
Module * getModuleOrNull() const
Definition: Module.h:743
clang::ASTFileSignature::truncatedValue
uint64_t truncatedValue() const
Returns the value truncated to the size of an uint64_t.
Definition: Module.h:66
clang::Module::Exports
SmallVector< ExportDecl, 2 > Exports
The set of export declarations.
Definition: Module.h:340
clang::Module::NumHeaderKinds
static const int NumHeaderKinds
Definition: Module.h:192
clang::ASTSourceDescriptor::getSignature
ASTFileSignature getSignature() const
Definition: Module.h:742
clang::Module::ModuleInterfaceUnit
@ ModuleInterfaceUnit
This is a C++ Modules TS module interface unit.
Definition: Module.h:110
clang::Module::HK_Textual
@ HK_Textual
Definition: Module.h:187
clang::VisibleModuleSet::VisibleModuleSet
VisibleModuleSet()=default
clang::Module::getTopLevelModuleName
StringRef getTopLevelModuleName() const
Retrieve the name of the top-level module.
Definition: Module.h:533
clang::Module::IsFramework
unsigned IsFramework
Whether this is a framework module.
Definition: Module.h:268
clang::Module::UnresolvedHeaderDirective::Size
Optional< off_t > Size
Definition: Module.h:225
clang::Module::LinkLibrary
A library or framework to link against when an entity from this module is used.
Definition: Module.h:368
clang::VisibleModuleSet
A set of visible modules.
Definition: Module.h:660
clang::Module::HeaderKind
HeaderKind
Definition: Module.h:185
clang::Module::GlobalModuleFragment
@ GlobalModuleFragment
This is a fragment of the global module within some C++ module.
Definition: Module.h:113
clang::Module::DefinitionLoc
SourceLocation DefinitionLoc
The location of the module definition.
Definition: Module.h:102
clang::Module::AllVisible
@ AllVisible
All of the names in this module are visible.
Definition: Module.h:320
clang::Module::Conflicts
std::vector< Conflict > Conflicts
The list of conflicts.
Definition: Module.h:418
clang::Module::UnresolvedConflicts
std::vector< UnresolvedConflict > UnresolvedConflicts
The list of conflicts for which the module-id has not yet been resolved.
Definition: Module.h:406
bool
#define bool
Definition: stdbool.h:15
clang::Module::ModuleKind
ModuleKind
Definition: Module.h:104
clang::Module::UnresolvedHeaderDirective::FileName
std::string FileName
Definition: Module.h:222
clang::VisibleModuleSet::getGeneration
unsigned getGeneration() const
Get the current visibility generation.
Definition: Module.h:681
llvm::DenseSet
Definition: Sema.h:77
clang::Module::isPartOfFramework
bool isPartOfFramework() const
Determine whether this module is a part of a framework, either because it is a framework module or be...
Definition: Module.h:486
clang::Module::MissingHeaders
SmallVector< UnresolvedHeaderDirective, 1 > MissingHeaders
Headers that are mentioned in the module map file but could not be found on the file system.
Definition: Module.h:235
clang::ASTSourceDescriptor::getPath
StringRef getPath() const
Definition: Module.h:740
clang::Module::IsExplicit
unsigned IsExplicit
Whether this is an explicit submodule.
Definition: Module.h:271
clang::Module::getASTFile
OptionalFileEntryRefDegradesToFileEntryPtr getASTFile() const
The serialized AST file for this module, if one was created.
Definition: Module.h:538
clang::ASTFileSignature
The signature of a module, which is a hash of the AST content.
Definition: Module.h:56
clang::VisibleModuleSet::setVisible
void setVisible(Module *M, SourceLocation Loc, VisibleCallback Vis=[](Module *) {}, ConflictCallback Cb=[](ArrayRef< Module * >, Module *, StringRef) {})
Make a specific module visible.
Definition: Module.cpp:631
clang::FileEntry
Cached information about one file (either on disk or in the virtual file system).
Definition: FileEntry.h:331
clang::Module::LinkLibrary::IsFramework
bool IsFramework
Whether this is a framework rather than a library.
Definition: Module.h:380
clang::ASTSourceDescriptor::getModuleName
std::string getModuleName() const
Definition: Module.cpp:684
clang::Module::Parent
Module * Parent
The parent of this module.
Definition: Module.h:124
clang::Module::PresumedModuleMapFile
std::string PresumedModuleMapFile
The presumed file name for the module map defining this module.
Definition: Module.h:133
clang::Module::submodules
llvm::iterator_range< submodule_iterator > submodules()
Definition: Module.h:632
clang::Module::submodule_iterator
std::vector< Module * >::iterator submodule_iterator
Definition: Module.h:624
clang::Module::UmbrellaAsWritten
std::string UmbrellaAsWritten
The name of the umbrella entry, as written in the module map.
Definition: Module.h:142
clang::Module::HK_Normal
@ HK_Normal
Definition: Module.h:186
clang::Module::markUnavailable
void markUnavailable(bool Unimportable)
Mark this module and all of its submodules as unavailable.
Definition: Module.cpp:300
clang::Module::LinkLibraries
llvm::SmallVector< LinkLibrary, 2 > LinkLibraries
The set of libraries or frameworks to link against when an entity from this module is used.
Definition: Module.h:385
SourceLocation.h
clang::Indent
raw_ostream & Indent(raw_ostream &Out, const unsigned int Space, bool IsDot)
Definition: JsonSupport.h:21
clang::Module::HK_Private
@ HK_Private
Definition: Module.h:188
clang::Module::DirectoryName::PathRelativeToRootModuleDirectory
std::string PathRelativeToRootModuleDirectory
Definition: Module.h:208
clang::Module::Directory
const DirectoryEntry * Directory
The build directory of this module.
Definition: Module.h:129
clang::Module::Headers
SmallVector< Header, 2 > Headers[5]
The headers that are part of this module.
Definition: Module.h:215
clang::Module::Conflict::Message
std::string Message
The message provided to the user when there is a conflict.
Definition: Module.h:414
clang::Module::isGlobalModule
bool isGlobalModule() const
Does this Module scope describe a fragment of the global module within some C++ module.
Definition: Module.h:158
clang::Module::IsSystem
unsigned IsSystem
Whether this is a "system" module (which assumes that all headers in it are system headers).
Definition: Module.h:275
llvm::ArrayRef
Definition: LLVM.h:34
Value
Value
Definition: UninitializedValues.cpp:102
clang::ASTFileSignature::createDISentinel
static ASTFileSignature createDISentinel()
Definition: Module.h:78
clang::Module::Umbrella
llvm::PointerUnion< const FileEntry *, const DirectoryEntry * > Umbrella
The umbrella header or directory.
Definition: Module.h:136
clang::ASTSourceDescriptor::getASTFile
StringRef getASTFile() const
Definition: Module.h:741
clang::Module::PrivateModuleFragment
@ PrivateModuleFragment
This is the private module fragment within some C++ module.
Definition: Module.h:116
clang::Module::UnresolvedHeaderDirective::HasBuiltinHeader
bool HasBuiltinHeader
Definition: Module.h:224
clang::Module::Imports
llvm::SmallSetVector< Module *, 2 > Imports
The set of modules imported by this module, and on which this module depends.
Definition: Module.h:331
clang::Module::UnresolvedConflict
An unresolved conflict with another module.
Definition: Module.h:396
clang::ASTFileSignature::BaseT
std::array< uint8_t, 20 > BaseT
Definition: Module.h:57
clang::Module::isModulePurview
bool isModulePurview() const
Does this Module scope describe part of the purview of a named C++ module?
Definition: Module.h:152
clang::Module::HK_Excluded
@ HK_Excluded
Definition: Module.h:190
clang::Module::InferExplicitSubmodules
unsigned InferExplicitSubmodules
Whether, when inferring submodules, the inferred submodules should be explicit.
Definition: Module.h:293
clang::Module::IsAvailable
unsigned IsAvailable
Whether this module is available in the current translation unit.
Definition: Module.h:262
clang::VisibleModuleSet::ConflictCallback
llvm::function_ref< void(ArrayRef< Module * > Path, Module *Conflict, StringRef Message)> ConflictCallback
A callback to call when a module conflict is found.
Definition: Module.h:704
clang::Module::UnresolvedHeaderDirective::IsUmbrella
bool IsUmbrella
Definition: Module.h:223
clang::Module::Conflict
A conflict between two modules.
Definition: Module.h:409
clang::LangOptions
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:58
std
Definition: Format.h:4275
clang::Module::UnresolvedHeaderDirective
Stored information about a header directive that was found in the module map file but has not been re...
Definition: Module.h:219
clang::VisibleModuleSet::VisibleModuleSet
VisibleModuleSet(VisibleModuleSet &&O)
Definition: Module.h:663
clang::Module::DirectoryName
Information about a directory name as found in the module map file.
Definition: Module.h:206
clang::Module::Kind
ModuleKind Kind
The kind of this module.
Definition: Module.h:120
clang
Definition: CalledOnceCheck.h:17
clang::FileManager
Implements support for file system lookup, file system caching, and directory search management.
Definition: FileManager.h:53
clang::Module::isSubModuleOf
bool isSubModuleOf(const Module *Other) const
Check if this module is a (possibly transitive) submodule of Other.
Definition: Module.cpp:173
clang::VisibleModuleSet::operator=
VisibleModuleSet & operator=(VisibleModuleSet &&O)
Move from another visible modules set.
Definition: Module.h:671
clang::Module::ExportAsModule
std::string ExportAsModule
The module through which entities defined in this module will eventually be exposed,...
Definition: Module.h:149
clang::VisibleModuleSet::VisibleCallback
llvm::function_ref< void(Module *M)> VisibleCallback
A callback to call when a module is made visible (directly or indirectly) by a call to setVisible.
Definition: Module.h:697
clang::Module::getModuleInputBufferName
static StringRef getModuleInputBufferName()
Definition: Module.h:645
clang::Module::UnresolvedExportDecl
Describes an exported module that has not yet been resolved (perhaps because the module it refers to ...
Definition: Module.h:344
clang::ASTSourceDescriptor::ASTSourceDescriptor
ASTSourceDescriptor()=default
clang::Module::Header
Information about a header directive as found in the module map file.
Definition: Module.h:196
clang::ComparisonCategoryType::Last
@ Last
clang::Module::print
void print(raw_ostream &OS, unsigned Indent=0, bool Dump=false) const
Print the module map for this module to the given stream.
Definition: Module.cpp:431
clang::Module::UnresolvedExportDecl::Id
ModuleId Id
The name of the module.
Definition: Module.h:349
clang::Module::IsUnimportable
unsigned IsUnimportable
Whether this module has declared itself unimportable, either because it's missing a requirement from ...
Definition: Module.h:253
clang::ASTSourceDescriptor::ASTSourceDescriptor
ASTSourceDescriptor(StringRef Name, StringRef Path, StringRef ASTFile, ASTFileSignature Signature)
Definition: Module.h:733
clang::Module::getUmbrellaHeader
Header getUmbrellaHeader() const
Retrieve the header that serves as the umbrella header for this module.
Definition: Module.h:555
clang::SourceLocation::isValid
bool isValid() const
Return true if this is a valid SourceLocation object.
Definition: SourceLocation.h:110
clang::Module::ConfigMacros
std::vector< std::string > ConfigMacros
The set of "configuration macros", which are macros that (intentionally) change how this module is bu...
Definition: Module.h:393
clang::Module::dump
void dump() const
Dump the contents of this module to the given output stream.
Definition: APINotesYAMLCompiler.cpp:577
clang::Module::LinkLibrary::Library
std::string Library
The library to link against.
Definition: Module.h:377
clang::Module::IsExternC
unsigned IsExternC
Whether this is an 'extern "C"' module (which implicitly puts all headers in it within an 'extern "C"...
Definition: Module.h:280
clang::Module::ConfigMacrosExhaustive
unsigned ConfigMacrosExhaustive
Whether the set of configuration macros is exhaustive.
Definition: Module.h:304
clang::Module::submodule_begin
submodule_const_iterator submodule_begin() const
Definition: Module.h:628
clang::Module::submodule_end
submodule_iterator submodule_end()
Definition: Module.h:629
clang::Module::addTopHeaderFilename
void addTopHeaderFilename(StringRef Filename)
Add a top-level header filename associated with this module.
Definition: Module.h:572
clang::Module::isSubFramework
bool isSubFramework() const
Determine whether this module is a subframework of another framework.
Definition: Module.h:496
clang::Module::setASTFile
void setASTFile(Optional< FileEntryRef > File)
Set the serialized AST file for the top-level module of this module.
Definition: Module.h:543
clang::Module::IsFromModuleFile
unsigned IsFromModuleFile
Whether this module was loaded from a module file.
Definition: Module.h:265
clang::Module::getExportedModules
void getExportedModules(SmallVectorImpl< Module * > &Exported) const
Appends this module's list of exported modules to Exported.
Definition: Module.cpp:351
clang::Module::addRequirement
void addRequirement(StringRef Feature, bool RequiredState, const LangOptions &LangOpts, const TargetInfo &Target)
Add the given feature requirement to the list of features required by this module.
Definition: Module.cpp:288
clang::Module::LinkLibrary::LinkLibrary
LinkLibrary()=default
clang::Module::addTopHeader
void addTopHeader(const FileEntry *File)
Add a top-level header associated with this module.
Definition: Module.cpp:252
llvm::SmallVectorImpl
Definition: LLVM.h:39
llvm::SmallSetVector
Definition: ExternalSemaSource.h:23
clang::Module::UnresolvedHeaderDirective::Kind
HeaderKind Kind
Definition: Module.h:220
clang::Module::ShadowingModule
Module * ShadowingModule
A module with the same name that shadows this module.
Definition: Module.h:248
clang::Module::UseExportAsModuleLinkName
bool UseExportAsModuleLinkName
Autolinking uses the framework name for linking purposes when this is false and the export_as name ot...
Definition: Module.h:389
clang::Module::UmbrellaRelativeToRootModuleDirectory
std::string UmbrellaRelativeToRootModuleDirectory
Definition: Module.h:145
clang::Module::ExportDecl
llvm::PointerIntPair< Module *, 1, bool > ExportDecl
Describes an exported module.
Definition: Module.h:337
clang::ASTFileSignature::ASTFileSignature
ASTFileSignature(BaseT S={{0}})
Definition: Module.h:61
clang::ASTFileSignature::size
static constexpr size_t size
Definition: Module.h:59
clang::Module::DirectoryName::NameAsWritten
std::string NameAsWritten
Definition: Module.h:207
clang::Module::UnresolvedHeaderDirective::ModTime
Optional< time_t > ModTime
Definition: Module.h:226
clang::Module::IsInferred
unsigned IsInferred
Whether this is an inferred submodule (module * { ... }).
Definition: Module.h:283
clang::Module::UnresolvedHeaderDirective::FileNameLoc
SourceLocation FileNameLoc
Definition: Module.h:221
clang::ASTSourceDescriptor
Abstracts clang modules and precompiled header files and holds everything needed to generate debug in...
Definition: Module.h:724
clang::Module::UnresolvedHeaders
SmallVector< UnresolvedHeaderDirective, 1 > UnresolvedHeaders
Headers that are mentioned in the module map file but that we have not yet attempted to resolve to a ...
Definition: Module.h:231
clang::Module::Header::NameAsWritten
std::string NameAsWritten
Definition: Module.h:197