Merge pull request #34 from andreiavrammsd/build-examples

Add iterator reference type.

Author: andreiavrammsd

.github/workflows/cmake.yml

@@ -60,7 +60,7 @@ jobs:
         working-directory: ${{github.workspace}}/build
         shell: bash
         # Execute the build.  You can specify a specific target with "--target <NAME>"
-        run: cmake --build . --config ${{ matrix.config.build_type }} --target channel_test11 channel_test14 channel_test17
+        run: cmake --build . --config ${{ matrix.config.build_type }} --target tests examples
 
       - name: Test
         working-directory: ${{github.workspace}}/build

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.12)
 project(cpp_channel)
-set(PROJECT_VERSION 0.8.0)
+set(PROJECT_VERSION 0.8.1)
 
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)

examples/CMakeLists.txt

@@ -2,10 +2,18 @@ function(add_example NAME)
     add_executable(${NAME} ${ARGN})
 
     set_target_warnings(${NAME} PRIVATE)
-    target_link_libraries(${NAME} -ltsan)
-    target_compile_options(${NAME} PRIVATE -fsanitize=thread)
+
+    if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+        target_link_libraries(${NAME} -ltsan)
+        target_compile_options(${NAME} PRIVATE -fsanitize=thread)
+    endif()    
+
+    add_dependencies(examples ${NAME})
 endfunction()
 
+add_custom_target(examples)
+
+# Examples
 add_example(example_basic basic.cpp)
 add_example(example_close close.cpp)
 add_example(example_move move.cpp)

examples/cmake-project/CMakeLists.txt

@@ -14,7 +14,7 @@ target_link_libraries(cmake_project)
 
 include(FetchContent)
 if (NOT channel_POPULATED)
-    FetchContent_Declare(channel URL https://github.com/andreiavrammsd/cpp-channel/archive/v0.8.0.zip)
+    FetchContent_Declare(channel URL https://github.com/andreiavrammsd/cpp-channel/archive/v0.8.1.zip)
     FetchContent_Populate(channel)
     include_directories(${channel_SOURCE_DIR}/include)
     # OR

examples/streaming.cpp

@@ -1,21 +1,23 @@
 #include <chrono>
 #include <future>
 #include <iostream>
+#include <string>
 #include <thread>
 #include <utility>
+#include <vector>
 
 #include "msd/channel.hpp"
 
 int main()
 {
     using messages = msd::channel<std::string>;
 
-    auto threads = std::thread::hardware_concurrency();
+    const auto threads = std::thread::hardware_concurrency();
     messages channel{threads};
 
     // Continuously get some data on multiple threads and send it all to a channel
-    auto in = [](messages& ch, int thread, std::chrono::milliseconds pause) {
-        thread_local static int i = 0;
+    const auto in = [](messages& ch, std::size_t thread, std::chrono::milliseconds pause) {
+        thread_local static std::size_t i = 0U;
 
         while (true) {
             if (ch.closed()) {
@@ -31,21 +33,21 @@ int main()
 
     std::vector<std::future<void>> in_futures;
     for (std::size_t i = 0U; i < threads; ++i) {
-        in_futures.push_back(std::async(in, std::ref(channel), i, std::chrono::milliseconds{500}));
+        in_futures.push_back(std::async(in, std::ref(channel), i, std::chrono::milliseconds{500U}));
     }
 
     // Stream incoming data to a destination
-    auto out = [](messages& ch, std::ostream& stream, const std::string& separator) {
+    const auto out = [](messages& ch, std::ostream& stream, const std::string& separator) {
         std::move(ch.begin(), ch.end(), std::ostream_iterator<std::string>(stream, separator.c_str()));
     };
-    auto out_future = std::async(out, std::ref(channel), std::ref(std::cout), "\n");
+    const auto out_future = std::async(out, std::ref(channel), std::ref(std::cout), "\n");
 
     // Close the channel after some time
-    auto timeout = [](messages& ch, std::chrono::milliseconds after) {
+    const auto timeout = [](messages& ch, std::chrono::milliseconds after) {
         std::this_thread::sleep_for(after);
         ch.close();
     };
-    auto timeout_future = std::async(timeout, std::ref(channel), std::chrono::milliseconds{3000});
+    const auto timeout_future = std::async(timeout, std::ref(channel), std::chrono::milliseconds{3000U});
 
     out_future.wait();
     for (auto& future : in_futures) {

include/msd/blocking_iterator.hpp

@@ -20,6 +20,7 @@ template <typename Channel>
 class blocking_iterator {
    public:
     using value_type = typename Channel::value_type;
+    using reference = typename Channel::value_type&;
 
     explicit blocking_iterator(Channel& ch) : ch_{ch} {}
 
@@ -62,6 +63,7 @@ class blocking_iterator {
 template <typename T>
 struct std::iterator_traits<msd::blocking_iterator<T>> {
     using value_type = typename msd::blocking_iterator<T>::value_type;
+    using reference = typename msd::blocking_iterator<T>::reference;
     using iterator_category = std::output_iterator_tag;
 };
 

tests/CMakeLists.txt

@@ -31,8 +31,12 @@ function(package_add_test TESTNAME)
     endif ()
 
     add_test(NAME ${TESTNAME} COMMAND ${TESTNAME})
+
+    add_dependencies(tests ${TESTNAME})
 endfunction()
 
+add_custom_target(tests)
+
 # Tests
 package_add_test(channel_test11 channel_test.cpp blocking_iterator_test.cpp)
 package_add_test(channel_test14 channel_test.cpp blocking_iterator_test.cpp)