include/llvm/Target/TargetAsmParser.h

   1 //===-- llvm/Target/TargetAsmParser.h - Target Assembly Parser --*- 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_TARGET_TARGETPARSER_H
  11 #define LLVM_TARGET_TARGETPARSER_H
  12
  13 #include "llvm/MC/MCParser/MCAsmParserExtension.h"
  14
  15 namespace llvm {
  16 class MCInst;
  17 class StringRef;
  18 class Target;
  19 class SMLoc;
  20 class AsmToken;
  21 class MCParsedAsmOperand;
  22 template <typename T> class SmallVectorImpl;
  23
  24 /// TargetAsmParser - Generic interface to target specific assembly parsers.
  25 class TargetAsmParser : public MCAsmParserExtension {
  26   TargetAsmParser(const TargetAsmParser &);   // DO NOT IMPLEMENT
  27   void operator=(const TargetAsmParser &);  // DO NOT IMPLEMENT
  28 protected: // Can only create subclasses.
  29   TargetAsmParser(const Target &);
  30
  31   /// TheTarget - The Target that this machine was created for.
  32   const Target &TheTarget;
  33
  34 public:
  35   virtual ~TargetAsmParser();
  36
  37   const Target &getTarget() const { return TheTarget; }
  38
  39   /// ParseInstruction - Parse one assembly instruction.
  40   ///
  41   /// The parser is positioned following the instruction name. The target
  42   /// specific instruction parser should parse the entire instruction and
  43   /// construct the appropriate MCInst, or emit an error. On success, the entire
  44   /// line should be parsed up to and including the end-of-statement token. On
  45   /// failure, the parser is not required to read to the end of the line.
  46   //
  47   /// \param Name - The instruction name.
  48   /// \param NameLoc - The source location of the name.
  49   /// \param Operands [out] - The list of parsed operands, this returns
  50   ///        ownership of them to the caller.
  51   /// \return True on failure.
  52   virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
  53                             SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
  54
  55   /// ParseDirective - Parse a target specific assembler directive
  56   ///
  57   /// The parser is positioned following the directive name.  The target
  58   /// specific directive parser should parse the entire directive doing or
  59   /// recording any target specific work, or return true and do nothing if the
  60   /// directive is not target specific. If the directive is specific for
  61   /// the target, the entire line is parsed up to and including the
  62   /// end-of-statement token and false is returned.
  63   ///
  64   /// \param DirectiveID - the identifier token of the directive.
  65   virtual bool ParseDirective(AsmToken DirectiveID) = 0;
  66
  67   /// MatchInstruction - Recognize a series of operands of a parsed instruction
  68   /// as an actual MCInst.  This returns false and fills in Inst on success and
  69   /// returns true on failure to match.
  70   virtual bool
  71   MatchInstruction(const SmallVectorImpl<MCParsedAsmOperand*> &Operands,
  72                    MCInst &Inst) = 0;
  73
  74 };
  75
  76 } // End llvm namespace
  77
  78 #endif