1 //===--- Specifiers.h - Declaration and Type Specifiers ---------*- 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 /// \file 11 /// \brief Defines various enumerations that describe declaration and 12 /// type specifiers. 13 /// 14 //===----------------------------------------------------------------------===// 15 16 #ifndef LLVM_CLANG_BASIC_SPECIFIERS_H 17 #define LLVM_CLANG_BASIC_SPECIFIERS_H 18 19 #include "llvm/ADT/StringRef.h" 20 #include "llvm/Support/DataTypes.h" 21 #include "llvm/Support/ErrorHandling.h" 22 23 namespace clang { 24 /// \brief Specifies the width of a type, e.g., short, long, or long long. 25 enum TypeSpecifierWidth { 26 TSW_unspecified, 27 TSW_short, 28 TSW_long, 29 TSW_longlong 30 }; 31 32 /// \brief Specifies the signedness of a type, e.g., signed or unsigned. 33 enum TypeSpecifierSign { 34 TSS_unspecified, 35 TSS_signed, 36 TSS_unsigned 37 }; 38 39 enum TypeSpecifiersPipe { 40 TSP_unspecified, 41 TSP_pipe 42 }; 43 44 /// \brief Specifies the kind of type. 45 enum TypeSpecifierType { 46 TST_unspecified, 47 TST_void, 48 TST_char, 49 TST_wchar, // C++ wchar_t 50 TST_char16, // C++11 char16_t 51 TST_char32, // C++11 char32_t 52 TST_int, 53 TST_int128, 54 TST_half, // OpenCL half, ARM NEON __fp16 55 TST_Float16, // C11 extension ISO/IEC TS 18661-3 56 TST_float, 57 TST_double, 58 TST_float128, 59 TST_bool, // _Bool 60 TST_decimal32, // _Decimal32 61 TST_decimal64, // _Decimal64 62 TST_decimal128, // _Decimal128 63 TST_enum, 64 TST_union, 65 TST_struct, 66 TST_class, // C++ class type 67 TST_interface, // C++ (Microsoft-specific) __interface type 68 TST_typename, // Typedef, C++ class-name or enum name, etc. 69 TST_typeofType, 70 TST_typeofExpr, 71 TST_decltype, // C++11 decltype 72 TST_underlyingType, // __underlying_type for C++11 73 TST_auto, // C++11 auto 74 TST_decltype_auto, // C++1y decltype(auto) 75 TST_auto_type, // __auto_type extension 76 TST_unknown_anytype, // __unknown_anytype extension 77 TST_atomic, // C11 _Atomic 78 #define GENERIC_IMAGE_TYPE(ImgType, Id) TST_##ImgType##_t, // OpenCL image types 79 #include "clang/Basic/OpenCLImageTypes.def" 80 TST_error // erroneous type 81 }; 82 83 /// \brief Structure that packs information about the type specifiers that 84 /// were written in a particular type specifier sequence. 85 struct WrittenBuiltinSpecs { 86 static_assert(TST_error < 1 << 6, "Type bitfield not wide enough for TST"); 87 /*DeclSpec::TST*/ unsigned Type : 6; 88 /*DeclSpec::TSS*/ unsigned Sign : 2; 89 /*DeclSpec::TSW*/ unsigned Width : 2; 90 unsigned ModeAttr : 1; 91 }; 92 93 /// \brief A C++ access specifier (public, private, protected), plus the 94 /// special value "none" which means different things in different contexts. 95 enum AccessSpecifier { 96 AS_public, 97 AS_protected, 98 AS_private, 99 AS_none 100 }; 101 102 /// \brief The categorization of expression values, currently following the 103 /// C++11 scheme. 104 enum ExprValueKind { 105 /// \brief An r-value expression (a pr-value in the C++11 taxonomy) 106 /// produces a temporary value. 107 VK_RValue, 108 109 /// \brief An l-value expression is a reference to an object with 110 /// independent storage. 111 VK_LValue, 112 113 /// \brief An x-value expression is a reference to an object with 114 /// independent storage but which can be "moved", i.e. 115 /// efficiently cannibalized for its resources. 116 VK_XValue 117 }; 118 119 /// \brief A further classification of the kind of object referenced by an 120 /// l-value or x-value. 121 enum ExprObjectKind { 122 /// An ordinary object is located at an address in memory. 123 OK_Ordinary, 124 125 /// A bitfield object is a bitfield on a C or C++ record. 126 OK_BitField, 127 128 /// A vector component is an element or range of elements on a vector. 129 OK_VectorComponent, 130 131 /// An Objective-C property is a logical field of an Objective-C 132 /// object which is read and written via Objective-C method calls. 133 OK_ObjCProperty, 134 135 /// An Objective-C array/dictionary subscripting which reads an 136 /// object or writes at the subscripted array/dictionary element via 137 /// Objective-C method calls. 138 OK_ObjCSubscript 139 }; 140 141 /// \brief Describes the kind of template specialization that a 142 /// particular template specialization declaration represents. 143 enum TemplateSpecializationKind { 144 /// This template specialization was formed from a template-id but 145 /// has not yet been declared, defined, or instantiated. 146 TSK_Undeclared = 0, 147 /// This template specialization was implicitly instantiated from a 148 /// template. (C++ [temp.inst]). 149 TSK_ImplicitInstantiation, 150 /// This template specialization was declared or defined by an 151 /// explicit specialization (C++ [temp.expl.spec]) or partial 152 /// specialization (C++ [temp.class.spec]). 153 TSK_ExplicitSpecialization, 154 /// This template specialization was instantiated from a template 155 /// due to an explicit instantiation declaration request 156 /// (C++11 [temp.explicit]). 157 TSK_ExplicitInstantiationDeclaration, 158 /// This template specialization was instantiated from a template 159 /// due to an explicit instantiation definition request 160 /// (C++ [temp.explicit]). 161 TSK_ExplicitInstantiationDefinition 162 }; 163 164 /// \brief Determine whether this template specialization kind refers 165 /// to an instantiation of an entity (as opposed to a non-template or 166 /// an explicit specialization). 167 inline bool isTemplateInstantiation(TemplateSpecializationKind Kind) { 168 return Kind != TSK_Undeclared && Kind != TSK_ExplicitSpecialization; 169 } 170 171 /// \brief True if this template specialization kind is an explicit 172 /// specialization, explicit instantiation declaration, or explicit 173 /// instantiation definition. 174 inline bool isTemplateExplicitInstantiationOrSpecialization( 175 TemplateSpecializationKind Kind) { 176 switch (Kind) { 177 case TSK_ExplicitSpecialization: 178 case TSK_ExplicitInstantiationDeclaration: 179 case TSK_ExplicitInstantiationDefinition: 180 return true; 181 182 case TSK_Undeclared: 183 case TSK_ImplicitInstantiation: 184 return false; 185 } 186 llvm_unreachable("bad template specialization kind"); 187 } 188 189 /// \brief Thread storage-class-specifier. 190 enum ThreadStorageClassSpecifier { 191 TSCS_unspecified, 192 /// GNU __thread. 193 TSCS___thread, 194 /// C++11 thread_local. Implies 'static' at block scope, but not at 195 /// class scope. 196 TSCS_thread_local, 197 /// C11 _Thread_local. Must be combined with either 'static' or 'extern' 198 /// if used at block scope. 199 TSCS__Thread_local 200 }; 201 202 /// \brief Storage classes. 203 enum StorageClass { 204 // These are legal on both functions and variables. 205 SC_None, 206 SC_Extern, 207 SC_Static, 208 SC_PrivateExtern, 209 210 // These are only legal on variables. 211 SC_Auto, 212 SC_Register 213 }; 214 215 /// \brief Checks whether the given storage class is legal for functions. 216 inline bool isLegalForFunction(StorageClass SC) { 217 return SC <= SC_PrivateExtern; 218 } 219 220 /// \brief Checks whether the given storage class is legal for variables. 221 inline bool isLegalForVariable(StorageClass SC) { 222 return true; 223 } 224 225 /// \brief In-class initialization styles for non-static data members. 226 enum InClassInitStyle { 227 ICIS_NoInit, ///< No in-class initializer. 228 ICIS_CopyInit, ///< Copy initialization. 229 ICIS_ListInit ///< Direct list-initialization. 230 }; 231 232 /// \brief CallingConv - Specifies the calling convention that a function uses. 233 enum CallingConv { 234 CC_C, // __attribute__((cdecl)) 235 CC_X86StdCall, // __attribute__((stdcall)) 236 CC_X86FastCall, // __attribute__((fastcall)) 237 CC_X86ThisCall, // __attribute__((thiscall)) 238 CC_X86VectorCall, // __attribute__((vectorcall)) 239 CC_X86Pascal, // __attribute__((pascal)) 240 CC_Win64, // __attribute__((ms_abi)) 241 CC_X86_64SysV, // __attribute__((sysv_abi)) 242 CC_X86RegCall, // __attribute__((regcall)) 243 CC_AAPCS, // __attribute__((pcs("aapcs"))) 244 CC_AAPCS_VFP, // __attribute__((pcs("aapcs-vfp"))) 245 CC_IntelOclBicc, // __attribute__((intel_ocl_bicc)) 246 CC_SpirFunction, // default for OpenCL functions on SPIR target 247 CC_OpenCLKernel, // inferred for OpenCL kernels 248 CC_Swift, // __attribute__((swiftcall)) 249 CC_PreserveMost, // __attribute__((preserve_most)) 250 CC_PreserveAll, // __attribute__((preserve_all)) 251 }; 252 253 /// \brief Checks whether the given calling convention supports variadic 254 /// calls. Unprototyped calls also use the variadic call rules. 255 inline bool supportsVariadicCall(CallingConv CC) { 256 switch (CC) { 257 case CC_X86StdCall: 258 case CC_X86FastCall: 259 case CC_X86ThisCall: 260 case CC_X86RegCall: 261 case CC_X86Pascal: 262 case CC_X86VectorCall: 263 case CC_SpirFunction: 264 case CC_OpenCLKernel: 265 case CC_Swift: 266 return false; 267 default: 268 return true; 269 } 270 } 271 272 /// \brief The storage duration for an object (per C++ [basic.stc]). 273 enum StorageDuration { 274 SD_FullExpression, ///< Full-expression storage duration (for temporaries). 275 SD_Automatic, ///< Automatic storage duration (most local variables). 276 SD_Thread, ///< Thread storage duration. 277 SD_Static, ///< Static storage duration. 278 SD_Dynamic ///< Dynamic storage duration. 279 }; 280 281 /// Describes the nullability of a particular type. 282 enum class NullabilityKind : uint8_t { 283 /// Values of this type can never be null. 284 NonNull = 0, 285 /// Values of this type can be null. 286 Nullable, 287 /// Whether values of this type can be null is (explicitly) 288 /// unspecified. This captures a (fairly rare) case where we 289 /// can't conclude anything about the nullability of the type even 290 /// though it has been considered. 291 Unspecified 292 }; 293 294 /// Retrieve the spelling of the given nullability kind. 295 llvm::StringRef getNullabilitySpelling(NullabilityKind kind, 296 bool isContextSensitive = false); 297 298 /// \brief Kinds of parameter ABI. 299 enum class ParameterABI { 300 /// This parameter uses ordinary ABI rules for its type. 301 Ordinary, 302 303 /// This parameter (which must have pointer type) is a Swift 304 /// indirect result parameter. 305 SwiftIndirectResult, 306 307 /// This parameter (which must have pointer-to-pointer type) uses 308 /// the special Swift error-result ABI treatment. There can be at 309 /// most one parameter on a given function that uses this treatment. 310 SwiftErrorResult, 311 312 /// This parameter (which must have pointer type) uses the special 313 /// Swift context-pointer ABI treatment. There can be at 314 /// most one parameter on a given function that uses this treatment. 315 SwiftContext 316 }; 317 318 llvm::StringRef getParameterABISpelling(ParameterABI kind); 319 } // end namespace clang 320 321 #endif // LLVM_CLANG_BASIC_SPECIFIERS_H 322
