1 //===-- llvm/MC/MCAsmParser.h - Abstract Asm Parser Interface ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_MC_MCASMPARSER_H
11 #define LLVM_MC_MCASMPARSER_H
13 #include "llvm/Support/DataTypes.h"
14 #include "llvm/ADT/ArrayRef.h"
20 class MCAsmParserExtension;
24 class MCTargetAsmParser;
31 /// MCAsmParser - Generic assembler parser interface, for use by target specific
35 typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc);
38 MCAsmParser(const MCAsmParser &); // DO NOT IMPLEMENT
39 void operator=(const MCAsmParser &); // DO NOT IMPLEMENT
41 MCTargetAsmParser *TargetParser;
43 unsigned ShowParsedOperands : 1;
45 protected: // Can only create subclasses.
49 virtual ~MCAsmParser();
51 virtual void AddDirectiveHandler(MCAsmParserExtension *Object,
53 DirectiveHandler Handler) = 0;
55 virtual SourceMgr &getSourceManager() = 0;
57 virtual MCAsmLexer &getLexer() = 0;
59 virtual MCContext &getContext() = 0;
61 /// getStreamer - Return the output streamer for the assembler.
62 virtual MCStreamer &getStreamer() = 0;
64 MCTargetAsmParser &getTargetParser() const { return *TargetParser; }
65 void setTargetParser(MCTargetAsmParser &P);
67 bool getShowParsedOperands() const { return ShowParsedOperands; }
68 void setShowParsedOperands(bool Value) { ShowParsedOperands = Value; }
70 /// Run - Run the parser on the input source buffer.
71 virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false) = 0;
73 /// Warning - Emit a warning at the location \arg L, with the message \arg
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;
80 /// Error - Emit an error at the location \arg L, with the message \arg
83 /// \return The return value is always true, as an idiomatic convenience to
85 virtual bool Error(SMLoc L, const Twine &Msg,
86 ArrayRef<SMRange> Ranges = ArrayRef<SMRange>()) = 0;
88 /// Lex - Get the next AsmToken in the stream, possibly handling file
90 virtual const AsmToken &Lex() = 0;
92 /// getTok - Get the current AsmToken from the stream.
93 const AsmToken &getTok();
95 /// \brief Report an error at the current lexer location.
96 bool TokError(const Twine &Msg,
97 ArrayRef<SMRange> Ranges = ArrayRef<SMRange>());
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;
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;
108 /// EatToEndOfStatement - Skip to the end of the current statement, for error
110 virtual void EatToEndOfStatement() = 0;
112 /// ParseExpression - Parse an arbitrary expression.
114 /// @param Res - The value of the expression. The result is undefined
116 /// @result - False on success.
117 virtual bool ParseExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
118 bool ParseExpression(const MCExpr *&Res);
120 /// ParseParenExpression - Parse an arbitrary expression, assuming that an
121 /// initial '(' has already been consumed.
123 /// @param Res - The value of the expression. The result is undefined
125 /// @result - False on success.
126 virtual bool ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
128 /// ParseAbsoluteExpression - Parse an expression which must evaluate to an
131 /// @param Res - The value of the absolute expression. The result is undefined
133 /// @result - False on success.
134 virtual bool ParseAbsoluteExpression(int64_t &Res) = 0;
137 /// \brief Create an MCAsmParser instance.
138 MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &,
139 MCStreamer &, const MCAsmInfo &);
141 } // End llvm namespace