iox-#2057 Use deprecation macros and fix issues

eclipse-iceoryx · Oct 25, 2023 · 9448165 · 9448165
1 parent 9deba47
commit 9448165
Show file tree

Hide file tree

Showing 26 changed files with 68 additions and 49 deletions.
diff --git a/iceoryx_hoofs/cmake/iceoryx_hoofs_deployment.hpp.in b/iceoryx_hoofs/cmake/iceoryx_hoofs_deployment.hpp.in
@@ -17,7 +17,7 @@
 #ifndef IOX_HOOFS_ICEORYX_HOOFS_DEPLOYMENT_HPP
 #define IOX_HOOFS_ICEORYX_HOOFS_DEPLOYMENT_HPP
 
-#include "iceoryx_hoofs/iceoryx_hoofs_types.hpp"
+#include "iox/iceoryx_hoofs_types.hpp"
 
 namespace iox
 {

diff --git a/iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/unix_domain_socket.hpp b/iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/unix_domain_socket.hpp
@@ -18,7 +18,6 @@
 #ifndef IOX_HOOFS_POSIX_WRAPPER_UNIX_DOMAIN_SOCKET_HPP
 #define IOX_HOOFS_POSIX_WRAPPER_UNIX_DOMAIN_SOCKET_HPP
 
-#include "iceoryx_hoofs/cxx/filesystem.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
 #include "iceoryx_platform/fcntl.hpp"
 #include "iceoryx_platform/platform_settings.hpp"
@@ -27,6 +26,7 @@
 #include "iceoryx_platform/un.hpp"
 #include "iox/builder.hpp"
 #include "iox/duration.hpp"
+#include "iox/filesystem.hpp"
 #include "iox/optional.hpp"
 
 namespace iox

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/algorithm.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/algorithm.hpp
@@ -17,7 +17,8 @@
 #define IOX_HOOFS_CXX_ALGORITHM_HPP
 
 #include "iox/algorithm.hpp"
-#pragma message(                                                                                                       \
-    "Deprecated in 3.0, removed in 4.0, please include 'iox/algorithm.hpp' instead of 'iceoryx_hoofs/cxx/algorithm.hpp'")
+#include "iox/detail/deprecation_marker.hpp"
+
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/algorithm.hpp' instead.")
 
 #endif // IOX_HOOFS_CXX_ALGORITHM_HPP
diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/attributes.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/attributes.hpp
@@ -18,11 +18,12 @@
 #define IOX_HOOFS_CXX_ATTRIBUTES_HPP
 
 #include "iox/attributes.hpp"
+#include "iox/detail/deprecation_marker.hpp"
+
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/attributes.hpp' instead.")
 
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/attributes.hpp' instead")]]
 namespace cxx
 {
 namespace internal

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/deadline_timer.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/deadline_timer.hpp
@@ -18,11 +18,12 @@
 #define IOX_HOOFS_CXX_DEADLINE_TIMER_HPP
 
 #include "iox/deadline_timer.hpp"
+#include "iox/detail/deprecation_marker.hpp"
+
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/deadline_timer.hpp' instead.")
 
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/deadline_timer.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::deadline_timer' instead of 'iox::cxx::DeadlineTimer'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/expected.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/expected.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_EXPECTED_HPP
 #define IOX_HOOFS_CXX_EXPECTED_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/expected.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/expected.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/expected.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::error' instead of 'iox::cxx::error'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/filesystem.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/filesystem.hpp
@@ -16,16 +16,17 @@
 #ifndef IOX_HOOFS_CXX_FILESYSTEM_HPP
 #define IOX_HOOFS_CXX_FILESYSTEM_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/filesystem.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/filesystem.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/filesystem.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::access_rights' instead of 'iox::cxx::perms'
-using perms = iox::access_rights;
+using perms IOX_DEPRECATED_SINCE(3, "Please use 'iox::access_rights' instead.") = iox::access_rights;
 } // namespace cxx
 } // namespace iox
 

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/function.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/function.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_FUNCTION_HPP
 #define IOX_HOOFS_FUNCTION_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/function.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/function.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/function.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::function' instead of 'iox::cxx::function'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/function_ref.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/function_ref.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_FUNCTION_REF_HPP
 #define IOX_HOOFS_CXX_FUNCTION_REF_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/function_ref.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/function_ref.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/function_ref.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::function_ref' instead of 'iox::cxx::function_ref'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/functional_interface.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/functional_interface.hpp
