mirror of
https://github.com/CLIUtils/CLI11.git
synced 2025-05-01 05:03:52 +00:00
chore: codacity (#621)
* docs: fix some Codacity recommendations * chore: update copyright year * style: more codacity fixes * style: fix issues reported by Codacity
This commit is contained in:
Henry Schreiner
GitHub
parent
9e247b1a0c
commit
b4f6be31c1
@ -1,14 +1,14 @@
|
||||
#!/usr/bin/env bash
|
||||
echo -en "travis_fold:start:script.build\\r"
|
||||
echo "Building..."
|
||||
STD=$1
|
||||
STD="$1"
|
||||
shift
|
||||
set -evx
|
||||
|
||||
|
||||
mkdir -p build
|
||||
cd build
|
||||
cmake .. -DCLI11_WARNINGS_AS_ERRORS=ON -DCLI11_SINGLE_FILE=ON -DCMAKE_CXX_STANDARD=$STD -DCLI11_SINGLE_FILE_TESTS=ON -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER_LAUNCHER=ccache $@
|
||||
cmake .. -DCLI11_WARNINGS_AS_ERRORS=ON -DCLI11_SINGLE_FILE=ON -DCMAKE_CXX_STANDARD="$STD" -DCLI11_SINGLE_FILE_TESTS=ON -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_COMPILER_LAUNCHER=ccache $@
|
||||
cmake --build . -- -j2
|
||||
|
||||
set +evx
|
||||
|
||||
@ -4,7 +4,7 @@ echo -en "travis_fold:start:script.build\\r"
|
||||
echo "Building..."
|
||||
set -evx
|
||||
|
||||
cd ${TRAVIS_BUILD_DIR}
|
||||
cd "${TRAVIS_BUILD_DIR}"
|
||||
mkdir -p build
|
||||
cd build
|
||||
cmake .. -DCLI11_SINGLE_FILE_TESTS=OFF -DCLI11_EXAMPLES=OFF -DCMAKE_BUILD_TYPE=Coverage
|
||||
|
||||
192
CHANGELOG.md
192
CHANGELOG.md
@ -178,28 +178,28 @@ configuration options were added to facilitate a wider variety of apps. GCC
|
||||
|
||||
Set handling has been completely replaced by a new backend that works as a Validator or Transformer. This provides a single interface instead of the 16 different functions in App. It also allows ordered collections to be used, custom functions for filtering, and better help and error messages. You can also use a collection of pairs (like `std::map`) to transform the match into an output. Also new are inverted flags, which can cancel or reduce the count of flags, and can also support general flag types. A new `add_option_fn` lets you more easily program CLI11 options with the types you choose. Vector options now support a custom separator. Apps can now be composed with unnamed subcommand support. The final bool "defaults" flag when creating options has been replaced by `->capture_default_str()` (ending an old limitation in construction made this possible); the old method is still available but may be removed in future versions.
|
||||
|
||||
* Replaced default help capture: `.add_option("name", value, "", True)` becomes `.add_option("name", value)->capture_default_str()` [#242]
|
||||
* Added `.always_capture_default()` [#242]
|
||||
* New `CLI::IsMember` validator replaces set validation [#222]
|
||||
* IsMember also supports container of pairs, transform allows modification of result [#228]
|
||||
* Added new Transformers, `CLI::AsNumberWithUnit` and `CLI::AsSizeValue` [#253]
|
||||
* Much more powerful flags with different values [#211], general types [#235]
|
||||
* `add_option` now supports bool due to unified bool handling [#211]
|
||||
* Support for composable unnamed subcommands [#216]
|
||||
* Reparsing is better supported with `.remaining_for_passthrough()` [#265]
|
||||
* Custom vector separator using `->delimiter(char)` [#209], [#221], [#240]
|
||||
* Validators added for IP4 addresses and positive numbers [#210] and numbers [#262]
|
||||
* Minimum required Boost for optional Optionals has been corrected to 1.61 [#226]
|
||||
* Positionals can stop options from being parsed with `app.positionals_at_end()` [#223]
|
||||
* Added `validate_positionals` [#262]
|
||||
* Positional parsing is much more powerful [#251], duplicates supported []#247]
|
||||
* Validators can be negated with `!` [#230], and now handle tname functions [#228]
|
||||
* Better enum support and streaming helper [#233] and [#228]
|
||||
* Cleanup for shadow warnings [#232]
|
||||
* Better alignment on multiline descriptions [#269]
|
||||
* Better support for aarch64 [#266]
|
||||
* Respect `BUILD_TESTING` only if CLI11 is the main project; otherwise, `CLI11_TESTING` must be used [#277]
|
||||
* Drop auto-detection of experimental optional and boost::optional; must be enabled explicitly (too fragile) [#277] [#279]
|
||||
* Replaced default help capture: `.add_option("name", value, "", True)` becomes `.add_option("name", value)->capture_default_str()` [#242][]
|
||||
* Added `.always_capture_default()` [#242][]
|
||||
* New `CLI::IsMember` validator replaces set validation [#222][]
|
||||
* `IsMember` also supports container of pairs, transform allows modification of result [#228][]
|
||||
* Added new Transformers, `CLI::AsNumberWithUnit` and `CLI::AsSizeValue` [#253][]
|
||||
* Much more powerful flags with different values [#211][], general types [#235][]
|
||||
* `add_option` now supports bool due to unified bool handling [#211][]
|
||||
* Support for composable unnamed subcommands [#216][]
|
||||
* Reparsing is better supported with `.remaining_for_passthrough()` [#265][]
|
||||
* Custom vector separator using `->delimiter(char)` [#209][], [#221][], [#240][]
|
||||
* Validators added for IP4 addresses and positive numbers [#210] and numbers [#262][]
|
||||
* Minimum required Boost for optional Optionals has been corrected to 1.61 [#226][]
|
||||
* Positionals can stop options from being parsed with `app.positionals_at_end()` [#223][]
|
||||
* Added `validate_positionals` [#262][]
|
||||
* Positional parsing is much more powerful [#251][], duplicates supported [#247][]
|
||||
* Validators can be negated with `!` [#230][], and now handle tname functions [#228][]
|
||||
* Better enum support and streaming helper [#233][] and [#228][]
|
||||
* Cleanup for shadow warnings [#232][]
|
||||
* Better alignment on multiline descriptions [#269][]
|
||||
* Better support for aarch64 [#266][]
|
||||
* Respect `BUILD_TESTING` only if CLI11 is the main project; otherwise, `CLI11_TESTING` must be used [#277][]
|
||||
* Drop auto-detection of experimental optional and boost::optional; must be enabled explicitly (too fragile) [#277][] [#279][]
|
||||
|
||||
> ### Converting from CLI11 1.7:
|
||||
>
|
||||
@ -243,9 +243,9 @@ Set handling has been completely replaced by a new backend that works as a Valid
|
||||
This version provides a quick patch for a (correct) warning from GCC 8 for the windows options code.
|
||||
|
||||
|
||||
* Fix for Windows style option parsing [#201]
|
||||
* Improve `add_subcommand` when throwing an exception [#204]
|
||||
* Better metadata for Conan package [#202]
|
||||
* Fix for Windows style option parsing [#201][]
|
||||
* Improve `add_subcommand` when throwing an exception [#204][]
|
||||
* Better metadata for Conan package [#202][]
|
||||
|
||||
[#201]: https://github.com/CLIUtils/CLI11/pull/201
|
||||
[#202]: https://github.com/CLIUtils/CLI11/pull/202
|
||||
@ -256,20 +256,20 @@ This version provides a quick patch for a (correct) warning from GCC 8 for the w
|
||||
The parsing procedure now maps much more sensibly to complex, nested subcommand structures. Each phase of the parsing happens on all subcommands before moving on with the next phase of the parse. This allows several features, like required environment variables, to work properly even through subcommand boundaries.
|
||||
Passing the same subcommand multiple times is better supported. Several new features were added as well, including Windows style option support, parsing strings directly, and ignoring underscores in names. Adding a set that you plan to change later must now be done with `add_mutable_set`.
|
||||
|
||||
* Support Windows style options with `->allow_windows_style_options`. [#187] On by default on Windows. [#190]
|
||||
* Added `parse(string)` to split up and parse a command-line style string directly. [#186]
|
||||
* Added `ignore_underscore` and related functions, to ignore underscores when matching names. [#185]
|
||||
* The default INI Config will now add quotes to strings with spaces [#195]
|
||||
* The default message now will mention the help-all flag also if present [#197]
|
||||
* Added `->description` to set Option descriptions [#199]
|
||||
* Mutating sets (introduced in Version 1.6) now have a clear add method, `add_mutable_set*`, since the set reference should not expire [#200]
|
||||
* Subcommands now track how many times they were parsed in a parsing process. `count()` with no arguments will return the number of times a subcommand was encountered. [#179]
|
||||
* Parsing is now done in phases: `shortcurcuits`, `ini`, `env`, `callbacks`, and `requirements`; all subcommands complete a phase before moving on. [#179]
|
||||
* Calling parse multiple times is now officially supported without `clear` (automatic). [#179]
|
||||
* Dropped the mostly undocumented `short_circuit` property, as help flag parsing is a bit more complex, and the default callback behavior of options now works properly. [#179]
|
||||
* Use the standard `BUILD_TESTING` over `CLI11_TESTING` if defined [#183]
|
||||
* Cleanup warnings [#191]
|
||||
* Remove deprecated names: `set_footer`, `set_name`, `set_callback`, and `set_type_name`. Use without the `set_` instead. [#192]
|
||||
* Support Windows style options with `->allow_windows_style_options`. [#187][] On by default on Windows. [#190][]
|
||||
* Added `parse(string)` to split up and parse a command-line style string directly. [#186][]
|
||||
* Added `ignore_underscore` and related functions, to ignore underscores when matching names. [#185][]
|
||||
* The default INI Config will now add quotes to strings with spaces [#195][]
|
||||
* The default message now will mention the help-all flag also if present [#197][]
|
||||
* Added `->description` to set Option descriptions [#199][]
|
||||
* Mutating sets (introduced in Version 1.6) now have a clear add method, `add_mutable_set*`, since the set reference should not expire [#200][]
|
||||
* Subcommands now track how many times they were parsed in a parsing process. `count()` with no arguments will return the number of times a subcommand was encountered. [#179][]
|
||||
* Parsing is now done in phases: `shortcurcuits`, `ini`, `env`, `callbacks`, and `requirements`; all subcommands complete a phase before moving on. [#179][]
|
||||
* Calling parse multiple times is now officially supported without `clear` (automatic). [#179][]
|
||||
* Dropped the mostly undocumented `short_circuit` property, as help flag parsing is a bit more complex, and the default callback behavior of options now works properly. [#179][]
|
||||
* Use the standard `BUILD_TESTING` over `CLI11_TESTING` if defined [#183][]
|
||||
* Cleanup warnings [#191][]
|
||||
* Remove deprecated names: `set_footer`, `set_name`, `set_callback`, and `set_type_name`. Use without the `set_` instead. [#192][]
|
||||
|
||||
> ### Converting from CLI11 1.6:
|
||||
>
|
||||
@ -294,17 +294,17 @@ Passing the same subcommand multiple times is better supported. Several new feat
|
||||
|
||||
This version fixes some formatting bugs with help-all. It also adds fixes for several warnings, including an experimental optional error on Clang 7. Several smaller fixes.
|
||||
|
||||
* Fixed help-all formatting [#163]
|
||||
* Fixed help-all formatting [#163][]
|
||||
* Printing help-all on nested command now fixed (App)
|
||||
* Missing space after help-all restored (Default formatter)
|
||||
* More detail printed on help all (Default formatter)
|
||||
* Help-all subcommands get indented with inner blank lines removed (Default formatter)
|
||||
* `detail::find_and_replace` added to utilities
|
||||
* Fixed CMake install as subproject with `CLI11_INSTALL` flag. [#156]
|
||||
* Fixed warning about local variable hiding class member with MSVC [#157]
|
||||
* Fixed compile error with default settings on Clang 7 and libc++ [#158]
|
||||
* Fixed special case of `--help` on subcommands (general fix planned for 1.7) [#168]
|
||||
* Removing an option with links [#179]
|
||||
* Fixed CMake install as subproject with `CLI11_INSTALL` flag. [#156][]
|
||||
* Fixed warning about local variable hiding class member with MSVC [#157][]
|
||||
* Fixed compile error with default settings on Clang 7 and libc++ [#158][]
|
||||
* Fixed special case of `--help` on subcommands (general fix planned for 1.7) [#168][]
|
||||
* Removing an option with links [#179][]
|
||||
|
||||
[#156]: https://github.com/CLIUtils/CLI11/issues/156
|
||||
[#157]: https://github.com/CLIUtils/CLI11/issues/157
|
||||
@ -320,9 +320,9 @@ This version provides a few fixes for special cases, such as mixing with `Window
|
||||
for systems like Hunter. The one new feature is the ability to produce "branded" single file output for
|
||||
providing custom namespaces or custom macro names.
|
||||
|
||||
* Added fix and test for including Windows.h [#145]
|
||||
* No longer build single file by default if main project, supports systems stuck on Python 2.6 [#149], [#151]
|
||||
* Branding support for single file output [#150]
|
||||
* Added fix and test for including Windows.h [#145][]
|
||||
* No longer build single file by default if main project, supports systems stuck on Python 2.6 [#149][], [#151][]
|
||||
* Branding support for single file output [#150][]
|
||||
|
||||
[#145]: https://github.com/CLIUtils/CLI11/pull/145
|
||||
[#149]: https://github.com/CLIUtils/CLI11/pull/149
|
||||
@ -331,7 +331,7 @@ providing custom namespaces or custom macro names.
|
||||
|
||||
## Version 1.6: Formatting help
|
||||
|
||||
Added a new formatting system [#109]. You can now set the formatter on Apps. This has also simplified the internals of Apps and Options a bit by separating most formatting code.
|
||||
Added a new formatting system [#109][]. You can now set the formatter on Apps. This has also simplified the internals of Apps and Options a bit by separating most formatting code.
|
||||
|
||||
* Added `CLI::Formatter` and `formatter` slot for apps, inherited.
|
||||
* `FormatterBase` is the minimum required.
|
||||
@ -347,10 +347,10 @@ Changes to the help system (most normal users will not notice this):
|
||||
* Protected function `_has_help_positional` removed.
|
||||
* `format_help` can now be chained.
|
||||
* Added getters for the missing parts of options (help no longer uses any private parts).
|
||||
* Help flags now use new `short_circuit` property to simplify parsing. [#121]
|
||||
* Help flags now use new `short_circuit` property to simplify parsing. [#121][]
|
||||
|
||||
|
||||
New for Config file reading and writing [#121]:
|
||||
New for Config file reading and writing [#121][]:
|
||||
|
||||
* Overridable, bidirectional Config.
|
||||
* ConfigINI provided and used by default.
|
||||
@ -361,7 +361,7 @@ New for Config file reading and writing [#121]:
|
||||
* Added an example of a custom config format using [nlohmann/json]. [#138]
|
||||
|
||||
|
||||
Validators are now much more powerful [#118], all built in validators upgraded to the new form:
|
||||
Validators are now much more powerful [#118][], all built in validators upgraded to the new form:
|
||||
|
||||
* A subclass of `CLI::Validator` is now also accepted.
|
||||
* They now can set the type name to things like `PATH` and `INT in [1-4]`.
|
||||
@ -370,29 +370,29 @@ Validators are now much more powerful [#118], all built in validators upgraded t
|
||||
|
||||
Other changes:
|
||||
|
||||
* Fixing `parse(args)`'s `args` setting and ordering after parse. [#141]
|
||||
* Replaced `set_custom_option` with `type_name` and `type_size` instead of `set_custom_option`. Methods return `this`. [#136]
|
||||
* Dropped `set_` on Option's `type_name`, `default_str`, and `default_val`. [#136]
|
||||
* Removed `set_` from App's `failure_message`, `footer`, `callback`, and `name`. [#136]
|
||||
* Fixed support `N<-1` for `type_size`. [#140]
|
||||
* Added `->each()` to make adding custom callbacks easier. [#126]
|
||||
* Allow empty options `add_option("-n",{})` to be edited later with `each` [#142]
|
||||
* Fixing `parse(args)`'s `args` setting and ordering after parse. [#141][]
|
||||
* Replaced `set_custom_option` with `type_name` and `type_size` instead of `set_custom_option`. Methods return `this`. [#136][]
|
||||
* Dropped `set_` on Option's `type_name`, `default_str`, and `default_val`. [#136][]
|
||||
* Removed `set_` from App's `failure_message`, `footer`, `callback`, and `name`. [#136][]
|
||||
* Fixed support `N<-1` for `type_size`. [#140][]
|
||||
* Added `->each()` to make adding custom callbacks easier. [#126][]
|
||||
* Allow empty options `add_option("-n",{})` to be edited later with `each` [#142][]
|
||||
* Added filter argument to `get_subcommands`, `get_options`; use empty filter `{}` to avoid filtering.
|
||||
* Added `get_groups()` to get groups.
|
||||
* Better support for manual options with `get_option`, `set_results`, and `empty`. [#119]
|
||||
* `lname` and `sname` have getters, added `const get_parent`. [#120]
|
||||
* Using `add_set` will now capture L-values for sets, allowing further modification. [#113]
|
||||
* Better support for manual options with `get_option`, `set_results`, and `empty`. [#119][]
|
||||
* `lname` and `sname` have getters, added `const get_parent`. [#120][]
|
||||
* Using `add_set` will now capture L-values for sets, allowing further modification. [#113][]
|
||||
* Dropped duplicate way to run `get_type_name` (`get_typeval`).
|
||||
* Removed `requires` in favor of `needs` (deprecated in last version). [#112]
|
||||
* Const added to argv. [#126]
|
||||
* Removed `requires` in favor of `needs` (deprecated in last version). [#112][]
|
||||
* Const added to argv. [#126][]
|
||||
|
||||
Backend and testing changes:
|
||||
|
||||
* Internally, `type_name` is now a lambda function; for sets, this reads the set live. [#116]
|
||||
* Cleaner tests without `app.reset()` (and `reset` is now `clear`). [#141]
|
||||
* Better CMake policy handling. [#110]
|
||||
* Includes are properly sorted. [#120]
|
||||
* Testing (only) now uses submodules. [#111]
|
||||
* Internally, `type_name` is now a lambda function; for sets, this reads the set live. [#116][]
|
||||
* Cleaner tests without `app.reset()` (and `reset` is now `clear`). [#141][]
|
||||
* Better CMake policy handling. [#110][]
|
||||
* Includes are properly sorted. [#120][]
|
||||
* Testing (only) now uses submodules. [#111][]
|
||||
|
||||
[#109]: https://github.com/CLIUtils/CLI11/pull/109
|
||||
[#110]: https://github.com/CLIUtils/CLI11/pull/110
|
||||
@ -427,13 +427,13 @@ This is a quick patch release that makes LICENSE part of the single header file,
|
||||
|
||||
This patch release adds better access to the App programmatically, to assist with writing custom converters to other formats. It also improves the help output, and uses a new feature in CLI11 1.5 to fix an old "quirk" in the way unlimited options and positionals interact.
|
||||
|
||||
* Make mixing unlimited positionals and options more intuitive [#102]
|
||||
* Add missing getters `get_options` and `get_description` to App [#105]
|
||||
* The app name now can be set, and will override the auto name if present [#105]
|
||||
* Add `(REQUIRED)` for required options [#104]
|
||||
* Print simple name for Needs/Excludes [#104]
|
||||
* Use Needs instead of Requires in help print [#104]
|
||||
* Groups now are listed in the original definition order [#106]
|
||||
* Make mixing unlimited positionals and options more intuitive [#102][]
|
||||
* Add missing getters `get_options` and `get_description` to App [#105][]
|
||||
* The app name now can be set, and will override the auto name if present [#105][]
|
||||
* Add `(REQUIRED)` for required options [#104][]
|
||||
* Print simple name for Needs/Excludes [#104][]
|
||||
* Use Needs instead of Requires in help print [#104][]
|
||||
* Groups now are listed in the original definition order [#106][]
|
||||
|
||||
[#102]: https://github.com/CLIUtils/CLI11/issues/102
|
||||
[#104]: https://github.com/CLIUtils/CLI11/pull/104
|
||||
@ -447,21 +447,21 @@ This version introduced support for optionals, along with clarification and exam
|
||||
|
||||
Note: This is the final release with `requires`, please switch to `needs`.
|
||||
|
||||
* Fix unlimited short options eating two values before checking for positionals when no space present [#90]
|
||||
* Symmetric exclude text when excluding options, exclude can be called multiple times [#64]
|
||||
* Support for `std::optional`, `std::experimental::optional`, and `boost::optional` added if `__has_include` is supported [#95]
|
||||
* All macros/CMake variables now start with `CLI11_` instead of just `CLI_` [#95]
|
||||
* The internal stream was not being cleared before use in some cases. Fixed. [#95]
|
||||
* Using an enum now requires explicit conversion overload [#97]
|
||||
* The separator `--` now is removed when it ends unlimited arguments [#100]
|
||||
* Fix unlimited short options eating two values before checking for positionals when no space present [#90][]
|
||||
* Symmetric exclude text when excluding options, exclude can be called multiple times [#64][]
|
||||
* Support for `std::optional`, `std::experimental::optional`, and `boost::optional` added if `__has_include` is supported [#95][]
|
||||
* All macros/CMake variables now start with `CLI11_` instead of just `CLI_` [#95][]
|
||||
* The internal stream was not being cleared before use in some cases. Fixed. [#95][]
|
||||
* Using an enum now requires explicit conversion overload [#97][]
|
||||
* The separator `--` now is removed when it ends unlimited arguments [#100][]
|
||||
|
||||
Other, non-user facing changes:
|
||||
|
||||
* Added `Macros.hpp` with better C++ mode discovery [#95]
|
||||
* Added `Macros.hpp` with better C++ mode discovery [#95][]
|
||||
* Deprecated macros added for all platforms
|
||||
* C++17 is now tested on supported platforms [#95]
|
||||
* Informational printout now added to CTest [#95]
|
||||
* Better single file generation [#95]
|
||||
* C++17 is now tested on supported platforms [#95][]
|
||||
* Informational printout now added to CTest [#95][]
|
||||
* Better single file generation [#95][]
|
||||
* Added support for GTest on MSVC 2017 (but not in C++17 mode, will need next version of GTest)
|
||||
* Types now have a specific size, separate from the expected number - cleaner and more powerful internally [#92]
|
||||
* Examples now run as part of testing [#99]
|
||||
@ -479,17 +479,17 @@ Other, non-user facing changes:
|
||||
|
||||
This version adds lots of smaller fixes and additions after the refactor in version 1.3. More ways to download and use CLI11 in CMake have been added. INI files have improved support.
|
||||
|
||||
* Lexical cast is now more strict than before [#68] and fails on overflow [#84]
|
||||
* Lexical cast is now more strict than before [#68] and fails on overflow [#84][]
|
||||
* Added `get_parent()` to access the parent from a subcommand
|
||||
* Added `ExistingPath` validator [#73]
|
||||
* `app.allow_ini_extras()` added to allow extras in INI files [#70]
|
||||
* Added `ExistingPath` validator [#73][]
|
||||
* `app.allow_ini_extras()` added to allow extras in INI files [#70][]
|
||||
* Multiline INI comments now supported
|
||||
* Descriptions can now be written with `config_to_str` [#66]
|
||||
* Double printing of error message fixed [#77]
|
||||
* Renamed `requires` to `needs` to avoid C++20 keyword [#75], [#82]
|
||||
* MakeSingleHeader now works if outside of git [#78]
|
||||
* Adding install support for CMake [#79], improved support for `find_package` [#83], [#84]
|
||||
* Added support for Conan.io [#83]
|
||||
* Descriptions can now be written with `config_to_str` [#66][]
|
||||
* Double printing of error message fixed [#77][]
|
||||
* Renamed `requires` to `needs` to avoid C++20 keyword [#75][], [#82][]
|
||||
* MakeSingleHeader now works if outside of git [#78][]
|
||||
* Adding install support for CMake [#79][], improved support for `find_package` [#83][], [#84][]
|
||||
* Added support for Conan.io [#83][]
|
||||
|
||||
[#70]: https://github.com/CLIUtils/CLI11/issues/70
|
||||
[#75]: https://github.com/CLIUtils/CLI11/issues/75
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
// This is a standalone header file generated by MakeSingleHeader.py in CLI11/scripts
|
||||
// from: {git}
|
||||
//
|
||||
// CLI11 {version} Copyright (c) 2017-2020 University of Cincinnati, developed by Henry
|
||||
// CLI11 {version} Copyright (c) 2017-2021 University of Cincinnati, developed by Henry
|
||||
// Schreiner under NSF AWARD 1414736. All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms of CLI11, with or without
|
||||
|
||||
34
README.md
34
README.md
@ -264,27 +264,33 @@ An option name must start with a alphabetic character, underscore, a number, '?'
|
||||
The `add_option_function<type>(...` function will typically require the template parameter be given unless a `std::function` object with an exact match is passed. The type can be any type supported by the `add_option` function. The function should throw an error (`CLI::ConversionError` or `CLI::ValidationError` possibly) if the value is not valid.
|
||||
|
||||
The two parameter template overload can be used in cases where you want to restrict the input such as
|
||||
```
|
||||
|
||||
```cpp
|
||||
double val
|
||||
app.add_option<double,unsigned int>("-v",val);
|
||||
```
|
||||
|
||||
which would first verify the input is convertible to an `unsigned int` before assigning it. Or using some variant type
|
||||
```
|
||||
|
||||
```cpp
|
||||
using vtype=std::variant<int, double, std::string>;
|
||||
vtype v1;
|
||||
app.add_option<vtype,std:string>("--vs",v1);
|
||||
app.add_option<vtype,int>("--vi",v1);
|
||||
app.add_option<vtype,double>("--vf",v1);
|
||||
```
|
||||
|
||||
otherwise the output would default to a string. The `add_option` can be used with any integral or floating point types, enumerations, or strings. Or any type that takes an int, double, or std\::string in an assignment operator or constructor. If an object can take multiple varieties of those, std::string takes precedence, then double then int. To better control which one is used or to use another type for the underlying conversions use the two parameter template to directly specify the conversion type.
|
||||
|
||||
Types such as (std or boost) `optional<int>`, `optional<double>`, and `optional<string>` and any other wrapper types are supported directly. For purposes of CLI11 wrapper types are those which `value_type` definition. See [CLI11 Advanced Topics/Custom Converters][] for information on how you can add your own converters for additional types.
|
||||
|
||||
Vector types can also be used in the two parameter template overload
|
||||
```
|
||||
|
||||
```cpp
|
||||
std::vector<double> v1;
|
||||
app.add_option<std::vector<double>,int>("--vs",v1);
|
||||
```
|
||||
|
||||
would load a vector of doubles but ensure all values can be represented as integers.
|
||||
|
||||
Automatic direct capture of the default string is disabled when using the two parameter template. Use `set_default_str(...)` or `->default_function(std::string())` to set the default string or capture function directly for these cases.
|
||||
@ -320,7 +326,6 @@ On a `C++14` compiler, you can pass a callback function directly to `.add_flag`,
|
||||
|
||||
The add commands return a pointer to an internally stored `Option`.
|
||||
This option can be used directly to check for the count (`->count()`) after parsing to avoid a string based lookup.
|
||||
⚠️ Deprecated: The `add_*` commands have a final argument than can be set to true, which causes the default value to be captured and printed on the command line with the help flag. Since CLI11 1.8, you can simply add `->capture_default_str()`.
|
||||
|
||||
#### Option options
|
||||
|
||||
@ -462,6 +467,7 @@ Validators are copyable and have a few operations that can be performed on them
|
||||
The name of a Validator, which is useful for later reference from the `get_validator(name)` method of an `Option` can be set via `.name(validator_name)`
|
||||
The operation function of a Validator can be set via
|
||||
`.operation(std::function<std::string(std::string &>)`. The `.active()` function can activate or deactivate a Validator from the operation. A validator can be set to apply only to a specific element of the output. For example in a pair option `std::pair<int, std::string>` the first element may need to be a positive integer while the second may need to be a valid file. The `.application_index(int)` function can specify this. It is zero based and negative indices apply to all values.
|
||||
|
||||
```cpp
|
||||
opt->check(CLI::Validator(CLI::PositiveNumber).application_index(0));
|
||||
opt->check(CLI::Validator(CLI::ExistingFile).application_index(1));
|
||||
@ -610,6 +616,7 @@ There are several options that are supported on the main app and subcommands and
|
||||
|
||||
|
||||
#### Callbacks
|
||||
|
||||
A subcommand has three optional callbacks that are executed at different stages of processing. The `preparse_callback` is executed once after the first argument of a subcommand or application is processed and gives an argument for the number of remaining arguments to process. For the main app the first argument is considered the program name, for subcommands the first argument is the subcommand name. For Option groups and nameless subcommands the first argument is after the first argument or subcommand is processed from that group.
|
||||
The second callback is executed after parsing. This is known as the `parse_complete_callback`. For subcommands this is executed immediately after parsing and can be executed multiple times if a subcommand is called multiple times. On the main app this callback is executed after all the `parse_complete_callback`s for the subcommands are executed but prior to any `final_callback` calls in the subcommand or option groups. If the main app or subcommand has a config file, no data from the config file will be reflected in `parse_complete_callback` on named subcommands. For `option_group`s the `parse_complete_callback` is executed prior to the `parse_complete_callback` on the main app but after the `config_file` is loaded (if specified). The `final_callback` is executed after all processing is complete. After the `parse_complete_callback` is executed on the main app, the used subcommand `final_callback` are executed followed by the "final callback" for option groups. The last thing to execute is the `final_callback` for the `main_app`.
|
||||
For example say an application was set up like
|
||||
@ -627,20 +634,21 @@ app.preparse_callback( pa);
|
||||
|
||||
Then the command line is given as
|
||||
|
||||
```
|
||||
```bash
|
||||
program --opt1 opt1_val sub1 --sub1opt --sub1optb val sub2 --sub2opt sub1 --sub1opt2 sub2 --sub2opt2 val
|
||||
```
|
||||
|
||||
- pa will be called prior to parsing any values with an argument of 13.
|
||||
- pc1 will be called immediately after processing the sub1 command with a value of 10.
|
||||
- c1 will be called when the `sub2` command is encountered.
|
||||
- pc2 will be called with value of 6 after the sub2 command is encountered.
|
||||
- c1 will be called again after the second sub2 command is encountered.
|
||||
- ac1 will be called after processing of all arguments
|
||||
- c2 will be called once after processing all arguments.
|
||||
- ac2 will be called last after completing all lower level callbacks have been executed.
|
||||
- `pa` will be called prior to parsing any values with an argument of 13.
|
||||
- `pc1` will be called immediately after processing the `sub1` command with a value of 10.
|
||||
- `c1` will be called when the `sub2` command is encountered.
|
||||
- `pc2` will be called with value of 6 after the `sub2` command is encountered.
|
||||
- `c1` will be called again after the second `sub2` command is encountered.
|
||||
- `ac1` will be called after processing of all arguments
|
||||
- `c2` will be called once after processing all arguments.
|
||||
- `ac2` will be called last after completing all lower level callbacks have been executed.
|
||||
|
||||
A subcommand is considered terminated when one of the following conditions are met.
|
||||
|
||||
1. There are no more arguments to process
|
||||
2. Another subcommand is encountered that would not fit in an optional slot of the subcommand
|
||||
3. The `positional_mark` (`--`) is encountered and there are no available positional slots in the subcommand.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# CLI11: An introduction
|
||||
|
||||
This gitbook is designed to provide an introduction to using the CLI11 library to write your own command line programs. The library is designed to be clean, intuitive, but powerful. There are no requirements beyond C++11 support (and even `<regex>` support not required). It works on Mac, Linux, and Windows, and has 100% test coverage on all three systems. You can simply drop in a single header file (`CLI11.hpp` available in [releases]) to use CLI11 in your own application. Other ways to integrate it into a build system are listed in the [README].
|
||||
This gitbook is designed to provide an introduction to using the CLI11 library to write your own command line programs. The library is designed to be clean, intuitive, but powerful. There are no requirements beyond C++11 support (and even `<regex>` support not required). It works on Mac, Linux, and Windows, and has 100% test coverage on all three systems. You can simply drop in a single header file (`CLI11.hpp` available in [releases]) to use CLI11 in your own application. Other ways to integrate it into a build system are listed in the [README][].
|
||||
|
||||
The library was inspired the Python libraries [Plumbum] and [Click], and incorporates many of their user friendly features. The library is extensively documented, with a [friendly introduction][README], this tutorial book, and more technical [API docs].
|
||||
The library was inspired the Python libraries [Plumbum][] and [Click][], and incorporates many of their user friendly features. The library is extensively documented, with a [friendly introduction][README], this tutorial book, and more technical [API docs][].
|
||||
|
||||
> Feel free to contribute to [this documentation here][CLI11Tutorial] if something can be improved!
|
||||
|
||||
@ -49,9 +49,9 @@ You can use any valid type; the above example could have used a `boost::file_sys
|
||||
|
||||
You can use subcommands, as well. Subcommands support callback lambda functions when parsed, or they can be checked later. You can infinitely nest subcommands, and each is a full `App` instance, supporting everything listed above.
|
||||
|
||||
Reading/producing `.ini` files for configuration is also supported, as is using environment variables as input. The base `App` can be subclassed and customized for use in a toolkit (like [GooFit]). All the standard shell idioms, like `--`, work as well.
|
||||
Reading/producing `.ini` files for configuration is also supported, as is using environment variables as input. The base `App` can be subclassed and customized for use in a toolkit (like [GooFit][]). All the standard shell idioms, like `--`, work as well.
|
||||
|
||||
CLI11 was developed at the [University of Cincinnati] in support of the [GooFit] library under [NSF Award 1414736][NSF 1414736]. It was featured in a [DIANA/HEP] meeting at CERN. Please give it a try! Feedback is always welcome.
|
||||
CLI11 was developed at the [University of Cincinnati] in support of the [GooFit][] library under [NSF Award 1414736][NSF 1414736]. It was featured in a [DIANA/HEP] meeting at CERN. Please give it a try! Feedback is always welcome.
|
||||
|
||||
[GooFit]: https://github.com/GooFit/GooFit
|
||||
[DIANA/HEP]: http://diana-hep.org
|
||||
|
||||
@ -176,6 +176,6 @@ For custom configuration files this behavior can be triggered by specifying the
|
||||
The config file input works with any form of the option given: Long, short, positional, or the environment variable name. When generating a config file it will create a name in following priority.
|
||||
|
||||
1. First long name
|
||||
1. Positional name
|
||||
1. First short name
|
||||
1. Environment name
|
||||
2. Positional name
|
||||
3. First short name
|
||||
4. Environment name
|
||||
|
||||
@ -123,4 +123,4 @@ Flag plain: 1
|
||||
```
|
||||
|
||||
|
||||
[^1] It will not inherit this from the parent defaults, since this is often useful even if you don't want all options to allow multiple passed options.
|
||||
[^1]: It will not inherit this from the parent defaults, since this is often useful even if you don't want all options to allow multiple passed options.
|
||||
|
||||
@ -7,7 +7,6 @@ C++ application, though the system git uses to extend the main command by callin
|
||||
in separate executables is supported too; that's called "Prefix commands" and is included at the
|
||||
end of this chapter.
|
||||
|
||||
|
||||
## The parent App
|
||||
|
||||
We'll start by discussing the parent `App`. You've already used it quite a bit, to create
|
||||
@ -18,7 +17,6 @@ You can replace the default help print when a `ParseError` is thrown with `app.s
|
||||
The default is `CLI:::FailureMessage::simple`, and you can easily define a new one. Just make a (lambda) function that takes an App pointer
|
||||
and a reference to an error code (even if you don't use them), and returns a string.
|
||||
|
||||
|
||||
## Adding a subcommand
|
||||
|
||||
Subcommands can be added just like an option:
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
@ -1763,7 +1763,7 @@ class App {
|
||||
if(name_.empty()) {
|
||||
return std::string("[Option Group: ") + get_group() + "]";
|
||||
}
|
||||
if(aliases_.empty() || !with_aliases || aliases_.empty()) {
|
||||
if(aliases_.empty() || !with_aliases) {
|
||||
return name_;
|
||||
}
|
||||
std::string dispname = name_;
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
@ -1113,7 +1113,6 @@ inline std::pair<std::string, std::string> split_program_name(std::string comman
|
||||
esp = end + 1;
|
||||
if(embeddedQuote) {
|
||||
vals.first = find_and_replace(vals.first, std::string("\\") + keyChar, std::string(1, keyChar));
|
||||
embeddedQuote = false;
|
||||
}
|
||||
} else {
|
||||
esp = commandline.find_first_of(' ', 1);
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -39,12 +39,20 @@ DIR = os.path.dirname(os.path.abspath(__file__))
|
||||
|
||||
class HeaderGroups(dict):
|
||||
def __init__(self, tag):
|
||||
"""
|
||||
A dictionary that also can read headers given a tag expression.
|
||||
|
||||
TODO: might have gone overboard on this one, could maybe be two functions.
|
||||
"""
|
||||
self.re_matcher = re.compile(
|
||||
tag_str.format(tag=tag), re.MULTILINE | re.DOTALL | re.VERBOSE
|
||||
)
|
||||
super(HeaderGroups, self).__init__()
|
||||
|
||||
def read_header(self, filename):
|
||||
"""
|
||||
Read a header file in and add items to the dict, based on the item's action.
|
||||
"""
|
||||
with open(filename) as f:
|
||||
inner = f.read()
|
||||
|
||||
@ -67,12 +75,18 @@ class HeaderGroups(dict):
|
||||
raise RuntimeError("Action not understood, must be verbatim or set")
|
||||
|
||||
def post_process(self):
|
||||
"""
|
||||
Turn sets into multiple line strings.
|
||||
"""
|
||||
for key in self:
|
||||
if isinstance(self[key], set):
|
||||
self[key] = "\n".join(self[key])
|
||||
|
||||
|
||||
def MakeHeader(output, main_header, files, tag, namespace, macro=None, version=None):
|
||||
def make_header(output, main_header, files, tag, namespace, macro=None, version=None):
|
||||
"""
|
||||
Makes a single header given a main header template and a list of files.
|
||||
"""
|
||||
groups = HeaderGroups(tag)
|
||||
|
||||
# Set tag if possible to class variable
|
||||
@ -129,7 +143,7 @@ if __name__ == "__main__":
|
||||
parser.add_argument("--version", help="Include this version in the generated file")
|
||||
args = parser.parse_args()
|
||||
|
||||
MakeHeader(
|
||||
make_header(
|
||||
args.output,
|
||||
args.main,
|
||||
args.files,
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
@ -1933,7 +1933,6 @@ TEST_CASE_METHOD(TApp, "AllowExtrasArgModify", "[app]") {
|
||||
app.allow_extras();
|
||||
app.add_option("-f", v2);
|
||||
args = {"27", "-f", "45", "-x"};
|
||||
auto cargs = args;
|
||||
app.parse(args);
|
||||
CHECK(std::vector<std::string>({"45", "-x"}) == args);
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
@ -1155,6 +1155,7 @@ TEST_CASE("THelp: ChangingDefaults", "[help]") {
|
||||
std::vector<int> x = {1, 2};
|
||||
CLI::Option *opt = app.add_option("-q,--quick", x);
|
||||
x = {3, 4};
|
||||
CHECK(x[0] == 3);
|
||||
|
||||
opt->capture_default_str();
|
||||
|
||||
@ -1162,6 +1163,7 @@ TEST_CASE("THelp: ChangingDefaults", "[help]") {
|
||||
std::string help = app.help();
|
||||
|
||||
CHECK_THAT(help, Contains("INT=[3,4] ..."));
|
||||
CHECK(x[0] == 5);
|
||||
}
|
||||
|
||||
TEST_CASE("THelp: ChangingDefaultsWithAutoCapture", "[help]") {
|
||||
@ -1170,6 +1172,7 @@ TEST_CASE("THelp: ChangingDefaultsWithAutoCapture", "[help]") {
|
||||
app.option_defaults()->always_capture_default();
|
||||
|
||||
std::vector<int> x = {1, 2};
|
||||
CHECK(x[0] == 1);
|
||||
app.add_option("-q,--quick", x);
|
||||
x = {3, 4};
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
@ -997,7 +997,12 @@ TEST_CASE("Types: TypeName", "[helpers]") {
|
||||
std::string umapName = CLI::detail::type_name<std::unordered_map<int, std::tuple<std::string, double>>>();
|
||||
CHECK(umapName == "[INT,[TEXT,FLOAT]]");
|
||||
|
||||
// On older compilers, this may show up as other/TEXT
|
||||
vclass = CLI::detail::classify_object<std::atomic<int>>::value;
|
||||
CHECK((CLI::detail::object_category::wrapper_value == vclass || CLI::detail::object_category::other == vclass));
|
||||
|
||||
std::string atomic_name = CLI::detail::type_name<std::atomic<int>>();
|
||||
CHECK((atomic_name == "INT" || atomic_name == "TEXT"));
|
||||
}
|
||||
|
||||
TEST_CASE("Types: OverflowSmall", "[helpers]") {
|
||||
@ -1128,8 +1133,8 @@ TEST_CASE("Types: LexicalConversionDouble", "[helpers]") {
|
||||
CHECK((float)x == Approx((float)9.12));
|
||||
|
||||
CLI::results_t bad_input = {"hello"};
|
||||
res = CLI::detail::lexical_conversion<long double, double>(input, x);
|
||||
CHECK(res);
|
||||
res = CLI::detail::lexical_conversion<long double, double>(bad_input, x);
|
||||
CHECK_FALSE(res);
|
||||
}
|
||||
|
||||
TEST_CASE("Types: LexicalConversionDoubleTuple", "[helpers]") {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
// Copyright (c) 2017-2020, University of Cincinnati, developed by Henry Schreiner
|
||||
// Copyright (c) 2017-2021, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user