1 //===-- llvm/MC/MCTargetAsmParser.h - Target Assembly Parser ----*- 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_TARGETPARSER_H
11 #define LLVM_MC_TARGETPARSER_H
13 #include "llvm/MC/MCParser/MCAsmParserExtension.h"
20 class MCParsedAsmOperand;
21 template <typename T> class SmallVectorImpl;
23 /// MCTargetAsmParser - Generic interface to target specific assembly parsers.
24 class MCTargetAsmParser : public MCAsmParserExtension {
35 MCTargetAsmParser(const MCTargetAsmParser &); // DO NOT IMPLEMENT
36 void operator=(const MCTargetAsmParser &); // DO NOT IMPLEMENT
37 protected: // Can only create subclasses.
40 /// AvailableFeatures - The current set of available features.
41 unsigned AvailableFeatures;
44 virtual ~MCTargetAsmParser();
46 unsigned getAvailableFeatures() const { return AvailableFeatures; }
47 void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; }
49 virtual bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc,
52 /// ParseInstruction - Parse one assembly instruction.
54 /// The parser is positioned following the instruction name. The target
55 /// specific instruction parser should parse the entire instruction and
56 /// construct the appropriate MCInst, or emit an error. On success, the entire
57 /// line should be parsed up to and including the end-of-statement token. On
58 /// failure, the parser is not required to read to the end of the line.
60 /// \param Name - The instruction name.
61 /// \param NameLoc - The source location of the name.
62 /// \param Operands [out] - The list of parsed operands, this returns
63 /// ownership of them to the caller.
64 /// \return True on failure.
65 virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
66 SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
68 /// ParseDirective - Parse a target specific assembler directive
70 /// The parser is positioned following the directive name. The target
71 /// specific directive parser should parse the entire directive doing or
72 /// recording any target specific work, or return true and do nothing if the
73 /// directive is not target specific. If the directive is specific for
74 /// the target, the entire line is parsed up to and including the
75 /// end-of-statement token and false is returned.
77 /// \param DirectiveID - the identifier token of the directive.
78 virtual bool ParseDirective(AsmToken DirectiveID) = 0;
80 /// MatchAndEmitInstruction - Recognize a series of operands of a parsed
81 /// instruction as an actual MCInst and emit it to the specified MCStreamer.
82 /// This returns false on success and returns true on failure to match.
84 /// On failure, the target parser is responsible for emitting a diagnostic
85 /// explaining the match failure.
87 MatchAndEmitInstruction(SMLoc IDLoc,
88 SmallVectorImpl<MCParsedAsmOperand*> &Operands,
93 } // End llvm namespace