clanguml::class_diagram::generators::json::generator Class Reference

Class diagram JSON generator. More...

Detailed Description

Class diagram JSON generator.

Definition at line 62 of file class_diagram_generator.h.

#include <class_diagram_generator.h>

Public Member Functions
	generator (diagram_config &config, diagram_model &model)
void	generate_diagram (nlohmann::json &parent) const override
	Main generator method.
void	generate (const class_ &c, nlohmann::json &parent) const
void	generate (const enum_ &c, nlohmann::json &parent) const
void	generate (const concept_ &c, nlohmann::json &parent) const
void	generate (const package &p, nlohmann::json &parent) const
void	generate_top_level_elements (nlohmann::json &parent) const
	In a nested diagram, generate the top level elements.
void	generate_relationships (nlohmann::json &parent) const
	Generate all relationships in the diagram.
void	generate_relationships (const class_ &c, nlohmann::json &parent) const
	Generate all relationships originating at a class element.
void	generate_relationships (const enum_ &c, nlohmann::json &parent) const
	Generate all relationships originating at an enum element.
void	generate_relationships (const concept_ &c, nlohmann::json &parent) const
	Generate all relationships originating at a concept element.
void	generate_relationships (const package &p, nlohmann::json &parent) const
	Generate all relationships in a package.
Public Member Functions inherited from clanguml::common::generators::json::generator< ConfigType, DiagramType >
	~generator () override=default
void	generate (std::ostream &ostr) const override
	Generate diagram.
virtual void	generate_diagram (nlohmann::json &parent) const =0
	Generate diagram model.
void	generate_metadata (nlohmann::json &parent) const
	Generate metadata element with diagram metadata.
Public Member Functions inherited from clanguml::common::generators::generator< ConfigType, DiagramType >
	generator (ConfigType &config, DiagramType &model)
	Constructor.
virtual	~generator ()=default
virtual void	generate (std::ostream &ostr) const =0
	Generate diagram.
const ConfigType &	config () const
	Get reference to diagram config.
const DiagramType &	model () const
	Get reference to diagram model.
template<typename E >
inja::json	element_context (const E &e) const
std::optional< std::pair< std::string, std::string > >	get_link_pattern (const common::model::source_location &sl) const
std::optional< std::pair< std::string, std::string > >	get_tooltip_pattern (const common::model::source_location &sl) const
void	init_context ()
	Initialize diagram Jinja context.
void	update_context () const
	Update diagram Jinja context.
void	init_env ()
const inja::json &	context () const
inja::Environment &	env () const

Additional Inherited Members
Protected Attributes inherited from clanguml::common::generators::generator< ConfigType, DiagramType >
inja::json	m_context
inja::Environment	m_env

Constructor & Destructor Documentation

generator()

clanguml::class_diagram::generators::json::generator::generator	(	diagram_config &	config,
		diagram_model &	model
	)

Definition at line 134 of file class_diagram_generator.cc.

    : common_generator<diagram_config, diagram_model>{config, model}
{
}

Member Function Documentation

generate() [1/4]

void clanguml::class_diagram::generators::json::generator::generate	(	const class_ &	c,
		nlohmann::json &	parent
	)		const

Render class element into a JSON node.

Parameters

c	class diagram element
parent	JSON node

Definition at line 229 of file class_diagram_generator.cc.

{
    nlohmann::json object = c;
 
    // Perform config dependent postprocessing on generated class
    if (!config().generate_fully_qualified_name())
        object["display_name"] =
            common::generators::json::render_name(c.full_name_no_ns());
 
    object["display_name"] =
        config().simplify_template_type(object["display_name"]);
 
    for (auto &tp : object["template_parameters"]) {
        if (tp.contains("type") && tp.at("type").is_string()) {
            tp["type"] = config().using_namespace().relative(tp.at("type"));
        }
    }
    for (auto &tp : object["members"]) {
        if (tp.contains("type") && tp.at("type").is_string()) {
            tp["type"] = config().using_namespace().relative(tp.at("type"));
        }
    }
 
    std::string object_str = object.dump(2);
 
    parent["elements"].push_back(std::move(object));
}

generate() [2/4]

void clanguml::class_diagram::generators::json::generator::generate	(	const concept_ &	c,
		nlohmann::json &	parent
	)		const

Render concept element into a JSON node.

Parameters

c	concept diagram element
parent	JSON node

Definition at line 268 of file class_diagram_generator.cc.

{
    nlohmann::json object = c;
 
    if (!config().generate_fully_qualified_name())
        object["display_name"] =
            common::generators::json::render_name(c.full_name_no_ns());
 
    parent["elements"].push_back(std::move(object));
}

generate() [3/4]

void clanguml::class_diagram::generators::json::generator::generate	(	const enum_ &	c,
		nlohmann::json &	parent
	)		const

Render enum element into a JSON node.

Parameters

c	enum diagram element
parent	JSON node

Definition at line 257 of file class_diagram_generator.cc.

{
    nlohmann::json object = e;
 
    if (!config().generate_fully_qualified_name())
        object["display_name"] =
            common::generators::json::render_name(e.full_name_no_ns());
 
    parent["elements"].push_back(std::move(object));
}

generate() [4/4]

void clanguml::class_diagram::generators::json::generator::generate	(	const package &	p,
		nlohmann::json &	parent
	)		const

Render package element into a JSON node.

Parameters

p	package diagram element
parent	JSON node

Definition at line 176 of file class_diagram_generator.cc.

{
    const auto &uns = config().using_namespace();
 
    nlohmann::json package_object;
 
    if (config().generate_packages()) {
        // Don't generate packages from namespaces filtered out by
        // using_namespace
        if (!uns.starts_with({p.full_name(false)})) {
            LOG_DBG("Generating package {}", p.name());
 
            package_object["type"] = to_string(config().package_type());
            package_object["name"] = p.name();
            package_object["display_name"] = p.name();
        }
    }
 
    for (const auto &subpackage : p) {
        if (dynamic_cast<package *>(subpackage.get()) != nullptr) {
            const auto &sp = dynamic_cast<package &>(*subpackage);
            if (!sp.is_empty()) {
                if (config().generate_packages())
                    generate(sp, package_object);
                else
                    generate(sp, parent);
            }
        }
        else if (auto *cls = dynamic_cast<class_ *>(subpackage.get()); cls) {
            if (config().generate_packages())
                generate(*cls, package_object);
            else
                generate(*cls, parent);
        }
        else if (auto *enm = dynamic_cast<enum_ *>(subpackage.get()); enm) {
            if (config().generate_packages())
                generate(*enm, package_object);
            else
                generate(*enm, parent);
        }
        else if (auto *cpt = dynamic_cast<concept_ *>(subpackage.get()); cpt) {
            if (config().generate_packages())
                generate(*cpt, package_object);
            else
                generate(*cpt, parent);
        }
    }
 
    if (config().generate_packages() && !package_object.empty()) {
        parent["elements"].push_back(std::move(package_object));
    }
}

generate_diagram()

void clanguml::class_diagram::generators::json::generator::generate_diagram ( nlohmann::json &  parent ) const

overridevirtual

Main generator method.

This method is called first and coordinates the entire diagram generation.

Parameters

ostr	Output stream.

Implements clanguml::common::generators::json::generator< ConfigType, DiagramType >.

Definition at line 139 of file class_diagram_generator.cc.

{
    if (config().using_namespace)
        parent["using_namespace"] = config().using_namespace().to_string();
 
    if (config().using_module)
        parent["using_module"] = config().using_module();
 
    if (config().generate_packages.has_value)
        parent["package_type"] = to_string(config().package_type());
    parent["elements"] = std::vector<nlohmann::json>{};
    parent["relationships"] = std::vector<nlohmann::json>{};
 
    generate_top_level_elements(parent);
 
    generate_relationships(parent);
}

generate_relationships() [1/5]

void clanguml::class_diagram::generators::json::generator::generate_relationships	(	const class_ &	c,
		nlohmann::json &	parent
	)		const

Generate all relationships originating at a class element.

Parameters

c	Class diagram element
parent	JSON node

Definition at line 297 of file class_diagram_generator.cc.

{
    for (const auto &r : c.relationships()) {
        auto target_element = model().get(r.destination());
        if (!target_element.has_value()) {
            LOG_DBG("Skipping {} relation from {} to {} due "
                    "to unresolved destination id",
                to_string(r.type()), c.full_name(), r.destination());
            continue;
        }
 
        nlohmann::json rel = r;
        rel["source"] = std::to_string(c.id().value());
        parent["relationships"].push_back(rel);
    }
 
    if (model().should_include(relationship_t::kExtension)) {
        for (const auto &b : c.parents()) {
            common::model::relationship r(
                relationship_t::kExtension, b.id(), b.access());
            nlohmann::json rel = r;
            rel["source"] = std::to_string(c.id().value());
            parent["relationships"].push_back(rel);
        }
    }
}

generate_relationships() [2/5]

void clanguml::class_diagram::generators::json::generator::generate_relationships	(	const concept_ &	c,
		nlohmann::json &	parent
	)		const

Generate all relationships originating at a concept element.

Parameters

c	Concept diagram element
parent	JSON node

