clang  14.0.0git
ModuleLoader.h
Go to the documentation of this file.
1 //===- ModuleLoader.h - Module Loader Interface -----------------*- 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 // This file defines the ModuleLoader interface, which is responsible for
10 // loading named modules.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LEX_MODULELOADER_H
15 #define LLVM_CLANG_LEX_MODULELOADER_H
16 
17 #include "clang/Basic/LLVM.h"
18 #include "clang/Basic/Module.h"
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/PointerIntPair.h"
22 #include "llvm/ADT/StringRef.h"
23 #include <utility>
24 
25 namespace clang {
26 
27 class GlobalModuleIndex;
28 class IdentifierInfo;
29 
30 /// A sequence of identifier/location pairs used to describe a particular
31 /// module or submodule, e.g., std.vector.
33 
34 /// Describes the result of attempting to load a module.
36 public:
38  // We either succeeded or failed to load the named module.
40 
41  // The module exists, but does not actually contain the named submodule.
42  // This should only happen if the named submodule was inferred from an
43  // umbrella directory, but not actually part of the umbrella header.
45 
46  // The module exists but cannot be imported due to a configuration mismatch.
48  };
49  llvm::PointerIntPair<Module *, 2, LoadResultKind> Storage;
50 
51  ModuleLoadResult() = default;
54 
55  operator Module *() const { return Storage.getPointer(); }
56 
57  /// Determines whether this is a normal return, whether or not loading the
58  /// module was successful.
59  bool isNormal() const { return Storage.getInt() == Normal; }
60 
61  /// Determines whether the module, which failed to load, was
62  /// actually a submodule that we expected to see (based on implying the
63  /// submodule from header structure), but didn't materialize in the actual
64  /// module.
65  bool isMissingExpected() const { return Storage.getInt() == MissingExpected; }
66 
67  /// Determines whether the module failed to load due to a configuration
68  /// mismatch with an explicitly-named .pcm file from the command line.
69  bool isConfigMismatch() const { return Storage.getInt() == ConfigMismatch; }
70 };
71 
72 /// Abstract interface for a module loader.
73 ///
74 /// This abstract interface describes a module loader, which is responsible
75 /// for resolving a module name (e.g., "std") to an actual module file, and
76 /// then loading that module.
77 class ModuleLoader {
78  // Building a module if true.
79  bool BuildingModule;
80 
81 public:
82  explicit ModuleLoader(bool BuildingModule = false)
83  : BuildingModule(BuildingModule) {}
84 
85  virtual ~ModuleLoader();
86 
87  /// Returns true if this instance is building a module.
88  bool buildingModule() const {
89  return BuildingModule;
90  }
91 
92  /// Flag indicating whether this instance is building a module.
93  void setBuildingModule(bool BuildingModuleFlag) {
94  BuildingModule = BuildingModuleFlag;
95  }
96 
97  /// Attempt to load the given module.
98  ///
99  /// This routine attempts to load the module described by the given
100  /// parameters. If there is a module cache, this may implicitly compile the
101  /// module before loading it.
102  ///
103  /// \param ImportLoc The location of the 'import' keyword.
104  ///
105  /// \param Path The identifiers (and their locations) of the module
106  /// "path", e.g., "std.vector" would be split into "std" and "vector".
107  ///
108  /// \param Visibility The visibility provided for the names in the loaded
109  /// module.
110  ///
111  /// \param IsInclusionDirective Indicates that this module is being loaded
112  /// implicitly, due to the presence of an inclusion directive. Otherwise,
113  /// it is being loaded due to an import declaration.
114  ///
115  /// \returns If successful, returns the loaded module. Otherwise, returns
116  /// NULL to indicate that the module could not be loaded.
117  virtual ModuleLoadResult loadModule(SourceLocation ImportLoc,
118  ModuleIdPath Path,
120  bool IsInclusionDirective) = 0;
121 
122  /// Attempt to create the given module from the specified source buffer.
123  /// Does not load the module or make any submodule visible; for that, use
124  /// loadModule and makeModuleVisible.
125  ///
126  /// \param Loc The location at which to create the module.
127  /// \param ModuleName The name of the module to create.
128  /// \param Source The source of the module: a (preprocessed) module map.
129  virtual void createModuleFromSource(SourceLocation Loc, StringRef ModuleName,
130  StringRef Source) = 0;
131 
132  /// Make the given module visible.
133  virtual void makeModuleVisible(Module *Mod,
135  SourceLocation ImportLoc) = 0;
136 
137  /// Load, create, or return global module.
138  /// This function returns an existing global module index, if one
139  /// had already been loaded or created, or loads one if it
140  /// exists, or creates one if it doesn't exist.
141  /// Also, importantly, if the index doesn't cover all the modules
142  /// in the module map, it will be update to do so here, because
143  /// of its use in searching for needed module imports and
144  /// associated fixit messages.
145  /// \param TriggerLoc The location for what triggered the load.
146  /// \returns Returns null if load failed.
148  SourceLocation TriggerLoc) = 0;
149 
150  /// Check global module index for missing imports.
151  /// \param Name The symbol name to look for.
152  /// \param TriggerLoc The location for what triggered the load.
153  /// \returns Returns true if any modules with that symbol found.
154  virtual bool lookupMissingImports(StringRef Name,
155  SourceLocation TriggerLoc) = 0;
156 
157  bool HadFatalFailure = false;
158 };
159 
160 /// A module loader that doesn't know how to create or load modules.
162 public:
165  bool IsInclusionDirective) override {
166  return {};
167  }
168 
169  void createModuleFromSource(SourceLocation ImportLoc, StringRef ModuleName,
170  StringRef Source) override {}
171 
173  SourceLocation ImportLoc) override {}
174 
176  return nullptr;
177  }
178 
179  bool lookupMissingImports(StringRef Name,
180  SourceLocation TriggerLoc) override {
181  return false;
182  }
183 };
184 
185 } // namespace clang
186 
187 #endif // LLVM_CLANG_LEX_MODULELOADER_H
clang::ModuleLoader::createModuleFromSource
virtual void createModuleFromSource(SourceLocation Loc, StringRef ModuleName, StringRef Source)=0
Attempt to create the given module from the specified source buffer.
clang::ModuleLoader::makeModuleVisible
virtual void makeModuleVisible(Module *Mod, Module::NameVisibilityKind Visibility, SourceLocation ImportLoc)=0
Make the given module visible.
clang::GlobalModuleIndex
A global index for a set of module files, providing information about the identifiers within those mo...
Definition: GlobalModuleIndex.h:56
clang::ModuleLoadResult::isNormal
bool isNormal() const
Determines whether this is a normal return, whether or not loading the module was successful.
Definition: ModuleLoader.h:59
clang::ModuleLoadResult
Describes the result of attempting to load a module.
Definition: ModuleLoader.h:35
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:88
clang::ModuleLoader::lookupMissingImports
virtual bool lookupMissingImports(StringRef Name, SourceLocation TriggerLoc)=0
Check global module index for missing imports.
Module.h
clang::Module::NameVisibilityKind
NameVisibilityKind
Describes the visibility of the various names within a particular module.
Definition: Module.h:312
clang::ModuleLoadResult::ModuleLoadResult
ModuleLoadResult(LoadResultKind Kind)
Definition: ModuleLoader.h:53
clang::ModuleLoader::HadFatalFailure
bool HadFatalFailure
Definition: ModuleLoader.h:157
clang::ModuleLoader::ModuleLoader
ModuleLoader(bool BuildingModule=false)
Definition: ModuleLoader.h:82
clang::ModuleLoadResult::LoadResultKind
LoadResultKind
Definition: ModuleLoader.h:37
clang::ModuleLoadResult::Storage
llvm::PointerIntPair< Module *, 2, LoadResultKind > Storage
Definition: ModuleLoader.h:49
clang::ModuleLoader::loadGlobalModuleIndex
virtual GlobalModuleIndex * loadGlobalModuleIndex(SourceLocation TriggerLoc)=0
Load, create, or return global module.
clang::ModuleLoader::loadModule
virtual ModuleLoadResult loadModule(SourceLocation ImportLoc, ModuleIdPath Path, Module::NameVisibilityKind Visibility, bool IsInclusionDirective)=0
Attempt to load the given module.
clang::TrivialModuleLoader::loadModule
ModuleLoadResult loadModule(SourceLocation ImportLoc, ModuleIdPath Path, Module::NameVisibilityKind Visibility, bool IsInclusionDirective) override
Attempt to load the given module.
Definition: ModuleLoader.h:163
clang::Module
Describes a module or submodule.
Definition: Module.h:96
clang::ModuleLoadResult::isConfigMismatch
bool isConfigMismatch() const
Determines whether the module failed to load due to a configuration mismatch with an explicitly-named...
Definition: ModuleLoader.h:69
clang::ModuleLoader::buildingModule
bool buildingModule() const
Returns true if this instance is building a module.
Definition: ModuleLoader.h:88
clang::ModuleLoadResult::isMissingExpected
bool isMissingExpected() const
Determines whether the module, which failed to load, was actually a submodule that we expected to see...
Definition: ModuleLoader.h:65
clang::Visibility
Visibility
Describes the different kinds of visibility that a declaration may have.
Definition: Visibility.h:33
SourceLocation.h
llvm::ArrayRef
Definition: LLVM.h:34
LLVM.h
clang::TrivialModuleLoader::lookupMissingImports
bool lookupMissingImports(StringRef Name, SourceLocation TriggerLoc) override
Check global module index for missing imports.
Definition: ModuleLoader.h:179
clang::TrivialModuleLoader::createModuleFromSource
void createModuleFromSource(SourceLocation ImportLoc, StringRef ModuleName, StringRef Source) override
Attempt to create the given module from the specified source buffer.
Definition: ModuleLoader.h:169
clang::ModuleLoader
Abstract interface for a module loader.
Definition: ModuleLoader.h:77
clang::TrivialModuleLoader
A module loader that doesn't know how to create or load modules.
Definition: ModuleLoader.h:161
clang::ModuleLoadResult::Normal
@ Normal
Definition: ModuleLoader.h:39
clang::ObjCPropertyAttribute::Kind
Kind
Definition: DeclObjCCommon.h:22
clang::TrivialModuleLoader::makeModuleVisible
void makeModuleVisible(Module *Mod, Module::NameVisibilityKind Visibility, SourceLocation ImportLoc) override
Make the given module visible.
Definition: ModuleLoader.h:172
clang::ModuleLoader::setBuildingModule
void setBuildingModule(bool BuildingModuleFlag)
Flag indicating whether this instance is building a module.
Definition: ModuleLoader.h:93
clang
Definition: CalledOnceCheck.h:17
clang::TrivialModuleLoader::loadGlobalModuleIndex
GlobalModuleIndex * loadGlobalModuleIndex(SourceLocation TriggerLoc) override
Load, create, or return global module.
Definition: ModuleLoader.h:175
clang::ModuleLoadResult::MissingExpected
@ MissingExpected
Definition: ModuleLoader.h:44
clang::ModuleLoadResult::ModuleLoadResult
ModuleLoadResult()=default
clang::ModuleLoadResult::ModuleLoadResult
ModuleLoadResult(Module *M)
Definition: ModuleLoader.h:52
clang::ModuleLoadResult::ConfigMismatch
@ ConfigMismatch
Definition: ModuleLoader.h:47
clang::ModuleLoader::~ModuleLoader
virtual ~ModuleLoader()