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