include/llvm/Assembly/PrintModulePass.h

   1 //===- llvm/Assembly/PrintModulePass.h - Printing Pass ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines two passes to print out a module.  The PrintModulePass pass
  11 // simply prints out the entire module when it is executed.  The
  12 // PrintFunctionPass class is designed to be pipelined with other
  13 // FunctionPass's, and prints out the functions of the module as they are
  14 // processed.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_ASSEMBLY_PRINTMODULEPASS_H
  19 #define LLVM_ASSEMBLY_PRINTMODULEPASS_H
  20
  21 #include <string>
  22
  23 namespace llvm {
  24   class FunctionPass;
  25   class ModulePass;
  26   class BasicBlockPass;
  27   class raw_ostream;
  28
  29   /// createPrintModulePass - Create and return a pass that writes the
  30   /// module to the specified raw_ostream.
  31   ModulePass *createPrintModulePass(raw_ostream *OS,
  32                                     bool DeleteStream=false,
  33                                     const std::string &Banner = "");
  34
  35   /// createPrintFunctionPass - Create and return a pass that prints
  36   /// functions to the specified raw_ostream as they are processed.
  37   FunctionPass *createPrintFunctionPass(const std::string &Banner,
  38                                         raw_ostream *OS,
  39                                         bool DeleteStream=false);
  40
  41   /// createPrintBasicBlockPass - Create and return a pass that writes the
  42   /// BB to the specified raw_ostream.
  43   BasicBlockPass *createPrintBasicBlockPass(raw_ostream *OS,
  44                                             bool DeleteStream=false,
  45                                             const std::string &Banner = "");
  46 } // End llvm namespace
  47
  48 #endif