llvm-6502/include/llvm/IR/IRPrintingPasses.h
2014-01-14 05:50:19 +00:00

86 lines
2.7 KiB
C++

//===- IRPrintingPasses.h - Passes to print out IR constructs ---*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
/// \file
///
/// This file defines passes to print out IR in various granularities. 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.
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_IR_IR_PRINTING_PASSES_H
#define LLVM_IR_IR_PRINTING_PASSES_H
#include "llvm/ADT/StringRef.h"
#include <string>
namespace llvm {
class BasicBlockPass;
class Function;
class FunctionPass;
class Module;
class ModulePass;
class PreservedAnalyses;
class raw_ostream;
/// \brief Create and return a pass that writes the module to the specified
/// \c raw_ostream.
ModulePass *createPrintModulePass(raw_ostream &OS,
const std::string &Banner = "");
/// \brief Create and return a pass that prints functions to the specified
/// \c raw_ostream as they are processed.
FunctionPass *createPrintFunctionPass(raw_ostream &OS,
const std::string &Banner = "");
/// \brief Create and return a pass that writes the BB to the specified
/// \c raw_ostream.
BasicBlockPass *createPrintBasicBlockPass(raw_ostream &OS,
const std::string &Banner = "");
/// \brief Pass for printing a Module as LLVM's text IR assembly.
///
/// Note: This pass is for use with the new pass manager. Use the create...Pass
/// functions above to create passes for use with the legacy pass manager.
class PrintModulePass {
raw_ostream &OS;
std::string Banner;
public:
PrintModulePass();
PrintModulePass(raw_ostream &OS, const std::string &Banner = "");
PreservedAnalyses run(Module *M);
static StringRef name() { return "PrintModulePass"; }
};
/// \brief Pass for printing a Function as LLVM's text IR assembly.
///
/// Note: This pass is for use with the new pass manager. Use the create...Pass
/// functions above to create passes for use with the legacy pass manager.
class PrintFunctionPass {
raw_ostream &OS;
std::string Banner;
public:
PrintFunctionPass();
PrintFunctionPass(raw_ostream &OS, const std::string &Banner = "");
PreservedAnalyses run(Function *F);
static StringRef name() { return "PrintFunctionPass"; }
};
} // End llvm namespace
#endif