1 //===- ASTBitCodes.h - Enum values for the PCH bitcode format ---*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This header defines Bitcode enum values for Clang serialized AST files.
11 // The enum values defined in this file should be considered permanent. If
12 // new features are added, they should have values added at the end of the
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_CLANG_SERIALIZATION_ASTBITCODES_H
18 #define LLVM_CLANG_SERIALIZATION_ASTBITCODES_H
20 #include "clang/AST/DeclarationName.h"
21 #include "clang/AST/Type.h"
22 #include "clang/Basic/IdentifierTable.h"
23 #include "clang/Basic/OperatorKinds.h"
24 #include "clang/Basic/SourceLocation.h"
25 #include "llvm/ADT/DenseMapInfo.h"
26 #include "llvm/Bitstream/BitCodes.h"
31 namespace serialization {
33 /// AST file major version number supported by this version of
36 /// Whenever the AST file format changes in a way that makes it
37 /// incompatible with previous versions (such that a reader
38 /// designed for the previous version could not support reading
39 /// the new version), this number should be increased.
41 /// Version 4 of AST files also requires that the version control branch and
42 /// revision match exactly, since there is no backward compatibility of
43 /// AST files at this time.
44 const unsigned VERSION_MAJOR = 7;
46 /// AST file minor version number supported by this version of
49 /// Whenever the AST format changes in a way that is still
50 /// compatible with previous versions (such that a reader designed
51 /// for the previous version could still support reading the new
52 /// version by ignoring new kinds of subblocks), this number
53 /// should be increased.
54 const unsigned VERSION_MINOR = 0;
56 /// An ID number that refers to an identifier in an AST file.
58 /// The ID numbers of identifiers are consecutive (in order of discovery)
59 /// and start at 1. 0 is reserved for NULL.
60 using IdentifierID = uint32_t;
62 /// An ID number that refers to a declaration in an AST file.
64 /// The ID numbers of declarations are consecutive (in order of
65 /// discovery), with values below NUM_PREDEF_DECL_IDS being reserved.
66 /// At the start of a chain of precompiled headers, declaration ID 1 is
67 /// used for the translation unit declaration.
68 using DeclID = uint32_t;
70 // FIXME: Turn these into classes so we can have some type safety when
71 // we go from local ID to global and vice-versa.
72 using LocalDeclID = DeclID;
73 using GlobalDeclID = DeclID;
75 /// An ID number that refers to a type in an AST file.
77 /// The ID of a type is partitioned into two parts: the lower
78 /// three bits are used to store the const/volatile/restrict
79 /// qualifiers (as with QualType) and the upper bits provide a
80 /// type index. The type index values are partitioned into two
81 /// sets. The values below NUM_PREDEF_TYPE_IDs are predefined type
82 /// IDs (based on the PREDEF_TYPE_*_ID constants), with 0 as a
83 /// placeholder for "no type". Values from NUM_PREDEF_TYPE_IDs are
84 /// other types that have serialized representations.
85 using TypeID = uint32_t;
87 /// A type index; the type ID with the qualifier bits removed.
93 explicit TypeIdx(uint32_t index) : Idx(index) {}
95 uint32_t getIndex() const { return Idx; }
97 TypeID asTypeID(unsigned FastQuals) const {
98 if (Idx == uint32_t(-1))
101 return (Idx << Qualifiers::FastWidth) | FastQuals;
104 static TypeIdx fromTypeID(TypeID ID) {
105 if (ID == TypeID(-1))
108 return TypeIdx(ID >> Qualifiers::FastWidth);
112 /// A structure for putting "fast"-unqualified QualTypes into a
113 /// DenseMap. This uses the standard pointer hash function.
114 struct UnsafeQualTypeDenseMapInfo {
115 static bool isEqual(QualType A, QualType B) { return A == B; }
117 static QualType getEmptyKey() {
118 return QualType::getFromOpaquePtr((void*) 1);
121 static QualType getTombstoneKey() {
122 return QualType::getFromOpaquePtr((void*) 2);
125 static unsigned getHashValue(QualType T) {
126 assert(!T.getLocalFastQualifiers() &&
127 "hash invalid for types with fast quals");
128 uintptr_t v = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
129 return (unsigned(v) >> 4) ^ (unsigned(v) >> 9);
133 /// An ID number that refers to an identifier in an AST file.
134 using IdentID = uint32_t;
136 /// The number of predefined identifier IDs.
137 const unsigned int NUM_PREDEF_IDENT_IDS = 1;
139 /// An ID number that refers to a macro in an AST file.
140 using MacroID = uint32_t;
142 /// A global ID number that refers to a macro in an AST file.
143 using GlobalMacroID = uint32_t;
145 /// A local to a module ID number that refers to a macro in an
147 using LocalMacroID = uint32_t;
149 /// The number of predefined macro IDs.
150 const unsigned int NUM_PREDEF_MACRO_IDS = 1;
152 /// An ID number that refers to an ObjC selector in an AST file.
153 using SelectorID = uint32_t;
155 /// The number of predefined selector IDs.
156 const unsigned int NUM_PREDEF_SELECTOR_IDS = 1;
158 /// An ID number that refers to a set of CXXBaseSpecifiers in an
160 using CXXBaseSpecifiersID = uint32_t;
162 /// An ID number that refers to a list of CXXCtorInitializers in an
164 using CXXCtorInitializersID = uint32_t;
166 /// An ID number that refers to an entity in the detailed
167 /// preprocessing record.
168 using PreprocessedEntityID = uint32_t;
170 /// An ID number that refers to a submodule in a module file.
171 using SubmoduleID = uint32_t;
173 /// The number of predefined submodule IDs.
174 const unsigned int NUM_PREDEF_SUBMODULE_IDS = 1;
176 /// Source range/offset of a preprocessed entity.
177 struct PPEntityOffset {
178 /// Raw source location of beginning of range.
181 /// Raw source location of end of range.
184 /// Offset in the AST file.
187 PPEntityOffset(SourceRange R, uint32_t BitOffset)
188 : Begin(R.getBegin().getRawEncoding()),
189 End(R.getEnd().getRawEncoding()), BitOffset(BitOffset) {}
191 SourceLocation getBegin() const {
192 return SourceLocation::getFromRawEncoding(Begin);
195 SourceLocation getEnd() const {
196 return SourceLocation::getFromRawEncoding(End);
200 /// Source range of a skipped preprocessor region
201 struct PPSkippedRange {
202 /// Raw source location of beginning of range.
204 /// Raw source location of end of range.
207 PPSkippedRange(SourceRange R)
208 : Begin(R.getBegin().getRawEncoding()),
209 End(R.getEnd().getRawEncoding()) { }
211 SourceLocation getBegin() const {
212 return SourceLocation::getFromRawEncoding(Begin);
214 SourceLocation getEnd() const {
215 return SourceLocation::getFromRawEncoding(End);
219 /// Source range/offset of a preprocessed entity.
221 /// Raw source location.
224 /// Offset in the AST file.
225 uint32_t BitOffset = 0;
227 DeclOffset() = default;
228 DeclOffset(SourceLocation Loc, uint32_t BitOffset)
229 : Loc(Loc.getRawEncoding()), BitOffset(BitOffset) {}
231 void setLocation(SourceLocation L) {
232 Loc = L.getRawEncoding();
235 SourceLocation getLocation() const {
236 return SourceLocation::getFromRawEncoding(Loc);
240 /// The number of predefined preprocessed entity IDs.
241 const unsigned int NUM_PREDEF_PP_ENTITY_IDS = 1;
243 /// Describes the various kinds of blocks that occur within
246 /// The AST block, which acts as a container around the
248 AST_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID,
250 /// The block containing information about the source
252 SOURCE_MANAGER_BLOCK_ID,
254 /// The block containing information about the
256 PREPROCESSOR_BLOCK_ID,
258 /// The block containing the definitions of all of the
259 /// types and decls used within the AST file.
262 /// The block containing the detailed preprocessing record.
263 PREPROCESSOR_DETAIL_BLOCK_ID,
265 /// The block containing the submodule structure.
268 /// The block containing comments.
271 /// The control block, which contains all of the
272 /// information that needs to be validated prior to committing
273 /// to loading the AST file.
276 /// The block of input files, which were used as inputs
277 /// to create this AST file.
279 /// This block is part of the control block.
280 INPUT_FILES_BLOCK_ID,
282 /// The block of configuration options, used to check that
283 /// a module is being used in a configuration compatible with the
284 /// configuration in which it was built.
286 /// This block is part of the control block.
289 /// A block containing a module file extension.
292 /// A block with unhashed content.
294 /// These records should not change the \a ASTFileSignature. See \a
295 /// UnhashedControlBlockRecordTypes for the list of records.
296 UNHASHED_CONTROL_BLOCK_ID,
299 /// Record types that occur within the control block.
300 enum ControlRecordTypes {
301 /// AST file metadata, including the AST file version number
302 /// and information about the compiler used to build this AST file.
305 /// Record code for the list of other AST files imported by
309 /// Record code for the original file that was used to
310 /// generate the AST file, including both its file ID and its
314 /// The directory that the PCH was originally created in.
317 /// Record code for file ID of the file or buffer that was used to
318 /// generate the AST file.
321 /// Offsets into the input-files block where input files
325 /// Record code for the module name.
328 /// Record code for the module map file that was used to build this
332 /// Record code for the module build directory.
336 /// Record types that occur within the options block inside
337 /// the control block.
338 enum OptionsRecordTypes {
339 /// Record code for the language options table.
341 /// The record with this code contains the contents of the
342 /// LangOptions structure. We serialize the entire contents of
343 /// the structure, and let the reader decide which options are
344 /// actually important to check.
345 LANGUAGE_OPTIONS = 1,
347 /// Record code for the target options table.
350 /// Record code for the filesystem options table.
353 /// Record code for the headers search options table.
354 HEADER_SEARCH_OPTIONS,
356 /// Record code for the preprocessor options table.
357 PREPROCESSOR_OPTIONS,
360 /// Record codes for the unhashed control block.
361 enum UnhashedControlBlockRecordTypes {
362 /// Record code for the signature that identifiers this AST file.
365 /// Record code for the diagnostic options table.
368 /// Record code for \#pragma diagnostic mappings.
369 DIAG_PRAGMA_MAPPINGS,
372 /// Record code for extension blocks.
373 enum ExtensionBlockRecordTypes {
374 /// Metadata describing this particular extension.
375 EXTENSION_METADATA = 1,
377 /// The first record ID allocated to the extensions themselves.
378 FIRST_EXTENSION_RECORD_ID = 4
381 /// Record types that occur within the input-files block
382 /// inside the control block.
383 enum InputFileRecordTypes {
388 /// Record types that occur within the AST block itself.
389 enum ASTRecordTypes {
390 /// Record code for the offsets of each type.
392 /// The TYPE_OFFSET constant describes the record that occurs
393 /// within the AST block. The record itself is an array of offsets that
394 /// point into the declarations and types block (identified by
395 /// DECLTYPES_BLOCK_ID). The index into the array is based on the ID
396 /// of a type. For a given type ID @c T, the lower three bits of
397 /// @c T are its qualifiers (const, volatile, restrict), as in
398 /// the QualType class. The upper bits, after being shifted and
399 /// subtracting NUM_PREDEF_TYPE_IDS, are used to index into the
400 /// TYPE_OFFSET block to determine the offset of that type's
401 /// corresponding record within the DECLTYPES_BLOCK_ID block.
404 /// Record code for the offsets of each decl.
406 /// The DECL_OFFSET constant describes the record that occurs
407 /// within the block identified by DECL_OFFSETS_BLOCK_ID within
408 /// the AST block. The record itself is an array of offsets that
409 /// point into the declarations and types block (identified by
410 /// DECLTYPES_BLOCK_ID). The declaration ID is an index into this
411 /// record, after subtracting one to account for the use of
412 /// declaration ID 0 for a NULL declaration pointer. Index 0 is
413 /// reserved for the translation unit declaration.
416 /// Record code for the table of offsets of each
419 /// The offset table contains offsets into the blob stored in
420 /// the IDENTIFIER_TABLE record. Each offset points to the
421 /// NULL-terminated string that corresponds to that identifier.
422 IDENTIFIER_OFFSET = 3,
424 /// This is so that older clang versions, before the introduction
425 /// of the control block, can read and reject the newer PCH format.
426 /// *DON'T CHANGE THIS NUMBER*.
427 METADATA_OLD_FORMAT = 4,
429 /// Record code for the identifier table.
431 /// The identifier table is a simple blob that contains
432 /// NULL-terminated strings for all of the identifiers
433 /// referenced by the AST file. The IDENTIFIER_OFFSET table
434 /// contains the mapping from identifier IDs to the characters
435 /// in this blob. Note that the starting offsets of all of the
436 /// identifiers are odd, so that, when the identifier offset
437 /// table is loaded in, we can use the low bit to distinguish
438 /// between offsets (for unresolved identifier IDs) and
439 /// IdentifierInfo pointers (for already-resolved identifier
441 IDENTIFIER_TABLE = 5,
443 /// Record code for the array of eagerly deserialized decls.
445 /// The AST file contains a list of all of the declarations that should be
446 /// eagerly deserialized present within the parsed headers, stored as an
447 /// array of declaration IDs. These declarations will be
448 /// reported to the AST consumer after the AST file has been
449 /// read, since their presence can affect the semantics of the
450 /// program (e.g., for code generation).
451 EAGERLY_DESERIALIZED_DECLS = 6,
453 /// Record code for the set of non-builtin, special
456 /// This record contains the type IDs for the various type nodes
457 /// that are constructed during semantic analysis (e.g.,
458 /// __builtin_va_list). The SPECIAL_TYPE_* constants provide
459 /// offsets into this record.
462 /// Record code for the extra statistics we gather while
463 /// generating an AST file.
466 /// Record code for the array of tentative definitions.
467 TENTATIVE_DEFINITIONS = 9,
469 // ID 10 used to be for a list of extern "C" declarations.
471 /// Record code for the table of offsets into the
472 /// Objective-C method pool.
473 SELECTOR_OFFSETS = 11,
475 /// Record code for the Objective-C method pool,
478 /// The value of the next __COUNTER__ to dispense.
479 /// [PP_COUNTER_VALUE, Val]
480 PP_COUNTER_VALUE = 13,
482 /// Record code for the table of offsets into the block
483 /// of source-location information.
484 SOURCE_LOCATION_OFFSETS = 14,
486 /// Record code for the set of source location entries
487 /// that need to be preloaded by the AST reader.
489 /// This set contains the source location entry for the
490 /// predefines buffer and for any file entries that need to be
492 SOURCE_LOCATION_PRELOADS = 15,
494 /// Record code for the set of ext_vector type names.
495 EXT_VECTOR_DECLS = 16,
497 /// Record code for the array of unused file scoped decls.
498 UNUSED_FILESCOPED_DECLS = 17,
500 /// Record code for the table of offsets to entries in the
501 /// preprocessing record.
502 PPD_ENTITIES_OFFSETS = 18,
504 /// Record code for the array of VTable uses.
507 // ID 20 used to be for a list of dynamic classes.
509 /// Record code for referenced selector pool.
510 REFERENCED_SELECTOR_POOL = 21,
512 /// Record code for an update to the TU's lexically contained
514 TU_UPDATE_LEXICAL = 22,
516 // ID 23 used to be for a list of local redeclarations.
518 /// Record code for declarations that Sema keeps references of.
521 /// Record code for weak undeclared identifiers.
522 WEAK_UNDECLARED_IDENTIFIERS = 25,
524 /// Record code for pending implicit instantiations.
525 PENDING_IMPLICIT_INSTANTIATIONS = 26,
527 // ID 27 used to be for a list of replacement decls.
529 /// Record code for an update to a decl context's lookup table.
531 /// In practice, this should only be used for the TU and namespaces.
534 /// Record for offsets of DECL_UPDATES records for declarations
535 /// that were modified after being deserialized and need updates.
536 DECL_UPDATE_OFFSETS = 29,
538 // ID 30 used to be a decl update record. These are now in the DECLTYPES
541 // ID 31 used to be a list of offsets to DECL_CXX_BASE_SPECIFIERS records.
543 // ID 32 used to be the code for \#pragma diagnostic mappings.
545 /// Record code for special CUDA declarations.
546 CUDA_SPECIAL_DECL_REFS = 33,
548 /// Record code for header search information.
549 HEADER_SEARCH_TABLE = 34,
551 /// Record code for floating point \#pragma options.
552 FP_PRAGMA_OPTIONS = 35,
554 /// Record code for enabled OpenCL extensions.
555 OPENCL_EXTENSIONS = 36,
557 /// The list of delegating constructor declarations.
558 DELEGATING_CTORS = 37,
560 /// Record code for the set of known namespaces, which are used
561 /// for typo correction.
562 KNOWN_NAMESPACES = 38,
564 /// Record code for the remapping information used to relate
565 /// loaded modules to the various offsets and IDs(e.g., source location
566 /// offests, declaration and type IDs) that are used in that module to
567 /// refer to other modules.
568 MODULE_OFFSET_MAP = 39,
570 /// Record code for the source manager line table information,
571 /// which stores information about \#line directives.
572 SOURCE_MANAGER_LINE_TABLE = 40,
574 /// Record code for map of Objective-C class definition IDs to the
575 /// ObjC categories in a module that are attached to that class.
576 OBJC_CATEGORIES_MAP = 41,
578 /// Record code for a file sorted array of DeclIDs in a module.
579 FILE_SORTED_DECLS = 42,
581 /// Record code for an array of all of the (sub)modules that were
582 /// imported by the AST file.
583 IMPORTED_MODULES = 43,
585 // ID 44 used to be a table of merged canonical declarations.
586 // ID 45 used to be a list of declaration IDs of local redeclarations.
588 /// Record code for the array of Objective-C categories (including
591 /// This array can only be interpreted properly using the Objective-C
593 OBJC_CATEGORIES = 46,
595 /// Record code for the table of offsets of each macro ID.
597 /// The offset table contains offsets into the blob stored in
598 /// the preprocessor block. Each offset points to the corresponding
599 /// macro definition.
602 /// A list of "interesting" identifiers. Only used in C++ (where we
603 /// don't normally do lookups into the serialized identifier table). These
604 /// are eagerly deserialized.
605 INTERESTING_IDENTIFIERS = 48,
607 /// Record code for undefined but used functions and variables that
608 /// need a definition in this TU.
609 UNDEFINED_BUT_USED = 49,
611 /// Record code for late parsed template functions.
612 LATE_PARSED_TEMPLATE = 50,
614 /// Record code for \#pragma optimize options.
615 OPTIMIZE_PRAGMA_OPTIONS = 51,
617 /// Record code for potentially unused local typedef names.
618 UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES = 52,
620 // ID 53 used to be a table of constructor initializer records.
622 /// Delete expressions that will be analyzed later.
623 DELETE_EXPRS_TO_ANALYZE = 54,
625 /// Record code for \#pragma ms_struct options.
626 MSSTRUCT_PRAGMA_OPTIONS = 55,
628 /// Record code for \#pragma ms_struct options.
629 POINTERS_TO_MEMBERS_PRAGMA_OPTIONS = 56,
631 /// Number of unmatched #pragma clang cuda_force_host_device begin
632 /// directives we've seen.
633 CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH = 57,
635 /// Record code for types associated with OpenCL extensions.
636 OPENCL_EXTENSION_TYPES = 58,
638 /// Record code for declarations associated with OpenCL extensions.
639 OPENCL_EXTENSION_DECLS = 59,
641 MODULAR_CODEGEN_DECLS = 60,
643 /// Record code for \#pragma pack options.
644 PACK_PRAGMA_OPTIONS = 61,
646 /// The stack of open #ifs/#ifdefs recorded in a preamble.
647 PP_CONDITIONAL_STACK = 62,
649 /// A table of skipped ranges within the preprocessing record.
650 PPD_SKIPPED_RANGES = 63
653 /// Record types used within a source manager block.
654 enum SourceManagerRecordTypes {
655 /// Describes a source location entry (SLocEntry) for a
657 SM_SLOC_FILE_ENTRY = 1,
659 /// Describes a source location entry (SLocEntry) for a
661 SM_SLOC_BUFFER_ENTRY = 2,
663 /// Describes a blob that contains the data for a buffer
664 /// entry. This kind of record always directly follows a
665 /// SM_SLOC_BUFFER_ENTRY record or a SM_SLOC_FILE_ENTRY with an
666 /// overridden buffer.
667 SM_SLOC_BUFFER_BLOB = 3,
669 /// Describes a zlib-compressed blob that contains the data for
671 SM_SLOC_BUFFER_BLOB_COMPRESSED = 4,
673 /// Describes a source location entry (SLocEntry) for a
675 SM_SLOC_EXPANSION_ENTRY = 5
678 /// Record types used within a preprocessor block.
679 enum PreprocessorRecordTypes {
680 // The macros in the PP section are a PP_MACRO_* instance followed by a
681 // list of PP_TOKEN instances for each token in the definition.
683 /// An object-like macro definition.
684 /// [PP_MACRO_OBJECT_LIKE, IdentInfoID, SLoc, IsUsed]
685 PP_MACRO_OBJECT_LIKE = 1,
687 /// A function-like macro definition.
688 /// [PP_MACRO_FUNCTION_LIKE, \<ObjectLikeStuff>, IsC99Varargs,
689 /// IsGNUVarars, NumArgs, ArgIdentInfoID* ]
690 PP_MACRO_FUNCTION_LIKE = 2,
692 /// Describes one token.
693 /// [PP_TOKEN, SLoc, Length, IdentInfoID, Kind, Flags]
696 /// The macro directives history for a particular identifier.
697 PP_MACRO_DIRECTIVE_HISTORY = 4,
699 /// A macro directive exported by a module.
700 /// [PP_MODULE_MACRO, SubmoduleID, MacroID, (Overridden SubmoduleID)*]
704 /// Record types used within a preprocessor detail block.
705 enum PreprocessorDetailRecordTypes {
706 /// Describes a macro expansion within the preprocessing record.
707 PPD_MACRO_EXPANSION = 0,
709 /// Describes a macro definition within the preprocessing record.
710 PPD_MACRO_DEFINITION = 1,
712 /// Describes an inclusion directive within the preprocessing
714 PPD_INCLUSION_DIRECTIVE = 2
717 /// Record types used within a submodule description block.
718 enum SubmoduleRecordTypes {
719 /// Metadata for submodules as a whole.
720 SUBMODULE_METADATA = 0,
722 /// Defines the major attributes of a submodule, including its
724 SUBMODULE_DEFINITION = 1,
726 /// Specifies the umbrella header used to create this module,
728 SUBMODULE_UMBRELLA_HEADER = 2,
730 /// Specifies a header that falls into this (sub)module.
731 SUBMODULE_HEADER = 3,
733 /// Specifies a top-level header that falls into this (sub)module.
734 SUBMODULE_TOPHEADER = 4,
736 /// Specifies an umbrella directory.
737 SUBMODULE_UMBRELLA_DIR = 5,
739 /// Specifies the submodules that are imported by this
741 SUBMODULE_IMPORTS = 6,
743 /// Specifies the submodules that are re-exported from this
745 SUBMODULE_EXPORTS = 7,
747 /// Specifies a required feature.
748 SUBMODULE_REQUIRES = 8,
750 /// Specifies a header that has been explicitly excluded
751 /// from this submodule.
752 SUBMODULE_EXCLUDED_HEADER = 9,
754 /// Specifies a library or framework to link against.
755 SUBMODULE_LINK_LIBRARY = 10,
757 /// Specifies a configuration macro for this module.
758 SUBMODULE_CONFIG_MACRO = 11,
760 /// Specifies a conflict with another module.
761 SUBMODULE_CONFLICT = 12,
763 /// Specifies a header that is private to this submodule.
764 SUBMODULE_PRIVATE_HEADER = 13,
766 /// Specifies a header that is part of the module but must be
767 /// textually included.
768 SUBMODULE_TEXTUAL_HEADER = 14,
770 /// Specifies a header that is private to this submodule but
771 /// must be textually included.
772 SUBMODULE_PRIVATE_TEXTUAL_HEADER = 15,
774 /// Specifies some declarations with initializers that must be
775 /// emitted to initialize the module.
776 SUBMODULE_INITIALIZERS = 16,
778 /// Specifies the name of the module that will eventually
779 /// re-export the entities in this module.
780 SUBMODULE_EXPORT_AS = 17,
783 /// Record types used within a comments block.
784 enum CommentRecordTypes {
785 COMMENTS_RAW_COMMENT = 0
788 /// \defgroup ASTAST AST file AST constants
790 /// The constants in this group describe various components of the
791 /// abstract syntax tree within an AST file.
795 /// Predefined type IDs.
797 /// These type IDs correspond to predefined types in the AST
798 /// context, such as built-in types (int) and special place-holder
799 /// types (the \<overload> and \<dependent> type markers). Such
800 /// types are never actually serialized, since they will be built
801 /// by the AST context when it is created.
802 enum PredefinedTypeIDs {
804 PREDEF_TYPE_NULL_ID = 0,
807 PREDEF_TYPE_VOID_ID = 1,
809 /// The 'bool' or '_Bool' type.
810 PREDEF_TYPE_BOOL_ID = 2,
812 /// The 'char' type, when it is unsigned.
813 PREDEF_TYPE_CHAR_U_ID = 3,
815 /// The 'unsigned char' type.
816 PREDEF_TYPE_UCHAR_ID = 4,
818 /// The 'unsigned short' type.
819 PREDEF_TYPE_USHORT_ID = 5,
821 /// The 'unsigned int' type.
822 PREDEF_TYPE_UINT_ID = 6,
824 /// The 'unsigned long' type.
825 PREDEF_TYPE_ULONG_ID = 7,
827 /// The 'unsigned long long' type.
828 PREDEF_TYPE_ULONGLONG_ID = 8,
830 /// The 'char' type, when it is signed.
831 PREDEF_TYPE_CHAR_S_ID = 9,
833 /// The 'signed char' type.
834 PREDEF_TYPE_SCHAR_ID = 10,
836 /// The C++ 'wchar_t' type.
837 PREDEF_TYPE_WCHAR_ID = 11,
839 /// The (signed) 'short' type.
840 PREDEF_TYPE_SHORT_ID = 12,
842 /// The (signed) 'int' type.
843 PREDEF_TYPE_INT_ID = 13,
845 /// The (signed) 'long' type.
846 PREDEF_TYPE_LONG_ID = 14,
848 /// The (signed) 'long long' type.
849 PREDEF_TYPE_LONGLONG_ID = 15,
851 /// The 'float' type.
852 PREDEF_TYPE_FLOAT_ID = 16,
854 /// The 'double' type.
855 PREDEF_TYPE_DOUBLE_ID = 17,
857 /// The 'long double' type.
858 PREDEF_TYPE_LONGDOUBLE_ID = 18,
860 /// The placeholder type for overloaded function sets.
861 PREDEF_TYPE_OVERLOAD_ID = 19,
863 /// The placeholder type for dependent types.
864 PREDEF_TYPE_DEPENDENT_ID = 20,
866 /// The '__uint128_t' type.
867 PREDEF_TYPE_UINT128_ID = 21,
869 /// The '__int128_t' type.
870 PREDEF_TYPE_INT128_ID = 22,
872 /// The type of 'nullptr'.
873 PREDEF_TYPE_NULLPTR_ID = 23,
875 /// The C++ 'char16_t' type.
876 PREDEF_TYPE_CHAR16_ID = 24,
878 /// The C++ 'char32_t' type.
879 PREDEF_TYPE_CHAR32_ID = 25,
881 /// The ObjC 'id' type.
882 PREDEF_TYPE_OBJC_ID = 26,
884 /// The ObjC 'Class' type.
885 PREDEF_TYPE_OBJC_CLASS = 27,
887 /// The ObjC 'SEL' type.
888 PREDEF_TYPE_OBJC_SEL = 28,
890 /// The 'unknown any' placeholder type.
891 PREDEF_TYPE_UNKNOWN_ANY = 29,
893 /// The placeholder type for bound member functions.
894 PREDEF_TYPE_BOUND_MEMBER = 30,
896 /// The "auto" deduction type.
897 PREDEF_TYPE_AUTO_DEDUCT = 31,
899 /// The "auto &&" deduction type.
900 PREDEF_TYPE_AUTO_RREF_DEDUCT = 32,
902 /// The OpenCL 'half' / ARM NEON __fp16 type.
903 PREDEF_TYPE_HALF_ID = 33,
905 /// ARC's unbridged-cast placeholder type.
906 PREDEF_TYPE_ARC_UNBRIDGED_CAST = 34,
908 /// The pseudo-object placeholder type.
909 PREDEF_TYPE_PSEUDO_OBJECT = 35,
911 /// The placeholder type for builtin functions.
912 PREDEF_TYPE_BUILTIN_FN = 36,
914 /// OpenCL event type.
915 PREDEF_TYPE_EVENT_ID = 37,
917 /// OpenCL clk event type.
918 PREDEF_TYPE_CLK_EVENT_ID = 38,
920 /// OpenCL sampler type.
921 PREDEF_TYPE_SAMPLER_ID = 39,
923 /// OpenCL queue type.
924 PREDEF_TYPE_QUEUE_ID = 40,
926 /// OpenCL reserve_id type.
927 PREDEF_TYPE_RESERVE_ID_ID = 41,
929 /// The placeholder type for OpenMP array section.
930 PREDEF_TYPE_OMP_ARRAY_SECTION = 42,
932 /// The '__float128' type
933 PREDEF_TYPE_FLOAT128_ID = 43,
935 /// The '_Float16' type
936 PREDEF_TYPE_FLOAT16_ID = 44,
938 /// The C++ 'char8_t' type.
939 PREDEF_TYPE_CHAR8_ID = 45,
941 /// \brief The 'short _Accum' type
942 PREDEF_TYPE_SHORT_ACCUM_ID = 46,
944 /// \brief The '_Accum' type
945 PREDEF_TYPE_ACCUM_ID = 47,
947 /// \brief The 'long _Accum' type
948 PREDEF_TYPE_LONG_ACCUM_ID = 48,
950 /// \brief The 'unsigned short _Accum' type
951 PREDEF_TYPE_USHORT_ACCUM_ID = 49,
953 /// \brief The 'unsigned _Accum' type
954 PREDEF_TYPE_UACCUM_ID = 50,
956 /// \brief The 'unsigned long _Accum' type
957 PREDEF_TYPE_ULONG_ACCUM_ID = 51,
959 /// \brief The 'short _Fract' type
960 PREDEF_TYPE_SHORT_FRACT_ID = 52,
962 /// \brief The '_Fract' type
963 PREDEF_TYPE_FRACT_ID = 53,
965 /// \brief The 'long _Fract' type
966 PREDEF_TYPE_LONG_FRACT_ID = 54,
968 /// \brief The 'unsigned short _Fract' type
969 PREDEF_TYPE_USHORT_FRACT_ID = 55,
971 /// \brief The 'unsigned _Fract' type
972 PREDEF_TYPE_UFRACT_ID = 56,
974 /// \brief The 'unsigned long _Fract' type
975 PREDEF_TYPE_ULONG_FRACT_ID = 57,
977 /// \brief The '_Sat short _Accum' type
978 PREDEF_TYPE_SAT_SHORT_ACCUM_ID = 58,
980 /// \brief The '_Sat _Accum' type
981 PREDEF_TYPE_SAT_ACCUM_ID = 59,
983 /// \brief The '_Sat long _Accum' type
984 PREDEF_TYPE_SAT_LONG_ACCUM_ID = 60,
986 /// \brief The '_Sat unsigned short _Accum' type
987 PREDEF_TYPE_SAT_USHORT_ACCUM_ID = 61,
989 /// \brief The '_Sat unsigned _Accum' type
990 PREDEF_TYPE_SAT_UACCUM_ID = 62,
992 /// \brief The '_Sat unsigned long _Accum' type
993 PREDEF_TYPE_SAT_ULONG_ACCUM_ID = 63,
995 /// \brief The '_Sat short _Fract' type
996 PREDEF_TYPE_SAT_SHORT_FRACT_ID = 64,
998 /// \brief The '_Sat _Fract' type
999 PREDEF_TYPE_SAT_FRACT_ID = 65,
1001 /// \brief The '_Sat long _Fract' type
1002 PREDEF_TYPE_SAT_LONG_FRACT_ID = 66,
1004 /// \brief The '_Sat unsigned short _Fract' type
1005 PREDEF_TYPE_SAT_USHORT_FRACT_ID = 67,
1007 /// \brief The '_Sat unsigned _Fract' type
1008 PREDEF_TYPE_SAT_UFRACT_ID = 68,
1010 /// \brief The '_Sat unsigned long _Fract' type
1011 PREDEF_TYPE_SAT_ULONG_FRACT_ID = 69,
1013 /// OpenCL image types with auto numeration
1014 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1015 PREDEF_TYPE_##Id##_ID,
1016 #include "clang/Basic/OpenCLImageTypes.def"
1017 /// \brief OpenCL extension types with auto numeration
1018 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
1019 PREDEF_TYPE_##Id##_ID,
1020 #include "clang/Basic/OpenCLExtensionTypes.def"
1023 /// The number of predefined type IDs that are reserved for
1024 /// the PREDEF_TYPE_* constants.
1026 /// Type IDs for non-predefined types will start at
1027 /// NUM_PREDEF_TYPE_IDs.
1028 const unsigned NUM_PREDEF_TYPE_IDS = 200;
1030 /// Record codes for each kind of type.
1032 /// These constants describe the type records that can occur within a
1033 /// block identified by DECLTYPES_BLOCK_ID in the AST file. Each
1034 /// constant describes a record for a specific type class in the
1035 /// AST. Note that DeclCode values share this code space.
1037 /// An ExtQualType record.
1040 /// A ComplexType record.
1043 /// A PointerType record.
1046 /// A BlockPointerType record.
1047 TYPE_BLOCK_POINTER = 5,
1049 /// An LValueReferenceType record.
1050 TYPE_LVALUE_REFERENCE = 6,
1052 /// An RValueReferenceType record.
1053 TYPE_RVALUE_REFERENCE = 7,
1055 /// A MemberPointerType record.
1056 TYPE_MEMBER_POINTER = 8,
1058 /// A ConstantArrayType record.
1059 TYPE_CONSTANT_ARRAY = 9,
1061 /// An IncompleteArrayType record.
1062 TYPE_INCOMPLETE_ARRAY = 10,
1064 /// A VariableArrayType record.
1065 TYPE_VARIABLE_ARRAY = 11,
1067 /// A VectorType record.
1070 /// An ExtVectorType record.
1071 TYPE_EXT_VECTOR = 13,
1073 /// A FunctionNoProtoType record.
1074 TYPE_FUNCTION_NO_PROTO = 14,
1076 /// A FunctionProtoType record.
1077 TYPE_FUNCTION_PROTO = 15,
1079 /// A TypedefType record.
1082 /// A TypeOfExprType record.
1083 TYPE_TYPEOF_EXPR = 17,
1085 /// A TypeOfType record.
1088 /// A RecordType record.
1091 /// An EnumType record.
1094 /// An ObjCInterfaceType record.
1095 TYPE_OBJC_INTERFACE = 21,
1097 /// An ObjCObjectPointerType record.
1098 TYPE_OBJC_OBJECT_POINTER = 22,
1100 /// a DecltypeType record.
1103 /// An ElaboratedType record.
1104 TYPE_ELABORATED = 24,
1106 /// A SubstTemplateTypeParmType record.
1107 TYPE_SUBST_TEMPLATE_TYPE_PARM = 25,
1109 /// An UnresolvedUsingType record.
1110 TYPE_UNRESOLVED_USING = 26,
1112 /// An InjectedClassNameType record.
1113 TYPE_INJECTED_CLASS_NAME = 27,
1115 /// An ObjCObjectType record.
1116 TYPE_OBJC_OBJECT = 28,
1118 /// An TemplateTypeParmType record.
1119 TYPE_TEMPLATE_TYPE_PARM = 29,
1121 /// An TemplateSpecializationType record.
1122 TYPE_TEMPLATE_SPECIALIZATION = 30,
1124 /// A DependentNameType record.
1125 TYPE_DEPENDENT_NAME = 31,
1127 /// A DependentTemplateSpecializationType record.
1128 TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION = 32,
1130 /// A DependentSizedArrayType record.
1131 TYPE_DEPENDENT_SIZED_ARRAY = 33,
1133 /// A ParenType record.
1136 /// A PackExpansionType record.
1137 TYPE_PACK_EXPANSION = 35,
1139 /// An AttributedType record.
1140 TYPE_ATTRIBUTED = 36,
1142 /// A SubstTemplateTypeParmPackType record.
1143 TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK = 37,
1145 /// A AutoType record.
1148 /// A UnaryTransformType record.
1149 TYPE_UNARY_TRANSFORM = 39,
1151 /// An AtomicType record.
1154 /// A DecayedType record.
1157 /// An AdjustedType record.
1160 /// A PipeType record.
1163 /// An ObjCTypeParamType record.
1164 TYPE_OBJC_TYPE_PARAM = 44,
1166 /// A DeducedTemplateSpecializationType record.
1167 TYPE_DEDUCED_TEMPLATE_SPECIALIZATION = 45,
1169 /// A DependentSizedExtVectorType record.
1170 TYPE_DEPENDENT_SIZED_EXT_VECTOR = 46,
1172 /// A DependentAddressSpaceType record.
1173 TYPE_DEPENDENT_ADDRESS_SPACE = 47,
1175 /// A dependentSizedVectorType record.
1176 TYPE_DEPENDENT_SIZED_VECTOR = 48,
1178 /// A type defined in a macro.
1179 TYPE_MACRO_QUALIFIED = 49
1182 /// The type IDs for special types constructed by semantic
1185 /// The constants in this enumeration are indices into the
1186 /// SPECIAL_TYPES record.
1187 enum SpecialTypeIDs {
1188 /// CFConstantString type
1189 SPECIAL_TYPE_CF_CONSTANT_STRING = 0,
1191 /// C FILE typedef type
1192 SPECIAL_TYPE_FILE = 1,
1194 /// C jmp_buf typedef type
1195 SPECIAL_TYPE_JMP_BUF = 2,
1197 /// C sigjmp_buf typedef type
1198 SPECIAL_TYPE_SIGJMP_BUF = 3,
1200 /// Objective-C "id" redefinition type
1201 SPECIAL_TYPE_OBJC_ID_REDEFINITION = 4,
1203 /// Objective-C "Class" redefinition type
1204 SPECIAL_TYPE_OBJC_CLASS_REDEFINITION = 5,
1206 /// Objective-C "SEL" redefinition type
1207 SPECIAL_TYPE_OBJC_SEL_REDEFINITION = 6,
1209 /// C ucontext_t typedef type
1210 SPECIAL_TYPE_UCONTEXT_T = 7
1213 /// The number of special type IDs.
1214 const unsigned NumSpecialTypeIDs = 8;
1216 /// Predefined declaration IDs.
1218 /// These declaration IDs correspond to predefined declarations in the AST
1219 /// context, such as the NULL declaration ID. Such declarations are never
1220 /// actually serialized, since they will be built by the AST context when
1222 enum PredefinedDeclIDs {
1223 /// The NULL declaration.
1224 PREDEF_DECL_NULL_ID = 0,
1226 /// The translation unit.
1227 PREDEF_DECL_TRANSLATION_UNIT_ID = 1,
1229 /// The Objective-C 'id' type.
1230 PREDEF_DECL_OBJC_ID_ID = 2,
1232 /// The Objective-C 'SEL' type.
1233 PREDEF_DECL_OBJC_SEL_ID = 3,
1235 /// The Objective-C 'Class' type.
1236 PREDEF_DECL_OBJC_CLASS_ID = 4,
1238 /// The Objective-C 'Protocol' type.
1239 PREDEF_DECL_OBJC_PROTOCOL_ID = 5,
1241 /// The signed 128-bit integer type.
1242 PREDEF_DECL_INT_128_ID = 6,
1244 /// The unsigned 128-bit integer type.
1245 PREDEF_DECL_UNSIGNED_INT_128_ID = 7,
1247 /// The internal 'instancetype' typedef.
1248 PREDEF_DECL_OBJC_INSTANCETYPE_ID = 8,
1250 /// The internal '__builtin_va_list' typedef.
1251 PREDEF_DECL_BUILTIN_VA_LIST_ID = 9,
1253 /// The internal '__va_list_tag' struct, if any.
1254 PREDEF_DECL_VA_LIST_TAG = 10,
1256 /// The internal '__builtin_ms_va_list' typedef.
1257 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID = 11,
1259 /// The extern "C" context.
1260 PREDEF_DECL_EXTERN_C_CONTEXT_ID = 12,
1262 /// The internal '__make_integer_seq' template.
1263 PREDEF_DECL_MAKE_INTEGER_SEQ_ID = 13,
1265 /// The internal '__NSConstantString' typedef.
1266 PREDEF_DECL_CF_CONSTANT_STRING_ID = 14,
1268 /// The internal '__NSConstantString' tag type.
1269 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID = 15,
1271 /// The internal '__type_pack_element' template.
1272 PREDEF_DECL_TYPE_PACK_ELEMENT_ID = 16,
1275 /// The number of declaration IDs that are predefined.
1277 /// For more information about predefined declarations, see the
1278 /// \c PredefinedDeclIDs type and the PREDEF_DECL_*_ID constants.
1279 const unsigned int NUM_PREDEF_DECL_IDS = 17;
1281 /// Record of updates for a declaration that was modified after
1282 /// being deserialized. This can occur within DECLTYPES_BLOCK_ID.
1283 const unsigned int DECL_UPDATES = 49;
1285 /// Record code for a list of local redeclarations of a declaration.
1286 /// This can occur within DECLTYPES_BLOCK_ID.
1287 const unsigned int LOCAL_REDECLARATIONS = 50;
1289 /// Record codes for each kind of declaration.
1291 /// These constants describe the declaration records that can occur within
1292 /// a declarations block (identified by DECLTYPES_BLOCK_ID). Each
1293 /// constant describes a record for a specific declaration class
1294 /// in the AST. Note that TypeCode values share this code space.
1296 /// A TypedefDecl record.
1298 /// A TypeAliasDecl record.
1302 /// An EnumDecl record.
1305 /// A RecordDecl record.
1308 /// An EnumConstantDecl record.
1311 /// A FunctionDecl record.
1314 /// A ObjCMethodDecl record.
1317 /// A ObjCInterfaceDecl record.
1318 DECL_OBJC_INTERFACE,
1320 /// A ObjCProtocolDecl record.
1323 /// A ObjCIvarDecl record.
1326 /// A ObjCAtDefsFieldDecl record.
1327 DECL_OBJC_AT_DEFS_FIELD,
1329 /// A ObjCCategoryDecl record.
1332 /// A ObjCCategoryImplDecl record.
1333 DECL_OBJC_CATEGORY_IMPL,
1335 /// A ObjCImplementationDecl record.
1336 DECL_OBJC_IMPLEMENTATION,
1338 /// A ObjCCompatibleAliasDecl record.
1339 DECL_OBJC_COMPATIBLE_ALIAS,
1341 /// A ObjCPropertyDecl record.
1344 /// A ObjCPropertyImplDecl record.
1345 DECL_OBJC_PROPERTY_IMPL,
1347 /// A FieldDecl record.
1350 /// A MSPropertyDecl record.
1353 /// A VarDecl record.
1356 /// An ImplicitParamDecl record.
1357 DECL_IMPLICIT_PARAM,
1359 /// A ParmVarDecl record.
1362 /// A DecompositionDecl record.
1365 /// A BindingDecl record.
1368 /// A FileScopeAsmDecl record.
1369 DECL_FILE_SCOPE_ASM,
1371 /// A BlockDecl record.
1374 /// A CapturedDecl record.
1377 /// A record that stores the set of declarations that are
1378 /// lexically stored within a given DeclContext.
1380 /// The record itself is a blob that is an array of declaration IDs,
1381 /// in the order in which those declarations were added to the
1382 /// declaration context. This data is used when iterating over
1383 /// the contents of a DeclContext, e.g., via
1384 /// DeclContext::decls_begin() and DeclContext::decls_end().
1385 DECL_CONTEXT_LEXICAL,
1387 /// A record that stores the set of declarations that are
1388 /// visible from a given DeclContext.
1390 /// The record itself stores a set of mappings, each of which
1391 /// associates a declaration name with one or more declaration
1392 /// IDs. This data is used when performing qualified name lookup
1393 /// into a DeclContext via DeclContext::lookup.
1394 DECL_CONTEXT_VISIBLE,
1396 /// A LabelDecl record.
1399 /// A NamespaceDecl record.
1402 /// A NamespaceAliasDecl record.
1403 DECL_NAMESPACE_ALIAS,
1405 /// A UsingDecl record.
1408 /// A UsingPackDecl record.
1411 /// A UsingShadowDecl record.
1414 /// A ConstructorUsingShadowDecl record.
1415 DECL_CONSTRUCTOR_USING_SHADOW,
1417 /// A UsingDirecitveDecl record.
1418 DECL_USING_DIRECTIVE,
1420 /// An UnresolvedUsingValueDecl record.
1421 DECL_UNRESOLVED_USING_VALUE,
1423 /// An UnresolvedUsingTypenameDecl record.
1424 DECL_UNRESOLVED_USING_TYPENAME,
1426 /// A LinkageSpecDecl record.
1429 /// An ExportDecl record.
1432 /// A CXXRecordDecl record.
1435 /// A CXXDeductionGuideDecl record.
1436 DECL_CXX_DEDUCTION_GUIDE,
1438 /// A CXXMethodDecl record.
1441 /// A CXXConstructorDecl record.
1442 DECL_CXX_CONSTRUCTOR,
1444 /// A CXXDestructorDecl record.
1445 DECL_CXX_DESTRUCTOR,
1447 /// A CXXConversionDecl record.
1448 DECL_CXX_CONVERSION,
1450 /// An AccessSpecDecl record.
1453 /// A FriendDecl record.
1456 /// A FriendTemplateDecl record.
1457 DECL_FRIEND_TEMPLATE,
1459 /// A ClassTemplateDecl record.
1460 DECL_CLASS_TEMPLATE,
1462 /// A ClassTemplateSpecializationDecl record.
1463 DECL_CLASS_TEMPLATE_SPECIALIZATION,
1465 /// A ClassTemplatePartialSpecializationDecl record.
1466 DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION,
1468 /// A VarTemplateDecl record.
1471 /// A VarTemplateSpecializationDecl record.
1472 DECL_VAR_TEMPLATE_SPECIALIZATION,
1474 /// A VarTemplatePartialSpecializationDecl record.
1475 DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION,
1477 /// A FunctionTemplateDecl record.
1478 DECL_FUNCTION_TEMPLATE,
1480 /// A TemplateTypeParmDecl record.
1481 DECL_TEMPLATE_TYPE_PARM,
1483 /// A NonTypeTemplateParmDecl record.
1484 DECL_NON_TYPE_TEMPLATE_PARM,
1486 /// A TemplateTemplateParmDecl record.
1487 DECL_TEMPLATE_TEMPLATE_PARM,
1489 /// A TypeAliasTemplateDecl record.
1490 DECL_TYPE_ALIAS_TEMPLATE,
1492 /// \brief A ConceptDecl record.
1495 /// \brief A StaticAssertDecl record.
1498 /// A record containing CXXBaseSpecifiers.
1499 DECL_CXX_BASE_SPECIFIERS,
1501 /// A record containing CXXCtorInitializers.
1502 DECL_CXX_CTOR_INITIALIZERS,
1504 /// A IndirectFieldDecl record.
1507 /// A NonTypeTemplateParmDecl record that stores an expanded
1508 /// non-type template parameter pack.
1509 DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK,
1511 /// A TemplateTemplateParmDecl record that stores an expanded
1512 /// template template parameter pack.
1513 DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK,
1515 /// A ClassScopeFunctionSpecializationDecl record a class scope
1516 /// function specialization. (Microsoft extension).
1517 DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION,
1519 /// An ImportDecl recording a module import.
1522 /// An OMPThreadPrivateDecl record.
1523 DECL_OMP_THREADPRIVATE,
1525 /// An OMPRequiresDecl record.
1528 /// An OMPAllocateDcl record.
1531 /// An EmptyDecl record.
1534 /// An ObjCTypeParamDecl record.
1535 DECL_OBJC_TYPE_PARAM,
1537 /// An OMPCapturedExprDecl record.
1538 DECL_OMP_CAPTUREDEXPR,
1540 /// A PragmaCommentDecl record.
1541 DECL_PRAGMA_COMMENT,
1543 /// A PragmaDetectMismatchDecl record.
1544 DECL_PRAGMA_DETECT_MISMATCH,
1546 /// An OMPDeclareMapperDecl record.
1547 DECL_OMP_DECLARE_MAPPER,
1549 /// An OMPDeclareReductionDecl record.
1550 DECL_OMP_DECLARE_REDUCTION,
1552 DECL_LAST = DECL_OMP_DECLARE_REDUCTION
1555 /// Record codes for each kind of statement or expression.
1557 /// These constants describe the records that describe statements
1558 /// or expressions. These records occur within type and declarations
1559 /// block, so they begin with record values of 128. Each constant
1560 /// describes a record for a specific statement or expression class in the
1563 /// A marker record that indicates that we are at the end
1564 /// of an expression.
1565 STMT_STOP = DECL_LAST + 1,
1567 /// A NULL expression.
1570 /// A reference to a previously [de]serialized Stmt record.
1573 /// A NullStmt record.
1576 /// A CompoundStmt record.
1579 /// A CaseStmt record.
1582 /// A DefaultStmt record.
1585 /// A LabelStmt record.
1588 /// An AttributedStmt record.
1591 /// An IfStmt record.
1594 /// A SwitchStmt record.
1597 /// A WhileStmt record.
1600 /// A DoStmt record.
1603 /// A ForStmt record.
1606 /// A GotoStmt record.
1609 /// An IndirectGotoStmt record.
1612 /// A ContinueStmt record.
1615 /// A BreakStmt record.
1618 /// A ReturnStmt record.
1621 /// A DeclStmt record.
1624 /// A CapturedStmt record.
1627 /// A GCC-style AsmStmt record.
1630 /// A MS-style AsmStmt record.
1633 /// A constant expression context.
1636 /// A PredefinedExpr record.
1639 /// A DeclRefExpr record.
1642 /// An IntegerLiteral record.
1643 EXPR_INTEGER_LITERAL,
1645 /// A FloatingLiteral record.
1646 EXPR_FLOATING_LITERAL,
1648 /// An ImaginaryLiteral record.
1649 EXPR_IMAGINARY_LITERAL,
1651 /// A StringLiteral record.
1652 EXPR_STRING_LITERAL,
1654 /// A CharacterLiteral record.
1655 EXPR_CHARACTER_LITERAL,
1657 /// A ParenExpr record.
1660 /// A ParenListExpr record.
1663 /// A UnaryOperator record.
1664 EXPR_UNARY_OPERATOR,
1666 /// An OffsetOfExpr record.
1669 /// A SizefAlignOfExpr record.
1670 EXPR_SIZEOF_ALIGN_OF,
1672 /// An ArraySubscriptExpr record.
1673 EXPR_ARRAY_SUBSCRIPT,
1675 /// A CallExpr record.
1678 /// A MemberExpr record.
1681 /// A BinaryOperator record.
1682 EXPR_BINARY_OPERATOR,
1684 /// A CompoundAssignOperator record.
1685 EXPR_COMPOUND_ASSIGN_OPERATOR,
1687 /// A ConditionOperator record.
1688 EXPR_CONDITIONAL_OPERATOR,
1690 /// An ImplicitCastExpr record.
1693 /// A CStyleCastExpr record.
1696 /// A CompoundLiteralExpr record.
1697 EXPR_COMPOUND_LITERAL,
1699 /// An ExtVectorElementExpr record.
1700 EXPR_EXT_VECTOR_ELEMENT,
1702 /// An InitListExpr record.
1705 /// A DesignatedInitExpr record.
1706 EXPR_DESIGNATED_INIT,
1708 /// A DesignatedInitUpdateExpr record.
1709 EXPR_DESIGNATED_INIT_UPDATE,
1711 /// An NoInitExpr record.
1714 /// An ArrayInitLoopExpr record.
1715 EXPR_ARRAY_INIT_LOOP,
1717 /// An ArrayInitIndexExpr record.
1718 EXPR_ARRAY_INIT_INDEX,
1720 /// An ImplicitValueInitExpr record.
1721 EXPR_IMPLICIT_VALUE_INIT,
1723 /// A VAArgExpr record.
1726 /// An AddrLabelExpr record.
1729 /// A StmtExpr record.
1732 /// A ChooseExpr record.
1735 /// A GNUNullExpr record.
1738 /// A SourceLocExpr record.
1741 /// A ShuffleVectorExpr record.
1742 EXPR_SHUFFLE_VECTOR,
1744 /// A ConvertVectorExpr record.
1745 EXPR_CONVERT_VECTOR,
1750 /// A GenericSelectionExpr record.
1751 EXPR_GENERIC_SELECTION,
1753 /// A PseudoObjectExpr record.
1756 /// An AtomicExpr record.
1761 /// An ObjCStringLiteral record.
1762 EXPR_OBJC_STRING_LITERAL,
1764 EXPR_OBJC_BOXED_EXPRESSION,
1765 EXPR_OBJC_ARRAY_LITERAL,
1766 EXPR_OBJC_DICTIONARY_LITERAL,
1768 /// An ObjCEncodeExpr record.
1771 /// An ObjCSelectorExpr record.
1772 EXPR_OBJC_SELECTOR_EXPR,
1774 /// An ObjCProtocolExpr record.
1775 EXPR_OBJC_PROTOCOL_EXPR,
1777 /// An ObjCIvarRefExpr record.
1778 EXPR_OBJC_IVAR_REF_EXPR,
1780 /// An ObjCPropertyRefExpr record.
1781 EXPR_OBJC_PROPERTY_REF_EXPR,
1783 /// An ObjCSubscriptRefExpr record.
1784 EXPR_OBJC_SUBSCRIPT_REF_EXPR,
1787 EXPR_OBJC_KVC_REF_EXPR,
1789 /// An ObjCMessageExpr record.
1790 EXPR_OBJC_MESSAGE_EXPR,
1792 /// An ObjCIsa Expr record.
1795 /// An ObjCIndirectCopyRestoreExpr record.
1796 EXPR_OBJC_INDIRECT_COPY_RESTORE,
1798 /// An ObjCForCollectionStmt record.
1799 STMT_OBJC_FOR_COLLECTION,
1801 /// An ObjCAtCatchStmt record.
1804 /// An ObjCAtFinallyStmt record.
1807 /// An ObjCAtTryStmt record.
1810 /// An ObjCAtSynchronizedStmt record.
1811 STMT_OBJC_AT_SYNCHRONIZED,
1813 /// An ObjCAtThrowStmt record.
1816 /// An ObjCAutoreleasePoolStmt record.
1817 STMT_OBJC_AUTORELEASE_POOL,
1819 /// An ObjCBoolLiteralExpr record.
1820 EXPR_OBJC_BOOL_LITERAL,
1822 /// An ObjCAvailabilityCheckExpr record.
1823 EXPR_OBJC_AVAILABILITY_CHECK,
1827 /// A CXXCatchStmt record.
1830 /// A CXXTryStmt record.
1832 /// A CXXForRangeStmt record.
1836 /// A CXXOperatorCallExpr record.
1837 EXPR_CXX_OPERATOR_CALL,
1839 /// A CXXMemberCallExpr record.
1840 EXPR_CXX_MEMBER_CALL,
1842 /// A CXXConstructExpr record.
1845 /// A CXXInheritedCtorInitExpr record.
1846 EXPR_CXX_INHERITED_CTOR_INIT,
1848 /// A CXXTemporaryObjectExpr record.
1849 EXPR_CXX_TEMPORARY_OBJECT,
1851 /// A CXXStaticCastExpr record.
1852 EXPR_CXX_STATIC_CAST,
1854 /// A CXXDynamicCastExpr record.
1855 EXPR_CXX_DYNAMIC_CAST,
1857 /// A CXXReinterpretCastExpr record.
1858 EXPR_CXX_REINTERPRET_CAST,
1860 /// A CXXConstCastExpr record.
1861 EXPR_CXX_CONST_CAST,
1863 /// A CXXFunctionalCastExpr record.
1864 EXPR_CXX_FUNCTIONAL_CAST,
1866 /// A UserDefinedLiteral record.
1867 EXPR_USER_DEFINED_LITERAL,
1869 /// A CXXStdInitializerListExpr record.
1870 EXPR_CXX_STD_INITIALIZER_LIST,
1872 /// A CXXBoolLiteralExpr record.
1873 EXPR_CXX_BOOL_LITERAL,
1875 EXPR_CXX_NULL_PTR_LITERAL, // CXXNullPtrLiteralExpr
1876 EXPR_CXX_TYPEID_EXPR, // CXXTypeidExpr (of expr).
1877 EXPR_CXX_TYPEID_TYPE, // CXXTypeidExpr (of type).
1878 EXPR_CXX_THIS, // CXXThisExpr
1879 EXPR_CXX_THROW, // CXXThrowExpr
1880 EXPR_CXX_DEFAULT_ARG, // CXXDefaultArgExpr
1881 EXPR_CXX_DEFAULT_INIT, // CXXDefaultInitExpr
1882 EXPR_CXX_BIND_TEMPORARY, // CXXBindTemporaryExpr
1884 EXPR_CXX_SCALAR_VALUE_INIT, // CXXScalarValueInitExpr
1885 EXPR_CXX_NEW, // CXXNewExpr
1886 EXPR_CXX_DELETE, // CXXDeleteExpr
1887 EXPR_CXX_PSEUDO_DESTRUCTOR, // CXXPseudoDestructorExpr
1889 EXPR_EXPR_WITH_CLEANUPS, // ExprWithCleanups
1891 EXPR_CXX_DEPENDENT_SCOPE_MEMBER, // CXXDependentScopeMemberExpr
1892 EXPR_CXX_DEPENDENT_SCOPE_DECL_REF, // DependentScopeDeclRefExpr
1893 EXPR_CXX_UNRESOLVED_CONSTRUCT, // CXXUnresolvedConstructExpr
1894 EXPR_CXX_UNRESOLVED_MEMBER, // UnresolvedMemberExpr
1895 EXPR_CXX_UNRESOLVED_LOOKUP, // UnresolvedLookupExpr
1897 EXPR_CXX_EXPRESSION_TRAIT, // ExpressionTraitExpr
1898 EXPR_CXX_NOEXCEPT, // CXXNoexceptExpr
1900 EXPR_OPAQUE_VALUE, // OpaqueValueExpr
1901 EXPR_BINARY_CONDITIONAL_OPERATOR, // BinaryConditionalOperator
1902 EXPR_TYPE_TRAIT, // TypeTraitExpr
1903 EXPR_ARRAY_TYPE_TRAIT, // ArrayTypeTraitIntExpr
1905 EXPR_PACK_EXPANSION, // PackExpansionExpr
1906 EXPR_SIZEOF_PACK, // SizeOfPackExpr
1907 EXPR_SUBST_NON_TYPE_TEMPLATE_PARM, // SubstNonTypeTemplateParmExpr
1908 EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK,// SubstNonTypeTemplateParmPackExpr
1909 EXPR_FUNCTION_PARM_PACK, // FunctionParmPackExpr
1910 EXPR_MATERIALIZE_TEMPORARY, // MaterializeTemporaryExpr
1911 EXPR_CXX_FOLD, // CXXFoldExpr
1914 EXPR_CUDA_KERNEL_CALL, // CUDAKernelCallExpr
1917 EXPR_ASTYPE, // AsTypeExpr
1920 EXPR_CXX_PROPERTY_REF_EXPR, // MSPropertyRefExpr
1921 EXPR_CXX_PROPERTY_SUBSCRIPT_EXPR, // MSPropertySubscriptExpr
1922 EXPR_CXX_UUIDOF_EXPR, // CXXUuidofExpr (of expr).
1923 EXPR_CXX_UUIDOF_TYPE, // CXXUuidofExpr (of type).
1924 STMT_SEH_LEAVE, // SEHLeaveStmt
1925 STMT_SEH_EXCEPT, // SEHExceptStmt
1926 STMT_SEH_FINALLY, // SEHFinallyStmt
1927 STMT_SEH_TRY, // SEHTryStmt
1929 // OpenMP directives
1930 STMT_OMP_PARALLEL_DIRECTIVE,
1931 STMT_OMP_SIMD_DIRECTIVE,
1932 STMT_OMP_FOR_DIRECTIVE,
1933 STMT_OMP_FOR_SIMD_DIRECTIVE,
1934 STMT_OMP_SECTIONS_DIRECTIVE,
1935 STMT_OMP_SECTION_DIRECTIVE,
1936 STMT_OMP_SINGLE_DIRECTIVE,
1937 STMT_OMP_MASTER_DIRECTIVE,
1938 STMT_OMP_CRITICAL_DIRECTIVE,
1939 STMT_OMP_PARALLEL_FOR_DIRECTIVE,
1940 STMT_OMP_PARALLEL_FOR_SIMD_DIRECTIVE,
1941 STMT_OMP_PARALLEL_SECTIONS_DIRECTIVE,
1942 STMT_OMP_TASK_DIRECTIVE,
1943 STMT_OMP_TASKYIELD_DIRECTIVE,
1944 STMT_OMP_BARRIER_DIRECTIVE,
1945 STMT_OMP_TASKWAIT_DIRECTIVE,
1946 STMT_OMP_FLUSH_DIRECTIVE,
1947 STMT_OMP_ORDERED_DIRECTIVE,
1948 STMT_OMP_ATOMIC_DIRECTIVE,
1949 STMT_OMP_TARGET_DIRECTIVE,
1950 STMT_OMP_TARGET_DATA_DIRECTIVE,
1951 STMT_OMP_TARGET_ENTER_DATA_DIRECTIVE,
1952 STMT_OMP_TARGET_EXIT_DATA_DIRECTIVE,
1953 STMT_OMP_TARGET_PARALLEL_DIRECTIVE,
1954 STMT_OMP_TARGET_PARALLEL_FOR_DIRECTIVE,
1955 STMT_OMP_TEAMS_DIRECTIVE,
1956 STMT_OMP_TASKGROUP_DIRECTIVE,
1957 STMT_OMP_CANCELLATION_POINT_DIRECTIVE,
1958 STMT_OMP_CANCEL_DIRECTIVE,
1959 STMT_OMP_TASKLOOP_DIRECTIVE,
1960 STMT_OMP_TASKLOOP_SIMD_DIRECTIVE,
1961 STMT_OMP_DISTRIBUTE_DIRECTIVE,
1962 STMT_OMP_TARGET_UPDATE_DIRECTIVE,
1963 STMT_OMP_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1964 STMT_OMP_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1965 STMT_OMP_DISTRIBUTE_SIMD_DIRECTIVE,
1966 STMT_OMP_TARGET_PARALLEL_FOR_SIMD_DIRECTIVE,
1967 STMT_OMP_TARGET_SIMD_DIRECTIVE,
1968 STMT_OMP_TEAMS_DISTRIBUTE_DIRECTIVE,
1969 STMT_OMP_TEAMS_DISTRIBUTE_SIMD_DIRECTIVE,
1970 STMT_OMP_TEAMS_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1971 STMT_OMP_TEAMS_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1972 STMT_OMP_TARGET_TEAMS_DIRECTIVE,
1973 STMT_OMP_TARGET_TEAMS_DISTRIBUTE_DIRECTIVE,
1974 STMT_OMP_TARGET_TEAMS_DISTRIBUTE_PARALLEL_FOR_DIRECTIVE,
1975 STMT_OMP_TARGET_TEAMS_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE,
1976 STMT_OMP_TARGET_TEAMS_DISTRIBUTE_SIMD_DIRECTIVE,
1977 EXPR_OMP_ARRAY_SECTION,
1980 EXPR_OBJC_BRIDGED_CAST, // ObjCBridgedCastExpr
1982 STMT_MS_DEPENDENT_EXISTS, // MSDependentExistsStmt
1983 EXPR_LAMBDA, // LambdaExpr
1984 STMT_COROUTINE_BODY,
1988 EXPR_DEPENDENT_COAWAIT,
1991 /// The kinds of designators that can occur in a
1992 /// DesignatedInitExpr.
1993 enum DesignatorTypes {
1994 /// Field designator where only the field name is known.
1995 DESIG_FIELD_NAME = 0,
1997 /// Field designator where the field has been resolved to
1999 DESIG_FIELD_DECL = 1,
2001 /// Array designator.
2004 /// GNU array range designator.
2005 DESIG_ARRAY_RANGE = 3
2008 /// The different kinds of data that can occur in a
2009 /// CtorInitializer.
2010 enum CtorInitializerType {
2011 CTOR_INITIALIZER_BASE,
2012 CTOR_INITIALIZER_DELEGATING,
2013 CTOR_INITIALIZER_MEMBER,
2014 CTOR_INITIALIZER_INDIRECT_MEMBER
2017 /// Describes the redeclarations of a declaration.
2018 struct LocalRedeclarationsInfo {
2019 // The ID of the first declaration
2022 // Offset into the array of redeclaration chains.
2025 friend bool operator<(const LocalRedeclarationsInfo &X,
2026 const LocalRedeclarationsInfo &Y) {
2027 return X.FirstID < Y.FirstID;
2030 friend bool operator>(const LocalRedeclarationsInfo &X,
2031 const LocalRedeclarationsInfo &Y) {
2032 return X.FirstID > Y.FirstID;
2035 friend bool operator<=(const LocalRedeclarationsInfo &X,
2036 const LocalRedeclarationsInfo &Y) {
2037 return X.FirstID <= Y.FirstID;
2040 friend bool operator>=(const LocalRedeclarationsInfo &X,
2041 const LocalRedeclarationsInfo &Y) {
2042 return X.FirstID >= Y.FirstID;
2046 /// Describes the categories of an Objective-C class.
2047 struct ObjCCategoriesInfo {
2048 // The ID of the definition
2049 DeclID DefinitionID;
2051 // Offset into the array of category lists.
2054 friend bool operator<(const ObjCCategoriesInfo &X,
2055 const ObjCCategoriesInfo &Y) {
2056 return X.DefinitionID < Y.DefinitionID;
2059 friend bool operator>(const ObjCCategoriesInfo &X,
2060 const ObjCCategoriesInfo &Y) {
2061 return X.DefinitionID > Y.DefinitionID;
2064 friend bool operator<=(const ObjCCategoriesInfo &X,
2065 const ObjCCategoriesInfo &Y) {
2066 return X.DefinitionID <= Y.DefinitionID;
2069 friend bool operator>=(const ObjCCategoriesInfo &X,
2070 const ObjCCategoriesInfo &Y) {
2071 return X.DefinitionID >= Y.DefinitionID;
2075 /// A key used when looking up entities by \ref DeclarationName.
2077 /// Different \ref DeclarationNames are mapped to different keys, but the
2078 /// same key can occasionally represent multiple names (for names that
2079 /// contain types, in particular).
2080 class DeclarationNameKey {
2081 using NameKind = unsigned;
2087 DeclarationNameKey() = default;
2088 DeclarationNameKey(DeclarationName Name);
2089 DeclarationNameKey(NameKind Kind, uint64_t Data)
2090 : Kind(Kind), Data(Data) {}
2092 NameKind getKind() const { return Kind; }
2094 IdentifierInfo *getIdentifier() const {
2095 assert(Kind == DeclarationName::Identifier ||
2096 Kind == DeclarationName::CXXLiteralOperatorName ||
2097 Kind == DeclarationName::CXXDeductionGuideName);
2098 return (IdentifierInfo *)Data;
2101 Selector getSelector() const {
2102 assert(Kind == DeclarationName::ObjCZeroArgSelector ||
2103 Kind == DeclarationName::ObjCOneArgSelector ||
2104 Kind == DeclarationName::ObjCMultiArgSelector);
2105 return Selector(Data);
2108 OverloadedOperatorKind getOperatorKind() const {
2109 assert(Kind == DeclarationName::CXXOperatorName);
2110 return (OverloadedOperatorKind)Data;
2113 /// Compute a fingerprint of this key for use in on-disk hash table.
2114 unsigned getHash() const;
2116 friend bool operator==(const DeclarationNameKey &A,
2117 const DeclarationNameKey &B) {
2118 return A.Kind == B.Kind && A.Data == B.Data;
2124 } // namespace serialization
2125 } // namespace clang
2129 template <> struct DenseMapInfo<clang::serialization::DeclarationNameKey> {
2130 static clang::serialization::DeclarationNameKey getEmptyKey() {
2131 return clang::serialization::DeclarationNameKey(-1, 1);
2134 static clang::serialization::DeclarationNameKey getTombstoneKey() {
2135 return clang::serialization::DeclarationNameKey(-1, 2);
2139 getHashValue(const clang::serialization::DeclarationNameKey &Key) {
2140 return Key.getHash();
2143 static bool isEqual(const clang::serialization::DeclarationNameKey &L,
2144 const clang::serialization::DeclarationNameKey &R) {
2151 #endif // LLVM_CLANG_SERIALIZATION_ASTBITCODES_H