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"
22 /// MCExpr - Base class for the full range of assembler expressions which are
23 /// needed for parsing.
27 Binary, ///< Binary expressions.
28 Constant, ///< Constant expressions.
29 SymbolRef, ///< References to labels and assigned expressions.
30 Unary ///< Unary expressions.
36 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
37 void operator=(const MCExpr&); // DO NOT IMPLEMENT
40 MCExpr(ExprKind _Kind) : Kind(_Kind) {}
46 ExprKind getKind() const { return Kind; }
49 /// @name Utility Methods
52 void print(raw_ostream &OS) const;
56 /// @name Expression Evaluation
59 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
61 /// @param Res - The absolute value, if evaluation succeeds.
62 /// @result - True on success.
63 bool EvaluateAsAbsolute(MCContext &Ctx, int64_t &Res) const;
65 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
66 /// value, i.e. an expression of the fixed form (a - b + constant).
68 /// @param Res - The relocatable value, if evaluation succeeds.
69 /// @result - True on success.
70 bool EvaluateAsRelocatable(MCContext &Ctx, MCValue &Res) const;
74 static bool classof(const MCExpr *) { return true; }
77 //// MCConstantExpr - Represent a constant integer expression.
78 class MCConstantExpr : public MCExpr {
81 MCConstantExpr(int64_t _Value)
82 : MCExpr(MCExpr::Constant), Value(_Value) {}
85 /// @name Construction
88 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
94 int64_t getValue() const { return Value; }
98 static bool classof(const MCExpr *E) {
99 return E->getKind() == MCExpr::Constant;
101 static bool classof(const MCConstantExpr *) { return true; }
104 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
107 /// A symbol reference in an expression may be a use of a label, a use of an
108 /// assembler variable (defined constant), or constitute an implicit definition
109 /// of the symbol as external.
110 class MCSymbolRefExpr : public MCExpr {
111 const MCSymbol *Symbol;
113 MCSymbolRefExpr(const MCSymbol *_Symbol)
114 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol) {}
117 /// @name Construction
120 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx);
126 const MCSymbol &getSymbol() const { return *Symbol; }
130 static bool classof(const MCExpr *E) {
131 return E->getKind() == MCExpr::SymbolRef;
133 static bool classof(const MCSymbolRefExpr *) { return true; }
136 /// MCUnaryExpr - Unary assembler expressions.
137 class MCUnaryExpr : public MCExpr {
140 LNot, ///< Logical negation.
141 Minus, ///< Unary minus.
142 Not, ///< Bitwise negation.
143 Plus ///< Unary plus.
150 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
151 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
154 /// @name Construction
157 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
159 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
160 return Create(LNot, Expr, Ctx);
162 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
163 return Create(Minus, Expr, Ctx);
165 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
166 return Create(Not, Expr, Ctx);
168 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
169 return Create(Plus, Expr, Ctx);
176 /// getOpcode - Get the kind of this unary expression.
177 Opcode getOpcode() const { return Op; }
179 /// getSubExpr - Get the child of this unary expression.
180 const MCExpr *getSubExpr() const { return Expr; }
184 static bool classof(const MCExpr *E) {
185 return E->getKind() == MCExpr::Unary;
187 static bool classof(const MCUnaryExpr *) { return true; }
190 /// MCBinaryExpr - Binary assembler expressions.
191 class MCBinaryExpr : public MCExpr {
195 And, ///< Bitwise and.
197 EQ, ///< Equality comparison.
198 GT, ///< Greater than comparison.
199 GTE, ///< Greater than or equal comparison.
200 LAnd, ///< Logical and.
201 LOr, ///< Logical or.
202 LT, ///< Less than comparison.
203 LTE, ///< Less than or equal comparison.
205 Mul, ///< Multiplication.
206 NE, ///< Inequality comparison.
208 Shl, ///< Bitwise shift left.
209 Shr, ///< Bitwise shift right.
210 Sub, ///< Subtraction.
211 Xor ///< Bitwise exclusive or.
216 const MCExpr *LHS, *RHS;
218 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
219 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
222 /// @name Construction
225 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
226 const MCExpr *RHS, MCContext &Ctx);
227 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
229 return Create(Add, LHS, RHS, Ctx);
231 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
233 return Create(And, LHS, RHS, Ctx);
235 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
237 return Create(Div, LHS, RHS, Ctx);
239 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
241 return Create(EQ, LHS, RHS, Ctx);
243 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
245 return Create(GT, LHS, RHS, Ctx);
247 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
249 return Create(GTE, LHS, RHS, Ctx);
251 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
253 return Create(LAnd, LHS, RHS, Ctx);
255 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
257 return Create(LOr, LHS, RHS, Ctx);
259 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
261 return Create(LT, LHS, RHS, Ctx);
263 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
265 return Create(LTE, LHS, RHS, Ctx);
267 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
269 return Create(Mod, LHS, RHS, Ctx);
271 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
273 return Create(Mul, LHS, RHS, Ctx);
275 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
277 return Create(NE, LHS, RHS, Ctx);
279 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
281 return Create(Or, LHS, RHS, Ctx);
283 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
285 return Create(Shl, LHS, RHS, Ctx);
287 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
289 return Create(Shr, LHS, RHS, Ctx);
291 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
293 return Create(Sub, LHS, RHS, Ctx);
295 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
297 return Create(Xor, LHS, RHS, Ctx);
304 /// getOpcode - Get the kind of this binary expression.
305 Opcode getOpcode() const { return Op; }
307 /// getLHS - Get the left-hand side expression of the binary operator.
308 const MCExpr *getLHS() const { return LHS; }
310 /// getRHS - Get the right-hand side expression of the binary operator.
311 const MCExpr *getRHS() const { return RHS; }
315 static bool classof(const MCExpr *E) {
316 return E->getKind() == MCExpr::Binary;
318 static bool classof(const MCBinaryExpr *) { return true; }
321 } // end namespace llvm