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 private:
157  /// The submodules of this module, indexed by name.
158  std::vector<Module *> SubModules;
159 
160  /// A mapping from the submodule name to the index into the
161  /// \c SubModules vector at which that submodule resides.
162  llvm::StringMap<unsigned> SubModuleIndex;
163 
164  /// The AST file if this is a top-level module which has a
165  /// corresponding serialized AST file, or null otherwise.
166  Optional<FileEntryRef> ASTFile;
167 
168  /// The top-level headers associated with this module.
170 
171  /// top-level header filenames that aren't resolved to FileEntries yet.
172  std::vector<std::string> TopHeaderNames;
173 
174  /// Cache of modules visible to lookup in this module.
175  mutable llvm::DenseSet<const Module*> VisibleModulesCache;
176 
177  /// The ID used when referencing this module within a VisibleModuleSet.
178  unsigned VisibilityID;
179 
180 public:
181  enum HeaderKind {
187  };
188  static const int NumHeaderKinds = HK_Excluded + 1;
189 
190  /// Information about a header directive as found in the module map
191  /// file.
192  struct Header {
195  const FileEntry *Entry;
196 
197  explicit operator bool() { return Entry; }
198  };
199 
200  /// Information about a directory name as found in the module map
201  /// file.
202  struct DirectoryName {
206 
207  explicit operator bool() { return Entry; }
208  };
209 
210  /// The headers that are part of this module.
212 
213  /// Stored information about a header directive that was found in the
214  /// module map file but has not been resolved to a file.
219  bool IsUmbrella = false;
220  bool HasBuiltinHeader = false;
223  };
224 
225  /// Headers that are mentioned in the module map file but that we have not
226  /// yet attempted to resolve to a file on the file system.
228 
229  /// Headers that are mentioned in the module map file but could not be
230  /// found on the file system.
232 
233  /// An individual requirement: a feature name and a flag indicating
234  /// the required state of that feature.
235  using Requirement = std::pair<std::string, bool>;
236 
237  /// The set of language features required to use this module.
238  ///
239  /// If any of these requirements are not available, the \c IsAvailable bit
240  /// will be false to indicate that this (sub)module is not available.
242 
243  /// A module with the same name that shadows this module.
245 
246  /// Whether this module has declared itself unimportable, either because
247  /// it's missing a requirement from \p Requirements or because it's been
248  /// shadowed by another module.
249  unsigned IsUnimportable : 1;
250 
251  /// Whether we tried and failed to load a module file for this module.
253 
254  /// Whether this module is available in the current translation unit.
255  ///
256  /// If the module is missing headers or does not meet all requirements then
257  /// this bit will be 0.
258  unsigned IsAvailable : 1;
259 
260  /// Whether this module was loaded from a module file.
261  unsigned IsFromModuleFile : 1;
262 
263  /// Whether this is a framework module.
264  unsigned IsFramework : 1;
265 
266  /// Whether this is an explicit submodule.
267  unsigned IsExplicit : 1;
268 
269  /// Whether this is a "system" module (which assumes that all
270  /// headers in it are system headers).
271  unsigned IsSystem : 1;
272 
273  /// Whether this is an 'extern "C"' module (which implicitly puts all
274  /// headers in it within an 'extern "C"' block, and allows the module to be
275  /// imported within such a block).
276  unsigned IsExternC : 1;
277 
278  /// Whether this is an inferred submodule (module * { ... }).
279  unsigned IsInferred : 1;
280 
281  /// Whether we should infer submodules for this module based on
282  /// the headers.
283  ///
284  /// Submodules can only be inferred for modules with an umbrella header.
285  unsigned InferSubmodules : 1;
286 
287  /// Whether, when inferring submodules, the inferred submodules
288  /// should be explicit.
290 
291  /// Whether, when inferring submodules, the inferr submodules should
292  /// export all modules they import (e.g., the equivalent of "export *").
293  unsigned InferExportWildcard : 1;
294 
295  /// Whether the set of configuration macros is exhaustive.
296  ///
297  /// When the set of configuration macros is exhaustive, meaning
298  /// that no identifier not in this list should affect how the module is
299  /// built.
301 
302  /// Whether files in this module can only include non-modular headers
303  /// and headers from used modules.
304  unsigned NoUndeclaredIncludes : 1;
305 
306  /// Whether this module came from a "private" module map, found next
307  /// to a regular (public) module map.
308  unsigned ModuleMapIsPrivate : 1;
309 
310  /// Describes the visibility of the various names within a
311  /// particular module.
313  /// All of the names in this module are hidden.
315  /// All of the names in this module are visible.
317  };
318 
319  /// The visibility of names within this particular module.
321 
322  /// The location of the inferred submodule.
324 
325  /// The set of modules imported by this module, and on which this
326  /// module depends.
328 
329  /// Describes an exported module.
330  ///
331  /// The pointer is the module being re-exported, while the bit will be true
332  /// to indicate that this is a wildcard export.
333  using ExportDecl = llvm::PointerIntPair<Module *, 1, bool>;
334 
335  /// The set of export declarations.
337 
338  /// Describes an exported module that has not yet been resolved
339  /// (perhaps because the module it refers to has not yet been loaded).
341  /// The location of the 'export' keyword in the module map file.
343 
344  /// The name of the module.
346 
347  /// Whether this export declaration ends in a wildcard, indicating
348  /// that all of its submodules should be exported (rather than the named
349  /// module itself).
350  bool Wildcard;
351  };
352 
353  /// The set of export declarations that have yet to be resolved.
355 
356  /// The directly used modules.
358 
359  /// The set of use declarations that have yet to be resolved.
361 
362  /// A library or framework to link against when an entity from this
363  /// module is used.
364  struct LinkLibrary {
365  LinkLibrary() = default;
368 
369  /// The library to link against.
370  ///
371  /// This will typically be a library or framework name, but can also
372  /// be an absolute path to the library or framework.
374 
375  /// Whether this is a framework rather than a library.
376  bool IsFramework = false;
377  };
378 
379  /// The set of libraries or frameworks to link against when
380  /// an entity from this module is used.
382 
383  /// Autolinking uses the framework name for linking purposes
384  /// when this is false and the export_as name otherwise.
386 
387  /// The set of "configuration macros", which are macros that
388  /// (intentionally) change how this module is built.
389  std::vector<std::string> ConfigMacros;
390 
391  /// An unresolved conflict with another module.
393  /// The (unresolved) module id.
395 
396  /// The message provided to the user when there is a conflict.
398  };
399 
400  /// The list of conflicts for which the module-id has not yet been
401  /// resolved.
402  std::vector<UnresolvedConflict> UnresolvedConflicts;
403 
404  /// A conflict between two modules.
405  struct Conflict {
406  /// The module that this module conflicts with.
408 
409  /// The message provided to the user when there is a conflict.
411  };
412 
413  /// The list of conflicts.
414  std::vector<Conflict> Conflicts;
415 
416  /// Construct a new module or submodule.
418  bool IsFramework, bool IsExplicit, unsigned VisibilityID);
419 
420  ~Module();
421 
422  /// Determine whether this module has been declared unimportable.
423  bool isUnimportable() const { return IsUnimportable; }
424 
425  /// Determine whether this module has been declared unimportable.
426  ///
427  /// \param LangOpts The language options used for the current
428  /// translation unit.
429  ///
430  /// \param Target The target options used for the current translation unit.
431  ///
432  /// \param Req If this module is unimportable because of a missing
433  /// requirement, this parameter will be set to one of the requirements that
434  /// is not met for use of this module.
435  ///
436  /// \param ShadowingModule If this module is unimportable because it is
437  /// shadowed, this parameter will be set to the shadowing module.
438  bool isUnimportable(const LangOptions &LangOpts, const TargetInfo &Target,
439  Requirement &Req, Module *&ShadowingModule) const;
440 
441  /// Determine whether this module is available for use within the
442  /// current translation unit.
443  bool isAvailable() const { return IsAvailable; }
444 
445  /// Determine whether this module is available for use within the
446  /// current translation unit.
447  ///
448  /// \param LangOpts The language options used for the current
449  /// translation unit.
450  ///
451  /// \param Target The target options used for the current translation unit.
452  ///
453  /// \param Req If this module is unavailable because of a missing requirement,
454  /// this parameter will be set to one of the requirements that is not met for
455  /// use of this module.
456  ///
457  /// \param MissingHeader If this module is unavailable because of a missing
458  /// header, this parameter will be set to one of the missing headers.
459  ///
460  /// \param ShadowingModule If this module is unavailable because it is
461  /// shadowed, this parameter will be set to the shadowing module.
462  bool isAvailable(const LangOptions &LangOpts,
463  const TargetInfo &Target,
464  Requirement &Req,
465  UnresolvedHeaderDirective &MissingHeader,
466  Module *&ShadowingModule) const;
467 
468  /// Determine whether this module is a submodule.
469  bool isSubModule() const { return Parent != nullptr; }
470 
471  /// Check if this module is a (possibly transitive) submodule of \p Other.
472  ///
473  /// The 'A is a submodule of B' relation is a partial order based on the
474  /// the parent-child relationship between individual modules.
475  ///
476  /// Returns \c false if \p Other is \c nullptr.
477  bool isSubModuleOf(const Module *Other) const;
478 
479  /// Determine whether this module is a part of a framework,
480  /// either because it is a framework module or because it is a submodule
481  /// of a framework module.
482  bool isPartOfFramework() const {
483  for (const Module *Mod = this; Mod; Mod = Mod->Parent)
484  if (Mod->IsFramework)
485  return true;
486 
487  return false;
488  }
489 
490  /// Determine whether this module is a subframework of another
491  /// framework.
492  bool isSubFramework() const {
493  return IsFramework && Parent && Parent->isPartOfFramework();
494  }
495 
496  /// Set the parent of this module. This should only be used if the parent
497  /// could not be set during module creation.
498  void setParent(Module *M) {
499  assert(!Parent);
500  Parent = M;
501  Parent->SubModuleIndex[Name] = Parent->SubModules.size();
502  Parent->SubModules.push_back(this);
503  }
504 
505  /// Retrieve the full name of this module, including the path from
506  /// its top-level module.
507  /// \param AllowStringLiterals If \c true, components that might not be
508  /// lexically valid as identifiers will be emitted as string literals.
509  std::string getFullModuleName(bool AllowStringLiterals = false) const;
510 
511  /// Whether the full name of this module is equal to joining
512  /// \p nameParts with "."s.
513  ///
514  /// This is more efficient than getFullModuleName().
515  bool fullModuleNameIs(ArrayRef<StringRef> nameParts) const;
516 
517  /// Retrieve the top-level module for this (sub)module, which may
518  /// be this module.
520  return const_cast<Module *>(
521  const_cast<const Module *>(this)->getTopLevelModule());
522  }
523 
524  /// Retrieve the top-level module for this (sub)module, which may
525  /// be this module.
526  const Module *getTopLevelModule() const;
527 
528  /// Retrieve the name of the top-level module.
529  StringRef getTopLevelModuleName() const {
530  return getTopLevelModule()->Name;
531  }
532 
533  /// The serialized AST file for this module, if one was created.
535  return getTopLevelModule()->ASTFile;
536  }
537 
538  /// Set the serialized AST file for the top-level module of this module.
540  assert((!File || !getASTFile() || getASTFile() == File) &&
541  "file path changed");
542  getTopLevelModule()->ASTFile = File;
543  }
544 
545  /// Retrieve the directory for which this module serves as the
546  /// umbrella.
547  DirectoryName getUmbrellaDir() const;
548 
549  /// Retrieve the header that serves as the umbrella header for this
550  /// module.
552  if (auto *FE = Umbrella.dyn_cast<const FileEntry *>())
554  FE};
555  return Header{};
556  }
557 
558  /// Determine whether this module has an umbrella directory that is
559  /// not based on an umbrella header.
560  bool hasUmbrellaDir() const {
561  return Umbrella && Umbrella.is<const DirectoryEntry *>();
562  }
563 
564  /// Add a top-level header associated with this module.
565  void addTopHeader(const FileEntry *File);
566 
567  /// Add a top-level header filename associated with this module.
568  void addTopHeaderFilename(StringRef Filename) {
569  TopHeaderNames.push_back(std::string(Filename));
570  }
571 
572  /// The top-level headers associated with this module.
574 
575  /// Determine whether this module has declared its intention to
576  /// directly use another module.
577  bool directlyUses(const Module *Requested) const;
578 
579  /// Add the given feature requirement to the list of features
580  /// required by this module.
581  ///
582  /// \param Feature The feature that is required by this module (and
583  /// its submodules).
584  ///
585  /// \param RequiredState The required state of this feature: \c true
586  /// if it must be present, \c false if it must be absent.
587  ///
588  /// \param LangOpts The set of language options that will be used to
589  /// evaluate the availability of this feature.
590  ///
591  /// \param Target The target options that will be used to evaluate the
592  /// availability of this feature.
593  void addRequirement(StringRef Feature, bool RequiredState,
594  const LangOptions &LangOpts,
595  const TargetInfo &Target);
596 
597  /// Mark this module and all of its submodules as unavailable.
598  void markUnavailable(bool Unimportable);
599 
600  /// Find the submodule with the given name.
601  ///
602  /// \returns The submodule if found, or NULL otherwise.
603  Module *findSubmodule(StringRef Name) const;
604  Module *findOrInferSubmodule(StringRef Name);
605 
606  /// Determine whether the specified module would be visible to
607  /// a lookup at the end of this module.
608  ///
609  /// FIXME: This may return incorrect results for (submodules of) the
610  /// module currently being built, if it's queried before we see all
611  /// of its imports.
612  bool isModuleVisible(const Module *M) const {
613  if (VisibleModulesCache.empty())
614  buildVisibleModulesCache();
615  return VisibleModulesCache.count(M);
616  }
617 
618  unsigned getVisibilityID() const { return VisibilityID; }
619 
620  using submodule_iterator = std::vector<Module *>::iterator;
621  using submodule_const_iterator = std::vector<Module *>::const_iterator;
622 
623  submodule_iterator submodule_begin() { return SubModules.begin(); }
624  submodule_const_iterator submodule_begin() const {return SubModules.begin();}
625  submodule_iterator submodule_end() { return SubModules.end(); }
626  submodule_const_iterator submodule_end() const { return SubModules.end(); }
627 
628  llvm::iterator_range<submodule_iterator> submodules() {
629  return llvm::make_range(submodule_begin(), submodule_end());
630  }
631  llvm::iterator_range<submodule_const_iterator> submodules() const {
632  return llvm::make_range(submodule_begin(), submodule_end());
633  }
634 
635  /// Appends this module's list of exported modules to \p Exported.
636  ///
637  /// This provides a subset of immediately imported modules (the ones that are
638  /// directly exported), not the complete set of exported modules.
639  void getExportedModules(SmallVectorImpl<Module *> &Exported) const;
640 
641  static StringRef getModuleInputBufferName() {
642  return "<module-includes>";
643  }
644 
645  /// Print the module map for this module to the given stream.
646  void print(raw_ostream &OS, unsigned Indent = 0, bool Dump = false) const;
647 
648  /// Dump the contents of this module to the given output stream.
649  void dump() const;
650 
651 private:
652  void buildVisibleModulesCache() const;
653 };
654 
655 /// A set of visible modules.
657 public:
658  VisibleModuleSet() = default;
660  : ImportLocs(std::move(O.ImportLocs)), Generation(O.Generation ? 1 : 0) {
661  O.ImportLocs.clear();
662  ++O.Generation;
663  }
664 
665  /// Move from another visible modules set. Guaranteed to leave the source
666  /// empty and bump the generation on both.
668  ImportLocs = std::move(O.ImportLocs);
669  O.ImportLocs.clear();
670  ++O.Generation;
671  ++Generation;
672  return *this;
673  }
674 
675  /// Get the current visibility generation. Incremented each time the
676  /// set of visible modules changes in any way.
677  unsigned getGeneration() const { return Generation; }
678 
679  /// Determine whether a module is visible.
680  bool isVisible(const Module *M) const {
681  return getImportLoc(M).isValid();
682  }
683 
684  /// Get the location at which the import of a module was triggered.
686  return M->getVisibilityID() < ImportLocs.size()
687  ? ImportLocs[M->getVisibilityID()]
688  : SourceLocation();
689  }
690 
691  /// A callback to call when a module is made visible (directly or
692  /// indirectly) by a call to \ref setVisible.
693  using VisibleCallback = llvm::function_ref<void(Module *M)>;
694 
695  /// A callback to call when a module conflict is found. \p Path
696  /// consists of a sequence of modules from the conflicting module to the one
697  /// made visible, where each was exported by the next.
698  using ConflictCallback =
699  llvm::function_ref<void(ArrayRef<Module *> Path, Module *Conflict,
700  StringRef Message)>;
701 
702  /// Make a specific module visible.
703  void setVisible(Module *M, SourceLocation Loc,
704  VisibleCallback Vis = [](Module *) {},
706  StringRef) {});
707 
708 private:
709  /// Import locations for each visible module. Indexed by the module's
710  /// VisibilityID.
711  std::vector<SourceLocation> ImportLocs;
712 
713  /// Visibility generation, bumped every time the visibility state changes.
714  unsigned Generation = 0;
715 };
716 
717 /// Abstracts clang modules and precompiled header files and holds
718 /// everything needed to generate debug info for an imported module
719 /// or PCH.
721  StringRef PCHModuleName;
722  StringRef Path;
723  StringRef ASTFile;
724  ASTFileSignature Signature;
725  Module *ClangModule = nullptr;
726 
727 public:
728  ASTSourceDescriptor() = default;
729  ASTSourceDescriptor(StringRef Name, StringRef Path, StringRef ASTFile,
730  ASTFileSignature Signature)
731  : PCHModuleName(std::move(Name)), Path(std::move(Path)),
732  ASTFile(std::move(ASTFile)), Signature(Signature) {}
734 
735  std::string getModuleName() const;
736  StringRef getPath() const { return Path; }
737  StringRef getASTFile() const { return ASTFile; }
738  ASTFileSignature getSignature() const { return Signature; }
739  Module *getModuleOrNull() const { return ClangModule; }
740 };
741 
742 
743 } // namespace clang
744 
745 #endif // LLVM_CLANG_BASIC_MODULE_H
clang::Module::DirectUses
SmallVector< Module *, 2 > DirectUses
The directly used modules.
Definition: Module.h:357
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:272
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:235
clang::Module::getTopLevelModule
Module * getTopLevelModule()
Retrieve the top-level module for this (sub)module, which may be this module.
Definition: Module.h:519
clang::Module::LinkLibrary::LinkLibrary
LinkLibrary(const std::string &Library, bool IsFramework)
Definition: Module.h:366
llvm
Definition: Dominators.h:30
clang::Module::InferSubmodules
unsigned InferSubmodules
Whether we should infer submodules for this module based on the headers.
Definition: Module.h:285
clang::ASTFileSignature::create
static ASTFileSignature create(InputIt First, InputIt Last)
Definition: Module.h:85
clang::Module::Header::PathRelativeToRootModuleDirectory
std::string PathRelativeToRootModuleDirectory
Definition: Module.h:194
clang::Module::Requirements
SmallVector< Requirement, 2 > Requirements
The set of language features required to use this module.
Definition: Module.h:241
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:237
clang::DeclaratorContext::File
@ File
clang::Module::getUmbrellaDir
DirectoryName getUmbrellaDir() const
Retrieve the directory for which this module serves as the umbrella.
Definition: Module.cpp:246
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:252
llvm::SmallVector< std::pair< std::string, SourceLocation >, 2 >
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:88
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:350
clang::Module::Conflict::Other
Module * Other
The module that this module conflicts with.
Definition: Module.h:407
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:221
clang::Module::UnresolvedConflict::Id
ModuleId Id
The (unresolved) module id.
Definition: Module.h:394
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:560
clang::Module::HK_PrivateTextual
@ HK_PrivateTextual
Definition: Module.h:185
clang::Module::submodule_begin
submodule_iterator submodule_begin()
Definition: Module.h:623
clang::Module::setParent
void setParent(Module *M)
Set the parent of this module.
Definition: Module.h:498
clang::Module::Header::Entry
const FileEntry * Entry
Definition: Module.h:195
clang::Module::DirectoryName::Entry
const DirectoryEntry * Entry
Definition: Module.h:205
Filename
StringRef Filename
Definition: Format.cpp:2333
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:189
clang::Module::NameVisibilityKind
NameVisibilityKind
Describes the visibility of the various names within a particular module.
Definition: Module.h:312
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:293
clang::Module::submodules
llvm::iterator_range< submodule_const_iterator > submodules() const
Definition: Module.h:631
clang::Module::findSubmodule
Module * findSubmodule(StringRef Name) const
Find the submodule with the given name.
Definition: Module.cpp:330
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:308
clang::VisibleModuleSet::isVisible
bool isVisible(const Module *M) const
Determine whether a module is visible.
Definition: Module.h:680
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:320
clang::Module::isAvailable
bool isAvailable() const
Determine whether this module is available for use within the current translation unit.
Definition: Module.h:443
clang::Module::~Module
~Module()
Definition: Module.cpp:61
clang::Module::InferredSubmoduleLoc
SourceLocation InferredSubmoduleLoc
The location of the inferred submodule.
Definition: Module.h:323
clang::Module::UnresolvedExports
SmallVector< UnresolvedExportDecl, 2 > UnresolvedExports
The set of export declarations that have yet to be resolved.
Definition: Module.h:354
clang::Module::UnresolvedConflict::Message
std::string Message
The message provided to the user when there is a conflict.
Definition: Module.h:397
clang::Module::UnresolvedDirectUses
SmallVector< ModuleId, 2 > UnresolvedDirectUses
The set of use declarations that have yet to be resolved.
Definition: Module.h:360
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:612
clang::Module::submodule_end
submodule_const_iterator submodule_end() const
Definition: Module.h:626
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:304
clang::Module::getTopHeaders
ArrayRef< const FileEntry * > getTopHeaders(FileManager &FileMgr)
The top-level headers associated with this module.
Definition: Module.cpp:259
clang::Module::submodule_const_iterator
std::vector< Module * >::const_iterator submodule_const_iterator
Definition: Module.h:621
clang::Module::isUnimportable
bool isUnimportable() const
Determine whether this module has been declared unimportable.
Definition: Module.h:423
clang::Module::getVisibilityID
unsigned getVisibilityID() const
Definition: Module.h:618
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:314
clang::Module::findOrInferSubmodule
Module * findOrInferSubmodule(StringRef Name)
Definition: Module.cpp:338
clang::Module::UnresolvedExportDecl::ExportLoc
SourceLocation ExportLoc
The location of the 'export' keyword in the module map file.
Definition: Module.h:342
clang::VisibleModuleSet::getImportLoc
SourceLocation getImportLoc(const Module *M) const
Get the location at which the import of a module was triggered.
Definition: Module.h:685
clang::Module::isSubModule
bool isSubModule() const
Determine whether this module is a submodule.
Definition: Module.h:469
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:739
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:336
clang::Module::NumHeaderKinds
static const int NumHeaderKinds
Definition: Module.h:188
clang::ASTSourceDescriptor::getSignature
ASTFileSignature getSignature() const
Definition: Module.h:738
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:183
clang::VisibleModuleSet::VisibleModuleSet
VisibleModuleSet()=default
clang::Module::getTopLevelModuleName
StringRef getTopLevelModuleName() const
Retrieve the name of the top-level module.
Definition: Module.h:529
clang::Module::IsFramework
unsigned IsFramework
Whether this is a framework module.
Definition: Module.h:264
clang::Module::UnresolvedHeaderDirective::Size
Optional< off_t > Size
Definition: Module.h:221
clang::Module::LinkLibrary
A library or framework to link against when an entity from this module is used.
Definition: Module.h:364
clang::VisibleModuleSet
A set of visible modules.
Definition: Module.h:656
clang::Module::HeaderKind
HeaderKind
Definition: Module.h:181
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:316
clang::Module::Conflicts
std::vector< Conflict > Conflicts
The list of conflicts.
Definition: Module.h:414
clang::Module::UnresolvedConflicts
std::vector< UnresolvedConflict > UnresolvedConflicts
The list of conflicts for which the module-id has not yet been resolved.
Definition: Module.h:402
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:218
clang::VisibleModuleSet::getGeneration
unsigned getGeneration() const
Get the current visibility generation.
Definition: Module.h:677
llvm::DenseSet
Definition: Sema.h:78
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:482
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:231
clang::ASTSourceDescriptor::getPath
StringRef getPath() const
Definition: Module.h:736
clang::Module::IsExplicit
unsigned IsExplicit
Whether this is an explicit submodule.
Definition: Module.h:267
clang::Module::getASTFile
OptionalFileEntryRefDegradesToFileEntryPtr getASTFile() const
The serialized AST file for this module, if one was created.
Definition: Module.h:534
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:633
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:376
clang::ASTSourceDescriptor::getModuleName
std::string getModuleName() const
Definition: Module.cpp:686
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:628
clang::Module::submodule_iterator
std::vector< Module * >::iterator submodule_iterator
Definition: Module.h:620
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:182
clang::Module::markUnavailable
void markUnavailable(bool Unimportable)
Mark this module and all of its submodules as unavailable.
Definition: Module.cpp:302
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:381
SourceLocation.h
clang::Indent
raw_ostream & Indent(raw_ostream &Out, const unsigned int Space, bool IsDot)
Definition: JsonSupport.h:20
clang::Module::HK_Private
@ HK_Private
Definition: Module.h:184
clang::Module::DirectoryName::PathRelativeToRootModuleDirectory
std::string PathRelativeToRootModuleDirectory
Definition: Module.h:204
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:211
clang::Module::Conflict::Message
std::string Message
The message provided to the user when there is a conflict.
Definition: Module.h:410
clang::Module::IsSystem
unsigned IsSystem
Whether this is a "system" module (which assumes that all headers in it are system headers).
Definition: Module.h:271
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:737
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:220
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:327
clang::Module::UnresolvedConflict
An unresolved conflict with another module.
Definition: Module.h:392
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:186
clang::Module::InferExplicitSubmodules
unsigned InferExplicitSubmodules
Whether, when inferring submodules, the inferred submodules should be explicit.
Definition: Module.h:289
clang::Module::IsAvailable
unsigned IsAvailable
Whether this module is available in the current translation unit.
Definition: Module.h:258
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:700
clang::Module::UnresolvedHeaderDirective::IsUmbrella
bool IsUmbrella
Definition: Module.h:219
clang::Module::Conflict
A conflict between two modules.
Definition: Module.h:405
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:3899
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:215
clang::VisibleModuleSet::VisibleModuleSet
VisibleModuleSet(VisibleModuleSet &&O)
Definition: Module.h:659
clang::Module::DirectoryName
Information about a directory name as found in the module map file.
Definition: Module.h:202
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:175
clang::VisibleModuleSet::operator=
VisibleModuleSet & operator=(VisibleModuleSet &&O)
Move from another visible modules set.
Definition: Module.h:667
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:693
clang::Module::getModuleInputBufferName
static StringRef getModuleInputBufferName()
Definition: Module.h:641
clang::Module::UnresolvedExportDecl
Describes an exported module that has not yet been resolved (perhaps because the module it refers to ...
Definition: Module.h:340
clang::ASTSourceDescriptor::ASTSourceDescriptor
ASTSourceDescriptor()=default
clang::Module::Header
Information about a header directive as found in the module map file.
Definition: Module.h:192
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:433
clang::Module::UnresolvedExportDecl::Id
ModuleId Id
The name of the module.
Definition: Module.h:345
clang::Module::IsUnimportable
unsigned IsUnimportable
Whether this module has declared itself unimportable, either because it's missing a requirement from ...
Definition: Module.h:249
clang::ASTSourceDescriptor::ASTSourceDescriptor
ASTSourceDescriptor(StringRef Name, StringRef Path, StringRef ASTFile, ASTFileSignature Signature)
Definition: Module.h:729
clang::Module::getUmbrellaHeader
Header getUmbrellaHeader() const
Retrieve the header that serves as the umbrella header for this module.
Definition: Module.h:551
clang::SourceLocation::isValid
bool isValid() const
Return true if this is a valid SourceLocation object.
Definition: SourceLocation.h:112
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:389
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:373
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:276
clang::Module::ConfigMacrosExhaustive
unsigned ConfigMacrosExhaustive
Whether the set of configuration macros is exhaustive.
Definition: Module.h:300
clang::Module::submodule_begin
submodule_const_iterator submodule_begin() const
Definition: Module.h:624
clang::Module::submodule_end
submodule_iterator submodule_end()
Definition: Module.h:625
clang::Module::addTopHeaderFilename
void addTopHeaderFilename(StringRef Filename)
Add a top-level header filename associated with this module.
Definition: Module.h:568
clang::Module::isSubFramework
bool isSubFramework() const
Determine whether this module is a subframework of another framework.
Definition: Module.h:492
clang::Module::setASTFile
void setASTFile(Optional< FileEntryRef > File)
Set the serialized AST file for the top-level module of this module.
Definition: Module.h:539
clang::Module::IsFromModuleFile
unsigned IsFromModuleFile
Whether this module was loaded from a module file.
Definition: Module.h:261
clang::Module::getExportedModules
void getExportedModules(SmallVectorImpl< Module * > &Exported) const
Appends this module's list of exported modules to Exported.
Definition: Module.cpp:353
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:290
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:254
llvm::SmallVectorImpl
Definition: LLVM.h:39
llvm::SmallSetVector
Definition: ExternalSemaSource.h:23
clang::Module::UnresolvedHeaderDirective::Kind
HeaderKind Kind
Definition: Module.h:216
clang::Module::ShadowingModule
Module * ShadowingModule
A module with the same name that shadows this module.
Definition: Module.h:244
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:385
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:333
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:203
clang::Module::UnresolvedHeaderDirective::ModTime
Optional< time_t > ModTime
Definition: Module.h:222
clang::Module::IsInferred
unsigned IsInferred
Whether this is an inferred submodule (module * { ... }).
Definition: Module.h:279
clang::Module::UnresolvedHeaderDirective::FileNameLoc
SourceLocation FileNameLoc
Definition: Module.h:217
clang::ASTSourceDescriptor
Abstracts clang modules and precompiled header files and holds everything needed to generate debug in...
Definition: Module.h:720
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:227
clang::Module::Header::NameAsWritten
std::string NameAsWritten
Definition: Module.h:193