clang::api_notes::CommonEntityInfo Class Reference

Describes API notes data for any entity. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::CommonEntityInfo:

Public Member Functions
	CommonEntityInfo ()
std::optional< bool >	isSwiftPrivate () const
void	setSwiftPrivate (std::optional< bool > Private)
std::optional< SwiftSafetyKind >	getSwiftSafety () const
void	setSwiftSafety (SwiftSafetyKind Safety)
CommonEntityInfo &	operator|= (const CommonEntityInfo &RHS)
LLVM_DUMP_METHOD void	dump (llvm::raw_ostream &OS) const

Public Attributes
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.

Friends
bool	operator== (const CommonEntityInfo &LHS, const CommonEntityInfo &RHS)

Detailed Description

Describes API notes data for any entity.

This is used as the base of all API notes.

Definition at line 54 of file Types.h.

Constructor & Destructor Documentation

CommonEntityInfo()

clang::api_notes::CommonEntityInfo::CommonEntityInfo ( )

inline

Definition at line 86 of file Types.h.

References CommonEntityInfo(), Unavailable, and UnavailableInSwift.

Referenced by CommonEntityInfo(), clang::api_notes::CommonTypeInfo::dump(), clang::api_notes::FunctionInfo::dump(), clang::api_notes::VariableInfo::dump(), operator==, clang::api_notes::CommonTypeInfo::operator==, clang::api_notes::FunctionInfo::operator==, clang::api_notes::VariableInfo::operator==, operator|=(), clang::api_notes::CommonTypeInfo::operator|=(), and clang::api_notes::VariableInfo::operator|=().

Member Function Documentation

dump()

LLVM_DUMP_METHOD void clang::api_notes::CommonEntityInfo::dump

(

llvm::raw_ostream &

OS

)

const

Definition at line 14 of file APINotesTypes.cpp.

References getSwiftSafety(), clang::api_notes::None, clang::api_notes::Safe, SwiftName, Unavailable, UnavailableInSwift, UnavailableMsg, clang::api_notes::Unsafe, and clang::api_notes::Unspecified.

getSwiftSafety()

std::optional< SwiftSafetyKind > clang::api_notes::CommonEntityInfo::getSwiftSafety ( ) const

inline

Definition at line 100 of file Types.h.

Referenced by dump(), operator|=(), and ProcessAPINotes().

isSwiftPrivate()

std::optional< bool > clang::api_notes::CommonEntityInfo::isSwiftPrivate ( ) const

inline

Definition at line 90 of file Types.h.

Referenced by operator|=(), and ProcessAPINotes().

operator|=()

CommonEntityInfo & clang::api_notes::CommonEntityInfo::operator|= ( const CommonEntityInfo & RHS )

inline

Definition at line 113 of file Types.h.

References CommonEntityInfo(), getSwiftSafety(), isSwiftPrivate(), setSwiftPrivate(), setSwiftSafety(), SwiftName, Unavailable, UnavailableInSwift, and UnavailableMsg.

setSwiftPrivate()

void clang::api_notes::CommonEntityInfo::setSwiftPrivate ( std::optional< bool > Private )

inline

Definition at line 95 of file Types.h.

References clang::Private.

Referenced by operator|=().

setSwiftSafety()

void clang::api_notes::CommonEntityInfo::setSwiftSafety ( SwiftSafetyKind Safety )

inline

Definition at line 106 of file Types.h.

Referenced by operator|=().

Friends And Related Symbol Documentation

operator==

bool operator== ( const CommonEntityInfo & LHS, const CommonEntityInfo & RHS )

friend

Definition at line 142 of file Types.h.

References CommonEntityInfo(), SwiftName, Unavailable, UnavailableInSwift, and UnavailableMsg.

Member Data Documentation

SwiftName

std::string clang::api_notes::CommonEntityInfo::SwiftName

Swift name of this entity.

Definition at line 84 of file Types.h.

Referenced by dump(), operator==, and operator|=().

Unavailable

unsigned clang::api_notes::CommonEntityInfo::Unavailable

Whether this entity is marked unavailable.

Definition at line 61 of file Types.h.

Referenced by CommonEntityInfo(), dump(), operator==, operator|=(), and ProcessAPINotes().

UnavailableInSwift

unsigned clang::api_notes::CommonEntityInfo::UnavailableInSwift

Whether this entity is marked unavailable in Swift.

Definition at line 65 of file Types.h.

Referenced by CommonEntityInfo(), dump(), operator==, operator|=(), and ProcessAPINotes().

UnavailableMsg

std::string clang::api_notes::CommonEntityInfo::UnavailableMsg

Message to use when this entity is unavailable.

Definition at line 57 of file Types.h.

Referenced by dump(), operator==, operator|=(), and ProcessAPINotes().

---

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

• include/clang/APINotes/Types.h
• lib/APINotes/APINotesTypes.cpp