This holds information associated with structs and unions. More...

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::RecordRecord:

Public Member Functions
	RecordRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader, bool IsEmbeddedInVarDeclarator, AccessControl Access=AccessControl())
bool	isAnonymousWithNoTypedef ()
virtual	~RecordRecord ()=0
Public Member Functions inherited from clang::extractapi::TagRecord
	TagRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader, bool IsEmbeddedInVarDeclarator, AccessControl Access=AccessControl())
virtual	~TagRecord ()=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

Static Public Member Functions
static bool	classof (const APIRecord *Record)
static bool	classofKind (RecordKind K)
Static Public Member Functions inherited from clang::extractapi::TagRecord
static bool	classof (const APIRecord *Record)
static bool	classofKind (RecordKind K)
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)

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>
Public Attributes inherited from clang::extractapi::TagRecord
bool	IsEmbeddedInVarDeclarator
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
Protected Member Functions inherited from clang::extractapi::RecordContext
void	addToRecordChain (APIRecord *) const

Detailed Description

This holds information associated with structs and unions.

Definition at line 689 of file API.h.

Constructor & Destructor Documentation

◆ RecordRecord()

clang::extractapi::RecordRecord::RecordRecord	(	RecordKind	Kind,
		StringRef	USR,
		StringRef	Name,
		SymbolReference	Parent,
		PresumedLoc	Loc,
		AvailabilityInfo	Availability,
		const DocComment &	Comment,
		DeclarationFragments	Declaration,
		DeclarationFragments	SubHeading,
		bool	IsFromSystemHeader,
		bool	IsEmbeddedInVarDeclarator,
		AccessControl	Access = AccessControl() )

inline

Definition at line 690 of file API.h.

References clang::extractapi::APIRecord::Access, clang::extractapi::APIRecord::Availability, clang::extractapi::APIRecord::Comment, clang::extractapi::APIRecord::Declaration, clang::extractapi::TagRecord::IsEmbeddedInVarDeclarator, clang::extractapi::APIRecord::IsFromSystemHeader, clang::extractapi::APIRecord::Name, clang::extractapi::APIRecord::Parent, clang::extractapi::APIRecord::SubHeading, clang::extractapi::TagRecord::TagRecord(), and clang::extractapi::APIRecord::USR.

Referenced by clang::extractapi::CXXClassRecord::CXXClassRecord(), clang::extractapi::StructRecord::StructRecord(), and clang::extractapi::UnionRecord::UnionRecord().

◆ ~RecordRecord()

RecordRecord::~RecordRecord ( )

pure virtual

Definition at line 170 of file API.cpp.

Member Function Documentation

◆ classof()

bool clang::extractapi::RecordRecord::classof ( const APIRecord * Record )

inlinestatic

Definition at line 701 of file API.h.

References classofKind().

◆ classofKind()

bool clang::extractapi::RecordRecord::classofKind ( RecordKind K )

inlinestatic

Definition at line 704 of file API.h.

References clang::extractapi::APIRecord::RK_ClassTemplate, clang::extractapi::APIRecord::RK_ClassTemplatePartialSpecialization, clang::extractapi::APIRecord::RK_ClassTemplateSpecialization, clang::extractapi::APIRecord::RK_CXXClass, clang::extractapi::APIRecord::RK_Struct, and clang::extractapi::APIRecord::RK_Union.

Referenced by classof().

◆ isAnonymousWithNoTypedef()

bool clang::extractapi::RecordRecord::isAnonymousWithNoTypedef ( )

inline

Definition at line 723 of file API.h.

References clang::extractapi::APIRecord::Name.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members