clang::extractapi::SymbolGraphSerializer Class Reference

The visitor that organizes API information in the Symbol Graph format. More...

#include "clang/ExtractAPI/Serialization/SymbolGraphSerializer.h"

Inheritance diagram for clang::extractapi::SymbolGraphSerializer:

Public Member Functions
bool	traverseAPIRecord (const APIRecord *Record)
bool	visitAPIRecord (const APIRecord *Record)
bool	visitGlobalFunctionRecord (const GlobalFunctionRecord *Record)
	Visit a global function record.
bool	visitCXXClassRecord (const CXXClassRecord *Record)
bool	visitClassTemplateRecord (const ClassTemplateRecord *Record)
bool	visitClassTemplatePartialSpecializationRecord (const ClassTemplatePartialSpecializationRecord *Record)
bool	visitCXXMethodRecord (const CXXMethodRecord *Record)
bool	visitCXXMethodTemplateRecord (const CXXMethodTemplateRecord *Record)
bool	visitCXXFieldTemplateRecord (const CXXFieldTemplateRecord *Record)
bool	visitConceptRecord (const ConceptRecord *Record)
bool	visitGlobalVariableTemplateRecord (const GlobalVariableTemplateRecord *Record)
bool	visitGlobalVariableTemplatePartialSpecializationRecord (const GlobalVariableTemplatePartialSpecializationRecord *Record)
bool	visitGlobalFunctionTemplateRecord (const GlobalFunctionTemplateRecord *Record)
bool	visitObjCContainerRecord (const ObjCContainerRecord *Record)
bool	visitObjCInterfaceRecord (const ObjCInterfaceRecord *Record)
bool	traverseObjCCategoryRecord (const ObjCCategoryRecord *Record)
bool	walkUpFromObjCCategoryRecord (const ObjCCategoryRecord *Record)
bool	visitObjCCategoryRecord (const ObjCCategoryRecord *Record)
bool	visitObjCMethodRecord (const ObjCMethodRecord *Record)
bool	visitObjCInstanceVariableRecord (const ObjCInstanceVariableRecord *Record)
bool	walkUpFromTypedefRecord (const TypedefRecord *Record)
bool	visitTypedefRecord (const TypedefRecord *Record)
	SymbolGraphSerializer (const APISet &API, const APIIgnoresList &IgnoresList, bool EmitSymbolLabelsForTesting=false, bool ForceEmitToMainModule=false, bool SkipSymbolsInCategoriesToExternalTypes=false)
