pax_global_header00006660000000000000000000000064145650625300014520gustar00rootroot0000000000000052 comment=4bf61f08697b110d9e3991864650a405b3dd515d cxxopts-3.2.1/000077500000000000000000000000001456506253000132335ustar00rootroot00000000000000cxxopts-3.2.1/.clang-format000066400000000000000000000007101456506253000156040ustar00rootroot00000000000000--- Language: Cpp BasedOnStyle: LLVM AccessModifierOffset: 0 AlignConsecutiveAssignments: true AlwaysBreakAfterReturnType: TopLevel BreakBeforeBraces: Custom BraceWrapping: AfterEnum: true AfterClass: true AfterStruct: true AfterFunction: true AfterNamespace: true AfterControlStatement: Always BeforeElse: true ConstructorInitializerIndentWidth: 2 ContinuationIndentWidth: 2 PenaltyReturnTypeOnItsOwnLine: 200 PointerAlignment: Left cxxopts-3.2.1/.github/000077500000000000000000000000001456506253000145735ustar00rootroot00000000000000cxxopts-3.2.1/.github/workflows/000077500000000000000000000000001456506253000166305ustar00rootroot00000000000000cxxopts-3.2.1/.github/workflows/build.yml000066400000000000000000000006121456506253000204510ustar00rootroot00000000000000name: Build cxxopts on: push: branches: [ $default-branch ] pull_request: branches: [ $default-branch ] workflow_dispatch: jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: setup run: mkdir build; cd build - name: cmake run: cmake .. - name: Build run: make -j$(nproc) - name: test run: ctest cxxopts-3.2.1/.github/workflows/cifuzz.yml000066400000000000000000000011671456506253000206720ustar00rootroot00000000000000name: CIFuzz on: [pull_request] jobs: Fuzzing: runs-on: ubuntu-latest steps: - name: Build Fuzzers id: build uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: oss-fuzz-project-name: 'cxxopts' language: c++ - name: Run Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: oss-fuzz-project-name: 'cxxopts' language: c++ fuzz-seconds: 300 - name: Upload Crash uses: actions/upload-artifact@v3 if: failure() && steps.build.outcome == 'success' with: name: artifacts path: ./out/artifactscxxopts-3.2.1/.github/workflows/cmake.yml000066400000000000000000000041771456506253000204440ustar00rootroot00000000000000name: CMake on: push: branches: [ master, main ] pull_request: branches: [ master, main ] workflow_dispatch: env: # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) BUILD_TYPE: Release defaults: run: shell: bash jobs: build-ubuntu: strategy: matrix: os: [ ubuntu-20.04, ubuntu-22.04 ] compiler: [ g++-9, g++-10, clang++ ] name: Build and Test on Ubuntu runs-on: ${{matrix.os}} steps: - uses: actions/checkout@v3 - name: Configure CMake run: cmake -S "${{github.workspace}}" -B "${{github.workspace}}/build" -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_CXX_COMPILER=${{matrix.compiler}} - name: Build run: cmake --build "${{github.workspace}}/build" --config $BUILD_TYPE - name: Test working-directory: ${{github.workspace}}/build/test run: ctest -C $BUILD_TYPE --output-on-failure build-macos: name: Build and Test on MacOS strategy: matrix: os: [ macos-11, macos-12 ] runs-on: ${{matrix.os}} steps: - uses: actions/checkout@v3 - name: Configure CMake run: cmake -S "${{github.workspace}}" -B "${{github.workspace}}/build" -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_EXPORT_COMPILE_COMMANDS=ON - name: Show compile commands run: cat build/compile_commands.json - name: Build run: cmake --build "${{github.workspace}}/build" --config $BUILD_TYPE - name: Test working-directory: ${{github.workspace}}/build/test shell: bash run: ctest -C $BUILD_TYPE --output-on-failure build-windows: name: Build and Test on Windows runs-on: windows-latest steps: - uses: actions/checkout@v3 - uses: ilammy/msvc-dev-cmd@v1 - name: Configure CMake run: cmake -S "${{github.workspace}}" -B "${{github.workspace}}/build" -DCMAKE_BUILD_TYPE=$BUILD_TYPE -T "ClangCl" - name: Build run: cmake --build "${{github.workspace}}/build" --config $BUILD_TYPE - name: Test working-directory: ${{github.workspace}}/build/test run: cd $BUILD_TYPE && ./link_test && ./options_test cxxopts-3.2.1/.gitignore000066400000000000000000000013571456506253000152310ustar00rootroot00000000000000syntax: glob # Temporary, cache, swap files \#\#* *.swp *.bkp # Files which "ask" to be hidden *~ .* unused/ # Build artifacts *.a *.o *.so *.ptx bin/* lib/* build/ build-*/ bazel-* # Core dumps core core.* core-* # CMake & CTest-generated files CMakeCache.txt CMakeFiles/ cmake_install.cmake CMakeScripts/* CMakeTmp/* Makefile CTestTestfile.cmake Testing/ # Eclise IDE-related files .project .cproject .settings # CLion IDE-related files .idea/ cmake-build-*/ # Patching *.diff *.rej *.orig # Files/folders downloaded from other repositories as part of the build external/* third-party/* # Miscellaneous tags log *.log *.v3breakpoints gmon.out .DS_Store # Doxygen doxygen.log Doxyfile docs/ # Archives *.zip *.gz *.bz2 *.tgz *.tar *.xz cxxopts-3.2.1/.tipi/000077500000000000000000000000001456506253000142565ustar00rootroot00000000000000cxxopts-3.2.1/.tipi/deps000066400000000000000000000000031456506253000151250ustar00rootroot00000000000000{ }cxxopts-3.2.1/.tipi/opts000066400000000000000000000000011456506253000151550ustar00rootroot00000000000000 cxxopts-3.2.1/.travis.yml000066400000000000000000000046751456506253000153600ustar00rootroot00000000000000sudo: required dist: trusty language: cpp os: - linux matrix: include: - os: linux env: COMPILER=g++-6 addons: apt: packages: - g++-6 sources: &sources - llvm-toolchain-trusty-3.8 - llvm-toolchain-trusty-5.0 - ubuntu-toolchain-r-test - os: linux env: COMPILER=g++-6 UNICODE_OPTIONS=-DCXXOPTS_USE_UNICODE_HELP=Yes addons: apt: packages: - g++-6 sources: *sources - os: linux env: COMPILER=g++-7 addons: apt: packages: - g++-7 sources: *sources - os: linux env: COMPILER=g++-7 UNICODE_OPTIONS=-DCXXOPTS_USE_UNICODE_HELP=Yes addons: apt: packages: - g++-7 sources: *sources - os: linux env: COMPILER=g++-5 addons: apt: packages: - g++-5 sources: *sources - os: linux env: COMPILER=g++-5 UNICODE_OPTIONS=-DCXXOPTS_USE_UNICODE_HELP=Yes addons: apt: packages: - g++-5 sources: *sources - os: linux env: COMPILER=g++-4.8 addons: apt: packages: - g++-4.8 sources: *sources - os: linux env: COMPILER=g++-4.8 UNICODE_OPTIONS=-DCXXOPTS_USE_UNICODE_HELP=Yes addons: apt: packages: - g++-4.8 sources: *sources - os: linux env: COMPILER=clang++-3.8 CXXFLAGS=-stdlib=libc++ addons: apt: packages: - clang-3.8 - libc++-dev sources: *sources - os: linux env: COMPILER=clang++-3.8 CXXFLAGS=-stdlib=libc++ UNICODE_OPTIONS=-DCXXOPTS_USE_UNICODE_HELP=Yes addons: apt: packages: - clang-3.8 - libc++-dev sources: *sources - os: linux env: COMPILER=clang++-5.0 CMAKE_OPTIONS=-DCXXOPTS_CXX_STANDARD=17 addons: apt: packages: - clang-5.0 - g++-5 sources: *sources script: > cmake -Werror=dev -DCXXOPTS_BUILD_TESTS=ON -DCMAKE_CXX_COMPILER=$COMPILER -DCMAKE_CXX_FLAGS=$CXXFLAGS $UNICODE_OPTIONS $CMAKE_OPTIONS . && make && make ARGS=--output-on-failure test before_install: - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update ; fi - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install icu4c; fi cxxopts-3.2.1/BUILD.bazel000066400000000000000000000005521456506253000151130ustar00rootroot00000000000000load("@rules_cc//cc:defs.bzl", "cc_library") cc_library( name = "cxxopts", hdrs = ["include/cxxopts.hpp"], strip_include_prefix = "include", visibility = ["//visibility:public"], ) load("@rules_fuzzing//fuzzing:cc_defs.bzl", "cc_fuzz_test") cc_fuzz_test( name = "cxxopts_fuzz_test", srcs = ["test/fuzz.cpp"], deps = [":cxxopts"], )cxxopts-3.2.1/CHANGELOG.md000066400000000000000000000112731456506253000150500ustar00rootroot00000000000000# Changelog This is the changelog for `cxxopts`, a C++11 library for parsing command line options. The project adheres to semantic versioning. ## 3.2.1 ### Bug fixes * Fix compilation with optional on C++20. ## 3.2 ### Bug fixes * Fix unannotated fallthrough. * Fix sign conversion with Unicode output. * Don't initialize regex in static initialiser. * Fix incorrect integer overflow checks. ### Added * Add fuzzing to CI ### Changed * Change quote output to '' to match Windows. * Don't split positional arguments by the list delimiter. * Order help groups by the order they were added. ## 3.1.1 ### Bug Fixes * Fixed version number in header. * Fixed cast warning in Unicode function. ## 3.1 ### Added * Support for multiple long names for the same option (= multiple long aliases) * Add a `program()` function to retrieve the program name. * Added a .clang-format file. * Added iterator and printing for a ParseResult. ### Changed * Cleanup exception code, add cxxopts::exceptions namespace. * Renamed several exceptions to be more descriptive, and added to a nested namespace. ### Bug Fixes * Fix `arguments()` having no key for options that only have a short name. ## 3.0 ### Changed * Only search for a C++ compiler in CMakeLists.txt. * Allow for exceptions to be disabled. * Fix duplicate default options when there is a short and long option. * Add `CXXOPTS_NO_EXCEPTIONS` to disable exceptions. * Fix char parsing for space and check for length. * Change argument type in `Options::parse` from `char**` to `const char**`. * Refactor parser to not change its arguments. * `ParseResult` doesn't depend on a reference to the parser. * Fixed several warnings and code quality issues. * Improved formatting for help descriptions. * Improve integer parsing. ### Added * A list of unmatched arguments is available in `ParseResult`. * Support single letter options with argument attached. * Use if it is present. ### Bug Fixes * Fix missing option name in exception. ## 2.2 ### Changed * Allow integers to have leading zeroes. * Build the tests by default. * Don't check for container when showing positional help. ### Added * Iterator inputs to `parse_positional`. * Throw an exception if the option in `parse_positional` doesn't exist. * Parse a delimited list in a single argument for vector options. * Add an option to disable implicit value on booleans. ### Bug Fixes * Fix a warning about possible loss of data. * Fix version numbering in CMakeLists.txt * Remove unused declaration of the undefined `ParseResult::get_option`. * Throw on invalid option syntax when beginning with a `-`. * Throw in `as` when option wasn't present. * Fix catching exceptions by reference. * Fix out of bounds errors parsing integers. ## 2.1.1 ### Bug Fixes * Revert the change adding `const` type for `argv`, because most users expect to pass a non-const `argv` from `main`. ## 2.1 ### Changed * Options with implicit arguments now require the `--option=value` form if they are to be specified with an option. This is to remove the ambiguity when a positional argument could follow an option with an implicit value. For example, `--foo value`, where `foo` has an implicit value, will be parsed as `--foo=implicit` and a positional argument `value`. * Boolean values are no longer special, but are just an option with a default and implicit value. ### Added * Added support for `std::optional` as a storage type. * Allow the help string to be customised. * Use `const` for the type in the `argv` parameter, since the contents of the arguments is never modified. ### Bug Fixes * Building against GCC 4.9 was broken due to overly strict shadow warnings. * Fixed an ambiguous overload in the `parse_positional` function when an `initializer_list` was directly passed. * Fixed precedence in the Boolean value regex. ## 2.0 ### Changed * `Options::parse` returns a ParseResult rather than storing the parse result internally. * Options with default values now get counted as appearing once if they were not specified by the user. ### Added * A new `ParseResult` object that is the immutable result of parsing. It responds to the same `count` and `operator[]` as `Options` of 1.x did. * The function `ParseResult::arguments` returns a vector of the parsed arguments to iterate through in the order they were provided. * The symbol `cxxopts::version` for the version of the library. * Booleans can be specified with various strings and explicitly set false. ## 1.x The 1.x series was the first major version of the library, with release numbers starting to follow semantic versioning, after 0.x being unstable. It never had a changelog maintained for it. Releases mostly contained bug fixes, with the occasional feature added. cxxopts-3.2.1/CMakeLists.txt000066400000000000000000000056641456506253000160060ustar00rootroot00000000000000# Copyright (c) 2014 Jarryd Beck # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. cmake_minimum_required(VERSION 3.1...3.19) list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/") include(cxxopts) set("PROJECT_DESCRIPTION" "A header-only lightweight C++ command line option parser") set("PROJECT_HOMEPAGE_URL" "https://github.com/jarro2783/cxxopts") # Get the version of the library cxxopts_getversion(VERSION) project(cxxopts VERSION "${VERSION}" LANGUAGES CXX ) # Must include after the project call due to GNUInstallDirs requiring a language be enabled (IE. CXX) include(GNUInstallDirs) # Determine whether this is a standalone project or included by other projects set(CXXOPTS_STANDALONE_PROJECT OFF) if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) set(CXXOPTS_STANDALONE_PROJECT ON) endif() # Establish the project options option(CXXOPTS_BUILD_EXAMPLES "Set to ON to build examples" ${CXXOPTS_STANDALONE_PROJECT}) option(CXXOPTS_BUILD_TESTS "Set to ON to build tests" ${CXXOPTS_STANDALONE_PROJECT}) option(CXXOPTS_ENABLE_INSTALL "Generate the install target" ${CXXOPTS_STANDALONE_PROJECT}) option(CXXOPTS_ENABLE_WARNINGS "Add warnings to CMAKE_CXX_FLAGS" ${CXXOPTS_STANDALONE_PROJECT}) option(CXXOPTS_USE_UNICODE_HELP "Use ICU Unicode library" OFF) if (CXXOPTS_STANDALONE_PROJECT) cxxopts_set_cxx_standard() endif() if (CXXOPTS_ENABLE_WARNINGS) cxxopts_enable_warnings() endif() add_library(cxxopts INTERFACE) add_library(cxxopts::cxxopts ALIAS cxxopts) add_subdirectory(include) # Link against the ICU library when requested if(CXXOPTS_USE_UNICODE_HELP) cxxopts_use_unicode() endif() # Install cxxopts when requested by the user if (CXXOPTS_ENABLE_INSTALL) cxxopts_install_logic() endif() # Build examples when requested by the user if (CXXOPTS_BUILD_EXAMPLES) add_subdirectory(src) endif() # Enable testing when requested by the user if (CXXOPTS_BUILD_TESTS) enable_testing() add_subdirectory(test) endif() cxxopts-3.2.1/INSTALL000066400000000000000000000023201456506253000142610ustar00rootroot00000000000000== System installation == This library is header only. So you can either copy `include/cxxopts.hpp` to `/usr/include` or `/usr/local/include`, or add `include` to your search path. == Building the examples and tests == It is preferable to build out of source. Make a build directory somewhere, and then do the following, where `${CXXOPTS_DIR}` is the path that you checked out `cxxopts` to: cmake ${CXXOPTS_DIR} make You can use another build tool, such as ninja. cmake -G Ninja ${CXXOPTS_DIR} ninja To run the tests, you have to configure `cxxopts` with another flag: cmake -D CXXOPTS_BUILD_TESTS=On ${CXXOPTS_DIR} make make test == Using cxxopts in tipi.build projects == `cxxopts` can be easily used in [tipi.build](https://tipi.build) projects simply by adding the following entry to your `.tipi/deps`: ```json { "jarro2783/cxxopts": { "@": "v3.0.0" } } ``` To try this you can run the following command in `/src` (change the target name appropriately to `linux` or `macos` or `windows`): ```bash tipi . -t ./build/linux-cxx17/bin/test_package -v ``` To develop `cxxopts` using tipi run the following command at the root of the repository: ```bash tipi . -t --test all -v ``` cxxopts-3.2.1/LICENSE000066400000000000000000000020371456506253000142420ustar00rootroot00000000000000Copyright (c) 2014 Jarryd Beck Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cxxopts-3.2.1/README.md000066400000000000000000000203001456506253000145050ustar00rootroot00000000000000[![Build Status](https://travis-ci.org/jarro2783/cxxopts.svg?branch=master)](https://travis-ci.org/jarro2783/cxxopts) # Release versions Note that `master` is generally a work in progress, and you probably want to use a tagged release version. ## Version 3 breaking changes If you have used version 2, there are a couple of breaking changes in version 3 that you should be aware of. If you are new to `cxxopts` you can skip this section. The parser no longer modifies its arguments, so you can pass a const `argc` and `argv` and expect them not to be changed. The `ParseResult` object no longer depends on the parser. So it can be returned from a scope outside the parser and still work. Now that the inputs are not modified, `ParseResult` stores a list of the unmatched arguments. These are retrieved like follows: ```cpp auto result = options.parse(argc, argv); result.unmatched(); // get the unmatched arguments ``` # Quick start This is a lightweight C++ option parser library, supporting the standard GNU style syntax for options. Options can be given as: --long --long=argument --long argument -a -ab -abc argument where c takes an argument, but a and b do not. Additionally, anything after `--` will be parsed as a positional argument. ## Basics ```cpp #include ``` Create a `cxxopts::Options` instance. ```cpp cxxopts::Options options("MyProgram", "One line description of MyProgram"); ``` Then use `add_options`. ```cpp options.add_options() ("d,debug", "Enable debugging") // a bool parameter ("i,integer", "Int param", cxxopts::value()) ("f,file", "File name", cxxopts::value()) ("v,verbose", "Verbose output", cxxopts::value()->default_value("false")) ; ``` Options are declared with a long and an optional short option. A description must be provided. The third argument is the value, if omitted it is boolean. Any type can be given as long as it can be parsed, with operator>>. To parse the command line do: ```cpp auto result = options.parse(argc, argv); ``` To retrieve an option use `result.count("option")` to get the number of times it appeared, and ```cpp result["opt"].as() ``` to get its value. If "opt" doesn't exist, or isn't of the right type, then an exception will be thrown. ## Unrecognised arguments You can allow unrecognised arguments to be skipped. This applies to both positional arguments that are not parsed into another option, and `--` arguments that do not match an argument that you specify. This is done by calling: ```cpp options.allow_unrecognised_options(); ``` and in the result object they are retrieved with: ```cpp result.unmatched() ``` ## Exceptions Exceptional situations throw C++ exceptions. There are two types of exceptions: errors defining the options, and errors when parsing a list of arguments. All exceptions derive from `cxxopts::exceptions::exception`. Errors defining options derive from `cxxopts::exceptions::specification` and errors parsing arguments derive from `cxxopts::exceptions::parsing`. All exceptions define a `what()` function to get a printable string explaining the error. ## Help groups Options can be placed into groups for the purposes of displaying help messages. To place options in a group, pass the group as a string to `add_options`. Then, when displaying the help, pass the groups that you would like displayed as a vector to the `help` function. ## Positional Arguments Positional arguments are those given without a preceding flag and can be used alongside non-positional arguments. There may be multiple positional arguments, and the final positional argument may be a container type to hold a list of all remaining positionals. To set up positional arguments, first declare the options, then configure a set of those arguments as positional like: ```cpp options.add_options() ("script", "The script file to execute", cxxopts::value()) ("server", "The server to execute on", cxxopts::value()) ("filenames", "The filename(s) to process", cxxopts::value>()); options.parse_positional({"script", "server", "filenames"}); // Parse options the usual way options.parse(argc, argv); ``` For example, parsing the following arguments: ~~~ my_script.py my_server.com file1.txt file2.txt file3.txt ~~~ will result in parsed arguments like the following table: | Field | Value | | ------------- | ----------------------------------------- | | `"script"` | `"my_script.py"` | | `"server"` | `"my_server.com"` | | `"filenames"` | `{"file1.txt", "file2.txt", "file3.txt"}` | ## Default and implicit values An option can be declared with a default or an implicit value, or both. A default value is the value that an option takes when it is not specified on the command line. The following specifies a default value for an option: ```cpp cxxopts::value()->default_value("value") ``` An implicit value is the value that an option takes when it is given on the command line without an argument. The following specifies an implicit value: ```cpp cxxopts::value()->implicit_value("implicit") ``` If an option had both, then not specifying it would give the value `"value"`, writing it on the command line as `--option` would give the value `"implicit"`, and writing `--option=another` would give it the value `"another"`. Note that the default and implicit value is always stored as a string, regardless of the type that you want to store it in. It will be parsed as though it was given on the command line. Default values are not counted by `Options::count`. ## Boolean values Boolean options have a default implicit value of `"true"`, which can be overridden. The effect is that writing `-o` by itself will set option `o` to `true`. However, they can also be written with various strings using `=value`. There is no way to disambiguate positional arguments from the value following a boolean, so we have chosen that they will be positional arguments, and therefore, `-o false` does not work. ## `std::vector` values Parsing a list of values into a `std::vector` is also supported, as long as `T` can be parsed. To separate single values in a list the define symbol `CXXOPTS_VECTOR_DELIMITER` is used, which is ',' by default. Ensure that you use no whitespaces between values because those would be interpreted as the next command line option. Example for a command line option that can be parsed as a `std::vector`: ~~~ --my_list=1,-2.1,3,4.5 ~~~ ## Options specified multiple times The same option can be specified several times, with different arguments, which will all be recorded in order of appearance. An example: ~~~ --use train --use bus --use ferry ~~~ this is supported through the use of a vector of value for the option: ~~~ options.add_options() ("use", "Usable means of transport", cxxopts::value>()) ~~~ ## Custom help The string after the program name on the first line of the help can be completely replaced by calling `options.custom_help`. Note that you might also want to override the positional help by calling `options.positional_help`. ## Example Putting all together: ```cpp int main(int argc, char** argv) { cxxopts::Options options("test", "A brief description"); options.add_options() ("b,bar", "Param bar", cxxopts::value()) ("d,debug", "Enable debugging", cxxopts::value()->default_value("false")) ("f,foo", "Param foo", cxxopts::value()->default_value("10")) ("h,help", "Print usage") ; auto result = options.parse(argc, argv); if (result.count("help")) { std::cout << options.help() << std::endl; exit(0); } bool debug = result["debug"].as(); std::string bar; if (result.count("bar")) bar = result["bar"].as(); int foo = result["foo"].as(); return 0; } ``` # Linking This is a header only library. # Requirements The only build requirement is a C++ compiler that supports C++11 features such as: * regex * constexpr * default constructors GCC >= 4.9 or clang >= 3.1 with libc++ are known to work. The following compilers are known not to work: * MSVC 2013 cxxopts-3.2.1/WORKSPACE000066400000000000000000000010001456506253000145030ustar00rootroot00000000000000load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "rules_fuzzing", sha256 = "d9002dd3cd6437017f08593124fdd1b13b3473c7b929ceb0e60d317cb9346118", strip_prefix = "rules_fuzzing-0.3.2", urls = ["https://github.com/bazelbuild/rules_fuzzing/archive/v0.3.2.zip"], ) load("@rules_fuzzing//fuzzing:repositories.bzl", "rules_fuzzing_dependencies") rules_fuzzing_dependencies() load("@rules_fuzzing//fuzzing:init.bzl", "rules_fuzzing_init") rules_fuzzing_init() cxxopts-3.2.1/cmake/000077500000000000000000000000001456506253000143135ustar00rootroot00000000000000cxxopts-3.2.1/cmake/cxxopts.cmake000066400000000000000000000157341456506253000170370ustar00rootroot00000000000000# Copyright (c) 2014 Jarryd Beck # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. if (CMAKE_VERSION VERSION_GREATER 3.10 OR CMAKE_VERSION VERSION_EQUAL 3.10) # Use include_guard() added in cmake 3.10 include_guard() endif() include(CMakePackageConfigHelpers) function(cxxopts_getversion version_arg) # Parse the current version from the cxxopts header file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/include/cxxopts.hpp" cxxopts_version_defines REGEX "#define CXXOPTS__VERSION_(MAJOR|MINOR|PATCH)") foreach(ver ${cxxopts_version_defines}) if(ver MATCHES "#define CXXOPTS__VERSION_(MAJOR|MINOR|PATCH) +([^ ]+)$") set(CXXOPTS__VERSION_${CMAKE_MATCH_1} "${CMAKE_MATCH_2}" CACHE INTERNAL "") endif() endforeach() set(VERSION ${CXXOPTS__VERSION_MAJOR}.${CXXOPTS__VERSION_MINOR}.${CXXOPTS__VERSION_PATCH}) # Give feedback to the user. Prefer DEBUG when available since large projects tend to have a lot # going on already if (CMAKE_VERSION VERSION_GREATER 3.15 OR CMAKE_VERSION VERSION_EQUAL 3.15) message(DEBUG "cxxopts version ${VERSION}") else() message(STATUS "cxxopts version ${VERSION}") endif() # Return the information to the caller set(${version_arg} ${VERSION} PARENT_SCOPE) endfunction() # Optionally, enable unicode support using the ICU library function(cxxopts_use_unicode) find_package(PkgConfig) pkg_check_modules(ICU REQUIRED icu-uc) target_link_libraries(cxxopts INTERFACE ${ICU_LDFLAGS}) target_compile_options(cxxopts INTERFACE ${ICU_CFLAGS}) target_compile_definitions(cxxopts INTERFACE CXXOPTS_USE_UNICODE) endfunction() # Request C++11 without gnu extension for the whole project and enable more warnings macro(cxxopts_set_cxx_standard) if (CXXOPTS_CXX_STANDARD) set(CMAKE_CXX_STANDARD ${CXXOPTS_CXX_STANDARD}) else() set(CMAKE_CXX_STANDARD 11) endif() set(CMAKE_CXX_EXTENSIONS OFF) endmacro() # Helper function to enable warnings function(cxxopts_enable_warnings) if(MSVC) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W2") elseif(CMAKE_CXX_COMPILER_ID MATCHES "[Cc]lang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU") if (CMAKE_CXX_COMPILER_ID MATCHES "GNU") if (${CMAKE_CXX_COMPILER_VERSION} VERSION_GREATER_EQUAL 5.0) set(COMPILER_SPECIFIC_FLAGS "-Wsuggest-override") endif() endif() set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Werror -Wextra -Wshadow -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings -Wpointer-arith -Winit-self -Wconversion -Wno-sign-conversion ${COMPILER_SPECIFIC_FLAGS}") endif() set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} PARENT_SCOPE) endfunction() # Helper function to ecapsulate install logic function(cxxopts_install_logic) if(CMAKE_LIBRARY_ARCHITECTURE) string(REPLACE "/${CMAKE_LIBRARY_ARCHITECTURE}" "" CMAKE_INSTALL_LIBDIR_ARCHIND "${CMAKE_INSTALL_LIBDIR}") else() # On some systems (e.g. NixOS), `CMAKE_LIBRARY_ARCHITECTURE` can be empty set(CMAKE_INSTALL_LIBDIR_ARCHIND "${CMAKE_INSTALL_LIBDIR}") endif() set(CXXOPTS_CMAKE_DIR "${CMAKE_INSTALL_LIBDIR_ARCHIND}/cmake/cxxopts" CACHE STRING "Installation directory for cmake files, relative to ${CMAKE_INSTALL_PREFIX}.") set(version_config "${PROJECT_BINARY_DIR}/cxxopts-config-version.cmake") set(project_config "${PROJECT_BINARY_DIR}/cxxopts-config.cmake") set(targets_export_name cxxopts-targets) set(PackagingTemplatesDir "${PROJECT_SOURCE_DIR}/packaging") if(${CMAKE_VERSION} VERSION_GREATER "3.14") set(OPTIONAL_ARCH_INDEPENDENT "ARCH_INDEPENDENT") endif() # Generate the version, config and target files into the build directory. write_basic_package_version_file( ${version_config} VERSION ${VERSION} COMPATIBILITY AnyNewerVersion ${OPTIONAL_ARCH_INDEPENDENT} ) configure_package_config_file( ${PackagingTemplatesDir}/cxxopts-config.cmake.in ${project_config} INSTALL_DESTINATION ${CXXOPTS_CMAKE_DIR}) export(TARGETS cxxopts NAMESPACE cxxopts:: FILE ${PROJECT_BINARY_DIR}/${targets_export_name}.cmake) # Install version, config and target files. install( FILES ${project_config} ${version_config} DESTINATION ${CXXOPTS_CMAKE_DIR}) install(EXPORT ${targets_export_name} DESTINATION ${CXXOPTS_CMAKE_DIR} NAMESPACE cxxopts::) # Install the header file and export the target install(TARGETS cxxopts EXPORT ${targets_export_name} DESTINATION ${CMAKE_INSTALL_LIBDIR}) install(FILES ${PROJECT_SOURCE_DIR}/include/cxxopts.hpp DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) set(CPACK_PACKAGE_NAME "${PROJECT_NAME}") set(CPACK_PACKAGE_VENDOR "cxxopt developers") set(CPACK_PACKAGE_DESCRIPTION "${PROJECT_DESCRIPTION}") set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") set(CPACK_RPM_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") set(CPACK_PACKAGE_HOMEPAGE_URL "${PROJECT_HOMEPAGE_URL}") set(CPACK_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}") set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${CPACK_PACKAGE_MAINTAINER}") set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE") set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md") set(CPACK_DEBIAN_PACKAGE_NAME "lib${PROJECT_NAME}-dev") set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6-dev") set(CPACK_DEBIAN_PACKAGE_SUGGESTS "cmake, pkg-config, pkg-conf") set(CPACK_RPM_PACKAGE_NAME "lib${PROJECT_NAME}-devel") set(CPACK_RPM_PACKAGE_SUGGESTS "${CPACK_DEBIAN_PACKAGE_SUGGESTS}") set(CPACK_DEB_COMPONENT_INSTALL ON) set(CPACK_RPM_COMPONENT_INSTALL ON) set(CPACK_NSIS_COMPONENT_INSTALL ON) set(CPACK_DEBIAN_COMPRESSION_TYPE "xz") set(PKG_CONFIG_FILE_NAME "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc") configure_file("${PackagingTemplatesDir}/pkgconfig.pc.in" "${PKG_CONFIG_FILE_NAME}" @ONLY) install(FILES "${PKG_CONFIG_FILE_NAME}" DESTINATION "${CMAKE_INSTALL_LIBDIR_ARCHIND}/pkgconfig" ) include(CPack) endfunction() cxxopts-3.2.1/include/000077500000000000000000000000001456506253000146565ustar00rootroot00000000000000cxxopts-3.2.1/include/CMakeLists.txt000066400000000000000000000023051456506253000174160ustar00rootroot00000000000000# Copyright (c) 2014 Jarryd Beck # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. target_include_directories(cxxopts INTERFACE $ $ ) cxxopts-3.2.1/include/cxxopts.hpp000066400000000000000000001624651456506253000171150ustar00rootroot00000000000000/* Copyright (c) 2014-2022 Jarryd Beck Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ // vim: ts=2:sw=2:expandtab #ifndef CXXOPTS_HPP_INCLUDED #define CXXOPTS_HPP_INCLUDED #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef CXXOPTS_NO_EXCEPTIONS #include #endif #if defined(__GNUC__) && !defined(__clang__) # if (__GNUC__ * 10 + __GNUC_MINOR__) < 49 # define CXXOPTS_NO_REGEX true # endif #endif #if defined(_MSC_VER) && !defined(__clang__) #define CXXOPTS_LINKONCE_CONST __declspec(selectany) extern #define CXXOPTS_LINKONCE __declspec(selectany) extern #else #define CXXOPTS_LINKONCE_CONST #define CXXOPTS_LINKONCE #endif #ifndef CXXOPTS_NO_REGEX # include #endif // CXXOPTS_NO_REGEX // Nonstandard before C++17, which is coincidentally what we also need for #ifdef __has_include # if __has_include() # include # ifdef __cpp_lib_optional # define CXXOPTS_HAS_OPTIONAL # endif # endif #endif #define CXXOPTS_FALLTHROUGH #ifdef __has_cpp_attribute #if __has_cpp_attribute(fallthrough) #undef CXXOPTS_FALLTHROUGH #define CXXOPTS_FALLTHROUGH [[fallthrough]] #endif #endif #if __cplusplus >= 201603L #define CXXOPTS_NODISCARD [[nodiscard]] #else #define CXXOPTS_NODISCARD #endif #ifndef CXXOPTS_VECTOR_DELIMITER #define CXXOPTS_VECTOR_DELIMITER ',' #endif #define CXXOPTS__VERSION_MAJOR 3 #define CXXOPTS__VERSION_MINOR 2 #define CXXOPTS__VERSION_PATCH 1 #if (__GNUC__ < 10 || (__GNUC__ == 10 && __GNUC_MINOR__ < 1)) && __GNUC__ >= 6 #define CXXOPTS_NULL_DEREF_IGNORE #endif #if defined(__GNUC__) #define DO_PRAGMA(x) _Pragma(#x) #define CXXOPTS_DIAGNOSTIC_PUSH DO_PRAGMA(GCC diagnostic push) #define CXXOPTS_DIAGNOSTIC_POP DO_PRAGMA(GCC diagnostic pop) #define CXXOPTS_IGNORE_WARNING(x) DO_PRAGMA(GCC diagnostic ignored x) #else // define other compilers here if needed #define CXXOPTS_DIAGNOSTIC_PUSH #define CXXOPTS_DIAGNOSTIC_POP #define CXXOPTS_IGNORE_WARNING(x) #endif #ifdef CXXOPTS_NO_RTTI #define CXXOPTS_RTTI_CAST static_cast #else #define CXXOPTS_RTTI_CAST dynamic_cast #endif namespace cxxopts { static constexpr struct { uint8_t major, minor, patch; } version = { CXXOPTS__VERSION_MAJOR, CXXOPTS__VERSION_MINOR, CXXOPTS__VERSION_PATCH }; } // namespace cxxopts //when we ask cxxopts to use Unicode, help strings are processed using ICU, //which results in the correct lengths being computed for strings when they //are formatted for the help output //it is necessary to make sure that can be found by the //compiler, and that icu-uc is linked in to the binary. #ifdef CXXOPTS_USE_UNICODE #include namespace cxxopts { using String = icu::UnicodeString; inline String toLocalString(std::string s) { return icu::UnicodeString::fromUTF8(std::move(s)); } // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we want to silence it: // warning: base class 'class std::enable_shared_from_this' has accessible non-virtual destructor CXXOPTS_DIAGNOSTIC_PUSH CXXOPTS_IGNORE_WARNING("-Wnon-virtual-dtor") // This will be ignored under other compilers like LLVM clang. class UnicodeStringIterator { public: using iterator_category = std::forward_iterator_tag; using value_type = int32_t; using difference_type = std::ptrdiff_t; using pointer = value_type*; using reference = value_type&; UnicodeStringIterator(const icu::UnicodeString* string, int32_t pos) : s(string) , i(pos) { } value_type operator*() const { return s->char32At(i); } bool operator==(const UnicodeStringIterator& rhs) const { return s == rhs.s && i == rhs.i; } bool operator!=(const UnicodeStringIterator& rhs) const { return !(*this == rhs); } UnicodeStringIterator& operator++() { ++i; return *this; } UnicodeStringIterator operator+(int32_t v) { return UnicodeStringIterator(s, i + v); } private: const icu::UnicodeString* s; int32_t i; }; CXXOPTS_DIAGNOSTIC_POP inline String& stringAppend(String&s, String a) { return s.append(std::move(a)); } inline String& stringAppend(String& s, std::size_t n, UChar32 c) { for (std::size_t i = 0; i != n; ++i) { s.append(c); } return s; } template String& stringAppend(String& s, Iterator begin, Iterator end) { while (begin != end) { s.append(*begin); ++begin; } return s; } inline size_t stringLength(const String& s) { return static_cast(s.length()); } inline std::string toUTF8String(const String& s) { std::string result; s.toUTF8String(result); return result; } inline bool empty(const String& s) { return s.isEmpty(); } } // namespace cxxopts namespace std { inline cxxopts::UnicodeStringIterator begin(const icu::UnicodeString& s) { return cxxopts::UnicodeStringIterator(&s, 0); } inline cxxopts::UnicodeStringIterator end(const icu::UnicodeString& s) { return cxxopts::UnicodeStringIterator(&s, s.length()); } } // namespace std //ifdef CXXOPTS_USE_UNICODE #else namespace cxxopts { using String = std::string; template T toLocalString(T&& t) { return std::forward(t); } inline std::size_t stringLength(const String& s) { return s.length(); } inline String& stringAppend(String&s, const String& a) { return s.append(a); } inline String& stringAppend(String& s, std::size_t n, char c) { return s.append(n, c); } template String& stringAppend(String& s, Iterator begin, Iterator end) { return s.append(begin, end); } template std::string toUTF8String(T&& t) { return std::forward(t); } inline bool empty(const std::string& s) { return s.empty(); } } // namespace cxxopts //ifdef CXXOPTS_USE_UNICODE #endif namespace cxxopts { namespace { CXXOPTS_LINKONCE_CONST std::string LQUOTE("\'"); CXXOPTS_LINKONCE_CONST std::string RQUOTE("\'"); } // namespace // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we // want to silence it: warning: base class 'class // std::enable_shared_from_this' has accessible non-virtual // destructor This will be ignored under other compilers like LLVM clang. CXXOPTS_DIAGNOSTIC_PUSH CXXOPTS_IGNORE_WARNING("-Wnon-virtual-dtor") // some older versions of GCC warn under this warning CXXOPTS_IGNORE_WARNING("-Weffc++") class Value : public std::enable_shared_from_this { public: virtual ~Value() = default; virtual std::shared_ptr clone() const = 0; virtual void add(const std::string& text) const = 0; virtual void parse(const std::string& text) const = 0; virtual void parse() const = 0; virtual bool has_default() const = 0; virtual bool is_container() const = 0; virtual bool has_implicit() const = 0; virtual std::string get_default_value() const = 0; virtual std::string get_implicit_value() const = 0; virtual std::shared_ptr default_value(const std::string& value) = 0; virtual std::shared_ptr implicit_value(const std::string& value) = 0; virtual std::shared_ptr no_implicit_value() = 0; virtual bool is_boolean() const = 0; }; CXXOPTS_DIAGNOSTIC_POP namespace exceptions { class exception : public std::exception { public: explicit exception(std::string message) : m_message(std::move(message)) { } CXXOPTS_NODISCARD const char* what() const noexcept override { return m_message.c_str(); } private: std::string m_message; }; class specification : public exception { public: explicit specification(const std::string& message) : exception(message) { } }; class parsing : public exception { public: explicit parsing(const std::string& message) : exception(message) { } }; class option_already_exists : public specification { public: explicit option_already_exists(const std::string& option) : specification("Option " + LQUOTE + option + RQUOTE + " already exists") { } }; class invalid_option_format : public specification { public: explicit invalid_option_format(const std::string& format) : specification("Invalid option format " + LQUOTE + format + RQUOTE) { } }; class invalid_option_syntax : public parsing { public: explicit invalid_option_syntax(const std::string& text) : parsing("Argument " + LQUOTE + text + RQUOTE + " starts with a - but has incorrect syntax") { } }; class no_such_option : public parsing { public: explicit no_such_option(const std::string& option) : parsing("Option " + LQUOTE + option + RQUOTE + " does not exist") { } }; class missing_argument : public parsing { public: explicit missing_argument(const std::string& option) : parsing( "Option " + LQUOTE + option + RQUOTE + " is missing an argument" ) { } }; class option_requires_argument : public parsing { public: explicit option_requires_argument(const std::string& option) : parsing( "Option " + LQUOTE + option + RQUOTE + " requires an argument" ) { } }; class gratuitous_argument_for_option : public parsing { public: gratuitous_argument_for_option ( const std::string& option, const std::string& arg ) : parsing( "Option " + LQUOTE + option + RQUOTE + " does not take an argument, but argument " + LQUOTE + arg + RQUOTE + " given" ) { } }; class requested_option_not_present : public parsing { public: explicit requested_option_not_present(const std::string& option) : parsing("Option " + LQUOTE + option + RQUOTE + " not present") { } }; class option_has_no_value : public exception { public: explicit option_has_no_value(const std::string& option) : exception( !option.empty() ? ("Option " + LQUOTE + option + RQUOTE + " has no value") : "Option has no value") { } }; class incorrect_argument_type : public parsing { public: explicit incorrect_argument_type ( const std::string& arg ) : parsing( "Argument " + LQUOTE + arg + RQUOTE + " failed to parse" ) { } }; } // namespace exceptions template void throw_or_mimic(const std::string& text) { static_assert(std::is_base_of::value, "throw_or_mimic only works on std::exception and " "deriving classes"); #ifndef CXXOPTS_NO_EXCEPTIONS // If CXXOPTS_NO_EXCEPTIONS is not defined, just throw throw T{text}; #else // Otherwise manually instantiate the exception, print what() to stderr, // and exit T exception{text}; std::cerr << exception.what() << std::endl; std::exit(EXIT_FAILURE); #endif } using OptionNames = std::vector; namespace values { namespace parser_tool { struct IntegerDesc { std::string negative = ""; std::string base = ""; std::string value = ""; }; struct ArguDesc { std::string arg_name = ""; bool grouping = false; bool set_value = false; std::string value = ""; }; #ifdef CXXOPTS_NO_REGEX inline IntegerDesc SplitInteger(const std::string &text) { if (text.empty()) { throw_or_mimic(text); } IntegerDesc desc; const char *pdata = text.c_str(); if (*pdata == '-') { pdata += 1; desc.negative = "-"; } if (strncmp(pdata, "0x", 2) == 0) { pdata += 2; desc.base = "0x"; } if (*pdata != '\0') { desc.value = std::string(pdata); } else { throw_or_mimic(text); } return desc; } inline bool IsTrueText(const std::string &text) { const char *pdata = text.c_str(); if (*pdata == 't' || *pdata == 'T') { pdata += 1; if (strncmp(pdata, "rue\0", 4) == 0) { return true; } } else if (strncmp(pdata, "1\0", 2) == 0) { return true; } return false; } inline bool IsFalseText(const std::string &text) { const char *pdata = text.c_str(); if (*pdata == 'f' || *pdata == 'F') { pdata += 1; if (strncmp(pdata, "alse\0", 5) == 0) { return true; } } else if (strncmp(pdata, "0\0", 2) == 0) { return true; } return false; } inline OptionNames split_option_names(const std::string &text) { OptionNames split_names; std::string::size_type token_start_pos = 0; auto length = text.length(); if (length == 0) { throw_or_mimic(text); } while (token_start_pos < length) { const auto &npos = std::string::npos; auto next_non_space_pos = text.find_first_not_of(' ', token_start_pos); if (next_non_space_pos == npos) { throw_or_mimic(text); } token_start_pos = next_non_space_pos; auto next_delimiter_pos = text.find(',', token_start_pos); if (next_delimiter_pos == token_start_pos) { throw_or_mimic(text); } if (next_delimiter_pos == npos) { next_delimiter_pos = length; } auto token_length = next_delimiter_pos - token_start_pos; // validate the token itself matches the regex /([:alnum:][-_[:alnum:]]*/ { const char* option_name_valid_chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789" "_-.?"; if (!std::isalnum(text[token_start_pos], std::locale::classic()) || text.find_first_not_of(option_name_valid_chars, token_start_pos) < next_delimiter_pos) { throw_or_mimic(text); } } split_names.emplace_back(text.substr(token_start_pos, token_length)); token_start_pos = next_delimiter_pos + 1; } return split_names; } inline ArguDesc ParseArgument(const char *arg, bool &matched) { ArguDesc argu_desc; const char *pdata = arg; matched = false; if (strncmp(pdata, "--", 2) == 0) { pdata += 2; if (isalnum(*pdata, std::locale::classic())) { argu_desc.arg_name.push_back(*pdata); pdata += 1; while (isalnum(*pdata, std::locale::classic()) || *pdata == '-' || *pdata == '_') { argu_desc.arg_name.push_back(*pdata); pdata += 1; } if (argu_desc.arg_name.length() > 1) { if (*pdata == '=') { argu_desc.set_value = true; pdata += 1; if (*pdata != '\0') { argu_desc.value = std::string(pdata); } matched = true; } else if (*pdata == '\0') { matched = true; } } } } else if (strncmp(pdata, "-", 1) == 0) { pdata += 1; argu_desc.grouping = true; while (isalnum(*pdata, std::locale::classic())) { argu_desc.arg_name.push_back(*pdata); pdata += 1; } matched = !argu_desc.arg_name.empty() && *pdata == '\0'; } return argu_desc; } #else // CXXOPTS_NO_REGEX namespace { CXXOPTS_LINKONCE const char* const integer_pattern = "(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"; CXXOPTS_LINKONCE const char* const truthy_pattern = "(t|T)(rue)?|1"; CXXOPTS_LINKONCE const char* const falsy_pattern = "(f|F)(alse)?|0"; CXXOPTS_LINKONCE const char* const option_pattern = "--([[:alnum:]][-_[:alnum:]\\.]+)(=(.*))?|-([[:alnum:]].*)"; CXXOPTS_LINKONCE const char* const option_specifier_pattern = "([[:alnum:]][-_[:alnum:]\\.]*)(,[ ]*[[:alnum:]][-_[:alnum:]]*)*"; CXXOPTS_LINKONCE const char* const option_specifier_separator_pattern = ", *"; } // namespace inline IntegerDesc SplitInteger(const std::string &text) { static const std::basic_regex integer_matcher(integer_pattern); std::smatch match; std::regex_match(text, match, integer_matcher); if (match.length() == 0) { throw_or_mimic(text); } IntegerDesc desc; desc.negative = match[1]; desc.base = match[2]; desc.value = match[3]; if (match.length(4) > 0) { desc.base = match[5]; desc.value = "0"; return desc; } return desc; } inline bool IsTrueText(const std::string &text) { static const std::basic_regex truthy_matcher(truthy_pattern); std::smatch result; std::regex_match(text, result, truthy_matcher); return !result.empty(); } inline bool IsFalseText(const std::string &text) { static const std::basic_regex falsy_matcher(falsy_pattern); std::smatch result; std::regex_match(text, result, falsy_matcher); return !result.empty(); } // Gets the option names specified via a single, comma-separated string, // and returns the separate, space-discarded, non-empty names // (without considering which or how many are single-character) inline OptionNames split_option_names(const std::string &text) { static const std::basic_regex option_specifier_matcher(option_specifier_pattern); if (!std::regex_match(text.c_str(), option_specifier_matcher)) { throw_or_mimic(text); } OptionNames split_names; static const std::basic_regex option_specifier_separator_matcher(option_specifier_separator_pattern); constexpr int use_non_matches { -1 }; auto token_iterator = std::sregex_token_iterator( text.begin(), text.end(), option_specifier_separator_matcher, use_non_matches); std::copy(token_iterator, std::sregex_token_iterator(), std::back_inserter(split_names)); return split_names; } inline ArguDesc ParseArgument(const char *arg, bool &matched) { static const std::basic_regex option_matcher(option_pattern); std::match_results result; std::regex_match(arg, result, option_matcher); matched = !result.empty(); ArguDesc argu_desc; if (matched) { argu_desc.arg_name = result[1].str(); argu_desc.set_value = result[2].length() > 0; argu_desc.value = result[3].str(); if (result[4].length() > 0) { argu_desc.grouping = true; argu_desc.arg_name = result[4].str(); } } return argu_desc; } #endif // CXXOPTS_NO_REGEX #undef CXXOPTS_NO_REGEX } // namespace parser_tool namespace detail { template struct SignedCheck; template struct SignedCheck { template void operator()(bool negative, U u, const std::string& text) { if (negative) { if (u > static_cast((std::numeric_limits::min)())) { throw_or_mimic(text); } } else { if (u > static_cast((std::numeric_limits::max)())) { throw_or_mimic(text); } } } }; template struct SignedCheck { template void operator()(bool, U, const std::string&) const {} }; template void check_signed_range(bool negative, U value, const std::string& text) { SignedCheck::is_signed>()(negative, value, text); } } // namespace detail template void checked_negate(R& r, T&& t, const std::string&, std::true_type) { // if we got to here, then `t` is a positive number that fits into // `R`. So to avoid MSVC C4146, we first cast it to `R`. // See https://github.com/jarro2783/cxxopts/issues/62 for more details. r = static_cast(-static_cast(t-1)-1); } template void checked_negate(R&, T&&, const std::string& text, std::false_type) { throw_or_mimic(text); } template void integer_parser(const std::string& text, T& value) { parser_tool::IntegerDesc int_desc = parser_tool::SplitInteger(text); using US = typename std::make_unsigned::type; constexpr bool is_signed = std::numeric_limits::is_signed; const bool negative = int_desc.negative.length() > 0; const uint8_t base = int_desc.base.length() > 0 ? 16 : 10; const std::string & value_match = int_desc.value; US result = 0; for (char ch : value_match) { US digit = 0; if (ch >= '0' && ch <= '9') { digit = static_cast(ch - '0'); } else if (base == 16 && ch >= 'a' && ch <= 'f') { digit = static_cast(ch - 'a' + 10); } else if (base == 16 && ch >= 'A' && ch <= 'F') { digit = static_cast(ch - 'A' + 10); } else { throw_or_mimic(text); } US limit = 0; if (negative) { limit = static_cast(std::abs(static_cast(std::numeric_limits::min()))); } else { limit = std::numeric_limits::max(); } if (base != 0 && result > limit / base) { throw_or_mimic(text); } if (result * base > limit - digit) { throw_or_mimic(text); } result = static_cast(result * base + digit); } detail::check_signed_range(negative, result, text); if (negative) { checked_negate(value, result, text, std::integral_constant()); } else { value = static_cast(result); } } template void stringstream_parser(const std::string& text, T& value) { std::stringstream in(text); in >> value; if (!in) { throw_or_mimic(text); } } template ::value>::type* = nullptr > void parse_value(const std::string& text, T& value) { integer_parser(text, value); } inline void parse_value(const std::string& text, bool& value) { if (parser_tool::IsTrueText(text)) { value = true; return; } if (parser_tool::IsFalseText(text)) { value = false; return; } throw_or_mimic(text); } inline void parse_value(const std::string& text, std::string& value) { value = text; } // The fallback parser. It uses the stringstream parser to parse all types // that have not been overloaded explicitly. It has to be placed in the // source code before all other more specialized templates. template ::value>::type* = nullptr > void parse_value(const std::string& text, T& value) { stringstream_parser(text, value); } #ifdef CXXOPTS_HAS_OPTIONAL template void parse_value(const std::string& text, std::optional& value) { T result; parse_value(text, result); value = std::move(result); } #endif inline void parse_value(const std::string& text, char& c) { if (text.length() != 1) { throw_or_mimic(text); } c = text[0]; } template void parse_value(const std::string& text, std::vector& value) { if (text.empty()) { T v; parse_value(text, v); value.emplace_back(std::move(v)); return; } std::stringstream in(text); std::string token; while(!in.eof() && std::getline(in, token, CXXOPTS_VECTOR_DELIMITER)) { T v; parse_value(token, v); value.emplace_back(std::move(v)); } } template void add_value(const std::string& text, T& value) { parse_value(text, value); } template void add_value(const std::string& text, std::vector& value) { T v; add_value(text, v); value.emplace_back(std::move(v)); } template struct type_is_container { static constexpr bool value = false; }; template struct type_is_container> { static constexpr bool value = true; }; template class abstract_value : public Value { using Self = abstract_value; public: abstract_value() : m_result(std::make_shared()) , m_store(m_result.get()) { } explicit abstract_value(T* t) : m_store(t) { } ~abstract_value() override = default; abstract_value& operator=(const abstract_value&) = default; abstract_value(const abstract_value& rhs) { if (rhs.m_result) { m_result = std::make_shared(); m_store = m_result.get(); } else { m_store = rhs.m_store; } m_default = rhs.m_default; m_implicit = rhs.m_implicit; m_default_value = rhs.m_default_value; m_implicit_value = rhs.m_implicit_value; } void add(const std::string& text) const override { add_value(text, *m_store); } void parse(const std::string& text) const override { parse_value(text, *m_store); } bool is_container() const override { return type_is_container::value; } void parse() const override { parse_value(m_default_value, *m_store); } bool has_default() const override { return m_default; } bool has_implicit() const override { return m_implicit; } std::shared_ptr default_value(const std::string& value) override { m_default = true; m_default_value = value; return shared_from_this(); } std::shared_ptr implicit_value(const std::string& value) override { m_implicit = true; m_implicit_value = value; return shared_from_this(); } std::shared_ptr no_implicit_value() override { m_implicit = false; return shared_from_this(); } std::string get_default_value() const override { return m_default_value; } std::string get_implicit_value() const override { return m_implicit_value; } bool is_boolean() const override { return std::is_same::value; } const T& get() const { if (m_store == nullptr) { return *m_result; } return *m_store; } protected: std::shared_ptr m_result{}; T* m_store{}; bool m_default = false; bool m_implicit = false; std::string m_default_value{}; std::string m_implicit_value{}; }; template class standard_value : public abstract_value { public: using abstract_value::abstract_value; CXXOPTS_NODISCARD std::shared_ptr clone() const override { return std::make_shared>(*this); } }; template <> class standard_value : public abstract_value { public: ~standard_value() override = default; standard_value() { set_default_and_implicit(); } explicit standard_value(bool* b) : abstract_value(b) { m_implicit = true; m_implicit_value = "true"; } std::shared_ptr clone() const override { return std::make_shared>(*this); } private: void set_default_and_implicit() { m_default = true; m_default_value = "false"; m_implicit = true; m_implicit_value = "true"; } }; } // namespace values template std::shared_ptr value() { return std::make_shared>(); } template std::shared_ptr value(T& t) { return std::make_shared>(&t); } class OptionAdder; CXXOPTS_NODISCARD inline const std::string& first_or_empty(const OptionNames& long_names) { static const std::string empty{""}; return long_names.empty() ? empty : long_names.front(); } class OptionDetails { public: OptionDetails ( std::string short_, OptionNames long_, String desc, std::shared_ptr val ) : m_short(std::move(short_)) , m_long(std::move(long_)) , m_desc(std::move(desc)) , m_value(std::move(val)) , m_count(0) { m_hash = std::hash{}(first_long_name() + m_short); } OptionDetails(const OptionDetails& rhs) : m_desc(rhs.m_desc) , m_value(rhs.m_value->clone()) , m_count(rhs.m_count) { } OptionDetails(OptionDetails&& rhs) = default; CXXOPTS_NODISCARD const String& description() const { return m_desc; } CXXOPTS_NODISCARD const Value& value() const { return *m_value; } CXXOPTS_NODISCARD std::shared_ptr make_storage() const { return m_value->clone(); } CXXOPTS_NODISCARD const std::string& short_name() const { return m_short; } CXXOPTS_NODISCARD const std::string& first_long_name() const { return first_or_empty(m_long); } CXXOPTS_NODISCARD const std::string& essential_name() const { return m_long.empty() ? m_short : m_long.front(); } CXXOPTS_NODISCARD const OptionNames & long_names() const { return m_long; } std::size_t hash() const { return m_hash; } private: std::string m_short{}; OptionNames m_long{}; String m_desc{}; std::shared_ptr m_value{}; int m_count; std::size_t m_hash{}; }; struct HelpOptionDetails { std::string s; OptionNames l; String desc; bool has_default; std::string default_value; bool has_implicit; std::string implicit_value; std::string arg_help; bool is_container; bool is_boolean; }; struct HelpGroupDetails { std::string name{}; std::string description{}; std::vector options{}; }; class OptionValue { public: void add ( const std::shared_ptr& details, const std::string& text ) { ensure_value(details); ++m_count; m_value->add(text); m_long_names = &details->long_names(); } void parse ( const std::shared_ptr& details, const std::string& text ) { ensure_value(details); ++m_count; m_value->parse(text); m_long_names = &details->long_names(); } void parse_default(const std::shared_ptr& details) { ensure_value(details); m_default = true; m_long_names = &details->long_names(); m_value->parse(); } void parse_no_value(const std::shared_ptr& details) { m_long_names = &details->long_names(); } #if defined(CXXOPTS_NULL_DEREF_IGNORE) CXXOPTS_DIAGNOSTIC_PUSH CXXOPTS_IGNORE_WARNING("-Wnull-dereference") #endif CXXOPTS_NODISCARD std::size_t count() const noexcept { return m_count; } #if defined(CXXOPTS_NULL_DEREF_IGNORE) CXXOPTS_DIAGNOSTIC_POP #endif // TODO: maybe default options should count towards the number of arguments CXXOPTS_NODISCARD bool has_default() const noexcept { return m_default; } template const T& as() const { if (m_value == nullptr) { throw_or_mimic( m_long_names == nullptr ? "" : first_or_empty(*m_long_names)); } return CXXOPTS_RTTI_CAST&>(*m_value).get(); } private: void ensure_value(const std::shared_ptr& details) { if (m_value == nullptr) { m_value = details->make_storage(); } } const OptionNames * m_long_names = nullptr; // Holding this pointer is safe, since OptionValue's only exist in key-value pairs, // where the key has the string we point to. std::shared_ptr m_value{}; std::size_t m_count = 0; bool m_default = false; }; class KeyValue { public: KeyValue(std::string key_, std::string value_) noexcept : m_key(std::move(key_)) , m_value(std::move(value_)) { } CXXOPTS_NODISCARD const std::string& key() const { return m_key; } CXXOPTS_NODISCARD const std::string& value() const { return m_value; } template T as() const { T result; values::parse_value(m_value, result); return result; } private: std::string m_key; std::string m_value; }; using ParsedHashMap = std::unordered_map; using NameHashMap = std::unordered_map; class ParseResult { public: class Iterator { public: using iterator_category = std::forward_iterator_tag; using value_type = KeyValue; using difference_type = void; using pointer = const KeyValue*; using reference = const KeyValue&; Iterator() = default; Iterator(const Iterator&) = default; // GCC complains about m_iter not being initialised in the member // initializer list CXXOPTS_DIAGNOSTIC_PUSH CXXOPTS_IGNORE_WARNING("-Weffc++") Iterator(const ParseResult *pr, bool end=false) : m_pr(pr) { if (end) { m_sequential = false; m_iter = m_pr->m_defaults.end(); } else { m_sequential = true; m_iter = m_pr->m_sequential.begin(); if (m_iter == m_pr->m_sequential.end()) { m_sequential = false; m_iter = m_pr->m_defaults.begin(); } } } CXXOPTS_DIAGNOSTIC_POP Iterator& operator++() { ++m_iter; if(m_sequential && m_iter == m_pr->m_sequential.end()) { m_sequential = false; m_iter = m_pr->m_defaults.begin(); return *this; } return *this; } Iterator operator++(int) { Iterator retval = *this; ++(*this); return retval; } bool operator==(const Iterator& other) const { return (m_sequential == other.m_sequential) && (m_iter == other.m_iter); } bool operator!=(const Iterator& other) const { return !(*this == other); } const KeyValue& operator*() { return *m_iter; } const KeyValue* operator->() { return m_iter.operator->(); } private: const ParseResult* m_pr; std::vector::const_iterator m_iter; bool m_sequential = true; }; ParseResult() = default; ParseResult(const ParseResult&) = default; ParseResult(NameHashMap&& keys, ParsedHashMap&& values, std::vector sequential, std::vector default_opts, std::vector&& unmatched_args) : m_keys(std::move(keys)) , m_values(std::move(values)) , m_sequential(std::move(sequential)) , m_defaults(std::move(default_opts)) , m_unmatched(std::move(unmatched_args)) { } ParseResult& operator=(ParseResult&&) = default; ParseResult& operator=(const ParseResult&) = default; Iterator begin() const { return Iterator(this); } Iterator end() const { return Iterator(this, true); } std::size_t count(const std::string& o) const { auto iter = m_keys.find(o); if (iter == m_keys.end()) { return 0; } auto viter = m_values.find(iter->second); if (viter == m_values.end()) { return 0; } return viter->second.count(); } const OptionValue& operator[](const std::string& option) const { auto iter = m_keys.find(option); if (iter == m_keys.end()) { throw_or_mimic(option); } auto viter = m_values.find(iter->second); if (viter == m_values.end()) { throw_or_mimic(option); } return viter->second; } const std::vector& arguments() const { return m_sequential; } const std::vector& unmatched() const { return m_unmatched; } const std::vector& defaults() const { return m_defaults; } const std::string arguments_string() const { std::string result; for(const auto& kv: m_sequential) { result += kv.key() + " = " + kv.value() + "\n"; } for(const auto& kv: m_defaults) { result += kv.key() + " = " + kv.value() + " " + "(default)" + "\n"; } return result; } private: NameHashMap m_keys{}; ParsedHashMap m_values{}; std::vector m_sequential{}; std::vector m_defaults{}; std::vector m_unmatched{}; }; struct Option { Option ( std::string opts, std::string desc, std::shared_ptr value = ::cxxopts::value(), std::string arg_help = "" ) : opts_(std::move(opts)) , desc_(std::move(desc)) , value_(std::move(value)) , arg_help_(std::move(arg_help)) { } std::string opts_; std::string desc_; std::shared_ptr value_; std::string arg_help_; }; using OptionMap = std::unordered_map>; using PositionalList = std::vector; using PositionalListIterator = PositionalList::const_iterator; class OptionParser { public: OptionParser(const OptionMap& options, const PositionalList& positional, bool allow_unrecognised) : m_options(options) , m_positional(positional) , m_allow_unrecognised(allow_unrecognised) { } ParseResult parse(int argc, const char* const* argv); bool consume_positional(const std::string& a, PositionalListIterator& next); void checked_parse_arg ( int argc, const char* const* argv, int& current, const std::shared_ptr& value, const std::string& name ); void add_to_option(const std::shared_ptr& value, const std::string& arg); void parse_option ( const std::shared_ptr& value, const std::string& name, const std::string& arg = "" ); void parse_default(const std::shared_ptr& details); void parse_no_value(const std::shared_ptr& details); private: void finalise_aliases(); const OptionMap& m_options; const PositionalList& m_positional; std::vector m_sequential{}; std::vector m_defaults{}; bool m_allow_unrecognised; ParsedHashMap m_parsed{}; NameHashMap m_keys{}; }; class Options { public: explicit Options(std::string program_name, std::string help_string = "") : m_program(std::move(program_name)) , m_help_string(toLocalString(std::move(help_string))) , m_custom_help("[OPTION...]") , m_positional_help("positional parameters") , m_show_positional(false) , m_allow_unrecognised(false) , m_width(76) , m_tab_expansion(false) , m_options(std::make_shared()) { } Options& positional_help(std::string help_text) { m_positional_help = std::move(help_text); return *this; } Options& custom_help(std::string help_text) { m_custom_help = std::move(help_text); return *this; } Options& show_positional_help() { m_show_positional = true; return *this; } Options& allow_unrecognised_options() { m_allow_unrecognised = true; return *this; } Options& set_width(std::size_t width) { m_width = width; return *this; } Options& set_tab_expansion(bool expansion=true) { m_tab_expansion = expansion; return *this; } ParseResult parse(int argc, const char* const* argv); OptionAdder add_options(std::string group = ""); void add_options ( const std::string& group, std::initializer_list