contrib/llvm/tools/clang/include/clang/Serialization/ASTBitCodes.h

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