diff --git a/.boostify b/.boostify deleted file mode 100644 index d3e9e09c0..000000000 --- a/.boostify +++ /dev/null @@ -1,88 +0,0 @@ -# Files to copy over -include_files = [ - (r'include/outcome/experimental/status-code/include/(.*)', r'include/boost/outcome/experimental/\1'), - (r'include/(.*)', r'include/boost/\1'), - r'^doc/src/.*$', - r'^test/.*$', - r'^\.clang-.*$', - r'^\.gitattributes$', - r'^index.html$', -] -exclude_files = [ - r'.*quickcpplib.*', - r'^include/outcome/experimental/status-code/(?!include)', - r'^include/outcome.ixx', - r'.*\.natvis$', - r'.*\.vs.*', - r'^test/single-header-test.cpp$', - r'^test/constexprs/.*', - r'^doc/src/themes/boostdoc/.git', - r'^doc/src/themes/docdock.*', - r'^doc/src/layouts/partials/.*', -] -overlay_files = [ - (r'boostify', r''), -] - -def fix_auto_test_case(x): - # Collapse spaces until comma found, replacing any / or - with _ - ret = '' - remove_spaces = True - for l in x.group(0): - if l == ',': - remove_spaces = False - if remove_spaces: - if l == ' ': - continue; - if l == '/' or l == '-': - l = '_' - ret += l - ret += '\n' - return ret - -# Regexs to replace -core_macros = { - r'^OUTCOME_': r'BOOST_OUTCOME_', - r'([^_])OUTCOME_': r'\1BOOST_OUTCOME_', - r'^SYSTEM_ERROR2_': r'BOOST_OUTCOME_SYSTEM_ERROR2_', - r'([^_])SYSTEM_ERROR2_': r'\1BOOST_OUTCOME_SYSTEM_ERROR2_', - r']+)': r'\n#include ', - r'BOOST_OUTCOME_AUTO_TEST_CASE\((.*)' : fix_auto_test_case, - r'#include "quickcpplib/execinfo_win64.h"' : r'#error This example can only compile on POSIX', - r'#ifdef __cpp_exceptions' : r'#ifndef BOOST_NO_EXCEPTIONS', -} -source_macros.update(core_macros) -transforms = { - r'^test/tests/.*\.cpp$': { - r'"[^"]+/\.\./include/outcome/([^"]+)"': r'', - r'"[^"]+/\.\./include/outcome.hpp"': r'', - r'std::errc([^:])': r'boost::system::errc::errc_t\1', - r'std::errc::': r'boost::system::errc::', - r'std::error_code': r'boost::system::error_code', - r'std::make_error_code': r'make_error_code', - r'std::generic_category': r'boost::system::generic_category', - r'std::system_category': r'boost::system::system_category', - r'std::system_error': r'boost::system::system_error', - r'std::exception_ptr': r'boost::exception_ptr', - r'std::make_exception_ptr': r'boost::copy_exception', - r'std::current_exception': r'boost::current_exception', - r'std::rethrow_exception': r'boost::rethrow_exception', - }, - r'^test/expected-pass\.cpp$': { - r'"\.\./include/outcome/([^"]+)"': r'', - }, - r'^.*\.hpp$' : source_macros, - r'^.*\.ipp$' : source_macros, - r'^.*\.cpp$' : source_macros, - r'^.*\.h$': source_macros, - r'^.*\.md$': core_macros, -} diff --git a/.ci.cmake b/.ci.cmake deleted file mode 100644 index d26de7ec8..000000000 --- a/.ci.cmake +++ /dev/null @@ -1,37 +0,0 @@ -# CTest script for a CI to submit to CDash a run of configuration, -# building and testing -cmake_minimum_required(VERSION 3.1 FATAL_ERROR) -include(cmake/QuickCppLibBootstrap.cmake) -include(QuickCppLibUtils) - - -CONFIGURE_CTEST_SCRIPT_FOR_CDASH("outcome" "prebuilt") -list(APPEND CTEST_CONFIGURE_OPTIONS -DCMAKE_BUILD_TYPE=${CTEST_CONFIGURATION_TYPE}) -ctest_empty_binary_directory(${CTEST_BINARY_DIRECTORY}) -include(FindGit) -set(CTEST_GIT_COMMAND "${GIT_EXECUTABLE}") - -ctest_start("Experimental") -ctest_update() -ctest_configure(OPTIONS "${CTEST_CONFIGURE_OPTIONS}") -ctest_build(TARGET _hl) -if(NOT WIN32 AND NOT APPLE) - ctest_build(TARGET outcome-snippets) -endif() -ctest_test(RETURN_VALUE retval) -set(retval2 0) -set(retval3 0) -if(("$ENV{CXX}" MATCHES "clang")) - ctest_build(TARGET _hl-asan) - set(CTEST_CONFIGURATION_TYPE "asan") - ctest_test(RETURN_VALUE retval2) - ctest_build(TARGET _hl-ubsan) - set(CTEST_CONFIGURATION_TYPE "ubsan") - ctest_test(RETURN_VALUE retval3) -endif() -merge_junit_results_into_ctest_xml() -#ctest_upload(FILES ) -ctest_submit() -if(NOT retval EQUAL 0 OR NOT retval2 EQUAL 0 OR NOT retval3 EQUAL 0) - message(FATAL_ERROR "FATAL: Running tests exited with ${retval} ${retval2} ${retval3}") -endif() diff --git a/.docs.cmake b/.docs.cmake deleted file mode 100644 index 40b387e38..000000000 --- a/.docs.cmake +++ /dev/null @@ -1,35 +0,0 @@ -# CTest script for a CI to submit to CDash a documentation generation run -cmake_minimum_required(VERSION 3.1 FATAL_ERROR) -include(cmake/QuickCppLibBootstrap.cmake) -include(QuickCppLibUtils) - - -CONFIGURE_CTEST_SCRIPT_FOR_CDASH("outcome" "cmake_ci") -ctest_empty_binary_directory(${CTEST_BINARY_DIRECTORY}) -include(FindGit) -set(CTEST_GIT_COMMAND "${GIT_EXECUTABLE}") -find_program(HUGO_EXECUTABLE "hugo") -#checked_execute_process("git reset" -# COMMAND "${GIT_EXECUTABLE}" checkout gh-pages -# COMMAND "${GIT_EXECUTABLE}" reset --hard ae7119571a3c81cb9a683a21f2759df1d742e998 -# WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/doc/html" -#) - -ctest_start("Documentation") -ctest_update() -checked_execute_process("git reset" - COMMAND "${GIT_EXECUTABLE}" checkout gh-pages - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/doc/html" -) -ctest_configure() -ctest_build(TARGET outcome-snippets) -#checked_execute_process("git commit" -# COMMAND "${GIT_EXECUTABLE}" commit -a -m "upd" -# COMMAND "${GIT_EXECUTABLE}" push -f origin gh-pages -# WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/doc/html" -#) -checked_execute_process("rebuild docs" - COMMAND "${HUGO_EXECUTABLE}" - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/doc/src" -) -ctest_submit() diff --git a/boostify/.drone.star b/.drone.star similarity index 100% rename from boostify/.drone.star rename to .drone.star diff --git a/boostify/.drone/drone.sh b/.drone/drone.sh similarity index 100% rename from boostify/.drone/drone.sh rename to .drone/drone.sh diff --git a/boostify/.github/actions/boost_clone/action.yml b/.github/actions/boost_clone/action.yml similarity index 100% rename from boostify/.github/actions/boost_clone/action.yml rename to .github/actions/boost_clone/action.yml diff --git a/boostify/.github/actions/cmake_run/action.yml b/.github/actions/cmake_run/action.yml similarity index 100% rename from boostify/.github/actions/cmake_run/action.yml rename to .github/actions/cmake_run/action.yml diff --git a/.github/workflows/abi_stability.yml b/.github/workflows/abi_stability.yml deleted file mode 100644 index a3039a809..000000000 --- a/.github/workflows/abi_stability.yml +++ /dev/null @@ -1,70 +0,0 @@ -name: ABIStability - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - abi_stability: - name: "ABI stability" - runs-on: ubuntu-20.04 - - steps: - - uses: actions/checkout@v2 - - - name: Force cmake version to older than runner's - uses: jwlawson/actions-setup-cmake@v1.12 - with: - cmake-version: '3.22.2' - - - name: Install abi-compliance-checker and abigail tools - shell: bash - run: | - sudo apt-get -y install abi-dumper abi-compliance-checker abigail-tools g++-7 g++-9 - - - name: Validate ABI compatibility (abi-dumper) - if: success() || failure() - shell: bash - run: | - cd abi-compliance - chmod +x check-abi.sh - ./check-abi.sh 2.2 - - - name: Validate ABI compatibility (abigail) - if: success() || failure() - shell: bash - run: | - cd abi-compliance - chmod +x check-abigail.sh - ./check-abigail.sh 2.2 - -# - name: Validate API + ABI compatibility (abi-compliance-checker) -# if: success() || failure() -# shell: bash -# run: | -# cd abi-compliance -# ./check-api-abi.sh 2.2 - - - name: Upload ABI stability reports 1 - if: success() || failure() - uses: actions/upload-artifact@v2 - with: - name: ABI stability report (GCC 7 with C++ 14) - path: abi-compliance/compat_reports/Outcome/2.2-gcc7-cxx14_to_test-gcc7-cxx14/compat_report.html - - - - name: Upload ABI stability reports 2 - if: success() || failure() - uses: actions/upload-artifact@v2 - with: - name: ABI stability report (GCC 9 with C++ 17) - path: abi-compliance/compat_reports/Outcome/2.2-gcc9-cxx17_to_test-gcc9-cxx17/compat_report.html - -# with: -# name: API + ABI stability report (GCC 9 with C++ 17) -# path: abi-compliance/compat-reports/Outcome/2.2-gcc7-cxx14_to_X/compat_report.html diff --git a/boostify/.github/workflows/ci.yml b/.github/workflows/ci.yml similarity index 100% rename from boostify/.github/workflows/ci.yml rename to .github/workflows/ci.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index 7cdb4c5b8..000000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,63 +0,0 @@ -name: Documentation - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - documentation: - name: "Regenerate and publish Documentation" - runs-on: ubuntu-20.04 - env: - NAME: Documentation - - steps: - - name: Checkout Documentation - uses: actions/checkout@v2 - with: - fetch-depth: 0 - submodules: recursive - - - name: Force cmake version to older than runner's - uses: jwlawson/actions-setup-cmake@v1.12 - with: - cmake-version: '3.22.2' - - - name: Cache Hugo - id: cache-hugo - uses: actions/cache@v2 - with: - path: hugo_bin - key: documentation-hugo_bin - - - name: Download Hugo - if: steps.cache-hugo.outputs.cache-hit != 'true' - shell: bash - run: | - wget -O hugo.tar.gz https://github.com/gohugoio/hugo/releases/download/v0.52/hugo_0.52_Linux-64bit.tar.gz - mkdir hugo_bin - tar xf hugo.tar.gz -C hugo_bin - - - name: Regenerate Documentation - shell: bash - run: | - export PATH=$PATH:`pwd`/hugo_bin - cd doc/html - git checkout gh-pages - cd ../.. - CXX=clang++ ctest -S .docs.cmake -V - cd doc/html - echo "google-site-verification: google5fc8a1f8de4b73f0.html" > google5fc8a1f8de4b73f0.html - - - name: Publish Documentation - uses: JamesIves/github-pages-deploy-action@3.7.1 - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: doc/html - CLEAN: true diff --git a/.github/workflows/installability.yml b/.github/workflows/installability.yml deleted file mode 100644 index eaf35cd68..000000000 --- a/.github/workflows/installability.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Installability - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - installability: - name: "Installability" - strategy: - fail-fast: false - matrix: - os: [ubuntu-latest, macos-latest, windows-2019] - env: - NAME: Install-${{ matrix.os }} - runs-on: ${{ matrix.os }} - - steps: - - uses: actions/checkout@v2 - - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: 3.8 - - - name: Force cmake version to older than runner's - uses: jwlawson/actions-setup-cmake@v1.12 - with: - cmake-version: '3.22.2' - - - name: Install - shell: bash - run: | - git config --global core.longpaths true - git clone --depth 1 https://github.com/ned14/quickcpplib.git - pip install --user gitpython - python quickcpplib/scripts/test_cpp-pm_install.py conan/test_package/example.cpp quickcpplib quickcpplib::hl https://github.com/ned14/quickcpplib master "" outcome outcome::hl https://github.com/ned14/outcome develop "" - cd test_cpp-pm_install - mkdir build - cd build - cmake .. -DCMAKE_BUILD_TYPE=Release $CMAKE_CONFIGURE_OPTIONS - cmake --build . diff --git a/.github/workflows/make_release.yml b/.github/workflows/make_release.yml deleted file mode 100644 index 45ddf6488..000000000 --- a/.github/workflows/make_release.yml +++ /dev/null @@ -1,167 +0,0 @@ -name: Create release if everything passes - -on: - push: - branches: - - develop - pull_request: - workflow_dispatch: - schedule: - - cron: '0 0 1 * *' - -jobs: - publish-binaries: - name: "Publish Tarball" - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - submodules: recursive - - - name: 'Wait for status checks' - id: waitforstatuschecks - uses: "WyriHaximus/github-action-wait-for-status@v1.2" - with: - ignoreActions: "Publish Tarball" - checkInterval: 60 - env: - GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" - -# - name: Delete Tag -# uses: dev-drprasad/delete-tag-and-release@v0.1.2 -# with: -# delete_release: true -# tag_name: last_all_tests_passing -# env: -# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: Create Tarball - if: steps.waitforstatuschecks.outputs.status == 'success' - shell: bash - run: | - cd doc/html - git checkout gh-pages - git pull - cd ../.. - mkdir quickcpplib - git clone --recurse-submodules --depth 1 --jobs 8 --shallow-submodules "https://github.com/ned14/quickcpplib.git" quickcpplib/repo - cd .. - tar cJf outcome-v2-all-sources.tar.xz --exclude .git outcome - cd outcome - - - name: Create Release - id: create_release - uses: actions/create-release@v1 - if: steps.waitforstatuschecks.outputs.status == 'success' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - tag_name: all_tests_passed_${{ github.sha }} - release_name: All tests passed ${{ github.sha }} - body: | - ``` - ${{ github.event.head_commit.message }} - ``` - - Use the 'all-sources' tarball below, NOT the github generated one which is missing dependencies: - draft: false - prerelease: true - - - name: Upload - uses: actions/upload-release-asset@v1 - if: steps.waitforstatuschecks.outputs.status == 'success' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: ../outcome-v2-all-sources.tar.xz - asset_name: outcome-v2-all-sources-${{ github.sha }}.tar.xz - asset_content_type: application/gzip - - - name: Extract boostorg/outcome ssh keys - id: vars - env: - BOOSTORG_OUTCOME_DEPLOY_KEY: ${{ secrets.BOOSTORG_OUTCOME_DEPLOY_KEY }} - shell: bash - run: | - if [ -n "$BOOSTORG_OUTCOME_DEPLOY_KEY" ] && [ "${{ steps.waitforstatuschecks.outputs.status }}" = "success" ]; then - mkdir -p $HOME/.ssh; - printf "%s" "$BOOSTORG_OUTCOME_DEPLOY_KEY" > "$HOME/.ssh/id_ed25519"; - chmod -R og-rwx $HOME/.ssh; - unset HAS_DEPLOY_KEY; - HAS_DEPLOY_KEY='true'; - fi - echo ::set-output name=HAS_DEPLOY_KEY::${HAS_DEPLOY_KEY} - - - name: Get Hugo - if: steps.vars.outputs.HAS_DEPLOY_KEY - uses: actions/cache@v2 - with: - path: hugo_bin - key: hugo_bin - - - name: Convert to boostorg/outcome - if: steps.vars.outputs.HAS_DEPLOY_KEY - shell: bash - run: | - if [ ! -f "hugo_bin/hugo" ]; then - wget -O hugo.tar.gz https://github.com/gohugoio/hugo/releases/download/v0.52/hugo_0.52_Linux-64bit.tar.gz; - mkdir hugo_bin; - tar xf hugo.tar.gz -C hugo_bin; - fi - ls -l hugo_bin - ls -l $HOME/.ssh - git config --global push.default simple - git config --global user.name "Jenkins nedprod CI" - git config --global user.email "foo@nowhere" - export PATH=$PATH:`pwd`/hugo_bin - pip install --user gitpython - git remote add outcome https://github.com/ned14/outcome - git fetch outcome - git submodule update --init - cd .. - git clone https://github.com/boostorg/outcome boost-outcome - cd boost-outcome - git checkout -b develop origin/develop - git checkout master - git remote add outcome https://github.com/ned14/outcome - git fetch outcome - git checkout -b orig-develop outcome/develop - git checkout -b orig-master outcome/master - git checkout master - cd .. - git clone --depth 1 https://github.com/ned14/quickcpplib.git - python quickcpplib/scripts/boostify_git_repo.py boost-outcome outcome ned14/outcome@ - cd boost-outcome - git checkout master - cd doc/src - rm -rf ../html - HUGO_BOOSTDOCDISABLECOMMONHEADING=1 hugo - cd ../html - git add . || true - cd ../.. - git commit -a -m "CI regenerates Boost.Outcome docs" || true - git checkout develop - cd doc/src - rm -rf ../html - HUGO_BOOSTDOCDISABLECOMMONHEADING=1 hugo - cd ../html - git add . || true - cd ../.. - git commit -a -m "CI regenerates Boost.Outcome docs" || true - if [ "${GITHUB_REF##*/}" = "master" ]; then - git push git@github.com:boostorg/outcome.git master || true - fi - git push git@github.com:boostorg/outcome.git develop || true - cd doc - rm -rf html - git clone -b gh-pages --single-branch https://github.com/boostorg/outcome html - cd src - hugo - cd ../html - git add . || true - git commit -a -m "CI regenerates Boost.Outcome docs" || true - git push -f git@github.com:boostorg/outcome.git gh-pages - cd ../.. diff --git a/.github/workflows/unittests_freebsd.yml.disabled b/.github/workflows/unittests_freebsd.yml.disabled deleted file mode 100644 index e62b146a3..000000000 --- a/.github/workflows/unittests_freebsd.yml.disabled +++ /dev/null @@ -1,55 +0,0 @@ -name: Unit tests FreeBSD - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - FreeBSD: - name: FreeBSD 13 - runs-on: macos-latest - env: - NAME: FreeBSD - - steps: - - uses: actions/checkout@v3 - - - name: CMake tests FreeBSD - uses: cross-platform-actions/action@v0.15.0 - with: - operating_system: freebsd - version: '13.2' - run: | - sudo pkg install -y cmake git - ctest -S .ci.cmake -VV -E 'noexcept' --timeout 900 - - - name: Upload Test Results - if: always() - uses: actions/upload-artifact@v2 - with: - name: FreeBSD test results - path: prebuilt/merged_junit_results.xml - - publish-test-results: - name: "Publish Unit Tests Results" - needs: [FreeBSD] - runs-on: ubuntu-latest - if: success() || failure() - - steps: - - name: Download Artifacts - uses: actions/download-artifact@v2 - with: - path: artifacts - - - name: Publish Unit Test Results - uses: EnricoMi/publish-unit-test-result-action@v2 - with: - check_name: Unit Test Results - github_token: ${{ secrets.GITHUB_TOKEN }} - files: '**/merged_junit_results.xml' diff --git a/.github/workflows/unittests_linux.yml b/.github/workflows/unittests_linux.yml deleted file mode 100644 index a8b333acf..000000000 --- a/.github/workflows/unittests_linux.yml +++ /dev/null @@ -1,71 +0,0 @@ -name: Unit tests Linux - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - Linux: - name: Ubuntu 20.04 - runs-on: ubuntu-20.04 - strategy: - fail-fast: false - matrix: - compiler: [clang++, g++, libc++] - env: - NAME: Linux-${{ matrix.compiler }} - CXX: ${{ matrix.compiler }} - - steps: - - uses: actions/checkout@v2 - - - name: Force cmake version to older than runner's - uses: jwlawson/actions-setup-cmake@v1.12 - with: - cmake-version: '3.22.2' - - - name: CMake tests Linux - shell: bash - run: | - sudo apt-get remove -y libstdc++-10-dev g++-10 gcc-10 libstdc++-11-dev g++-11 gcc-11 || true - sudo apt-get autoremove - if [ "${{ matrix.compiler }}" = "libc++" ]; then - wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -; - sudo add-apt-repository "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-11 main"; - sudo apt update; - sudo apt install clang-11 libc++-11-dev libc++abi-11-dev libomp-11-dev; - export CMAKE_CONFIGURE_OPTIONS="-DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain-linux-libc++.cmake"; - ctest -S .ci.cmake -VV -E noexcept --timeout 900 "-DCTEST_CONFIGURE_OPTIONS=$CMAKE_CONFIGURE_OPTIONS"; - else - ctest -S .ci.cmake -VV --timeout 900 "-DCTEST_CONFIGURE_OPTIONS=$CMAKE_CONFIGURE_OPTIONS"; - fi - - - name: Upload Test Results - uses: actions/upload-artifact@v2 - with: - name: Linux ${{ matrix.compiler }} test results - path: prebuilt/merged_junit_results.xml - - publish-test-results: - name: "Publish Unit Tests Results" - needs: [Linux] - runs-on: ubuntu-latest - if: success() || failure() - - steps: - - name: Download Artifacts - uses: actions/download-artifact@v2 - with: - path: artifacts - - - name: Publish Unit Test Results - uses: EnricoMi/publish-unit-test-result-action@v2 - with: - check_name: Unit Test Results - github_token: ${{ secrets.GITHUB_TOKEN }} - files: '**/merged_junit_results.xml' diff --git a/.github/workflows/unittests_macos.yml b/.github/workflows/unittests_macos.yml deleted file mode 100644 index 1c2455446..000000000 --- a/.github/workflows/unittests_macos.yml +++ /dev/null @@ -1,51 +0,0 @@ -name: Unit tests Mac OS - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - MacOS: - name: Mac OS - runs-on: macos-latest - env: - NAME: MacOS - - steps: - - uses: actions/checkout@v2 - - - name: CMake tests Mac OS - shell: bash - run: | - ctest -S .ci.cmake -VV -E 'noexcept|comparison' --timeout 900 "-DCTEST_CONFIGURE_OPTIONS=$CMAKE_CONFIGURE_OPTIONS" - - - name: Upload Test Results - if: always() - uses: actions/upload-artifact@v2 - with: - name: Mac OS test results - path: prebuilt/merged_junit_results.xml - - publish-test-results: - name: "Publish Unit Tests Results" - needs: [MacOS] - runs-on: ubuntu-latest - if: success() || failure() - - steps: - - name: Download Artifacts - uses: actions/download-artifact@v2 - with: - path: artifacts - - - name: Publish Unit Test Results - uses: EnricoMi/publish-unit-test-result-action@v2 - with: - check_name: Unit Test Results - github_token: ${{ secrets.GITHUB_TOKEN }} - files: '**/merged_junit_results.xml' diff --git a/.github/workflows/unittests_windows.yml b/.github/workflows/unittests_windows.yml deleted file mode 100644 index 83bb8c971..000000000 --- a/.github/workflows/unittests_windows.yml +++ /dev/null @@ -1,51 +0,0 @@ -name: Unit tests Windows - -on: - push: - branches: - - develop - - master - pull_request: - schedule: - - cron: '0 0 1 * *' - -jobs: - WinVS2019: - name: Windows VS2019 - runs-on: windows-2019 - env: - NAME: WinVS2019 - - steps: - - uses: actions/checkout@v2 - - - name: CMake tests Windows - shell: bash - run: | - ctest -S .ci.cmake -VV --timeout 900 "-DCTEST_CONFIGURE_OPTIONS=$CMAKE_CONFIGURE_OPTIONS" -DCTEST_SITE=$NAME - - - name: Upload Test Results - if: always() - uses: actions/upload-artifact@v2 - with: - name: Windows VS2019 test results - path: prebuilt/merged_junit_results.xml - - publish-test-results: - name: "Publish Unit Tests Results" - needs: [WinVS2019] - runs-on: ubuntu-latest - if: success() || failure() - - steps: - - name: Download Artifacts - uses: actions/download-artifact@v2 - with: - path: artifacts - - - name: Publish Unit Test Results - uses: EnricoMi/publish-unit-test-result-action@v2 - with: - check_name: Unit Test Results - github_token: ${{ secrets.GITHUB_TOKEN }} - files: '**/merged_junit_results.xml' diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 1a7b98ad0..000000000 --- a/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -*.cache -doc/outcome.hpp -doc/src/public diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 78662c09b..000000000 --- a/.gitmodules +++ /dev/null @@ -1,20 +0,0 @@ -[submodule "doc/html"] - path = doc/html - url = https://github.com/ned14/outcome.git - branch = gh-pages - fetchRecurseSubmodules = true - ignore = none -# shallow = true ## master repo is always somewhat behind -[submodule "doc/src/themes/docdock"] - path = doc/src/themes/docdock - url = https://github.com/ned14/hugo-theme-docdock.git -[submodule "doc/src/themes/boostdoc"] - path = doc/src/themes/boostdoc - url = https://github.com/ned14/boostdoc.git - branch = master -[submodule "include/outcome/status-code"] - path = include/outcome/experimental/status-code - url = https://github.com/ned14/status-code.git - branch = master - fetchRecurseSubmodules = true - ignore = untracked diff --git a/.quickcpplib b/.quickcpplib deleted file mode 100644 index e69de29bb..000000000 diff --git a/boostify/.travis.yml b/.travis.yml similarity index 100% rename from boostify/.travis.yml rename to .travis.yml diff --git a/CMakeLists.txt b/CMakeLists.txt index 732f70f86..837426609 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,401 +1,63 @@ -# Outcome cmake -# (C) 2016-2023 Niall Douglas -# File Created: June 2016 -# -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License in the accompanying file -# Licence.txt or at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# +# Generated by `boostdep --cmake outcome` +# Copyright 2020 Peter Dimov # Distributed under the Boost Software License, Version 1.0. -# (See accompanying file Licence.txt or copy at -# http://www.boost.org/LICENSE_1_0.txt) +# https://www.boost.org/LICENSE_1_0.txt -cmake_minimum_required(VERSION 3.9 FATAL_ERROR) +cmake_minimum_required(VERSION 3.5...3.16) -set(OUTCOME_DEPENDENCY_QUICKCPPLIB_GIT_TAG "master" CACHE STRING "Which git tag to use for the QuickCppLib dependency") -if(NOT OUTCOME_DEPENDENCY_QUICKCPPLIB_GIT_TAG STREQUAL "master") - # Don't reuse the bootstrapped git clone as the dependency itself - if(CMAKE_BINARY_DIR) - set(CTEST_QUICKCPPLIB_CLONE_DIR "${CMAKE_BINARY_DIR}/quickcpplib-bootstrap") - else() - set(CTEST_QUICKCPPLIB_CLONE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/quickcpplib-bootstrap") - endif() -endif() -set(OUTCOME_DEPENDENCY_STATUS_CODE_GIT_TAG "master" CACHE STRING "Which git tag to use for the status-code dependency") -option(OUTCOME_BUNDLE_EMBEDDED_STATUS_CODE "Whether to bundle an embedded copy of SG14 status-code with Outcome. Used by various package managers such as vcpkg." ON) - -include(cmake/QuickCppLibBootstrap.cmake) -include(QuickCppLibRequireOutOfSourceBuild) -include(QuickCppLibUtils) -include(QuickCppLibPolicies) - -# Parse the version we tell cmake directly from the version header file -ParseProjectVersionFromHpp("${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/detail/version.hpp" VERSIONSTRING) -# Sets the usual PROJECT_NAME etc -project(outcome VERSION ${VERSIONSTRING} LANGUAGES C CXX) -# Also set a *cmake* namespace for this project -set(PROJECT_NAMESPACE) - -# Setup this cmake environment for this project -include(QuickCppLibSetupProject) - -option(OUTCOME_BUNDLE_EMBEDDED_QUICKCPPLIB "Whether to bundle an embedded copy of QuickCppLib with Outcome. Used by various package managers such as vcpkg." OFF) -option(OUTCOME_ENABLE_DEPENDENCY_SMOKE_TEST "Whether to build executables which are smoke tests that Outcome is fully working. Used by various package managers such as vcpkg." OFF) -option(OUTCOME_ENABLE_CXX_MODULES "Whether to enable the building of an Outcome C++ module" OFF) -set(UNIT_TESTS_CXX_VERSION "latest" CACHE STRING "The version of C++ to use in the unit tests") - -if(NOT outcome_IS_DEPENDENCY) - # This file should be updated with the last git SHA next commit - UpdateRevisionHppFromGit("${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/detail/revision.hpp") - # Need to also possibly update the .natvis file -# file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/detail/revision.hpp" namespace_permuter REGEX "OUTCOME_PREVIOUS_COMMIT_UNIQUE (.+)") -# if(NOT namespace_permuter MATCHES "OUTCOME_PREVIOUS_COMMIT_UNIQUE (.+)") -# indented_message(FATAL_ERROR "FATAL: ${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/detail/revision.hpp was not parseable") -# endif() -# set(namespace_permuter "${CMAKE_MATCH_1}") -# file(READ "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/outcome.natvis" natvis_contents) -# string(REGEX REPLACE "outcome_v2_([0-9a-f]+)" "outcome_v2_${namespace_permuter}" new_natvis_contents "${natvis_contents}") -# if(NOT natvis_contents STREQUAL new_natvis_contents) -# file(WRITE "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/outcome.natvis" "${new_natvis_contents}") -# endif() -endif() -# Find my library dependencies -if(OUTCOME_BUNDLE_EMBEDDED_QUICKCPPLIB AND CTEST_QUICKCPPLIB_CLONE_DIR) - file(COPY "${CTEST_QUICKCPPLIB_CLONE_DIR}/repo/" DESTINATION "${CMAKE_BINARY_DIR}/quickcpplib") - find_quickcpplib_library(quickcpplib - GIT_REPOSITORY "https://github.com/ned14/quickcpplib.git" - REQUIRED - IS_HEADER_ONLY - INBUILD - INCLUDE_ALL - ) -else() - find_quickcpplib_library(quickcpplib - GIT_REPOSITORY "https://github.com/ned14/quickcpplib.git" - GIT_TAG "${OUTCOME_DEPENDENCY_QUICKCPPLIB_GIT_TAG}" - REQUIRED - IS_HEADER_ONLY - ) -endif() -if(OUTCOME_BUNDLE_EMBEDDED_STATUS_CODE) - ensure_git_subrepo("${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/experimental/status-code/include" "https://github.com/ned14/status-code.git") -else() - find_quickcpplib_library(status-code - GIT_REPOSITORY "https://github.com/ned14/status-code.git" - GIT_TAG "${OUTCOME_DEPENDENCY_STATUS_CODE_GIT_TAG}" - REQUIRED - IS_HEADER_ONLY - ) - list_filter(${PROJECT_NAME}_HEADERS EXCLUDE REGEX include/outcome/experimental/status-code/) -endif() +project(boost_outcome VERSION "${BOOST_SUPERPROJECT_VERSION}" LANGUAGES CXX) -# Make an interface only library so dependent CMakeLists can bring in this header-only library -include(QuickCppLibMakeHeaderOnlyLibrary) - -# If we have standard concepts, enable those for both myself and all inclusions -apply_cxx_concepts_to(INTERFACE outcome_hl REQUIRE_STD_CONCEPTS) - -# Make preprocessed edition of this library target -if(NOT outcome_IS_DEPENDENCY OR OUTCOME_FORCE_ENABLE_PP_TARGETS) - if(NOT PYTHONINTERP_FOUND) - indented_message(WARNING "NOT rebuilding preprocessed edition of library due to python not being installed") - else() - function(make_single_header target name) - add_partial_preprocess(${target} - "${name}" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/detail/revision.hpp" - ${ARGN} - -I ../quickcpplib/include - --passthru-defines --passthru-unfound-includes --passthru-unknown-exprs - --passthru-comments --line-directive --compress # --debug - -U __cpp_modules - -U QUICKCPPLIB_ENABLE_VALGRIND - -U DOXYGEN_SHOULD_SKIP_THIS -U DOXYGEN_IS_IN_THE_HOUSE - -U STANDARDESE_IS_IN_THE_HOUSE - -U OUTCOME_UNSTABLE_VERSION -U OUTCOME_ENABLE_ABI_PERMUTATION - -D QUICKCPPLIB_DISABLE_ABI_PERMUTATION=1 - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" - ) - if(NOT CMAKE_VERSION VERSION_LESS 3.3) - add_dependencies(outcome_hl ${target}) - endif() - endfunction() - make_single_header(outcome_hl-pp-std - "${CMAKE_CURRENT_SOURCE_DIR}/single-header/outcome.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome.hpp") - make_single_header(outcome_hl-pp-basic - "${CMAKE_CURRENT_SOURCE_DIR}/single-header/outcome-basic.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/basic_outcome.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/try.hpp") - make_single_header(outcome_hl-pp-experimental - "${CMAKE_CURRENT_SOURCE_DIR}/single-header/outcome-experimental.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/experimental/status_outcome.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/experimental/status-code/include/status-code/nested_status_code.hpp" - "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome/try.hpp") +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() -endif() - -# Set the standard definitions for these libraries and bring in the all_* helper functions -include(QuickCppLibApplyDefaultDefinitions) -# Set the C++ features this library requires -all_compile_features(PUBLIC - cxx_alias_templates - cxx_variadic_templates - cxx_noexcept - cxx_constexpr - cxx_lambda_init_captures - cxx_attributes - cxx_generic_lambdas -) -if(NOT MSVC OR CMAKE_VERSION VERSION_GREATER 3.59) - all_compile_features(PUBLIC - cxx_variable_templates - ) -endif() -# Set the library dependencies this library has -if(TARGET quickcpplib::hl) - target_link_libraries(outcome_hl INTERFACE quickcpplib::hl) -endif() -if(TARGET status-code::hl) - target_link_libraries(outcome_hl INTERFACE status-code::hl) - all_compile_definitions(PUBLIC OUTCOME_USE_SYSTEM_STATUS_CODE=1) -endif() - -if(OUTCOME_ENABLE_CXX_MODULES) - # Right now this is very hacky, as cmake doesn't support building C++ Modules yet - add_custom_target(outcome_module - COMMAND "${CMAKE_CXX_COMPILER}" /std:c++latest /EHsc $<$:/MDd> $<$>:/MD> /fp:precise /c "${CMAKE_CURRENT_SOURCE_DIR}/include/outcome.ixx" "-I${CMAKE_CURRENT_SOURCE_DIR}/../quickcpplib/include" "-I${CMAKE_BINARY_DIR}/quickcpplib/include" - ) - all_compile_definitions(PUBLIC - OUTCOME_ENABLE_CXX_MODULES=1 - ) -endif() - -if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test" AND NOT outcome_IS_DEPENDENCY AND (NOT DEFINED BUILD_TESTING OR BUILD_TESTING)) - # For all possible configurations of this library, add each test - list_filter(outcome_TESTS EXCLUDE REGEX "constexprs") - set(outcome_TESTS_DISABLE_PRECOMPILE_HEADERS - "outcome_hl--coroutine-support" - "outcome_hl--core-result" - "outcome_hl--fileopen" - "outcome_hl--hooks" - "outcome_hl--outcome-int-int-1" - "outcome_hl--result-int-int-1" - "outcome_hl--result-int-int-2" - ) - include(QuickCppLibMakeStandardTests) - - # Enable Coroutines for the coroutines support test - foreach(target ${outcome_TEST_TARGETS}) - if(${target} MATCHES "coroutine-support") - apply_cxx_coroutines_to(PRIVATE ${target}) - endif() - # MSVC's concepts implementation blow up unless permissive is off - if(MSVC AND NOT CLANG) - target_compile_options(${target} PRIVATE /permissive-) - endif() - endforeach() - - # Duplicate all tests into C++ exceptions disabled forms - set(noexcept_tests) - set(first_test_target_noexcept) - set(first_test_target_permissive) - foreach(testsource ${outcome_TESTS}) - if(testsource MATCHES ".+/(.+)[.](c|cpp|cxx)$") - set(testname ${CMAKE_MATCH_1}) - if(NOT testname MATCHES "expected-pass") - set(target_name "outcome_hl--${testname}-noexcept") - add_executable(${target_name} "${testsource}") - if(NOT first_test_target_noexcept) - set(first_test_target_noexcept ${target_name}) - elseif(${target_name} MATCHES "coroutine-support|fileopen|hooks|core-result") - set_target_properties(${target_name} PROPERTIES DISABLE_PRECOMPILE_HEADERS On) - elseif(COMMAND target_precompile_headers) - target_precompile_headers(${target_name} REUSE_FROM ${first_test_target_noexcept}) - endif() - add_dependencies(_hl ${target_name}) - list(APPEND noexcept_tests ${target_name}) - if(MSVC AND NOT CLANG) - # Disable warnings "C++ exception handler used" and "noexcept used with no exception handling" - target_compile_options(${target_name} PRIVATE /wd4530 /wd4577) -# target_compile_options(${target_name} PRIVATE /permissive-) # test bug report #142 - endif() - target_compile_definitions(${target_name} PRIVATE SYSTEM_ERROR2_NOT_POSIX=1 "SYSTEM_ERROR2_FATAL=::abort()") - target_link_libraries(${target_name} PRIVATE outcome::hl) - if(${target_name} MATCHES "coroutine-support") - apply_cxx_coroutines_to(PRIVATE ${target_name}) - endif() - set_target_properties(${target_name} PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin" - POSITION_INDEPENDENT_CODE ON - CXX_EXCEPTIONS OFF - CXX_RTTI OFF - ) - add_test(NAME ${target_name} CONFIGURATIONS Debug Release RelWithDebInfo MinSizeRel - COMMAND $ --reporter junit --out $.junit.xml - ) - if(MSVC AND NOT CLANG) - set(target_name "outcome_hl--${testname}-permissive") - add_executable(${target_name} "${testsource}") - if(NOT first_test_target_permissive) - set(first_test_target_permissive ${target_name}) - elseif(${target_name} MATCHES "coroutine-support|fileopen|core-result") - set_target_properties(${target_name} PROPERTIES DISABLE_PRECOMPILE_HEADERS On) - elseif(COMMAND target_precompile_headers) - target_precompile_headers(${target_name} REUSE_FROM ${first_test_target_permissive}) - endif() - add_dependencies(_hl ${target_name}) - target_link_libraries(${target_name} PRIVATE outcome::hl) - target_compile_options(${target_name} PRIVATE /permissive) - if(${target_name} MATCHES "coroutine-support") - apply_cxx_coroutines_to(PRIVATE ${target_name}) - endif() - set_target_properties(${target_name} PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin" - POSITION_INDEPENDENT_CODE ON - ) - if(OUTCOME_ENABLE_CXX_MODULES) - set(target_name "outcome_hl--${testname}-modules") - add_executable(${target_name} "${testsource}") - add_dependencies(${target_name} outcome_module) - target_link_libraries(${target_name} PRIVATE outcome::hl) - target_compile_options(${target_name} PRIVATE /experimental:module /std:c++latest) - target_compile_definitions(${target_name} PRIVATE __cpp_modules=202001L) - set_target_properties(${target_name} PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin" - POSITION_INDEPENDENT_CODE ON - DISABLE_PRECOMPILE_HEADERS On - ) - endif() - endif() - 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() - add_custom_target(${PROJECT_NAME}-noexcept COMMENT "Building all tests with C++ exceptions disabled ...") - add_dependencies(${PROJECT_NAME}-noexcept ${noexcept_tests}) - - # Turn on latest C++ where possible for the test suite - if(UNIT_TESTS_CXX_VERSION STREQUAL "latest") - set(LATEST_CXX_FEATURE) - foreach(feature ${CMAKE_CXX_COMPILE_FEATURES}) - if(feature STREQUAL "cxx_std_23") - set(LATEST_CXX_FEATURE "cxx_std_23") - indented_message(STATUS "NOTE: This compiler claims to support C++ 23, enabling for unit test suite") - endif() - endforeach() - if(NOT LATEST_CXX_FEATURE) - foreach(feature ${CMAKE_CXX_COMPILE_FEATURES}) - if(feature STREQUAL "cxx_std_20") - set(LATEST_CXX_FEATURE "cxx_std_20") - indented_message(STATUS "NOTE: This compiler claims to support C++ 20, enabling for unit test suite") - endif() - endforeach() - endif() - if(NOT LATEST_CXX_FEATURE) - foreach(feature ${CMAKE_CXX_COMPILE_FEATURES}) - if(feature STREQUAL "cxx_std_17") - set(LATEST_CXX_FEATURE "cxx_std_17") - indented_message(STATUS "NOTE: This compiler claims to support C++ 17, enabling for unit test suite") - endif() - endforeach() - endif() - elseif(UNIT_TESTS_CXX_VERSION) - set(LATEST_CXX_FEATURE "cxx_std_${UNIT_TESTS_CXX_VERSION}") - endif() - if(LATEST_CXX_FEATURE) - # Turn on latest C++ where possible for the test suite - if(ENABLE_CXX_MODULES) - target_compile_features(outcome_hl_ixx PUBLIC ${LATEST_CXX_FEATURE}) - endif() - foreach(test_target ${outcome_TEST_TARGETS} ${outcome_EXAMPLE_TARGETS}) - target_compile_features(${test_target} PUBLIC ${LATEST_CXX_FEATURE}) - 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() - - # Add in the documentation snippets - foreach(feature ${CMAKE_CXX_COMPILE_FEATURES}) - if(feature STREQUAL cxx_std_17) - file(GLOB example_srcs RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" - "${CMAKE_CURRENT_SOURCE_DIR}/doc/src/snippets/*.c" - "${CMAKE_CURRENT_SOURCE_DIR}/doc/src/snippets/*.cpp" - ) - set(example_bins) - foreach(example_src ${example_srcs}) - if(example_src MATCHES ".+/(.+)[.](c|cpp|cxx)$") - set(example_bin "${PROJECT_NAME}-snippets_${CMAKE_MATCH_1}") - add_executable(${example_bin} EXCLUDE_FROM_ALL "${example_src}") - list(APPEND example_bins ${example_bin}) - target_link_libraries(${example_bin} PRIVATE outcome::hl) - set_target_properties(${example_bin} PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin" - POSITION_INDEPENDENT_CODE ON - ) - if(example_src MATCHES "[.]c$") - set_target_properties(${example_bin} PROPERTIES DISABLE_PRECOMPILE_HEADERS On) - else() - target_compile_features(${example_bin} PUBLIC cxx_std_17) - if(CMAKE_SYSTEM_NAME MATCHES "Linux") - target_link_libraries(${example_bin} PRIVATE stdc++fs) - elseif(CMAKE_SYSTEM_NAME MATCHES "FreeBSD" OR APPLE) - target_link_libraries(${example_bin} PRIVATE c++experimental) - endif() - endif() - endif() - endforeach() - add_custom_target(${PROJECT_NAME}-snippets COMMENT "Building all documentation snippets ...") - add_dependencies(${PROJECT_NAME}-snippets ${example_bins}) - endif() - endforeach() endif() -# Turn on pedantic warnings for all tests, examples and snippets -if(NOT MSVC) - foreach(target ${outcome_TEST_TARGETS} ${outcome_EXAMPLE_TARGETS} ${example_bins}) - target_compile_options(${target} PUBLIC "-Wpedantic") - endforeach() -endif() +add_library(boost_outcome INTERFACE) +add_library(Boost::outcome ALIAS boost_outcome) -if(OUTCOME_ENABLE_DEPENDENCY_SMOKE_TEST) - set(OUTCOME_SMOKE_TESTS) - add_executable(outcome-dependency-smoke-test_1 "test/tests/core-result.cpp") - list(APPEND OUTCOME_SMOKE_TESTS outcome-dependency-smoke-test_1) - add_executable(outcome-dependency-smoke-test_2 "test/tests/experimental-core-result-status.cpp") - list(APPEND OUTCOME_SMOKE_TESTS outcome-dependency-smoke-test_2) - foreach(target ${OUTCOME_SMOKE_TESTS}) - target_link_libraries(${target} PRIVATE outcome::hl) - set_target_properties(${target} PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin" - DISABLE_PRECOMPILE_HEADERS On - ) - add_test(NAME ${target} CONFIGURATIONS Debug Release RelWithDebInfo MinSizeRel - COMMAND $ --reporter junit --out $.junit.xml - ) - endforeach() -endif() +target_include_directories(boost_outcome INTERFACE include) + +target_link_libraries(boost_outcome + INTERFACE + Boost::config + Boost::exception + Boost::system + Boost::throw_exception +) -# Cache this library's auto scanned sources for later reuse -include(QuickCppLibCacheLibrarySources) +target_compile_features(boost_outcome + INTERFACE + cxx_std_14 +) -# Dependencies needed to consume our cmake package -set(PROJECT_PACKAGE_DEPENDENCIES "include(CMakeFindDependencyMacro)") -if(TARGET quickcpplib::hl) - string(APPEND PROJECT_PACKAGE_DEPENDENCIES "\nfind_dependency(quickcpplib)") -endif() -if(TARGET status-code::hl) - string(APPEND PROJECT_PACKAGE_DEPENDENCIES "\nfind_dependency(status-code)") -endif() +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 () -# Make available this library for install and export -include(QuickCppLibMakeInstall) -include(QuickCppLibMakeExport) +if(BUILD_TESTING AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test/CMakeLists.txt") + enable_testing() + add_subdirectory(test) +endif() diff --git a/CTestConfig.cmake b/CTestConfig.cmake deleted file mode 100644 index b6ecc2384..000000000 --- a/CTestConfig.cmake +++ /dev/null @@ -1,15 +0,0 @@ -## This file should be placed in the root directory of your project. -## Then modify the CMakeLists.txt file in the root directory of your -## project to incorporate the testing dashboard. -## -## # The following are required to submit to the CDash dashboard: -## ENABLE_TESTING() -## INCLUDE(CTest) - -set(CTEST_PROJECT_NAME "Boost.Outcome") -set(CTEST_NIGHTLY_START_TIME "00:00:00 EST") - -set(CTEST_DROP_METHOD "https") -set(CTEST_DROP_SITE "my.cdash.org") -set(CTEST_DROP_LOCATION "/submit.php?project=Boost.Outcome") -set(CTEST_DROP_SITE_CDASH TRUE) diff --git a/Doxyfile b/Doxyfile deleted file mode 100644 index 74a1ee1c4..000000000 --- a/Doxyfile +++ /dev/null @@ -1,2413 +0,0 @@ -# Doxyfile 1.8.10 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = Outcome - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = "2.0 beta" - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = doc - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -#ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = YES - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 2 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = "errors=@par Errors returnable\n" "mallocs=@par Memory Allocations\n" \ - "raceguarantees{1}=@par Race Guarantees\n\1" \ - "complexity{1}=@par Complexity\n\1" \ - "exceptionmodel{1}=@par Errors returnable\n\1" \ - "requires=@par Requires:\n" \ - "effects=@par Effects:\n" - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = NO - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -#GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -#HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = YES - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = NO - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = YES - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = doxygen_warnings.log - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = include/outcome - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, -# *.vhdl, *.ucf, *.qsf, *.as and *.js. - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = include/outcome/experimental - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = quickcpplib* - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = test example - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = benchmark - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = YES - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = NO - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = NO - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = -std=c++14 -I.. - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = src/static/doxygen - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.boostoutcome - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.nedproductions - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = ned Productions - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.boostoutcome - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.boostoutcome - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /