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

Class diagram JSON generator. More...

Detailed Description

Class diagram JSON generator.

Definition at line 63 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 objc_interface &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.
template<typename T >
void	generate_relationships (const T &c, nlohmann::json &parent) const
	Generate all relationships originating at a diagram element.
template<>
void	generate_relationships (const package &p, nlohmann::json &parent) const
template<>
void	generate_relationships (const package &p, nlohmann::json &parent) const
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.
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
std::optional< std::string >	render_link (const common::model::diagram_element &e) const
std::optional< std::string >	render_link (const common::model::relationship &e) const
std::optional< std::string >	render_tooltip (const common::model::diagram_element &e) const
std::optional< std::string >	render_tooltip (const common::model::relationship &e) 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 179 of file class_diagram_generator.cc.

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

Member Function Documentation

generate() [1/5]

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 260 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"] =
            display_name_adapter(c).with_packages().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"));
        }
    }
 
    parent["elements"].push_back(std::move(object));
}

generate() [2/5]

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 296 of file class_diagram_generator.cc.

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

generate() [3/5]

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 286 of file class_diagram_generator.cc.

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

generate() [4/5]

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

Render ObjC interface or protocol element into a JSON node.

Parameters

c	enum diagram element
parent	JSON node

Definition at line 306 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"] = display_name_adapter(c).full_name_no_ns();
 
    object["display_name"] =
        config().simplify_template_type(object["display_name"]);
 
    parent["elements"].push_back(std::move(object));
}

generate() [5/5]

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 216 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"] =
                display_name_adapter(p).with_packages().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 {
            model().dynamic_apply(subpackage.get(), [&](auto *el) {
                if (config().generate_packages())
                    generate(*el, package_object);
                else
                    generate(*el, 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 184 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/4]

template<>

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

Definition at line 334 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 {
            model().dynamic_apply(subpackage.get(), [&](auto *el) {
                if (model().should_include(*el)) {
                    generate_relationships(*el, parent);
                }
            });
        }
    }
}

generate_relationships() [2/4]

template<>

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

generate_relationships() [3/4]

template<typename T >

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

Generate all relationships originating at a diagram element.

Template Parameters

T	Type of diagram element

Parameters

c	Diagram diagram element
parent	JSON node

Definition at line 149 of file class_diagram_generator.h.

{
    const auto &model =
        common_generator<diagram_config, diagram_model>::model();
 
    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(true),
                r.destination().value());
            continue;
        }
 
        nlohmann::json rel = r;
        rel["source"] = std::to_string(c.id().value());
        parent["relationships"].push_back(rel);
    }
}

generate_relationships() [4/4]

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 320 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 {
            model().dynamic_apply(p.get(),
                [&](auto *el) { generate_relationships(*el, 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 202 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 {
            model().dynamic_apply(
                p.get(), [&](auto *el) { generate(*el, 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