clang 18.0.0git
Public Types | Public Member Functions | Public Attributes | List of all members
clang::extractapi::APISet Class Reference

APISet holds the set of API records collected from given inputs. More...

#include "clang/ExtractAPI/API.h"

Public Types

template<typename RecordTy , typename = std::enable_if_t<std::is_base_of<APIRecord, RecordTy>::value>>
using RecordMap = llvm::MapVector< StringRef, std::unique_ptr< RecordTy > >
 A mapping type to store a set of APIRecords with the USR as the key.
 

Public Member Functions

NamespaceRecord * addNamespace (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeaderg)
 
GlobalVariableRecord * addGlobalVar (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeadin, bool IsFromSystemHeaderg)
 Create and add a global variable record into the API set.
 
GlobalVariableTemplateRecord * addGlobalVariableTemplate (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, Template Template, bool IsFromSystemHeader)
 
GlobalFunctionRecord * addGlobalFunction (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, bool IsFromSystemHeader)
 Create and add a function record into the API set.
 
GlobalFunctionTemplateRecord * addGlobalFunctionTemplate (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, Template Template, bool IsFromSystemHeader)
 
GlobalFunctionTemplateSpecializationRecord * addGlobalFunctionTemplateSpecialization (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, bool IsFromSystemHeader)
 
