include/llvm/Assembly/Writer.h

   1 //===-- llvm/Assembly/Writer.h - Printer for LLVM assembly files --*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This functionality is implemented by lib/VMCore/AsmWriter.cpp.
  11 // This library is used to print LLVM assembly language files to an iostream. It
  12 // can print LLVM code at a variety of granularities, including Modules,
  13 // BasicBlocks, and Instructions.  This makes it useful for debugging.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ASSEMBLY_WRITER_H
  18 #define LLVM_ASSEMBLY_WRITER_H
  19
  20 #include <iosfwd>
  21
  22 namespace llvm {
  23
  24 class Type;
  25 class Module;
  26 class Value;
  27
  28 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
  29 // type, iff there is an entry in the Module's symbol table for the specified
  30 // type or one of its component types.  This is slower than a simple x << Type;
  31 //
  32 std::ostream &WriteTypeSymbolic(std::ostream &, const Type *, const Module *M);
  33
  34 // WriteAsOperand - Write the name of the specified value out to the specified
  35 // ostream.  This can be useful when you just want to print int %reg126, not the
  36 // whole instruction that generated it.  If you specify a Module for context,
  37 // then even constants get pretty-printed; for example, the type of a null
  38 // pointer is printed symbolically.
  39 //
  40 std::ostream &WriteAsOperand(std::ostream &, const Value *, bool PrintTy = true,
  41                              const Module *Context = 0);
  42
  43 } // End llvm namespace
  44
  45 #endif