333 lines
12 KiB
C++
333 lines
12 KiB
C++
//===--- ModuleMap.h - Describe the layout of modules -----------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines the ModuleMap interface, which describes the layout of a
|
|
// module as it relates to headers.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
#ifndef LLVM_CLANG_LEX_MODULEMAP_H
|
|
#define LLVM_CLANG_LEX_MODULEMAP_H
|
|
|
|
#include "clang/Basic/LangOptions.h"
|
|
#include "clang/Basic/Module.h"
|
|
#include "clang/Basic/SourceManager.h"
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/ADT/IntrusiveRefCntPtr.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include <string>
|
|
|
|
namespace clang {
|
|
|
|
class DirectoryEntry;
|
|
class FileEntry;
|
|
class FileManager;
|
|
class DiagnosticConsumer;
|
|
class DiagnosticsEngine;
|
|
class HeaderSearch;
|
|
class ModuleMapParser;
|
|
|
|
class ModuleMap {
|
|
SourceManager *SourceMgr;
|
|
IntrusiveRefCntPtr<DiagnosticsEngine> Diags;
|
|
const LangOptions &LangOpts;
|
|
const TargetInfo *Target;
|
|
HeaderSearch &HeaderInfo;
|
|
|
|
/// \brief The directory used for Clang-supplied, builtin include headers,
|
|
/// such as "stdint.h".
|
|
const DirectoryEntry *BuiltinIncludeDir;
|
|
|
|
/// \brief Language options used to parse the module map itself.
|
|
///
|
|
/// These are always simple C language options.
|
|
LangOptions MMapLangOpts;
|
|
|
|
/// \brief The top-level modules that are known.
|
|
llvm::StringMap<Module *> Modules;
|
|
|
|
/// \brief A header that is known to reside within a given module,
|
|
/// whether it was included or excluded.
|
|
class KnownHeader {
|
|
llvm::PointerIntPair<Module *, 1, bool> Storage;
|
|
|
|
public:
|
|
KnownHeader() : Storage(0, false) { }
|
|
KnownHeader(Module *M, bool Excluded) : Storage(M, Excluded) { }
|
|
|
|
/// \brief Retrieve the module the header is stored in.
|
|
Module *getModule() const { return Storage.getPointer(); }
|
|
|
|
/// \brief Whether this header is explicitly excluded from the module.
|
|
bool isExcluded() const { return Storage.getInt(); }
|
|
|
|
/// \brief Whether this header is available in the module.
|
|
bool isAvailable() const {
|
|
return !isExcluded() && getModule()->isAvailable();
|
|
}
|
|
|
|
// \brief Whether this known header is valid (i.e., it has an
|
|
// associated module).
|
|
operator bool() const { return Storage.getPointer() != 0; }
|
|
};
|
|
|
|
typedef llvm::DenseMap<const FileEntry *, KnownHeader> HeadersMap;
|
|
|
|
/// \brief Mapping from each header to the module that owns the contents of the
|
|
/// that header.
|
|
HeadersMap Headers;
|
|
|
|
/// \brief Mapping from directories with umbrella headers to the module
|
|
/// that is generated from the umbrella header.
|
|
///
|
|
/// This mapping is used to map headers that haven't explicitly been named
|
|
/// in the module map over to the module that includes them via its umbrella
|
|
/// header.
|
|
llvm::DenseMap<const DirectoryEntry *, Module *> UmbrellaDirs;
|
|
|
|
/// \brief A directory for which framework modules can be inferred.
|
|
struct InferredDirectory {
|
|
InferredDirectory() : InferModules(), InferSystemModules() { }
|
|
|
|
/// \brief Whether to infer modules from this directory.
|
|
unsigned InferModules : 1;
|
|
|
|
/// \brief Whether the modules we infer are [system] modules.
|
|
unsigned InferSystemModules : 1;
|
|
|
|
/// \brief The names of modules that cannot be inferred within this
|
|
/// directory.
|
|
SmallVector<std::string, 2> ExcludedModules;
|
|
};
|
|
|
|
/// \brief A mapping from directories to information about inferring
|
|
/// framework modules from within those directories.
|
|
llvm::DenseMap<const DirectoryEntry *, InferredDirectory> InferredDirectories;
|
|
|
|
/// \brief Describes whether we haved parsed a particular file as a module
|
|
/// map.
|
|
llvm::DenseMap<const FileEntry *, bool> ParsedModuleMap;
|
|
|
|
friend class ModuleMapParser;
|
|
|
|
/// \brief Resolve the given export declaration into an actual export
|
|
/// declaration.
|
|
///
|
|
/// \param Mod The module in which we're resolving the export declaration.
|
|
///
|
|
/// \param Unresolved The export declaration to resolve.
|
|
///
|
|
/// \param Complain Whether this routine should complain about unresolvable
|
|
/// exports.
|
|
///
|
|
/// \returns The resolved export declaration, which will have a NULL pointer
|
|
/// if the export could not be resolved.
|
|
Module::ExportDecl
|
|
resolveExport(Module *Mod, const Module::UnresolvedExportDecl &Unresolved,
|
|
bool Complain) const;
|
|
|
|
/// \brief Resolve the given module id to an actual module.
|
|
///
|
|
/// \param Id The module-id to resolve.
|
|
///
|
|
/// \param Mod The module in which we're resolving the module-id.
|
|
///
|
|
/// \param Complain Whether this routine should complain about unresolvable
|
|
/// module-ids.
|
|
///
|
|
/// \returns The resolved module, or null if the module-id could not be
|
|
/// resolved.
|
|
Module *resolveModuleId(const ModuleId &Id, Module *Mod, bool Complain) const;
|
|
|
|
public:
|
|
/// \brief Construct a new module map.
|
|
///
|
|
/// \param FileMgr The file manager used to find module files and headers.
|
|
/// This file manager should be shared with the header-search mechanism, since
|
|
/// they will refer to the same headers.
|
|
///
|
|
/// \param DC A diagnostic consumer that will be cloned for use in generating
|
|
/// diagnostics.
|
|
///
|
|
/// \param LangOpts Language options for this translation unit.
|
|
///
|
|
/// \param Target The target for this translation unit.
|
|
ModuleMap(FileManager &FileMgr, const DiagnosticConsumer &DC,
|
|
const LangOptions &LangOpts, const TargetInfo *Target,
|
|
HeaderSearch &HeaderInfo);
|
|
|
|
/// \brief Destroy the module map.
|
|
///
|
|
~ModuleMap();
|
|
|
|
/// \brief Set the target information.
|
|
void setTarget(const TargetInfo &Target);
|
|
|
|
/// \brief Set the directory that contains Clang-supplied include
|
|
/// files, such as our stdarg.h or tgmath.h.
|
|
void setBuiltinIncludeDir(const DirectoryEntry *Dir) {
|
|
BuiltinIncludeDir = Dir;
|
|
}
|
|
const DirectoryEntry *getBuiltinIncludeDir() { return BuiltinIncludeDir; }
|
|
|
|
/// \brief Retrieve the module that owns the given header file, if any.
|
|
///
|
|
/// \param File The header file that is likely to be included.
|
|
///
|
|
/// \returns The module that owns the given header file, or null to indicate
|
|
/// that no module owns this header file.
|
|
Module *findModuleForHeader(const FileEntry *File);
|
|
|
|
/// \brief Determine whether the given header is part of a module
|
|
/// marked 'unavailable'.
|
|
bool isHeaderInUnavailableModule(const FileEntry *Header) const;
|
|
|
|
/// \brief Retrieve a module with the given name.
|
|
///
|
|
/// \param Name The name of the module to look up.
|
|
///
|
|
/// \returns The named module, if known; otherwise, returns null.
|
|
Module *findModule(StringRef Name) const;
|
|
|
|
/// \brief Retrieve a module with the given name using lexical name lookup,
|
|
/// starting at the given context.
|
|
///
|
|
/// \param Name The name of the module to look up.
|
|
///
|
|
/// \param Context The module context, from which we will perform lexical
|
|
/// name lookup.
|
|
///
|
|
/// \returns The named module, if known; otherwise, returns null.
|
|
Module *lookupModuleUnqualified(StringRef Name, Module *Context) const;
|
|
|
|
/// \brief Retrieve a module with the given name within the given context,
|
|
/// using direct (qualified) name lookup.
|
|
///
|
|
/// \param Name The name of the module to look up.
|
|
///
|
|
/// \param Context The module for which we will look for a submodule. If
|
|
/// null, we will look for a top-level module.
|
|
///
|
|
/// \returns The named submodule, if known; otherwose, returns null.
|
|
Module *lookupModuleQualified(StringRef Name, Module *Context) const;
|
|
|
|
/// \brief Find a new module or submodule, or create it if it does not already
|
|
/// exist.
|
|
///
|
|
/// \param Name The name of the module to find or create.
|
|
///
|
|
/// \param Parent The module that will act as the parent of this submodule,
|
|
/// or NULL to indicate that this is a top-level module.
|
|
///
|
|
/// \param IsFramework Whether this is a framework module.
|
|
///
|
|
/// \param IsExplicit Whether this is an explicit submodule.
|
|
///
|
|
/// \returns The found or newly-created module, along with a boolean value
|
|
/// that will be true if the module is newly-created.
|
|
std::pair<Module *, bool> findOrCreateModule(StringRef Name, Module *Parent,
|
|
bool IsFramework,
|
|
bool IsExplicit);
|
|
|
|
/// \brief Determine whether we can infer a framework module a framework
|
|
/// with the given name in the given
|
|
///
|
|
/// \param ParentDir The directory that is the parent of the framework
|
|
/// directory.
|
|
///
|
|
/// \param Name The name of the module.
|
|
///
|
|
/// \param IsSystem Will be set to 'true' if the inferred module must be a
|
|
/// system module.
|
|
///
|
|
/// \returns true if we are allowed to infer a framework module, and false
|
|
/// otherwise.
|
|
bool canInferFrameworkModule(const DirectoryEntry *ParentDir,
|
|
StringRef Name, bool &IsSystem) const;
|
|
|
|
/// \brief Infer the contents of a framework module map from the given
|
|
/// framework directory.
|
|
Module *inferFrameworkModule(StringRef ModuleName,
|
|
const DirectoryEntry *FrameworkDir,
|
|
bool IsSystem, Module *Parent);
|
|
|
|
/// \brief Retrieve the module map file containing the definition of the given
|
|
/// module.
|
|
///
|
|
/// \param Module The module whose module map file will be returned, if known.
|
|
///
|
|
/// \returns The file entry for the module map file containing the given
|
|
/// module, or NULL if the module definition was inferred.
|
|
const FileEntry *getContainingModuleMapFile(Module *Module) const;
|
|
|
|
/// \brief Resolve all of the unresolved exports in the given module.
|
|
///
|
|
/// \param Mod The module whose exports should be resolved.
|
|
///
|
|
/// \param Complain Whether to emit diagnostics for failures.
|
|
///
|
|
/// \returns true if any errors were encountered while resolving exports,
|
|
/// false otherwise.
|
|
bool resolveExports(Module *Mod, bool Complain);
|
|
|
|
/// \brief Resolve all of the unresolved conflicts in the given module.
|
|
///
|
|
/// \param Mod The module whose conflicts should be resolved.
|
|
///
|
|
/// \param Complain Whether to emit diagnostics for failures.
|
|
///
|
|
/// \returns true if any errors were encountered while resolving conflicts,
|
|
/// false otherwise.
|
|
bool resolveConflicts(Module *Mod, bool Complain);
|
|
|
|
/// \brief Infers the (sub)module based on the given source location and
|
|
/// source manager.
|
|
///
|
|
/// \param Loc The location within the source that we are querying, along
|
|
/// with its source manager.
|
|
///
|
|
/// \returns The module that owns this source location, or null if no
|
|
/// module owns this source location.
|
|
Module *inferModuleFromLocation(FullSourceLoc Loc);
|
|
|
|
/// \brief Sets the umbrella header of the given module to the given
|
|
/// header.
|
|
void setUmbrellaHeader(Module *Mod, const FileEntry *UmbrellaHeader);
|
|
|
|
/// \brief Sets the umbrella directory of the given module to the given
|
|
/// directory.
|
|
void setUmbrellaDir(Module *Mod, const DirectoryEntry *UmbrellaDir);
|
|
|
|
/// \brief Adds this header to the given module.
|
|
/// \param Excluded Whether this header is explicitly excluded from the
|
|
/// module; otherwise, it's included in the module.
|
|
void addHeader(Module *Mod, const FileEntry *Header, bool Excluded);
|
|
|
|
/// \brief Parse the given module map file, and record any modules we
|
|
/// encounter.
|
|
///
|
|
/// \param File The file to be parsed.
|
|
///
|
|
/// \returns true if an error occurred, false otherwise.
|
|
bool parseModuleMapFile(const FileEntry *File);
|
|
|
|
/// \brief Dump the contents of the module map, for debugging purposes.
|
|
void dump();
|
|
|
|
typedef llvm::StringMap<Module *>::const_iterator module_iterator;
|
|
module_iterator module_begin() const { return Modules.begin(); }
|
|
module_iterator module_end() const { return Modules.end(); }
|
|
};
|
|
|
|
}
|
|
#endif
|