clanguml::common::jinja Namespace Reference

Classes
class	jinja_context
	Jinja diagram element context wrapper. More...

Typedefs
template<typename T >
using	element_context = jinja_context< T, element_context_tag >
template<typename T >
using	diagram_context = jinja_context< T, diagram_context_tag >

Functions
void	to_json (inja::json &ctx, const element_context< class_diagram::model::class_element > &d)
void	to_json (inja::json &ctx, const diagram_context< class_diagram::model::diagram > &d)
void	to_json (inja::json &ctx, const element_context< common::model::decorated_element > &jc)
void	to_json (inja::json &ctx, const element_context< diagram_element > &jc)
void	to_json (inja::json &ctx, const element_context< element > &jc)
void	to_json (inja::json &ctx, const element_context< common::model::relationship > &jc)
void	to_json (inja::json &ctx, const element_context< source_file > &jc)
void	to_json (inja::json &ctx, const diagram_context< source_location > &jc)
void	to_json (inja::json &ctx, const element_context< source_location > &jc)
void	to_json (inja::json &ctx, const diagram_context< common::model::decorated_element > &jc)
void	to_json (inja::json &ctx, const diagram_context< common::model::diagram_element > &jc)
void	to_json (inja::json &ctx, const diagram_context< common::model::element > &jc)
void	to_json (inja::json &ctx, const diagram_context< source_file > &jc)
std::optional< std::string >	render_template (inja::Environment &env, const inja::json &context, const std::string &jinja_template)
std::optional< std::string >	render_template (inja::Environment &env, const std::string &jinja_template)
void	to_json (inja::json &ctx, const element_context< common::model::diagram_element > &jc)
void	to_json (inja::json &ctx, const element_context< common::model::element > &jc)
void	to_json (inja::json &ctx, const element_context< common::model::source_file > &jc)
void	to_json (inja::json &ctx, const element_context< common::model::source_location > &jc)
void	to_json (inja::json &ctx, const diagram_context< common::model::source_file > &jc)
void	to_json (inja::json &ctx, const diagram_context< common::model::source_location > &jc)
void	to_json (inja::json &ctx, const diagram_context< include_diagram::model::diagram > &d)
void	to_json (inja::json &ctx, const diagram_context< package_diagram::model::diagram > &d)
void	to_json (inja::json &ctx, const diagram_context< sequence_diagram::model::diagram > &d)

Typedef Documentation

diagram_context

template<typename T >

using clanguml::common::jinja::diagram_context = typedef jinja_context<T, diagram_context_tag>

Definition at line 75 of file jinja_context.h.

element_context

template<typename T >

using clanguml::common::jinja::element_context = typedef jinja_context<T, element_context_tag>

Definition at line 73 of file jinja_context.h.

Function Documentation

render_template() [1/2]

std::optional< std::string > clanguml::common::jinja::render_template	(	inja::Environment &	env,
		const inja::json &	context,
		const std::string &	jinja_template
	)

Definition at line 209 of file jinja_context.cc.

{
    std::optional<std::string> result;
 
    if (jinja_template.empty())
        return result;
 
    try {
        // Render the directive with template engine first
        auto rendered_template =
            env.render(std::string_view{jinja_template}, context);
 
        result = std::move(rendered_template);
    }
    catch (const clanguml::error::uml_alias_missing &e) {
        LOG_WARN("Failed to render Jinja template '{}' due to unresolvable "
                 "alias: {}",
            jinja_template, e.what());
    }
    catch (const inja::json::parse_error &e) {
        LOG_WARN("Failed to parse Jinja template: {}", jinja_template);
    }
    catch (const inja::json::exception &e) {
        LOG_WARN("Failed to render Jinja template: \n{}\n due to: {}",
            jinja_template, e.what());
    }
    catch (const std::regex_error &e) {
        LOG_WARN("Failed to render Jinja template: \n{}\n due to "
                 "std::regex_error: {}",
            jinja_template, e.what());
    }
    catch (const std::exception &e) {
        LOG_WARN("Failed to render Jinja template: \n{}\n due to: {}",
            jinja_template, e.what());
    }
 
    return result;
}

render_template() [2/2]

std::optional< std::string > clanguml::common::jinja::render_template	(	inja::Environment &	env,
		const std::string &	jinja_template
	)

Definition at line 249 of file jinja_context.cc.

{
    inja::json empty;
    return render_template(env, empty, jinja_template);
}

to_json() [1/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< class_diagram::model::diagram > &	d
	)

Definition at line 49 of file jinja_context.cc.

