YAML serialization emitters

Detailed Description

Overloads for YAML serializations for various config types.

Overloads for YAML serializations for various model types.

Functions
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const config &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const inheritable_diagram_options &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const filter &f)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const plantuml &p)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const method_arguments &ma)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const generate_links_config &glc)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const git_config &gc)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const relationship_hint_t &rh)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const comment_parser_t &cp)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const hint_t &h)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const class_diagram &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const sequence_diagram &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const include_diagram &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const package_diagram &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const layout_hint &c)
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const source_location &sc)
template<typename T >
YAML::Emitter &	clanguml::config::operator<< (YAML::Emitter &out, const option< T > &o)
YAML::Emitter &	clanguml::common::model::operator<< (YAML::Emitter &out, const namespace_ &n)
YAML::Emitter &	clanguml::common::model::operator<< (YAML::Emitter &out, const relationship_t &r)
YAML::Emitter &	clanguml::common::model::operator<< (YAML::Emitter &out, const access_t &r)
YAML::Emitter &	clanguml::common::model::operator<< (YAML::Emitter &out, const diagram_t &d)

Function Documentation

operator<<() [1/21]

YAML::Emitter & clanguml::common::model::operator<<	(	YAML::Emitter &	out,
		const access_t &	r
	)

Definition at line 66 of file yaml_emitters.cc.

{
    out << to_string(a);
    return out;
}

operator<<() [2/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const class_diagram &	c
	)

Definition at line 373 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "type" << YAML::Value << c.type();
    out << c.layout;
    out << dynamic_cast<const inheritable_diagram_options &>(c);
    out << YAML::EndMap;
    return out;
}

operator<<() [3/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const comment_parser_t &	cp
	)

Definition at line 224 of file yaml_emitters.cc.

{
    out << to_string(cp);
    return out;
}

operator<<() [4/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const config &	c
	)

Definition at line 271 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
 
    out << c.compilation_database_dir;
    out << c.output_directory;
    out << c.query_driver;
    out << c.add_compile_flags;
    out << c.remove_compile_flags;
 
    out << dynamic_cast<const inheritable_diagram_options &>(c);
 
    out << YAML::Key << "diagrams";
    out << YAML::BeginMap;
 
    for (const auto &[k, v] : c.diagrams) {
        out << YAML::Key << k;
        if (v->type() == common::model::diagram_t::kClass) {
            out << YAML::Value << dynamic_cast<class_diagram &>(*v);
        }
        else if (v->type() == common::model::diagram_t::kSequence) {
            out << YAML::Value << dynamic_cast<sequence_diagram &>(*v);
        }
        else if (v->type() == common::model::diagram_t::kInclude) {
            out << YAML::Value << dynamic_cast<include_diagram &>(*v);
        }
        else if (v->type() == common::model::diagram_t::kPackage) {
            out << YAML::Value << dynamic_cast<package_diagram &>(*v);
        }
    }
 
    out << YAML::EndMap;
    out << YAML::EndMap;
    return out;
}

operator<<() [5/21]

YAML::Emitter & clanguml::common::model::operator<<	(	YAML::Emitter &	out,
		const diagram_t &	d
	)

Definition at line 78 of file yaml_emitters.cc.

{
    out << to_string(d);
    return out;
}

operator<<() [6/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const filter &	f
	)

Definition at line 126 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    if (!f.namespaces.empty())
        out << YAML::Key << "namespaces" << YAML::Value << f.namespaces;
    if (!f.modules.empty())
        out << YAML::Key << "modules" << YAML::Value << f.modules;
    if (!f.module_access.empty())
        out << YAML::Key << "module_access" << YAML::Value << f.module_access;
    if (!f.access.empty())
        out << YAML::Key << "access" << YAML::Value << f.access;
    if (!f.context.empty())
        out << YAML::Key << "context" << YAML::Value << f.context;
    if (!f.dependants.empty())
        out << YAML::Key << "dependants" << YAML::Value << f.dependants;
    if (!f.dependencies.empty())
        out << YAML::Key << "dependencies" << YAML::Value << f.dependencies;
    if (!f.elements.empty())
        out << YAML::Key << "elements" << YAML::Value << f.elements;
    if (!f.element_types.empty())
        out << YAML::Key << "element_types" << YAML::Value << f.element_types;
    if (!f.method_types.empty())
        out << YAML::Key << "method_types" << YAML::Value << f.method_types;
    if (!f.paths.empty())
        out << YAML::Key << "paths" << YAML::Value << f.paths;
    if (!f.relationships.empty())
        out << YAML::Key << "relationships" << YAML::Value << f.relationships;
    if (!f.specializations.empty())
        out << YAML::Key << "specializations" << YAML::Value
            << f.specializations;
    if (!f.subclasses.empty())
        out << YAML::Key << "subclasses" << YAML::Value << f.subclasses;
    if (!f.parents.empty())
        out << YAML::Key << "parents" << YAML::Value << f.parents;
    if (!f.method_types.empty())
        out << YAML::Key << "callee_types" << YAML::Value << f.callee_types;
    out << YAML::EndMap;
    return out;
}

operator<<() [7/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const generate_links_config &	glc
	)

Definition at line 187 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "link" << YAML::Value << glc.link;
    out << YAML::Key << "tooltip" << YAML::Value << glc.tooltip;
    out << YAML::EndMap;
    return out;
}

operator<<() [8/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const git_config &	gc
	)

Definition at line 196 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "branch" << YAML::Value << gc.branch;
    out << YAML::Key << "revision" << YAML::Value << gc.revision;
    out << YAML::Key << "commit" << YAML::Value << gc.commit;
    out << YAML::Key << "toplevel" << YAML::Value << gc.toplevel;
    out << YAML::EndMap;
 
    return out;
}

