Implement Tree class (#30)

* Implement Tree class

Signed-off-by: jparisu <javierparis@eprosima.com>

* Add comment to classes

Signed-off-by: jparisu <javierparis@eprosima.com>

* uncrustify

Signed-off-by: jparisu <javierparis@eprosima.com>

Signed-off-by: jparisu <javierparis@eprosima.com>

Author: jparisu

cpp_utils/include/cpp_utils/macros/macros.hpp

@@ -66,7 +66,8 @@ namespace utils {
  */
 #define TYPE_NAME(x) typeid(x).name()
 
+#define MAX(x, y) x < y ? y : x
+#define MIN(x, y) x > y ? y : x
+
 } /* namespace utils */
 } /* namespace eprosima */
-
-

cpp_utils/include/cpp_utils/types/Tree.hpp

@@ -0,0 +1,85 @@
+// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// 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.
+
+/**
+ * @file Tree.hpp
+ *
+ * This file contains class Tree definition.
+ */
+
+#pragma once
+
+#include <list>
+
+namespace eprosima {
+namespace utils {
+
+/**
+ * Generic data struct of with an internal value of type \c Info .
+ */
+template <typename Info>
+struct Node
+{
+public:
+
+    Node();
+    Node(
+            const Info& info);
+    Node(
+            Info&& info);
+
+    template<typename ... Args>
+    Node(
+            Args... args);
+
+    Info info;
+};
+
+/**
+ * Class that represents each of the Nodes that form a Tree, including the source and the leaves.
+ */
+template <typename Info>
+class TreeNode : public Node<Info>
+{
+public:
+
+    using Node<Info>::Node;
+
+    void add_branch(
+            const Info& info);
+    void add_branch(
+            Info&& info);
+    void add_branch(
+            const TreeNode& node);
+    void add_branch(
+            TreeNode&& node);
+
+    bool leaf() const noexcept;
+
+    unsigned int depth() const noexcept;
+
+    const std::list<TreeNode>& branches() const noexcept;
+
+    std::list<TreeNode> all_nodes() const noexcept;
+
+protected:
+
+    std::list<TreeNode> branches_;
+};
+
+} /* namespace utils */
+} /* namespace eprosima */
+
+// Include implementation template file
+#include <cpp_utils/types/impl/Tree.ipp>

cpp_utils/include/cpp_utils/types/impl/Tree.ipp

@@ -0,0 +1,122 @@
+// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// 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.
+
+/**
+ * @file Tree.ipp
+ *
+ * This file contains class Tree implementation.
+ */
+
+#pragma once
+
+namespace eprosima {
+namespace utils {
+
+template <typename Info>
+Node<Info>::Node()
+{
+    // Do nothing
+}
+
+template <typename Info>
+Node<Info>::Node(
+        const Info& info)
+    : info(info)
+{
+    // Do nothing
+}
+
+template <typename Info>
+Node<Info>::Node(
+        Info&& info)
+    : info(std::move(info))
+{
+    // Do nothing
+}
+
+template <typename Info>
+template<typename ... Args>
+Node<Info>::Node(
+        Args... args)
+    : info(args ...)
+{
+    // Do nothing
+}
+
+template <typename Info>
+void TreeNode<Info>::add_branch(
+        const Info& info)
+{
+    branches_.push_back(TreeNode(info));
+}
+
+template <typename Info>
+void TreeNode<Info>::add_branch(
+        Info&& info)
+{
+    branches_.push_back(TreeNode(std::move(info)));
+}
+
+template <typename Info>
+void TreeNode<Info>::add_branch(
+        const TreeNode& node)
+{
+    branches_.push_back(node);
+}
+
+template <typename Info>
+void TreeNode<Info>::add_branch(
+        TreeNode&& node)
+{
+    branches_.push_back(std::move(node));
+}
+
+template <typename Info>
+bool TreeNode<Info>::leaf() const noexcept
+{
+    return branches_.empty();
+}
+
+template <typename Info>
+unsigned int TreeNode<Info>::depth() const noexcept
+{
+    unsigned int max_value = 0;
+    for (const auto& b : branches_)
+    {
+        auto child_value = b.depth();
+        max_value = MAX(max_value, child_value);
+    }
+    return max_value;
+}
+
+template <typename Info>
+const std::list<TreeNode<Info>>& TreeNode<Info>::branches() const noexcept
+{
+    return branches_;
+}
+
+template <typename Info>
+std::list<TreeNode<Info>> TreeNode<Info>::all_nodes() const noexcept
+{
+    std::list<TreeNode<Info>> result(branches_);
+    for (const auto& b : branches_)
+    {
+        auto b_branches = b.all_nodes();
+        result.splice(result.end(), b_branches);
+    }
+    return result;
+}
+
+} /* namespace utils */
+} /* namespace eprosima */