[ARM] Introduce subtarget features per ARM architecture.

[oota-llvm.git] / include / llvm / MC / MCInstPrinter.h

diff --git a/include/llvm/MC/MCInstPrinter.h b/include/llvm/MC/MCInstPrinter.h
index 96716c775fdfc0556bb67dd6cfa786fe583423c6..0eafd02c51c63c6052e22792d11e4615c1585a4f 100644 (file)
--- a/include/llvm/MC/MCInstPrinter.h
+++ b/include/llvm/MC/MCInstPrinter.h
@@ -1,4 +1,4 @@
-//===-- MCInstPrinter.h - Convert an MCInst to target assembly syntax -----===//
+//===- MCInstPrinter.h - MCInst to target assembly syntax -------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -10,37 +10,97 @@
 #ifndef LLVM_MC_MCINSTPRINTER_H
 #define LLVM_MC_MCINSTPRINTER_H
 
+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/Support/DataTypes.h"
+#include "llvm/Support/Format.h"
+
 namespace llvm {
 class MCInst;
 class raw_ostream;
 class MCAsmInfo;
+class MCInstrInfo;
+class MCRegisterInfo;
+class MCSubtargetInfo;
 class StringRef;
 
-/// MCInstPrinter - This is an instance of a target assembly language printer
-/// that converts an MCInst to valid target assembly syntax.
+/// Convert `Bytes' to a hex string and output to `OS'
+void dumpBytes(ArrayRef<uint8_t> Bytes, raw_ostream &OS);
+
+namespace HexStyle {
+enum Style {
+  C,  ///< 0xff
+  Asm ///< 0ffh
+};
+}
+
+/// \brief This is an instance of a target assembly language printer that
+/// converts an MCInst to valid target assembly syntax.
 class MCInstPrinter {
 protected:
-  /// CommentStream - a stream that comments can be emitted to if desired.
-  /// Each comment must end with a newline.  This will be null if verbose
-  /// assembly emission is disable.
+  /// \brief A stream that comments can be emitted to if desired.  Each comment
+  /// must end with a newline.  This will be null if verbose assembly emission
+  /// is disable.
   raw_ostream *CommentStream;
   const MCAsmInfo &MAI;
+  const MCInstrInfo &MII;
+  const MCRegisterInfo &MRI;
+
+  /// True if we are printing marked up assembly.
+  bool UseMarkup;
+
+  /// True if we are printing immediates as hex.
+  bool PrintImmHex;
+
+  /// Which style to use for printing hexadecimal values.
+  HexStyle::Style PrintHexStyle;
+
+  /// Utility function for printing annotations.
+  void printAnnotation(raw_ostream &OS, StringRef Annot);
+
 public:
-  MCInstPrinter(const MCAsmInfo &mai)
-    : CommentStream(0), MAI(mai) {}
+  MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii,
+                const MCRegisterInfo &mri)
+      : CommentStream(nullptr), MAI(mai), MII(mii), MRI(mri), UseMarkup(0),
+        PrintImmHex(0), PrintHexStyle(HexStyle::C) {}
 
   virtual ~MCInstPrinter();
 
-  /// setCommentStream - Specify a stream to emit comments to.
+  /// \brief Specify a stream to emit comments to.
   void setCommentStream(raw_ostream &OS) { CommentStream = &OS; }
 
-  /// printInst - Print the specified MCInst to the specified raw_ostream.
-  ///
-  virtual void printInst(const MCInst *MI, raw_ostream &OS) = 0;
+  /// \brief Print the specified MCInst to the specified raw_ostream.
+  virtual void printInst(const MCInst *MI, raw_ostream &OS, StringRef Annot,
+                         const MCSubtargetInfo &STI) = 0;
+
+  /// \brief Return the name of the specified opcode enum (e.g. "MOV32ri") or
+  /// empty if we can't resolve it.
+  StringRef getOpcodeName(unsigned Opcode) const;
+
+  /// \brief Print the assembler register name.
+  virtual void printRegName(raw_ostream &OS, unsigned RegNo) const;
+
+  bool getUseMarkup() const { return UseMarkup; }
+  void setUseMarkup(bool Value) { UseMarkup = Value; }
+
+  /// Utility functions to make adding mark ups simpler.
+  StringRef markup(StringRef s) const;
+  StringRef markup(StringRef a, StringRef b) const;
+
+  bool getPrintImmHex() const { return PrintImmHex; }
+  void setPrintImmHex(bool Value) { PrintImmHex = Value; }
+
+  HexStyle::Style getPrintHexStyle() const { return PrintHexStyle; }
+  void setPrintHexStyle(HexStyle::Style Value) { PrintHexStyle = Value; }
+
+  /// Utility function to print immediates in decimal or hex.
+  format_object<int64_t> formatImm(int64_t Value) const {
+    return PrintImmHex ? formatHex(Value) : formatDec(Value);
+  }
 
-  /// getOpcodeName - Return the name of the specified opcode enum (e.g.
-  /// "MOV32ri") or empty if we can't resolve it.
-  virtual StringRef getOpcodeName(unsigned Opcode) const;
+  /// Utility functions to print decimal/hexadecimal values.
+  format_object<int64_t> formatDec(int64_t Value) const;
+  format_object<int64_t> formatHex(int64_t Value) const;
+  format_object<uint64_t> formatHex(uint64_t Value) const;
 };
 
 } // namespace llvm