clang::extractapi::ObjCPropertyRecord Struct Reference

This holds information associated with Objective-C properties. More...

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::ObjCPropertyRecord:

Public Types
enum	AttributeKind : unsigned { NoAttr = 0 , ReadOnly = 1 , Dynamic = 1 << 2 }
	The attributes associated with an Objective-C property. More...
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 Member Functions
	ObjCPropertyRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, AttributeKind Attributes, StringRef GetterName, StringRef SetterName, bool IsOptional, bool IsFromSystemHeader)
bool	isReadOnly () const
bool	isDynamic () const
virtual	~ObjCPropertyRecord ()=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 Attributes
AttributeKind	Attributes
StringRef	GetterName
StringRef	SetterName
bool	IsOptional
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
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)

Detailed Description

This holds information associated with Objective-C properties.

Definition at line 1002 of file API.h.

Member Enumeration Documentation

AttributeKind

enum clang::extractapi::ObjCPropertyRecord::AttributeKind : unsigned

The attributes associated with an Objective-C property.

Enumerator
NoAttr
ReadOnly
Dynamic

Definition at line 1004 of file API.h.

Constructor & Destructor Documentation

ObjCPropertyRecord()

clang::extractapi::ObjCPropertyRecord::ObjCPropertyRecord ( RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, const DocComment & Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, AttributeKind Attributes, StringRef GetterName, StringRef SetterName, bool IsOptional, bool IsFromSystemHeader )

inline

Definition at line 1015 of file API.h.

References clang::extractapi::APIRecord::APIRecord(), Attributes, clang::extractapi::APIRecord::Availability, clang::extractapi::APIRecord::Comment, clang::extractapi::APIRecord::Declaration, GetterName, clang::extractapi::APIRecord::IsFromSystemHeader, IsOptional, clang::extractapi::APIRecord::Name, clang::extractapi::APIRecord::Parent, SetterName, clang::extractapi::APIRecord::SubHeading, and clang::extractapi::APIRecord::USR.

Referenced by clang::extractapi::ObjCClassPropertyRecord::ObjCClassPropertyRecord(), and clang::extractapi::ObjCInstancePropertyRecord::ObjCInstancePropertyRecord().

~ObjCPropertyRecord()

ObjCPropertyRecord::~ObjCPropertyRecord ( )

pure virtual

Definition at line 174 of file API.cpp.

Member Function Documentation

isDynamic()

bool clang::extractapi::ObjCPropertyRecord::isDynamic ( ) const

inline

Definition at line 1029 of file API.h.

References Attributes, and Dynamic.

isReadOnly()

bool clang::extractapi::ObjCPropertyRecord::isReadOnly ( ) const

inline

Definition at line 1028 of file API.h.

References Attributes, and ReadOnly.

Member Data Documentation

Attributes

AttributeKind clang::extractapi::ObjCPropertyRecord::Attributes

Definition at line 1010 of file API.h.

Referenced by isDynamic(), isReadOnly(), clang::extractapi::ObjCClassPropertyRecord::ObjCClassPropertyRecord(), clang::extractapi::ObjCInstancePropertyRecord::ObjCInstancePropertyRecord(), and ObjCPropertyRecord().

GetterName

StringRef clang::extractapi::ObjCPropertyRecord::GetterName

Definition at line 1011 of file API.h.

Referenced by clang::extractapi::ObjCClassPropertyRecord::ObjCClassPropertyRecord(), clang::extractapi::ObjCInstancePropertyRecord::ObjCInstancePropertyRecord(), and ObjCPropertyRecord().

IsOptional

bool clang::extractapi::ObjCPropertyRecord::IsOptional

Definition at line 1013 of file API.h.

Referenced by clang::extractapi::ObjCClassPropertyRecord::ObjCClassPropertyRecord(), clang::extractapi::ObjCInstancePropertyRecord::ObjCInstancePropertyRecord(), and ObjCPropertyRecord().

SetterName

StringRef clang::extractapi::ObjCPropertyRecord::SetterName

Definition at line 1012 of file API.h.

Referenced by clang::extractapi::ObjCClassPropertyRecord::ObjCClassPropertyRecord(), clang::extractapi::ObjCInstancePropertyRecord::ObjCInstancePropertyRecord(), and ObjCPropertyRecord().

---

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

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