1 //===--- Specifiers.h - Declaration and Type Specifiers ---------*- 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 //===----------------------------------------------------------------------===//
11 /// \brief Defines various enumerations that describe declaration and
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_BASIC_SPECIFIERS_H
17 #define LLVM_CLANG_BASIC_SPECIFIERS_H
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Support/DataTypes.h"
21 #include "llvm/Support/ErrorHandling.h"
24 /// \brief Specifies the width of a type, e.g., short, long, or long long.
25 enum TypeSpecifierWidth {
32 /// \brief Specifies the signedness of a type, e.g., signed or unsigned.
33 enum TypeSpecifierSign {
39 enum TypeSpecifiersPipe {
44 /// \brief Specifies the kind of type.
45 enum TypeSpecifierType {
49 TST_wchar, // C++ wchar_t
50 TST_char16, // C++11 char16_t
51 TST_char32, // C++11 char32_t
54 TST_half, // OpenCL half, ARM NEON __fp16
59 TST_decimal32, // _Decimal32
60 TST_decimal64, // _Decimal64
61 TST_decimal128, // _Decimal128
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.
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
82 /// \brief Structure that packs information about the type specifiers that
83 /// were written in a particular type specifier sequence.
84 struct WrittenBuiltinSpecs {
85 /*DeclSpec::TST*/ unsigned Type : 5;
86 /*DeclSpec::TSS*/ unsigned Sign : 2;
87 /*DeclSpec::TSW*/ unsigned Width : 2;
88 unsigned ModeAttr : 1;
91 /// \brief A C++ access specifier (public, private, protected), plus the
92 /// special value "none" which means different things in different contexts.
93 enum AccessSpecifier {
100 /// \brief The categorization of expression values, currently following the
103 /// \brief An r-value expression (a pr-value in the C++11 taxonomy)
104 /// produces a temporary value.
107 /// \brief An l-value expression is a reference to an object with
108 /// independent storage.
111 /// \brief An x-value expression is a reference to an object with
112 /// independent storage but which can be "moved", i.e.
113 /// efficiently cannibalized for its resources.
117 /// \brief A further classification of the kind of object referenced by an
118 /// l-value or x-value.
119 enum ExprObjectKind {
120 /// An ordinary object is located at an address in memory.
123 /// A bitfield object is a bitfield on a C or C++ record.
126 /// A vector component is an element or range of elements on a vector.
129 /// An Objective-C property is a logical field of an Objective-C
130 /// object which is read and written via Objective-C method calls.
133 /// An Objective-C array/dictionary subscripting which reads an
134 /// object or writes at the subscripted array/dictionary element via
135 /// Objective-C method calls.
139 /// \brief Describes the kind of template specialization that a
140 /// particular template specialization declaration represents.
141 enum TemplateSpecializationKind {
142 /// This template specialization was formed from a template-id but
143 /// has not yet been declared, defined, or instantiated.
145 /// This template specialization was implicitly instantiated from a
146 /// template. (C++ [temp.inst]).
147 TSK_ImplicitInstantiation,
148 /// This template specialization was declared or defined by an
149 /// explicit specialization (C++ [temp.expl.spec]) or partial
150 /// specialization (C++ [temp.class.spec]).
151 TSK_ExplicitSpecialization,
152 /// This template specialization was instantiated from a template
153 /// due to an explicit instantiation declaration request
154 /// (C++11 [temp.explicit]).
155 TSK_ExplicitInstantiationDeclaration,
156 /// This template specialization was instantiated from a template
157 /// due to an explicit instantiation definition request
158 /// (C++ [temp.explicit]).
159 TSK_ExplicitInstantiationDefinition
162 /// \brief Determine whether this template specialization kind refers
163 /// to an instantiation of an entity (as opposed to a non-template or
164 /// an explicit specialization).
165 inline bool isTemplateInstantiation(TemplateSpecializationKind Kind) {
166 return Kind != TSK_Undeclared && Kind != TSK_ExplicitSpecialization;
169 /// \brief True if this template specialization kind is an explicit
170 /// specialization, explicit instantiation declaration, or explicit
171 /// instantiation definition.
172 inline bool isTemplateExplicitInstantiationOrSpecialization(
173 TemplateSpecializationKind Kind) {
175 case TSK_ExplicitSpecialization:
176 case TSK_ExplicitInstantiationDeclaration:
177 case TSK_ExplicitInstantiationDefinition:
181 case TSK_ImplicitInstantiation:
184 llvm_unreachable("bad template specialization kind");
187 /// \brief Thread storage-class-specifier.
188 enum ThreadStorageClassSpecifier {
192 /// C++11 thread_local. Implies 'static' at block scope, but not at
195 /// C11 _Thread_local. Must be combined with either 'static' or 'extern'
196 /// if used at block scope.
200 /// \brief Storage classes.
202 // These are legal on both functions and variables.
208 // These are only legal on variables.
213 /// \brief Checks whether the given storage class is legal for functions.
214 inline bool isLegalForFunction(StorageClass SC) {
215 return SC <= SC_PrivateExtern;
218 /// \brief Checks whether the given storage class is legal for variables.
219 inline bool isLegalForVariable(StorageClass SC) {
223 /// \brief In-class initialization styles for non-static data members.
224 enum InClassInitStyle {
225 ICIS_NoInit, ///< No in-class initializer.
226 ICIS_CopyInit, ///< Copy initialization.
227 ICIS_ListInit ///< Direct list-initialization.
230 /// \brief CallingConv - Specifies the calling convention that a function uses.
232 CC_C, // __attribute__((cdecl))
233 CC_X86StdCall, // __attribute__((stdcall))
234 CC_X86FastCall, // __attribute__((fastcall))
235 CC_X86ThisCall, // __attribute__((thiscall))
236 CC_X86VectorCall, // __attribute__((vectorcall))
237 CC_X86Pascal, // __attribute__((pascal))
238 CC_X86_64Win64, // __attribute__((ms_abi))
239 CC_X86_64SysV, // __attribute__((sysv_abi))
240 CC_X86RegCall, // __attribute__((regcall))
241 CC_AAPCS, // __attribute__((pcs("aapcs")))
242 CC_AAPCS_VFP, // __attribute__((pcs("aapcs-vfp")))
243 CC_IntelOclBicc, // __attribute__((intel_ocl_bicc))
244 CC_SpirFunction, // default for OpenCL functions on SPIR target
245 CC_OpenCLKernel, // inferred for OpenCL kernels
246 CC_Swift, // __attribute__((swiftcall))
247 CC_PreserveMost, // __attribute__((preserve_most))
248 CC_PreserveAll, // __attribute__((preserve_all))
251 /// \brief Checks whether the given calling convention supports variadic
252 /// calls. Unprototyped calls also use the variadic call rules.
253 inline bool supportsVariadicCall(CallingConv CC) {
260 case CC_X86VectorCall:
261 case CC_SpirFunction:
262 case CC_OpenCLKernel:
270 /// \brief The storage duration for an object (per C++ [basic.stc]).
271 enum StorageDuration {
272 SD_FullExpression, ///< Full-expression storage duration (for temporaries).
273 SD_Automatic, ///< Automatic storage duration (most local variables).
274 SD_Thread, ///< Thread storage duration.
275 SD_Static, ///< Static storage duration.
276 SD_Dynamic ///< Dynamic storage duration.
279 /// Describes the nullability of a particular type.
280 enum class NullabilityKind : uint8_t {
281 /// Values of this type can never be null.
283 /// Values of this type can be null.
285 /// Whether values of this type can be null is (explicitly)
286 /// unspecified. This captures a (fairly rare) case where we
287 /// can't conclude anything about the nullability of the type even
288 /// though it has been considered.
292 /// Retrieve the spelling of the given nullability kind.
293 llvm::StringRef getNullabilitySpelling(NullabilityKind kind,
294 bool isContextSensitive = false);
296 /// \brief Kinds of parameter ABI.
297 enum class ParameterABI {
298 /// This parameter uses ordinary ABI rules for its type.
301 /// This parameter (which must have pointer type) is a Swift
302 /// indirect result parameter.
305 /// This parameter (which must have pointer-to-pointer type) uses
306 /// the special Swift error-result ABI treatment. There can be at
307 /// most one parameter on a given function that uses this treatment.
310 /// This parameter (which must have pointer type) uses the special
311 /// Swift context-pointer ABI treatment. There can be at
312 /// most one parameter on a given function that uses this treatment.
316 llvm::StringRef getParameterABISpelling(ParameterABI kind);
317 } // end namespace clang
319 #endif // LLVM_CLANG_BASIC_SPECIFIERS_H