merge develop

Author: liss-h

.github/workflows/detect-pobr-diff.yml

@@ -0,0 +1,27 @@
+name: Detect POBR diff
+
+on: [ pull_request ]
+
+concurrency:
+  group: detect-pobr-diff-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  detect-pobr-diff:
+    uses: dice-group/cpp-conan-release-reusable-workflow/.github/workflows/abi-diff.yml@main
+    with:
+      os: ubuntu-22.04
+      compiler: clang-16
+      cmake-version: 3.24.0
+      conan-version: 2.3.1
+      base-branch: ${{ github.base_ref }}
+      search-path: >
+        include/dice/template-library/polymorphic_allocator.hpp
+        include/dice/template-library/flex_array.hpp
+        include/dice/template-library/integral_template_tuple.hpp
+        include/dice/template-library/integral_template_variant.hpp
+      abi-version-header: include/dice/template-library/version.hpp
+      abi-version-const: dice::template_library::pobr_version
+    secrets:
+      CONAN_USER: ""
+      CONAN_PW: ""

.gitignore

@@ -107,3 +107,4 @@ test_package/build/
 test_package/CMakeUserPresets.json
 /CMakeUserPresets.json
 /conan_provider.cmake
+include/dice/template-library/version.hpp

CMakeLists.txt

@@ -2,16 +2,23 @@ cmake_minimum_required(VERSION 3.24)
 
 project(
   dice-template-library
-  VERSION 1.6.0
+  VERSION 1.7.0
   DESCRIPTION
     "This template library is a collection of template-oriented code that we, the Data Science Group at UPB, found pretty handy. It contains: `switch_cases` (Use runtime values in compile-time context), `integral_template_tuple` (Create a tuple-like structure that instantiates a template for a range of values), `integral_template_variant` (A wrapper type for `std::variant` guarantees to only contain variants of the form `T<IX>` and `for_{types,values,range}` (Compile time for loops for types, values or ranges))."
   HOMEPAGE_URL "https://dice-research.org/")
+set(POBR_VERSION 1)  # Persisted Object Binary Representation
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.hpp.in ${CMAKE_CURRENT_SOURCE_DIR}/include/dice/template-library/version.hpp)
 
 option(BUILD_TESTING "build tests" OFF)
 option(BUILD_EXAMPLES "build examples" OFF)
 
 if (PROJECT_IS_TOP_LEVEL)
     set(CONAN_INSTALL_ARGS "${CONAN_INSTALL_ARGS};-o=boost/*:header_only=True")
+
+    if (BUILD_TESTING)
+        set(CONAN_INSTALL_ARGS "${CONAN_INSTALL_ARGS};-o=&:with_test_deps=True")
+    endif ()
 endif ()
 
 # conan requires cmake build type to be specified and it is generally a good idea

README.md

@@ -14,6 +14,7 @@ It contains:
 - `flex_array`: A combination of `std::array` and `std::span`
 - `tuple_algorithms`: Some algorithms for iterating tuples
 - `generator`: The reference implementation of `std::generator` from [P2502R2](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2502r2.pdf)
+- `channel`: A single producer, single consumer queue
 
 ## Usage
 
@@ -82,6 +83,10 @@ If you want this generator to serve as a drop in replacement for `std::generator
 use `#define DICE_TEMPLATELIBRARY_GENERATOR_STD_COMPAT 1` before including the generator header. That will export
 all generator related things under namespace `std::`.
 
+### `channel`
+A single producer, single consume queue. This can be used to communicate between threads in a more high level
+fashion than a mutex+container would allow.
+
 ### Further Examples
 
 Compilable code examples can be found in [examples](./examples). The example build requires the cmake
@@ -101,7 +106,7 @@ add
 FetchContent_Declare(
         dice-template-library
         GIT_REPOSITORY "https://github.com/dice-group/dice-template-library.git"
-        GIT_TAG v1.6.0
+        GIT_TAG v1.7.0
         GIT_SHALLOW TRUE)
 
 FetchContent_MakeAvailable(dice-template-library)
@@ -120,7 +125,7 @@ target_link_libraries(your_target
 ### conan
 
 You can use it with [conan](https://conan.io/).
-To do so, you need to add `dice-template-library/1.6.0` to the `[requires]` section of your conan file.
+To do so, you need to add `dice-template-library/1.7.0` to the `[requires]` section of your conan file.
 
 ## Build and Run Tests and Examples
 

cmake/version.hpp.in

@@ -0,0 +1,13 @@
+#ifndef DICE_TEMPLATELIBRARY_VERSION_HPP
+#define DICE_TEMPLATELIBRARY_VERSION_HPP
+
+#include <array>
+
+namespace dice::template_library {
+    inline constexpr char name[] = "@PROJECT_NAME@";
+    inline constexpr char version[] = "@PROJECT_VERSION@";
+    inline constexpr std::array<int, 3> version_tuple = {@PROJECT_VERSION_MAJOR@, @PROJECT_VERSION_MINOR@, @PROJECT_VERSION_PATCH@};
+    inline constexpr int pobr_version = @POBR_VERSION@; ///< persisted object binary representation version
+} // namespace dice::template_library
+
+#endif // DICE_TEMPLATELIBRARY_VERSION_HPP

conanfile.py

@@ -18,10 +18,17 @@ class DiceTemplateLibrary(ConanFile):
     settings = "os", "compiler", "build_type", "arch"
     exports_sources = "include/*", "CMakeLists.txt", "cmake/*", "LICENSE"
     no_copy_source = True
+    options = {
+        "with_test_deps": [True, False],
+    }
+    default_options = {
+        "with_test_deps": False,
+    }
 
     def requirements(self):
-        self.test_requires("boost/1.83.0")
-        self.test_requires("doctest/2.4.11")
+        if self.options.with_test_deps:
+            self.test_requires("boost/1.83.0")
+            self.test_requires("doctest/2.4.11")
 
     def layout(self):
         cmake_layout(self)

examples/CMakeLists.txt

@@ -65,3 +65,10 @@ target_link_libraries(example_generator
         PRIVATE
         dice-template-library::dice-template-library
 )
+
+add_executable(example_channel
+        example_channel.cpp)
+target_link_libraries(example_channel
+        PRIVATE
+        dice-template-library::dice-template-library
+)

examples/example_channel.cpp

@@ -0,0 +1,26 @@
+#include <dice/template-library/channel.hpp>
+
+#include <algorithm>
+#include <iostream>
+#include <thread>
+#include <vector>
+
+
+int main() {
+	dice::template_library::channel<int> chan{8};
+
+	std::jthread thrd{[&chan]() {
+		std::vector<int> ints;
+		for (int x : chan) {
+			ints.push_back(x);
+			std::cout << x << ' ';
+		}
+
+		assert(std::ranges::equal(ints, std::vector<int>{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}));
+	}};
+
+	for (int x = 0; x < 10; ++x) {
+		chan.push(x);
+	}
+	chan.close(); // don't forget to close
+}