WIP (#432)

Author: bkryza

src/class_diagram/model/diagram.cc

@@ -313,34 +313,6 @@ bool diagram::has_element(eid_t id) const
         [id](const auto &c) { return c.get().id() == id; });
 }
 
-std::string diagram::to_alias(eid_t id) const
-{
-    LOG_TRACE("Looking for alias for {}", id);
-
-    for (const auto &c : classes()) {
-        if (c.get().id() == id) {
-            return c.get().alias();
-        }
-    }
-
-    for (const auto &e : enums()) {
-        if (e.get().id() == id)
-            return e.get().alias();
-    }
-
-    for (const auto &c : concepts()) {
-        if (c.get().id() == id)
-            return c.get().alias();
-    }
-
-    for (const auto &c : objc_interfaces()) {
-        if (c.get().id() == id)
-            return c.get().alias();
-    }
-
-    throw error::uml_alias_missing(fmt::format("Missing alias for {}", id));
-}
-
 void diagram::remove_redundant_dependencies()
 {
     using common::eid_t;
@@ -376,49 +348,6 @@ void diagram::remove_redundant_dependencies()
     });
 }
 
-void diagram::apply_filter()
-{
-    common::model::apply_filter(relationships(), filter());
-
-    // First find all element ids which should be removed
-    std::set<eid_t> to_remove;
-
-    while (true) {
-        for_all_elements([&](auto &&elements_view) mutable {
-            for (const auto &el : elements_view)
-                if (!filter().should_include(el.get()))
-                    to_remove.emplace(el.get().id());
-        });
-
-        if (to_remove.empty())
-            break;
-
-        element_view<class_>::remove(to_remove);
-        element_view<enum_>::remove(to_remove);
-        element_view<concept_>::remove(to_remove);
-        element_view<objc_interface>::remove(to_remove);
-
-        nested_trait_ns::remove(to_remove);
-
-        to_remove.clear();
-
-        filter().reset();
-    }
-
-    for_all_elements([&](auto &&elements_view) mutable {
-        for (const auto &el : elements_view)
-            el.get().apply_filter(filter(), to_remove);
-    });
-
-    auto &rels = relationships();
-    rels.erase(std::remove_if(std::begin(rels), std::end(rels),
-                   [&to_remove](auto &&r) {
-                       return to_remove.count(r.source()) > 0 ||
-                           to_remove.count(r.destination()) > 0;
-                   }),
-        std::end(rels));
-}
-
 bool diagram::is_empty() const
 {
     return element_view<class_>::is_empty() &&

src/class_diagram/model/diagram.h

@@ -20,6 +20,7 @@
 #include "class.h"
 #include "common/model/diagram.h"
 #include "common/model/element_view.h"
+#include "common/model/filters/diagram_filter.h"
 #include "common/model/nested_trait.h"
 #include "common/model/package.h"
 #include "common/types.h"
@@ -44,21 +45,16 @@ using common::model::element_views;
 using common::model::path;
 using common::model::path_type;
 
-using nested_trait_ns =
-    clanguml::common::model::nested_trait<clanguml::common::model::element,
-        clanguml::common::model::namespace_>;
-
 /**
  * @brief Class representing a class diagram.
  */
-class diagram : public common::model::diagram,
-                public element_views<class_, enum_, concept_, objc_interface>,
-                public nested_trait_ns {
+class diagram : public common::model::hierarchical_diagram<class_, enum_,
+                    concept_, objc_interface> {
 public:
-    using nested_trait_t = nested_trait_ns;
-
     diagram(const config::class_diagram &config)
-        : clanguml::common::model::diagram{config}, config_{config}
+        : common::model::hierarchical_diagram<class_, enum_, concept_,
+              objc_interface>(config)
+        , config_{config}
     {
     }
 
@@ -76,11 +72,6 @@ class diagram : public common::model::diagram,
      */
     diagram_t type() const override;
 
-    /**
-     * Inherit the should_include methods from the common diagram model.
-     */
-    using common::model::diagram::should_include;
-
     /**
      * @brief Whether a class_member should be included in the diagram.
      *
@@ -243,37 +234,21 @@ class diagram : public common::model::diagram,
     void add_concept(std::unique_ptr<concept_> &&c);
 
     void add_objc_interface(std::unique_ptr<objc_interface> &&c);
-
-    template <typename ElementT> void move(eid_t id, const path &parent_path)
-    {
-        LOG_DBG("Moving element {} to package {}", id.value(),
-            parent_path.to_string());
-
-        auto e = nested_trait_ns::get_and_remove<ElementT>(id);
-        assert(e);
-
-        element_view<ElementT>::remove({id});
-        added_elements_.erase(id);
-
-        this->add<ElementT>(parent_path, std::move(e));
-    }
-
-    template <typename ElementT> void remove(eid_t id)
-    {
-        nested_trait_ns::remove({id});
-        element_view<ElementT>::remove({id});
-    }
-
-    /**
-     * @brief Convert element id to PlantUML alias.
-     *
-     * @todo This method does not belong here - refactor to PlantUML specific
-     *       code.
-     *
-     * @param id Id of the diagram element.
-     * @return PlantUML alias.
-     */
-    std::string to_alias(eid_t id) const;
+    //
+    //    template <typename ElementT> void move(eid_t id, const path
+    //    &parent_path)
+    //    {
+    //        LOG_DBG("Moving element {} to package {}", id.value(),
+    //            parent_path.to_string());
+    //
+    //        auto e = nested_trait_ns::get_and_remove<ElementT>(id);
+    //        assert(e);
+    //
+    //        element_view<ElementT>::remove({id});
+    //        added_elements_.erase(id);
+    //
+    //        this->add<ElementT>(parent_path, std::move(e));
+    //    }
 
     /**
      * @brief Given an initial set of classes, add all their parents to the
@@ -312,17 +287,6 @@ class diagram : public common::model::diagram,
     const config::class_diagram &config_;
 
     std::set<eid_t> added_elements_;
-
-    template <typename ElementT>
-    bool add_with_namespace_path(std::unique_ptr<ElementT> &&e);
-
-    template <typename ElementT>
-    bool add_with_module_path(
-        const common::model::path &parent_path, std::unique_ptr<ElementT> &&e);
-
-    template <typename ElementT>
-    bool add_with_filesystem_path(
-        const common::model::path &parent_path, std::unique_ptr<ElementT> &&e);
 };
 
 template <typename ElementT> bool diagram::contains(const ElementT &element)
@@ -333,143 +297,6 @@ template <typename ElementT> bool diagram::contains(const ElementT &element)
             const auto &element_opt) { return element_opt.get() == element; });
 }
 
-template <typename ElementT>
-bool diagram::add_with_namespace_path(std::unique_ptr<ElementT> &&e)
-{
-    if (added_elements_.count(e->id()) > 0)
-        return true;
-
-    added_elements_.emplace(e->id());
-
-    const auto base_name = e->name();
-    const auto full_name = e->full_name(false);
-    const auto element_type = e->type_name();
-
-    LOG_DBG("Adding {}: {}::{}, {} [{}]", element_type,
-        e->get_namespace().to_string(), base_name, full_name, e->id().usr());
-
-    if (util::contains(base_name, "::"))
-        throw std::runtime_error("Name cannot contain namespace: " + base_name);
-
-    const auto ns = e->get_relative_namespace();
-
-    auto name = base_name;
-    auto name_and_ns = ns | name;
-    auto &e_ref = *e;
-    auto id = e_ref.id();
-
-    try {
-        if (!contains(e_ref)) {
-            if (add_element(ns, std::move(e)))
-                element_view<ElementT>::add(std::ref(e_ref));
-
-#if !defined(NDEBUG)
-            const auto maybe_el = get_element<ElementT>(name_and_ns);
-            const auto &el = maybe_el.value();
-
-            if ((el.name() != name) || !(el.get_relative_namespace() == ns))
-                throw std::runtime_error(
-                    "Invalid element stored in the diagram tree");
-
-            LOG_DBG("Added {} {} ({} - [{}])", element_type, base_name,
-                full_name, id);
-#endif
-
-            return true;
-        }
-    }
-    catch (const std::runtime_error &e) {
-        LOG_WARN("Cannot add {} {} with id {} due to: {}", element_type, name,
-            id, e.what());
-        return false;
-    }
-
-    LOG_DBG("{} {} ({} - [{}]) already in the model", element_type, base_name,
-        full_name, id);
-
-    return false;
-}
-
-template <typename ElementT>
-bool diagram::add_with_module_path(
-    const common::model::path &parent_path, std::unique_ptr<ElementT> &&e)
-{
-    if (added_elements_.count(e->id()) > 0)
-        return true;
-
-    added_elements_.emplace(e->id());
-
-    const auto element_type = e->type_name();
-
-    // Make sure all parent modules are already packages in the
-    // model
-    for (auto it = parent_path.begin(); it != parent_path.end(); it++) {
-        auto pkg = std::make_unique<common::model::package>(
-            e->using_namespace(), parent_path.type());
-        pkg->set_name(*it);
-        auto ns =
-            common::model::path(parent_path.begin(), it, parent_path.type());
-        // ns.pop_back();
-        pkg->set_namespace(ns);
-        pkg->set_id(common::to_id(*pkg));
-
-        add(ns, std::move(pkg));
-    }
-
-    const auto base_name = e->name();
-    const auto full_name = e->full_name(false);
-    auto &e_ref = *e;
-
-    if (add_element(parent_path, std::move(e))) {
-        element_view<ElementT>::add(std::ref(e_ref));
-        return true;
-    }
-
-    return false;
-}
-
-template <typename ElementT>
-bool diagram::add_with_filesystem_path(
-    const common::model::path &parent_path, std::unique_ptr<ElementT> &&e)
-{
-    if (added_elements_.count(e->id()) > 0)
-        return false;
-
-    LOG_DBG("Adding element {} at path {}", e->full_name(false),
-        parent_path.to_string());
-
-    const auto element_type = e->type_name();
-
-    // Make sure all parent modules are already packages in the
-    // model
-    for (auto it = parent_path.begin(); it != parent_path.end(); it++) {
-        auto pkg = std::make_unique<common::model::package>(
-            e->using_namespace(), parent_path.type());
-        pkg->set_name(*it);
-        auto package_path =
-            common::model::path(parent_path.begin(), it, parent_path.type());
-        pkg->set_namespace(package_path);
-        pkg->set_id(common::to_id(*pkg));
-
-        LOG_DBG("Adding filesystem package {} at path {}", pkg->name(),
-            package_path.to_string());
-
-        add(package_path, std::move(pkg));
-    }
-
-    const auto base_name = e->name();
-    const auto full_name = e->full_name(false);
-    auto &e_ref = *e;
-
-    if (add_element(parent_path, std::move(e))) {
-        added_elements_.emplace(e_ref.id());
-        element_view<ElementT>::add(std::ref(e_ref));
-        return true;
-    }
-
-    return false;
-}
-
 template <typename ElementT>
 opt_ref<ElementT> diagram::find(const std::string &name) const
 {
@@ -523,23 +350,6 @@ const common::reference_vector<ElementT> &diagram::elements() const
     return element_view<ElementT>::view();
 }
 
-//
-// Template method specialization pre-declarations...
-//
-template <>
-bool diagram::add_with_namespace_path<common::model::package>(
-    std::unique_ptr<common::model::package> &&p);
-
-template <>
-bool diagram::add_with_module_path<common::model::package>(
-    const common::model::path &parent_path,
-    std::unique_ptr<common::model::package> &&p);
-
-template <>
-bool diagram::add_with_filesystem_path<common::model::package>(
-    const common::model::path &parent_path,
-    std::unique_ptr<common::model::package> &&p);
-
 } // namespace clanguml::class_diagram::model
 
 namespace clanguml::common::model {

src/class_diagram/visitor/translation_unit_visitor.h

@@ -674,20 +674,7 @@ bool translation_unit_visitor::add_or_update(
         set_source_location(*cls, class_model);
     }
 
-    if (is_complete_definition) {
-        if (maybe_existing_model &&
-            config().package_type() == config::package_type_t::kDirectory) {
-            // Move the class model to current filesystem path
-            // Eventually, this should be refactored so that it's
-            // not needed
-            const auto file = config().make_path_relative(class_model.file());
-            common::model::path p{
-                file.string(), common::model::path_type::kFilesystem};
-            p.pop_back();
-            diagram().move<ElementT>(id, p);
-        }
-    }
-    else {
+    if (!is_complete_definition) {
         forward_declarations_.get<ElementT>().emplace(id, std::move(c_ptr));
         return true;
     }