iox-eclipse-iceoryx#1614 Move UninitializedArray to internal, add sta…

…tic_assert Signed-off-by: Marika Lehmann <marika.lehmann@apex.ai>
ApexAI · Nov 1, 2022 · 1f5f480 · 1f5f480
1 parent f14fddc
commit 1f5f480
Show file tree

Hide file tree

Showing 18 changed files with 21 additions and 20 deletions.
diff --git a/.clang-tidy-diff-scans.txt b/.clang-tidy-diff-scans.txt
@@ -37,7 +37,6 @@
 ./iceoryx_hoofs/test/moduletests/test_posix*
 ./iceoryx_hoofs/include/iceoryx_hoofs/design_pattern/builder.hpp
 
-./iceoryx_hoofs/include/iceoryx_hoofs/containers/*
 ./iceoryx_hoofs/include/iceoryx_hoofs/internal/containers/*
 ./iceoryx_hoofs/test/moduletests/test_containers_*
 

diff --git a/iceoryx_dust/include/iceoryx_dust/cxx/forward_list.hpp b/iceoryx_dust/include/iceoryx_dust/cxx/forward_list.hpp
@@ -18,8 +18,8 @@
 #ifndef IOX_DUST_CXX_FORWARD_LIST_HPP
 #define IOX_DUST_CXX_FORWARD_LIST_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/helplets.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <cstdint>
 #include <iostream>

diff --git a/iceoryx_dust/include/iceoryx_dust/posix_wrapper/named_pipe.hpp b/iceoryx_dust/include/iceoryx_dust/posix_wrapper/named_pipe.hpp
@@ -17,9 +17,9 @@
 #define IOX_DUST_POSIX_WRAPPER_NAMED_PIPE_HPP
 
 #include "iceoryx_hoofs/concurrent/lockfree_queue.hpp"
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/string.hpp"
 #include "iceoryx_hoofs/design_pattern/creation.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/shared_memory_object.hpp"
 #include "iceoryx_hoofs/internal/units/duration.hpp"

diff --git a/iceoryx_hoofs/README.md b/iceoryx_hoofs/README.md
@@ -41,7 +41,7 @@ The module structure is a logical grouping. It is replicated for `concurrent` an
 |:---------------------:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 |`vector`               |          | Heap and exception free implementation of `std::vector`                                                                                                                                                                               |
 |`list`                 |          | Heap and exception free, relocatable implementation of `std::list`                                                                                                                                                                    |
-|`UninitializedArray`   |          | Wrapper class for an uninitialized C-style array which can be zeroed via a template parameter                                                                                                                                         |
+|`UninitializedArray`   | i        | Wrapper class for an uninitialized C-style array which can be zeroed via a template parameter                                                                                                                                         |
 
 ### Vocabulary types (vocabulary)
 

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/concurrent/lockfree_queue.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/concurrent/lockfree_queue.hpp
@@ -18,9 +18,9 @@
 #ifndef IOX_HOOFS_CONCURRENT_LOCKFREE_QUEUE_HPP
 #define IOX_HOOFS_CONCURRENT_LOCKFREE_QUEUE_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/optional.hpp"
 #include "iceoryx_hoofs/internal/concurrent/lockfree_queue/index_queue.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <atomic>
 

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/cxx/list.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/list.hpp
@@ -18,8 +18,8 @@
 #ifndef IOX_HOOFS_CXX_LIST_HPP
 #define IOX_HOOFS_CXX_LIST_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/helplets.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <cstdint>
 #include <iostream>

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/cxx/optional.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/optional.hpp
@@ -17,9 +17,9 @@
 #ifndef IOX_HOOFS_CXX_OPTIONAL_HPP
 #define IOX_HOOFS_CXX_OPTIONAL_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/functional_interface.hpp"
 #include "iceoryx_hoofs/cxx/requires.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <new> // needed for placement new in the construct_value member function
 #include <utility>

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/cxx/stack.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/stack.hpp
@@ -16,9 +16,9 @@
 #ifndef IOX_HOOFS_CXX_STACK_HPP
 #define IOX_HOOFS_CXX_STACK_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/algorithm.hpp"
 #include "iceoryx_hoofs/cxx/optional.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <cstdint>
 

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/cxx/string.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/string.hpp
@@ -17,9 +17,9 @@
 #ifndef IOX_HOOFS_CXX_STRING_HPP
 #define IOX_HOOFS_CXX_STRING_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/optional.hpp"
 #include "iceoryx_hoofs/cxx/type_traits.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/internal/cxx/string_internal.hpp"
 
 #include <algorithm>

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/cxx/vector.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/vector.hpp
@@ -17,10 +17,10 @@
 #ifndef IOX_HOOFS_CXX_VECTOR_HPP
 #define IOX_HOOFS_CXX_VECTOR_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/algorithm.hpp"
 #include "iceoryx_hoofs/cxx/attributes.hpp"
 #include "iceoryx_hoofs/cxx/requires.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/log/logging.hpp"
 
 #include <algorithm>

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/internal/concurrent/fifo.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/internal/concurrent/fifo.hpp
@@ -17,8 +17,8 @@
 #ifndef IOX_HOOFS_CONCURRENT_FIFO_HPP
 #define IOX_HOOFS_CONCURRENT_FIFO_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/optional.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <atomic>
 

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/internal/concurrent/sofi.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/internal/concurrent/sofi.hpp
@@ -17,8 +17,8 @@
 #ifndef IOX_HOOFS_CONCURRENT_SOFI_HPP
 #define IOX_HOOFS_CONCURRENT_SOFI_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/type_traits.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_platform/platform_correction.hpp"
 
 #include <atomic>

diff --git a/..._hoofs/containers/uninitialized_array.hpp → ...ternal/containers/uninitialized_array.hpp b/..._hoofs/containers/uninitialized_array.hpp → ...ternal/containers/uninitialized_array.hpp
@@ -64,6 +64,8 @@ struct NotZeroedBuffer
 template <typename ElementType, uint64_t Capacity, template <typename, uint64_t> class Buffer = NotZeroedBuffer>
 class UninitializedArray
 {
+    static_assert(Capacity > 0U, "The size of the UninitializedArray must be greater than 0!");
+
   public:
     using value_type = ElementType;
     using iterator = ElementType*;

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/internal/containers/uninitialized_array.inl b/iceoryx_hoofs/include/iceoryx_hoofs/internal/containers/uninitialized_array.inl
@@ -18,7 +18,7 @@
 #ifndef IOX_HOOFS_CONTAINERS_UNINITIALIZED_ARRAY_INL
 #define IOX_HOOFS_CONTAINERS_UNINITIALIZED_ARRAY_INL
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 namespace iox
 {

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/posix_call.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/posix_call.hpp
@@ -16,11 +16,11 @@
 #ifndef IOX_HOOFS_POSIX_WRAPPER_POSIX_CALL_HPP
 #define IOX_HOOFS_POSIX_WRAPPER_POSIX_CALL_HPP
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/cxx/algorithm.hpp"
 #include "iceoryx_hoofs/cxx/attributes.hpp"
 #include "iceoryx_hoofs/cxx/expected.hpp"
 #include "iceoryx_hoofs/cxx/string.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 #include <cstdint>
 #include <cstring>

diff --git a/iceoryx_hoofs/source/posix_wrapper/posix_access_rights.cpp b/iceoryx_hoofs/source/posix_wrapper/posix_access_rights.cpp
@@ -16,7 +16,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "iceoryx_hoofs/posix_wrapper/posix_access_rights.hpp"
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/posix_wrapper/posix_call.hpp"
 #include "iceoryx_platform/grp.hpp"
 #include "iceoryx_platform/platform_correction.hpp"

diff --git a/iceoryx_hoofs/source/posix_wrapper/thread.cpp b/iceoryx_hoofs/source/posix_wrapper/thread.cpp
@@ -15,7 +15,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "iceoryx_hoofs/posix_wrapper/thread.hpp"
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 #include "iceoryx_hoofs/log/logging.hpp"
 #include "iceoryx_hoofs/posix_wrapper/posix_call.hpp"
 

diff --git a/iceoryx_hoofs/test/moduletests/test_containers_uninitialized_array.cpp b/iceoryx_hoofs/test/moduletests/test_containers_uninitialized_array.cpp
@@ -17,7 +17,7 @@
 
 #include "test.hpp"
 
-#include "iceoryx_hoofs/containers/uninitialized_array.hpp"
+#include "iceoryx_hoofs/internal/containers/uninitialized_array.hpp"
 
 namespace
 {
@@ -150,15 +150,15 @@ TYPED_TEST(UninitializedArrayTest, EndReturnsIteratorToEndOfUninitializedArray)
 {
     ::testing::Test::RecordProperty("TEST_ID", "52447fba-0c7f-40df-8b7f-64d8b3ffcc49");
     auto& buffer = this->buffer;
-    EXPECT_EQ(buffer.end(), &buffer[0] + buffer.capacity());
+    EXPECT_EQ(buffer.end(), &buffer[buffer.capacity()]);
 }
 
 TYPED_TEST(UninitializedArrayTest, ConstEndReturnsIteratorToEndOfUninitializedArray)
 {
     ::testing::Test::RecordProperty("TEST_ID", "2946ad83-b782-4c54-966b-c94b482335cc");
     auto& buffer = this->buffer;
     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-const-cast) reuse of buffer to test const method
-    EXPECT_EQ(const_cast<const decltype(buffer)>(buffer).end(), &buffer[0] + buffer.capacity());
+    EXPECT_EQ(const_cast<const decltype(buffer)>(buffer).end(), &buffer[buffer.capacity()]);
 }
 
 TEST(UninitializedArrayTest, BeginAndEndIteratorNotEqualInNonEmptyUninitializedArray)
@@ -183,7 +183,7 @@ TEST(UninitializedArrayTest, BeginAndEndConstIteratorNotEqualInNonEmptyUninitial
     new (&buffer[0]) Buffer::value_type(2);
 
     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-const-cast) reuse of buffer to test const methods
-    EXPECT_NE(const_cast<Buffer&>(buffer).begin(), const_cast<Buffer&>(buffer).end());
+    EXPECT_NE(const_cast<const Buffer&>(buffer).begin(), const_cast<const Buffer&>(buffer).end());
 }
 
 TYPED_TEST(UninitializedArrayTest, BeginAndEndIteratorNotEqualInFullUninitializedArray)