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