clang 19.0.0git
Public Member Functions | List of all members
clang::api_notes::GlobalFunctionInfo Class Reference

Describes API notes data for a global function. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::GlobalFunctionInfo:
Inheritance graph

Public Member Functions

 GlobalFunctionInfo ()
- 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)
CommonEntityInfooperator|= (const CommonEntityInfo &RHS)
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS) const

Additional Inherited Members

- Static Public Member Functions inherited from clang::api_notes::FunctionInfo
static unsigned getMaxNullabilityIndex ()
- 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::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.

Detailed Description

Describes API notes data for a global function.

Definition at line 660 of file Types.h.

Constructor & Destructor Documentation

◆ GlobalFunctionInfo()

clang::api_notes::GlobalFunctionInfo::GlobalFunctionInfo ( )

Definition at line 662 of file Types.h.

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