ModuleLoader.h revision 93ebfa6139bbca4d446c7343e3afc8e5ec777484 
1//===--- ModuleLoader.h - Module Loader Interface ---------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the ModuleLoader interface, which is responsible for
11//  loading named modules.
12//
13//===----------------------------------------------------------------------===//
14#ifndef LLVM_CLANG_LEX_MODULE_LOADER_H
15#define LLVM_CLANG_LEX_MODULE_LOADER_H
16
17#include "clang/Basic/Module.h"
18#include "clang/Basic/SourceLocation.h"
19#include "llvm/ADT/ArrayRef.h"
20
21namespace clang {
22
23class IdentifierInfo;
24
25/// \brief A sequence of identifier/location pairs used to describe a particular
26/// module or submodule, e.g., std.vector.
27typedef llvm::ArrayRef<std::pair<IdentifierInfo*, SourceLocation> > ModuleIdPath;
28
29/// \brief Abstract interface for a module loader.
30///
31/// This abstract interface describes a module loader, which is responsible
32/// for resolving a module name (e.g., "std") to an actual module file, and
33/// then loading that module.
34class ModuleLoader {
35public:
36  virtual ~ModuleLoader();
37
38  /// \brief Attempt to load the given module.
39  ///
40  /// This routine attempts to load the module described by the given
41  /// parameters.
42  ///
43  /// \param ImportLoc The location of the 'import' keyword.
44  ///
45  /// \param Path The identifiers (and their locations) of the module
46  /// "path", e.g., "std.vector" would be split into "std" and "vector".
47  ///
48  /// \param Visibility The visibility provided for the names in the loaded
49  /// module.
50  ///
51  /// \param IsInclusionDirective Indicates that this module is being loaded
52  /// implicitly, due to the presence of an inclusion directive. Otherwise,
53  /// it is being loaded due to an import declaration.
54  ///
55  /// \returns If successful, returns the loaded module. Otherwise, returns
56  /// NULL to indicate that the module could not be loaded.
57  virtual Module *loadModule(SourceLocation ImportLoc, ModuleIdPath Path,
58                             Module::NameVisibilityKind Visibility,
59                             bool IsInclusionDirective) = 0;
60};
61
62}
63
64#endif
65