165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//===-- MCInstPrinter.h - Convert an MCInst to target assembly syntax -----===// 265b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// 365b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// The LLVM Compiler Infrastructure 465b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// 565b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// This file is distributed under the University of Illinois Open Source 665b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// License. See LICENSE.TXT for details. 765b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// 865b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//===----------------------------------------------------------------------===// 965b0b297db16252835ab4d78f33578baa3ace28aChris Lattner 1065b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#ifndef LLVM_MC_MCINSTPRINTER_H 1165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#define LLVM_MC_MCINSTPRINTER_H 1265b0b297db16252835ab4d78f33578baa3ace28aChris Lattner 13d9791538156702ac1f92ca2984a8ab536deda4f1Benjamin Kramer#include "llvm/Support/DataTypes.h" 1414ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby#include "llvm/Support/Format.h" 1514ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 1665b0b297db16252835ab4d78f33578baa3ace28aChris Lattnernamespace llvm { 1765b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass MCInst; 1865b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass raw_ostream; 19c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattnerclass MCAsmInfo; 2017463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topperclass MCInstrInfo; 21c6449b636f4984be88f128d0375c056ad05e7e8fJim Grosbachclass MCRegisterInfo; 227e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattnerclass StringRef; 23c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattner 2465b0b297db16252835ab4d78f33578baa3ace28aChris Lattner/// MCInstPrinter - This is an instance of a target assembly language printer 2565b0b297db16252835ab4d78f33578baa3ace28aChris Lattner/// that converts an MCInst to valid target assembly syntax. 2665b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass MCInstPrinter { 27c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattnerprotected: 285d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// CommentStream - a stream that comments can be emitted to if desired. 295d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// Each comment must end with a newline. This will be null if verbose 305d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// assembly emission is disable. 315d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner raw_ostream *CommentStream; 32c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattner const MCAsmInfo &MAI; 3317463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper const MCInstrInfo &MII; 34c6449b636f4984be88f128d0375c056ad05e7e8fJim Grosbach const MCRegisterInfo &MRI; 3544dcfd36253570ccd5f00189eb918604473135e0Bill Wendling 3644dcfd36253570ccd5f00189eb918604473135e0Bill Wendling /// The current set of available features. 3744dcfd36253570ccd5f00189eb918604473135e0Bill Wendling unsigned AvailableFeatures; 3898c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson 393ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby /// True if we are printing marked up assembly. 403ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby bool UseMarkup; 413ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby 4214ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby /// True if we are printing immediates as hex. 4314ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby bool PrintImmHex; 4414ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 4598c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson /// Utility function for printing annotations. 4698c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson void printAnnotation(raw_ostream &OS, StringRef Annot); 4765b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerpublic: 4817463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii, 4917463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper const MCRegisterInfo &mri) 503ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby : CommentStream(0), MAI(mai), MII(mii), MRI(mri), AvailableFeatures(0), 5114ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby UseMarkup(0), PrintImmHex(0) {} 52fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 5365b0b297db16252835ab4d78f33578baa3ace28aChris Lattner virtual ~MCInstPrinter(); 545d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner 555d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// setCommentStream - Specify a stream to emit comments to. 565d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner void setCommentStream(raw_ostream &OS) { CommentStream = &OS; } 57fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 58d374087be5360a353a4239a155b1227057145f48Chris Lattner /// printInst - Print the specified MCInst to the specified raw_ostream. 5965b0b297db16252835ab4d78f33578baa3ace28aChris Lattner /// 6098c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson virtual void printInst(const MCInst *MI, raw_ostream &OS, 6198c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson StringRef Annot) = 0; 62ede042dc8d59ff48a48ef8e2271f2a7ee8324ba5Owen Anderson 637e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner /// getOpcodeName - Return the name of the specified opcode enum (e.g. 647e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner /// "MOV32ri") or empty if we can't resolve it. 65c97ef618d2d849a272a353c2b4343fc5902cd921Benjamin Kramer StringRef getOpcodeName(unsigned Opcode) const; 6657caad7a33ff145b71545f10dcfbbf2fd0f595d3Anton Korobeynikov 67cde4ce411b1ace4a80ea1dd38df97e8508aed0c9Rafael Espindola /// printRegName - Print the assembler register name. 68cde4ce411b1ace4a80ea1dd38df97e8508aed0c9Rafael Espindola virtual void printRegName(raw_ostream &OS, unsigned RegNo) const; 6944dcfd36253570ccd5f00189eb918604473135e0Bill Wendling 7044dcfd36253570ccd5f00189eb918604473135e0Bill Wendling unsigned getAvailableFeatures() const { return AvailableFeatures; } 7144dcfd36253570ccd5f00189eb918604473135e0Bill Wendling void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; } 723ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby 733ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby bool getUseMarkup() const { return UseMarkup; } 743ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby void setUseMarkup(bool Value) { UseMarkup = Value; } 75e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby 76e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby /// Utility functions to make adding mark ups simpler. 77e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby StringRef markup(StringRef s) const; 78e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby StringRef markup(StringRef a, StringRef b) const; 7914ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 8014ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby bool getPrintImmHex() const { return PrintImmHex; } 8114ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby void setPrintImmHex(bool Value) { PrintImmHex = Value; } 8214ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 8314ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby /// Utility function to print immediates in decimal or hex. 8414ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby format_object1<int64_t> formatImm(const int64_t Value) const; 8565b0b297db16252835ab4d78f33578baa3ace28aChris Lattner}; 86fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 8765b0b297db16252835ab4d78f33578baa3ace28aChris Lattner} // namespace llvm 8865b0b297db16252835ab4d78f33578baa3ace28aChris Lattner 8965b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#endif 90