iox-#1391 Move functional interface files

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

Author: FerdinandSpitzschnueffler

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

@@ -220,7 +220,7 @@
    via a pointer to `FunctionalInterface`
 
    ```cpp
-   iox::cxx::FunctionalInterface<iox::optional<MyClass>, MyClass, void>* soSmart =
+   iox::FunctionalInterface<iox::optional<MyClass>, MyClass, void>* soSmart =
        new iox::optional<MyClass>{};
 
    delete soSmart; // <- not possible anymore

iceoryx_hoofs/BUILD.bazel

@@ -34,6 +34,7 @@ cc_library(
         "vocabulary/source/**/*.cpp",
         "source/**/*.hpp",
         "memory/source/*.cpp",
+        "design/source/*.cpp",
     ]),
     hdrs = glob(["include/**"]) + glob(["legacy/**"]) + glob(["memory/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + glob(["utility/**"]) + glob(["primitives/**"]) + glob(["design/**"]) + [
         ":iceoryx_hoofs_deployment_hpp",

iceoryx_hoofs/CMakeLists.txt

@@ -69,7 +69,6 @@ iox_add_library(
         source/cxx/adaptive_wait.cpp
         source/cxx/deadline_timer.cpp
         source/cxx/filesystem.cpp
-        source/cxx/functional_interface.cpp
         source/cxx/requires.cpp
         source/cxx/type_traits.cpp
         source/cxx/unique_id.cpp
@@ -97,6 +96,7 @@ iox_add_library(
         source/units/duration.cpp
         memory/source/bump_allocator.cpp
         memory/source/memory.cpp
+        design/source/functional_interface.cpp
 )
 
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/iceoryx_hoofs_deployment.hpp.in"

iceoryx_hoofs/include/iceoryx_hoofs/internal/cxx/functional_interface.inl renamed to iceoryx_hoofs/design/include/iox/detail/functional_interface.inl

@@ -14,16 +14,14 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#ifndef IOX_HOOFS_CXX_FUNCTIONAL_INTERFACE_INL
-#define IOX_HOOFS_CXX_FUNCTIONAL_INTERFACE_INL
+#ifndef IOX_HOOFS_DESIGN_FUNCTIONAL_INTERFACE_INL
+#define IOX_HOOFS_DESIGN_FUNCTIONAL_INTERFACE_INL
 
-#include "iceoryx_hoofs/cxx/functional_interface.hpp"
 #include "iox/detail/string_type_traits.hpp"
+#include "iox/functional_interface.hpp"
 
 namespace iox
 {
-namespace cxx
-{
 namespace internal
 {
 ///////////////
@@ -33,31 +31,31 @@ template <typename Derived>
 template <typename StringType>
 inline void Expect<Derived>::expect(const StringType& msg) const noexcept
 {
-    static_assert(is_char_array<StringType>::value || is_cxx_string<StringType>::value,
+    static_assert(cxx::is_char_array<StringType>::value || is_cxx_string<StringType>::value,
                   "Only char arrays and iox::strings are allowed as message type.");
 
     const auto& derivedThis = *static_cast<const Derived*>(this);
 
     if (!derivedThis)
     {
         print_expect_message(&msg[0]);
-        Ensures(false);
+        cxx::Ensures(false);
     }
 }
 
 template <typename Derived, typename ValueType>
 template <typename StringType>
 inline ValueType& ExpectWithValue<Derived, ValueType>::expect(const StringType& msg) & noexcept
 {
-    static_assert(is_char_array<StringType>::value || is_cxx_string<StringType>::value,
+    static_assert(cxx::is_char_array<StringType>::value || is_cxx_string<StringType>::value,
                   "Only char arrays and iox::strings are allowed as message type.");
 
     auto& derivedThis = *static_cast<Derived*>(this);
 
     if (!derivedThis)
     {
         print_expect_message(&msg[0]);
-        Ensures(false);
+        cxx::Ensures(false);
     }
 
     return derivedThis.value();
@@ -312,6 +310,5 @@ inline const Derived&& OrElse<Derived>::or_else(const or_else_callback_t& callab
 
 
 } // namespace internal
-} // namespace cxx
 } // namespace iox
 #endif

iceoryx_hoofs/include/iceoryx_hoofs/cxx/functional_interface.hpp renamed to iceoryx_hoofs/design/include/iox/functional_interface.hpp

@@ -13,8 +13,8 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_HOOFS_CXX_FUNCTIONAL_POLICY_HPP
-#define IOX_HOOFS_CXX_FUNCTIONAL_POLICY_HPP
+#ifndef IOX_HOOFS_DESIGN_FUNCTIONAL_INTERFACE_HPP
+#define IOX_HOOFS_DESIGN_FUNCTIONAL_INTERFACE_HPP
 
 #include "iceoryx_hoofs/cxx/function_ref.hpp"
 #include "iceoryx_hoofs/cxx/type_traits.hpp"
@@ -24,8 +24,6 @@
 
 namespace iox
 {
-namespace cxx
-{
 namespace internal
 {
 template <typename Derived, class = void>
@@ -434,9 +432,8 @@ struct FunctionalInterfaceImpl<Derived, void, ErrorType>
 template <typename Derived, typename ValueType, typename ErrorType>
 using FunctionalInterface = internal::FunctionalInterfaceImpl<Derived, ValueType, ErrorType>;
 
-} // namespace cxx
 } // namespace iox
 
-#include "iceoryx_hoofs/internal/cxx/functional_interface.inl"
+#include "iox/detail/functional_interface.inl"
 
 #endif

iceoryx_hoofs/source/cxx/functional_interface.cpp renamed to iceoryx_hoofs/design/source/functional_interface.cpp

@@ -14,13 +14,11 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_hoofs/cxx/functional_interface.hpp"
+#include "iox/functional_interface.hpp"
 #include "iceoryx_hoofs/log/logging.hpp"
 
 namespace iox
 {
-namespace cxx
-{
 namespace internal
 {
 // AXIVION Next Construct AutosarC++19_03-A3.9.1 : See rational in header
@@ -31,5 +29,4 @@ void print_expect_message(const char* message) noexcept
     IOX_LOG(FATAL) << message;
 }
 } // namespace internal
-} // namespace cxx
 } // namespace iox

iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/functional_interface.hpp

@@ -0,0 +1,66 @@
+// 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_FUNCTIONAL_INTERFACE_HPP
+#define IOX_HOOFS_CXX_FUNCTIONAL_INTERFACE_HPP
+
+#include "iox/functional_interface.hpp"
+
+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
+{
+/// @deprecated use `iox::internal::HasValueMethod` instead of `iox::cxx::internal::HasValueMethod`
+using iox::internal::HasValueMethod;
+
+/// @deprecated use `iox::internal::HasGetErrorMethod` instead of `iox::cxx::internal::HasGetErrorMethod`
+using iox::internal::HasGetErrorMethod;
+
+/// @deprecated use `iox::internal::Expect` instead of `iox::cxx::internal::Expect`
+using iox::internal::Expect;
+
+/// @deprecated use `iox::internal::ExpectWithValue` instead of `iox::cxx::internal::ExpectWithValue`
+using iox::internal::ExpectWithValue;
+
+/// @deprecated use `iox::internal::ValueOr` instead of `iox::cxx::internal::ValueOr`
+using iox::internal::ValueOr;
+
+/// @deprecated use `iox::internal::AndThenWithValue` instead of `iox::cxx::internal::AndThenWithValue`
+using iox::internal::AndThenWithValue;
+
+/// @deprecated use `iox::internal::AndThen` instead of `iox::cxx::internal::AndThen`
+using iox::internal::AndThen;
+
+/// @deprecated use `iox::internal::OrElseWithValue` instead of `iox::cxx::internal::OrElseWithValue`
+using iox::internal::OrElseWithValue;
+
+/// @deprecated use `iox::internal::OrElse` instead of `iox::cxx::internal::OrElse`
+using iox::internal::OrElse;
+
+/// @deprecated use `iox::internal::FunctionalInterfaceImpl` instead of `iox::cxx::internal::FunctionalInterfaceImpl`
+using iox::internal::FunctionalInterfaceImpl;
+} // namespace internal
+
+/// @deprecated use `iox::FunctionalInterface` instead of `iox::cxx::FunctionalInterface`
+using iox::FunctionalInterface;
+
+} // namespace cxx
+} // namespace iox
+
+#endif

iceoryx_hoofs/legacy/include/iceoryx_hoofs/design_pattern/builder.hpp

@@ -22,4 +22,3 @@
 /// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/builder.hpp' instead")]]
 
 #endif
-

iceoryx_hoofs/test/moduletests/test_cxx_functional_interface_and_then.cpp renamed to iceoryx_hoofs/test/moduletests/test_design_functional_interface_and_then.cpp

@@ -14,18 +14,18 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 #include "iceoryx_hoofs/testing/expect_no_death.hpp"
-#include "test_cxx_functional_interface_types.hpp"
+#include "test_design_functional_interface_types.hpp"
 
 namespace
 {
-using namespace test_cxx_functional_interface;
+using namespace test_design_functional_interface;
 using namespace ::testing;
 
 TYPED_TEST(FunctionalInterface_test, AndThenHasCorrectSignature)
 {
     ::testing::Test::RecordProperty("TEST_ID", "7636fda5-090f-4dd6-b3a0-3d71bdbca787");
     using Factory = typename TestFixture::TestFactoryType;
-    constexpr bool DOES_AND_THEN_HAVE_A_VALUE = iox::cxx::internal::HasValueMethod<typename Factory::Type>::value;
+    constexpr bool DOES_AND_THEN_HAVE_A_VALUE = iox::internal::HasValueMethod<typename Factory::Type>::value;
 
     EXPECT_THAT(DOES_AND_THEN_HAVE_A_VALUE, Eq(Factory::EXPECT_AND_THEN_WITH_VALUE));
 }
@@ -36,7 +36,7 @@ TYPED_TEST(FunctionalInterface_test, AndThenHasCorrectSignature)
 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
 #define IOX_TEST_FUNCTIONAL_INTERFACE(TestName, variationPoint)                                                        \
     using SutType = typename TestFixture::TestFactoryType::Type;                                                       \
-    constexpr bool HAS_VALUE_METHOD = iox::cxx::internal::HasValueMethod<SutType>::value;                              \
+    constexpr bool HAS_VALUE_METHOD = iox::internal::HasValueMethod<SutType>::value;                                   \
     /* NOLINTNEXTLINE(bugprone-macro-parentheses) prevents clang-tidy parsing failures */                              \
     TestName<HAS_VALUE_METHOD>::template performTest<typename TestFixture::TestFactoryType>(                           \
         [](auto& sut, auto callback) { (variationPoint).and_then(callback); })

iceoryx_hoofs/test/moduletests/test_cxx_functional_interface_common.cpp renamed to iceoryx_hoofs/test/moduletests/test_design_functional_interface_common.cpp

@@ -14,9 +14,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "test_cxx_functional_interface_common.hpp"
+#include "test_design_functional_interface_common.hpp"
 
-namespace test_cxx_functional_interface
+namespace test_design_functional_interface
 {
 // NOLINTNEXTLINE(bugprone-easily-swappable-parameters) only for testing purposes
 GenericValueError::GenericValueError(const value_t value, const error_t error) noexcept
@@ -95,4 +95,4 @@ GenericPlain::operator bool() const noexcept
 }
 
 
-} // namespace test_cxx_functional_interface
+} // namespace test_design_functional_interface