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 MCStreamer;
  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   /// The Target that this machine was created for.
  32   const Target &TheTarget;
  33
  34   /// The current set of available features.
  35   unsigned AvailableFeatures;
  36
  37 public:
  38   virtual ~TargetAsmParser();
  39
  40   const Target &getTarget() const { return TheTarget; }
  41
  42   unsigned getAvailableFeatures() const { return AvailableFeatures; }
  43   void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; }
  44
  45   virtual bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc, SMLoc &EndLoc) = 0;
  46
  47   /// ParseInstruction - Parse one assembly instruction.
  48   ///
  49   /// The parser is positioned following the instruction name. The target
  50   /// specific instruction parser should parse the entire instruction and
  51   /// construct the appropriate MCInst, or emit an error. On success, the entire
  52   /// line should be parsed up to and including the end-of-statement token. On
  53   /// failure, the parser is not required to read to the end of the line.
  54   //
  55   /// \param Name - The instruction name.
  56   /// \param NameLoc - The source location of the name.
  57   /// \param Operands [out] - The list of parsed operands, this returns
  58   ///        ownership of them to the caller.
  59   /// \return True on failure.
  60   virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
  61                             SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
  62
  63   /// ParseDirective - Parse a target specific assembler directive
  64   ///
  65   /// The parser is positioned following the directive name.  The target
  66   /// specific directive parser should parse the entire directive doing or
  67   /// recording any target specific work, or return true and do nothing if the
  68   /// directive is not target specific. If the directive is specific for
  69   /// the target, the entire line is parsed up to and including the
  70   /// end-of-statement token and false is returned.
  71   ///
  72   /// \param DirectiveID - the identifier token of the directive.
  73   virtual bool ParseDirective(AsmToken DirectiveID) = 0;
  74
  75   /// MatchAndEmitInstruction - Recognize a series of operands of a parsed
  76   /// instruction as an actual MCInst and emit it to the specified MCStreamer.
  77   /// This returns false on success and returns true on failure to match.
  78   ///
  79   /// On failure, the target parser is responsible for emitting a diagnostic
  80   /// explaining the match failure.
  81   virtual bool
  82   MatchAndEmitInstruction(SMLoc IDLoc,
  83                           SmallVectorImpl<MCParsedAsmOperand*> &Operands,
  84                           MCStreamer &Out) = 0;
  85
  86 };
  87
  88 } // End llvm namespace
  89
  90 #endif