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/Support/DataTypes.h"
  14 #include "llvm/ADT/ArrayRef.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 MCStreamer;
  24 class MCTargetAsmParser;
  25 class SMLoc;
  26 class SMRange;
  27 class SourceMgr;
  28 class StringRef;
  29 class Twine;
  30
  31 /// MCAsmParser - Generic assembler parser interface, for use by target specific
  32 /// assembly parsers.
  33 class MCAsmParser {
  34 public:
  35   typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc);
  36
  37 private:
  38   MCAsmParser(const MCAsmParser &);   // DO NOT IMPLEMENT
  39   void operator=(const MCAsmParser &);  // DO NOT IMPLEMENT
  40
  41   MCTargetAsmParser *TargetParser;
  42
  43   unsigned ShowParsedOperands : 1;
  44
  45 protected: // Can only create subclasses.
  46   MCAsmParser();
  47
  48 public:
  49   virtual ~MCAsmParser();
  50
  51   virtual void AddDirectiveHandler(MCAsmParserExtension *Object,
  52                                    StringRef Directive,
  53                                    DirectiveHandler Handler) = 0;
  54
  55   virtual SourceMgr &getSourceManager() = 0;
  56
  57   virtual MCAsmLexer &getLexer() = 0;
  58
  59   virtual MCContext &getContext() = 0;
  60
  61   /// getStreamer - Return the output streamer for the assembler.
  62   virtual MCStreamer &getStreamer() = 0;
  63
  64   MCTargetAsmParser &getTargetParser() const { return *TargetParser; }
  65   void setTargetParser(MCTargetAsmParser &P);
  66
  67   bool getShowParsedOperands() const { return ShowParsedOperands; }
  68   void setShowParsedOperands(bool Value) { ShowParsedOperands = Value; }
  69
  70   /// Run - Run the parser on the input source buffer.
  71   virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0;
  72
  73   /// Warning - Emit a warning at the location \arg L, with the message \arg
  74   /// Msg.
  75   ///
  76   /// \return The return value is true, if warnings are fatal.
  77   virtual bool Warning(SMLoc L, const Twine &Msg,
  78                        ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) = 0;
  79
  80   /// Error - Emit an error at the location \arg L, with the message \arg
  81   /// Msg.
  82   ///
  83   /// \return The return value is always true, as an idiomatic convenience to
  84   /// clients.
  85   virtual bool Error(SMLoc L, const Twine &Msg,
  86                      ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) = 0;
  87
  88   /// Lex - Get the next AsmToken in the stream, possibly handling file
  89   /// inclusion first.
  90   virtual const AsmToken &Lex() = 0;
  91
  92   /// getTok - Get the current AsmToken from the stream.
  93   const AsmToken &getTok();
  94
  95   /// \brief Report an error at the current lexer location.
  96   bool TokError(const Twine &Msg,
  97                 ArrayRef<SMRange> Ranges = ArrayRef<SMRange>());
  98
  99   /// ParseIdentifier - Parse an identifier or string (as a quoted identifier)
 100   /// and set \arg Res to the identifier contents.
 101   virtual bool ParseIdentifier(StringRef &Res) = 0;
 102
 103   /// \brief Parse up to the end of statement and return the contents from the
 104   /// current token until the end of the statement; the current token on exit
 105   /// will be either the EndOfStatement or EOF.
 106   virtual StringRef ParseStringToEndOfStatement() = 0;
 107
 108   /// EatToEndOfStatement - Skip to the end of the current statement, for error
 109   /// recovery.
 110   virtual void EatToEndOfStatement() = 0;
 111
 112   /// ParseExpression - Parse an arbitrary expression.
 113   ///
 114   /// @param Res - The value of the expression. The result is undefined
 115   /// on error.
 116   /// @result - False on success.
 117   virtual bool ParseExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 118   bool ParseExpression(const MCExpr *&Res);
 119
 120   /// ParseParenExpression - Parse an arbitrary expression, assuming that an
 121   /// initial '(' has already been consumed.
 122   ///
 123   /// @param Res - The value of the expression. The result is undefined
 124   /// on error.
 125   /// @result - False on success.
 126   virtual bool ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
 127
 128   /// ParseAbsoluteExpression - Parse an expression which must evaluate to an
 129   /// absolute value.
 130   ///
 131   /// @param Res - The value of the absolute expression. The result is undefined
 132   /// on error.
 133   /// @result - False on success.
 134   virtual bool ParseAbsoluteExpression(int64_t &Res) = 0;
 135 };
 136
 137 /// \brief Create an MCAsmParser instance.
 138 MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &,
 139                                MCStreamer &, const MCAsmInfo &);
 140
 141 } // End llvm namespace
 142
 143 #endif