MCAsmParser.h revision 733c336327621d41617d3d49c7b86199a361a367 
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/Support/DataTypes.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 ~MCAsmParserSemaCallback();
38  virtual void *LookupInlineAsmIdentifier(StringRef Name, void *Loc,
39                                          unsigned &Size, bool &IsVarDecl) = 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.
46class MCAsmParser {
47public:
48  typedef bool (*DirectiveHandler)(MCAsmParserExtension*, StringRef, SMLoc);
49
50private:
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
58protected: // Can only create subclasses.
59  MCAsmParser();
60
61public:
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  /// Control a flag in the parser that enables or disables macros.
140  virtual bool MacrosEnabled() = 0;
141  virtual void SetMacrosEnabled(bool flag) = 0;
142
143  /// ParseExpression - Parse an arbitrary expression.
144  ///
145  /// @param Res - The value of the expression. The result is undefined
146  /// on error.
147  /// @result - False on success.
148  virtual bool ParseExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
149  bool ParseExpression(const MCExpr *&Res);
150
151  /// ParseParenExpression - Parse an arbitrary expression, assuming that an
152  /// initial '(' has already been consumed.
153  ///
154  /// @param Res - The value of the expression. The result is undefined
155  /// on error.
156  /// @result - False on success.
157  virtual bool ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) = 0;
158
159  /// ParseAbsoluteExpression - Parse an expression which must evaluate to an
160  /// absolute value.
161  ///
162  /// @param Res - The value of the absolute expression. The result is undefined
163  /// on error.
164  /// @result - False on success.
165  virtual bool ParseAbsoluteExpression(int64_t &Res) = 0;
166};
167
168/// \brief Create an MCAsmParser instance.
169MCAsmParser *createMCAsmParser(SourceMgr &, MCContext &,
170                               MCStreamer &, const MCAsmInfo &);
171
172} // End llvm namespace
173
174#endif
175