1 //===- MCExpr.h - Assembly Level Expressions --------------------*- 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_MCEXPR_H
11 #define LLVM_MC_MCEXPR_H
13 #include "llvm/Support/Casting.h"
14 #include "llvm/Support/DataTypes.h"
21 /// MCExpr - Base class for the full range of assembler expressions which are
22 /// needed for parsing.
26 Binary, ///< Binary expressions.
27 Constant, ///< Constant expressions.
28 SymbolRef, ///< References to labels and assigned expressions.
29 Unary ///< Unary expressions.
35 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
36 void operator=(const MCExpr&); // DO NOT IMPLEMENT
39 MCExpr(ExprKind _Kind) : Kind(_Kind) {}
45 ExprKind getKind() const { return Kind; }
48 /// @name Expression Evaluation
51 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
53 /// @param Res - The absolute value, if evaluation succeeds.
54 /// @result - True on success.
55 bool EvaluateAsAbsolute(MCContext &Ctx, int64_t &Res) const;
57 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
58 /// value, i.e. an expression of the fixed form (a - b + constant).
60 /// @param Res - The relocatable value, if evaluation succeeds.
61 /// @result - True on success.
62 bool EvaluateAsRelocatable(MCContext &Ctx, MCValue &Res) const;
66 static bool classof(const MCExpr *) { return true; }
69 //// MCConstantExpr - Represent a constant integer expression.
70 class MCConstantExpr : public MCExpr {
73 MCConstantExpr(int64_t _Value)
74 : MCExpr(MCExpr::Constant), Value(_Value) {}
77 /// @name Construction
80 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
86 int64_t getValue() const { return Value; }
90 static bool classof(const MCExpr *E) {
91 return E->getKind() == MCExpr::Constant;
93 static bool classof(const MCConstantExpr *) { return true; }
96 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
99 /// A symbol reference in an expression may be a use of a label, a use of an
100 /// assembler variable (defined constant), or constitute an implicit definition
101 /// of the symbol as external.
102 class MCSymbolRefExpr : public MCExpr {
103 const MCSymbol *Symbol;
105 MCSymbolRefExpr(const MCSymbol *_Symbol)
106 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol) {}
109 /// @name Construction
112 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx);
118 const MCSymbol &getSymbol() const { return *Symbol; }
122 static bool classof(const MCExpr *E) {
123 return E->getKind() == MCExpr::SymbolRef;
125 static bool classof(const MCSymbolRefExpr *) { return true; }
128 /// MCUnaryExpr - Unary assembler expressions.
129 class MCUnaryExpr : public MCExpr {
132 LNot, ///< Logical negation.
133 Minus, ///< Unary minus.
134 Not, ///< Bitwise negation.
135 Plus ///< Unary plus.
142 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
143 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
146 /// @name Construction
149 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
151 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
152 return Create(LNot, Expr, Ctx);
154 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
155 return Create(Minus, Expr, Ctx);
157 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
158 return Create(Not, Expr, Ctx);
160 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
161 return Create(Plus, Expr, Ctx);
168 /// getOpcode - Get the kind of this unary expression.
169 Opcode getOpcode() const { return Op; }
171 /// getSubExpr - Get the child of this unary expression.
172 const MCExpr *getSubExpr() const { return Expr; }
176 static bool classof(const MCExpr *E) {
177 return E->getKind() == MCExpr::Unary;
179 static bool classof(const MCUnaryExpr *) { return true; }
182 /// MCBinaryExpr - Binary assembler expressions.
183 class MCBinaryExpr : public MCExpr {
187 And, ///< Bitwise and.
189 EQ, ///< Equality comparison.
190 GT, ///< Greater than comparison.
191 GTE, ///< Greater than or equal comparison.
192 LAnd, ///< Logical and.
193 LOr, ///< Logical or.
194 LT, ///< Less than comparison.
195 LTE, ///< Less than or equal comparison.
197 Mul, ///< Multiplication.
198 NE, ///< Inequality comparison.
200 Shl, ///< Bitwise shift left.
201 Shr, ///< Bitwise shift right.
202 Sub, ///< Subtraction.
203 Xor ///< Bitwise exclusive or.
208 const MCExpr *LHS, *RHS;
210 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
211 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
214 /// @name Construction
217 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
218 const MCExpr *RHS, MCContext &Ctx);
219 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
221 return Create(Add, LHS, RHS, Ctx);
223 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
225 return Create(And, LHS, RHS, Ctx);
227 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
229 return Create(Div, LHS, RHS, Ctx);
231 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
233 return Create(EQ, LHS, RHS, Ctx);
235 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
237 return Create(GT, LHS, RHS, Ctx);
239 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
241 return Create(GTE, LHS, RHS, Ctx);
243 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
245 return Create(LAnd, LHS, RHS, Ctx);
247 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
249 return Create(LOr, LHS, RHS, Ctx);
251 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
253 return Create(LT, LHS, RHS, Ctx);
255 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
257 return Create(LTE, LHS, RHS, Ctx);
259 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
261 return Create(Mod, LHS, RHS, Ctx);
263 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
265 return Create(Mul, LHS, RHS, Ctx);
267 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
269 return Create(NE, LHS, RHS, Ctx);
271 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
273 return Create(Or, LHS, RHS, Ctx);
275 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
277 return Create(Shl, LHS, RHS, Ctx);
279 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
281 return Create(Shr, LHS, RHS, Ctx);
283 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
285 return Create(Sub, LHS, RHS, Ctx);
287 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
289 return Create(Xor, LHS, RHS, Ctx);
296 /// getOpcode - Get the kind of this binary expression.
297 Opcode getOpcode() const { return Op; }
299 /// getLHS - Get the left-hand side expression of the binary operator.
300 const MCExpr *getLHS() const { return LHS; }
302 /// getRHS - Get the right-hand side expression of the binary operator.
303 const MCExpr *getRHS() const { return RHS; }
307 static bool classof(const MCExpr *E) {
308 return E->getKind() == MCExpr::Binary;
310 static bool classof(const MCBinaryExpr *) { return true; }
313 } // end namespace llvm