class FunctionInfo

Declaration

class FunctionInfo : public CommonEntityInfo { /* full declaration omitted */ };

Description

API notes for a function or method.

Declared at: clang/include/clang/APINotes/Types.h:478

Inherits from: CommonEntityInfo

Member Variables

public unsigned int NullabilityAudited

Whether the signature has been audited with respect to nullability.

public unsigned int NumAdjustedNullable

Number of types whose nullability is encoded with the NullabilityPayload.

public unsigned int RawRetainCountConvention

A biased RetainCountConventionKind, where 0 means "unspecified".

public uint64_t NullabilityPayload = 0

Stores the nullability of the return type and the parameters.

public std::string ResultType

The result type of this function, as a C type.

public std::vector<ParamInfo> Params

The function parameters.

private static const unsigned int NullabilityKindMask = 3

private static const unsigned int NullabilityKindSize = 2

private static const unsigned int ReturnInfoIndex = 0

Inherited from CommonEntityInfo:

public UnavailableMsg

public Unavailable

public UnavailableInSwift

public SwiftName

Method Overview

• public FunctionInfo()
• public void addParamTypeInfo(unsigned int index, clang::NullabilityKind kind)
• public void addReturnTypeInfo(clang::NullabilityKind kind)
• public void addTypeInfo(unsigned int index, clang::NullabilityKind kind)
• public void dump(llvm::raw_ostream & OS) const
• public static unsigned int getMaxNullabilityIndex()
• public clang::NullabilityKind getParamTypeInfo(unsigned int index) const
• public llvm::Optional<RetainCountConventionKind> getRetainCountConvention() const
• public clang::NullabilityKind getReturnTypeInfo() const
• private clang::NullabilityKind getTypeInfo(unsigned int index) const
• public void setRetainCountConvention(llvm::Optional<RetainCountConventionKind> Value)

Inherited from CommonEntityInfo:

• public dump
• public isSwiftPrivate
• public setSwiftPrivate

Methods

¶FunctionInfo()

Declared at: clang/include/clang/APINotes/Types.h:512

¶void addParamTypeInfo(unsigned int index,
                      clang::NullabilityKind kind)

Description

Adds the parameter type info.

Declared at: clang/include/clang/APINotes/Types.h:544

Parameters

unsigned int index

clang::NullabilityKind kind

¶void addReturnTypeInfo(
    clang::NullabilityKind kind)

Description

Adds the return type info.

Declared at: clang/include/clang/APINotes/Types.h:539

Parameters

clang::NullabilityKind kind

¶void addTypeInfo(unsigned int index,
                 clang::NullabilityKind kind)

Declared at: clang/include/clang/APINotes/Types.h:520

Parameters

unsigned int index

clang::NullabilityKind kind

¶void dump(llvm::raw_ostream& OS) const

Declared at: clang/include/clang/APINotes/Types.h:580

Parameters

llvm::raw_ostream& OS

¶static unsigned int getMaxNullabilityIndex()

Declared at: clang/include/clang/APINotes/Types.h:516

¶clang::NullabilityKind getParamTypeInfo(
    unsigned int index) const

Declared at: clang/include/clang/APINotes/Types.h:548

Parameters

unsigned int index

¶llvm::Optional<RetainCountConventionKind>
getRetainCountConvention() const

Declared at: clang/include/clang/APINotes/Types.h:554

¶clang::NullabilityKind getReturnTypeInfo() const

Declared at: clang/include/clang/APINotes/Types.h:552

¶clang::NullabilityKind getTypeInfo(
    unsigned int index) const

Declared at: clang/include/clang/APINotes/Types.h:568

Parameters

unsigned int index

¶void setRetainCountConvention(
    llvm::Optional<RetainCountConventionKind>
        Value)

Declared at: clang/include/clang/APINotes/Types.h:560

Parameters

llvm::Optional<RetainCountConventionKind> Value