clang  10.0.0svn
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 
22 namespace clang {
23 
24  /// Define the meaning of possible values of the kind in ExplicitSpecifier.
25  enum class ExplicitSpecKind : unsigned {
28  Unresolved,
29  };
30 
31  /// Define the kind of constexpr specifier.
37  };
38 
39  /// Specifies the width of a type, e.g., short, long, or long long.
45  };
46 
47  /// Specifies the signedness of a type, e.g., signed or unsigned.
52  };
53 
57  };
58 
59  /// Specifies the kind of type.
64  TST_wchar, // C++ wchar_t
65  TST_char8, // C++20 char8_t (proposed)
66  TST_char16, // C++11 char16_t
67  TST_char32, // C++11 char32_t
70  TST_half, // OpenCL half, ARM NEON __fp16
71  TST_Float16, // C11 extension ISO/IEC TS 18661-3
72  TST_Accum, // ISO/IEC JTC1 SC22 WG14 N1169 Extension
77  TST_bool, // _Bool
78  TST_decimal32, // _Decimal32
79  TST_decimal64, // _Decimal64
80  TST_decimal128, // _Decimal128
84  TST_class, // C++ class type
85  TST_interface, // C++ (Microsoft-specific) __interface type
86  TST_typename, // Typedef, C++ class-name or enum name, etc.
89  TST_decltype, // C++11 decltype
90  TST_underlyingType, // __underlying_type for C++11
91  TST_auto, // C++11 auto
92  TST_decltype_auto, // C++1y decltype(auto)
93  TST_auto_type, // __auto_type extension
94  TST_unknown_anytype, // __unknown_anytype extension
95  TST_atomic, // C11 _Atomic
96 #define GENERIC_IMAGE_TYPE(ImgType, Id) TST_##ImgType##_t, // OpenCL image types
97 #include "clang/Basic/OpenCLImageTypes.def"
98  TST_error // erroneous type
99  };
100 
101  /// Structure that packs information about the type specifiers that
102  /// were written in a particular type specifier sequence.
104  static_assert(TST_error < 1 << 6, "Type bitfield not wide enough for TST");
105  /*DeclSpec::TST*/ unsigned Type : 6;
106  /*DeclSpec::TSS*/ unsigned Sign : 2;
107  /*DeclSpec::TSW*/ unsigned Width : 2;
108  unsigned ModeAttr : 1;
109  };
110 
111  /// A C++ access specifier (public, private, protected), plus the
112  /// special value "none" which means different things in different contexts.
118  };
119 
120  /// The categorization of expression values, currently following the
121  /// C++11 scheme.
123  /// An r-value expression (a pr-value in the C++11 taxonomy)
124  /// produces a temporary value.
126 
127  /// An l-value expression is a reference to an object with
128  /// independent storage.
130 
131  /// An x-value expression is a reference to an object with
132  /// independent storage but which can be "moved", i.e.
133  /// efficiently cannibalized for its resources.
135  };
136 
137  /// A further classification of the kind of object referenced by an
138  /// l-value or x-value.
140  /// An ordinary object is located at an address in memory.
142 
143  /// A bitfield object is a bitfield on a C or C++ record.
145 
146  /// A vector component is an element or range of elements on a vector.
148 
149  /// An Objective-C property is a logical field of an Objective-C
150  /// object which is read and written via Objective-C method calls.
152 
153  /// An Objective-C array/dictionary subscripting which reads an
154  /// object or writes at the subscripted array/dictionary element via
155  /// Objective-C method calls.
157  };
158 
159  /// The reason why a DeclRefExpr does not constitute an odr-use.
161  /// This is an odr-use.
163  /// This name appears in an unevaluated operand.
165  /// This name appears as a potential result of an lvalue-to-rvalue
166  /// conversion that is a constant expression.
168  /// This name appears as a potential result of a discarded value
169  /// expression.
171  };
172 
173  /// Describes the kind of template specialization that a
174  /// particular template specialization declaration represents.
176  /// This template specialization was formed from a template-id but
177  /// has not yet been declared, defined, or instantiated.
179  /// This template specialization was implicitly instantiated from a
180  /// template. (C++ [temp.inst]).
182  /// This template specialization was declared or defined by an
183  /// explicit specialization (C++ [temp.expl.spec]) or partial
184  /// specialization (C++ [temp.class.spec]).
186  /// This template specialization was instantiated from a template
187  /// due to an explicit instantiation declaration request
188  /// (C++11 [temp.explicit]).
190  /// This template specialization was instantiated from a template
191  /// due to an explicit instantiation definition request
192  /// (C++ [temp.explicit]).
194  };
195 
196  /// Determine whether this template specialization kind refers
197  /// to an instantiation of an entity (as opposed to a non-template or
198  /// an explicit specialization).
200  return Kind != TSK_Undeclared && Kind != TSK_ExplicitSpecialization;
201  }
202 
203  /// True if this template specialization kind is an explicit
204  /// specialization, explicit instantiation declaration, or explicit
205  /// instantiation definition.
208  switch (Kind) {
212  return true;
213 
214  case TSK_Undeclared:
216  return false;
217  }
218  llvm_unreachable("bad template specialization kind");
219  }
220 
221  /// Thread storage-class-specifier.
224  /// GNU __thread.
226  /// C++11 thread_local. Implies 'static' at block scope, but not at
227  /// class scope.
229  /// C11 _Thread_local. Must be combined with either 'static' or 'extern'
230  /// if used at block scope.
232  };
233 
234  /// Storage classes.
236  // These are legal on both functions and variables.
241 
242  // These are only legal on variables.
245  };
246 
247  /// Checks whether the given storage class is legal for functions.
249  return SC <= SC_PrivateExtern;
250  }
251 
252  /// Checks whether the given storage class is legal for variables.
254  return true;
255  }
256 
257  /// In-class initialization styles for non-static data members.
259  ICIS_NoInit, ///< No in-class initializer.
260  ICIS_CopyInit, ///< Copy initialization.
261  ICIS_ListInit ///< Direct list-initialization.
262  };
263 
264  /// CallingConv - Specifies the calling convention that a function uses.
265  enum CallingConv {
266  CC_C, // __attribute__((cdecl))
267  CC_X86StdCall, // __attribute__((stdcall))
268  CC_X86FastCall, // __attribute__((fastcall))
269  CC_X86ThisCall, // __attribute__((thiscall))
270  CC_X86VectorCall, // __attribute__((vectorcall))
271  CC_X86Pascal, // __attribute__((pascal))
272  CC_Win64, // __attribute__((ms_abi))
273  CC_X86_64SysV, // __attribute__((sysv_abi))
274  CC_X86RegCall, // __attribute__((regcall))
275  CC_AAPCS, // __attribute__((pcs("aapcs")))
276  CC_AAPCS_VFP, // __attribute__((pcs("aapcs-vfp")))
277  CC_IntelOclBicc, // __attribute__((intel_ocl_bicc))
278  CC_SpirFunction, // default for OpenCL functions on SPIR target
279  CC_OpenCLKernel, // inferred for OpenCL kernels
280  CC_Swift, // __attribute__((swiftcall))
281  CC_PreserveMost, // __attribute__((preserve_most))
282  CC_PreserveAll, // __attribute__((preserve_all))
283  CC_AArch64VectorCall, // __attribute__((aarch64_vector_pcs))
284  };
285 
286  /// Checks whether the given calling convention supports variadic
287  /// calls. Unprototyped calls also use the variadic call rules.
289  switch (CC) {
290  case CC_X86StdCall:
291  case CC_X86FastCall:
292  case CC_X86ThisCall:
293  case CC_X86RegCall:
294  case CC_X86Pascal:
295  case CC_X86VectorCall:
296  case CC_SpirFunction:
297  case CC_OpenCLKernel:
298  case CC_Swift:
299  return false;
300  default:
301  return true;
302  }
303  }
304 
305  /// The storage duration for an object (per C++ [basic.stc]).
307  SD_FullExpression, ///< Full-expression storage duration (for temporaries).
308  SD_Automatic, ///< Automatic storage duration (most local variables).
309  SD_Thread, ///< Thread storage duration.
310  SD_Static, ///< Static storage duration.
311  SD_Dynamic ///< Dynamic storage duration.
312  };
313 
314  /// Describes the nullability of a particular type.
315  enum class NullabilityKind : uint8_t {
316  /// Values of this type can never be null.
317  NonNull = 0,
318  /// Values of this type can be null.
319  Nullable,
320  /// Whether values of this type can be null is (explicitly)
321  /// unspecified. This captures a (fairly rare) case where we
322  /// can't conclude anything about the nullability of the type even
323  /// though it has been considered.
325  };
326 
327  /// Return true if \p L has a weaker nullability annotation than \p R. The
328  /// ordering is: Unspecified < Nullable < NonNull.
330  return uint8_t(L) > uint8_t(R);
331  }
332 
333  /// Retrieve the spelling of the given nullability kind.
335  bool isContextSensitive = false);
336 
337  /// Kinds of parameter ABI.
338  enum class ParameterABI {
339  /// This parameter uses ordinary ABI rules for its type.
340  Ordinary,
341 
342  /// This parameter (which must have pointer type) is a Swift
343  /// indirect result parameter.
345 
346  /// This parameter (which must have pointer-to-pointer type) uses
347  /// the special Swift error-result ABI treatment. There can be at
348  /// most one parameter on a given function that uses this treatment.
350 
351  /// This parameter (which must have pointer type) uses the special
352  /// Swift context-pointer ABI treatment. There can be at
353  /// most one parameter on a given function that uses this treatment.
355  };
356 
357  llvm::StringRef getParameterABISpelling(ParameterABI kind);
358 } // end namespace clang
359 
360 #endif // LLVM_CLANG_BASIC_SPECIFIERS_H
Static storage duration.
Definition: Specifiers.h:310
NullabilityKind
Describes the nullability of a particular type.
Definition: Specifiers.h:315
AccessSpecifier
A C++ access specifier (public, private, protected), plus the special value "none" which means differ...
Definition: Specifiers.h:113
StorageDuration
The storage duration for an object (per C++ [basic.stc]).
Definition: Specifiers.h:306
This name appears in an unevaluated operand.
Definition: Specifiers.h:164
An Objective-C array/dictionary subscripting which reads an object or writes at the subscripted array...
Definition: Specifiers.h:156
TypeSpecifierType
Specifies the kind of type.
Definition: Specifiers.h:60
bool isTemplateExplicitInstantiationOrSpecialization(TemplateSpecializationKind Kind)
True if this template specialization kind is an explicit specialization, explicit instantiation decla...
Definition: Specifiers.h:206
C11 _Thread_local.
Definition: Specifiers.h:231
A vector component is an element or range of elements on a vector.
Definition: Specifiers.h:147
Copy initialization.
Definition: Specifiers.h:260
TypeSpecifierSign
Specifies the signedness of a type, e.g., signed or unsigned.
Definition: Specifiers.h:48
An r-value expression (a pr-value in the C++11 taxonomy) produces a temporary value.
Definition: Specifiers.h:125
Values of this type can be null.
This parameter (which must have pointer type) uses the special Swift context-pointer ABI treatment...
Whether values of this type can be null is (explicitly) unspecified.
An x-value expression is a reference to an object with independent storage but which can be "moved"...
Definition: Specifiers.h:134
Values of this type can never be null.
An ordinary object is located at an address in memory.
Definition: Specifiers.h:141
This is an odr-use.
Definition: Specifiers.h:162
This parameter (which must have pointer-to-pointer type) uses the special Swift error-result ABI trea...
llvm::StringRef getParameterABISpelling(ParameterABI kind)
An Objective-C property is a logical field of an Objective-C object which is read and written via Obj...
Definition: Specifiers.h:151
ExprValueKind
The categorization of expression values, currently following the C++11 scheme.
Definition: Specifiers.h:122
This name appears as a potential result of an lvalue-to-rvalue conversion that is a constant expressi...
Definition: Specifiers.h:167
bool supportsVariadicCall(CallingConv CC)
Checks whether the given calling convention supports variadic calls.
Definition: Specifiers.h:288
StorageClass
Storage classes.
Definition: Specifiers.h:235
bool isLegalForFunction(StorageClass SC)
Checks whether the given storage class is legal for functions.
Definition: Specifiers.h:248
InClassInitStyle
In-class initialization styles for non-static data members.
Definition: Specifiers.h:258
This template specialization was implicitly instantiated from a template.
Definition: Specifiers.h:181
TypeSpecifiersPipe
Definition: Specifiers.h:54
bool isTemplateInstantiation(TemplateSpecializationKind Kind)
Determine whether this template specialization kind refers to an instantiation of an entity (as oppos...
Definition: Specifiers.h:199
CallingConv
CallingConv - Specifies the calling convention that a function uses.
Definition: Specifiers.h:265
Dynamic storage duration.
Definition: Specifiers.h:311
Thread storage duration.
Definition: Specifiers.h:309
Kind
bool hasWeakerNullability(NullabilityKind L, NullabilityKind R)
Return true if L has a weaker nullability annotation than R.
Definition: Specifiers.h:329
ExprObjectKind
A further classification of the kind of object referenced by an l-value or x-value.
Definition: Specifiers.h:139
bool isLegalForVariable(StorageClass SC)
Checks whether the given storage class is legal for variables.
Definition: Specifiers.h:253
GNU __thread.
Definition: Specifiers.h:225
Direct list-initialization.
Definition: Specifiers.h:261
This template specialization was instantiated from a template due to an explicit instantiation defini...
Definition: Specifiers.h:193
This template specialization was formed from a template-id but has not yet been declared, defined, or instantiated.
Definition: Specifiers.h:178
ParameterABI
Kinds of parameter ABI.
Definition: Specifiers.h:338
C++11 thread_local.
Definition: Specifiers.h:228
This name appears as a potential result of a discarded value expression.
Definition: Specifiers.h:170
Dataflow Directional Tag Classes.
ConstexprSpecKind
Define the kind of constexpr specifier.
Definition: Specifiers.h:32
This template specialization was instantiated from a template due to an explicit instantiation declar...
Definition: Specifiers.h:189
TemplateSpecializationKind
Describes the kind of template specialization that a particular template specialization declaration r...
Definition: Specifiers.h:175
This template specialization was declared or defined by an explicit specialization (C++ [temp...
Definition: Specifiers.h:185
A bitfield object is a bitfield on a C or C++ record.
Definition: Specifiers.h:144
Structure that packs information about the type specifiers that were written in a particular type spe...
Definition: Specifiers.h:103
ThreadStorageClassSpecifier
Thread storage-class-specifier.
Definition: Specifiers.h:222
TypeSpecifierWidth
Specifies the width of a type, e.g., short, long, or long long.
Definition: Specifiers.h:40
unsigned kind
All of the diagnostics that can be emitted by the frontend.
Definition: DiagnosticIDs.h:60
Full-expression storage duration (for temporaries).
Definition: Specifiers.h:307
ExplicitSpecKind
Define the meaning of possible values of the kind in ExplicitSpecifier.
Definition: Specifiers.h:25
NonOdrUseReason
The reason why a DeclRefExpr does not constitute an odr-use.
Definition: Specifiers.h:160
An l-value expression is a reference to an object with independent storage.
Definition: Specifiers.h:129
Automatic storage duration (most local variables).
Definition: Specifiers.h:308
llvm::StringRef getNullabilitySpelling(NullabilityKind kind, bool isContextSensitive=false)
Retrieve the spelling of the given nullability kind.
No in-class initializer.
Definition: Specifiers.h:259
This parameter (which must have pointer type) is a Swift indirect result parameter.