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