package_diagram_generator.cc

Go to the documentation of this file.

/**
 * @file src/package_diagram/generators/mermaid/package_diagram_generator.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 "package_diagram_generator.h"
 
#include "common/generators/display_adapters.h"
#include "util/error.h"
 
namespace clanguml::package_diagram::generators::mermaid {
 
using clanguml::common::generators::mermaid::indent;
 
generator::generator(diagram_config &config, diagram_model &model)
    : common_generator<diagram_config, diagram_model>{config, model}
    , together_group_stack_{false}
{
}
 
void generator::generate_diagram_type(std::ostream &ostr) const
{
    ostr << "flowchart\n";
}
 
void generator::generate_relationships(
    const package &p, std::ostream &ostr) const
{
    LOG_DBG("Generating relationships for package {}", p.full_name(true));
 
    // Generate this packages relationship
    if (model().should_include(relationship_t::kDependency)) {
        for (const auto &r : p.relationships()) {
            std::stringstream relstr;
            try {
                auto destination_package = model().get(r.destination());
 
                if (!destination_package)
                    continue;
 
                auto destination_alias = model().to_alias(r.destination());
                if (!destination_alias.empty()) {
                    relstr << p.alias() << " -.-> " << destination_alias
                           << '\n';
                    ostr << indent(1) << relstr.str();
                }
            }
            catch (error::uml_alias_missing &e) {
                LOG_DBG("=== Skipping dependency relation from {} to {} due "
                        "to: {}",
                    p.full_name(false), r.destination(), e.what());
            }
        }
    }
 
    // Process it's subpackages relationships
    for (const auto &subpackage : p) {
        generate_relationships(
            dynamic_cast<const package &>(*subpackage), ostr);
    }
}
 
void generator::generate(const package &p, std::ostream &ostr) const
{
    using clanguml::common::generators::display_name_adapter;
 
    LOG_DBG("Generating package {}", p.name());
 
    together_group_stack_.enter();
 
    const auto &uns = config().using_namespace();
 
    // Don't generate packages from namespaces filtered out by
    // using_namespace
    if (!uns.starts_with({p.full_name(false)})) {
        ostr << indent(1) << "subgraph " << p.alias() << "["
             << display_name_adapter(p).with_packages().name() << "]\n";
 
        if (p.is_deprecated())
            ostr << indent(1) << "%% <<deprecated>>\n";
    }
 
    for (const auto &subpackage : p) {
        auto &pkg = dynamic_cast<package &>(*subpackage);
        auto together_group = config().get_together_group(pkg.full_name(false));
        if (together_group) {
            together_group_stack_.group_together(together_group.value(), &pkg);
        }
        else {
            generate(pkg, ostr);
        }
    }
 
    generate_groups(ostr);
 
    if (!uns.starts_with({p.full_name(false)})) {
        ostr << indent(1) << "end" << '\n';
    }
 
    if (config().generate_links) {
        common_generator<diagram_config, diagram_model>::generate_link(ostr, p);
    }
 
    generate_notes(ostr, p);
 
    together_group_stack_.leave();
}
 
void generator::generate_groups(std::ostream &ostr) const
{
    for (const auto &[group_name, group_elements] :
        together_group_stack_.get_current_groups()) {
        ostr << indent(1) << "%% together group - not rendered in MermaidJS \n";
 
        for (auto *pkg : group_elements) {
            generate(*pkg, ostr);
        }
 
        ostr << indent(1) << "%% end together group\n";
    }
}
 
void generator::generate_notes(
    std::ostream &ostr, const common::model::diagram_element &element) const
{
    const auto &config =
        common_generator<diagram_config, diagram_model>::config();
 
    for (const auto &decorator : element.decorators()) {
        auto note = std::dynamic_pointer_cast<decorators::note>(decorator);
        if (note && note->applies_to_diagram(config.name)) {
            auto note_id_str = fmt::format("N_{}", note_id_++);
 
            ostr << indent(1) << note_id_str << "(" << note->text << ")\n";
 
            ostr << indent(1) << note_id_str << "-.-" << element.alias()
                 << '\n';
        }
    }
}
 
void generator::generate_diagram(std::ostream &ostr) const
{
    for (const auto &p : model()) {
        auto &pkg = dynamic_cast<package &>(*p);
        auto together_group = config().get_together_group(pkg.full_name(false));
        if (together_group) {
            together_group_stack_.group_together(together_group.value(), &pkg);
        }
        else {
            generate(pkg, ostr);
        }
    }
 
    generate_groups(ostr);
 
    // Process package relationships
    for (const auto &p : model()) {
        generate_relationships(dynamic_cast<package &>(*p), ostr);
    }
}
 
} // namespace clanguml::package_diagram::generators::mermaid