clang
19.0.0git
|
The visitor that organizes API information in the Symbol Graph format. More...
#include "clang/ExtractAPI/Serialization/SymbolGraphSerializer.h"
Static Public Member Functions | |
static void | serializeMainSymbolGraph (raw_ostream &OS, const APISet &API, const APIIgnoresList &IgnoresList, SymbolGraphSerializerOption Options={}) |
static void | serializeWithExtensionGraphs (raw_ostream &MainOutput, const APISet &API, const APIIgnoresList &IgnoresList, llvm::function_ref< std::unique_ptr< llvm::raw_pwrite_stream >(llvm::Twine BaseFileName)> CreateOutputStream, SymbolGraphSerializerOption Options={}) |
static std::optional< Object > | serializeSingleSymbolSGF (StringRef USR, const APISet &API) |
Serialize a single symbol SGF. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from clang::extractapi::APISetVisitor< SymbolGraphSerializer > | |
APISetVisitor (const APISet &API) | |
~APISetVisitor ()=default | |
SymbolGraphSerializer * | getDerived () |
Protected Attributes inherited from clang::extractapi::APISetVisitor< SymbolGraphSerializer > | |
const APISet & | API |
The visitor that organizes API information in the Symbol Graph format.
The Symbol Graph format (https://github.com/apple/swift-docc-symbolkit) models an API set as a directed graph, where nodes are symbol declarations, and edges are relationships between the connected symbols.
Definition at line 75 of file SymbolGraphSerializer.h.
|
inline |
Definition at line 274 of file SymbolGraphSerializer.h.
|
static |
Definition at line 1044 of file SymbolGraphSerializer.cpp.
Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().
|
static |
Serialize a single symbol SGF.
This is primarily used for libclang.
std::nullopt
. Definition at line 1081 of file SymbolGraphSerializer.cpp.
References clang::extractapi::APIRecord::Access, Array, clang::extractapi::APISet::findRecordForUSR(), clang::extractapi::AccessControl::getAccess(), clang::PresumedLoc::getFilename(), clang::extractapi::APISet::getLanguage(), clang::format::getLanguageName(), clang::extractapi::APIRecord::IsFromSystemHeader, clang::extractapi::APIRecord::Location, clang::extractapi::APISet::ProductName, and clang::extractapi::APIRecord::USR.
|
static |
Definition at line 1058 of file SymbolGraphSerializer.cpp.
Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().
Definition at line 786 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::traverseObjCCategoryRecord | ( | const ObjCCategoryRecord * | Record | ) |
Definition at line 926 of file SymbolGraphSerializer.cpp.
References clang::extractapi::APISet::findRecordForUSR().
Definition at line 798 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitClassTemplatePartialSpecializationRecord | ( | const ClassTemplatePartialSpecializationRecord * | Record | ) |
Definition at line 831 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitClassTemplateRecord | ( | const ClassTemplateRecord * | Record | ) |
Definition at line 822 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitConceptRecord | ( | const ConceptRecord * | Record | ) |
Definition at line 867 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitCXXClassRecord | ( | const CXXClassRecord * | Record | ) |
Definition at line 812 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitCXXFieldTemplateRecord | ( | const CXXFieldTemplateRecord * | Record | ) |
Definition at line 858 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitCXXMethodRecord | ( | const CXXMethodRecord * | Record | ) |
Definition at line 840 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitCXXMethodTemplateRecord | ( | const CXXMethodTemplateRecord * | Record | ) |
Definition at line 849 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitGlobalFunctionRecord | ( | const GlobalFunctionRecord * | Record | ) |
Visit a global function record.
Definition at line 803 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitGlobalFunctionTemplateRecord | ( | const GlobalFunctionTemplateRecord * | Record | ) |
Definition at line 894 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitGlobalVariableTemplatePartialSpecializationRecord | ( | const GlobalVariableTemplatePartialSpecializationRecord * | Record | ) |
Definition at line 884 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitGlobalVariableTemplateRecord | ( | const GlobalVariableTemplateRecord * | Record | ) |
Definition at line 875 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitObjCCategoryRecord | ( | const ObjCCategoryRecord * | Record | ) |
Definition at line 949 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitObjCContainerRecord | ( | const ObjCContainerRecord * | Record | ) |
Definition at line 903 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitObjCInstanceVariableRecord | ( | const ObjCInstanceVariableRecord * | Record | ) |
Definition at line 970 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitObjCInterfaceRecord | ( | const ObjCInterfaceRecord * | Record | ) |
Definition at line 915 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitObjCMethodRecord | ( | const ObjCMethodRecord * | Record | ) |
Definition at line 961 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::visitTypedefRecord | ( | const TypedefRecord * | Record | ) |
Definition at line 984 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::walkUpFromObjCCategoryRecord | ( | const ObjCCategoryRecord * | Record | ) |
Definition at line 944 of file SymbolGraphSerializer.cpp.
bool SymbolGraphSerializer::walkUpFromTypedefRecord | ( | const TypedefRecord * | Record | ) |
Definition at line 976 of file SymbolGraphSerializer.cpp.