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;
25 AOK_DotOperator, // Rewrite a dot operator expression as an immediate.
26 // E.g., [eax].foo.bar -> [eax].8
27 AOK_Emit, // Rewrite _emit as .byte.
28 AOK_Imm, // Rewrite as $$N.
29 AOK_ImmPrefix, // Add $$ before a parsed Imm.
30 AOK_Input, // Rewrite in terms of $N.
31 AOK_Output, // Rewrite in terms of $N.
32 AOK_SizeDirective, // Add a sizing directive (e.g., dword ptr).
33 AOK_Skip // Skip emission (e.g., offset/type operators).
42 AsmRewrite(AsmRewriteKind kind, SMLoc loc, unsigned len = 0, unsigned val = 0)
43 : Kind(kind), Loc(loc), Len(len), Val(val) {}
46 struct ParseInstructionInfo {
48 SmallVectorImpl<AsmRewrite> *AsmRewrites;
50 ParseInstructionInfo() : AsmRewrites(0) {}
51 ParseInstructionInfo(SmallVectorImpl<AsmRewrite> *rewrites)
52 : AsmRewrites(rewrites) {}
54 ~ParseInstructionInfo() {}
57 /// MCTargetAsmParser - Generic interface to target specific assembly parsers.
58 class MCTargetAsmParser : public MCAsmParserExtension {
65 FIRST_TARGET_MATCH_RESULT_TY
69 MCTargetAsmParser(const MCTargetAsmParser &) LLVM_DELETED_FUNCTION;
70 void operator=(const MCTargetAsmParser &) LLVM_DELETED_FUNCTION;
71 protected: // Can only create subclasses.
74 /// AvailableFeatures - The current set of available features.
75 unsigned AvailableFeatures;
77 /// ParsingInlineAsm - Are we parsing ms-style inline assembly?
78 bool ParsingInlineAsm;
80 /// SemaCallback - The Sema callback implementation. Must be set when parsing
81 /// ms-style inline assembly.
82 MCAsmParserSemaCallback *SemaCallback;
85 virtual ~MCTargetAsmParser();
87 unsigned getAvailableFeatures() const { return AvailableFeatures; }
88 void setAvailableFeatures(unsigned Value) { AvailableFeatures = Value; }
90 bool isParsingInlineAsm () { return ParsingInlineAsm; }
91 void setParsingInlineAsm (bool Value) { ParsingInlineAsm = Value; }
93 void setSemaCallback(MCAsmParserSemaCallback *Callback) {
94 SemaCallback = Callback;
97 virtual bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc,
100 /// ParseInstruction - Parse one assembly instruction.
102 /// The parser is positioned following the instruction name. The target
103 /// specific instruction parser should parse the entire instruction and
104 /// construct the appropriate MCInst, or emit an error. On success, the entire
105 /// line should be parsed up to and including the end-of-statement token. On
106 /// failure, the parser is not required to read to the end of the line.
108 /// \param Name - The instruction name.
109 /// \param NameLoc - The source location of the name.
110 /// \param Operands [out] - The list of parsed operands, this returns
111 /// ownership of them to the caller.
112 /// \return True on failure.
113 virtual bool ParseInstruction(ParseInstructionInfo &Info, StringRef Name,
115 SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
117 /// ParseDirective - Parse a target specific assembler directive
119 /// The parser is positioned following the directive name. The target
120 /// specific directive parser should parse the entire directive doing or
121 /// recording any target specific work, or return true and do nothing if the
122 /// directive is not target specific. If the directive is specific for
123 /// the target, the entire line is parsed up to and including the
124 /// end-of-statement token and false is returned.
126 /// \param DirectiveID - the identifier token of the directive.
127 virtual bool ParseDirective(AsmToken DirectiveID) = 0;
129 /// mnemonicIsValid - This returns true if this is a valid mnemonic and false
131 virtual bool mnemonicIsValid(StringRef Mnemonic) = 0;
133 /// MatchAndEmitInstruction - Recognize a series of operands of a parsed
134 /// instruction as an actual MCInst and emit it to the specified MCStreamer.
135 /// This returns false on success and returns true on failure to match.
137 /// On failure, the target parser is responsible for emitting a diagnostic
138 /// explaining the match failure.
140 MatchAndEmitInstruction(SMLoc IDLoc, unsigned &Opcode,
141 SmallVectorImpl<MCParsedAsmOperand*> &Operands,
142 MCStreamer &Out, unsigned &ErrorInfo,
143 bool MatchingInlineAsm) = 0;
145 /// checkTargetMatchPredicate - Validate the instruction match against
146 /// any complex target predicates not expressible via match classes.
147 virtual unsigned checkTargetMatchPredicate(MCInst &Inst) {
148 return Match_Success;
151 virtual void convertToMapAndConstraints(unsigned Kind,
152 const SmallVectorImpl<MCParsedAsmOperand*> &Operands) = 0;
155 } // End llvm namespace