{
    using namespace class_diagram::model;
 
    ctx["name"] = d.get().name();
    ctx["type"] = "class";
 
    inja::json::array_t elements{};
 
    d.get().view<class_>().for_each([&](auto &&e) mutable {
        elements.emplace_back(diagram_context<element>(e));
    });
 
    d.get().view<enum_>().for_each([&](auto &&e) mutable {
        elements.emplace_back(diagram_context<element>(e));
    });
 
    d.get().view<concept_>().for_each([&](auto &&e) mutable {
        elements.emplace_back(diagram_context<element>(e));
    });
 
    d.get().view<objc_interface>().for_each([&](auto &&e) mutable {
        elements.emplace_back(diagram_context<element>(e));
    });
 
    ctx["elements"] = elements;
}

to_json() [2/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< common::model::decorated_element > &	jc
	)

Definition at line 163 of file jinja_context.cc.

{
    if (const auto maybe_comment = jc.get().comment();
        maybe_comment.has_value()) {
        ctx["comment"] = maybe_comment.value();
    }
}

to_json() [3/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< common::model::diagram_element > &	jc
	)

Definition at line 172 of file jinja_context.cc.

{
    to_json(ctx, jc.as<decorated_element>());
 
    ctx["name"] = display_name_adapter(jc.get()).name();
    ctx["type"] = jc.get().type_name();
    ctx["alias"] = jc.get().alias();
    ctx["full_name"] = display_name_adapter(jc.get()).full_name(false);
    auto maybe_doxygen_link = jc.get().doxygen_link();
    if (maybe_doxygen_link)
        ctx["doxygen_link"] = maybe_doxygen_link.value();
 
    to_json(ctx, jc.as<source_location>());
}

to_json() [4/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< common::model::element > &	jc
	)

Definition at line 188 of file jinja_context.cc.

{
    to_json(ctx, jc.as<diagram_element>());
 
    ctx["using_namespace"] = jc.get().using_namespace().to_string();
    ctx["namespace"] = jc.get().get_namespace().to_string();
    if (const auto maybe_comment = jc.get().comment();
        maybe_comment.has_value()) {
        ctx["comment"] = maybe_comment.value();
    }
}

to_json() [5/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< common::model::source_file > &	jc
	)

to_json() [6/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< common::model::source_location > &	jc
	)

to_json() [7/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< include_diagram::model::diagram > &	d
	)

Definition at line 23 of file jinja_context.cc.

{
    ctx["name"] = d.get().name();
    ctx["type"] = "include";
 
    inja::json::array_t elements{};
 
    d.get().view<common::model::source_file>().for_each(
        [&](auto &&element) mutable {
            elements.emplace_back(
                diagram_context<common::model::source_file>(element));
        });
 
    ctx["elements"] = elements;
}

to_json() [8/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< package_diagram::model::diagram > &	d
	)

Definition at line 25 of file jinja_context.cc.

{
    ctx["name"] = d.get().name();
    ctx["type"] = "package";
 
    inja::json::array_t elements{};
 
    d.get().view<package>().for_each([&](auto &&e) mutable {
        elements.emplace_back(diagram_context<element>(e));
    });
 
    ctx["elements"] = elements;
}

to_json() [9/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< sequence_diagram::model::diagram > &	d
	)

Definition at line 25 of file jinja_context.cc.

{
    ctx["name"] = d.get().name();
    ctx["type"] = "sequence";
 
    inja::json::array_t elements{};
 
    for (const auto &[id, p] : d.get().participants()) {
        elements.emplace_back(diagram_context<element>(*p));
    }
 
    ctx["elements"] = elements;
}

to_json() [10/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< source_file > &	jc
	)

Definition at line 200 of file jinja_context.cc.

{
    to_json(ctx, jc.as<diagram_element>());
 
    std::filesystem::path fullNamePath{ctx["full_name"].get<std::string>()};
    fullNamePath.make_preferred();
    ctx["full_name"] = fullNamePath.string();
}

to_json() [11/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const diagram_context< source_location > &	jc
	)

Definition at line 96 of file jinja_context.cc.

