1 //===- llvm/Assembly/PrintModulePass.h - Printing Pass ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_ASSEMBLY_PRINTMODULEPASS_H
19 #define LLVM_ASSEMBLY_PRINTMODULEPASS_H
21 #include "llvm/Pass.h"
22 #include "llvm/Module.h"
23 #include "llvm/Support/Streams.h"
27 class PrintModulePass : public ModulePass {
28 OStream *Out; // ostream to print on
29 bool DeleteStream; // Delete the ostream in our dtor?
32 PrintModulePass() : ModulePass(intptr_t(&ID)), Out(&cerr),
33 DeleteStream(false) {}
34 PrintModulePass(OStream *o, bool DS = false)
35 : ModulePass(intptr_t(&ID)), Out(o), DeleteStream(DS) {}
38 if (DeleteStream) delete Out;
41 bool runOnModule(Module &M) {
42 (*Out) << M << std::flush;
46 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
51 class PrintFunctionPass : public FunctionPass {
52 std::string Banner; // String to print before each function
53 OStream *Out; // ostream to print on
54 bool DeleteStream; // Delete the ostream in our dtor?
57 PrintFunctionPass() : FunctionPass(intptr_t(&ID)), Banner(""), Out(&cerr),
58 DeleteStream(false) {}
59 PrintFunctionPass(const std::string &B, OStream *o = &cout,
61 : FunctionPass(intptr_t(&ID)), Banner(B), Out(o), DeleteStream(DS) {}
63 inline ~PrintFunctionPass() {
64 if (DeleteStream) delete Out;
67 // runOnFunction - This pass just prints a banner followed by the function as
70 bool runOnFunction(Function &F) {
71 (*Out) << Banner << static_cast<Value&>(F);
75 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
80 } // End llvm namespace