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"
24 /// MCExpr - Base class for the full range of assembler expressions which are
25 /// needed for parsing.
29 Binary, ///< Binary expressions.
30 Constant, ///< Constant expressions.
31 SymbolRef, ///< References to labels and assigned expressions.
32 Unary ///< Unary expressions.
38 MCExpr(const MCExpr&); // DO NOT IMPLEMENT
39 void operator=(const MCExpr&); // DO NOT IMPLEMENT
42 MCExpr(ExprKind _Kind) : Kind(_Kind) {}
48 ExprKind getKind() const { return Kind; }
51 /// @name Utility Methods
54 void print(raw_ostream &OS, const MCAsmInfo *MAI) const;
58 /// @name Expression Evaluation
61 /// EvaluateAsAbsolute - Try to evaluate the expression to an absolute value.
63 /// @param Res - The absolute value, if evaluation succeeds.
64 /// @result - True on success.
65 bool EvaluateAsAbsolute(int64_t &Res) const;
67 /// EvaluateAsRelocatable - Try to evaluate the expression to a relocatable
68 /// value, i.e. an expression of the fixed form (a - b + constant).
70 /// @param Res - The relocatable value, if evaluation succeeds.
71 /// @result - True on success.
72 bool EvaluateAsRelocatable(MCValue &Res) const;
76 static bool classof(const MCExpr *) { return true; }
79 //// MCConstantExpr - Represent a constant integer expression.
80 class MCConstantExpr : public MCExpr {
83 MCConstantExpr(int64_t _Value)
84 : MCExpr(MCExpr::Constant), Value(_Value) {}
87 /// @name Construction
90 static const MCConstantExpr *Create(int64_t Value, MCContext &Ctx);
96 int64_t getValue() const { return Value; }
100 static bool classof(const MCExpr *E) {
101 return E->getKind() == MCExpr::Constant;
103 static bool classof(const MCConstantExpr *) { return true; }
106 /// MCSymbolRefExpr - Represent a reference to a symbol from inside an
109 /// A symbol reference in an expression may be a use of a label, a use of an
110 /// assembler variable (defined constant), or constitute an implicit definition
111 /// of the symbol as external.
112 class MCSymbolRefExpr : public MCExpr {
113 const MCSymbol *Symbol;
115 MCSymbolRefExpr(const MCSymbol *_Symbol)
116 : MCExpr(MCExpr::SymbolRef), Symbol(_Symbol) {}
119 /// @name Construction
122 static const MCSymbolRefExpr *Create(const MCSymbol *Symbol, MCContext &Ctx);
123 static const MCSymbolRefExpr *Create(const StringRef &Name, MCContext &Ctx);
131 const MCSymbol &getSymbol() const { return *Symbol; }
135 static bool classof(const MCExpr *E) {
136 return E->getKind() == MCExpr::SymbolRef;
138 static bool classof(const MCSymbolRefExpr *) { return true; }
141 /// MCUnaryExpr - Unary assembler expressions.
142 class MCUnaryExpr : public MCExpr {
145 LNot, ///< Logical negation.
146 Minus, ///< Unary minus.
147 Not, ///< Bitwise negation.
148 Plus ///< Unary plus.
155 MCUnaryExpr(Opcode _Op, const MCExpr *_Expr)
156 : MCExpr(MCExpr::Unary), Op(_Op), Expr(_Expr) {}
159 /// @name Construction
162 static const MCUnaryExpr *Create(Opcode Op, const MCExpr *Expr,
164 static const MCUnaryExpr *CreateLNot(const MCExpr *Expr, MCContext &Ctx) {
165 return Create(LNot, Expr, Ctx);
167 static const MCUnaryExpr *CreateMinus(const MCExpr *Expr, MCContext &Ctx) {
168 return Create(Minus, Expr, Ctx);
170 static const MCUnaryExpr *CreateNot(const MCExpr *Expr, MCContext &Ctx) {
171 return Create(Not, Expr, Ctx);
173 static const MCUnaryExpr *CreatePlus(const MCExpr *Expr, MCContext &Ctx) {
174 return Create(Plus, Expr, Ctx);
181 /// getOpcode - Get the kind of this unary expression.
182 Opcode getOpcode() const { return Op; }
184 /// getSubExpr - Get the child of this unary expression.
185 const MCExpr *getSubExpr() const { return Expr; }
189 static bool classof(const MCExpr *E) {
190 return E->getKind() == MCExpr::Unary;
192 static bool classof(const MCUnaryExpr *) { return true; }
195 /// MCBinaryExpr - Binary assembler expressions.
196 class MCBinaryExpr : public MCExpr {
200 And, ///< Bitwise and.
202 EQ, ///< Equality comparison.
203 GT, ///< Greater than comparison.
204 GTE, ///< Greater than or equal comparison.
205 LAnd, ///< Logical and.
206 LOr, ///< Logical or.
207 LT, ///< Less than comparison.
208 LTE, ///< Less than or equal comparison.
210 Mul, ///< Multiplication.
211 NE, ///< Inequality comparison.
213 Shl, ///< Bitwise shift left.
214 Shr, ///< Bitwise shift right.
215 Sub, ///< Subtraction.
216 Xor ///< Bitwise exclusive or.
221 const MCExpr *LHS, *RHS;
223 MCBinaryExpr(Opcode _Op, const MCExpr *_LHS, const MCExpr *_RHS)
224 : MCExpr(MCExpr::Binary), Op(_Op), LHS(_LHS), RHS(_RHS) {}
227 /// @name Construction
230 static const MCBinaryExpr *Create(Opcode Op, const MCExpr *LHS,
231 const MCExpr *RHS, MCContext &Ctx);
232 static const MCBinaryExpr *CreateAdd(const MCExpr *LHS, const MCExpr *RHS,
234 return Create(Add, LHS, RHS, Ctx);
236 static const MCBinaryExpr *CreateAnd(const MCExpr *LHS, const MCExpr *RHS,
238 return Create(And, LHS, RHS, Ctx);
240 static const MCBinaryExpr *CreateDiv(const MCExpr *LHS, const MCExpr *RHS,
242 return Create(Div, LHS, RHS, Ctx);
244 static const MCBinaryExpr *CreateEQ(const MCExpr *LHS, const MCExpr *RHS,
246 return Create(EQ, LHS, RHS, Ctx);
248 static const MCBinaryExpr *CreateGT(const MCExpr *LHS, const MCExpr *RHS,
250 return Create(GT, LHS, RHS, Ctx);
252 static const MCBinaryExpr *CreateGTE(const MCExpr *LHS, const MCExpr *RHS,
254 return Create(GTE, LHS, RHS, Ctx);
256 static const MCBinaryExpr *CreateLAnd(const MCExpr *LHS, const MCExpr *RHS,
258 return Create(LAnd, LHS, RHS, Ctx);
260 static const MCBinaryExpr *CreateLOr(const MCExpr *LHS, const MCExpr *RHS,
262 return Create(LOr, LHS, RHS, Ctx);
264 static const MCBinaryExpr *CreateLT(const MCExpr *LHS, const MCExpr *RHS,
266 return Create(LT, LHS, RHS, Ctx);
268 static const MCBinaryExpr *CreateLTE(const MCExpr *LHS, const MCExpr *RHS,
270 return Create(LTE, LHS, RHS, Ctx);
272 static const MCBinaryExpr *CreateMod(const MCExpr *LHS, const MCExpr *RHS,
274 return Create(Mod, LHS, RHS, Ctx);
276 static const MCBinaryExpr *CreateMul(const MCExpr *LHS, const MCExpr *RHS,
278 return Create(Mul, LHS, RHS, Ctx);
280 static const MCBinaryExpr *CreateNE(const MCExpr *LHS, const MCExpr *RHS,
282 return Create(NE, LHS, RHS, Ctx);
284 static const MCBinaryExpr *CreateOr(const MCExpr *LHS, const MCExpr *RHS,
286 return Create(Or, LHS, RHS, Ctx);
288 static const MCBinaryExpr *CreateShl(const MCExpr *LHS, const MCExpr *RHS,
290 return Create(Shl, LHS, RHS, Ctx);
292 static const MCBinaryExpr *CreateShr(const MCExpr *LHS, const MCExpr *RHS,
294 return Create(Shr, LHS, RHS, Ctx);
296 static const MCBinaryExpr *CreateSub(const MCExpr *LHS, const MCExpr *RHS,
298 return Create(Sub, LHS, RHS, Ctx);
300 static const MCBinaryExpr *CreateXor(const MCExpr *LHS, const MCExpr *RHS,
302 return Create(Xor, LHS, RHS, Ctx);
309 /// getOpcode - Get the kind of this binary expression.
310 Opcode getOpcode() const { return Op; }
312 /// getLHS - Get the left-hand side expression of the binary operator.
313 const MCExpr *getLHS() const { return LHS; }
315 /// getRHS - Get the right-hand side expression of the binary operator.
316 const MCExpr *getRHS() const { return RHS; }
320 static bool classof(const MCExpr *E) {
321 return E->getKind() == MCExpr::Binary;
323 static bool classof(const MCBinaryExpr *) { return true; }
326 } // end namespace llvm