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

API notes for a variable/property. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::VariableInfo:
Inheritance graph
[legend]

Public Member Functions

 VariableInfo ()
 
std::optional< NullabilityKindgetNullability () const
 
void setNullabilityAudited (NullabilityKind kind)
 
const std::string & getType () const
 
void setType (const std::string &type)
 
VariableInfooperator|= (const VariableInfo &RHS)
 
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
 

Friends

bool operator== (const VariableInfo &, const VariableInfo &)
 

Additional Inherited Members

- 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

API notes for a variable/property.

Definition at line 310 of file Types.h.

Constructor & Destructor Documentation

◆ VariableInfo()

clang::api_notes::VariableInfo::VariableInfo ( )
inline

Definition at line 324 of file Types.h.

Member Function Documentation

◆ dump()

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

◆ getNullability()

std::optional< NullabilityKind > clang::api_notes::VariableInfo::getNullability ( ) const
inline

◆ getType()

const std::string & clang::api_notes::VariableInfo::getType ( ) const
inline

Definition at line 337 of file Types.h.

Referenced by ProcessAPINotes().

◆ operator|=()

VariableInfo & clang::api_notes::VariableInfo::operator|= ( const VariableInfo RHS)
inline

Definition at line 342 of file Types.h.

References getNullability(), and setNullabilityAudited().

◆ setNullabilityAudited()

void clang::api_notes::VariableInfo::setNullabilityAudited ( NullabilityKind  kind)
inline

Definition at line 332 of file Types.h.

Referenced by clang::api_notes::ObjCPropertyInfo::operator|=(), and operator|=().

◆ setType()

void clang::api_notes::VariableInfo::setType ( const std::string &  type)
inline

Definition at line 338 of file Types.h.

References clang::ast_matchers::type.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const VariableInfo LHS,
const VariableInfo RHS 
)
friend

Definition at line 356 of file Types.h.


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