From e00b72ebcd9d2add12cfe0e6fe4d114a7858dfa5 Mon Sep 17 00:00:00 2001
From: Stephane Del Pino <stephane.delpino44@gmail.com>
Date: Sat, 30 Oct 2021 20:31:41 +0200
Subject: [PATCH] git subrepo clone --branch=main
git@github.com:CLIUtils/CLI11.git packages/CLI11
subrepo:
subdir: "packages/CLI11"
merged: "70f8072f9"
upstream:
origin: "git@github.com:CLIUtils/CLI11.git"
branch: "main"
commit: "70f8072f9"
git-subrepo:
version: "0.4.3"
origin: "git@github.com:ingydotnet/git-subrepo.git"
commit: "2f68596"
---
packages/CLI11/.appveyor.yml | 4 +-
packages/CLI11/.github/CONTRIBUTING.md | 3 +-
packages/CLI11/.github/workflows/build.yml | 4 +-
packages/CLI11/.github/workflows/tests.yml | 42 ++++--
packages/CLI11/.gitrepo | 8 +-
packages/CLI11/.pre-commit-config.yaml | 15 +--
packages/CLI11/.travis.yml | 122 ------------------
packages/CLI11/CHANGELOG.md | 22 +++-
packages/CLI11/CMakeLists.txt | 46 +++++--
packages/CLI11/README.md | 111 +++++++++-------
packages/CLI11/azure-pipelines.yml | 4 +-
packages/CLI11/book/README.md | 4 +-
.../book/chapters/an-advanced-example.md | 2 +-
packages/CLI11/book/chapters/config.md | 2 +-
packages/CLI11/book/chapters/flags.md | 2 +-
packages/CLI11/docs/Doxyfile | 2 +-
packages/CLI11/include/CLI/App.hpp | 16 +--
packages/CLI11/include/CLI/Option.hpp | 2 +-
packages/CLI11/include/CLI/TypeTools.hpp | 2 +-
packages/CLI11/include/CLI/Validators.hpp | 12 +-
packages/CLI11/include/CLI/Version.hpp | 4 +-
packages/CLI11/tests/CMakeLists.txt | 44 ++++---
packages/CLI11/tests/OptionalTest.cpp | 24 ++--
packages/CLI11/tests/catch.hpp | 9 ++
24 files changed, 235 insertions(+), 271 deletions(-)
delete mode 100644 packages/CLI11/.travis.yml
create mode 100644 packages/CLI11/tests/catch.hpp
diff --git a/packages/CLI11/.appveyor.yml b/packages/CLI11/.appveyor.yml
index 18915a174..59bb8326b 100644
--- a/packages/CLI11/.appveyor.yml
+++ b/packages/CLI11/.appveyor.yml
@@ -1,8 +1,8 @@
-version: 2.1.1.{build}
+version: 2.1.2.{build}
branches:
only:
- - master
+ - main
- v1
install:
diff --git a/packages/CLI11/.github/CONTRIBUTING.md b/packages/CLI11/.github/CONTRIBUTING.md
index 330d8b15b..2f44c9da7 100644
--- a/packages/CLI11/.github/CONTRIBUTING.md
+++ b/packages/CLI11/.github/CONTRIBUTING.md
@@ -76,9 +76,8 @@ Steps:
* Update changelog if needed
* Update the version in `.appveyor.yml` and `include/CLI/Version.hpp`.
-* Find and replace in README:
+* Find and replace in README (new minor/major release only):
* Replace " 🆕" and "🆕 " with "" (ignores the description line)
* Check for `\/\/$` (vi syntax) to catch leftover `// 🆕`
* Replace "🚧" with "🆕" (manually ignore the description line)
* Make a release in the GitHub UI, use a name such as "Version X.Y(.Z): Title"
-* Currently, the release action wipes the title after you release, so remember to edit the title back to the original name after the `CLI11.hpp` file gets uploaded.
diff --git a/packages/CLI11/.github/workflows/build.yml b/packages/CLI11/.github/workflows/build.yml
index 11ed11ca4..a6f250409 100644
--- a/packages/CLI11/.github/workflows/build.yml
+++ b/packages/CLI11/.github/workflows/build.yml
@@ -2,13 +2,11 @@ name: Build
on:
push:
branches:
- - master
+ - main
- v*
tags:
- "*"
pull_request:
- branches:
- - master
jobs:
single-header:
diff --git a/packages/CLI11/.github/workflows/tests.yml b/packages/CLI11/.github/workflows/tests.yml
index 020ba3b2b..a48b4e367 100644
--- a/packages/CLI11/.github/workflows/tests.yml
+++ b/packages/CLI11/.github/workflows/tests.yml
@@ -2,21 +2,11 @@ name: Tests
on:
push:
branches:
- - master
+ - main
- v*
pull_request:
- branches:
- - master
jobs:
- pre-commit:
- name: Formatting
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-python@v2
- - uses: pre-commit/action@v2.0.3
-
cuda-build:
name: CUDA build only
runs-on: ubuntu-latest
@@ -27,13 +17,34 @@ jobs:
submodules: true
- name: Add wget
run: apt-get update && apt-get install -y wget
- - name: Setup cmake
+ - name: Get cmake
uses: jwlawson/actions-setup-cmake@v1.11
- name: Configure
run: cmake -S . -B build -DCLI11_CUDA_TESTS=ON
- name: Build
run: cmake --build build -j2
+
+ boost-build:
+ name: Boost build
+ runs-on: ubuntu-latest
+ container: zouzias/boost:1.76.0
+ steps:
+ - uses: actions/checkout@v1
+ with:
+ submodules: true
+ - name: Add deps
+ run: apt-get update && apt-get install make
+ - name: Get CMake
+ uses: jwlawson/actions-setup-cmake@v1.11
+ - name: Configure
+ run: cmake -S . -B build -DCLI11_BOOST=ON
+ - name: Build
+ run: cmake --build build -j2
+ - name: Run tests
+ run: ctest --output-on-failure
+ working-directory: build
+
cmake-config:
name: CMake config check
runs-on: ubuntu-latest
@@ -148,3 +159,10 @@ jobs:
cmake-version: "3.21"
args: -DCLI11_SANITIZERS=ON -DCLI11_BUILD_EXAMPLES_JSON=ON
if: success() || failure()
+
+ - name: Check CMake 3.22 (full)
+ uses: ./.github/actions/quick_cmake
+ with:
+ cmake-version: "3.22"
+ args: -DCLI11_SANITIZERS=ON -DCLI11_BUILD_EXAMPLES_JSON=ON
+ if: success() || failure()
diff --git a/packages/CLI11/.gitrepo b/packages/CLI11/.gitrepo
index 6e7179c30..9e19e3887 100644
--- a/packages/CLI11/.gitrepo
+++ b/packages/CLI11/.gitrepo
@@ -5,8 +5,8 @@
;
[subrepo]
remote = git@github.com:CLIUtils/CLI11.git
- branch = master
- commit = b440890eaf29d526e13997f67c2e0288c7c3c60f
- parent = 4bd033645f2c3c03bdf1682e34ec57bbd2b5dd21
- cmdver = 0.4.3
+ branch = main
+ commit = 70f8072f9dd2292fd0b9f9e5f58e279f60483ed3
+ parent = ae4cfe8875caf314c7f66eec2e6d09d5ee321e6a
method = merge
+ cmdver = 0.4.3
diff --git a/packages/CLI11/.pre-commit-config.yaml b/packages/CLI11/.pre-commit-config.yaml
index 00d77d22f..84135427c 100644
--- a/packages/CLI11/.pre-commit-config.yaml
+++ b/packages/CLI11/.pre-commit-config.yaml
@@ -1,8 +1,6 @@
ci:
autoupdate_commit_msg: "chore(deps): pre-commit.ci autoupdate"
autofix_commit_msg: "style: pre-commit.ci fixes"
- skip:
- - docker-clang-format
repos:
@@ -23,17 +21,10 @@ repos:
- id: mixed-line-ending
- id: trailing-whitespace
-- repo: local
+- repo: https://github.com/pre-commit/mirrors-clang-format
+ rev: v13.0.0
hooks:
- - id: docker-clang-format
- name: Docker Clang Format
- language: docker_image
- types:
- - c++
- entry: unibeautify/clang-format:latest
- args:
- - -style=file
- - -i
+ - id: clang-format
- repo: https://github.com/cheshirekow/cmake-format-precommit
rev: v0.6.13
diff --git a/packages/CLI11/.travis.yml b/packages/CLI11/.travis.yml
deleted file mode 100644
index d352aed96..000000000
--- a/packages/CLI11/.travis.yml
+++ /dev/null
@@ -1,122 +0,0 @@
-language: cpp
-dist: trusty
-
-# Exclude ghpages,
-# but even better, don't build branch and PR, just PR
-# Include tags starting with v and a digit
-branches:
- only:
- - master
- - /^v\d/
-
-cache:
- apt: true
- directories:
- - "${TRAVIS_BUILD_DIR}/deps/doxygen"
-
-matrix:
- include:
- # Default clang
- - compiler: clang
- script:
- - .ci/make_and_test.sh 11
- - .ci/make_and_test.sh 14
- - .ci/make_and_test.sh 17
-
- # Docs and clang 3.5
- - compiler: clang
- language: node_js
- node_js: "7.4.0"
- env:
- - DEPLOY_MAT=yes
- addons:
- apt:
- packages:
- - clang-3.5
- install:
- - export CC=clang-3.5
- - export CXX=clang++-3.5
- - npm install gitbook-cli -g
- - gitbook fetch 3.2.3
- - gitbook install book
- script:
- - .ci/make_and_test.sh 11
- after_success:
- - export DEPS_DIR="${TRAVIS_BUILD_DIR}/deps"
- - . .ci/build_doxygen.sh
- - doxygen docs/Doxyfile
- - gitbook build book html/book
-
- # GCC 7 and coverage (8 does not support lcov, wait till 9 and new lcov)
- - compiler: gcc
- dist: bionic
- addons:
- apt:
- packages:
- - curl
- - lcov
- install:
- - DEPS_DIR="${TRAVIS_BUILD_DIR}/deps"
- - cd $TRAVIS_BUILD_DIR
- - ". .ci/build_lcov.sh"
- - ".ci/run_codecov.sh"
- script:
- - .ci/make_and_test.sh 11 -DCLI11_EXAMPLE_JSON=ON
- - .ci/make_and_test.sh 14 -DCLI11_EXAMPLE_JSON=ON
- - .ci/make_and_test.sh 17 -DCLI11_EXAMPLE_JSON=ON
-
- # GCC 4.8 and Conan
- - compiler: gcc
- dist: bionic
- addons:
- apt:
- packages:
- - python3-pip
- - python3-setuptools
- install:
- - python3 -VV
- - python3 -m pip install --user conan
- - conan user
- script:
- - .ci/make_and_test.sh 11
- after_success:
- - conan create . cliutils/stable
- - |
- if [ "${TRAVIS_TAG}" ]
- then
- conan remote add origin https://api.bintray.com/conan/cliutils/CLI11
- conan user -p ${BINFROG_API_KEY} -r origin henryiii
- conan upload "*" -c -r origin --all
- fi
-
-
-install: skip
-
-script:
-- .ci/make_and_test.sh 11
-- .ci/make_and_test.sh 14
-
-
-deploy:
-- provider: pages
- skip_cleanup: true
- github_token: ${GH_REPO_TOKEN}
- keep_history: false
- local_dir: ${TRAVIS_BUILD_DIR}/html
- on:
- branch: master
- condition: "$DEPLOY_MAT = yes"
-
-notifications:
- webhooks:
- urls:
- - https://webhooks.gitter.im/e/bbdb3befce4c00448d24
- on_success: change
- on_failure: always
- on_start: never
-
-env:
- global:
- - secure: cY0OI609iTAxLRYuYQnNMi+H6n0dBwioTAoFXGGRTnngw2V9om3UmY5eUu4HQEQsQZovHdYpNhlSgRmdwQ4UqSp3FGyrwobf0kzacV4bVnMDeXDmHt8RzE5wP/LwDd8elNF6RRYjElY99f0k0FyXVd0fIvuVkGKQECNLOtEk0jQo+4YTh7dhuCxRhBYgTbNiRL6UJynfrcK0YN+DQ+8CJNupu2VxgaEpCSngTfvDHLcddcrXwpvn3MPc3FsDUbtN389ZCIe41qqIL0ATv46DQaTw4FOevyVfRyrBOznONoGCVeAYKL6VBdrk01Fh6aytF5zgI3hKaKobgEn+QFfzR6l68c6APvqA0Qv39iLjuh6KbdIV2YsqXfyt6FBgqP2xZuNEZW1jZ8LxUOLl2I40UEh87nFutvnSbfIzN+FcLrajm2H2jV2kZGNKAMx+4qxkZuXSre4JPkENfJm2WNFAKlqPt4ZSEQarkDYzZPcEr2I9fbGjQYVJICoN4LikCv9K5z7ujpTxCTNbVpQWZcEOT6QQBc6Vml/N/NKAIl9o2OeTLiXCmT31+KQMeO492KYNQ6VmkeqrVhGExOUcJdNyDJV9C+3mSekb3Sq78SneYRKDechkWbMl0ol07wGTdBwQQwgaorjRyn07x1rDxpPr3z19/+eubnpPUW4UQ5MYsjs=
- - secure: G6H5HA9pPUgsd96A+uvTxbLjR1rcT9NtxsknIkFDfzGDpffn6wVX+kCIQLf9zFDnQnsfYA/4piiuoBN5U5C7HQrh9UCvBVptXjWviea0Y7CRbMJZpw2rPvXWQtrFNzYkaV7kdJ5B0Mmvh6rcH/I8gKFrkdjF7i7sfzWdFWRU5QXfxXOk2n+xCXX6uFemxHH9850XEjVtnU7YYUebQFaoTYLLy05nlt9JaEF84wfJljY/SJX7I9gpNLtizE9MpJylnrwUeL66OqFievmjL3/bWpPUBjUF0WdtXYlVDja7O582FQDs94ofgqeGieGIMQ0VuovpbQOJSdjs5XHZwu2ce6HZxtOhJJqw6xEwbq43ZdofAlJ5GUEOgrr+j25zIDkdzOhliDKJtw5ysmmTUKEcZ36iWbCE0YP/IC42yOV9oOP6UkgbuwpVDdxAFRgLZLahW9Ok+c1PlzIauPxv+jIEI4rSEEJRKZG2JK3TXUdhd58mHBfQMNjKQMF+Y2wCCGjfMO0q4SgvBhYyb4oBTxEqnc2Pzh2DJdNzRFsV7ktsQSRglHGVI+1XTmQ+2kbBzNOQBLjOuRvDZENUhyxPKGZDHyAOMlVvYm8vvWebM1/F3YgDb/tPh33+EGSvpKkCZ5nUxB5e605H6gdYlNKNhuWKlEKTo2/kF0D39gAUCIcGbzw=
- - CCACHE_CPP2: yes
diff --git a/packages/CLI11/CHANGELOG.md b/packages/CLI11/CHANGELOG.md
index 41c193814..e35ca3867 100644
--- a/packages/CLI11/CHANGELOG.md
+++ b/packages/CLI11/CHANGELOG.md
@@ -11,7 +11,7 @@ is not passed, or every time the option is parsed.
* Option/subcommand name restrictions have been relaxed. Most characters are now allowed. [#627][]
* The config parser can accept streams, specify a specific section, and inline comment characters are supported [#630][]
-* `force_callback` & `trigger_on_parse` added, allowing a callback to always run on parse even if not present or every time the option is parsed[#631][]
+* `force_callback` & `trigger_on_parse` added, allowing a callback to always run on parse even if not present or every time the option is parsed [#631][]
* Bugfix(cmake): Only add `CONFIGURE_DEPENDS` if CLI11 is the main project [#633][]
* Bugfix(cmake): Ensure the cmake/pkg-config files install to a arch independent path [#635][]
* Bugfix: The single header file generation was missing the include guard. [#620][]
@@ -26,8 +26,24 @@ is not passed, or every time the option is parsed.
### Version 2.1.1: Quick Windows fix
* A collision with `min`/`max` macros on Windows has been fixed. [#642][]
+* Tests pass with Boost again [#646][]
+* Running the pre-commit hooks in development no longer requires docker for clang-format [#647][]
[#642]: https://github.com/CLIUtils/CLI11/pull/642
+[#646]: https://github.com/CLIUtils/CLI11/pull/646
+[#647]: https://github.com/CLIUtils/CLI11/pull/647
+
+## Version 2.1.2: Better subproject builds
+
+* Use `main` for the main branch of the repository [#657][]
+* Bugfix(cmake): Enforce at least C++11 when using CMake target [#656][]
+* Build: Don't run doxygen and CTest includes if a submodule [#656][]
+* Build: Avoid a warning on CMake 3.22 [#656][]
+* Build: Support compiling the tests with an external copy of Catch2 [#653][]
+
+[#653]: https://github.com/CLIUtils/CLI11/pull/653
+[#656]: https://github.com/CLIUtils/CLI11/pull/656
+[#657]: https://github.com/CLIUtils/CLI11/pull/657
## Version 2.0: Simplification
@@ -610,7 +626,7 @@ This release focused on cleaning up the most exotic compiler warnings, fixing a
## Version 0.8: CLIUtils
-This release moved the repository to the CLIUtils master organization.
+This release moved the repository to the CLIUtils main organization.
* Moved to CLIUtils on GitHub
* Fixed docs build and a few links
@@ -645,7 +661,7 @@ Lots of cleanup and docs additions made it into this release. Parsing is simpler
* `->ignore_case()` added to subcommands, options, and `add_set_ignore_case`. Subcommands inherit setting from parent App on creation.
* Subcommands now can be "chained", that is, left over arguments can now include subcommands that then get parsed. Subcommands are now a list (`get_subcommands`). Added `got_subcommand(App_or_name)` to check for subcommands.
* Added `.allow_extras()` to disable error on failure. Parse returns a vector of leftover options. Renamed error to `ExtrasError`, and now triggers on extra options too.
-* Added `require_subcommand` to `App`, to simplify forcing subcommands. Do **not** do `add_subcommand()->require_subcommand`, since that is the subcommand, not the master `App`.
+* Added `require_subcommand` to `App`, to simplify forcing subcommands. Do **not** do `add_subcommand()->require_subcommand`, since that is the subcommand, not the main `App`.
* Added printout of ini file text given parsed options, skips flags.
* Support for quotes and spaces in ini files
* Fixes to allow support for Windows (added Appveyor) (Uses `-`, not `/` syntax)
diff --git a/packages/CLI11/CMakeLists.txt b/packages/CLI11/CMakeLists.txt
index 3227e409d..1f4313ff5 100644
--- a/packages/CLI11/CMakeLists.txt
+++ b/packages/CLI11/CMakeLists.txt
@@ -2,14 +2,14 @@ cmake_minimum_required(VERSION 3.4)
# Note: this is a header only library. If you have an older CMake than 3.4,
# just add the CLI11/include directory and that's all you need to do.
-# Make sure users don't get warnings on a tested (3.4 to 3.21) version
+# Make sure users don't get warnings on a tested (3.4 to 3.22) version
# of CMake. For most of the policies, the new version is better (hence the change).
# We don't use the 3.4...3.21 syntax because of a bug in an older MSVC's
# built-in and modified CMake 3.11
-if(${CMAKE_VERSION} VERSION_LESS 3.21)
+if(${CMAKE_VERSION} VERSION_LESS 3.22)
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
else()
- cmake_policy(VERSION 3.21)
+ cmake_policy(VERSION 3.22)
endif()
set(VERSION_REGEX "#define CLI11_VERSION[ \t]+\"(.+)\"")
@@ -30,18 +30,29 @@ project(
# Print the version number of CMake if this is the main project
if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
message(STATUS "CMake ${CMAKE_VERSION}")
+
+ find_package(Doxygen)
+
+ if(CMAKE_VERSION VERSION_LESS 3.10)
+ message(STATUS "CMake 3.10+ adds Doxygen support. Update CMake to build documentation")
+ elseif(NOT Doxygen_FOUND)
+ message(STATUS "Doxygen not found, building docs has been disabled")
+ endif()
+
+ include(CTest)
+else()
+ if(NOT DEFINED BUILD_TESTING)
+ set(BUILD_TESTING OFF)
+ endif()
endif()
include(CMakeDependentOption)
include(GNUInstallDirs)
-include(CTest)
if(NOT CMAKE_VERSION VERSION_LESS 3.11)
include(FetchContent)
endif()
-find_package(Doxygen)
-
list(APPEND force-libcxx "CMAKE_CXX_COMPILER_ID STREQUAL \"Clang\"")
list(APPEND force-libcxx "CMAKE_SYSTEM_NAME STREQUAL \"Linux\"")
list(APPEND force-libcxx "CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME")
@@ -118,12 +129,6 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
endif()
-if(CMAKE_VERSION VERSION_LESS 3.10)
- message(STATUS "CMake 3.10+ adds Doxygen support. Update CMake to build documentation")
-elseif(NOT Doxygen_FOUND)
- message(STATUS "Doxygen not found, building docs has been disabled")
-endif()
-
# Special target that adds warnings. Is not exported.
add_library(CLI11_warnings INTERFACE)
@@ -154,6 +159,22 @@ add_library(CLI11::CLI11 ALIAS CLI11) # for add_subdirectory calls
target_include_directories(CLI11 INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:include>)
+if(CMAKE_VERSION VERSION_LESS 3.8)
+ # This might not be a complete list
+ target_compile_features(
+ CLI11
+ INTERFACE cxx_lambdas
+ cxx_nullptr
+ cxx_override
+ cxx_range_for
+ cxx_right_angle_brackets
+ cxx_strong_enums
+ cxx_constexpr
+ cxx_auto_type)
+else()
+ target_compile_features(CLI11 INTERFACE cxx_std_11)
+endif()
+
# To see in IDE, headers must be listed for target
set(header-patterns "${PROJECT_SOURCE_DIR}/include/CLI/*")
if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME AND NOT CMAKE_VERSION VERSION_LESS 3.12)
@@ -254,6 +275,7 @@ if(CLI11_SINGLE_FILE)
endif()
if(CLI11_BUILD_TESTS)
+ include(CTest)
add_subdirectory(tests)
endif()
diff --git a/packages/CLI11/README.md b/packages/CLI11/README.md
index 229b65451..ad1ac1e97 100644
--- a/packages/CLI11/README.md
+++ b/packages/CLI11/README.md
@@ -2,19 +2,20 @@
-[![Build Status Linux and macOS][travis-badge]][travis]
-[![Build Status Windows][appveyor-badge]][appveyor]
[![Build Status Azure][azure-badge]][azure]
[![Actions Status][actions-badge]][actions-link]
+[![Build Status AppVeyor][appveyor-badge]][appveyor]
[![Code Coverage][codecov-badge]][codecov]
[![Codacy Badge][codacy-badge]][codacy-link]
-[![Gitter chat][gitter-badge]][gitter]
[![License: BSD][license-badge]](./LICENSE)
-[![Latest release][releases-badge]][github releases]
[![DOI][doi-badge]][doi-link]
+
+[![Gitter chat][gitter-badge]][gitter]
+[![Latest GHA release][releases-badge]][github releases]
+[![Latest release][repology-badge]][repology]
[![Conan.io][conan-badge]][conan-link]
[![Conda Version][conda-badge]][conda-link]
-[![Try CLI11 2.0 online][wandbox-badge]][wandbox-link]
+[![Try CLI11 2.1 online][wandbox-badge]][wandbox-link]
[What's new](./CHANGELOG.md) •
[Documentation][gitbook] •
@@ -57,14 +58,14 @@ CLI11 is a command line parser for C++11 and beyond that provides a rich feature
* [Contribute](#contribute)
* [License](#license)
-Features that were added in the last released major version are marked with "🆕". Features only available in master are marked with "🚧".
+Features that were added in the last released major version are marked with "🆕". Features only available in main are marked with "🚧".
## Background
### Introduction
CLI11 provides all the features you expect in a powerful command line parser, with a beautiful, minimal syntax and no dependencies beyond C++11. It is header only, and comes in a single file form for easy inclusion in projects. It is easy to use for small projects, but powerful enough for complex command line projects, and can be customized for frameworks.
-It is tested on [Travis][], [AppVeyor][], [Azure][], and [GitHub Actions][actions-link], and is used by the [GooFit GPU fitting framework][goofit]. It was inspired by [`plumbum.cli`][plumbum] for Python. CLI11 has a user friendly introduction in this README, a more in-depth tutorial [GitBook][], as well as [API documentation][api-docs] generated by Travis.
+It is tested on [Azure][] and [GitHub Actions][actions-link], and was originally used by the [GooFit GPU fitting framework][goofit]. It was inspired by [`plumbum.cli`][plumbum] for Python. CLI11 has a user friendly introduction in this README, a more in-depth tutorial [GitBook][], as well as [API documentation][api-docs] generated by Travis.
See the [changelog](./CHANGELOG.md) or [GitHub Releases][] for details for current and past releases. Also see the [Version 1.0 post][], [Version 1.3 post][], [Version 1.6 post][], or [Version 2.0 post][] for more information.
You can be notified when new releases are made by subscribing to <https://github.com/CLIUtils/CLI11/releases.atom> on an RSS reader, like Feedly, or use the releases mode of the GitHub watching tool.
@@ -77,7 +78,7 @@ An acceptable CLI parser library should be all of the following:
* Short, simple syntax: This is one of the main reasons to use a CLI parser, it should make variables from the command line nearly as easy to define as any other variables. If most of your program is hidden in CLI parsing, this is a problem for readability.
* C++11 or better: Should work with GCC 4.8+ (default on CentOS/RHEL 7), Clang 3.4+, AppleClang 7+, NVCC 7.0+, or MSVC 2015+.
* Work on Linux, macOS, and Windows.
-* Well tested using [Travis][] (Linux) and [AppVeyor][] (Windows) or [Azure][] (all three). "Well" is defined as having good coverage measured by [CodeCov][].
+* Well tested on all common platforms and compilers. "Well" is defined as having good coverage measured by [CodeCov][].
* Clear help printing.
* Nice error messages.
* Standard shell idioms supported naturally, like grouping flags, a positional separator, etc.
@@ -128,7 +129,7 @@ So, this library was designed to provide a great syntax, good compiler compatibi
There are some other possible "features" that are intentionally not supported by this library:
* Non-standard variations on syntax, like `-long` options. This is non-standard and should be avoided, so that is enforced by this library.
-* Completion of partial options, such as Python's `argparse` supplies for incomplete arguments. It's better not to guess. Most third party command line parsers for python actually reimplement command line parsing rather than using argparse because of this perceived design flaw.
+* Completion of partial options, such as Python's `argparse` supplies for incomplete arguments. It's better not to guess. Most third party command line parsers for python actually reimplement command line parsing rather than using argparse because of this perceived design flaw (recent versions do have an option to disable it).
* Autocomplete: This might eventually be added to both Plumbum and CLI11, but it is not supported yet.
* Wide strings / unicode: Since this uses the standard library only, it might be hard to properly implement, but I would be open to suggestions in how to do this.
@@ -139,7 +140,7 @@ To use, there are several methods:
* All-in-one local header: Copy `CLI11.hpp` from the [most recent release][github releases] into your include directory, and you are set. This is combined from the source files for every release. This includes the entire command parser library, but does not include separate utilities (like `Timer`, `AutoTimer`). The utilities are completely self contained and can be copied separately.
* All-in-one global header: Like above, but copying the file to a shared folder location like `/opt/CLI11`. Then, the C++ include path has to be extended to point at this folder. With CMake, use `include_directories(/opt/CLI11)`
* Local headers and target: Use `CLI/*.hpp` files. You could check out the repository as a git submodule, for example. With CMake, you can use `add_subdirectory` and the `CLI11::CLI11` interface target when linking. If not using a submodule, you must ensure that the copied files are located inside the same tree directory than your current project, to prevent an error with CMake and `add_subdirectory`.
-* Global headers: Use `CLI/*.hpp` files stored in a shared folder. You could check out the git repository in a system-wide folder, for example `/opt/`. With CMake, you could add to the include path via:
+* Global headers: Use `CLI/*.hpp` files stored in a shared folder. You could check out the git repository to a system-wide folder, for example `/opt/`. With CMake, you could add to the include path via:
```bash
if(NOT DEFINED CLI11_DIR)
@@ -159,15 +160,27 @@ And then in the source code (adding several headers might be needed to prevent l
* Global headers and target: configuring and installing the project is required for linking CLI11 to your project in the same way as you would do with any other external library. With CMake, this step allows using `find_package(CLI11 CONFIG REQUIRED)` and then using the `CLI11::CLI11` target when linking. If `CMAKE_INSTALL_PREFIX` was changed during install to a specific folder like `/opt/CLI11`, then you have to pass `-DCLI11_DIR=/opt/CLI11` when building your current project. You can also use [Conan.io][conan-link] or [Hunter][].
(These are just conveniences to allow you to use your favorite method of managing packages; it's just header only so including the correct path and
using C++11 is all you really need.)
+* Via FetchContent in CMake 3.14+ (or 3.11+ with more work): you can add this with fetch-content, then use the `CLI11::CLI11` target as above, and CMake will download the project in the configure stage:
+
+```cmake
+include(FetchContent)
+FetchContent_Declare(
+ cli11
+ GIT_REPOSITORY https://github.com/CLIUtils/CLI11
+ GIT_TAG v2.1.2
+)
+
+FetchContent_MakeAvailable(cli11)
+```
+
+It is highly recommended that you use the git hash for `GIT_TAG` instead of a tag or branch, as that will both be more secure, as well as faster to reconfigure - CMake will not have to reach out to the internet to see if the tag moved. You can also download just the single header file from the releases using `file(DOWNLOAD`.
To build the tests, checkout the repository and use CMake:
```bash
-mkdir build
-cd build
-cmake ..
-make
-GTEST_COLOR=1 CTEST_OUTPUT_ON_FAILURE=1 make test
+cmake -S . -B build
+cmake --build build
+CTEST_OUTPUT_ON_FAILURE=1 cmake --build build -t test
```
<details><summary>Note: Special instructions for GCC 8</summary><p>
@@ -592,7 +605,7 @@ There are several options that are supported on the main app and subcommands and
* `.got_subcommand(App_or_name)`: Check to see if a subcommand was received on the command line.
* `.get_subcommands(filter)`: The list of subcommands that match a particular filter function.
* `.add_option_group(name="", description="")`: Add an [option group](#option-groups) to an App, an option group is specialized subcommand intended for containing groups of options or other groups for controlling how options interact.
-* `.get_parent()`: Get the parent App or `nullptr` if called on master App.
+* `.get_parent()`: Get the parent App or `nullptr` if called on main App.
* `.get_option(name)`: Get an option pointer by option name will throw if the specified option is not available, nameless subcommands are also searched
* `.get_option_no_throw(name)`: Get an option pointer by option name. This function will return a `nullptr` instead of throwing if the option is not available.
* `.get_options(filter)`: Get the list of all defined option pointers (useful for processing the app for custom output formats).
@@ -604,7 +617,7 @@ There are several options that are supported on the main app and subcommands and
* `.parsed()`: True if this subcommand was given on the command line.
* `.count()`: Returns the number of times the subcommand was called.
* `.count(option_name)`: Returns the number of times a particular option was called.
-* `.count_all()`: Returns the total number of arguments a particular subcommand processed, on the master App it returns the total number of processed commands.
+* `.count_all()`: Returns the total number of arguments a particular subcommand processed, on the main App it returns the total number of processed commands.
* `.name(name)`: Add or change the name.
* `.callback(void() function)`: Set the callback for an app. Either sets the `pre_parse_callback` or the `final_callback` depending on the value of `immediate_callback`. See [Subcommand callbacks](#callbacks) for some additional details.
* `.parse_complete_callback(void() function)`: Set the callback that runs at the completion of parsing. For subcommands this is executed at the completion of the single subcommand and can be executed multiple times. See [Subcommand callbacks](#callbacks) for some additional details.
@@ -673,7 +686,7 @@ The subcommand method
.add_option_group(name,description)
```
-Will create an option group, and return a pointer to it. The argument for `description` is optional and can be omitted. An option group allows creation of a collection of options, similar to the groups function on options, but with additional controls and requirements. They allow specific sets of options to be composed and controlled as a collective. For an example see [range example](https://github.com/CLIUtils/CLI11/blob/master/examples/ranges.cpp). Option groups are a specialization of an App so all [functions](#subcommand-options) that work with an App or subcommand also work on option groups. Options can be created as part of an option group using the add functions just like a subcommand, or previously created options can be added through. The name given in an option group must not contain newlines or null characters.🆕
+Will create an option group, and return a pointer to it. The argument for `description` is optional and can be omitted. An option group allows creation of a collection of options, similar to the groups function on options, but with additional controls and requirements. They allow specific sets of options to be composed and controlled as a collective. For an example see [range example](https://github.com/CLIUtils/CLI11/blob/main/examples/ranges.cpp). Option groups are a specialization of an App so all [functions](#subcommand-options) that work with an App or subcommand also work on option groups. Options can be created as part of an option group using the add functions just like a subcommand, or previously created options can be added through. The name given in an option group must not contain newlines or null characters.🆕
```cpp
ogroup->add_option(option_pointer);
@@ -892,28 +905,28 @@ The API is [documented here][api-docs]. Also see the [CLI11 tutorial GitBook][gi
Several short examples of different features are included in the repository. A brief description of each is included here
-* [callback_passthrough](https://github.com/CLIUtils/CLI11/blob/master/examples/callback_passthrough.cpp): Example of directly passing remaining arguments through to a callback function which generates a CLI11 application based on existing arguments.
-* [custom_parse](https://github.com/CLIUtils/CLI11/blob/master/examples/custom_parse.cpp): Based on [Issue #566](https://github.com/CLIUtils/CLI11/issues/566), example of custom parser
-* [digit_args](https://github.com/CLIUtils/CLI11/blob/master/examples/digit_args.cpp): Based on [Issue #123](https://github.com/CLIUtils/CLI11/issues/123), uses digit flags to pass a value
-* [enum](https://github.com/CLIUtils/CLI11/blob/master/examples/enum.cpp): Using enumerations in an option, and the use of [CheckedTransformer](#transforming-validators)
-* [enum_ostream](https://github.com/CLIUtils/CLI11/blob/master/examples/enum_ostream.cpp): In addition to the contents of example enum.cpp, this example shows how a custom ostream operator overrides CLI11's enum streaming.
-* [formatter](https://github.com/CLIUtils/CLI11/blob/master/examples/formatter.cpp): Illustrating usage of a custom formatter
-* [groups](https://github.com/CLIUtils/CLI11/blob/master/examples/groups.cpp): Example using groups of options for help grouping and a the timer helper class
-* [inter_argument_order](https://github.com/CLIUtils/CLI11/blob/master/examples/inter_argument_order.cpp): An app to practice mixing unlimited arguments, but still recover the original order.
-* [json](https://github.com/CLIUtils/CLI11/blob/master/examples/json.cpp): Using JSON as a config file parser
-* [modhelp](https://github.com/CLIUtils/CLI11/blob/master/examples/modhelp.cpp): How to modify the help flag to do something other than default
-* [nested](https://github.com/CLIUtils/CLI11/blob/master/examples/nested.cpp): Nested subcommands
-* [option_groups](https://github.com/CLIUtils/CLI11/blob/master/examples/option_groups.cpp): Illustrating the use of option groups and a required number of options. Based on [Issue #88](https://github.com/CLIUtils/CLI11/issues/88) to set interacting groups of options
-* [positional_arity](https://github.com/CLIUtils/CLI11/blob/master/examples/positional_arity.cpp): Illustrating use of `preparse_callback` to handle situations where the number of arguments can determine which should get parsed, Based on [Issue #166](https://github.com/CLIUtils/CLI11/issues/166)
-* [positional_validation](https://github.com/CLIUtils/CLI11/blob/master/examples/positional_validation.cpp): Example of how positional arguments are validated using the `validate_positional` flag, also based on [Issue #166](https://github.com/CLIUtils/CLI11/issues/166)
-* [prefix_command](https://github.com/CLIUtils/CLI11/blob/master/examples/prefix_command.cpp): Illustrating use of the `prefix_command` flag.
-* [ranges](https://github.com/CLIUtils/CLI11/blob/master/examples/ranges.cpp): App to demonstrate exclusionary option groups based on [Issue #88](https://github.com/CLIUtils/CLI11/issues/88)
-* [shapes](https://github.com/CLIUtils/CLI11/blob/master/examples/shapes.cpp): Illustrating how to set up repeated subcommands Based on [gitter discussion](https://gitter.im/CLI11gitter/Lobby?at=5c7af6b965ffa019ea788cd5)
-* [simple](https://github.com/CLIUtils/CLI11/blob/master/examples/simple.cpp): A simple example of how to set up a CLI11 Application with different flags and options
-* [subcom_help](https://github.com/CLIUtils/CLI11/blob/master/examples/subcom_help.cpp): Configuring help for subcommands
-* [subcom_partitioned](https://github.com/CLIUtils/CLI11/blob/master/examples/subcom_partitioned.cpp): Example with a timer and subcommands generated separately and added to the main app later.
-* [subcommands](https://github.com/CLIUtils/CLI11/blob/master/examples/subcommands.cpp): Short example of subcommands
-* [validators](https://github.com/CLIUtils/CLI11/blob/master/examples/validators.cpp): Example illustrating use of validators
+* [callback_passthrough](https://github.com/CLIUtils/CLI11/blob/main/examples/callback_passthrough.cpp): Example of directly passing remaining arguments through to a callback function which generates a CLI11 application based on existing arguments.
+* [custom_parse](https://github.com/CLIUtils/CLI11/blob/main/examples/custom_parse.cpp): Based on [Issue #566](https://github.com/CLIUtils/CLI11/issues/566), example of custom parser
+* [digit_args](https://github.com/CLIUtils/CLI11/blob/main/examples/digit_args.cpp): Based on [Issue #123](https://github.com/CLIUtils/CLI11/issues/123), uses digit flags to pass a value
+* [enum](https://github.com/CLIUtils/CLI11/blob/main/examples/enum.cpp): Using enumerations in an option, and the use of [CheckedTransformer](#transforming-validators)
+* [enum_ostream](https://github.com/CLIUtils/CLI11/blob/main/examples/enum_ostream.cpp): In addition to the contents of example enum.cpp, this example shows how a custom ostream operator overrides CLI11's enum streaming.
+* [formatter](https://github.com/CLIUtils/CLI11/blob/main/examples/formatter.cpp): Illustrating usage of a custom formatter
+* [groups](https://github.com/CLIUtils/CLI11/blob/main/examples/groups.cpp): Example using groups of options for help grouping and a the timer helper class
+* [inter_argument_order](https://github.com/CLIUtils/CLI11/blob/main/examples/inter_argument_order.cpp): An app to practice mixing unlimited arguments, but still recover the original order.
+* [json](https://github.com/CLIUtils/CLI11/blob/main/examples/json.cpp): Using JSON as a config file parser
+* [modhelp](https://github.com/CLIUtils/CLI11/blob/main/examples/modhelp.cpp): How to modify the help flag to do something other than default
+* [nested](https://github.com/CLIUtils/CLI11/blob/main/examples/nested.cpp): Nested subcommands
+* [option_groups](https://github.com/CLIUtils/CLI11/blob/main/examples/option_groups.cpp): Illustrating the use of option groups and a required number of options. Based on [Issue #88](https://github.com/CLIUtils/CLI11/issues/88) to set interacting groups of options
+* [positional_arity](https://github.com/CLIUtils/CLI11/blob/main/examples/positional_arity.cpp): Illustrating use of `preparse_callback` to handle situations where the number of arguments can determine which should get parsed, Based on [Issue #166](https://github.com/CLIUtils/CLI11/issues/166)
+* [positional_validation](https://github.com/CLIUtils/CLI11/blob/main/examples/positional_validation.cpp): Example of how positional arguments are validated using the `validate_positional` flag, also based on [Issue #166](https://github.com/CLIUtils/CLI11/issues/166)
+* [prefix_command](https://github.com/CLIUtils/CLI11/blob/main/examples/prefix_command.cpp): Illustrating use of the `prefix_command` flag.
+* [ranges](https://github.com/CLIUtils/CLI11/blob/main/examples/ranges.cpp): App to demonstrate exclusionary option groups based on [Issue #88](https://github.com/CLIUtils/CLI11/issues/88)
+* [shapes](https://github.com/CLIUtils/CLI11/blob/main/examples/shapes.cpp): Illustrating how to set up repeated subcommands Based on [gitter discussion](https://gitter.im/CLI11gitter/Lobby?at=5c7af6b965ffa019ea788cd5)
+* [simple](https://github.com/CLIUtils/CLI11/blob/main/examples/simple.cpp): A simple example of how to set up a CLI11 Application with different flags and options
+* [subcom_help](https://github.com/CLIUtils/CLI11/blob/main/examples/subcom_help.cpp): Configuring help for subcommands
+* [subcom_partitioned](https://github.com/CLIUtils/CLI11/blob/main/examples/subcom_partitioned.cpp): Example with a timer and subcommands generated separately and added to the main app later.
+* [subcommands](https://github.com/CLIUtils/CLI11/blob/main/examples/subcommands.cpp): Short example of subcommands
+* [validators](https://github.com/CLIUtils/CLI11/blob/main/examples/validators.cpp): Example illustrating use of validators
## Contribute
@@ -1008,15 +1021,15 @@ CLI11 was developed at the [University of Cincinnati][] to support of the [GooFi
[doi-badge]: https://zenodo.org/badge/80064252.svg
[doi-link]: https://zenodo.org/badge/latestdoi/80064252
-[azure-badge]: https://dev.azure.com/CLIUtils/CLI11/_apis/build/status/CLIUtils.CLI11?branchName=master
+[azure-badge]: https://dev.azure.com/CLIUtils/CLI11/_apis/build/status/CLIUtils.CLI11?branchName=main
[azure]: https://dev.azure.com/CLIUtils/CLI11
-[travis-badge]: https://img.shields.io/travis/CLIUtils/CLI11/master.svg?label=Linux/macOS
-[travis]: https://travis-ci.org/CLIUtils/CLI11
-[appveyor-badge]: https://img.shields.io/appveyor/ci/HenrySchreiner/cli11/master.svg?label=AppVeyor
+[actions-link]: https://github.com/CLIUtils/CLI11/actions
+[actions-badge]: https://github.com/CLIUtils/CLI11/actions/workflows/tests.yml/badge.svg
+[appveyor-badge]: https://ci.appveyor.com/api/projects/status/82niaxpaa28dwbms/branch/main?svg=true
[appveyor]: https://ci.appveyor.com/project/HenrySchreiner/cli11
-[actions-badge]: https://github.com/CLIUtils/CLI11/workflows/Tests/badge.svg
-[actions-link]: https://github.com/CLIUtils/CLI11/actions
-[codecov-badge]: https://codecov.io/gh/CLIUtils/CLI11/branch/master/graph/badge.svg
+[repology-badge]: https://repology.org/badge/latest-versions/cli11.svg
+[repology]: https://repology.org/project/cli11/versions
+[codecov-badge]: https://codecov.io/gh/CLIUtils/CLI11/branch/main/graph/badge.svg?token=2O4wfs8NJO
[codecov]: https://codecov.io/gh/CLIUtils/CLI11
[gitter-badge]: https://badges.gitter.im/CLI11gitter/Lobby.svg
[gitter]: https://gitter.im/CLI11gitter/Lobby
@@ -1056,8 +1069,8 @@ CLI11 was developed at the [University of Cincinnati][] to support of the [GooFi
[version 1.3 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-13/
[version 1.6 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-16/
[version 2.0 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-20/
-[wandbox-badge]: https://img.shields.io/badge/try_2.0-online-blue.svg
-[wandbox-link]: https://wandbox.org/permlink/650go2SXpfdvQ7ex
+[wandbox-badge]: https://img.shields.io/badge/try_2.1-online-blue.svg
+[wandbox-link]: https://wandbox.org/permlink/CA5bymNHh0AczdeN
[releases-badge]: https://img.shields.io/github/release/CLIUtils/CLI11.svg
[cli11-po-compare]: https://iscinumpy.gitlab.io/post/comparing-cli11-and-boostpo/
[diana slides]: https://indico.cern.ch/event/619465/contributions/2507949/attachments/1448567/2232649/20170424-diana-2.pdf
diff --git a/packages/CLI11/azure-pipelines.yml b/packages/CLI11/azure-pipelines.yml
index c72c748e6..750ac31d9 100644
--- a/packages/CLI11/azure-pipelines.yml
+++ b/packages/CLI11/azure-pipelines.yml
@@ -4,11 +4,11 @@
# https://docs.microsoft.com/azure/devops/pipelines/apps/c-cpp/gcc
trigger:
-- master
+- main
- 'v*'
pr:
-- master
+- main
- 'v*'
variables:
diff --git a/packages/CLI11/book/README.md b/packages/CLI11/book/README.md
index 593adbc96..917e753fe 100644
--- a/packages/CLI11/book/README.md
+++ b/packages/CLI11/book/README.md
@@ -28,7 +28,7 @@ Like any good command line application, help is provided. This program can be im
[include](code/intro.cpp)
-[Source code](https://github.com/CLIUtils/CLI11/blob/master/book/code/intro.cpp)
+[Source code](https://github.com/CLIUtils/CLI11/blob/main/book/code/intro.cpp)
Unlike some other libraries, this is enough to exit correctly and cleanly if help is requested or if incorrect arguments are passed. You can try this example out for yourself. To compile with GCC:
@@ -58,7 +58,7 @@ CLI11 was developed at the [University of Cincinnati][] in support of the [GooFi
[cli11tutorial]: https://cliutils.github.io/CLI11/book
[releases]: https://github.com/CLIUtils/CLI11/releases
[api docs]: https://cliutils.github.io/CLI11
-[readme]: https://github.com/CLIUtils/CLI11/blob/master/README.md
+[readme]: https://github.com/CLIUtils/CLI11/blob/main/README.md
[nsf 1414736]: https://nsf.gov/awardsearch/showAward?AWD_ID=1414736
[university of cincinnati]: https://www.uc.edu
[plumbum]: https://plumbum.readthedocs.io/en/latest/
diff --git a/packages/CLI11/book/chapters/an-advanced-example.md b/packages/CLI11/book/chapters/an-advanced-example.md
index 82fe7b71c..84e838ebf 100644
--- a/packages/CLI11/book/chapters/an-advanced-example.md
+++ b/packages/CLI11/book/chapters/an-advanced-example.md
@@ -16,7 +16,7 @@ All that's need now is the parse call. We'll print a little message after the co
[include:"Parse"](../code/geet.cpp)
-[Source code](https://github.com/CLIUtils/CLI11/tree/master/book/code/geet.cpp)
+[Source code](https://github.com/CLIUtils/CLI11/tree/main/book/code/geet.cpp)
If you compile and run:
diff --git a/packages/CLI11/book/chapters/config.md b/packages/CLI11/book/chapters/config.md
index df004ce75..79295bdbf 100644
--- a/packages/CLI11/book/chapters/config.md
+++ b/packages/CLI11/book/chapters/config.md
@@ -195,7 +195,7 @@ Finally, set your new class as new config formatter:
app.config_formatter(std::make_shared<NewConfig>());
```
-See [`examples/json.cpp`](https://github.com/CLIUtils/CLI11/blob/master/examples/json.cpp) for a complete JSON config example.
+See [`examples/json.cpp`](https://github.com/CLIUtils/CLI11/blob/main/examples/json.cpp) for a complete JSON config example.
### Trivial JSON configuration example
diff --git a/packages/CLI11/book/chapters/flags.md b/packages/CLI11/book/chapters/flags.md
index aa920fe85..4e269acdf 100644
--- a/packages/CLI11/book/chapters/flags.md
+++ b/packages/CLI11/book/chapters/flags.md
@@ -97,7 +97,7 @@ The values would be used like this:
[include:"usage"](../code/flags.cpp)
-[Source code](https://github.com/CLIUtils/CLI11/tree/master/book/code/flags.cpp)
+[Source code](https://github.com/CLIUtils/CLI11/tree/main/book/code/flags.cpp)
If you compile and run:
diff --git a/packages/CLI11/docs/Doxyfile b/packages/CLI11/docs/Doxyfile
index d08a2902e..c86b0ba72 100644
--- a/packages/CLI11/docs/Doxyfile
+++ b/packages/CLI11/docs/Doxyfile
@@ -1325,7 +1325,7 @@ CHM_FILE =
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).
+# (YES) or that it should be included in the main .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
diff --git a/packages/CLI11/include/CLI/App.hpp b/packages/CLI11/include/CLI/App.hpp
index 03b58d9fe..803f0f7f6 100644
--- a/packages/CLI11/include/CLI/App.hpp
+++ b/packages/CLI11/include/CLI/App.hpp
@@ -1739,10 +1739,10 @@ class App {
/// Get a pointer to the version option. (const)
const Option *get_version_ptr() const { return version_ptr_; }
- /// Get the parent of this subcommand (or nullptr if master app)
+ /// Get the parent of this subcommand (or nullptr if main app)
App *get_parent() { return parent_; }
- /// Get the parent of this subcommand (or nullptr if master app) (const version)
+ /// Get the parent of this subcommand (or nullptr if main app) (const version)
const App *get_parent() const { return parent_; }
/// Get the name of the current app
@@ -2456,7 +2456,7 @@ class App {
}
/// Parse "one" argument (some may eat more than one), delegate to parent if fails, add to missing if missing
- /// from master return false if the parse has failed and needs to return to parent
+ /// from main return false if the parse has failed and needs to return to parent
bool _parse_single(std::vector<std::string> &args, bool &positional_only) {
bool retval = true;
detail::Classifier classifier = positional_only ? detail::Classifier::NONE : _recognize(args.back());
@@ -2731,7 +2731,7 @@ class App {
}
}
}
- // If a subcommand, try the master command
+ // If a subcommand, try the main command
if(parent_ != nullptr && fallthrough_)
return _get_fallthrough_parent()->_parse_arg(args, current_type);
// don't capture missing if this is a nameless subcommand
@@ -3169,25 +3169,25 @@ struct AppFriend {
#ifdef CLI11_CPP14
/// Wrap _parse_short, perfectly forward arguments and return
- template <typename... Args> static decltype(auto) parse_arg(App *app, Args &&... args) {
+ template <typename... Args> static decltype(auto) parse_arg(App *app, Args &&...args) {
return app->_parse_arg(std::forward<Args>(args)...);
}
/// Wrap _parse_subcommand, perfectly forward arguments and return
- template <typename... Args> static decltype(auto) parse_subcommand(App *app, Args &&... args) {
+ template <typename... Args> static decltype(auto) parse_subcommand(App *app, Args &&...args) {
return app->_parse_subcommand(std::forward<Args>(args)...);
}
#else
/// Wrap _parse_short, perfectly forward arguments and return
template <typename... Args>
- static auto parse_arg(App *app, Args &&... args) ->
+ static auto parse_arg(App *app, Args &&...args) ->
typename std::result_of<decltype (&App::_parse_arg)(App, Args...)>::type {
return app->_parse_arg(std::forward<Args>(args)...);
}
/// Wrap _parse_subcommand, perfectly forward arguments and return
template <typename... Args>
- static auto parse_subcommand(App *app, Args &&... args) ->
+ static auto parse_subcommand(App *app, Args &&...args) ->
typename std::result_of<decltype (&App::_parse_subcommand)(App, Args...)>::type {
return app->_parse_subcommand(std::forward<Args>(args)...);
}
diff --git a/packages/CLI11/include/CLI/Option.hpp b/packages/CLI11/include/CLI/Option.hpp
index 616cd120c..25a676055 100644
--- a/packages/CLI11/include/CLI/Option.hpp
+++ b/packages/CLI11/include/CLI/Option.hpp
@@ -781,7 +781,7 @@ class Option : public OptionBase<Option> {
/// Use `get_name(true)` to get the positional name (replaces `get_pname`)
std::string get_name(bool positional = false, ///< Show the positional name
bool all_options = false ///< Show every option
- ) const {
+ ) const {
if(get_group().empty())
return {}; // Hidden
diff --git a/packages/CLI11/include/CLI/TypeTools.hpp b/packages/CLI11/include/CLI/TypeTools.hpp
index 2b87ec60a..0fa229975 100644
--- a/packages/CLI11/include/CLI/TypeTools.hpp
+++ b/packages/CLI11/include/CLI/TypeTools.hpp
@@ -36,7 +36,7 @@ constexpr enabler dummy = {};
/// A copy of enable_if_t from C++14, compatible with C++11.
///
/// We could check to see if C++14 is being used, but it does not hurt to redefine this
-/// (even Google does this: https://github.com/google/skia/blob/master/include/private/SkTLogic.h)
+/// (even Google does this: https://github.com/google/skia/blob/main/include/private/SkTLogic.h)
/// It is not in the std namespace anyway, so no harm done.
template <bool B, class T = void> using enable_if_t = typename std::enable_if<B, T>::type;
diff --git a/packages/CLI11/include/CLI/Validators.hpp b/packages/CLI11/include/CLI/Validators.hpp
index 3c8b2f420..03eb77b6f 100644
--- a/packages/CLI11/include/CLI/Validators.hpp
+++ b/packages/CLI11/include/CLI/Validators.hpp
@@ -676,7 +676,7 @@ class IsMember : public Validator {
/// This allows in-place construction using an initializer list
template <typename T, typename... Args>
- IsMember(std::initializer_list<T> values, Args &&... args)
+ IsMember(std::initializer_list<T> values, Args &&...args)
: IsMember(std::vector<T>(values), std::forward<Args>(args)...) {}
/// This checks to see if an item is in a set (empty function)
@@ -728,7 +728,7 @@ class IsMember : public Validator {
/// You can pass in as many filter functions as you like, they nest (string only currently)
template <typename T, typename... Args>
- IsMember(T &&set, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&... other)
+ IsMember(T &&set, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
: IsMember(
std::forward<T>(set),
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
@@ -745,7 +745,7 @@ class Transformer : public Validator {
/// This allows in-place construction
template <typename... Args>
- Transformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&... args)
+ Transformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&...args)
: Transformer(TransformPairs<std::string>(values), std::forward<Args>(args)...) {}
/// direct map of std::string to std::string
@@ -789,7 +789,7 @@ class Transformer : public Validator {
/// You can pass in as many filter functions as you like, they nest
template <typename T, typename... Args>
- Transformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&... other)
+ Transformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
: Transformer(
std::forward<T>(mapping),
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
@@ -803,7 +803,7 @@ class CheckedTransformer : public Validator {
/// This allows in-place construction
template <typename... Args>
- CheckedTransformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&... args)
+ CheckedTransformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&...args)
: CheckedTransformer(TransformPairs<std::string>(values), std::forward<Args>(args)...) {}
/// direct map of std::string to std::string
@@ -865,7 +865,7 @@ class CheckedTransformer : public Validator {
/// You can pass in as many filter functions as you like, they nest
template <typename T, typename... Args>
- CheckedTransformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&... other)
+ CheckedTransformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
: CheckedTransformer(
std::forward<T>(mapping),
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
diff --git a/packages/CLI11/include/CLI/Version.hpp b/packages/CLI11/include/CLI/Version.hpp
index c989ae86d..4bc79a773 100644
--- a/packages/CLI11/include/CLI/Version.hpp
+++ b/packages/CLI11/include/CLI/Version.hpp
@@ -10,7 +10,7 @@
#define CLI11_VERSION_MAJOR 2
#define CLI11_VERSION_MINOR 1
-#define CLI11_VERSION_PATCH 1
-#define CLI11_VERSION "2.1.1"
+#define CLI11_VERSION_PATCH 2
+#define CLI11_VERSION "2.1.2"
// [CLI11:version_hpp:end]
diff --git a/packages/CLI11/tests/CMakeLists.txt b/packages/CLI11/tests/CMakeLists.txt
index c322615f6..80c4f6a83 100644
--- a/packages/CLI11/tests/CMakeLists.txt
+++ b/packages/CLI11/tests/CMakeLists.txt
@@ -63,23 +63,33 @@ endif()
set(CLI11_MULTIONLY_TESTS TimerTest)
-add_library(catch_main main.cpp)
+add_library(catch_main main.cpp catch.hpp)
target_include_directories(catch_main PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}")
-# Currently a required download; could be make to look for existing Catch2, but
-# that would require changing the includes. FetchContent would be better, but
-# requires newer CMake.
-
-set(url https://github.com/philsquared/Catch/releases/download/v2.13.6/catch.hpp)
-file(
- DOWNLOAD ${url} "${CMAKE_CURRENT_BINARY_DIR}/catch.hpp"
- STATUS status
- EXPECTED_HASH SHA256=681e7505a50887c9085539e5135794fc8f66d8e5de28eadf13a30978627b0f47)
-list(GET status 0 error)
-if(error)
- message(FATAL_ERROR "Could not download ${url}")
+find_package(Catch2 CONFIG)
+
+if(Catch2_FOUND)
+ if(NOT TARGET Catch2::Catch2)
+ message(FATAL_ERROR "Found Catch2 at ${Catch2_DIR} but targets are missing.")
+ endif()
+ message(STATUS "Found Catch2")
+ target_link_libraries(catch_main PUBLIC Catch2::Catch2)
+else()
+ message(STATUS "Downloading Catch2")
+
+ # FetchContent would be better, but requires newer CMake.
+ file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/catch2")
+ set(url https://github.com/philsquared/Catch/releases/download/v2.13.7/catch.hpp)
+ file(
+ DOWNLOAD ${url} "${CMAKE_CURRENT_BINARY_DIR}/catch2/catch.hpp"
+ STATUS status
+ EXPECTED_HASH SHA256=ea379c4a3cb5799027b1eb451163dff065a3d641aaba23bf4e24ee6b536bd9bc)
+ list(GET status 0 error)
+ if(error)
+ message(FATAL_ERROR "Could not download ${url}, and Catch2 not found on your system.")
+ endif()
+ target_include_directories(catch_main PUBLIC "${CMAKE_CURRENT_BINARY_DIR}")
endif()
-target_include_directories(catch_main PUBLIC "${CMAKE_CURRENT_BINARY_DIR}")
# Target must already exist
macro(add_catch_test TESTNAME)
@@ -174,8 +184,6 @@ file(WRITE "${PROJECT_BINARY_DIR}/CTestCustom.cmake"
target_compile_definitions(informational PRIVATE ${boost-optional-def})
target_compile_definitions(OptionalTest PRIVATE ${boost-optional-def})
-message(STATUS "Boost libs=${Boost_INCLUDE_DIRS}")
-
if(TARGET Boost::boost)
message(STATUS "including boost target")
target_link_libraries(informational PRIVATE Boost::boost)
@@ -185,6 +193,7 @@ if(TARGET Boost::boost)
target_link_libraries(OptionalTest_Single PRIVATE Boost::boost)
target_link_libraries(BoostOptionTypeTest_Single PRIVATE Boost::boost)
endif()
+ message(STATUS "Boost libs=${Boost_INCLUDE_DIRS}")
elseif(BOOST_FOUND)
message(STATUS "no boost target")
target_include_directories(informational PRIVATE ${Boost_INCLUDE_DIRS})
@@ -194,6 +203,9 @@ elseif(BOOST_FOUND)
target_include_directories(OptionalTest_Single PRIVATE ${Boost_INCLUDE_DIRS})
target_include_directories(BoostOptionTypeTest_Single PRIVATE ${Boost_INCLUDE_DIRS})
endif()
+ message(STATUS "Boost libs=${Boost_INCLUDE_DIRS}")
+else()
+ message(STATUS "Boost not found, not adding boost tests")
endif()
if(CMAKE_BUILD_TYPE STREQUAL Coverage)
diff --git a/packages/CLI11/tests/OptionalTest.cpp b/packages/CLI11/tests/OptionalTest.cpp
index 6b07f01c7..5ea20be9d 100644
--- a/packages/CLI11/tests/OptionalTest.cpp
+++ b/packages/CLI11/tests/OptionalTest.cpp
@@ -258,11 +258,13 @@ TEST_CASE_METHOD(TApp, "BoostOptionalVector", "[optional]") {
"-v,--vec", [&opt](const std::vector<int> &v) { opt = v; }, "some vector")
->expected(3);
run();
- CHECK(!opt);
+ bool checkOpt = static_cast<bool>(opt);
+ CHECK(!checkOpt);
args = {"-v", "1", "4", "5"};
run();
- CHECK(opt);
+ checkOpt = static_cast<bool>(opt);
+ CHECK(checkOpt);
std::vector<int> expV{1, 4, 5};
CHECK(expV == *opt);
}
@@ -272,14 +274,17 @@ TEST_CASE_METHOD(TApp, "BoostOptionalVectorEmpty", "[optional]") {
app.add_option<decltype(opt), std::vector<int>>("-v,--vec", opt)->expected(0, 3)->allow_extra_args();
// app.add_option("-v,--vec", opt)->expected(0, 3)->allow_extra_args();
run();
- CHECK(!opt);
+ bool checkOpt = static_cast<bool>(opt);
+ CHECK(!checkOpt);
args = {"-v"};
opt = std::vector<int>{4, 3};
run();
- CHECK(!opt);
+ checkOpt = static_cast<bool>(opt);
+ CHECK(!checkOpt);
args = {"-v", "1", "4", "5"};
run();
- CHECK(opt);
+ checkOpt = static_cast<bool>(opt);
+ CHECK(checkOpt);
std::vector<int> expV{1, 4, 5};
CHECK(expV == *opt);
}
@@ -289,14 +294,17 @@ TEST_CASE_METHOD(TApp, "BoostOptionalVectorEmptyDirect", "[optional]") {
app.add_option_no_stream("-v,--vec", opt)->expected(0, 3)->allow_extra_args();
// app.add_option("-v,--vec", opt)->expected(0, 3)->allow_extra_args();
run();
- CHECK(!opt);
+ bool checkOpt = static_cast<bool>(opt);
+ CHECK(!checkOpt);
args = {"-v"};
opt = std::vector<int>{4, 3};
run();
- CHECK(!opt);
+ checkOpt = static_cast<bool>(opt);
+ CHECK(!checkOpt);
args = {"-v", "1", "4", "5"};
run();
- CHECK(opt);
+ checkOpt = static_cast<bool>(opt);
+ CHECK(checkOpt);
std::vector<int> expV{1, 4, 5};
CHECK(expV == *opt);
}
diff --git a/packages/CLI11/tests/catch.hpp b/packages/CLI11/tests/catch.hpp
new file mode 100644
index 000000000..2aaeae76e
--- /dev/null
+++ b/packages/CLI11/tests/catch.hpp
@@ -0,0 +1,9 @@
+// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
+// under NSF AWARD 1414736 and by the respective contributors.
+// All rights reserved.
+//
+// SPDX-License-Identifier: BSD-3-Clause
+
+#pragma once
+
+#include <catch2/catch.hpp>
--
GitLab