Improve InstVisitor docs.

[oota-llvm.git] / include / llvm / ModuleProvider.h

diff --git a/include/llvm/ModuleProvider.h b/include/llvm/ModuleProvider.h
index 8f7010360ccfe5ab0f315fdceed0021a878cf299..2f185e01d353732b909c9614bed901f482ab1f93 100644 (file)
--- a/include/llvm/ModuleProvider.h
+++ b/include/llvm/ModuleProvider.h
@@ -1,5 +1,12 @@
 //===-- llvm/ModuleProvider.h - Interface for module providers --*- C++ -*-===//
 //
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
 // This file provides an abstract interface for loading a module from some
 // place.  This interface allows incremental or random access loading of
 // functions from the file.  This is useful for applications like JIT compilers
@@ -11,6 +18,8 @@
 #ifndef MODULEPROVIDER_H
 #define MODULEPROVIDER_H
 
+namespace llvm {
+
 class Function;
 class Module;
 
@@ -26,23 +35,41 @@ public:
   ///
   Module* getModule() { return TheModule; }
 
-  /// materializeFunction - make sure the given function is fully read.
+  /// materializeFunction - make sure the given function is fully read.  Note
+  /// that this can throw an exception if the module is corrupt!
   ///
   virtual void materializeFunction(Function *F) = 0;
 
   /// materializeModule - make sure the entire Module has been completely read.
+  /// Note that this can throw an exception if the module is corrupt!
   ///
-  void materializeModule();
+  virtual Module* materializeModule() = 0;
 
   /// releaseModule - no longer delete the Module* when provider is destroyed.
+  /// Note that this can throw an exception if the module is corrupt!
   ///
-  virtual Module* releaseModule() { 
+  virtual Module* releaseModule() {
     // Since we're losing control of this Module, we must hand it back complete
     materializeModule();
-    Module *tempM = TheModule; 
-    TheModule = 0; 
-    return tempM; 
+    Module *tempM = TheModule;
+    TheModule = 0;
+    return tempM;
   }
 };
 
+
+/// ExistingModuleProvider - Allow conversion from a fully materialized Module
+/// into a ModuleProvider, allowing code that expects a ModuleProvider to work
+/// if we just have a Module.  Note that the ModuleProvider takes ownership of
+/// the Module specified.
+struct ExistingModuleProvider : public ModuleProvider {
+  ExistingModuleProvider(Module *M) {
+    TheModule = M;
+  }
+  void materializeFunction(Function *F) {}
+  Module* materializeModule() { return TheModule; }
+};
+
+} // End llvm namespace
+
 #endif