Files
swift-mirror/include/swift/AST/ModuleLoader.h
Jordan Rose ec1e47cbf0 Thread operator lookup through Module to ModuleLoader...
...even though Swift modules don't provide this lookup yet, and Clang
modules never will.

Swift SVN r5173
2013-05-16 00:23:10 +00:00

100 lines
3.3 KiB
C++

//===--- ModuleLoader.h - Module Loader Interface -------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file implements an abstract interface for loading modules.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_AST_MODULE_LOADER_H
#define SWIFT_AST_MODULE_LOADER_H
#include "swift/AST/Identifier.h"
#include "swift/AST/Module.h"
#include "swift/AST/Type.h"
#include "swift/Basic/LLVM.h"
#include "swift/Basic/SourceLoc.h"
#include "llvm/ADT/IntrusiveRefCntPtr.h"
namespace swift {
class Module;
/// \brief Abstract interface that loads named modules into the AST.
class ModuleLoader : public llvm::RefCountedBaseVPTR {
public:
virtual ~ModuleLoader();
/// \brief Import a module with the given module path.
///
/// \param importLoc The location of the 'import' keyword.
///
/// \param path A sequence of (identifier, location) pairs that denote
/// the dotted module name to load, e.g., AppKit.NSWindow.
///
/// \returns the module referenced, if it could be loaded. Otherwise,
/// emits a diagnostic and returns NULL.
virtual
Module *loadModule(SourceLoc importLoc,
ArrayRef<std::pair<Identifier, SourceLoc>> path) = 0;
/// \brief Look for declarations associated with the given name.
///
/// \param module The module to search.
///
/// \param accessPath The access path used to refer to the name within this
/// (top-level) module.
///
/// \param name The name we're searching for.
///
/// \param lookupKind Whether we're performing qualified vs. unqualified
/// lookup.
///
/// \param result Will be populated with the results of name lookup.
virtual void lookupValue(Module *module,
Module::AccessPathTy accessPath, Identifier name,
NLKind lookupKind,
SmallVectorImpl<ValueDecl*> &result) { }
/// \brief Look for extensions associated with the given type.
///
/// \param module The module to search.
///
/// \param type The type for which we are looking for extensions.
virtual ArrayRef<ExtensionDecl*> lookupExtensions(Module *module, Type type) {
return {};
}
/// \brief Look for members of the given type.
///
/// \param module The module to search.
///
/// \param base The type into which we will look to find members.
///
/// \param name The name of the members we are looking for.
///
/// \param result Will be populated with the results of name lookup.
virtual void lookupMembers(Module *module, Type base, Identifier name,
SmallVectorImpl<ValueDecl*> &result) { }
/// \brief Look for a declaration of the given operator.
///
/// \returns The operator decl, or null if this module does not define the
/// operator in question.
virtual OperatorDecl *lookupOperator(Module *module, Identifier name,
DeclKind fixity) {
return nullptr;
}
};
}
#endif