EnumConstantRecord * addEnumConstant (EnumRecord *Enum, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create and add an enum constant record into the API set.
 
EnumRecord * addEnum (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create and add an enum record into the API set.
 
StructFieldRecord * addStructField (StructRecord *Struct, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create and add a struct field record into the API set.
 
StructRecord * addStruct (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create and add a struct record into the API set.
 
StaticFieldRecord * addStaticField (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availabilities, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, SymbolReference Context, AccessControl Access, bool IsFromSystemHeaderg)
 
CXXFieldRecord * addCXXField (APIRecord *CXXClass, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availabilities, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, AccessControl Access, bool IsFromSystemHeader)
 
CXXFieldTemplateRecord * addCXXFieldTemplate (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, AccessControl Access, Template Template, bool IsFromSystemHeader)
 
CXXClassRecord * addCXXClass (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, APIRecord::RecordKind Kind, AccessControl Access, bool IsFromSystemHeader)
 
ClassTemplateRecord * addClassTemplate (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, Template Template, AccessControl Access, bool IsFromSystemHeader)
 
ClassTemplateSpecializationRecord * addClassTemplateSpecialization (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, AccessControl Access, bool IsFromSystemHeader)
 
ClassTemplatePartialSpecializationRecord * addClassTemplatePartialSpecialization (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, Template Template, AccessControl Access, bool IsFromSystemHeader)
 
GlobalVariableTemplateSpecializationRecord * addGlobalVariableTemplateSpecialization (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 
GlobalVariableTemplatePartialSpecializationRecord * addGlobalVariableTemplatePartialSpecialization (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, Template Template, bool IsFromSystemHeader)
 
CXXMethodRecord * addCXXInstanceMethod (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, AccessControl Access, bool IsFromSystemHeader)
 
CXXMethodRecord * addCXXStaticMethod (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, AccessControl Access, bool IsFromSystemHeader)
 
CXXMethodRecord * addCXXSpecialMethod (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, AccessControl Access, bool IsFromSystemHeader)
 
CXXMethodTemplateRecord * addCXXMethodTemplate (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, AccessControl Access, Template Template, bool IsFromSystemHeader)
 
CXXMethodTemplateSpecializationRecord * addCXXMethodTemplateSpec (APIRecord *Parent, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, AccessControl Access, bool IsFromSystemHeader)
 
ConceptRecord * addConcept (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, Template Template, bool IsFromSystemHeader)
 
ObjCCategoryRecord * addObjCCategory (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, SymbolReference Interface, bool IsFromSystemHeader, bool IsFromExternalModule)
 Create and add an Objective-C category record into the API set.
 
ObjCInterfaceRecord * addObjCInterface (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, SymbolReference SuperClass, bool IsFromSystemHeader)
 Create and add an Objective-C interface record into the API set.
 
ObjCMethodRecord * addObjCMethod (ObjCContainerRecord *Container, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, bool IsInstanceMethod, bool IsFromSystemHeader)
 Create and add an Objective-C method record into the API set.
 
ObjCPropertyRecord * addObjCProperty (ObjCContainerRecord *Container, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, ObjCPropertyRecord::AttributeKind Attributes, StringRef GetterName, StringRef SetterName, bool IsOptional, bool IsInstanceProperty, bool IsFromSystemHeader)
 Create and add an Objective-C property record into the API set.
 
ObjCInstanceVariableRecord * addObjCInstanceVariable (ObjCContainerRecord *Container, StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, ObjCInstanceVariableRecord::AccessControl Access, bool IsFromSystemHeader)
 Create and add an Objective-C instance variable record into the API set.
 
ObjCProtocolRecord * addObjCProtocol (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create and add an Objective-C protocol record into the API set.
 
MacroDefinitionRecord * addMacroDefinition (StringRef Name, StringRef USR, PresumedLoc Loc, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader)
 Create a macro definition record into the API set.
 
TypedefRecord * addTypedef (StringRef Name, StringRef USR, PresumedLoc Loc, AvailabilitySet Availability, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, SymbolReference UnderlyingType, bool IsFromSystemHeader)
 Create a typedef record into the API set.
 
const llvm::Triple & getTarget () const
 Get the target triple for the ExtractAPI invocation.
 
Language getLanguage () const
 Get the language used by the APIs.
 
const RecordMap< NamespaceRecord > & getNamespaces () const
 
const RecordMap< GlobalFunctionRecord > & getGlobalFunctions () const
 
const RecordMap< GlobalFunctionTemplateRecord > & getGlobalFunctionTemplates () const
 
const RecordMap< GlobalFunctionTemplateSpecializationRecord > & getGlobalFunctionTemplateSpecializations () const
 
const RecordMap< GlobalVariableRecord > & getGlobalVariables () const
 
const RecordMap< GlobalVariableTemplateRecord > & getGlobalVariableTemplates () const
 
const RecordMap< StaticFieldRecord > & getStaticFields () const
 
const RecordMap< GlobalVariableTemplateSpecializationRecord > & getGlobalVariableTemplateSpecializations () const
 
const RecordMap< GlobalVariableTemplatePartialSpecializationRecord > & getGlobalVariableTemplatePartialSpecializations () const
 
const RecordMap< EnumRecord > & getEnums () const
 
const RecordMap< StructRecord > & getStructs () const
 
const RecordMap< CXXClassRecord > & getCXXClasses () const
 
const RecordMap< CXXMethodTemplateRecord > & getCXXMethodTemplates () const
 
const RecordMap< CXXInstanceMethodRecord > & getCXXInstanceMethods () const
 
const RecordMap< CXXStaticMethodRecord > & getCXXStaticMethods () const
 
const RecordMap< CXXFieldRecord > & getCXXFields () const
 
const RecordMap< CXXMethodTemplateSpecializationRecord > & getCXXMethodTemplateSpecializations () const
 
const RecordMap< CXXFieldTemplateRecord > & getCXXFieldTemplates () const
 
const RecordMap< ConceptRecord > & getConcepts () const
 
const RecordMap< ClassTemplateRecord > & getClassTemplates () const
 
const RecordMap< ClassTemplateSpecializationRecord > & getClassTemplateSpecializations () const
 
const RecordMap< ClassTemplatePartialSpecializationRecord > & getClassTemplatePartialSpecializations () const
 
const RecordMap< ConceptRecord > & getRecords () const
 
const RecordMap< ObjCCategoryRecord > & getObjCCategories () const
 
const RecordMap< ObjCInterfaceRecord > & getObjCInterfaces () const
 
const RecordMap< ObjCProtocolRecord > & getObjCProtocols () const
 
const RecordMap< MacroDefinitionRecord > & getMacros () const
 
const RecordMap< TypedefRecord > & getTypedefs () const
 
APIRecord * findRecordForUSR (StringRef USR) const
 Finds the APIRecord for a given USR.
 
StringRef recordUSR (const Decl *D)
 Generate and store the USR of declaration D.
 
StringRef recordUSRForMacro (StringRef Name, SourceLocation SL, const SourceManager &SM)
 Generate and store the USR for a macro Name.
 
StringRef copyString (StringRef String)
 Copy String into the Allocator in this APISet.
 
 APISet (const llvm::Triple &Target, Language Lang, const std::string &ProductName)
 

Public Attributes

const std::string ProductName
 

Detailed Description

APISet holds the set of API records collected from given inputs.

Definition at line 1190 of file API.h.

Member Typedef Documentation

◆ RecordMap

template<typename RecordTy , typename = std::enable_if_t<std::is_base_of<APIRecord, RecordTy>::value>>
using clang::extractapi::APISet::RecordMap = llvm::MapVector<StringRef, std::unique_ptr<RecordTy> >

A mapping type to store a set of APIRecords with the USR as the key.

Definition at line 1509 of file API.h.

Constructor & Destructor Documentation

◆ APISet()

clang::extractapi::APISet::APISet ( const llvm::Triple &  Target,
Language  Lang,
const std::string &  ProductName 
)
inline

Definition at line 1617 of file API.h.

References clang::Target.

Member Function Documentation

◆ addClassTemplate()

ClassTemplateRecord * APISet::addClassTemplate ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
Template  Template,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 233 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addClassTemplatePartialSpecialization()

ClassTemplatePartialSpecializationRecord * APISet::addClassTemplatePartialSpecialization ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
Template  Template,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 264 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addClassTemplateSpecialization()

ClassTemplateSpecializationRecord * APISet::addClassTemplateSpecialization ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 248 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addConcept()

ConceptRecord * APISet::addConcept ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 304 of file API.cpp.

References clang::Declaration.

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

◆ addCXXClass()

CXXClassRecord * APISet::addCXXClass ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
APIRecord::RecordKind  Kind,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 218 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addCXXField()

CXXFieldRecord * APISet::addCXXField ( APIRecord *  CXXClass,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availabilities,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 189 of file API.cpp.

References clang::Declaration, clang::extractapi::APIRecord::getKind(), clang::extractapi::APIRecord::Name, and clang::extractapi::APIRecord::USR.

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

◆ addCXXFieldTemplate()

CXXFieldTemplateRecord * APISet::addCXXFieldTemplate ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
AccessControl  Access,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 202 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addCXXInstanceMethod()

CXXMethodRecord * APISet::addCXXInstanceMethod ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 315 of file API.cpp.

References clang::Declaration, clang::extractapi::APIRecord::getKind(), clang::extractapi::APIRecord::Name, and clang::extractapi::APIRecord::USR.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl().

◆ addCXXMethodTemplate()

CXXMethodTemplateRecord * APISet::addCXXMethodTemplate ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
AccessControl  Access,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 349 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addCXXMethodTemplateSpec()

CXXMethodTemplateSpecializationRecord * APISet::addCXXMethodTemplateSpec ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 365 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addCXXSpecialMethod()

CXXMethodRecord * clang::extractapi::APISet::addCXXSpecialMethod ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
AccessControl  Access,
bool  IsFromSystemHeader 
)

◆ addCXXStaticMethod()

CXXMethodRecord * APISet::addCXXStaticMethod ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
AccessControl  Access,
bool  IsFromSystemHeader 
)

Definition at line 332 of file API.cpp.

References clang::Declaration, clang::extractapi::APIRecord::getKind(), clang::extractapi::APIRecord::Name, and clang::extractapi::APIRecord::USR.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl().

◆ addEnum()

EnumRecord * APISet::addEnum ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create and add an enum record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 137 of file API.cpp.

References clang::Declaration.

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

◆ addEnumConstant()

EnumConstantRecord * APISet::addEnumConstant ( EnumRecord *  Enum,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create and add an enum constant record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 121 of file API.cpp.

References clang::Declaration, and clang::Enum.

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

◆ addGlobalFunction()

GlobalFunctionRecord * APISet::addGlobalFunction ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
bool  IsFromSystemHeader 
)

Create and add a function record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 84 of file API.cpp.

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

◆ addGlobalFunctionTemplate()

GlobalFunctionTemplateRecord * APISet::addGlobalFunctionTemplate ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 96 of file API.cpp.

References clang::Declaration.

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

◆ addGlobalFunctionTemplateSpecialization()

GlobalFunctionTemplateSpecializationRecord * APISet::addGlobalFunctionTemplateSpecialization ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
bool  IsFromSystemHeader 
)

Definition at line 109 of file API.cpp.

References clang::Declaration.

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

◆ addGlobalVar()

GlobalVariableRecord * APISet::addGlobalVar ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeadin,
bool  IsFromSystemHeaderg 
)

Create and add a global variable record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 63 of file API.cpp.

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

◆ addGlobalVariableTemplate()

GlobalVariableTemplateRecord * APISet::addGlobalVariableTemplate ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 72 of file API.cpp.

References clang::Declaration.

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

◆ addGlobalVariableTemplatePartialSpecialization()

GlobalVariableTemplatePartialSpecializationRecord * APISet::addGlobalVariableTemplatePartialSpecialization ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
Template  Template,
bool  IsFromSystemHeader 
)

Definition at line 292 of file API.cpp.

References clang::Declaration.

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

◆ addGlobalVariableTemplateSpecialization()

GlobalVariableTemplateSpecializationRecord * APISet::addGlobalVariableTemplateSpecialization ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Definition at line 280 of file API.cpp.

References clang::Declaration.

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

◆ addMacroDefinition()

MacroDefinitionRecord * APISet::addMacroDefinition ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create a macro definition record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSRForMacro(StringRef Name, SourceLocation SL, const SourceManager &SM) is a helper method to generate the USR for the macro and keep it alive in APISet.

Definition at line 489 of file API.cpp.

References clang::Declaration.

◆ addNamespace()

NamespaceRecord * APISet::addNamespace ( APIRecord *  Parent,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeaderg 
)

Definition at line 47 of file API.cpp.

References clang::Declaration, and Parent.

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

◆ addObjCCategory()

ObjCCategoryRecord * APISet::addObjCCategory ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
SymbolReference  Interface,
bool  IsFromSystemHeader,
bool  IsFromExternalModule 
)

Create and add an Objective-C category record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 382 of file API.cpp.

References clang::Declaration, and clang::Interface.

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

◆ addObjCInstanceVariable()

ObjCInstanceVariableRecord * APISet::addObjCInstanceVariable ( ObjCContainerRecord *  Container,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
ObjCInstanceVariableRecord::AccessControl  Access,
bool  IsFromSystemHeader 
)

Create and add an Objective-C instance variable record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 462 of file API.cpp.

References clang::Declaration.

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

◆ addObjCInterface()

ObjCInterfaceRecord * APISet::addObjCInterface ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
SymbolReference  SuperClass,
bool  IsFromSystemHeader 
)

