Include diagram MermaidJS generator. More...

Detailed Description

Include diagram MermaidJS 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 (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 source_file &p, std::ostream &ostr) const
	Generate relationships originating from source_file `f`

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

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 Member Functions
void	generate_with_packages (const source_file &f, std::ostream &ostr) const

void	generate_without_packages (const source_file &f, std::ostream &ostr) const

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

Definition at line 27 of file include_diagram_generator.cc.

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

Member Function Documentation

◆ generate()

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

Generate diagram element.

Parameters

e	Source file diagram element
parent	Output stream

Definition at line 62 of file include_diagram_generator.cc.

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

◆ generate_diagram()

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

{
    // Generate files and folders
    util::for_each(model(), [this, &ostr](const auto &f) {
        generate(dynamic_cast<source_file &>(*f), ostr);
    });
 
    // Process file include relationships
    util::for_each(model(), [this, &ostr](const auto &f) {
        generate_relationships(dynamic_cast<source_file &>(*f), ostr);
    });
 
    // Process file notes
    util::for_each(model(), [this, &ostr](const auto &f) {
        generate_notes(ostr, dynamic_cast<source_file &>(*f));
    });
}

◆ generate_diagram_type()

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

{
    ostr << "flowchart\n";
}

◆ generate_relationships()

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

Generate relationships originating from source_file f

Parameters

p	Diagram element
parent	Output stream

Definition at line 37 of file include_diagram_generator.cc.

{
    if (!util::contains(m_generated_aliases, f.alias()))
        return;
 
    LOG_DBG("Generating relationships for file {}", f.full_name(true));
 
    if (f.type() == common::model::source_file_t::kDirectory) {
        util::for_each(f, [this, &ostr](const auto &file) {
            generate_relationships(
                dynamic_cast<const source_file &>(*file), ostr);
        });
    }
    else {
        for (const auto &r : f.relationships()) {
            ostr << indent(1) << f.alias() << " "
                 << (r.type() == common::model::relationship_t::kDependency
                            ? "-.->"
                            : "-->")
                 << " " << model().get(r.destination()).value().alias() << '\n';
        }
    }
}

◆ generate_with_packages()

void clanguml::include_diagram::generators::mermaid::generator::generate_with_packages	(	const source_file &	f,
		std::ostream &	ostr
	)		const

private

Definition at line 72 of file include_diagram_generator.cc.

{
    if (f.type() == common::model::source_file_t::kDirectory) {
        LOG_DBG("Generating directory {}", f.name());
 
        ostr << indent(1) << "subgraph " << f.alias() << "[" << f.name()
             << "]\n";
 
        util::for_each(f, [this, &ostr](const auto &file) {
            generate(dynamic_cast<const source_file &>(*file), ostr);
        });
 
        ostr << indent(1) << "end" << '\n';
 
        m_generated_aliases.emplace(f.alias());
    }
    else {
        LOG_DBG("Generating file {}", f.name());
 
        ostr << indent(1) << f.alias() << "[" << f.name() << "]\n";
 
        m_generated_aliases.emplace(f.alias());
    }
 
    if (config().generate_links) {
        common_generator<diagram_config, diagram_model>::generate_link(ostr, f);
    }
}

◆ generate_without_packages()

void clanguml::include_diagram::generators::mermaid::generator::generate_without_packages	(	const source_file &	f,
		std::ostream &	ostr
	)		const

private

Definition at line 102 of file include_diagram_generator.cc.

{
    if (f.type() == common::model::source_file_t::kDirectory) {
        util::for_each(f, [this, &ostr](const auto &file) {
            generate(dynamic_cast<const source_file &>(*file), ostr);
        });
 
        m_generated_aliases.emplace(f.alias());
    }
    else {
        LOG_DBG("Generating file {}", f.file_relative());
 
        ostr << indent(1) << f.alias() << "[" << f.file_relative() << "]\n";
 
        m_generated_aliases.emplace(f.alias());
    }
 
    if (config().generate_links) {
        common_generator<diagram_config, diagram_model>::generate_link(ostr, f);
    }
}

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

src/include_diagram/generators/mermaid/include_diagram_generator.h
src/include_diagram/generators/mermaid/include_diagram_generator.cc

Detailed Description

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ generator()

Member Function Documentation

◆ generate()

◆ generate_diagram()

◆ generate_diagram_type()

◆ generate_relationships()

◆ generate_with_packages()

◆ generate_without_packages()