clang 23.0.0git
clang::ssaf::SerializationFormat Class Referenceabstract

Abstract base class for serialization formats. More...

#include "clang/ScalableStaticAnalysisFramework/Core/Serialization/SerializationFormat.h"

Inheritance diagram for clang::ssaf::SerializationFormat:
[legend]

Public Member Functions

virtual ~SerializationFormat ()=default
virtual llvm::Expected< TUSummaryreadTUSummary (llvm::StringRef Path)=0
virtual llvm::Error writeTUSummary (const TUSummary &Summary, llvm::StringRef Path)=0
virtual llvm::Expected< TUSummaryEncodingreadTUSummaryEncoding (llvm::StringRef Path)=0
virtual llvm::Error writeTUSummaryEncoding (const TUSummaryEncoding &SummaryEncoding, llvm::StringRef Path)=0
virtual llvm::Expected< LUSummaryreadLUSummary (llvm::StringRef Path)=0
virtual llvm::Error writeLUSummary (const LUSummary &Summary, llvm::StringRef Path)=0
virtual llvm::Expected< LUSummaryEncodingreadLUSummaryEncoding (llvm::StringRef Path)=0
virtual llvm::Error writeLUSummaryEncoding (const LUSummaryEncoding &SummaryEncoding, llvm::StringRef Path)=0
virtual void forEachRegisteredAnalysis (llvm::function_ref< void(llvm::StringRef Name, llvm::StringRef Desc)> Callback) const =0
 Invokes Callback once for each analysis that has registered serialization support for this format.

Static Protected Member Functions

static EntityId makeEntityId (const size_t Index)

Detailed Description

Abstract base class for serialization formats.

Definition at line 30 of file SerializationFormat.h.

Constructor & Destructor Documentation

◆ ~SerializationFormat()

virtual clang::ssaf::SerializationFormat::~SerializationFormat ( )
virtualdefault

Member Function Documentation

◆ forEachRegisteredAnalysis()

virtual void clang::ssaf::SerializationFormat::forEachRegisteredAnalysis ( llvm::function_ref< void(llvm::StringRef Name, llvm::StringRef Desc)> Callback) const
pure virtual

Invokes Callback once for each analysis that has registered serialization support for this format.

Implemented in clang::ssaf::JSONFormat.

◆ makeEntityId()

EntityId clang::ssaf::SerializationFormat::makeEntityId ( const size_t Index)
inlinestaticprotected

Definition at line 68 of file SerializationFormat.h.

◆ readLUSummary()

virtual llvm::Expected< LUSummary > clang::ssaf::SerializationFormat::readLUSummary ( llvm::StringRef Path)
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ readLUSummaryEncoding()

virtual llvm::Expected< LUSummaryEncoding > clang::ssaf::SerializationFormat::readLUSummaryEncoding ( llvm::StringRef Path)
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ readTUSummary()

virtual llvm::Expected< TUSummary > clang::ssaf::SerializationFormat::readTUSummary ( llvm::StringRef Path)
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ readTUSummaryEncoding()

virtual llvm::Expected< TUSummaryEncoding > clang::ssaf::SerializationFormat::readTUSummaryEncoding ( llvm::StringRef Path)
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ writeLUSummary()

virtual llvm::Error clang::ssaf::SerializationFormat::writeLUSummary ( const LUSummary & Summary,
llvm::StringRef Path )
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ writeLUSummaryEncoding()

virtual llvm::Error clang::ssaf::SerializationFormat::writeLUSummaryEncoding ( const LUSummaryEncoding & SummaryEncoding,
llvm::StringRef Path )
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ writeTUSummary()

virtual llvm::Error clang::ssaf::SerializationFormat::writeTUSummary ( const TUSummary & Summary,
llvm::StringRef Path )
pure virtual

Implemented in clang::ssaf::JSONFormat.

◆ writeTUSummaryEncoding()

virtual llvm::Error clang::ssaf::SerializationFormat::writeTUSummaryEncoding ( const TUSummaryEncoding & SummaryEncoding,
llvm::StringRef Path )
pure virtual

Implemented in clang::ssaf::JSONFormat.


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