MCCodeEmitter.h revision 360784 
1//===- llvm/MC/MCCodeEmitter.h - Instruction Encoding -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_MC_MCCODEEMITTER_H
10#define LLVM_MC_MCCODEEMITTER_H
11
12namespace llvm {
13
14class MCFixup;
15class MCInst;
16class MCSubtargetInfo;
17class raw_ostream;
18template<typename T> class SmallVectorImpl;
19
20/// MCCodeEmitter - Generic instruction encoding interface.
21class MCCodeEmitter {
22protected: // Can only create subclasses.
23  MCCodeEmitter();
24
25public:
26  MCCodeEmitter(const MCCodeEmitter &) = delete;
27  MCCodeEmitter &operator=(const MCCodeEmitter &) = delete;
28  virtual ~MCCodeEmitter();
29
30  /// Lifetime management
31  virtual void reset() {}
32
33  /// Emit the prefixes of given instruction on the output stream.
34  ///
35  /// \param Inst a single low-level machine instruction.
36  /// \param OS output stream.
37  virtual void emitPrefix(const MCInst &Inst, raw_ostream &OS,
38                          const MCSubtargetInfo &STI) const {}
39  /// EncodeInstruction - Encode the given \p Inst to bytes on the output
40  /// stream \p OS.
41  virtual void encodeInstruction(const MCInst &Inst, raw_ostream &OS,
42                                 SmallVectorImpl<MCFixup> &Fixups,
43                                 const MCSubtargetInfo &STI) const = 0;
44};
45
46} // end namespace llvm
47
48#endif // LLVM_MC_MCCODEEMITTER_H
49