From 357add2c4685362afb188feaaa67b90e4d6d2361 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Mon, 10 Apr 2023 23:26:40 +0100 Subject: Update cxxopts from 3.0 to 3.1.1 !android-nn-driver:9431 Signed-off-by: Jim Flynn Change-Id: I58143445b5c5cf2aafd0838156c9543adce21e6a --- third-party/cxxopts/CHANGELOG.md | 34 + third-party/cxxopts/CHANGELOG.md.license | 2 +- third-party/cxxopts/LICENSE.spdx | 2 +- third-party/cxxopts/README.md | 46 +- third-party/cxxopts/README.md.license | 2 +- third-party/cxxopts/cxxopts.hpp | 3237 +++++++++++++++++------------- 6 files changed, 1956 insertions(+), 1367 deletions(-) (limited to 'third-party') diff --git a/third-party/cxxopts/CHANGELOG.md b/third-party/cxxopts/CHANGELOG.md index df0e110995..782f4d061f 100644 --- a/third-party/cxxopts/CHANGELOG.md +++ b/third-party/cxxopts/CHANGELOG.md @@ -3,6 +3,31 @@ This is the changelog for `cxxopts`, a C++11 library for parsing command line options. The project adheres to semantic versioning. +## 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 @@ -15,10 +40,19 @@ options. The project adheres to semantic versioning. * 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 diff --git a/third-party/cxxopts/CHANGELOG.md.license b/third-party/cxxopts/CHANGELOG.md.license index bf1b5b51c7..2a9007a4fe 100644 --- a/third-party/cxxopts/CHANGELOG.md.license +++ b/third-party/cxxopts/CHANGELOG.md.license @@ -1,4 +1,4 @@ # -# Copyright (c) 2014 Jarryd Beck +# Copyright (c) 2014-2022 Jarryd Beck # SPDX-License-Identifier: MIT # diff --git a/third-party/cxxopts/LICENSE.spdx b/third-party/cxxopts/LICENSE.spdx index e4139cb989..079b1a78e5 100644 --- a/third-party/cxxopts/LICENSE.spdx +++ b/third-party/cxxopts/LICENSE.spdx @@ -4,4 +4,4 @@ FilesAnalyzed: true PackageLicenseConcluded: MIT PackageLicenseInfoFromFiles: MIT PackageLicenseDeclared: MIT -PackageCopyrightText: Copyright (c) 2014, 2015, 2016, 2017 Jarryd Beck +PackageCopyrightText: Copyright (c) 2014-2022 Jarryd Beck diff --git a/third-party/cxxopts/README.md b/third-party/cxxopts/README.md index 9517993d04..de69e5ab88 100644 --- a/third-party/cxxopts/README.md +++ b/third-party/cxxopts/README.md @@ -7,9 +7,9 @@ tagged release version. ## Version 3 breaking changes -If you have used version 2, there are a couple of breaking changes in (the as -yet unreleased, current master) version 3 that you should be aware of. If you are new to -`cxxopts` you can skip this section. +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. @@ -109,9 +109,9 @@ result.unmatched() 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::OptionException`. Errors -defining options derive from `cxxopts::OptionSpecException` and errors -parsing arguments derive from `cxxopts::OptionParseException`. +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. @@ -125,15 +125,37 @@ vector to the `help` function. ## Positional Arguments -Positional arguments can be optionally parsed into one or more options. -To set up positional arguments, call +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.parse_positional({"first", "second", "last"}) +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); ``` -where "last" should be the name of an option with a container type, and the -others should have a single value. +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 @@ -161,6 +183,8 @@ 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 diff --git a/third-party/cxxopts/README.md.license b/third-party/cxxopts/README.md.license index bf1b5b51c7..2a9007a4fe 100644 --- a/third-party/cxxopts/README.md.license +++ b/third-party/cxxopts/README.md.license @@ -1,4 +1,4 @@ # -# Copyright (c) 2014 Jarryd Beck +# Copyright (c) 2014-2022 Jarryd Beck # SPDX-License-Identifier: MIT # diff --git a/third-party/cxxopts/cxxopts.hpp b/third-party/cxxopts/cxxopts.hpp index 5cebc4bd17..8aa17bd63b 100644 --- a/third-party/cxxopts/cxxopts.hpp +++ b/third-party/cxxopts/cxxopts.hpp @@ -1,7 +1,6 @@ /* -Copyright (c) 2014, 2015, 2016, 2017 Jarryd Beck - +Copyright (c) 2014-2022 Jarryd Beck SPDX-License-Identifier: MIT Permission is hereby granted, free of charge, to any person obtaining a copy @@ -24,28 +23,55 @@ 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 #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 -#ifdef __cpp_lib_optional -#include -#define CXXOPTS_HAS_OPTIONAL +#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 #if __cplusplus >= 201603L @@ -59,18 +85,39 @@ THE SOFTWARE. #endif #define CXXOPTS__VERSION_MAJOR 3 -#define CXXOPTS__VERSION_MINOR 0 -#define CXXOPTS__VERSION_PATCH 0 +#define CXXOPTS__VERSION_MINOR 1 +#define CXXOPTS__VERSION_PATCH 1 -namespace cxxopts -{ - static constexpr struct { - uint8_t major, minor, patch; - } version = { - CXXOPTS__VERSION_MAJOR, - CXXOPTS__VERSION_MINOR, - CXXOPTS__VERSION_PATCH - }; +#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, @@ -82,1602 +129,2064 @@ namespace cxxopts #ifdef CXXOPTS_USE_UNICODE #include -namespace cxxopts -{ - typedef icu::UnicodeString String; - - inline - String - toLocalString(std::string s) - { - return icu::UnicodeString::fromUTF8(std::move(s)); - } - - class UnicodeStringIterator : public - std::iterator - { - public: - - 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; - } +namespace cxxopts { - bool - operator!=(const UnicodeStringIterator& rhs) const - { - return !(*this == rhs); - } +using String = icu::UnicodeString; - UnicodeStringIterator& - operator++() - { - ++i; - return *this; - } +inline +String +toLocalString(std::string s) +{ + return icu::UnicodeString::fromUTF8(std::move(s)); +} - UnicodeStringIterator - operator+(int32_t v) - { - return UnicodeStringIterator(s, i + v); - } +// 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: - private: - const icu::UnicodeString* s; - int32_t i; - }; + 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&; - inline - String& - stringAppend(String&s, String a) + UnicodeStringIterator(const icu::UnicodeString* string, int32_t pos) + : s(string) + , i(pos) { - return s.append(std::move(a)); } - inline - String& - stringAppend(String& s, size_t n, UChar32 c) + value_type + operator*() const { - for (size_t i = 0; i != n; ++i) - { - s.append(c); - } - - return s; + return s->char32At(i); } - template - String& - stringAppend(String& s, Iterator begin, Iterator end) + bool + operator==(const UnicodeStringIterator& rhs) const { - while (begin != end) - { - s.append(*begin); - ++begin; - } - - return s; + return s == rhs.s && i == rhs.i; } - inline - size_t - stringLength(const String& s) + bool + operator!=(const UnicodeStringIterator& rhs) const { - return s.length(); + return !(*this == rhs); } - inline - std::string - toUTF8String(const String& s) + UnicodeStringIterator& + operator++() { - std::string result; - s.toUTF8String(result); - - return result; + ++i; + return *this; } - inline - bool - empty(const String& s) + UnicodeStringIterator + operator+(int32_t v) { - return s.isEmpty(); + 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)); } -namespace std +inline +String& +stringAppend(String& s, std::size_t n, UChar32 c) { - inline - cxxopts::UnicodeStringIterator - begin(const icu::UnicodeString& s) + for (std::size_t i = 0; i != n; ++i) { - return cxxopts::UnicodeStringIterator(&s, 0); + s.append(c); } - inline - cxxopts::UnicodeStringIterator - end(const icu::UnicodeString& s) + return s; +} + +template +String& +stringAppend(String& s, Iterator begin, Iterator end) +{ + while (begin != end) { - return cxxopts::UnicodeStringIterator(&s, s.length()); + 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 +namespace cxxopts { + +using String = std::string; + +template +T +toLocalString(T&& t) { - typedef std::string String; + return std::forward(t); +} - template - T - toLocalString(T&& t) - { - return std::forward(t); - } +inline +std::size_t +stringLength(const String& s) +{ + return s.length(); +} - inline - 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, const String& a) - { - return s.append(a); - } +inline +String& +stringAppend(String& s, std::size_t n, char c) +{ + return s.append(n, c); +} - inline - String& - stringAppend(String& s, 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 - String& - stringAppend(String& s, Iterator begin, Iterator end) - { - return s.append(begin, end); - } +template +std::string +toUTF8String(T&& t) +{ + return std::forward(t); +} - template - std::string - toUTF8String(T&& t) - { - return std::forward(t); - } +inline +bool +empty(const std::string& s) +{ + return s.empty(); +} - inline - bool - empty(const std::string& s) - { - return s.empty(); - } } // namespace cxxopts //ifdef CXXOPTS_USE_UNICODE #endif -namespace cxxopts -{ - namespace - { -#ifdef _WIN32 - const std::string LQUOTE("\'"); - const std::string RQUOTE("\'"); -#else - const std::string LQUOTE("‘"); - const std::string RQUOTE("’"); -#endif - } // namespace +namespace cxxopts { -#if defined(__GNUC__) -// 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 -#pragma GCC diagnostic ignored "-Wnon-virtual-dtor" -#pragma GCC diagnostic push -// This will be ignored under other compilers like LLVM clang. -#endif - class Value : public std::enable_shared_from_this - { - public: +namespace { +CXXOPTS_LINKONCE_CONST std::string LQUOTE("\'"); +CXXOPTS_LINKONCE_CONST std::string RQUOTE("\'"); +} // namespace - virtual ~Value() = default; +// 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") - virtual - std::shared_ptr - clone() const = 0; +// some older versions of GCC warn under this warning +CXXOPTS_IGNORE_WARNING("-Weffc++") +class Value : public std::enable_shared_from_this +{ + public: - virtual void - parse(const std::string& text) const = 0; + virtual ~Value() = default; - virtual void - parse() const = 0; + virtual + std::shared_ptr + clone() const = 0; - virtual bool - has_default() const = 0; + virtual void + parse(const std::string& text) const = 0; - virtual bool - is_container() const = 0; + virtual void + parse() const = 0; - virtual bool - has_implicit() const = 0; + virtual bool + has_default() const = 0; - virtual std::string - get_default_value() const = 0; + virtual bool + is_container() const = 0; - virtual std::string - get_implicit_value() const = 0; + virtual bool + has_implicit() const = 0; - virtual std::shared_ptr - default_value(const std::string& value) = 0; + virtual std::string + get_default_value() const = 0; - virtual std::shared_ptr - implicit_value(const std::string& value) = 0; + virtual std::string + get_implicit_value() const = 0; - virtual std::shared_ptr - no_implicit_value() = 0; + virtual std::shared_ptr + default_value(const std::string& value) = 0; - virtual bool - is_boolean() const = 0; - }; -#if defined(__GNUC__) -#pragma GCC diagnostic pop -#endif - class OptionException : public std::exception - { - public: - explicit OptionException(std::string message) - : m_message(std::move(message)) - { - } + virtual std::shared_ptr + implicit_value(const std::string& value) = 0; - CXXOPTS_NODISCARD - const char* - what() const noexcept override - { - return m_message.c_str(); - } + virtual std::shared_ptr + no_implicit_value() = 0; - private: - std::string m_message; - }; + virtual bool + is_boolean() const = 0; +}; - class OptionSpecException : public OptionException - { - public: +CXXOPTS_DIAGNOSTIC_POP - explicit OptionSpecException(const std::string& message) - : OptionException(message) - { - } - }; +namespace exceptions { - class OptionParseException : public OptionException +class exception : public std::exception +{ + public: + explicit exception(std::string message) + : m_message(std::move(message)) { - public: - explicit OptionParseException(const std::string& message) - : OptionException(message) - { - } - }; + } - class option_exists_error : public OptionSpecException + CXXOPTS_NODISCARD + const char* + what() const noexcept override { - public: - explicit option_exists_error(const std::string& option) - : OptionSpecException("Option " + LQUOTE + option + RQUOTE + " already exists") - { - } - }; + return m_message.c_str(); + } - class invalid_option_format_error : public OptionSpecException - { - public: - explicit invalid_option_format_error(const std::string& format) - : OptionSpecException("Invalid option format " + LQUOTE + format + RQUOTE) - { - } - }; + private: + std::string m_message; +}; - class option_syntax_exception : public OptionParseException { - public: - explicit option_syntax_exception(const std::string& text) - : OptionParseException("Argument " + LQUOTE + text + RQUOTE + - " starts with a - but has incorrect syntax") - { - } - }; +class specification : public exception +{ + public: - class option_not_exists_exception : public OptionParseException + explicit specification(const std::string& message) + : exception(message) { - public: - explicit option_not_exists_exception(const std::string& option) - : OptionParseException("Option " + LQUOTE + option + RQUOTE + " does not exist") - { - } - }; + } +}; - class missing_argument_exception : public OptionParseException +class parsing : public exception +{ + public: + explicit parsing(const std::string& message) + : exception(message) { - public: - explicit missing_argument_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " is missing an argument" - ) - { - } - }; + } +}; - class option_requires_argument_exception : public OptionParseException +class option_already_exists : public specification +{ + public: + explicit option_already_exists(const std::string& option) + : specification("Option " + LQUOTE + option + RQUOTE + " already exists") { - public: - explicit option_requires_argument_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " requires an argument" - ) - { - } - }; + } +}; - class option_not_has_argument_exception : public OptionParseException +class invalid_option_format : public specification +{ + public: + explicit invalid_option_format(const std::string& format) + : specification("Invalid option format " + LQUOTE + format + RQUOTE) { - public: - option_not_has_argument_exception - ( - const std::string& option, - const std::string& arg - ) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + - " does not take an argument, but argument " + - LQUOTE + arg + RQUOTE + " given" - ) - { - } - }; + } +}; - class option_not_present_exception : public OptionParseException +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") { - public: - explicit option_not_present_exception(const std::string& option) - : OptionParseException("Option " + LQUOTE + option + RQUOTE + " not present") - { - } - }; + } +}; - class option_has_no_value_exception : public OptionException +class no_such_option : public parsing +{ + public: + explicit no_such_option(const std::string& option) + : parsing("Option " + LQUOTE + option + RQUOTE + " does not exist") { - public: - explicit option_has_no_value_exception(const std::string& option) - : OptionException( - option.empty() ? - ("Option " + LQUOTE + option + RQUOTE + " has no value") : - "Option has no value") - { - } - }; + } +}; - class argument_incorrect_type : public OptionParseException - { - public: - explicit argument_incorrect_type - ( - const std::string& arg +class missing_argument : public parsing +{ + public: + explicit missing_argument(const std::string& option) + : parsing( + "Option " + LQUOTE + option + RQUOTE + " is missing an argument" ) - : OptionParseException( - "Argument " + LQUOTE + arg + RQUOTE + " failed to parse" - ) - { - } - }; - - class option_required_exception : public OptionParseException { - public: - explicit option_required_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " is required but not present" - ) - { - } - }; + } +}; - template - void throw_or_mimic(const std::string& text) +class option_requires_argument : public parsing +{ + public: + explicit option_requires_argument(const std::string& option) + : parsing( + "Option " + LQUOTE + option + RQUOTE + " requires an argument" + ) { - 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 } +}; - namespace values +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" + ) { - namespace - { - std::basic_regex integer_pattern - ("(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"); - std::basic_regex truthy_pattern - ("(t|T)(rue)?|1"); - std::basic_regex falsy_pattern - ("(f|F)(alse)?|0"); - } // namespace - - 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); - } - } - } - }; +class requested_option_not_present : public parsing +{ + public: + explicit requested_option_not_present(const std::string& option) + : parsing("Option " + LQUOTE + option + RQUOTE + " not present") + { + } +}; - template - struct SignedCheck - { - template - void - operator()(bool, U, const std::string&) {} - }; - - template - void - check_signed_range(bool negative, U value, const std::string& text) - { - SignedCheck::is_signed>()(negative, value, text); - } - } // namespace detail +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 - checked_negate(R& r, T&& t, const std::string&, std::true_type) + +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) { - // 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); + return true; } + } + else if (strncmp(pdata, "1\0", 2) == 0) + { + return true; + } + return false; +} - template - void - checked_negate(R&, T&&, const std::string& text, std::false_type) +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) { - throw_or_mimic(text); + 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(); - template - void - integer_parser(const std::string& text, T& value) + 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:]]*/ { - std::smatch match; - std::regex_match(text, match, integer_pattern); + const char* option_name_valid_chars = + "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz" + "0123456789" + "_-.?"; - if (match.length() == 0) - { - throw_or_mimic(text); + 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; +} - if (match.length(4) > 0) +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 == '_') { - value = 0; - return; + 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; +} - using US = typename std::make_unsigned::type; +#else // CXXOPTS_NO_REGEX + +namespace { +CXXOPTS_LINKONCE +std::basic_regex integer_pattern + ("(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"); +CXXOPTS_LINKONCE +std::basic_regex truthy_pattern + ("(t|T)(rue)?|1"); +CXXOPTS_LINKONCE +std::basic_regex falsy_pattern + ("(f|F)(alse)?|0"); +CXXOPTS_LINKONCE +std::basic_regex option_matcher + ("--([[:alnum:]][-_[:alnum:]\\.]+)(=(.*))?|-([[:alnum:]].*)"); +CXXOPTS_LINKONCE +std::basic_regex option_specifier + ("([[:alnum:]][-_[:alnum:]\\.]*)(,[ ]*[[:alnum:]][-_[:alnum:]]*)*"); +CXXOPTS_LINKONCE +std::basic_regex option_specifier_separator(", *"); + +} // namespace + +inline IntegerDesc SplitInteger(const std::string &text) +{ + std::smatch match; + std::regex_match(text, match, integer_pattern); - constexpr bool is_signed = std::numeric_limits::is_signed; - const bool negative = match.length(1) > 0; - const uint8_t base = match.length(2) > 0 ? 16 : 10; + if (match.length() == 0) + { + throw_or_mimic(text); + } - auto value_match = match[3]; + IntegerDesc desc; + desc.negative = match[1]; + desc.base = match[2]; + desc.value = match[3]; - US result = 0; + if (match.length(4) > 0) + { + desc.base = match[5]; + desc.value = "0"; + return desc; + } - for (auto iter = value_match.first; iter != value_match.second; ++iter) - { - US digit = 0; + return desc; +} - if (*iter >= '0' && *iter <= '9') - { - digit = static_cast(*iter - '0'); - } - else if (base == 16 && *iter >= 'a' && *iter <= 'f') - { - digit = static_cast(*iter - 'a' + 10); - } - else if (base == 16 && *iter >= 'A' && *iter <= 'F') - { - digit = static_cast(*iter - 'A' + 10); - } - else - { - throw_or_mimic(text); - } +inline bool IsTrueText(const std::string &text) +{ + std::smatch result; + std::regex_match(text, result, truthy_pattern); + return !result.empty(); +} - const US next = static_cast(result * base + digit); - if (result > next) - { - throw_or_mimic(text); - } +inline bool IsFalseText(const std::string &text) +{ + std::smatch result; + std::regex_match(text, result, falsy_pattern); + return !result.empty(); +} - result = next; - } +// 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) +{ + if (!std::regex_match(text.c_str(), option_specifier)) + { + throw_or_mimic(text); + } - detail::check_signed_range(negative, result, text); + OptionNames split_names; - if (negative) - { - checked_negate(value, result, text, std::integral_constant()); - } - else - { - value = static_cast(result); - } - } + constexpr int use_non_matches { -1 }; + auto token_iterator = std::sregex_token_iterator( + text.begin(), text.end(), option_specifier_separator, use_non_matches); + std::copy(token_iterator, std::sregex_token_iterator(), std::back_inserter(split_names)); + return split_names; +} - template - void stringstream_parser(const std::string& text, T& value) - { - std::stringstream in(text); - in >> value; - if (!in) { - throw_or_mimic(text); - } - } +inline ArguDesc ParseArgument(const char *arg, bool &matched) +{ + std::match_results result; + std::regex_match(arg, result, option_matcher); + matched = !result.empty(); - inline - void - parse_value(const std::string& text, uint8_t& value) + 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) { - integer_parser(text, value); + 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; - inline - void - parse_value(const std::string& text, int8_t& value) +template +struct SignedCheck +{ + template + void + operator()(bool negative, U u, const std::string& text) + { + if (negative) { - integer_parser(text, value); + if (u > static_cast((std::numeric_limits::min)())) + { + throw_or_mimic(text); + } } - - inline - void - parse_value(const std::string& text, uint16_t& value) + else { - integer_parser(text, value); + 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); +} - inline - void - parse_value(const std::string& text, int16_t& value) +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') { - integer_parser(text, value); + digit = static_cast(ch - '0'); } - - inline - void - parse_value(const std::string& text, uint32_t& value) + else if (base == 16 && ch >= 'a' && ch <= 'f') { - integer_parser(text, value); + digit = static_cast(ch - 'a' + 10); } - - inline - void - parse_value(const std::string& text, int32_t& value) + else if (base == 16 && ch >= 'A' && ch <= 'F') { - integer_parser(text, value); + digit = static_cast(ch - 'A' + 10); } - - inline - void - parse_value(const std::string& text, uint64_t& value) + else { - integer_parser(text, value); + throw_or_mimic(text); } - inline - void - parse_value(const std::string& text, int64_t& value) + const US next = static_cast(result * base + digit); + if (result > next) { - integer_parser(text, value); + throw_or_mimic(text); } - inline - void - parse_value(const std::string& text, bool& value) - { - std::smatch result; - std::regex_match(text, result, truthy_pattern); + result = next; + } - if (!result.empty()) - { - value = true; - return; - } + detail::check_signed_range(negative, result, text); - std::regex_match(text, result, falsy_pattern); - if (!result.empty()) - { - value = false; - return; - } + if (negative) + { + checked_negate(value, result, text, std::integral_constant()); + } + else + { + value = static_cast(result); + } +} - throw_or_mimic(text); - } +template +void stringstream_parser(const std::string& text, T& value) +{ + std::stringstream in(text); + in >> value; + if (!in) { + throw_or_mimic(text); + } +} - inline - void - parse_value(const std::string& text, std::string& value) - { - value = text; - } +template ::value>::type* = nullptr + > +void parse_value(const std::string& text, T& value) +{ + integer_parser(text, value); +} - // 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 - void - parse_value(const std::string& text, T& value) { - stringstream_parser(text, value); - } +inline +void +parse_value(const std::string& text, bool& value) +{ + if (parser_tool::IsTrueText(text)) + { + value = true; + return; + } - template - void - parse_value(const std::string& text, std::vector& value) - { - 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)); - } - } + 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); +} + +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)); + } +} #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); - } +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); - } +inline +void parse_value(const std::string& text, char& c) +{ + if (text.length() != 1) + { + throw_or_mimic(text); + } - c = text[0]; - } + c = text[0]; +} - template - struct type_is_container - { - static constexpr bool value = false; - }; +template +struct type_is_container +{ + static constexpr bool value = false; +}; - template - struct type_is_container> - { - static constexpr bool value = true; - }; +template +struct type_is_container> +{ + static constexpr bool value = true; +}; - template - class abstract_value : public Value +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 { - using Self = abstract_value; + m_store = rhs.m_store; + } - public: - abstract_value() - : m_result(std::make_shared()) - , m_store(m_result.get()) - { - } + m_default = rhs.m_default; + m_implicit = rhs.m_implicit; + m_default_value = rhs.m_default_value; + m_implicit_value = rhs.m_implicit_value; + } - explicit abstract_value(T* t) - : m_store(t) - { - } + void + parse(const std::string& text) const override + { + parse_value(text, *m_store); + } - ~abstract_value() override = default; + bool + is_container() const override + { + return type_is_container::value; + } - abstract_value& operator=(const abstract_value&) = default; + void + parse() const override + { + parse_value(m_default_value, *m_store); + } - 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; - } + bool + has_default() const override + { + return m_default; + } - m_default = rhs.m_default; - m_implicit = rhs.m_implicit; - m_default_value = rhs.m_default_value; - m_implicit_value = rhs.m_implicit_value; - } + bool + has_implicit() const override + { + return m_implicit; + } - void - parse(const std::string& text) const override - { - parse_value(text, *m_store); - } + std::shared_ptr + default_value(const std::string& value) override + { + m_default = true; + m_default_value = value; + return shared_from_this(); + } - bool - is_container() const override - { - return type_is_container::value; - } + std::shared_ptr + implicit_value(const std::string& value) override + { + m_implicit = true; + m_implicit_value = value; + return shared_from_this(); + } - void - parse() const override - { - parse_value(m_default_value, *m_store); - } + std::shared_ptr + no_implicit_value() override + { + m_implicit = false; + return shared_from_this(); + } - bool - has_default() const override - { - return m_default; - } + std::string + get_default_value() const override + { + return m_default_value; + } - bool - has_implicit() const override - { - return m_implicit; - } + std::string + get_implicit_value() const override + { + return m_implicit_value; + } - std::shared_ptr - default_value(const std::string& value) override - { - m_default = true; - m_default_value = value; - return shared_from_this(); - } + bool + is_boolean() const override + { + return std::is_same::value; + } - std::shared_ptr - implicit_value(const std::string& value) override - { - m_implicit = true; - m_implicit_value = value; - return shared_from_this(); - } + const T& + get() const + { + if (m_store == nullptr) + { + return *m_result; + } + return *m_store; + } - std::shared_ptr - no_implicit_value() override - { - m_implicit = false; - return shared_from_this(); - } + protected: + std::shared_ptr m_result{}; + T* m_store{}; - std::string - get_default_value() const override - { - return m_default_value; - } + bool m_default = false; + bool m_implicit = false; - std::string - get_implicit_value() const override - { - return m_implicit_value; - } + std::string m_default_value{}; + std::string m_implicit_value{}; +}; - bool - is_boolean() const override - { - return std::is_same::value; - } +template +class standard_value : public abstract_value +{ + public: + using abstract_value::abstract_value; - const T& - get() const - { - if (m_store == nullptr) - { - return *m_result; - } - return *m_store; - } + CXXOPTS_NODISCARD + std::shared_ptr + clone() const override + { + return std::make_shared>(*this); + } +}; - protected: - std::shared_ptr m_result{}; - T* m_store{}; +template <> +class standard_value : public abstract_value +{ + public: + ~standard_value() override = default; - bool m_default = false; - bool m_implicit = false; + standard_value() + { + set_default_and_implicit(); + } - std::string m_default_value{}; - std::string m_implicit_value{}; - }; + explicit standard_value(bool* b) + : abstract_value(b) + { + m_implicit = true; + m_implicit_value = "true"; + } - template - class standard_value : public abstract_value - { - public: - using abstract_value::abstract_value; + std::shared_ptr + clone() const override + { + return std::make_shared>(*this); + } - CXXOPTS_NODISCARD - std::shared_ptr - clone() const - { - return std::make_shared>(*this); - } - }; + private: - template <> - class standard_value : public abstract_value - { - public: - ~standard_value() override = default; + void + set_default_and_implicit() + { + m_default = true; + m_default_value = "false"; + m_implicit = true; + m_implicit_value = "true"; + } +}; - standard_value() - { - set_default_and_implicit(); - } +} // namespace values - explicit standard_value(bool* b) - : abstract_value(b) - { - set_default_and_implicit(); - } +template +std::shared_ptr +value() +{ + return std::make_shared>(); +} - std::shared_ptr - clone() const override - { - return std::make_shared>(*this); - } +template +std::shared_ptr +value(T& t) +{ + return std::make_shared>(&t); +} - private: +class OptionAdder; - void - set_default_and_implicit() - { - m_default = true; - m_default_value = "false"; - m_implicit = true; - m_implicit_value = "true"; - } - }; - } // namespace values +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(); +} - template - std::shared_ptr - value() +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) { - return std::make_shared>(); + m_hash = std::hash{}(first_long_name() + m_short); } - template + 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 - value(T& t) + make_storage() const { - return std::make_shared>(&t); + return m_value->clone(); } - class OptionAdder; + CXXOPTS_NODISCARD + const std::string& + short_name() const + { + return m_short; + } - class OptionDetails + CXXOPTS_NODISCARD + const std::string& + first_long_name() const { - public: - OptionDetails - ( - std::string short_, - std::string 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{}(m_long + m_short); - } + return first_or_empty(m_long); + } - OptionDetails(const OptionDetails& rhs) - : m_desc(rhs.m_desc) - , m_count(rhs.m_count) - { - m_value = rhs.m_value->clone(); - } + CXXOPTS_NODISCARD + const std::string& + essential_name() const + { + return m_long.empty() ? m_short : m_long.front(); + } - OptionDetails(OptionDetails&& rhs) = default; + CXXOPTS_NODISCARD + const OptionNames & + long_names() const + { + return m_long; + } - CXXOPTS_NODISCARD - const String& - description() const - { - return m_desc; - } + std::size_t + hash() const + { + return m_hash; + } - CXXOPTS_NODISCARD - const Value& - value() const { - return *m_value; - } + private: + std::string m_short{}; + OptionNames m_long{}; + String m_desc{}; + std::shared_ptr m_value{}; + int m_count; - CXXOPTS_NODISCARD - std::shared_ptr - make_storage() const - { - return m_value->clone(); - } + std::size_t m_hash{}; +}; - CXXOPTS_NODISCARD - const std::string& - short_name() const - { - return m_short; - } +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{}; +}; - CXXOPTS_NODISCARD - const std::string& - long_name() const - { - return m_long; - } +class OptionValue +{ + public: + 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(); + } - size_t - hash() const - { - return m_hash; - } + void + parse_default(const std::shared_ptr& details) + { + ensure_value(details); + m_default = true; + m_long_names = &details->long_names(); + m_value->parse(); + } - private: - std::string m_short{}; - std::string m_long{}; - String m_desc{}; - std::shared_ptr m_value{}; - int m_count; + void + parse_no_value(const std::shared_ptr& details) + { + m_long_names = &details->long_names(); + } - size_t m_hash{}; - }; +#if defined(CXXOPTS_NULL_DEREF_IGNORE) +CXXOPTS_DIAGNOSTIC_PUSH +CXXOPTS_IGNORE_WARNING("-Wnull-dereference") +#endif - struct HelpOptionDetails - { - std::string s; - std::string 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; - }; + CXXOPTS_NODISCARD + std::size_t + count() const noexcept + { + return m_count; + } + +#if defined(CXXOPTS_NULL_DEREF_IGNORE) +CXXOPTS_DIAGNOSTIC_POP +#endif - struct HelpGroupDetails + // TODO: maybe default options should count towards the number of arguments + CXXOPTS_NODISCARD + bool + has_default() const noexcept { - std::string name{}; - std::string description{}; - std::vector options{}; - }; + return m_default; + } - class OptionValue + template + const T& + as() const { - public: - void - parse - ( - const std::shared_ptr& details, - const std::string& text - ) - { - ensure_value(details); - ++m_count; - m_value->parse(text); - m_long_name = &details->long_name(); + if (m_value == nullptr) { + throw_or_mimic( + m_long_names == nullptr ? "" : first_or_empty(*m_long_names)); } - void - parse_default(const std::shared_ptr& details) - { - ensure_value(details); - m_default = true; - m_long_name = &details->long_name(); - m_value->parse(); - } + return CXXOPTS_RTTI_CAST&>(*m_value).get(); + } - CXXOPTS_NODISCARD - size_t - count() const noexcept + private: + void + ensure_value(const std::shared_ptr& details) + { + if (m_value == nullptr) { - return m_count; + m_value = details->make_storage(); } + } - // 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_name == nullptr ? "" : *m_long_name); + 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(); -#ifdef CXXOPTS_NO_RTTI - return static_cast&>(*m_value).get(); -#else - return dynamic_cast&>(*m_value).get(); -#endif + if (m_iter == m_pr->m_sequential.end()) + { + m_sequential = false; + m_iter = m_pr->m_defaults.begin(); + } + } } +CXXOPTS_DIAGNOSTIC_POP - private: - void - ensure_value(const std::shared_ptr& details) + Iterator& operator++() { - if (m_value == nullptr) + ++m_iter; + if(m_sequential && m_iter == m_pr->m_sequential.end()) { - m_value = details->make_storage(); + m_sequential = false; + m_iter = m_pr->m_defaults.begin(); + return *this; } + return *this; } + Iterator operator++(int) + { + Iterator retval = *this; + ++(*this); + return retval; + } - const std::string* m_long_name = 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{}; - size_t m_count = 0; - bool m_default = false; - }; - - class KeyValue - { - public: - KeyValue(std::string key_, std::string value_) - : m_key(std::move(key_)) - , m_value(std::move(value_)) + bool operator==(const Iterator& other) const { + return (m_sequential == other.m_sequential) && (m_iter == other.m_iter); } - CXXOPTS_NODISCARD - const std::string& - key() const + bool operator!=(const Iterator& other) const { - return m_key; + return !(*this == other); } - CXXOPTS_NODISCARD - const std::string& - value() const + const KeyValue& operator*() { - return m_value; + return *m_iter; } - template - T - as() const + const KeyValue* operator->() { - T result; - values::parse_value(m_value, result); - return result; + return m_iter.operator->(); } private: - std::string m_key; - std::string m_value; + const ParseResult* m_pr; + std::vector::const_iterator m_iter; + bool m_sequential = true; }; - using ParsedHashMap = std::unordered_map; - using NameHashMap = std::unordered_map; + ParseResult() = default; + ParseResult(const ParseResult&) = default; - class ParseResult + 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)) { - public: + } - ParseResult() {} + ParseResult& operator=(ParseResult&&) = default; + ParseResult& operator=(const ParseResult&) = default; + + Iterator + begin() const + { + return Iterator(this); + } - ParseResult(const ParseResult&) = default; + Iterator + end() const + { + return Iterator(this, true); + } - ParseResult(NameHashMap&& keys, ParsedHashMap&& values, std::vector sequential, std::vector&& unmatched_args) - : m_keys(std::move(keys)) - , m_values(std::move(values)) - , m_sequential(std::move(sequential)) - , m_unmatched(std::move(unmatched_args)) + std::size_t + count(const std::string& o) const + { + auto iter = m_keys.find(o); + if (iter == m_keys.end()) { + return 0; } - ParseResult& operator=(ParseResult&&) = default; - ParseResult& operator=(const ParseResult&) = default; + auto viter = m_values.find(iter->second); - size_t - count(const std::string& o) const + if (viter == m_values.end()) { - auto iter = m_keys.find(o); - if (iter == m_keys.end()) - { - return 0; - } + return 0; + } - auto viter = m_values.find(iter->second); + return viter->second.count(); + } - if (viter == m_values.end()) - { - return 0; - } + const OptionValue& + operator[](const std::string& option) const + { + auto iter = m_keys.find(option); - return viter->second.count(); + if (iter == m_keys.end()) + { + throw_or_mimic(option); } - const OptionValue& - operator[](const std::string& option) const + auto viter = m_values.find(iter->second); + + if (viter == m_values.end()) { - auto iter = m_keys.find(option); + throw_or_mimic(option); + } - if (iter == m_keys.end()) - { - throw_or_mimic(option); - } + return viter->second; + } - auto viter = m_values.find(iter->second); + const std::vector& + arguments() const + { + return m_sequential; + } - if (viter == m_values.end()) - { - throw_or_mimic(option); - } + const std::vector& + unmatched() const + { + return m_unmatched; + } - return viter->second; - } + const std::vector& + defaults() const + { + return m_defaults; + } - const std::vector& - arguments() const + const std::string + arguments_string() const + { + std::string result; + for(const auto& kv: m_sequential) { - return m_sequential; + result += kv.key() + " = " + kv.value() + "\n"; } - - const std::vector& - unmatched() const + for(const auto& kv: m_defaults) { - return m_unmatched; + result += kv.key() + " = " + kv.value() + " " + "(default)" + "\n"; } + return result; + } - private: - NameHashMap m_keys{}; - ParsedHashMap m_values{}; - std::vector m_sequential{}; - std::vector m_unmatched{}; - }; + private: + NameHashMap m_keys{}; + ParsedHashMap m_values{}; + std::vector m_sequential{}; + std::vector m_defaults{}; + std::vector m_unmatched{}; +}; - struct Option +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)) { - 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_; - }; + 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; +using OptionMap = std::unordered_map>; +using PositionalList = std::vector; +using PositionalListIterator = PositionalList::const_iterator; - class OptionParser +class OptionParser +{ + public: + OptionParser(const OptionMap& options, const PositionalList& positional, bool allow_unrecognised) + : m_options(options) + , m_positional(positional) + , m_allow_unrecognised(allow_unrecognised) { - 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); + ParseResult + parse(int argc, const char* const* argv); - bool - consume_positional(const std::string& a, PositionalListIterator& next); + 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 + checked_parse_arg + ( + int argc, + const char* const* argv, + int& current, + const std::shared_ptr& value, + const std::string& name + ); - void - add_to_option(OptionMap::const_iterator iter, const std::string& option, const std::string& arg); + void + add_to_option(OptionMap::const_iterator iter, const std::string& option, const std::string& arg); - void - parse_option - ( - const std::shared_ptr& value, - const std::string& name, - 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_default(const std::shared_ptr& details); - private: + void + parse_no_value(const std::shared_ptr& details); - void finalise_aliases(); + private: - const OptionMap& m_options; - const PositionalList& m_positional; + void finalise_aliases(); - std::vector m_sequential{}; - bool m_allow_unrecognised; + const OptionMap& m_options; + const PositionalList& m_positional; - ParsedHashMap m_parsed{}; - NameHashMap m_keys{}; - }; + std::vector m_sequential{}; + std::vector m_defaults{}; + bool m_allow_unrecognised; - class Options + 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()) { - public: + } - explicit Options(std::string program, std::string help_string = "") - : m_program(std::move(program)) - , 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_options(std::make_shared()) - { - } + Options& + positional_help(std::string help_text) + { + m_positional_help = std::move(help_text); + return *this; + } - 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& - 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& - show_positional_help() - { - m_show_positional = true; - return *this; - } + Options& + allow_unrecognised_options() + { + m_allow_unrecognised = 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; + } - ParseResult - parse(int argc, const char* const* argv); + Options& + set_tab_expansion(bool expansion=true) + { + m_tab_expansion = expansion; + return *this; + } - OptionAdder - add_options(std::string group = ""); + ParseResult + parse(int argc, const char* const* argv); - void - add_options - ( - const std::string& group, - std::initializer_list