X-Git-Url: http://git.efficios.com/?p=argpar.git;a=blobdiff_plain;f=argpar%2Fargpar.h;h=be715131d5628c3018393a7d436b92ae2744e4e7;hp=6ebc845e69cec679df268c464dfc8b19a161e166;hb=dd757a651292048da829dd6fa085c1f107569bcc;hpb=fb12ac67619ddd7101bb2db3fd02b9119ee4a203 diff --git a/argpar/argpar.h b/argpar/argpar.h index 6ebc845..be71513 100644 --- a/argpar/argpar.h +++ b/argpar/argpar.h @@ -5,8 +5,8 @@ * Copyright (c) 2020-2021 Simon Marchi */ -#ifndef BABELTRACE_ARGPAR_H -#define BABELTRACE_ARGPAR_H +#ifndef ARGPAR_ARGPAR_H +#define ARGPAR_ARGPAR_H #include @@ -18,8 +18,8 @@ * * Iterator API: * Create a parsing iterator with argpar_iter_create(), then - * repeatedly call argpar_iter_parse_next() to access the parsing - * results, until one of: + * repeatedly call argpar_iter_next() to access the parsing results, + * until one of: * * * There are no more arguments. * @@ -67,10 +67,7 @@ * * * Non-option arguments (anything else). * - * The argpar parsers don't accept `-` or `--` as arguments. The latter - * means "end of options" for many command-line tools, but this library - * is all about keeping the order of the arguments, so it doesn't mean - * much to put them at the end. This has the side effect that a + * The argpar parsers parse `-` and `--` as non-option arguments. A * non-option argument cannot have the form of an option, for example if * you need to pass the exact relative path `--component`. In that case, * you would need to pass `./--component`. There's no generic way to @@ -79,10 +76,10 @@ * Both argpar_iter_create() and argpar_parse() accept duplicate options * (they produce one item for each instance). * - * A returned parsing item has the type `struct argpar_item *`. Each - * item is to be casted to the appropriate type - * (`struct argpar_item_opt *` or `struct argpar_item_non_opt *`) - * depending on its `type` member. + * A returned parsing item has the type `const struct argpar_item *`. + * Get the type (option or non-option) of an item with + * argpar_item_type(). Each item type has its set of dedicated methods + * (`argpar_item_opt_` and `argpar_item_non_opt_` prefixes). * * Both argpar_iter_create() and argpar_parse() produce the items in * the same order that the arguments were parsed, including non-option @@ -128,7 +125,7 @@ struct argpar_opt_descr { /* Short option character, or `\0` */ const char short_name; - /* Long option name (without `--`), or `NULL` */ + /* Long option name (without the `--` prefix), or `NULL` */ const char * const long_name; /* True if this option has an argument */ @@ -144,38 +141,55 @@ enum argpar_item_type { ARGPAR_ITEM_TYPE_NON_OPT, }; -/* Base item */ -struct argpar_item { - enum argpar_item_type type; -}; +/* Parsing item, as created by argpar_parse() and argpar_iter_next() */ +struct argpar_item; -/* Option item */ -struct argpar_item_opt { - struct argpar_item base; +/* + * Returns the type of the parsing item `item`. + */ +ARGPAR_HIDDEN +enum argpar_item_type argpar_item_type(const struct argpar_item *item); - /* Corresponding descriptor */ - const struct argpar_opt_descr *descr; +/* + * Returns the option descriptor of the option parsing item `item`. + */ +ARGPAR_HIDDEN +const struct argpar_opt_descr *argpar_item_opt_descr( + const struct argpar_item *item); - /* Argument, or `NULL` if none */ - const char *arg; -}; +/* + * Returns the argument of the option parsing item `item`, or `NULL` if + * none. + */ +ARGPAR_HIDDEN +const char *argpar_item_opt_arg(const struct argpar_item *item); -/* Non-option item */ -struct argpar_item_non_opt { - struct argpar_item base; +/* + * Returns the complete argument, pointing to one of the entries of the + * original arguments (`argv`), of the non-option parsing item `item`. + */ +ARGPAR_HIDDEN +const char *argpar_item_non_opt_arg(const struct argpar_item *item); - /* - * Complete argument, pointing to one of the entries of the - * original arguments (`argv`). - */ - const char *arg; +/* + * Returns the original index, within ALL the original arguments + * (`argv`), of the non-option parsing item `item`. + */ +ARGPAR_HIDDEN +unsigned int argpar_item_non_opt_orig_index(const struct argpar_item *item); - /* Index of this argument amongst all original arguments (`argv`) */ - unsigned int orig_index; +/* + * Returns the index, within the non-option arguments, of the non-option + * parsing item `item`. + */ +ARGPAR_HIDDEN +unsigned int argpar_item_non_opt_non_opt_index(const struct argpar_item *item); - /* Index of this argument amongst other non-option arguments */ - unsigned int non_opt_index; -}; +/* + * Destroys `item`, as created by argpar_iter_next(). + */ +ARGPAR_HIDDEN +void argpar_item_destroy(const struct argpar_item *item); struct argpar_item_array { const struct argpar_item **items; @@ -273,10 +287,12 @@ void argpar_parse_ret_fini(struct argpar_parse_ret *ret); * actually start parsing the arguments. * * `*argv` and `*descrs` must NOT change for the lifetime of the - * returned iterator (until you call argpar_iter_destroy()). + * returned iterator (until you call argpar_iter_destroy()) and for the + * lifetime of any parsing item (until you call argpar_item_destroy()) + * argpar_iter_next() creates for the returned iterator. * - * Call argpar_iter_parse_next() with the returned iterator to obtain - * the next parsing result (item). + * Call argpar_iter_next() with the returned iterator to obtain the next + * parsing result (item). */ ARGPAR_HIDDEN struct argpar_iter *argpar_iter_create(unsigned int argc, @@ -290,34 +306,58 @@ ARGPAR_HIDDEN void argpar_iter_destroy(struct argpar_iter *iter); /* - * Return type of argpar_iter_parse_next(). + * Return type of argpar_iter_next(). */ -enum argpar_iter_parse_next_status { - ARGPAR_ITER_PARSE_NEXT_STATUS_OK, - ARGPAR_ITER_PARSE_NEXT_STATUS_END, - ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT, - ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR, +enum argpar_iter_next_status { + ARGPAR_ITER_NEXT_STATUS_OK, + ARGPAR_ITER_NEXT_STATUS_END, + ARGPAR_ITER_NEXT_STATUS_ERROR_UNKNOWN_OPT, + ARGPAR_ITER_NEXT_STATUS_ERROR_MISSING_OPT_ARG, + ARGPAR_ITER_NEXT_STATUS_ERROR_INVALID_ARG, + ARGPAR_ITER_NEXT_STATUS_ERROR_UNEXPECTED_OPT_ARG, + ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY, }; /* * Parses and returns the next item from `iter`. * - * On success, this function sets `*item` to an item which describes the - * next option or non-option argument and returns - * `ARGPAR_ITER_PARSE_NEXT_STATUS_OK`. Destroy `*item` with - * argpar_item_destroy(). + * On success, this function: + * + * * Sets `*item` to a parsing item which describes the next option + * or non-option argument. + * + * Destroy `*item` with argpar_item_destroy(). + * + * * Returns `ARGPAR_ITER_NEXT_STATUS_OK`. * * If there are no more items to return, this function returns - * `ARGPAR_ITER_PARSE_NEXT_STATUS_END`. + * `ARGPAR_ITER_NEXT_STATUS_END`. + * + * On failure, this function: * - * On failure (status codes - * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT` and - * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR`), this function sets `*error` - * to a descriptive error string. Free `*error` with free(). + * * Returns one of: * - * Create an argument parsing iterator with argpar_iter_create(). + * `ARGPAR_ITER_NEXT_STATUS_ERROR_UNKNOWN_OPT`: + * Unknown option (not found in `descrs` as passed to + * argpar_iter_create() to create `iter`). + * + * `ARGPAR_ITER_NEXT_STATUS_ERROR_MISSING_OPT_ARG`: + * Missing option argument. + * + * `ARGPAR_ITER_NEXT_STATUS_ERROR_INVALID_ARG`: + * Invalid argument. + * + * `ARGPAR_ITER_NEXT_STATUS_ERROR_UNEXPECTED_OPT_ARG`: + * Unexpected option argument. + * + * `ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY`: + * Memory error. + * + * * Except for the `ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY` status, + * sets `*error`, if not `NULL`, to a descriptive error string. + * Free `*error` with free(). */ -enum argpar_iter_parse_next_status argpar_iter_parse_next( +enum argpar_iter_next_status argpar_iter_next( struct argpar_iter *iter, const struct argpar_item **item, char **error); @@ -327,13 +367,7 @@ enum argpar_iter_parse_next_status argpar_iter_parse_next( * the previously returned items. */ ARGPAR_HIDDEN -unsigned int argpar_iter_get_ingested_orig_args(const struct argpar_iter *iter); - -/* - * Destroys `item`, as created by argpar_iter_parse_next(). - */ -ARGPAR_HIDDEN -void argpar_item_destroy(const struct argpar_item *item); +unsigned int argpar_iter_ingested_orig_args(const struct argpar_iter *iter); /* * Destroys `_item` (`const struct argpar_item *`) and sets it to @@ -345,4 +379,4 @@ void argpar_item_destroy(const struct argpar_item *item); _item = NULL; \ } -#endif /* BABELTRACE_ARGPAR_H */ +#endif /* ARGPAR_ARGPAR_H */