Merge branch 'dev/1.0.0' into merge_dev1.0.0

.github/workflows/ci.yml

@@ -8,14 +8,30 @@ on:
   schedule:
     - cron: "0 6 * * 1-5"
 
+env:
+  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
+  CARGO_PROFILE_DEV_DEBUG: false
+
 jobs:
+  check_format:
+    name: Check codebase format with clang-format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run clang-format dry-run
+        run: find include/ src/ tests/ examples/ -iname "*.h" -o -iname "*.c" | xargs clang-format -n -Werror
+
   build:
     name: Build on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
+        shm: [false, true]
+        unstable: [false, true]
 
     steps:
       - uses: actions/checkout@v4
@@ -27,7 +43,7 @@ jobs:
         run: cargo clippy --all-targets --all-features -- --deny warnings
 
       - name: Run rustfmt
-        run: cargo fmt --check
+        run: cargo fmt --check -- --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate"
 
       - name: Check for feature leaks
         run: cargo test --no-default-features
@@ -36,22 +52,33 @@ jobs:
         shell: bash
         run: |
           mkdir -p build && cd build 
-          cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/local
+          cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/local -DZENOHC_BUILD_WITH_SHARED_MEMORY=${{ matrix.shm }} -DZENOHC_BUILD_WITH_UNSTABLE_API=${{ matrix.unstable }}
           cmake --build . --target install --config Release
 
+      - name: Install valgrind
+        uses: taiki-e/install-action@valgrind
+        if: matrix.os == 'ubuntu-latest'
+
       - name: Run cmake tests with zenoh-c as dynamic library
         shell: bash
         run: |
           cd build
-          cmake .. -DZENOHC_LIB_STATIC=FALSE -DCMAKE_BUILD_TYPE=Release
+          cmake .. -DZENOHC_LIB_STATIC=FALSE -DCMAKE_BUILD_TYPE=Release -DZENOHC_BUILD_WITH_SHARED_MEMORY=${{ matrix.shm }} -DZENOHC_BUILD_WITH_UNSTABLE_API=${{ matrix.unstable }}
           cmake --build . --target tests --config Release
           ctest -C Release --output-on-failure -E "(unit_z_api_alignment_test|build_z_build_static)"
 
+      - name: Build cmake tests with C++ compiler to make sure that C API is C++ compatible
+        shell: bash
+        run: |
+          cd build
+          cmake .. -DZENOHC_LIB_STATIC=TRUE -DCMAKE_BUILD_TYPE=Debug -DZENOHC_BUILD_TESTS_WITH_CXX=TRUE -DZENOHC_BUILD_WITH_SHARED_MEMORY=${{ matrix.shm }} -DZENOHC_BUILD_WITH_UNSTABLE_API=${{ matrix.unstable }}
+          cmake --build . --target tests --config Debug
+
       - name: Run cmake tests with zenoh-c as static library
         shell: bash
         run: |
           cd build
-          cmake .. -DZENOHC_LIB_STATIC=TRUE -DCMAKE_BUILD_TYPE=Release
+          cmake .. -DZENOHC_LIB_STATIC=TRUE -DCMAKE_BUILD_TYPE=Release -DZENOHC_BUILD_WITH_SHARED_MEMORY=${{ matrix.shm }} -DZENOHC_BUILD_WITH_UNSTABLE_API=${{ matrix.unstable }}
           cmake --build . --target tests --config Release
           ctest -C Release --output-on-failure -E "(unit_z_api_alignment_test|build_z_build_shared)"
 
@@ -61,24 +88,27 @@ jobs:
           cd build
           cmake --build . --target examples
 
-      - name: Build examples with zenoh-c as subbroject and static library and in debug mode
+      - name: Build examples with zenoh-c as subbroject and static library and in debug mode and in separate directory
         shell: bash
         run: |
-          mkdir -p build_examples_subproj && cd build_examples_subproj
-          cmake ../examples -DCMAKE_BUILD_TYPE=Debug -DZENOHC_LIB_STATIC=TRUE
-          cmake --build . --config Debug
+          mkdir -p ../build_examples
+          cmake -S examples -B ../build_examples -DCMAKE_BUILD_TYPE=Debug -DZENOHC_LIB_STATIC=TRUE
+          cmake --build ../build_examples --config Debug
+          rm -rf ../build_examples
 
       - name: Build examples with zenoh-c as installed package
         shell: bash
         run: |
-          mkdir -p build_examples_findproj && cd build_examples_findproj
+          mkdir -p build_examples && cd build_examples
           cmake ../examples -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/local -DZENOHC_SOURCE=PACKAGE
           cmake --build . --config Release
+          cd .. && rm -rf build_examples
 
       - name: Run rust tests
-        run: cargo test --verbose --release --features=logger-autoinit --features=shared-memory
+        run: cargo test --verbose --release --features=logger-autoinit
 
       - name: Upload artifact
+        if: ${{ matrix.unstable == 'false' && matrix.shm == 'false' }}
         uses: actions/upload-artifact@v4
         with:
           # Artifact name

.gitignore

@@ -71,8 +71,13 @@ dkms.conf
 
 # Platform dependent generated files
 include/zenoh_configure.h
+include/zenoh_opaque.h
+
+# Build resources
+.build_resources*
+src/opaque_types/mod.rs
 
 # CMake
 CMakeFiles/
 debug/
