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