Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1 | /* |
| 2 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 3 | Copyright (c) 2014-2022 Jarryd Beck |
Jim Flynn | 6217c3d | 2022-06-14 10:58:23 +0100 | [diff] [blame] | 4 | SPDX-License-Identifier: MIT |
| 5 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 6 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | of this software and associated documentation files (the "Software"), to deal |
| 8 | in the Software without restriction, including without limitation the rights |
| 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | copies of the Software, and to permit persons to whom the Software is |
| 11 | furnished to do so, subject to the following conditions: |
| 12 | |
| 13 | The above copyright notice and this permission notice shall be included in |
| 14 | all copies or substantial portions of the Software. |
| 15 | |
| 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | THE SOFTWARE. |
| 23 | |
| 24 | */ |
| 25 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 26 | // vim: ts=2:sw=2:expandtab |
| 27 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 28 | #ifndef CXXOPTS_HPP_INCLUDED |
| 29 | #define CXXOPTS_HPP_INCLUDED |
| 30 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 31 | #include <cstring> |
| 32 | #include <exception> |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 33 | #include <limits> |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 34 | #include <initializer_list> |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 35 | #include <map> |
| 36 | #include <memory> |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 37 | #include <sstream> |
| 38 | #include <string> |
| 39 | #include <unordered_map> |
| 40 | #include <unordered_set> |
| 41 | #include <utility> |
| 42 | #include <vector> |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 43 | #include <algorithm> |
| 44 | #include <locale> |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 45 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 46 | #ifdef CXXOPTS_NO_EXCEPTIONS |
| 47 | #include <iostream> |
| 48 | #endif |
| 49 | |
| 50 | #if defined(__GNUC__) && !defined(__clang__) |
| 51 | # if (__GNUC__ * 10 + __GNUC_MINOR__) < 49 |
| 52 | # define CXXOPTS_NO_REGEX true |
| 53 | # endif |
| 54 | #endif |
| 55 | #if defined(_MSC_VER) && !defined(__clang__) |
| 56 | #define CXXOPTS_LINKONCE_CONST __declspec(selectany) extern |
| 57 | #define CXXOPTS_LINKONCE __declspec(selectany) extern |
| 58 | #else |
| 59 | #define CXXOPTS_LINKONCE_CONST |
| 60 | #define CXXOPTS_LINKONCE |
| 61 | #endif |
| 62 | |
| 63 | #ifndef CXXOPTS_NO_REGEX |
| 64 | # include <regex> |
| 65 | #endif // CXXOPTS_NO_REGEX |
| 66 | |
| 67 | // Nonstandard before C++17, which is coincidentally what we also need for <optional> |
| 68 | #ifdef __has_include |
| 69 | # if __has_include(<optional>) |
| 70 | # include <optional> |
| 71 | # ifdef __cpp_lib_optional |
| 72 | # define CXXOPTS_HAS_OPTIONAL |
| 73 | # endif |
| 74 | # endif |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 75 | #endif |
| 76 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 77 | #if __cplusplus >= 201603L |
| 78 | #define CXXOPTS_NODISCARD [[nodiscard]] |
| 79 | #else |
| 80 | #define CXXOPTS_NODISCARD |
| 81 | #endif |
| 82 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 83 | #ifndef CXXOPTS_VECTOR_DELIMITER |
| 84 | #define CXXOPTS_VECTOR_DELIMITER ',' |
| 85 | #endif |
| 86 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 87 | #define CXXOPTS__VERSION_MAJOR 3 |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 88 | #define CXXOPTS__VERSION_MINOR 1 |
| 89 | #define CXXOPTS__VERSION_PATCH 1 |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 90 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 91 | #if (__GNUC__ < 10 || (__GNUC__ == 10 && __GNUC_MINOR__ < 1)) && __GNUC__ >= 6 |
| 92 | #define CXXOPTS_NULL_DEREF_IGNORE |
| 93 | #endif |
| 94 | |
| 95 | #if defined(__GNUC__) |
| 96 | #define DO_PRAGMA(x) _Pragma(#x) |
| 97 | #define CXXOPTS_DIAGNOSTIC_PUSH DO_PRAGMA(GCC diagnostic push) |
| 98 | #define CXXOPTS_DIAGNOSTIC_POP DO_PRAGMA(GCC diagnostic pop) |
| 99 | #define CXXOPTS_IGNORE_WARNING(x) DO_PRAGMA(GCC diagnostic ignored x) |
| 100 | #else |
| 101 | // define other compilers here if needed |
| 102 | #define CXXOPTS_DIAGNOSTIC_PUSH |
| 103 | #define CXXOPTS_DIAGNOSTIC_POP |
| 104 | #define CXXOPTS_IGNORE_WARNING(x) |
| 105 | #endif |
| 106 | |
| 107 | #ifdef CXXOPTS_NO_RTTI |
| 108 | #define CXXOPTS_RTTI_CAST static_cast |
| 109 | #else |
| 110 | #define CXXOPTS_RTTI_CAST dynamic_cast |
| 111 | #endif |
| 112 | |
| 113 | namespace cxxopts { |
| 114 | static constexpr struct { |
| 115 | uint8_t major, minor, patch; |
| 116 | } version = { |
| 117 | CXXOPTS__VERSION_MAJOR, |
| 118 | CXXOPTS__VERSION_MINOR, |
| 119 | CXXOPTS__VERSION_PATCH |
| 120 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 121 | } // namespace cxxopts |
| 122 | |
| 123 | //when we ask cxxopts to use Unicode, help strings are processed using ICU, |
| 124 | //which results in the correct lengths being computed for strings when they |
| 125 | //are formatted for the help output |
| 126 | //it is necessary to make sure that <unicode/unistr.h> can be found by the |
| 127 | //compiler, and that icu-uc is linked in to the binary. |
| 128 | |
| 129 | #ifdef CXXOPTS_USE_UNICODE |
| 130 | #include <unicode/unistr.h> |
| 131 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 132 | namespace cxxopts { |
| 133 | |
| 134 | using String = icu::UnicodeString; |
| 135 | |
| 136 | inline |
| 137 | String |
| 138 | toLocalString(std::string s) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 139 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 140 | return icu::UnicodeString::fromUTF8(std::move(s)); |
| 141 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 142 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 143 | // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we want to silence it: |
| 144 | // warning: base class 'class std::enable_shared_from_this<cxxopts::Value>' has accessible non-virtual destructor |
| 145 | CXXOPTS_DIAGNOSTIC_PUSH |
| 146 | CXXOPTS_IGNORE_WARNING("-Wnon-virtual-dtor") |
| 147 | // This will be ignored under other compilers like LLVM clang. |
| 148 | class UnicodeStringIterator |
| 149 | { |
| 150 | public: |
| 151 | |
| 152 | using iterator_category = std::forward_iterator_tag; |
| 153 | using value_type = int32_t; |
| 154 | using difference_type = std::ptrdiff_t; |
| 155 | using pointer = value_type*; |
| 156 | using reference = value_type&; |
| 157 | |
| 158 | UnicodeStringIterator(const icu::UnicodeString* string, int32_t pos) |
| 159 | : s(string) |
| 160 | , i(pos) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 161 | { |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 162 | } |
| 163 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 164 | value_type |
| 165 | operator*() const |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 166 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 167 | return s->char32At(i); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 168 | } |
| 169 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 170 | bool |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 171 | operator==(const UnicodeStringIterator& rhs) const |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 172 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 173 | return s == rhs.s && i == rhs.i; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 174 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 175 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 176 | bool |
| 177 | operator!=(const UnicodeStringIterator& rhs) const |
| 178 | { |
| 179 | return !(*this == rhs); |
| 180 | } |
| 181 | |
| 182 | UnicodeStringIterator& |
| 183 | operator++() |
| 184 | { |
| 185 | ++i; |
| 186 | return *this; |
| 187 | } |
| 188 | |
| 189 | UnicodeStringIterator |
| 190 | operator+(int32_t v) |
| 191 | { |
| 192 | return UnicodeStringIterator(s, i + v); |
| 193 | } |
| 194 | |
| 195 | private: |
| 196 | const icu::UnicodeString* s; |
| 197 | int32_t i; |
| 198 | }; |
| 199 | CXXOPTS_DIAGNOSTIC_POP |
| 200 | |
| 201 | inline |
| 202 | String& |
| 203 | stringAppend(String&s, String a) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 204 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 205 | return s.append(std::move(a)); |
| 206 | } |
| 207 | |
| 208 | inline |
| 209 | String& |
| 210 | stringAppend(String& s, std::size_t n, UChar32 c) |
| 211 | { |
| 212 | for (std::size_t i = 0; i != n; ++i) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 213 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 214 | s.append(c); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 215 | } |
| 216 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 217 | return s; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 218 | } |
| 219 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 220 | template <typename Iterator> |
| 221 | String& |
| 222 | stringAppend(String& s, Iterator begin, Iterator end) |
| 223 | { |
| 224 | while (begin != end) |
| 225 | { |
| 226 | s.append(*begin); |
| 227 | ++begin; |
| 228 | } |
| 229 | |
| 230 | return s; |
| 231 | } |
| 232 | |
| 233 | inline |
| 234 | size_t |
| 235 | stringLength(const String& s) |
| 236 | { |
| 237 | return static_cast<size_t>(s.length()); |
| 238 | } |
| 239 | |
| 240 | inline |
| 241 | std::string |
| 242 | toUTF8String(const String& s) |
| 243 | { |
| 244 | std::string result; |
| 245 | s.toUTF8String(result); |
| 246 | |
| 247 | return result; |
| 248 | } |
| 249 | |
| 250 | inline |
| 251 | bool |
| 252 | empty(const String& s) |
| 253 | { |
| 254 | return s.isEmpty(); |
| 255 | } |
| 256 | |
| 257 | } // namespace cxxopts |
| 258 | |
| 259 | namespace std { |
| 260 | |
| 261 | inline |
| 262 | cxxopts::UnicodeStringIterator |
| 263 | begin(const icu::UnicodeString& s) |
| 264 | { |
| 265 | return cxxopts::UnicodeStringIterator(&s, 0); |
| 266 | } |
| 267 | |
| 268 | inline |
| 269 | cxxopts::UnicodeStringIterator |
| 270 | end(const icu::UnicodeString& s) |
| 271 | { |
| 272 | return cxxopts::UnicodeStringIterator(&s, s.length()); |
| 273 | } |
| 274 | |
| 275 | } // namespace std |
| 276 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 277 | //ifdef CXXOPTS_USE_UNICODE |
| 278 | #else |
| 279 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 280 | namespace cxxopts { |
| 281 | |
| 282 | using String = std::string; |
| 283 | |
| 284 | template <typename T> |
| 285 | T |
| 286 | toLocalString(T&& t) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 287 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 288 | return std::forward<T>(t); |
| 289 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 290 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 291 | inline |
| 292 | std::size_t |
| 293 | stringLength(const String& s) |
| 294 | { |
| 295 | return s.length(); |
| 296 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 297 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 298 | inline |
| 299 | String& |
| 300 | stringAppend(String&s, const String& a) |
| 301 | { |
| 302 | return s.append(a); |
| 303 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 304 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 305 | inline |
| 306 | String& |
| 307 | stringAppend(String& s, std::size_t n, char c) |
| 308 | { |
| 309 | return s.append(n, c); |
| 310 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 311 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 312 | template <typename Iterator> |
| 313 | String& |
| 314 | stringAppend(String& s, Iterator begin, Iterator end) |
| 315 | { |
| 316 | return s.append(begin, end); |
| 317 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 318 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 319 | template <typename T> |
| 320 | std::string |
| 321 | toUTF8String(T&& t) |
| 322 | { |
| 323 | return std::forward<T>(t); |
| 324 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 325 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 326 | inline |
| 327 | bool |
| 328 | empty(const std::string& s) |
| 329 | { |
| 330 | return s.empty(); |
| 331 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 332 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 333 | } // namespace cxxopts |
| 334 | |
| 335 | //ifdef CXXOPTS_USE_UNICODE |
| 336 | #endif |
| 337 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 338 | namespace cxxopts { |
| 339 | |
| 340 | namespace { |
| 341 | CXXOPTS_LINKONCE_CONST std::string LQUOTE("\'"); |
| 342 | CXXOPTS_LINKONCE_CONST std::string RQUOTE("\'"); |
| 343 | } // namespace |
| 344 | |
| 345 | // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we |
| 346 | // want to silence it: warning: base class 'class |
| 347 | // std::enable_shared_from_this<cxxopts::Value>' has accessible non-virtual |
| 348 | // destructor This will be ignored under other compilers like LLVM clang. |
| 349 | CXXOPTS_DIAGNOSTIC_PUSH |
| 350 | CXXOPTS_IGNORE_WARNING("-Wnon-virtual-dtor") |
| 351 | |
| 352 | // some older versions of GCC warn under this warning |
| 353 | CXXOPTS_IGNORE_WARNING("-Weffc++") |
| 354 | class Value : public std::enable_shared_from_this<Value> |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 355 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 356 | public: |
| 357 | |
| 358 | virtual ~Value() = default; |
| 359 | |
| 360 | virtual |
| 361 | std::shared_ptr<Value> |
| 362 | clone() const = 0; |
| 363 | |
| 364 | virtual void |
| 365 | parse(const std::string& text) const = 0; |
| 366 | |
| 367 | virtual void |
| 368 | parse() const = 0; |
| 369 | |
| 370 | virtual bool |
| 371 | has_default() const = 0; |
| 372 | |
| 373 | virtual bool |
| 374 | is_container() const = 0; |
| 375 | |
| 376 | virtual bool |
| 377 | has_implicit() const = 0; |
| 378 | |
| 379 | virtual std::string |
| 380 | get_default_value() const = 0; |
| 381 | |
| 382 | virtual std::string |
| 383 | get_implicit_value() const = 0; |
| 384 | |
| 385 | virtual std::shared_ptr<Value> |
| 386 | default_value(const std::string& value) = 0; |
| 387 | |
| 388 | virtual std::shared_ptr<Value> |
| 389 | implicit_value(const std::string& value) = 0; |
| 390 | |
| 391 | virtual std::shared_ptr<Value> |
| 392 | no_implicit_value() = 0; |
| 393 | |
| 394 | virtual bool |
| 395 | is_boolean() const = 0; |
| 396 | }; |
| 397 | |
| 398 | CXXOPTS_DIAGNOSTIC_POP |
| 399 | |
| 400 | namespace exceptions { |
| 401 | |
| 402 | class exception : public std::exception |
| 403 | { |
| 404 | public: |
| 405 | explicit exception(std::string message) |
| 406 | : m_message(std::move(message)) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 407 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 408 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 409 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 410 | CXXOPTS_NODISCARD |
| 411 | const char* |
| 412 | what() const noexcept override |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 413 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 414 | return m_message.c_str(); |
| 415 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 416 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 417 | private: |
| 418 | std::string m_message; |
| 419 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 420 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 421 | class specification : public exception |
| 422 | { |
| 423 | public: |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 424 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 425 | explicit specification(const std::string& message) |
| 426 | : exception(message) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 427 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 428 | } |
| 429 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 430 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 431 | class parsing : public exception |
| 432 | { |
| 433 | public: |
| 434 | explicit parsing(const std::string& message) |
| 435 | : exception(message) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 436 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 437 | } |
| 438 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 439 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 440 | class option_already_exists : public specification |
| 441 | { |
| 442 | public: |
| 443 | explicit option_already_exists(const std::string& option) |
| 444 | : specification("Option " + LQUOTE + option + RQUOTE + " already exists") |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 445 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 446 | } |
| 447 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 448 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 449 | class invalid_option_format : public specification |
| 450 | { |
| 451 | public: |
| 452 | explicit invalid_option_format(const std::string& format) |
| 453 | : specification("Invalid option format " + LQUOTE + format + RQUOTE) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 454 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 455 | } |
| 456 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 457 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 458 | class invalid_option_syntax : public parsing { |
| 459 | public: |
| 460 | explicit invalid_option_syntax(const std::string& text) |
| 461 | : parsing("Argument " + LQUOTE + text + RQUOTE + |
| 462 | " starts with a - but has incorrect syntax") |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 463 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 464 | } |
| 465 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 466 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 467 | class no_such_option : public parsing |
| 468 | { |
| 469 | public: |
| 470 | explicit no_such_option(const std::string& option) |
| 471 | : parsing("Option " + LQUOTE + option + RQUOTE + " does not exist") |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 472 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 473 | } |
| 474 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 475 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 476 | class missing_argument : public parsing |
| 477 | { |
| 478 | public: |
| 479 | explicit missing_argument(const std::string& option) |
| 480 | : parsing( |
| 481 | "Option " + LQUOTE + option + RQUOTE + " is missing an argument" |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 482 | ) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 483 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 484 | } |
| 485 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 486 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 487 | class option_requires_argument : public parsing |
| 488 | { |
| 489 | public: |
| 490 | explicit option_requires_argument(const std::string& option) |
| 491 | : parsing( |
| 492 | "Option " + LQUOTE + option + RQUOTE + " requires an argument" |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 493 | ) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 494 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 495 | } |
| 496 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 497 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 498 | class gratuitous_argument_for_option : public parsing |
| 499 | { |
| 500 | public: |
| 501 | gratuitous_argument_for_option |
| 502 | ( |
| 503 | const std::string& option, |
| 504 | const std::string& arg |
| 505 | ) |
| 506 | : parsing( |
| 507 | "Option " + LQUOTE + option + RQUOTE + |
| 508 | " does not take an argument, but argument " + |
| 509 | LQUOTE + arg + RQUOTE + " given" |
| 510 | ) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 511 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 512 | } |
| 513 | }; |
| 514 | |
| 515 | class requested_option_not_present : public parsing |
| 516 | { |
| 517 | public: |
| 518 | explicit requested_option_not_present(const std::string& option) |
| 519 | : parsing("Option " + LQUOTE + option + RQUOTE + " not present") |
| 520 | { |
| 521 | } |
| 522 | }; |
| 523 | |
| 524 | class option_has_no_value : public exception |
| 525 | { |
| 526 | public: |
| 527 | explicit option_has_no_value(const std::string& option) |
| 528 | : exception( |
| 529 | !option.empty() ? |
| 530 | ("Option " + LQUOTE + option + RQUOTE + " has no value") : |
| 531 | "Option has no value") |
| 532 | { |
| 533 | } |
| 534 | }; |
| 535 | |
| 536 | class incorrect_argument_type : public parsing |
| 537 | { |
| 538 | public: |
| 539 | explicit incorrect_argument_type |
| 540 | ( |
| 541 | const std::string& arg |
| 542 | ) |
| 543 | : parsing( |
| 544 | "Argument " + LQUOTE + arg + RQUOTE + " failed to parse" |
| 545 | ) |
| 546 | { |
| 547 | } |
| 548 | }; |
| 549 | |
| 550 | } // namespace exceptions |
| 551 | |
| 552 | |
| 553 | template <typename T> |
| 554 | void throw_or_mimic(const std::string& text) |
| 555 | { |
| 556 | static_assert(std::is_base_of<std::exception, T>::value, |
| 557 | "throw_or_mimic only works on std::exception and " |
| 558 | "deriving classes"); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 559 | |
| 560 | #ifndef CXXOPTS_NO_EXCEPTIONS |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 561 | // If CXXOPTS_NO_EXCEPTIONS is not defined, just throw |
| 562 | throw T{text}; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 563 | #else |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 564 | // Otherwise manually instantiate the exception, print what() to stderr, |
| 565 | // and exit |
| 566 | T exception{text}; |
| 567 | std::cerr << exception.what() << std::endl; |
| 568 | std::exit(EXIT_FAILURE); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 569 | #endif |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 570 | } |
| 571 | |
| 572 | using OptionNames = std::vector<std::string>; |
| 573 | |
| 574 | namespace values { |
| 575 | |
| 576 | namespace parser_tool { |
| 577 | |
| 578 | struct IntegerDesc |
| 579 | { |
| 580 | std::string negative = ""; |
| 581 | std::string base = ""; |
| 582 | std::string value = ""; |
| 583 | }; |
| 584 | struct ArguDesc { |
| 585 | std::string arg_name = ""; |
| 586 | bool grouping = false; |
| 587 | bool set_value = false; |
| 588 | std::string value = ""; |
| 589 | }; |
| 590 | |
| 591 | #ifdef CXXOPTS_NO_REGEX |
| 592 | inline IntegerDesc SplitInteger(const std::string &text) |
| 593 | { |
| 594 | if (text.empty()) |
| 595 | { |
| 596 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 597 | } |
| 598 | IntegerDesc desc; |
| 599 | const char *pdata = text.c_str(); |
| 600 | if (*pdata == '-') |
| 601 | { |
| 602 | pdata += 1; |
| 603 | desc.negative = "-"; |
| 604 | } |
| 605 | if (strncmp(pdata, "0x", 2) == 0) |
| 606 | { |
| 607 | pdata += 2; |
| 608 | desc.base = "0x"; |
| 609 | } |
| 610 | if (*pdata != '\0') |
| 611 | { |
| 612 | desc.value = std::string(pdata); |
| 613 | } |
| 614 | else |
| 615 | { |
| 616 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 617 | } |
| 618 | return desc; |
| 619 | } |
| 620 | |
| 621 | inline bool IsTrueText(const std::string &text) |
| 622 | { |
| 623 | const char *pdata = text.c_str(); |
| 624 | if (*pdata == 't' || *pdata == 'T') |
| 625 | { |
| 626 | pdata += 1; |
| 627 | if (strncmp(pdata, "rue\0", 4) == 0) |
| 628 | { |
| 629 | return true; |
| 630 | } |
| 631 | } |
| 632 | else if (strncmp(pdata, "1\0", 2) == 0) |
| 633 | { |
| 634 | return true; |
| 635 | } |
| 636 | return false; |
| 637 | } |
| 638 | |
| 639 | inline bool IsFalseText(const std::string &text) |
| 640 | { |
| 641 | const char *pdata = text.c_str(); |
| 642 | if (*pdata == 'f' || *pdata == 'F') |
| 643 | { |
| 644 | pdata += 1; |
| 645 | if (strncmp(pdata, "alse\0", 5) == 0) |
| 646 | { |
| 647 | return true; |
| 648 | } |
| 649 | } |
| 650 | else if (strncmp(pdata, "0\0", 2) == 0) |
| 651 | { |
| 652 | return true; |
| 653 | } |
| 654 | return false; |
| 655 | } |
| 656 | |
| 657 | inline OptionNames split_option_names(const std::string &text) |
| 658 | { |
| 659 | OptionNames split_names; |
| 660 | |
| 661 | std::string::size_type token_start_pos = 0; |
| 662 | auto length = text.length(); |
| 663 | |
| 664 | if (length == 0) |
| 665 | { |
| 666 | throw_or_mimic<exceptions::invalid_option_format>(text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 667 | } |
| 668 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 669 | while (token_start_pos < length) { |
| 670 | const auto &npos = std::string::npos; |
| 671 | auto next_non_space_pos = text.find_first_not_of(' ', token_start_pos); |
| 672 | if (next_non_space_pos == npos) { |
| 673 | throw_or_mimic<exceptions::invalid_option_format>(text); |
| 674 | } |
| 675 | token_start_pos = next_non_space_pos; |
| 676 | auto next_delimiter_pos = text.find(',', token_start_pos); |
| 677 | if (next_delimiter_pos == token_start_pos) { |
| 678 | throw_or_mimic<exceptions::invalid_option_format>(text); |
| 679 | } |
| 680 | if (next_delimiter_pos == npos) { |
| 681 | next_delimiter_pos = length; |
| 682 | } |
| 683 | auto token_length = next_delimiter_pos - token_start_pos; |
| 684 | // validate the token itself matches the regex /([:alnum:][-_[:alnum:]]*/ |
| 685 | { |
| 686 | const char* option_name_valid_chars = |
| 687 | "ABCDEFGHIJKLMNOPQRSTUVWXYZ" |
| 688 | "abcdefghijklmnopqrstuvwxyz" |
| 689 | "0123456789" |
| 690 | "_-.?"; |
| 691 | |
| 692 | if (!std::isalnum(text[token_start_pos], std::locale::classic()) || |
| 693 | text.find_first_not_of(option_name_valid_chars, token_start_pos) < next_delimiter_pos) { |
| 694 | throw_or_mimic<exceptions::invalid_option_format>(text); |
| 695 | } |
| 696 | } |
| 697 | split_names.emplace_back(text.substr(token_start_pos, token_length)); |
| 698 | token_start_pos = next_delimiter_pos + 1; |
| 699 | } |
| 700 | return split_names; |
| 701 | } |
| 702 | |
| 703 | inline ArguDesc ParseArgument(const char *arg, bool &matched) |
| 704 | { |
| 705 | ArguDesc argu_desc; |
| 706 | const char *pdata = arg; |
| 707 | matched = false; |
| 708 | if (strncmp(pdata, "--", 2) == 0) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 709 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 710 | pdata += 2; |
| 711 | if (isalnum(*pdata, std::locale::classic())) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 712 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 713 | argu_desc.arg_name.push_back(*pdata); |
| 714 | pdata += 1; |
| 715 | while (isalnum(*pdata, std::locale::classic()) || *pdata == '-' || *pdata == '_') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 716 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 717 | argu_desc.arg_name.push_back(*pdata); |
| 718 | pdata += 1; |
| 719 | } |
| 720 | if (argu_desc.arg_name.length() > 1) |
| 721 | { |
| 722 | if (*pdata == '=') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 723 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 724 | argu_desc.set_value = true; |
| 725 | pdata += 1; |
| 726 | if (*pdata != '\0') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 727 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 728 | argu_desc.value = std::string(pdata); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 729 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 730 | matched = true; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 731 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 732 | else if (*pdata == '\0') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 733 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 734 | matched = true; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 735 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 736 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 737 | } |
| 738 | } |
| 739 | else if (strncmp(pdata, "-", 1) == 0) |
| 740 | { |
| 741 | pdata += 1; |
| 742 | argu_desc.grouping = true; |
| 743 | while (isalnum(*pdata, std::locale::classic())) |
| 744 | { |
| 745 | argu_desc.arg_name.push_back(*pdata); |
| 746 | pdata += 1; |
| 747 | } |
| 748 | matched = !argu_desc.arg_name.empty() && *pdata == '\0'; |
| 749 | } |
| 750 | return argu_desc; |
| 751 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 752 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 753 | #else // CXXOPTS_NO_REGEX |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 754 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 755 | namespace { |
| 756 | CXXOPTS_LINKONCE |
| 757 | std::basic_regex<char> integer_pattern |
| 758 | ("(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"); |
| 759 | CXXOPTS_LINKONCE |
| 760 | std::basic_regex<char> truthy_pattern |
| 761 | ("(t|T)(rue)?|1"); |
| 762 | CXXOPTS_LINKONCE |
| 763 | std::basic_regex<char> falsy_pattern |
| 764 | ("(f|F)(alse)?|0"); |
| 765 | CXXOPTS_LINKONCE |
| 766 | std::basic_regex<char> option_matcher |
| 767 | ("--([[:alnum:]][-_[:alnum:]\\.]+)(=(.*))?|-([[:alnum:]].*)"); |
| 768 | CXXOPTS_LINKONCE |
| 769 | std::basic_regex<char> option_specifier |
| 770 | ("([[:alnum:]][-_[:alnum:]\\.]*)(,[ ]*[[:alnum:]][-_[:alnum:]]*)*"); |
| 771 | CXXOPTS_LINKONCE |
| 772 | std::basic_regex<char> option_specifier_separator(", *"); |
| 773 | |
| 774 | } // namespace |
| 775 | |
| 776 | inline IntegerDesc SplitInteger(const std::string &text) |
| 777 | { |
| 778 | std::smatch match; |
| 779 | std::regex_match(text, match, integer_pattern); |
| 780 | |
| 781 | if (match.length() == 0) |
| 782 | { |
| 783 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 784 | } |
| 785 | |
| 786 | IntegerDesc desc; |
| 787 | desc.negative = match[1]; |
| 788 | desc.base = match[2]; |
| 789 | desc.value = match[3]; |
| 790 | |
| 791 | if (match.length(4) > 0) |
| 792 | { |
| 793 | desc.base = match[5]; |
| 794 | desc.value = "0"; |
| 795 | return desc; |
| 796 | } |
| 797 | |
| 798 | return desc; |
| 799 | } |
| 800 | |
| 801 | inline bool IsTrueText(const std::string &text) |
| 802 | { |
| 803 | std::smatch result; |
| 804 | std::regex_match(text, result, truthy_pattern); |
| 805 | return !result.empty(); |
| 806 | } |
| 807 | |
| 808 | inline bool IsFalseText(const std::string &text) |
| 809 | { |
| 810 | std::smatch result; |
| 811 | std::regex_match(text, result, falsy_pattern); |
| 812 | return !result.empty(); |
| 813 | } |
| 814 | |
| 815 | // Gets the option names specified via a single, comma-separated string, |
| 816 | // and returns the separate, space-discarded, non-empty names |
| 817 | // (without considering which or how many are single-character) |
| 818 | inline OptionNames split_option_names(const std::string &text) |
| 819 | { |
| 820 | if (!std::regex_match(text.c_str(), option_specifier)) |
| 821 | { |
| 822 | throw_or_mimic<exceptions::invalid_option_format>(text); |
| 823 | } |
| 824 | |
| 825 | OptionNames split_names; |
| 826 | |
| 827 | constexpr int use_non_matches { -1 }; |
| 828 | auto token_iterator = std::sregex_token_iterator( |
| 829 | text.begin(), text.end(), option_specifier_separator, use_non_matches); |
| 830 | std::copy(token_iterator, std::sregex_token_iterator(), std::back_inserter(split_names)); |
| 831 | return split_names; |
| 832 | } |
| 833 | |
| 834 | inline ArguDesc ParseArgument(const char *arg, bool &matched) |
| 835 | { |
| 836 | std::match_results<const char*> result; |
| 837 | std::regex_match(arg, result, option_matcher); |
| 838 | matched = !result.empty(); |
| 839 | |
| 840 | ArguDesc argu_desc; |
| 841 | if (matched) { |
| 842 | argu_desc.arg_name = result[1].str(); |
| 843 | argu_desc.set_value = result[2].length() > 0; |
| 844 | argu_desc.value = result[3].str(); |
| 845 | if (result[4].length() > 0) |
| 846 | { |
| 847 | argu_desc.grouping = true; |
| 848 | argu_desc.arg_name = result[4].str(); |
| 849 | } |
| 850 | } |
| 851 | |
| 852 | return argu_desc; |
| 853 | } |
| 854 | |
| 855 | #endif // CXXOPTS_NO_REGEX |
| 856 | #undef CXXOPTS_NO_REGEX |
| 857 | } // namespace parser_tool |
| 858 | |
| 859 | namespace detail { |
| 860 | |
| 861 | template <typename T, bool B> |
| 862 | struct SignedCheck; |
| 863 | |
| 864 | template <typename T> |
| 865 | struct SignedCheck<T, true> |
| 866 | { |
| 867 | template <typename U> |
| 868 | void |
| 869 | operator()(bool negative, U u, const std::string& text) |
| 870 | { |
| 871 | if (negative) |
| 872 | { |
| 873 | if (u > static_cast<U>((std::numeric_limits<T>::min)())) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 874 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 875 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 876 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 877 | } |
| 878 | else |
| 879 | { |
| 880 | if (u > static_cast<U>((std::numeric_limits<T>::max)())) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 881 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 882 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 883 | } |
| 884 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 885 | } |
| 886 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 887 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 888 | template <typename T> |
| 889 | struct SignedCheck<T, false> |
| 890 | { |
| 891 | template <typename U> |
| 892 | void |
| 893 | operator()(bool, U, const std::string&) const {} |
| 894 | }; |
| 895 | |
| 896 | template <typename T, typename U> |
| 897 | void |
| 898 | check_signed_range(bool negative, U value, const std::string& text) |
| 899 | { |
| 900 | SignedCheck<T, std::numeric_limits<T>::is_signed>()(negative, value, text); |
| 901 | } |
| 902 | |
| 903 | } // namespace detail |
| 904 | |
| 905 | template <typename R, typename T> |
| 906 | void |
| 907 | checked_negate(R& r, T&& t, const std::string&, std::true_type) |
| 908 | { |
| 909 | // if we got to here, then `t` is a positive number that fits into |
| 910 | // `R`. So to avoid MSVC C4146, we first cast it to `R`. |
| 911 | // See https://github.com/jarro2783/cxxopts/issues/62 for more details. |
| 912 | r = static_cast<R>(-static_cast<R>(t-1)-1); |
| 913 | } |
| 914 | |
| 915 | template <typename R, typename T> |
| 916 | void |
| 917 | checked_negate(R&, T&&, const std::string& text, std::false_type) |
| 918 | { |
| 919 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 920 | } |
| 921 | |
| 922 | template <typename T> |
| 923 | void |
| 924 | integer_parser(const std::string& text, T& value) |
| 925 | { |
| 926 | parser_tool::IntegerDesc int_desc = parser_tool::SplitInteger(text); |
| 927 | |
| 928 | using US = typename std::make_unsigned<T>::type; |
| 929 | constexpr bool is_signed = std::numeric_limits<T>::is_signed; |
| 930 | |
| 931 | const bool negative = int_desc.negative.length() > 0; |
| 932 | const uint8_t base = int_desc.base.length() > 0 ? 16 : 10; |
| 933 | const std::string & value_match = int_desc.value; |
| 934 | |
| 935 | US result = 0; |
| 936 | |
| 937 | for (char ch : value_match) |
| 938 | { |
| 939 | US digit = 0; |
| 940 | |
| 941 | if (ch >= '0' && ch <= '9') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 942 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 943 | digit = static_cast<US>(ch - '0'); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 944 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 945 | else if (base == 16 && ch >= 'a' && ch <= 'f') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 946 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 947 | digit = static_cast<US>(ch - 'a' + 10); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 948 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 949 | else if (base == 16 && ch >= 'A' && ch <= 'F') |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 950 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 951 | digit = static_cast<US>(ch - 'A' + 10); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 952 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 953 | else |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 954 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 955 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 956 | } |
| 957 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 958 | const US next = static_cast<US>(result * base + digit); |
| 959 | if (result > next) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 960 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 961 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 962 | } |
| 963 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 964 | result = next; |
| 965 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 966 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 967 | detail::check_signed_range<T>(negative, result, text); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 968 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 969 | if (negative) |
| 970 | { |
| 971 | checked_negate<T>(value, result, text, std::integral_constant<bool, is_signed>()); |
| 972 | } |
| 973 | else |
| 974 | { |
| 975 | value = static_cast<T>(result); |
| 976 | } |
| 977 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 978 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 979 | template <typename T> |
| 980 | void stringstream_parser(const std::string& text, T& value) |
| 981 | { |
| 982 | std::stringstream in(text); |
| 983 | in >> value; |
| 984 | if (!in) { |
| 985 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 986 | } |
| 987 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 988 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 989 | template <typename T, |
| 990 | typename std::enable_if<std::is_integral<T>::value>::type* = nullptr |
| 991 | > |
| 992 | void parse_value(const std::string& text, T& value) |
| 993 | { |
| 994 | integer_parser(text, value); |
| 995 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 996 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 997 | inline |
| 998 | void |
| 999 | parse_value(const std::string& text, bool& value) |
| 1000 | { |
| 1001 | if (parser_tool::IsTrueText(text)) |
| 1002 | { |
| 1003 | value = true; |
| 1004 | return; |
| 1005 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1006 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1007 | if (parser_tool::IsFalseText(text)) |
| 1008 | { |
| 1009 | value = false; |
| 1010 | return; |
| 1011 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1012 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1013 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 1014 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1015 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1016 | inline |
| 1017 | void |
| 1018 | parse_value(const std::string& text, std::string& value) |
| 1019 | { |
| 1020 | value = text; |
| 1021 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1022 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1023 | // The fallback parser. It uses the stringstream parser to parse all types |
| 1024 | // that have not been overloaded explicitly. It has to be placed in the |
| 1025 | // source code before all other more specialized templates. |
| 1026 | template <typename T, |
| 1027 | typename std::enable_if<!std::is_integral<T>::value>::type* = nullptr |
| 1028 | > |
| 1029 | void |
| 1030 | parse_value(const std::string& text, T& value) { |
| 1031 | stringstream_parser(text, value); |
| 1032 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1033 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1034 | template <typename T> |
| 1035 | void |
| 1036 | parse_value(const std::string& text, std::vector<T>& value) |
| 1037 | { |
| 1038 | if (text.empty()) { |
| 1039 | T v; |
| 1040 | parse_value(text, v); |
| 1041 | value.emplace_back(std::move(v)); |
| 1042 | return; |
| 1043 | } |
| 1044 | std::stringstream in(text); |
| 1045 | std::string token; |
| 1046 | while(!in.eof() && std::getline(in, token, CXXOPTS_VECTOR_DELIMITER)) { |
| 1047 | T v; |
| 1048 | parse_value(token, v); |
| 1049 | value.emplace_back(std::move(v)); |
| 1050 | } |
| 1051 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1052 | |
| 1053 | #ifdef CXXOPTS_HAS_OPTIONAL |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1054 | template <typename T> |
| 1055 | void |
| 1056 | parse_value(const std::string& text, std::optional<T>& value) |
| 1057 | { |
| 1058 | T result; |
| 1059 | parse_value(text, result); |
| 1060 | value = std::move(result); |
| 1061 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1062 | #endif |
| 1063 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1064 | inline |
| 1065 | void parse_value(const std::string& text, char& c) |
| 1066 | { |
| 1067 | if (text.length() != 1) |
| 1068 | { |
| 1069 | throw_or_mimic<exceptions::incorrect_argument_type>(text); |
| 1070 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1071 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1072 | c = text[0]; |
| 1073 | } |
| 1074 | |
| 1075 | template <typename T> |
| 1076 | struct type_is_container |
| 1077 | { |
| 1078 | static constexpr bool value = false; |
| 1079 | }; |
| 1080 | |
| 1081 | template <typename T> |
| 1082 | struct type_is_container<std::vector<T>> |
| 1083 | { |
| 1084 | static constexpr bool value = true; |
| 1085 | }; |
| 1086 | |
| 1087 | template <typename T> |
| 1088 | class abstract_value : public Value |
| 1089 | { |
| 1090 | using Self = abstract_value<T>; |
| 1091 | |
| 1092 | public: |
| 1093 | abstract_value() |
| 1094 | : m_result(std::make_shared<T>()) |
| 1095 | , m_store(m_result.get()) |
| 1096 | { |
| 1097 | } |
| 1098 | |
| 1099 | explicit abstract_value(T* t) |
| 1100 | : m_store(t) |
| 1101 | { |
| 1102 | } |
| 1103 | |
| 1104 | ~abstract_value() override = default; |
| 1105 | |
| 1106 | abstract_value& operator=(const abstract_value&) = default; |
| 1107 | |
| 1108 | abstract_value(const abstract_value& rhs) |
| 1109 | { |
| 1110 | if (rhs.m_result) |
| 1111 | { |
| 1112 | m_result = std::make_shared<T>(); |
| 1113 | m_store = m_result.get(); |
| 1114 | } |
| 1115 | else |
| 1116 | { |
| 1117 | m_store = rhs.m_store; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1118 | } |
| 1119 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1120 | m_default = rhs.m_default; |
| 1121 | m_implicit = rhs.m_implicit; |
| 1122 | m_default_value = rhs.m_default_value; |
| 1123 | m_implicit_value = rhs.m_implicit_value; |
| 1124 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1125 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1126 | void |
| 1127 | parse(const std::string& text) const override |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1128 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1129 | parse_value(text, *m_store); |
| 1130 | } |
| 1131 | |
| 1132 | bool |
| 1133 | is_container() const override |
| 1134 | { |
| 1135 | return type_is_container<T>::value; |
| 1136 | } |
| 1137 | |
| 1138 | void |
| 1139 | parse() const override |
| 1140 | { |
| 1141 | parse_value(m_default_value, *m_store); |
| 1142 | } |
| 1143 | |
| 1144 | bool |
| 1145 | has_default() const override |
| 1146 | { |
| 1147 | return m_default; |
| 1148 | } |
| 1149 | |
| 1150 | bool |
| 1151 | has_implicit() const override |
| 1152 | { |
| 1153 | return m_implicit; |
| 1154 | } |
| 1155 | |
| 1156 | std::shared_ptr<Value> |
| 1157 | default_value(const std::string& value) override |
| 1158 | { |
| 1159 | m_default = true; |
| 1160 | m_default_value = value; |
| 1161 | return shared_from_this(); |
| 1162 | } |
| 1163 | |
| 1164 | std::shared_ptr<Value> |
| 1165 | implicit_value(const std::string& value) override |
| 1166 | { |
| 1167 | m_implicit = true; |
| 1168 | m_implicit_value = value; |
| 1169 | return shared_from_this(); |
| 1170 | } |
| 1171 | |
| 1172 | std::shared_ptr<Value> |
| 1173 | no_implicit_value() override |
| 1174 | { |
| 1175 | m_implicit = false; |
| 1176 | return shared_from_this(); |
| 1177 | } |
| 1178 | |
| 1179 | std::string |
| 1180 | get_default_value() const override |
| 1181 | { |
| 1182 | return m_default_value; |
| 1183 | } |
| 1184 | |
| 1185 | std::string |
| 1186 | get_implicit_value() const override |
| 1187 | { |
| 1188 | return m_implicit_value; |
| 1189 | } |
| 1190 | |
| 1191 | bool |
| 1192 | is_boolean() const override |
| 1193 | { |
| 1194 | return std::is_same<T, bool>::value; |
| 1195 | } |
| 1196 | |
| 1197 | const T& |
| 1198 | get() const |
| 1199 | { |
| 1200 | if (m_store == nullptr) |
| 1201 | { |
| 1202 | return *m_result; |
| 1203 | } |
| 1204 | return *m_store; |
| 1205 | } |
| 1206 | |
| 1207 | protected: |
| 1208 | std::shared_ptr<T> m_result{}; |
| 1209 | T* m_store{}; |
| 1210 | |
| 1211 | bool m_default = false; |
| 1212 | bool m_implicit = false; |
| 1213 | |
| 1214 | std::string m_default_value{}; |
| 1215 | std::string m_implicit_value{}; |
| 1216 | }; |
| 1217 | |
| 1218 | template <typename T> |
| 1219 | class standard_value : public abstract_value<T> |
| 1220 | { |
| 1221 | public: |
| 1222 | using abstract_value<T>::abstract_value; |
| 1223 | |
| 1224 | CXXOPTS_NODISCARD |
| 1225 | std::shared_ptr<Value> |
| 1226 | clone() const override |
| 1227 | { |
| 1228 | return std::make_shared<standard_value<T>>(*this); |
| 1229 | } |
| 1230 | }; |
| 1231 | |
| 1232 | template <> |
| 1233 | class standard_value<bool> : public abstract_value<bool> |
| 1234 | { |
| 1235 | public: |
| 1236 | ~standard_value() override = default; |
| 1237 | |
| 1238 | standard_value() |
| 1239 | { |
| 1240 | set_default_and_implicit(); |
| 1241 | } |
| 1242 | |
| 1243 | explicit standard_value(bool* b) |
| 1244 | : abstract_value(b) |
| 1245 | { |
| 1246 | m_implicit = true; |
| 1247 | m_implicit_value = "true"; |
| 1248 | } |
| 1249 | |
| 1250 | std::shared_ptr<Value> |
| 1251 | clone() const override |
| 1252 | { |
| 1253 | return std::make_shared<standard_value<bool>>(*this); |
| 1254 | } |
| 1255 | |
| 1256 | private: |
| 1257 | |
| 1258 | void |
| 1259 | set_default_and_implicit() |
| 1260 | { |
| 1261 | m_default = true; |
| 1262 | m_default_value = "false"; |
| 1263 | m_implicit = true; |
| 1264 | m_implicit_value = "true"; |
| 1265 | } |
| 1266 | }; |
| 1267 | |
| 1268 | } // namespace values |
| 1269 | |
| 1270 | template <typename T> |
| 1271 | std::shared_ptr<Value> |
| 1272 | value() |
| 1273 | { |
| 1274 | return std::make_shared<values::standard_value<T>>(); |
| 1275 | } |
| 1276 | |
| 1277 | template <typename T> |
| 1278 | std::shared_ptr<Value> |
| 1279 | value(T& t) |
| 1280 | { |
| 1281 | return std::make_shared<values::standard_value<T>>(&t); |
| 1282 | } |
| 1283 | |
| 1284 | class OptionAdder; |
| 1285 | |
| 1286 | CXXOPTS_NODISCARD |
| 1287 | inline |
| 1288 | const std::string& |
| 1289 | first_or_empty(const OptionNames& long_names) |
| 1290 | { |
| 1291 | static const std::string empty{""}; |
| 1292 | return long_names.empty() ? empty : long_names.front(); |
| 1293 | } |
| 1294 | |
| 1295 | class OptionDetails |
| 1296 | { |
| 1297 | public: |
| 1298 | OptionDetails |
| 1299 | ( |
| 1300 | std::string short_, |
| 1301 | OptionNames long_, |
| 1302 | String desc, |
| 1303 | std::shared_ptr<const Value> val |
| 1304 | ) |
| 1305 | : m_short(std::move(short_)) |
| 1306 | , m_long(std::move(long_)) |
| 1307 | , m_desc(std::move(desc)) |
| 1308 | , m_value(std::move(val)) |
| 1309 | , m_count(0) |
| 1310 | { |
| 1311 | m_hash = std::hash<std::string>{}(first_long_name() + m_short); |
| 1312 | } |
| 1313 | |
| 1314 | OptionDetails(const OptionDetails& rhs) |
| 1315 | : m_desc(rhs.m_desc) |
| 1316 | , m_value(rhs.m_value->clone()) |
| 1317 | , m_count(rhs.m_count) |
| 1318 | { |
| 1319 | } |
| 1320 | |
| 1321 | OptionDetails(OptionDetails&& rhs) = default; |
| 1322 | |
| 1323 | CXXOPTS_NODISCARD |
| 1324 | const String& |
| 1325 | description() const |
| 1326 | { |
| 1327 | return m_desc; |
| 1328 | } |
| 1329 | |
| 1330 | CXXOPTS_NODISCARD |
| 1331 | const Value& |
| 1332 | value() const { |
| 1333 | return *m_value; |
| 1334 | } |
| 1335 | |
| 1336 | CXXOPTS_NODISCARD |
| 1337 | std::shared_ptr<Value> |
| 1338 | make_storage() const |
| 1339 | { |
| 1340 | return m_value->clone(); |
| 1341 | } |
| 1342 | |
| 1343 | CXXOPTS_NODISCARD |
| 1344 | const std::string& |
| 1345 | short_name() const |
| 1346 | { |
| 1347 | return m_short; |
| 1348 | } |
| 1349 | |
| 1350 | CXXOPTS_NODISCARD |
| 1351 | const std::string& |
| 1352 | first_long_name() const |
| 1353 | { |
| 1354 | return first_or_empty(m_long); |
| 1355 | } |
| 1356 | |
| 1357 | CXXOPTS_NODISCARD |
| 1358 | const std::string& |
| 1359 | essential_name() const |
| 1360 | { |
| 1361 | return m_long.empty() ? m_short : m_long.front(); |
| 1362 | } |
| 1363 | |
| 1364 | CXXOPTS_NODISCARD |
| 1365 | const OptionNames & |
| 1366 | long_names() const |
| 1367 | { |
| 1368 | return m_long; |
| 1369 | } |
| 1370 | |
| 1371 | std::size_t |
| 1372 | hash() const |
| 1373 | { |
| 1374 | return m_hash; |
| 1375 | } |
| 1376 | |
| 1377 | private: |
| 1378 | std::string m_short{}; |
| 1379 | OptionNames m_long{}; |
| 1380 | String m_desc{}; |
| 1381 | std::shared_ptr<const Value> m_value{}; |
| 1382 | int m_count; |
| 1383 | |
| 1384 | std::size_t m_hash{}; |
| 1385 | }; |
| 1386 | |
| 1387 | struct HelpOptionDetails |
| 1388 | { |
| 1389 | std::string s; |
| 1390 | OptionNames l; |
| 1391 | String desc; |
| 1392 | bool has_default; |
| 1393 | std::string default_value; |
| 1394 | bool has_implicit; |
| 1395 | std::string implicit_value; |
| 1396 | std::string arg_help; |
| 1397 | bool is_container; |
| 1398 | bool is_boolean; |
| 1399 | }; |
| 1400 | |
| 1401 | struct HelpGroupDetails |
| 1402 | { |
| 1403 | std::string name{}; |
| 1404 | std::string description{}; |
| 1405 | std::vector<HelpOptionDetails> options{}; |
| 1406 | }; |
| 1407 | |
| 1408 | class OptionValue |
| 1409 | { |
| 1410 | public: |
| 1411 | void |
| 1412 | parse |
| 1413 | ( |
| 1414 | const std::shared_ptr<const OptionDetails>& details, |
| 1415 | const std::string& text |
| 1416 | ) |
| 1417 | { |
| 1418 | ensure_value(details); |
| 1419 | ++m_count; |
| 1420 | m_value->parse(text); |
| 1421 | m_long_names = &details->long_names(); |
| 1422 | } |
| 1423 | |
| 1424 | void |
| 1425 | parse_default(const std::shared_ptr<const OptionDetails>& details) |
| 1426 | { |
| 1427 | ensure_value(details); |
| 1428 | m_default = true; |
| 1429 | m_long_names = &details->long_names(); |
| 1430 | m_value->parse(); |
| 1431 | } |
| 1432 | |
| 1433 | void |
| 1434 | parse_no_value(const std::shared_ptr<const OptionDetails>& details) |
| 1435 | { |
| 1436 | m_long_names = &details->long_names(); |
| 1437 | } |
| 1438 | |
| 1439 | #if defined(CXXOPTS_NULL_DEREF_IGNORE) |
| 1440 | CXXOPTS_DIAGNOSTIC_PUSH |
| 1441 | CXXOPTS_IGNORE_WARNING("-Wnull-dereference") |
| 1442 | #endif |
| 1443 | |
| 1444 | CXXOPTS_NODISCARD |
| 1445 | std::size_t |
| 1446 | count() const noexcept |
| 1447 | { |
| 1448 | return m_count; |
| 1449 | } |
| 1450 | |
| 1451 | #if defined(CXXOPTS_NULL_DEREF_IGNORE) |
| 1452 | CXXOPTS_DIAGNOSTIC_POP |
| 1453 | #endif |
| 1454 | |
| 1455 | // TODO: maybe default options should count towards the number of arguments |
| 1456 | CXXOPTS_NODISCARD |
| 1457 | bool |
| 1458 | has_default() const noexcept |
| 1459 | { |
| 1460 | return m_default; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1461 | } |
| 1462 | |
| 1463 | template <typename T> |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1464 | const T& |
| 1465 | as() const |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1466 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1467 | if (m_value == nullptr) { |
| 1468 | throw_or_mimic<exceptions::option_has_no_value>( |
| 1469 | m_long_names == nullptr ? "" : first_or_empty(*m_long_names)); |
| 1470 | } |
| 1471 | |
| 1472 | return CXXOPTS_RTTI_CAST<const values::standard_value<T>&>(*m_value).get(); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1473 | } |
| 1474 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1475 | private: |
| 1476 | void |
| 1477 | ensure_value(const std::shared_ptr<const OptionDetails>& details) |
| 1478 | { |
| 1479 | if (m_value == nullptr) |
| 1480 | { |
| 1481 | m_value = details->make_storage(); |
| 1482 | } |
| 1483 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1484 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1485 | |
| 1486 | const OptionNames * m_long_names = nullptr; |
| 1487 | // Holding this pointer is safe, since OptionValue's only exist in key-value pairs, |
| 1488 | // where the key has the string we point to. |
| 1489 | std::shared_ptr<Value> m_value{}; |
| 1490 | std::size_t m_count = 0; |
| 1491 | bool m_default = false; |
| 1492 | }; |
| 1493 | |
| 1494 | class KeyValue |
| 1495 | { |
| 1496 | public: |
| 1497 | KeyValue(std::string key_, std::string value_) noexcept |
| 1498 | : m_key(std::move(key_)) |
| 1499 | , m_value(std::move(value_)) |
| 1500 | { |
| 1501 | } |
| 1502 | |
| 1503 | CXXOPTS_NODISCARD |
| 1504 | const std::string& |
| 1505 | key() const |
| 1506 | { |
| 1507 | return m_key; |
| 1508 | } |
| 1509 | |
| 1510 | CXXOPTS_NODISCARD |
| 1511 | const std::string& |
| 1512 | value() const |
| 1513 | { |
| 1514 | return m_value; |
| 1515 | } |
| 1516 | |
| 1517 | template <typename T> |
| 1518 | T |
| 1519 | as() const |
| 1520 | { |
| 1521 | T result; |
| 1522 | values::parse_value(m_value, result); |
| 1523 | return result; |
| 1524 | } |
| 1525 | |
| 1526 | private: |
| 1527 | std::string m_key; |
| 1528 | std::string m_value; |
| 1529 | }; |
| 1530 | |
| 1531 | using ParsedHashMap = std::unordered_map<std::size_t, OptionValue>; |
| 1532 | using NameHashMap = std::unordered_map<std::string, std::size_t>; |
| 1533 | |
| 1534 | class ParseResult |
| 1535 | { |
| 1536 | public: |
| 1537 | class Iterator |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1538 | { |
| 1539 | public: |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1540 | using iterator_category = std::forward_iterator_tag; |
| 1541 | using value_type = KeyValue; |
| 1542 | using difference_type = void; |
| 1543 | using pointer = const KeyValue*; |
| 1544 | using reference = const KeyValue&; |
| 1545 | |
| 1546 | Iterator() = default; |
| 1547 | Iterator(const Iterator&) = default; |
| 1548 | |
| 1549 | // GCC complains about m_iter not being initialised in the member |
| 1550 | // initializer list |
| 1551 | CXXOPTS_DIAGNOSTIC_PUSH |
| 1552 | CXXOPTS_IGNORE_WARNING("-Weffc++") |
| 1553 | Iterator(const ParseResult *pr, bool end=false) |
| 1554 | : m_pr(pr) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1555 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1556 | if (end) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1557 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1558 | m_sequential = false; |
| 1559 | m_iter = m_pr->m_defaults.end(); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1560 | } |
| 1561 | else |
| 1562 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1563 | m_sequential = true; |
| 1564 | m_iter = m_pr->m_sequential.begin(); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1565 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1566 | if (m_iter == m_pr->m_sequential.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1567 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1568 | m_sequential = false; |
| 1569 | m_iter = m_pr->m_defaults.begin(); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1570 | } |
| 1571 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1572 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1573 | CXXOPTS_DIAGNOSTIC_POP |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1574 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1575 | Iterator& operator++() |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1576 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1577 | ++m_iter; |
| 1578 | if(m_sequential && m_iter == m_pr->m_sequential.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1579 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1580 | m_sequential = false; |
| 1581 | m_iter = m_pr->m_defaults.begin(); |
| 1582 | return *this; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1583 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1584 | return *this; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 1585 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 1586 | |
| 1587 | Iterator operator++(int) |
| 1588 | { |
| 1589 | Iterator retval = *this; |
| 1590 | ++(*this); |
| 1591 | return retval; |
| 1592 | } |
| 1593 | |
| 1594 | bool operator==(const Iterator& other) const |
| 1595 | { |
| 1596 | return (m_sequential == other.m_sequential) && (m_iter == other.m_iter); |
| 1597 | } |
| 1598 | |
| 1599 | bool operator!=(const Iterator& other) const |
| 1600 | { |
| 1601 | return !(*this == other); |
| 1602 | } |
| 1603 | |
| 1604 | const KeyValue& operator*() |
| 1605 | { |
| 1606 | return *m_iter; |
| 1607 | } |
| 1608 | |
| 1609 | const KeyValue* operator->() |
| 1610 | { |
| 1611 | return m_iter.operator->(); |
| 1612 | } |
| 1613 | |
| 1614 | private: |
| 1615 | const ParseResult* m_pr; |
| 1616 | std::vector<KeyValue>::const_iterator m_iter; |
| 1617 | bool m_sequential = true; |
| 1618 | }; |
| 1619 | |
| 1620 | ParseResult() = default; |
| 1621 | ParseResult(const ParseResult&) = default; |
| 1622 | |
| 1623 | ParseResult(NameHashMap&& keys, ParsedHashMap&& values, std::vector<KeyValue> sequential, |
| 1624 | std::vector<KeyValue> default_opts, std::vector<std::string>&& unmatched_args) |
| 1625 | : m_keys(std::move(keys)) |
| 1626 | , m_values(std::move(values)) |
| 1627 | , m_sequential(std::move(sequential)) |
| 1628 | , m_defaults(std::move(default_opts)) |
| 1629 | , m_unmatched(std::move(unmatched_args)) |
| 1630 | { |
| 1631 | } |
| 1632 | |
| 1633 | ParseResult& operator=(ParseResult&&) = default; |
| 1634 | ParseResult& operator=(const ParseResult&) = default; |
| 1635 | |
| 1636 | Iterator |
| 1637 | begin() const |
| 1638 | { |
| 1639 | return Iterator(this); |
| 1640 | } |
| 1641 | |
| 1642 | Iterator |
| 1643 | end() const |
| 1644 | { |
| 1645 | return Iterator(this, true); |
| 1646 | } |
| 1647 | |
| 1648 | std::size_t |
| 1649 | count(const std::string& o) const |
| 1650 | { |
| 1651 | auto iter = m_keys.find(o); |
| 1652 | if (iter == m_keys.end()) |
| 1653 | { |
| 1654 | return 0; |
| 1655 | } |
| 1656 | |
| 1657 | auto viter = m_values.find(iter->second); |
| 1658 | |
| 1659 | if (viter == m_values.end()) |
| 1660 | { |
| 1661 | return 0; |
| 1662 | } |
| 1663 | |
| 1664 | return viter->second.count(); |
| 1665 | } |
| 1666 | |
| 1667 | const OptionValue& |
| 1668 | operator[](const std::string& option) const |
| 1669 | { |
| 1670 | auto iter = m_keys.find(option); |
| 1671 | |
| 1672 | if (iter == m_keys.end()) |
| 1673 | { |
| 1674 | throw_or_mimic<exceptions::requested_option_not_present>(option); |
| 1675 | } |
| 1676 | |
| 1677 | auto viter = m_values.find(iter->second); |
| 1678 | |
| 1679 | if (viter == m_values.end()) |
| 1680 | { |
| 1681 | throw_or_mimic<exceptions::requested_option_not_present>(option); |
| 1682 | } |
| 1683 | |
| 1684 | return viter->second; |
| 1685 | } |
| 1686 | |
| 1687 | const std::vector<KeyValue>& |
| 1688 | arguments() const |
| 1689 | { |
| 1690 | return m_sequential; |
| 1691 | } |
| 1692 | |
| 1693 | const std::vector<std::string>& |
| 1694 | unmatched() const |
| 1695 | { |
| 1696 | return m_unmatched; |
| 1697 | } |
| 1698 | |
| 1699 | const std::vector<KeyValue>& |
| 1700 | defaults() const |
| 1701 | { |
| 1702 | return m_defaults; |
| 1703 | } |
| 1704 | |
| 1705 | const std::string |
| 1706 | arguments_string() const |
| 1707 | { |
| 1708 | std::string result; |
| 1709 | for(const auto& kv: m_sequential) |
| 1710 | { |
| 1711 | result += kv.key() + " = " + kv.value() + "\n"; |
| 1712 | } |
| 1713 | for(const auto& kv: m_defaults) |
| 1714 | { |
| 1715 | result += kv.key() + " = " + kv.value() + " " + "(default)" + "\n"; |
| 1716 | } |
| 1717 | return result; |
| 1718 | } |
| 1719 | |
| 1720 | private: |
| 1721 | NameHashMap m_keys{}; |
| 1722 | ParsedHashMap m_values{}; |
| 1723 | std::vector<KeyValue> m_sequential{}; |
| 1724 | std::vector<KeyValue> m_defaults{}; |
| 1725 | std::vector<std::string> m_unmatched{}; |
| 1726 | }; |
| 1727 | |
| 1728 | struct Option |
| 1729 | { |
| 1730 | Option |
| 1731 | ( |
| 1732 | std::string opts, |
| 1733 | std::string desc, |
| 1734 | std::shared_ptr<const Value> value = ::cxxopts::value<bool>(), |
| 1735 | std::string arg_help = "" |
| 1736 | ) |
| 1737 | : opts_(std::move(opts)) |
| 1738 | , desc_(std::move(desc)) |
| 1739 | , value_(std::move(value)) |
| 1740 | , arg_help_(std::move(arg_help)) |
| 1741 | { |
| 1742 | } |
| 1743 | |
| 1744 | std::string opts_; |
| 1745 | std::string desc_; |
| 1746 | std::shared_ptr<const Value> value_; |
| 1747 | std::string arg_help_; |
| 1748 | }; |
| 1749 | |
| 1750 | using OptionMap = std::unordered_map<std::string, std::shared_ptr<OptionDetails>>; |
| 1751 | using PositionalList = std::vector<std::string>; |
| 1752 | using PositionalListIterator = PositionalList::const_iterator; |
| 1753 | |
| 1754 | class OptionParser |
| 1755 | { |
| 1756 | public: |
| 1757 | OptionParser(const OptionMap& options, const PositionalList& positional, bool allow_unrecognised) |
| 1758 | : m_options(options) |
| 1759 | , m_positional(positional) |
| 1760 | , m_allow_unrecognised(allow_unrecognised) |
| 1761 | { |
| 1762 | } |
| 1763 | |
| 1764 | ParseResult |
| 1765 | parse(int argc, const char* const* argv); |
| 1766 | |
| 1767 | bool |
| 1768 | consume_positional(const std::string& a, PositionalListIterator& next); |
| 1769 | |
| 1770 | void |
| 1771 | checked_parse_arg |
| 1772 | ( |
| 1773 | int argc, |
| 1774 | const char* const* argv, |
| 1775 | int& current, |
| 1776 | const std::shared_ptr<OptionDetails>& value, |
| 1777 | const std::string& name |
| 1778 | ); |
| 1779 | |
| 1780 | void |
| 1781 | add_to_option(OptionMap::const_iterator iter, const std::string& option, const std::string& arg); |
| 1782 | |
| 1783 | void |
| 1784 | parse_option |
| 1785 | ( |
| 1786 | const std::shared_ptr<OptionDetails>& value, |
| 1787 | const std::string& name, |
| 1788 | const std::string& arg = "" |
| 1789 | ); |
| 1790 | |
| 1791 | void |
| 1792 | parse_default(const std::shared_ptr<OptionDetails>& details); |
| 1793 | |
| 1794 | void |
| 1795 | parse_no_value(const std::shared_ptr<OptionDetails>& details); |
| 1796 | |
| 1797 | private: |
| 1798 | |
| 1799 | void finalise_aliases(); |
| 1800 | |
| 1801 | const OptionMap& m_options; |
| 1802 | const PositionalList& m_positional; |
| 1803 | |
| 1804 | std::vector<KeyValue> m_sequential{}; |
| 1805 | std::vector<KeyValue> m_defaults{}; |
| 1806 | bool m_allow_unrecognised; |
| 1807 | |
| 1808 | ParsedHashMap m_parsed{}; |
| 1809 | NameHashMap m_keys{}; |
| 1810 | }; |
| 1811 | |
| 1812 | class Options |
| 1813 | { |
| 1814 | public: |
| 1815 | |
| 1816 | explicit Options(std::string program_name, std::string help_string = "") |
| 1817 | : m_program(std::move(program_name)) |
| 1818 | , m_help_string(toLocalString(std::move(help_string))) |
| 1819 | , m_custom_help("[OPTION...]") |
| 1820 | , m_positional_help("positional parameters") |
| 1821 | , m_show_positional(false) |
| 1822 | , m_allow_unrecognised(false) |
| 1823 | , m_width(76) |
| 1824 | , m_tab_expansion(false) |
| 1825 | , m_options(std::make_shared<OptionMap>()) |
| 1826 | { |
| 1827 | } |
| 1828 | |
| 1829 | Options& |
| 1830 | positional_help(std::string help_text) |
| 1831 | { |
| 1832 | m_positional_help = std::move(help_text); |
| 1833 | return *this; |
| 1834 | } |
| 1835 | |
| 1836 | Options& |
| 1837 | custom_help(std::string help_text) |
| 1838 | { |
| 1839 | m_custom_help = std::move(help_text); |
| 1840 | return *this; |
| 1841 | } |
| 1842 | |
| 1843 | Options& |
| 1844 | show_positional_help() |
| 1845 | { |
| 1846 | m_show_positional = true; |
| 1847 | return *this; |
| 1848 | } |
| 1849 | |
| 1850 | Options& |
| 1851 | allow_unrecognised_options() |
| 1852 | { |
| 1853 | m_allow_unrecognised = true; |
| 1854 | return *this; |
| 1855 | } |
| 1856 | |
| 1857 | Options& |
| 1858 | set_width(std::size_t width) |
| 1859 | { |
| 1860 | m_width = width; |
| 1861 | return *this; |
| 1862 | } |
| 1863 | |
| 1864 | Options& |
| 1865 | set_tab_expansion(bool expansion=true) |
| 1866 | { |
| 1867 | m_tab_expansion = expansion; |
| 1868 | return *this; |
| 1869 | } |
| 1870 | |
| 1871 | ParseResult |
| 1872 | parse(int argc, const char* const* argv); |
| 1873 | |
| 1874 | OptionAdder |
| 1875 | add_options(std::string group = ""); |
| 1876 | |
| 1877 | void |
| 1878 | add_options |
| 1879 | ( |
| 1880 | const std::string& group, |
| 1881 | std::initializer_list<Option> options |
| 1882 | ); |
| 1883 | |
| 1884 | void |
| 1885 | add_option |
| 1886 | ( |
| 1887 | const std::string& group, |
| 1888 | const Option& option |
| 1889 | ); |
| 1890 | |
| 1891 | void |
| 1892 | add_option |
| 1893 | ( |
| 1894 | const std::string& group, |
| 1895 | const std::string& s, |
| 1896 | const OptionNames& l, |
| 1897 | std::string desc, |
| 1898 | const std::shared_ptr<const Value>& value, |
| 1899 | std::string arg_help |
| 1900 | ); |
| 1901 | |
| 1902 | void |
| 1903 | add_option |
| 1904 | ( |
| 1905 | const std::string& group, |
| 1906 | const std::string& short_name, |
| 1907 | const std::string& single_long_name, |
| 1908 | std::string desc, |
| 1909 | const std::shared_ptr<const Value>& value, |
| 1910 | std::string arg_help |
| 1911 | ) |
| 1912 | { |
| 1913 | OptionNames long_names; |
| 1914 | long_names.emplace_back(single_long_name); |
| 1915 | add_option(group, short_name, long_names, desc, value, arg_help); |
| 1916 | } |
| 1917 | |
| 1918 | //parse positional arguments into the given option |
| 1919 | void |
| 1920 | parse_positional(std::string option); |
| 1921 | |
| 1922 | void |
| 1923 | parse_positional(std::vector<std::string> options); |
| 1924 | |
| 1925 | void |
| 1926 | parse_positional(std::initializer_list<std::string> options); |
| 1927 | |
| 1928 | template <typename Iterator> |
| 1929 | void |
| 1930 | parse_positional(Iterator begin, Iterator end) { |
| 1931 | parse_positional(std::vector<std::string>{begin, end}); |
| 1932 | } |
| 1933 | |
| 1934 | std::string |
| 1935 | help(const std::vector<std::string>& groups = {}, bool print_usage=true) const; |
| 1936 | |
| 1937 | std::vector<std::string> |
| 1938 | groups() const; |
| 1939 | |
| 1940 | const HelpGroupDetails& |
| 1941 | group_help(const std::string& group) const; |
| 1942 | |
| 1943 | const std::string& program() const |
| 1944 | { |
| 1945 | return m_program; |
| 1946 | } |
| 1947 | |
| 1948 | private: |
| 1949 | |
| 1950 | void |
| 1951 | add_one_option |
| 1952 | ( |
| 1953 | const std::string& option, |
| 1954 | const std::shared_ptr<OptionDetails>& details |
| 1955 | ); |
| 1956 | |
| 1957 | String |
| 1958 | help_one_group(const std::string& group) const; |
| 1959 | |
| 1960 | void |
| 1961 | generate_group_help |
| 1962 | ( |
| 1963 | String& result, |
| 1964 | const std::vector<std::string>& groups |
| 1965 | ) const; |
| 1966 | |
| 1967 | void |
| 1968 | generate_all_groups_help(String& result) const; |
| 1969 | |
| 1970 | std::string m_program{}; |
| 1971 | String m_help_string{}; |
| 1972 | std::string m_custom_help{}; |
| 1973 | std::string m_positional_help{}; |
| 1974 | bool m_show_positional; |
| 1975 | bool m_allow_unrecognised; |
| 1976 | std::size_t m_width; |
| 1977 | bool m_tab_expansion; |
| 1978 | |
| 1979 | std::shared_ptr<OptionMap> m_options; |
| 1980 | std::vector<std::string> m_positional{}; |
| 1981 | std::unordered_set<std::string> m_positional_set{}; |
| 1982 | |
| 1983 | //mapping from groups to help options |
| 1984 | std::map<std::string, HelpGroupDetails> m_help{}; |
| 1985 | }; |
| 1986 | |
| 1987 | class OptionAdder |
| 1988 | { |
| 1989 | public: |
| 1990 | |
| 1991 | OptionAdder(Options& options, std::string group) |
| 1992 | : m_options(options), m_group(std::move(group)) |
| 1993 | { |
| 1994 | } |
| 1995 | |
| 1996 | OptionAdder& |
| 1997 | operator() |
| 1998 | ( |
| 1999 | const std::string& opts, |
| 2000 | const std::string& desc, |
| 2001 | const std::shared_ptr<const Value>& value |
| 2002 | = ::cxxopts::value<bool>(), |
| 2003 | std::string arg_help = "" |
| 2004 | ); |
| 2005 | |
| 2006 | private: |
| 2007 | Options& m_options; |
| 2008 | std::string m_group; |
| 2009 | }; |
| 2010 | |
| 2011 | namespace { |
| 2012 | constexpr std::size_t OPTION_LONGEST = 30; |
| 2013 | constexpr std::size_t OPTION_DESC_GAP = 2; |
| 2014 | |
| 2015 | String |
| 2016 | format_option |
| 2017 | ( |
| 2018 | const HelpOptionDetails& o |
| 2019 | ) |
| 2020 | { |
| 2021 | const auto& s = o.s; |
| 2022 | const auto& l = first_or_empty(o.l); |
| 2023 | |
| 2024 | String result = " "; |
| 2025 | |
| 2026 | if (!s.empty()) |
| 2027 | { |
| 2028 | result += "-" + toLocalString(s); |
| 2029 | if (!l.empty()) |
| 2030 | { |
| 2031 | result += ","; |
| 2032 | } |
| 2033 | } |
| 2034 | else |
| 2035 | { |
| 2036 | result += " "; |
| 2037 | } |
| 2038 | |
| 2039 | if (!l.empty()) |
| 2040 | { |
| 2041 | result += " --" + toLocalString(l); |
| 2042 | } |
| 2043 | |
| 2044 | auto arg = !o.arg_help.empty() ? toLocalString(o.arg_help) : "arg"; |
| 2045 | |
| 2046 | if (!o.is_boolean) |
| 2047 | { |
| 2048 | if (o.has_implicit) |
| 2049 | { |
| 2050 | result += " [=" + arg + "(=" + toLocalString(o.implicit_value) + ")]"; |
| 2051 | } |
| 2052 | else |
| 2053 | { |
| 2054 | result += " " + arg; |
| 2055 | } |
| 2056 | } |
| 2057 | |
| 2058 | return result; |
| 2059 | } |
| 2060 | |
| 2061 | String |
| 2062 | format_description |
| 2063 | ( |
| 2064 | const HelpOptionDetails& o, |
| 2065 | std::size_t start, |
| 2066 | std::size_t allowed, |
| 2067 | bool tab_expansion |
| 2068 | ) |
| 2069 | { |
| 2070 | auto desc = o.desc; |
| 2071 | |
| 2072 | if (o.has_default && (!o.is_boolean || o.default_value != "false")) |
| 2073 | { |
| 2074 | if(!o.default_value.empty()) |
| 2075 | { |
| 2076 | desc += toLocalString(" (default: " + o.default_value + ")"); |
| 2077 | } |
| 2078 | else |
| 2079 | { |
| 2080 | desc += toLocalString(" (default: \"\")"); |
| 2081 | } |
| 2082 | } |
| 2083 | |
| 2084 | String result; |
| 2085 | |
| 2086 | if (tab_expansion) |
| 2087 | { |
| 2088 | String desc2; |
| 2089 | auto size = std::size_t{ 0 }; |
| 2090 | for (auto c = std::begin(desc); c != std::end(desc); ++c) |
| 2091 | { |
| 2092 | if (*c == '\n') |
| 2093 | { |
| 2094 | desc2 += *c; |
| 2095 | size = 0; |
| 2096 | } |
| 2097 | else if (*c == '\t') |
| 2098 | { |
| 2099 | auto skip = 8 - size % 8; |
| 2100 | stringAppend(desc2, skip, ' '); |
| 2101 | size += skip; |
| 2102 | } |
| 2103 | else |
| 2104 | { |
| 2105 | desc2 += *c; |
| 2106 | ++size; |
| 2107 | } |
| 2108 | } |
| 2109 | desc = desc2; |
| 2110 | } |
| 2111 | |
| 2112 | desc += " "; |
| 2113 | |
| 2114 | auto current = std::begin(desc); |
| 2115 | auto previous = current; |
| 2116 | auto startLine = current; |
| 2117 | auto lastSpace = current; |
| 2118 | |
| 2119 | auto size = std::size_t{}; |
| 2120 | |
| 2121 | bool appendNewLine; |
| 2122 | bool onlyWhiteSpace = true; |
| 2123 | |
| 2124 | while (current != std::end(desc)) |
| 2125 | { |
| 2126 | appendNewLine = false; |
| 2127 | if (*previous == ' ' || *previous == '\t') |
| 2128 | { |
| 2129 | lastSpace = current; |
| 2130 | } |
| 2131 | if (*current != ' ' && *current != '\t') |
| 2132 | { |
| 2133 | onlyWhiteSpace = false; |
| 2134 | } |
| 2135 | |
| 2136 | while (*current == '\n') |
| 2137 | { |
| 2138 | previous = current; |
| 2139 | ++current; |
| 2140 | appendNewLine = true; |
| 2141 | } |
| 2142 | |
| 2143 | if (!appendNewLine && size >= allowed) |
| 2144 | { |
| 2145 | if (lastSpace != startLine) |
| 2146 | { |
| 2147 | current = lastSpace; |
| 2148 | previous = current; |
| 2149 | } |
| 2150 | appendNewLine = true; |
| 2151 | } |
| 2152 | |
| 2153 | if (appendNewLine) |
| 2154 | { |
| 2155 | stringAppend(result, startLine, current); |
| 2156 | startLine = current; |
| 2157 | lastSpace = current; |
| 2158 | |
| 2159 | if (*previous != '\n') |
| 2160 | { |
| 2161 | stringAppend(result, "\n"); |
| 2162 | } |
| 2163 | |
| 2164 | stringAppend(result, start, ' '); |
| 2165 | |
| 2166 | if (*previous != '\n') |
| 2167 | { |
| 2168 | stringAppend(result, lastSpace, current); |
| 2169 | } |
| 2170 | |
| 2171 | onlyWhiteSpace = true; |
| 2172 | size = 0; |
| 2173 | } |
| 2174 | |
| 2175 | previous = current; |
| 2176 | ++current; |
| 2177 | ++size; |
| 2178 | } |
| 2179 | |
| 2180 | //append whatever is left but ignore whitespace |
| 2181 | if (!onlyWhiteSpace) |
| 2182 | { |
| 2183 | stringAppend(result, startLine, previous); |
| 2184 | } |
| 2185 | |
| 2186 | return result; |
| 2187 | } |
| 2188 | |
| 2189 | } // namespace |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2190 | |
| 2191 | inline |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2192 | void |
| 2193 | Options::add_options |
| 2194 | ( |
| 2195 | const std::string &group, |
| 2196 | std::initializer_list<Option> options |
| 2197 | ) |
| 2198 | { |
| 2199 | OptionAdder option_adder(*this, group); |
| 2200 | for (const auto &option: options) |
| 2201 | { |
| 2202 | option_adder(option.opts_, option.desc_, option.value_, option.arg_help_); |
| 2203 | } |
| 2204 | } |
| 2205 | |
| 2206 | inline |
| 2207 | OptionAdder |
| 2208 | Options::add_options(std::string group) |
| 2209 | { |
| 2210 | return OptionAdder(*this, std::move(group)); |
| 2211 | } |
| 2212 | |
| 2213 | inline |
| 2214 | OptionAdder& |
| 2215 | OptionAdder::operator() |
| 2216 | ( |
| 2217 | const std::string& opts, |
| 2218 | const std::string& desc, |
| 2219 | const std::shared_ptr<const Value>& value, |
| 2220 | std::string arg_help |
| 2221 | ) |
| 2222 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2223 | OptionNames option_names = values::parser_tool::split_option_names(opts); |
| 2224 | // Note: All names will be non-empty; but we must separate the short |
| 2225 | // (length-1) and longer names |
| 2226 | std::string short_name {""}; |
| 2227 | auto first_short_name_iter = |
| 2228 | std::partition(option_names.begin(), option_names.end(), |
| 2229 | [&](const std::string& name) { return name.length() > 1; } |
| 2230 | ); |
| 2231 | auto num_length_1_names = (option_names.end() - first_short_name_iter); |
| 2232 | switch(num_length_1_names) { |
| 2233 | case 1: |
| 2234 | short_name = *first_short_name_iter; |
| 2235 | option_names.erase(first_short_name_iter); |
| 2236 | break; |
| 2237 | case 0: |
| 2238 | break; |
| 2239 | default: |
| 2240 | throw_or_mimic<exceptions::invalid_option_format>(opts); |
| 2241 | }; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2242 | |
| 2243 | m_options.add_option |
| 2244 | ( |
| 2245 | m_group, |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2246 | short_name, |
| 2247 | option_names, |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2248 | desc, |
| 2249 | value, |
| 2250 | std::move(arg_help) |
| 2251 | ); |
| 2252 | |
| 2253 | return *this; |
| 2254 | } |
| 2255 | |
| 2256 | inline |
| 2257 | void |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2258 | OptionParser::parse_default(const std::shared_ptr<OptionDetails>& details) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2259 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2260 | // TODO: remove the duplicate code here |
| 2261 | auto& store = m_parsed[details->hash()]; |
| 2262 | store.parse_default(details); |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2263 | m_defaults.emplace_back(details->essential_name(), details->value().get_default_value()); |
| 2264 | } |
| 2265 | |
| 2266 | inline |
| 2267 | void |
| 2268 | OptionParser::parse_no_value(const std::shared_ptr<OptionDetails>& details) |
| 2269 | { |
| 2270 | auto& store = m_parsed[details->hash()]; |
| 2271 | store.parse_no_value(details); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2272 | } |
| 2273 | |
| 2274 | inline |
| 2275 | void |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2276 | OptionParser::parse_option |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2277 | ( |
| 2278 | const std::shared_ptr<OptionDetails>& value, |
| 2279 | const std::string& /*name*/, |
| 2280 | const std::string& arg |
| 2281 | ) |
| 2282 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2283 | auto hash = value->hash(); |
| 2284 | auto& result = m_parsed[hash]; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2285 | result.parse(value, arg); |
| 2286 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2287 | m_sequential.emplace_back(value->essential_name(), arg); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2288 | } |
| 2289 | |
| 2290 | inline |
| 2291 | void |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2292 | OptionParser::checked_parse_arg |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2293 | ( |
| 2294 | int argc, |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2295 | const char* const* argv, |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2296 | int& current, |
| 2297 | const std::shared_ptr<OptionDetails>& value, |
| 2298 | const std::string& name |
| 2299 | ) |
| 2300 | { |
| 2301 | if (current + 1 >= argc) |
| 2302 | { |
| 2303 | if (value->value().has_implicit()) |
| 2304 | { |
| 2305 | parse_option(value, name, value->value().get_implicit_value()); |
| 2306 | } |
| 2307 | else |
| 2308 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2309 | throw_or_mimic<exceptions::missing_argument>(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2310 | } |
| 2311 | } |
| 2312 | else |
| 2313 | { |
| 2314 | if (value->value().has_implicit()) |
| 2315 | { |
| 2316 | parse_option(value, name, value->value().get_implicit_value()); |
| 2317 | } |
| 2318 | else |
| 2319 | { |
| 2320 | parse_option(value, name, argv[current + 1]); |
| 2321 | ++current; |
| 2322 | } |
| 2323 | } |
| 2324 | } |
| 2325 | |
| 2326 | inline |
| 2327 | void |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2328 | OptionParser::add_to_option(OptionMap::const_iterator iter, const std::string& option, const std::string& arg) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2329 | { |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2330 | parse_option(iter->second, option, arg); |
| 2331 | } |
| 2332 | |
| 2333 | inline |
| 2334 | bool |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2335 | OptionParser::consume_positional(const std::string& a, PositionalListIterator& next) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2336 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2337 | while (next != m_positional.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2338 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2339 | auto iter = m_options.find(*next); |
| 2340 | if (iter != m_options.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2341 | { |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2342 | if (!iter->second->value().is_container()) |
| 2343 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2344 | auto& result = m_parsed[iter->second->hash()]; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2345 | if (result.count() == 0) |
| 2346 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2347 | add_to_option(iter, *next, a); |
| 2348 | ++next; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2349 | return true; |
| 2350 | } |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2351 | ++next; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2352 | continue; |
| 2353 | } |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2354 | add_to_option(iter, *next, a); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2355 | return true; |
| 2356 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2357 | throw_or_mimic<exceptions::no_such_option>(*next); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2358 | } |
| 2359 | |
| 2360 | return false; |
| 2361 | } |
| 2362 | |
| 2363 | inline |
| 2364 | void |
| 2365 | Options::parse_positional(std::string option) |
| 2366 | { |
| 2367 | parse_positional(std::vector<std::string>{std::move(option)}); |
| 2368 | } |
| 2369 | |
| 2370 | inline |
| 2371 | void |
| 2372 | Options::parse_positional(std::vector<std::string> options) |
| 2373 | { |
| 2374 | m_positional = std::move(options); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2375 | |
| 2376 | m_positional_set.insert(m_positional.begin(), m_positional.end()); |
| 2377 | } |
| 2378 | |
| 2379 | inline |
| 2380 | void |
| 2381 | Options::parse_positional(std::initializer_list<std::string> options) |
| 2382 | { |
| 2383 | parse_positional(std::vector<std::string>(options)); |
| 2384 | } |
| 2385 | |
| 2386 | inline |
| 2387 | ParseResult |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2388 | Options::parse(int argc, const char* const* argv) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2389 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2390 | OptionParser parser(*m_options, m_positional, m_allow_unrecognised); |
| 2391 | |
| 2392 | return parser.parse(argc, argv); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2393 | } |
| 2394 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2395 | inline ParseResult |
| 2396 | OptionParser::parse(int argc, const char* const* argv) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2397 | { |
| 2398 | int current = 1; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2399 | bool consume_remaining = false; |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2400 | auto next_positional = m_positional.begin(); |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2401 | |
| 2402 | std::vector<std::string> unmatched; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2403 | |
| 2404 | while (current != argc) |
| 2405 | { |
| 2406 | if (strcmp(argv[current], "--") == 0) |
| 2407 | { |
| 2408 | consume_remaining = true; |
| 2409 | ++current; |
| 2410 | break; |
| 2411 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2412 | bool matched = false; |
| 2413 | values::parser_tool::ArguDesc argu_desc = |
| 2414 | values::parser_tool::ParseArgument(argv[current], matched); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2415 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2416 | if (!matched) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2417 | { |
| 2418 | //not a flag |
| 2419 | |
| 2420 | // but if it starts with a `-`, then it's an error |
| 2421 | if (argv[current][0] == '-' && argv[current][1] != '\0') { |
| 2422 | if (!m_allow_unrecognised) { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2423 | throw_or_mimic<exceptions::invalid_option_syntax>(argv[current]); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2424 | } |
| 2425 | } |
| 2426 | |
| 2427 | //if true is returned here then it was consumed, otherwise it is |
| 2428 | //ignored |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2429 | if (consume_positional(argv[current], next_positional)) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2430 | { |
| 2431 | } |
| 2432 | else |
| 2433 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2434 | unmatched.emplace_back(argv[current]); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2435 | } |
| 2436 | //if we return from here then it was parsed successfully, so continue |
| 2437 | } |
| 2438 | else |
| 2439 | { |
| 2440 | //short or long option? |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2441 | if (argu_desc.grouping) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2442 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2443 | const std::string& s = argu_desc.arg_name; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2444 | |
| 2445 | for (std::size_t i = 0; i != s.size(); ++i) |
| 2446 | { |
| 2447 | std::string name(1, s[i]); |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2448 | auto iter = m_options.find(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2449 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2450 | if (iter == m_options.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2451 | { |
| 2452 | if (m_allow_unrecognised) |
| 2453 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2454 | unmatched.push_back(std::string("-") + s[i]); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2455 | continue; |
| 2456 | } |
| 2457 | //error |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2458 | throw_or_mimic<exceptions::no_such_option>(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2459 | } |
| 2460 | |
| 2461 | auto value = iter->second; |
| 2462 | |
| 2463 | if (i + 1 == s.size()) |
| 2464 | { |
| 2465 | //it must be the last argument |
| 2466 | checked_parse_arg(argc, argv, current, value, name); |
| 2467 | } |
| 2468 | else if (value->value().has_implicit()) |
| 2469 | { |
| 2470 | parse_option(value, name, value->value().get_implicit_value()); |
| 2471 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2472 | else if (i + 1 < s.size()) |
| 2473 | { |
| 2474 | std::string arg_value = s.substr(i + 1); |
| 2475 | parse_option(value, name, arg_value); |
| 2476 | break; |
| 2477 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2478 | else |
| 2479 | { |
| 2480 | //error |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2481 | throw_or_mimic<exceptions::option_requires_argument>(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2482 | } |
| 2483 | } |
| 2484 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2485 | else if (argu_desc.arg_name.length() != 0) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2486 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2487 | const std::string& name = argu_desc.arg_name; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2488 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2489 | auto iter = m_options.find(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2490 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2491 | if (iter == m_options.end()) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2492 | { |
| 2493 | if (m_allow_unrecognised) |
| 2494 | { |
| 2495 | // keep unrecognised options in argument list, skip to next argument |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2496 | unmatched.emplace_back(argv[current]); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2497 | ++current; |
| 2498 | continue; |
| 2499 | } |
| 2500 | //error |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2501 | throw_or_mimic<exceptions::no_such_option>(name); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2502 | } |
| 2503 | |
| 2504 | auto opt = iter->second; |
| 2505 | |
| 2506 | //equals provided for long option? |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2507 | if (argu_desc.set_value) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2508 | { |
| 2509 | //parse the option given |
| 2510 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2511 | parse_option(opt, name, argu_desc.value); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2512 | } |
| 2513 | else |
| 2514 | { |
| 2515 | //parse the next argument |
| 2516 | checked_parse_arg(argc, argv, current, opt, name); |
| 2517 | } |
| 2518 | } |
| 2519 | |
| 2520 | } |
| 2521 | |
| 2522 | ++current; |
| 2523 | } |
| 2524 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2525 | for (auto& opt : m_options) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2526 | { |
| 2527 | auto& detail = opt.second; |
| 2528 | const auto& value = detail->value(); |
| 2529 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2530 | auto& store = m_parsed[detail->hash()]; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2531 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2532 | if (value.has_default()) { |
| 2533 | if (!store.count() && !store.has_default()) { |
| 2534 | parse_default(detail); |
| 2535 | } |
| 2536 | } |
| 2537 | else { |
| 2538 | parse_no_value(detail); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2539 | } |
| 2540 | } |
| 2541 | |
| 2542 | if (consume_remaining) |
| 2543 | { |
| 2544 | while (current < argc) |
| 2545 | { |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2546 | if (!consume_positional(argv[current], next_positional)) { |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2547 | break; |
| 2548 | } |
| 2549 | ++current; |
| 2550 | } |
| 2551 | |
| 2552 | //adjust argv for any that couldn't be swallowed |
| 2553 | while (current != argc) { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2554 | unmatched.emplace_back(argv[current]); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2555 | ++current; |
| 2556 | } |
| 2557 | } |
| 2558 | |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2559 | finalise_aliases(); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2560 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2561 | ParseResult parsed(std::move(m_keys), std::move(m_parsed), std::move(m_sequential), std::move(m_defaults), std::move(unmatched)); |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2562 | return parsed; |
| 2563 | } |
| 2564 | |
| 2565 | inline |
| 2566 | void |
| 2567 | OptionParser::finalise_aliases() |
| 2568 | { |
| 2569 | for (auto& option: m_options) |
| 2570 | { |
| 2571 | auto& detail = *option.second; |
| 2572 | auto hash = detail.hash(); |
| 2573 | m_keys[detail.short_name()] = hash; |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2574 | for(const auto& long_name : detail.long_names()) { |
| 2575 | m_keys[long_name] = hash; |
| 2576 | } |
Matthew Sloyan | 84dc843 | 2020-10-06 16:06:07 +0100 | [diff] [blame] | 2577 | |
| 2578 | m_parsed.emplace(hash, OptionValue()); |
| 2579 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2580 | } |
| 2581 | |
| 2582 | inline |
| 2583 | void |
| 2584 | Options::add_option |
| 2585 | ( |
| 2586 | const std::string& group, |
| 2587 | const Option& option |
| 2588 | ) |
| 2589 | { |
| 2590 | add_options(group, {option}); |
| 2591 | } |
| 2592 | |
| 2593 | inline |
| 2594 | void |
| 2595 | Options::add_option |
| 2596 | ( |
| 2597 | const std::string& group, |
| 2598 | const std::string& s, |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2599 | const OptionNames& l, |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2600 | std::string desc, |
| 2601 | const std::shared_ptr<const Value>& value, |
| 2602 | std::string arg_help |
| 2603 | ) |
| 2604 | { |
| 2605 | auto stringDesc = toLocalString(std::move(desc)); |
| 2606 | auto option = std::make_shared<OptionDetails>(s, l, stringDesc, value); |
| 2607 | |
| 2608 | if (!s.empty()) |
| 2609 | { |
| 2610 | add_one_option(s, option); |
| 2611 | } |
| 2612 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2613 | for(const auto& long_name : l) { |
| 2614 | add_one_option(long_name, option); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2615 | } |
| 2616 | |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2617 | //add the help details |
| 2618 | auto& options = m_help[group]; |
| 2619 | |
| 2620 | options.options.emplace_back(HelpOptionDetails{s, l, stringDesc, |
| 2621 | value->has_default(), value->get_default_value(), |
| 2622 | value->has_implicit(), value->get_implicit_value(), |
| 2623 | std::move(arg_help), |
| 2624 | value->is_container(), |
| 2625 | value->is_boolean()}); |
| 2626 | } |
| 2627 | |
| 2628 | inline |
| 2629 | void |
| 2630 | Options::add_one_option |
| 2631 | ( |
| 2632 | const std::string& option, |
| 2633 | const std::shared_ptr<OptionDetails>& details |
| 2634 | ) |
| 2635 | { |
| 2636 | auto in = m_options->emplace(option, details); |
| 2637 | |
| 2638 | if (!in.second) |
| 2639 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2640 | throw_or_mimic<exceptions::option_already_exists>(option); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2641 | } |
| 2642 | } |
| 2643 | |
| 2644 | inline |
| 2645 | String |
| 2646 | Options::help_one_group(const std::string& g) const |
| 2647 | { |
| 2648 | using OptionHelp = std::vector<std::pair<String, String>>; |
| 2649 | |
| 2650 | auto group = m_help.find(g); |
| 2651 | if (group == m_help.end()) |
| 2652 | { |
| 2653 | return ""; |
| 2654 | } |
| 2655 | |
| 2656 | OptionHelp format; |
| 2657 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2658 | std::size_t longest = 0; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2659 | |
| 2660 | String result; |
| 2661 | |
| 2662 | if (!g.empty()) |
| 2663 | { |
| 2664 | result += toLocalString(" " + g + " options:\n"); |
| 2665 | } |
| 2666 | |
| 2667 | for (const auto& o : group->second.options) |
| 2668 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2669 | if (o.l.size() && |
| 2670 | m_positional_set.find(o.l.front()) != m_positional_set.end() && |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2671 | !m_show_positional) |
| 2672 | { |
| 2673 | continue; |
| 2674 | } |
| 2675 | |
| 2676 | auto s = format_option(o); |
| 2677 | longest = (std::max)(longest, stringLength(s)); |
| 2678 | format.push_back(std::make_pair(s, String())); |
| 2679 | } |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2680 | longest = (std::min)(longest, OPTION_LONGEST); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2681 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2682 | //widest allowed description -- min 10 chars for helptext/line |
| 2683 | std::size_t allowed = 10; |
| 2684 | if (m_width > allowed + longest + OPTION_DESC_GAP) |
| 2685 | { |
| 2686 | allowed = m_width - longest - OPTION_DESC_GAP; |
| 2687 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2688 | |
| 2689 | auto fiter = format.begin(); |
| 2690 | for (const auto& o : group->second.options) |
| 2691 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2692 | if (o.l.size() && |
| 2693 | m_positional_set.find(o.l.front()) != m_positional_set.end() && |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2694 | !m_show_positional) |
| 2695 | { |
| 2696 | continue; |
| 2697 | } |
| 2698 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2699 | auto d = format_description(o, longest + OPTION_DESC_GAP, allowed, m_tab_expansion); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2700 | |
| 2701 | result += fiter->first; |
| 2702 | if (stringLength(fiter->first) > longest) |
| 2703 | { |
| 2704 | result += '\n'; |
| 2705 | result += toLocalString(std::string(longest + OPTION_DESC_GAP, ' ')); |
| 2706 | } |
| 2707 | else |
| 2708 | { |
| 2709 | result += toLocalString(std::string(longest + OPTION_DESC_GAP - |
| 2710 | stringLength(fiter->first), |
| 2711 | ' ')); |
| 2712 | } |
| 2713 | result += d; |
| 2714 | result += '\n'; |
| 2715 | |
| 2716 | ++fiter; |
| 2717 | } |
| 2718 | |
| 2719 | return result; |
| 2720 | } |
| 2721 | |
| 2722 | inline |
| 2723 | void |
| 2724 | Options::generate_group_help |
| 2725 | ( |
| 2726 | String& result, |
| 2727 | const std::vector<std::string>& print_groups |
| 2728 | ) const |
| 2729 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2730 | for (std::size_t i = 0; i != print_groups.size(); ++i) |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2731 | { |
| 2732 | const String& group_help_text = help_one_group(print_groups[i]); |
| 2733 | if (empty(group_help_text)) |
| 2734 | { |
| 2735 | continue; |
| 2736 | } |
| 2737 | result += group_help_text; |
| 2738 | if (i < print_groups.size() - 1) |
| 2739 | { |
| 2740 | result += '\n'; |
| 2741 | } |
| 2742 | } |
| 2743 | } |
| 2744 | |
| 2745 | inline |
| 2746 | void |
| 2747 | Options::generate_all_groups_help(String& result) const |
| 2748 | { |
| 2749 | std::vector<std::string> all_groups; |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2750 | |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2751 | std::transform( |
| 2752 | m_help.begin(), |
| 2753 | m_help.end(), |
| 2754 | std::back_inserter(all_groups), |
| 2755 | [] (const std::map<std::string, HelpGroupDetails>::value_type& group) |
| 2756 | { |
| 2757 | return group.first; |
| 2758 | } |
| 2759 | ); |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2760 | |
| 2761 | generate_group_help(result, all_groups); |
| 2762 | } |
| 2763 | |
| 2764 | inline |
| 2765 | std::string |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2766 | Options::help(const std::vector<std::string>& help_groups, bool print_usage) const |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2767 | { |
Jim Flynn | 357add2 | 2023-04-10 23:26:40 +0100 | [diff] [blame] | 2768 | String result = m_help_string; |
| 2769 | if(print_usage) |
| 2770 | { |
| 2771 | result+= "\nUsage:\n " + toLocalString(m_program); |
| 2772 | } |
| 2773 | |
| 2774 | if (!m_custom_help.empty()) |
| 2775 | { |
| 2776 | result += " " + toLocalString(m_custom_help); |
| 2777 | } |
Jan Eilers | 7e98983 | 2020-06-19 11:47:21 +0100 | [diff] [blame] | 2778 | |
| 2779 | if (!m_positional.empty() && !m_positional_help.empty()) { |
| 2780 | result += " " + toLocalString(m_positional_help); |
| 2781 | } |
| 2782 | |
| 2783 | result += "\n\n"; |
| 2784 | |
| 2785 | if (help_groups.empty()) |
| 2786 | { |
| 2787 | generate_all_groups_help(result); |
| 2788 | } |
| 2789 | else |
| 2790 | { |
| 2791 | generate_group_help(result, help_groups); |
| 2792 | } |
| 2793 | |
| 2794 | return toUTF8String(result); |
| 2795 | } |
| 2796 | |
| 2797 | inline |
| 2798 | std::vector<std::string> |
| 2799 | Options::groups() const |
| 2800 | { |
| 2801 | std::vector<std::string> g; |
| 2802 | |
| 2803 | std::transform( |
| 2804 | m_help.begin(), |
| 2805 | m_help.end(), |
| 2806 | std::back_inserter(g), |
| 2807 | [] (const std::map<std::string, HelpGroupDetails>::value_type& pair) |
| 2808 | { |
| 2809 | return pair.first; |
| 2810 | } |
| 2811 | ); |
| 2812 | |
| 2813 | return g; |
| 2814 | } |
| 2815 | |
| 2816 | inline |
| 2817 | const HelpGroupDetails& |
| 2818 | Options::group_help(const std::string& group) const |
| 2819 | { |
| 2820 | return m_help.at(group); |
| 2821 | } |
| 2822 | |
| 2823 | } // namespace cxxopts |
| 2824 | |
| 2825 | #endif //CXXOPTS_HPP_INCLUDED |