Fix braces.

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

diff --git a/include/llvm/PassManager.h b/include/llvm/PassManager.h
index 7d4a2df6d15220e48a068e94f1f1f7b8d10befcb..a6703fd5867a88457d4a91b8dc67e22ec6126903 100644 (file)
--- a/include/llvm/PassManager.h
+++ b/include/llvm/PassManager.h
@@ -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.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -17,19 +17,36 @@
 #ifndef LLVM_PASSMANAGER_H
 #define LLVM_PASSMANAGER_H
 
+#include "llvm/Pass.h"
+
 namespace llvm {
 
 class Pass;
 class ModulePass;
 class Module;
 class ModuleProvider;
-class ModulePassManager;
-class FunctionPassManagerT;
-class BasicBlockPassManager;
 
-class PassManager {
-  ModulePassManager *PM;    // This is a straightforward Pimpl class
+class PassManagerImpl;
+class FunctionPassManagerImpl;
+
+/// 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();
   ~PassManager();
 
@@ -37,52 +54,57 @@ public:
   /// 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'.
-  ///
   void add(Pass *P);
-
+ 
   /// run - Execute all of the passes scheduled for execution.  Keep track of
   /// whether any of the passes modifies the module, and if so, return true.
-  ///
   bool run(Module &M);
-};
 
-class FunctionPass;
-class ImmutablePass;
-class Function;
+private:
 
-class FunctionPassManager {
-  FunctionPassManagerT *PM;    // This is a straightforward Pimpl class
-  ModuleProvider *MP;
+  /// 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 : public PassManagerBase {
 public:
-  FunctionPassManager(ModuleProvider *P);
+  /// FunctionPassManager ctor - This initializes the pass manager.  It needs,
+  /// but does not take ownership of, the specified module provider.
+  explicit FunctionPassManager(ModuleProvider *P);
   ~FunctionPassManager();
-
+ 
   /// add - Add a pass to the queue of passes to run.  This passes
-  /// ownership of the FunctionPass 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'.
-  ///
-  void add(FunctionPass *P);
-
-  /// add - ImmutablePasses are not FunctionPasses, so we have a
-  /// special hack to get them into a FunctionPassManager.
-  ///
-  void add(ImmutablePass *IP);
+  /// ownership of the Pass to the PassManager.  When the
+  /// PassManager_X is destroyed, the pass will be destroyed as well, so
+  /// there is no need to delete the pass. (TODO delete passes.)
+  /// This implies that all passes MUST be allocated with 'new'.
+  void add(Pass *P);
 
-  /// doInitialization - Run all of the initializers for the function passes.
-  ///
-  bool doInitialization();
-  
   /// run - Execute all of the passes scheduled for execution.  Keep
   /// track of whether any of the passes modifies the function, and if
   /// so, return true.
   ///
   bool run(Function &F);
   
-  /// doFinalization - Run all of the initializers for the function passes.
+  /// doInitialization - Run all of the initializers for the function passes.
+  ///
+  bool doInitialization();
+  
+  /// doFinalization - Run all of the finalizers for the function passes.
   ///
   bool doFinalization();
+  
+  /// 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;
 };
 
 } // End llvm namespace