clang 18.0.0git
|
Namespaces | |
namespace | control_block |
namespace | enum_constant_block |
namespace | global_function_block |
namespace | global_variable_block |
namespace | identifier_block |
namespace | objc_context_block |
namespace | objc_method_block |
namespace | objc_property_block |
namespace | objc_selector_block |
namespace | tag_block |
namespace | typedef_block |
Classes | |
class | APINotesWriter |
class | CommonEntityInfo |
Describes API notes data for any entity. More... | |
class | CommonTypeInfo |
Describes API notes for types. More... | |
struct | Context |
class | ContextID |
Opaque context ID used to refer to an Objective-C class or protocol or a C++ namespace. More... | |
struct | ContextTableKey |
A stored Objective-C or C++ context, represented by the ID of its parent context, the kind of this context (Objective-C class / C++ namespace / etc), and the ID of this context. More... | |
class | EnumConstantInfo |
Describes API notes data for an enumerator. More... | |
class | FunctionInfo |
API notes for a function or method. More... | |
class | GlobalFunctionInfo |
Describes API notes data for a global function. More... | |
class | GlobalVariableInfo |
Describes API notes data for a global variable. More... | |
class | ObjCContextInfo |
Describes API notes data for an Objective-C class or protocol. More... | |
class | ObjCMethodInfo |
Describes API notes data for an Objective-C method. More... | |
class | ObjCPropertyInfo |
Describes API notes data for an Objective-C property. More... | |
struct | ObjCSelectorRef |
A temporary reference to an Objective-C selector, suitable for referencing selector data on the stack. More... | |
class | ParamInfo |
Describes a function or method parameter. More... | |
struct | StoredObjCSelector |
A stored Objective-C selector. More... | |
class | TagInfo |
Describes API notes data for a tag. More... | |
class | TypedefInfo |
Describes API notes data for a typedef. More... | |
class | VariableInfo |
API notes for a variable/property. More... | |
Typedefs | |
using | IdentifierID = llvm::PointerEmbeddedInt< unsigned, 31 > |
using | IdentifierIDField = llvm::BCVBR< 16 > |
using | SelectorID = llvm::PointerEmbeddedInt< unsigned, 31 > |
using | SelectorIDField = llvm::BCVBR< 16 > |
Enumerations | |
enum class | RetainCountConventionKind { None , CFReturnsRetained , CFReturnsNotRetained , NSReturnsRetained , NSReturnsNotRetained } |
enum class | EnumExtensibilityKind { None , Open , Closed } |
The payload for an enum_extensibility attribute. More... | |
enum class | SwiftNewTypeKind { None , Struct , Enum } |
The kind of a swift_wrapper/swift_newtype. More... | |
enum class | ContextKind : uint8_t { ObjCClass = 0 , ObjCProtocol = 1 , Namespace = 2 } |
enum | BlockID { CONTROL_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID , IDENTIFIER_BLOCK_ID , OBJC_CONTEXT_BLOCK_ID , OBJC_PROPERTY_BLOCK_ID , OBJC_METHOD_BLOCK_ID , OBJC_SELECTOR_BLOCK_ID , GLOBAL_VARIABLE_BLOCK_ID , GLOBAL_FUNCTION_BLOCK_ID , TAG_BLOCK_ID , TYPEDEF_BLOCK_ID , ENUM_CONSTANT_BLOCK_ID } |
The various types of blocks that can occur within a API notes file. More... | |
Variables | |
const unsigned char | API_NOTES_SIGNATURE [] = {0xE2, 0x9C, 0xA8, 0x01} |
Magic number for API notes files. | |
const uint16_t | VERSION_MAJOR = 0 |
API notes file major version number. | |
const uint16_t | VERSION_MINOR = 25 |
API notes file minor version number. | |
using clang::api_notes::IdentifierID = typedef llvm::PointerEmbeddedInt<unsigned, 31> |
Definition at line 29 of file APINotesFormat.h.
using clang::api_notes::IdentifierIDField = typedef llvm::BCVBR<16> |
Definition at line 30 of file APINotesFormat.h.
using clang::api_notes::SelectorID = typedef llvm::PointerEmbeddedInt<unsigned, 31> |
Definition at line 32 of file APINotesFormat.h.
using clang::api_notes::SelectorIDField = typedef llvm::BCVBR<16> |
Definition at line 33 of file APINotesFormat.h.
The various types of blocks that can occur within a API notes file.
These IDs must not be renumbered or reordered without incrementing VERSION_MAJOR.
Enumerator | |
---|---|
CONTROL_BLOCK_ID | The control block, which contains all of the information that needs to be validated prior to committing to loading the API notes file.
|
IDENTIFIER_BLOCK_ID | The identifier data block, which maps identifier strings to IDs. |
OBJC_CONTEXT_BLOCK_ID | The Objective-C context data block, which contains information about Objective-C classes and protocols. |
OBJC_PROPERTY_BLOCK_ID | The Objective-C property data block, which maps Objective-C (class name, property name) pairs to information about the property. |
OBJC_METHOD_BLOCK_ID | The Objective-C property data block, which maps Objective-C (class name, selector, is_instance_method) tuples to information about the method. |
OBJC_SELECTOR_BLOCK_ID | The Objective-C selector data block, which maps Objective-C selector names (# of pieces, identifier IDs) to the selector ID used in other tables. |
GLOBAL_VARIABLE_BLOCK_ID | The global variables data block, which maps global variable names to information about the global variable. |
GLOBAL_FUNCTION_BLOCK_ID | The (global) functions data block, which maps global function names to information about the global function. |
TAG_BLOCK_ID | The tag data block, which maps tag names to information about the tags. |
TYPEDEF_BLOCK_ID | The typedef data block, which maps typedef names to information about the typedefs. |
ENUM_CONSTANT_BLOCK_ID | The enum constant data block, which maps enumerator names to information about the enumerators. |
Definition at line 39 of file APINotesFormat.h.
|
strong |
|
strong |
|
strong |
|
strong |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Definition at line 281 of file APINotesFormat.h.
References clang::api_notes::ContextTableKey::contextID, clang::api_notes::ContextTableKey::contextKind, and clang::api_notes::ContextTableKey::parentContextID.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool clang::api_notes::parseAndDumpAPINotes | ( | llvm::StringRef | YI, |
llvm::raw_ostream & | OS | ||
) |
Parses the APINotes YAML content and writes the representation back to the specified stream.
This provides a means of testing the YAML processing of the APINotes format.
const unsigned char clang::api_notes::API_NOTES_SIGNATURE[] = {0xE2, 0x9C, 0xA8, 0x01} |
Magic number for API notes files.
Definition at line 19 of file APINotesFormat.h.
Referenced by clang::api_notes::APINotesWriter::Implementation::writeToStream().
const uint16_t clang::api_notes::VERSION_MAJOR = 0 |
API notes file major version number.
Definition at line 22 of file APINotesFormat.h.
const uint16_t clang::api_notes::VERSION_MINOR = 25 |
API notes file minor version number.
When the format changes IN ANY WAY, this number should be incremented.
Definition at line 27 of file APINotesFormat.h.