clanguml::package_diagram::generators::json::generator Class Reference

Package diagram JSON generator. More...

Detailed Description

Package diagram JSON generator.

Definition at line 50 of file package_diagram_generator.h.

#include <package_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_relationships (const package &p, nlohmann::json &parent) const
	Generate relationships originating from package p
void	generate (const package &p, nlohmann::json &parent) const
	Generate diagram 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::package_diagram::generators::json::generator::generator	(	diagram_config &	config,
		diagram_model &	model
	)

Definition at line 25 of file package_diagram_generator.cc.

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

Member Function Documentation

generate()

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

Generate diagram package.

Parameters

p	Diagram package element
parent	Parent JSON node

Definition at line 57 of file package_diagram_generator.cc.

{
    LOG_DBG("Generating package {}", p.full_name(false));
 
    const auto &uns = config().using_namespace();
    if (!uns.starts_with({p.full_name(false)})) {
        nlohmann::json j;
        j["id"] = std::to_string(p.id().value());
        j["name"] = p.name();
        j["type"] = to_string(config().package_type());
        j["display_name"] = p.name();
        switch (config().package_type()) {
        case config::package_type_t::kNamespace:
            j["namespace"] = p.get_namespace().to_string();
            break;
        case config::package_type_t::kModule:
            j["namespace"] = p.get_namespace().to_string();
            break;
        case config::package_type_t::kDirectory:
            j["path"] = p.get_namespace().to_string();
            break;
        }
 
        j["is_deprecated"] = p.is_deprecated();
        if (!p.file().empty())
            j["source_location"] =
                dynamic_cast<const common::model::source_location &>(p);
        if (const auto &comment = p.comment(); comment)
            j["comment"] = comment.value();
 
        for (const auto &subpackage : p) {
            auto &pkg = dynamic_cast<package &>(*subpackage);
            generate(pkg, j);
        }
 
        parent["elements"].push_back(std::move(j));
    }
    else {
        for (const auto &subpackage : p) {
            auto &pkg = dynamic_cast<package &>(*subpackage);
            generate(pkg, parent);
        }
    }
}

generate_diagram()

void clanguml::package_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 102 of file package_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();
 
    parent["name"] = model().name();
    parent["diagram_type"] = "package";
    parent["package_type"] = to_string(config().package_type());
    parent["elements"] = std::vector<nlohmann::json>{};
    parent["relationships"] = std::vector<nlohmann::json>{};
 
    for (const auto &p : model()) {
        auto &pkg = dynamic_cast<package &>(*p);
        generate(pkg, parent);
    }
 
    // Process package relationships
    for (const auto &p : model()) {
        generate_relationships(dynamic_cast<package &>(*p), parent);
    }
}

generate_relationships()

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

Generate relationships originating from package p

Parameters

p	Diagram element
parent	JSON node

Definition at line 30 of file package_diagram_generator.cc.

{
    LOG_DBG("Generating relationships for package {}", p.full_name(true));
 
    // Generate this packages relationship
    if (model().should_include(relationship_t::kDependency)) {
        for (const auto &r : p.relationships()) {
            nlohmann::json rel = r;
 
            auto destination_package = model().get(r.destination());
 
            if (!destination_package)
                continue;
 
            rel["source"] = std::to_string(p.id().value());
            parent["relationships"].push_back(std::move(rel));
        }
    }
 
    // Process it's subpackages relationships
    for (const auto &subpackage : p) {
        generate_relationships(
            dynamic_cast<const package &>(*subpackage), parent);
    }
}

---

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

• src/package_diagram/generators/json/package_diagram_generator.h
• src/package_diagram/generators/json/package_diagram_generator.cc