include/llvm/MC/MCParser/MCAsmParser.h

   1 //===-- llvm/MC/MCAsmParser.h - Abstract Asm Parser Interface ---*- 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_MCASMPARSER_H
  11 #define LLVM_MC_MCASMPARSER_H
  12
  13 #include "llvm/ADT/ArrayRef.h"
  14 #include "llvm/Support/DataTypes.h"
  15
  16 namespace llvm {
  17 class AsmToken;
  18 class MCAsmInfo;
  19 class MCAsmLexer;
  20 class MCAsmParserExtension;
  21 class MCContext;
  22 class MCExpr;
  23 class MCInstPrinter;
  24 class MCInstrInfo;
  25 class MCParsedAsmOperand;
  26 class MCStreamer;
  27 class MCTargetAsmParser;
  28 class SMLoc;
  29 class SMRange;
  30 class SourceMgr;
  31 class StringRef;
  32 class Twine;
  33
  34 /// MCAsmParserSemaCallback - Generic Sema callback for assembly parser.
  35 class MCAsmParserSemaCallback {
  36 public:
  37   virtual ~MCAsmParserSemaCallback();
  38   virtual void *LookupInlineAsmIdentifier(StringRef Name, void *Loc,
  39                                           unsigned &Size) = 0;
  40   virtual bool LookupInlineAsmField(StringRef Base, StringRef Member,
  41                                     unsigned &Offset) = 0;
  42 };
  43
  44 /// MCAsmParser - Generic assembler parser interface, for use by target specific
  45 /// assembly parsers.
  46 class MCAsmParser {
  47 public:
  48   typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc);
  49
  50 private:
  51   MCAsmParser(const MCAsmParser &) LLVM_DELETED_FUNCTION;
  52   void operator=(const MCAsmParser &) LLVM_DELETED_FUNCTION;
  53
  54   MCTargetAsmParser *TargetParser;
  55
  56   unsigned ShowParsedOperands : 1;
  57
  58 protected: // Can only create subclasses.
  59   MCAsmParser();
  60
  61 public:
  62   virtual ~MCAsmParser();
  63
  64   virtual void AddDirectiveHandler(MCAsmParserExtension *Object,
  65                                    StringRef Directive,
  66                                    DirectiveHandler Handler) = 0;
  67
  68   virtual SourceMgr &getSourceManager() = 0;
  69
  70   virtual MCAsmLexer &getLexer() = 0;
  71
  72   virtual MCContext &getContext() = 0;
  73
  74   /// getStreamer - Return the output streamer for the assembler.
  75   virtual MCStreamer &getStreamer() = 0;
  76
  77   MCTargetAsmParser &getTargetParser() const { return *TargetParser; }
  78   void setTargetParser(MCTargetAsmParser &P);
  79
  80   virtual unsigned getAssemblerDialect() { return 0;}
  81   virtual void setAssemblerDialect(unsigned i) { }
  82
  83   bool getShowParsedOperands() const { return ShowParsedOperands; }
  84   void setShowParsedOperands(bool Value) { ShowParsedOperands = Value; }
  85
  86   /// Run - Run the parser on the input source buffer.
  87   virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0;
  88
  89   virtual void setParsingInlineAsm(bool V) = 0;
  90   virtual bool isParsingInlineAsm() = 0;
  91
  92   /// ParseMSInlineAsm - Parse ms-style inline assembly.
  93   virtual bool ParseMSInlineAsm(void *AsmLoc, std::string &AsmString,
  94                                 unsigned &NumOutputs, unsigned &NumInputs,
  95                                 SmallVectorImpl<std::pair<void *, bool> > &OpDecls,
  96                                 SmallVectorImpl<std::string> &Constraints,
  97                                 SmallVectorImpl<std::string> &Clobbers,
  98                                 const MCInstrInfo *MII,
  99                                 const MCInstPrinter *IP,
 100                                 MCAsmParserSemaCallback &SI) = 0;
 101
 102   /// Warning - Emit a warning at the location \p L, with the message \p Msg.
 103   ///
 104   /// \return The return value is true, if warnings are fatal.
 105   virtual bool Warning(SMLoc L, const Twine &Msg,
 106                        ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) = 0;
 107
 108   /// Error - Emit an error at the location \p L, with the message \p Msg.
 109   ///
 110   /// \return The return value is always true, as an idiomatic convenience to
 111   /// clients.
 112   virtual bool Error(SMLoc L, const Twine &Msg,
 113                      ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) = 0;
 114
 115   /// Lex - Get the next AsmToken in the stream, possibly handling file
 116   /// inclusion first.
 117   virtual const AsmToken &Lex() = 0;
 118
 119   /// getTok - Get the current AsmToken from the stream.
 120   const AsmToken &getTok();
 121
 122   /// \brief Report an error at the current lexer location.
 123   bool TokError(const Twine &Msg,
 124                 ArrayRef<SMRange> Ranges = ArrayRef<SMRange>());
 125
 126   /// ParseIdentifier - Parse an identifier or string (as a quoted identifier)
 127   /// and set \p Res to the identifier contents.
 128   virtual bool ParseIdentifier(StringRef &Res) = 0;
 129
 130   /// \brief Parse up to the end of statement and return the contents from the
 131   /// current token until the end of the statement; the current token on exit
 132   /// will be either the EndOfStatement or EOF.
 133   virtual StringRef ParseStringToEndOfStatement() = 0;
 134
 135   /// EatToEndOfStatement - Skip to the end of the current statement, for error
 136   /// recovery.
 137   virtual void EatToEndOfStatement() = 0;
 138
 139   /// ParseExpression - Parse an arbitrary expression.
 140   ///
 141   /// @param Res - The value of the expression. The result is undefined
 142   /// on error.
 143   /// @result - False on success.
 144   virtual bool ParseExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 145   bool ParseExpression(const MCExpr *&Res);
 146
 147   /// ParseParenExpression - Parse an arbitrary expression, assuming that an
 148   /// initial '(' has already been consumed.
 149   ///
 150   /// @param Res - The value of the expression. The result is undefined
 151   /// on error.
 152   /// @result - False on success.
 153   virtual bool ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 154
 155   /// ParseAbsoluteExpression - Parse an expression which must evaluate to an
 156   /// absolute value.
 157   ///
 158   /// @param Res - The value of the absolute expression. The result is undefined
 159   /// on error.
 160   /// @result - False on success.
 161   virtual bool ParseAbsoluteExpression(int64_t &Res) = 0;
 162 };
 163
 164 /// \brief Create an MCAsmParser instance.
 165 MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &,
 166                                MCStreamer &, const MCAsmInfo &);
 167
 168 } // End llvm namespace
 169
 170 #endif