include/llvm/MC/MCParser/MCParsedAsmOperand.h

   1 //===-- llvm/MC/MCParsedAsmOperand.h - Asm Parser Operand -------*- C++ -*-===//
   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_MCPARSER_MCPARSEDASMOPERAND_H
  11 #define LLVM_MC_MCPARSER_MCPARSEDASMOPERAND_H
  12
  13 namespace llvm {
  14 class SMLoc;
  15 class raw_ostream;
  16
  17 /// MCParsedAsmOperand - This abstract class represents a source-level assembly
  18 /// instruction operand.  It should be subclassed by target-specific code.  This
  19 /// base class is used by target-independent clients and is the interface
  20 /// between parsing an asm instruction and recognizing it.
  21 class MCParsedAsmOperand {
  22   /// MCOperandNum - The corresponding MCInst operand number.  Only valid when
  23   /// parsing MS-style inline assembly.
  24   unsigned MCOperandNum;
  25
  26   /// Constraint - The constraint on this operand.  Only valid when parsing
  27   /// MS-style inline assembly.
  28   std::string Constraint;
  29
  30 public:
  31   MCParsedAsmOperand() {}
  32   virtual ~MCParsedAsmOperand() {}
  33
  34   void setConstraint(StringRef C) { Constraint = C.str(); }
  35   StringRef getConstraint() { return Constraint; }
  36
  37   void setMCOperandNum (unsigned OpNum) { MCOperandNum = OpNum; }
  38   unsigned getMCOperandNum() { return MCOperandNum; }
  39
  40   unsigned getNameLen() {
  41     assert (getStartLoc().isValid() && "Invalid StartLoc!");
  42     assert (getEndLoc().isValid() && "Invalid EndLoc!");
  43     return getEndLoc().getPointer() - getStartLoc().getPointer();
  44   }
  45
  46   StringRef getName() {
  47     return StringRef(getStartLoc().getPointer(), getNameLen());
  48   }
  49
  50   /// isToken - Is this a token operand?
  51   virtual bool isToken() const = 0;
  52   /// isImm - Is this an immediate operand?
  53   virtual bool isImm() const = 0;
  54   /// isReg - Is this a register operand?
  55   virtual bool isReg() const = 0;
  56   virtual unsigned getReg() const = 0;
  57
  58   /// isMem - Is this a memory operand?
  59   virtual bool isMem() const = 0;
  60
  61   /// getStartLoc - Get the location of the first token of this operand.
  62   virtual SMLoc getStartLoc() const = 0;
  63   /// getEndLoc - Get the location of the last token of this operand.
  64   virtual SMLoc getEndLoc() const = 0;
  65
  66   /// needAddressOf - Do we need to emit code to get the address of the
  67   /// variable/label?   Only valid when parsing MS-style inline assembly.
  68   virtual bool needAddressOf() const { return false; }
  69
  70   /// isOffsetOf - Do we need to emit code to get the offset of the variable,
  71   /// rather then the value of the variable?   Only valid when parsing MS-style
  72   /// inline assembly.
  73   virtual bool isOffsetOf() const { return false; }
  74
  75   /// getOffsetOfLoc - Get the location of the offset operator.
  76   virtual SMLoc getOffsetOfLoc() const { return SMLoc(); }
  77
  78   /// print - Print a debug representation of the operand to the given stream.
  79   virtual void print(raw_ostream &OS) const = 0;
  80   /// dump - Print to the debug stream.
  81   virtual void dump() const;
  82 };
  83
  84 //===----------------------------------------------------------------------===//
  85 // Debugging Support
  86
  87 inline raw_ostream& operator<<(raw_ostream &OS, const MCParsedAsmOperand &MO) {
  88   MO.print(OS);
  89   return OS;
  90 }
  91
  92 } // end namespace llvm.
  93
  94 #endif