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; \ 85 return static_cast<ParseArgumentBehavior>(
static_cast<unsigned char>(lhs) | static_cast<unsigned char>(rhs));
90 return static_cast<bool>(
static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
116 return static_cast<ValueCompletionBehavior>(
static_cast<unsigned char>(lhs) | static_cast<unsigned char>(rhs));
121 return static_cast<bool>(
static_cast<unsigned char>(lhs) & static_cast<unsigned char>(rhs));
172 path.push_back(parent);
184 Argument(
const char *name,
char abbreviation =
'\0',
const char *description =
nullptr,
const char *example =
nullptr);
187 const char *name()
const;
188 void setName(
const char *name);
189 char abbreviation()
const;
190 void setAbbreviation(
char abbreviation);
191 const char *environmentVariable()
const;
192 void setEnvironmentVariable(
const char *environmentVariable);
193 const char *description()
const;
194 void setDescription(
const char *description);
195 const char *example()
const;
196 void setExample(
const char *example);
197 const std::vector<const char *> &values(std::size_t occurrence = 0)
const;
198 const char *firstValue()
const;
199 std::size_t requiredValueCount()
const;
200 void setRequiredValueCount(std::size_t requiredValueCount);
201 const std::vector<const char *> &valueNames()
const;
202 void setValueNames(std::initializer_list<const char *> valueNames);
203 void appendValueName(
const char *valueName);
204 bool allRequiredValuesPresent(std::size_t occurrence = 0)
const;
205 bool isPresent()
const;
206 std::size_t occurrences()
const;
207 std::size_t index(std::size_t occurrence)
const;
208 std::size_t minOccurrences()
const;
209 std::size_t maxOccurrences()
const;
210 void setConstraints(std::size_t minOccurrences, std::size_t maxOccurrences);
211 const std::vector<Argument *> &path(std::size_t occurrence = 0)
const;
212 bool isRequired()
const;
213 void setRequired(
bool required);
214 bool isCombinable()
const;
215 void setCombinable(
bool value);
216 bool isImplicit()
const;
217 void setImplicit(
bool value);
218 bool denotesOperation()
const;
219 void setDenotesOperation(
bool denotesOperation);
222 void printInfo(std::ostream &os,
unsigned char indentation = 0)
const;
226 bool hasSubArguments()
const;
228 bool isMainArgument()
const;
229 bool isParentPresent()
const;
232 const char *preDefinedCompletionValues()
const;
233 void setPreDefinedCompletionValues(
const char *preDefinedCompletionValues);
234 Argument *conflictsWithArgument()
const;
235 Argument *wouldConflictWithArgument()
const;
236 Argument *specifiedOperation()
const;
238 void resetRecursively();
239 const std::vector<ArgumentOccurrence> &occurrenceInfo()
const;
240 std::vector<ArgumentOccurrence> &occurrenceInfo();
246 static constexpr std::size_t varValueCount = std::numeric_limits<std::size_t>::max();
249 bool matchesDenotation(
const char *denotation,
size_t denotationLength)
const;
253 const char *m_environmentVar;
254 const char *m_description;
255 const char *m_example;
256 std::size_t m_minOccurrences;
257 std::size_t m_maxOccurrences;
259 bool m_denotesOperation;
260 std::size_t m_requiredValueCount;
261 std::vector<const char *> m_valueNames;
263 std::vector<ArgumentOccurrence> m_occurrences;
269 const char *m_preDefinedCompletionValues;
281 void addMainArgument(
Argument *argument);
282 void printHelp(std::ostream &os)
const;
283 void parseArgs(
int argc,
const char *
const *argv);
284 void parseArgsOrExit(
int argc,
const char *
const *argv);
285 void parseArgsExt(
int argc,
const char *
const *argv,
288 void readArgs(
int argc,
const char *
const *argv);
290 unsigned int actualArgumentCount()
const;
291 const char *executable()
const;
295 void setDefaultArgument(
Argument *argument);
296 Argument *specifiedOperation()
const;
297 void checkConstraints();
298 void invokeCallbacks();
299 bool isUncombinableMainArgPresent()
const;
303 void printBashCompletion(
int argc,
const char *
const *argv,
unsigned int cursorPos,
const ArgumentReader &reader);
308 unsigned int m_actualArgc;
309 const char *m_executable;
335 assert(*
name !=
'-');
336 for (
const char *c =
name; *c; ++c) {
337 assert(*c !=
' ' && *c !=
'=' && *c !=
'\'' && *c !=
'\"' && *c !=
'\n' && *c !=
'\r');
351 return m_abbreviation;
374 return m_environmentVar;
393 return m_description;
434 return m_occurrences[occurrence].values;
452 return m_requiredValueCount;
511 m_valueNames.emplace_back(valueName);
520 || (m_occurrences[occurrence].values.size() >=
static_cast<std::size_t
>(m_requiredValueCount));
538 m_implicit = implicit;
546 return !m_occurrences.empty();
554 return m_occurrences.size();
562 return m_occurrences[occurrence].index;
572 return m_minOccurrences;
582 return m_maxOccurrences;
599 inline const std::vector<Argument *> &
Argument::path(std::size_t occurrence)
const 601 return m_occurrences[occurrence].path;
615 return m_minOccurrences;
628 if (!m_minOccurrences) {
629 m_minOccurrences = 1;
632 m_minOccurrences = 0;
659 m_combinable = value;
674 return m_denotesOperation;
692 return m_callbackFunction;
725 return !m_subArgs.empty();
762 return m_valueCompletionBehavior;
773 m_valueCompletionBehavior = completionValues;
781 return m_preDefinedCompletionValues;
797 m_occurrences.clear();
806 return m_occurrences;
817 return m_occurrences;
852 return m_unknownArgBehavior;
862 m_unknownArgBehavior = behavior;
880 m_defaultArg = argument;
909 OperationArgument(
const char *name,
char abbreviation =
'\0',
const char *description =
nullptr,
const char *example =
nullptr);
913 :
Argument(name, abbreviation, description, example)
920 ConfigValueArgument(
const char *name,
char abbreviation =
'\0',
const char *description =
nullptr,
921 std::initializer_list<const char *> valueNames = std::initializer_list<const char *>());
928 const char *name,
char abbreviation,
const char *description, std::initializer_list<const char *> valueNames)
929 :
Argument(name, abbreviation, description)
950 #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.
const std::vector< ArgumentOccurrence > & occurrenceInfo() const
Returns information about all occurrences of the argument which have been detected when parsing...
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 NoColorArgument class allows to specify whether use of escape codes or similar technique to provi...
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.
ParseArgumentBehavior
The ParseArgumentBehavior enum specifies the behavior when parsing arguments.
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.
static constexpr std::size_t varValueCount
Denotes a variable number of values.
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.
const CallbackFunction & callback() const
Returns the assigned callback function.
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()).
The ArgumentReader class internally encapsulates the process of reading command line arguments...
#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.