MCAsmParser.h revision 3298959540ca744ec16b4c65db244534a929a862
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 16namespace llvm { 17class AsmToken; 18class MCAsmInfo; 19class MCAsmLexer; 20class MCAsmParserExtension; 21class MCContext; 22class MCExpr; 23class MCInstPrinter; 24class MCInstrInfo; 25class MCParsedAsmOperand; 26class MCStreamer; 27class MCTargetAsmParser; 28class SMLoc; 29class SMRange; 30class SourceMgr; 31class StringRef; 32class Twine; 33 34/// MCAsmParserSemaCallback - Generic Sema callback for assembly parser. 35class MCAsmParserSemaCallback { 36public: 37 virtual void *LookupInlineAsmIdentifier(StringRef Name, void *Loc, 38 unsigned &Size) = 0; 39}; 40 41/// MCAsmParser - Generic assembler parser interface, for use by target specific 42/// assembly parsers. 43class MCAsmParser { 44public: 45 typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc); 46 47private: 48 MCAsmParser(const MCAsmParser &) LLVM_DELETED_FUNCTION; 49 void operator=(const MCAsmParser &) LLVM_DELETED_FUNCTION; 50 51 MCTargetAsmParser *TargetParser; 52 53 unsigned ShowParsedOperands : 1; 54 55protected: // Can only create subclasses. 56 MCAsmParser(); 57 58public: 59 virtual ~MCAsmParser(); 60 61 virtual void AddDirectiveHandler(MCAsmParserExtension *Object, 62 StringRef Directive, 63 DirectiveHandler Handler) = 0; 64 65 virtual SourceMgr &getSourceManager() = 0; 66 67 virtual MCAsmLexer &getLexer() = 0; 68 69 virtual MCContext &getContext() = 0; 70 71 /// getStreamer - Return the output streamer for the assembler. 72 virtual MCStreamer &getStreamer() = 0; 73 74 MCTargetAsmParser &getTargetParser() const { return *TargetParser; } 75 void setTargetParser(MCTargetAsmParser &P); 76 77 virtual unsigned getAssemblerDialect() { return 0;} 78 virtual void setAssemblerDialect(unsigned i) { } 79 80 bool getShowParsedOperands() const { return ShowParsedOperands; } 81 void setShowParsedOperands(bool Value) { ShowParsedOperands = Value; } 82 83 /// Run - Run the parser on the input source buffer. 84 virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0; 85 86 virtual void setParsingInlineAsm(bool V) = 0; 87 virtual bool isParsingInlineAsm() = 0; 88 89 /// ParseMSInlineAsm - Parse ms-style inline assembly. 90 virtual bool ParseMSInlineAsm(void *AsmLoc, std::string &AsmString, 91 unsigned &NumOutputs, unsigned &NumInputs, 92 SmallVectorImpl<void *> &OpDecls, 93 SmallVectorImpl<std::string> &Constraints, 94 SmallVectorImpl<std::string> &Clobbers, 95 const MCInstrInfo *MII, 96 const MCInstPrinter *IP, 97 MCAsmParserSemaCallback &SI) = 0; 98 99 /// ParseStatement - Parse the next statement. 100 virtual bool ParseStatement() = 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. 165MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &, 166 MCStreamer &, const MCAsmInfo &); 167 168} // End llvm namespace 169 170#endif 171