clanguml::common::generators::json::generator< ConfigType, DiagramType > Class Template Reference

Base class for diagram generators. More...

Detailed Description

template<typename ConfigType, typename DiagramType>
class clanguml::common::generators::json::generator< ConfigType, DiagramType >

Base class for diagram generators.

Template Parameters

ConfigType	Configuration type
DiagramType	Diagram model type

Definition at line 61 of file generator.h.

#include <generator.h>

Public Member Functions
	~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

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()

template<typename ConfigType , typename DiagramType >

clanguml::common::generators::json::generator< ConfigType, DiagramType >::~generator ( )

overridevirtualdefault

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

Member Function Documentation

generate()

template<typename C , typename D >

void clanguml::common::generators::json::generator< C, D >::generate ( std::ostream &  ostr ) const

overridevirtual

Generate diagram.

This is the main diagram generation entrypoint. It is responsible for calling other methods in appropriate order to generate the diagram into the output stream. It generates diagram elements, that are common to all types of diagrams in a given generator.

Parameters

ostr	Output stream

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

Definition at line 108 of file generator.h.

{
    const auto &config = generators::generator<C, D>::config();
    const auto &model = generators::generator<C, D>::model();
 
    if (!config.allow_empty_diagrams() && model.is_empty()) {
        throw clanguml::error::empty_diagram_error{model.type(), model.name(),
            "Diagram configuration resulted in empty diagram."};
    }
 
    nlohmann::json j;
    j["name"] = model.name();
    j["diagram_type"] = to_string(model.type());
    if (config.title) {
        j["title"] = config.title();
    }
 
    generate_diagram(j);
 
    generate_metadata(j);
 
    ostr << j;
}

generate_diagram()

template<typename ConfigType , typename DiagramType >

virtual void clanguml::common::generators::json::generator< ConfigType, DiagramType >::generate_diagram ( nlohmann::json &  parent ) const

pure virtual

Generate diagram model.

This method must be implemented in subclasses for specific diagram types.

Parameters

ostr	Output stream

Implemented in clanguml::class_diagram::generators::json::generator, clanguml::include_diagram::generators::json::generator, clanguml::package_diagram::generators::json::generator, and clanguml::sequence_diagram::generators::json::generator.

generate_metadata()

template<typename C , typename D >

void clanguml::common::generators::json::generator< C, D >::generate_metadata

(

nlohmann::json &

parent

)

const

Generate metadata element with diagram metadata.

Parameters

parent

Root JSON object

Definition at line 133 of file generator.h.

{
    if (generators::generator<C, D>::config().generate_metadata()) {
        parent["metadata"]["clang_uml_version"] = clanguml::version::version();
        parent["metadata"]["schema_version"] =
            clanguml::version::json_generator_schema_version();
        parent["metadata"]["llvm_version"] = clang::getClangFullVersion();
    }
}

---

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

• src/common/generators/json/generator.h