Added initial support for directory based packages in class diagrams

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

View File

@@ -168,7 +168,11 @@ void generator::generate(const package &p, nlohmann::json &parent) const
if (!uns.starts_with({p.full_name(false)})) { if (!uns.starts_with({p.full_name(false)})) {
LOG_DBG("Generating package {}", p.name()); 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["name"] = p.name();
package_object["display_name"] = p.full_name(false); package_object["display_name"] = p.full_name(false);
} }

View File

@@ -173,6 +173,15 @@ common::optional_ref<concept_> diagram::get_concept(
return {}; 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) bool diagram::add_package(std::unique_ptr<common::model::package> &&p)
{ {
LOG_DBG("Adding namespace package: {}, {}", p->name(), p->full_name(true)); 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)); 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) bool diagram::add_class(std::unique_ptr<class_> &&c)
{ {
const auto base_name = c->name(); 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) { catch (const std::runtime_error &e) {
LOG_WARN( 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; return false;
} }

View File

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

View File

@@ -40,6 +40,9 @@ bool translation_unit_visitor::VisitNamespaceDecl(clang::NamespaceDecl *ns)
{ {
assert(ns != nullptr); assert(ns != nullptr);
if (config().package_type() == config::package_type_t::kDirectory)
return true;
if (ns->isAnonymousNamespace() || ns->isInline()) if (ns->isAnonymousNamespace() || ns->isInline())
return true; return true;
@@ -741,11 +744,11 @@ bool translation_unit_visitor::VisitCXXRecordDecl(clang::CXXRecordDecl *cls)
} }
forward_declarations_.erase(id); 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), LOG_DBG("Adding class {} with id {}", class_model.full_name(false),
class_model.id()); class_model.id());
diagram_.add_class(std::move(c_ptr)); add_class(std::move(c_ptr));
} }
else { else {
LOG_DBG("Skipping class {} with id {}", class_model.full_name(), 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(), relationships.emplace_back(template_specialization_ptr->id(),
relationship_t::kDependency); 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(), relationships.emplace_back(template_specialization_ptr->id(),
relationship_t::kDependency); 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 - absolute_lambda_path_end -
(lambda_begin + lambda_prefix.size() - 1)); (lambda_begin + lambda_prefix.size() - 1));
auto relative_lambda_path = util::path_to_url(std::filesystem::relative( auto relative_lambda_path = util::path_to_url(
absolute_lambda_path, config().relative_to()) config().make_path_relative(absolute_lambda_path).string());
.string());
parameter_type = fmt::format("{}(lambda at {}{}", parameter_type = fmt::format("{}(lambda at {}{}",
parameter_type.substr(0, lambda_begin), relative_lambda_path, 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 // Add the template instantiation object to the diagram if it
// matches the include pattern // matches the include pattern
if (add_template_instantiation_to_diagram) 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_) { for (auto &[id, c] : forward_declarations_) {
if (diagram().should_include(c->full_name(false))) { if (diagram().should_include(c->full_name(false))) {
diagram().add_class(std::move(c)); add_class(std::move(c));
} }
} }
forward_declarations_.clear(); forward_declarations_.clear();
@@ -2092,4 +2094,35 @@ bool translation_unit_visitor::has_processed_template_class(
return util::contains(processed_template_qualified_names_, qualified_name); 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 } // namespace clanguml::class_diagram::visitor

View File

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

View File

@@ -39,7 +39,7 @@ public:
virtual diagram_t type() const = 0; virtual diagram_t type() const = 0;
virtual common::optional_ref<clanguml::common::model::diagram_element> get( virtual opt_ref<clanguml::common::model::diagram_element> get(
const std::string &full_name) const = 0; const std::string &full_name) const = 0;
virtual common::optional_ref<clanguml::common::model::diagram_element> get( virtual common::optional_ref<clanguml::common::model::diagram_element> get(

View File

@@ -430,8 +430,8 @@ paths_filter::paths_filter(filter_t type, const std::filesystem::path &root,
absolute_path = path; absolute_path = path;
try { try {
absolute_path = absolute_path = absolute(absolute_path);
std::filesystem::canonical(absolute_path.lexically_normal()); absolute_path = canonical(absolute_path.lexically_normal());
} }
catch (std::filesystem::filesystem_error &e) { catch (std::filesystem::filesystem_error &e) {
LOG_WARN("Cannot add non-existent path {} to paths filter", LOG_WARN("Cannot add non-existent path {} to paths filter",
@@ -539,7 +539,7 @@ void diagram_filter::init_filters(const config::diagram &c)
filter_t::kInclusive, c.include().access)); filter_t::kInclusive, c.include().access));
add_inclusive_filter(std::make_unique<paths_filter>( add_inclusive_filter(std::make_unique<paths_filter>(
filter_t::kInclusive, c.relative_to(), c.include().paths)); filter_t::kInclusive, c.root_directory(), c.include().paths));
// Include any of these matches even if one them does not match // Include any of these matches even if one them does not match
std::vector<std::unique_ptr<filter_visitor>> element_filters; std::vector<std::unique_ptr<filter_visitor>> element_filters;
@@ -623,7 +623,7 @@ void diagram_filter::init_filters(const config::diagram &c)
filter_t::kExclusive, c.exclude().namespaces)); filter_t::kExclusive, c.exclude().namespaces));
add_exclusive_filter(std::make_unique<paths_filter>( add_exclusive_filter(std::make_unique<paths_filter>(
filter_t::kExclusive, c.relative_to(), c.exclude().paths)); filter_t::kExclusive, c.root_directory(), c.exclude().paths));
add_exclusive_filter(std::make_unique<element_filter>( add_exclusive_filter(std::make_unique<element_filter>(
filter_t::kExclusive, c.exclude().elements)); filter_t::kExclusive, c.exclude().elements));

View File

@@ -29,7 +29,7 @@ struct ns_path_separator {
static constexpr std::string_view value = "::"; static constexpr std::string_view value = "::";
}; };
using namespace_ = path<ns_path_separator>; using namespace_ = path;
} }

