yaml_decoders.cc

Go to the documentation of this file.

/**
 * @file src/config/yaml_decoders.cc
 *
 * Copyright (c) 2021-2025 Bartek Kryza <bkryza@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#include "config.h"
#include "diagram_templates.h"
#include "schema.h"
#include "util/error.h"
 
#define MIROIR_IMPLEMENTATION
#define MIROIR_YAMLCPP_SPECIALIZATION
#include <miroir/miroir.hpp>
 
namespace clanguml::error {
 
std::string to_string(miroir::ErrorType et)
{
    switch (et) {
    case miroir::ErrorType::NodeNotFound:
        return "NodeNotFound";
    case miroir::ErrorType::InvalidValueType:
        return "InvalidValueType";
    case miroir::ErrorType::InvalidValue:
        return "InvalidValue";
    case miroir::ErrorType::MissingKeyWithType:
        return "MissingKeyWithType";
    case miroir::ErrorType::UndefinedNode:
        return "UndefinedNode";
    default:
        return "";
    }
}
 
void print(std::ostream &ostr, const config_schema_error &e,
    logging::logger_type_t logger_type)
{
    if (logger_type == logging::logger_type_t::text) {
        ostr << "ERROR: Invalid schema:\n";
        for (const auto &schema_error : e.errors) {
            std::cout << " - " << schema_error.description() << '\n';
        }
    }
    else {
        inja::json j;
        j["valid"] = false;
        j["errors"] = inja::json::array();
        for (const auto &schema_error : e.errors) {
            inja::json je;
            je["path"] = schema_error.path;
            je["error_type"] = to_string(schema_error.type);
            je["description"] = schema_error.description();
            j["errors"].emplace_back(std::move(je));
        }
        ostr << j.dump();
    }
}
} // namespace clanguml::error
 
namespace YAML {
using clanguml::common::namespace_or_regex;
using clanguml::common::string_or_regex;
using clanguml::common::model::access_t;
using clanguml::common::model::module_access_t;
using clanguml::common::model::relationship_t;
using clanguml::config::callee_type;
using clanguml::config::class_diagram;
using clanguml::config::config;
using clanguml::config::context_config;
using clanguml::config::context_direction_t;
using clanguml::config::diagram_template;
using clanguml::config::element_filter_t;
using clanguml::config::filter;
using clanguml::config::generate_links_config;
using clanguml::config::git_config;
using clanguml::config::glob_t;
using clanguml::config::graphml;
using clanguml::config::hint_t;
using clanguml::config::include_diagram;
using clanguml::config::layout_hint;
using clanguml::config::location_t;
using clanguml::config::member_order_t;
using clanguml::config::mermaid;
using clanguml::config::method_arguments;
using clanguml::config::method_type;
using clanguml::config::package_diagram;
using clanguml::config::package_type_t;
using clanguml::config::plantuml;
using clanguml::config::relationship_hint_t;
using clanguml::config::sequence_diagram;
using clanguml::config::source_location;
 
inline bool has_key(const YAML::Node &n, const std::string &key)
{
    assert(n.Type() == NodeType::Map);
 
    return std::count_if(n.begin(), n.end(), [&key](auto &&n) {
        return n.first.template as<std::string>() == key;
    }) > 0;
}
 
template <typename T>
void get_option(const Node &node, clanguml::config::option<T> &option)
{
    if (node[option.name])
        option.set(node[option.name].template as<T>());
 
    for (const auto &alt_name : option.alternate_names)
        if (node[alt_name]) {
            option.set(node[alt_name].template as<T>());
            break;
        }
}
 
template <typename T>
void get_option(
    const Node &node, clanguml::config::option<T> &option, T default_override)
{
    get_option(node, option);
 
    if (!option.is_declared)
        option.set(default_override);
}
 
template <>
void get_option<clanguml::common::model::namespace_>(const Node &node,
    clanguml::config::option<clanguml::common::model::namespace_> &option)
{
    if (node[option.name]) {
        if (node[option.name].Type() == NodeType::Scalar)
            option.set({node[option.name].template as<std::string>()});
        else if (node[option.name].Type() == NodeType::Sequence)
            option.set(
                {node[option.name].template as<std::vector<std::string>>()[0]});
        else
            throw std::runtime_error("Invalid using_namespace value");
    }
}
 
template <>
void get_option<method_arguments>(
    const Node &node, clanguml::config::option<method_arguments> &option)
{
    if (node[option.name]) {
        const auto &val = node[option.name].as<std::string>();
        if (val == "full")
            option.set(method_arguments::full);
        else if (val == "abbreviated")
            option.set(method_arguments::abbreviated);
        else if (val == "none")
            option.set(method_arguments::none);
        else
            throw std::runtime_error(
                "Invalid generate_method_arguments value: " + val);
    }
}
 
template <>
void get_option<member_order_t>(
    const Node &node, clanguml::config::option<member_order_t> &option)
{
    if (node[option.name]) {
        const auto &val = node[option.name].as<std::string>();
        if (val == "as_is")
            option.set(member_order_t::as_is);
        else if (val == "lexical")
            option.set(member_order_t::lexical);
        else
            throw std::runtime_error("Invalid member_order value: " + val);
    }
}
 
template <>
void get_option<package_type_t>(
    const Node &node, clanguml::config::option<package_type_t> &option)
{
    if (node[option.name]) {
        const auto &val = node[option.name].as<std::string>();
        if (val == "namespace")
            option.set(package_type_t::kNamespace);
        else if (val == "directory")
            option.set(package_type_t::kDirectory);
        else if (val == "module")
            option.set(package_type_t::kModule);
        else
            throw std::runtime_error(
                "Invalid generate_method_arguments value: " + val);
    }
}
 
template <>
void get_option<clanguml::config::comment_parser_t>(const Node &node,
    clanguml::config::option<clanguml::config::comment_parser_t> &option)
{
    if (node[option.name]) {
        const auto &val = node[option.name].as<std::string>();
        if (val == "plain")
            option.set(clanguml::config::comment_parser_t::plain);
        else if (val == "clang")
            option.set(clanguml::config::comment_parser_t::clang);
        else
            throw std::runtime_error("Invalid comment_parser value: " + val);
    }
}
 
template <>
void get_option<clanguml::config::filter_mode_t>(const Node &node,
    clanguml::config::option<clanguml::config::filter_mode_t> &option)
{
    if (node[option.name]) {
        const auto &val = node[option.name].as<std::string>();
        if (val == "basic")
            option.set(clanguml::config::filter_mode_t::basic);
        else if (val == "advanced")
            option.set(clanguml::config::filter_mode_t::advanced);
        else
            throw std::runtime_error("Invalid comment_parser value: " + val);
    }
}
 
template <>
void get_option<std::map<std::string, clanguml::config::diagram_template>>(
    const Node &node,
    clanguml::config::option<
        std::map<std::string, clanguml::config::diagram_template>> &option)
{
    if (!node[option.name]) {
        return;
    }
 
    if (node[option.name].IsMap() && node[option.name]["include!"]) {
        auto parent_path = node["__parent_path"].as<std::string>();
 
        // Load templates from file
        auto include_path = std::filesystem::path{parent_path};
        include_path /= node[option.name]["include!"].as<std::string>();
 
        YAML::Node included_node = YAML::LoadFile(include_path.string());
 
        option.set(
            included_node.as<
                std::map<std::string, clanguml::config::diagram_template>>());
    }
    else
        option.set(node[option.name]
                       .as<std::map<std::string,
                           clanguml::config::diagram_template>>());
}
 
std::shared_ptr<clanguml::config::diagram> parse_diagram_config(const Node &d)
{
    const auto diagram_type = d["type"].as<std::string>();
 
    if (diagram_type == "class") {
        return std::make_shared<class_diagram>(d.as<class_diagram>());
    }
    if (diagram_type == "sequence") {
        return std::make_shared<sequence_diagram>(d.as<sequence_diagram>());
    }
    if (diagram_type == "package") {
        return std::make_shared<package_diagram>(d.as<package_diagram>());
    }
    if (diagram_type == "include") {
        return std::make_shared<include_diagram>(d.as<include_diagram>());
    }
 
    LOG_ERROR("Diagrams of type {} are not supported... ", diagram_type);
 
    return {};
}
 
//
// config std::filesystem::path decoder
//
template <> struct convert<std::filesystem::path> {
    static bool decode(const Node &node, std::filesystem::path &rhs)
    {
        if (!node.IsScalar())
            return false;
 
        rhs = std::filesystem::path{node.as<std::string>()};
 
        return true;
    }
};
 
//
// config access_t decoder
//
template <> struct convert<access_t> {
    static bool decode(const Node &node, access_t &rhs)
    {
        if (node.as<std::string>() == "public")
            rhs = access_t::kPublic;
        else if (node.as<std::string>() == "protected")
            rhs = access_t::kProtected;
        else if (node.as<std::string>() == "private")
            rhs = access_t::kPrivate;
        else
            return false;
 
        return true;
    }
};
 
//
// config module_access_t decoder
//
template <> struct convert<module_access_t> {
    static bool decode(const Node &node, module_access_t &rhs)
    {
        if (node.as<std::string>() == "public")
            rhs = module_access_t::kPublic;
        else if (node.as<std::string>() == "private")
            rhs = module_access_t::kPrivate;
        else
            return false;
 
        return true;
    }
};
 
//
// config context_direction_t decoder
//
template <> struct convert<context_direction_t> {
    static bool decode(const Node &node, context_direction_t &rhs)
    {
        if (node.as<std::string>() == "inward")
            rhs = context_direction_t::inward;
        else if (node.as<std::string>() == "outward")
            rhs = context_direction_t::outward;
        else if (node.as<std::string>() == "any")
            rhs = context_direction_t::any;
        else
            return false;
 
        return true;
    }
};
 
//
// config method_type decoder
//
template <> struct convert<method_type> {
    static bool decode(const Node &node, method_type &rhs)
    {
        const auto &val = node.as<std::string>();
        if (val == to_string(method_type::constructor))
            rhs = method_type::constructor;
        else if (val == to_string(method_type::destructor))
            rhs = method_type::destructor;
        else if (val == to_string(method_type::assignment))
            rhs = method_type::assignment;
        else if (val == to_string(method_type::operator_))
            rhs = method_type::operator_;
        else if (val == to_string(method_type::defaulted))
            rhs = method_type::defaulted;
        else if (val == to_string(method_type::deleted))
            rhs = method_type::deleted;
        else if (val == to_string(method_type::static_))
            rhs = method_type::static_;
        else
            return false;
 
        return true;
    }
};
 
//
// config callee_type decoder
//
template <> struct convert<callee_type> {
    static bool decode(const Node &node, callee_type &rhs)
    {
        const auto &val = node.as<std::string>();
        if (val == to_string(callee_type::constructor))
            rhs = callee_type::constructor;
        else if (val == to_string(callee_type::assignment))
            rhs = callee_type::assignment;
        else if (val == to_string(callee_type::operator_))
            rhs = callee_type::operator_;
        else if (val == to_string(callee_type::defaulted))
            rhs = callee_type::defaulted;
        else if (val == to_string(callee_type::static_))
            rhs = callee_type::static_;
        else if (val == to_string(callee_type::function))
            rhs = callee_type::function;
        else if (val == to_string(callee_type::function_template))
            rhs = callee_type::function_template;
        else if (val == to_string(callee_type::method))
            rhs = callee_type::method;
        else if (val == to_string(callee_type::lambda))
            rhs = callee_type::lambda;
        else if (val == to_string(callee_type::cuda_kernel))
            rhs = callee_type::cuda_kernel;
        else if (val == to_string(callee_type::cuda_device))
            rhs = callee_type::cuda_device;
        else
            return false;
 
        return true;
    }
};
 
//
// config relationship_t decoder
//
template <> struct convert<relationship_t> {
    static bool decode(const Node &node, relationship_t &rhs)
    {
        assert(node.Type() == NodeType::Scalar);
 
        auto relationship_name = node.as<std::string>();
        if (relationship_name == "extension" ||
            relationship_name == "inheritance") {
            rhs = relationship_t::kExtension;
        }
        else if (relationship_name == "composition") {
            rhs = relationship_t::kComposition;
        }
        else if (relationship_name == "aggregation") {
            rhs = relationship_t::kAggregation;
        }
        else if (relationship_name == "containment") {
            rhs = relationship_t::kContainment;
        }
        else if (relationship_name == "ownership") {
            rhs = relationship_t::kOwnership;
        }
        else if (relationship_name == "association") {
            rhs = relationship_t::kAssociation;
        }
        else if (relationship_name == "instantiation") {
            rhs = relationship_t::kInstantiation;
        }
        else if (relationship_name == "friendship") {
            rhs = relationship_t::kFriendship;
        }
        else if (relationship_name == "dependency") {
            rhs = relationship_t::kDependency;
        }
        else if (relationship_name == "none") {
            rhs = relationship_t::kNone;
        }
        else
            return false;
 
        return true;
    }
};
 
template <> struct convert<std::vector<source_location>> {
    static bool decode(const Node &node, std::vector<source_location> &rhs)
    {
        for (auto it = node.begin(); it != node.end(); ++it) {
            const YAML::Node &n = *it;
            if (n["marker"]) {
                source_location loc;
                loc.location_type = location_t::marker;
                loc.location = n["marker"].as<std::string>();
                rhs.emplace_back(std::move(loc));
            }
            else if (n["file"] && n["line"]) {
                source_location loc;
                loc.location_type = location_t::fileline;
                loc.location = n["file"].as<std::string>() + ":" +
                    n["line"].as<std::string>();
                rhs.emplace_back(std::move(loc));
            }
            else if (n["function"]) {
                source_location loc;
                loc.location_type = location_t::function;
                loc.location = n["function"].as<decltype(loc.location)>();
                rhs.emplace_back(std::move(loc));
            }
            else {
                return false;
            }
        }
 
        return true;
    }
};
 
template <> struct convert<plantuml> {
    static bool decode(const Node &node, plantuml &rhs)
    {
        if (node["before"])
            rhs.before = node["before"].as<decltype(rhs.before)>();
 
        if (node["after"])
            rhs.after = node["after"].as<decltype(rhs.after)>();
 
        if (node["cmd"])
            rhs.cmd = node["cmd"].as<decltype(rhs.cmd)>();
 
        if (node["style"])
            rhs.style = node["style"].as<decltype(rhs.style)>();
 
        return true;
    }
};
 
template <> struct convert<mermaid> {
    static bool decode(const Node &node, mermaid &rhs)
    {
        if (node["before"])
            rhs.before = node["before"].as<decltype(rhs.before)>();
 
        if (node["after"])
            rhs.after = node["after"].as<decltype(rhs.after)>();
 
        if (node["cmd"])
            rhs.cmd = node["cmd"].as<decltype(rhs.cmd)>();
 
        return true;
    }
};
 
template <> struct convert<graphml> {
    static bool decode(const Node &node, graphml &rhs)
    {
        if (node["notes"])
            rhs.notes = node["notes"].as<decltype(rhs.notes)>();
 
        return true;
    }
};
 
template <> struct convert<string_or_regex> {
    static bool decode(const Node &node, string_or_regex &rhs)
    {
        using namespace std::string_literals;
        if (node.IsMap()) {
            auto pattern = node["r"].as<std::string>();
            auto rx = std::regex(pattern);
            rhs = string_or_regex{std::move(rx), std::move(pattern)};
        }
        else {
            rhs = string_or_regex{node.as<std::string>()};
        }
 
        return true;
    }
};
 
template <> struct convert<context_config> {
    static bool decode(const Node &node, context_config &rhs)
    {
        using namespace std::string_literals;
        if (node.IsMap() && has_key(node, "match")) {
            const auto &match = node["match"];
            rhs.radius = match["radius"].as<unsigned>();
            rhs.pattern = match["pattern"].as<string_or_regex>();
            if (has_key(match, "direction"))
                rhs.direction = match["direction"].as<context_direction_t>();
            if (has_key(match, "relationships"))
                rhs.relationships =
                    match["relationships"].as<std::vector<relationship_t>>();
        }
        else {
            rhs.radius = 1;
            rhs.pattern = node.as<string_or_regex>();
        }
 
        return true;
    }
};
 
template <> struct convert<namespace_or_regex> {
    static bool decode(const Node &node, namespace_or_regex &rhs)
    {
        using namespace std::string_literals;
        if (node.IsMap()) {
            auto pattern = node["r"].as<std::string>();
            auto rx = std::regex(pattern);
            rhs = namespace_or_regex{std::move(rx), std::move(pattern)};
        }
        else {
            rhs = namespace_or_regex{node.as<std::string>()};
        }
 
        return true;
    }
};
 
template <> struct convert<element_filter_t> {
    static bool decode(const Node &node, element_filter_t &rhs)
    {
        using namespace std::string_literals;
        if (node.IsMap()) {
            if (has_key(node, "r")) {
                rhs.type = element_filter_t::filtered_type::any;
                auto pattern = node["r"].as<std::string>();
                auto rx = std::regex(pattern);
                rhs.name = string_or_regex(std::move(rx), std::move(pattern));
            }
            else if (has_key(node, "type")) {
                rhs.type = element_filter_t::filtered_type::any;
                if (node["type"].as<std::string>() == "class")
                    rhs.type = element_filter_t::filtered_type::class_;
                else if (node["type"].as<std::string>() == "enum")
                    rhs.type = element_filter_t::filtered_type::enum_;
                else if (node["type"].as<std::string>() == "function")
                    rhs.type = element_filter_t::filtered_type::function;
                else if (node["type"].as<std::string>() == "method")
                    rhs.type = element_filter_t::filtered_type::method;
                else if (node["type"].as<std::string>() == "member")
                    rhs.type = element_filter_t::filtered_type::member;
                else if (node["type"].as<std::string>() == "concept")
                    rhs.type = element_filter_t::filtered_type::concept_;
                else if (node["type"].as<std::string>() == "package")
                    rhs.type = element_filter_t::filtered_type::package;
                else if (node["type"].as<std::string>() == "function_template")
                    rhs.type =
                        element_filter_t::filtered_type::function_template;
                else if (node["type"].as<std::string>() == "objc_method")
                    rhs.type = element_filter_t::filtered_type::objc_method;
                else if (node["type"].as<std::string>() == "objc_member")
                    rhs.type = element_filter_t::filtered_type::objc_member;
                else if (node["type"].as<std::string>() == "objc_protocol")
                    rhs.type = element_filter_t::filtered_type::objc_protocol;
                else if (node["type"].as<std::string>() == "objc_category")
                    rhs.type = element_filter_t::filtered_type::objc_category;
                else if (node["type"].as<std::string>() == "objc_interface")
                    rhs.type = element_filter_t::filtered_type::objc_interface;
                auto name = node["name"];
                if (name.IsMap() && has_key(name, "r")) {
                    auto pattern = name["r"].as<std::string>();
                    auto rx = std::regex(pattern);
                    rhs.name =
                        string_or_regex(std::move(rx), std::move(pattern));
                }
                else
                    rhs.name = name.as<std::string>();
            }
        }
        else {
            rhs.type = element_filter_t::filtered_type::any;
            rhs.name = string_or_regex{node.as<std::string>()};
        }
 
        return true;
    }
};
 
//
// filter Yaml decoder
//
template <> struct convert<filter> {
    static bool decode(const Node &node, filter &rhs)
    {
        if (node["anyof"]) {
            rhs.anyof = std::make_unique<filter>(node["anyof"].as<filter>());
        }
 
        if (node["allof"]) {
            rhs.allof = std::make_unique<filter>(node["allof"].as<filter>());
        }
 
        if (node["namespaces"]) {
            auto namespace_list =
                node["namespaces"].as<decltype(rhs.namespaces)>();
            for (const auto &ns : namespace_list)
                rhs.namespaces.push_back({ns});
        }
 
        if (node["modules"]) {
            auto module_list = node["modules"].as<decltype(rhs.modules)>();
            for (const auto &ns : module_list)
                rhs.modules.push_back({ns});
        }
 
        if (node["module_access"])
            rhs.module_access =
                node["module_access"].as<decltype(rhs.module_access)>();
 
        if (node["relationships"])
            rhs.relationships =
                node["relationships"].as<decltype(rhs.relationships)>();
 
        if (node["elements"])
            rhs.elements = node["elements"].as<decltype(rhs.elements)>();
 
        if (node["element_types"])
            rhs.element_types =
                node["element_types"].as<decltype(rhs.element_types)>();
 
        if (node["method_types"])
            rhs.method_types =
                node["method_types"].as<decltype(rhs.method_types)>();
 
        if (node["access"])
            rhs.access = node["access"].as<decltype(rhs.access)>();
 
        if (node["subclasses"])
            rhs.subclasses = node["subclasses"].as<decltype(rhs.subclasses)>();
 
        if (node["parents"])
            rhs.parents = node["parents"].as<decltype(rhs.parents)>();
 
        if (node["specializations"])
            rhs.specializations =
                node["specializations"].as<decltype(rhs.specializations)>();
 
        if (node["dependants"])
            rhs.dependants = node["dependants"].as<decltype(rhs.dependants)>();
 
        if (node["dependencies"])
            rhs.dependencies =
                node["dependencies"].as<decltype(rhs.dependencies)>();
 
        if (node["context"])
            rhs.context = node["context"].as<decltype(rhs.context)>();
 
        if (node["paths"])
            rhs.paths = node["paths"].as<decltype(rhs.paths)>();
 
        if (node["callee_types"])
            rhs.callee_types =
                node["callee_types"].as<decltype(rhs.callee_types)>();
 
        return true;
    }
};
 
//
// generate_links_config Yaml decoder
//
template <> struct convert<generate_links_config> {
    static bool decode(const Node &node, generate_links_config &rhs)
    {
        if (node["link"]) {
            if (node["link"].IsMap())
                rhs.link = node["link"].as<decltype(rhs.link)>();
            else
                rhs.link.emplace(".", node["link"].as<std::string>());
        }
 
        if (node["tooltip"]) {
            if (node["tooltip"].IsMap())
                rhs.tooltip = node["tooltip"].as<decltype(rhs.tooltip)>();
            else
                rhs.tooltip.emplace(".", node["tooltip"].as<std::string>());
        }
 
        return true;
    }
};
 
//
// git_config Yaml decoder
//
template <> struct convert<git_config> {
    static bool decode(const Node &node, git_config &rhs)
    {
        if (node["branch"])
            rhs.branch = node["branch"].as<decltype(rhs.branch)>();
 
        if (node["revision"])
            rhs.revision = node["revision"].as<decltype(rhs.revision)>();
 
        if (node["commit"])
            rhs.commit = node["commit"].as<decltype(rhs.commit)>();
 
        if (node["toplevel"])
            rhs.toplevel = node["toplevel"].as<decltype(rhs.toplevel)>();
 
        return true;
    }
};
 
template <typename T> bool decode_diagram(const Node &node, T &rhs)
{
    // Decode options common for all diagrams
    get_option(node, rhs.glob);
    get_option(node, rhs.using_namespace);
    get_option(node, rhs.using_module);
    get_option(node, rhs.filter_mode);
    get_option(node, rhs.include_system_headers);
    get_option(node, rhs.include);
    get_option(node, rhs.exclude);
    get_option(node, rhs.puml);
    get_option(node, rhs.mermaid);
    get_option(node, rhs.graphml);
    get_option(node, rhs.git);
    get_option(node, rhs.generate_links);
    get_option(node, rhs.type_aliases);
    get_option(node, rhs.comment_parser);
    get_option(node, rhs.debug_mode);
    get_option(node, rhs.generate_metadata);
    get_option(node, rhs.title);
    get_option(node, rhs.get_relative_to());
    get_option(node, rhs.user_data);
 
    return true;
}
 
//
// class_diagram Yaml decoder
//
template <> struct convert<class_diagram> {
    static bool decode(const Node &node, class_diagram &rhs)
    {
        if (!decode_diagram(node, rhs))
            return false;
 
        get_option(node, rhs.layout);
        get_option(node, rhs.include_relations_also_as_members);
        get_option(node, rhs.generate_method_arguments);
        get_option(node, rhs.generate_concept_requirements);
        get_option(node, rhs.group_methods);
        get_option(node, rhs.member_order);
        get_option(node, rhs.generate_packages);
        get_option(node, rhs.package_type);
        get_option(node, rhs.generate_template_argument_dependencies);
        get_option(node, rhs.skip_redundant_dependencies);
        get_option(node, rhs.relationship_hints);
        get_option(node, rhs.type_aliases);
 
        get_option(node, rhs.get_relative_to());
 
        rhs.initialize_relationship_hints();
        rhs.initialize_type_aliases();
 
        return true;
    }
};
 
//
// sequence_diagram Yaml decoder
//
template <> struct convert<sequence_diagram> {
    static bool decode(const Node &node, sequence_diagram &rhs)
    {
        if (!decode_diagram(node, rhs))
            return false;
 
        get_option(node, rhs.from);
        get_option(node, rhs.from_to);
        get_option(node, rhs.to);
        get_option(node, rhs.combine_free_functions_into_file_participants);
        get_option(node, rhs.inline_lambda_messages);
        get_option(node, rhs.generate_return_types);
        get_option(node, rhs.generate_condition_statements);
        get_option(node, rhs.participants_order);
        get_option(node, rhs.generate_method_arguments);
        get_option(node, rhs.generate_message_comments);
        get_option(node, rhs.fold_repeated_activities);
        get_option(node, rhs.message_comment_width);
        get_option(node, rhs.type_aliases);
 
        get_option(node, rhs.get_relative_to());
 
        rhs.initialize_type_aliases();
 
        return true;
    }
};
 
//
// package_diagram Yaml decoder
//
template <> struct convert<package_diagram> {
    static bool decode(const Node &node, package_diagram &rhs)
    {
        if (!decode_diagram(node, rhs))
            return false;
 
        get_option(node, rhs.layout);
        get_option(node, rhs.package_type);
 
        get_option(node, rhs.get_relative_to());
 
        return true;
    }
};
 
//
// include_diagram Yaml decoder
//
template <> struct convert<include_diagram> {
    static bool decode(const Node &node, include_diagram &rhs)
    {
        if (!decode_diagram(node, rhs))
            return false;
 
        get_option(node, rhs.layout);
        get_option(node, rhs.generate_system_headers);
        get_option(node, rhs.generate_packages, true);
 
        get_option(node, rhs.get_relative_to());
 
        return true;
    }
};
 
//
// layout_hint Yaml decoder
//
template <> struct convert<glob_t> {
    static bool decode(const Node &node, glob_t &rhs)
    {
        if (node.Type() == NodeType::Sequence) {
            rhs.include = node.as<std::vector<string_or_regex>>();
            return true;
        }
 
        if (node.Type() == NodeType::Map) {
            if (has_key(node, "include"))
                rhs.include =
                    node["include"].as<std::vector<string_or_regex>>();
            if (has_key(node, "exclude"))
                rhs.exclude =
                    node["exclude"].as<std::vector<string_or_regex>>();
            return true;
        }
 
        return false;
    }
};
 
//
// layout_hint Yaml decoder
//
template <> struct convert<layout_hint> {
    static bool decode(const Node &node, layout_hint &rhs)
    {
        assert(node.Type() == NodeType::Map);
 
        if (node["up"]) {
            rhs.hint = hint_t::up;
            rhs.entity = node["up"].as<std::string>();
        }
        else if (node["down"]) {
            rhs.hint = hint_t::down;
            rhs.entity = node["down"].as<std::string>();
        }
        else if (node["left"]) {
            rhs.hint = hint_t::left;
            rhs.entity = node["left"].as<std::string>();
        }
        else if (node["right"]) {
            rhs.hint = hint_t::right;
            rhs.entity = node["right"].as<std::string>();
        }
        else if (node["together"]) {
            rhs.hint = hint_t::together;
            rhs.entity = node["together"].as<std::vector<std::string>>();
        }
        else if (node["row"]) {
            rhs.hint = hint_t::row;
            rhs.entity = node["row"].as<std::vector<std::string>>();
        }
        else if (node["column"]) {
            rhs.hint = hint_t::column;
            rhs.entity = node["column"].as<std::vector<std::string>>();
        }
        else
            return false;
 
        return true;
    }
};
 
//
// relationship_hint_t Yaml decoder
//
template <> struct convert<relationship_hint_t> {
    static bool decode(const Node &node, relationship_hint_t &rhs)
    {
        assert(node.Type() == NodeType::Map || node.Type() == NodeType::Scalar);
 
        if (node.Type() == NodeType::Scalar) {
            // This will be default relationship hint for all arguments
            // of this template (useful for instance for tuples)
            rhs.default_hint = node.as<relationship_t>();
        }
        else {
            for (const auto &it : node) {
                auto key = it.first.as<std::string>();
                if (key == "default") {
                    rhs.default_hint = node["default"].as<relationship_t>();
                }
                else {
                    try {
                        auto index = stoul(key);
                        rhs.argument_hints[index] =
                            it.second.as<relationship_t>();
                    }
                    catch (std::exception &e) {
                        return false;
                    }
                }
            }
        }
 
        return true;
    }
};
 
//
// diagram_template Yaml decoder
//
template <> struct convert<diagram_template> {
    static bool decode(const Node &node, diagram_template &rhs)
    {
        assert(node.Type() == NodeType::Map);
 
        rhs.type = clanguml::common::model::from_string(
            node["type"].as<std::string>());
        rhs.jinja_template = node["template"].as<std::string>();
        rhs.description = node["description"].as<std::string>();
 
        return true;
    }
};
 
//
// config Yaml decoder
//
template <> struct convert<config> {
    static bool decode(const Node &node, config &rhs)
    {
        get_option(node, rhs.glob);
        get_option(node, rhs.using_namespace);
        get_option(node, rhs.using_module);
        get_option(node, rhs.filter_mode);
        get_option(node, rhs.output_directory);
        get_option(node, rhs.query_driver);
        get_option(node, rhs.allow_empty_diagrams);
        get_option(node, rhs.compilation_database_dir);
        get_option(node, rhs.add_compile_flags);
        get_option(node, rhs.remove_compile_flags);
        get_option(node, rhs.include_relations_also_as_members);
        get_option(node, rhs.puml);
        get_option(node, rhs.mermaid);
        get_option(node, rhs.graphml);
        get_option(node, rhs.generate_method_arguments);
        get_option(node, rhs.generate_concept_requirements);
        get_option(node, rhs.generate_packages);
        get_option(node, rhs.package_type);
        get_option(node, rhs.generate_template_argument_dependencies);
        get_option(node, rhs.skip_redundant_dependencies);
        get_option(node, rhs.generate_links);
        get_option(node, rhs.generate_system_headers);
        get_option(node, rhs.git);
        get_option(node, rhs.comment_parser);
        get_option(node, rhs.debug_mode);
        get_option(node, rhs.generate_metadata);
        get_option(node, rhs.combine_free_functions_into_file_participants);
        get_option(node, rhs.inline_lambda_messages);
        get_option(node, rhs.generate_return_types);
        get_option(node, rhs.generate_condition_statements);
        get_option(node, rhs.generate_message_comments);
        get_option(node, rhs.fold_repeated_activities);
        get_option(node, rhs.message_comment_width);
        get_option(node, rhs.type_aliases);
        get_option(node, rhs.user_data);
 
        rhs.base_directory.set(node["__parent_path"].as<std::string>());
        get_option(node, rhs.get_relative_to());
 
        get_option(node, rhs.diagram_templates);
 
        auto diagrams = node["diagrams"];
 
        for (auto d : diagrams) {
            auto name = d.first.as<std::string>();
            std::shared_ptr<clanguml::config::diagram> diagram_config{};
            auto parent_path = node["__parent_path"].as<std::string>();
            d.second.force_insert("__parent_path", parent_path);
 
            diagram_config = parse_diagram_config(d.second);
            if (diagram_config) {
                diagram_config->name = name;
                rhs.diagrams[name] = diagram_config;
            }
            else {
                return false;
            }
        }
 
        return true;
    }
};
 
template <> struct convert<inja::json> {
    static bool parse_scalar(const YAML::Node &node, inja::json &rhs)
    {
        int i{};
        double d{};
        bool b{};
        std::string s;
 
        if (YAML::convert<int>::decode(node, i)) {
            rhs = i;
            return true;
        }
        if (YAML::convert<double>::decode(node, d)) {
            rhs = d;
            return true;
        }
        if (YAML::convert<bool>::decode(node, b)) {
            rhs = b;
            return true;
        }
        if (YAML::convert<std::string>::decode(node, s)) {
            rhs = s;
            return true;
        }
 
        return false;
    }
 
    static bool decode(const Node &node, inja::json &rhs)
    {
        switch (node.Type()) {
        case YAML::NodeType::Null:
            break;
        case YAML::NodeType::Scalar:
            parse_scalar(node, rhs);
            break;
        case YAML::NodeType::Sequence:
            for (auto &&array_element : node)
                rhs.emplace_back(array_element.as<inja::json>());
            break;
        case YAML::NodeType::Map:
            for (auto &&it : node)
                rhs[it.first.as<std::string>()] = it.second.as<inja::json>();
            break;
        default:
            break;
        }
        return true;
    }
};
} // namespace YAML
 
namespace clanguml::config {
 
void config::initialize_diagram_templates()
{
    const auto &predefined_templates_str = get_predefined_diagram_templates();
 
    YAML::Node predefined_templates = YAML::Load(predefined_templates_str);
 
    if (!diagram_templates) {
        diagram_templates.set({});
    }
 
    diagram_templates().merge(
        predefined_templates.as<std::map<std::string, diagram_template>>());
}
 
void config::inherit()
{
    for (auto &[name, diagram] : diagrams) {
        diagram->inherit(*this);
 
        assert(diagram->get_relative_to().has_value);
    }
}
 
namespace {
void resolve_option_path(YAML::Node &doc, const std::string &option_name)
{
    std::filesystem::path relative_to_path{
        doc["relative_to"].as<std::string>()};
 
    relative_to_path = weakly_canonical(relative_to_path);
 
    std::filesystem::path option_path{doc[option_name].as<std::string>()};
 
    if (option_path.is_absolute())
        return;
 
    option_path = relative_to_path / option_path;
    option_path = option_path.lexically_normal();
    option_path.make_preferred();
 
    doc[option_name] = option_path.string();
}
} // namespace
 
config load(const std::string &config_file, bool inherit,
    std::optional<bool> paths_relative_to_pwd, std::optional<bool> no_metadata,
    bool validate)
{
    try {
        auto schema = YAML::Load(clanguml::config::schema_str);
        auto schema_validator = miroir::Validator<YAML::Node>(schema);
 
        YAML::Node doc;
        std::filesystem::path config_file_path{};
 
        if (config_file == "-") {
            std::istreambuf_iterator<char> stdin_stream_begin{std::cin};
            std::istreambuf_iterator<char> stdin_stream_end{};
            std::string stdin_stream_str{stdin_stream_begin, stdin_stream_end};
 
            doc = YAML::Load(stdin_stream_str);
        }
        else {
            doc = YAML::LoadFile(config_file);
        }
 
        // Store the parent path of the config_file to properly resolve
        // relative paths in config file
        if (has_key(doc, "__parent_path"))
            doc.remove("__parent_path");
        if (config_file == "-") {
            config_file_path = std::filesystem::current_path();
            doc.force_insert("__parent_path", config_file_path.string());
        }
        else {
            config_file_path =
                canonical(absolute(std::filesystem::path{config_file}));
            doc.force_insert(
                "__parent_path", config_file_path.parent_path().string());
        }
 
        LOG_DBG("Effective config file path is {}", config_file_path.string());
 
        //
        // If no relative_to path is specified in the config, make all paths
        // resolvable against the parent directory of the .clang-uml config
        // file, or against the $PWD if it was specified so in the command
        // line
        //
        if (!doc["relative_to"]) {
            bool paths_relative_to_config_file = true;
 
            if (doc["paths_relative_to_config_file"] &&
                !doc["paths_relative_to_config_file"].as<bool>())
                paths_relative_to_config_file = false;
 
            if (paths_relative_to_pwd && *paths_relative_to_pwd)
                paths_relative_to_config_file = false;
 
            if (paths_relative_to_config_file)
                doc["relative_to"] = config_file_path.parent_path().string();
            else
                doc["relative_to"] = std::filesystem::current_path().string();
        }
 
        if (no_metadata.has_value()) {
            doc["generate_metadata"] = !no_metadata.value();
        }
 
        //
        // Resolve common path-like config options relative to `relative_to`
        //
        if (!doc["output_directory"]) {
            doc["output_directory"] = ".";
        }
        resolve_option_path(doc, "output_directory");
 
        if (!doc["compilation_database_dir"]) {
            doc["compilation_database_dir"] = ".";
        }
        resolve_option_path(doc, "compilation_database_dir");
 
        // If the current directory is also a git repository,
        // load some config values, which can be included in the
        // generated diagrams
        if (util::is_git_repository() && !doc["git"]) {
            YAML::Node git_config{YAML::NodeType::Map};
            git_config["branch"] = util::get_git_branch();
            git_config["revision"] = util::get_git_revision();
            git_config["commit"] = util::get_git_commit();
            git_config["toplevel"] = util::get_git_toplevel_dir();
 
            doc["git"] = git_config;
        }
 
        if (has_key(doc, "diagrams")) {
            auto diagrams = doc["diagrams"];
 
            assert(diagrams.Type() == YAML::NodeType::Map);
 
            for (auto d : diagrams) {
                auto name = d.first.as<std::string>();
                std::shared_ptr<clanguml::config::diagram> diagram_config{};
                auto parent_path = doc["__parent_path"].as<std::string>();
 
                if (has_key(d.second, "include!")) {
                    auto include_path = std::filesystem::path{parent_path};
                    include_path /= d.second["include!"].as<std::string>();
 
                    YAML::Node included_node =
                        YAML::LoadFile(include_path.string());
 
                    diagrams[name] = included_node;
                }
            }
        }
 
        if (validate) {
            auto schema_errors = schema_validator.validate(doc);
 
            if (!schema_errors.empty()) {
                throw clanguml::error::config_schema_error(
                    std::move(schema_errors));
            }
        }
 
        auto d = doc.as<config>();
 
        if (inherit)
            d.inherit();
 
        d.initialize_diagram_templates();
 
        return d;
    }
    catch (YAML::BadFile &e) {
        throw std::runtime_error(fmt::format(
            "Could not open config file {}: {}", config_file, e.what()));
    }
    catch (YAML::Exception &e) {
        throw std::runtime_error(
            fmt::format("Cannot parse YAML file {} at line {}: {}", config_file,
                e.mark.line, e.msg));
    }
}
} // namespace clanguml::config