ModuleLoader.h revision 1a4761edca58c6b559de825b9abfb66f7f1ba94a
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/SourceLocation.h" 18#include "llvm/ADT/ArrayRef.h" 19 20namespace clang { 21 22class IdentifierInfo; 23class Module; 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 /// \param Path The identifiers (and their locations) of the module 45 /// "path", e.g., "std.vector" would be split into "std" and "vector". 46 /// 47 /// \returns If successful, returns the loaded module. Otherwise, returns 48 /// NULL to indicate that the module could not be loaded. 49 virtual Module *loadModule(SourceLocation ImportLoc, ModuleIdPath Path) = 0; 50}; 51 52} 53 54#endif 55