Package diagram MermaidJS generator. More...

Detailed Description

Package diagram MermaidJS generator.

Definition at line 53 of file package_diagram_generator.h.

#include <package_diagram_generator.h>

Public Member Functions
	generator (diagram_config &config, diagram_model &model)

void	generate_diagram (std::ostream &ostr) const override
	Main generator method.

void	generate_diagram_type (std::ostream &ostr) const override
	Generate the diagram type.

void	generate_relationships (const package &p, std::ostream &ostr) const
	Generate relationships originating from package `p`

void	generate (const package &e, std::ostream &ostr) const
	Generate diagram package element.

void	generate_groups (std::ostream &ostr) const
	Generate package elements grouped using `together` MermaidJS tag.

void	generate_notes (std::ostream &ostr, const common::model::diagram_element &element) const override
	Generate notes attached to packages.

Public Member Functions inherited from clanguml::common::generators::mermaid::generator< ConfigType, DiagramType >
	generator (ConfigType &config, DiagramType &model)
	Constructor.

	~generator () override=default

void	generate (std::ostream &ostr) const override
	Generate diagram.

virtual void	generate_diagram (std::ostream &ostr) const =0
	Generate diagram specific part.

void	generate_mermaid_directives (std::ostream &ostr, const std::vector< std::string > &directives) const
	Generate MermaidJS directives from config file.

virtual void	generate_diagram_type (std::ostream &ostr) const =0
	Generate the diagram type.

virtual void	generate_notes (std::ostream &ostr, const model::diagram_element &element) const
	Generate diagram notes.

void	generate_metadata (std::ostream &ostr) const
	Generate comment with diagram metadata.

void	generate_title (std::ostream &ostr) const
	Generate diagram title.

template<typename E >
void	generate_link (std::ostream &ostr, const E &e) const
	Generate hyper link to element.

void	print_debug (const common::model::source_location &e, std::ostream &ostr) const
	Print debug information in diagram comments.

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 Attributes
uint64_t	note_id_ {0UL}

common::generators::nested_element_stack< common::model::package >	together_group_stack_

Additional Inherited Members
Protected Attributes inherited from clanguml::common::generators::mermaid::generator< ConfigType, DiagramType >
std::set< std::string >	m_generated_aliases

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::mermaid::generator::generator	(	diagram_config &	config,
		diagram_model &	model
	)

Definition at line 28 of file package_diagram_generator.cc.

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

Member Function Documentation

◆ generate()

void clanguml::package_diagram::generators::mermaid::generator::generate	(	const package &	e,
		std::ostream &	ostr
	)		const

Generate diagram package element.

Parameters

p	Package diagram element
parent	Output stream

Definition at line 76 of file package_diagram_generator.cc.

{
    using clanguml::common::generators::display_name_adapter;
 
    LOG_DBG("Generating package {}", p.name());
 
    together_group_stack_.enter();
 
    const auto &uns = config().using_namespace();
 
    // Don't generate packages from namespaces filtered out by
    // using_namespace
    if (!uns.starts_with({p.full_name(false)})) {
        ostr << indent(1) << "subgraph " << p.alias() << "["
             << display_name_adapter(p).with_packages().name() << "]\n";
 
        if (p.is_deprecated())
            ostr << indent(1) << "%% <<deprecated>>\n";
    }
 
    for (const auto &subpackage : p) {
        auto &pkg = dynamic_cast<package &>(*subpackage);
        auto together_group = config().get_together_group(pkg.full_name(false));
        if (together_group) {
            together_group_stack_.group_together(together_group.value(), &pkg);
        }
        else {
            generate(pkg, ostr);
        }
    }
 
    generate_groups(ostr);
 
    if (!uns.starts_with({p.full_name(false)})) {
        ostr << indent(1) << "end" << '\n';
    }
 
    if (config().generate_links) {
        common_generator<diagram_config, diagram_model>::generate_link(ostr, p);
    }
 
    generate_notes(ostr, p);
 
    together_group_stack_.leave();
}

◆ generate_diagram()

void clanguml::package_diagram::generators::mermaid::generator::generate_diagram ( std::ostream & ostr ) const

overridevirtual

Main generator method.

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

Parameters

ostr	Output stream.

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

Definition at line 155 of file package_diagram_generator.cc.

