0.5.4
C++ to UML diagram generator based on Clang
Loading...
Searching...
No Matches
include_diagram_generator.h
Go to the documentation of this file.
1/**
2 * @file src/include_diagram/generators/json/include_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
46using namespace clanguml::util;
47
48/**
49 * @brief Include diagram JSON generator
50 */
51class generator : public common_generator<diagram_config, diagram_model> {
52public:
54
56
57 /**
58 * @brief Main generator method.
59 *
60 * This method is called first and coordinates the entire diagram
61 * generation.
62 *
63 * @param ostr Output stream.
64 */
65 void generate_diagram(nlohmann::json &parent) const override;
66
67 /**
68 * @brief Generate relationships originating from source_file `f`
69 *
70 * @param p Diagram element
71 * @param parent JSON node
72 */
74 const source_file &f, nlohmann::json &parent) const;
75
76 /**
77 * @brief Generate diagram element
78 *
79 * @param e Source file diagram element
80 * @param parent Parent JSON node
81 */
82 void generate(const source_file &e, nlohmann::json &parent) const;
83};
84
85} // namespace clanguml::include_diagram::generators::json