17f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei//===--- Specifiers.h - Declaration and Type Specifiers ---------*- C++ -*-===// 27f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// 37f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// The LLVM Compiler Infrastructure 47f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// 57f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// This file is distributed under the University of Illinois Open Source 67f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// License. See LICENSE.TXT for details. 77f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei// 87f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei//===----------------------------------------------------------------------===// 97f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei/// 107f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei/// \file 117f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei/// \brief Defines various enumerations that describe declaration and 127f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei/// type specifiers. 137f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei/// 147f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei//===----------------------------------------------------------------------===// 157f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 167f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei#ifndef LLVM_CLANG_BASIC_SPECIFIERS_H 177f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei#define LLVM_CLANG_BASIC_SPECIFIERS_H 187f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar#include "llvm/ADT/StringRef.h" 2087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar#include "llvm/Support/DataTypes.h" 2187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar#include "llvm/Support/ErrorHandling.h" 2287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 237f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyeinamespace clang { 247f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Specifies the width of a type, e.g., short, long, or long long. 257f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum TypeSpecifierWidth { 267f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSW_unspecified, 277f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSW_short, 287f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSW_long, 297f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSW_longlong 307f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 317f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 327f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Specifies the signedness of a type, e.g., signed or unsigned. 337f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum TypeSpecifierSign { 347f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSS_unspecified, 357f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSS_signed, 367f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSS_unsigned 377f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 387f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 394967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar enum TypeSpecifiersPipe { 404967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar TSP_unspecified, 414967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar TSP_pipe 424967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar }; 434967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 447f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Specifies the kind of type. 457f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum TypeSpecifierType { 467f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_unspecified, 477f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_void, 487f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_char, 497f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_wchar, // C++ wchar_t 50a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_char16, // C++11 char16_t 51a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_char32, // C++11 char32_t 527f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_int, 537f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_int128, 547f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_half, // OpenCL half, ARM NEON __fp16 557f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_float, 567f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_double, 574967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar TST_float128, 587f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_bool, // _Bool 597f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_decimal32, // _Decimal32 607f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_decimal64, // _Decimal64 617f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_decimal128, // _Decimal128 627f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_enum, 637f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_union, 647f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_struct, 657f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_class, // C++ class type 667f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_interface, // C++ (Microsoft-specific) __interface type 677f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_typename, // Typedef, C++ class-name or enum name, etc. 687f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_typeofType, 697f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TST_typeofExpr, 70a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_decltype, // C++11 decltype 71a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_underlyingType, // __underlying_type for C++11 72a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_auto, // C++11 auto 73a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_decltype_auto, // C++1y decltype(auto) 7487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar TST_auto_type, // __auto_type extension 75a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_unknown_anytype, // __unknown_anytype extension 76a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith TST_atomic, // C11 _Atomic 774967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar#define GENERIC_IMAGE_TYPE(ImgType, Id) TST_##ImgType##_t, // OpenCL image types 784967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar#include "clang/Basic/OpenCLImageTypes.def" 794967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar TST_error // erroneous type 807f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 814967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 827f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Structure that packs information about the type specifiers that 837f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// were written in a particular type specifier sequence. 847f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei struct WrittenBuiltinSpecs { 85651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /*DeclSpec::TST*/ unsigned Type : 5; 867f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /*DeclSpec::TSS*/ unsigned Sign : 2; 877f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /*DeclSpec::TSW*/ unsigned Width : 2; 884967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar unsigned ModeAttr : 1; 897f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 907f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 917f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief A C++ access specifier (public, private, protected), plus the 927f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// special value "none" which means different things in different contexts. 937f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum AccessSpecifier { 947f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei AS_public, 957f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei AS_protected, 967f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei AS_private, 977f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei AS_none 987f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 997f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1007f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief The categorization of expression values, currently following the 1017f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// C++11 scheme. 1027f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum ExprValueKind { 1037f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief An r-value expression (a pr-value in the C++11 taxonomy) 1047f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// produces a temporary value. 1057f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei VK_RValue, 1067f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1077f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief An l-value expression is a reference to an object with 1087f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// independent storage. 1097f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei VK_LValue, 1107f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1117f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief An x-value expression is a reference to an object with 1127f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// independent storage but which can be "moved", i.e. 1137f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// efficiently cannibalized for its resources. 1147f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei VK_XValue 1157f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 1167f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1177f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief A further classification of the kind of object referenced by an 1187f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// l-value or x-value. 1197f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum ExprObjectKind { 1207f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// An ordinary object is located at an address in memory. 1217f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei OK_Ordinary, 1227f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1237f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// A bitfield object is a bitfield on a C or C++ record. 1247f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei OK_BitField, 1257f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1267f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// A vector component is an element or range of elements on a vector. 1277f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei OK_VectorComponent, 1287f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1297f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// An Objective-C property is a logical field of an Objective-C 1307f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// object which is read and written via Objective-C method calls. 1317f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei OK_ObjCProperty, 1327f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1337f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// An Objective-C array/dictionary subscripting which reads an 1347f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// object or writes at the subscripted array/dictionary element via 1357f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// Objective-C method calls. 1367f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei OK_ObjCSubscript 1377f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 1387f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1396aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith /// \brief Describes the kind of template specialization that a 1406aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith /// particular template specialization declaration represents. 1417f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum TemplateSpecializationKind { 1427f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// This template specialization was formed from a template-id but 1437f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// has not yet been declared, defined, or instantiated. 1447f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSK_Undeclared = 0, 1457f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// This template specialization was implicitly instantiated from a 1467f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// template. (C++ [temp.inst]). 1477f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSK_ImplicitInstantiation, 1487f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// This template specialization was declared or defined by an 1497f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// explicit specialization (C++ [temp.expl.spec]) or partial 1507f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// specialization (C++ [temp.class.spec]). 1517f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSK_ExplicitSpecialization, 1527f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// This template specialization was instantiated from a template 1537f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// due to an explicit instantiation declaration request 154a2c3646c35dd09d21b74826240aa916545b1873fRichard Smith /// (C++11 [temp.explicit]). 1557f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSK_ExplicitInstantiationDeclaration, 1567f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// This template specialization was instantiated from a template 1577f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// due to an explicit instantiation definition request 1587f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// (C++ [temp.explicit]). 1597f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei TSK_ExplicitInstantiationDefinition 1607f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 1617f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 1626aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith /// \brief Determine whether this template specialization kind refers 1636aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith /// to an instantiation of an entity (as opposed to a non-template or 1646aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith /// an explicit specialization). 1656aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith inline bool isTemplateInstantiation(TemplateSpecializationKind Kind) { 1666aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith return Kind != TSK_Undeclared && Kind != TSK_ExplicitSpecialization; 1676aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith } 1686aa7df9df93bcf2d6399f6e535ef74c132db40ecRichard Smith 16987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief True if this template specialization kind is an explicit 17087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// specialization, explicit instantiation declaration, or explicit 17187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// instantiation definition. 17287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar inline bool isTemplateExplicitInstantiationOrSpecialization( 17387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar TemplateSpecializationKind Kind) { 17487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar switch (Kind) { 17587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar case TSK_ExplicitSpecialization: 17687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar case TSK_ExplicitInstantiationDeclaration: 17787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar case TSK_ExplicitInstantiationDefinition: 17887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return true; 17987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 18087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar case TSK_Undeclared: 18187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar case TSK_ImplicitInstantiation: 18287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return false; 18387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar } 18487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar llvm_unreachable("bad template specialization kind"); 18587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar } 18687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 187dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// \brief Thread storage-class-specifier. 188dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella enum ThreadStorageClassSpecifier { 189dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella TSCS_unspecified, 190dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// GNU __thread. 191dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella TSCS___thread, 192dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// C++11 thread_local. Implies 'static' at block scope, but not at 193dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// class scope. 194dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella TSCS_thread_local, 195dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// C11 _Thread_local. Must be combined with either 'static' or 'extern' 196dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella /// if used at block scope. 197dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella TSCS__Thread_local 198dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella }; 199dc17384581e37436582a007be4d9185bcf7003ecEnea Zaffanella 2007f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Storage classes. 2017f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum StorageClass { 2027f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei // These are legal on both functions and variables. 2037f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_None, 2047f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_Extern, 2057f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_Static, 2067f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_PrivateExtern, 2077f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 2087f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei // These are only legal on variables. 2097f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_Auto, 2107f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei SC_Register 2117f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 2127f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 2137f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Checks whether the given storage class is legal for functions. 2147f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei inline bool isLegalForFunction(StorageClass SC) { 2157f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei return SC <= SC_PrivateExtern; 2167f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei } 2177f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 2187f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief Checks whether the given storage class is legal for variables. 2197f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei inline bool isLegalForVariable(StorageClass SC) { 2207f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei return true; 2217f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei } 2227f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 2237f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief In-class initialization styles for non-static data members. 2247f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum InClassInitStyle { 2257f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei ICIS_NoInit, ///< No in-class initializer. 2267f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei ICIS_CopyInit, ///< Copy initialization. 2277f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei ICIS_ListInit ///< Direct list-initialization. 2287f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 2297f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 2307f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei /// \brief CallingConv - Specifies the calling convention that a function uses. 2317f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei enum CallingConv { 2327f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_C, // __attribute__((cdecl)) 2337f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_X86StdCall, // __attribute__((stdcall)) 2347f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_X86FastCall, // __attribute__((fastcall)) 2357f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_X86ThisCall, // __attribute__((thiscall)) 236176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines CC_X86VectorCall, // __attribute__((vectorcall)) 2377f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_X86Pascal, // __attribute__((pascal)) 238e8519c31a6ef853b627d557702ac1890f18ce2c9Charles Davis CC_X86_64Win64, // __attribute__((ms_abi)) 239e8519c31a6ef853b627d557702ac1890f18ce2c9Charles Davis CC_X86_64SysV, // __attribute__((sysv_abi)) 2407f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_AAPCS, // __attribute__((pcs("aapcs"))) 2417f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei CC_AAPCS_VFP, // __attribute__((pcs("aapcs-vfp"))) 2420e2c34f92f00628d48968dfea096d36381f494cbStephen Hines CC_IntelOclBicc, // __attribute__((intel_ocl_bicc)) 2430e2c34f92f00628d48968dfea096d36381f494cbStephen Hines CC_SpirFunction, // default for OpenCL functions on SPIR target 2444967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar CC_OpenCLKernel, // inferred for OpenCL kernels 2454967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar CC_Swift, // __attribute__((swiftcall)) 2464967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar CC_PreserveMost, // __attribute__((preserve_most)) 2474967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar CC_PreserveAll, // __attribute__((preserve_all)) 2487f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei }; 2497f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 250176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \brief Checks whether the given calling convention supports variadic 251176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// calls. Unprototyped calls also use the variadic call rules. 252176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines inline bool supportsVariadicCall(CallingConv CC) { 25345d3950e373412f395413c81a0310e8090508608Hans Wennborg switch (CC) { 25445d3950e373412f395413c81a0310e8090508608Hans Wennborg case CC_X86StdCall: 25545d3950e373412f395413c81a0310e8090508608Hans Wennborg case CC_X86FastCall: 25645d3950e373412f395413c81a0310e8090508608Hans Wennborg case CC_X86ThisCall: 25745d3950e373412f395413c81a0310e8090508608Hans Wennborg case CC_X86Pascal: 258176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines case CC_X86VectorCall: 2590e2c34f92f00628d48968dfea096d36381f494cbStephen Hines case CC_SpirFunction: 2604967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar case CC_OpenCLKernel: 2614967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar case CC_Swift: 26245d3950e373412f395413c81a0310e8090508608Hans Wennborg return false; 263176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines default: 264176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines return true; 26545d3950e373412f395413c81a0310e8090508608Hans Wennborg } 26645d3950e373412f395413c81a0310e8090508608Hans Wennborg } 26745d3950e373412f395413c81a0310e8090508608Hans Wennborg 268211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith /// \brief The storage duration for an object (per C++ [basic.stc]). 269211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith enum StorageDuration { 270211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith SD_FullExpression, ///< Full-expression storage duration (for temporaries). 271211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith SD_Automatic, ///< Automatic storage duration (most local variables). 272211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith SD_Thread, ///< Thread storage duration. 273211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith SD_Static, ///< Static storage duration. 274211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith SD_Dynamic ///< Dynamic storage duration. 275211c8ddb5b500ed84833751363d0cfe1115f4dd3Richard Smith }; 27687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 27787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// Describes the nullability of a particular type. 27887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar enum class NullabilityKind : uint8_t { 27987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// Values of this type can never be null. 28087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar NonNull = 0, 28187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// Values of this type can be null. 28287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar Nullable, 28387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// Whether values of this type can be null is (explicitly) 28487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// unspecified. This captures a (fairly rare) case where we 28587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// can't conclude anything about the nullability of the type even 28687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// though it has been considered. 28787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar Unspecified 28887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar }; 28987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 29087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// Retrieve the spelling of the given nullability kind. 29187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar llvm::StringRef getNullabilitySpelling(NullabilityKind kind, 29287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bool isContextSensitive = false); 2934967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 2944967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// \brief Kinds of parameter ABI. 2954967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar enum class ParameterABI { 2964967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// This parameter uses ordinary ABI rules for its type. 2974967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar Ordinary, 2984967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 2994967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// This parameter (which must have pointer type) is a Swift 3004967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// indirect result parameter. 3014967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar SwiftIndirectResult, 3024967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 3034967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// This parameter (which must have pointer-to-pointer type) uses 3044967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// the special Swift error-result ABI treatment. There can be at 3054967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// most one parameter on a given function that uses this treatment. 3064967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar SwiftErrorResult, 3074967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 3084967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// This parameter (which must have pointer type) uses the special 3094967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// Swift context-pointer ABI treatment. There can be at 3104967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// most one parameter on a given function that uses this treatment. 3114967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar SwiftContext 3124967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar }; 3134967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 3144967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar llvm::StringRef getParameterABISpelling(ParameterABI kind); 3157f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei} // end namespace clang 3167f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei 3177f92f2d8d9b7a07900c030183bc13a9ff60057ccGuy Benyei#endif // LLVM_CLANG_BASIC_SPECIFIERS_H 318