clanguml::common::generators::mermaid Namespace Reference

Classes
class	generator
	Base class for diagram generators. More...

Functions
std::string	to_mermaid (relationship_t r)
std::string	to_mermaid (access_t scope)
std::string	to_mermaid (message_t r)
std::string	indent (const unsigned level)
std::string	render_name (std::string name)
std::string	escape_name (std::string name, bool round_brackets)
template<typename DiagramModel , typename DiagramConfig >
std::ostream &	operator<< (std::ostream &os, const generator< DiagramModel, DiagramConfig > &g)

Function Documentation

escape_name()

std::string clanguml::common::generators::mermaid::escape_name	(	std::string	name,
		bool	round_brackets
	)

Definition at line 88 of file generator.cc.

{
    util::replace_all(name, "<", "&lt;");
    util::replace_all(name, ">", "&gt;");
    if (round_brackets) {
        util::replace_all(name, "(", "&lpar;");
        util::replace_all(name, ")", "&rpar;");
    }
    util::replace_all(name, "{", "&lbrace;");
    util::replace_all(name, "}", "&rbrace;");
 
    return name;
}

indent()

std::string clanguml::common::generators::mermaid::indent

(

const unsigned

level

)

Definition at line 75 of file generator.cc.

{
    const auto kIndentWidth = 4UL;
    return std::string(level * kIndentWidth, ' '); // NOLINT
}

operator<<()

template<typename DiagramModel , typename DiagramConfig >

std::ostream & clanguml::common::generators::mermaid::operator<<	(	std::ostream &	os,
		const generator< DiagramModel, DiagramConfig > &	g
	)

Definition at line 388 of file generator.h.

{
    g.generate(os);
    return os;
}

render_name()

std::string clanguml::common::generators::mermaid::render_name

(

std::string

name

)

Definition at line 81 of file generator.cc.

{
    util::replace_all(name, "##", "::");
 
    return name;
}

to_mermaid() [1/3]

std::string clanguml::common::generators::mermaid::to_mermaid

(

access_t

scope

)

Definition at line 49 of file generator.cc.

{
    switch (scope) {
    case access_t::kPublic:
        return "+";
    case access_t::kProtected:
        return "#";
    case access_t::kPrivate:
        return "-";
    default:
        return "";
    }
}

to_mermaid() [2/3]

std::string clanguml::common::generators::mermaid::to_mermaid

(

message_t

r

)

Definition at line 63 of file generator.cc.

{
    switch (r) {
    case message_t::kCall:
        return "->>";
    case message_t::kReturn:
        return "-->>";
    default:
        return "";
    }
}

to_mermaid() [3/3]

std::string clanguml::common::generators::mermaid::to_mermaid

(

relationship_t

r

)

Definition at line 22 of file generator.cc.

{
    switch (r) {
    case relationship_t::kOwnership:
    case relationship_t::kComposition:
        return "*--";
    case relationship_t::kAggregation:
        return "o--";
    case relationship_t::kContainment:
        return "()--";
    case relationship_t::kAssociation:
        return "-->";
    case relationship_t::kInstantiation:
        return "..|>";
    case relationship_t::kFriendship:
        return "<..";
    case relationship_t::kDependency:
        return "..>";
    case relationship_t::kConstraint:
        return "..>";
    case relationship_t::kAlias:
        return "..";
    default:
        return "";
    }
}