Create and add an Objective-C interface record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 404 of file API.cpp.

References clang::Declaration.

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

◆ addObjCMethod()

ObjCMethodRecord * APISet::addObjCMethod ( ObjCContainerRecord *  Container,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
FunctionSignature  Signature,
bool  IsInstanceMethod,
bool  IsFromSystemHeader 
)

Create and add an Objective-C method record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 416 of file API.cpp.

References clang::Declaration.

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

◆ addObjCProperty()

ObjCPropertyRecord * APISet::addObjCProperty ( ObjCContainerRecord *  Container,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
ObjCPropertyRecord::AttributeKind  Attributes,
StringRef  GetterName,
StringRef  SetterName,
bool  IsOptional,
bool  IsInstanceProperty,
bool  IsFromSystemHeader 
)

Create and add an Objective-C property record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 438 of file API.cpp.

References clang::Declaration.

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

◆ addObjCProtocol()

ObjCProtocolRecord * APISet::addObjCProtocol ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create and add an Objective-C protocol record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 476 of file API.cpp.

References clang::Declaration.

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

◆ addStaticField()

StaticFieldRecord * APISet::addStaticField ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availabilities,
LinkageInfo  Linkage,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
SymbolReference  Context,
AccessControl  Access,
bool  IsFromSystemHeaderg 
)

Definition at line 176 of file API.cpp.

References clang::Declaration.

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

◆ addStruct()

StructRecord * APISet::addStruct ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create and add a struct record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 164 of file API.cpp.

References clang::Declaration.

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

◆ addStructField()

StructFieldRecord * APISet::addStructField ( StructRecord *  Struct,
StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
bool  IsFromSystemHeader 
)

Create and add a struct field record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 148 of file API.cpp.

References clang::Declaration, and clang::Struct.

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

◆ addTypedef()

TypedefRecord * APISet::addTypedef ( StringRef  Name,
StringRef  USR,
PresumedLoc  Loc,
AvailabilitySet  Availability,
const DocComment &  Comment,
DeclarationFragments  Declaration,
DeclarationFragments  SubHeading,
SymbolReference  UnderlyingType,
bool  IsFromSystemHeader 
)

Create a typedef record into the API set.

Note: the caller is responsible for keeping the StringRef Name and USR alive. APISet::copyString provides a way to copy strings into APISet itself, and APISet::recordUSR(const Decl *D) is a helper method to generate the USR for D and keep it alive in APISet.

Definition at line 498 of file API.cpp.

References clang::Declaration.

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

◆ copyString()

StringRef APISet::copyString ( StringRef  String)

Copy String into the Allocator in this APISet.

