class APISet
Declaration
class APISet { /* full declaration omitted */ };
Description
APISet holds the set of API records collected from given inputs.
Declared at: clang/include/clang/ExtractAPI/API.h:471
Member Variables
- private llvm::BumpPtrAllocator StringAllocator
- Note: The main use for this is being able to deduplicate strings.
- private const llvm::Triple Target
- private const clang::Language Lang
- private RecordMap<clang::extractapi::GlobalFunctionRecord> GlobalFunctions
- private RecordMap<clang::extractapi::GlobalVariableRecord> GlobalVariables
- private RecordMap<clang::extractapi::EnumRecord> Enums
- private RecordMap<clang::extractapi::StructRecord> Structs
- private RecordMap<clang::extractapi::ObjCCategoryRecord> ObjCCategories
- private RecordMap<clang::extractapi::ObjCInterfaceRecord> ObjCInterfaces
- private RecordMap<clang::extractapi::ObjCProtocolRecord> ObjCProtocols
- private RecordMap< clang::extractapi::MacroDefinitionRecord> Macros
- private RecordMap<clang::extractapi::TypedefRecord> Typedefs
Method Overview
- public APISet(const llvm::Triple & Target, clang::Language Lang)
- public clang::extractapi::EnumRecord * addEnum(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::EnumConstantRecord * addEnumConstant(clang::extractapi::EnumRecord * Enum, llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::GlobalFunctionRecord * addGlobalFunction(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, clang::LinkageInfo Linkage, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, clang::extractapi::FunctionSignature Signature)
- public clang::extractapi::GlobalVariableRecord * addGlobalVar(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, clang::LinkageInfo Linkage, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::MacroDefinitionRecord * addMacroDefinition(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::ObjCCategoryRecord * addObjCCategory(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, clang::extractapi::SymbolReference Interface)
- public clang::extractapi::ObjCInstanceVariableRecord * addObjCInstanceVariable(clang::extractapi::ObjCContainerRecord * Container, llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, ObjCInstanceVariableRecord::AccessControl Access)
- public clang::extractapi::ObjCInterfaceRecord * addObjCInterface(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, clang::LinkageInfo Linkage, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, clang::extractapi::SymbolReference SuperClass)
- public clang::extractapi::ObjCMethodRecord * addObjCMethod(clang::extractapi::ObjCContainerRecord * Container, llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, clang::extractapi::FunctionSignature Signature, bool IsInstanceMethod)
- public clang::extractapi::ObjCPropertyRecord * addObjCProperty(clang::extractapi::ObjCContainerRecord * Container, llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, ObjCPropertyRecord::AttributeKind Attributes, llvm::StringRef GetterName, llvm::StringRef SetterName, bool IsOptional)
- public clang::extractapi::ObjCProtocolRecord * addObjCProtocol(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::StructRecord * addStruct(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::StructFieldRecord * addStructField(clang::extractapi::StructRecord * Struct, llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
- public clang::extractapi::TypedefRecord * addTypedef(llvm::StringRef Name, llvm::StringRef USR, clang::PresumedLoc Loc, const clang::extractapi::AvailabilityInfo & Availability, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading, clang::extractapi::SymbolReference UnderlyingType)
- public llvm::StringRef copyString(llvm::StringRef String)
- public const RecordMap<clang::extractapi::EnumRecord> & getEnums() const
- public const RecordMap<clang::extractapi::GlobalFunctionRecord> & getGlobalFunctions() const
- public const RecordMap<clang::extractapi::GlobalVariableRecord> & getGlobalVariables() const
- public clang::Language getLanguage() const
- public const RecordMap<clang::extractapi::MacroDefinitionRecord> & getMacros() const
- public const RecordMap<clang::extractapi::ObjCCategoryRecord> & getObjCCategories() const
- public const RecordMap<clang::extractapi::ObjCInterfaceRecord> & getObjCInterfaces() const
- public const RecordMap<clang::extractapi::ObjCProtocolRecord> & getObjCProtocols() const
- public const RecordMap<clang::extractapi::StructRecord> & getStructs() const
- public const llvm::Triple & getTarget() const
- public const RecordMap<clang::extractapi::TypedefRecord> & getTypedefs() const
- public llvm::StringRef recordUSR(const clang::Decl * D)
- public llvm::StringRef recordUSRForMacro(llvm::StringRef Name, clang::SourceLocation SL, const clang::SourceManager & SM)
Methods
¶APISet(const llvm::Triple& Target,
clang::Language Lang)
APISet(const llvm::Triple& Target,
clang::Language Lang)
Declared at: clang/include/clang/ExtractAPI/API.h:702
Parameters
- const llvm::Triple& Target
- clang::Language Lang
¶clang::extractapi::EnumRecord* addEnum(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::EnumRecord* addEnum(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add an enum record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:517
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::EnumConstantRecord*
addEnumConstant(
clang::extractapi::EnumRecord* Enum,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::EnumConstantRecord*
addEnumConstant(
clang::extractapi::EnumRecord* Enum,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add an enum constant record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:504
Parameters
- clang::extractapi::EnumRecord* Enum
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::GlobalFunctionRecord*
addGlobalFunction(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::FunctionSignature
Signature)
clang::extractapi::GlobalFunctionRecord*
addGlobalFunction(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::FunctionSignature
Signature)
Description
Create and add a function record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:492
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- clang::LinkageInfo Linkage
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- clang::extractapi::FunctionSignature Signature
¶clang::extractapi::GlobalVariableRecord*
addGlobalVar(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::GlobalVariableRecord*
addGlobalVar(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add a global variable record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:480
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- clang::LinkageInfo Linkage
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::MacroDefinitionRecord*
addMacroDefinition(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::MacroDefinitionRecord*
addMacroDefinition(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create a macro definition record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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.
Declared at: clang/include/clang/ExtractAPI/API.h:632
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::ObjCCategoryRecord*
addObjCCategory(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference Interface)
clang::extractapi::ObjCCategoryRecord*
addObjCCategory(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference Interface)
Description
Create and add an Objective-C category record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:555
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- clang::extractapi::SymbolReference Interface
¶clang::extractapi::ObjCInstanceVariableRecord*
addObjCInstanceVariable(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
ObjCInstanceVariableRecord::AccessControl
Access)
clang::extractapi::ObjCInstanceVariableRecord*
addObjCInstanceVariable(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
ObjCInstanceVariableRecord::AccessControl
Access)
Description
Create and add an Objective-C instance variable record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:605
Parameters
- clang::extractapi::ObjCContainerRecord* Container
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- ObjCInstanceVariableRecord::AccessControl Access
¶clang::extractapi::ObjCInterfaceRecord*
addObjCInterface(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference SuperClass)
clang::extractapi::ObjCInterfaceRecord*
addObjCInterface(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
clang::LinkageInfo Linkage,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference SuperClass)
Description
Create and add an Objective-C interface record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:567
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- clang::LinkageInfo Linkage
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- clang::extractapi::SymbolReference SuperClass
¶clang::extractapi::ObjCMethodRecord*
addObjCMethod(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::FunctionSignature
Signature,
bool IsInstanceMethod)
clang::extractapi::ObjCMethodRecord*
addObjCMethod(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::FunctionSignature
Signature,
bool IsInstanceMethod)
Description
Create and add an Objective-C method record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:579
Parameters
- clang::extractapi::ObjCContainerRecord* Container
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- clang::extractapi::FunctionSignature Signature
- bool IsInstanceMethod
¶clang::extractapi::ObjCPropertyRecord*
addObjCProperty(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
ObjCPropertyRecord::AttributeKind Attributes,
llvm::StringRef GetterName,
llvm::StringRef SetterName,
bool IsOptional)
clang::extractapi::ObjCPropertyRecord*
addObjCProperty(
clang::extractapi::ObjCContainerRecord*
Container,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
ObjCPropertyRecord::AttributeKind Attributes,
llvm::StringRef GetterName,
llvm::StringRef SetterName,
bool IsOptional)
Description
Create and add an Objective-C property record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:592
Parameters
- clang::extractapi::ObjCContainerRecord* Container
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- ObjCPropertyRecord::AttributeKind Attributes
- llvm::StringRef GetterName
- llvm::StringRef SetterName
- bool IsOptional
¶clang::extractapi::ObjCProtocolRecord*
addObjCProtocol(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::ObjCProtocolRecord*
addObjCProtocol(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add an Objective-C protocol record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:618
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::StructRecord* addStruct(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::StructRecord* addStruct(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add a struct record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:542
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::StructFieldRecord*
addStructField(
clang::extractapi::StructRecord* Struct,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
clang::extractapi::StructFieldRecord*
addStructField(
clang::extractapi::StructRecord* Struct,
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading)
Description
Create and add a struct field record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:529
Parameters
- clang::extractapi::StructRecord* Struct
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
¶clang::extractapi::TypedefRecord* addTypedef(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference
UnderlyingType)
clang::extractapi::TypedefRecord* addTypedef(
llvm::StringRef Name,
llvm::StringRef USR,
clang::PresumedLoc Loc,
const clang::extractapi::AvailabilityInfo&
Availability,
const clang::extractapi::DocComment& Comment,
clang::extractapi::DeclarationFragments
Declaration,
clang::extractapi::DeclarationFragments
SubHeading,
clang::extractapi::SymbolReference
UnderlyingType)
Description
Create a typedef record into the API set. Note: the caller is responsible for keeping the StringRef \p Name and\p 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 \c D and keep it alive in APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:643
Parameters
- llvm::StringRef Name
- llvm::StringRef USR
- clang::PresumedLoc Loc
- const clang::extractapi::AvailabilityInfo& Availability
- const clang::extractapi::DocComment& Comment
- clang::extractapi::DeclarationFragments Declaration
- clang::extractapi::DeclarationFragments SubHeading
- clang::extractapi::SymbolReference UnderlyingType
¶llvm::StringRef copyString(llvm::StringRef String)
llvm::StringRef copyString(llvm::StringRef String)
Description
Copy \p String into the Allocator in this APISet.
Declared at: clang/include/clang/ExtractAPI/API.h:700
Parameters
- llvm::StringRef String
Returns
a StringRef of the copied string in APISet::Allocator.
¶const RecordMap<clang::extractapi::EnumRecord>&
getEnums() const
const RecordMap<clang::extractapi::EnumRecord>&
getEnums() const
Declared at: clang/include/clang/ExtractAPI/API.h:668
¶const RecordMap<
clang::extractapi::GlobalFunctionRecord>&
getGlobalFunctions() const
const RecordMap<
clang::extractapi::GlobalFunctionRecord>&
getGlobalFunctions() const
Declared at: clang/include/clang/ExtractAPI/API.h:662
¶const RecordMap<
clang::extractapi::GlobalVariableRecord>&
getGlobalVariables() const
const RecordMap<
clang::extractapi::GlobalVariableRecord>&
getGlobalVariables() const
Declared at: clang/include/clang/ExtractAPI/API.h:665
¶clang::Language getLanguage() const
clang::Language getLanguage() const
Description
Get the language used by the APIs.
Declared at: clang/include/clang/ExtractAPI/API.h:660
¶const RecordMap<
clang::extractapi::MacroDefinitionRecord>&
getMacros() const
const RecordMap<
clang::extractapi::MacroDefinitionRecord>&
getMacros() const
Declared at: clang/include/clang/ExtractAPI/API.h:679
¶const RecordMap<
clang::extractapi::ObjCCategoryRecord>&
getObjCCategories() const
const RecordMap<
clang::extractapi::ObjCCategoryRecord>&
getObjCCategories() const
Declared at: clang/include/clang/ExtractAPI/API.h:670
¶const RecordMap<
clang::extractapi::ObjCInterfaceRecord>&
getObjCInterfaces() const
const RecordMap<
clang::extractapi::ObjCInterfaceRecord>&
getObjCInterfaces() const
Declared at: clang/include/clang/ExtractAPI/API.h:673
¶const RecordMap<
clang::extractapi::ObjCProtocolRecord>&
getObjCProtocols() const
const RecordMap<
clang::extractapi::ObjCProtocolRecord>&
getObjCProtocols() const
Declared at: clang/include/clang/ExtractAPI/API.h:676
¶const RecordMap<clang::extractapi::StructRecord>&
getStructs() const
const RecordMap<clang::extractapi::StructRecord>&
getStructs() const
Declared at: clang/include/clang/ExtractAPI/API.h:669
¶const llvm::Triple& getTarget() const
const llvm::Triple& getTarget() const
Description
Get the target triple for the ExtractAPI invocation.
Declared at: clang/include/clang/ExtractAPI/API.h:657
¶const RecordMap<clang::extractapi::TypedefRecord>&
getTypedefs() const
const RecordMap<clang::extractapi::TypedefRecord>&
getTypedefs() const
Declared at: clang/include/clang/ExtractAPI/API.h:680
¶llvm::StringRef recordUSR(const clang::Decl* D)
llvm::StringRef recordUSR(const clang::Decl* D)
Description
Generate and store the USR of declaration \p D. Note: The USR string is stored in and owned by Allocator.
Declared at: clang/include/clang/ExtractAPI/API.h:687
Parameters
- const clang::Decl* D
Returns
a StringRef of the generated USR string.
¶llvm::StringRef recordUSRForMacro(
llvm::StringRef Name,
clang::SourceLocation SL,
const clang::SourceManager& SM)
llvm::StringRef recordUSRForMacro(
llvm::StringRef Name,
clang::SourceLocation SL,
const clang::SourceManager& SM)
Description
Generate and store the USR for a macro \p Name. Note: The USR string is stored in and owned by Allocator.
Declared at: clang/include/clang/ExtractAPI/API.h:694
Parameters
- llvm::StringRef Name
- clang::SourceLocation SL
- const clang::SourceManager& SM
Returns
a StringRef to the generate USR string.