contrib/llvm/tools/clang/include/clang/Lex/ModuleLoader.h

   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 #include "llvm/ADT/PointerIntPair.h"
  21
  22 namespace clang {
  23
  24 class IdentifierInfo;
  25 class Module;
  26
  27 /// \brief A sequence of identifier/location pairs used to describe a particular
  28 /// module or submodule, e.g., std.vector.
  29 typedef ArrayRef<std::pair<IdentifierInfo *, SourceLocation> > ModuleIdPath;
  30
  31 /// \brief Describes the result of attempting to load a module.
  32 class ModuleLoadResult {
  33   llvm::PointerIntPair<Module *, 1, bool> Storage;
  34
  35 public:
  36   ModuleLoadResult() : Storage() { }
  37
  38   ModuleLoadResult(Module *module, bool missingExpected)
  39     : Storage(module, missingExpected) { }
  40
  41   operator Module *() const { return Storage.getPointer(); }
  42
  43   /// \brief Determines whether the module, which failed to load, was
  44   /// actually a submodule that we expected to see (based on implying the
  45   /// submodule from header structure), but didn't materialize in the actual
  46   /// module.
  47   bool isMissingExpected() const { return Storage.getInt(); }
  48 };
  49
  50 /// \brief Abstract interface for a module loader.
  51 ///
  52 /// This abstract interface describes a module loader, which is responsible
  53 /// for resolving a module name (e.g., "std") to an actual module file, and
  54 /// then loading that module.
  55 class ModuleLoader {
  56 public:
  57   virtual ~ModuleLoader();
  58
  59   /// \brief Attempt to load the given module.
  60   ///
  61   /// This routine attempts to load the module described by the given
  62   /// parameters.
  63   ///
  64   /// \param ImportLoc The location of the 'import' keyword.
  65   ///
  66   /// \param Path The identifiers (and their locations) of the module
  67   /// "path", e.g., "std.vector" would be split into "std" and "vector".
  68   ///
  69   /// \param Visibility The visibility provided for the names in the loaded
  70   /// module.
  71   ///
  72   /// \param IsInclusionDirective Indicates that this module is being loaded
  73   /// implicitly, due to the presence of an inclusion directive. Otherwise,
  74   /// it is being loaded due to an import declaration.
  75   ///
  76   /// \returns If successful, returns the loaded module. Otherwise, returns
  77   /// NULL to indicate that the module could not be loaded.
  78   virtual ModuleLoadResult loadModule(SourceLocation ImportLoc,
  79                                       ModuleIdPath Path,
  80                                       Module::NameVisibilityKind Visibility,
  81                                       bool IsInclusionDirective) = 0;
  82
  83   /// \brief Make the given module visible.
  84   virtual void makeModuleVisible(Module *Mod,
  85                                  Module::NameVisibilityKind Visibility,
  86                                  SourceLocation ImportLoc,
  87                                  bool Complain) = 0;
  88 };
  89
  90 }
  91
  92 #endif