clang 22.0.0git
clang::api_notes::CXXMethodInfo Class Reference

Describes API notes data for a C++ method. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::CXXMethodInfo:
[legend]

Public Member Functions

 CXXMethodInfo ()
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS)
Public Member Functions inherited from clang::api_notes::FunctionInfo
 FunctionInfo ()
void addTypeInfo (unsigned index, NullabilityKind kind)
void addReturnTypeInfo (NullabilityKind kind)
 Adds the return type info.
void addParamTypeInfo (unsigned index, NullabilityKind kind)
 Adds the parameter type info.
NullabilityKind getParamTypeInfo (unsigned index) const
NullabilityKind getReturnTypeInfo () const
std::optional< RetainCountConventionKindgetRetainCountConvention () const
void setRetainCountConvention (std::optional< RetainCountConventionKind > Value)
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS) const
Public Member Functions inherited from clang::api_notes::CommonEntityInfo
 CommonEntityInfo ()
std::optional< boolisSwiftPrivate () const
void setSwiftPrivate (std::optional< bool > Private)
std::optional< SwiftSafetyKindgetSwiftSafety () const
void setSwiftSafety (SwiftSafetyKind Safety)
CommonEntityInfooperator|= (const CommonEntityInfo &RHS)
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS) const

Public Attributes

std::optional< ParamInfoThis
Public Attributes inherited from clang::api_notes::FunctionInfo
unsigned NullabilityAudited: 1
 Whether the signature has been audited with respect to nullability.
unsigned NumAdjustedNullable: 8
 Number of types whose nullability is encoded with the NullabilityPayload.
unsigned RawRetainCountConvention: 3
 A biased RetainCountConventionKind, where 0 means "unspecified".
uint64_t NullabilityPayload = 0
 Stores the nullability of the return type and the parameters.
std::string ResultType
 The result type of this function, as a C type.
std::string SwiftReturnOwnership
 Ownership convention for return value.
std::vector< ParamInfoParams
 The function parameters.
Public Attributes inherited from clang::api_notes::CommonEntityInfo
std::string UnavailableMsg
 Message to use when this entity is unavailable.
unsigned Unavailable: 1
 Whether this entity is marked unavailable.
unsigned UnavailableInSwift: 1
 Whether this entity is marked unavailable in Swift.
std::string SwiftName
 Swift name of this entity.

Additional Inherited Members

Static Public Member Functions inherited from clang::api_notes::FunctionInfo
static unsigned getMaxNullabilityIndex ()

Detailed Description

Describes API notes data for a C++ method.

Definition at line 734 of file Types.h.

Constructor & Destructor Documentation

◆ CXXMethodInfo()

clang::api_notes::CXXMethodInfo::CXXMethodInfo ( )
inline

Definition at line 736 of file Types.h.

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void clang::api_notes::CXXMethodInfo::dump ( llvm::raw_ostream & OS)

Definition at line 111 of file APINotesTypes.cpp.

References clang::api_notes::FunctionInfo::FunctionInfo(), and This.

Member Data Documentation

◆ This

std::optional<ParamInfo> clang::api_notes::CXXMethodInfo::This

Definition at line 738 of file Types.h.

Referenced by dump(), clang::api_notes::operator==(), and ProcessAPINotes().


The documentation for this class was generated from the following files: