1 //===-- llvm/Assembly/Writer.h - Printer for LLVM assembly files --*- 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 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.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_ASSEMBLY_WRITER_H
18 #define LLVM_ASSEMBLY_WRITER_H
29 template <typename T> class SmallVectorImpl;
31 /// TypePrinting - Type printing machinery.
33 void *TypeNames; // A map to remember type names.
34 TypePrinting(const TypePrinting &); // DO NOT IMPLEMENT
35 void operator=(const TypePrinting&); // DO NOT IMPLEMENT
42 void print(const Type *Ty, raw_ostream &OS, bool IgnoreTopLevelName = false);
44 void printAtLeastOneLevel(const Type *Ty, raw_ostream &OS) {
48 /// hasTypeName - Return true if the type has a name in TypeNames, false
50 bool hasTypeName(const Type *Ty) const;
52 /// addTypeName - Add a name for the specified type if it doesn't already have
53 /// one. This name will be printed instead of the structural version of the
54 /// type in order to make the output more concise.
55 void addTypeName(const Type *Ty, const std::string &N);
58 void CalcTypeName(const Type *Ty, SmallVectorImpl<const Type *> &TypeStack,
59 raw_ostream &OS, bool IgnoreTopLevelName = false);
62 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
63 // type, if there is an entry in the Module's symbol table for the specified
64 // type or one of its component types.
66 void WriteTypeSymbolic(raw_ostream &, const Type *, const Module *M);
68 // WriteAsOperand - Write the name of the specified value out to the specified
69 // ostream. This can be useful when you just want to print int %reg126, not the
70 // whole instruction that generated it. If you specify a Module for context,
71 // then even constants get pretty-printed; for example, the type of a null
72 // pointer is printed symbolically.
74 void WriteAsOperand(std::ostream &, const Value *, bool PrintTy = true,
75 const Module *Context = 0);
76 void WriteAsOperand(raw_ostream &, const Value *, bool PrintTy = true,
77 const Module *Context = 0);
79 } // End llvm namespace