clang::ssaf::JSONFormat Class Reference

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

Inheritance diagram for clang::ssaf::JSONFormat:

Public Types
using	EntityIdToJSONFn = llvm::function_ref<Object(EntityId)>
using	EntityIdFromJSONFn
using	SerializerFn
using	DeserializerFn
using	FormatInfo = FormatInfoEntry<SerializerFn, DeserializerFn>
using	AnalysisResultSerializerFn
using	AnalysisResultDeserializerFn
using	AnalysisResultRegistry

Public Member Functions
llvm::Expected< TUSummary >	readTUSummary (llvm::StringRef Path) override
llvm::Error	writeTUSummary (const TUSummary &Summary, llvm::StringRef Path) override
llvm::Expected< TUSummaryEncoding >	readTUSummaryEncoding (llvm::StringRef Path) override
llvm::Error	writeTUSummaryEncoding (const TUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) override
llvm::Expected< LUSummary >	readLUSummary (llvm::StringRef Path) override
llvm::Error	writeLUSummary (const LUSummary &Summary, llvm::StringRef Path) override
llvm::Expected< LUSummaryEncoding >	readLUSummaryEncoding (llvm::StringRef Path) override
llvm::Error	writeLUSummaryEncoding (const LUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) override
llvm::Expected< WPASuite >	readWPASuite (llvm::StringRef Path) override
llvm::Error	writeWPASuite (const WPASuite &Suite, llvm::StringRef Path) override
void	forEachRegisteredAnalysis (llvm::function_ref< void(llvm::StringRef Name, llvm::StringRef Desc)> Callback) const override
	Invokes Callback once for each analysis that has registered serialization support for this format.
Public Member Functions inherited from clang::ssaf::SerializationFormat
virtual	~SerializationFormat ()=default

Friends
class	JSONEntitySummaryEncoding

Additional Inherited Members
Static Protected Member Functions inherited from clang::ssaf::SerializationFormat
static EntityId	makeEntityId (const size_t Index)
static WPASuite	makeWPASuite ()
	Constructs an empty WPASuite.

Detailed Description

Definition at line 31 of file JSONFormat.h.

Member Typedef Documentation

AnalysisResultDeserializerFn

using clang::ssaf::JSONFormat::AnalysisResultDeserializerFn

Initial value:

 
      llvm::function_ref<llvm::Expected<std::unique_ptr<AnalysisResult>>(
          const Object &, EntityIdFromJSONFn)>

Definition at line 84 of file JSONFormat.h.

AnalysisResultRegistry

using clang::ssaf::JSONFormat::AnalysisResultRegistry

Initial value:

 
      SerializationFormat::AnalysisResultRegistryGenerator<
          JSONFormat, AnalysisResultSerializerFn, AnalysisResultDeserializerFn>

Definition at line 88 of file JSONFormat.h.

AnalysisResultSerializerFn

using clang::ssaf::JSONFormat::AnalysisResultSerializerFn

Initial value:

 
      llvm::function_ref<Object(const AnalysisResult &, EntityIdToJSONFn)>

Definition at line 82 of file JSONFormat.h.

DeserializerFn

using clang::ssaf::JSONFormat::DeserializerFn

Initial value:

 
      llvm::function_ref<llvm::Expected<std::unique_ptr<EntitySummary>>(
          const Object &, EntityIdTable &, EntityIdFromJSONFn)>

Definition at line 76 of file JSONFormat.h.

EntityIdFromJSONFn

using clang::ssaf::JSONFormat::EntityIdFromJSONFn

Initial value:

 
      llvm::function_ref<llvm::Expected<EntityId>(const Object &)>

Definition at line 71 of file JSONFormat.h.

EntityIdToJSONFn

using clang::ssaf::JSONFormat::EntityIdToJSONFn = llvm::function_ref<Object(EntityId)>

Definition at line 70 of file JSONFormat.h.

FormatInfo

using clang::ssaf::JSONFormat::FormatInfo = FormatInfoEntry<SerializerFn, DeserializerFn>

Definition at line 80 of file JSONFormat.h.

SerializerFn

using clang::ssaf::JSONFormat::SerializerFn

Initial value:

 
      llvm::function_ref<Object(const EntitySummary &, EntityIdToJSONFn)>

Definition at line 74 of file JSONFormat.h.

Member Function Documentation

forEachRegisteredAnalysis()

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

overridevirtual

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

Implements clang::ssaf::SerializationFormat.

Definition at line 130 of file JSONFormatImpl.cpp.

readLUSummary()

