matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added support for 'together' option in class diagrams with rendered namespaces

Browse Source
This commit is contained in:
Bartek Kryza
2023-02-04 15:42:46 +01:00
parent d7d80ab41e
commit 4423b14b62
8 changed files with 301 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
src/class_diagram/generators/plantuml/class_diagram_generator.cc
View File

@@ -26,6 +26,7 @@ namespace clanguml::class_diagram::generators::plantuml {
generator::generator(diagram_config &config, diagram_model &model)
: common_generator<diagram_config, diagram_model>{config, model}
, together_group_stack_{!config.generate_packages()}
{
}
@@ -288,6 +289,25 @@ void generator::generate_member_notes(std::ostream &ostr,
}
}
void generator::generate_relationships(std::ostream &ostr) const
{
for (const auto &p : m_model) {
if (auto *pkg = dynamic_cast<package *>(p.get()); pkg) {
generate_relationships(*pkg, ostr);
}
else if (auto *cls = dynamic_cast<class_ *>(p.get()); cls) {
if (m_model.should_include(*cls)) {
generate_relationships(*cls, ostr);
}
}
else if (auto *enm = dynamic_cast<enum_ *>(p.get()); enm) {
if (m_model.should_include(*enm)) {
generate_relationships(*enm, ostr);
}
}
}
}
void generator::generate_relationships(
const class_ &c, std::ostream &ostr) const
{
@@ -474,40 +494,65 @@ void generator::generate(const package &p, std::ostream &ostr) const
if (dynamic_cast<package *>(subpackage.get()) != nullptr) {
// TODO: add option - generate_empty_packages
const auto &sp = dynamic_cast<package &>(*subpackage);
if (!sp.is_empty())
if (!sp.is_empty()) {
together_group_stack_.enter();
generate(sp, ostr);
together_group_stack_.leave();
}
}
else if (dynamic_cast<class_ *>(subpackage.get()) != nullptr) {
else if (auto *cls = dynamic_cast<class_ *>(subpackage.get()); cls) {
if (m_model.should_include(*subpackage)) {
auto together_group =
m_config.get_together_group(subpackage->full_name(false));
m_config.get_together_group(cls->full_name(false));
if (together_group) {
current_level_together_groups_[together_group.value()]
.push_back(subpackage.get());
together_group_stack_.group_together(
together_group.value(), cls);
}
else {
generate_alias(dynamic_cast<class_ &>(*subpackage), ostr);
generate(dynamic_cast<class_ &>(*subpackage), ostr);
generate_alias(*cls, ostr);
generate(*cls, ostr);
}
}
}
else if (dynamic_cast<enum_ *>(subpackage.get()) != nullptr) {
else if (auto *enm = dynamic_cast<enum_ *>(subpackage.get()); enm) {
if (m_model.should_include(*subpackage)) {
auto together_group =
m_config.get_together_group(subpackage->full_name(false));
if (together_group) {
current_level_together_groups_[together_group.value()]
.push_back(subpackage.get());
together_group_stack_.group_together(
together_group.value(), enm);
}
else {
generate_alias(dynamic_cast<enum_ &>(*subpackage), ostr);
generate(dynamic_cast<enum_ &>(*subpackage), ostr);
generate_alias(*enm, ostr);
generate(*enm, ostr);
}
}
}
}
if (m_config.generate_packages()) {
// Now generate any diagram elements which are in together
// groups
for (const auto &[group_name, group_elements] :
together_group_stack_.get_current_groups()) {
ostr << "together {\n";
for (auto *e : group_elements) {
if (auto *cls = dynamic_cast<class_ *>(e); cls) {
generate_alias(*cls, ostr);
generate(*cls, ostr);
}
if (auto *enm = dynamic_cast<enum_ *>(e); enm) {
generate_alias(*enm, ostr);
generate(*enm, ostr);
}
}
ostr << "}\n";
}
// Don't generate packages from namespaces filtered out by
// using_namespace
if (!uns.starts_with({p.full_name(false)})) {
@@ -551,6 +596,21 @@ void generator::generate(std::ostream &ostr) const
generate_plantuml_directives(ostr, m_config.puml().before);
generate_top_level_elements(ostr);
generate_groups(ostr);
generate_relationships(ostr);
generate_config_layout_hints(ostr);
generate_plantuml_directives(ostr, m_config.puml().after);
ostr << "@enduml" << '\n';
}
void generator::generate_top_level_elements(std::ostream &ostr) const
{
for (const auto &p : m_model) {
if (auto *pkg = dynamic_cast<package *>(p.get()); pkg) {
if (!pkg->is_empty())
@@ -561,8 +621,8 @@ void generator::generate(std::ostream &ostr) const
auto together_group =
m_config.get_together_group(cls->full_name(false));
if (together_group) {
current_level_together_groups_[together_group.value()]
.push_back(cls);
together_group_stack_.group_together(
together_group.value(), cls);
}
else {
generate_alias(*cls, ostr);
@@ -575,8 +635,8 @@ void generator::generate(std::ostream &ostr) const
auto together_group =
m_config.get_together_group(enm->full_name(false));
if (together_group) {
current_level_together_groups_[together_group.value()]
.push_back(enm);
together_group_stack_.group_together(
together_group.value(), enm);
}
else {
generate_alias(*enm, ostr);
@@ -585,13 +645,14 @@ void generator::generate(std::ostream &ostr) const
}
}
}
}
// Now generate any diagram elements which are in together groups
void generator::generate_groups(std::ostream &ostr) const
{
for (const auto &[group_name, group_elements] :
current_level_together_groups_) {
ostr << "' together group for " << group_name << "\n";
together_group_stack_.get_current_groups()) {
ostr << "together {\n";
for (auto *e : group_elements) {
if (auto *cls = dynamic_cast<class_ *>(e); cls) {
generate_alias(*cls, ostr);
@@ -602,30 +663,9 @@ void generator::generate(std::ostream &ostr) const
generate(*enm, ostr);
}
}
ostr << "}\n";
}
for (const auto &p : m_model) {
if (auto *pkg = dynamic_cast<package *>(p.get()); pkg) {
generate_relationships(*pkg, ostr);
}
else if (auto *cls = dynamic_cast<class_ *>(p.get()); cls) {
if (m_model.should_include(*cls)) {
generate_relationships(*cls, ostr);
}
}
else if (auto *enm = dynamic_cast<enum_ *>(p.get()); enm) {
if (m_model.should_include(*enm)) {
generate_relationships(*enm, ostr);
}
}
}
generate_config_layout_hints(ostr);
generate_plantuml_directives(ostr, m_config.puml().after);
ostr << "@enduml" << '\n';
}
} // namespace clanguml::class_diagram::generators::plantuml

11
src/class_diagram/generators/plantuml/class_diagram_generator.h
View File

@@ -21,6 +21,7 @@
#include "class_diagram/model/diagram.h"
#include "class_diagram/model/enum.h"
#include "class_diagram/visitor/translation_unit_visitor.h"
#include "common/generators/nested_element_stack.h"
#include "common/generators/plantuml/generator.h"
#include "common/model/relationship.h"
#include "config/config.h"
@@ -66,6 +67,10 @@ public:
void generate(const class_ &c, std::ostream &ostr) const;
void generate_top_level_elements(std::ostream &ostr) const;
void generate_relationships(std::ostream &ostr) const;
void generate_relationships(const class_ &c, std::ostream &ostr) const;
void generate(const enum_ &e, std::ostream &ostr) const;
@@ -79,13 +84,15 @@ public:
void generate_member_notes(std::ostream &ostream,
const class_element &member, const std::string &basicString) const;
void generate_groups(std::ostream &ostr) const;
void generate(std::ostream &ostr) const override;
private:
std::string render_name(std::string name) const;
mutable std::map<std::string, std::vector<common::model::element *>>
current_level_together_groups_;
mutable common::generators::nested_element_stack<common::model::element>
together_group_stack_;
};
} // namespace plantuml