slang::netlist::NetlistSerializer Struct Reference

#include <NetlistSerializer.hpp>

Static Public Member Functions
static auto	serialize (NetlistGraph const &graph) -> std::string
	Serialise graph to a pretty-printed JSON string.
static void	deserialize (std::string_view json, NetlistGraph &graph)

Static Public Attributes
static constexpr int	formatVersion = 3

Detailed Description

Serialise and deserialise a NetlistGraph to/from JSON.

Format (version 3):

{
  "version": 3,
  "fileTable": ["test.sv", "other.sv"],
  "blackBoxes": ["m.u_core"],
  "nodes": [
    {"id": 1, "kind": "Port", "path": "m.a", "name": "a",
     "bounds": [0, 0], "direction": "In",
     "location": {"fileIndex": 0, "line": 2, "column": 31}}
  ],
  "edges": [
    {"source": 1, "target": 3, "edgeKind": "None",
     "symbol": {"name": "a", "path": "m.a",
                "location": {"fileIndex": 0, "line": 2, "column": 31}},
     "bounds": [0, 0], "disabled": false}
  ]
}

Member Function Documentation

deserialize()

void slang::netlist::NetlistSerializer::deserialize ( std::string_view json, NetlistGraph & graph )

static

Deserialise a JSON string into graph. The graph must be empty. FileTable is populated from the JSON.

Exceptions

std::runtime_error

on parse failure or unsupported version.

serialize()

auto slang::netlist::NetlistSerializer::serialize ( NetlistGraph const & graph ) -> std::string

static

Serialise graph to a pretty-printed JSON string.

Member Data Documentation

formatVersion

int slang::netlist::NetlistSerializer::formatVersion = 3

staticconstexpr

---

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

• netlist/NetlistSerializer.hpp