Home | History | Annotate | Download | only in MC
      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 
     13 namespace llvm {
     14 class MCInst;
     15 class raw_ostream;
     16 class MCAsmInfo;
     17 class StringRef;
     18 
     19 /// MCInstPrinter - This is an instance of a target assembly language printer
     20 /// that converts an MCInst to valid target assembly syntax.
     21 class MCInstPrinter {
     22 protected:
     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;
     28 
     29   /// The current set of available features.
     30   unsigned AvailableFeatures;
     31 
     32   /// Utility function for printing annotations.
     33   void printAnnotation(raw_ostream &OS, StringRef Annot);
     34 public:
     35   MCInstPrinter(const MCAsmInfo &mai)
     36     : CommentStream(0), MAI(mai), AvailableFeatures(0) {}
     37 
     38   virtual ~MCInstPrinter();
     39 
     40   /// setCommentStream - Specify a stream to emit comments to.
     41   void setCommentStream(raw_ostream &OS) { CommentStream = &OS; }
     42 
     43   /// printInst - Print the specified MCInst to the specified raw_ostream.
     44   ///
     45   virtual void printInst(const MCInst *MI, raw_ostream &OS,
     46                          StringRef Annot) = 0;
     47 
     48   /// getOpcodeName - Return the name of the specified opcode enum (e.g.
     49   /// "MOV32ri") or empty if we can't resolve it.
     50   virtual StringRef getOpcodeName(unsigned Opcode) const;
     51 
     52   /// printRegName - Print the assembler register name.
     53   virtual void printRegName(raw_ostream &OS, unsigned RegNo) const;
     54 
     55   unsigned getAvailableFeatures() const { return AvailableFeatures; }
     56   void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; }
     57 };
     58 
     59 } // namespace llvm
     60 
     61 #endif
     62