A simple C++ header-only library for easily parsing command line arguments. Querying the version can be done via three pre-processor definitions: GETARGS_VERSION_MAJOR, GETARGS_VERSION_MINOR, and GETARGS_VERSION_PATCH.
- Function Reference
- Pre-Processor Definition Reference
- GETARGS_IMPLEMENTATION
- GETARGS_NAMESPACE_NAME_OVERRIDE
- GETARGS_HANDLE_HELP_FLAG
- GETARGS_EXIT_ON_HELP
- GETARGS_LONG_HELP_FLAG
- GETARGS_SHORT_HELP_FLAG
- GETARGS_HELP_PRINTOUT
- GETARGS_HANDLE_VERSION_FLAG
- GETARGS_EXIT_ON_VERSION
- GETARGS_LONG_VERSION_FLAG
- GETARGS_SHORT_VERSION_FLAG
- GETARGS_VERSION_PRINTOUT
- GETARGS_HANDLE_INVALID_ARGS
- GETARGS_EXIT_ON_INVALID_ARG
- GETARGS_STRING_t
- GETARGS_MAP_t
- GETARGS_SET_t
- GETARGS_VECTOR_t
- GETARGS_SAMEAS_c
- GETARGS_CONVERTIBLE_TO_c
template<String_t... Args> void set_valid_args(Args...)
Parses command-line arguments from argv, initializes the parsed argument containers, and returns a status indicator (0 if successful). See GETARGS_HANDLE_HELP_FLAG, GETARGS_HANDLE_VERSION_FLAG, and GETARGS_HANDLE_INVALID_ARGS for more information on other return values.
const GETARGS_STRING_t get_bad_arg()
Requires [GETARGS_HANDLE_INVALID_ARGS] to be defined. If an invalid argument is parsed during getargs::get_args, getargs::get_bad_arg will return the invalid argument. Otherwise, an empty GETARGS_STRING_t will be returned instead.
bool get_flag(const GETARGS_STRING_t&)
Returns true if the flag was called in the command line, and false if not.
bool get_option(const GETARGS_STRING_t&, GETARGS_STRING_t&)
If the option was called in the command line, the output GETARGS_STRING_t argument will be set to the value assigned to the option and the function will return true. Otherwise, the argument is untouched and false is returned.
const GETARGS_STRING_t& get_option(const GETARGS_STRING_t&)
If the option was called in the command line, the value assigned to the option will be returned. Otherwise, an empty GETARGS_STRING_t is returned instead.
bool argument_exists(const GETARGS_STRING_t&)
Returns true if the argument was called in the command line. If an option was called but no value was given, this will still return true. Returns false otherwise.
bool option_has_value(const GETARGS_STRING_t&)
Returns true if the option was called in the command line and a value was assigned to it. Returns false otherwise.
Must be defined before including the library.
Overrides the library's namespace name, which is getargs by default.
Enables the handling of arguments matching GETARGS_LONG_HELP_FLAG and, if it's been defined, GETARGS_SHORT_HELP_FLAG. By default, handling is done by printing GETARGS_HELP_PRINTOUT, and returning getargs::HELP_CALLED from getargs::get_args which has had its return value changed from int to getargs::Status.
If GETARGS_HANDLE_HELP_FLAG is defined, handling is instead done by exiting the program via exit(0); after the printout.
If GETARGS_HANDLE_HELP_FLAG is defined, arguments are matched against GETARGS_LONG_HELP_FLAG during getargs::get_args to determine whether or not the help flag has appeared. By default, this is set to "--help".
If GETARGS_HANDLE_HELP_FLAG is defined, arguments are also matched against GETARGS_SHORT_HELP_FLAG during getargs::get_args to determine whether or not the help flag has appeared. By default, this is undefined and not used.
If GETARGS_HANDLE_HELP_FLAG is defined, GETARGS_HELP_PRINTOUT will be printed to the console when the help flag has been parsed.
Enables the handling of arguments matching GETARGS_LONG_VERSION_FLAG and, if it's been defined, GETARGS_SHORT_VERSION_FLAG. By default, handling is done by printing GETARGS_VERSION_PRINTOUT, and returning getargs::VERSION_CALLED from getargs::get_args, which has had its return value changed from int to getargs::Status.
If GETARGS_HANDLE_VERSION_FLAG is defined, handling is instead done by exiting the program via exit(0); after the printout.
If GETARGS_HANDLE_VERSION_FLAG is defined, arguments are matched against GETARGS_LONG_VERSION_FLAG during getargs::get_args to determine whether or not the version flag has appeared. By default, this is set to "--version".
If GETARGS_HANDLE_VERSION_FLAG is defined, arguments are also matched against GETARGS_SHORT_VERSION_FLAG during getargs::get_args to determine whether or not the version flag has appeared. By default, this is undefined and not used.
If GETARGS_HANDLE_VERSION_FLAG is defined, GETARGS_VERSION_PRINTOUT will be printed to the console when the help flag has been parsed.
Enables the handling of invalid arguments. Now, before arguments can be parsed, valid arguments must be passed to getargs::set_valid_args. By default, handling is done by printing an error message to stderr, and returning getargs::INVALID_ARGUMENT from getargs::get_args, which has had its return value changed from int to getargs::Status.
If GETARGS_HANDLE_INVALID_ARGS is defined, handling is instead done by exiting the program via exit(-1); after the printout.
Defines the class used to handle strings. By default, this is set to std::string
Defines the class used to handle maps. By default, this is set to std::map
Defines the class used to handle sets. By default, this is set to std::set
Defines the class used to handle vectors. By default, this is set to std::vector
Defines one of the constraints used by getargs::set_valid_args when GETARGS_HANDLE_INVALID_ARGS is defined. By default, this is set to std::same_as<T, U>
Defines one of the constraints used by getargs::set_valid_args when GETARGS_HANDLE_INVALID_ARGS is defined. By default, this is set to std::convertible_to<From, To>