yaze::editor::layout_designer::LayoutSerializer Class Reference

Handles JSON serialization and deserialization of layouts. More...

#include <layout_serialization.h>

Static Public Member Functions
static std::string	ToJson (const LayoutDefinition &layout)
	Serialize a layout to JSON string.
static absl::StatusOr< LayoutDefinition >	FromJson (const std::string &json_str)
	Deserialize a layout from JSON string.
static absl::Status	SaveToFile (const LayoutDefinition &layout, const std::string &filepath)
	Save layout to JSON file.
static absl::StatusOr< LayoutDefinition >	LoadFromFile (const std::string &filepath)
	Load layout from JSON file.

Static Private Member Functions
static std::string	SerializePanel (const LayoutPanel &panel)
static std::string	SerializeDockNode (const DockNode &node)
static LayoutPanel	DeserializePanel (const std::string &json)
static std::unique_ptr< DockNode >	DeserializeDockNode (const std::string &json)

Detailed Description

Handles JSON serialization and deserialization of layouts.

Definition at line 17 of file layout_serialization.h.

Member Function Documentation

ToJson()

std::string yaze::editor::layout_designer::LayoutSerializer::ToJson ( const LayoutDefinition & layout )

static

Serialize a layout to JSON string.

Parameters

layout

The layout to serialize

Returns

JSON string representation

Definition at line 71 of file layout_serialization.cc.

References yaze::editor::layout_designer::LayoutDefinition::author, yaze::editor::layout_designer::LayoutDefinition::canvas_size, yaze::editor::layout_designer::LayoutDefinition::created_timestamp, yaze::editor::layout_designer::LayoutDefinition::description, yaze::editor::layout_designer::LayoutDefinition::modified_timestamp, yaze::editor::layout_designer::LayoutDefinition::name, yaze::editor::layout_designer::LayoutDefinition::root, SerializeDockNode(), and yaze::editor::layout_designer::LayoutDefinition::version.

Referenced by SaveToFile().

Here is the call graph for this function:

FromJson()

absl::StatusOr< LayoutDefinition > yaze::editor::layout_designer::LayoutSerializer::FromJson ( const std::string & json_str )

static

Deserialize a layout from JSON string.

Parameters

json_str

The JSON string

Returns

LayoutDefinition or error status

Definition at line 153 of file layout_serialization.cc.

Referenced by LoadFromFile().

SaveToFile()

absl::Status yaze::editor::layout_designer::LayoutSerializer::SaveToFile ( const LayoutDefinition & layout, const std::string & filepath )

static

Save layout to JSON file.

Parameters

layout	The layout to save
filepath	Path to save to

Returns

Success status

Definition at line 162 of file layout_serialization.cc.

References LOG_INFO, and ToJson().

Here is the call graph for this function:

LoadFromFile()

absl::StatusOr< LayoutDefinition > yaze::editor::layout_designer::LayoutSerializer::LoadFromFile ( const std::string & filepath )

static

Load layout from JSON file.

Parameters

filepath

Path to load from

Returns

LayoutDefinition or error status

Definition at line 183 of file layout_serialization.cc.

References FromJson().

Here is the call graph for this function:

SerializePanel()

std::string yaze::editor::layout_designer::LayoutSerializer::SerializePanel ( const LayoutPanel & panel )

staticprivate

Definition at line 140 of file layout_serialization.cc.

References yaze::editor::layout_designer::LayoutPanel::closable, yaze::editor::layout_designer::LayoutPanel::display_name, yaze::editor::layout_designer::LayoutPanel::icon, yaze::editor::layout_designer::LayoutPanel::panel_id, yaze::editor::layout_designer::LayoutPanel::pinnable, yaze::editor::layout_designer::LayoutPanel::priority, and yaze::editor::layout_designer::LayoutPanel::visible_by_default.

Referenced by SerializeDockNode().

SerializeDockNode()

std::string yaze::editor::layout_designer::LayoutSerializer::SerializeDockNode ( const DockNode & node )

staticprivate

Definition at line 97 of file layout_serialization.cc.

References yaze::editor::layout_designer::DockNode::child_left, yaze::editor::layout_designer::DockNode::child_right, yaze::editor::layout_designer::DockNode::IsLeaf(), yaze::editor::layout_designer::DockNode::IsSplit(), yaze::editor::layout_designer::DockNode::panels, SerializeDockNode(), SerializePanel(), yaze::editor::layout_designer::DockNode::split_dir, yaze::editor::layout_designer::DockNode::split_ratio, and yaze::editor::layout_designer::DockNode::type.

Referenced by SerializeDockNode(), and ToJson().

Here is the call graph for this function:

DeserializePanel()

static LayoutPanel yaze::editor::layout_designer::LayoutSerializer::DeserializePanel ( const std::string & json )

staticprivate

DeserializeDockNode()

static std::unique_ptr< DockNode > yaze::editor::layout_designer::LayoutSerializer::DeserializeDockNode ( const std::string & json )

staticprivate

---

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

• src/app/editor/layout_designer/layout_serialization.h
• src/app/editor/layout_designer/layout_serialization.cc