Public Member Functions inherited from clang::extractapi::APISetVisitor< SymbolGraphSerializer >
bool	traverseAPISet ()
bool	traverseAPIRecord (const APIRecord *Record)
bool	walkUpFromAPIRecord (const APIRecord *Record)
bool	visitAPIRecord (const APIRecord *Record)
	CONCRETE_RECORD (GlobalFunctionTemplateRecord, GlobalFunctionRecord, RK_GlobalFunctionTemplate) CONCRETE_RECORD(GlobalFunctionTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization	CONCRETE_RECORD (GlobalVariableTemplateRecord, GlobalVariableRecord, RK_GlobalVariableTemplate) CONCRETE_RECORD(GlobalVariableTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization	CONCRETE_RECORD (GlobalVariableTemplatePartialSpecializationRecord, GlobalVariableRecord, RK_GlobalVariableTemplatePartialSpecialization) CONCRETE_RECORD(CXXMethodTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization	CONCRETE_RECORD (ObjCInstancePropertyRecord, ObjCPropertyRecord, RK_ObjCInstanceProperty) CONCRETE_RECORD(ObjCClassPropertyRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization RK_ObjCClassProperty	CONCRETE_RECORD (ObjCInstanceMethodRecord, ObjCMethodRecord, RK_ObjCInstanceMethod) CONCRETE_RECORD(ClassTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization RK_ObjCClassProperty RK_ClassTemplateSpecialization	CONCRETE_RECORD (ClassTemplatePartialSpecializationRecord, CXXClassRecord, RK_ClassTemplatePartialSpecialization) RECORD_CONTEXT(ClassTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization RK_ObjCClassProperty RK_ClassTemplateSpecialization RK_ClassTemplateSpecialization	RECORD_CONTEXT (ClassTemplatePartialSpecializationRecord, RK_ClassTemplatePartialSpecialization) RECORD_CONTEXT(GlobalVariableTemplateSpecializationRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization RK_ObjCClassProperty RK_ClassTemplateSpecialization RK_ClassTemplateSpecialization RK_GlobalVariableTemplateSpecialization	RECORD_CONTEXT (GlobalVariableTemplatePartialSpecializationRecord, RK_GlobalVariableTemplatePartialSpecialization) bool traverseRecordContext(const RecordContext *)
	APISetVisitor ()=delete
	APISetVisitor (const APISetVisitor &)=delete
	APISetVisitor (APISetVisitor &&)=delete
APISetVisitor &	operator= (const APISetVisitor &)=delete
APISetVisitor &	operator= (APISetVisitor &&)=delete

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.

Additional Inherited Members
Public Attributes inherited from clang::extractapi::APISetVisitor< SymbolGraphSerializer >
	GlobalFunctionRecord
RK_GlobalFunctionTemplateSpecialization	GlobalVariableRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization	CXXMethodRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization	ObjCPropertyRecord
RK_GlobalFunctionTemplateSpecialization RK_GlobalVariableTemplateSpecialization RK_CXXMethodTemplateSpecialization RK_ObjCClassProperty	CXXClassRecord
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

Detailed Description

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 74 of file SymbolGraphSerializer.h.

Constructor & Destructor Documentation

SymbolGraphSerializer()

clang::extractapi::SymbolGraphSerializer::SymbolGraphSerializer ( const APISet & API, const APIIgnoresList & IgnoresList, bool EmitSymbolLabelsForTesting = false, bool ForceEmitToMainModule = false, bool SkipSymbolsInCategoriesToExternalTypes = false )

inline

Definition at line 273 of file SymbolGraphSerializer.h.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API.

Referenced by serializeMainSymbolGraph(), serializeSingleSymbolSGF(), and serializeWithExtensionGraphs().

Member Function Documentation

serializeMainSymbolGraph()

void SymbolGraphSerializer::serializeMainSymbolGraph ( raw_ostream & OS, const APISet & API, const APIIgnoresList & IgnoresList, SymbolGraphSerializerOption Options = {} )

static

Definition at line 1055 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API, clang::extractapi::SymbolGraphSerializerOption::EmitSymbolLabelsForTesting, SymbolGraphSerializer(), and clang::extractapi::APISetVisitor< Derived >::traverseAPISet().

Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().

serializeSingleSymbolSGF()

std::optional< Object > SymbolGraphSerializer::serializeSingleSymbolSGF ( StringRef USR, const APISet & API )

static

Serialize a single symbol SGF.

This is primarily used for libclang.

Returns

an optional JSON Object representing the payload that libclang expects for providing symbol information for a single symbol. If this is not a known symbol returns std::nullopt.

Definition at line 1091 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APIRecord::Access, clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API, clang::extractapi::AccessControl::getAccess(), clang::PresumedLoc::getFilename(), getLanguageName(), clang::extractapi::APIRecord::IsFromSystemHeader, clang::extractapi::APIRecord::Location, SymbolGraphSerializer(), and clang::extractapi::APIRecord::USR.

serializeWithExtensionGraphs()

void SymbolGraphSerializer::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

Definition at line 1069 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API, clang::extractapi::SymbolGraphSerializerOption::EmitSymbolLabelsForTesting, SymbolGraphSerializer(), and clang::extractapi::APISetVisitor< Derived >::traverseAPISet().

Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().

traverseAPIRecord()

bool SymbolGraphSerializer::traverseAPIRecord

(

const APIRecord *

Record

)

Definition at line 797 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API, and clang::extractapi::APISetVisitor< SymbolGraphSerializer >::traverseAPIRecord().

traverseObjCCategoryRecord()

bool SymbolGraphSerializer::traverseObjCCategoryRecord

(

const ObjCCategoryRecord *

Record

)

Definition at line 937 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::API, and walkUpFromObjCCategoryRecord().

visitAPIRecord()

bool SymbolGraphSerializer::visitAPIRecord

(

const APIRecord *

Record

)

Definition at line 809 of file SymbolGraphSerializer.cpp.

visitClassTemplatePartialSpecializationRecord()

bool SymbolGraphSerializer::visitClassTemplatePartialSpecializationRecord

(

const ClassTemplatePartialSpecializationRecord *

Record

)

Definition at line 842 of file SymbolGraphSerializer.cpp.

visitClassTemplateRecord()

bool SymbolGraphSerializer::visitClassTemplateRecord

(

const ClassTemplateRecord *

Record

)

Definition at line 833 of file SymbolGraphSerializer.cpp.

visitConceptRecord()

bool SymbolGraphSerializer::visitConceptRecord

(

const ConceptRecord *

Record

)

Definition at line 878 of file SymbolGraphSerializer.cpp.

visitCXXClassRecord()

bool SymbolGraphSerializer::visitCXXClassRecord

(

const CXXClassRecord *

Record

)

Definition at line 823 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::CXXClassRecord.

visitCXXFieldTemplateRecord()

bool SymbolGraphSerializer::visitCXXFieldTemplateRecord

(

const CXXFieldTemplateRecord *

Record

)

Definition at line 869 of file SymbolGraphSerializer.cpp.

visitCXXMethodRecord()

bool SymbolGraphSerializer::visitCXXMethodRecord

(

const CXXMethodRecord *

Record

)

Definition at line 851 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::CXXMethodRecord.

visitCXXMethodTemplateRecord()

bool SymbolGraphSerializer::visitCXXMethodTemplateRecord

(

const CXXMethodTemplateRecord *

Record

)

Definition at line 860 of file SymbolGraphSerializer.cpp.

visitGlobalFunctionRecord()

bool SymbolGraphSerializer::visitGlobalFunctionRecord

(

const GlobalFunctionRecord *

Record

)

Visit a global function record.

Definition at line 814 of file SymbolGraphSerializer.cpp.

References clang::extractapi::APISetVisitor< SymbolGraphSerializer >::GlobalFunctionRecord.

visitGlobalFunctionTemplateRecord()

bool SymbolGraphSerializer::visitGlobalFunctionTemplateRecord

(

const GlobalFunctionTemplateRecord *

Record

)

Definition at line 905 of file SymbolGraphSerializer.cpp.

visitGlobalVariableTemplatePartialSpecializationRecord()

bool SymbolGraphSerializer::visitGlobalVariableTemplatePartialSpecializationRecord

(

const GlobalVariableTemplatePartialSpecializationRecord *

Record

)

Definition at line 895 of file SymbolGraphSerializer.cpp.

visitGlobalVariableTemplateRecord()

bool SymbolGraphSerializer::visitGlobalVariableTemplateRecord

(

const GlobalVariableTemplateRecord *

Record

)

Definition at line 886 of file SymbolGraphSerializer.cpp.

visitObjCCategoryRecord()

bool SymbolGraphSerializer::visitObjCCategoryRecord

(

const ObjCCategoryRecord *

Record

)

Definition at line 960 of file SymbolGraphSerializer.cpp.

Referenced by walkUpFromObjCCategoryRecord().

visitObjCContainerRecord()

bool SymbolGraphSerializer::visitObjCContainerRecord

(

const ObjCContainerRecord *

Record

)

Definition at line 914 of file SymbolGraphSerializer.cpp.

visitObjCInstanceVariableRecord()

bool SymbolGraphSerializer::visitObjCInstanceVariableRecord

(

const ObjCInstanceVariableRecord *

Record

)

Definition at line 981 of file SymbolGraphSerializer.cpp.

visitObjCInterfaceRecord()

bool SymbolGraphSerializer::visitObjCInterfaceRecord

(

const ObjCInterfaceRecord *

Record

)

Definition at line 926 of file SymbolGraphSerializer.cpp.

visitObjCMethodRecord()

bool SymbolGraphSerializer::visitObjCMethodRecord

(

const ObjCMethodRecord *

Record

)

Definition at line 972 of file SymbolGraphSerializer.cpp.

visitTypedefRecord()

bool SymbolGraphSerializer::visitTypedefRecord

(

const TypedefRecord *

Record

)

Definition at line 995 of file SymbolGraphSerializer.cpp.

Referenced by walkUpFromTypedefRecord().

walkUpFromObjCCategoryRecord()

bool SymbolGraphSerializer::walkUpFromObjCCategoryRecord

(

const ObjCCategoryRecord *

Record

)

Definition at line 955 of file SymbolGraphSerializer.cpp.

References visitObjCCategoryRecord().

Referenced by traverseObjCCategoryRecord().

walkUpFromTypedefRecord()

bool SymbolGraphSerializer::walkUpFromTypedefRecord

(

const TypedefRecord *

Record

)

Definition at line 987 of file SymbolGraphSerializer.cpp.

References visitTypedefRecord().

---

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

• include/clang/ExtractAPI/Serialization/SymbolGraphSerializer.h
• lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp