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"
23 /// MCExpr - Base class for the full range of assembler expressions which are
24 /// needed for parsing.
28 Binary, ///< Binary expressions.
29 Constant, ///< Constant expressions.
30 SymbolRef, ///< References to labels and assigned expressions.
31 Unary ///< Unary expressions.
37 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
38 void operator=(const MCExpr&); // DO NOT IMPLEMENT
41 MCExpr(ExprKind _Kind) : Kind(_Kind) {}
47 ExprKind getKind() const { return Kind; }
50 /// @name Utility Methods
53 void print(raw_ostream &OS, const MCAsmInfo *MAI) const;
57 /// @name Expression Evaluation
60 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
62 /// @param Res - The absolute value, if evaluation succeeds.
63 /// @result - True on success.
64 bool EvaluateAsAbsolute(MCContext &Ctx, int64_t &Res) const;
66 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
67 /// value, i.e. an expression of the fixed form (a - b + constant).
69 /// @param Res - The relocatable value, if evaluation succeeds.
70 /// @result - True on success.
71 bool EvaluateAsRelocatable(MCContext &Ctx, MCValue &Res) const;
75 static bool classof(const MCExpr *) { return true; }
78 //// MCConstantExpr - Represent a constant integer expression.
79 class MCConstantExpr : public MCExpr {
82 MCConstantExpr(int64_t _Value)
83 : MCExpr(MCExpr::Constant), Value(_Value) {}
86 /// @name Construction
89 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
95 int64_t getValue() const { return Value; }
99 static bool classof(const MCExpr *E) {
100 return E->getKind() == MCExpr::Constant;
102 static bool classof(const MCConstantExpr *) { return true; }
105 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
108 /// A symbol reference in an expression may be a use of a label, a use of an
109 /// assembler variable (defined constant), or constitute an implicit definition
110 /// of the symbol as external.
111 class MCSymbolRefExpr : public MCExpr {
112 const MCSymbol *Symbol;
114 MCSymbolRefExpr(const MCSymbol *_Symbol)
115 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol) {}
118 /// @name Construction
121 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx);
127 const MCSymbol &getSymbol() const { return *Symbol; }
131 static bool classof(const MCExpr *E) {
132 return E->getKind() == MCExpr::SymbolRef;
134 static bool classof(const MCSymbolRefExpr *) { return true; }
137 /// MCUnaryExpr - Unary assembler expressions.
138 class MCUnaryExpr : public MCExpr {
141 LNot, ///< Logical negation.
142 Minus, ///< Unary minus.
143 Not, ///< Bitwise negation.
144 Plus ///< Unary plus.
151 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
152 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
155 /// @name Construction
158 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
160 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
161 return Create(LNot, Expr, Ctx);
163 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
164 return Create(Minus, Expr, Ctx);
166 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
167 return Create(Not, Expr, Ctx);
169 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
170 return Create(Plus, Expr, Ctx);
177 /// getOpcode - Get the kind of this unary expression.
178 Opcode getOpcode() const { return Op; }
180 /// getSubExpr - Get the child of this unary expression.
181 const MCExpr *getSubExpr() const { return Expr; }
185 static bool classof(const MCExpr *E) {
186 return E->getKind() == MCExpr::Unary;
188 static bool classof(const MCUnaryExpr *) { return true; }
191 /// MCBinaryExpr - Binary assembler expressions.
192 class MCBinaryExpr : public MCExpr {
196 And, ///< Bitwise and.
198 EQ, ///< Equality comparison.
199 GT, ///< Greater than comparison.
200 GTE, ///< Greater than or equal comparison.
201 LAnd, ///< Logical and.
202 LOr, ///< Logical or.
203 LT, ///< Less than comparison.
204 LTE, ///< Less than or equal comparison.
206 Mul, ///< Multiplication.
207 NE, ///< Inequality comparison.
209 Shl, ///< Bitwise shift left.
210 Shr, ///< Bitwise shift right.
211 Sub, ///< Subtraction.
212 Xor ///< Bitwise exclusive or.
217 const MCExpr *LHS, *RHS;
219 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
220 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
223 /// @name Construction
226 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
227 const MCExpr *RHS, MCContext &Ctx);
228 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
230 return Create(Add, LHS, RHS, Ctx);
232 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
234 return Create(And, LHS, RHS, Ctx);
236 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
238 return Create(Div, LHS, RHS, Ctx);
240 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
242 return Create(EQ, LHS, RHS, Ctx);
244 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
246 return Create(GT, LHS, RHS, Ctx);
248 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
250 return Create(GTE, LHS, RHS, Ctx);
252 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
254 return Create(LAnd, LHS, RHS, Ctx);
256 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
258 return Create(LOr, LHS, RHS, Ctx);
260 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
262 return Create(LT, LHS, RHS, Ctx);
264 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
266 return Create(LTE, LHS, RHS, Ctx);
268 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
270 return Create(Mod, LHS, RHS, Ctx);
272 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
274 return Create(Mul, LHS, RHS, Ctx);
276 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
278 return Create(NE, LHS, RHS, Ctx);
280 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
282 return Create(Or, LHS, RHS, Ctx);
284 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
286 return Create(Shl, LHS, RHS, Ctx);
288 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
290 return Create(Shr, LHS, RHS, Ctx);
292 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
294 return Create(Sub, LHS, RHS, Ctx);
296 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
298 return Create(Xor, LHS, RHS, Ctx);
305 /// getOpcode - Get the kind of this binary expression.
306 Opcode getOpcode() const { return Op; }
308 /// getLHS - Get the left-hand side expression of the binary operator.
309 const MCExpr *getLHS() const { return LHS; }
311 /// getRHS - Get the right-hand side expression of the binary operator.
312 const MCExpr *getRHS() const { return RHS; }
316 static bool classof(const MCExpr *E) {
317 return E->getKind() == MCExpr::Binary;
319 static bool classof(const MCBinaryExpr *) { return true; }
322 } // end namespace llvm