clanguml::include_diagram::generators::json::generator Class Reference

Include diagram JSON generator. More...

Detailed Description

Include diagram JSON generator.

Definition at line 51 of file include_diagram_generator.h.

#include <include_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 source_file &f, nlohmann::json &parent) const
	Generate relationships originating from source_file f
void	generate (const source_file &e, nlohmann::json &parent) const
	Generate diagram element.
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

Private Member Functions
void	generate_with_packages (const source_file &f, nlohmann::json &parent) const
void	generate_without_packages (const source_file &f, nlohmann::json &parent) 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::include_diagram::generators::json::generator::generator	(	diagram_config &	config,
		diagram_model &	model
	)

Definition at line 25 of file include_diagram_generator.cc.

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

Member Function Documentation

generate()

void clanguml::include_diagram::generators::json::generator::generate	(	const source_file &	e,
		nlohmann::json &	parent
	)		const

Generate diagram element.

Parameters

e	Source file diagram element
parent	Parent JSON node

Definition at line 50 of file include_diagram_generator.cc.

{
    if (config().generate_packages && !config().generate_packages()) {
        generate_without_packages(f, parent);
    }
    else {
        generate_with_packages(f, parent);
    }
}

generate_diagram()

void clanguml::include_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 126 of file include_diagram_generator.cc.

{
    parent["elements"] = std::vector<nlohmann::json>{};
    parent["relationships"] = std::vector<nlohmann::json>{};
 
    // Generate files and folders
    util::for_each(model(), [this, &parent](const auto &f) {
        generate(dynamic_cast<source_file &>(*f), parent);
    });
 
    // Process file include relationships
    util::for_each(model(), [this, &parent](const auto &f) {
        generate_relationships(dynamic_cast<source_file &>(*f), parent);
    });
}

generate_relationships()

void clanguml::include_diagram::generators::json::generator::generate_relationships	(	const source_file &	f,
		nlohmann::json &	parent
	)		const

Generate relationships originating from source_file f

Parameters

p	Diagram element
parent	JSON node

Definition at line 30 of file include_diagram_generator.cc.

{
    LOG_DBG("Generating relationships for file {}", f.full_name(true));
 
    if (f.type() == common::model::source_file_t::kDirectory) {
        util::for_each(f, [this, &parent](const auto &file) {
            generate_relationships(
                dynamic_cast<const source_file &>(*file), parent);
        });
    }
    else {
        for (const auto &r : f.relationships()) {
            nlohmann::json rel = r;
            rel["source"] = std::to_string(f.id().value());
            parent["relationships"].push_back(std::move(rel));
        }
    }
}

generate_with_packages()

void clanguml::include_diagram::generators::json::generator::generate_with_packages ( const source_file &  f, nlohmann::json &  parent  ) const

private

Definition at line 60 of file include_diagram_generator.cc.

{
    nlohmann::json j;
    j["id"] = std::to_string(f.id().value());
    j["name"] = f.name();
    auto display_name = f.full_name(false);
#if defined(_MSC_VER)
    util::replace_all(display_name, "\\", "/");
#endif
    j["display_name"] = std::move(display_name);
 
    if (f.type() == common::model::source_file_t::kDirectory) {
        LOG_DBG("Generating directory {}", f.name());
 
        j["type"] = "folder";
 
        util::for_each(f, [this, &j](const auto &file) {
            generate(dynamic_cast<const source_file &>(*file), j);
        });
 
        parent["elements"].push_back(std::move(j));
    }
    else {
        LOG_DBG("Generating file {}", f.name());
 
        j["type"] = "file";
        j["file_kind"] = to_string(f.type());
        if (f.type() == common::model::source_file_t::kHeader) {
            j["is_system"] = f.is_system_header();
        }
 
        parent["elements"].push_back(std::move(j));
    }
}

generate_without_packages()

void clanguml::include_diagram::generators::json::generator::generate_without_packages ( const source_file &  f, nlohmann::json &  parent  ) const

private

Definition at line 96 of file include_diagram_generator.cc.

{
    nlohmann::json j;
    j["id"] = std::to_string(f.id().value());
    j["name"] = f.file_relative();
    auto display_name = f.full_name(false);
#if defined(_MSC_VER)
    util::replace_all(display_name, "\\", "/");
#endif
    j["display_name"] = std::move(display_name);
 
    if (f.type() == common::model::source_file_t::kDirectory) {
        util::for_each(f, [this, &parent](const auto &file) {
            generate(dynamic_cast<const source_file &>(*file), parent);
        });
    }
    else {
        LOG_DBG("Generating file {}", f.file_relative());
 
        j["type"] = "file";
        j["file_kind"] = to_string(f.type());
        if (f.type() == common::model::source_file_t::kHeader) {
            j["is_system"] = f.is_system_header();
        }
 
        parent["elements"].push_back(std::move(j));
    }
}

---

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

• src/include_diagram/generators/json/include_diagram_generator.h
• src/include_diagram/generators/json/include_diagram_generator.cc