add a handy typedef.

[oota-llvm.git] / include / llvm / Assembly / PrintModulePass.h

diff --git a/include/llvm/Assembly/PrintModulePass.h b/include/llvm/Assembly/PrintModulePass.h
index a03b3492e622dc176d2f8c5499ae497dba68c5a6..239fbcc0c8caae629e7a7ac18adb85e58d03b21d 100644 (file)
--- a/include/llvm/Assembly/PrintModulePass.h
+++ b/include/llvm/Assembly/PrintModulePass.h
@@ -1,6 +1,16 @@
-//===- llvm/Assembly/PrintModulePass.h - Printing Pass -----------*- C++ -*--=//
+//===- llvm/Assembly/PrintModulePass.h - Printing Pass ----------*- C++ -*-===//
 //
-// This file defines a simple pass to print out methods of a module as they are
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines two passes to print out a module.  The PrintModulePass pass
+// simply prints out the entire module when it is executed.  The
+// PrintFunctionPass class is designed to be pipelined with other
+// FunctionPass's, and prints out the functions of the module as they are
 // processed.
 //
 //===----------------------------------------------------------------------===//
@@ -8,42 +18,25 @@
 #ifndef LLVM_ASSEMBLY_PRINTMODULEPASS_H
 #define LLVM_ASSEMBLY_PRINTMODULEPASS_H
 
-#include "llvm/Pass.h"
-#include "llvm/Assembly/Writer.h"
+#include <string>
 
-class PrintModulePass : public Pass {
-  string Banner;          // String to print before each method
-  ostream *Out;           // ostream to print on
-  bool DeleteStream;      // Delete the ostream in our dtor?
-  bool PrintPerMethod;    // Print one method at a time rather than the whole?
-public:
-  inline PrintModulePass(const string &B, ostream *o = &cout,
-                         bool DS = false,
-                         bool printPerMethod = true)
-    : Banner(B), Out(o), DeleteStream(DS), PrintPerMethod(printPerMethod) {
-  }
+namespace llvm {
+  class FunctionPass;
+  class ModulePass;
+  class raw_ostream;
   
-  inline ~PrintModulePass() {
-    if (DeleteStream) delete Out;
-  }
+  /// createPrintModulePass - Create and return a pass that writes the
+  /// module to the specified raw_ostream.
+  ModulePass *createPrintModulePass(raw_ostream *OS,
+                                    bool DeleteStream=false,
+                                    const std::string &Banner = "");
   
-  // doPerMethodWork - This pass just prints a banner followed by the method as
-  // it's processed.
-  //
-  bool doPerMethodWork(Method *M) {
-    if (PrintPerMethod)
-      (*Out) << Banner << M;
-    return false;
-  }
+  /// createPrintFunctionPass - Create and return a pass that prints
+  /// functions to the specified raw_ostream as they are processed.
+  FunctionPass *createPrintFunctionPass(const std::string &Banner,
+                                        raw_ostream *OS, 
+                                        bool DeleteStream=false);  
 
-  // doPassFinalization - Virtual method overriden by subclasses to do any post
-  // processing needed after all passes have run.
-  //
-  bool doPassFinalization(Module *M) {
-    if (! PrintPerMethod)
-      (*Out) << Banner << M;
-    return false;
-  }
-};
+} // End llvm namespace
 
 #endif