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