minor cleanups. Add provisions for a new standard BLOCKINFO_BLOCK

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

diff --git a/include/llvm/PassManager.h b/include/llvm/PassManager.h
index c012379b5ad90568d730348cb57bf0c20f74d98e..254cac94d10ea12e7bdbbf9bfcc59400f8df6693 100644 (file)
--- a/include/llvm/PassManager.h
+++ b/include/llvm/PassManager.h
@@ -1,7 +1,14 @@
-//===- 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 Pass's.  The PassManager class ensures
+// maintain, and optimize execution of Passes.  The PassManager class ensures
 // that analysis results are available before a pass runs, and that Pass's are
 // destroyed when the PassManager is destroyed.
 //
@@ -10,27 +17,78 @@
 #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 ModulePassManager;
+class PassManagerImpl;
+class FunctionPassManagerImpl;
 
+/// PassManager manages ModulePassManagers
 class PassManager {
-  PassManagerT<Module> *PM;    // This is a straightforward Pimpl class
+
 public:
+
   PassManager();
   ~PassManager();
 
-  // 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'.
-  //
+  /// 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'.
   void add(Pass *P);
-
-  // run - Execute all of the passes scheduled for execution.  Keep track of
-  // whether any of the functions modifies the program, and if so, return true.
-  //
+ 
+  /// 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);
+
+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 {
+public:
+  explicit FunctionPassManager(ModuleProvider *P);
+  FunctionPassManager();
+  ~FunctionPassManager();
+ 
+  /// add - Add a pass to the queue of passes to run.  This passes
+  /// 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 &F);
+  
+  /// doInitialization - Run all of the initializers for the function passes.
+  ///
+  bool doInitialization();
+  
+  /// doFinalization - Run all of the initializers for the function passes.
+  ///
+  bool doFinalization();
+private:
+  
+  FunctionPassManagerImpl *FPM;
+  ModuleProvider *MP;
+};
+
+} // End llvm namespace
+
 #endif