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