1 //===- OperationKinds.h - Operation enums -----------------------*- 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 // This file enumerates the different kinds of operations that can be
11 // performed by various expressions.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_AST_OPERATION_KINDS_H
16 #define LLVM_CLANG_AST_OPERATION_KINDS_H
20 /// CastKind - The kind of operation required for a conversion.
22 /// CK_Dependent - A conversion which cannot yet be analyzed because
23 /// either the expression or target type is dependent. These are
24 /// created only for explicit casts; dependent ASTs aren't required
25 /// to even approximately type-check.
26 /// (T*) malloc(sizeof(T))
27 /// reinterpret_cast<intptr_t>(A<T>::alloc());
30 /// CK_BitCast - A conversion which causes a bit pattern of one type
31 /// to be reinterpreted as a bit pattern of another type. Generally
32 /// the operands must have equivalent size and unrelated types.
34 /// The pointer conversion char* -> int* is a bitcast. Many other
35 /// pointer conversions which are "physically" bitcasts are given
36 /// special cast kinds.
38 /// Vector coercions are bitcasts.
41 /// CK_LValueBitCast - A conversion which reinterprets the address of
42 /// an l-value as an l-value of a different kind. Used for
43 /// reinterpret_casts of l-value expressions to reference types.
44 /// bool b; reinterpret_cast<char&>(b) = 'a';
47 /// CK_LValueToRValue - A conversion which causes the extraction of
48 /// an r-value from the operand gl-value. The result of an r-value
49 /// conversion is always unqualified.
52 /// CK_GetObjCProperty - A conversion which calls an Objective-C
53 /// property getter. The operand is an OK_ObjCProperty l-value; the
54 /// result will generally be an r-value, but could be an ordinary
55 /// gl-value if the property reference is to an implicit property
56 /// for a method that returns a reference type.
59 /// CK_NoOp - A conversion which does not affect the type other than
60 /// (possibly) adding qualifiers.
62 /// char** -> const char * const *
65 /// CK_BaseToDerived - A conversion from a C++ class pointer/reference
66 /// to a derived class pointer/reference.
67 /// B *b = static_cast<B*>(a);
70 /// CK_DerivedToBase - A conversion from a C++ class pointer
71 /// to a base class pointer.
75 /// CK_UncheckedDerivedToBase - A conversion from a C++ class
76 /// pointer/reference to a base class that can assume that the
77 /// derived pointer is not null.
79 /// b->method_from_a();
80 CK_UncheckedDerivedToBase,
82 /// CK_Dynamic - A C++ dynamic_cast.
85 /// CK_ToUnion - The GCC cast-to-union extension.
86 /// int -> union { int x; float y; }
87 /// float -> union { int x; float y; }
90 /// CK_ArrayToPointerDecay - Array to pointer decay.
92 /// char[5][6] -> char(*)[6]
93 CK_ArrayToPointerDecay,
95 /// CK_FunctionToPointerDecay - Function to pointer decay.
96 /// void(int) -> void(*)(int)
97 CK_FunctionToPointerDecay,
99 /// CK_NullToPointer - Null pointer constant to pointer, ObjC
100 /// pointer, or block pointer.
102 /// void (^block)() = 0;
105 /// CK_NullToMemberPointer - Null pointer constant to member pointer.
106 /// int A::*mptr = 0;
107 /// int (A::*fptr)(int) = nullptr;
108 CK_NullToMemberPointer,
110 /// CK_BaseToDerivedMemberPointer - Member pointer in base class to
111 /// member pointer in derived class.
112 /// int B::*mptr = &A::member;
113 CK_BaseToDerivedMemberPointer,
115 /// CK_DerivedToBaseMemberPointer - Member pointer in derived class to
116 /// member pointer in base class.
117 /// int A::*mptr = static_cast<int A::*>(&B::member);
118 CK_DerivedToBaseMemberPointer,
120 /// CK_MemberPointerToBoolean - Member pointer to boolean. A check
121 /// against the null member pointer.
122 CK_MemberPointerToBoolean,
124 /// CK_UserDefinedConversion - Conversion using a user defined type
125 /// conversion function.
126 /// struct A { operator int(); }; int i = int(A());
127 CK_UserDefinedConversion,
129 /// CK_ConstructorConversion - Conversion by constructor.
130 /// struct A { A(int); }; A a = A(10);
131 CK_ConstructorConversion,
133 /// CK_IntegralToPointer - Integral to pointer. A special kind of
134 /// reinterpreting conversion. Applies to normal, ObjC, and block
136 /// (char*) 0x1001aab0
137 /// reinterpret_cast<int*>(0)
138 CK_IntegralToPointer,
140 /// CK_PointerToIntegral - Pointer to integral. A special kind of
141 /// reinterpreting conversion. Applies to normal, ObjC, and block
143 /// (intptr_t) "help!"
144 CK_PointerToIntegral,
146 /// CK_PointerToBoolean - Pointer to boolean conversion. A check
147 /// against null. Applies to normal, ObjC, and block pointers.
150 /// CK_ToVoid - Cast to void, discarding the computed value.
151 /// (void) malloc(2048)
154 /// CK_VectorSplat - A conversion from an arithmetic type to a
155 /// vector of that element type. Fills all elements ("splats") with
156 /// the source value.
157 /// __attribute__((ext_vector_type(4))) int v = 5;
160 /// CK_IntegralCast - A cast between integral types (other than to
161 /// boolean). Variously a bitcast, a truncation, a sign-extension,
162 /// or a zero-extension.
167 /// CK_IntegralToBoolean - Integral to boolean. A check against zero.
169 CK_IntegralToBoolean,
171 /// CK_IntegralToFloating - Integral to floating point.
173 CK_IntegralToFloating,
175 /// CK_FloatingToIntegral - Floating point to integral. Rounds
176 /// towards zero, discarding any fractional component.
178 CK_FloatingToIntegral,
180 /// CK_FloatingToBoolean - Floating point to boolean.
182 CK_FloatingToBoolean,
184 /// CK_FloatingCast - Casting between floating types of different size.
189 /// CK_AnyPointerToObjCPointerCast - Casting any other pointer kind
190 /// to an Objective-C pointer.
191 CK_AnyPointerToObjCPointerCast,
193 /// CK_AnyPointerToBlockPointerCast - Casting any other pointer kind
194 /// to a block pointer.
195 CK_AnyPointerToBlockPointerCast,
197 /// \brief Converting between two Objective-C object types, which
198 /// can occur when performing reference binding to an Objective-C
200 CK_ObjCObjectLValueCast,
202 /// \brief A conversion of a floating point real to a floating point
203 /// complex of the original type. Injects the value as the real
204 /// component with a zero imaginary component.
205 /// float -> _Complex float
206 CK_FloatingRealToComplex,
208 /// \brief Converts a floating point complex to floating point real
209 /// of the source's element type. Just discards the imaginary
211 /// _Complex long double -> long double
212 CK_FloatingComplexToReal,
214 /// \brief Converts a floating point complex to bool by comparing
216 CK_FloatingComplexToBoolean,
218 /// \brief Converts between different floating point complex types.
219 /// _Complex float -> _Complex double
220 CK_FloatingComplexCast,
222 /// \brief Converts from a floating complex to an integral complex.
223 /// _Complex float -> _Complex int
224 CK_FloatingComplexToIntegralComplex,
226 /// \brief Converts from an integral real to an integral complex
227 /// whose element type matches the source. Injects the value as
228 /// the real component with a zero imaginary component.
229 /// long -> _Complex long
230 CK_IntegralRealToComplex,
232 /// \brief Converts an integral complex to an integral real of the
233 /// source's element type by discarding the imaginary component.
234 /// _Complex short -> short
235 CK_IntegralComplexToReal,
237 /// \brief Converts an integral complex to bool by comparing against
239 CK_IntegralComplexToBoolean,
241 /// \brief Converts between different integral complex types.
242 /// _Complex char -> _Complex long long
243 /// _Complex unsigned int -> _Complex signed int
244 CK_IntegralComplexCast,
246 /// \brief Converts from an integral complex to a floating complex.
247 /// _Complex unsigned -> _Complex float
248 CK_IntegralComplexToFloatingComplex,
250 /// \brief Assign an unknown-any declaration a type.
251 CK_ResolveUnknownAnyType,
253 /// \brief Assign an unknown-any declaration a reference type.
254 CK_ResolveUnknownAnyTypeToReference
257 #define CK_Invalid ((CastKind) -1)
259 enum BinaryOperatorKind {
260 // Operators listed in order of precedence.
261 // Note that additions to this should also update the StmtVisitor class.
262 BO_PtrMemD, BO_PtrMemI, // [C++ 5.5] Pointer-to-member operators.
263 BO_Mul, BO_Div, BO_Rem, // [C99 6.5.5] Multiplicative operators.
264 BO_Add, BO_Sub, // [C99 6.5.6] Additive operators.
265 BO_Shl, BO_Shr, // [C99 6.5.7] Bitwise shift operators.
266 BO_LT, BO_GT, BO_LE, BO_GE, // [C99 6.5.8] Relational operators.
267 BO_EQ, BO_NE, // [C99 6.5.9] Equality operators.
268 BO_And, // [C99 6.5.10] Bitwise AND operator.
269 BO_Xor, // [C99 6.5.11] Bitwise XOR operator.
270 BO_Or, // [C99 6.5.12] Bitwise OR operator.
271 BO_LAnd, // [C99 6.5.13] Logical AND operator.
272 BO_LOr, // [C99 6.5.14] Logical OR operator.
273 BO_Assign, BO_MulAssign, // [C99 6.5.16] Assignment operators.
274 BO_DivAssign, BO_RemAssign,
275 BO_AddAssign, BO_SubAssign,
276 BO_ShlAssign, BO_ShrAssign,
277 BO_AndAssign, BO_XorAssign,
279 BO_Comma // [C99 6.5.17] Comma operator.
282 enum UnaryOperatorKind {
283 // Note that additions to this should also update the StmtVisitor class.
284 UO_PostInc, UO_PostDec, // [C99 6.5.2.4] Postfix increment and decrement
285 UO_PreInc, UO_PreDec, // [C99 6.5.3.1] Prefix increment and decrement
286 UO_AddrOf, UO_Deref, // [C99 6.5.3.2] Address and indirection
287 UO_Plus, UO_Minus, // [C99 6.5.3.3] Unary arithmetic
288 UO_Not, UO_LNot, // [C99 6.5.3.3] Unary arithmetic
289 UO_Real, UO_Imag, // "__real expr"/"__imag expr" Extension.
290 UO_Extension // __extension__ marker.