0.5.4
C++ to UML diagram generator based on Clang
Loading...
Searching...
No Matches
package_diagram_generator.h
Go to the documentation of this file.
1/**
2 * @file src/package_diagram/generators/json/package_diagram_generator.h
3 *
4 * Copyright (c) 2021-2024 Bartek Kryza <bkryza@gmail.com>
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18#pragma once
19
24#include "config/config.h"
27#include "util/util.h"
28
29#include <filesystem>
30#include <fstream>
31#include <iostream>
32#include <sstream>
33
35
38
39template <typename C, typename D>
41
45using namespace clanguml::util;
46
47/**
48 * @brief Package diagram JSON generator
49 */
50class generator : public common_generator<diagram_config, diagram_model> {
51public:
53
55
56 /**
57 * @brief Main generator method.
58 *
59 * This method is called first and coordinates the entire diagram
60 * generation.
61 *
62 * @param ostr Output stream.
63 */
64 void generate_diagram(nlohmann::json &parent) const override;
65
66 /**
67 * @brief Generate relationships originating from package `p`
68 *
69 * @param p Diagram element
70 * @param parent JSON node
71 */
72 void generate_relationships(const package &p, nlohmann::json &parent) const;
73
74 /**
75 * @brief Generate diagram package
76 *
77 * @param p Diagram package element
78 * @param parent Parent JSON node
79 */
80 void generate(const package &p, nlohmann::json &parent) const;
81};
82
83} // namespace clanguml::package_diagram::generators::json