This holds information associated with global functions. More...

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::GlobalVariableRecord:

[legend]

Public Member Functions
	GlobalVariableRecord (StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)

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

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::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::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 global functions.

Definition at line 480 of file API.h.

Constructor & Destructor Documentation

◆ GlobalVariableRecord() [1/2]

clang::extractapi::GlobalVariableRecord::GlobalVariableRecord	(	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 481 of file API.h.

◆ GlobalVariableRecord() [2/2]

clang::extractapi::GlobalVariableRecord::GlobalVariableRecord	(	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 491 of file API.h.

Member Function Documentation

◆ classof()

static bool clang::extractapi::GlobalVariableRecord::classof ( const APIRecord * Record )

inlinestatic

Definition at line 502 of file API.h.

References classofKind().

◆ classofKind()

static bool clang::extractapi::GlobalVariableRecord::classofKind ( RecordKind K )

inlinestatic

Definition at line 505 of file API.h.

References clang::extractapi::APIRecord::RK_GlobalVariable, clang::extractapi::APIRecord::RK_GlobalVariableTemplate, clang::extractapi::APIRecord::RK_GlobalVariableTemplatePartialSpecialization, and clang::extractapi::APIRecord::RK_GlobalVariableTemplateSpecialization.

Referenced by classof().

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