The base representation of an Objective-C container record. More...

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::ObjCContainerRecord:

Public Member Functions
	ObjCContainerRecord ()=delete
	ObjCContainerRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
virtual	~ObjCContainerRecord ()=0
Public Member Functions inherited from clang::extractapi::APIRecord
APIRecord *	getNextInContext () const
RecordKind	getKind () const
RecordKind	getKindForDisplay () const
	APIRecord ()=delete
	APIRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Location, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader, AccessControl Access=AccessControl())
	APIRecord (RecordKind Kind, StringRef USR, StringRef Name)
virtual	~APIRecord ()=0
Public Member Functions inherited from clang::extractapi::RecordContext
	RecordContext (APIRecord::RecordKind Kind)
void	stealRecordChain (RecordContext &Other)
	Append `Other` children chain into ours and empty out Other's record chain.
void	removeFromRecordChain (APIRecord *Record)
APIRecord::RecordKind	getKind () const
record_range	records () const
record_iterator	records_begin () const
record_iterator	records_end () const
bool	records_empty () const

Public Attributes
SmallVector< SymbolReference >	Protocols
Public Attributes inherited from clang::extractapi::APIRecord
StringRef	USR
StringRef	Name
SymbolReference	Parent
PresumedLoc	Location
AvailabilityInfo	Availability
LinkageInfo	Linkage
DocComment	Comment
	Documentation comment lines attached to this symbol declaration.
DeclarationFragments	Declaration
	Declaration fragments of this symbol declaration.
DeclarationFragments	SubHeading
	SubHeading provides a more detailed representation than the plain declaration name.
bool	IsFromSystemHeader
	Whether the symbol was defined in a system header.
AccessControl	Access
RecordKind	KindForDisplay

Additional Inherited Members
Public Types inherited from clang::extractapi::APIRecord
enum	RecordKind { RK_Unknown , RK_FirstRecordContext , RK_Namespace , RK_Enum , RK_Struct , RK_Union , RK_ObjCInterface , RK_ObjCCategory , RK_ObjCProtocol , RK_CXXClass , RK_ClassTemplate , RK_ClassTemplateSpecialization , RK_ClassTemplatePartialSpecialization , RK_StructField , RK_UnionField , RK_CXXField , RK_StaticField , RK_CXXFieldTemplate , RK_GlobalVariable , RK_GlobalVariableTemplate , RK_GlobalVariableTemplateSpecialization , RK_GlobalVariableTemplatePartialSpecialization , RK_LastRecordContext , RK_GlobalFunction , RK_GlobalFunctionTemplate , RK_GlobalFunctionTemplateSpecialization , RK_EnumConstant , RK_Concept , RK_CXXStaticMethod , RK_CXXInstanceMethod , RK_CXXConstructorMethod , RK_CXXDestructorMethod , RK_CXXMethodTemplate , RK_CXXMethodTemplateSpecialization , RK_ObjCInstanceProperty , RK_ObjCClassProperty , RK_ObjCIvar , RK_ObjCClassMethod , RK_ObjCInstanceMethod , RK_MacroDefinition , RK_Typedef }
	Discriminator for LLVM-style RTTI (dyn_cast<> et al.) More...
Public Types inherited from clang::extractapi::RecordContext
using	record_range = llvm::iterator_range<record_iterator>
Static Public Member Functions inherited from clang::extractapi::APIRecord
static APIRecord *	castFromRecordContext (const RecordContext *Ctx)
static RecordContext *	castToRecordContext (const APIRecord *Record)
static bool	classof (const APIRecord *Record)
static bool	classofKind (RecordKind K)
static bool	classof (const RecordContext *Ctx)
Static Public Member Functions inherited from clang::extractapi::RecordContext
static bool	classof (const APIRecord *Record)
static bool	classofKind (APIRecord::RecordKind K)
static bool	classof (const RecordContext *Context)
Protected Member Functions inherited from clang::extractapi::RecordContext
void	addToRecordChain (APIRecord *) const

Detailed Description

The base representation of an Objective-C container record.

Holds common information associated with Objective-C containers.

Definition at line 1179 of file API.h.

Constructor & Destructor Documentation

◆ ObjCContainerRecord() [1/2]

clang::extractapi::ObjCContainerRecord::ObjCContainerRecord ( )

delete

Referenced by clang::extractapi::ObjCCategoryRecord::ObjCCategoryRecord(), clang::extractapi::ObjCInterfaceRecord::ObjCInterfaceRecord(), and clang::extractapi::ObjCProtocolRecord::ObjCProtocolRecord().

◆ ObjCContainerRecord() [2/2]

clang::extractapi::ObjCContainerRecord::ObjCContainerRecord	(	RecordKind	Kind,
		StringRef	USR,
		StringRef	Name,
		SymbolReference	Parent,
		PresumedLoc	Loc,
		AvailabilityInfo	Availability,
		LinkageInfo	Linkage,
		const DocComment &	Comment,
		DeclarationFragments	Declaration,
		DeclarationFragments	SubHeading,
		bool	IsFromSystemHeader )

inline

Definition at line 1184 of file API.h.

References clang::extractapi::APIRecord::APIRecord(), clang::extractapi::APIRecord::Availability, clang::extractapi::APIRecord::Comment, clang::extractapi::APIRecord::Declaration, clang::extractapi::APIRecord::IsFromSystemHeader, clang::extractapi::APIRecord::Linkage, clang::extractapi::APIRecord::Name, clang::extractapi::APIRecord::Parent, clang::extractapi::APIRecord::RecordContext, clang::extractapi::APIRecord::SubHeading, and clang::extractapi::APIRecord::USR.

◆ ~ObjCContainerRecord()

ObjCContainerRecord::~ObjCContainerRecord ( )

pure virtual

Definition at line 172 of file API.cpp.

Member Data Documentation

◆ Protocols

SmallVector<SymbolReference> clang::extractapi::ObjCContainerRecord::Protocols

Definition at line 1180 of file API.h.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCProtocols().

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

include/clang/ExtractAPI/API.h
lib/ExtractAPI/API.cpp

Public Member Functions

Public Attributes