11a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor//===--- Module.h - Describe a module ---------------------------*- C++ -*-===// 21a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// 31a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// The LLVM Compiler Infrastructure 41a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// 51a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// This file is distributed under the University of Illinois Open Source 61a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// License. See LICENSE.TXT for details. 71a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor// 81a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor//===----------------------------------------------------------------------===// 92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the clang::Module class, which describes a module in the 122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// source code. 132f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 141a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor//===----------------------------------------------------------------------===// 151a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#ifndef LLVM_CLANG_BASIC_MODULE_H 161a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#define LLVM_CLANG_BASIC_MODULE_H 171a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 184967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar#include "clang/Basic/FileManager.h" 191a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#include "clang/Basic/SourceLocation.h" 20b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar#include "llvm/ADT/ArrayRef.h" 21b775100fea6d8955149897dae1adca50ca471d17Richard Smith#include "llvm/ADT/DenseSet.h" 2290db26000aefe9335370013eec64c85232d80227Douglas Gregor#include "llvm/ADT/PointerIntPair.h" 2310694cee2588442bee1e717f5042c58ffee25279Douglas Gregor#include "llvm/ADT/PointerUnion.h" 2430a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/SetVector.h" 251a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#include "llvm/ADT/SmallVector.h" 26b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar#include "llvm/ADT/STLExtras.h" 271a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#include "llvm/ADT/StringMap.h" 281a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#include "llvm/ADT/StringRef.h" 291a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#include <string> 3090db26000aefe9335370013eec64c85232d80227Douglas Gregor#include <utility> 31b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor#include <vector> 321a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 331a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregornamespace llvm { 341a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor class raw_ostream; 351a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor} 361a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 371a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregornamespace clang { 381a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 3951f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregorclass LangOptions; 40dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregorclass TargetInfo; 415794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smithclass IdentifierInfo; 4210694cee2588442bee1e717f5042c58ffee25279Douglas Gregor 4390db26000aefe9335370013eec64c85232d80227Douglas Gregor/// \brief Describes the name of a module. 44cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenkotypedef SmallVector<std::pair<std::string, SourceLocation>, 2> ModuleId; 4590db26000aefe9335370013eec64c85232d80227Douglas Gregor 461a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor/// \brief Describes a module or submodule. 471a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregorclass Module { 481a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregorpublic: 491a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief The name of this module. 501a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor std::string Name; 511a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 521a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief The location of the module definition. 531a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor SourceLocation DefinitionLoc; 546bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 551a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief The parent of this module. This will be NULL for the top-level 561a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// module. 571a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor Module *Parent; 580e2c34f92f00628d48968dfea096d36381f494cbStephen Hines 590e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// \brief The build directory of this module. This is the directory in 600e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// which the module is notionally built, and relative to which its headers 610e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// are found. 620e2c34f92f00628d48968dfea096d36381f494cbStephen Hines const DirectoryEntry *Directory; 630e2c34f92f00628d48968dfea096d36381f494cbStephen Hines 6410694cee2588442bee1e717f5042c58ffee25279Douglas Gregor /// \brief The umbrella header or directory. 6510694cee2588442bee1e717f5042c58ffee25279Douglas Gregor llvm::PointerUnion<const DirectoryEntry *, const FileEntry *> Umbrella; 66b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 6787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief The module signature. 6887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar uint64_t Signature; 6987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 70b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief The name of the umbrella entry, as written in the module map. 71b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar std::string UmbrellaAsWritten; 721a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 73b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregorprivate: 741a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief The submodules of this module, indexed by name. 75b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor std::vector<Module *> SubModules; 761a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 77b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor /// \brief A mapping from the submodule name to the index into the 78b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor /// \c SubModules vector at which that submodule resides. 79b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor llvm::StringMap<unsigned> SubModuleIndex; 80e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis 81e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis /// \brief The AST file if this is a top-level module which has a 82e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis /// corresponding serialized AST file, or null otherwise. 83e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis const FileEntry *ASTFile; 84c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 85c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis /// \brief The top-level headers associated with this module. 86c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis llvm::SmallSetVector<const FileEntry *, 2> TopHeaders; 87c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 88c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis /// \brief top-level header filenames that aren't resolved to FileEntries yet. 89c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis std::vector<std::string> TopHeaderNames; 90c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 91b775100fea6d8955149897dae1adca50ca471d17Richard Smith /// \brief Cache of modules visible to lookup in this module. 92b775100fea6d8955149897dae1adca50ca471d17Richard Smith mutable llvm::DenseSet<const Module*> VisibleModulesCache; 93b775100fea6d8955149897dae1adca50ca471d17Richard Smith 94b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// The ID used when referencing this module within a VisibleModuleSet. 95b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar unsigned VisibilityID; 96b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 97b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregorpublic: 980e2c34f92f00628d48968dfea096d36381f494cbStephen Hines enum HeaderKind { 990e2c34f92f00628d48968dfea096d36381f494cbStephen Hines HK_Normal, 1000e2c34f92f00628d48968dfea096d36381f494cbStephen Hines HK_Textual, 1010e2c34f92f00628d48968dfea096d36381f494cbStephen Hines HK_Private, 1020e2c34f92f00628d48968dfea096d36381f494cbStephen Hines HK_PrivateTextual, 1030e2c34f92f00628d48968dfea096d36381f494cbStephen Hines HK_Excluded 1040e2c34f92f00628d48968dfea096d36381f494cbStephen Hines }; 1050e2c34f92f00628d48968dfea096d36381f494cbStephen Hines static const int NumHeaderKinds = HK_Excluded + 1; 106176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines 107651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Information about a header directive as found in the module map 108651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// file. 1090e2c34f92f00628d48968dfea096d36381f494cbStephen Hines struct Header { 1100e2c34f92f00628d48968dfea096d36381f494cbStephen Hines std::string NameAsWritten; 1110e2c34f92f00628d48968dfea096d36381f494cbStephen Hines const FileEntry *Entry; 112b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 113b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar explicit operator bool() { return Entry; } 114b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar }; 115b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 116b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief Information about a directory name as found in the module map 117b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// file. 118b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar struct DirectoryName { 119b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar std::string NameAsWritten; 120b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar const DirectoryEntry *Entry; 121b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 122b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar explicit operator bool() { return Entry; } 1230e2c34f92f00628d48968dfea096d36381f494cbStephen Hines }; 1240e2c34f92f00628d48968dfea096d36381f494cbStephen Hines 1250e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// \brief The headers that are part of this module. 1260e2c34f92f00628d48968dfea096d36381f494cbStephen Hines SmallVector<Header, 2> Headers[5]; 1270e2c34f92f00628d48968dfea096d36381f494cbStephen Hines 1280e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// \brief Stored information about a header directive that was found in the 1290e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// module map file but has not been resolved to a file. 1300e2c34f92f00628d48968dfea096d36381f494cbStephen Hines struct UnresolvedHeaderDirective { 131651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines SourceLocation FileNameLoc; 132651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::string FileName; 133651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines bool IsUmbrella; 134651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines }; 135651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 136651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Headers that are mentioned in the module map file but could not be 137651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// found on the file system. 1380e2c34f92f00628d48968dfea096d36381f494cbStephen Hines SmallVector<UnresolvedHeaderDirective, 1> MissingHeaders; 139bc3f628815b3841dc99109e7f67f9afa7793bc94Lawrence Crowl 1405794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// \brief An individual requirement: a feature name and a flag indicating 1415794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// the required state of that feature. 1425794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith typedef std::pair<std::string, bool> Requirement; 1435794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith 14451f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \brief The set of language features required to use this module. 14551f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// 1465794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// If any of these requirements are not available, the \c IsAvailable bit 1475794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// will be false to indicate that this (sub)module is not available. 1485794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith SmallVector<Requirement, 2> Requirements; 14951f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 1506bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Whether this module is missing a feature from \c Requirements. 1516bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned IsMissingRequirement : 1; 1526bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 15387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief Whether we tried and failed to load a module file for this module. 15487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned HasIncompatibleModuleFile : 1; 15587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1566bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Whether this module is available in the current translation unit. 1576bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// 1586bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// If the module is missing headers or does not meet all requirements then 1596bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// this bit will be 0. 16051f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor unsigned IsAvailable : 1; 16151f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 162305dc3ebaa0bea5f3b789e4b54afc79c25907615Douglas Gregor /// \brief Whether this module was loaded from a module file. 163305dc3ebaa0bea5f3b789e4b54afc79c25907615Douglas Gregor unsigned IsFromModuleFile : 1; 164305dc3ebaa0bea5f3b789e4b54afc79c25907615Douglas Gregor 1651a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Whether this is a framework module. 1661e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor unsigned IsFramework : 1; 1671a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 1681a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Whether this is an explicit submodule. 1691e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor unsigned IsExplicit : 1; 1701e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 171a1f1fad8b60e1cb9d21a40a37f2e03150bcbeb6fDouglas Gregor /// \brief Whether this is a "system" module (which assumes that all 172a1f1fad8b60e1cb9d21a40a37f2e03150bcbeb6fDouglas Gregor /// headers in it are system headers). 173a1f1fad8b60e1cb9d21a40a37f2e03150bcbeb6fDouglas Gregor unsigned IsSystem : 1; 174651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 175651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Whether this is an 'extern "C"' module (which implicitly puts all 176651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// headers in it within an 'extern "C"' block, and allows the module to be 177651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// imported within such a block). 178651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned IsExternC : 1; 179651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1806bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Whether this is an inferred submodule (module * { ... }). 1816bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned IsInferred : 1; 1826bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1831e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief Whether we should infer submodules for this module based on 1841e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// the headers. 1851e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// 1861e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// Submodules can only be inferred for modules with an umbrella header. 1871e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor unsigned InferSubmodules : 1; 1881e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 1891e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief Whether, when inferring submodules, the inferred submodules 1901e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// should be explicit. 1911e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor unsigned InferExplicitSubmodules : 1; 1921e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 1931e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief Whether, when inferring submodules, the inferr submodules should 1941e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// export all modules they import (e.g., the equivalent of "export *"). 1951e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor unsigned InferExportWildcard : 1; 19663a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor 19763a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// \brief Whether the set of configuration macros is exhaustive. 19863a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// 19963a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// When the set of configuration macros is exhaustive, meaning 20063a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// that no identifier not in this list should affect how the module is 20163a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// built. 20263a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor unsigned ConfigMacrosExhaustive : 1; 20363a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor 2045e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor /// \brief Describes the visibility of the various names within a 2055e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor /// particular module. 2065e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor enum NameVisibilityKind { 2075e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor /// \brief All of the names in this module are hidden. 2085e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor Hidden, 2095e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor /// \brief All of the names in this module are visible. 2105e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor AllVisible 211651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines }; 212651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 213651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief The visibility of names within this particular module. 2145e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor NameVisibilityKind NameVisibility; 21555988680ece66b8e505ee136b35e74fcb1173aeeDouglas Gregor 2161e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief The location of the inferred submodule. 2171e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor SourceLocation InferredSubmoduleLoc; 2181e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 21955988680ece66b8e505ee136b35e74fcb1173aeeDouglas Gregor /// \brief The set of modules imported by this module, and on which this 22055988680ece66b8e505ee136b35e74fcb1173aeeDouglas Gregor /// module depends. 221b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar llvm::SmallSetVector<Module *, 2> Imports; 2225e35693721364673f8196e4f5a370f56b92e6053Douglas Gregor 22390db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Describes an exported module. 22490db26000aefe9335370013eec64c85232d80227Douglas Gregor /// 22590db26000aefe9335370013eec64c85232d80227Douglas Gregor /// The pointer is the module being re-exported, while the bit will be true 22690db26000aefe9335370013eec64c85232d80227Douglas Gregor /// to indicate that this is a wildcard export. 22790db26000aefe9335370013eec64c85232d80227Douglas Gregor typedef llvm::PointerIntPair<Module *, 1, bool> ExportDecl; 22890db26000aefe9335370013eec64c85232d80227Douglas Gregor 22990db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief The set of export declarations. 230cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<ExportDecl, 2> Exports; 23190db26000aefe9335370013eec64c85232d80227Douglas Gregor 23290db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Describes an exported module that has not yet been resolved 2332f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett /// (perhaps because the module it refers to has not yet been loaded). 23490db26000aefe9335370013eec64c85232d80227Douglas Gregor struct UnresolvedExportDecl { 23590db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief The location of the 'export' keyword in the module map file. 23690db26000aefe9335370013eec64c85232d80227Douglas Gregor SourceLocation ExportLoc; 23790db26000aefe9335370013eec64c85232d80227Douglas Gregor 23890db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief The name of the module. 23990db26000aefe9335370013eec64c85232d80227Douglas Gregor ModuleId Id; 24090db26000aefe9335370013eec64c85232d80227Douglas Gregor 24190db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief Whether this export declaration ends in a wildcard, indicating 24290db26000aefe9335370013eec64c85232d80227Douglas Gregor /// that all of its submodules should be exported (rather than the named 24390db26000aefe9335370013eec64c85232d80227Douglas Gregor /// module itself). 24490db26000aefe9335370013eec64c85232d80227Douglas Gregor bool Wildcard; 24590db26000aefe9335370013eec64c85232d80227Douglas Gregor }; 24690db26000aefe9335370013eec64c85232d80227Douglas Gregor 24790db26000aefe9335370013eec64c85232d80227Douglas Gregor /// \brief The set of export declarations that have yet to be resolved. 248cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<UnresolvedExportDecl, 2> UnresolvedExports; 249b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor 250ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper /// \brief The directly used modules. 251ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper SmallVector<Module *, 2> DirectUses; 252ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper 253ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper /// \brief The set of use declarations that have yet to be resolved. 254ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper SmallVector<ModuleId, 2> UnresolvedDirectUses; 255ddd2dfc1d3f4a36cbe8cd775c588623a17049f9fDaniel Jasper 256b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// \brief A library or framework to link against when an entity from this 257b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// module is used. 258b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor struct LinkLibrary { 259b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor LinkLibrary() : IsFramework(false) { } 260b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor LinkLibrary(const std::string &Library, bool IsFramework) 261b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor : Library(Library), IsFramework(IsFramework) { } 262b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor 263b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// \brief The library to link against. 264b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// 265b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// This will typically be a library or framework name, but can also 266b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// be an absolute path to the library or framework. 267b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor std::string Library; 268b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor 269b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// \brief Whether this is a framework rather than a library. 270b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor bool IsFramework; 271b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor }; 272b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor 273b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// \brief The set of libraries or frameworks to link against when 274b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor /// an entity from this module is used. 275b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor llvm::SmallVector<LinkLibrary, 2> LinkLibraries; 276b6cbe517237c3c223beb064d60d5b49e56d65c06Douglas Gregor 27763a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// \brief The set of "configuration macros", which are macros that 27863a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor /// (intentionally) change how this module is built. 27963a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor std::vector<std::string> ConfigMacros; 28063a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor 281906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief An unresolved conflict with another module. 282906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor struct UnresolvedConflict { 283906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The (unresolved) module id. 284906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor ModuleId Id; 285906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 286906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The message provided to the user when there is a conflict. 287906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor std::string Message; 288906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor }; 289906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 290906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The list of conflicts for which the module-id has not yet been 291906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// resolved. 292906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor std::vector<UnresolvedConflict> UnresolvedConflicts; 293906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 294906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief A conflict between two modules. 295906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor struct Conflict { 296906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The module that this module conflicts with. 297906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor Module *Other; 298906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 299906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The message provided to the user when there is a conflict. 300906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor std::string Message; 301906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor }; 302906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 303906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor /// \brief The list of conflicts. 304906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor std::vector<Conflict> Conflicts; 305906d66acc5cf2679453e10a4f0a67feedd765b21Douglas Gregor 306a1f1fad8b60e1cb9d21a40a37f2e03150bcbeb6fDouglas Gregor /// \brief Construct a new module or submodule. 3076bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent, 308b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar bool IsFramework, bool IsExplicit, unsigned VisibilityID); 3091a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 3101a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor ~Module(); 3111a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 31251f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \brief Determine whether this module is available for use within the 31351f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// current translation unit. 31451f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor bool isAvailable() const { return IsAvailable; } 31551f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 31651f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \brief Determine whether this module is available for use within the 31751f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// current translation unit. 31851f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// 31951f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \param LangOpts The language options used for the current 32051f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// translation unit. 32151f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// 322dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor /// \param Target The target options used for the current translation unit. 323dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor /// 3245794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// \param Req If this module is unavailable, this parameter 3255794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// will be set to one of the requirements that is not met for use of 3265794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// this module. 327dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor bool isAvailable(const LangOptions &LangOpts, 328dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor const TargetInfo &Target, 329651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines Requirement &Req, 3300e2c34f92f00628d48968dfea096d36381f494cbStephen Hines UnresolvedHeaderDirective &MissingHeader) const; 33151f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 3321a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Determine whether this module is a submodule. 3336bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool isSubModule() const { return Parent != nullptr; } 3341a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 3350adaa880993ad23186c87c7f98e7a3fd2697742cDouglas Gregor /// \brief Determine whether this module is a submodule of the given other 3360adaa880993ad23186c87c7f98e7a3fd2697742cDouglas Gregor /// module. 3376bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool isSubModuleOf(const Module *Other) const; 3380adaa880993ad23186c87c7f98e7a3fd2697742cDouglas Gregor 3391a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Determine whether this module is a part of a framework, 3401a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// either because it is a framework module or because it is a submodule 3411a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// of a framework module. 3421a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor bool isPartOfFramework() const { 3431a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor for (const Module *Mod = this; Mod; Mod = Mod->Parent) 3441a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor if (Mod->IsFramework) 3451a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor return true; 3461a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 3471a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor return false; 3481a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor } 3498767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor 3508767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor /// \brief Determine whether this module is a subframework of another 3518767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor /// framework. 3528767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor bool isSubFramework() const { 3538767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor return IsFramework && Parent && Parent->isPartOfFramework(); 3548767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor } 3558767dc29ec23f96e71658f760333bdf5d87283d5Douglas Gregor 3561a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Retrieve the full name of this module, including the path from 3571a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// its top-level module. 3581a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor std::string getFullModuleName() const; 3591e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 36087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief Whether the full name of this module is equal to joining 36187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \p nameParts with "."s. 36287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// 36387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// This is more efficient than getFullModuleName(). 36487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bool fullModuleNameIs(ArrayRef<StringRef> nameParts) const; 36587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 3661e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief Retrieve the top-level module for this (sub)module, which may 3671e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// be this module. 3681e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor Module *getTopLevelModule() { 3691e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor return const_cast<Module *>( 3701e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor const_cast<const Module *>(this)->getTopLevelModule()); 3711e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor } 3721e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor 3731e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// \brief Retrieve the top-level module for this (sub)module, which may 3741e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor /// be this module. 3751e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor const Module *getTopLevelModule() const; 3761a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 3771a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Retrieve the name of the top-level module. 3781a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// 3791e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor StringRef getTopLevelModuleName() const { 3801e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor return getTopLevelModule()->Name; 3811e12368db12005ddd92fd9188c86383fe30ef443Douglas Gregor } 382e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis 383e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis /// \brief The serialized AST file for this module, if one was created. 384e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis const FileEntry *getASTFile() const { 385e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis return getTopLevelModule()->ASTFile; 386e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis } 387e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis 388e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis /// \brief Set the serialized AST file for the top-level module of this module. 389e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis void setASTFile(const FileEntry *File) { 3906bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert((File == nullptr || getASTFile() == nullptr || 3916bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines getASTFile() == File) && "file path changed"); 392e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis getTopLevelModule()->ASTFile = File; 393e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis } 394e2ac16b09ea66ad955752381b82fb8719d003e5eArgyrios Kyrtzidis 39510694cee2588442bee1e717f5042c58ffee25279Douglas Gregor /// \brief Retrieve the directory for which this module serves as the 39610694cee2588442bee1e717f5042c58ffee25279Douglas Gregor /// umbrella. 397b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar DirectoryName getUmbrellaDir() const; 39810694cee2588442bee1e717f5042c58ffee25279Douglas Gregor 39910694cee2588442bee1e717f5042c58ffee25279Douglas Gregor /// \brief Retrieve the header that serves as the umbrella header for this 40010694cee2588442bee1e717f5042c58ffee25279Douglas Gregor /// module. 401b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar Header getUmbrellaHeader() const { 402b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar if (auto *E = Umbrella.dyn_cast<const FileEntry *>()) 403b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar return Header{UmbrellaAsWritten, E}; 404b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar return Header{}; 40510694cee2588442bee1e717f5042c58ffee25279Douglas Gregor } 40610694cee2588442bee1e717f5042c58ffee25279Douglas Gregor 4076a1db484f32eb791840dd55a8d45c86ff5bd0834Douglas Gregor /// \brief Determine whether this module has an umbrella directory that is 4086a1db484f32eb791840dd55a8d45c86ff5bd0834Douglas Gregor /// not based on an umbrella header. 4096a1db484f32eb791840dd55a8d45c86ff5bd0834Douglas Gregor bool hasUmbrellaDir() const { 4106a1db484f32eb791840dd55a8d45c86ff5bd0834Douglas Gregor return Umbrella && Umbrella.is<const DirectoryEntry *>(); 4116a1db484f32eb791840dd55a8d45c86ff5bd0834Douglas Gregor } 41251f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 413c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis /// \brief Add a top-level header associated with this module. 414c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis void addTopHeader(const FileEntry *File) { 415c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis assert(File); 416c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis TopHeaders.insert(File); 417c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis } 418c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 419c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis /// \brief Add a top-level header filename associated with this module. 420c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis void addTopHeaderFilename(StringRef Filename) { 421c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis TopHeaderNames.push_back(Filename); 422c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis } 423c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 424c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis /// \brief The top-level headers associated with this module. 425c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis ArrayRef<const FileEntry *> getTopHeaders(FileManager &FileMgr); 426c1d22393628a145e54396c0ac66e9625d13a7658Argyrios Kyrtzidis 4273ea9e33ea25e0c2b12db56418ba3f994eb662c04Pirama Arumuga Nainar /// \brief Determine whether this module has declared its intention to 4283ea9e33ea25e0c2b12db56418ba3f994eb662c04Pirama Arumuga Nainar /// directly use another module. 4293ea9e33ea25e0c2b12db56418ba3f994eb662c04Pirama Arumuga Nainar bool directlyUses(const Module *Requested) const; 4303ea9e33ea25e0c2b12db56418ba3f994eb662c04Pirama Arumuga Nainar 431c9e4b4b091e9bec50d8918a02ea155220b513d47James Dennett /// \brief Add the given feature requirement to the list of features 43251f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// required by this module. 43351f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// 43451f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \param Feature The feature that is required by this module (and 43551f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// its submodules). 43651f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// 4375794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// \param RequiredState The required state of this feature: \c true 4385794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// if it must be present, \c false if it must be absent. 4395794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith /// 44051f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// \param LangOpts The set of language options that will be used to 44151f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor /// evaluate the availability of this feature. 442dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor /// 443dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor /// \param Target The target options that will be used to evaluate the 444dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor /// availability of this feature. 4455794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith void addRequirement(StringRef Feature, bool RequiredState, 4465794b53ad5b38b53c9eaf3a172354e63081ceb2fRichard Smith const LangOptions &LangOpts, 447dc58aa71026cce539ca9b5c2c52cc4efc7bd77feDouglas Gregor const TargetInfo &Target); 44851f564f80d9f71e175635b452ffeeeff899e9bf1Douglas Gregor 4496bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Mark this module and all of its submodules as unavailable. 4506bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines void markUnavailable(bool MissingRequirement = false); 4516bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 452b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor /// \brief Find the submodule with the given name. 453b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor /// 454b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor /// \returns The submodule if found, or NULL otherwise. 455b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor Module *findSubmodule(StringRef Name) const; 45663a726870b486e0470c3a4b11cf62bab8be00b73Douglas Gregor 457b775100fea6d8955149897dae1adca50ca471d17Richard Smith /// \brief Determine whether the specified module would be visible to 458b775100fea6d8955149897dae1adca50ca471d17Richard Smith /// a lookup at the end of this module. 459c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// 460c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// FIXME: This may return incorrect results for (submodules of) the 461c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// module currently being built, if it's queried before we see all 462c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// of its imports. 463b775100fea6d8955149897dae1adca50ca471d17Richard Smith bool isModuleVisible(const Module *M) const { 464b775100fea6d8955149897dae1adca50ca471d17Richard Smith if (VisibleModulesCache.empty()) 465b775100fea6d8955149897dae1adca50ca471d17Richard Smith buildVisibleModulesCache(); 466b775100fea6d8955149897dae1adca50ca471d17Richard Smith return VisibleModulesCache.count(M); 467b775100fea6d8955149897dae1adca50ca471d17Richard Smith } 468b775100fea6d8955149897dae1adca50ca471d17Richard Smith 469b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar unsigned getVisibilityID() const { return VisibilityID; } 470b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 471b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor typedef std::vector<Module *>::iterator submodule_iterator; 472b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor typedef std::vector<Module *>::const_iterator submodule_const_iterator; 473b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor 474b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor submodule_iterator submodule_begin() { return SubModules.begin(); } 475b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor submodule_const_iterator submodule_begin() const {return SubModules.begin();} 476b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor submodule_iterator submodule_end() { return SubModules.end(); } 477b7a7819473709c01ea024a2dc15e99d38f0f8760Douglas Gregor submodule_const_iterator submodule_end() const { return SubModules.end(); } 47821a0004d80f50808ee343ae70092f6260a4c9477Argyrios Kyrtzidis 47987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar llvm::iterator_range<submodule_iterator> submodules() { 48087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return llvm::make_range(submodule_begin(), submodule_end()); 48187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar } 48287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar llvm::iterator_range<submodule_const_iterator> submodules() const { 48387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return llvm::make_range(submodule_begin(), submodule_end()); 48487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar } 48587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 4868b1ab400d40b96f4634eb0c29986218c2905fda4Richard Smith /// \brief Appends this module's list of exported modules to \p Exported. 487bc64d35c4151dc34c21d0fc971b3aee0d28d83a3Dmitri Gribenko /// 4888b1ab400d40b96f4634eb0c29986218c2905fda4Richard Smith /// This provides a subset of immediately imported modules (the ones that are 4898b1ab400d40b96f4634eb0c29986218c2905fda4Richard Smith /// directly exported), not the complete set of exported modules. 49021a0004d80f50808ee343ae70092f6260a4c9477Argyrios Kyrtzidis void getExportedModules(SmallVectorImpl<Module *> &Exported) const; 49121a0004d80f50808ee343ae70092f6260a4c9477Argyrios Kyrtzidis 4922a857180050fb78b356c17931e311eef7f2daf3eArgyrios Kyrtzidis static StringRef getModuleInputBufferName() { 4932a857180050fb78b356c17931e311eef7f2daf3eArgyrios Kyrtzidis return "<module-includes>"; 4942a857180050fb78b356c17931e311eef7f2daf3eArgyrios Kyrtzidis } 4952a857180050fb78b356c17931e311eef7f2daf3eArgyrios Kyrtzidis 4961a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Print the module map for this module to the given stream. 4971a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// 498cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko void print(raw_ostream &OS, unsigned Indent = 0) const; 4991a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 5001a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor /// \brief Dump the contents of this module to the given output stream. 5011a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor void dump() const; 502b775100fea6d8955149897dae1adca50ca471d17Richard Smith 503b775100fea6d8955149897dae1adca50ca471d17Richard Smithprivate: 504b775100fea6d8955149897dae1adca50ca471d17Richard Smith void buildVisibleModulesCache() const; 5051a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor}; 5061a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 507b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar/// \brief A set of visible modules. 508b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainarclass VisibleModuleSet { 509b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainarpublic: 510b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar VisibleModuleSet() : Generation(0) {} 511b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar VisibleModuleSet(VisibleModuleSet &&O) 512b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar : ImportLocs(std::move(O.ImportLocs)), Generation(O.Generation ? 1 : 0) { 513b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar O.ImportLocs.clear(); 514b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ++O.Generation; 515b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar } 516b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 517b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// Move from another visible modules set. Guaranteed to leave the source 518b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// empty and bump the generation on both. 519b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar VisibleModuleSet &operator=(VisibleModuleSet &&O) { 520b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ImportLocs = std::move(O.ImportLocs); 521b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar O.ImportLocs.clear(); 522b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ++O.Generation; 523b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ++Generation; 524b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar return *this; 525b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar } 526b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 527b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief Get the current visibility generation. Incremented each time the 528b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// set of visible modules changes in any way. 529b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar unsigned getGeneration() const { return Generation; } 530b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 531b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief Determine whether a module is visible. 532b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar bool isVisible(const Module *M) const { 533b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar return getImportLoc(M).isValid(); 534b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar } 535b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 536b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief Get the location at which the import of a module was triggered. 537b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar SourceLocation getImportLoc(const Module *M) const { 538b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar return M->getVisibilityID() < ImportLocs.size() 539b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ? ImportLocs[M->getVisibilityID()] 540b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar : SourceLocation(); 541b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar } 542b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 543b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief A callback to call when a module is made visible (directly or 544b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// indirectly) by a call to \ref setVisible. 545b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar typedef llvm::function_ref<void(Module *M)> VisibleCallback; 546b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief A callback to call when a module conflict is found. \p Path 547b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// consists of a sequence of modules from the conflicting module to the one 548b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// made visible, where each was exported by the next. 549b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar typedef llvm::function_ref<void(ArrayRef<Module *> Path, 550b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar Module *Conflict, StringRef Message)> 551b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ConflictCallback; 552b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// \brief Make a specific module visible. 553b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar void setVisible(Module *M, SourceLocation Loc, 554b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar VisibleCallback Vis = [](Module *) {}, 555b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar ConflictCallback Cb = [](ArrayRef<Module *>, Module *, 556b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar StringRef) {}); 557b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 558b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainarprivate: 559b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// Import locations for each visible module. Indexed by the module's 560b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// VisibilityID. 561b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar std::vector<SourceLocation> ImportLocs; 562b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar /// Visibility generation, bumped every time the visibility state changes. 563b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar unsigned Generation; 564b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar}; 565b6d6993e6e6d3daf4d9876794254d20a134e37c2Pirama Arumuga Nainar 5661a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor} // end namespace clang 5671a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 5681a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor 5691a4761edca58c6b559de825b9abfb66f7f1ba94aDouglas Gregor#endif // LLVM_CLANG_BASIC_MODULE_H 570