Make single-argument ctors explicit to avoid tricky bugs :)

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

diff --git a/include/llvm/PassManager.h b/include/llvm/PassManager.h
index c30164b54021ba8452aa2c8d9bd6cd3092db770a..1abfa68a1ace62a1f5286f969c1aa573f3b599af 100644 (file)
--- a/include/llvm/PassManager.h
+++ b/include/llvm/PassManager.h
@@ -1,4 +1,11 @@
-//===- llvm/PassManager.h - Container for Passes -----------------*- C++ -*--=//
+//===- llvm/PassManager.h - Container for Passes ----------------*- 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 defines the PassManager class.  This class is used to hold,
 // maintain, and optimize execution of Passes.  The PassManager class ensures
@@ -10,13 +17,23 @@
 #ifndef LLVM_PASSMANAGER_H
 #define LLVM_PASSMANAGER_H
 
+#include "llvm/Pass.h"
+
+namespace llvm {
+
 class Pass;
+class ModulePass;
 class Module;
-template<class UnitType> class PassManagerT;
+class ModuleProvider;
 
+class PassManagerImpl;
+class FunctionPassManagerImpl;
+
+/// PassManager manages ModulePassManagers
 class PassManager {
-  PassManagerT<Module> *PM;    // This is a straightforward Pimpl class
+
 public:
+
   PassManager();
   ~PassManager();
 
@@ -24,43 +41,53 @@ 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:
+
+  /// 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 {
-  PassManagerT<Function> *PM;    // This is a straightforward Pimpl class
 public:
+  explicit FunctionPassManager(ModuleProvider *P);
   FunctionPassManager();
   ~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);
 
   /// 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 &M);
+  bool run(Function &F);
+  
+  /// doInitialization - Run all of the initializers for the function passes.
+  ///
+  bool doInitialization();
+  
+  /// doFinalization - Run all of the finalizers for the function passes.
+  ///
+  bool doFinalization();
+private:
+  
+  FunctionPassManagerImpl *FPM;
+  ModuleProvider *MP;
 };
 
+} // End llvm namespace
+
 #endif