started to update the poject to the Beman standard

Author: dietmarkuehl

CMakeLists.txt

@@ -1,15 +1,32 @@
 # cmake-format: off
-# /CMakeLists.txt -*-makefile-*-
+# CMakeLists.txt -*-makefile-*-
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 # cmake-format: on
 
 cmake_minimum_required(VERSION 3.25...3.31)
 
-project(beman_execution VERSION 0.0.1 LANGUAGES CXX)
+project(
+    beman.execution
+    DESCRIPTION "Beman implementation of asynchronous components"
+    LANGUAGES CXX
+    VERSION 0.0.1
+)
 
-if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
-  message(FATAL_ERROR "In-source builds are not allowed!")
-endif()
+option(
+    BEMAN_EXECUTION_BUILD_TESTS
+    "Enable building tests and test infrastructure. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }."
+    ${PROJECT_IS_TOP_LEVEL}
+)
+option(
+    BEMAN_EXECUTION_BUILD_EXAMPLES
+    "Enable building examples. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }."
+    ${PROJECT_IS_TOP_LEVEL}
+)
+option(
+    BEMAN_EXECUTION_INSTALL_CONFIG_FILE_PACKAGE
+    "Enable creating and installing a CMake config-file package. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }."
+    ${PROJECT_IS_TOP_LEVEL}
+)
 
 set(TARGET_NAME execution)
 set(TARGET_NAMESPACE beman)
@@ -19,112 +36,14 @@ set(TARGET_ALIAS ${TARGET_NAMESPACE}::${TARGET_NAME})
 set(TARGET_PACKAGE_NAME ${PROJECT_NAME}-config)
 set(TARGETS_EXPORT_NAME ${PROJECT_NAME}-targets)
 
-option(
-  BEMAN_EXECUTION_ENABLE_TESTING
-  "Enable building tests and test infrastructure. Values: { ON, OFF }."
-  ${PROJECT_IS_TOP_LEVEL}
-)
-
-option(
-  BEMAN_EXECUTION_BUILD_EXAMPLES
-  "Enable building examples. Values: { ON, OFF }."
-  ${PROJECT_IS_TOP_LEVEL}
-)
-
-option(
-  BEMAN_EXECUTION_ENABLE_INSTALL
-  "Install the project components. Values: { ON, OFF }."
-  ${PROJECT_IS_TOP_LEVEL}
-)
-
-include(GNUInstallDirs)
-set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
-
-if(PROJECT_IS_TOP_LEVEL AND NOT BEMAN_EXECUTION_ENABLE_INSTALL OR CMAKE_SKIP_INSTALL_RULES)
-  set(CMAKE_SKIP_INSTALL_RULES ON)
-
-  include(FetchContent)
-
-  # Add project_options from https://github.com/aminya/project_options
-  # Change the version in the following URL to update the package
-  # (watch the releases of the repository for future updates)
-  set(PROJECT_OPTIONS_VERSION "v0.41.0")
-  FetchContent_Declare(
-    _project_options URL https://github.com/aminya/project_options/archive/refs/tags/${PROJECT_OPTIONS_VERSION}.zip
-  )
-  FetchContent_MakeAvailable(_project_options)
-  include(${_project_options_SOURCE_DIR}/Index.cmake)
-
-  # Initialize project_options variable related to this project
-  # This overwrites `project_options` and sets `project_warnings`
-  # uncomment to enable the options. Some of them accept one or more inputs:
-  project_options(
-    PREFIX
-    ${TARGET_NAME}
-    ENABLE_CACHE
-    # NO! # ENABLE_CLANG_TIDY
-    # NO! ENABLE_VS_ANALYSIS
-    # ENABLE_INTERPROCEDURAL_OPTIMIZATION
-    # ENABLE_NATIVE_OPTIMIZATION
-    # ENABLE_DOXYGEN
-    # ENABLE_COVERAGE
-    ENABLE_SANITIZER_ADDRESS
-    ENABLE_SANITIZER_UNDEFINED
-    # TODO: ENABLE_SANITIZER_THREAD
-    # FIXME: on Linux only with clang++? ENABLE_SANITIZER_MEMORY
-    ENABLE_SANITIZER_POINTER_COMPARE
-    ENABLE_SANITIZER_POINTER_SUBTRACT
-    ENABLE_CONTROL_FLOW_PROTECTION
-    ENABLE_STACK_PROTECTION
-    ENABLE_OVERFLOW_PROTECTION
-    # ENABLE_ELF_PROTECTION
-    # ENABLE_RUNTIME_SYMBOLS_RESOLUTION
-    # ENABLE_COMPILE_COMMANDS_SYMLINK
-    # ENABLE_PCH
-    # PCH_HEADERS
-    # WARNINGS_AS_ERRORS
-    # ENABLE_INCLUDE_WHAT_YOU_USE
-    # ENABLE_GCC_ANALYZER
-    # ENABLE_BUILD_WITH_TIME_TRACE
-    # TODO: buggy! ENABLE_UNITY
-    # LINKER "lld"
-  )
-endif()
-
 add_subdirectory(src/beman/execution)
 
