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

Added initial support for directory based packages in class diagrams

Browse Source
This commit is contained in:
Bartek Kryza
2023-05-21 11:55:41 +02:00
parent bca1162b16
commit 01c791e6a1
27 changed files with 399 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/class_diagram/generators/json/class_diagram_generator.cc
View File

@@ -168,7 +168,11 @@ void generator::generate(const package &p, nlohmann::json &parent) const
if (!uns.starts_with({p.full_name(false)})) {
LOG_DBG("Generating package {}", p.name());
package_object["type"] = "namespace";
if (m_config.package_type() == config::package_type_t::kDirectory)
package_object["type"] = "directory";
else
package_object["type"] = "namespace";
package_object["name"] = p.name();
package_object["display_name"] = p.full_name(false);
}

30
src/class_diagram/model/diagram.cc
View File

@@ -173,6 +173,15 @@ common::optional_ref<concept_> diagram::get_concept(
return {};
}
bool diagram::add_package_fs(std::unique_ptr<common::model::package> &&p)
{
LOG_DBG("Adding filesystem package: {}, {}", p->name(), p->full_name(true));
auto ns = p->get_namespace();
return add_element(ns, std::move(p));
}
bool diagram::add_package(std::unique_ptr<common::model::package> &&p)
{
LOG_DBG("Adding namespace package: {}, {}", p->name(), p->full_name(true));
@@ -182,6 +191,25 @@ bool diagram::add_package(std::unique_ptr<common::model::package> &&p)
return add_element(ns, std::move(p));
}
bool diagram::add_class_fs(
const common::model::path &p, std::unique_ptr<class_> &&c)
{
const auto base_name = c->name();
const auto full_name = c->full_name(false);
const auto id = c->id();
auto &cc = *c;
if (add_element(p, std::move(c))) {
classes_.push_back(std::ref(cc));
return true;
}
else {
LOG_WARN("Cannot add class {} with id {} due to: {}", base_name, id);
}
return false;
}
bool diagram::add_class(std::unique_ptr<class_> &&c)
{
const auto base_name = c->name();
@@ -221,7 +249,7 @@ bool diagram::add_class(std::unique_ptr<class_> &&c)
}
catch (const std::runtime_error &e) {
LOG_WARN(
"Cannot add concept {} with id {} due to: {}", name, id, e.what());
"Cannot add class {} with id {} due to: {}", name, id, e.what());
return false;
}

47
src/class_diagram/model/diagram.h
View File