llvm::Expected< LUSummary > clang::ssaf::JSONFormat::readLUSummary ( llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 21 of file LUSummary.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadObject, clang::ssaf::ErrorMessages::FailedToReadObjectAtField, clang::ssaf::ErrorMessages::ReadingFromField, clang::ssaf::ErrorMessages::ReadingFromFile, clang::ssaf::readJSON(), and clang::ssaf::ErrorBuilder::wrap().

readLUSummaryEncoding()

llvm::Expected< LUSummaryEncoding > clang::ssaf::JSONFormat::readLUSummaryEncoding ( llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 22 of file LUSummaryEncoding.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadObject, clang::ssaf::ErrorMessages::FailedToReadObjectAtField, clang::ssaf::ErrorMessages::ReadingFromField, clang::ssaf::ErrorMessages::ReadingFromFile, clang::ssaf::readJSON(), and clang::ssaf::ErrorBuilder::wrap().

readTUSummary()

llvm::Expected< TUSummary > clang::ssaf::JSONFormat::readTUSummary ( llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 21 of file TUSummary.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadObject, clang::ssaf::ErrorMessages::FailedToReadObjectAtField, clang::ssaf::ErrorMessages::ReadingFromField, clang::ssaf::ErrorMessages::ReadingFromFile, clang::ssaf::readJSON(), and clang::ssaf::ErrorBuilder::wrap().

readTUSummaryEncoding()

llvm::Expected< TUSummaryEncoding > clang::ssaf::JSONFormat::readTUSummaryEncoding ( llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 22 of file TUSummaryEncoding.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadObject, clang::ssaf::ErrorMessages::FailedToReadObjectAtField, clang::ssaf::ErrorMessages::ReadingFromField, clang::ssaf::ErrorMessages::ReadingFromFile, clang::ssaf::readJSON(), and clang::ssaf::ErrorBuilder::wrap().

readWPASuite()

llvm::Expected< WPASuite > clang::ssaf::JSONFormat::readWPASuite ( llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 122 of file WPASuite.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::ssaf::ErrorBuilder::create(), clang::ssaf::ErrorMessages::FailedToReadObject, clang::ssaf::ErrorMessages::FailedToReadObjectAtField, clang::ssaf::SerializationFormat::makeWPASuite(), clang::ssaf::ErrorMessages::ReadingFromField, clang::ssaf::ErrorMessages::ReadingFromFile, clang::ssaf::readJSON(), and clang::ssaf::ErrorBuilder::wrap().

writeLUSummary()

llvm::Error clang::ssaf::JSONFormat::writeLUSummary ( const LUSummary & Summary, llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 137 of file LUSummary.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::Error, clang::ssaf::ErrorBuilder::wrap(), clang::ssaf::writeJSON(), and clang::ssaf::ErrorMessages::WritingToFile.

writeLUSummaryEncoding()

llvm::Error clang::ssaf::JSONFormat::writeLUSummaryEncoding ( const LUSummaryEncoding & SummaryEncoding, llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 139 of file LUSummaryEncoding.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::Error, clang::ssaf::ErrorBuilder::wrap(), clang::ssaf::writeJSON(), and clang::ssaf::ErrorMessages::WritingToFile.

writeTUSummary()

llvm::Error clang::ssaf::JSONFormat::writeTUSummary ( const TUSummary & Summary, llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 137 of file TUSummary.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::Error, clang::ssaf::ErrorBuilder::wrap(), clang::ssaf::writeJSON(), and clang::ssaf::ErrorMessages::WritingToFile.

writeTUSummaryEncoding()

llvm::Error clang::ssaf::JSONFormat::writeTUSummaryEncoding ( const TUSummaryEncoding & SummaryEncoding, llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 139 of file TUSummaryEncoding.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::Error, clang::ssaf::ErrorBuilder::wrap(), clang::ssaf::writeJSON(), and clang::ssaf::ErrorMessages::WritingToFile.

writeWPASuite()

llvm::Error clang::ssaf::JSONFormat::writeWPASuite ( const WPASuite & Suite, llvm::StringRef Path )

overridevirtual

Implements clang::ssaf::SerializationFormat.

Definition at line 188 of file WPASuite.cpp.

References clang::ssaf::ErrorBuilder::build(), clang::ssaf::ErrorBuilder::context(), clang::Error, clang::ssaf::ErrorBuilder::wrap(), clang::ssaf::writeJSON(), and clang::ssaf::ErrorMessages::WritingToFile.

Friends And Related Symbol Documentation

JSONEntitySummaryEncoding

friend class JSONEntitySummaryEncoding

friend

Definition at line 36 of file JSONFormat.h.

References JSONEntitySummaryEncoding.

Referenced by JSONEntitySummaryEncoding.

---

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

• include/clang/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat.h
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/JSONFormatImpl.cpp
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/LUSummary.cpp
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/LUSummaryEncoding.cpp
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/TUSummary.cpp
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/TUSummaryEncoding.cpp
• lib/ScalableStaticAnalysisFramework/Core/Serialization/JSONFormat/WPASuite.cpp