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;
22 template <typename T> class SmallVectorImpl;
24 /// MCTargetAsmParser - Generic interface to target specific assembly parsers.
25 class MCTargetAsmParser : public MCAsmParserExtension {
33 FIRST_TARGET_MATCH_RESULT_TY
37 MCTargetAsmParser(const MCTargetAsmParser &); // DO NOT IMPLEMENT
38 void operator=(const MCTargetAsmParser &); // DO NOT IMPLEMENT
39 protected: // Can only create subclasses.
42 /// AvailableFeatures - The current set of available features.
43 unsigned AvailableFeatures;
46 virtual ~MCTargetAsmParser();
48 unsigned getAvailableFeatures() const { return AvailableFeatures; }
49 void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; }
51 virtual bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc,
54 /// ParseInstruction - Parse one assembly instruction.
56 /// The parser is positioned following the instruction name. The target
57 /// specific instruction parser should parse the entire instruction and
58 /// construct the appropriate MCInst, or emit an error. On success, the entire
59 /// line should be parsed up to and including the end-of-statement token. On
60 /// failure, the parser is not required to read to the end of the line.
62 /// \param Name - The instruction name.
63 /// \param NameLoc - The source location of the name.
64 /// \param Operands [out] - The list of parsed operands, this returns
65 /// ownership of them to the caller.
66 /// \return True on failure.
67 virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
68 SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
70 /// ParseDirective - Parse a target specific assembler directive
72 /// The parser is positioned following the directive name. The target
73 /// specific directive parser should parse the entire directive doing or
74 /// recording any target specific work, or return true and do nothing if the
75 /// directive is not target specific. If the directive is specific for
76 /// the target, the entire line is parsed up to and including the
77 /// end-of-statement token and false is returned.
79 /// \param DirectiveID - the identifier token of the directive.
80 virtual bool ParseDirective(AsmToken DirectiveID) = 0;
82 /// MatchAndEmitInstruction - Recognize a series of operands of a parsed
83 /// instruction as an actual MCInst and emit it to the specified MCStreamer.
84 /// This returns false on success and returns true on failure to match.
86 /// On failure, the target parser is responsible for emitting a diagnostic
87 /// explaining the match failure.
89 MatchAndEmitInstruction(SMLoc IDLoc,
90 SmallVectorImpl<MCParsedAsmOperand*> &Operands,
93 /// checkTargetMatchPredicate - Validate the instruction match against
94 /// any complex target predicates not expressible via match classes.
95 virtual unsigned checkTargetMatchPredicate(MCInst &Inst) {
101 } // End llvm namespace