iox-eclipse-iceoryx#590 Rename iceoryx_utils to iceoryx_hoofs

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>

README.md

@@ -75,7 +75,7 @@ Please see the dedicated [README.md](tools/docker/README.md) for information on
 * [Getting Started](doc/website/getting-started/overview.md)
 * [Installation Guide](doc/website/getting-started/installation.md)
 * [Concepts](doc/conceptual-guide.md)
-* [Iceoryx Utils Hacker Guide](iceoryx_utils/README.md)
+* [Iceoryx Hoofs Hacker Guide](iceoryx_hoofs/README.md)
 
 ### Targeted quality levels & platforms
 
@@ -88,7 +88,7 @@ Please see the dedicated [README.md](tools/docker/README.md) for information on
 | iceoryx_dds                             | 4    | 4                     |                                     |
 | iceoryx_meta                            | 5    | 5                     |                                     |
 | iceoryx_posh                            | 1, 2 | 4                     | Will be split into separate targets |
-| iceoryx_utils                           | 1    | 4                     |                                     |
+| iceoryx_hoofs                           | 1    | 4                     |                                     |
 | iceoryx_introspection                   | 5    | 5                     |                                     |
 
 Is something missing or you've got ideas for other nifty examples? Jump right away to the next section!

doc/aspice_swe3_4/CMakeLists.txt

@@ -18,7 +18,7 @@ cmake_minimum_required(VERSION 3.10)
 
 set(IOX_VERSION_STRING "1.0.0")
 
-#find_package(iceoryx_utils REQUIRED)
+#find_package(iceoryx_hoofs REQUIRED)
 
 #include(IceoryxVersion)
 #parse_version(${IOX_VERSION_STRING})
@@ -55,10 +55,10 @@ swcomponent="@par Software Component:" \
 error="@par Error Handling:" \
 generatedcode="@par Generated by:"]])
 