operator<<() [9/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const hint_t &	h
	)

Definition at line 218 of file yaml_emitters.cc.

{
    out << to_string(h);
    return out;
}

operator<<() [10/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const include_diagram &	c
	)

Definition at line 395 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "type" << YAML::Value << c.type();
    out << c.layout;
    out << dynamic_cast<const inheritable_diagram_options &>(c);
    out << YAML::EndMap;
    return out;
}

operator<<() [11/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const inheritable_diagram_options &	c
	)

Definition at line 307 of file yaml_emitters.cc.

{
    // Common options
    out << c.base_directory;
    out << c.comment_parser;
    out << c.debug_mode;
    out << c.exclude;
    out << c.generate_links;
    out << c.git;
    out << c.glob;
    out << c.include;
    out << c.puml;
    out << c.relative_to;
    out << c.using_namespace;
    out << c.using_module;
    out << c.generate_metadata;
 
    if (const auto *cd = dynamic_cast<const class_diagram *>(&c);
        cd != nullptr) {
        out << cd->title;
        out << c.generate_method_arguments;
        out << c.generate_concept_requirements;
        out << c.generate_packages;
        out << c.include_relations_also_as_members;
        if (c.relationship_hints) {
            out << YAML::Key << "relationship_hints" << YAML::Value
                << c.relationship_hints();
        }
 
        if (c.type_aliases) {
            out << YAML::Key << "type_aliases" << YAML::Value
                << c.type_aliases();
        }
        out << c.member_order;
        out << c.package_type;
        out << c.generate_template_argument_dependencies;
        out << c.skip_redundant_dependencies;
    }
    else if (const auto *sd = dynamic_cast<const sequence_diagram *>(&c);
             sd != nullptr) {
        out << sd->title;
        out << c.combine_free_functions_into_file_participants;
        out << c.inline_lambda_messages;
        out << c.generate_condition_statements;
        out << c.generate_method_arguments;
        out << c.generate_return_types;
        out << c.participants_order;
        out << c.generate_message_comments;
        out << c.message_comment_width;
    }
    else if (const auto *pd = dynamic_cast<const package_diagram *>(&c);
             pd != nullptr) {
        out << pd->title;
        out << c.generate_packages;
        out << c.package_type;
    }
    else if (const auto *id = dynamic_cast<const include_diagram *>(&c);
             id != nullptr) {
        out << id->title;
        out << c.generate_system_headers;
    }
 
    return out;
}

operator<<() [12/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const layout_hint &	c
	)

Definition at line 248 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
 
    out << YAML::Key << c.hint << YAML::Value;
    if (std::holds_alternative<std::string>(c.entity))
        out << std::get<std::string>(c.entity);
    else if (std::holds_alternative<std::vector<std::string>>(c.entity))
        out << std::get<std::vector<std::string>>(c.entity);
 
    out << YAML::EndMap;
    return out;
}

operator<<() [13/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const method_arguments &	ma
	)

Definition at line 181 of file yaml_emitters.cc.

{
    out << to_string(ma);
    return out;
}

operator<<() [14/21]

YAML::Emitter & clanguml::common::model::operator<<	(	YAML::Emitter &	out,
		const namespace_ &	n
	)

Definition at line 54 of file yaml_emitters.cc.

{
    out << n.to_string();
    return out;
}

operator<<() [15/21]

template<typename T >

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const option< T > &	o
	)

Definition at line 862 of file config.h.

{
    if (o.has_value) {
        out << YAML::Key << o.name;
        if constexpr (std::is_same_v<T, std::filesystem::path>)
            out << YAML::Value << o.value.string();
        else
            out << YAML::Value << o.value;
    }
    return out;
}

operator<<() [16/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const package_diagram &	c
	)

Definition at line 405 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "type" << YAML::Value << c.type();
    out << c.layout;
    out << dynamic_cast<const inheritable_diagram_options &>(c);
    out << YAML::EndMap;
    return out;
}

operator<<() [17/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const plantuml &	p
	)

Definition at line 166 of file yaml_emitters.cc.

{
    if (p.before.empty() && p.after.empty())
        return out;
 
    out << YAML::BeginMap;
    if (!p.before.empty())
        out << YAML::Key << "before" << YAML::Value << p.before;
    if (!p.after.empty())
        out << YAML::Key << "after" << YAML::Value << p.after;
    out << YAML::EndMap;
 
    return out;
}

operator<<() [18/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const relationship_hint_t &	rh
	)

Definition at line 208 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "default" << YAML::Value << rh.default_hint;
    for (const auto &[k, v] : rh.argument_hints)
        out << YAML::Key << k << YAML::Value << v;
    out << YAML::EndMap;
    return out;
}

operator<<() [19/21]

YAML::Emitter & clanguml::common::model::operator<<	(	YAML::Emitter &	out,
		const relationship_t &	r
	)

Definition at line 60 of file yaml_emitters.cc.

{
    out << to_string(r);
    return out;
}

operator<<() [20/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const sequence_diagram &	c
	)

Definition at line 383 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << "type" << YAML::Value << c.type();
    out << c.from;
    out << c.from_to;
    out << c.to;
    out << dynamic_cast<const inheritable_diagram_options &>(c);
    out << YAML::EndMap;
    return out;
}

operator<<() [21/21]

YAML::Emitter & clanguml::config::operator<<	(	YAML::Emitter &	out,
		const source_location &	sc
	)

Definition at line 262 of file yaml_emitters.cc.

{
    out << YAML::BeginMap;
    out << YAML::Key << to_string(sc.location_type) << YAML::Value
        << sc.location;
    out << YAML::EndMap;
    return out;
}