-release/
+release/

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2024 ZettaScale Technology
+#
+# This program and the accompanying materials are made available under the
+# terms of the Eclipse Public License 2.0 which is available at
+# http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+# which is available at https://www.apache.org/licenses/LICENSE-2.0.
+#
+# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+#
+# Contributors:
+#   ZettaScale Zenoh Team, <[email protected]>
+#
+repos:
+  - repo: local
+    hooks:
+      - id: fmt
+        name: fmt
+        entry: cargo fmt -- --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate"
+        language: system
+        types: [rust]

.readthedocs.yaml

@@ -10,6 +10,14 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+    rust: "1.75"
+  apt_packages:
+    - cargo
+  jobs:
+    # Run cargo build to build git ignored files that are platform specific (e.g. include/zenoh_opaque.h)
+    pre_build:
+      - cargo build --release --manifest-path=./Cargo.toml --features=logger-autoinit --features=unstable --features=shared-memory
+
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

CMakeLists.txt

@@ -7,7 +7,7 @@ project(
 	VERSION ${version}
 	DESCRIPTION "The C bindings for Zenoh"
 	HOMEPAGE_URL "https://github.com/eclipse-zenoh/zenoh-c"
-	LANGUAGES C
+	LANGUAGES C CXX
 )
 
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
@@ -28,7 +28,9 @@ enable_testing()
 #
 declare_cache_var_true_if_vscode(ZENOHC_BUILD_IN_SOURCE_TREE "Do build inside source tree")
 declare_cache_var(ZENOHC_BUILD_WITH_LOGGER_AUTOINIT TRUE BOOL "Enable logger-autoinit zenoh-c feature")
-declare_cache_var(ZENOHC_BUILD_WITH_SHARED_MEMORY TRUE BOOL "Enable shared-memory zenoh-c feature")
+declare_cache_var(ZENOHC_BUILD_WITH_SHARED_MEMORY FALSE BOOL "Enable shared-memory zenoh-c feature")
+declare_cache_var(ZENOHC_BUILD_WITH_UNSTABLE_API TRUE BOOL "Enable unstable API feature")
+declare_cache_var(ZENOHC_BUILD_TESTS_WITH_CXX FALSE BOOL "Use C++ compiler for building tests to check API's C++ compatibility")
 declare_cache_var(ZENOHC_CUSTOM_TARGET "" STRING "Rust target for cross compilation, 'aarch64-unknown-linux-gnu' for example")
 declare_cache_var(ZENOHC_CARGO_CHANNEL "" STRING "Cargo channel parameter. Should be '+stable', '+nightly' or empty value")
 declare_cache_var(ZENOHC_CARGO_FLAGS "" STRING "Additional cargo flags")
@@ -115,6 +117,11 @@ function(configure_cargo_toml cargo_toml_dir CARGO_PROJECT_VERSION CARGO_LIB_NAM
 			${CMAKE_CURRENT_SOURCE_DIR}/Cargo.lock
 			${CMAKE_CURRENT_SOURCE_DIR}/rust-toolchain.toml
 			DESTINATION ${cargo_toml_dir})
+		file(COPY
+			${CMAKE_CURRENT_SOURCE_DIR}/include/zenoh.h
+			${CMAKE_CURRENT_SOURCE_DIR}/include/zenoh_memory.h
+			${CMAKE_CURRENT_SOURCE_DIR}/include/zenoh_constants.h
+			DESTINATION ${cargo_toml_dir}/include/)
 	endif()	
 	configure_file("${CMAKE_CURRENT_SOURCE_DIR}/Cargo.toml.in" "${cargo_toml_dir}/Cargo.toml" @ONLY)
 endfunction()
@@ -142,6 +149,16 @@ else()
 	configure_cargo_toml(${cargo_toml_dir_release} ${project_version} ${cargo_lib_name_release})
 endif()
 
+#
+# Copy toolchain configuration to build directory to ensure it is used when cargo is invoked from a directory other
+# than the directory containing the manifest file
+#
+if(NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/rust-toolchain.toml")
+	file(COPY
+		${CMAKE_CURRENT_SOURCE_DIR}/rust-toolchain.toml
+		DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+endif()
+
 #
 # Configure result library names
 #
@@ -191,6 +208,11 @@ if(ZENOHC_BUILD_WITH_SHARED_MEMORY)
 	set(cargo_flags ${cargo_flags} --features=shared-memory)
 endif()
 
+if(ZENOHC_BUILD_WITH_UNSTABLE_API)
+	set(cargo_flags ${cargo_flags} --features=unstable)
+endif()
+
+
 if(NOT(ZENOHC_CUSTOM_TARGET STREQUAL ""))
 	set(cargo_flags ${cargo_flags} --target=${ZENOHC_CUSTOM_TARGET})
 endif()
@@ -270,12 +292,13 @@ endif()
 # Define include directories for library targets
 status_print(source_include_dir)
 status_print(cargo_generated_include_dir)
-target_include_directories(zenohc_static INTERFACE ${source_include_dir})
-target_include_directories(zenohc_shared INTERFACE ${source_include_dir})
 
 if(NOT(cargo_generated_include_dir STREQUAL ${source_include_dir}))
 	target_include_directories(zenohc_static INTERFACE ${cargo_generated_include_dir})
 	target_include_directories(zenohc_shared INTERFACE ${cargo_generated_include_dir})
+else()
+	target_include_directories(zenohc_static INTERFACE ${source_include_dir})
+	target_include_directories(zenohc_shared INTERFACE ${source_include_dir})
 endif()
 
 set_target_properties(zenohc_shared zenohc_static PROPERTIES IMPORTED_GLOBAL TRUE)