1 //===- ASTBitCodes.h - Enum values for the PCH bitcode format ---*- 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 // This header defines Bitcode enum values for Clang serialized AST files.
10 //
11 // The enum values defined in this file should be considered permanent.  If
12 // new features are added, they should have values added at the end of the
13 // respective lists.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_CLANG_SERIALIZATION_ASTBITCODES_H
18 #define LLVM_CLANG_SERIALIZATION_ASTBITCODES_H
19 
20 #include "clang/AST/DeclarationName.h"
21 #include "clang/AST/Type.h"
22 #include "clang/Basic/IdentifierTable.h"
23 #include "clang/Basic/OperatorKinds.h"
24 #include "clang/Basic/SourceLocation.h"
25 #include "llvm/ADT/DenseMapInfo.h"
26 #include "llvm/Bitstream/BitCodes.h"
27 #include <cassert>
28 #include <cstdint>
29 
30 namespace clang {
31 namespace serialization {
32 
33 /// AST file major version number supported by this version of
34 /// Clang.
35 ///
36 /// Whenever the AST file format changes in a way that makes it
37 /// incompatible with previous versions (such that a reader
38 /// designed for the previous version could not support reading
39 /// the new version), this number should be increased.
40 ///
41 /// Version 4 of AST files also requires that the version control branch and
42 /// revision match exactly, since there is no backward compatibility of
43 /// AST files at this time.
44 const unsigned VERSION_MAJOR = 15;
45 
46 /// AST file minor version number supported by this version of
47 /// Clang.
48 ///
49 /// Whenever the AST format changes in a way that is still
50 /// compatible with previous versions (such that a reader designed
51 /// for the previous version could still support reading the new
52 /// version by ignoring new kinds of subblocks), this number
53 /// should be increased.
54 const unsigned VERSION_MINOR = 0;
55 
56 /// An ID number that refers to an identifier in an AST file.
57 ///
58 /// The ID numbers of identifiers are consecutive (in order of discovery)
59 /// and start at 1. 0 is reserved for NULL.
60 using IdentifierID = uint32_t;
61 
62 /// An ID number that refers to a declaration in an AST file.
63 ///
64 /// The ID numbers of declarations are consecutive (in order of
65 /// discovery), with values below NUM_PREDEF_DECL_IDS being reserved.
66 /// At the start of a chain of precompiled headers, declaration ID 1 is
67 /// used for the translation unit declaration.
68 using DeclID = uint32_t;
69 
70 // FIXME: Turn these into classes so we can have some type safety when
71 // we go from local ID to global and vice-versa.
72 using LocalDeclID = DeclID;
73 using GlobalDeclID = DeclID;
74 
75 /// An ID number that refers to a type in an AST file.
76 ///
77 /// The ID of a type is partitioned into two parts: the lower
78 /// three bits are used to store the const/volatile/restrict
79 /// qualifiers (as with QualType) and the upper bits provide a
80 /// type index. The type index values are partitioned into two
81 /// sets. The values below NUM_PREDEF_TYPE_IDs are predefined type
82 /// IDs (based on the PREDEF_TYPE_*_ID constants), with 0 as a
83 /// placeholder for "no type". Values from NUM_PREDEF_TYPE_IDs are
84 /// other types that have serialized representations.
85 using TypeID = uint32_t;
86 
87 /// A type index; the type ID with the qualifier bits removed.
88 class TypeIdx {
89   uint32_t Idx = 0;
90 
91 public:
92   TypeIdx() = default;
93   explicit TypeIdx(uint32_t index) : Idx(index) {}
94 
95   uint32_t getIndex() const { return Idx; }
96 
97   TypeID asTypeID(unsigned FastQuals) const {
98     if (Idx == uint32_t(-1))
99       return TypeID(-1);
100 
101     return (Idx << Qualifiers::FastWidth) | FastQuals;
102   }
103 
104   static TypeIdx fromTypeID(TypeID ID) {
105     if (ID == TypeID(-1))
106       return TypeIdx(-1);
107 
108     return TypeIdx(ID >> Qualifiers::FastWidth);
109   }
110 };
111 
112 /// A structure for putting "fast"-unqualified QualTypes into a
113 /// DenseMap.  This uses the standard pointer hash function.
114 struct UnsafeQualTypeDenseMapInfo {
115   static bool isEqual(QualType A, QualType B) { return A == B; }
116 
117   static QualType getEmptyKey() {
118     return QualType::getFromOpaquePtr((void *)1);
119   }
120 
121   static QualType getTombstoneKey() {
122     return QualType::getFromOpaquePtr((void *)2);
123   }
124 
125   static unsigned getHashValue(QualType T) {
126     assert(!T.getLocalFastQualifiers() &&
127            "hash invalid for types with fast quals");
128     uintptr_t v = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
129     return (unsigned(v) >> 4) ^ (unsigned(v) >> 9);
130   }
131 };
132 
133 /// An ID number that refers to an identifier in an AST file.
134 using IdentID = uint32_t;
135 
136 /// The number of predefined identifier IDs.
137 const unsigned int NUM_PREDEF_IDENT_IDS = 1;
138 
139 /// An ID number that refers to a macro in an AST file.
140 using MacroID = uint32_t;
141 
142 /// A global ID number that refers to a macro in an AST file.
143 using GlobalMacroID = uint32_t;
144 
145 /// A local to a module ID number that refers to a macro in an
146 /// AST file.
147 using LocalMacroID = uint32_t;
148 
149 /// The number of predefined macro IDs.
150 const unsigned int NUM_PREDEF_MACRO_IDS = 1;
151 
152 /// An ID number that refers to an ObjC selector in an AST file.
153 using SelectorID = uint32_t;
154 
155 /// The number of predefined selector IDs.
156 const unsigned int NUM_PREDEF_SELECTOR_IDS = 1;
157 
158 /// An ID number that refers to a set of CXXBaseSpecifiers in an
159 /// AST file.
160 using CXXBaseSpecifiersID = uint32_t;
161 
162 /// An ID number that refers to a list of CXXCtorInitializers in an
163 /// AST file.
164 using CXXCtorInitializersID = uint32_t;
165 
166 /// An ID number that refers to an entity in the detailed
167 /// preprocessing record.
168 using PreprocessedEntityID = uint32_t;
169 
170 /// An ID number that refers to a submodule in a module file.
171 using SubmoduleID = uint32_t;
172 
173 /// The number of predefined submodule IDs.
174 const unsigned int NUM_PREDEF_SUBMODULE_IDS = 1;
175 
176 /// Source range/offset of a preprocessed entity.
177 struct PPEntityOffset {
178   /// Raw source location of beginning of range.
179   SourceLocation::UIntTy Begin;
180 
181   /// Raw source location of end of range.
182   SourceLocation::UIntTy End;
183 
184   /// Offset in the AST file relative to ModuleFile::MacroOffsetsBase.
185   uint32_t BitOffset;
186 
187   PPEntityOffset(SourceRange R, uint32_t BitOffset)
188       : Begin(R.getBegin().getRawEncoding()), End(R.getEnd().getRawEncoding()),
189         BitOffset(BitOffset) {}
190 
191   SourceLocation getBegin() const {
192     return SourceLocation::getFromRawEncoding(Begin);
193   }
194 
195   SourceLocation getEnd() const {
196     return SourceLocation::getFromRawEncoding(End);
197   }
198 };
199 
200 /// Source range of a skipped preprocessor region
201 struct PPSkippedRange {
202   /// Raw source location of beginning of range.
203   SourceLocation::UIntTy Begin;
204   /// Raw source location of end of range.
205   SourceLocation::UIntTy End;
206 
207   PPSkippedRange(SourceRange R)
208       : Begin(R.getBegin().getRawEncoding()), End(R.getEnd().getRawEncoding()) {
209   }
210 
211   SourceLocation getBegin() const {
212     return SourceLocation::getFromRawEncoding(Begin);
213   }
214   SourceLocation getEnd() const {
215     return SourceLocation::getFromRawEncoding(End);
216   }
217 };
218 
219 /// Offset in the AST file. Use splitted 64-bit integer into low/high
220 /// parts to keep structure alignment 32-bit (it is important because
221 /// blobs in bitstream are 32-bit aligned). This structure is serialized
222 /// "as is" to the AST file.
223 struct UnderalignedInt64 {
224   uint32_t BitOffsetLow = 0;
225   uint32_t BitOffsetHigh = 0;
226 
227   UnderalignedInt64() = default;
228   UnderalignedInt64(uint64_t BitOffset) { setBitOffset(BitOffset); }
229 
230   void setBitOffset(uint64_t Offset) {
231     BitOffsetLow = Offset;
232     BitOffsetHigh = Offset >> 32;
233   }
234 
235   uint64_t getBitOffset() const {
236     return BitOffsetLow | (uint64_t(BitOffsetHigh) << 32);
237   }
238 };
239 
240 /// Source location and bit offset of a declaration.
241 struct DeclOffset {
242   /// Raw source location.
243   SourceLocation::UIntTy Loc = 0;
244 
245   /// Offset relative to the start of the DECLTYPES_BLOCK block. Keep
246   /// structure alignment 32-bit and avoid padding gap because undefined
247   /// value in the padding affects AST hash.
248   UnderalignedInt64 BitOffset;
249 
250   DeclOffset() = default;
251   DeclOffset(SourceLocation Loc, uint64_t BitOffset,
252              uint64_t DeclTypesBlockStartOffset) {
253     setLocation(Loc);
254     setBitOffset(BitOffset, DeclTypesBlockStartOffset);
255   }
256 
257   void setLocation(SourceLocation L) { Loc = L.getRawEncoding(); }
258 
259   SourceLocation getLocation() const {
260     return SourceLocation::getFromRawEncoding(Loc);
261   }
262 
263   void setBitOffset(uint64_t Offset, const uint64_t DeclTypesBlockStartOffset) {
264     BitOffset.setBitOffset(Offset - DeclTypesBlockStartOffset);
265   }
266 
267   uint64_t getBitOffset(const uint64_t DeclTypesBlockStartOffset) const {
268     return BitOffset.getBitOffset() + DeclTypesBlockStartOffset;
269   }
270 };
271 
272 /// The number of predefined preprocessed entity IDs.
273 const unsigned int NUM_PREDEF_PP_ENTITY_IDS = 1;
274 
275 /// Describes the various kinds of blocks that occur within
276 /// an AST file.
277 enum BlockIDs {
278   /// The AST block, which acts as a container around the
279   /// full AST block.
280   AST_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID,
281 
282   /// The block containing information about the source
283   /// manager.
284   SOURCE_MANAGER_BLOCK_ID,
285 
286   /// The block containing information about the
287   /// preprocessor.
288   PREPROCESSOR_BLOCK_ID,
289 
290   /// The block containing the definitions of all of the
291   /// types and decls used within the AST file.
292   DECLTYPES_BLOCK_ID,
293 
294   /// The block containing the detailed preprocessing record.
295   PREPROCESSOR_DETAIL_BLOCK_ID,
296 
297   /// The block containing the submodule structure.
298   SUBMODULE_BLOCK_ID,
299 
300   /// The block containing comments.
301   COMMENTS_BLOCK_ID,
302 
303   /// The control block, which contains all of the
304   /// information that needs to be validated prior to committing
305   /// to loading the AST file.
306   CONTROL_BLOCK_ID,
307 
308   /// The block of input files, which were used as inputs
309   /// to create this AST file.
310   ///
311   /// This block is part of the control block.
312   INPUT_FILES_BLOCK_ID,
313 
314   /// The block of configuration options, used to check that
315   /// a module is being used in a configuration compatible with the
316   /// configuration in which it was built.
317   ///
318   /// This block is part of the control block.
319   OPTIONS_BLOCK_ID,
320 
321   /// A block containing a module file extension.
322   EXTENSION_BLOCK_ID,
323 
324   /// A block with unhashed content.
325   ///
326   /// These records should not change the \a ASTFileSignature.  See \a
327   /// UnhashedControlBlockRecordTypes for the list of records.
328   UNHASHED_CONTROL_BLOCK_ID,
329 };
330 
331 /// Record types that occur within the control block.
332 enum ControlRecordTypes {
333   /// AST file metadata, including the AST file version number
334   /// and information about the compiler used to build this AST file.
335   METADATA = 1,
336 
337   /// Record code for the list of other AST files imported by
338   /// this AST file.
339   IMPORTS,
340 
341   /// Record code for the original file that was used to
342   /// generate the AST file, including both its file ID and its
343   /// name.
344   ORIGINAL_FILE,
345 
346   /// The directory that the PCH was originally created in.
347   ORIGINAL_PCH_DIR,
348 
349   /// Record code for file ID of the file or buffer that was used to
350   /// generate the AST file.
351   ORIGINAL_FILE_ID,
352 
353   /// Offsets into the input-files block where input files
354   /// reside.
355   INPUT_FILE_OFFSETS,
356 
357   /// Record code for the module name.
358   MODULE_NAME,
359 
360   /// Record code for the module map file that was used to build this
361   /// AST file.
362   MODULE_MAP_FILE,
363 
364   /// Record code for the module build directory.
365   MODULE_DIRECTORY,
366 };
367 
368 /// Record types that occur within the options block inside
369 /// the control block.
370 enum OptionsRecordTypes {
371   /// Record code for the language options table.
372   ///
373   /// The record with this code contains the contents of the
374   /// LangOptions structure. We serialize the entire contents of
375   /// the structure, and let the reader decide which options are
376   /// actually important to check.
377   LANGUAGE_OPTIONS = 1,
378 
379   /// Record code for the target options table.
380   TARGET_OPTIONS,
381 
382   /// Record code for the filesystem options table.
383   FILE_SYSTEM_OPTIONS,
384 
385   /// Record code for the headers search options table.
386   HEADER_SEARCH_OPTIONS,
387 
388   /// Record code for the preprocessor options table.
389   PREPROCESSOR_OPTIONS,
390 };
391 
392 /// Record codes for the unhashed control block.
393 enum UnhashedControlBlockRecordTypes {
394   /// Record code for the signature that identifiers this AST file.
395   SIGNATURE = 1,
396 
397   /// Record code for the content hash of the AST block.
398   AST_BLOCK_HASH,
399 
400   /// Record code for the diagnostic options table.
401   DIAGNOSTIC_OPTIONS,
402 
403   /// Record code for \#pragma diagnostic mappings.
404   DIAG_PRAGMA_MAPPINGS,
405 
406   /// Record code for the indices of used header search entries.
407   HEADER_SEARCH_ENTRY_USAGE,
408 };
409 
410 /// Record code for extension blocks.
411 enum ExtensionBlockRecordTypes {
412   /// Metadata describing this particular extension.
413   EXTENSION_METADATA = 1,
414 
415   /// The first record ID allocated to the extensions themselves.
416   FIRST_EXTENSION_RECORD_ID = 4
417 };
418 
419 /// Record types that occur within the input-files block
420 /// inside the control block.
421 enum InputFileRecordTypes {
422   /// An input file.
423   INPUT_FILE = 1,
424 
425   /// The input file content hash
426   INPUT_FILE_HASH
427 };
428 
429 /// Record types that occur within the AST block itself.
430 enum ASTRecordTypes {
431   /// Record code for the offsets of each type.
432   ///
433   /// The TYPE_OFFSET constant describes the record that occurs
434   /// within the AST block. The record itself is an array of offsets that
435   /// point into the declarations and types block (identified by
436   /// DECLTYPES_BLOCK_ID). The index into the array is based on the ID
437   /// of a type. For a given type ID @c T, the lower three bits of
438   /// @c T are its qualifiers (const, volatile, restrict), as in
439   /// the QualType class. The upper bits, after being shifted and
440   /// subtracting NUM_PREDEF_TYPE_IDS, are used to index into the
441   /// TYPE_OFFSET block to determine the offset of that type's
442   /// corresponding record within the DECLTYPES_BLOCK_ID block.
443   TYPE_OFFSET = 1,
444 
445   /// Record code for the offsets of each decl.
446   ///
447   /// The DECL_OFFSET constant describes the record that occurs
448   /// within the block identified by DECL_OFFSETS_BLOCK_ID within
449   /// the AST block. The record itself is an array of offsets that
450   /// point into the declarations and types block (identified by
451   /// DECLTYPES_BLOCK_ID). The declaration ID is an index into this
452   /// record, after subtracting one to account for the use of
453   /// declaration ID 0 for a NULL declaration pointer. Index 0 is
454   /// reserved for the translation unit declaration.
455   DECL_OFFSET = 2,
456 
457   /// Record code for the table of offsets of each
458   /// identifier ID.
459   ///
460   /// The offset table contains offsets into the blob stored in
461   /// the IDENTIFIER_TABLE record. Each offset points to the
462   /// NULL-terminated string that corresponds to that identifier.
463   IDENTIFIER_OFFSET = 3,
464 
465   /// This is so that older clang versions, before the introduction
466   /// of the control block, can read and reject the newer PCH format.
467   /// *DON'T CHANGE THIS NUMBER*.
468   METADATA_OLD_FORMAT = 4,
469 
470   /// Record code for the identifier table.
471   ///
472   /// The identifier table is a simple blob that contains
473   /// NULL-terminated strings for all of the identifiers
474   /// referenced by the AST file. The IDENTIFIER_OFFSET table
475   /// contains the mapping from identifier IDs to the characters
476   /// in this blob. Note that the starting offsets of all of the
477   /// identifiers are odd, so that, when the identifier offset
478   /// table is loaded in, we can use the low bit to distinguish
479   /// between offsets (for unresolved identifier IDs) and
480   /// IdentifierInfo pointers (for already-resolved identifier
481   /// IDs).
482   IDENTIFIER_TABLE = 5,
483 
484   /// Record code for the array of eagerly deserialized decls.
485   ///
486   /// The AST file contains a list of all of the declarations that should be
487   /// eagerly deserialized present within the parsed headers, stored as an
488   /// array of declaration IDs. These declarations will be
489   /// reported to the AST consumer after the AST file has been
490   /// read, since their presence can affect the semantics of the
491   /// program (e.g., for code generation).
492   EAGERLY_DESERIALIZED_DECLS = 6,
493 
494   /// Record code for the set of non-builtin, special
495   /// types.
496   ///
497   /// This record contains the type IDs for the various type nodes
498   /// that are constructed during semantic analysis (e.g.,
499   /// __builtin_va_list). The SPECIAL_TYPE_* constants provide
500   /// offsets into this record.
501   SPECIAL_TYPES = 7,
502 
503   /// Record code for the extra statistics we gather while
504   /// generating an AST file.
505   STATISTICS = 8,
506 
507   /// Record code for the array of tentative definitions.
508   TENTATIVE_DEFINITIONS = 9,
509 
510   // ID 10 used to be for a list of extern "C" declarations.
511 
512   /// Record code for the table of offsets into the
513   /// Objective-C method pool.
514   SELECTOR_OFFSETS = 11,
515 
516   /// Record code for the Objective-C method pool,
517   METHOD_POOL = 12,
518 
519   /// The value of the next __COUNTER__ to dispense.
520   /// [PP_COUNTER_VALUE, Val]
521   PP_COUNTER_VALUE = 13,
522 
523   /// Record code for the table of offsets into the block
524   /// of source-location information.
525   SOURCE_LOCATION_OFFSETS = 14,
526 
527   /// Record code for the set of source location entries
528   /// that need to be preloaded by the AST reader.
529   ///
530   /// This set contains the source location entry for the
531   /// predefines buffer and for any file entries that need to be
532   /// preloaded.
533   SOURCE_LOCATION_PRELOADS = 15,
534 
535   /// Record code for the set of ext_vector type names.
536   EXT_VECTOR_DECLS = 16,
537 
538   /// Record code for the array of unused file scoped decls.
539   UNUSED_FILESCOPED_DECLS = 17,
540 
541   /// Record code for the table of offsets to entries in the
542   /// preprocessing record.
543   PPD_ENTITIES_OFFSETS = 18,
544 
545   /// Record code for the array of VTable uses.
546   VTABLE_USES = 19,
547 
548   // ID 20 used to be for a list of dynamic classes.
549 
550   /// Record code for referenced selector pool.
551   REFERENCED_SELECTOR_POOL = 21,
552 
553   /// Record code for an update to the TU's lexically contained
554   /// declarations.
555   TU_UPDATE_LEXICAL = 22,
556 
557   // ID 23 used to be for a list of local redeclarations.
558 
559   /// Record code for declarations that Sema keeps references of.
560   SEMA_DECL_REFS = 24,
561 
562   /// Record code for weak undeclared identifiers.
563   WEAK_UNDECLARED_IDENTIFIERS = 25,
564 
565   /// Record code for pending implicit instantiations.
566   PENDING_IMPLICIT_INSTANTIATIONS = 26,
567 
568   // ID 27 used to be for a list of replacement decls.
569 
570   /// Record code for an update to a decl context's lookup table.
571   ///
572   /// In practice, this should only be used for the TU and namespaces.
573   UPDATE_VISIBLE = 28,
574 
575   /// Record for offsets of DECL_UPDATES records for declarations
576   /// that were modified after being deserialized and need updates.
577   DECL_UPDATE_OFFSETS = 29,
578 
579   // ID 30 used to be a decl update record. These are now in the DECLTYPES
580   // block.
581 
582   // ID 31 used to be a list of offsets to DECL_CXX_BASE_SPECIFIERS records.
583 
584   // ID 32 used to be the code for \#pragma diagnostic mappings.
585 
586   /// Record code for special CUDA declarations.
587   CUDA_SPECIAL_DECL_REFS = 33,
588 
589   /// Record code for header search information.
590   HEADER_SEARCH_TABLE = 34,
591 
592   /// Record code for floating point \#pragma options.
593   FP_PRAGMA_OPTIONS = 35,
594 
595   /// Record code for enabled OpenCL extensions.
596   OPENCL_EXTENSIONS = 36,
597 
598   /// The list of delegating constructor declarations.
599   DELEGATING_CTORS = 37,
600 
601   /// Record code for the set of known namespaces, which are used
602   /// for typo correction.
603   KNOWN_NAMESPACES = 38,
604 
605   /// Record code for the remapping information used to relate
606   /// loaded modules to the various offsets and IDs(e.g., source location
607   /// offests, declaration and type IDs) that are used in that module to
608   /// refer to other modules.
609   MODULE_OFFSET_MAP = 39,
610 
611   /// Record code for the source manager line table information,
612   /// which stores information about \#line directives.
613   SOURCE_MANAGER_LINE_TABLE = 40,
614 
615   /// Record code for map of Objective-C class definition IDs to the
616   /// ObjC categories in a module that are attached to that class.
617   OBJC_CATEGORIES_MAP = 41,
618 
619   /// Record code for a file sorted array of DeclIDs in a module.
620   FILE_SORTED_DECLS = 42,
621 
622   /// Record code for an array of all of the (sub)modules that were
623   /// imported by the AST file.
624   IMPORTED_MODULES = 43,
625 
626   // ID 44 used to be a table of merged canonical declarations.
627   // ID 45 used to be a list of declaration IDs of local redeclarations.
628 
629   /// Record code for the array of Objective-C categories (including
630   /// extensions).
631   ///
632   /// This array can only be interpreted properly using the Objective-C
633   /// categories map.
634   OBJC_CATEGORIES = 46,
635 
636   /// Record code for the table of offsets of each macro ID.
637   ///
638   /// The offset table contains offsets into the blob stored in
639   /// the preprocessor block. Each offset points to the corresponding
640   /// macro definition.
641   MACRO_OFFSET = 47,
642 
643   /// A list of "interesting" identifiers. Only used in C++ (where we
644   /// don't normally do lookups into the serialized identifier table). These
645   /// are eagerly deserialized.
646   INTERESTING_IDENTIFIERS = 48,
647 
648   /// Record code for undefined but used functions and variables that
649   /// need a definition in this TU.
650   UNDEFINED_BUT_USED = 49,
651 
652   /// Record code for late parsed template functions.
653   LATE_PARSED_TEMPLATE = 50,
654 
655   /// Record code for \#pragma optimize options.
656   OPTIMIZE_PRAGMA_OPTIONS = 51,
657 
658   /// Record code for potentially unused local typedef names.
659   UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES = 52,
660 
661   // ID 53 used to be a table of constructor initializer records.
662 
663   /// Delete expressions that will be analyzed later.
664   DELETE_EXPRS_TO_ANALYZE = 54,
665 
666   /// Record code for \#pragma ms_struct options.
667   MSSTRUCT_PRAGMA_OPTIONS = 55,
668 
669   /// Record code for \#pragma ms_struct options.
670   POINTERS_TO_MEMBERS_PRAGMA_OPTIONS = 56,
671 
672   /// Number of unmatched #pragma clang cuda_force_host_device begin
673   /// directives we've seen.
674   CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH = 57,
675 
676   /// Record code for types associated with OpenCL extensions.
677   OPENCL_EXTENSION_TYPES = 58,
678 
679   /// Record code for declarations associated with OpenCL extensions.
680   OPENCL_EXTENSION_DECLS = 59,
681 
682   MODULAR_CODEGEN_DECLS = 60,
683 
684   /// Record code for \#pragma align/pack options.
685   ALIGN_PACK_PRAGMA_OPTIONS = 61,
686 
687   /// The stack of open #ifs/#ifdefs recorded in a preamble.
688   PP_CONDITIONAL_STACK = 62,
689 
690   /// A table of skipped ranges within the preprocessing record.
691   PPD_SKIPPED_RANGES = 63,
692 
693   /// Record code for the Decls to be checked for deferred diags.
694   DECLS_TO_CHECK_FOR_DEFERRED_DIAGS = 64,
695 
696   /// Record code for \#pragma float_control options.
697   FLOAT_CONTROL_PRAGMA_OPTIONS = 65,
698 
699   /// Record code for included files.
700   PP_INCLUDED_FILES = 66,
701 };
702 
703 /// Record types used within a source manager block.
704 enum SourceManagerRecordTypes {
705   /// Describes a source location entry (SLocEntry) for a
706   /// file.
707   SM_SLOC_FILE_ENTRY = 1,
708 
709   /// Describes a source location entry (SLocEntry) for a
710   /// buffer.
711   SM_SLOC_BUFFER_ENTRY = 2,
712 
713   /// Describes a blob that contains the data for a buffer
714   /// entry. This kind of record always directly follows a
715   /// SM_SLOC_BUFFER_ENTRY record or a SM_SLOC_FILE_ENTRY with an
716   /// overridden buffer.
717   SM_SLOC_BUFFER_BLOB = 3,
718 
719   /// Describes a zlib-compressed blob that contains the data for
720   /// a buffer entry.
721   SM_SLOC_BUFFER_BLOB_COMPRESSED = 4,
722 
723   /// Describes a source location entry (SLocEntry) for a
724   /// macro expansion.
725   SM_SLOC_EXPANSION_ENTRY = 5
726 };
727 
728 /// Record types used within a preprocessor block.
729 enum PreprocessorRecordTypes {
730   // The macros in the PP section are a PP_MACRO_* instance followed by a
731   // list of PP_TOKEN instances for each token in the definition.
732 
733   /// An object-like macro definition.
734   /// [PP_MACRO_OBJECT_LIKE, IdentInfoID, SLoc, IsUsed]
735   PP_MACRO_OBJECT_LIKE = 1,
736 
737   /// A function-like macro definition.
738   /// [PP_MACRO_FUNCTION_LIKE, \<ObjectLikeStuff>, IsC99Varargs,
739   /// IsGNUVarars, NumArgs, ArgIdentInfoID* ]
740   PP_MACRO_FUNCTION_LIKE = 2,
741 
742   /// Describes one token.
743   /// [PP_TOKEN, SLoc, Length, IdentInfoID, Kind, Flags]
744   PP_TOKEN = 3,
745 
746   /// The macro directives history for a particular identifier.
747   PP_MACRO_DIRECTIVE_HISTORY = 4,
748 
749   /// A macro directive exported by a module.
750   /// [PP_MODULE_MACRO, SubmoduleID, MacroID, (Overridden SubmoduleID)*]
751   PP_MODULE_MACRO = 5,
752 };
753 
754 /// Record types used within a preprocessor detail block.
755 enum PreprocessorDetailRecordTypes {
756   /// Describes a macro expansion within the preprocessing record.
757   PPD_MACRO_EXPANSION = 0,
758 
759   /// Describes a macro definition within the preprocessing record.
760   PPD_MACRO_DEFINITION = 1,
761 
762   /// Describes an inclusion directive within the preprocessing
763   /// record.
764   PPD_INCLUSION_DIRECTIVE = 2
765 };
766 
767 /// Record types used within a submodule description block.
768 enum SubmoduleRecordTypes {
769   /// Metadata for submodules as a whole.
770   SUBMODULE_METADATA = 0,
771 
772   /// Defines the major attributes of a submodule, including its
773   /// name and parent.
774   SUBMODULE_DEFINITION = 1,
775 
776   /// Specifies the umbrella header used to create this module,
777   /// if any.
778   SUBMODULE_UMBRELLA_HEADER = 2,
779 
780   /// Specifies a header that falls into this (sub)module.
781   SUBMODULE_HEADER = 3,
782 
783   /// Specifies a top-level header that falls into this (sub)module.
784   SUBMODULE_TOPHEADER = 4,
785 
786   /// Specifies an umbrella directory.
787   SUBMODULE_UMBRELLA_DIR = 5,
788 
789   /// Specifies the submodules that are imported by this
790   /// submodule.
791   SUBMODULE_IMPORTS = 6,
792 
793   /// Specifies the submodules that are re-exported from this
794   /// submodule.
795   SUBMODULE_EXPORTS = 7,
796 
797   /// Specifies a required feature.
798   SUBMODULE_REQUIRES = 8,
799 
800   /// Specifies a header that has been explicitly excluded
801   /// from this submodule.
802   SUBMODULE_EXCLUDED_HEADER = 9,
803 
804   /// Specifies a library or framework to link against.
805   SUBMODULE_LINK_LIBRARY = 10,
806 
807   /// Specifies a configuration macro for this module.
808   SUBMODULE_CONFIG_MACRO = 11,
809 
810   /// Specifies a conflict with another module.
811   SUBMODULE_CONFLICT = 12,
812 
813   /// Specifies a header that is private to this submodule.
814   SUBMODULE_PRIVATE_HEADER = 13,
815 
816   /// Specifies a header that is part of the module but must be
817   /// textually included.
818   SUBMODULE_TEXTUAL_HEADER = 14,
819 
820   /// Specifies a header that is private to this submodule but
821   /// must be textually included.
822   SUBMODULE_PRIVATE_TEXTUAL_HEADER = 15,
823 
824   /// Specifies some declarations with initializers that must be
825   /// emitted to initialize the module.
826   SUBMODULE_INITIALIZERS = 16,
827 
828   /// Specifies the name of the module that will eventually
829   /// re-export the entities in this module.
830   SUBMODULE_EXPORT_AS = 17,
831 };
832 
833 /// Record types used within a comments block.
834 enum CommentRecordTypes { COMMENTS_RAW_COMMENT = 0 };
835 
836 /// \defgroup ASTAST AST file AST constants
837 ///
838 /// The constants in this group describe various components of the
839 /// abstract syntax tree within an AST file.
840 ///
841 /// @{
842 
843 /// Predefined type IDs.
844 ///
845 /// These type IDs correspond to predefined types in the AST
846 /// context, such as built-in types (int) and special place-holder
847 /// types (the \<overload> and \<dependent> type markers). Such
848 /// types are never actually serialized, since they will be built
849 /// by the AST context when it is created.
850 enum PredefinedTypeIDs {
851   /// The NULL type.
852   PREDEF_TYPE_NULL_ID = 0,
853 
854   /// The void type.
855   PREDEF_TYPE_VOID_ID = 1,
856 
857   /// The 'bool' or '_Bool' type.
858   PREDEF_TYPE_BOOL_ID = 2,
859 
860   /// The 'char' type, when it is unsigned.
861   PREDEF_TYPE_CHAR_U_ID = 3,
862 
863   /// The 'unsigned char' type.
864   PREDEF_TYPE_UCHAR_ID = 4,
865 
866   /// The 'unsigned short' type.
867   PREDEF_TYPE_USHORT_ID = 5,
868 
869   /// The 'unsigned int' type.
870   PREDEF_TYPE_UINT_ID = 6,
871 
872   /// The 'unsigned long' type.
873   PREDEF_TYPE_ULONG_ID = 7,
874 
875   /// The 'unsigned long long' type.
876   PREDEF_TYPE_ULONGLONG_ID = 8,
877 
878   /// The 'char' type, when it is signed.
879   PREDEF_TYPE_CHAR_S_ID = 9,
880 
881   /// The 'signed char' type.
882   PREDEF_TYPE_SCHAR_ID = 10,
883 
884   /// The C++ 'wchar_t' type.
885   PREDEF_TYPE_WCHAR_ID = 11,
886 
887   /// The (signed) 'short' type.
888   PREDEF_TYPE_SHORT_ID = 12,
889 
890   /// The (signed) 'int' type.
891   PREDEF_TYPE_INT_ID = 13,
892 
893   /// The (signed) 'long' type.
894   PREDEF_TYPE_LONG_ID = 14,
895 
896   /// The (signed) 'long long' type.
897   PREDEF_TYPE_LONGLONG_ID = 15,
898 
899   /// The 'float' type.
900   PREDEF_TYPE_FLOAT_ID = 16,
901 
902   /// The 'double' type.
903   PREDEF_TYPE_DOUBLE_ID = 17,
904 
905   /// The 'long double' type.
906   PREDEF_TYPE_LONGDOUBLE_ID = 18,
907 
908   /// The placeholder type for overloaded function sets.
909   PREDEF_TYPE_OVERLOAD_ID = 19,
910 
911   /// The placeholder type for dependent types.
912   PREDEF_TYPE_DEPENDENT_ID = 20,
913 
914   /// The '__uint128_t' type.
915   PREDEF_TYPE_UINT128_ID = 21,
916 
917   /// The '__int128_t' type.
918   PREDEF_TYPE_INT128_ID = 22,
919 
920   /// The type of 'nullptr'.
921   PREDEF_TYPE_NULLPTR_ID = 23,
922 
923   /// The C++ 'char16_t' type.
924   PREDEF_TYPE_CHAR16_ID = 24,
925 
926   /// The C++ 'char32_t' type.
927   PREDEF_TYPE_CHAR32_ID = 25,
928 
929   /// The ObjC 'id' type.
930   PREDEF_TYPE_OBJC_ID = 26,
931 
932   /// The ObjC 'Class' type.
933   PREDEF_TYPE_OBJC_CLASS = 27,
934 
935   /// The ObjC 'SEL' type.
936   PREDEF_TYPE_OBJC_SEL = 28,
937 
938   /// The 'unknown any' placeholder type.
939   PREDEF_TYPE_UNKNOWN_ANY = 29,
940 
941   /// The placeholder type for bound member functions.
942   PREDEF_TYPE_BOUND_MEMBER = 30,
943 
944   /// The "auto" deduction type.
945   PREDEF_TYPE_AUTO_DEDUCT = 31,
946 
947   /// The "auto &&" deduction type.
948   PREDEF_TYPE_AUTO_RREF_DEDUCT = 32,
949 
950   /// The OpenCL 'half' / ARM NEON __fp16 type.
951   PREDEF_TYPE_HALF_ID = 33,
952 
953   /// ARC's unbridged-cast placeholder type.
954   PREDEF_TYPE_ARC_UNBRIDGED_CAST = 34,
955 
956   /// The pseudo-object placeholder type.
957   PREDEF_TYPE_PSEUDO_OBJECT = 35,
958 
959   /// The placeholder type for builtin functions.
960   PREDEF_TYPE_BUILTIN_FN = 36,
961 
962   /// OpenCL event type.
963   PREDEF_TYPE_EVENT_ID = 37,
964 
965   /// OpenCL clk event type.
966   PREDEF_TYPE_CLK_EVENT_ID = 38,
967 
968   /// OpenCL sampler type.
969   PREDEF_TYPE_SAMPLER_ID = 39,
970 
971   /// OpenCL queue type.
972   PREDEF_TYPE_QUEUE_ID = 40,
973 
974   /// OpenCL reserve_id type.
975   PREDEF_TYPE_RESERVE_ID_ID = 41,
976 
977   /// The placeholder type for OpenMP array section.
978   PREDEF_TYPE_OMP_ARRAY_SECTION = 42,
979 
980   /// The '__float128' type
981   PREDEF_TYPE_FLOAT128_ID = 43,
982 
983   /// The '_Float16' type
984   PREDEF_TYPE_FLOAT16_ID = 44,
985 
986   /// The C++ 'char8_t' type.
987   PREDEF_TYPE_CHAR8_ID = 45,
988 
989   /// \brief The 'short _Accum' type
990   PREDEF_TYPE_SHORT_ACCUM_ID = 46,
991 
992   /// \brief The '_Accum' type
993   PREDEF_TYPE_ACCUM_ID = 47,
994 
995   /// \brief The 'long _Accum' type
996   PREDEF_TYPE_LONG_ACCUM_ID = 48,
997 
998   /// \brief The 'unsigned short _Accum' type
999   PREDEF_TYPE_USHORT_ACCUM_ID = 49,
1000 
1001   /// \brief The 'unsigned _Accum' type
1002   PREDEF_TYPE_UACCUM_ID = 50,
1003 
1004   /// \brief The 'unsigned long _Accum' type
1005   PREDEF_TYPE_ULONG_ACCUM_ID = 51,
1006 
1007   /// \brief The 'short _Fract' type
1008   PREDEF_TYPE_SHORT_FRACT_ID = 52,
1009 
1010   /// \brief The '_Fract' type
1011   PREDEF_TYPE_FRACT_ID = 53,
1012 
1013   /// \brief The 'long _Fract' type
1014   PREDEF_TYPE_LONG_FRACT_ID = 54,
1015 
1016   /// \brief The 'unsigned short _Fract' type
1017   PREDEF_TYPE_USHORT_FRACT_ID = 55,
1018 
1019   /// \brief The 'unsigned _Fract' type
1020   PREDEF_TYPE_UFRACT_ID = 56,
1021 
1022   /// \brief The 'unsigned long _Fract' type
1023   PREDEF_TYPE_ULONG_FRACT_ID = 57,
1024 
1025   /// \brief The '_Sat short _Accum' type
1026   PREDEF_TYPE_SAT_SHORT_ACCUM_ID = 58,
1027 
1028   /// \brief The '_Sat _Accum' type
1029   PREDEF_TYPE_SAT_ACCUM_ID = 59,
1030 
1031   /// \brief The '_Sat long _Accum' type
1032   PREDEF_TYPE_SAT_LONG_ACCUM_ID = 60,
1033 
1034   /// \brief The '_Sat unsigned short _Accum' type
1035   PREDEF_TYPE_SAT_USHORT_ACCUM_ID = 61,
1036 
1037   /// \brief The '_Sat unsigned _Accum' type
1038   PREDEF_TYPE_SAT_UACCUM_ID = 62,
1039 
1040   /// \brief The '_Sat unsigned long _Accum' type
1041   PREDEF_TYPE_SAT_ULONG_ACCUM_ID = 63,
1042 
1043   /// \brief The '_Sat short _Fract' type
1044   PREDEF_TYPE_SAT_SHORT_FRACT_ID = 64,
1045 
1046   /// \brief The '_Sat _Fract' type
1047   PREDEF_TYPE_SAT_FRACT_ID = 65,
1048 
1049   /// \brief The '_Sat long _Fract' type
1050   PREDEF_TYPE_SAT_LONG_FRACT_ID = 66,
1051 
1052   /// \brief The '_Sat unsigned short _Fract' type
1053   PREDEF_TYPE_SAT_USHORT_FRACT_ID = 67,
1054 
1055   /// \brief The '_Sat unsigned _Fract' type
1056   PREDEF_TYPE_SAT_UFRACT_ID = 68,
1057 
1058   /// \brief The '_Sat unsigned long _Fract' type
1059   PREDEF_TYPE_SAT_ULONG_FRACT_ID = 69,
1060 
1061   /// The placeholder type for OpenMP array shaping operation.
1062   PREDEF_TYPE_OMP_ARRAY_SHAPING = 70,
1063 
1064   /// The placeholder type for OpenMP iterator expression.
1065   PREDEF_TYPE_OMP_ITERATOR = 71,
1066 
1067   /// A placeholder type for incomplete matrix index operations.
1068   PREDEF_TYPE_INCOMPLETE_MATRIX_IDX = 72,
1069 
1070   /// \brief The '__bf16' type
1071   PREDEF_TYPE_BFLOAT16_ID = 73,
1072 
1073   /// \brief The '__ibm128' type
1074   PREDEF_TYPE_IBM128_ID = 74,
1075 
1076 /// OpenCL image types with auto numeration
1077 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
1078   PREDEF_TYPE_##Id##_ID,
1079 #include "clang/Basic/OpenCLImageTypes.def"
1080 /// \brief OpenCL extension types with auto numeration
1081 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) PREDEF_TYPE_##Id##_ID,
1082 #include "clang/Basic/OpenCLExtensionTypes.def"
1083 // \brief SVE types with auto numeration
1084 #define SVE_TYPE(Name, Id, SingletonId) PREDEF_TYPE_##Id##_ID,
1085 #include "clang/Basic/AArch64SVEACLETypes.def"
1086 // \brief  PowerPC MMA types with auto numeration
1087 #define PPC_VECTOR_TYPE(Name, Id, Size) PREDEF_TYPE_##Id##_ID,
1088 #include "clang/Basic/PPCTypes.def"
1089 // \brief RISC-V V types with auto numeration
1090 #define RVV_TYPE(Name, Id, SingletonId) PREDEF_TYPE_##Id##_ID,
1091 #include "clang/Basic/RISCVVTypes.def"
1092 };
1093 
1094 /// The number of predefined type IDs that are reserved for
1095 /// the PREDEF_TYPE_* constants.
1096 ///
1097 /// Type IDs for non-predefined types will start at
1098 /// NUM_PREDEF_TYPE_IDs.
1099 const unsigned NUM_PREDEF_TYPE_IDS = 300;
1100 
1101 /// Record codes for each kind of type.
1102 ///
1103 /// These constants describe the type records that can occur within a
1104 /// block identified by DECLTYPES_BLOCK_ID in the AST file. Each
1105 /// constant describes a record for a specific type class in the
1106 /// AST. Note that DeclCode values share this code space.
1107 enum TypeCode {
1108 #define TYPE_BIT_CODE(CLASS_ID, CODE_ID, CODE_VALUE)                           \
1109   TYPE_##CODE_ID = CODE_VALUE,
1110 #include "clang/Serialization/TypeBitCodes.def"
1111 
1112   /// An ExtQualType record.
1113   TYPE_EXT_QUAL = 1
1114 };
1115 
1116 /// The type IDs for special types constructed by semantic
1117 /// analysis.
1118 ///
1119 /// The constants in this enumeration are indices into the
1120 /// SPECIAL_TYPES record.
1121 enum SpecialTypeIDs {
1122   /// CFConstantString type
1123   SPECIAL_TYPE_CF_CONSTANT_STRING = 0,
1124 
1125   /// C FILE typedef type
1126   SPECIAL_TYPE_FILE = 1,
1127 
1128   /// C jmp_buf typedef type
1129   SPECIAL_TYPE_JMP_BUF = 2,
1130 
1131   /// C sigjmp_buf typedef type
1132   SPECIAL_TYPE_SIGJMP_BUF = 3,
1133 
1134   /// Objective-C "id" redefinition type
1135   SPECIAL_TYPE_OBJC_ID_REDEFINITION = 4,
1136 
1137   /// Objective-C "Class" redefinition type
1138   SPECIAL_TYPE_OBJC_CLASS_REDEFINITION = 5,
1139 
1140   /// Objective-C "SEL" redefinition type
1141   SPECIAL_TYPE_OBJC_SEL_REDEFINITION = 6,
1142 
1143   /// C ucontext_t typedef type
1144   SPECIAL_TYPE_UCONTEXT_T = 7
1145 };
1146 
1147 /// The number of special type IDs.
1148 const unsigned NumSpecialTypeIDs = 8;
1149 
1150 /// Predefined declaration IDs.
1151 ///
1152 /// These declaration IDs correspond to predefined declarations in the AST
1153 /// context, such as the NULL declaration ID. Such declarations are never
1154 /// actually serialized, since they will be built by the AST context when
1155 /// it is created.
1156 enum PredefinedDeclIDs {
1157   /// The NULL declaration.
1158   PREDEF_DECL_NULL_ID = 0,
1159 
1160   /// The translation unit.
1161   PREDEF_DECL_TRANSLATION_UNIT_ID = 1,
1162 
1163   /// The Objective-C 'id' type.
1164   PREDEF_DECL_OBJC_ID_ID = 2,
1165 
1166   /// The Objective-C 'SEL' type.
1167   PREDEF_DECL_OBJC_SEL_ID = 3,
1168 
1169   /// The Objective-C 'Class' type.
1170   PREDEF_DECL_OBJC_CLASS_ID = 4,
1171 
1172   /// The Objective-C 'Protocol' type.
1173   PREDEF_DECL_OBJC_PROTOCOL_ID = 5,
1174 
1175   /// The signed 128-bit integer type.
1176   PREDEF_DECL_INT_128_ID = 6,
1177 
1178   /// The unsigned 128-bit integer type.
1179   PREDEF_DECL_UNSIGNED_INT_128_ID = 7,
1180 
1181   /// The internal 'instancetype' typedef.
1182   PREDEF_DECL_OBJC_INSTANCETYPE_ID = 8,
1183 
1184   /// The internal '__builtin_va_list' typedef.
1185   PREDEF_DECL_BUILTIN_VA_LIST_ID = 9,
1186 
1187   /// The internal '__va_list_tag' struct, if any.
1188   PREDEF_DECL_VA_LIST_TAG = 10,
1189 
1190   /// The internal '__builtin_ms_va_list' typedef.
1191   PREDEF_DECL_BUILTIN_MS_VA_LIST_ID = 11,
1192 
1193   /// The predeclared '_GUID' struct.
1194   PREDEF_DECL_BUILTIN_MS_GUID_ID = 12,
1195 
1196   /// The extern "C" context.
1197   PREDEF_DECL_EXTERN_C_CONTEXT_ID = 13,
1198 
1199   /// The internal '__make_integer_seq' template.
1200   PREDEF_DECL_MAKE_INTEGER_SEQ_ID = 14,
1201 
1202   /// The internal '__NSConstantString' typedef.
1203   PREDEF_DECL_CF_CONSTANT_STRING_ID = 15,
1204 
1205   /// The internal '__NSConstantString' tag type.
1206   PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID = 16,
1207 
1208   /// The internal '__type_pack_element' template.
1209   PREDEF_DECL_TYPE_PACK_ELEMENT_ID = 17,
1210 };
1211 
1212 /// The number of declaration IDs that are predefined.
1213 ///
1214 /// For more information about predefined declarations, see the
1215 /// \c PredefinedDeclIDs type and the PREDEF_DECL_*_ID constants.
1216 const unsigned int NUM_PREDEF_DECL_IDS = 18;
1217 
1218 /// Record of updates for a declaration that was modified after
1219 /// being deserialized. This can occur within DECLTYPES_BLOCK_ID.
1220 const unsigned int DECL_UPDATES = 49;
1221 
1222 /// Record code for a list of local redeclarations of a declaration.
1223 /// This can occur within DECLTYPES_BLOCK_ID.
1224 const unsigned int LOCAL_REDECLARATIONS = 50;
1225 
1226 /// Record codes for each kind of declaration.
1227 ///
1228 /// These constants describe the declaration records that can occur within
1229 /// a declarations block (identified by DECLTYPES_BLOCK_ID). Each
1230 /// constant describes a record for a specific declaration class
1231 /// in the AST. Note that TypeCode values share this code space.
1232 enum DeclCode {
1233   /// A TypedefDecl record.
1234   DECL_TYPEDEF = 51,
1235   /// A TypeAliasDecl record.
1236 
1237   DECL_TYPEALIAS,
1238 
1239   /// An EnumDecl record.
1240   DECL_ENUM,
1241 
1242   /// A RecordDecl record.
1243   DECL_RECORD,
1244 
1245   /// An EnumConstantDecl record.
1246   DECL_ENUM_CONSTANT,
1247 
1248   /// A FunctionDecl record.
1249   DECL_FUNCTION,
1250 
1251   /// A ObjCMethodDecl record.
1252   DECL_OBJC_METHOD,
1253 
1254   /// A ObjCInterfaceDecl record.
1255   DECL_OBJC_INTERFACE,
1256 
1257   /// A ObjCProtocolDecl record.
1258   DECL_OBJC_PROTOCOL,
1259 
1260   /// A ObjCIvarDecl record.
1261   DECL_OBJC_IVAR,
1262 
1263   /// A ObjCAtDefsFieldDecl record.
1264   DECL_OBJC_AT_DEFS_FIELD,
1265 
1266   /// A ObjCCategoryDecl record.
1267   DECL_OBJC_CATEGORY,
1268 
1269   /// A ObjCCategoryImplDecl record.
1270   DECL_OBJC_CATEGORY_IMPL,
1271 
1272   /// A ObjCImplementationDecl record.
1273   DECL_OBJC_IMPLEMENTATION,
1274 
1275   /// A ObjCCompatibleAliasDecl record.
1276   DECL_OBJC_COMPATIBLE_ALIAS,
1277 
1278   /// A ObjCPropertyDecl record.
1279   DECL_OBJC_PROPERTY,
1280 
1281   /// A ObjCPropertyImplDecl record.
1282   DECL_OBJC_PROPERTY_IMPL,
1283 
1284   /// A FieldDecl record.
1285   DECL_FIELD,
1286 
1287   /// A MSPropertyDecl record.
1288   DECL_MS_PROPERTY,
1289 
1290   /// A MSGuidDecl record.
1291   DECL_MS_GUID,
1292 
1293   /// A TemplateParamObjectDecl record.
1294   DECL_TEMPLATE_PARAM_OBJECT,
1295 
1296   /// A VarDecl record.
1297   DECL_VAR,
1298 
1299   /// An ImplicitParamDecl record.
1300   DECL_IMPLICIT_PARAM,
1301 
1302   /// A ParmVarDecl record.
1303   DECL_PARM_VAR,
1304 
1305   /// A DecompositionDecl record.
1306   DECL_DECOMPOSITION,
1307 
1308   /// A BindingDecl record.
1309   DECL_BINDING,
1310 
1311   /// A FileScopeAsmDecl record.
1312   DECL_FILE_SCOPE_ASM,
1313 
1314   /// A BlockDecl record.
1315   DECL_BLOCK,
1316 
1317   /// A CapturedDecl record.
1318   DECL_CAPTURED,
1319 
1320   /// A record that stores the set of declarations that are
1321   /// lexically stored within a given DeclContext.
1322   ///
1323   /// The record itself is a blob that is an array of declaration IDs,
1324   /// in the order in which those declarations were added to the
1325   /// declaration context. This data is used when iterating over
1326   /// the contents of a DeclContext, e.g., via
1327   /// DeclContext::decls_begin() and DeclContext::decls_end().
1328   DECL_CONTEXT_LEXICAL,
1329 
1330   /// A record that stores the set of declarations that are
1331   /// visible from a given DeclContext.
1332   ///
1333   /// The record itself stores a set of mappings, each of which
1334   /// associates a declaration name with one or more declaration
1335   /// IDs. This data is used when performing qualified name lookup
1336   /// into a DeclContext via DeclContext::lookup.
1337   DECL_CONTEXT_VISIBLE,
1338 
1339   /// A LabelDecl record.
1340   DECL_LABEL,
1341 
1342   /// A NamespaceDecl record.
1343   DECL_NAMESPACE,
1344 
1345   /// A NamespaceAliasDecl record.
1346   DECL_NAMESPACE_ALIAS,
1347 
1348   /// A UsingDecl record.
1349   DECL_USING,
1350 
1351   /// A UsingEnumDecl record.
1352   DECL_USING_ENUM,
1353 
1354   /// A UsingPackDecl record.
1355   DECL_USING_PACK,
1356 
1357   /// A UsingShadowDecl record.
1358   DECL_USING_SHADOW,
1359 
1360   /// A ConstructorUsingShadowDecl record.
1361   DECL_CONSTRUCTOR_USING_SHADOW,
1362 
1363   /// A UsingDirecitveDecl record.
1364   DECL_USING_DIRECTIVE,
1365 
1366   /// An UnresolvedUsingValueDecl record.
1367   DECL_UNRESOLVED_USING_VALUE,
1368 
1369   /// An UnresolvedUsingTypenameDecl record.
1370   DECL_UNRESOLVED_USING_TYPENAME,
1371 
1372   /// A LinkageSpecDecl record.
1373   DECL_LINKAGE_SPEC,
1374 
1375   /// An ExportDecl record.
1376   DECL_EXPORT,
1377 
1378   /// A CXXRecordDecl record.
1379   DECL_CXX_RECORD,
1380 
1381   /// A CXXDeductionGuideDecl record.
1382   DECL_CXX_DEDUCTION_GUIDE,
1383 
1384   /// A CXXMethodDecl record.
1385   DECL_CXX_METHOD,
1386 
1387   /// A CXXConstructorDecl record.
1388   DECL_CXX_CONSTRUCTOR,
1389 
1390   /// A CXXDestructorDecl record.
1391   DECL_CXX_DESTRUCTOR,
1392 
1393   /// A CXXConversionDecl record.
1394   DECL_CXX_CONVERSION,
1395 
1396   /// An AccessSpecDecl record.
1397   DECL_ACCESS_SPEC,
1398 
1399   /// A FriendDecl record.
1400   DECL_FRIEND,
1401 
1402   /// A FriendTemplateDecl record.
1403   DECL_FRIEND_TEMPLATE,
1404 
1405   /// A ClassTemplateDecl record.
1406   DECL_CLASS_TEMPLATE,
1407 
1408   /// A ClassTemplateSpecializationDecl record.
1409   DECL_CLASS_TEMPLATE_SPECIALIZATION,
1410 
1411   /// A ClassTemplatePartialSpecializationDecl record.
1412   DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION,
1413 
1414   /// A VarTemplateDecl record.
1415   DECL_VAR_TEMPLATE,
1416 
1417   /// A VarTemplateSpecializationDecl record.
1418   DECL_VAR_TEMPLATE_SPECIALIZATION,
1419 
1420   /// A VarTemplatePartialSpecializationDecl record.
1421   DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION,
1422 
1423   /// A FunctionTemplateDecl record.
1424   DECL_FUNCTION_TEMPLATE,
1425 
1426   /// A TemplateTypeParmDecl record.
1427   DECL_TEMPLATE_TYPE_PARM,
1428 
1429   /// A NonTypeTemplateParmDecl record.
1430   DECL_NON_TYPE_TEMPLATE_PARM,
1431 
1432   /// A TemplateTemplateParmDecl record.
1433   DECL_TEMPLATE_TEMPLATE_PARM,
1434 
1435   /// A TypeAliasTemplateDecl record.
1436   DECL_TYPE_ALIAS_TEMPLATE,
1437 
1438   /// \brief A ConceptDecl record.
1439   DECL_CONCEPT,
1440 
1441   /// An UnresolvedUsingIfExistsDecl record.
1442   DECL_UNRESOLVED_USING_IF_EXISTS,
1443 
1444   /// \brief A StaticAssertDecl record.
1445   DECL_STATIC_ASSERT,
1446 
1447   /// A record containing CXXBaseSpecifiers.
1448   DECL_CXX_BASE_SPECIFIERS,
1449 
1450   /// A record containing CXXCtorInitializers.
1451   DECL_CXX_CTOR_INITIALIZERS,
1452 
1453   /// A IndirectFieldDecl record.
1454   DECL_INDIRECTFIELD,
1455 
1456   /// A NonTypeTemplateParmDecl record that stores an expanded
1457   /// non-type template parameter pack.
1458   DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK,
1459 
1460   /// A TemplateTemplateParmDecl record that stores an expanded
1461   /// template template parameter pack.
1462   DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK,
1463 
1464   /// A ClassScopeFunctionSpecializationDecl record a class scope
1465   /// function specialization. (Microsoft extension).
1466   DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION,
1467 
1468   /// An ImportDecl recording a module import.
1469   DECL_IMPORT,
1470 
1471   /// An OMPThreadPrivateDecl record.
1472   DECL_OMP_THREADPRIVATE,
1473 
1474   /// An OMPRequiresDecl record.
1475   DECL_OMP_REQUIRES,
1476 
1477   /// An OMPAllocateDcl record.
1478   DECL_OMP_ALLOCATE,
1479 
1480   /// An EmptyDecl record.
1481   DECL_EMPTY,
1482 
1483   /// An LifetimeExtendedTemporaryDecl record.
1484   DECL_LIFETIME_EXTENDED_TEMPORARY,
1485 
1486   /// A RequiresExprBodyDecl record.
1487   DECL_REQUIRES_EXPR_BODY,
1488 
1489   /// An ObjCTypeParamDecl record.
1490   DECL_OBJC_TYPE_PARAM,
1491 
1492   /// An OMPCapturedExprDecl record.
1493   DECL_OMP_CAPTUREDEXPR,
1494 
1495   /// A PragmaCommentDecl record.
1496   DECL_PRAGMA_COMMENT,
1497 
1498   /// A PragmaDetectMismatchDecl record.
1499   DECL_PRAGMA_DETECT_MISMATCH,
1500 
1501   /// An OMPDeclareMapperDecl record.
1502   DECL_OMP_DECLARE_MAPPER,
1503 
1504   /// An OMPDeclareReductionDecl record.
1505   DECL_OMP_DECLARE_REDUCTION,
1506 
1507   DECL_LAST = DECL_OMP_DECLARE_REDUCTION
1508 };
1509 
1510 /// Record codes for each kind of statement or expression.
1511 ///
1512 /// These constants describe the records that describe statements
1513 /// or expressions. These records  occur within type and declarations
1514 /// block, so they begin with record values of 128.  Each constant
1515 /// describes a record for a specific statement or expression class in the
1516 /// AST.
1517 enum StmtCode {
1518   /// A marker record that indicates that we are at the end
1519   /// of an expression.
1520   STMT_STOP = DECL_LAST + 1,
1521 
1522   /// A NULL expression.
1523   STMT_NULL_PTR,
1524 
1525   /// A reference to a previously [de]serialized Stmt record.
1526   STMT_REF_PTR,
1527 
1528   /// A NullStmt record.
1529   STMT_NULL,
1530 
1531   /// A CompoundStmt record.
1532   STMT_COMPOUND,
1533 
1534   /// A CaseStmt record.
1535   STMT_CASE,
1536 
1537   /// A DefaultStmt record.
1538   STMT_DEFAULT,
1539 
1540   /// A LabelStmt record.
1541   STMT_LABEL,
1542 
1543   /// An AttributedStmt record.
1544   STMT_ATTRIBUTED,
1545 
1546   /// An IfStmt record.
1547   STMT_IF,
1548 
1549   /// A SwitchStmt record.
1550   STMT_SWITCH,
1551 
1552   /// A WhileStmt record.
1553   STMT_WHILE,
1554 
1555   /// A DoStmt record.
1556   STMT_DO,
1557 
1558   /// A ForStmt record.
1559   STMT_FOR,
1560 
1561   /// A GotoStmt record.
1562   STMT_GOTO,
1563 
1564   /// An IndirectGotoStmt record.
1565   STMT_INDIRECT_GOTO,
1566 
1567   /// A ContinueStmt record.
1568   STMT_CONTINUE,
1569 
1570   /// A BreakStmt record.
1571   STMT_BREAK,
1572 
1573   /// A ReturnStmt record.
1574   STMT_RETURN,
1575 
1576   /// A DeclStmt record.
1577   STMT_DECL,
1578 
1579   /// A CapturedStmt record.
1580   STMT_CAPTURED,
1581 
1582   /// A GCC-style AsmStmt record.
1583   STMT_GCCASM,
1584 
1585   /// A MS-style AsmStmt record.
1586   STMT_MSASM,
1587 
1588   /// A constant expression context.
1589   EXPR_CONSTANT,
1590 
1591   /// A PredefinedExpr record.
1592   EXPR_PREDEFINED,
1593 
1594   /// A DeclRefExpr record.
1595   EXPR_DECL_REF,
1596 
1597   /// An IntegerLiteral record.
1598   EXPR_INTEGER_LITERAL,
1599 
1600   /// A FloatingLiteral record.
1601   EXPR_FLOATING_LITERAL,
1602 
1603   /// An ImaginaryLiteral record.
1604   EXPR_IMAGINARY_LITERAL,
1605 
1606   /// A StringLiteral record.
1607   EXPR_STRING_LITERAL,
1608 
1609   /// A CharacterLiteral record.
1610   EXPR_CHARACTER_LITERAL,
1611 
1612   /// A ParenExpr record.
1613   EXPR_PAREN,
1614 
1615   /// A ParenListExpr record.
1616   EXPR_PAREN_LIST,
1617 
1618   /// A UnaryOperator record.
1619   EXPR_UNARY_OPERATOR,
1620 
1621   /// An OffsetOfExpr record.
1622   EXPR_OFFSETOF,
1623 
1624   /// A SizefAlignOfExpr record.
1625   EXPR_SIZEOF_ALIGN_OF,
1626 
1627   /// An ArraySubscriptExpr record.
1628   EXPR_ARRAY_SUBSCRIPT,
1629 
1630   /// An MatrixSubscriptExpr record.
1631   EXPR_MATRIX_SUBSCRIPT,
1632 
1633   /// A CallExpr record.
1634   EXPR_CALL,
1635 
1636   /// A MemberExpr record.
1637   EXPR_MEMBER,
1638 
1639   /// A BinaryOperator record.
1640   EXPR_BINARY_OPERATOR,
1641 
1642   /// A CompoundAssignOperator record.
1643   EXPR_COMPOUND_ASSIGN_OPERATOR,
1644 
1645   /// A ConditionOperator record.
1646   EXPR_CONDITIONAL_OPERATOR,
1647 
1648   /// An ImplicitCastExpr record.
1649   EXPR_IMPLICIT_CAST,
1650 
1651   /// A CStyleCastExpr record.
1652   EXPR_CSTYLE_CAST,
1653 
1654   /// A CompoundLiteralExpr record.
1655   EXPR_COMPOUND_LITERAL,
1656 
1657   /// An ExtVectorElementExpr record.
1658   EXPR_EXT_VECTOR_ELEMENT,
1659 
1660   /// An InitListExpr record.
1661   EXPR_INIT_LIST,
1662 
1663   /// A DesignatedInitExpr record.
1664   EXPR_DESIGNATED_INIT,
1665 
1666   /// A DesignatedInitUpdateExpr record.
1667   EXPR_DESIGNATED_INIT_UPDATE,
1668 
1669   /// An NoInitExpr record.
1670   EXPR_NO_INIT,
1671 
1672   /// An ArrayInitLoopExpr record.
1673   EXPR_ARRAY_INIT_LOOP,
1674 
1675   /// An ArrayInitIndexExpr record.
1676   EXPR_ARRAY_INIT_INDEX,
1677 
1678   /// An ImplicitValueInitExpr record.
1679   EXPR_IMPLICIT_VALUE_INIT,
1680 
1681   /// A VAArgExpr record.
1682   EXPR_VA_ARG,
1683 
1684   /// An AddrLabelExpr record.
1685   EXPR_ADDR_LABEL,
1686 
1687   /// A StmtExpr record.
1688   EXPR_STMT,
1689 
1690   /// A ChooseExpr record.
1691   EXPR_CHOOSE,
1692 
1693   /// A GNUNullExpr record.
1694   EXPR_GNU_NULL,
1695 
1696   /// A SourceLocExpr record.
1697   EXPR_SOURCE_LOC,
1698 
1699   /// A ShuffleVectorExpr record.
1700   EXPR_SHUFFLE_VECTOR,
1701 
1702   /// A ConvertVectorExpr record.
1703   EXPR_CONVERT_VECTOR,
1704 
1705   /// BlockExpr
1706   EXPR_BLOCK,
1707 
1708   /// A GenericSelectionExpr record.
1709   EXPR_GENERIC_SELECTION,
1710 
1711   /// A PseudoObjectExpr record.
1712   EXPR_PSEUDO_OBJECT,
1713 
1714   /// An AtomicExpr record.
1715   EXPR_ATOMIC,
1716 
1717   /// A RecoveryExpr record.
1718   EXPR_RECOVERY,
1719 
1720   // Objective-C
1721 
1722   /// An ObjCStringLiteral record.
1723   EXPR_OBJC_STRING_LITERAL,
1724 
1725   EXPR_OBJC_BOXED_EXPRESSION,
1726   EXPR_OBJC_ARRAY_LITERAL,
1727   EXPR_OBJC_DICTIONARY_LITERAL,
1728 
1729   /// An ObjCEncodeExpr record.
1730   EXPR_OBJC_ENCODE,
1731 
1732   /// An ObjCSelectorExpr record.
1733   EXPR_OBJC_SELECTOR_EXPR,
1734 
1735   /// An ObjCProtocolExpr record.
1736   EXPR_OBJC_PROTOCOL_EXPR,
1737 
1738   /// An ObjCIvarRefExpr record.
1739   EXPR_OBJC_IVAR_REF_EXPR,
1740 
1741   /// An ObjCPropertyRefExpr record.
1742   EXPR_OBJC_PROPERTY_REF_EXPR,
1743 
1744   /// An ObjCSubscriptRefExpr record.
1745   EXPR_OBJC_SUBSCRIPT_REF_EXPR,
1746 
1747   /// UNUSED
1748   EXPR_OBJC_KVC_REF_EXPR,
1749 
1750   /// An ObjCMessageExpr record.
1751   EXPR_OBJC_MESSAGE_EXPR,
1752 
1753   /// An ObjCIsa Expr record.
1754   EXPR_OBJC_ISA,
1755 
1756   /// An ObjCIndirectCopyRestoreExpr record.
1757   EXPR_OBJC_INDIRECT_COPY_RESTORE,
1758 
1759   /// An ObjCForCollectionStmt record.
1760   STMT_OBJC_FOR_COLLECTION,
1761 
1762   /// An ObjCAtCatchStmt record.
1763   STMT_OBJC_CATCH,
1764 
1765   /// An ObjCAtFinallyStmt record.
1766   STMT_OBJC_FINALLY,
1767 
1768   /// An ObjCAtTryStmt record.
1769   STMT_OBJC_AT_TRY,
1770 
1771   /// An ObjCAtSynchronizedStmt record.
1772   STMT_OBJC_AT_SYNCHRONIZED,
1773 
1774   /// An ObjCAtThrowStmt record.
1775   STMT_OBJC_AT_THROW,
1776 
1777   /// An ObjCAutoreleasePoolStmt record.
1778   STMT_OBJC_AUTORELEASE_POOL,
1779 
1780   /// An ObjCBoolLiteralExpr record.
1781   EXPR_OBJC_BOOL_LITERAL,
1782 
1783   /// An ObjCAvailabilityCheckExpr record.
1784   EXPR_OBJC_AVAILABILITY_CHECK,
1785 
1786   // C++
1787 
1788   /// A CXXCatchStmt record.
1789   STMT_CXX_CATCH,
1790 
1791   /// A CXXTryStmt record.
1792   STMT_CXX_TRY,
1793   /// A CXXForRangeStmt record.
1794 
1795   STMT_CXX_FOR_RANGE,
1796 
1797   /// A CXXOperatorCallExpr record.
1798   EXPR_CXX_OPERATOR_CALL,
1799 
1800   /// A CXXMemberCallExpr record.
1801   EXPR_CXX_MEMBER_CALL,
1802 
1803   /// A CXXRewrittenBinaryOperator record.
1804   EXPR_CXX_REWRITTEN_BINARY_OPERATOR,
1805 
1806   /// A CXXConstructExpr record.
1807   EXPR_CXX_CONSTRUCT,
1808 
1809   /// A CXXInheritedCtorInitExpr record.
1810   EXPR_CXX_INHERITED_CTOR_INIT,
1811 
1812   /// A CXXTemporaryObjectExpr record.
1813   EXPR_CXX_TEMPORARY_OBJECT,
1814 
1815   /// A CXXStaticCastExpr record.
1816   EXPR_CXX_STATIC_CAST,
1817 
1818   /// A CXXDynamicCastExpr record.
1819   EXPR_CXX_DYNAMIC_CAST,
1820 
1821   /// A CXXReinterpretCastExpr record.
1822   EXPR_CXX_REINTERPRET_CAST,
1823 
1824   /// A CXXConstCastExpr record.
1825   EXPR_CXX_CONST_CAST,
1826 
1827   /// A CXXAddrspaceCastExpr record.
1828   EXPR_CXX_ADDRSPACE_CAST,
1829 
1830   /// A CXXFunctionalCastExpr record.
1831   EXPR_CXX_FUNCTIONAL_CAST,
1832 
1833   /// A BuiltinBitCastExpr record.
1834   EXPR_BUILTIN_BIT_CAST,
1835 
1836   /// A UserDefinedLiteral record.
1837   EXPR_USER_DEFINED_LITERAL,
1838 
1839   /// A CXXStdInitializerListExpr record.
1840   EXPR_CXX_STD_INITIALIZER_LIST,
1841 
1842   /// A CXXBoolLiteralExpr record.
1843   EXPR_CXX_BOOL_LITERAL,
1844 
1845   EXPR_CXX_NULL_PTR_LITERAL, // CXXNullPtrLiteralExpr
1846   EXPR_CXX_TYPEID_EXPR,      // CXXTypeidExpr (of expr).
1847   EXPR_CXX_TYPEID_TYPE,      // CXXTypeidExpr (of type).
1848   EXPR_CXX_THIS,             // CXXThisExpr
1849   EXPR_CXX_THROW,            // CXXThrowExpr
1850   EXPR_CXX_DEFAULT_ARG,      // CXXDefaultArgExpr
1851   EXPR_CXX_DEFAULT_INIT,     // CXXDefaultInitExpr
1852   EXPR_CXX_BIND_TEMPORARY,   // CXXBindTemporaryExpr
1853 
1854   EXPR_CXX_SCALAR_VALUE_INIT, // CXXScalarValueInitExpr
1855   EXPR_CXX_NEW,               // CXXNewExpr
1856   EXPR_CXX_DELETE,            // CXXDeleteExpr
1857   EXPR_CXX_PSEUDO_DESTRUCTOR, // CXXPseudoDestructorExpr
1858 
1859   EXPR_EXPR_WITH_CLEANUPS, // ExprWithCleanups
1860 
1861   EXPR_CXX_DEPENDENT_SCOPE_MEMBER,   // CXXDependentScopeMemberExpr
1862   EXPR_CXX_DEPENDENT_SCOPE_DECL_REF, // DependentScopeDeclRefExpr
1863   EXPR_CXX_UNRESOLVED_CONSTRUCT,     // CXXUnresolvedConstructExpr
1864   EXPR_CXX_UNRESOLVED_MEMBER,        // UnresolvedMemberExpr
1865   EXPR_CXX_UNRESOLVED_LOOKUP,        // UnresolvedLookupExpr
1866 
1867   EXPR_CXX_EXPRESSION_TRAIT, // ExpressionTraitExpr
1868   EXPR_CXX_NOEXCEPT,         // CXXNoexceptExpr
1869 
1870   EXPR_OPAQUE_VALUE,                // OpaqueValueExpr
1871   EXPR_BINARY_CONDITIONAL_OPERATOR, // BinaryConditionalOperator
1872   EXPR_TYPE_TRAIT,                  // TypeTraitExpr
1873   EXPR_ARRAY_TYPE_TRAIT,            // ArrayTypeTraitIntExpr
1874 
1875   EXPR_PACK_EXPANSION,                    // PackExpansionExpr
1876   EXPR_SIZEOF_PACK,                       // SizeOfPackExpr
1877   EXPR_SUBST_NON_TYPE_TEMPLATE_PARM,      // SubstNonTypeTemplateParmExpr
1878   EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK, // SubstNonTypeTemplateParmPackExpr
1879   EXPR_FUNCTION_PARM_PACK,                // FunctionParmPackExpr
1880   EXPR_MATERIALIZE_TEMPORARY,             // MaterializeTemporaryExpr
1881   EXPR_CXX_FOLD,                          // CXXFoldExpr
1882   EXPR_CONCEPT_SPECIALIZATION,            // ConceptSpecializationExpr
1883   EXPR_REQUIRES,                          // RequiresExpr
1884 
1885   // CUDA
1886   EXPR_CUDA_KERNEL_CALL, // CUDAKernelCallExpr
1887 
1888   // OpenCL
1889   EXPR_ASTYPE, // AsTypeExpr
1890 
1891   // Microsoft
1892   EXPR_CXX_PROPERTY_REF_EXPR,       // MSPropertyRefExpr
1893   EXPR_CXX_PROPERTY_SUBSCRIPT_EXPR, // MSPropertySubscriptExpr
1894   EXPR_CXX_UUIDOF_EXPR,             // CXXUuidofExpr (of expr).
1895   EXPR_CXX_UUIDOF_TYPE,             // CXXUuidofExpr (of type).
1896   STMT_SEH_LEAVE,                   // SEHLeaveStmt
1897   STMT_SEH_EXCEPT,                  // SEHExceptStmt
1898   STMT_SEH_FINALLY,                 // SEHFinallyStmt
1899   STMT_SEH_TRY,                     // SEHTryStmt
1900 
1901   // OpenMP directives
1902   STMT_OMP_META_DIRECTIVE,
1903   STMT_OMP_CANONICAL_LOOP,
1904   STMT_OMP_PARALLEL_DIRECTIVE,
1905   STMT_OMP_SIMD_DIRECTIVE,
1906   STMT_OMP_TILE_DIRECTIVE,
1907   STMT_OMP_UNROLL_DIRECTIVE,
1908   STMT_OMP_FOR_DIRECTIVE,
1909   STMT_OMP_FOR_SIMD_DIRECTIVE,
1910   STMT_OMP_SECTIONS_DIRECTIVE,
1911   STMT_OMP_SECTION_DIRECTIVE,
1912   STMT_OMP_SINGLE_DIRECTIVE,
1913   STMT_OMP_MASTER_DIRECTIVE,
1914   STMT_OMP_CRITICAL_DIRECTIVE,
1915   STMT_OMP_PARALLEL_FOR_DIRECTIVE,
1916   STMT_OMP_PARALLEL_FOR_SIMD_DIRECTIVE,
1917   STMT_OMP_PARALLEL_MASTER_DIRECTIVE,
1918   STMT_OMP_PARALLEL_SECTIONS_DIRECTIVE,
1919   STMT_OMP_TASK_DIRECTIVE,
1920   STMT_OMP_TASKYIELD_DIRECTIVE,
1921   STMT_OMP_BARRIER_DIRECTIVE,
1922   STMT_OMP_TASKWAIT_DIRECTIVE,
1923   STMT_OMP_FLUSH_DIRECTIVE,
1924   STMT_OMP_DEPOBJ_DIRECTIVE,
1925   STMT_OMP_SCAN_DIRECTIVE,
1926   STMT_OMP_ORDERED_DIRECTIVE,
1927   STMT_OMP_ATOMIC_DIRECTIVE,
1928   STMT_OMP_TARGET_DIRECTIVE,
1929   STMT_OMP_TARGET_DATA_DIRECTIVE,
1930   STMT_OMP_TARGET_ENTER_DATA_DIRECTIVE,
1931   STMT_OMP_TARGET_EXIT_DATA_DIRECTIVE,
1932   STMT_OMP_TARGET_PARALLEL_DIRECTIVE,
1933   STMT_OMP_TARGET_PARALLEL_FOR_DIRECTIVE,
1934   STMT_OMP_TEAMS_DIRECTIVE,
1935   STMT_OMP_TASKGROUP_DIRECTIVE,
1936   STMT_OMP_CANCELLATION_POINT_DIRECTIVE,
1937   STMT_OMP_CANCEL_DIRECTIVE,
1938   STMT_OMP_TASKLOOP_DIRECTIVE,
1939   STMT_OMP_TASKLOOP_SIMD_DIRECTIVE,
1940   STMT_OMP_MASTER_TASKLOOP_DIRECTIVE,
1941   STMT_OMP_MASTER_TASKLOOP_SIMD_DIRECTIVE,
1942   STMT_OMP_PARALLEL_MASTER_TASKLOOP_DIRECTIVE,
1943   STMT_OMP_PARALLEL_MASTER_TASKLOOP_SIMD_DIRECTIVE,
1944   STMT_OMP_DISTRIBUTE_DIRECTIVE,
1945   STMT_OMP_TARGET_UPDATE_DIRECTIVE,
1946   STMT_OMP_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1947   STMT_OMP_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1948   STMT_OMP_DISTRIBUTE_SIMD_DIRECTIVE,
1949   STMT_OMP_TARGET_PARALLEL_FOR_SIMD_DIRECTIVE,
1950   STMT_OMP_TARGET_SIMD_DIRECTIVE,
1951   STMT_OMP_TEAMS_DISTRIBUTE_DIRECTIVE,
1952   STMT_OMP_TEAMS_DISTRIBUTE_SIMD_DIRECTIVE,
1953   STMT_OMP_TEAMS_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1954   STMT_OMP_TEAMS_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1955   STMT_OMP_TARGET_TEAMS_DIRECTIVE,
1956   STMT_OMP_TARGET_TEAMS_DISTRIBUTE_DIRECTIVE,
1957   STMT_OMP_TARGET_TEAMS_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1958   STMT_OMP_TARGET_TEAMS_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1959   STMT_OMP_TARGET_TEAMS_DISTRIBUTE_SIMD_DIRECTIVE,
1960   STMT_OMP_INTEROP_DIRECTIVE,
1961   STMT_OMP_DISPATCH_DIRECTIVE,
1962   STMT_OMP_MASKED_DIRECTIVE,
1963   STMT_OMP_GENERIC_LOOP_DIRECTIVE,
1964   EXPR_OMP_ARRAY_SECTION,
1965   EXPR_OMP_ARRAY_SHAPING,
1966   EXPR_OMP_ITERATOR,
1967 
1968   // ARC
1969   EXPR_OBJC_BRIDGED_CAST, // ObjCBridgedCastExpr
1970 
1971   STMT_MS_DEPENDENT_EXISTS, // MSDependentExistsStmt
1972   EXPR_LAMBDA,              // LambdaExpr
1973   STMT_COROUTINE_BODY,
1974   STMT_CORETURN,
1975   EXPR_COAWAIT,
1976   EXPR_COYIELD,
1977   EXPR_DEPENDENT_COAWAIT,
1978 
1979   // FixedPointLiteral
1980   EXPR_FIXEDPOINT_LITERAL,
1981 
1982   // SYCLUniqueStableNameExpr
1983   EXPR_SYCL_UNIQUE_STABLE_NAME,
1984 };
1985 
1986 /// The kinds of designators that can occur in a
1987 /// DesignatedInitExpr.
1988 enum DesignatorTypes {
1989   /// Field designator where only the field name is known.
1990   DESIG_FIELD_NAME = 0,
1991 
1992   /// Field designator where the field has been resolved to
1993   /// a declaration.
1994   DESIG_FIELD_DECL = 1,
1995 
1996   /// Array designator.
1997   DESIG_ARRAY = 2,
1998 
1999   /// GNU array range designator.
2000   DESIG_ARRAY_RANGE = 3
2001 };
2002 
2003 /// The different kinds of data that can occur in a
2004 /// CtorInitializer.
2005 enum CtorInitializerType {
2006   CTOR_INITIALIZER_BASE,
2007   CTOR_INITIALIZER_DELEGATING,
2008   CTOR_INITIALIZER_MEMBER,
2009   CTOR_INITIALIZER_INDIRECT_MEMBER
2010 };
2011 
2012 /// Kinds of cleanup objects owned by ExprWithCleanups.
2013 enum CleanupObjectKind { COK_Block, COK_CompoundLiteral };
2014 
2015 /// Describes the redeclarations of a declaration.
2016 struct LocalRedeclarationsInfo {
2017   // The ID of the first declaration
2018   DeclID FirstID;
2019 
2020   // Offset into the array of redeclaration chains.
2021   unsigned Offset;
2022 
2023   friend bool operator<(const LocalRedeclarationsInfo &X,
2024                         const LocalRedeclarationsInfo &Y) {
2025     return X.FirstID < Y.FirstID;
2026   }
2027 
2028   friend bool operator>(const LocalRedeclarationsInfo &X,
2029                         const LocalRedeclarationsInfo &Y) {
2030     return X.FirstID > Y.FirstID;
2031   }
2032 
2033   friend bool operator<=(const LocalRedeclarationsInfo &X,
2034                          const LocalRedeclarationsInfo &Y) {
2035     return X.FirstID <= Y.FirstID;
2036   }
2037 
2038   friend bool operator>=(const LocalRedeclarationsInfo &X,
2039                          const LocalRedeclarationsInfo &Y) {
2040     return X.FirstID >= Y.FirstID;
2041   }
2042 };
2043 
2044 /// Describes the categories of an Objective-C class.
2045 struct ObjCCategoriesInfo {
2046   // The ID of the definition
2047   DeclID DefinitionID;
2048 
2049   // Offset into the array of category lists.
2050   unsigned Offset;
2051 
2052   friend bool operator<(const ObjCCategoriesInfo &X,
2053                         const ObjCCategoriesInfo &Y) {
2054     return X.DefinitionID < Y.DefinitionID;
2055   }
2056 
2057   friend bool operator>(const ObjCCategoriesInfo &X,
2058                         const ObjCCategoriesInfo &Y) {
2059     return X.DefinitionID > Y.DefinitionID;
2060   }
2061 
2062   friend bool operator<=(const ObjCCategoriesInfo &X,
2063                          const ObjCCategoriesInfo &Y) {
2064     return X.DefinitionID <= Y.DefinitionID;
2065   }
2066 
2067   friend bool operator>=(const ObjCCategoriesInfo &X,
2068                          const ObjCCategoriesInfo &Y) {
2069     return X.DefinitionID >= Y.DefinitionID;
2070   }
2071 };
2072 
2073 /// A key used when looking up entities by \ref DeclarationName.
2074 ///
2075 /// Different \ref DeclarationNames are mapped to different keys, but the
2076 /// same key can occasionally represent multiple names (for names that
2077 /// contain types, in particular).
2078 class DeclarationNameKey {
2079   using NameKind = unsigned;
2080 
2081   NameKind Kind = 0;
2082   uint64_t Data = 0;
2083 
2084 public:
2085   DeclarationNameKey() = default;
2086   DeclarationNameKey(DeclarationName Name);
2087   DeclarationNameKey(NameKind Kind, uint64_t Data) : Kind(Kind), Data(Data) {}
2088 
2089   NameKind getKind() const { return Kind; }
2090 
2091   IdentifierInfo *getIdentifier() const {
2092     assert(Kind == DeclarationName::Identifier ||
2093            Kind == DeclarationName::CXXLiteralOperatorName ||
2094            Kind == DeclarationName::CXXDeductionGuideName);
2095     return (IdentifierInfo *)Data;
2096   }
2097 
2098   Selector getSelector() const {
2099     assert(Kind == DeclarationName::ObjCZeroArgSelector ||
2100            Kind == DeclarationName::ObjCOneArgSelector ||
2101            Kind == DeclarationName::ObjCMultiArgSelector);
2102     return Selector(Data);
2103   }
2104 
2105   OverloadedOperatorKind getOperatorKind() const {
2106     assert(Kind == DeclarationName::CXXOperatorName);
2107     return (OverloadedOperatorKind)Data;
2108   }
2109 
2110   /// Compute a fingerprint of this key for use in on-disk hash table.
2111   unsigned getHash() const;
2112 
2113   friend bool operator==(const DeclarationNameKey &A,
2114                          const DeclarationNameKey &B) {
2115     return A.Kind == B.Kind && A.Data == B.Data;
2116   }
2117 };
2118 
2119 /// @}
2120 
2121 } // namespace serialization
2122 } // namespace clang
2123 
2124 namespace llvm {
2125 
2126 template <> struct DenseMapInfo<clang::serialization::DeclarationNameKey> {
2127   static clang::serialization::DeclarationNameKey getEmptyKey() {
2128     return clang::serialization::DeclarationNameKey(-1, 1);
2129   }
2130 
2131   static clang::serialization::DeclarationNameKey getTombstoneKey() {
2132     return clang::serialization::DeclarationNameKey(-1, 2);
2133   }
2134 
2135   static unsigned
2136   getHashValue(const clang::serialization::DeclarationNameKey &Key) {
2137     return Key.getHash();
2138   }
2139 
2140   static bool isEqual(const clang::serialization::DeclarationNameKey &L,
2141                       const clang::serialization::DeclarationNameKey &R) {
2142     return L == R;
2143   }
2144 };
2145 
2146 } // namespace llvm
2147 
2148 #endif // LLVM_CLANG_SERIALIZATION_ASTBITCODES_H
2149