Definition at line 343 of file class_diagram_generator.cc.

{
    for (const auto &r : c.relationships()) {
        auto target_element = model().get(r.destination());
        if (!target_element.has_value()) {
            LOG_DBG("Skipping {} relation from {} to {} due "
                    "to unresolved destination id",
                to_string(r.type()), c.full_name(), r.destination());
            continue;
        }
 
        nlohmann::json rel = r;
        rel["source"] = std::to_string(c.id().value());
        parent["relationships"].push_back(rel);
    }
}

generate_relationships() [3/5]

void clanguml::class_diagram::generators::json::generator::generate_relationships	(	const enum_ &	c,
		nlohmann::json &	parent
	)		const

Generate all relationships originating at an enum element.

Parameters

c	Enum diagram element
parent	JSON node

Definition at line 325 of file class_diagram_generator.cc.

{
    for (const auto &r : c.relationships()) {
        auto target_element = model().get(r.destination());
        if (!target_element.has_value()) {
            LOG_DBG("Skipping {} relation from {} to {} due "
                    "to unresolved destination id",
                to_string(r.type()), c.full_name(), r.destination());
            continue;
        }
 
        nlohmann::json rel = r;
        rel["source"] = std::to_string(c.id().value());
        parent["relationships"].push_back(rel);
    }
}

generate_relationships() [4/5]

void clanguml::class_diagram::generators::json::generator::generate_relationships	(	const package &	p,
		nlohmann::json &	parent
	)		const

Generate all relationships in a package.

If the diagram is nested, it recursively calls relationship generation for all subelements.

Parameters

p	Package diagram element
parent	JSON node

Definition at line 361 of file class_diagram_generator.cc.

{
    for (const auto &subpackage : p) {
        if (dynamic_cast<package *>(subpackage.get()) != nullptr) {
            const auto &sp = dynamic_cast<package &>(*subpackage);
            if (!sp.is_empty())
                generate_relationships(sp, parent);
        }
        else if (dynamic_cast<class_ *>(subpackage.get()) != nullptr) {
            if (model().should_include(*subpackage)) {
                generate_relationships(
                    dynamic_cast<class_ &>(*subpackage), parent);
            }
        }
        else if (dynamic_cast<enum_ *>(subpackage.get()) != nullptr) {
            if (model().should_include(*subpackage)) {
                generate_relationships(
                    dynamic_cast<enum_ &>(*subpackage), parent);
            }
        }
        else if (dynamic_cast<concept_ *>(subpackage.get()) != nullptr) {
            if (model().should_include(*subpackage)) {
                generate_relationships(
                    dynamic_cast<concept_ &>(*subpackage), parent);
            }
        }
    }
}

generate_relationships() [5/5]

void clanguml::class_diagram::generators::json::generator::generate_relationships

(

nlohmann::json &

parent

)

const

Generate all relationships in the diagram.

Parameters

parent

JSON node

Definition at line 279 of file class_diagram_generator.cc.

{
    for (const auto &p : model()) {
        if (auto *pkg = dynamic_cast<package *>(p.get()); pkg) {
            generate_relationships(*pkg, parent);
        }
        else if (auto *cls = dynamic_cast<class_ *>(p.get()); cls) {
            generate_relationships(*cls, parent);
        }
        else if (auto *enm = dynamic_cast<enum_ *>(p.get()); enm) {
            generate_relationships(*enm, parent);
        }
        else if (auto *cpt = dynamic_cast<concept_ *>(p.get()); cpt) {
            generate_relationships(*cpt, parent);
        }
    }
}

generate_top_level_elements()

void clanguml::class_diagram::generators::json::generator::generate_top_level_elements

(

nlohmann::json &

parent

)

const

In a nested diagram, generate the top level elements.

This method iterates over the top level elements. In case the diagram is nested (i.e. includes packages), for each package it recursively call generation of elements contained in each package.

Parameters

parent

JSON node

Definition at line 157 of file class_diagram_generator.cc.

{
    for (const auto &p : model()) {
        if (auto *pkg = dynamic_cast<package *>(p.get()); pkg) {
            if (!pkg->is_empty())
                generate(*pkg, parent);
        }
        else if (auto *cls = dynamic_cast<class_ *>(p.get()); cls) {
            generate(*cls, parent);
        }
        else if (auto *enm = dynamic_cast<enum_ *>(p.get()); enm) {
            generate(*enm, parent);
        }
        else if (auto *cpt = dynamic_cast<concept_ *>(p.get()); cpt) {
            generate(*cpt, parent);
        }
    }
}

---

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

• src/class_diagram/generators/json/class_diagram_generator.h
• src/class_diagram/generators/json/class_diagram_generator.cc