-if(BEMAN_EXECUTION_ENABLE_TESTING)
+if(BEMAN_EXECUTION_BUILD_TESTS)
   enable_testing()
-
   add_subdirectory(tests/beman/execution)
 endif()
 
 if(BEMAN_EXECUTION_BUILD_EXAMPLES)
+  enable_testing()
   add_subdirectory(examples)
 endif()
-
-if(NOT BEMAN_EXECUTION_ENABLE_INSTALL OR CMAKE_SKIP_INSTALL_RULES)
-  return()
-endif()
-
-include(CMakePackageConfigHelpers)
-
-write_basic_package_version_file(
-  ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}-version.cmake
-  VERSION ${CMAKE_PROJECT_VERSION}
-  COMPATIBILITY AnyNewerVersion
-)
-
-configure_package_config_file(
-  "cmake/Config.cmake.in" ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}.cmake
-  INSTALL_DESTINATION ${INSTALL_CONFIGDIR}
-)
-
-install(
-  FILES ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}.cmake
-        ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_PACKAGE_NAME}-version.cmake
-  DESTINATION ${INSTALL_CONFIGDIR}
-)
-
-set(CPACK_GENERATOR TGZ)
-include(CPack)

LICENSE.txt LICENSELICENSE.txt renamed to LICENSE

@@ -1,9 +1,18 @@
 <!--
 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 -->
-# beman.execution: Building Block For Asynchronous Programs
+# beman.execution: Asynchronous Programming Foundation
 