@@ -31,10 +31,15 @@
namespace clanguml::class_diagram::model {
class diagram : public clanguml::common::model::diagram,
public clanguml::common::model::nested_trait<
clanguml::common::model::element,
clanguml::common::model::namespace_> {
using common::opt_ref;
using common::model::diagram_element;
using common::model::diagram_t;
using nested_trait_ns =
clanguml::common::model::nested_trait<clanguml::common::model::element,
clanguml::common::model::namespace_>;
class diagram : public common::model::diagram::diagram, public nested_trait_ns {
public:
diagram() = default;
@@ -43,13 +48,11 @@ public:
diagram &operator=(const diagram &) = delete;
diagram &operator=(diagram &&) = default;
common::model::diagram_t type() const override;
diagram_t type() const override;
common::optional_ref<common::model::diagram_element> get(
const std::string &full_name) const override;
opt_ref<diagram_element> get(const std::string &full_name) const override;
common::optional_ref<common::model::diagram_element> get(
clanguml::common::model::diagram_element::id_t id) const override;
opt_ref<diagram_element> get(diagram_element::id_t id) const override;
const common::reference_vector<class_> &classes() const;
@@ -63,20 +66,20 @@ public:
bool has_concept(const concept_ &e) const;
common::optional_ref<class_> get_class(const std::string &name) const;
opt_ref<class_> get_class(const std::string &name) const;
common::optional_ref<class_> get_class(
clanguml::common::model::diagram_element::id_t id) const;
opt_ref<class_> get_class(diagram_element::id_t id) const;
common::optional_ref<enum_> get_enum(const std::string &name) const;
opt_ref<enum_> get_enum(const std::string &name) const;
common::optional_ref<enum_> get_enum(
clanguml::common::model::diagram_element::id_t id) const;
opt_ref<enum_> get_enum(diagram_element::id_t id) const;
common::optional_ref<concept_> get_concept(const std::string &name) const;
opt_ref<concept_> get_concept(const std::string &name) const;
common::optional_ref<concept_> get_concept(
clanguml::common::model::diagram_element::id_t id) const;
opt_ref<concept_> get_concept(diagram_element::id_t id) const;
bool add_class_fs(
const common::model::path &p, std::unique_ptr<class_> &&c);
bool add_class(std::unique_ptr<class_> &&c);
@@ -86,15 +89,15 @@ public:
bool add_package(std::unique_ptr<common::model::package> &&p);
std::string to_alias(
clanguml::common::model::diagram_element::id_t id) const;
bool add_package_fs(std::unique_ptr<common::model::package> &&p);
std::string to_alias(diagram_element::id_t id) const;
void get_parents(clanguml::common::reference_set<class_> &parents) const;
friend void print_diagram_tree(const diagram &d, int level);
bool has_element(
clanguml::common::model::diagram_element::id_t id) const override;
bool has_element(diagram_element::id_t id) const override;
inja::json context() const override;

51
src/class_diagram/visitor/translation_unit_visitor.cc
View File

@@ -40,6 +40,9 @@ bool translation_unit_visitor::VisitNamespaceDecl(clang::NamespaceDecl *ns)
{
assert(ns != nullptr);
if (config().package_type() == config::package_type_t::kDirectory)
return true;
if (ns->isAnonymousNamespace() || ns->isInline())
return true;
@@ -741,11 +744,11 @@ bool translation_unit_visitor::VisitCXXRecordDecl(clang::CXXRecordDecl *cls)
}
forward_declarations_.erase(id);
if (diagram_.should_include(class_model)) {
if (diagram().should_include(class_model)) {
LOG_DBG("Adding class {} with id {}", class_model.full_name(false),
class_model.id());
diagram_.add_class(std::move(c_ptr));
add_class(std::move(c_ptr));
}
else {
LOG_DBG("Skipping class {} with id {}", class_model.full_name(),
@@ -1320,7 +1323,7 @@ void translation_unit_visitor::process_method(
relationships.emplace_back(template_specialization_ptr->id(),
relationship_t::kDependency);
diagram().add_class(std::move(template_specialization_ptr));
add_class(std::move(template_specialization_ptr));
}
}
}
@@ -1657,7 +1660,7 @@ void translation_unit_visitor::process_function_parameter(
relationships.emplace_back(template_specialization_ptr->id(),
relationship_t::kDependency);
diagram().add_class(std::move(template_specialization_ptr));
add_class(std::move(template_specialization_ptr));
}
}
@@ -1708,9 +1711,8 @@ void translation_unit_visitor::ensure_lambda_type_is_relative(
absolute_lambda_path_end -
(lambda_begin + lambda_prefix.size() - 1));
auto relative_lambda_path = util::path_to_url(std::filesystem::relative(
absolute_lambda_path, config().relative_to())
.string());
auto relative_lambda_path = util::path_to_url(
config().make_path_relative(absolute_lambda_path).string());
parameter_type = fmt::format("{}(lambda at {}{}",
parameter_type.substr(0, lambda_begin), relative_lambda_path,
@@ -1972,7 +1974,7 @@ void translation_unit_visitor::process_field(
// Add the template instantiation object to the diagram if it
// matches the include pattern
if (add_template_instantiation_to_diagram)
diagram().add_class(std::move(template_specialization_ptr));
add_class(std::move(template_specialization_ptr));
}
}
@@ -2004,7 +2006,7 @@ void translation_unit_visitor::add_incomplete_forward_declarations()
{
for (auto &[id, c] : forward_declarations_) {
if (diagram().should_include(c->full_name(false))) {
diagram().add_class(std::move(c));
add_class(std::move(c));
}
}
forward_declarations_.clear();
@@ -2092,4 +2094,35 @@ bool translation_unit_visitor::has_processed_template_class(
return util::contains(processed_template_qualified_names_, qualified_name);
}
void translation_unit_visitor::add_class(std::unique_ptr<class_> &&c)
{
if ((config().generate_packages() &&
config().package_type() == config::package_type_t::kDirectory)) {
assert(!c->file().empty());
const auto file = config().make_path_relative(c->file());
common::model::path p{file, common::model::path_type::kFilesystem};
p.pop_back();
// Make sure all parent directories are already packages in the model
for (auto it = p.begin(); it != p.end(); it++) {
auto pkg = std::make_unique<common::model::package>(
config().using_namespace());
pkg->set_name(*it);
auto ns = common::model::path(p.begin(), it);
// ns.pop_back();
pkg->set_namespace(ns);
pkg->set_id(common::to_id(pkg->full_name(false)));
diagram().add_package_fs(std::move(pkg));
}
diagram().add_class_fs(p, std::move(c));
}
else {
diagram().add_class(std::move(c));
}
}
} // namespace clanguml::class_diagram::visitor

2
src/class_diagram/visitor/translation_unit_visitor.h
View File

@@ -119,6 +119,8 @@ public:
void finalize();
private:
void add_class(std::unique_ptr<class_> &&c);
bool should_include(const clang::NamedDecl *decl);
std::unique_ptr<clanguml::class_diagram::model::class_>