View File

@@ -19,6 +19,7 @@
#include "common/model/element.h" #include "common/model/element.h"
#include "common/model/nested_trait.h" #include "common/model/nested_trait.h"
#include "common/model/path.h"
#include "common/model/stylable_element.h" #include "common/model/stylable_element.h"
#include "common/types.h" #include "common/types.h"
#include "util/util.h" #include "util/util.h"
@@ -33,9 +34,9 @@ namespace clanguml::common::model {
class package : public element, class package : public element,
public stylable_element, public stylable_element,
public nested_trait<element, namespace_> { public nested_trait<element, path> {
public: public:
package(const common::model::namespace_ &using_namespace); package(const common::model::path &using_namespace);
package(const package &) = delete; package(const package &) = delete;
package(package &&) = default; package(package &&) = default;

View File

@@ -25,41 +25,84 @@
namespace clanguml::common::model { namespace clanguml::common::model {
template <typename Sep> class path { enum class path_type { kNamespace, kFilesystem };
class path {
const char *separator() const
{
switch (path_type_) {
case path_type::kNamespace:
return "::";
case path_type::kFilesystem:
#ifdef _WIN32
return "\\";
#else
return "/";
#endif
}
return "::";
}
public: public:
using container_type = std::vector<std::string>; using container_type = std::vector<std::string>;
path() = default; path(path_type pt = path_type::kNamespace)
: path_type_{pt}
{
}
explicit path(const std::string &ns) path(const std::string &ns, path_type pt = path_type::kNamespace)
: path_type_{pt}
{ {
if (ns.empty()) if (ns.empty())
return; return;
path_ = util::split(ns, Sep::value); path_ = util::split(ns, separator());
} }
virtual ~path() = default;
path(container_type::const_iterator begin, path(container_type::const_iterator begin,
container_type::const_iterator end) container_type::const_iterator end,
path_type pt = path_type::kNamespace)
: path(pt)
{ {
if (begin == end)
return;
std::copy(begin, end, std::back_inserter(path_)); std::copy(begin, end, std::back_inserter(path_));
} }
path(const path &right) path(const path &right)
: path_{right.path_} : path_type_{right.path_type_}
, path_{right.path_}
{ {
} }
path &operator=(const path &right) = default; path &operator=(const path &right)
{
if (path_type_ != right.path_type_)
throw std::runtime_error("");
path_type_ = right.path_type_;
path_ = right.path_;
return *this;
}
path(path &&right) noexcept = default; path(path &&right) noexcept = default;
path &operator=(path &&right) noexcept = default; path &operator=(path &&right) noexcept = default;
path(std::initializer_list<std::string> ns) path(std::initializer_list<std::string> ns,
path_type pt = path_type::kNamespace)
: path(pt)
{ {
if ((ns.size() == 1) && util::contains(*ns.begin(), Sep::value)) { if ((ns.size() == 1) &&
path_ = util::split(*ns.begin(), Sep::value); util::contains(*ns.begin(), std::string{separator()})) {
path_ = util::split(*ns.begin(), separator());
} }
else if ((ns.size() == 1) && ns.begin()->empty()) { else if ((ns.size() == 1) && ns.begin()->empty()) {
} }
@@ -67,10 +110,13 @@ public:
path_ = ns; path_ = ns;
} }
explicit path(const std::vector<std::string> &ns) explicit path(const std::vector<std::string> &ns,
path_type pt = path_type::kNamespace)
: path(pt)
{ {
if ((ns.size() == 1) && util::contains(*ns.begin(), Sep::value)) { if ((ns.size() == 1) &&
path_ = util::split(*ns.begin(), Sep::value); util::contains(*ns.begin(), std::string{separator()})) {
path_ = util::split(*ns.begin(), separator());
} }
else if ((ns.size() == 1) && ns.begin()->empty()) { else if ((ns.size() == 1) && ns.begin()->empty()) {
} }
@@ -78,19 +124,19 @@ public:
path_ = ns; path_ = ns;
} }
friend bool operator==(const path<Sep> &left, const path<Sep> &right) friend bool operator==(const path &left, const path &right)
{ {
return left.path_ == right.path_; return left.path_ == right.path_;
} }
friend bool operator<(const path<Sep> &left, const path<Sep> &right) friend bool operator<(const path &left, const path &right)
{ {
return std::hash<path<Sep>>{}(left) < std::hash<path<Sep>>{}(right); return left.to_string() < right.to_string();
} }
std::string to_string() const std::string to_string() const
{ {
return fmt::format("{}", fmt::join(path_, Sep::value)); return fmt::format("{}", fmt::join(path_, std::string{separator()}));
} }
bool is_empty() const { return path_.empty(); } bool is_empty() const { return path_.empty(); }
@@ -190,7 +236,7 @@ public:
return name; return name;
auto res = name; auto res = name;
auto ns_prefix = to_string() + std::string{Sep::value}; auto ns_prefix = to_string() + std::string{separator()};
auto it = res.find(ns_prefix); auto it = res.find(ns_prefix);
while (it != std::string::npos) { while (it != std::string::npos) {
@@ -220,7 +266,10 @@ public:
path::container_type::const_iterator begin() const { return path_.begin(); } path::container_type::const_iterator begin() const { return path_.begin(); }
path::container_type::const_iterator end() const { return path_.end(); } path::container_type::const_iterator end() const { return path_.end(); }
path_type type() const { return path_type_; }
private: private:
path_type path_type_;
container_type path_; container_type path_;
}; };

View File

@@ -46,7 +46,7 @@ struct fs_path_sep {
#endif #endif
}; };
using filesystem_path = common::model::path<fs_path_sep>; using filesystem_path = common::model::path;
class source_file class source_file
: public common::model::diagram_element, : public common::model::diagram_element,
@@ -60,7 +60,7 @@ public:
{ {
auto preferred = p; auto preferred = p;
preferred.make_preferred(); preferred.make_preferred();
set_path({preferred.parent_path().string()}); set_path({preferred.parent_path().string(), path_type::kFilesystem});
set_name(preferred.filename().string()); set_name(preferred.filename().string());
is_absolute_ = preferred.is_absolute(); is_absolute_ = preferred.is_absolute();
set_id(common::to_id(preferred)); set_id(common::to_id(preferred));
@@ -126,7 +126,7 @@ public:
} }
private: private:
filesystem_path path_; filesystem_path path_{path_type::kFilesystem};
source_file_t type_{source_file_t::kDirectory}; source_file_t type_{source_file_t::kDirectory};
bool is_absolute_{false}; bool is_absolute_{false};
}; };
@@ -134,21 +134,24 @@ private:
namespace std { namespace std {
template <> struct hash<clanguml::common::model::filesystem_path> { /*
std::size_t operator()( template <> struct hash<clanguml::common::model::filesystem_path> {
const clanguml::common::model::filesystem_path &key) const std::size_t operator()(
{ const clanguml::common::model::filesystem_path &key) const
using clanguml::common::model::path; {
using clanguml::common::model::path;
std::size_t seed = key.size(); std::size_t seed = key.size();
for (const auto &ns : key) { for (const auto &ns : key) {
seed ^= seed ^=
std::hash<std::string>{}(ns) + clanguml::util::hash_seed(seed); std::hash<std::string>{}(ns) +
} clanguml::util::hash_seed(seed);
}
return seed; return seed;
} }
}; };
*/
} // namespace std } // namespace std

View File

@@ -129,6 +129,8 @@ private:
T *value_{nullptr}; T *value_{nullptr};
}; };
template <typename T> using opt_ref = optional_ref<T>;
template <typename T> template <typename T>
using reference_vector = std::vector<std::reference_wrapper<T>>; using reference_vector = std::vector<std::reference_wrapper<T>>;

View File

@@ -107,6 +107,8 @@ void inheritable_diagram_options::inherit(
exclude.override(parent.exclude); exclude.override(parent.exclude);
puml.override(parent.puml); puml.override(parent.puml);
generate_method_arguments.override(parent.generate_method_arguments); generate_method_arguments.override(parent.generate_method_arguments);
generate_packages.override(parent.generate_packages);
package_type.override(parent.package_type);
generate_links.override(parent.generate_links); generate_links.override(parent.generate_links);
generate_system_headers.override(parent.generate_system_headers); generate_system_headers.override(parent.generate_system_headers);
git.override(parent.git); git.override(parent.git);
@@ -136,14 +138,20 @@ std::vector<std::string> diagram::get_translation_units() const
{ {
std::vector<std::string> translation_units{}; std::vector<std::string> translation_units{};
LOG_DBG("Looking for translation units in {}",
std::filesystem::current_path().string());
for (const auto &g : glob()) { for (const auto &g : glob()) {
std::string glob_path = std::string glob_path =
fmt::format("{}/{}", relative_to().string(), g.c_str()); fmt::format("{}/{}", root_directory().string(), g.c_str());
LOG_DBG("Searching glob path {}", glob_path);
auto matches = glob::glob(glob_path, true, false); auto matches = glob::glob(glob_path, true, false);
for (const auto &match : matches) { for (const auto &match : matches) {
const auto path = std::filesystem::canonical(relative_to() / match); const auto path =
std::filesystem::canonical(root_directory() / match);
translation_units.emplace_back(path.string()); translation_units.emplace_back(path.string());
} }
} }
@@ -151,6 +159,17 @@ std::vector<std::string> diagram::get_translation_units() const
return translation_units; return translation_units;
} }
std::filesystem::path diagram::root_directory() const
{
return canonical(absolute(base_directory() / relative_to()));
}
std::filesystem::path diagram::make_path_relative(
const std::filesystem::path &p) const
{
return relative(p, root_directory()).lexically_normal().string();
}
std::optional<std::string> diagram::get_together_group( std::optional<std::string> diagram::get_together_group(
const std::string &full_name) const const std::string &full_name) const
{ {

View File

@@ -37,6 +37,8 @@ namespace config {
enum class method_arguments { full, abbreviated, none }; enum class method_arguments { full, abbreviated, none };
enum class package_type_t { kNamespace, kDirectory };
std::string to_string(method_arguments ma); std::string to_string(method_arguments ma);
enum class comment_parser_t { plain, clang }; enum class comment_parser_t { plain, clang };
@@ -162,10 +164,17 @@ struct inheritable_diagram_options {
option<method_arguments> generate_method_arguments{ option<method_arguments> generate_method_arguments{
"generate_method_arguments", method_arguments::full}; "generate_method_arguments", method_arguments::full};
option<bool> generate_packages{"generate_packages", false}; option<bool> generate_packages{"generate_packages", false};
option<package_type_t> package_type{
"package_type", package_type_t::kNamespace};
option<generate_links_config> generate_links{"generate_links"}; option<generate_links_config> generate_links{"generate_links"};
option<git_config> git{"git"}; option<git_config> git{"git"};
option<layout_hints> layout{"layout"}; option<layout_hints> layout{"layout"};
// This is the absolute filesystem path to the directory containing
// the current .clang-uml config file - it is set automatically
option<std::filesystem::path> base_directory{"__parent_path"}; option<std::filesystem::path> base_directory{"__parent_path"};
// This is the relative path with respect to the `base_directory`,
// against which all matches are made, if not provided it defaults to the
// `base_directory`
option<std::filesystem::path> relative_to{"relative_to"}; option<std::filesystem::path> relative_to{"relative_to"};
option<bool> generate_system_headers{"generate_system_headers", false}; option<bool> generate_system_headers{"generate_system_headers", false};
option<relationship_hints_t> relationship_hints{"relationship_hints"}; option<relationship_hints_t> relationship_hints{"relationship_hints"};
@@ -190,6 +199,11 @@ struct diagram : public inheritable_diagram_options {
std::vector<std::string> get_translation_units() const; std::vector<std::string> get_translation_units() const;
std::filesystem::path make_path_relative(
const std::filesystem::path &p) const;
std::filesystem::path root_directory() const;
std::optional<std::string> get_together_group( std::optional<std::string> get_together_group(
const std::string &full_name) const; const std::string &full_name) const;

View File

@@ -34,6 +34,7 @@ using clanguml::config::layout_hint;
using clanguml::config::location_t; using clanguml::config::location_t;
using clanguml::config::method_arguments; using clanguml::config::method_arguments;
using clanguml::config::package_diagram; using clanguml::config::package_diagram;
using clanguml::config::package_type_t;
using clanguml::config::plantuml; using clanguml::config::plantuml;
using clanguml::config::relationship_hint_t; using clanguml::config::relationship_hint_t;
using clanguml::config::sequence_diagram; using clanguml::config::sequence_diagram;
@@ -88,6 +89,22 @@ void get_option<method_arguments>(
} }
} }
template <>
void get_option<package_type_t>(
const Node &node, clanguml::config::option<package_type_t> &option)
{
if (node[option.name]) {
const auto &val = node[option.name].as<std::string>();
if (val == "namespace")
option.set(package_type_t::kNamespace);
else if (val == "directory")
option.set(package_type_t::kDirectory);
else
throw std::runtime_error(
"Invalid generate_method_arguments value: " + val);
}
}
template <> template <>
void get_option<clanguml::config::comment_parser_t>(const Node &node, void get_option<clanguml::config::comment_parser_t>(const Node &node,
clanguml::config::option<clanguml::config::comment_parser_t> &option) clanguml::config::option<clanguml::config::comment_parser_t> &option)
@@ -403,6 +420,7 @@ template <> struct convert<class_diagram> {
get_option(node, rhs.include_relations_also_as_members); get_option(node, rhs.include_relations_also_as_members);
get_option(node, rhs.generate_method_arguments); get_option(node, rhs.generate_method_arguments);
get_option(node, rhs.generate_packages); get_option(node, rhs.generate_packages);
get_option(node, rhs.package_type);
get_option(node, rhs.relationship_hints); get_option(node, rhs.relationship_hints);
get_option(node, rhs.type_aliases); get_option(node, rhs.type_aliases);
get_option(node, rhs.relative_to); get_option(node, rhs.relative_to);
@@ -597,6 +615,7 @@ template <> struct convert<config> {
get_option(node, rhs.puml); get_option(node, rhs.puml);
get_option(node, rhs.generate_method_arguments); get_option(node, rhs.generate_method_arguments);
get_option(node, rhs.generate_packages); get_option(node, rhs.generate_packages);
get_option(node, rhs.package_type);
get_option(node, rhs.generate_links); get_option(node, rhs.generate_links);
get_option(node, rhs.generate_system_headers); get_option(node, rhs.generate_system_headers);
get_option(node, rhs.git); get_option(node, rhs.git);

View File

@@ -60,7 +60,8 @@ void diagram::add_file(std::unique_ptr<common::model::source_file> &&f)
if (!f->path().is_empty()) { if (!f->path().is_empty()) {
// If the parent path is not empty, ensure relative parent directories // If the parent path is not empty, ensure relative parent directories
// of this source_file are in the diagram // of this source_file are in the diagram
common::model::filesystem_path parent_path_so_far; common::model::filesystem_path parent_path_so_far{
common::model::path_type::kFilesystem};
for (const auto &directory : f->path()) { for (const auto &directory : f->path()) {
auto source_file_path = parent_path_so_far | directory; auto source_file_path = parent_path_so_far | directory;
if (parent_path_so_far.is_empty()) if (parent_path_so_far.is_empty())
@@ -83,6 +84,8 @@ void diagram::add_file(std::unique_ptr<common::model::source_file> &&f)
} }
} }
assert(p.type() == common::model::path_type::kFilesystem);
add_element(p, std::move(f)); add_element(p, std::move(f));
} }

View File

@@ -550,8 +550,7 @@ common::id_t generator::generate_participant(
nlohmann::json j = function_participant; nlohmann::json j = function_participant;
j["name"] = util::path_to_url( j["name"] = util::path_to_url(
std::filesystem::relative(function_participant.file(), m_config.make_path_relative(function_participant.file()).string());
std::filesystem::canonical(m_config.relative_to()).string()));
participant_id = common::to_id(function_participant.file_relative()); participant_id = common::to_id(function_participant.file_relative());

View File

@@ -329,11 +329,8 @@ void generator::generate_participant(
if (is_participant_generated(file_id)) if (is_participant_generated(file_id))
return; return;
const auto &relative_to =
std::filesystem::canonical(m_config.relative_to());
auto participant_name = util::path_to_url(std::filesystem::relative( auto participant_name = util::path_to_url(std::filesystem::relative(
std::filesystem::path{file_path}, relative_to) std::filesystem::path{file_path}, m_config.root_directory())
.string()); .string());
ostr << "participant \"" << render_name(participant_name) << "\" as " ostr << "participant \"" << render_name(participant_name) << "\" as "

View File

@@ -3,7 +3,7 @@ output_directory: puml
diagrams: diagrams:
t00061_class: t00061_class:
type: class type: class
relative_to: ../../tests/t00061 relative_to: ../../../tests/t00061
glob: glob:
- t00061.cc - t00061.cc
include: include:

15
tests/t00065/.clang-uml Normal file
View File

@@ -0,0 +1,15 @@
compilation_database_dir: ..
output_directory: puml
diagrams:
t00065_class:
type: class
glob:
- t00065.cc
relative_to: ../../../tests/t00065
generate_packages: true
package_type: directory
include:
namespaces:
- clanguml::t00065
using_namespace:
- clanguml::t00065

View File

@@ -0,0 +1,11 @@
#include "submodule1a/submodule1a.h"
#pragma once
namespace clanguml {
namespace t00065 {
struct A {
detail::AImpl *pimpl;
};
}
}

View File

@@ -0,0 +1,9 @@
#pragma once
namespace clanguml {
namespace t00065 {
namespace detail {
struct AImpl { };
}
}
}

View File

@@ -0,0 +1,7 @@
#pragma once
namespace clanguml {
namespace t00065 {
struct B { };
}
}

10
tests/t00065/t00065.cc Normal file
View File

@@ -0,0 +1,10 @@
#include "module1/module1.h"
#include "module2/module2.h"
namespace clanguml {
namespace t00065 {
struct R {
A *a;
};
}
}

83
tests/t00065/test_case.h Normal file
View File

@@ -0,0 +1,83 @@
/**
* tests/t00065/test_case.h
*
* Copyright (c) 2021-2023 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.
*/
TEST_CASE("t00065", "[test-case][class]")
{
auto [config, db] = load_config("t00065");
auto diagram = config.diagrams["t00065_class"];
REQUIRE(diagram->name == "t00065_class");
auto model = generate_class_diagram(*db, diagram);
REQUIRE(model->name() == "t00065_class");
{
auto puml = generate_class_puml(diagram, *model);
AliasMatcher _A(puml);
REQUIRE_THAT(puml, StartsWith("@startuml"));
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
// Check if all classes exist
// REQUIRE_THAT(puml, IsClass(_A("AAA")));
// Check if class templates exist
// REQUIRE_THAT(puml, IsClassTemplate("A", "T,P,CMP,int N"));
// Check concepts
// REQUIRE_THAT(puml, IsConcept(_A("AConcept<T>")));
// REQUIRE_THAT(puml,
// IsConceptRequirement(
// _A("AConcept<T,P>"), "sizeof (T) > sizeof (P)"));
// Check if all enums exist
// REQUIRE_THAT(puml, IsEnum(_A("Lights")));
// Check if all inner classes exist
// REQUIRE_THAT(puml, IsInnerClass(_A("A"), _A("AA")));
// Check if all inheritance relationships exist
// REQUIRE_THAT(puml, IsBaseClass(_A("Base"), _A("Child")));
// Check if all methods exist
// REQUIRE_THAT(puml, (IsMethod<Public, Const>("foo")));
// Check if all fields exist
// REQUIRE_THAT(puml, (IsField<Private>("private_member", "int")));
// Check if all relationships exist
// REQUIRE_THAT(puml, IsAssociation(_A("D"), _A("A"), "-as"));
// REQUIRE_THAT(puml, IsDependency(_A("R"), _A("B")));
// REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("D"), "-ag"));
// REQUIRE_THAT(puml, IsComposition(_A("R"), _A("D"), "-ac"));
// REQUIRE_THAT(puml, IsInstantiation(_A("ABCD::F<T>"), _A("F<int>")));
save_puml(
config.output_directory() + "/" + diagram->name + ".puml", puml);
}
{
auto j = generate_class_json(diagram, *model);
using namespace json;
save_json(config.output_directory() + "/" + diagram->name + ".json", j);
}
}

View File

@@ -4,9 +4,9 @@ diagrams:
t20017_sequence: t20017_sequence:
type: sequence type: sequence
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
relative_to: ../../tests/t20017 relative_to: ../../../tests/t20017
glob: glob:
- ../../tests/t20017/t20017.cc - t20017.cc
include: include:
namespaces: namespaces:
- clanguml::t20017 - clanguml::t20017

View File

@@ -301,6 +301,7 @@ using namespace clanguml::test::matchers;
#include "t00062/test_case.h" #include "t00062/test_case.h"
#include "t00063/test_case.h" #include "t00063/test_case.h"
#include "t00064/test_case.h" #include "t00064/test_case.h"
#include "t00065/test_case.h"
/// ///
/// Sequence diagram tests /// Sequence diagram tests