OperationKinds.h revision 7e5e5f4cc36fe50f46ad76dca7a266434c94f475 
1//===- OperationKinds.h - Operation enums -----------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file enumerates the different kinds of operations that can be
11// performed by various expressions.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_AST_OPERATION_KINDS_H
16#define LLVM_CLANG_AST_OPERATION_KINDS_H
17
18namespace clang {
19
20/// CastKind - The kind of operation required for a conversion.
21enum CastKind {
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());
28  CK_Dependent,
29
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.
33  ///
34  /// The pointer conversion char* -> int* is a bitcast.  Many other
35  /// pointer conversions which are "physically" bitcasts are given
36  /// special cast kinds.
37  ///
38  /// Vector coercions are bitcasts.
39  CK_BitCast,
40
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';
45  CK_LValueBitCast,
46
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.
50  CK_LValueToRValue,
51
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.
57  CK_GetObjCProperty,
58
59  /// CK_NoOp - A conversion which does not affect the type other than
60  /// (possibly) adding qualifiers.
61  ///   int    -> int
62  ///   char** -> const char * const *
63  CK_NoOp,
64
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);
68  CK_BaseToDerived,
69
70  /// CK_DerivedToBase - A conversion from a C++ class pointer
71  /// to a base class pointer.
72  ///   A *a = new B();
73  CK_DerivedToBase,
74
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.
78  ///   const A &a = B();
79  ///   b->method_from_a();
80  CK_UncheckedDerivedToBase,
81
82  /// CK_Dynamic - A C++ dynamic_cast.
83  CK_Dynamic,
84
85  /// CK_ToUnion - The GCC cast-to-union extension.
86  ///   int   -> union { int x; float y; }
87  ///   float -> union { int x; float y; }
88  CK_ToUnion,
89
90  /// CK_ArrayToPointerDecay - Array to pointer decay.
91  ///   int[10] -> int*
92  ///   char[5][6] -> char(*)[6]
93  CK_ArrayToPointerDecay,
94
95  /// CK_FunctionToPointerDecay - Function to pointer decay.
96  ///   void(int) -> void(*)(int)
97  CK_FunctionToPointerDecay,
98
99  /// CK_NullToPointer - Null pointer constant to pointer, ObjC
100  /// pointer, or block pointer.
101  ///   (void*) 0
102  ///   void (^block)() = 0;
103  CK_NullToPointer,
104
105  /// CK_NullToMemberPointer - Null pointer constant to member pointer.
106  ///   int A::*mptr = 0;
107  ///   int (A::*fptr)(int) = nullptr;
108  CK_NullToMemberPointer,
109
110  /// CK_BaseToDerivedMemberPointer - Member pointer in base class to
111  /// member pointer in derived class.
112  ///   int B::*mptr = &A::member;
113  CK_BaseToDerivedMemberPointer,
114
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,
119
120  /// CK_MemberPointerToBoolean - Member pointer to boolean.  A check
121  /// against the null member pointer.
122  CK_MemberPointerToBoolean,
123
124  /// CK_UserDefinedConversion - Conversion using a user defined type
125  /// conversion function.
126  ///    struct A { operator int(); }; int i = int(A());
127  CK_UserDefinedConversion,
128
129  /// CK_ConstructorConversion - Conversion by constructor.
130  ///    struct A { A(int); }; A a = A(10);
131  CK_ConstructorConversion,
132
133  /// CK_IntegralToPointer - Integral to pointer.  A special kind of
134  /// reinterpreting conversion.  Applies to normal, ObjC, and block
135  /// pointers.
136  ///    (char*) 0x1001aab0
137  ///    reinterpret_cast<int*>(0)
138  CK_IntegralToPointer,
139
140  /// CK_PointerToIntegral - Pointer to integral.  A special kind of
141  /// reinterpreting conversion.  Applies to normal, ObjC, and block
142  /// pointers.
143  ///    (intptr_t) "help!"
144  CK_PointerToIntegral,
145
146  /// CK_PointerToBoolean - Pointer to boolean conversion.  A check
147  /// against null.  Applies to normal, ObjC, and block pointers.
148  CK_PointerToBoolean,
149
150  /// CK_ToVoid - Cast to void, discarding the computed value.
151  ///    (void) malloc(2048)
152  CK_ToVoid,
153
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;
158  CK_VectorSplat,
159
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.
163  ///    long l = 5;
164  ///    (unsigned) i
165  CK_IntegralCast,
166
167  /// CK_IntegralToBoolean - Integral to boolean.  A check against zero.
168  ///    (bool) i
169  CK_IntegralToBoolean,
170
171  /// CK_IntegralToFloating - Integral to floating point.
172  ///    float f = i;
173  CK_IntegralToFloating,
174
175  /// CK_FloatingToIntegral - Floating point to integral.  Rounds
176  /// towards zero, discarding any fractional component.
177  ///    (int) f
178  CK_FloatingToIntegral,
179
180  /// CK_FloatingToBoolean - Floating point to boolean.
181  ///    (bool) f
182  CK_FloatingToBoolean,
183
184  /// CK_FloatingCast - Casting between floating types of different size.
185  ///    (double) f
186  ///    (float) ld
187  CK_FloatingCast,
188
189  /// CK_AnyPointerToObjCPointerCast - Casting any other pointer kind
190  /// to an Objective-C pointer.
191  CK_AnyPointerToObjCPointerCast,
192
193  /// CK_AnyPointerToBlockPointerCast - Casting any other pointer kind
194  /// to a block pointer.
195  CK_AnyPointerToBlockPointerCast,
196
197  /// \brief Converting between two Objective-C object types, which
198  /// can occur when performing reference binding to an Objective-C
199  /// object.
200  CK_ObjCObjectLValueCast,
201
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,
207
208  /// \brief Converts a floating point complex to floating point real
209  /// of the source's element type.  Just discards the imaginary
210  /// component.
211  ///   _Complex long double -> long double
212  CK_FloatingComplexToReal,
213
214  /// \brief Converts a floating point complex to bool by comparing
215  /// against 0+0i.
216  CK_FloatingComplexToBoolean,
217
218  /// \brief Converts between different floating point complex types.
219  ///   _Complex float -> _Complex double
220  CK_FloatingComplexCast,
221
222  /// \brief Converts from a floating complex to an integral complex.
223  ///   _Complex float -> _Complex int
224  CK_FloatingComplexToIntegralComplex,
225
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,
231
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,
236
237  /// \brief Converts an integral complex to bool by comparing against
238  /// 0+0i.
239  CK_IntegralComplexToBoolean,
240
241  /// \brief Converts between different integral complex types.
242  ///   _Complex char -> _Complex long long
243  ///   _Complex unsigned int -> _Complex signed int
244  CK_IntegralComplexCast,
245
246  /// \brief Converts from an integral complex to a floating complex.
247  ///   _Complex unsigned -> _Complex float
248  CK_IntegralComplexToFloatingComplex,
249
250  /// \brief Produces a retainable object pointer so that it may be
251  /// consumed, e.g. by being passed to a consuming parameter.  Calls
252  /// objc_retain.
253  CK_ObjCProduceObject,
254
255  /// \brief Consumes a retainable object pointer that has just been
256  /// produced, e.g. as the return value of a retaining call.  Enters
257  /// a cleanup to call objc_release at some indefinite time.
258  CK_ObjCConsumeObject,
259
260  /// \brief Reclaim a retainable object pointer object that may have
261  /// been produced and autoreleased as part of a function return
262  /// sequence.
263  CK_ObjCReclaimReturnedObject
264};
265
266#define CK_Invalid ((CastKind) -1)
267
268enum BinaryOperatorKind {
269  // Operators listed in order of precedence.
270  // Note that additions to this should also update the StmtVisitor class.
271  BO_PtrMemD, BO_PtrMemI,       // [C++ 5.5] Pointer-to-member operators.
272  BO_Mul, BO_Div, BO_Rem,       // [C99 6.5.5] Multiplicative operators.
273  BO_Add, BO_Sub,               // [C99 6.5.6] Additive operators.
274  BO_Shl, BO_Shr,               // [C99 6.5.7] Bitwise shift operators.
275  BO_LT, BO_GT, BO_LE, BO_GE,   // [C99 6.5.8] Relational operators.
276  BO_EQ, BO_NE,                 // [C99 6.5.9] Equality operators.
277  BO_And,                       // [C99 6.5.10] Bitwise AND operator.
278  BO_Xor,                       // [C99 6.5.11] Bitwise XOR operator.
279  BO_Or,                        // [C99 6.5.12] Bitwise OR operator.
280  BO_LAnd,                      // [C99 6.5.13] Logical AND operator.
281  BO_LOr,                       // [C99 6.5.14] Logical OR operator.
282  BO_Assign, BO_MulAssign,      // [C99 6.5.16] Assignment operators.
283  BO_DivAssign, BO_RemAssign,
284  BO_AddAssign, BO_SubAssign,
285  BO_ShlAssign, BO_ShrAssign,
286  BO_AndAssign, BO_XorAssign,
287  BO_OrAssign,
288  BO_Comma                      // [C99 6.5.17] Comma operator.
289};
290
291enum UnaryOperatorKind {
292  // Note that additions to this should also update the StmtVisitor class.
293  UO_PostInc, UO_PostDec, // [C99 6.5.2.4] Postfix increment and decrement
294  UO_PreInc, UO_PreDec,   // [C99 6.5.3.1] Prefix increment and decrement
295  UO_AddrOf, UO_Deref,    // [C99 6.5.3.2] Address and indirection
296  UO_Plus, UO_Minus,      // [C99 6.5.3.3] Unary arithmetic
297  UO_Not, UO_LNot,        // [C99 6.5.3.3] Unary arithmetic
298  UO_Real, UO_Imag,       // "__real expr"/"__imag expr" Extension.
299  UO_Extension            // __extension__ marker.
300};
301
302/// \brief The kind of bridging performed by the Objective-C bridge cast.
303enum ObjCBridgeCastKind {
304  /// \brief Bridging via __bridge, which does nothing but reinterpret
305  /// the bits.
306  OBC_Bridge,
307  /// \brief Bridging via __bridge_transfer, which transfers ownership of an
308  /// Objective-C pointer into ARC.
309  OBC_BridgeTransfer,
310  /// \brief Bridging via __bridge_retain, which makes an ARC object available
311  /// as a +1 C pointer.
312  OBC_BridgeRetained
313};
314
315}
316
317#endif
318