iox-#1391 Move stack to buffer module

Signed-off-by: Marika Lehmann <[email protected]>

Author: FerdinandSpitzschnueffler

doc/website/release-notes/iceoryx-unreleased.md

@@ -56,7 +56,7 @@
 - Add check in `RelativePointer::get` to avoid `nullptr` dereferencing [\#1596](https://github.com/eclipse-iceoryx/iceoryx/issues/1596)
 - iceoryx_posh_testing cannot find iceoryx_hoofs_testing in CMake [\#1602](https://github.com/eclipse-iceoryx/iceoryx/issues/1602)
 - locking_policy.cpp calls error handler without log message [\#1609](https://github.com/eclipse-iceoryx/iceoryx/issues/1609)
-- Implement destructor, copy and move operations in `cxx::stack` [\#1469](https://github.com/eclipse-iceoryx/iceoryx/issues/1469)
+- Implement destructor, copy and move operations in `iox::stack` [\#1469](https://github.com/eclipse-iceoryx/iceoryx/issues/1469)
 - `gw::GatewayGeneric` sometimes terminates discovery and forward threads immediately [\#1666](https://github.com/eclipse-iceoryx/iceoryx/issues/1666)
 - `m_originId` in `mepoo::ChunkHeader` sometimes not set [\#1668](https://github.com/eclipse-iceoryx/iceoryx/issues/1668)
 - Remove `cxx::unique_ptr::reset` [\#1655](https://github.com/eclipse-iceoryx/iceoryx/issues/1655)

iceoryx_examples/complexdata/topic_data.hpp

@@ -19,8 +19,8 @@
 
 #include "iceoryx_dust/cxx/forward_list.hpp"
 #include "iceoryx_hoofs/cxx/list.hpp"
-#include "iceoryx_hoofs/cxx/stack.hpp"
 #include "iox/optional.hpp"
+#include "iox/stack.hpp"
 #include "iox/string.hpp"
 #include "iox/variant.hpp"
 #include "iox/vector.hpp"

iceoryx_hoofs/BUILD.bazel

@@ -37,10 +37,11 @@ cc_library(
         "design/source/*.cpp",
         "posix/time/source/*.cpp",
     ]),
-    hdrs = glob(["include/**"]) + glob(["legacy/**"]) + glob(["memory/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + glob(["time/**"]) + glob(["utility/**"]) + glob(["primitives/**"]) + glob(["posix/**"]) + glob(["design/**"]) + [
+    hdrs = glob(["include/**"]) + glob(["legacy/**"]) + glob(["memory/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + glob(["time/**"]) + glob(["utility/**"]) + glob(["primitives/**"]) + glob(["posix/**"]) + glob(["design/**"]) + glob(["buffer/**"]) + [
         ":iceoryx_hoofs_deployment_hpp",
     ],
     includes = [
+        "buffer/include/",
         "container/include/",
         "design/include",
         "include/",

iceoryx_hoofs/CMakeLists.txt

@@ -56,6 +56,7 @@ iox_add_library(
                                 ${PROJECT_SOURCE_DIR}/design/include
                                 ${PROJECT_SOURCE_DIR}/time/include
                                 ${PROJECT_SOURCE_DIR}/posix/time/include
+                                ${PROJECT_SOURCE_DIR}/buffer/include
                                 ${CMAKE_BINARY_DIR}/generated/iceoryx_hoofs/include
     INSTALL_INTERFACE           include/${PREFIX}
     EXPORT_INCLUDE_DIRS         include/
@@ -68,6 +69,7 @@ iox_add_library(
                                 design/include/
                                 time/include/
                                 posix/time/include/
+                                buffer/include/
     FILES
         source/concurrent/loffli.cpp
         posix/time/source/adaptive_wait.cpp

iceoryx_hoofs/include/iceoryx_hoofs/internal/cxx/stack.inl renamed to iceoryx_hoofs/buffer/include/iox/detail/stack.inl

@@ -13,15 +13,13 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_HOOFS_CXX_STACK_INL
-#define IOX_HOOFS_CXX_STACK_INL
+#ifndef IOX_HOOFS_BUFFER_STACK_INL
+#define IOX_HOOFS_BUFFER_STACK_INL
 
-#include "iceoryx_hoofs/cxx/stack.hpp"
+#include "iox/stack.hpp"
 
 namespace iox
 {
-namespace cxx
-{
 template <typename T, uint64_t Capacity>
 inline stack<T, Capacity>& stack<T, Capacity>::copy(const stack& rhs) noexcept
 {
@@ -196,7 +194,6 @@ inline constexpr uint64_t stack<T, Capacity>::capacity() noexcept
 }
 
 
-} // namespace cxx
 } // namespace iox
 
-#endif // IOX_HOOFS_CXX_STACK_INL
+#endif // IOX_HOOFS_BUFFER_STACK_INL

iceoryx_hoofs/include/iceoryx_hoofs/cxx/stack.hpp renamed to iceoryx_hoofs/buffer/include/iox/stack.hpp

@@ -13,8 +13,8 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_HOOFS_CXX_STACK_HPP
-#define IOX_HOOFS_CXX_STACK_HPP
+#ifndef IOX_HOOFS_BUFFER_STACK_HPP
+#define IOX_HOOFS_BUFFER_STACK_HPP
 
 #include "iceoryx_hoofs/cxx/algorithm.hpp"
 #include "iox/optional.hpp"
@@ -24,8 +24,6 @@
 
 namespace iox
 {
-namespace cxx
-{
 // AXIVION Next Construct AutosarC++19_03-A12.1.1 : it is guaranteed that the array elements are initialized before read
 // access
 // AXIVION Next Construct AutosarC++19_03-A9.6.1 : false positive since no bit-fields are involved
@@ -75,9 +73,8 @@ class stack final // NOLINT(cppcoreguidelines-pro-type-member-init, hicpp-member
     UninitializedArray<T, Capacity> m_data;
     uint64_t m_size{0U};
 };
-} // namespace cxx
 } // namespace iox
 
-#include "iceoryx_hoofs/internal/cxx/stack.inl"
+#include "iox/detail/stack.inl"
 
 #endif

iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/stack.hpp

@@ -0,0 +1,32 @@
+// Copyright (c) 2023 by Apex.AI Inc. All rights reserved.
+//
+// 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.
+//
+// SPDX-License-Identifier: Apache-2.0
+#ifndef IOX_HOOFS_CXX_STACK_HPP
+#define IOX_HOOFS_CXX_STACK_HPP
+
+#include "iox/stack.hpp"
+
+namespace iox
+{
+/// @todo iox-#1593 Deprecate include
+/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/stack.hpp' instead")]]
+namespace cxx
+{
+/// @deprecated use `iox::stack` instead of `iox::cxx::stack`
+using iox::stack;
+} // namespace cxx
+} // namespace iox
+
+#endif

iceoryx_hoofs/test/moduletests/test_cxx_stack.cpp renamed to iceoryx_hoofs/test/moduletests/test_buffer_stack.cpp

@@ -14,7 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_hoofs/cxx/stack.hpp"
+#include "iox/stack.hpp"
 #include "test.hpp"
 
 #include <vector>
@@ -127,7 +127,7 @@ class stack_test : public Test
 {
   public:
     static constexpr uint32_t STACK_SIZE = 10U;
-    cxx::stack<TestClass, STACK_SIZE> m_sut;
+    stack<TestClass, STACK_SIZE> m_sut;
 
     void pushElements(const uint32_t numberOfElements)
     {
@@ -216,7 +216,7 @@ TEST_F(stack_test, TestClassDTorIsCalledWhenStackGoesOutOfScope)
 {
     ::testing::Test::RecordProperty("TEST_ID", "3c496cb7-898b-4a65-a405-c42cbd7f0d7b");
     {
-        cxx::stack<TestClass, STACK_SIZE> sut;
+        stack<TestClass, STACK_SIZE> sut;
         sut.push();
         sut.push(1U, 2U, 3U);
         EXPECT_THAT(TestClass::dTor, Eq(0));
@@ -228,7 +228,7 @@ TEST_F(stack_test, StackDestroysElementsInReverseOrder)
 {
     ::testing::Test::RecordProperty("TEST_ID", "fb38b063-4921-46ae-bdf2-922f49a9ab41");
     {
-        cxx::stack<TestClass, STACK_SIZE> sut;
+        stack<TestClass, STACK_SIZE> sut;
         for (uint32_t i{0}; i < STACK_SIZE; ++i)
         {
             sut.push(i + 3, i + 1, i + 2);
@@ -248,7 +248,7 @@ TEST_F(stack_test, CopyConstructorWorksAndCallsTestClassCopyConstructor)
     constexpr uint32_t ELEMENT{13};
     m_sut.push(ELEMENT, ELEMENT, ELEMENT);
 
-    cxx::stack<TestClass, STACK_SIZE> testStack(m_sut);
+    stack<TestClass, STACK_SIZE> testStack(m_sut);
     EXPECT_THAT(TestClass::copyCTor, Eq(1));
     ASSERT_THAT(testStack.size(), Eq(1));
     EXPECT_THAT(testStack.pop().value(), Eq(TestClass(ELEMENT, ELEMENT, ELEMENT)));
@@ -257,7 +257,7 @@ TEST_F(stack_test, CopyConstructorWorksAndCallsTestClassCopyConstructor)
 TEST_F(stack_test, CopyConstructorWithEmptyStackWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "08bfe7d9-233e-47cc-a7ca-5520eb6b99df");
-    cxx::stack<TestClass, STACK_SIZE> testStack(m_sut);
+    stack<TestClass, STACK_SIZE> testStack(m_sut);
     EXPECT_THAT(TestClass::copyCTor, Eq(0));
     EXPECT_THAT(testStack.size(), Eq(0));
 }
@@ -267,7 +267,7 @@ TEST_F(stack_test, CopyConstructorWithFullStackWorks)
     ::testing::Test::RecordProperty("TEST_ID", "f5ff8a1c-8bd4-40a9-9b10-7e90f232d78a");
     pushElements(STACK_SIZE);
 
-    cxx::stack<TestClass, STACK_SIZE> testStack(m_sut);
+    stack<TestClass, STACK_SIZE> testStack(m_sut);
     EXPECT_THAT(TestClass::copyCTor, Eq(STACK_SIZE));
     EXPECT_THAT(testStack.size(), Eq(STACK_SIZE));
 
@@ -283,7 +283,7 @@ TEST_F(stack_test, CopyAssignmentWithEmptySourceWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "0b563f12-e565-49d8-ba62-7d9a2323afdb");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
 
     m_sut = testStack;
 
@@ -297,7 +297,7 @@ TEST_F(stack_test, CopyAssignmentWithEmptyDestinationWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "81ea12ea-14ad-474c-bfd7-72433c780ceb");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
 
     testStack = m_sut;
 
@@ -318,7 +318,7 @@ TEST_F(stack_test, CopyAssignmentWithLargerDestinationWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "2f07ec25-fd62-414f-bb41-9284ce9f69b2");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
     testStack.push(9U, 11U, 13U);
     const auto srcSize = testStack.size();
 
@@ -335,7 +335,7 @@ TEST_F(stack_test, CopyAssignmentWithLargerSourceWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "1a001c09-abc2-4518-a47a-30d41aca3be4");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
     testStack.push(17U, 19U, 23U);
     const auto destSize = testStack.size();
 
@@ -358,7 +358,7 @@ TEST_F(stack_test, MoveConstructorWorksAndCallsTestClassMoveConstructor)
     ::testing::Test::RecordProperty("TEST_ID", "e3ad8e37-a95a-4f35-bee0-c83961c626a7");
     constexpr uint32_t ELEMENT{46};
     m_sut.push(ELEMENT, ELEMENT, ELEMENT);
-    cxx::stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
+    stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
 
     EXPECT_THAT(TestClass::moveCTor, Eq(1));
     ASSERT_THAT(testStack.size(), Eq(1));
@@ -369,7 +369,7 @@ TEST_F(stack_test, MoveConstructorWorksAndCallsTestClassMoveConstructor)
 TEST_F(stack_test, MoveConstructorWithEmptyStackWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "2cb3bfc8-ef86-4648-90e0-c0d4375834cc");
-    cxx::stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
+    stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
     EXPECT_THAT(TestClass::moveCTor, Eq(0));
     EXPECT_THAT(testStack.size(), Eq(0));
     EXPECT_THAT(m_sut.size(), Eq(0));
@@ -379,7 +379,7 @@ TEST_F(stack_test, MoveConstructorWithFullStackWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "08661d3d-89d7-4ada-ba78-757e92eeb8d4");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
+    stack<TestClass, STACK_SIZE> testStack(std::move(m_sut));
 
     EXPECT_THAT(TestClass::moveCTor, Eq(STACK_SIZE));
     EXPECT_THAT(testStack.size(), Eq(STACK_SIZE));
@@ -397,7 +397,7 @@ TEST_F(stack_test, MoveAssignmentWithEmptySourceWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "a06a3f8e-a886-43e2-b119-adc66c2af799");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
 
     m_sut = std::move(testStack);
 
@@ -414,7 +414,7 @@ TEST_F(stack_test, MoveAssignmentWithEmptyDestinationWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "b67825b9-2053-453d-a2b7-5fe544f7b16d");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
 
     testStack = std::move(m_sut);
 
@@ -436,7 +436,7 @@ TEST_F(stack_test, MoveAssignmentWithLargerDestinationWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "de0b02d2-762e-41e7-a179-bd3f57da5dc6");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
     testStack.push(9U, 11U, 13U);
     const auto srcSize = testStack.size();
 
@@ -456,7 +456,7 @@ TEST_F(stack_test, MoveAssignmentWithLargerSourceWorks)
 {
     ::testing::Test::RecordProperty("TEST_ID", "7ff5a53d-18f7-447d-8bc8-04d2f9e38caa");
     pushElements(STACK_SIZE);
-    cxx::stack<TestClass, STACK_SIZE> testStack;
+    stack<TestClass, STACK_SIZE> testStack;
     testStack.push(17U, 19U, 23U);
     const auto destSize = testStack.size();
 

iceoryx_posh/include/iceoryx_posh/popo/wait_set.hpp

@@ -20,7 +20,6 @@
 #include "iceoryx_hoofs/cxx/algorithm.hpp"
 #include "iceoryx_hoofs/cxx/function.hpp"
 #include "iceoryx_hoofs/cxx/function_ref.hpp"
-#include "iceoryx_hoofs/cxx/stack.hpp"
 #include "iceoryx_posh/iceoryx_posh_types.hpp"
 #include "iceoryx_posh/internal/popo/building_blocks/condition_listener.hpp"
 #include "iceoryx_posh/internal/popo/building_blocks/condition_variable_data.hpp"
@@ -31,6 +30,7 @@
 #include "iceoryx_posh/popo/trigger.hpp"
 #include "iceoryx_posh/popo/trigger_handle.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/stack.hpp"
 #include "iox/vector.hpp"
 
 namespace iox
@@ -238,7 +238,7 @@ class WaitSet
     ConditionVariableData* m_conditionVariableDataPtr{nullptr};
     ConditionListener m_conditionListener;
 
-    cxx::stack<uint64_t, Capacity> m_indexRepository;
+    stack<uint64_t, Capacity> m_indexRepository;
     ConditionListener::NotificationVector_t m_activeNotifications;
 };
 

iceoryx_posh/test/integrationtests/test_publisher_subscriber_communication.cpp

@@ -17,14 +17,14 @@
 
 #include "iceoryx_dust/cxx/forward_list.hpp"
 #include "iceoryx_hoofs/cxx/list.hpp"
-#include "iceoryx_hoofs/cxx/stack.hpp"
 #include "iceoryx_hoofs/testing/barrier.hpp"
 #include "iceoryx_hoofs/testing/watch_dog.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 #include "iceoryx_posh/testing/roudi_gtest.hpp"
 #include "iox/optional.hpp"
+#include "iox/stack.hpp"
 #include "iox/string.hpp"
 #include "iox/variant.hpp"
 #include "iox/vector.hpp"