clang 19.0.0git
Specifiers.h
Go to the documentation of this file.
1//===--- Specifiers.h - Declaration and Type Specifiers ---------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// Defines various enumerations that describe declaration and
11/// type specifiers.
12///
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_BASIC_SPECIFIERS_H
16#define LLVM_CLANG_BASIC_SPECIFIERS_H
17
18#include "llvm/ADT/StringRef.h"
19#include "llvm/Support/DataTypes.h"
20#include "llvm/Support/ErrorHandling.h"
21
22namespace llvm {
23class raw_ostream;
24} // namespace llvm
25namespace clang {
26
27 /// Define the meaning of possible values of the kind in ExplicitSpecifier.
28 enum class ExplicitSpecKind : unsigned {
32 };
33
34 /// Define the kind of constexpr specifier.
36
37 /// In an if statement, this denotes whether the statement is
38 /// a constexpr or consteval if statement.
39 enum class IfStatementKind : unsigned {
44 };
45
46 /// Specifies the width of a type, e.g., short, long, or long long.
48
49 /// Specifies the signedness of a type, e.g., signed or unsigned.
51
53
54 /// Specifies the kind of type.
59 TST_wchar, // C++ wchar_t
60 TST_char8, // C++20 char8_t (proposed)
61 TST_char16, // C++11 char16_t
62 TST_char32, // C++11 char32_t
65 TST_bitint, // Bit-precise integer types.
66 TST_half, // OpenCL half, ARM NEON __fp16
67 TST_Float16, // C11 extension ISO/IEC TS 18661-3
68 TST_Accum, // ISO/IEC JTC1 SC22 WG14 N1169 Extension
75 TST_bool, // _Bool
76 TST_decimal32, // _Decimal32
77 TST_decimal64, // _Decimal64
78 TST_decimal128, // _Decimal128
82 TST_class, // C++ class type
83 TST_interface, // C++ (Microsoft-specific) __interface type
84 TST_typename, // Typedef, C++ class-name or enum name, etc.
85 TST_typeofType, // C23 (and GNU extension) typeof(type-name)
86 TST_typeofExpr, // C23 (and GNU extension) typeof(expression)
87 TST_typeof_unqualType, // C23 typeof_unqual(type-name)
88 TST_typeof_unqualExpr, // C23 typeof_unqual(expression)
89 TST_decltype, // C++11 decltype
90#define TRANSFORM_TYPE_TRAIT_DEF(_, Trait) TST_##Trait,
91#include "clang/Basic/TransformTypeTraits.def"
92 TST_auto, // C++11 auto
93 TST_decltype_auto, // C++1y decltype(auto)
94 TST_auto_type, // __auto_type extension
95 TST_unknown_anytype, // __unknown_anytype extension
96 TST_atomic, // C11 _Atomic
98#define GENERIC_IMAGE_TYPE(ImgType, Id) \
99 TST_##ImgType##_t, // OpenCL image types
100#include "clang/Basic/OpenCLImageTypes.def"
101 TST_error // erroneous type
102 };
103
104 /// Structure that packs information about the type specifiers that
105 /// were written in a particular type specifier sequence.
107 static_assert(TST_error < 1 << 7, "Type bitfield not wide enough for TST");
108 LLVM_PREFERRED_TYPE(TypeSpecifierType)
110 LLVM_PREFERRED_TYPE(TypeSpecifierSign)
111 unsigned Sign : 2;
112 LLVM_PREFERRED_TYPE(TypeSpecifierWidth)
113 unsigned Width : 2;
114 LLVM_PREFERRED_TYPE(bool)
115 unsigned ModeAttr : 1;
116 };
117
118 /// A C++ access specifier (public, private, protected), plus the
119 /// special value "none" which means different things in different contexts.
124 AS_none
125 };
126
127 /// The categorization of expression values, currently following the
128 /// C++11 scheme.
130 /// A pr-value expression (in the C++11 taxonomy)
131 /// produces a temporary value.
133
134 /// An l-value expression is a reference to an object with
135 /// independent storage.
137
138 /// An x-value expression is a reference to an object with
139 /// independent storage but which can be "moved", i.e.
140 /// efficiently cannibalized for its resources.
142 };
143
144 /// A further classification of the kind of object referenced by an
145 /// l-value or x-value.
147 /// An ordinary object is located at an address in memory.
149
150 /// A bitfield object is a bitfield on a C or C++ record.
152
153 /// A vector component is an element or range of elements on a vector.
155
156 /// An Objective-C property is a logical field of an Objective-C
157 /// object which is read and written via Objective-C method calls.
159
160 /// An Objective-C array/dictionary subscripting which reads an
161 /// object or writes at the subscripted array/dictionary element via
162 /// Objective-C method calls.
164
165 /// A matrix component is a single element of a matrix.
167 };
168
169 /// The reason why a DeclRefExpr does not constitute an odr-use.
171 /// This is an odr-use.
173 /// This name appears in an unevaluated operand.
175 /// This name appears as a potential result of an lvalue-to-rvalue
176 /// conversion that is a constant expression.
178 /// This name appears as a potential result of a discarded value
179 /// expression.
181 };
182
183 /// Describes the kind of template specialization that a
184 /// particular template specialization declaration represents.
186 /// This template specialization was formed from a template-id but
187 /// has not yet been declared, defined, or instantiated.
189 /// This template specialization was implicitly instantiated from a
190 /// template. (C++ [temp.inst]).
192 /// This template specialization was declared or defined by an
193 /// explicit specialization (C++ [temp.expl.spec]) or partial
194 /// specialization (C++ [temp.class.spec]).
196 /// This template specialization was instantiated from a template
197 /// due to an explicit instantiation declaration request
198 /// (C++11 [temp.explicit]).
200 /// This template specialization was instantiated from a template
201 /// due to an explicit instantiation definition request
202 /// (C++ [temp.explicit]).
204 };
205
206 /// Determine whether this template specialization kind refers
207 /// to an instantiation of an entity (as opposed to a non-template or
208 /// an explicit specialization).
210 return Kind != TSK_Undeclared && Kind != TSK_ExplicitSpecialization;
211 }
212
213 /// True if this template specialization kind is an explicit
214 /// specialization, explicit instantiation declaration, or explicit
215 /// instantiation definition.
218 switch (Kind) {
222 return true;
223
224 case TSK_Undeclared:
226 return false;
227 }
228 llvm_unreachable("bad template specialization kind");
229 }
230
231 /// Thread storage-class-specifier.
234 /// GNU __thread.
236 /// C++11 thread_local. Implies 'static' at block scope, but not at
237 /// class scope.
239 /// C11 _Thread_local. Must be combined with either 'static' or 'extern'
240 /// if used at block scope.
242 };
243
244 /// Storage classes.
246 // These are legal on both functions and variables.
251
252 // These are only legal on variables.
255 };
256
257 /// Checks whether the given storage class is legal for functions.
259 return SC <= SC_PrivateExtern;
260 }
261
262 /// Checks whether the given storage class is legal for variables.
264 return true;
265 }
266
267 /// In-class initialization styles for non-static data members.
269 ICIS_NoInit, ///< No in-class initializer.
270 ICIS_CopyInit, ///< Copy initialization.
271 ICIS_ListInit ///< Direct list-initialization.
272 };
273
274 /// CallingConv - Specifies the calling convention that a function uses.
276 CC_C, // __attribute__((cdecl))
277 CC_X86StdCall, // __attribute__((stdcall))
278 CC_X86FastCall, // __attribute__((fastcall))
279 CC_X86ThisCall, // __attribute__((thiscall))
280 CC_X86VectorCall, // __attribute__((vectorcall))
281 CC_X86Pascal, // __attribute__((pascal))
282 CC_Win64, // __attribute__((ms_abi))
283 CC_X86_64SysV, // __attribute__((sysv_abi))
284 CC_X86RegCall, // __attribute__((regcall))
285 CC_AAPCS, // __attribute__((pcs("aapcs")))
286 CC_AAPCS_VFP, // __attribute__((pcs("aapcs-vfp")))
287 CC_IntelOclBicc, // __attribute__((intel_ocl_bicc))
288 CC_SpirFunction, // default for OpenCL functions on SPIR target
289 CC_OpenCLKernel, // inferred for OpenCL kernels
290 CC_Swift, // __attribute__((swiftcall))
291 CC_SwiftAsync, // __attribute__((swiftasynccall))
292 CC_PreserveMost, // __attribute__((preserve_most))
293 CC_PreserveAll, // __attribute__((preserve_all))
294 CC_AArch64VectorCall, // __attribute__((aarch64_vector_pcs))
295 CC_AArch64SVEPCS, // __attribute__((aarch64_sve_pcs))
296 CC_AMDGPUKernelCall, // __attribute__((amdgpu_kernel))
297 CC_M68kRTD, // __attribute__((m68k_rtd))
298 CC_PreserveNone, // __attribute__((preserve_none))
299 CC_RISCVVectorCall, // __attribute__((riscv_vector_cc))
300 };
301
302 /// Checks whether the given calling convention supports variadic
303 /// calls. Unprototyped calls also use the variadic call rules.
305 switch (CC) {
306 case CC_X86StdCall:
307 case CC_X86FastCall:
308 case CC_X86ThisCall:
309 case CC_X86RegCall:
310 case CC_X86Pascal:
311 case CC_X86VectorCall:
312 case CC_SpirFunction:
313 case CC_OpenCLKernel:
314 case CC_Swift:
315 case CC_SwiftAsync:
316 case CC_M68kRTD:
317 return false;
318 default:
319 return true;
320 }
321 }
322
323 /// The storage duration for an object (per C++ [basic.stc]).
325 SD_FullExpression, ///< Full-expression storage duration (for temporaries).
326 SD_Automatic, ///< Automatic storage duration (most local variables).
327 SD_Thread, ///< Thread storage duration.
328 SD_Static, ///< Static storage duration.
329 SD_Dynamic ///< Dynamic storage duration.
330 };
331
332 /// Describes the nullability of a particular type.
333 enum class NullabilityKind : uint8_t {
334 /// Values of this type can never be null.
335 NonNull = 0,
336 /// Values of this type can be null.
337 Nullable,
338 /// Whether values of this type can be null is (explicitly)
339 /// unspecified. This captures a (fairly rare) case where we
340 /// can't conclude anything about the nullability of the type even
341 /// though it has been considered.
343 // Generally behaves like Nullable, except when used in a block parameter
344 // that was imported into a swift async method. There, swift will assume
345 // that the parameter can get null even if no error occurred. _Nullable
346 // parameters are assumed to only get null on error.
348 };
349 /// Prints human-readable debug representation.
350 llvm::raw_ostream &operator<<(llvm::raw_ostream&, NullabilityKind);
351
352 /// Return true if \p L has a weaker nullability annotation than \p R. The
353 /// ordering is: Unspecified < Nullable < NonNull.
355 return uint8_t(L) > uint8_t(R);
356 }
357
358 /// Retrieve the spelling of the given nullability kind.
359 llvm::StringRef getNullabilitySpelling(NullabilityKind kind,
360 bool isContextSensitive = false);
361
362 /// Kinds of parameter ABI.
363 enum class ParameterABI {
364 /// This parameter uses ordinary ABI rules for its type.
365 Ordinary,
366
367 /// This parameter (which must have pointer type) is a Swift
368 /// indirect result parameter.
370
371 /// This parameter (which must have pointer-to-pointer type) uses
372 /// the special Swift error-result ABI treatment. There can be at
373 /// most one parameter on a given function that uses this treatment.
375
376 /// This parameter (which must have pointer type) uses the special
377 /// Swift context-pointer ABI treatment. There can be at
378 /// most one parameter on a given function that uses this treatment.
380
381 /// This parameter (which must have pointer type) uses the special
382 /// Swift asynchronous context-pointer ABI treatment. There can be at
383 /// most one parameter on a given function that uses this treatment.
385 };
386
387 /// Assigned inheritance model for a class in the MS C++ ABI. Must match order
388 /// of spellings in MSInheritanceAttr.
390 Single = 0,
391 Multiple = 1,
392 Virtual = 2,
393 Unspecified = 3,
394 };
395
396 llvm::StringRef getParameterABISpelling(ParameterABI kind);
397
398 inline llvm::StringRef getAccessSpelling(AccessSpecifier AS) {
399 switch (AS) {
401 return "public";
403 return "protected";
405 return "private";
407 return {};
408 }
409 llvm_unreachable("Unknown AccessSpecifier");
410 }
411} // end namespace clang
412
413#endif // LLVM_CLANG_BASIC_SPECIFIERS_H
The base class of the type hierarchy.
Definition: Type.h:1607
The JSON file list parser is used to communicate input to InstallAPI.
TypeSpecifierType
Specifies the kind of type.
Definition: Specifiers.h:55
@ TST_typeof_unqualType
Definition: Specifiers.h:87
@ TST_ibm128
Definition: Specifiers.h:74
@ TST_decimal64
Definition: Specifiers.h:77
@ TST_float
Definition: Specifiers.h:71
@ TST_auto_type
Definition: Specifiers.h:94
@ TST_auto
Definition: Specifiers.h:92
@ TST_typeof_unqualExpr
Definition: Specifiers.h:88
@ TST_decimal32
Definition: Specifiers.h:76
@ TST_int128
Definition: Specifiers.h:64
@ TST_atomic
Definition: Specifiers.h:96
@ TST_half
Definition: Specifiers.h:66
@ TST_decltype
Definition: Specifiers.h:89
@ TST_typename_pack_indexing
Definition: Specifiers.h:97
@ TST_char32
Definition: Specifiers.h:62
@ TST_struct
Definition: Specifiers.h:81
@ TST_typeofType
Definition: Specifiers.h:85
@ TST_bitint
Definition: Specifiers.h:65
@ TST_wchar
Definition: Specifiers.h:59
@ TST_BFloat16
Definition: Specifiers.h:70
@ TST_char16
Definition: Specifiers.h:61
@ TST_char
Definition: Specifiers.h:58
@ TST_unspecified
Definition: Specifiers.h:56
@ TST_class
Definition: Specifiers.h:82
@ TST_union
Definition: Specifiers.h:80
@ TST_Fract
Definition: Specifiers.h:69
@ TST_float128
Definition: Specifiers.h:73
@ TST_double
Definition: Specifiers.h:72
@ TST_Accum
Definition: Specifiers.h:68
@ TST_int
Definition: Specifiers.h:63
@ TST_bool
Definition: Specifiers.h:75
@ TST_typeofExpr
Definition: Specifiers.h:86
@ TST_typename
Definition: Specifiers.h:84
@ TST_void
Definition: Specifiers.h:57
@ TST_unknown_anytype
Definition: Specifiers.h:95
@ TST_enum
Definition: Specifiers.h:79
@ TST_error
Definition: Specifiers.h:101
@ TST_decltype_auto
Definition: Specifiers.h:93
@ TST_interface
Definition: Specifiers.h:83
@ TST_Float16
Definition: Specifiers.h:67
@ TST_char8
Definition: Specifiers.h:60
@ TST_decimal128
Definition: Specifiers.h:78
bool isTemplateInstantiation(TemplateSpecializationKind Kind)
Determine whether this template specialization kind refers to an instantiation of an entity (as oppos...
Definition: Specifiers.h:209
llvm::StringRef getAccessSpelling(AccessSpecifier AS)
Definition: Specifiers.h:398
llvm::StringRef getParameterABISpelling(ParameterABI kind)
ConstexprSpecKind
Define the kind of constexpr specifier.
Definition: Specifiers.h:35
IfStatementKind
In an if statement, this denotes whether the statement is a constexpr or consteval if statement.
Definition: Specifiers.h:39
NullabilityKind
Describes the nullability of a particular type.
Definition: Specifiers.h:333
@ Nullable
Values of this type can be null.
@ NonNull
Values of this type can never be null.
InClassInitStyle
In-class initialization styles for non-static data members.
Definition: Specifiers.h:268
@ ICIS_CopyInit
Copy initialization.
Definition: Specifiers.h:270
@ ICIS_ListInit
Direct list-initialization.
Definition: Specifiers.h:271
@ ICIS_NoInit
No in-class initializer.
Definition: Specifiers.h:269
ExprObjectKind
A further classification of the kind of object referenced by an l-value or x-value.
Definition: Specifiers.h:146
@ OK_VectorComponent
A vector component is an element or range of elements on a vector.
Definition: Specifiers.h:154
@ OK_ObjCProperty
An Objective-C property is a logical field of an Objective-C object which is read and written via Obj...
Definition: Specifiers.h:158
@ OK_ObjCSubscript
An Objective-C array/dictionary subscripting which reads an object or writes at the subscripted array...
Definition: Specifiers.h:163
@ OK_Ordinary
An ordinary object is located at an address in memory.
Definition: Specifiers.h:148
@ OK_BitField
A bitfield object is a bitfield on a C or C++ record.
Definition: Specifiers.h:151
@ OK_MatrixComponent
A matrix component is a single element of a matrix.
Definition: Specifiers.h:166
StorageClass
Storage classes.
Definition: Specifiers.h:245
@ SC_Auto
Definition: Specifiers.h:253
@ SC_PrivateExtern
Definition: Specifiers.h:250
@ SC_Extern
Definition: Specifiers.h:248
@ SC_Register
Definition: Specifiers.h:254
@ SC_Static
Definition: Specifiers.h:249
@ SC_None
Definition: Specifiers.h:247
ThreadStorageClassSpecifier
Thread storage-class-specifier.
Definition: Specifiers.h:232
@ TSCS_thread_local
C++11 thread_local.
Definition: Specifiers.h:238
@ TSCS_unspecified
Definition: Specifiers.h:233
@ TSCS__Thread_local
C11 _Thread_local.
Definition: Specifiers.h:241
@ TSCS___thread
GNU __thread.
Definition: Specifiers.h:235
const StreamingDiagnostic & operator<<(const StreamingDiagnostic &DB, const ASTContext::SectionInfo &Section)
Insertion operator for diagnostics.
TypeSpecifiersPipe
Definition: Specifiers.h:52
StorageDuration
The storage duration for an object (per C++ [basic.stc]).
Definition: Specifiers.h:324
@ SD_Thread
Thread storage duration.
Definition: Specifiers.h:327
@ SD_Static
Static storage duration.
Definition: Specifiers.h:328
@ SD_FullExpression
Full-expression storage duration (for temporaries).
Definition: Specifiers.h:325
@ SD_Automatic
Automatic storage duration (most local variables).
Definition: Specifiers.h:326
@ SD_Dynamic
Dynamic storage duration.
Definition: Specifiers.h:329
llvm::StringRef getNullabilitySpelling(NullabilityKind kind, bool isContextSensitive=false)
Retrieve the spelling of the given nullability kind.
ParameterABI
Kinds of parameter ABI.
Definition: Specifiers.h:363
@ SwiftAsyncContext
This parameter (which must have pointer type) uses the special Swift asynchronous context-pointer ABI...
@ SwiftErrorResult
This parameter (which must have pointer-to-pointer type) uses the special Swift error-result ABI trea...
@ SwiftIndirectResult
This parameter (which must have pointer type) is a Swift indirect result parameter.
@ SwiftContext
This parameter (which must have pointer type) uses the special Swift context-pointer ABI treatment.
bool supportsVariadicCall(CallingConv CC)
Checks whether the given calling convention supports variadic calls.
Definition: Specifiers.h:304
bool hasWeakerNullability(NullabilityKind L, NullabilityKind R)
Return true if L has a weaker nullability annotation than R.
Definition: Specifiers.h:354
bool isLegalForFunction(StorageClass SC)
Checks whether the given storage class is legal for functions.
Definition: Specifiers.h:258
TypeSpecifierWidth
Specifies the width of a type, e.g., short, long, or long long.
Definition: Specifiers.h:47
TypeSpecifierSign
Specifies the signedness of a type, e.g., signed or unsigned.
Definition: Specifiers.h:50
bool isLegalForVariable(StorageClass SC)
Checks whether the given storage class is legal for variables.
Definition: Specifiers.h:263
ExprValueKind
The categorization of expression values, currently following the C++11 scheme.
Definition: Specifiers.h:129
@ VK_PRValue
A pr-value expression (in the C++11 taxonomy) produces a temporary value.
Definition: Specifiers.h:132
@ VK_XValue
An x-value expression is a reference to an object with independent storage but which can be "moved",...
Definition: Specifiers.h:141
@ VK_LValue
An l-value expression is a reference to an object with independent storage.
Definition: Specifiers.h:136
MSInheritanceModel
Assigned inheritance model for a class in the MS C++ ABI.
Definition: Specifiers.h:389
ExplicitSpecKind
Define the meaning of possible values of the kind in ExplicitSpecifier.
Definition: Specifiers.h:28
TemplateSpecializationKind
Describes the kind of template specialization that a particular template specialization declaration r...
Definition: Specifiers.h:185
@ TSK_ExplicitInstantiationDefinition
This template specialization was instantiated from a template due to an explicit instantiation defini...
Definition: Specifiers.h:203
@ TSK_ExplicitInstantiationDeclaration
This template specialization was instantiated from a template due to an explicit instantiation declar...
Definition: Specifiers.h:199
@ TSK_ExplicitSpecialization
This template specialization was declared or defined by an explicit specialization (C++ [temp....
Definition: Specifiers.h:195
@ TSK_ImplicitInstantiation
This template specialization was implicitly instantiated from a template.
Definition: Specifiers.h:191
@ TSK_Undeclared
This template specialization was formed from a template-id but has not yet been declared,...
Definition: Specifiers.h:188
CallingConv
CallingConv - Specifies the calling convention that a function uses.
Definition: Specifiers.h:275
@ CC_X86Pascal
Definition: Specifiers.h:281
@ CC_Swift
Definition: Specifiers.h:290
@ CC_IntelOclBicc
Definition: Specifiers.h:287
@ CC_OpenCLKernel
Definition: Specifiers.h:289
@ CC_PreserveMost
Definition: Specifiers.h:292
@ CC_Win64
Definition: Specifiers.h:282
@ CC_X86ThisCall
Definition: Specifiers.h:279
@ CC_AArch64VectorCall
Definition: Specifiers.h:294
@ CC_AAPCS
Definition: Specifiers.h:285
@ CC_PreserveNone
Definition: Specifiers.h:298
@ CC_C
Definition: Specifiers.h:276
@ CC_AMDGPUKernelCall
Definition: Specifiers.h:296
@ CC_M68kRTD
Definition: Specifiers.h:297
@ CC_SwiftAsync
Definition: Specifiers.h:291
@ CC_X86RegCall
Definition: Specifiers.h:284
@ CC_RISCVVectorCall
Definition: Specifiers.h:299
@ CC_X86VectorCall
Definition: Specifiers.h:280
@ CC_SpirFunction
Definition: Specifiers.h:288
@ CC_AArch64SVEPCS
Definition: Specifiers.h:295
@ CC_X86StdCall
Definition: Specifiers.h:277
@ CC_X86_64SysV
Definition: Specifiers.h:283
@ CC_PreserveAll
Definition: Specifiers.h:293
@ CC_X86FastCall
Definition: Specifiers.h:278
@ CC_AAPCS_VFP
Definition: Specifiers.h:286
bool isTemplateExplicitInstantiationOrSpecialization(TemplateSpecializationKind Kind)
True if this template specialization kind is an explicit specialization, explicit instantiation decla...
Definition: Specifiers.h:216
AccessSpecifier
A C++ access specifier (public, private, protected), plus the special value "none" which means differ...
Definition: Specifiers.h:120
@ AS_public
Definition: Specifiers.h:121
@ AS_protected
Definition: Specifiers.h:122
@ AS_none
Definition: Specifiers.h:124
@ AS_private
Definition: Specifiers.h:123
NonOdrUseReason
The reason why a DeclRefExpr does not constitute an odr-use.
Definition: Specifiers.h:170
@ NOUR_Discarded
This name appears as a potential result of a discarded value expression.
Definition: Specifiers.h:180
@ NOUR_Unevaluated
This name appears in an unevaluated operand.
Definition: Specifiers.h:174
@ NOUR_None
This is an odr-use.
Definition: Specifiers.h:172
@ NOUR_Constant
This name appears as a potential result of an lvalue-to-rvalue conversion that is a constant expressi...
Definition: Specifiers.h:177
Diagnostic wrappers for TextAPI types for error reporting.
Definition: Dominators.h:30
Structure that packs information about the type specifiers that were written in a particular type spe...
Definition: Specifiers.h:106