Merge pull request #2051 from eclipse-iceoryx/iox-2044-refactor-fixed…

…-position-container-and-move-to-dust iox-#2044 Refactor fixed position container and move to dust
eclipse-iceoryx · Oct 25, 2023 · 811bd76 · 811bd76
2 parents 89ea8f7 + 17657f4
commit 811bd76
Show file tree

Hide file tree

Showing 17 changed files with 2,589 additions and 24 deletions.
diff --git a/.clang-tidy b/.clang-tidy
@@ -5,6 +5,9 @@
 # - hicpp-member-init (duplicate of cppcoreguidelines-pro-type-member-init)
 # - performance-move-const-arg (duplicate of hicpp-move-const-arg)
 # - bugprone-use-after-move (duplicate of hicpp-move-const-arg)
+#
+# NOTE: following checks are disabled because they are deprecated
+# - cert-dcl21-cpp
 
 Checks: '
 -*,
@@ -32,6 +35,8 @@ hicpp-*,
 -readability-use-anyofallof,
 -readability-named-parameter,
 
+-cert-dcl21-cpp
+
 '
 
 ### Temporarily disabled because massive API changes:

diff --git a/doc/website/release-notes/iceoryx-unreleased.md b/doc/website/release-notes/iceoryx-unreleased.md
@@ -162,6 +162,7 @@
 - Speed up posh tests [#1030](https://github.com/eclipse-iceoryx/iceoryx/issues/1030)
 - Roudi Environment independent from Googletest [#1533](https://github.com/eclipse-iceoryx/iceoryx/issues/1533)
 - Move test class for ctor and assignment operators to hoofs testing [#2041](https://github.com/eclipse-iceoryx/iceoryx/issues/2041)
+- Refactor `FixdePositionContainer` and move to `dust` [#2044](https://github.com/eclipse-iceoryx/iceoryx/issues/2044)
 
 **Workflow:**
 

diff --git a/iceoryx_dust/BUILD.bazel b/iceoryx_dust/BUILD.bazel
@@ -33,10 +33,11 @@ cc_library(
         "source/**/*.cpp",
         "source/**/*.hpp",
     ]),
-    hdrs = glob(["include/**"] + glob(["vocabulary/**"])) + [
+    hdrs = glob(["include/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + [
         ":iceoryx_dust_deployment_hpp",
     ],
     includes = [
+        "container/include/",
         "include",
         "vocabulary/include/",
     ],

diff --git a/iceoryx_dust/CMakeLists.txt b/iceoryx_dust/CMakeLists.txt
@@ -47,10 +47,12 @@ iox_add_library(
     PRIVATE_LIBS_LINUX          ${CODE_COVERAGE_LIBS}
     PUBLIC_LIBS                 iceoryx_hoofs::iceoryx_hoofs
     BUILD_INTERFACE             ${PROJECT_SOURCE_DIR}/include
+                                ${PROJECT_SOURCE_DIR}/container/include
                                 ${PROJECT_SOURCE_DIR}/vocabulary/include
                                 ${CMAKE_BINARY_DIR}/generated/iceoryx/include
     INSTALL_INTERFACE           include/${PREFIX}
     EXPORT_INCLUDE_DIRS         include/
+                                container/include/
                                 vocabulary/include/
     FILES
         source/cli/arguments.cpp

diff --git a/iceoryx_dust/README.md b/iceoryx_dust/README.md
@@ -12,6 +12,7 @@ grouped together in categories or namespace, depending on where or how they are
 |`forward_list`         | Heap and exception free, relocatable implementation of `std::forward_list`                                                                                                                                                                                                                                            |
 |`ObjectPool`           | Container which stores raw objects without calling the ctor of the objects.                                                                                                                                                                                                                                           |
 |`FileReader`           | Wrapper for opening files and reading them.                                                                                                                                                                                                                                                                           |
+|`FixedPositionContainer` | A fixed-position container is similar to a list but is optimized for iterating over its elements without the back-and-forth jumping that can occur during iteration in a list. |
 |`MessageQueue`         | Interface for Message Queues, see [ManPage mq_overview](https://www.man7.org/linux/man-pages/man7/mq_overview.7.html).                                                                                                                                                                                                |
 |`SignalWatcher`        | Batteries included signal handling with polling and optional blocking wait for `SIGINT` and `SIGTERM`.                                                                                                                                                                                                                |
 |`NamedPipe`            | Shared memory based IPC channel. Mainly a `UnixDomainSocket` replacement on Windows.                                                                                                                                                                                                                                  |