Class diagram GraphML generator. More...

Detailed Description

Class diagram GraphML generator.

Definition at line 62 of file class_diagram_generator.h.

#include <class_diagram_generator.h>

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

std::vector< std::pair< std::string, common::generators::graphml::property_type > >	node_property_names () const override

void	generate (const class_ &c, graphml_node_t &parent) const

void	generate (const objc_interface &c, graphml_node_t &parent) const

void	generate (const enum_ &c, graphml_node_t &parent) const

void	generate (const concept_ &c, graphml_node_t &parent) const

void	generate (const package &p, graphml_node_t &parent) const override

void	generate_top_level_elements (graphml_node_t &parent) const override

Public Member Functions inherited from clanguml::common::generators::graphml::generator< ConfigType, DiagramType >
	~generator () override=default

virtual std::vector< std::pair< std::string, property_type > >	graph_property_names () const

virtual std::vector< std::pair< std::string, property_type > >	node_property_names () const

virtual std::vector< std::pair< std::string, property_type > >	edge_property_names () const

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

void	generate_diagram (graphml_node_t &parent) const
	Generate diagram model.

virtual void	generate_top_level_elements (graphml_node_t &parent) const =0
	In a nested diagram, generate the top level elements.

template<typename T >
void	generate_notes (const T &e, graphml_node_t &parent) const
	Generate any notes to be attached to diagram elements.

void	generate_metadata (graphml_t &parent) const
	Generate metadata element with diagram metadata.

virtual void	generate (const model::package &p, graphml_node_t &parent) const
	Generate diagram package.

virtual void	generate_relationships (graphml_node_t &parent) const
	Generate all relationships in the diagram.

virtual void	generate_relationships (const model::diagram_element &c, graphml_node_t &parent) const
	Generate all relationships originating at a diagram element.

template<typename T >
void	generate_link (pugi::xml_node &node, const T &c) const

const property_keymap_t &	graph_properties () const

const property_keymap_t &	node_properties () const

const property_keymap_t &	edge_properties () const

pugi::xml_node	make_node (graphml_node_t &parent, const std::string &id) const

pugi::xml_node	make_graph (graphml_node_t &parent, const std::string &id) const

pugi::xml_node	make_subgraph (graphml_node_t &parent, const std::string &id, const std::string &name="", const std::string &type="") const

void	add_data (pugi::xml_node &node, const std::string &key, const std::string &value, bool cdata=false) const

void	add_cdata (pugi::xml_node &node, const std::string &key, const std::string &value) const

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 Member Functions inherited from clanguml::common::generators::graphml::generator< ConfigType, DiagramType >
void	generate_key (pugi::xml_node &parent, const std::string &attr_name, const std::string &for_value, const std::string &id_value, const std::string &attr_type="string") const

property_keymap_t &	graph_properties ()

property_keymap_t &	node_properties ()

property_keymap_t &	edge_properties ()

Protected Attributes inherited from clanguml::common::generators::graphml::generator< ConfigType, DiagramType >
graphml_node_map_t	graph_ids_ {"g"}

graphml_node_map_t	node_ids_ {"n"}

graphml_node_map_t	edge_ids_ {"e"}

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

Definition at line 28 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::graphml::generator::generate	(	const class_ &	c,
		graphml_node_t &	parent
	)		const

Render class element into a GraphML node.

Parameters

c	class diagram element
parent	GraphML node

Definition at line 107 of file class_diagram_generator.cc.

{
    using namespace common::generators::graphml;
 
    std::string full_name;
    if (!config().generate_fully_qualified_name())
        full_name = display_name_adapter(c).with_packages().full_name_no_ns();
    else
        full_name = display_name_adapter(c).full_name(true);
 
    auto class_node = make_node(parent, node_ids_.add(c.alias()));
    add_data(class_node, "type", c.type_name());
    add_cdata(class_node, "name", config().simplify_template_type(full_name));
    if (c.is_abstract()) {
        add_data(class_node, "stereotype", "abstract");
    }
    else if (c.is_union()) {
        add_data(class_node, "stereotype", "union");
    }
    add_data(class_node, "is_template", to_string(c.is_template()));
 
    generate_link(class_node, c);
}

◆ generate() [2/5]

void clanguml::class_diagram::generators::graphml::generator::generate	(	const concept_ &	c,
		graphml_node_t &	parent
	)		const

Render concept element into a GraphML node.