@@ -16,12 +16,13 @@
 #ifndef IOX_HOOFS_CXX_FUNCTIONAL_INTERFACE_HPP
 #define IOX_HOOFS_CXX_FUNCTIONAL_INTERFACE_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/functional_interface.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/functional_interface.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/functional_interface.hpp' instead")]]
 namespace cxx
 {
 namespace internal

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/newtype.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/newtype.hpp
@@ -16,12 +16,13 @@
 #ifndef IOX_HOOFS_CXX_NEWTYPE_HPP
 #define IOX_HOOFS_CXX_NEWTYPE_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/newtype.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/newtype.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/newtype.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::NewType' instead of 'iox::cxx::NewType'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/optional.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/optional.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_OPTIONAL_HPP
 #define IOX_HOOFS_CXX_OPTIONAL_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/optional.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/optional.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/optional.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::in_place' instead of 'iox::cxx::in_place'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/scope_guard.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/scope_guard.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_SCOPE_GUARD_HPP
 #define IOX_HOOFS_CXX_SCOPE_GUARD_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/scope_guard.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/scope_guard.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/scope_guard.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::ScopeGuard' instead of 'iox::cxx::ScopeGuard'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/scoped_static.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/scoped_static.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_SCOPED_STATIC_HPP
 #define IOX_HOOFS_CXX_SCOPED_STATIC_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/scoped_static.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/scoped_static.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/scoped_static.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::makeScopedStatic' instead of 'iox::cxx::makeScopedStatic'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/stack.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/stack.hpp
@@ -16,12 +16,13 @@
 #ifndef IOX_HOOFS_CXX_STACK_HPP
 #define IOX_HOOFS_CXX_STACK_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/stack.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/stack.hpp' instead.")
+
 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'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/string.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/string.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_STRING_HPP
 #define IOX_HOOFS_CXX_STRING_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/string.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/string.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/string.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::concatenate' instead of 'iox::cxx::concatenate'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/type_traits.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/type_traits.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_TYPE_TRAITS_HPP
 #define IOX_HOOFS_CXX_TYPE_TRAITS_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/type_traits.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/type_traits.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/type_traits.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::add_const_conditionally' instead of 'iox::cxx::add_const_conditionally'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/unique_ptr.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/unique_ptr.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_UNIQUE_PTR_HPP
 #define IOX_HOOFS_CXX_UNIQUE_PTR_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/unique_ptr.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/unique_ptr.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/unique_ptr.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/variant.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/variant.hpp
@@ -17,12 +17,13 @@
 #ifndef IOX_HOOFS_CXX_VARIANT_HPP
 #define IOX_HOOFS_CXX_VARIANT_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/variant.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/variant.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/variant.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::in_place_index' instead of 'iox::cxx::in_place_index'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/vector.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/vector.hpp
@@ -16,12 +16,13 @@
 #ifndef IOX_HOOFS_CXX_VECTOR_HPP
 #define IOX_HOOFS_CXX_VECTOR_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/vector.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/vector.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::vector' instead of 'iox::cxx::vector'

diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/design_pattern/builder.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/design_pattern/builder.hpp
@@ -18,7 +18,8 @@
 #define IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
 
 #include "iox/builder.hpp"
-#pragma message(                                                                                                       \
-    "Deprecated in 3.0, removed in 4.0, please include 'iox/builder.hpp' instead of 'iceoryx_hoofs/design_pattern/builder.hpp'")
+#include "iox/detail/deprecation_marker.hpp"
 
-#endif
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/builder.hpp' instead.")
+
+#endif // IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
diff --git a/iceoryx_hoofs/legacy/include/iceoryx_hoofs/iceoryx_hoofs_types.hpp b/iceoryx_hoofs/legacy/include/iceoryx_hoofs/iceoryx_hoofs_types.hpp
@@ -17,16 +17,17 @@
 #ifndef IOX_HOOFS_ICEORYX_HOOFS_TYPES_HPP
 #define IOX_HOOFS_ICEORYX_HOOFS_TYPES_HPP
 
+#include "iox/detail/deprecation_marker.hpp"
 #include "iox/iceoryx_hoofs_types.hpp"
 
+IOX_DEPRECATED_HEADER_SINCE(3, "Please include 'iox/iceoryx_hoofs_types.hpp' instead.")
+
 namespace iox
 {
-/// @todo iox-#1593 Deprecate include
-/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/iceoryx_hoofs_types.hpp' instead")]]
 namespace cxx
 {
 /// @deprecated use 'iox::byte' instead of 'iox::cxx::byte_t'
-using byte_t = byte;
+using byte_t IOX_DEPRECATED_SINCE(3, "Please use 'iox::byte' instead.") = byte;
 
 } // namespace cxx
 namespace log

diff --git a/iceoryx_hoofs/memory/include/iox/bump_allocator.hpp b/iceoryx_hoofs/memory/include/iox/bump_allocator.hpp
@@ -17,7 +17,7 @@
 #ifndef IOX_HOOFS_MEMORY_BUMP_ALLOCATOR_HPP
 #define IOX_HOOFS_MEMORY_BUMP_ALLOCATOR_HPP
 
-#include "iceoryx_hoofs/cxx/expected.hpp"
+#include "iox/expected.hpp"
 
 #include <cstdint>
 

diff --git a/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_macros.cpp b/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_macros.cpp
@@ -31,7 +31,6 @@ namespace
 // NOLINTBEGIN(cppcoreguidelines-avoid-do-while) bad rule, disable globally
 using namespace ::testing;
 using namespace iox::er;
-using namespace iox::cxx;
 using namespace iox::testing;
 
 using MyErrorA = module_a::errors::Error;

diff --git a/iceoryx_hoofs/time/include/iox/detail/duration.inl b/iceoryx_hoofs/time/include/iox/detail/duration.inl
@@ -483,7 +483,7 @@ template <typename T>
 inline constexpr T& operator*=(T&, const Duration&) noexcept
 {
     static_assert(
-        cxx::always_false_v<T>,
+        always_false_v<T>,
         "Assigning the result of a Duration multiplication with 'operator*=' to an arithmetic type is not supported");
     return T();
 }

diff --git a/iceoryx_hoofs/time/include/iox/duration.hpp b/iceoryx_hoofs/time/include/iox/duration.hpp
@@ -17,11 +17,11 @@
 #ifndef IOX_HOOFS_TIME_UNITS_DURATION_HPP
 #define IOX_HOOFS_TIME_UNITS_DURATION_HPP
 
-#include "iceoryx_hoofs/cxx/type_traits.hpp"
 #include "iceoryx_platform/time.hpp" // required for QNX
 #include "iox/expected.hpp"
 #include "iox/log/logstream.hpp"
 #include "iox/logging.hpp"
+#include "iox/type_traits.hpp"
 
 #include <cmath>