-set(COMPONENTS iceoryx_utils iceoryx_posh iceoryx_binding_c iceoryx_dds
+set(COMPONENTS iceoryx_hoofs iceoryx_posh iceoryx_binding_c iceoryx_dds
                iceoryx_introspection iceoryx_component)
 set(COMPONENT_DIRS
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_utils
+    ${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_hoofs
     ${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_posh
     ${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_binding_c
     ${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_dds
@@ -85,7 +85,7 @@ endforeach()
 # create dummy install directive to generate docu also with "make install"
 install(
   FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.doxygen_iceoryx_utils
+    ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.doxygen_iceoryx_hoofs
   DESTINATION
     ${CMAKE_CURRENT_BINARY_DIR}
 )

doc/aspice_swe3_4/example/iceoryx_component/CMakeLists.txt

@@ -17,7 +17,7 @@
 cmake_minimum_required(VERSION 3.5)
 project(iceoryx_component VERSION 0.8.15)
 
-find_package(iceoryx_utils REQUIRED)
+find_package(iceoryx_hoofs REQUIRED)
 
 include(IceoryxPlatform)
 

doc/design/error-handling.md

@@ -131,11 +131,11 @@ Error logging shall be done by the logger only, no calls to ``std::cerr`` or sim
 
 All the methods presented (``cxx::expected``, ``Expects`` and ``Ensures`` and the error handler) can be used in posh. The appropriate way depends on the type of error scenario (cf. the respective sections for examples). The error handler should be considered the last option.
 
-### Error Handling in utils
+### Error Handling in hoofs
 
 Error logging is currently done by calls to ``std::cerr``. In the future those might be redirected to the logger.
 
-The error handler cannot be used in utils.
+The error handler cannot be used in hoofs.
 
 Whether it is appropriate to use ``cxx::expected`` even if STL compatibility is broken by doing so depends on the circumstances and needs to be decided on a case-by-case basis. If the function has no STL counterpart ``cxx::expected`` can be used freely to communicate potential failure to the caller.
 

doc/website/advanced/how-optional-and-error-values-are-returned-in-iceoryx.md

@@ -64,7 +64,7 @@ result = iox::cxx::nullopt;
 ```
 
 For a complete list of available functions see
-[`optional.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_utils/include/iceoryx_utils/cxx/optional.hpp).
+[`optional.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_hoofs/include/iceoryx_hoofs/cxx/optional.hpp).
 The `iox::cxx::optional` behaves like the [`std::optional`](https://en.cppreference.com/w/cpp/utility/optional)
 except that it does not throw exceptions and has no undefined behavior.
 
@@ -74,7 +74,7 @@ except that it does not throw exceptions and has no undefined behavior.
 no value at all, i.e. it contains either a value of type `T` or `E`. In this way, `expected` is a special case of
 the 'either monad'. It is usually used to pass a value of type `T` or an error that may have occurred, i.e. `E` is the
 error type. `E` must contain a static member or an enum value called `INVALID_STATE`. Alternatively an
-[`ErrorTypeAdapter`](https://github.com/eclipse-iceoryx/iceoryx/blob/5b1a0514e72514c2eae8a9d071d82a3905fedf8b/iceoryx_utils/include/iceoryx_utils/cxx/expected.hpp#L46)
+[`ErrorTypeAdapter`](https://github.com/eclipse-iceoryx/iceoryx/blob/5b1a0514e72514c2eae8a9d071d82a3905fedf8b/iceoryx_hoofs/include/iceoryx_hoofs/cxx/expected.hpp#L46)
 can be implemented.
 
 For more information on how it is used for error handling see
@@ -119,7 +119,7 @@ result.and_then(handleValue).or_else(handleError);
 
 There are more convenience functions such as `value_or` which provides the value or an alternative specified by the
 user. These can be found in
-[`expected.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_utils/include/iceoryx_utils/cxx/expected.hpp).
+[`expected.hpp`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/iceoryx_hoofs/include/iceoryx_hoofs/cxx/expected.hpp).
 
 Note that when we move an `expected`, the origin is set to the error value `E::INVALID_STATE` and `has_error()` will
 always return true:

doc/website/advanced/iceoryx_hoofs.md

@@ -0,0 +1,4 @@
+---
+title: Safe building blocks
+---
+{! ../iceoryx/iceoryx_hoofs/README.md !}

doc/website/advanced/installation-guide-for-contributors.md

@@ -81,14 +81,14 @@ This should be only rarely used and only in coordination with an iceoryx maintai
 
 !!! note
     iceoryx needs to be built as a static library for working with sanitizer flags. The script does it automatically.
-    Except when you want to use the ${ICEORYX_WARNINGS} then you have to call `findpackage(iceoryx_utils)`
+    Except when you want to use the ${ICEORYX_WARNINGS} then you have to call `findpackage(iceoryx_hoofs)`
 
 ## :material-library: iceoryx library build
 
 The iceoryx build consists of several libraries which have dependencies on each other. The goal is to have self-encapsulated library packages available where the end-user can easily find it with the CMake command `find-package(...)`.
 In the default case, the iceoryx libraries are installed by `make install` into `/usr/lib` which requires root access. As an alternative you can install the libs into a custom folder by setting `-DCMAKE_INSTALL_PREFIX=/custom/install/path` as build-flag for the CMake file in iceoryx_meta.
 
-As a starting point for the CMake build, iceoryx_meta collects all libraries (utils, posh etc.) and extensions (binding_c, dds) together. The provided build script `iceoryx_build_test.sh` in the `tools` folder uses iceoryx_meta.
+As a starting point for the CMake build, iceoryx_meta collects all libraries (hoofs, posh etc.) and extensions (binding_c, dds) together. The provided build script `iceoryx_build_test.sh` in the `tools` folder uses iceoryx_meta.
 
 Per default, iceoryx is built as static lib for better usability.
 Additionally, we offer to build as shared library because it is a cleaner solution for resolving dependency issues and it reduces the linker time.
@@ -109,4 +109,4 @@ LD_LIBRARY_PATH=/your/path/to/lib iox-roudi
 If you want to share iceoryx to other users, you can create a debian package. This can be done by using: `./tools/iceoryx_build_test.sh package` where it will be deployed into the `build_package` folder.
 
 !!! note
-    The CMake libraries export their dependencies for easier integration. This means that you do not need to do a `findpackage()` to all the dependencies. For example, you don't need to call `findpackage(iceoryx_utils)` when you have it done for iceoryx_posh. It includes it already.
+    The CMake libraries export their dependencies for easier integration. This means that you do not need to do a `findpackage()` to all the dependencies. For example, you don't need to call `findpackage(iceoryx_hoofs)` when you have it done for iceoryx_posh. It includes it already.

doc/website/getting-started/installation.md

@@ -1,6 +1,6 @@
 # Installation
 
-All iceoryx libraries are deployed as independent CMake packages. Posh is using functions from utils and is depending on it. You are able to build posh and utils and integrate them into existing CMake projects.
+All iceoryx libraries are deployed as independent CMake packages. Posh is using functions from hoofs and is depending on it. You are able to build posh and hoofs and integrate them into existing CMake projects.
 
 ## Prerequisites
 

doc/website/getting-started/overview.md

@@ -223,7 +223,7 @@ to process local constructs, no dynamic allocators
 
 !!! note
     Most of the STL types cannot be used, but we reimplemented some of them so that they meet the conditions above.
-    You can find an overview [here](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_utils#cxx).
+    You can find an overview [here](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_hoofs#cxx).
 
 ### Publisher
 

doc/website/getting-started/what-is-iceoryx.md

@@ -61,4 +61,4 @@ thanks to modern C++.
 The tools available for automotive-compliant software development are always one or two releases behind the latest C++
 standard. This fact, combined with our already mentioned constraints, led to a bunch of STL like C++ classes that have
 the goal to combine modern C++ with the reliability needed for the domains iceoryx is used in. They can be found in
-the iceoryx utils which are introduced [here](../../advanced/iceoryx_utils/)
+the iceoryx hoofs which are introduced [here](../../advanced/iceoryx_hoofs/)

iceoryx_binding_c/CMakeLists.txt

@@ -22,7 +22,7 @@ set(IOX_VERSION_STRING "1.0.0")
 
 project(iceoryx_binding_c VERSION ${IOX_VERSION_STRING})
 
-find_package(iceoryx_utils REQUIRED)
+find_package(iceoryx_hoofs REQUIRED)
 find_package(iceoryx_posh REQUIRED)
 
 
@@ -92,13 +92,13 @@ if(NOT (WIN32 OR QNX))
         pthread
       PRIVATE
         iceoryx_posh::iceoryx_posh
-        iceoryx_utils::iceoryx_utils
+        iceoryx_hoofs::iceoryx_hoofs
     )
 else()
     target_link_libraries(${PROJECT_NAME}
       PRIVATE
         iceoryx_posh::iceoryx_posh
-        iceoryx_utils::iceoryx_utils
+        iceoryx_hoofs::iceoryx_hoofs
     )
 endif()
 

iceoryx_binding_c/cmake/Config.cmake.in

@@ -17,7 +17,7 @@
 
 include(CMakeFindDependencyMacro)
 
-find_dependency(iceoryx_utils)
+find_dependency(iceoryx_hoofs)
 find_dependency(iceoryx_posh)
 
 include("${CMAKE_CURRENT_LIST_DIR}/@TARGETS_EXPORT_NAME@.cmake")

iceoryx_binding_c/package.xml

@@ -13,7 +13,7 @@
     <buildtool_depend>cmake</buildtool_depend>
 
     <build_depend>iceoryx_posh</build_depend>
-    <build_depend>iceoryx_utils</build_depend>
+    <build_depend>iceoryx_hoofs</build_depend>
 
     <doc_depend>doxygen</doc_depend>
 

iceoryx_binding_c/source/c2cpp_enum_translation.cpp

@@ -16,7 +16,7 @@
 
 #include "iceoryx_binding_c/internal/c2cpp_enum_translation.hpp"
 #include "iceoryx_binding_c/internal/c2cpp_binding.h"
-#include "iceoryx_utils/error_handling/error_handling.hpp"
+#include "iceoryx_hoofs/error_handling/error_handling.hpp"
 
 namespace c2cpp
 {

iceoryx_binding_c/source/c_log.cpp

@@ -14,7 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_utils/log/logmanager.hpp"
+#include "iceoryx_hoofs/log/logmanager.hpp"
 
 extern "C" {
 #include "iceoryx_binding_c/log.h"

iceoryx_binding_c/test/CMakeLists.txt

@@ -17,7 +17,7 @@
 cmake_minimum_required(VERSION 3.5)
 project(test_binding_c VERSION 0)
 
-find_package(iceoryx_utils_testing REQUIRED)
+find_package(iceoryx_hoofs_testing REQUIRED)
 find_package(iceoryx_posh_testing REQUIRED)
 find_package(GTest CONFIG REQUIRED)
 
@@ -31,8 +31,8 @@ set(TEST_LINK_LIBS
     GTest::gtest
     GTest::gmock
     iceoryx_binding_c::iceoryx_binding_c
-    iceoryx_utils::iceoryx_utils
-    iceoryx_utils_testing::iceoryx_utils_testing
+    iceoryx_hoofs::iceoryx_hoofs
+    iceoryx_hoofs_testing::iceoryx_hoofs_testing
     iceoryx_posh::iceoryx_posh
     iceoryx_posh::iceoryx_posh_config
     iceoryx_posh::iceoryx_posh_roudi

iceoryx_binding_c/test/moduletests/test_listener.cpp

@@ -21,7 +21,7 @@
 #include "iceoryx_posh/mepoo/mepoo_config.hpp"
 #include "iceoryx_posh/popo/listener.hpp"
 #include "iceoryx_posh/popo/user_trigger.hpp"
-#include "iceoryx_utils/testing/timing_test.hpp"
+#include "iceoryx_hoofs/testing/timing_test.hpp"
 
 using namespace iox;
 using namespace iox::popo;

iceoryx_binding_c/test/moduletests/test_log.cpp

@@ -14,7 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_utils/log/logmanager.hpp"
+#include "iceoryx_hoofs/log/logmanager.hpp"
 
 extern "C" {
 #include "iceoryx_binding_c/log.h"

iceoryx_binding_c/test/moduletests/test_wait_set.cpp

@@ -20,7 +20,7 @@
 #include "iceoryx_posh/iceoryx_posh_types.hpp"
 #include "iceoryx_posh/internal/popo/ports/subscriber_port_user.hpp"
 #include "iceoryx_posh/popo/user_trigger.hpp"
-#include "iceoryx_utils/testing/timing_test.hpp"
+#include "iceoryx_hoofs/testing/timing_test.hpp"
 #include "mocks/wait_set_mock.hpp"
 
 using namespace iox;

iceoryx_dds/CMakeLists.txt

@@ -26,7 +26,7 @@ if(NOT cpptoml_FOUND)
     find_package(cpptoml REQUIRED)
 endif()
 
-find_package(iceoryx_utils REQUIRED)
+find_package(iceoryx_hoofs REQUIRED)
 find_package(iceoryx_posh REQUIRED)
 
 include(IceoryxPackageHelper)
@@ -64,7 +64,7 @@ add_library(iceoryx_dds
 )
 add_library(${PROJECT_NAMESPACE}::iceoryx_dds ALIAS iceoryx_dds)
 
-set_target_properties(iceoryx_utils PROPERTIES
+set_target_properties(iceoryx_hoofs PROPERTIES
     CXX_STANDARD_REQUIRED ON
     CXX_STANDARD ${ICEORYX_CXX_STANDARD}
     POSITION_INDEPENDENT_CODE ON
@@ -81,7 +81,7 @@ target_link_libraries(iceoryx_dds
     iceoryx_posh::iceoryx_posh
     iceoryx_posh::iceoryx_posh_config
     iceoryx_posh::iceoryx_posh_gateway
-    iceoryx_utils::iceoryx_utils
+    iceoryx_hoofs::iceoryx_hoofs
 )
 
 if(USE_CYCLONE_DDS)

iceoryx_dds/cmake/Config.cmake.in

@@ -18,7 +18,7 @@
 
 include(CMakeFindDependencyMacro)
 
-find_dependency(iceoryx_utils)
+find_dependency(iceoryx_hoofs)
 find_dependency(iceoryx_posh)
 
 include("${CMAKE_CURRENT_LIST_DIR}/@TARGETS_EXPORT_NAME@.cmake")

iceoryx_dds/include/iceoryx_dds/dds/data_reader.hpp

@@ -20,8 +20,8 @@
 
 #include "iceoryx_dds/dds/iox_chunk_datagram_header.hpp"
 #include "iceoryx_posh/iceoryx_posh_types.hpp"
-#include "iceoryx_utils/cxx/expected.hpp"
-#include "iceoryx_utils/cxx/optional.hpp"
+#include "iceoryx_hoofs/cxx/expected.hpp"
+#include "iceoryx_hoofs/cxx/optional.hpp"
 
 namespace iox
 {

iceoryx_dds/include/iceoryx_dds/dds/iox_chunk_datagram_header.hpp

@@ -17,7 +17,7 @@
 #ifndef IOX_DDS_DDS_IOX_CHUNK_DATAGRAM_HEADER_HPP
 #define IOX_DDS_DDS_IOX_CHUNK_DATAGRAM_HEADER_HPP
 
-#include "iceoryx_utils/cxx/vector.hpp"
+#include "iceoryx_hoofs/cxx/vector.hpp"
 
 #include <cstdint>
 

iceoryx_dds/include/iceoryx_dds/internal/gateway/dds_to_iox.inl

@@ -21,7 +21,7 @@
 #include "iceoryx_dds/dds/dds_config.hpp"
 #include "iceoryx_dds/internal/log/logging.hpp"
 #include "iceoryx_posh/capro/service_description.hpp"
-#include "iceoryx_utils/cxx/string.hpp"
+#include "iceoryx_hoofs/cxx/string.hpp"
 
 namespace iox
 {

iceoryx_dds/include/iceoryx_dds/internal/log/logging.hpp

@@ -17,7 +17,7 @@
 #ifndef IOX_DDS_LOG_LOGGING_HPP
 #define IOX_DDS_LOG_LOGGING_HPP
 
-#include "iceoryx_utils/log/logging_free_function_building_block.hpp"
+#include "iceoryx_hoofs/log/logging_free_function_building_block.hpp"
 
 namespace iox
 {

iceoryx_dds/source/dds2iceoryx_app/main.cpp

@@ -20,9 +20,9 @@
 #include "iceoryx_dds/internal/log/logging.hpp"
 #include "iceoryx_posh/gateway/toml_gateway_config_parser.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_utils/platform/signal.hpp"
-#include "iceoryx_utils/posix_wrapper/semaphore.hpp"
-#include "iceoryx_utils/posix_wrapper/signal_handler.hpp"
+#include "iceoryx_hoofs/platform/signal.hpp"
+#include "iceoryx_hoofs/posix_wrapper/semaphore.hpp"
+#include "iceoryx_hoofs/posix_wrapper/signal_handler.hpp"
 
 #include <chrono>
 #include <iostream>

iceoryx_dds/source/iceoryx2dds_app/main.cpp

@@ -22,11 +22,11 @@
 #include "iceoryx_posh/gateway/gateway_config.hpp"
 #include "iceoryx_posh/gateway/toml_gateway_config_parser.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
-#include "iceoryx_utils/cxx/helplets.hpp"
-#include "iceoryx_utils/cxx/optional.hpp"
-#include "iceoryx_utils/platform/signal.hpp"
-#include "iceoryx_utils/posix_wrapper/semaphore.hpp"
-#include "iceoryx_utils/posix_wrapper/signal_handler.hpp"
+#include "iceoryx_hoofs/cxx/helplets.hpp"
+#include "iceoryx_hoofs/cxx/optional.hpp"
+#include "iceoryx_hoofs/platform/signal.hpp"
+#include "iceoryx_hoofs/posix_wrapper/semaphore.hpp"
+#include "iceoryx_hoofs/posix_wrapper/signal_handler.hpp"
 
 class ShutdownManager
 {

iceoryx_dds/source/iceoryx_dds/dds/iox_chunk_datagram_header.cpp

@@ -15,7 +15,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "iceoryx_dds/dds/iox_chunk_datagram_header.hpp"
-#include "iceoryx_utils/cxx/helplets.hpp"
+#include "iceoryx_hoofs/cxx/helplets.hpp"
 
 namespace iox
 {

iceoryx_dds/test/CMakeLists.txt

@@ -17,7 +17,7 @@
 cmake_minimum_required(VERSION 3.5)
 project(test_iox_to_dds VERSION 0)
 
-find_package(iceoryx_utils_testing REQUIRED)
+find_package(iceoryx_hoofs_testing REQUIRED)
 find_package(iceoryx_posh_testing REQUIRED)
 find_package(GTest CONFIG REQUIRED)
 
@@ -30,8 +30,8 @@ set(TEST_LINK_LIBS
     ${CODE_COVERAGE_LIBS}
     GTest::gtest
     GTest::gmock
-    iceoryx_utils::iceoryx_utils
-    iceoryx_utils_testing::iceoryx_utils_testing
+    iceoryx_hoofs::iceoryx_hoofs
+    iceoryx_hoofs_testing::iceoryx_hoofs_testing
     iceoryx_posh::iceoryx_posh
     iceoryx_posh_testing::iceoryx_posh_testing
     iceoryx_dds::iceoryx_dds