1 #ifndef APPLICATION_UTILITIES_ARGUMENTPARSER_H 2 #define APPLICATION_UTILITIES_ARGUMENTPARSER_H 7 #include <initializer_list> 30 #ifndef APP_STATICALLY_LINKED 31 #define SET_DEPENDENCY_INFO ::ApplicationUtilities::dependencyVersions = DEPENCENCY_VERSIONS 33 #define SET_DEPENDENCY_INFO ::ApplicationUtilities::dependencyVersions = STATIC_DEPENCENCY_VERSIONS 41 #define SET_APPLICATION_INFO \ 42 ::ApplicationUtilities::applicationName = APP_NAME; \ 43 ::ApplicationUtilities::applicationAuthor = APP_AUTHOR; \ 44 ::ApplicationUtilities::applicationVersion = APP_VERSION; \ 45 ::ApplicationUtilities::applicationUrl = APP_URL; \ 88 return static_cast<bool>(
static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
99 ArgumentOccurrence(std::size_t index,
const std::vector<Argument *> parentPath,
Argument *parent);
139 path.push_back(parent);
151 Argument(
const char *name,
char abbreviation =
'\0',
const char *description =
nullptr,
const char *example =
nullptr);
154 const char *name()
const;
155 void setName(
const char *name);
156 char abbreviation()
const;
157 void setAbbreviation(
char abbreviation);
158 const char *environmentVariable()
const;
159 void setEnvironmentVariable(
const char *environmentVariable);
160 const char *description()
const;
161 void setDescription(
const char *description);
162 const char *example()
const;
163 void setExample(
const char *example);
164 const std::vector<const char *> &
values(std::size_t occurrence = 0)
const;
165 const char *firstValue()
const;
166 std::size_t requiredValueCount()
const;
167 void setRequiredValueCount(std::size_t requiredValueCount);
168 const std::vector<const char *> &valueNames()
const;
169 void setValueNames(std::initializer_list<const char *> valueNames);
170 void appendValueName(
const char *valueName);
171 bool allRequiredValuesPresent(std::size_t occurrence = 0)
const;
172 bool isPresent()
const;
173 std::size_t occurrences()
const;
174 std::size_t
index(std::size_t occurrence)
const;
175 std::size_t minOccurrences()
const;
176 std::size_t maxOccurrences()
const;
177 void setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences);
178 const std::vector<Argument *> &
path(std::size_t occurrence = 0)
const;
179 bool isRequired()
const;
180 void setRequired(
bool required);
181 bool isCombinable()
const;
182 void setCombinable(
bool value);
183 bool isImplicit()
const;
184 void setImplicit(
bool value);
185 bool denotesOperation()
const;
186 void setDenotesOperation(
bool denotesOperation);
187 void setCallback(CallbackFunction callback);
188 void printInfo(std::ostream &os,
unsigned char indentation = 0)
const;
189 const ArgumentVector &subArguments()
const;
190 void setSubArguments(
const ArgumentInitializerList &subArguments);
192 bool hasSubArguments()
const;
193 const ArgumentVector parents()
const;
194 bool isMainArgument()
const;
195 bool isParentPresent()
const;
198 const char *preDefinedCompletionValues()
const;
199 void setPreDefinedCompletionValues(
const char *preDefinedCompletionValues);
200 Argument *conflictsWithArgument()
const;
201 Argument *wouldConflictWithArgument()
const;
203 void resetRecursively();
209 static constexpr std::size_t varValueCount = std::numeric_limits<std::size_t>::max();
214 const char *m_environmentVar;
215 const char *m_description;
216 const char *m_example;
217 std::size_t m_minOccurrences;
218 std::size_t m_maxOccurrences;
220 bool m_denotesOperation;
221 std::size_t m_requiredValueCount;
222 std::vector<const char *> m_valueNames;
224 std::vector<ArgumentOccurrence> m_occurrences;
225 ArgumentVector m_subArgs;
226 CallbackFunction m_callbackFunction;
227 ArgumentVector m_parents;
230 const char *m_preDefinedCompletionValues;
240 const ArgumentVector &mainArguments()
const;
241 void setMainArguments(
const ArgumentInitializerList &mainArguments);
242 void addMainArgument(
Argument *argument);
243 void printHelp(std::ostream &os)
const;
244 void parseArgs(
int argc,
const char *
const *argv);
245 void readArgs(
int argc,
const char *
const *argv);
247 unsigned int actualArgumentCount()
const;
248 const char *executable()
const;
252 void setDefaultArgument(
Argument *argument);
253 void checkConstraints();
254 void invokeCallbacks();
255 bool isUncombinableMainArgPresent()
const;
258 IF_DEBUG_BUILD(
void verifyArgs(
const ArgumentVector &args, std::vector<char> abbreviations, std::vector<const char *> names);)
259 void printBashCompletion(
int argc,
const char *
const *argv,
unsigned int cursorPos,
const ArgumentReader &reader);
260 void checkConstraints(
const ArgumentVector &args);
261 void invokeCallbacks(
const ArgumentVector &args);
263 ArgumentVector m_mainArgs;
264 unsigned int m_actualArgc;
265 const char *m_executable;
291 assert(*name !=
'-');
292 for (
const char *c = name; *c; ++c) {
293 assert(*c !=
' ' && *c !=
'=' && *c !=
'\'' && *c !=
'\"' && *c !=
'\n' && *c !=
'\r');
307 return m_abbreviation;
319 IF_DEBUG_BUILD(assert(abbreviation !=
' ' && abbreviation !=
'=' && abbreviation !=
'-' && abbreviation !=
'\'' && abbreviation !=
'"' 320 && abbreviation !=
'\n' && abbreviation !=
'\r'));
321 m_abbreviation = abbreviation;
330 return m_environmentVar;
339 m_environmentVar = environmentVariable;
349 return m_description;
359 m_description = description;
390 return m_occurrences[occurrence].values;
408 return m_requiredValueCount;
425 m_requiredValueCount = requiredValueCount;
456 m_valueNames.assign(valueNames);
467 m_valueNames.emplace_back(valueName);
475 return m_requiredValueCount ==
static_cast<std::size_t
>(-1)
476 || (m_occurrences[occurrence].
values.size() >=
static_cast<std::size_t
>(m_requiredValueCount));
494 m_implicit = implicit;
502 return !m_occurrences.empty();
510 return m_occurrences.size();
518 return m_occurrences[occurrence].index;
528 return m_minOccurrences;
538 return m_maxOccurrences;
548 m_minOccurrences = minOccurrences;
549 m_maxOccurrences = maxOccurrences;
555 inline const std::vector<Argument *> &
Argument::path(std::size_t occurrence)
const 557 return m_occurrences[occurrence].path;
571 return m_minOccurrences;
584 if (!m_minOccurrences) {
585 m_minOccurrences = 1;
588 m_minOccurrences = 0;
615 m_combinable = value;
630 return m_denotesOperation;
639 m_denotesOperation = denotesOperation;
649 m_callbackFunction = callback;
671 return !m_subArgs.empty();
705 return m_valueCompletionBehavior;
713 m_valueCompletionBehavior = completionValues;
721 return m_preDefinedCompletionValues;
729 m_preDefinedCompletionValues = preDefinedCompletionValues;
737 m_occurrences.clear();
772 return m_unknownArgBehavior;
782 m_unknownArgBehavior = behavior;
800 m_defaultArg = argument;
810 checkConstraints(m_mainArgs);
819 invokeCallbacks(m_mainArgs);
829 OperationArgument(
const char *name,
char abbreviation =
'\0',
const char *description =
nullptr,
const char *example =
nullptr);
833 :
Argument(name, abbreviation, description, example)
841 std::initializer_list<const char *>
valueNames = std::initializer_list<const char *>());
849 :
Argument(name, abbreviation, description)
857 #endif // APPLICATION_UTILITIES_ARGUMENTPARSER_H bool isMainArgument() const
Returns an indication whether the argument is used as main argument.
std::function< bool(Argument *)> ArgumentPredicate
CPP_UTILITIES_EXPORT const char * applicationUrl
Specifies the URL to the application website (used by ArgumentParser::printHelp()).
ValueCompletionBehavior
The ValueCompletionBehavior enum specifies the items to be considered when generating completion for ...
const char * preDefinedCompletionValues() const
Returns the assigned values used when generating completion for the values.
bool denotesOperation() const
Returns whether the argument denotes the operation.
UnknownArgumentBehavior unknownArgumentBehavior() const
Returns how unknown arguments are treated.
The ConfigValueArgument class is an Argument where setCombinable() is true by default.
std::initializer_list< Argument * > ArgumentInitializerList
#define IF_DEBUG_BUILD(x)
Wraps debug-only lines conveniently.
Argument * defaultArgument() const
Returns the default argument.
std::size_t requiredValueCount() const
Returns the number of values which are required to be given for this argument.
void setImplicit(bool value)
Sets whether the argument is an implicit argument.
const char * description() const
Returns the description of the argument.
std::size_t index
The index of the occurrence.
void setCombinable(bool value)
Sets whether this argument can be combined.
ValueCompletionBehavior valueCompletionBehaviour() const
Returns the items to be considered when generating completion for the values.
void setUnknownArgumentBehavior(UnknownArgumentBehavior behavior)
Sets how unknown arguments are treated.
const ArgumentVector parents() const
Returns the parents of this argument.
Contains currently only ArgumentParser and related classes.
std::size_t maxOccurrences() const
Returns the maximum number of occurrences.
constexpr DirectoryEntryType operator|(DirectoryEntryType lhs, DirectoryEntryType rhs)
bool isRequired() const
Returns an indication whether the argument is mandatory.
Argument CPP_UTILITIES_EXPORT * firstPresentUncombinableArg(const ArgumentVector &args, const Argument *except)
This function return the first present and uncombinable argument of the given list of arguments...
void setRequired(bool required)
Sets whether this argument is mandatory or not.
std::size_t index(std::size_t occurrence) const
Returns the indices of the argument's occurences which could be detected when parsing.
std::function< void(const ArgumentOccurrence &)> CallbackFunction
void setDefaultArgument(Argument *argument)
Sets the default argument.
CPP_UTILITIES_EXPORT const char * applicationVersion
Specifies the version of the application (used by ArgumentParser::printHelp()).
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.
void invokeCallbacks()
Invokes all assigned callbacks.
The ArgumentParserTests class tests the ArgumentParser and Argument classes.
void checkConstraints()
Checks whether contraints are violated.
const char * name() const
Returns the name of the argument.
const std::vector< const char * > & valueNames() const
Returns the names of the requried values.
The OperationArgument class is an Argument where denotesOperation() is true by default.
void setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences)
Sets the allowed number of occurrences.
const ArgumentVector & subArguments() const
Returns the secondary arguments for this argument.
std::size_t minOccurrences() const
Returns the minimum number of occurrences.
void setAbbreviation(char abbreviation)
Sets the abbreviation of the argument.
void setDescription(const char *description)
Sets the description of the argument.
void setValueCompletionBehavior(ValueCompletionBehavior valueCompletionBehaviour)
Sets the items to be considered when generating completion for the values.
void appendValueName(const char *valueName)
Appends a value name.
CPP_UTILITIES_EXPORT std::initializer_list< const char * > dependencyVersions
Specifies the dependency versions the application was linked against (used by ArgumentParser::printHe...
const std::vector< const char * > & values(std::size_t occurrence=0) const
Returns the parameter values for the specified occurrence of argument.
CPP_UTILITIES_EXPORT void(* exitFunction)(int)
Specifies a function quit the application.
const char * executable() const
Returns the name of the current executable.
std::size_t occurrences() const
Returns how often the argument could be detected when parsing.
The Argument class is a wrapper for command line argument information.
void setCallback(CallbackFunction callback)
Sets a callback function which will be called by the parser if the argument could be found and no par...
void setExample(const char *example)
Sets the a usage example for the argument.
const std::vector< Argument * > & path(std::size_t occurrence=0) const
Returns the path of the specified occurrence.
bool isCombinable() const
Returns an indication whether the argument is combinable.
void setPreDefinedCompletionValues(const char *preDefinedCompletionValues)
Assignes the values to be used when generating completion for the values.
std::vector< Argument * > path
The "path" of the occurrence (the parent elements which have been specified before).
UnknownArgumentBehavior
The UnknownArgumentBehavior enum specifies the behavior of the argument parser when an unknown argume...
OperationArgument(const char *name, char abbreviation='\0', const char *description=nullptr, const char *example=nullptr)
void setEnvironmentVariable(const char *environmentVariable)
Sets the environment variable queried when firstValue() is called.
The ArgumentOccurrence struct holds argument values for an occurrence of an argument.
CPP_UTILITIES_EXPORT const char * applicationName
Specifies the name of the application (used by ArgumentParser::printHelp()).
bool isPresent() const
Returns an indication whether the argument could be detected when parsing.
bool hasSubArguments() const
Returns an indication whether the argument has secondary arguments.
The HelpArgument class prints help information for an argument parser when present (–help...
bool allRequiredValuesPresent(std::size_t occurrence=0) const
Returns an indication whether all required values are present.
const ArgumentVector & mainArguments() const
Returns the main arguments.
void setDenotesOperation(bool denotesOperation)
Sets whether the argument denotes the operation.
char abbreviation() const
Returns the abbreviation of the argument.
const char * example() const
Returns the usage example of the argument.
void reset()
Resets occurrences (indices, values and paths).
ArgumentOccurrence(std::size_t index)
Constructs an argument occurrence for the specified index.
void setRequiredValueCount(std::size_t requiredValueCount)
Sets the number of values which are required to be given for this argument.
CPP_UTILITIES_EXPORT const char * applicationAuthor
Specifies the author of the application (used by ArgumentParser::printHelp()).
#define CPP_UTILITIES_EXPORT
Marks the symbol to be exported by the c++utilities library.
const char * environmentVariable() const
Returns the environment variable queried when firstValue() is called.
unsigned int actualArgumentCount() const
Returns the actual number of arguments that could be found when parsing.
void setName(const char *name)
Sets the name of the argument.
bool isImplicit() const
Returns an indication whether the argument is an implicit argument.
The ArgumentParser class provides a means for handling command line arguments.
void setValueNames(std::initializer_list< const char *> valueNames)
Sets the names of the requried values.
std::vector< Argument * > ArgumentVector
constexpr DirectoryEntryType operator &(DirectoryEntryType lhs, DirectoryEntryType rhs)
std::vector< const char * > values
The parameter values which have been specified after the occurrence of the argument.