{
    for (const auto &p : model()) {
        auto &pkg = dynamic_cast<package &>(*p);
        auto together_group = config().get_together_group(pkg.full_name(false));
        if (together_group) {
            together_group_stack_.group_together(together_group.value(), &pkg);
        }
        else {
            generate(pkg, ostr);
        }
    }
 
    generate_groups(ostr);
 
    // Process package relationships
    for (const auto &p : model()) {
        generate_relationships(dynamic_cast<package &>(*p), ostr);
    }
}

◆ generate_diagram_type()

void clanguml::package_diagram::generators::mermaid::generator::generate_diagram_type ( std::ostream & ostr ) const

overridevirtual

Generate the diagram type.

Parameters

ostr	Output stream

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

Definition at line 34 of file package_diagram_generator.cc.

{
    ostr << "flowchart\n";
}

◆ generate_groups()

void clanguml::package_diagram::generators::mermaid::generator::generate_groups ( std::ostream & ostr ) const

Generate package elements grouped using together MermaidJS tag.

Parameters

ostr	Output stream

Definition at line 122 of file package_diagram_generator.cc.

{
    for (const auto &[group_name, group_elements] :
        together_group_stack_.get_current_groups()) {
        ostr << indent(1) << "%% together group - not rendered in MermaidJS \n";
 
        for (auto *pkg : group_elements) {
            generate(*pkg, ostr);
        }
 
        ostr << indent(1) << "%% end together group\n";
    }
}

◆ generate_notes()

void clanguml::package_diagram::generators::mermaid::generator::generate_notes	(	std::ostream &	ostr,
		const common::model::diagram_element &	element
	)		const

overridevirtual

Generate notes attached to packages.

Parameters

ostr	Output stream
element	Element with a note

Reimplemented from clanguml::common::generators::mermaid::generator< ConfigType, DiagramType >.

Definition at line 136 of file package_diagram_generator.cc.

{
    const auto &config =
        common_generator<diagram_config, diagram_model>::config();
 
    for (const auto &decorator : element.decorators()) {
        auto note = std::dynamic_pointer_cast<decorators::note>(decorator);
        if (note && note->applies_to_diagram(config.name)) {
            auto note_id_str = fmt::format("N_{}", note_id_++);
 
            ostr << indent(1) << note_id_str << "(" << note->text << ")\n";
 
            ostr << indent(1) << note_id_str << "-.-" << element.alias()
                 << '\n';
        }
    }
}

◆ generate_relationships()

void clanguml::package_diagram::generators::mermaid::generator::generate_relationships	(	const package &	p,
		std::ostream &	ostr
	)		const

Generate relationships originating from package p

Parameters

p	Diagram element
parent	Output stream

Definition at line 39 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()) {
            std::stringstream relstr;
            try {
                auto destination_package = model().get(r.destination());
 
                if (!destination_package)
                    continue;
 
                auto destination_alias = model().to_alias(r.destination());
                if (!destination_alias.empty()) {
                    relstr << p.alias() << " -.-> " << destination_alias
                           << '\n';
                    ostr << indent(1) << relstr.str();
                }
            }
            catch (error::uml_alias_missing &e) {
                LOG_DBG("=== Skipping dependency relation from {} to {} due "
                        "to: {}",
                    p.full_name(false), r.destination(), e.what());
            }
        }
    }
 
    // Process it's subpackages relationships
    for (const auto &subpackage : p) {
        generate_relationships(
            dynamic_cast<const package &>(*subpackage), ostr);
    }
}

Member Data Documentation

◆ note_id_

uint64_t clanguml::package_diagram::generators::mermaid::generator::note_id_ {0UL}

mutableprivate

Definition at line 109 of file package_diagram_generator.h.

◆ together_group_stack_

common::generators::nested_element_stack<common::model::package> clanguml::package_diagram::generators::mermaid::generator::together_group_stack_

mutableprivate

Definition at line 111 of file package_diagram_generator.h.

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

src/package_diagram/generators/mermaid/package_diagram_generator.h
src/package_diagram/generators/mermaid/package_diagram_generator.cc

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ generator()

Member Function Documentation

◆ generate()

◆ generate_diagram()

◆ generate_diagram_type()

◆ generate_groups()

◆ generate_notes()

◆ generate_relationships()

Member Data Documentation

◆ note_id_

◆ together_group_stack_