Parameters

c	concept diagram element
parent	JSON node

Definition at line 147 of file class_diagram_generator.cc.

{
    using namespace common::generators::graphml;
 
    std::string full_name;
    if (!config().generate_fully_qualified_name())
        full_name = display_name_adapter(c).with_packages().full_name_no_ns();
    else
        full_name = display_name_adapter(c).full_name(true);
 
    auto node = make_node(parent, node_ids_.add(c.alias()));
    add_data(node, "type", c.type_name());
    add_cdata(node, "name", full_name);
    generate_link(node, c);
}

◆ generate() [3/5]

void clanguml::class_diagram::generators::graphml::generator::generate	(	const enum_ &	c,
		graphml_node_t &	parent
	)		const

Render enum element into a GraphML node.

Parameters

c	enum diagram element
parent	GraphML node

Definition at line 131 of file class_diagram_generator.cc.

{
    using namespace common::generators::graphml;
 
    std::string full_name;
    if (!config().generate_fully_qualified_name())
        full_name = display_name_adapter(e).with_packages().name();
    else
        full_name = display_name_adapter(e).full_name(true);
 
    auto node = make_node(parent, node_ids_.add(e.alias()));
    add_data(node, "type", e.type_name());
    add_cdata(node, "name", full_name);
    generate_link(node, e);
}

◆ generate() [4/5]

void clanguml::class_diagram::generators::graphml::generator::generate	(	const objc_interface &	c,
		graphml_node_t &	parent
	)		const

Render ObjC interface or protocol element into a GraphML node.

Parameters

c	enum diagram element
parent	GraphML node

Definition at line 163 of file class_diagram_generator.cc.

{
    using namespace common::generators::graphml;
 
    auto node = make_node(parent, node_ids_.add(c.alias()));
    add_data(node, "type", c.type_name());
    add_data(node, "name", display_name_adapter(c).full_name(true));
    generate_link(node, c);
}

◆ generate() [5/5]

void clanguml::class_diagram::generators::graphml::generator::generate	(	const package &	p,
		graphml_node_t &	parent
	)		const

override

Render package element into a GraphML node.

Parameters

p	package diagram element
parent	GraphML node

Definition at line 57 of file class_diagram_generator.cc.

{
    const auto &uns = config().using_namespace();
    using namespace common::generators::graphml;
 
    pugi::xml_node package_node;
    pugi::xml_node graph_node;
 
    if (config().generate_packages()) {
        // Don't generate packages from namespaces filtered out by
        // using_namespace
        if (!uns.starts_with({p.full_name(false)})) {
            auto name = display_name_adapter(p).with_packages().name();
            LOG_DBG("Generating package {}", name);
 
            package_node = make_subgraph(
                parent, p.alias(), name, to_string(config().package_type()));
            graph_node = make_graph(package_node, p.alias());
        }
    }
 
    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, graph_node);
                }
                else
                    generate(sp, parent);
            }
        }
        else {
            model().dynamic_apply(subpackage.get(), [&](auto *el) {
                if (config().generate_packages()) {
                    generate(*el, graph_node);
                }
                else
                    generate(*el, parent);
            });
        }
    }
 
    // When generating packages as subgraphs, we want to render the note nodes
    // and their relationship to their elements within the subgraph
    if (config().generate_packages()) {
        generate_notes(p, package_node);
    }
}

◆ generate_top_level_elements()

void clanguml::class_diagram::generators::graphml::generator::generate_top_level_elements ( graphml_node_t & parent ) const

override

Definition at line 43 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); });
        }
    }
}

◆ node_property_names()

std::vector< std::pair< std::string, common::generators::graphml::property_type > > clanguml::class_diagram::generators::graphml::generator::node_property_names ( ) const

overridevirtual

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

Definition at line 34 of file class_diagram_generator.cc.

{
    auto defaults =
        common_generator<diagram_config, diagram_model>::node_property_names();
    defaults.emplace_back(
        "is_template", common::generators::graphml::property_type::kBoolean);
    return defaults;
}

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

src/class_diagram/generators/graphml/class_diagram_generator.h
src/class_diagram/generators/graphml/class_diagram_generator.cc

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ generator()

Member Function Documentation

◆ generate() [1/5]

◆ generate() [2/5]

◆ generate() [3/5]

◆ generate() [4/5]

◆ generate() [5/5]

◆ generate_top_level_elements()

◆ node_property_names()