* argpar is a library which provides facilities for command-line
* argument parsing.
*
- * Two APIs are available:
+ * Create a parsing iterator with argpar_iter_create(), then
+ * repeatedly call argpar_iter_next() to access the parsing results,
+ * until one of:
*
- * Iterator API:
- * Create a parsing iterator with argpar_iter_create(), then
- * repeatedly call argpar_iter_next() to access the parsing results,
- * until one of:
+ * * There are no more arguments.
*
- * * There are no more arguments.
+ * * The argument parser encounters an error (for example, an unknown
+ * option).
*
- * * The argument parser encounters an error (for example, an
- * unknown option).
+ * * You need to stop.
*
- * * You need to stop.
- *
- * This API provides more parsing control than the next one.
- *
- * Single call API:
- * Call argpar_parse(), which parses the arguments until one of:
- *
- * * There are no more arguments.
- *
- * * It encounters an argument parsing error.
- *
- * argpar_parse() returns a single array of parsing results.
- *
- * Both methods parse the arguments `argv` of which the count is `argc`
- * using the sentinel-terminated (use `ARGPAR_OPT_DESCR_SENTINEL`)
- * option descriptor array `descrs`.
+ * The argpar parser parses the original arguments `argv` of which the
+ * count is `argc` using the sentinel-terminated (use
+ * `ARGPAR_OPT_DESCR_SENTINEL`) option descriptor array `descrs`.
*
* argpar considers ALL the elements of `argv`, including the first one,
* so that you would typically pass `argc - 1` and `&argv[1]` from what
* main() receives.
*
- * The argpar parsers support:
+ * The argpar parser supports:
*
* * Short options without an argument, possibly tied together:
*
*
* * Non-option arguments (anything else).
*
- * The argpar parsers parse `-` and `--` as non-option arguments. A
+ * The argpar parser parses `-` 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
* escape `-` as of this version.
*
- * Both argpar_iter_create() and argpar_parse() accept duplicate options
- * (they produce one item for each instance).
+ * argpar_iter_create() accepts duplicate options in `descrs` (it
+ * produces one item for each instance).
*
* 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
- * arguments. This means, for example, that for:
+ * argpar_iter_next() produces the items in the same order that the
+ * original arguments were parsed, including non-option arguments. This
+ * means, for example, that for:
*
* --hello --count=23 /path/to/file -ab --type file magie
*
- * The produced items are, in this order:
+ * argpar_iter_next() produces the following items, in this order:
*
* 1. Option item (`--hello`).
* 2. Option item (`--count` with argument `23`).
# define ARGPAR_HIDDEN __attribute__((visibility("hidden")))
#endif
-/* Forward-declaration for the opaque type */
+/* Forward-declaration for the opaque argpar iterator type */
struct argpar_iter;
/* Option descriptor */
ARGPAR_ITEM_TYPE_NON_OPT,
};
-/* Parsing item, as created by argpar_parse() and argpar_iter_next() */
+/* Forward-declaration for the opaque argpar parsing item type */
struct argpar_item;
/*
ARGPAR_HIDDEN
void argpar_item_destroy(const struct argpar_item *item);
-struct argpar_item_array {
- const struct argpar_item **items;
-
- /* Number of used slots in `items` */
- unsigned int n_items;
-
- /* Number of allocated slots in `items` */
- unsigned int n_alloc;
-};
-
-/* What is returned by argpar_parse() */
-struct argpar_parse_ret {
- /*
- * Array of parsing items, or `NULL` on error.
- *
- * Do NOT destroy those items manually with
- * argpar_iter_destroy(): call argpar_parse_ret_fini() to
- * finalize the whole structure.
- */
- struct argpar_item_array *items;
-
- /* Error string, or `NULL` if none */
- char *error;
-
- /* Number of original arguments (`argv`) ingested */
- unsigned int ingested_orig_args;
-};
-
-/*
- * Parses arguments in `argv` until the end is reached or an error is
- * encountered.
- *
- * On success, this function returns an array of items (field `items` of
- * `struct argpar_parse_ret`).
- *
- * In the returned structure, `ingested_orig_args` is the number of
- * ingested arguments within `argv` to produce the resulting array of
- * items.
- *
- * If `fail_on_unknown_opt` is true, then on success
- * `ingested_orig_args` is equal to `argc`. Otherwise,
- * `ingested_orig_args` contains the number of original arguments until
- * an unknown _option_ occurs. For example, with
- *
- * --great --white contact nuance --shark nuclear
- *
- * if `--shark` is not described within `descrs` and
- * `fail_on_unknown_opt` is false, then `ingested_orig_args` is 4 (two
- * options, two non-options), whereas `argc` is 6.
- *
- * This makes it possible to know where a command name is, for example.
- * With those arguments:
- *
- * --verbose --stuff=23 do-something --specific-opt -f -b
- *
- * and the descriptors for `--verbose` and `--stuff` only, the function
- * returns the `--verbose` and `--stuff` option items, the
- * `do-something` non-option item, and that three original arguments
- * were ingested. This means you can start the next argument parsing
- * stage, with option descriptors depending on the command name, at
- * `&argv[3]`.
- *
- * Note that `ingested_orig_args` is not always equal to the number of
- * returned items, as
- *
- * --hello -fdw
- *
- * for example contains two ingested original arguments, but four
- * resulting items.
- *
- * On failure, the `items` member of the returned structure is `NULL`,
- * and the `error` string member contains details about the error.
- *
- * Finalize the returned structure with argpar_parse_ret_fini().
- */
-ARGPAR_HIDDEN
-struct argpar_parse_ret argpar_parse(unsigned int argc,
- const char * const *argv,
- const struct argpar_opt_descr *descrs,
- bool fail_on_unknown_opt);
-
-/*
- * Finalizes what argpar_parse() returns.
- *
- * You may call argpar_parse() multiple times with the same structure.
- */
-ARGPAR_HIDDEN
-void argpar_parse_ret_fini(struct argpar_parse_ret *ret);
-
/*
* Creates an argument parsing iterator.
*
projects / argpar.git / blobdiff