clang 19.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
clang::extractapi::ObjCCategoryRecord Struct Reference

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

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::ObjCCategoryRecord:
Inheritance graph
[legend]

Public Member Functions

 ObjCCategoryRecord (StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, SymbolReference Interface, bool IsFromSystemHeader)
 
bool isExtendingExternalModule () const
 
std::optional< StringRef > getExtendedExternalModule () const
 
- Public Member Functions inherited from clang::extractapi::ObjCContainerRecord
 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
APIRecordgetNextInContext () 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.
 
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 APIRecordcastFromRecordContext (const RecordContext *Ctx)
 
static RecordContextcastToRecordContext (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)
 

Public Attributes

SymbolReference Interface
 
- Public Attributes inherited from clang::extractapi::ObjCContainerRecord
SmallVector< SymbolReferenceProtocols
 
- 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 >
 
- Protected Member Functions inherited from clang::extractapi::RecordContext
void addToRecordChain (APIRecord *) const
 

Detailed Description

This holds information associated with Objective-C categories.

Definition at line 1276 of file API.h.

Constructor & Destructor Documentation

◆ ObjCCategoryRecord()

clang::extractapi::ObjCCategoryRecord::ObjCCategoryRecord ( StringRef  USR,
StringRef  Name,
SymbolReference  Parent,
PresumedLoc  Loc,
AvailabilityInfo  Availability,
const DocComment Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
SymbolReference  Interface,
bool  IsFromSystemHeader 
)
inline

Definition at line 1279 of file API.h.

Member Function Documentation

◆ classof()

static bool clang::extractapi::ObjCCategoryRecord::classof ( const APIRecord Record)
inlinestatic

Definition at line 1291 of file API.h.

References classofKind().

◆ classofKind()

static bool clang::extractapi::ObjCCategoryRecord::classofKind ( RecordKind  K)
inlinestatic

Definition at line 1294 of file API.h.

References clang::extractapi::APIRecord::RK_ObjCCategory.

Referenced by classof().

◆ getExtendedExternalModule()

std::optional< StringRef > clang::extractapi::ObjCCategoryRecord::getExtendedExternalModule ( ) const
inline

◆ isExtendingExternalModule()

bool clang::extractapi::ObjCCategoryRecord::isExtendingExternalModule ( ) const
inline

Definition at line 1296 of file API.h.

References Interface, and clang::extractapi::SymbolReference::Source.

Referenced by getExtendedExternalModule().

Member Data Documentation

◆ Interface

SymbolReference clang::extractapi::ObjCCategoryRecord::Interface

Definition at line 1277 of file API.h.

Referenced by getExtendedExternalModule(), and isExtendingExternalModule().


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