1 //===--- Module.cpp - Describe a module -----------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the Module class, which describes a module in the source
13 //===----------------------------------------------------------------------===//
14 #include "clang/Basic/Module.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/LangOptions.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/StringSwitch.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/raw_ostream.h"
23 using namespace clang;
25 Module::Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent,
26 bool IsFramework, bool IsExplicit)
27 : Name(Name), DefinitionLoc(DefinitionLoc), Parent(Parent),
28 Umbrella(), ASTFile(0), IsAvailable(true), IsFromModuleFile(false),
29 IsFramework(IsFramework), IsExplicit(IsExplicit), IsSystem(false),
30 InferSubmodules(false), InferExplicitSubmodules(false),
31 InferExportWildcard(false), ConfigMacrosExhaustive(false),
32 NameVisibility(Hidden)
35 if (!Parent->isAvailable())
40 Parent->SubModuleIndex[Name] = Parent->SubModules.size();
41 Parent->SubModules.push_back(this);
46 for (submodule_iterator I = submodule_begin(), IEnd = submodule_end();
52 /// \brief Determine whether a translation unit built using the current
53 /// language options has the given feature.
54 static bool hasFeature(StringRef Feature, const LangOptions &LangOpts,
55 const TargetInfo &Target) {
56 return llvm::StringSwitch<bool>(Feature)
57 .Case("altivec", LangOpts.AltiVec)
58 .Case("blocks", LangOpts.Blocks)
59 .Case("cplusplus", LangOpts.CPlusPlus)
60 .Case("cplusplus11", LangOpts.CPlusPlus11)
61 .Case("objc", LangOpts.ObjC1)
62 .Case("objc_arc", LangOpts.ObjCAutoRefCount)
63 .Case("opencl", LangOpts.OpenCL)
64 .Case("tls", Target.isTLSSupported())
65 .Default(Target.hasFeature(Feature));
69 Module::isAvailable(const LangOptions &LangOpts, const TargetInfo &Target,
70 StringRef &Feature) const {
74 for (const Module *Current = this; Current; Current = Current->Parent) {
75 for (unsigned I = 0, N = Current->Requires.size(); I != N; ++I) {
76 if (!hasFeature(Current->Requires[I], LangOpts, Target)) {
77 Feature = Current->Requires[I];
83 llvm_unreachable("could not find a reason why module is unavailable");
86 bool Module::isSubModuleOf(Module *Other) const {
87 const Module *This = this;
98 const Module *Module::getTopLevelModule() const {
99 const Module *Result = this;
100 while (Result->Parent)
101 Result = Result->Parent;
106 std::string Module::getFullModuleName() const {
107 SmallVector<StringRef, 2> Names;
109 // Build up the set of module names (from innermost to outermost).
110 for (const Module *M = this; M; M = M->Parent)
111 Names.push_back(M->Name);
114 for (SmallVector<StringRef, 2>::reverse_iterator I = Names.rbegin(),
126 const DirectoryEntry *Module::getUmbrellaDir() const {
127 if (const FileEntry *Header = getUmbrellaHeader())
128 return Header->getDir();
130 return Umbrella.dyn_cast<const DirectoryEntry *>();
133 ArrayRef<const FileEntry *> Module::getTopHeaders(FileManager &FileMgr) {
134 if (!TopHeaderNames.empty()) {
135 for (std::vector<std::string>::iterator
136 I = TopHeaderNames.begin(), E = TopHeaderNames.end(); I != E; ++I) {
137 if (const FileEntry *FE = FileMgr.getFile(*I))
138 TopHeaders.insert(FE);
140 TopHeaderNames.clear();
143 return llvm::makeArrayRef(TopHeaders.begin(), TopHeaders.end());
146 void Module::addRequirement(StringRef Feature, const LangOptions &LangOpts,
147 const TargetInfo &Target) {
148 Requires.push_back(Feature);
150 // If this feature is currently available, we're done.
151 if (hasFeature(Feature, LangOpts, Target))
157 SmallVector<Module *, 2> Stack;
158 Stack.push_back(this);
159 while (!Stack.empty()) {
160 Module *Current = Stack.back();
163 if (!Current->IsAvailable)
166 Current->IsAvailable = false;
167 for (submodule_iterator Sub = Current->submodule_begin(),
168 SubEnd = Current->submodule_end();
169 Sub != SubEnd; ++Sub) {
170 if ((*Sub)->IsAvailable)
171 Stack.push_back(*Sub);
176 Module *Module::findSubmodule(StringRef Name) const {
177 llvm::StringMap<unsigned>::const_iterator Pos = SubModuleIndex.find(Name);
178 if (Pos == SubModuleIndex.end())
181 return SubModules[Pos->getValue()];
184 static void printModuleId(raw_ostream &OS, const ModuleId &Id) {
185 for (unsigned I = 0, N = Id.size(); I != N; ++I) {
192 void Module::getExportedModules(SmallVectorImpl<Module *> &Exported) const {
193 bool AnyWildcard = false;
194 bool UnrestrictedWildcard = false;
195 SmallVector<Module *, 4> WildcardRestrictions;
196 for (unsigned I = 0, N = Exports.size(); I != N; ++I) {
197 Module *Mod = Exports[I].getPointer();
198 if (!Exports[I].getInt()) {
199 // Export a named module directly; no wildcards involved.
200 Exported.push_back(Mod);
205 // Wildcard export: export all of the imported modules that match
206 // the given pattern.
208 if (UnrestrictedWildcard)
211 if (Module *Restriction = Exports[I].getPointer())
212 WildcardRestrictions.push_back(Restriction);
214 WildcardRestrictions.clear();
215 UnrestrictedWildcard = true;
219 // If there were any wildcards, push any imported modules that were
220 // re-exported by the wildcard restriction.
224 for (unsigned I = 0, N = Imports.size(); I != N; ++I) {
225 Module *Mod = Imports[I];
226 bool Acceptable = UnrestrictedWildcard;
228 // Check whether this module meets one of the restrictions.
229 for (unsigned R = 0, NR = WildcardRestrictions.size(); R != NR; ++R) {
230 Module *Restriction = WildcardRestrictions[R];
231 if (Mod == Restriction || Mod->isSubModuleOf(Restriction)) {
241 Exported.push_back(Mod);
245 void Module::print(raw_ostream &OS, unsigned Indent) const {
251 OS << "module " << Name;
254 OS.indent(Indent + 2);
260 if (!Requires.empty()) {
261 OS.indent(Indent + 2);
263 for (unsigned I = 0, N = Requires.size(); I != N; ++I) {
271 if (const FileEntry *UmbrellaHeader = getUmbrellaHeader()) {
272 OS.indent(Indent + 2);
273 OS << "umbrella header \"";
274 OS.write_escaped(UmbrellaHeader->getName());
276 } else if (const DirectoryEntry *UmbrellaDir = getUmbrellaDir()) {
277 OS.indent(Indent + 2);
279 OS.write_escaped(UmbrellaDir->getName());
283 if (!ConfigMacros.empty() || ConfigMacrosExhaustive) {
284 OS.indent(Indent + 2);
285 OS << "config_macros ";
286 if (ConfigMacrosExhaustive)
287 OS << "[exhaustive]";
288 for (unsigned I = 0, N = ConfigMacros.size(); I != N; ++I) {
291 OS << ConfigMacros[I];
296 for (unsigned I = 0, N = Headers.size(); I != N; ++I) {
297 OS.indent(Indent + 2);
299 OS.write_escaped(Headers[I]->getName());
303 for (unsigned I = 0, N = ExcludedHeaders.size(); I != N; ++I) {
304 OS.indent(Indent + 2);
305 OS << "exclude header \"";
306 OS.write_escaped(ExcludedHeaders[I]->getName());
310 for (submodule_const_iterator MI = submodule_begin(), MIEnd = submodule_end();
312 (*MI)->print(OS, Indent + 2);
314 for (unsigned I = 0, N = Exports.size(); I != N; ++I) {
315 OS.indent(Indent + 2);
317 if (Module *Restriction = Exports[I].getPointer()) {
318 OS << Restriction->getFullModuleName();
319 if (Exports[I].getInt())
327 for (unsigned I = 0, N = UnresolvedExports.size(); I != N; ++I) {
328 OS.indent(Indent + 2);
330 printModuleId(OS, UnresolvedExports[I].Id);
331 if (UnresolvedExports[I].Wildcard) {
332 if (UnresolvedExports[I].Id.empty())
340 for (unsigned I = 0, N = LinkLibraries.size(); I != N; ++I) {
341 OS.indent(Indent + 2);
343 if (LinkLibraries[I].IsFramework)
346 OS.write_escaped(LinkLibraries[I].Library);
350 for (unsigned I = 0, N = UnresolvedConflicts.size(); I != N; ++I) {
351 OS.indent(Indent + 2);
353 printModuleId(OS, UnresolvedConflicts[I].Id);
355 OS.write_escaped(UnresolvedConflicts[I].Message);
359 for (unsigned I = 0, N = Conflicts.size(); I != N; ++I) {
360 OS.indent(Indent + 2);
362 OS << Conflicts[I].Other->getFullModuleName();
364 OS.write_escaped(Conflicts[I].Message);
368 if (InferSubmodules) {
369 OS.indent(Indent + 2);
370 if (InferExplicitSubmodules)
372 OS << "module * {\n";
373 if (InferExportWildcard) {
374 OS.indent(Indent + 4);
377 OS.indent(Indent + 2);
385 void Module::dump() const {