blob: 31c5c7ec9ca885f13530d39b335ca43ba258f35c [file] [log] [blame]
//===--- Module.h - Describe a module ---------------------------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
/// \file
/// \brief Defines the clang::Module class, which describes a module in the
/// source code.
#include "clang/Basic/FileManager.h"
#include "clang/Basic/SourceLocation.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/PointerIntPair.h"
#include "llvm/ADT/PointerUnion.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include <string>
#include <utility>
#include <vector>
namespace llvm {
class raw_ostream;
namespace clang {
class LangOptions;
class TargetInfo;
class IdentifierInfo;
/// \brief Describes the name of a module.
typedef SmallVector<std::pair<std::string, SourceLocation>, 2> ModuleId;
/// \brief Describes a module or submodule.
class Module {
/// \brief The name of this module.
std::string Name;
/// \brief The location of the module definition.
SourceLocation DefinitionLoc;
/// \brief The parent of this module. This will be NULL for the top-level
/// module.
Module *Parent;
/// \brief The build directory of this module. This is the directory in
/// which the module is notionally built, and relative to which its headers
/// are found.
const DirectoryEntry *Directory;
/// \brief The umbrella header or directory.
llvm::PointerUnion<const DirectoryEntry *, const FileEntry *> Umbrella;
/// \brief The module signature.
uint64_t Signature;
/// \brief The name of the umbrella entry, as written in the module map.
std::string UmbrellaAsWritten;
/// \brief The submodules of this module, indexed by name.
std::vector<Module *> SubModules;
/// \brief A mapping from the submodule name to the index into the
/// \c SubModules vector at which that submodule resides.
llvm::StringMap<unsigned> SubModuleIndex;
/// \brief The AST file if this is a top-level module which has a
/// corresponding serialized AST file, or null otherwise.
const FileEntry *ASTFile;
/// \brief The top-level headers associated with this module.
llvm::SmallSetVector<const FileEntry *, 2> TopHeaders;
/// \brief top-level header filenames that aren't resolved to FileEntries yet.
std::vector<std::string> TopHeaderNames;
/// \brief Cache of modules visible to lookup in this module.
mutable llvm::DenseSet<const Module*> VisibleModulesCache;
/// The ID used when referencing this module within a VisibleModuleSet.
unsigned VisibilityID;
enum HeaderKind {
static const int NumHeaderKinds = HK_Excluded + 1;
/// \brief Information about a header directive as found in the module map
/// file.
struct Header {
std::string NameAsWritten;
const FileEntry *Entry;
explicit operator bool() { return Entry; }
/// \brief Information about a directory name as found in the module map
/// file.
struct DirectoryName {
std::string NameAsWritten;
const DirectoryEntry *Entry;
explicit operator bool() { return Entry; }
/// \brief The headers that are part of this module.
SmallVector<Header, 2> Headers[5];
/// \brief Stored information about a header directive that was found in the
/// module map file but has not been resolved to a file.
struct UnresolvedHeaderDirective {
SourceLocation FileNameLoc;
std::string FileName;
bool IsUmbrella;
/// \brief Headers that are mentioned in the module map file but could not be
/// found on the file system.
SmallVector<UnresolvedHeaderDirective, 1> MissingHeaders;
/// \brief An individual requirement: a feature name and a flag indicating
/// the required state of that feature.
typedef std::pair<std::string, bool> Requirement;
/// \brief The set of language features required to use this module.
/// If any of these requirements are not available, the \c IsAvailable bit
/// will be false to indicate that this (sub)module is not available.
SmallVector<Requirement, 2> Requirements;
/// \brief Whether this module is missing a feature from \c Requirements.
unsigned IsMissingRequirement : 1;
/// \brief Whether we tried and failed to load a module file for this module.
unsigned HasIncompatibleModuleFile : 1;
/// \brief Whether this module is available in the current translation unit.
/// If the module is missing headers or does not meet all requirements then
/// this bit will be 0.
unsigned IsAvailable : 1;
/// \brief Whether this module was loaded from a module file.
unsigned IsFromModuleFile : 1;
/// \brief Whether this is a framework module.
unsigned IsFramework : 1;
/// \brief Whether this is an explicit submodule.
unsigned IsExplicit : 1;
/// \brief Whether this is a "system" module (which assumes that all
/// headers in it are system headers).
unsigned IsSystem : 1;
/// \brief Whether this is an 'extern "C"' module (which implicitly puts all
/// headers in it within an 'extern "C"' block, and allows the module to be
/// imported within such a block).
unsigned IsExternC : 1;
/// \brief Whether this is an inferred submodule (module * { ... }).
unsigned IsInferred : 1;
/// \brief Whether we should infer submodules for this module based on
/// the headers.
/// Submodules can only be inferred for modules with an umbrella header.
unsigned InferSubmodules : 1;
/// \brief Whether, when inferring submodules, the inferred submodules
/// should be explicit.
unsigned InferExplicitSubmodules : 1;
/// \brief Whether, when inferring submodules, the inferr submodules should
/// export all modules they import (e.g., the equivalent of "export *").
unsigned InferExportWildcard : 1;
/// \brief Whether the set of configuration macros is exhaustive.
/// When the set of configuration macros is exhaustive, meaning
/// that no identifier not in this list should affect how the module is
/// built.
unsigned ConfigMacrosExhaustive : 1;
/// \brief Whether files in this module can only include non-modular headers
/// and headers from used modules.
unsigned NoUndeclaredIncludes : 1;
/// \brief Describes the visibility of the various names within a
/// particular module.
enum NameVisibilityKind {
/// \brief All of the names in this module are hidden.
/// \brief All of the names in this module are visible.
/// \brief The visibility of names within this particular module.
NameVisibilityKind NameVisibility;
/// \brief The location of the inferred submodule.
SourceLocation InferredSubmoduleLoc;
/// \brief The set of modules imported by this module, and on which this
/// module depends.
llvm::SmallSetVector<Module *, 2> Imports;
/// \brief Describes an exported module.
/// The pointer is the module being re-exported, while the bit will be true
/// to indicate that this is a wildcard export.
typedef llvm::PointerIntPair<Module *, 1, bool> ExportDecl;
/// \brief The set of export declarations.
SmallVector<ExportDecl, 2> Exports;
/// \brief Describes an exported module that has not yet been resolved
/// (perhaps because the module it refers to has not yet been loaded).
struct UnresolvedExportDecl {
/// \brief The location of the 'export' keyword in the module map file.
SourceLocation ExportLoc;
/// \brief The name of the module.
ModuleId Id;
/// \brief Whether this export declaration ends in a wildcard, indicating
/// that all of its submodules should be exported (rather than the named
/// module itself).
bool Wildcard;
/// \brief The set of export declarations that have yet to be resolved.
SmallVector<UnresolvedExportDecl, 2> UnresolvedExports;
/// \brief The directly used modules.
SmallVector<Module *, 2> DirectUses;
/// \brief The set of use declarations that have yet to be resolved.
SmallVector<ModuleId, 2> UnresolvedDirectUses;
/// \brief A library or framework to link against when an entity from this
/// module is used.
struct LinkLibrary {
LinkLibrary() : IsFramework(false) { }
LinkLibrary(const std::string &Library, bool IsFramework)
: Library(Library), IsFramework(IsFramework) { }
/// \brief The library to link against.
/// This will typically be a library or framework name, but can also
/// be an absolute path to the library or framework.
std::string Library;
/// \brief Whether this is a framework rather than a library.
bool IsFramework;
/// \brief The set of libraries or frameworks to link against when
/// an entity from this module is used.
llvm::SmallVector<LinkLibrary, 2> LinkLibraries;
/// \brief The set of "configuration macros", which are macros that
/// (intentionally) change how this module is built.
std::vector<std::string> ConfigMacros;
/// \brief An unresolved conflict with another module.
struct UnresolvedConflict {
/// \brief The (unresolved) module id.
ModuleId Id;
/// \brief The message provided to the user when there is a conflict.
std::string Message;
/// \brief The list of conflicts for which the module-id has not yet been
/// resolved.
std::vector<UnresolvedConflict> UnresolvedConflicts;
/// \brief A conflict between two modules.
struct Conflict {
/// \brief The module that this module conflicts with.
Module *Other;
/// \brief The message provided to the user when there is a conflict.
std::string Message;
/// \brief The list of conflicts.
std::vector<Conflict> Conflicts;
/// \brief Construct a new module or submodule.
Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent,
bool IsFramework, bool IsExplicit, unsigned VisibilityID);
/// \brief Determine whether this module is available for use within the
/// current translation unit.
bool isAvailable() const { return IsAvailable; }
/// \brief Determine whether this module is available for use within the
/// current translation unit.
/// \param LangOpts The language options used for the current
/// translation unit.
/// \param Target The target options used for the current translation unit.
/// \param Req If this module is unavailable, this parameter
/// will be set to one of the requirements that is not met for use of
/// this module.
bool isAvailable(const LangOptions &LangOpts,
const TargetInfo &Target,
Requirement &Req,
UnresolvedHeaderDirective &MissingHeader) const;
/// \brief Determine whether this module is a submodule.
bool isSubModule() const { return Parent != nullptr; }
/// \brief Determine whether this module is a submodule of the given other
/// module.
bool isSubModuleOf(const Module *Other) const;
/// \brief Determine whether this module is a part of a framework,
/// either because it is a framework module or because it is a submodule
/// of a framework module.
bool isPartOfFramework() const {
for (const Module *Mod = this; Mod; Mod = Mod->Parent)
if (Mod->IsFramework)
return true;
return false;
/// \brief Determine whether this module is a subframework of another
/// framework.
bool isSubFramework() const {
return IsFramework && Parent && Parent->isPartOfFramework();
/// \brief Retrieve the full name of this module, including the path from
/// its top-level module.
std::string getFullModuleName() const;
/// \brief Whether the full name of this module is equal to joining
/// \p nameParts with "."s.
/// This is more efficient than getFullModuleName().
bool fullModuleNameIs(ArrayRef<StringRef> nameParts) const;
/// \brief Retrieve the top-level module for this (sub)module, which may
/// be this module.
Module *getTopLevelModule() {
return const_cast<Module *>(
const_cast<const Module *>(this)->getTopLevelModule());
/// \brief Retrieve the top-level module for this (sub)module, which may
/// be this module.
const Module *getTopLevelModule() const;
/// \brief Retrieve the name of the top-level module.
StringRef getTopLevelModuleName() const {
return getTopLevelModule()->Name;
/// \brief The serialized AST file for this module, if one was created.
const FileEntry *getASTFile() const {
return getTopLevelModule()->ASTFile;
/// \brief Set the serialized AST file for the top-level module of this module.
void setASTFile(const FileEntry *File) {
assert((File == nullptr || getASTFile() == nullptr ||
getASTFile() == File) && "file path changed");
getTopLevelModule()->ASTFile = File;
/// \brief Retrieve the directory for which this module serves as the
/// umbrella.
DirectoryName getUmbrellaDir() const;
/// \brief Retrieve the header that serves as the umbrella header for this
/// module.
Header getUmbrellaHeader() const {
if (auto *E = Umbrella.dyn_cast<const FileEntry *>())
return Header{UmbrellaAsWritten, E};
return Header{};
/// \brief Determine whether this module has an umbrella directory that is
/// not based on an umbrella header.
bool hasUmbrellaDir() const {
return Umbrella &&<const DirectoryEntry *>();
/// \brief Add a top-level header associated with this module.
void addTopHeader(const FileEntry *File) {
/// \brief Add a top-level header filename associated with this module.
void addTopHeaderFilename(StringRef Filename) {
/// \brief The top-level headers associated with this module.
ArrayRef<const FileEntry *> getTopHeaders(FileManager &FileMgr);
/// \brief Determine whether this module has declared its intention to
/// directly use another module.
bool directlyUses(const Module *Requested) const;
/// \brief Add the given feature requirement to the list of features
/// required by this module.
/// \param Feature The feature that is required by this module (and
/// its submodules).
/// \param RequiredState The required state of this feature: \c true
/// if it must be present, \c false if it must be absent.
/// \param LangOpts The set of language options that will be used to
/// evaluate the availability of this feature.
/// \param Target The target options that will be used to evaluate the
/// availability of this feature.
void addRequirement(StringRef Feature, bool RequiredState,
const LangOptions &LangOpts,
const TargetInfo &Target);
/// \brief Mark this module and all of its submodules as unavailable.
void markUnavailable(bool MissingRequirement = false);
/// \brief Find the submodule with the given name.
/// \returns The submodule if found, or NULL otherwise.
Module *findSubmodule(StringRef Name) const;
/// \brief Determine whether the specified module would be visible to
/// a lookup at the end of this module.
/// FIXME: This may return incorrect results for (submodules of) the
/// module currently being built, if it's queried before we see all
/// of its imports.
bool isModuleVisible(const Module *M) const {
if (VisibleModulesCache.empty())
return VisibleModulesCache.count(M);
unsigned getVisibilityID() const { return VisibilityID; }
typedef std::vector<Module *>::iterator submodule_iterator;
typedef std::vector<Module *>::const_iterator submodule_const_iterator;
submodule_iterator submodule_begin() { return SubModules.begin(); }
submodule_const_iterator submodule_begin() const {return SubModules.begin();}
submodule_iterator submodule_end() { return SubModules.end(); }
submodule_const_iterator submodule_end() const { return SubModules.end(); }
llvm::iterator_range<submodule_iterator> submodules() {
return llvm::make_range(submodule_begin(), submodule_end());
llvm::iterator_range<submodule_const_iterator> submodules() const {
return llvm::make_range(submodule_begin(), submodule_end());
/// \brief Appends this module's list of exported modules to \p Exported.
/// This provides a subset of immediately imported modules (the ones that are
/// directly exported), not the complete set of exported modules.
void getExportedModules(SmallVectorImpl<Module *> &Exported) const;
static StringRef getModuleInputBufferName() {
return "<module-includes>";
/// \brief Print the module map for this module to the given stream.
void print(raw_ostream &OS, unsigned Indent = 0) const;
/// \brief Dump the contents of this module to the given output stream.
void dump() const;
void buildVisibleModulesCache() const;
/// \brief A set of visible modules.
class VisibleModuleSet {
VisibleModuleSet() : Generation(0) {}
VisibleModuleSet(VisibleModuleSet &&O)
: ImportLocs(std::move(O.ImportLocs)), Generation(O.Generation ? 1 : 0) {
/// Move from another visible modules set. Guaranteed to leave the source
/// empty and bump the generation on both.
VisibleModuleSet &operator=(VisibleModuleSet &&O) {
ImportLocs = std::move(O.ImportLocs);
return *this;
/// \brief Get the current visibility generation. Incremented each time the
/// set of visible modules changes in any way.
unsigned getGeneration() const { return Generation; }
/// \brief Determine whether a module is visible.
bool isVisible(const Module *M) const {
return getImportLoc(M).isValid();
/// \brief Get the location at which the import of a module was triggered.
SourceLocation getImportLoc(const Module *M) const {
return M->getVisibilityID() < ImportLocs.size()
? ImportLocs[M->getVisibilityID()]
: SourceLocation();
/// \brief A callback to call when a module is made visible (directly or
/// indirectly) by a call to \ref setVisible.
typedef llvm::function_ref<void(Module *M)> VisibleCallback;
/// \brief A callback to call when a module conflict is found. \p Path
/// consists of a sequence of modules from the conflicting module to the one
/// made visible, where each was exported by the next.
typedef llvm::function_ref<void(ArrayRef<Module *> Path,
Module *Conflict, StringRef Message)>
/// \brief Make a specific module visible.
void setVisible(Module *M, SourceLocation Loc,
VisibleCallback Vis = [](Module *) {},
ConflictCallback Cb = [](ArrayRef<Module *>, Module *,
StringRef) {});
/// Import locations for each visible module. Indexed by the module's
/// VisibilityID.
std::vector<SourceLocation> ImportLocs;
/// Visibility generation, bumped every time the visibility state changes.
unsigned Generation;
} // end namespace clang