clanguml::class_diagram::model Namespace Reference

Classes
class	class_
	Diagram element representing a class or class template. More...
class	class_element
	Base class for class elements (e.g. member or method). More...
class	class_member
	Class member model. More...
class	class_method
	Class method model. More...
class	class_parent
	Class parent relationship model. More...
class	concept_
	Model of C++ concept. More...
class	diagram
	Class representing a class diagram. More...
class	enum_
class	method_parameter
	Model of a method parameter. More...

Typedefs
using	nested_trait_ns = clanguml::common::model::nested_trait< clanguml::common::model::element, clanguml::common::model::namespace_ >

Functions
void	set_module (nlohmann::json &j, const common::model::element &e)
void	to_json (nlohmann::json &j, const class_element &c)
void	to_json (nlohmann::json &j, const class_member &c)
void	to_json (nlohmann::json &j, const method_parameter &c)
void	to_json (nlohmann::json &j, const class_method &c)
void	to_json (nlohmann::json &j, const class_parent &c)
void	to_json (nlohmann::json &j, const class_ &c)
void	to_json (nlohmann::json &j, const enum_ &c)
void	to_json (nlohmann::json &j, const concept_ &c)
bool	operator== (const class_ &l, const class_ &r)
bool	operator== (const concept_ &l, const concept_ &r)
template<>
bool	diagram::add_with_namespace_path< common::model::package > (std::unique_ptr< common::model::package > &&p)
template<>
bool	diagram::add_with_filesystem_path< common::model::package > (const common::model::path &, std::unique_ptr< common::model::package > &&p)
template<>
bool	diagram::add_with_module_path< common::model::package > (const common::model::path &, std::unique_ptr< common::model::package > &&p)
template<>
bool	diagram::add_with_namespace_path< common::model::package > (std::unique_ptr< common::model::package > &&p)
template<>
bool	diagram::add_with_module_path< common::model::package > (const common::model::path &parent_path, std::unique_ptr< common::model::package > &&p)
template<>
bool	diagram::add_with_filesystem_path< common::model::package > (const common::model::path &parent_path, std::unique_ptr< common::model::package > &&p)
bool	operator== (const enum_ &l, const enum_ &r)

Typedef Documentation

nested_trait_ns

using clanguml::class_diagram::model::nested_trait_ns = typedef clanguml::common::model::nested_trait<clanguml::common::model::element, clanguml::common::model::namespace_>

Definition at line 44 of file diagram.h.

Function Documentation

