MCInstPrinter.h revision fd2eaed4f0a9375071a448993c573a124370ed34 
1//===-- MCInstPrinter.h - Convert an MCInst to target assembly syntax -----===//
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#ifndef LLVM_MC_MCINSTPRINTER_H
11#define LLVM_MC_MCINSTPRINTER_H
12
13namespace llvm {
14class MCInst;
15class raw_ostream;
16class MCAsmInfo;
17class StringRef;
18
19/// MCInstPrinter - This is an instance of a target assembly language printer
20/// that converts an MCInst to valid target assembly syntax.
21class MCInstPrinter {
22protected:
23  /// CommentStream - a stream that comments can be emitted to if desired.
24  /// Each comment must end with a newline.  This will be null if verbose
25  /// assembly emission is disable.
26  raw_ostream *CommentStream;
27  const MCAsmInfo &MAI;
28public:
29  MCInstPrinter(const MCAsmInfo &mai)
30    : CommentStream(0), MAI(mai) {}
31
32  virtual ~MCInstPrinter();
33
34  /// setCommentStream - Specify a stream to emit comments to.
35  void setCommentStream(raw_ostream &OS) { CommentStream = &OS; }
36
37  /// printInst - Print the specified MCInst to the specified raw_ostream.
38  ///
39  virtual void printInst(const MCInst *MI, raw_ostream &OS) = 0;
40
41  /// getOpcodeName - Return the name of the specified opcode enum (e.g.
42  /// "MOV32ri") or empty if we can't resolve it.
43  virtual StringRef getOpcodeName(unsigned Opcode) const;
44};
45
46} // namespace llvm
47
48#endif
49