blob: b2bb9a13771de304f4cf2ae8380d52a0fac0964c [file] [log] [blame]
Douglas Gregor2cf26342009-04-09 22:27:44 +00001//===- PCHBitCodes.h - Enum values for the PCH bitcode format ---*- 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// This header defines Bitcode enum values for Clang precompiled header files.
11//
12// The enum values defined in this file should be considered permanent. If
13// new features are added, they should have values added at the end of the
14// respective lists.
15//
16//===----------------------------------------------------------------------===//
17#ifndef LLVM_CLANG_FRONTEND_PCHBITCODES_H
18#define LLVM_CLANG_FRONTEND_PCHBITCODES_H
19
20#include "llvm/Bitcode/BitCodes.h"
Chandler Carruth9f8eb202009-10-26 01:37:10 +000021#include "llvm/System/DataTypes.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000022
23namespace clang {
24 namespace pch {
Douglas Gregorab41e632009-04-27 22:23:34 +000025 /// \brief PCH major version number supported by this version of
26 /// Clang.
27 ///
28 /// Whenever the PCH format changes in a way that makes it
29 /// incompatible with previous versions (such that a reader
30 /// designed for the previous version could not support reading
31 /// the new version), this number should be increased.
Douglas Gregor445e23e2009-10-05 21:07:28 +000032 ///
33 /// Version 3 of PCH files also requires that the Subversion branch and
34 /// revision match exactly, since there is no backward compatibility of
35 /// PCH files at this time.
36 const unsigned VERSION_MAJOR = 3;
Douglas Gregorab41e632009-04-27 22:23:34 +000037
38 /// \brief PCH minor version number supported by this version of
39 /// Clang.
40 ///
41 /// Whenever the PCH format changes in a way that is still
42 /// compatible with previous versions (such that a reader designed
43 /// for the previous version could still support reading the new
44 /// version by ignoring new kinds of subblocks), this number
45 /// should be increased.
46 const unsigned VERSION_MINOR = 0;
47
Douglas Gregor8038d512009-04-10 17:25:41 +000048 /// \brief An ID number that refers to a declaration in a PCH file.
49 ///
50 /// The ID numbers of types are consecutive (in order of
51 /// discovery) and start at 2. 0 is reserved for NULL, and 1 is
52 /// reserved for the translation unit declaration.
53 typedef uint32_t DeclID;
54
55 /// \brief An ID number that refers to a type in a PCH file.
56 ///
57 /// The ID of a type is partitioned into two parts: the lower
58 /// three bits are used to store the const/volatile/restrict
59 /// qualifiers (as with QualType) and the upper bits provide a
60 /// type index. The type index values are partitioned into two
61 /// sets. The values below NUM_PREDEF_TYPE_IDs are predefined type
62 /// IDs (based on the PREDEF_TYPE_*_ID constants), with 0 as a
63 /// placeholder for "no type". Values from NUM_PREDEF_TYPE_IDs are
64 /// other types that have serialized representations.
65 typedef uint32_t TypeID;
Douglas Gregor2cf26342009-04-09 22:27:44 +000066
Douglas Gregorafaf3082009-04-11 00:14:32 +000067 /// \brief An ID number that refers to an identifier in a PCH
68 /// file.
69 typedef uint32_t IdentID;
70
Steve Naroff90cd1bb2009-04-23 10:39:46 +000071 typedef uint32_t SelectorID;
Mike Stump1eb44332009-09-09 15:08:12 +000072
Douglas Gregor2cf26342009-04-09 22:27:44 +000073 /// \brief Describes the various kinds of blocks that occur within
74 /// a PCH file.
75 enum BlockIDs {
76 /// \brief The PCH block, which acts as a container around the
77 /// full PCH block.
78 PCH_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID,
Douglas Gregor14f79002009-04-10 03:52:48 +000079
Douglas Gregor14f79002009-04-10 03:52:48 +000080 /// \brief The block containing information about the source
81 /// manager.
82 SOURCE_MANAGER_BLOCK_ID,
83
84 /// \brief The block containing information about the
85 /// preprocessor.
86 PREPROCESSOR_BLOCK_ID,
87
Douglas Gregor2cf26342009-04-09 22:27:44 +000088 /// \brief The block containing the definitions of all of the
Douglas Gregor61d60ee2009-10-17 00:13:19 +000089 /// types and decls used within the PCH file.
90 DECLTYPES_BLOCK_ID
Douglas Gregor8038d512009-04-10 17:25:41 +000091 };
Douglas Gregor2cf26342009-04-09 22:27:44 +000092
Douglas Gregor8038d512009-04-10 17:25:41 +000093 /// \brief Record types that occur within the PCH block itself.
94 enum PCHRecordTypes {
Douglas Gregor61d60ee2009-10-17 00:13:19 +000095 /// \brief Record code for the offsets of each type.
Douglas Gregor2cf26342009-04-09 22:27:44 +000096 ///
Douglas Gregor8038d512009-04-10 17:25:41 +000097 /// The TYPE_OFFSET constant describes the record that occurs
Douglas Gregor61d60ee2009-10-17 00:13:19 +000098 /// within the PCH block. The record itself is an array of offsets that
99 /// point into the declarations and types block (identified by
100 /// DECLTYPES_BLOCK_ID). The index into the array is based on the ID
Douglas Gregor8038d512009-04-10 17:25:41 +0000101 /// of a type. For a given type ID @c T, the lower three bits of
102 /// @c T are its qualifiers (const, volatile, restrict), as in
103 /// the QualType class. The upper bits, after being shifted and
104 /// subtracting NUM_PREDEF_TYPE_IDS, are used to index into the
105 /// TYPE_OFFSET block to determine the offset of that type's
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000106 /// corresponding record within the DECLTYPES_BLOCK_ID block.
Douglas Gregor8038d512009-04-10 17:25:41 +0000107 TYPE_OFFSET = 1,
Mike Stump1eb44332009-09-09 15:08:12 +0000108
Douglas Gregor8038d512009-04-10 17:25:41 +0000109 /// \brief Record code for the offsets of each decl.
110 ///
111 /// The DECL_OFFSET constant describes the record that occurs
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000112 /// within the block identified by DECL_OFFSETS_BLOCK_ID within
113 /// the PCH block. The record itself is an array of offsets that
114 /// point into the declarations and types block (identified by
115 /// DECLTYPES_BLOCK_ID). The declaration ID is an index into this
Douglas Gregor8038d512009-04-10 17:25:41 +0000116 /// record, after subtracting one to account for the use of
117 /// declaration ID 0 for a NULL declaration pointer. Index 0 is
118 /// reserved for the translation unit declaration.
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000119 DECL_OFFSET = 2,
120
121 /// \brief Record code for the language options table.
122 ///
123 /// The record with this code contains the contents of the
124 /// LangOptions structure. We serialize the entire contents of
125 /// the structure, and let the reader decide which options are
126 /// actually important to check.
Douglas Gregor2bec0412009-04-10 21:16:55 +0000127 LANGUAGE_OPTIONS = 3,
128
Douglas Gregorab41e632009-04-27 22:23:34 +0000129 /// \brief PCH metadata, including the PCH file version number
130 /// and the target triple used to build the PCH file.
131 METADATA = 4,
Douglas Gregorafaf3082009-04-11 00:14:32 +0000132
133 /// \brief Record code for the table of offsets of each
134 /// identifier ID.
135 ///
136 /// The offset table contains offsets into the blob stored in
137 /// the IDENTIFIER_TABLE record. Each offset points to the
138 /// NULL-terminated string that corresponds to that identifier.
139 IDENTIFIER_OFFSET = 5,
140
141 /// \brief Record code for the identifier table.
142 ///
143 /// The identifier table is a simple blob that contains
144 /// NULL-terminated strings for all of the identifiers
145 /// referenced by the PCH file. The IDENTIFIER_OFFSET table
146 /// contains the mapping from identifier IDs to the characters
147 /// in this blob. Note that the starting offsets of all of the
148 /// identifiers are odd, so that, when the identifier offset
149 /// table is loaded in, we can use the low bit to distinguish
150 /// between offsets (for unresolved identifier IDs) and
151 /// IdentifierInfo pointers (for already-resolved identifier
152 /// IDs).
Douglas Gregorfdd01722009-04-14 00:24:19 +0000153 IDENTIFIER_TABLE = 6,
154
155 /// \brief Record code for the array of external definitions.
156 ///
Douglas Gregor4c0e86b2009-04-22 22:02:47 +0000157 /// The PCH file contains a list of all of the unnamed external
Douglas Gregorfdd01722009-04-14 00:24:19 +0000158 /// definitions present within the parsed headers, stored as an
159 /// array of declaration IDs. These external definitions will be
160 /// reported to the AST consumer after the PCH file has been
161 /// read, since their presence can affect the semantics of the
162 /// program (e.g., for code generation).
Douglas Gregor3e1af842009-04-17 22:13:46 +0000163 EXTERNAL_DEFINITIONS = 7,
164
Douglas Gregorad1de002009-04-18 05:55:16 +0000165 /// \brief Record code for the set of non-builtin, special
166 /// types.
167 ///
168 /// This record contains the type IDs for the various type nodes
169 /// that are constructed during semantic analysis (e.g.,
170 /// __builtin_va_list). The SPECIAL_TYPE_* constants provide
171 /// offsets into this record.
172 SPECIAL_TYPES = 8,
173
Douglas Gregor4c0e86b2009-04-22 22:02:47 +0000174 /// \brief Record code for the extra statistics we gather while
175 /// generating a PCH file.
176 STATISTICS = 9,
177
178 /// \brief Record code for the array of tentative definitions.
Douglas Gregor14c22f22009-04-22 22:18:58 +0000179 TENTATIVE_DEFINITIONS = 10,
180
181 /// \brief Record code for the array of locally-scoped external
182 /// declarations.
Steve Naroff90cd1bb2009-04-23 10:39:46 +0000183 LOCALLY_SCOPED_EXTERNAL_DECLS = 11,
Mike Stump1eb44332009-09-09 15:08:12 +0000184
Douglas Gregor83941df2009-04-25 17:48:32 +0000185 /// \brief Record code for the table of offsets into the
186 /// Objective-C method pool.
187 SELECTOR_OFFSETS = 12,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000188
189 /// \brief Record code for the Objective-C method pool,
Douglas Gregor2eafc1b2009-04-26 00:07:37 +0000190 METHOD_POOL = 13,
191
192 /// \brief The value of the next __COUNTER__ to dispense.
193 /// [PP_COUNTER_VALUE, Val]
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000194 PP_COUNTER_VALUE = 14,
195
196 /// \brief Record code for the table of offsets into the block
197 /// of source-location information.
198 SOURCE_LOCATION_OFFSETS = 15,
199
200 /// \brief Record code for the set of source location entries
201 /// that need to be preloaded by the PCH reader.
202 ///
203 /// This set contains the source location entry for the
204 /// predefines buffer and for any file entries that need to be
205 /// preloaded.
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000206 SOURCE_LOCATION_PRELOADS = 16,
207
208 /// \brief Record code for the stat() cache.
Douglas Gregorb81c1702009-04-27 20:06:05 +0000209 STAT_CACHE = 17,
210
211 /// \brief Record code for the set of ext_vector type names.
212 EXT_VECTOR_DECLS = 18,
213
Douglas Gregorb64c1932009-05-12 01:31:05 +0000214 /// \brief Record code for the original file that was used to
215 /// generate the precompiled header.
Argyrios Kyrtzidis1cb35dd2009-07-21 00:06:20 +0000216 ORIGINAL_FILE_NAME = 19,
Mike Stump1eb44332009-09-09 15:08:12 +0000217
Douglas Gregor2e222532009-07-02 17:08:52 +0000218 /// \brief Record code for the sorted array of source ranges where
219 /// comments were encountered in the source code.
Douglas Gregor445e23e2009-10-05 21:07:28 +0000220 COMMENT_RANGES = 20,
221
222 /// \brief Record code for the Subversion branch and revision information
223 /// of the compiler used to build this PCH file.
224 SVN_BRANCH_REVISION = 21
Douglas Gregor2cf26342009-04-09 22:27:44 +0000225 };
226
Douglas Gregor14f79002009-04-10 03:52:48 +0000227 /// \brief Record types used within a source manager block.
228 enum SourceManagerRecordTypes {
229 /// \brief Describes a source location entry (SLocEntry) for a
230 /// file.
231 SM_SLOC_FILE_ENTRY = 1,
232 /// \brief Describes a source location entry (SLocEntry) for a
233 /// buffer.
234 SM_SLOC_BUFFER_ENTRY = 2,
235 /// \brief Describes a blob that contains the data for a buffer
236 /// entry. This kind of record always directly follows a
237 /// SM_SLOC_BUFFER_ENTRY record.
238 SM_SLOC_BUFFER_BLOB = 3,
239 /// \brief Describes a source location entry (SLocEntry) for a
240 /// macro instantiation.
Douglas Gregorbd945002009-04-13 16:31:14 +0000241 SM_SLOC_INSTANTIATION_ENTRY = 4,
242 /// \brief Describes the SourceManager's line table, with
243 /// information about #line directives.
Douglas Gregor2eafc1b2009-04-26 00:07:37 +0000244 SM_LINE_TABLE = 5,
245 /// \brief Describes one header file info [isImport, DirInfo, NumIncludes]
246 /// ControllingMacro is optional.
247 SM_HEADER_FILE_INFO = 6
Douglas Gregor14f79002009-04-10 03:52:48 +0000248 };
Mike Stump1eb44332009-09-09 15:08:12 +0000249
Chris Lattner7c5d24e2009-04-10 18:00:12 +0000250 /// \brief Record types used within a preprocessor block.
251 enum PreprocessorRecordTypes {
252 // The macros in the PP section are a PP_MACRO_* instance followed by a
253 // list of PP_TOKEN instances for each token in the definition.
254
255 /// \brief An object-like macro definition.
256 /// [PP_MACRO_OBJECT_LIKE, IdentInfoID, SLoc, IsUsed]
257 PP_MACRO_OBJECT_LIKE = 1,
258
259 /// \brief A function-like macro definition.
260 /// [PP_MACRO_FUNCTION_LIKE, <ObjectLikeStuff>, IsC99Varargs, IsGNUVarars,
261 /// NumArgs, ArgIdentInfoID* ]
262 PP_MACRO_FUNCTION_LIKE = 2,
Mike Stump1eb44332009-09-09 15:08:12 +0000263
Chris Lattner7c5d24e2009-04-10 18:00:12 +0000264 /// \brief Describes one token.
Chris Lattnerc1f9d822009-04-13 01:29:17 +0000265 /// [PP_TOKEN, SLoc, Length, IdentInfoID, Kind, Flags]
Douglas Gregor2eafc1b2009-04-26 00:07:37 +0000266 PP_TOKEN = 3
Chris Lattner7c5d24e2009-04-10 18:00:12 +0000267 };
Douglas Gregor14f79002009-04-10 03:52:48 +0000268
269 /// \defgroup PCHAST Precompiled header AST constants
270 ///
271 /// The constants in this group describe various components of the
272 /// abstract syntax tree within a precompiled header.
273 ///
274 /// @{
275
Douglas Gregor2cf26342009-04-09 22:27:44 +0000276 /// \brief Predefined type IDs.
277 ///
278 /// These type IDs correspond to predefined types in the AST
279 /// context, such as built-in types (int) and special place-holder
280 /// types (the <overload> and <dependent> type markers). Such
281 /// types are never actually serialized, since they will be built
282 /// by the AST context when it is created.
283 enum PredefinedTypeIDs {
284 /// \brief The NULL type.
285 PREDEF_TYPE_NULL_ID = 0,
286 /// \brief The void type.
287 PREDEF_TYPE_VOID_ID = 1,
288 /// \brief The 'bool' or '_Bool' type.
289 PREDEF_TYPE_BOOL_ID = 2,
290 /// \brief The 'char' type, when it is unsigned.
291 PREDEF_TYPE_CHAR_U_ID = 3,
292 /// \brief The 'unsigned char' type.
293 PREDEF_TYPE_UCHAR_ID = 4,
294 /// \brief The 'unsigned short' type.
295 PREDEF_TYPE_USHORT_ID = 5,
296 /// \brief The 'unsigned int' type.
297 PREDEF_TYPE_UINT_ID = 6,
298 /// \brief The 'unsigned long' type.
299 PREDEF_TYPE_ULONG_ID = 7,
300 /// \brief The 'unsigned long long' type.
301 PREDEF_TYPE_ULONGLONG_ID = 8,
302 /// \brief The 'char' type, when it is signed.
303 PREDEF_TYPE_CHAR_S_ID = 9,
304 /// \brief The 'signed char' type.
305 PREDEF_TYPE_SCHAR_ID = 10,
306 /// \brief The C++ 'wchar_t' type.
307 PREDEF_TYPE_WCHAR_ID = 11,
308 /// \brief The (signed) 'short' type.
309 PREDEF_TYPE_SHORT_ID = 12,
310 /// \brief The (signed) 'int' type.
311 PREDEF_TYPE_INT_ID = 13,
312 /// \brief The (signed) 'long' type.
313 PREDEF_TYPE_LONG_ID = 14,
314 /// \brief The (signed) 'long long' type.
315 PREDEF_TYPE_LONGLONG_ID = 15,
316 /// \brief The 'float' type.
317 PREDEF_TYPE_FLOAT_ID = 16,
318 /// \brief The 'double' type.
319 PREDEF_TYPE_DOUBLE_ID = 17,
320 /// \brief The 'long double' type.
321 PREDEF_TYPE_LONGDOUBLE_ID = 18,
322 /// \brief The placeholder type for overloaded function sets.
323 PREDEF_TYPE_OVERLOAD_ID = 19,
324 /// \brief The placeholder type for dependent types.
Chris Lattner2df9ced2009-04-30 02:43:43 +0000325 PREDEF_TYPE_DEPENDENT_ID = 20,
326 /// \brief The '__uint128_t' type.
327 PREDEF_TYPE_UINT128_ID = 21,
328 /// \brief The '__int128_t' type.
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000329 PREDEF_TYPE_INT128_ID = 22,
330 /// \brief The type of 'nullptr'.
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000331 PREDEF_TYPE_NULLPTR_ID = 23,
332 /// \brief The C++ 'char16_t' type.
333 PREDEF_TYPE_CHAR16_ID = 24,
334 /// \brief The C++ 'char32_t' type.
Steve Naroffde2e22d2009-07-15 18:40:39 +0000335 PREDEF_TYPE_CHAR32_ID = 25,
336 /// \brief The ObjC 'id' type.
337 PREDEF_TYPE_OBJC_ID = 26,
338 /// \brief The ObjC 'Class' type.
Mike Stump1eb44332009-09-09 15:08:12 +0000339 PREDEF_TYPE_OBJC_CLASS = 27
Douglas Gregor2cf26342009-04-09 22:27:44 +0000340 };
341
342 /// \brief The number of predefined type IDs that are reserved for
343 /// the PREDEF_TYPE_* constants.
344 ///
345 /// Type IDs for non-predefined types will start at
346 /// NUM_PREDEF_TYPE_IDs.
347 const unsigned NUM_PREDEF_TYPE_IDS = 100;
348
349 /// \brief Record codes for each kind of type.
350 ///
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000351 /// These constants describe the type records that can occur within a
352 /// block identified by DECLTYPES_BLOCK_ID in the PCH file. Each
Douglas Gregor2cf26342009-04-09 22:27:44 +0000353 /// constant describes a record for a specific type class in the
354 /// AST.
355 enum TypeCode {
356 /// \brief An ExtQualType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000357 TYPE_EXT_QUAL = 1,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000358 /// \brief A FixedWidthIntType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000359 TYPE_FIXED_WIDTH_INT = 2,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000360 /// \brief A ComplexType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000361 TYPE_COMPLEX = 3,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000362 /// \brief A PointerType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000363 TYPE_POINTER = 4,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000364 /// \brief A BlockPointerType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000365 TYPE_BLOCK_POINTER = 5,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000366 /// \brief An LValueReferenceType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000367 TYPE_LVALUE_REFERENCE = 6,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000368 /// \brief An RValueReferenceType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000369 TYPE_RVALUE_REFERENCE = 7,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000370 /// \brief A MemberPointerType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000371 TYPE_MEMBER_POINTER = 8,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000372 /// \brief A ConstantArrayType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000373 TYPE_CONSTANT_ARRAY = 9,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000374 /// \brief An IncompleteArrayType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000375 TYPE_INCOMPLETE_ARRAY = 10,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000376 /// \brief A VariableArrayType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000377 TYPE_VARIABLE_ARRAY = 11,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000378 /// \brief A VectorType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000379 TYPE_VECTOR = 12,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000380 /// \brief An ExtVectorType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000381 TYPE_EXT_VECTOR = 13,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000382 /// \brief A FunctionNoProtoType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000383 TYPE_FUNCTION_NO_PROTO = 14,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000384 /// \brief A FunctionProtoType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000385 TYPE_FUNCTION_PROTO = 15,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000386 /// \brief A TypedefType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000387 TYPE_TYPEDEF = 16,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000388 /// \brief A TypeOfExprType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000389 TYPE_TYPEOF_EXPR = 17,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000390 /// \brief A TypeOfType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000391 TYPE_TYPEOF = 18,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000392 /// \brief A RecordType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000393 TYPE_RECORD = 19,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000394 /// \brief An EnumType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000395 TYPE_ENUM = 20,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000396 /// \brief An ObjCInterfaceType record.
Douglas Gregor63f5c262009-04-16 02:45:14 +0000397 TYPE_OBJC_INTERFACE = 21,
Steve Naroffd1b3c2d2009-06-17 22:40:22 +0000398 /// \brief An ObjCObjectPointerType record.
Steve Naroffc15cb2a2009-07-18 15:33:26 +0000399 TYPE_OBJC_OBJECT_POINTER = 22,
Anders Carlsson395b4752009-06-24 19:06:50 +0000400 /// \brief a DecltypeType record.
John McCall54e14c42009-10-22 22:37:11 +0000401 TYPE_DECLTYPE = 23,
John McCall7da24312009-09-05 00:15:47 +0000402 /// \brief An ElaboratedType record.
John McCall54e14c42009-10-22 22:37:11 +0000403 TYPE_ELABORATED = 24,
John McCall49a832b2009-10-18 09:09:24 +0000404 /// \brief A SubstTemplateTypeParmType record.
John McCall54e14c42009-10-22 22:37:11 +0000405 TYPE_SUBST_TEMPLATE_TYPE_PARM = 25
Douglas Gregor2cf26342009-04-09 22:27:44 +0000406 };
407
Douglas Gregorad1de002009-04-18 05:55:16 +0000408 /// \brief The type IDs for special types constructed by semantic
409 /// analysis.
410 ///
411 /// The constants in this enumeration are indices into the
412 /// SPECIAL_TYPES record.
413 enum SpecialTypeIDs {
414 /// \brief __builtin_va_list
Douglas Gregor319ac892009-04-23 22:29:11 +0000415 SPECIAL_TYPE_BUILTIN_VA_LIST = 0,
416 /// \brief Objective-C "id" type
417 SPECIAL_TYPE_OBJC_ID = 1,
418 /// \brief Objective-C selector type
419 SPECIAL_TYPE_OBJC_SELECTOR = 2,
420 /// \brief Objective-C Protocol type
421 SPECIAL_TYPE_OBJC_PROTOCOL = 3,
422 /// \brief Objective-C Class type
423 SPECIAL_TYPE_OBJC_CLASS = 4,
424 /// \brief CFConstantString type
425 SPECIAL_TYPE_CF_CONSTANT_STRING = 5,
426 /// \brief Objective-C fast enumeration state type
Douglas Gregorc29f77b2009-07-07 16:35:42 +0000427 SPECIAL_TYPE_OBJC_FAST_ENUMERATION_STATE = 6,
428 /// \brief C FILE typedef type
Mike Stump782fa302009-07-28 02:25:19 +0000429 SPECIAL_TYPE_FILE = 7,
430 /// \brief C jmp_buf typedef type
431 SPECIAL_TYPE_jmp_buf = 8,
432 /// \brief C sigjmp_buf typedef type
Douglas Gregord1571ac2009-08-21 00:27:50 +0000433 SPECIAL_TYPE_sigjmp_buf = 9,
434 /// \brief Objective-C "id" redefinition type
435 SPECIAL_TYPE_OBJC_ID_REDEFINITION = 10,
436 /// \brief Objective-C "Class" redefinition type
Mike Stumpadaaad32009-10-20 02:12:22 +0000437 SPECIAL_TYPE_OBJC_CLASS_REDEFINITION = 11,
438 /// \brief Block descriptor type for Blocks CodeGen
Mike Stump083c25e2009-10-22 00:49:09 +0000439 SPECIAL_TYPE_BLOCK_DESCRIPTOR = 12,
440 /// \brief Block extedned descriptor type for Blocks CodeGen
441 SPECIAL_TYPE_BLOCK_EXTENDED_DESCRIPTOR = 13
Douglas Gregorad1de002009-04-18 05:55:16 +0000442 };
443
Douglas Gregor2cf26342009-04-09 22:27:44 +0000444 /// \brief Record codes for each kind of declaration.
445 ///
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000446 /// These constants describe the declaration records that can occur within
447 /// a declarations block (identified by DECLS_BLOCK_ID). Each
Douglas Gregor2cf26342009-04-09 22:27:44 +0000448 /// constant describes a record for a specific declaration class
449 /// in the AST.
450 enum DeclCode {
Douglas Gregor68a2eb02009-04-15 21:30:51 +0000451 /// \brief Attributes attached to a declaration.
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000452 DECL_ATTR = 50,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000453 /// \brief A TranslationUnitDecl record.
Douglas Gregor68a2eb02009-04-15 21:30:51 +0000454 DECL_TRANSLATION_UNIT,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000455 /// \brief A TypedefDecl record.
456 DECL_TYPEDEF,
Douglas Gregor0a2b45e2009-04-13 18:14:40 +0000457 /// \brief An EnumDecl record.
458 DECL_ENUM,
Douglas Gregor8c700062009-04-13 21:20:57 +0000459 /// \brief A RecordDecl record.
460 DECL_RECORD,
Douglas Gregor0a2b45e2009-04-13 18:14:40 +0000461 /// \brief An EnumConstantDecl record.
462 DECL_ENUM_CONSTANT,
Douglas Gregor3a2f7e42009-04-13 22:18:37 +0000463 /// \brief A FunctionDecl record.
464 DECL_FUNCTION,
Steve Naroff53c9d8a2009-04-20 15:06:07 +0000465 /// \brief A ObjCMethodDecl record.
466 DECL_OBJC_METHOD,
Steve Naroff33feeb02009-04-20 20:09:33 +0000467 /// \brief A ObjCInterfaceDecl record.
Steve Naroff30833f82009-04-21 15:12:33 +0000468 DECL_OBJC_INTERFACE,
469 /// \brief A ObjCProtocolDecl record.
470 DECL_OBJC_PROTOCOL,
Steve Naroff33feeb02009-04-20 20:09:33 +0000471 /// \brief A ObjCIvarDecl record.
Steve Naroff30833f82009-04-21 15:12:33 +0000472 DECL_OBJC_IVAR,
473 /// \brief A ObjCAtDefsFieldDecl record.
474 DECL_OBJC_AT_DEFS_FIELD,
475 /// \brief A ObjCClassDecl record.
476 DECL_OBJC_CLASS,
477 /// \brief A ObjCForwardProtocolDecl record.
478 DECL_OBJC_FORWARD_PROTOCOL,
479 /// \brief A ObjCCategoryDecl record.
480 DECL_OBJC_CATEGORY,
481 /// \brief A ObjCCategoryImplDecl record.
482 DECL_OBJC_CATEGORY_IMPL,
483 /// \brief A ObjCImplementationDecl record.
484 DECL_OBJC_IMPLEMENTATION,
485 /// \brief A ObjCCompatibleAliasDecl record.
486 DECL_OBJC_COMPATIBLE_ALIAS,
487 /// \brief A ObjCPropertyDecl record.
488 DECL_OBJC_PROPERTY,
489 /// \brief A ObjCPropertyImplDecl record.
490 DECL_OBJC_PROPERTY_IMPL,
Douglas Gregor8c700062009-04-13 21:20:57 +0000491 /// \brief A FieldDecl record.
492 DECL_FIELD,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000493 /// \brief A VarDecl record.
494 DECL_VAR,
Douglas Gregor405bad02009-04-26 22:20:50 +0000495 /// \brief An ImplicitParamDecl record.
496 DECL_IMPLICIT_PARAM,
Douglas Gregor3a2f7e42009-04-13 22:18:37 +0000497 /// \brief A ParmVarDecl record.
498 DECL_PARM_VAR,
Douglas Gregor1028bc62009-04-13 22:49:25 +0000499 /// \brief A FileScopeAsmDecl record.
500 DECL_FILE_SCOPE_ASM,
501 /// \brief A BlockDecl record.
502 DECL_BLOCK,
Douglas Gregor2cf26342009-04-09 22:27:44 +0000503 /// \brief A record that stores the set of declarations that are
504 /// lexically stored within a given DeclContext.
505 ///
506 /// The record itself is an array of declaration IDs, in the
507 /// order in which those declarations were added to the
508 /// declaration context. This data is used when iterating over
509 /// the contents of a DeclContext, e.g., via
510 /// DeclContext::decls_begin()/DeclContext::decls_end().
511 DECL_CONTEXT_LEXICAL,
512 /// \brief A record that stores the set of declarations that are
513 /// visible from a given DeclContext.
514 ///
515 /// The record itself stores a set of mappings, each of which
516 /// associates a declaration name with one or more declaration
517 /// IDs. This data is used when performing qualified name lookup
518 /// into a DeclContext via DeclContext::lookup.
519 DECL_CONTEXT_VISIBLE
520 };
Douglas Gregor0b748912009-04-14 21:18:50 +0000521
522 /// \brief Record codes for each kind of statement or expression.
523 ///
524 /// These constants describe the records that describe statements
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000525 /// or expressions. These records occur within type and declarations
526 /// block, so they begin with record values of 100. Each constant
527 /// describes a record for a specific statement or expression class in the
528 /// AST.
Douglas Gregor0b748912009-04-14 21:18:50 +0000529 enum StmtCode {
Douglas Gregor087fd532009-04-14 23:32:43 +0000530 /// \brief A marker record that indicates that we are at the end
531 /// of an expression.
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000532 STMT_STOP = 100,
Douglas Gregor0b748912009-04-14 21:18:50 +0000533 /// \brief A NULL expression.
Douglas Gregorc9490c02009-04-16 22:23:12 +0000534 STMT_NULL_PTR,
Douglas Gregor025452f2009-04-17 00:04:06 +0000535 /// \brief A NullStmt record.
536 STMT_NULL,
537 /// \brief A CompoundStmt record.
538 STMT_COMPOUND,
539 /// \brief A CaseStmt record.
540 STMT_CASE,
541 /// \brief A DefaultStmt record.
542 STMT_DEFAULT,
Douglas Gregor1de05fe2009-04-17 18:18:49 +0000543 /// \brief A LabelStmt record.
544 STMT_LABEL,
Douglas Gregor025452f2009-04-17 00:04:06 +0000545 /// \brief An IfStmt record.
546 STMT_IF,
547 /// \brief A SwitchStmt record.
548 STMT_SWITCH,
Douglas Gregord921cf92009-04-17 00:16:09 +0000549 /// \brief A WhileStmt record.
550 STMT_WHILE,
Douglas Gregor67d82492009-04-17 00:29:51 +0000551 /// \brief A DoStmt record.
552 STMT_DO,
553 /// \brief A ForStmt record.
554 STMT_FOR,
Douglas Gregor1de05fe2009-04-17 18:18:49 +0000555 /// \brief A GotoStmt record.
556 STMT_GOTO,
Douglas Gregor7d5c2f22009-04-17 18:58:21 +0000557 /// \brief An IndirectGotoStmt record.
558 STMT_INDIRECT_GOTO,
Douglas Gregord921cf92009-04-17 00:16:09 +0000559 /// \brief A ContinueStmt record.
560 STMT_CONTINUE,
Douglas Gregor025452f2009-04-17 00:04:06 +0000561 /// \brief A BreakStmt record.
562 STMT_BREAK,
Douglas Gregor0de9d882009-04-17 16:34:57 +0000563 /// \brief A ReturnStmt record.
564 STMT_RETURN,
Douglas Gregor84f21702009-04-17 16:55:36 +0000565 /// \brief A DeclStmt record.
566 STMT_DECL,
Douglas Gregorcd7d5a92009-04-17 20:57:14 +0000567 /// \brief An AsmStmt record.
568 STMT_ASM,
Douglas Gregor17fc2232009-04-14 21:55:33 +0000569 /// \brief A PredefinedExpr record.
570 EXPR_PREDEFINED,
Douglas Gregor0b748912009-04-14 21:18:50 +0000571 /// \brief A DeclRefExpr record.
572 EXPR_DECL_REF,
573 /// \brief An IntegerLiteral record.
574 EXPR_INTEGER_LITERAL,
Douglas Gregor17fc2232009-04-14 21:55:33 +0000575 /// \brief A FloatingLiteral record.
576 EXPR_FLOATING_LITERAL,
Douglas Gregorcb2ca732009-04-15 22:19:53 +0000577 /// \brief An ImaginaryLiteral record.
578 EXPR_IMAGINARY_LITERAL,
Douglas Gregor673ecd62009-04-15 16:35:07 +0000579 /// \brief A StringLiteral record.
580 EXPR_STRING_LITERAL,
Douglas Gregor0b748912009-04-14 21:18:50 +0000581 /// \brief A CharacterLiteral record.
Douglas Gregor087fd532009-04-14 23:32:43 +0000582 EXPR_CHARACTER_LITERAL,
Douglas Gregorc04db4f2009-04-14 23:59:37 +0000583 /// \brief A ParenExpr record.
584 EXPR_PAREN,
Douglas Gregor0b0b77f2009-04-15 15:58:59 +0000585 /// \brief A UnaryOperator record.
586 EXPR_UNARY_OPERATOR,
587 /// \brief A SizefAlignOfExpr record.
588 EXPR_SIZEOF_ALIGN_OF,
Douglas Gregorcb2ca732009-04-15 22:19:53 +0000589 /// \brief An ArraySubscriptExpr record.
590 EXPR_ARRAY_SUBSCRIPT,
Douglas Gregor1f0d0132009-04-15 17:43:59 +0000591 /// \brief A CallExpr record.
592 EXPR_CALL,
593 /// \brief A MemberExpr record.
594 EXPR_MEMBER,
Douglas Gregordb600c32009-04-15 00:25:59 +0000595 /// \brief A BinaryOperator record.
596 EXPR_BINARY_OPERATOR,
Douglas Gregorad90e962009-04-15 22:40:36 +0000597 /// \brief A CompoundAssignOperator record.
598 EXPR_COMPOUND_ASSIGN_OPERATOR,
599 /// \brief A ConditionOperator record.
600 EXPR_CONDITIONAL_OPERATOR,
Douglas Gregor087fd532009-04-14 23:32:43 +0000601 /// \brief An ImplicitCastExpr record.
Douglas Gregordb600c32009-04-15 00:25:59 +0000602 EXPR_IMPLICIT_CAST,
603 /// \brief A CStyleCastExpr record.
Douglas Gregord3c98a02009-04-15 23:02:49 +0000604 EXPR_CSTYLE_CAST,
Douglas Gregorba6d7e72009-04-16 02:33:48 +0000605 /// \brief A CompoundLiteralExpr record.
606 EXPR_COMPOUND_LITERAL,
Douglas Gregord3c98a02009-04-15 23:02:49 +0000607 /// \brief An ExtVectorElementExpr record.
608 EXPR_EXT_VECTOR_ELEMENT,
Douglas Gregord077d752009-04-16 00:55:48 +0000609 /// \brief An InitListExpr record.
610 EXPR_INIT_LIST,
611 /// \brief A DesignatedInitExpr record.
612 EXPR_DESIGNATED_INIT,
613 /// \brief An ImplicitValueInitExpr record.
614 EXPR_IMPLICIT_VALUE_INIT,
Douglas Gregord3c98a02009-04-15 23:02:49 +0000615 /// \brief A VAArgExpr record.
Douglas Gregor44cae0c2009-04-15 23:33:31 +0000616 EXPR_VA_ARG,
Douglas Gregor6a2dd552009-04-17 19:05:30 +0000617 /// \brief An AddrLabelExpr record.
Douglas Gregor7d5c2f22009-04-17 18:58:21 +0000618 EXPR_ADDR_LABEL,
Douglas Gregor6a2dd552009-04-17 19:05:30 +0000619 /// \brief A StmtExpr record.
620 EXPR_STMT,
Douglas Gregor44cae0c2009-04-15 23:33:31 +0000621 /// \brief A TypesCompatibleExpr record.
622 EXPR_TYPES_COMPATIBLE,
623 /// \brief A ChooseExpr record.
624 EXPR_CHOOSE,
625 /// \brief A GNUNullExpr record.
Douglas Gregor94cd5d12009-04-16 00:01:45 +0000626 EXPR_GNU_NULL,
627 /// \brief A ShuffleVectorExpr record.
628 EXPR_SHUFFLE_VECTOR,
Douglas Gregor84af7c22009-04-17 19:21:43 +0000629 /// \brief BlockExpr
630 EXPR_BLOCK,
631 /// \brief A BlockDeclRef record.
Chris Lattner4dcf151a2009-04-22 05:57:30 +0000632 EXPR_BLOCK_DECL_REF,
Douglas Gregor39da0b82009-09-09 23:08:42 +0000633
Chris Lattner4dcf151a2009-04-22 05:57:30 +0000634 // Objective-C
Mike Stump1eb44332009-09-09 15:08:12 +0000635
Chris Lattner0389e6b2009-04-26 00:44:05 +0000636 /// \brief An ObjCStringLiteral record.
Chris Lattner3a57a372009-04-22 06:29:42 +0000637 EXPR_OBJC_STRING_LITERAL,
Chris Lattner0389e6b2009-04-26 00:44:05 +0000638 /// \brief An ObjCEncodeExpr record.
Chris Lattner3a57a372009-04-22 06:29:42 +0000639 EXPR_OBJC_ENCODE,
Chris Lattner0389e6b2009-04-26 00:44:05 +0000640 /// \brief An ObjCSelectorExpr record.
Chris Lattner3a57a372009-04-22 06:29:42 +0000641 EXPR_OBJC_SELECTOR_EXPR,
Chris Lattner0389e6b2009-04-26 00:44:05 +0000642 /// \brief An ObjCProtocolExpr record.
Steve Naroffc4f0bbd2009-04-25 14:04:28 +0000643 EXPR_OBJC_PROTOCOL_EXPR,
Chris Lattner0389e6b2009-04-26 00:44:05 +0000644 /// \brief An ObjCIvarRefExpr record.
645 EXPR_OBJC_IVAR_REF_EXPR,
646 /// \brief An ObjCPropertyRefExpr record.
647 EXPR_OBJC_PROPERTY_REF_EXPR,
Fariborz Jahanian09105f52009-08-20 17:02:02 +0000648 /// \brief An ObjCImplicitSetterGetterRefExpr record.
Chris Lattner0389e6b2009-04-26 00:44:05 +0000649 EXPR_OBJC_KVC_REF_EXPR,
650 /// \brief An ObjCMessageExpr record.
651 EXPR_OBJC_MESSAGE_EXPR,
652 /// \brief An ObjCSuperExpr record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000653 EXPR_OBJC_SUPER_EXPR,
Steve Narofff242b1b2009-07-24 17:54:45 +0000654 /// \brief An ObjCIsa Expr record.
655 EXPR_OBJC_ISA,
Mike Stump1eb44332009-09-09 15:08:12 +0000656
657 /// \brief An ObjCForCollectionStmt record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000658 STMT_OBJC_FOR_COLLECTION,
Mike Stump1eb44332009-09-09 15:08:12 +0000659 /// \brief An ObjCAtCatchStmt record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000660 STMT_OBJC_CATCH,
Mike Stump1eb44332009-09-09 15:08:12 +0000661 /// \brief An ObjCAtFinallyStmt record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000662 STMT_OBJC_FINALLY,
Mike Stump1eb44332009-09-09 15:08:12 +0000663 /// \brief An ObjCAtTryStmt record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000664 STMT_OBJC_AT_TRY,
Mike Stump1eb44332009-09-09 15:08:12 +0000665 /// \brief An ObjCAtSynchronizedStmt record.
Steve Naroff1eb55402009-04-26 18:52:16 +0000666 STMT_OBJC_AT_SYNCHRONIZED,
Mike Stump1eb44332009-09-09 15:08:12 +0000667 /// \brief An ObjCAtThrowStmt record.
Argyrios Kyrtzidisba0a9002009-07-14 03:19:21 +0000668 STMT_OBJC_AT_THROW,
669
670 // C++
671
Douglas Gregor39da0b82009-09-09 23:08:42 +0000672 /// \brief A CXXOperatorCallExpr record.
673 EXPR_CXX_OPERATOR_CALL,
674 /// \brief A CXXConstructExpr record.
675 EXPR_CXX_CONSTRUCT
Douglas Gregor0b748912009-04-14 21:18:50 +0000676 };
Douglas Gregord077d752009-04-16 00:55:48 +0000677
678 /// \brief The kinds of designators that can occur in a
679 /// DesignatedInitExpr.
680 enum DesignatorTypes {
681 /// \brief Field designator where only the field name is known.
682 DESIG_FIELD_NAME = 0,
683 /// \brief Field designator where the field has been resolved to
684 /// a declaration.
685 DESIG_FIELD_DECL = 1,
686 /// \brief Array designator.
687 DESIG_ARRAY = 2,
688 /// \brief GNU array range designator.
689 DESIG_ARRAY_RANGE = 3
690 };
691
Douglas Gregor14f79002009-04-10 03:52:48 +0000692 /// @}
Douglas Gregor2cf26342009-04-09 22:27:44 +0000693 }
694} // end namespace clang
695
696#endif