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 is distributed under the University of Illinois Open Source
   6 // 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 <string>
  21
  22 namespace llvm {
  23
  24 class Type;
  25 class Module;
  26 class Value;
  27 class raw_ostream;
  28 template <typename T> class SmallVectorImpl;
  29
  30 /// TypePrinting - Type printing machinery.
  31 class TypePrinting {
  32   void *TypeNames;  // A map to remember type names.
  33   TypePrinting(const TypePrinting &);   // DO NOT IMPLEMENT
  34   void operator=(const TypePrinting&);  // DO NOT IMPLEMENT
  35 public:
  36   TypePrinting();
  37   ~TypePrinting();
  38
  39   void clear();
  40
  41   void print(const Type *Ty, raw_ostream &OS, bool IgnoreTopLevelName = false);
  42
  43   void printAtLeastOneLevel(const Type *Ty, raw_ostream &OS) {
  44     print(Ty, OS, true);
  45   }
  46
  47   /// hasTypeName - Return true if the type has a name in TypeNames, false
  48   /// otherwise.
  49   bool hasTypeName(const Type *Ty) const;
  50
  51   /// addTypeName - Add a name for the specified type if it doesn't already have
  52   /// one.  This name will be printed instead of the structural version of the
  53   /// type in order to make the output more concise.
  54   void addTypeName(const Type *Ty, const std::string &N);
  55
  56 private:
  57   void CalcTypeName(const Type *Ty, SmallVectorImpl<const Type *> &TypeStack,
  58                     raw_ostream &OS, bool IgnoreTopLevelName = false);
  59 };
  60
  61 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
  62 // type, if there is an entry in the Module's symbol table for the specified
  63 // type or one of its component types.
  64 //
  65 void WriteTypeSymbolic(raw_ostream &, const Type *, const Module *M);
  66
  67 // WriteAsOperand - Write the name of the specified value out to the specified
  68 // ostream.  This can be useful when you just want to print int %reg126, not the
  69 // whole instruction that generated it.  If you specify a Module for context,
  70 // then even constants get pretty-printed; for example, the type of a null
  71 // pointer is printed symbolically.
  72 //
  73 void WriteAsOperand(raw_ostream &, const Value *, bool PrintTy = true,
  74                     const Module *Context = 0);
  75
  76 } // End llvm namespace
  77
  78 #endif