-<img src="https://github.com/bemanproject/beman/blob/main/images/logos/beman_logo-beman_library_under_development.png" style="width:5%; height:auto;">
+![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/execution/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/execution/actions/workflows/pre-commit.yml/badge.svg)
+[![Compiler Explorer Example](https://img.shields.io/badge/Try%20it%20on%20Compiler%20Explorer-grey?logo=compilerexplorer&logoColor=67c52a)](https://godbolt.org/z/1narY8cra)
+
+`beman.execution` provides vocabulary and algorithms for asynchronous programs.
+
+**Implements:** [`std::execution` (P2300R10)](http://wg21.link/P2300R10).
+
+**Status**: [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/BEMAN_LIBRARY_MATURITY_MODEL.md#under-development-and-not-yet-ready-for-production-use)
+
+## Description
 
 `beman.execution` provides the basic vocabulary for asynchronous
 programming as well as important algorithms implemented in terms
@@ -35,10 +44,6 @@ e.g.:
     completed.
 - `bulk(...)` to executed execute work, potentially concurrently.
 
-**Implements:** [`std::execution` (P2300R10)](http://wg21.link/P2300R10).
-
-**Status**: [Under development and not yet ready for production use.](https://github.com/bemanproject/beman/blob/main/docs/BEMAN_LIBRARY_MATURITY_MODEL.md#under-development-and-not-yet-ready-for-production-use)
-
 ## Help Welcome!
 
 There are plenty of things which need to be done. See the

README.md

@@ -6,7 +6,7 @@ This page provides a series of examples showing how to use the
 `std::execution` components.
 
 <details>
-<summary>`"Hello, world"` - synchronous using asynchronous components</summary>
+<summary><code>"Hello, world"</code> - synchronous using asynchronous components</summary>
 
 Code: [`examples/intro-1-hello-world.cpp`]()
 @include examples/intro-1-hello-world.cpp
@@ -124,7 +124,7 @@ The components used in this example do all of that synchronously:
 </details>
 
 <details>
-<summary>`"Hello, async"` - a simple asynchronous example</summary>
+<summary><code>"Hello, async"</code> - a simple asynchronous example</summary>
 
 Code: [`examples/intro-2-hello-async.cpp`]()
 @include examples/intro-2-hello-async.cpp

docs/intro-examples.md

@@ -25,4 +25,5 @@ foreach(EXAMPLE ${EXAMPLES})
   add_executable(${EXAMPLE_TARGET})
   target_sources(${EXAMPLE_TARGET} PRIVATE ${EXAMPLE}.cpp)
   target_link_libraries(${EXAMPLE_TARGET} PRIVATE ${TARGET_NAMESPACE}::${TARGET_NAME})
+  add_test(NAME ${EXAMPLE_TARGET} COMMAND $<TARGET_FILE:${EXAMPLE_TARGET}>)
 endforeach()

examples/CMakeLists.txt

@@ -10,7 +10,7 @@ namespace ex = ::beman::execution;
 using namespace std::string_literals;
 
 // ----------------------------------------------------------------------------
-// Please see the explanation in docs/intro-examples.md for an explanation.
+// Explanation: https://github.com/bemanproject/execution/blob/main/docs/intro-examples.md
 
 int main() {
     // clang-format off

examples/intro-1-hello-world.cpp

@@ -84,12 +84,13 @@ int main() {
             inject_cancel_sender{token, ex::read_env(ex::get_stop_token) | ex::then([](ex::inplace_stop_token tok) {
                                             while (not tok.stop_requested()) {
                                                 std::cout << "sleeping\n";
-                                                std::this_thread::sleep_for(1s);
+                                                std::this_thread::sleep_for(100ms);
                                             }
                                         })});
     });
 
-    std::cin.get();
+    // std::cin.get();
+    std::this_thread::sleep_for(300ms);
     std::cout << "requesting stop\n";
     source.request_stop();
 

examples/stopping.cpp

@@ -6,11 +6,6 @@
 add_library(${TARGET_NAME} STATIC)
 add_library(${TARGET_ALIAS} ALIAS ${TARGET_NAME})
 
-if(NOT BEMAN_EXECUTION_ENABLE_INSTALL OR CMAKE_SKIP_INSTALL_RULES)
-  target_link_libraries(${TARGET_NAME} PUBLIC $<BUILD_INTERFACE:${TARGET_NAME}_project_options>)
-  target_link_libraries(${TARGET_NAME} PUBLIC $<BUILD_INTERFACE:${TARGET_NAME}_project_warnings>)
-endif()
-
 include(CMakePrintHelpers)
 cmake_print_variables(TARGET_ALIAS TARGET_NAME TARGET_PREFIX PROJECT_SOURCE_DIR)
 

src/beman/execution/CMakeLists.txt

@@ -110,7 +110,6 @@ if(NOT DEFINED CMAKE_PREFIX_PATH)
 endif()
 
 if(PROJECT_IS_TOP_LEVEL)
-  enable_testing()
   find_package(beman_execution 0.0.1 EXACT QUIET)
   if(beman_execution_FOUND)
     set(execution_tests exec-awaitable.test) # only one sample to save time! CK