include/llvm/MC/MCCodeEmitter.h

   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
  12 namespace llvm {
  13
  14 class MCFixup;
  15 class MCInst;
  16 class MCSubtargetInfo;
  17 class raw_ostream;
  18 template<typename T> class SmallVectorImpl;
  19
  20 /// MCCodeEmitter - Generic instruction encoding interface.
  21 class MCCodeEmitter {
  22 protected: // Can only create subclasses.
  23   MCCodeEmitter();
  24
  25 public:
  26   MCCodeEmitter(const MCCodeEmitter &) = delete;
  27   MCCodeEmitter &operator=(const MCCodeEmitter &) = delete;
  28   virtual ~MCCodeEmitter();
  29
  30   /// Lifetime management
  31   virtual void reset() {}
  32
  33   /// EncodeInstruction - Encode the given \p Inst to bytes on the output
  34   /// stream \p OS.
  35   virtual void encodeInstruction(const MCInst &Inst, raw_ostream &OS,
  36                                  SmallVectorImpl<MCFixup> &Fixups,
  37                                  const MCSubtargetInfo &STI) const = 0;
  38 };
  39
  40 } // end namespace llvm
  41
  42 #endif // LLVM_MC_MCCODEEMITTER_H