{
    const auto &e = jc.get();
 
    if (!e.file().empty()) {
        const std::filesystem::path file{e.file()};
        std::string git_relative_path = file.string();
        if (!e.file_relative().empty()) {
#if _MSC_VER
            if (file.is_absolute() && ctx.contains("git")) {
#else
            if (file.is_absolute() && ctx.contains("git")) {
#endif
                git_relative_path =
                    std::filesystem::relative(file, ctx["git"]["toplevel"])
                        .string();
                ctx["source"]["path"] = util::path_to_url(git_relative_path);
            }
            else {
                ctx["source"]["path"] = e.file();
            }
        }
        else {
            git_relative_path = "";
            ctx["source"]["path"] = e.file();
        }
 
        ctx["source"]["full_path"] = file.string();
        ctx["source"]["name"] = file.filename().string();
        ctx["source"]["line"] = e.line();
    }
}

to_json() [12/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< class_diagram::model::class_element > &	d
	)

Definition at line 29 of file jinja_context.cc.

{
    to_json(ctx, d.as<decorated_element>());
 
    ctx["element"]["name"] = display_name_adapter(d.get()).name();
    ctx["element"]["type"] = display_name_adapter(d.get()).type();
    ctx["element"]["access"] = to_string(d.get().access());
 
    if (d.diagram_context().contains("git")) {
        ctx["git"] = d.diagram_context()["git"];
    }
 
    if (d.diagram_context().contains("user_data")) {
        ctx["user_data"] = d.diagram_context()["user_data"];
    }
 
    to_json(ctx, d.as<source_location>());
}

to_json() [13/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::decorated_element > &	jc
	)

Definition at line 29 of file jinja_context.cc.

{
    if (const auto maybe_comment = jc.get().comment();
        maybe_comment.has_value()) {
        ctx["element"]["comment"] = maybe_comment.value();
    }
 
    if (jc.diagram_context().contains("git")) {
        ctx["git"] = jc.diagram_context()["git"];
    }
 
    if (jc.diagram_context().contains("user_data")) {
        ctx["user_data"] = jc.diagram_context()["user_data"];
    }
}

to_json() [14/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::diagram_element > &	jc
	)

to_json() [15/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::element > &	jc
	)

to_json() [16/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::relationship > &	jc
	)

Definition at line 70 of file jinja_context.cc.

{
    to_json(ctx, jc.as<decorated_element>());
 
    ctx["element"]["type"] = "relationship";
    ctx["element"]["name"] = jc.get().label();
    ctx["element"]["relationship_type"] = to_string(jc.get().type());
    ctx["element"]["multiplicity"]["source"] = jc.get().multiplicity_source();
    ctx["element"]["multiplicity"]["destination"] =
        jc.get().multiplicity_destination();
    ctx["element"]["access"] = to_string(jc.get().access());
 
    to_json(ctx, jc.as<source_location>());
}

to_json() [17/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::source_file > &	jc
	)

to_json() [18/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< common::model::source_location > &	jc
	)

to_json() [19/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< diagram_element > &	jc
	)

Definition at line 46 of file jinja_context.cc.

{
    to_json(ctx, jc.as<decorated_element>());
 
    ctx["element"]["name"] = display_name_adapter(jc.get()).name();
    ctx["element"]["type"] = jc.get().type_name();
    ctx["element"]["alias"] = jc.get().alias();
    ctx["element"]["full_name"] =
        display_name_adapter(jc.get()).full_name(false);
    auto maybe_doxygen_link = jc.get().doxygen_link();
    if (maybe_doxygen_link)
        ctx["element"]["doxygen_link"] = maybe_doxygen_link.value();
 
    to_json(ctx, jc.as<source_location>());
}

to_json() [20/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< element > &	jc
	)

Definition at line 62 of file jinja_context.cc.

{
    to_json(ctx, jc.as<diagram_element>());
 
    ctx["element"]["using_namespace"] = jc.get().using_namespace().to_string();
    ctx["element"]["namespace"] = jc.get().get_namespace().to_string();
}

to_json() [21/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< source_file > &	jc
	)

Definition at line 86 of file jinja_context.cc.

{
    to_json(ctx, jc.as<diagram_element>());
 
    std::filesystem::path fullNamePath{
        ctx["element"]["full_name"].get<std::string>()};
    fullNamePath.make_preferred();
    ctx["element"]["full_name"] = fullNamePath.string();
}

to_json() [22/22]

void clanguml::common::jinja::to_json	(	inja::json &	ctx,
		const element_context< source_location > &	jc
	)

Definition at line 129 of file jinja_context.cc.

{
    const auto &e = jc.get();
 
    if (!e.file().empty()) {
        const std::filesystem::path file{e.file()};
        std::string git_relative_path = file.string();
        if (!e.file_relative().empty()) {
#if _MSC_VER
            if (file.is_absolute() && ctx.contains("git")) {
#else
            if (file.is_absolute() && ctx.contains("git")) {
#endif
                git_relative_path =
                    std::filesystem::relative(file, ctx["git"]["toplevel"])
                        .string();
                ctx["element"]["source"]["path"] =
                    util::path_to_url(git_relative_path);
            }
            else {
                ctx["element"]["source"]["path"] = e.file();
            }
        }
        else {
            git_relative_path = "";
            ctx["element"]["source"]["path"] = e.file();
        }
 
        ctx["element"]["source"]["full_path"] = file.string();
        ctx["element"]["source"]["name"] = file.filename().string();
        ctx["element"]["source"]["line"] = e.line();
    }
}