include_diagram_generator.h

Go to the documentation of this file.

/**
 * @file src/include_diagram/generators/mermaid/include_diagram_generator.h
 *
 * 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.
 */
#pragma once
 
#include "common/generators/mermaid/generator.h"
#include "common/model/package.h"
#include "common/model/relationship.h"
#include "common/model/source_file.h"
#include "config/config.h"
#include "include_diagram/model/diagram.h"
#include "include_diagram/visitor/translation_unit_visitor.h"
#include "util/util.h"
 
#include <filesystem>
#include <fstream>
#include <iostream>
#include <sstream>
 
namespace clanguml::include_diagram::generators::mermaid {
 
using diagram_config = clanguml::config::include_diagram;
using diagram_model = clanguml::include_diagram::model::diagram;
 
template <typename C, typename D>
using common_generator = clanguml::common::generators::mermaid::generator<C, D>;
 
using clanguml::common::model::access_t;
using clanguml::common::model::package;
using clanguml::common::model::relationship_t;
using clanguml::common::model::source_file;
using namespace clanguml::util;
 
/**
 * @brief Include diagram MermaidJS generator
 */
class generator : public common_generator<diagram_config, diagram_model> {
public:
    generator(diagram_config &config, diagram_model &model);
 
    using common_generator<diagram_config, diagram_model>::generate;
 
    /**
     * @brief Main generator method.
     *
     * This method is called first and coordinates the entire diagram
     * generation.
     *
     * @param ostr Output stream.
     */
    void generate_diagram(std::ostream &ostr) const override;
 
    /**
     * @brief Generate the diagram type
     *
     * @param ostr Output stream
     */
    void generate_diagram_type(std::ostream &ostr) const override;
 
    /**
     * @brief Generate relationships originating from source_file `f`
     *
     * @param p Diagram element
     * @param parent Output stream
     */
    void generate_relationships(const source_file &p, std::ostream &ostr) const;
 
    /**
     * @brief Generate diagram element
     *
     * @param e Source file diagram element
     * @param parent Output stream
     */
    void generate(const source_file &e, std::ostream &ostr) const;
 
private:
    void generate_with_packages(const source_file &f, std::ostream &ostr) const;
 
    void generate_without_packages(
        const source_file &f, std::ostream &ostr) const;
};
 
} // namespace clanguml::include_diagram::generators::mermaid