Working in shared buffer repo

Author: cliffg-softwarelibre

.github/workflows/build_run_unit_test_cmake.yml

@@ -0,0 +1,30 @@
+# Build, run unit tests
+name: CMake build and run unit test matrix
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+env:
+  BUILD_TYPE: Release
+jobs:
+  build_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-14]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: create-build-dir
+        run: mkdir build
+      - name: configure-cmake
+        run: cd build && cmake -D SHARED_BUFFER_BUILD_TESTS:BOOL=ON -D SHARED_BUFFER_BUILD_EXAMPLES:BOOL=ON ..
+      - name: build
+        run: cd build && cmake --build . --config $BUILD_TYPE
+      - name: run-unit-test
+        run: cd build && ctest -C $BUILD_TYPE

.github/workflows/gen_docs.yml

@@ -0,0 +1,28 @@
+# Build, run unit tests
+name: Generate documentation
+
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: run-doxygen
+        uses: mattnotmitt/doxygen-action@v1.9.8
+        with:
+          working-directory: doc
+      - name: deploy-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/doc_output/html

example/CMakeLists.txt

@@ -8,6 +8,12 @@ cmake_minimum_required ( VERSION 3.14 FATAL_ERROR )
 # create project
 project ( shared_buffer_example LANGUAGES CXX )
 
+# add dependencies
+include ( ../cmake/download_cpm.cmake )
+
+CPMAddPackage ( "gh:connectivecpp/utility-rack@1.0.0" )
+CPMAddPackage ( "gh:connectivecpp/binary-serialize@1.0.0" )
+
 # add executable
 add_executable ( shared_buffer_example shared_buffer_example.cpp )
 target_compile_features ( shared_buffer_example PRIVATE cxx_std_20 )

example/shared_buffer_example.cpp

@@ -4,8 +4,6 @@
  *  @c chops::repeat. See @c threaded_wait_shared_demo.cpp for multithreaded
  *  example.
  * 
- *  @ingroup example_module
- *
  *  @author Thurman Gillespy
  * 
  *  @copyright (c) 2019 by Thurman Gillespy
@@ -28,8 +26,8 @@
 #include <cstdint> // std::uint16_t
 #include <string>
 
-#include "marshall/extract_append.hpp"
-#include "marshall/shared_buffer.hpp"
+#include "serialize/extract_append.hpp"
+#include "buffer/shared_buffer.hpp"
 #include "utility/repeat.hpp"
 
 // tasty utility lambda function

include/buffer/shared_buffer.hpp

@@ -573,7 +573,7 @@ class const_shared_buffer {
  *  @return Spaceship operator comparison result.
  *
  */
-  bool operator<=> (const const_shared_buffer& lhs, const const_shared_buffer& rhs) noexcept {
+  auto operator<=> (const const_shared_buffer& rhs) noexcept {
     return *m_data <=> *rhs.m_data;
   }
 

test/CMakeLists.txt

@@ -19,7 +19,7 @@ CPMAddPackage ( "gh:catchorg/Catch2@3.5.4" )
 CPMAddPackage ( "gh:connectivecpp/utility-rack@1.0.0" )
 
 # link dependencies
-target_link_libraries ( shared_buffer_test PRIVATE utility_rack Catch2::Catch2WithMain )
+target_link_libraries ( shared_buffer_test PRIVATE shared_buffer utility_rack Catch2::Catch2WithMain )
 
 enable_testing()
 

test/shared_buffer_test.cpp

@@ -13,6 +13,7 @@
  */
 
 #include "catch2/catch_test_macros.hpp"
+#include "catch2/catch_template_test_macros.hpp"
 
 
 #include <cstddef> // std::byte