Returns
a StringRef of the copied string in APISet::Allocator.

Definition at line 528 of file API.cpp.

References memcpy().

Referenced by clang::extractapi::TypedefUnderlyingTypeResolver::getSymbolReferenceForType(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCMethods(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCProperties(), recordUSR(), recordUSRForMacro(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitEnumDecl().

◆ findRecordForUSR()

APIRecord * APISet::findRecordForUSR ( StringRef  USR) const

Finds the APIRecord for a given USR.

Returns
a pointer to the APIRecord associated with that USR or nullptr.

Definition at line 508 of file API.cpp.

Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFieldDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateDecl().

◆ getClassTemplatePartialSpecializations()

const RecordMap< ClassTemplatePartialSpecializationRecord > & clang::extractapi::APISet::getClassTemplatePartialSpecializations ( ) const
inline

Definition at line 1576 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseClassTemplatePartialSpecializationRecords().

◆ getClassTemplates()

const RecordMap< ClassTemplateRecord > & clang::extractapi::APISet::getClassTemplates ( ) const
inline

Definition at line 1568 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseClassTemplateRecords().

◆ getClassTemplateSpecializations()

const RecordMap< ClassTemplateSpecializationRecord > & clang::extractapi::APISet::getClassTemplateSpecializations ( ) const
inline

Definition at line 1572 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseClassTemplateSpecializationRecords().

◆ getConcepts()

const RecordMap< ConceptRecord > & clang::extractapi::APISet::getConcepts ( ) const
inline

Definition at line 1567 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseConcepts().

◆ getCXXClasses()

const RecordMap< CXXClassRecord > & clang::extractapi::APISet::getCXXClasses ( ) const
inline

Definition at line 1549 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXClassRecords().

◆ getCXXFields()

const RecordMap< CXXFieldRecord > & clang::extractapi::APISet::getCXXFields ( ) const
inline

Definition at line 1559 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXFields().

◆ getCXXFieldTemplates()

const RecordMap< CXXFieldTemplateRecord > & clang::extractapi::APISet::getCXXFieldTemplates ( ) const
inline

Definition at line 1564 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXFieldTemplates().

◆ getCXXInstanceMethods()

const RecordMap< CXXInstanceMethodRecord > & clang::extractapi::APISet::getCXXInstanceMethods ( ) const
inline

Definition at line 1553 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXInstanceMethods().

◆ getCXXMethodTemplates()

const RecordMap< CXXMethodTemplateRecord > & clang::extractapi::APISet::getCXXMethodTemplates ( ) const
inline

Definition at line 1550 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXMethodTemplates().

◆ getCXXMethodTemplateSpecializations()

const RecordMap< CXXMethodTemplateSpecializationRecord > & clang::extractapi::APISet::getCXXMethodTemplateSpecializations ( ) const
inline

Definition at line 1561 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXMethodTemplateSpecializations().

◆ getCXXStaticMethods()

const RecordMap< CXXStaticMethodRecord > & clang::extractapi::APISet::getCXXStaticMethods ( ) const
inline

Definition at line 1556 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseCXXStaticMethods().

◆ getEnums()

const RecordMap< EnumRecord > & clang::extractapi::APISet::getEnums ( ) const
inline

Definition at line 1547 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseEnumRecords(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitTypedefNameDecl().

◆ getGlobalFunctions()

const RecordMap< GlobalFunctionRecord > & clang::extractapi::APISet::getGlobalFunctions ( ) const
inline

Definition at line 1518 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalFunctionRecords().

◆ getGlobalFunctionTemplates()

const RecordMap< GlobalFunctionTemplateRecord > & clang::extractapi::APISet::getGlobalFunctionTemplates ( ) const
inline

Definition at line 1522 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalFunctionTemplateRecords().

◆ getGlobalFunctionTemplateSpecializations()

const RecordMap< GlobalFunctionTemplateSpecializationRecord > & clang::extractapi::APISet::getGlobalFunctionTemplateSpecializations ( ) const
inline

Definition at line 1526 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalFunctionTemplateSpecializationRecords().

◆ getGlobalVariables()

const RecordMap< GlobalVariableRecord > & clang::extractapi::APISet::getGlobalVariables ( ) const
inline

Definition at line 1529 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalVariableRecords().

◆ getGlobalVariableTemplatePartialSpecializations()

const RecordMap< GlobalVariableTemplatePartialSpecializationRecord > & clang::extractapi::APISet::getGlobalVariableTemplatePartialSpecializations ( ) const
inline

Definition at line 1544 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalVariableTemplatePartialSpecializationRecords().

◆ getGlobalVariableTemplates()

const RecordMap< GlobalVariableTemplateRecord > & clang::extractapi::APISet::getGlobalVariableTemplates ( ) const
inline

Definition at line 1533 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalVariableTemplateRecords().

◆ getGlobalVariableTemplateSpecializations()

const RecordMap< GlobalVariableTemplateSpecializationRecord > & clang::extractapi::APISet::getGlobalVariableTemplateSpecializations ( ) const
inline

Definition at line 1540 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseGlobalVariableTemplateSpecializationRecords().

◆ getLanguage()

Language clang::extractapi::APISet::getLanguage ( ) const
inline

Get the language used by the APIs.

Definition at line 1515 of file API.h.

Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF(), and clang::extractapi::SymbolGraphSerializer::visitObjCCategoryRecord().

◆ getMacros()

const RecordMap< MacroDefinitionRecord > & clang::extractapi::APISet::getMacros ( ) const
inline

Definition at line 1589 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseMacroDefinitionRecords().

◆ getNamespaces()

const RecordMap< NamespaceRecord > & clang::extractapi::APISet::getNamespaces ( ) const
inline

Definition at line 1517 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseNamespaces().

◆ getObjCCategories()

const RecordMap< ObjCCategoryRecord > & clang::extractapi::APISet::getObjCCategories ( ) const
inline

Definition at line 1580 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseObjCCategories().

◆ getObjCInterfaces()

const RecordMap< ObjCInterfaceRecord > & clang::extractapi::APISet::getObjCInterfaces ( ) const
inline

Definition at line 1583 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseObjCInterfaces(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCCategoryDecl().

◆ getObjCProtocols()

const RecordMap< ObjCProtocolRecord > & clang::extractapi::APISet::getObjCProtocols ( ) const
inline

Definition at line 1586 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseObjCProtocols().

◆ getRecords()

const RecordMap< ConceptRecord > & clang::extractapi::APISet::getRecords ( ) const
inline

Definition at line 1579 of file API.h.

◆ getStaticFields()

const RecordMap< StaticFieldRecord > & clang::extractapi::APISet::getStaticFields ( ) const
inline

Definition at line 1536 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseStaticFieldRecords().

◆ getStructs()

const RecordMap< StructRecord > & clang::extractapi::APISet::getStructs ( ) const
inline

Definition at line 1548 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseStructRecords(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitTypedefNameDecl().

◆ getTarget()

const llvm::Triple & clang::extractapi::APISet::getTarget ( ) const
inline

Get the target triple for the ExtractAPI invocation.

Definition at line 1512 of file API.h.

◆ getTypedefs()

const RecordMap< TypedefRecord > & clang::extractapi::APISet::getTypedefs ( ) const
inline

Definition at line 1590 of file API.h.

Referenced by clang::extractapi::APISetVisitor< Derived >::traverseTypedefRecords().

◆ recordUSR()

StringRef APISet::recordUSR ( const Decl *  D)

Generate and store the USR of declaration D.

Note: The USR string is stored in and owned by Allocator.

Returns
a StringRef of the generated USR string.

Definition at line 515 of file API.cpp.

References copyString(), and clang::index::generateUSRForDecl().

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordEnumConstants(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCInstanceVariables(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCMethods(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCProperties(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCProtocols(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordStructFields(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitClassTemplatePartialSpecializationDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitClassTemplateSpecializationDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitConceptDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXRecordDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitEnumDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFieldDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionTemplateDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitNamespaceDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCCategoryDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCInterfaceDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCProtocolDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitRecordDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitTypedefNameDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplatePartialSpecializationDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateSpecializationDecl().

◆ recordUSRForMacro()

StringRef APISet::recordUSRForMacro ( StringRef  Name,
SourceLocation  SL,
const SourceManager &  SM 
)

Generate and store the USR for a macro Name.

Note: The USR string is stored in and owned by Allocator.

Returns
a StringRef to the generate USR string.

Definition at line 521 of file API.cpp.

References copyString(), clang::index::generateUSRForMacro(), and SM.

Member Data Documentation

◆ ProductName

const std::string clang::extractapi::APISet::ProductName

Definition at line 1666 of file API.h.

Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF().

The documentation for this class was generated from the following files:
Generated on Fri Dec 1 2023 14:46:59 for clang by doxygen 1.9.6