-
Notifications
You must be signed in to change notification settings - Fork 19
/
args.hxx
4173 lines (3608 loc) · 139 KB
/
args.hxx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2016-2017 Taylor C. Richberger <taywee@gmx.com> and Pavel
* Belikov
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
/** \file args.hxx
* \brief this single-header lets you use all of the args functionality
*
* The important stuff is done inside the args namespace
*/
#ifndef ARGS_HXX
#define ARGS_HXX
#include <algorithm>
#include <iterator>
#include <exception>
#include <functional>
#include <sstream>
#include <string>
#include <tuple>
#include <vector>
#include <unordered_map>
#include <unordered_set>
#include <type_traits>
#ifdef ARGS_TESTNAMESPACE
namespace argstest
{
#else
/** \namespace args
* \brief contains all the functionality of the args library
*/
namespace args
{
#endif
/** Getter to grab the value from the argument type.
*
* If the Get() function of the type returns a reference, so does this, and
* the value will be modifiable.
*/
template <typename Option>
auto get(Option &option_) -> decltype(option_.Get())
{
return option_.Get();
}
/** (INTERNAL) Count UTF-8 glyphs
*
* This is not reliable, and will fail for combinatory glyphs, but it's
* good enough here for now.
*
* \param string The string to count glyphs from
* \return The UTF-8 glyphs in the string
*/
inline std::string::size_type Glyphs(const std::string &string_)
{
std::string::size_type length = 0;
for (const char c: string_)
{
if ((c & 0xc0) != 0x80)
{
++length;
}
}
return length;
}
/** (INTERNAL) Wrap a vector of words into a vector of lines
*
* Empty words are skipped. Word "\n" forces wrapping.
*
* \param begin The begin iterator
* \param end The end iterator
* \param width The width of the body
* \param firstlinewidth the width of the first line, defaults to the width of the body
* \param firstlineindent the indent of the first line, defaults to 0
* \return the vector of lines
*/
template <typename It>
inline std::vector<std::string> Wrap(It begin,
It end,
const std::string::size_type width,
std::string::size_type firstlinewidth = 0,
std::string::size_type firstlineindent = 0)
{
std::vector<std::string> output;
std::string line(firstlineindent, ' ');
bool empty = true;
if (firstlinewidth == 0)
{
firstlinewidth = width;
}
auto currentwidth = firstlinewidth;
for (auto it = begin; it != end; ++it)
{
if (it->empty())
{
continue;
}
if (*it == "\n")
{
if (!empty)
{
output.push_back(line);
line.clear();
empty = true;
currentwidth = width;
}
continue;
}
auto itemsize = Glyphs(*it);
if ((line.length() + 1 + itemsize) > currentwidth)
{
if (!empty)
{
output.push_back(line);
line.clear();
empty = true;
currentwidth = width;
}
}
if (itemsize > 0)
{
if (!empty)
{
line += ' ';
}
line += *it;
empty = false;
}
}
if (!empty)
{
output.push_back(line);
}
return output;
}
namespace detail
{
template <typename T>
std::string Join(const T& array, const std::string &delimiter)
{
std::string res;
for (auto &element : array)
{
if (!res.empty())
{
res += delimiter;
}
res += element;
}
return res;
}
}
/** (INTERNAL) Wrap a string into a vector of lines
*
* This is quick and hacky, but works well enough. You can specify a
* different width for the first line
*
* \param width The width of the body
* \param firstlinewid the width of the first line, defaults to the width of the body
* \return the vector of lines
*/
inline std::vector<std::string> Wrap(const std::string &in, const std::string::size_type width, std::string::size_type firstlinewidth = 0)
{
// Preserve existing line breaks
const auto newlineloc = in.find('\n');
if (newlineloc != in.npos)
{
auto first = Wrap(std::string(in, 0, newlineloc), width);
auto second = Wrap(std::string(in, newlineloc + 1), width);
first.insert(
std::end(first),
std::make_move_iterator(std::begin(second)),
std::make_move_iterator(std::end(second)));
return first;
}
std::istringstream stream(in);
std::string::size_type indent = 0;
for (char c : in)
{
if (!isspace(c))
{
break;
}
++indent;
}
return Wrap(std::istream_iterator<std::string>(stream), std::istream_iterator<std::string>(),
width, firstlinewidth, indent);
}
#ifdef ARGS_NOEXCEPT
/// Error class, for when ARGS_NOEXCEPT is defined
enum class Error
{
None,
Usage,
Parse,
Validation,
Required,
Map,
Extra,
Help,
Subparser,
Completion,
};
#else
/** Base error class
*/
class Error : public std::runtime_error
{
public:
Error(const std::string &problem) : std::runtime_error(problem) {}
virtual ~Error() {}
};
/** Errors that occur during usage
*/
class UsageError : public Error
{
public:
UsageError(const std::string &problem) : Error(problem) {}
virtual ~UsageError() {}
};
/** Errors that occur during regular parsing
*/
class ParseError : public Error
{
public:
ParseError(const std::string &problem) : Error(problem) {}
virtual ~ParseError() {}
};
/** Errors that are detected from group validation after parsing finishes
*/
class ValidationError : public Error
{
public:
ValidationError(const std::string &problem) : Error(problem) {}
virtual ~ValidationError() {}
};
/** Errors that when a required flag is omitted
*/
class RequiredError : public ValidationError
{
public:
RequiredError(const std::string &problem) : ValidationError(problem) {}
virtual ~RequiredError() {}
};
/** Errors in map lookups
*/
class MapError : public ParseError
{
public:
MapError(const std::string &problem) : ParseError(problem) {}
virtual ~MapError() {}
};
/** Error that occurs when a singular flag is specified multiple times
*/
class ExtraError : public ParseError
{
public:
ExtraError(const std::string &problem) : ParseError(problem) {}
virtual ~ExtraError() {}
};
/** An exception that indicates that the user has requested help
*/
class Help : public Error
{
public:
Help(const std::string &flag) : Error(flag) {}
virtual ~Help() {}
};
/** (INTERNAL) An exception that emulates coroutine-like control flow for subparsers.
*/
class SubparserError : public Error
{
public:
SubparserError() : Error("") {}
virtual ~SubparserError() {}
};
/** An exception that contains autocompletion reply
*/
class Completion : public Error
{
public:
Completion(const std::string &flag) : Error(flag) {}
virtual ~Completion() {}
};
#endif
/** A simple unified option type for unified initializer lists for the Matcher class.
*/
struct EitherFlag
{
const bool isShort;
const char shortFlag;
const std::string longFlag;
EitherFlag(const std::string &flag) : isShort(false), shortFlag(), longFlag(flag) {}
EitherFlag(const char *flag) : isShort(false), shortFlag(), longFlag(flag) {}
EitherFlag(const char flag) : isShort(true), shortFlag(flag), longFlag() {}
/** Get just the long flags from an initializer list of EitherFlags
*/
static std::unordered_set<std::string> GetLong(std::initializer_list<EitherFlag> flags)
{
std::unordered_set<std::string> longFlags;
for (const EitherFlag &flag: flags)
{
if (!flag.isShort)
{
longFlags.insert(flag.longFlag);
}
}
return longFlags;
}
/** Get just the short flags from an initializer list of EitherFlags
*/
static std::unordered_set<char> GetShort(std::initializer_list<EitherFlag> flags)
{
std::unordered_set<char> shortFlags;
for (const EitherFlag &flag: flags)
{
if (flag.isShort)
{
shortFlags.insert(flag.shortFlag);
}
}
return shortFlags;
}
std::string str() const
{
return isShort ? std::string(1, shortFlag) : longFlag;
}
std::string str(const std::string &shortPrefix, const std::string &longPrefix) const
{
return isShort ? shortPrefix + std::string(1, shortFlag) : longPrefix + longFlag;
}
};
/** A class of "matchers", specifying short and flags that can possibly be
* matched.
*
* This is supposed to be constructed and then passed in, not used directly
* from user code.
*/
class Matcher
{
private:
const std::unordered_set<char> shortFlags;
const std::unordered_set<std::string> longFlags;
public:
/** Specify short and long flags separately as iterators
*
* ex: `args::Matcher(shortFlags.begin(), shortFlags.end(), longFlags.begin(), longFlags.end())`
*/
template <typename ShortIt, typename LongIt>
Matcher(ShortIt shortFlagsStart, ShortIt shortFlagsEnd, LongIt longFlagsStart, LongIt longFlagsEnd) :
shortFlags(shortFlagsStart, shortFlagsEnd),
longFlags(longFlagsStart, longFlagsEnd)
{
if (shortFlags.empty() && longFlags.empty())
{
#ifndef ARGS_NOEXCEPT
throw UsageError("empty Matcher");
#endif
}
}
#ifdef ARGS_NOEXCEPT
/// Only for ARGS_NOEXCEPT
Error GetError() const noexcept
{
return shortFlags.empty() && longFlags.empty() ? Error::Usage : Error::None;
}
#endif
/** Specify short and long flags separately as iterables
*
* ex: `args::Matcher(shortFlags, longFlags)`
*/
template <typename Short, typename Long>
Matcher(Short &&shortIn, Long &&longIn) :
Matcher(std::begin(shortIn), std::end(shortIn), std::begin(longIn), std::end(longIn))
{}
/** Specify a mixed single initializer-list of both short and long flags
*
* This is the fancy one. It takes a single initializer list of
* any number of any mixed kinds of flags. Chars are
* automatically interpreted as short flags, and strings are
* automatically interpreted as long flags:
*
* args::Matcher{'a'}
* args::Matcher{"foo"}
* args::Matcher{'h', "help"}
* args::Matcher{"foo", 'f', 'F', "FoO"}
*/
Matcher(std::initializer_list<EitherFlag> in) :
Matcher(EitherFlag::GetShort(in), EitherFlag::GetLong(in)) {}
Matcher(Matcher &&other) : shortFlags(std::move(other.shortFlags)), longFlags(std::move(other.longFlags))
{}
~Matcher() {}
/** (INTERNAL) Check if there is a match of a short flag
*/
bool Match(const char flag) const
{
return shortFlags.find(flag) != shortFlags.end();
}
/** (INTERNAL) Check if there is a match of a long flag
*/
bool Match(const std::string &flag) const
{
return longFlags.find(flag) != longFlags.end();
}
/** (INTERNAL) Check if there is a match of a flag
*/
bool Match(const EitherFlag &flag) const
{
return flag.isShort ? Match(flag.shortFlag) : Match(flag.longFlag);
}
/** (INTERNAL) Get all flag strings as a vector, with the prefixes embedded
*/
std::vector<EitherFlag> GetFlagStrings() const
{
std::vector<EitherFlag> flagStrings;
flagStrings.reserve(shortFlags.size() + longFlags.size());
for (const char flag: shortFlags)
{
flagStrings.emplace_back(flag);
}
for (const std::string &flag: longFlags)
{
flagStrings.emplace_back(flag);
}
return flagStrings;
}
/** (INTERNAL) Get long flag if it exists or any short flag
*/
EitherFlag GetLongOrAny() const
{
if (!longFlags.empty())
{
return *longFlags.begin();
}
if (!shortFlags.empty())
{
return *shortFlags.begin();
}
// should be unreachable
return ' ';
}
/** (INTERNAL) Get short flag if it exists or any long flag
*/
EitherFlag GetShortOrAny() const
{
if (!shortFlags.empty())
{
return *shortFlags.begin();
}
if (!longFlags.empty())
{
return *longFlags.begin();
}
// should be unreachable
return ' ';
}
};
/** Attributes for flags.
*/
enum class Options
{
/** Default options.
*/
None = 0x0,
/** Flag can't be passed multiple times.
*/
Single = 0x01,
/** Flag can't be omitted.
*/
Required = 0x02,
/** Flag is excluded from usage line.
*/
HiddenFromUsage = 0x04,
/** Flag is excluded from options help.
*/
HiddenFromDescription = 0x08,
/** Flag is global and can be used in any subcommand.
*/
Global = 0x10,
/** Flag stops a parser.
*/
KickOut = 0x20,
/** Flag is excluded from auto completion.
*/
HiddenFromCompletion = 0x40,
/** Flag is excluded from options help and usage line
*/
Hidden = HiddenFromUsage | HiddenFromDescription | HiddenFromCompletion,
};
inline Options operator | (Options lhs, Options rhs)
{
return static_cast<Options>(static_cast<int>(lhs) | static_cast<int>(rhs));
}
inline Options operator & (Options lhs, Options rhs)
{
return static_cast<Options>(static_cast<int>(lhs) & static_cast<int>(rhs));
}
class FlagBase;
class PositionalBase;
class Command;
class ArgumentParser;
/** A simple structure of parameters for easy user-modifyable help menus
*/
struct HelpParams
{
/** The width of the help menu
*/
unsigned int width = 80;
/** The indent of the program line
*/
unsigned int progindent = 2;
/** The indent of the program trailing lines for long parameters
*/
unsigned int progtailindent = 4;
/** The indent of the description and epilogs
*/
unsigned int descriptionindent = 4;
/** The indent of the flags
*/
unsigned int flagindent = 6;
/** The indent of the flag descriptions
*/
unsigned int helpindent = 40;
/** The additional indent each group adds
*/
unsigned int eachgroupindent = 2;
/** The minimum gutter between each flag and its help
*/
unsigned int gutter = 1;
/** Show the terminator when both options and positional parameters are present
*/
bool showTerminator = true;
/** Show the {OPTIONS} on the prog line when this is true
*/
bool showProglineOptions = true;
/** Show the positionals on the prog line when this is true
*/
bool showProglinePositionals = true;
/** The prefix for short flags
*/
std::string shortPrefix;
/** The prefix for long flags
*/
std::string longPrefix;
/** The separator for short flags
*/
std::string shortSeparator;
/** The separator for long flags
*/
std::string longSeparator;
/** The program name for help generation
*/
std::string programName;
/** Show command's flags
*/
bool showCommandChildren = false;
/** Show command's descriptions and epilog
*/
bool showCommandFullHelp = false;
/** The postfix for progline when showProglineOptions is true and command has any flags
*/
std::string proglineOptions = "{OPTIONS}";
/** The prefix for progline when command has any subcommands
*/
std::string proglineCommand = "COMMAND";
/** The prefix for progline value
*/
std::string proglineValueOpen = " <";
/** The postfix for progline value
*/
std::string proglineValueClose = ">";
/** The prefix for progline required argument
*/
std::string proglineRequiredOpen = "";
/** The postfix for progline required argument
*/
std::string proglineRequiredClose = "";
/** The prefix for progline non-required argument
*/
std::string proglineNonrequiredOpen = "[";
/** The postfix for progline non-required argument
*/
std::string proglineNonrequiredClose = "]";
/** Show flags in program line
*/
bool proglineShowFlags = false;
/** Use short flags in program lines when possible
*/
bool proglinePreferShortFlags = false;
/** Program line prefix
*/
std::string usageString;
/** String shown in help before flags descriptions
*/
std::string optionsString = "OPTIONS:";
/** Display value name after all the long and short flags
*/
bool useValueNameOnce = false;
/** Show value name
*/
bool showValueName = true;
/** Add newline before flag description
*/
bool addNewlineBeforeDescription = false;
/** The prefix for option value
*/
std::string valueOpen = "[";
/** The postfix for option value
*/
std::string valueClose = "]";
/** Add choices to argument description
*/
bool addChoices = false;
/** The prefix for choices
*/
std::string choiceString = "\nOne of: ";
/** Add default values to argument description
*/
bool addDefault = false;
/** The prefix for default values
*/
std::string defaultString = "\nDefault: ";
};
/** A number of arguments which can be consumed by an option.
*
* Represents a closed interval [min, max].
*/
struct Nargs
{
const size_t min;
const size_t max;
Nargs(size_t min_, size_t max_) : min(min_), max(max_)
{
#ifndef ARGS_NOEXCEPT
if (max < min)
{
throw UsageError("Nargs: max > min");
}
#endif
}
Nargs(size_t num_) : min(num_), max(num_)
{
}
friend bool operator == (const Nargs &lhs, const Nargs &rhs)
{
return lhs.min == rhs.min && lhs.max == rhs.max;
}
friend bool operator != (const Nargs &lhs, const Nargs &rhs)
{
return !(lhs == rhs);
}
};
/** Base class for all match types
*/
class Base
{
private:
Options options = {};
protected:
bool matched = false;
const std::string help;
#ifdef ARGS_NOEXCEPT
/// Only for ARGS_NOEXCEPT
mutable Error error = Error::None;
mutable std::string errorMsg;
#endif
public:
Base(const std::string &help_, Options options_ = {}) : options(options_), help(help_) {}
virtual ~Base() {}
Options GetOptions() const noexcept
{
return options;
}
bool IsRequired() const noexcept
{
return (GetOptions() & Options::Required) != Options::None;
}
virtual bool Matched() const noexcept
{
return matched;
}
virtual void Validate(const std::string &, const std::string &) const
{
}
operator bool() const noexcept
{
return Matched();
}
virtual std::vector<std::tuple<std::string, std::string, unsigned>> GetDescription(const HelpParams &, const unsigned indentLevel) const
{
std::tuple<std::string, std::string, unsigned> description;
std::get<1>(description) = help;
std::get<2>(description) = indentLevel;
return { std::move(description) };
}
virtual std::vector<Command*> GetCommands()
{
return {};
}
virtual bool IsGroup() const
{
return false;
}
virtual FlagBase *Match(const EitherFlag &)
{
return nullptr;
}
virtual PositionalBase *GetNextPositional()
{
return nullptr;
}
virtual std::vector<FlagBase*> GetAllFlags()
{
return {};
}
virtual bool HasFlag() const
{
return false;
}
virtual bool HasPositional() const
{
return false;
}
virtual bool HasCommand() const
{
return false;
}
virtual std::vector<std::string> GetProgramLine(const HelpParams &) const
{
return {};
}
/// Sets a kick-out value for building subparsers
void KickOut(bool kickout_) noexcept
{
if (kickout_)
{
options = options | Options::KickOut;
}
else
{
options = static_cast<Options>(static_cast<int>(options) & ~static_cast<int>(Options::KickOut));
}
}
/// Gets the kick-out value for building subparsers
bool KickOut() const noexcept
{
return (options & Options::KickOut) != Options::None;
}
virtual void Reset() noexcept
{
matched = false;
#ifdef ARGS_NOEXCEPT
error = Error::None;
errorMsg.clear();
#endif
}
#ifdef ARGS_NOEXCEPT
/// Only for ARGS_NOEXCEPT
virtual Error GetError() const
{
return error;
}
/// Only for ARGS_NOEXCEPT
std::string GetErrorMsg() const
{
return errorMsg;
}
#endif
};
/** Base class for all match types that have a name
*/
class NamedBase : public Base
{
protected:
const std::string name;
bool kickout = false;
std::string defaultString;
bool defaultStringManual = false;
std::vector<std::string> choicesStrings;
bool choicesStringManual = false;
virtual std::string GetDefaultString(const HelpParams&) const { return {}; }
virtual std::vector<std::string> GetChoicesStrings(const HelpParams&) const { return {}; }
virtual std::string GetNameString(const HelpParams&) const { return Name(); }
void AddDescriptionPostfix(std::string &dest, const bool isManual, const std::string &manual, bool isGenerated, const std::string &generated, const std::string &str) const
{
if (isManual && !manual.empty())
{
dest += str;
dest += manual;
}
else if (!isManual && isGenerated && !generated.empty())
{
dest += str;
dest += generated;
}
}
public:
NamedBase(const std::string &name_, const std::string &help_, Options options_ = {}) : Base(help_, options_), name(name_) {}
virtual ~NamedBase() {}
/** Sets default value string that will be added to argument description.
* Use empty string to disable it for this argument.
*/
void HelpDefault(const std::string &str)
{
defaultStringManual = true;
defaultString = str;
}
/** Gets default value string that will be added to argument description.
*/
std::string HelpDefault(const HelpParams ¶ms) const
{
return defaultStringManual ? defaultString : GetDefaultString(params);
}
/** Sets choices strings that will be added to argument description.
* Use empty vector to disable it for this argument.
*/
void HelpChoices(const std::vector<std::string> &array)
{
choicesStringManual = true;
choicesStrings = array;
}
/** Gets choices strings that will be added to argument description.
*/
std::vector<std::string> HelpChoices(const HelpParams ¶ms) const
{
return choicesStringManual ? choicesStrings : GetChoicesStrings(params);
}
virtual std::vector<std::tuple<std::string, std::string, unsigned>> GetDescription(const HelpParams ¶ms, const unsigned indentLevel) const override
{
std::tuple<std::string, std::string, unsigned> description;
std::get<0>(description) = GetNameString(params);
std::get<1>(description) = help;
std::get<2>(description) = indentLevel;
AddDescriptionPostfix(std::get<1>(description), choicesStringManual, detail::Join(choicesStrings, ", "), params.addChoices, detail::Join(GetChoicesStrings(params), ", "), params.choiceString);
AddDescriptionPostfix(std::get<1>(description), defaultStringManual, defaultString, params.addDefault, GetDefaultString(params), params.defaultString);
return { std::move(description) };
}
virtual std::string Name() const
{
return name;
}