diagram::add_with_filesystem_path< common::model::package >() [1/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_filesystem_path< common::model::package >	(	const common::model::path &	parent_path,
		std::unique_ptr< common::model::package > &&	p
	)

Definition at line 108 of file diagram.cc.

{
    LOG_DBG("Adding filesystem package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

diagram::add_with_filesystem_path< common::model::package >() [2/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_filesystem_path< common::model::package >	(	const common::model::path &	parent_path,
		std::unique_ptr< common::model::package > &&	p
	)

Definition at line 108 of file diagram.cc.

{
    LOG_DBG("Adding filesystem package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

diagram::add_with_module_path< common::model::package >() [1/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_module_path< common::model::package >	(	const common::model::path &	parent_path,
		std::unique_ptr< common::model::package > &&	p
	)

Definition at line 120 of file diagram.cc.

{
    LOG_DBG("Adding module package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

diagram::add_with_module_path< common::model::package >() [2/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_module_path< common::model::package >	(	const common::model::path &	parent_path,
		std::unique_ptr< common::model::package > &&	p
	)

Definition at line 120 of file diagram.cc.

{
    LOG_DBG("Adding module package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

diagram::add_with_namespace_path< common::model::package >() [1/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_namespace_path< common::model::package >

(

std::unique_ptr< common::model::package > &&

p

)

Definition at line 97 of file diagram.cc.

{
    LOG_DBG("Adding namespace package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

diagram::add_with_namespace_path< common::model::package >() [2/2]

template<>

bool clanguml::class_diagram::model::diagram::add_with_namespace_path< common::model::package >

(

std::unique_ptr< common::model::package > &&

p

)

Definition at line 97 of file diagram.cc.

{
    LOG_DBG("Adding namespace package: {}, {}", p->name(), p->full_name(true));
 
    auto ns = p->get_relative_namespace();
 
    return add_element(ns, std::move(p));
}

operator==() [1/3]

bool clanguml::class_diagram::model::operator==	(	const class_ &	l,
		const class_ &	r
	)

Definition at line 69 of file class.cc.

{ return l.id() == r.id(); }

operator==() [2/3]

bool clanguml::class_diagram::model::operator==	(	const concept_ &	l,
		const concept_ &	r
	)

Definition at line 31 of file concept.cc.

{
    return l.id() == r.id();
}

operator==() [3/3]

bool clanguml::class_diagram::model::operator==	(	const enum_ &	l,
		const enum_ &	r
	)

Definition at line 32 of file enum.cc.

{
    return (l.get_namespace() == r.get_namespace()) && (l.name() == r.name());
}

set_module()

void clanguml::class_diagram::model::set_module	(	nlohmann::json &	j,
		const common::model::element &	e
	)

Definition at line 26 of file class_diagram_generator.cc.

{
    if (const auto &maybe_module = e.module(); maybe_module) {
        j["module"]["name"] = *maybe_module;
        j["module"]["is_private"] = e.module_private();
    }
}

to_json() [1/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const class_ &	c
	)

Definition at line 94 of file class_diagram_generator.cc.

{
    j = dynamic_cast<const common::model::element &>(c);
    j["is_struct"] = c.is_struct();
    j["is_abstract"] = c.is_abstract();
    j["is_union"] = c.is_union();
    j["is_nested"] = c.is_nested();
    j["is_template"] = c.is_template();
 
    j["members"] = c.members();
    j["methods"] = c.methods();
    j["bases"] = c.parents();
 
    set_module(j, c);
 
    j["template_parameters"] = c.template_params();
}

to_json() [2/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const class_element &	c
	)

Definition at line 34 of file class_diagram_generator.cc.

{
    j["name"] = c.name();
    j["type"] = common::generators::json::render_name(c.type());
    if (c.access() != common::model::access_t::kNone)
        j["access"] = to_string(c.access());
    if (!c.file().empty())
        j["source_location"] =
            dynamic_cast<const common::model::source_location &>(c);
    if (const auto &comment = c.comment(); comment)
        j["comment"] = comment.value();
}

to_json() [3/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const class_member &	c
	)

Definition at line 47 of file class_diagram_generator.cc.

{
    j = dynamic_cast<const class_element &>(c);
    j["is_static"] = c.is_static();
}

to_json() [4/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const class_method &	c
	)

Definition at line 61 of file class_diagram_generator.cc.

{
    j = dynamic_cast<const class_element &>(c);
 
    j["is_pure_virtual"] = c.is_pure_virtual();
    j["is_virtual"] = c.is_virtual();
    j["is_const"] = c.is_const();
    j["is_defaulted"] = c.is_defaulted();
    j["is_deleted"] = c.is_deleted();
    j["is_static"] = c.is_static();
    j["is_noexcept"] = c.is_noexcept();
    j["is_constexpr"] = c.is_constexpr();
    j["is_consteval"] = c.is_consteval();
    j["is_coroutine"] = c.is_coroutine();
    j["is_constructor"] = c.is_constructor();
    j["is_move_assignment"] = c.is_move_assignment();
    j["is_copy_assignment"] = c.is_copy_assignment();
    j["is_operator"] = c.is_operator();
    j["template_parameters"] = c.template_params();
    j["display_name"] = c.display_name();
 
    j["parameters"] = c.parameters();
}

to_json() [5/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const class_parent &	c
	)

Definition at line 85 of file class_diagram_generator.cc.

{
    j["is_virtual"] = c.is_virtual();
    j["id"] = std::to_string(c.id().value());
    if (c.access() != common::model::access_t::kNone)
        j["access"] = to_string(c.access());
    j["name"] = c.name();
}

to_json() [6/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const concept_ &	c
	)

Definition at line 121 of file class_diagram_generator.cc.

{
    j = dynamic_cast<const common::model::element &>(c);
    j["parameters"] = c.requires_parameters();
    j["statements"] = c.requires_statements();
 
    set_module(j, c);
}

to_json() [7/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const enum_ &	c
	)

Definition at line 112 of file class_diagram_generator.cc.

{
    j = dynamic_cast<const common::model::element &>(c);
    j["is_nested"] = c.is_nested();
    j["constants"] = c.constants();
 
    set_module(j, c);
}

to_json() [8/8]

void clanguml::class_diagram::model::to_json	(	nlohmann::json &	j,
		const method_parameter &	c
	)

Definition at line 53 of file class_diagram_generator.cc.

{
    j["name"] = c.name();
    j["type"] = c.type();
    if (!c.default_value().empty())
        j["default_value"] = c.default_value();
}