Fix braces.
[oota-llvm.git] / include / llvm / PassManager.h
index 5d936c49abc90da29cebac38dac639e7f0831818..a6703fd5867a88457d4a91b8dc67e22ec6126903 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -29,9 +29,22 @@ class ModuleProvider;
 class PassManagerImpl;
 class FunctionPassManagerImpl;
 
-/// PassManager manages ModulePassManagers
-class PassManager {
+/// PassManagerBase - An abstract interface to allow code to add passes to
+/// a pass manager without having to hard-code what kind of pass manager
+/// it is.
+class PassManagerBase {
+public:
+  virtual ~PassManagerBase();
 
+  /// add - Add a pass to the queue of passes to run.  This passes ownership of
+  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
+  /// will be destroyed as well, so there is no need to delete the pass.  This
+  /// implies that all passes MUST be allocated with 'new'.
+  virtual void add(Pass *P) = 0;
+};
+
+/// PassManager manages ModulePassManagers
+class PassManager : public PassManagerBase {
 public:
 
   PassManager();
@@ -52,14 +65,14 @@ private:
   /// PassManagerImpl_New is the actual class. PassManager is just the 
   /// wraper to publish simple pass manager interface
   PassManagerImpl *PM;
-
 };
 
 /// FunctionPassManager manages FunctionPasses and BasicBlockPassManagers.
-class FunctionPassManager {
+class FunctionPassManager : public PassManagerBase {
 public:
+  /// FunctionPassManager ctor - This initializes the pass manager.  It needs,
+  /// but does not take ownership of, the specified module provider.
   explicit FunctionPassManager(ModuleProvider *P);
-  FunctionPassManager();
   ~FunctionPassManager();
  
   /// add - Add a pass to the queue of passes to run.  This passes
@@ -79,11 +92,17 @@ public:
   ///
   bool doInitialization();
   
-  /// doFinalization - Run all of the initializers for the function passes.
+  /// doFinalization - Run all of the finalizers for the function passes.
   ///
   bool doFinalization();
-private:
   
+  /// getModuleProvider - Return the module provider that this passmanager is
+  /// currently using.  This is the module provider that it uses when a function
+  /// is optimized that is non-resident in the module.
+  ModuleProvider *getModuleProvider() const { return MP; }
+  void setModuleProvider(ModuleProvider *NewMP) { MP = NewMP; }
+
+private:
   FunctionPassManagerImpl *FPM;
   ModuleProvider *MP;
 };