C++ Utilities 5.17.0
Useful C++ classes and routines such as argument parser, IO and conversion utilities
argumentparser.h
Go to the documentation of this file.
1#ifndef APPLICATION_UTILITIES_ARGUMENTPARSER_H
2#define APPLICATION_UTILITIES_ARGUMENTPARSER_H
3
4#include "../conversion/stringconversion.h"
5#include "../misc/traits.h"
6
7#include <functional>
8#include <initializer_list>
9#include <limits>
10#include <vector>
11#ifdef CPP_UTILITIES_DEBUG_BUILD
12#include <cassert>
13#endif
14
15class ArgumentParserTests; // not a public class (only used for internal tests)
16
17namespace CppUtilities {
18
23 const char *name = nullptr;
24 const char *author = nullptr;
25 const char *version = nullptr;
26 const char *url = nullptr;
27 const char *domain = nullptr;
28 const char *description = nullptr;
29 const char *license = nullptr;
30 const char *credits = nullptr;
31 std::vector<const char *> dependencyVersions;
32};
33
38
45#define SET_DEPENDENCY_INFO ::CppUtilities::applicationInfo.dependencyVersions = DEPENCENCY_VERSIONS
46
52#define SET_APPLICATION_INFO \
53 ::CppUtilities::applicationInfo.name = APP_NAME; \
54 ::CppUtilities::applicationInfo.author = APP_AUTHOR; \
55 ::CppUtilities::applicationInfo.version = APP_VERSION; \
56 ::CppUtilities::applicationInfo.url = APP_URL; \
57 ::CppUtilities::applicationInfo.domain = APP_DOMAIN; \
58 ::CppUtilities::applicationInfo.description = APP_DESCRIPTION; \
59 ::CppUtilities::applicationInfo.license = PROJECT_LICENSE; \
60 ::CppUtilities::applicationInfo.credits = APP_CREDITS; \
61 SET_DEPENDENCY_INFO
62
63class Argument;
64class ArgumentParser;
65class ArgumentReader;
66
67using ArgumentInitializerList = std::initializer_list<Argument *>;
68using ArgumentVector = std::vector<Argument *>;
69using ArgumentPredicate = std::function<bool(Argument *)>;
70
76 Ignore,
77 Warn,
78 Fail
79};
80
88 ReadArguments = 0x0,
89 CheckConstraints = 0x1,
90 InvokeCallbacks = 0x2,
92 = 0x4,
93};
94
97{
98 return static_cast<ParseArgumentBehavior>(static_cast<unsigned char>(lhs) | static_cast<unsigned char>(rhs));
99}
100
102{
103 return static_cast<bool>(static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
104}
106
116enum class ValueCompletionBehavior : unsigned char {
117 None = 0,
118 PreDefinedValues = 2,
119 Files = 4,
120 Directories = 8,
122 AppendEquationSign = 32,
123 InvokeCallback = 64,
124};
125
128{
129 return static_cast<ValueCompletionBehavior>(static_cast<unsigned char>(lhs) | static_cast<unsigned char>(rhs));
130}
131
133{
134 return static_cast<bool>(static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
135}
137
145namespace ValueConversion {
146template <typename TargetType, Traits::EnableIf<std::is_same<TargetType, std::string>> * = nullptr> TargetType convert(const char *value)
147{
148 return std::string(value);
149}
150
151template <typename TargetType, Traits::EnableIf<std::is_arithmetic<TargetType>> * = nullptr> TargetType convert(const char *value)
152{
153 return stringToNumber<TargetType>(value);
154}
155
157namespace Helper {
158struct CPP_UTILITIES_EXPORT ArgumentValueConversionError {
159 const std::string errorMessage;
160 const char *const valueToConvert;
161 const char *const targetTypeName;
162
163 [[noreturn]] void throwFailure(const std::vector<Argument *> &argumentPath) const;
164};
165
166template <std::size_t N, typename FirstTargetType, typename... RemainingTargetTypes> struct ArgumentValueConverter {
167 static std::tuple<FirstTargetType, RemainingTargetTypes...> convertValues(std::vector<const char *>::const_iterator firstValue)
168 {
169 return std::tuple_cat(ArgumentValueConverter<1, FirstTargetType>::convertValues(firstValue),
170 ArgumentValueConverter<N - 1, RemainingTargetTypes...>::convertValues(firstValue + 1));
171 }
172};
173
174template <typename FirstTargetType, typename... RemainingTargetTypes> struct ArgumentValueConverter<1, FirstTargetType, RemainingTargetTypes...> {
175 static std::tuple<FirstTargetType> convertValues(std::vector<const char *>::const_iterator firstValue)
176 {
177 // FIXME: maybe use std::expected here when available
178 try {
179 return std::make_tuple<FirstTargetType>(ValueConversion::convert<FirstTargetType>(*firstValue));
180 } catch (const ConversionException &exception) {
181 throw ArgumentValueConversionError{ exception.what(), *firstValue, typeid(FirstTargetType).name() };
182 }
183 }
184};
185} // namespace Helper
187
188} // namespace ValueConversion
189
194 ArgumentOccurrence(std::size_t index);
195 ArgumentOccurrence(std::size_t index, const std::vector<Argument *> parentPath, Argument *parent);
196
200 std::size_t index;
201
205 std::vector<const char *> values;
206
211 std::vector<Argument *> path;
212
213 template <typename... RemainingTargetTypes> std::tuple<RemainingTargetTypes...> convertValues() const;
214
215private:
216 [[noreturn]] void throwNumberOfValuesNotSufficient(unsigned long valuesToConvert) const;
217};
218
224template <typename... RemainingTargetTypes> std::tuple<RemainingTargetTypes...> ArgumentOccurrence::convertValues() const
225{
226 constexpr auto valuesToConvert = sizeof...(RemainingTargetTypes);
227 if (values.size() < valuesToConvert) {
228 throwNumberOfValuesNotSufficient(valuesToConvert);
229 }
230 try {
231 return ValueConversion::Helper::ArgumentValueConverter<valuesToConvert, RemainingTargetTypes...>::convertValues(values.cbegin());
232 } catch (const ValueConversion::Helper::ArgumentValueConversionError &error) {
233 error.throwFailure(path);
234 }
235}
236
241 : index(index)
242{
243}
244
253inline ArgumentOccurrence::ArgumentOccurrence(std::size_t index, const std::vector<Argument *> parentPath, Argument *parent)
254 : index(index)
255 , path(parentPath)
256{
257 if (parent) {
258 path.push_back(parent);
259 }
260}
261
263 friend ArgumentParser;
264 friend ArgumentReader;
265 friend ArgumentParserTests;
266
267public:
268 typedef std::function<void(const ArgumentOccurrence &)> CallbackFunction;
269
271 enum class Flags : std::uint64_t {
272 None = 0x0,
273 Combinable
274 = 0x1,
275 Implicit = 0x2,
276 Operation = 0x4,
277 Deprecated = 0x8,
278 Greedy
279 = 0x10,
280 };
281
282 Argument(const char *name, char abbreviation = '\0', const char *description = nullptr, const char *example = nullptr);
283 ~Argument();
284
285 // declare getter/setter/properties/operations for argument definition:
286 // - those properties must be set *before* parsing
287 // - they control the behaviour of the parser, eg.
288 // - the name/abbreviation to look for
289 // - constraints to be checked
290 // - callbacks to be invoked
291 // TODO v5: It would make sense to move these to a separate class (eg. ArgumentDefinition) to prevent this one from
292 // becoming to big.
293 const char *name() const;
294 void setName(const char *name);
295 char abbreviation() const;
296 void setAbbreviation(char abbreviation);
297 const char *environmentVariable() const;
298 void setEnvironmentVariable(const char *environmentVariable);
299 const char *description() const;
300 void setDescription(const char *description);
301 const char *example() const;
302 void setExample(const char *example);
303 std::size_t requiredValueCount() const;
304 void setRequiredValueCount(std::size_t requiredValueCount);
305 const std::vector<const char *> &valueNames() const;
306 void setValueNames(std::initializer_list<const char *> valueNames);
307 void appendValueName(const char *valueName);
308 void setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences);
309 const std::vector<Argument *> &path(std::size_t occurrence = 0) const;
310 bool isRequired() const;
311 void setRequired(bool required);
312 Argument::Flags flags() const;
313 void setFlags(Argument::Flags flags);
314 void setFlags(Argument::Flags flags, bool add);
315 bool isCombinable() const;
316 void setCombinable(bool combinable);
317 bool isImplicit() const;
318 void setImplicit(bool implicit);
319 bool denotesOperation() const;
320 void setDenotesOperation(bool denotesOperation);
321 const CallbackFunction &callback() const;
322 void setCallback(CallbackFunction callback);
323 const ArgumentVector &subArguments() const;
324 void setSubArguments(const ArgumentInitializerList &subArguments);
325 void addSubArgument(Argument *arg);
326 bool hasSubArguments() const;
327 const ArgumentVector &parents() const;
328 void printInfo(std::ostream &os, unsigned char indentation = 0) const;
329
330 // declare getter/setter/properties for bash completion: those properties must be set *before parsing
331 ValueCompletionBehavior valueCompletionBehaviour() const;
332 void setValueCompletionBehavior(ValueCompletionBehavior valueCompletionBehaviour);
333 const char *preDefinedCompletionValues() const;
334 void setPreDefinedCompletionValues(const char *preDefinedCompletionValues);
335
336 // declare getter/read-only properties for parsing results: those properties will be populated when parsing
337 const std::vector<const char *> &values(std::size_t occurrence = 0) const;
338 template <typename... TargetType> std::tuple<TargetType...> valuesAs(std::size_t occurrence = 0) const;
339 template <typename... TargetType> std::vector<std::tuple<TargetType...>> allValuesAs() const;
340
341 const char *firstValue() const;
342 const char *firstValueOr(const char *fallback) const;
343 bool allRequiredValuesPresent(std::size_t occurrence = 0) const;
344 bool isPresent() const;
345 std::size_t occurrences() const;
346 std::size_t index(std::size_t occurrence) const;
347 std::size_t minOccurrences() const;
348 std::size_t maxOccurrences() const;
349 bool isDeprecated() const;
350 const Argument *deprecatedBy() const;
351 void markAsDeprecated(const Argument *deprecatedBy = nullptr);
352 bool isMainArgument() const;
353 bool isParentPresent() const;
354 Argument *conflictsWithArgument() const;
355 Argument *wouldConflictWithArgument() const;
356 Argument *specifiedOperation() const;
357 const std::vector<ArgumentOccurrence> &occurrenceInfo() const;
358 std::vector<ArgumentOccurrence> &occurrenceInfo();
359 void reset();
360 void resetRecursively();
361
366 static constexpr std::size_t varValueCount = std::numeric_limits<std::size_t>::max();
367
368private:
369 // declare internal getter/setter/properties/operations for argument definition
370 bool matchesDenotation(const char *denotation, std::size_t denotationLength) const;
371
372 const char *m_name;
373 char m_abbreviation;
374 const char *m_environmentVar;
375 const char *m_description;
376 const char *m_example;
377 std::size_t m_minOccurrences;
378 std::size_t m_maxOccurrences;
379 std::size_t m_requiredValueCount;
380 std::vector<const char *> m_valueNames;
381 Flags m_flags;
382 std::vector<ArgumentOccurrence> m_occurrences;
383 ArgumentVector m_subArgs;
384 CallbackFunction m_callbackFunction;
385 ArgumentVector m_parents;
386 const Argument *m_deprecatedBy;
387 bool m_isMainArg;
388 ValueCompletionBehavior m_valueCompletionBehavior;
389 const char *m_preDefinedCompletionValues;
390};
391
394{
395 return static_cast<Argument::Flags>(static_cast<unsigned char>(lhs) | static_cast<unsigned char>(rhs));
396}
397
398constexpr bool operator&(Argument::Flags lhs, Argument::Flags rhs)
399{
400 return static_cast<bool>(static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
401}
403
409template <typename... TargetType> std::tuple<TargetType...> Argument::valuesAs(std::size_t occurrence) const
410{
411 return m_occurrences[occurrence].convertValues<TargetType...>();
412}
413
419template <typename... TargetType> std::vector<std::tuple<TargetType...>> Argument::allValuesAs() const
420{
421 std::vector<std::tuple<TargetType...>> res;
422 res.reserve(m_occurrences.size());
423 for (const auto &occurrence : m_occurrences) {
424 res.emplace_back(occurrence.convertValues<TargetType...>());
425 }
426 return res;
427}
428
430public:
432};
433
435public:
436 OperationArgument(const char *name, char abbreviation = '\0', const char *description = nullptr, const char *example = nullptr);
437};
438
440public:
441 ConfigValueArgument(const char *name, char abbreviation = '\0', const char *description = nullptr,
442 std::initializer_list<const char *> valueNames = std::initializer_list<const char *>());
443};
444
446 friend ArgumentParserTests;
447
448public:
450 void apply() const;
451};
452
454
456 friend ArgumentParserTests;
457 friend ArgumentReader;
458
459public:
461
462 // declare getter/setter for argument definitions
463 const ArgumentVector &mainArguments() const;
464 void setMainArguments(const ArgumentInitializerList &mainArguments);
465 void addMainArgument(Argument *argument);
466
467 // declare operations which will consider previously assigned argument definitions and maybe modify parsing results
468 void printHelp(std::ostream &os) const;
469 void parseArgs(int argc, const char *const *argv,
470 ParseArgumentBehavior behavior
472 void readArgs(int argc, const char *const *argv);
473 void resetArgs();
474 void checkConstraints();
475 void invokeCallbacks();
476
477 // declare getter for parsing results
478 unsigned int actualArgumentCount() const;
479 const char *executable() const;
480 UnknownArgumentBehavior unknownArgumentBehavior() const;
481 void setUnknownArgumentBehavior(UnknownArgumentBehavior behavior);
482 Argument *defaultArgument() const;
483 void setDefaultArgument(Argument *argument);
484 Argument *specifiedOperation() const;
485 bool isUncombinableMainArgPresent() const;
486 void setExitFunction(std::function<void(int)> exitFunction);
487 const HelpArgument &helpArg() const;
488 HelpArgument &helpArg();
489 const NoColorArgument &noColorArg() const;
490 NoColorArgument &noColorArg();
491
492private:
493 // declare internal operations
494 CPP_UTILITIES_IF_DEBUG_BUILD(void verifyArgs(const ArgumentVector &args);)
495 ArgumentCompletionInfo determineCompletionInfo(
496 int argc, const char *const *argv, unsigned int currentWordIndex, const ArgumentReader &reader) const;
497 std::string findSuggestions(int argc, const char *const *argv, unsigned int cursorPos, const ArgumentReader &reader) const;
498 void printBashCompletion(int argc, const char *const *argv, unsigned int cursorPos, const ArgumentReader &reader) const;
499 void checkConstraints(const ArgumentVector &args);
500 static void invokeCallbacks(const ArgumentVector &args);
501 void invokeExit(int code);
502
503 ArgumentVector m_mainArgs;
504 unsigned int m_actualArgc;
505 const char *m_executable;
506 UnknownArgumentBehavior m_unknownArgBehavior;
507 Argument *m_defaultArg;
508 HelpArgument m_helpArg;
509 NoColorArgument m_noColorArg;
510 std::function<void(int)> m_exitFunction;
511};
512
518inline const char *Argument::name() const
519{
520 return m_name;
521}
522
530inline void Argument::setName(const char *name)
531{
532#ifdef CPP_UTILITIES_DEBUG_BUILD
533 if (name && *name) {
534 assert(*name != '-');
535 for (const char *c = name; *c; ++c) {
536 assert(*c != ' ' && *c != '=' && *c != '\'' && *c != '\"' && *c != '\n' && *c != '\r');
537 }
538 }
539#endif
540 m_name = name;
541}
542
548inline char Argument::abbreviation() const
549{
550 return m_abbreviation;
551}
552
560inline void Argument::setAbbreviation(char abbreviation)
561{
562 CPP_UTILITIES_IF_DEBUG_BUILD(assert(abbreviation != ' ' && abbreviation != '=' && abbreviation != '-' && abbreviation != '\''
563 && abbreviation != '"' && abbreviation != '\n' && abbreviation != '\r'));
564 m_abbreviation = abbreviation;
565}
566
571inline const char *Argument::environmentVariable() const
572{
573 return m_environmentVar;
574}
575
580inline void Argument::setEnvironmentVariable(const char *environmentVariable)
581{
582 m_environmentVar = environmentVariable;
583}
584
590inline const char *Argument::description() const
591{
592 return m_description;
593}
594
600inline void Argument::setDescription(const char *description)
601{
602 m_description = description;
603}
604
610inline const char *Argument::example() const
611{
612 return m_example;
613}
614
620inline void Argument::setExample(const char *example)
621{
622 m_example = example;
623}
624
631inline const std::vector<const char *> &Argument::values(std::size_t occurrence) const
632{
633 return m_occurrences[occurrence].values;
634}
635
649inline std::size_t Argument::requiredValueCount() const
650{
651 return m_requiredValueCount;
652}
653
666inline void Argument::setRequiredValueCount(std::size_t requiredValueCount)
667{
668 m_requiredValueCount = requiredValueCount;
669}
670
679inline const std::vector<const char *> &Argument::valueNames() const
680{
681 return m_valueNames;
682}
683
697inline void Argument::setValueNames(std::initializer_list<const char *> valueNames)
698{
699 m_valueNames.assign(valueNames);
700}
701
708inline void Argument::appendValueName(const char *valueName)
709{
710 m_valueNames.emplace_back(valueName);
711}
712
716inline bool Argument::allRequiredValuesPresent(std::size_t occurrence) const
717{
718 return m_requiredValueCount == Argument::varValueCount
719 || (m_occurrences[occurrence].values.size() >= static_cast<std::size_t>(m_requiredValueCount));
720}
721
726inline bool Argument::isImplicit() const
727{
728 return m_flags & Flags::Implicit;
729}
730
735inline void Argument::setImplicit(bool implicit)
736{
737 setFlags(Flags::Implicit, implicit);
738}
739
743inline bool Argument::isPresent() const
744{
745 return !m_occurrences.empty();
746}
747
751inline std::size_t Argument::occurrences() const
752{
753 return m_occurrences.size();
754}
755
759inline std::size_t Argument::index(std::size_t occurrence) const
760{
761 return m_occurrences[occurrence].index;
762}
763
769inline std::size_t Argument::minOccurrences() const
770{
771 return m_minOccurrences;
772}
773
779inline std::size_t Argument::maxOccurrences() const
780{
781 return m_maxOccurrences;
782}
783
784inline bool Argument::isDeprecated() const
785{
786 return m_flags & Flags::Deprecated;
787}
788
792inline const Argument *Argument::deprecatedBy() const
793{
794 return m_deprecatedBy;
795}
796
802inline void Argument::markAsDeprecated(const Argument *deprecatedBy)
803{
805 m_deprecatedBy = deprecatedBy;
806}
807
813inline void Argument::setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences)
814{
815 m_minOccurrences = minOccurrences;
816 m_maxOccurrences = maxOccurrences;
817}
818
822inline const std::vector<Argument *> &Argument::path(std::size_t occurrence) const
823{
824 return m_occurrences[occurrence].path;
825}
826
836inline bool Argument::isRequired() const
837{
838 return m_minOccurrences;
839}
840
848inline void Argument::setRequired(bool required)
849{
850 if (required) {
851 if (!m_minOccurrences) {
852 m_minOccurrences = 1;
853 }
854 } else {
855 m_minOccurrences = 0;
856 }
857}
858
863{
864 return m_flags;
865}
866
871{
872 m_flags = flags;
873}
874
878inline void Argument::setFlags(Argument::Flags flags, bool add)
879{
880 m_flags = add ? (m_flags | flags)
881 : static_cast<Argument::Flags>(static_cast<std::underlying_type<Argument::Flags>::type>(m_flags)
882 & ~static_cast<std::underlying_type<Argument::Flags>::type>(flags));
883}
884
893inline bool Argument::isCombinable() const
894{
895 return m_flags & Flags::Combinable;
896}
897
906inline void Argument::setCombinable(bool combinable)
907{
908 setFlags(Flags::Combinable, combinable);
909}
910
921inline bool Argument::denotesOperation() const
922{
923 return m_flags & Flags::Operation;
924}
925
930inline void Argument::setDenotesOperation(bool denotesOperation)
931{
933}
934
940{
941 return m_callbackFunction;
942}
943
951{
952 m_callbackFunction = callback;
953}
954
962{
963 return m_subArgs;
964}
965
972inline bool Argument::hasSubArguments() const
973{
974 return !m_subArgs.empty();
975}
976
988{
989 return m_parents;
990}
991
998inline bool Argument::isMainArgument() const
999{
1000 return m_isMainArg;
1001}
1002
1010{
1011 return m_valueCompletionBehavior;
1012}
1013
1021{
1022 m_valueCompletionBehavior = completionValues;
1023}
1024
1029{
1030 return m_preDefinedCompletionValues;
1031}
1032
1036inline void Argument::setPreDefinedCompletionValues(const char *preDefinedCompletionValues)
1037{
1038 m_preDefinedCompletionValues = preDefinedCompletionValues;
1039}
1040
1046inline void Argument::reset()
1047{
1048 m_occurrences.clear();
1049}
1050
1051inline OperationArgument::OperationArgument(const char *name, char abbreviation, const char *description, const char *example)
1052 : Argument(name, abbreviation, description, example)
1053{
1054 setDenotesOperation(true);
1055}
1056
1061 const char *name, char abbreviation, const char *description, std::initializer_list<const char *> valueNames)
1062 : Argument(name, abbreviation, description)
1063{
1064 setCombinable(true);
1067}
1068
1073inline const std::vector<ArgumentOccurrence> &Argument::occurrenceInfo() const
1074{
1075 return m_occurrences;
1076}
1077
1084inline std::vector<ArgumentOccurrence> &Argument::occurrenceInfo()
1085{
1086 return m_occurrences;
1087}
1088
1094{
1095 return m_mainArgs;
1096}
1097
1101inline unsigned int ArgumentParser::actualArgumentCount() const
1102{
1103 return m_actualArgc;
1104}
1105
1109inline const char *ArgumentParser::executable() const
1110{
1111 return m_executable;
1112}
1113
1120{
1121 return m_unknownArgBehavior;
1122}
1123
1130{
1131 m_unknownArgBehavior = behavior;
1132}
1133
1139{
1140 return m_defaultArg;
1141}
1142
1148{
1149 m_defaultArg = argument;
1150}
1151
1158{
1159 checkConstraints(m_mainArgs);
1160}
1161
1167{
1168 invokeCallbacks(m_mainArgs);
1169}
1170
1175inline void ArgumentParser::setExitFunction(std::function<void(int)> exitFunction)
1176{
1177 m_exitFunction = exitFunction;
1178}
1179
1184{
1185 return m_helpArg;
1186}
1187
1192{
1193 return m_helpArg;
1194}
1195
1200{
1201 return m_noColorArg;
1202}
1203
1208{
1209 return m_noColorArg;
1210}
1211
1212} // namespace CppUtilities
1213
1214#endif // APPLICATION_UTILITIES_ARGUMENTPARSER_H
#define CPP_UTILITIES_IF_DEBUG_BUILD(x)
Wraps debug-only lines conveniently.
Definition: global.h:102
The ArgumentParserTests class tests the ArgumentParser and Argument classes.
The ArgumentParser class provides a means for handling command line arguments.
void setDefaultArgument(Argument *argument)
Sets the default argument.
const HelpArgument & helpArg() const
Returns the --help argument.
void checkConstraints()
Checks whether constraints are violated.
const char * executable() const
Returns the name of the current executable.
const ArgumentVector & mainArguments() const
Returns the main arguments.
unsigned int actualArgumentCount() const
Returns the actual number of arguments that could be found when parsing.
void setUnknownArgumentBehavior(UnknownArgumentBehavior behavior)
Sets how unknown arguments are treated.
Argument * defaultArgument() const
Returns the default argument.
void setExitFunction(std::function< void(int)> exitFunction)
Specifies a function quit the application.
void invokeCallbacks()
Invokes all assigned callbacks.
UnknownArgumentBehavior unknownArgumentBehavior() const
Returns how unknown arguments are treated.
const NoColorArgument & noColorArg() const
Returns the --no-color argument.
The ArgumentReader class internally encapsulates the process of reading command line arguments.
The Argument class is a wrapper for command line argument information.
const char * description() const
Returns the description of the argument.
static constexpr std::size_t varValueCount
Denotes a variable number of values.
const std::vector< Argument * > & path(std::size_t occurrence=0) const
Returns the path of the specified occurrence.
bool isMainArgument() const
Returns an indication whether the argument is used as main argument.
const ArgumentVector & subArguments() const
Returns the secondary arguments for this argument.
const char * example() const
Returns the usage example of the argument.
Flags
The Flags enum specifies options for treating the argument in a special way.
const std::vector< const char * > & valueNames() const
Returns the names of the required values.
void setValueCompletionBehavior(ValueCompletionBehavior valueCompletionBehaviour)
Sets the items to be considered when generating completion for the values.
const CallbackFunction & callback() const
Returns the assigned callback function.
const std::vector< ArgumentOccurrence > & occurrenceInfo() const
Returns information about all occurrences of the argument which have been detected when parsing.
ValueCompletionBehavior valueCompletionBehaviour() const
Returns the items to be considered when generating completion for the values.
void setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences)
Sets the allowed number of occurrences.
void setImplicit(bool implicit)
Sets whether the argument is an implicit argument.
void setValueNames(std::initializer_list< const char * > valueNames)
Sets the names of the required values.
char abbreviation() const
Returns the abbreviation of the argument.
std::size_t occurrences() const
Returns how often the argument could be detected when parsing.
void setDenotesOperation(bool denotesOperation)
Sets whether the argument denotes the operation.
void markAsDeprecated(const Argument *deprecatedBy=nullptr)
Marks the argument as deprecated.
const char * name() const
Returns the name of the argument.
void setAbbreviation(char abbreviation)
Sets the abbreviation of the argument.
bool isCombinable() const
Returns an indication whether the argument is combinable.
bool denotesOperation() const
Returns whether the argument denotes an operation.
void setDescription(const char *description)
Sets the description of the argument.
void appendValueName(const char *valueName)
Appends a value name.
std::size_t maxOccurrences() const
Returns the maximum number of occurrences.
Argument::Flags flags() const
Returns Argument::Flags for the argument.
const std::vector< const char * > & values(std::size_t occurrence=0) const
Returns the parameter values for the specified occurrence of argument.
const char * preDefinedCompletionValues() const
Returns the assigned values used when generating completion for the values.
std::size_t requiredValueCount() const
Returns the number of values which are required to be given for this argument.
const char * environmentVariable() const
Returns the environment variable queried when firstValue() is called.
std::vector< std::tuple< TargetType... > > allValuesAs() const
Converts the present values for all occurrence to the specified target types.
bool isImplicit() const
Returns an indication whether the argument is an implicit argument.
void reset()
Resets occurrences (indices, values and paths).
const Argument * deprecatedBy() const
Returns the argument which obsoletes this argument.
std::function< void(const ArgumentOccurrence &)> CallbackFunction
std::size_t index(std::size_t occurrence) const
Returns the indices of the argument's occurrences which could be detected when parsing.
bool isPresent() const
Returns an indication whether the argument could be detected when parsing.
void setExample(const char *example)
Sets the a usage example for the argument.
const ArgumentVector & parents() const
Returns the parents of this argument.
void setFlags(Argument::Flags flags)
Replaces all Argument::Flags for the argument with the flags.
std::size_t minOccurrences() const
Returns the minimum number of occurrences.
bool allRequiredValuesPresent(std::size_t occurrence=0) const
Returns an indication whether all required values are present.
void setCombinable(bool combinable)
Sets whether this argument can be combined.
void setCallback(CallbackFunction callback)
Sets a callback function which will be called by the parser if the argument could be found and no par...
bool isRequired() const
Returns an indication whether the argument is mandatory.
void setRequired(bool required)
Sets whether this argument is mandatory or not.
void setPreDefinedCompletionValues(const char *preDefinedCompletionValues)
Assigns the values to be used when generating completion for the values.
void setEnvironmentVariable(const char *environmentVariable)
Sets the environment variable queried when firstValue() is called.
bool hasSubArguments() const
Returns an indication whether the argument has secondary arguments.
std::tuple< TargetType... > valuesAs(std::size_t occurrence=0) const
Converts the present values for the specified occurrence to the specified target types.
void setRequiredValueCount(std::size_t requiredValueCount)
Sets the number of values which are required to be given for this argument.
void setName(const char *name)
Sets the name of the argument.
The ConfigValueArgument class is an Argument where setCombinable() is true by default.
ConfigValueArgument(const char *name, char abbreviation='\0', const char *description=nullptr, std::initializer_list< const char * > valueNames=std::initializer_list< const char * >())
Constructs a new ConfigValueArgument with the specified parameter.
The HelpArgument class prints help information for an argument parser when present (–help,...
The NoColorArgument class allows to specify whether use of escape codes or similar technique to provi...
The OperationArgument class is an Argument where denotesOperation() is true by default.
OperationArgument(const char *name, char abbreviation='\0', const char *description=nullptr, const char *example=nullptr)
#define CPP_UTILITIES_EXPORT
Marks the symbol to be exported by the c++utilities library.
constexpr bool operator&(FlagEnumClass lhs, FlagEnumClass rhs)
Definition: flagenumclass.h:50
constexpr FlagEnumClass operator|(FlagEnumClass lhs, FlagEnumClass rhs)
Definition: flagenumclass.h:43
TargetType convert(const char *value)
Contains all utilities provides by the c++utilities library.
std::vector< Argument * > ArgumentVector
UnknownArgumentBehavior
The UnknownArgumentBehavior enum specifies the behavior of the argument parser when an unknown argume...
ParseArgumentBehavior
The ParseArgumentBehavior enum specifies the behavior when parsing arguments.
std::function< bool(Argument *)> ArgumentPredicate
std::initializer_list< Argument * > ArgumentInitializerList
constexpr T max(T first, T second)
Returns the greatest of the given items.
Definition: math.h:100
ValueCompletionBehavior
The ValueCompletionBehavior enum specifies the items to be considered when generating completion for ...
CPP_UTILITIES_EXPORT ApplicationInfo applicationInfo
Stores global application info used by ArgumentParser::printHelp() and AboutDialog.
Stores information about an application.
std::vector< const char * > dependencyVersions
The ArgumentCompletionInfo struct holds information internally used for shell completion and suggesti...
The ArgumentOccurrence struct holds argument values for an occurrence of an argument.
std::size_t index
The index of the occurrence.
std::vector< const char * > values
The parameter values which have been specified after the occurrence of the argument.
std::tuple< RemainingTargetTypes... > convertValues() const
Converts the present values to the specified target types.
ArgumentOccurrence(std::size_t index)
Constructs an argument occurrence for the specified index.
std::vector< Argument * > path
The "path" of the occurrence (the parent elements which have been specified before).