[pull] master from boostorg:master

.github/actions/boost_clone/action.yml

@@ -0,0 +1,121 @@
+name: 'Boost Clone'
+description: 'This workflow clones the boost source directory, attempting to get it from the cache first'
+inputs:
+  boost_dir:
+    description: 'The boost directory. The default value assumes boost is in-source.'
+    required: false
+    default: 'boost'
+  branch:
+    description: 'Branch of the super-project'
+    required: false
+    default: 'master'
+  patches:
+    description: 'Libraries used to patch the boost installation'
+    required: true
+    default: ''
+  modules:
+    description: 'The boost submodules we need to clone'
+    required: false
+    default: ''
+
+runs:
+  using: "composite"
+  steps:
+    - name: Environment
+      id: ctx
+      shell: bash
+      run: |
+        boost_hash=$(git ls-remote https://github.com/boostorg/boost.git ${{ inputs.branch }} | awk '{ print $1 }')
+        echo "boost_hash=$boost_hash" >> $GITHUB_OUTPUT
+
+        # Create cache hash
+        cache_hash=${{ runner.os }}-boost-$boost_hash
+        # Add modules names to hash
+        modules=${{ inputs.modules }}
+        for module in ${modules//,/ }
+        do
+            module_filename=${module##*/}
+            cache_hash=$cache_hash-$module_filename
+        done
+        # Add patch names and hashes to hash
+        patches=${{ inputs.patches }}
+        for patch in ${patches//,/ }
+        do
+            patch_hash=$(git ls-remote $patch ${{ inputs.branch }} | awk '{ print $1 }')
+            cache_hash=$cache_hash-$patch-$patch_hash
+        done
+        echo "cache_hash=$cache_hash" >> $GITHUB_OUTPUT
+
+    # attempt to get boost from the cache before cloning it
+    - name: boost cache
+      id: cache-boost
+      uses: actions/cache@v3
+      with:
+        path: boost
+        key: ${{ steps.ctx.outputs.cache_hash }}
+
+    # clone (if boost not found in cache)
+    - name: boost clone
+      if: steps.cache-boost.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        git clone https://github.com/boostorg/boost.git -b ${{ inputs.branch }} ${{ inputs.boost_dir }}
+
+    # apply patches (if boost not found in cache)
+    - name: boost patches
+      if: steps.cache-boost.outputs.cache-hit != 'true' && inputs.patches != ''
+      shell: bash
+      working-directory: ${{ inputs.boost_dir }}/libs
+      run: |
+        # Apply boost patches ${{ inputs.patches }}
+        patches=${{ inputs.patches }}
+        for patch in ${patches//,/ }
+        do
+            git clone $patch -b ${{ inputs.branch }}
+        done
+
+    # Init all submodules (if boost not found in cache + no specific modules specified)
+    - name: boost init submodules
+      if: (steps.cache-boost.outputs.cache-hit != 'true' && inputs.modules == '')
+      working-directory: ${{ inputs.boost_dir }}
+      shell: bash
+      run: |
+        # Init all boost submodules
+        git submodule update --init --recursive
+
+    # Init specified submodules (if boost not found in cache + modules specified)
+    - name: boost patches
+      if: (steps.cache-boost.outputs.cache-hit != 'true' && inputs.modules != '')
+      working-directory: ${{ inputs.boost_dir }}
+      shell: bash
+      run: |
+        # Init required boost submodules
+        echo "Look for python"
+        if command -v python &> /dev/null; then
+          python_executable="python"
+        elif command -v python3 &> /dev/null; then
+          python_executable="python3"
+        elif command -v python2 &> /dev/null; then
+          python_executable="python2"
+        else
+          echo "Please install Python!" >&2
+          false
+        fi
+        echo "python_executable=$python_executable"
+
+        echo "Init boostdep"
+        git submodule update -q --init tools/boostdep
+
+        echo "Run boostdep for required modules: ${{ inputs.modules }}"
+        modules=${{ inputs.modules }}
+        for module in ${modules//,/ }
+        do
+            echo "Init submodule $module"
+            git submodule update -q --init libs/$module || true
+        done
+        for module in ${modules//,/ }
+        do
+            echo "Run boostdep for required module $module"
+            $python_executable tools/boostdep/depinst/depinst.py --include benchmark --include example --include examples --include tools --include source $module
+        done
+

.github/actions/cmake_run/action.yml

@@ -0,0 +1,131 @@
+name: 'Install dependencies'
+description: 'This workflow installs dependencies from multiple package managers'
+inputs:
+  cmake_exec:
+    description: 'The cmake executable'
+    required: false
+    default: 'cmake'
+  cc:
+    description: 'Path to C compiler.'
+    required: false
+    default: ''
+  cxx:
+    description: 'Path to C++ compiler.'
+    required: false
+    default: ''
+  cxxstd:
+    description: 'List of standards with which cmake will build and test the program.'
+    required: false
+    default: ''
+  source_dir:
+    description: 'Path to the source directory.'
+    required: false
+    default: ''
+  toolchain:
+    description: 'Path to toolchain.'
+    required: false
+    default: ''
+  build-type:
+    description: 'Build type.'
+    required: false
+    default: 'Release'
+  build-target:
+    description: 'Targets to build instead of the default target'
+    required: false
+    default: ''
+  install-prefix:
+    description: 'Path where the library should be installed.'
+    required: false
+    default: '.local/usr'
+  run-tests:
+    description: 'Whether we should run tests.'
+    required: false
+    default: 'true'
+  extra-args:
+    description: 'Extra arguments to cmake configure command.'
+    required: false
+    default: ''
+
+runs:
+  using: "composite"
+  steps:
+    - name: Get CPU cores
+      uses: SimenB/github-actions-cpu-cores@v1
+      id: cpu-cores
+
+    - name: Setup msvc dev-cmd
+      if: runner.os == 'Windows'
+      uses: ilammy/msvc-dev-cmd@v1
+
+    - name: CMake Build C++${{ inputs.cxxstd }}
+      shell: bash
+      working-directory: ${{ inputs.source_dir }}
+      run: |
+        set -xe
+
+        # cmake args
+        cc=${{ matrix.cc }}
+        if [ "$cc" != "" ]; then
+            if command -v $cc &> /dev/null; then
+              cc="$(which $cc)"
+            elif command -v /usr/bin/$cc &> /dev/null; then
+              cc="/usr/bin/$cc"
+            fi
+            cmake_cc_path_args="-D CMAKE_C_COMPILER=$cc"
+        else
+            cmake_cc_path_args=
+        fi
+
+        cxx=${{ matrix.cxx }}
+        if [ "$cxx" != "" ]; then
+            if command -v $cxx &> /dev/null; then
+              cxx="$(which $cxx)"
+            elif command -v /usr/bin/$cxx &> /dev/null; then
+              cxx="/usr/bin/$cxx"
+            fi
+            cmake_cxx_path_args="-D CMAKE_CXX_COMPILER=$cxx"
+        else
+            cmake_cxx_path_args=
+        fi
+
+        cxxstds=${{ inputs.cxxstd }}
+        if [ "$cxxstds" == "" ]; then
+            cxxstds=defaultcxx
+        fi
+
+        cmake_toolchain=${{ inputs.toolchain }}
+        if [ "$cmake_toolchain" != "" ]; then
+            cmake_toolchain_arg="-D CMAKE_TOOLCHAIN_FILE=$cmake_toolchain"
+        else
+            cmake_toolchain_arg=
+        fi
+
+        run_tests=${{ inputs.run-tests }}
+        if [ "$run_tests" == "true" ]; then
+          cmake_enable_test_args="-D BUILD_TESTING=ON"
+        fi
+
+        build_target=${{ inputs.build-target }}
+        if [ "$build_target" != "true" ]; then
+          target_args="--target $build_target"
+        fi
+
+        # iterate stds
+        for cxxstd in ${cxxstds//,/ }
+        do
+            echo "==================================> CMAKE: C++$cxxstd"
+            if [ "$cxxstd" == "defaultcxx" ]; then
+                cmake_cxxstd_arg=""
+                build_dir="build"
+            else
+                cmake_cxxstd_arg="-D CMAKE_CXX_STANDARD=$cxxstd"
+                build_dir="build-$cxxstd"
+            fi
+            cmake -S . -B $build_dir -D CMAKE_BUILD_TYPE=${{ inputs.build-type }} $cmake_toolchain_arg $cmake_cxxstd_arg ${{ inputs.extra-args }} -D CMAKE_INSTALL_PREFIX=${{ inputs.install-prefix }} $cmake_cc_path_args $cmake_cxx_path_args $cmake_enable_test_args
+            cmake --build $build_dir --config ${{ inputs.build-type }} -j ${{ steps.cpu-cores.outputs.count }} $target_args
+            cmake --install $build_dir --config ${{ inputs.build-type }} --prefix prefix
+            if [ "$run_tests" == "true" ]; then
+              ctest --test-dir "$build_dir" -j ${{ steps.cpu-cores.outputs.count }} -C ${{ inputs.build-type }} --no-tests=error --progress --output-on-failure
+            fi
+        done
+

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - '*'
+      - '*/*'
+
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  build:
+    name: ${{ matrix.name }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { name: "MSVC 14.3 - C++17-20", os: windows-2022, cxxstd: '17,20', cmake_args: -G "Visual Studio 17 2022" -A x64, }
+          - { name: "clang-cl 14.3 - C++14,20", os: windows-2022, cxxstd: '14,20', cmake_args: -G "Visual Studio 17 2022" -T ClangCL -A x64, }
+          - { name: "MSVC 14.2 - C++14-17", os: windows-2019, cxxstd: '14,17', cmake_args: -G "Visual Studio 16 2019" -A x64, }
+
+          - { name: "GCC 12 - C++17-20", os: ubuntu-22.04, cc: gcc-12, cxx: g++-12, cxxstd: '17,20', install: g++-12, }
+          - { name: "GCC 11 - C++14,20",    os: ubuntu-22.04, cc: gcc-11, cxx: g++-11, cxxstd: '14,20', install: g++-11, }
+# The GCC 10 this runner has is broken
+#          - { name: "GCC 10 - C++17-20",    os: ubuntu-22.04, cc: gcc-10, cxx: g++-10, cxxstd: '17,20', }
+          - { name: "GCC 9  - C++17-20",    os: ubuntu-22.04, cc: gcc-9,  cxx: g++-9,  cxxstd: '17,20', install: g++-9, }
+          - { name: "GCC 8  - C++14-17",    os: ubuntu-20.04, cc: gcc-8,  cxx: g++-8,  cxxstd: '14,17', install: g++-8, }
+          - { name: "GCC 7  - C++14",    os: ubuntu-20.04, cc: gcc-7,  cxx: g++-7,  cxxstd: 14, install: g++-7, }
+
+          - { name: "Clang 14 - C++17-20",  os: ubuntu-22.04, cc: clang-14, cxx: clang++-14, cxxstd: '17,20', install: clang-14, }
+          - { name: "Clang 13 - C++14,20",  os: ubuntu-22.04, cc: clang-13, cxx: clang++-13, cxxstd: '14,20', install: clang-13, }
+          - { name: "Clang 12 - C++17-20",  os: ubuntu-22.04, cc: clang-12, cxx: clang++-12, cxxstd: '17,20', install: clang-12, }
+          - { name: "Clang 11 - C++14-17",  os: ubuntu-20.04, cc: clang-11, cxx: clang++-11, cxxstd: '14,17', install: clang-11, }
+
+          - { name: "AppleClang 13",     os: macos-12,     cxxstd: 17 }
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Outcome checkout
+        uses: actions/checkout@v4
+
+      - name: Install packages
+        if: startsWith(matrix.os, 'ubuntu') && matrix.install
+        run: sudo apt-get install -y ${{ matrix.install }}
+
+      - name: Boost checkout
+        uses: ./.github/actions/boost_clone
+        with:
+          boost_dir: boost
+          branch: ${{ (github.ref_name == 'master' && 'master') || 'develop' }}
+          modules: config,exception,system,throw_exception,test
+
+      - name: CMake Run (C++${{ matrix.cxxstd }})
+        uses: ./.github/actions/cmake_run
+        with:
+          cxxstd: ${{ matrix.cxxstd }}
+          cxx: ${{ matrix.cxx }}
+          cc: ${{ matrix.cc }}
+          extra-args: ${{ format('-D BOOST_SRC_DIR=boost {0}', matrix.cmake_args) }}
+          build-target: tests
+

CMakeLists.txt

@@ -7,6 +7,34 @@ cmake_minimum_required(VERSION 3.5...3.16)
 
 project(boost_outcome VERSION "${BOOST_SUPERPROJECT_VERSION}" LANGUAGES CXX)
 
+if (${PROJECT_SOURCE_DIR} STREQUAL ${CMAKE_SOURCE_DIR})
+  # Project is root. Find Boost source.
+  set(BOOST_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../.." CACHE STRING "Boost source dir to use when running CMake from this directory")
+  if (NOT IS_ABSOLUTE ${BOOST_SRC_DIR})
+    set(BOOST_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${BOOST_SRC_DIR}")
+  endif()
+  set(BOOST_SRC_DIR_IS_VALID ON)
+  foreach (F "CMakeLists.txt" "Jamroot" "boost-build.jam" "bootstrap.sh" "libs")
+    if (NOT EXISTS "${BOOST_SRC_DIR}/${F}")
+      message(STATUS "${BOOST_SRC_DIR}/${F} does not exist. Fallback to find_package.")
+      set(BOOST_SRC_DIR_IS_VALID OFF)
+      break()
+    endif()
+  endforeach()
+  # Create Boost targets from source dir or boost package.
+  set(BOOST_INCLUDE_LIBRARIES config exception system throw_exception test)
+  if (BOOST_SRC_DIR_IS_VALID)
+    set(BOOST_EXCLUDE_LIBRARIES ${PROJECT_NAME})
+    add_subdirectory(${BOOST_SRC_DIR} deps_/boost EXCLUDE_FROM_ALL)
+    set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${BOOST_SRC_DIR}/tools/cmake/include")
+  else()
+    find_package(Boost 1.81.0 REQUIRED)
+    foreach (BOOST_INCLUDE_LIBRARY ${BOOST_INCLUDE_LIBRARIES})
+      add_library(Boost::${BOOST_INCLUDE_LIBRARY} ALIAS Boost::headers)
+    endforeach ()
+  endif()
+endif()
+
 add_library(boost_outcome INTERFACE)
 add_library(Boost::outcome ALIAS boost_outcome)
 
@@ -25,8 +53,11 @@ target_compile_features(boost_outcome
     cxx_std_14
 )
 
-if(BUILD_TESTING AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test/CMakeLists.txt")
+if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 10 AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 11)
+  target_compile_options(boost_outcome INTERFACE -ftemplate-depth=5000)
+endif ()
 
+if(BUILD_TESTING AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test/CMakeLists.txt")
+  enable_testing()
   add_subdirectory(test)
-
 endif()

build.jam

@@ -0,0 +1,26 @@
+# Copyright René Ferdinand Rivera Morell 2023-2024
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+require-b2 5.2 ;
+
+constant boost_dependencies :
+    /boost/assert//boost_assert
+    /boost/config//boost_config
+    /boost/exception//boost_exception
+    /boost/system//boost_system
+    /boost/throw_exception//boost_throw_exception ;
+
+project /boost/outcome
+    : common-requirements
+        <include>include
+    ;
+
+explicit
+    [ alias boost_outcome : : : : <library>$(boost_dependencies) ]
+    [ alias all : boost_outcome test ]
+    ;
+
+call-if : boost-library outcome
+    ;