contrib/llvm/tools/clang/include/clang/Basic/Specifiers.h

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