/*
* SPDX-License-Identifier: MIT
- *
- * Copyright (c) 2019-2021 Philippe Proulx <pproulx@efficios.com>
- * Copyright (c) 2020-2021 Simon Marchi <simon.marchi@efficios.com>
+ * SPDX-FileCopyrightText: 2019-2024 Philippe Proulx <pproulx@efficios.com>
+ * SPDX-FileCopyrightText: 2020-2024 Simon Marchi <simon.marchi@efficios.com>
*/
#ifndef ARGPAR_ARGPAR_H
#include <stdbool.h>
-/*
- * argpar is a library which provides facilities for command-line
- * argument parsing.
- *
- * Two APIs are available:
- *
- * 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:
- *
- * * There are no more arguments.
- *
- * * The argument parser encounters an error (for example, an
- * unknown option).
- *
- * * 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`.
- *
- * 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:
- *
- * * Short options without an argument, possibly tied together:
- *
- * -f -auf -n
- *
- * * Short options with argument:
- *
- * -b 45 -f/mein/file -xyzhello
- *
- * * Long options without an argument:
- *
- * --five-guys --burger-king --pizza-hut --subway
- *
- * * Long options with arguments:
- *
- * --security enable --time=18.56
- *
- * * 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
- * 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).
- *
- * 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:
- *
- * --hello --count=23 /path/to/file -ab --type file magie
- *
- * The produced items are, in this order:
- *
- * 1. Option item (`--hello`).
- * 2. Option item (`--count` with argument `23`).
- * 3. Non-option item (`/path/to/file`).
- * 4. Option item (`-a`).
- * 5. Option item (`-b`).
- * 6. Option item (`--type` with argument `file`).
- * 7. Non-option item (`magie`).
- */
+#if defined(__cplusplus)
+extern "C" {
+#endif
-/* Sentinel for an option descriptor array */
-#define ARGPAR_OPT_DESCR_SENTINEL { -1, '\0', NULL, false }
+/*!
+@mainpage
-/*
- * If argpar is used in some shared library, we don't want said library
- * to export its symbols, so mark them as "hidden".
- *
- * On Windows, symbols are local unless explicitly exported; see
- * <https://gcc.gnu.org/wiki/Visibility>.
- */
-#if defined(_WIN32) || defined(__CYGWIN__)
-# define ARGPAR_HIDDEN
-#else
-# define ARGPAR_HIDDEN __attribute__((visibility("hidden")))
-#endif
+See the \ref api module.
-/* Forward-declaration for the opaque type */
-struct argpar_iter;
+@addtogroup api argpar API
+@{
-/* Option descriptor */
-struct argpar_opt_descr {
- /* Numeric ID for this option */
- const int id;
+argpar is a library which provides an iterator-based API to parse
+command-line arguments.
- /* Short option character, or `\0` */
- const char short_name;
+The argpar parser supports:
- /* Long option name (without `--`), or `NULL` */
- const char * const long_name;
+<ul>
+ <li>
+ Short options without an argument, possibly tied together:
- /* True if this option has an argument */
- const bool with_arg;
-};
+ @code{.unparsed}
+ -f -auf -n
+ @endcode
-/* Item type */
-enum argpar_item_type {
- /* Option */
- ARGPAR_ITEM_TYPE_OPT,
+ <li>
+ Short options with arguments:
- /* Non-option */
- ARGPAR_ITEM_TYPE_NON_OPT,
-};
+ @code{.unparsed}
+ -b 45 -f/mein/file -xyzhello
+ @endcode
-/* Parsing item, as created by argpar_parse() and argpar_iter_parse_next() */
-struct argpar_item;
+ <li>
+ Long options without an argument:
-/*
- * Returns the type of the parsing item `item`.
- */
-ARGPAR_HIDDEN
-enum argpar_item_type argpar_item_type(const struct argpar_item *item);
+ @code{.unparsed}
+ --five-guys --burger-king --pizza-hut --subway
+ @endcode
-/*
- * 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);
+ <li>
+ Long options with arguments (two original arguments or a single
+ one with a <code>=</code> character):
-/*
- * 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);
+ @code{.unparsed}
+ --security enable --time=18.56
+ @endcode
-/*
- * 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);
+ <li>
+ Non-option arguments (anything else, including
+ <code>-</code> and <code>\--</code>).
-/*
- * 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);
+ A non-option argument cannot have the form of an option, for example
+ if you need to pass the exact relative path
+ <code>\--component</code>. In that case, you would need to pass
+ <code>./\--component</code>. There's no generic way to escape
+ <code>-</code> as of this version.
+</ul>
-/*
- * 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);
+Create a parsing iterator with argpar_iter_create(), then repeatedly
+call argpar_iter_next() to access the parsing results (items), until one
+of:
-struct argpar_item_array {
- const struct argpar_item **items;
+- There are no more arguments.
- /* Number of used slots in `items` */
- unsigned int n_items;
+- The argument parser encounters an error (for example, an unknown
+ option).
- /* Number of allocated slots in `items` */
- unsigned int n_alloc;
-};
+- You need to stop.
-/* 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;
-};
+argpar_iter_create() accepts duplicate option descriptors in
+\p descrs (argpar_iter_next() produces one item for each
+instance).
-/*
- * 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);
+A parsing item (the result of argpar_iter_next()) has the type
+#argpar_item.
-/*
- * 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);
+Get the type (option or non-option) of an item with
+\link argpar_item_type(const argpar_item_t *) argpar_item_type()\endlink.
+Each item type has its set of dedicated functions
+(\c argpar_item_opt_ and \c argpar_item_non_opt_ prefixes).
-/*
- * Creates an argument parsing iterator.
- *
- * This function initializes the returned structure, but doesn't
- * actually start parsing the arguments.
- *
- * `*argv` and `*descrs` must NOT change for the lifetime of the
- * returned iterator (until you call argpar_iter_destroy()).
- *
- * Call argpar_iter_parse_next() with the returned iterator to obtain
- * the next parsing result (item).
- */
-ARGPAR_HIDDEN
-struct argpar_iter *argpar_iter_create(unsigned int argc,
- const char * const *argv,
- const struct argpar_opt_descr *descrs);
+argpar_iter_next() produces the items in the same order that it parses
+original arguments, including non-option arguments. This means, for
+example, that for:
-/*
- * Destroys `iter`, as returned by argpar_iter_create().
- */
-ARGPAR_HIDDEN
-void argpar_iter_destroy(struct argpar_iter *iter);
+@code{.unparsed}
+--hello --count=23 /path/to/file -ab --type file -- magie
+@endcode
-/*
- * Return type of argpar_iter_parse_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,
-};
+argpar_iter_next() produces the following items, in this order:
-/*
- * 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().
- *
- * If there are no more items to return, this function returns
- * `ARGPAR_ITER_PARSE_NEXT_STATUS_END`.
- *
- * On failure (status codes
- * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT` and
- * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR`), this function sets `*error`,
- * if not `NULL`, to a descriptive error string. Free `*error` with
- * free().
- *
- * Create an argument parsing iterator with argpar_iter_create().
- */
-enum argpar_iter_parse_next_status argpar_iter_parse_next(
- struct argpar_iter *iter, const struct argpar_item **item,
- char **error);
+-# Option item: <code>\--hello</code>.
+-# Option item: <code>\--count</code> with argument <code>23</code>.
+-# Non-option item: <code>/path/to/file</code>.
+-# Option item: <code>-a</code>.
+-# Option item: <code>-b</code>.
+-# Option item: <code>\--type</code> with argument <code>file</code>.
+-# Non-option item: <code>\--</code>.
+-# Non-option item: <code>magie</code>.
+*/
+
+/* Internal: `noexcept` specifier if C++ ≥ 11 */
+#if defined(__cplusplus) && (__cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1900))
+# define ARGPAR_NOEXCEPT noexcept
+#else
+# define ARGPAR_NOEXCEPT
+#endif
+
+typedef struct argpar_opt_descr argpar_opt_descr_t;
+
+/*!
+@name Item API
+@{
+*/
+
+/*!
+@brief
+ Type of a parsing item, as returned by
+ \link argpar_item_type(const argpar_item *) argpar_item_type()\endlink.
+*/
+typedef enum argpar_item_type
+{
+ /// Option
+ ARGPAR_ITEM_TYPE_OPT,
+
+ /// Non-option
+ ARGPAR_ITEM_TYPE_NON_OPT,
+} argpar_item_type_t;
+
+/*!
+@struct argpar_item
+
+@brief
+ Opaque parsing item type
+
+argpar_iter_next() sets a pointer to such a type.
+*/
+typedef struct argpar_item argpar_item_t;
+
+/*!
+@brief
+ Returns the type of the parsing item \p item.
+
+@param[in] item
+ Parsing item of which to get the type.
+
+@returns
+ Type of \p item.
+
+@pre
+ \p item is not \c NULL.
+*/
+argpar_item_type_t argpar_item_type(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the option descriptor of the option parsing item \p item.
+
+@param[in] item
+ Option parsing item of which to get the option descriptor.
+
+@returns
+ Option descriptor of \p item.
+
+@pre
+ \p item is not \c NULL.
+@pre
+ \p item has the type #ARGPAR_ITEM_TYPE_OPT.
+*/
+const argpar_opt_descr_t *argpar_item_opt_descr(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the argument of the option parsing item \p item, or
+ \c NULL if none.
+
+@param[in] item
+ Option parsing item of which to get the argument.
+
+@returns
+ Argument of \p item, or \c NULL if none.
+
+@pre
+ \p item is not \c NULL.
+@pre
+ \p item has the type #ARGPAR_ITEM_TYPE_OPT.
+*/
+const char *argpar_item_opt_arg(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the complete original argument, pointing to one of the
+ entries of the original arguments (in \p argv, as passed to
+ argpar_iter_create()), of the non-option parsing item \p item.
+
+@param[in] item
+ Non-option parsing item of which to get the complete original
+ argument.
+
+@returns
+ Complete original argument of \p item.
+
+@pre
+ \p item is not \c NULL.
+@pre
+ \p item has the type #ARGPAR_ITEM_TYPE_NON_OPT.
+*/
+const char *argpar_item_non_opt_arg(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the index, within \em all the original arguments (in
+ \p argv, as passed to argpar_iter_create()), of the non-option
+ parsing item \p item.
+
+For example, with the following command line (all options have no
+argument):
+
+@code{.unparsed}
+-f -m meow --jus mix --kilo
+@endcode
+
+The original argument index of \c meow is 2 while the original
+argument index of \c mix is 4.
+
+@param[in] item
+ Non-option parsing item of which to get the original argument index.
+
+@returns
+ Original argument index of \p item.
+
+@pre
+ \p item is not \c NULL.
+@pre
+ \p item has the type #ARGPAR_ITEM_TYPE_NON_OPT.
+
+@sa
+ argpar_item_non_opt_non_opt_index() -- Returns the non-option index
+ of a non-option parsing item.
+*/
+unsigned int argpar_item_non_opt_orig_index(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the index, within the parsed non-option parsing items, of
+ the non-option parsing item \p item.
+
+For example, with the following command line (all options have no
+argument):
+
+@code{.unparsed}
+-f -m meow --jus mix --kilo
+@endcode
+
+The non-option index of \c meow is 0 while the original
+argument index of \c mix is 1.
+
+@param[in] item
+ Non-option parsing item of which to get the non-option index.
+
+@returns
+ Non-option index of \p item.
+
+@pre
+ \p item is not \c NULL.
+@pre
+ \p item has the type #ARGPAR_ITEM_TYPE_NON_OPT.
+
+@sa
+ argpar_item_non_opt_orig_index() -- Returns the original argument
+ index of a non-option parsing item.
+*/
+unsigned int argpar_item_non_opt_non_opt_index(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Destroys the parsing item \p item.
+
+@param[in] item
+ Parsing item to destroy (may be \c NULL).
+*/
+void argpar_item_destroy(const argpar_item_t *item) ARGPAR_NOEXCEPT;
+
+/*!
+@def ARGPAR_ITEM_DESTROY_AND_RESET(_item)
+
+@brief
+ Calls argpar_item_destroy() with \p _item, and then sets \p _item
+ to \c NULL.
+
+@param[in] _item
+ Item to destroy and variable to reset
+ (<code>const argpar_item_t *</code> type).
+*/
+#define ARGPAR_ITEM_DESTROY_AND_RESET(_item) \
+ { \
+ argpar_item_destroy(_item); \
+ (_item) = NULL; \
+ }
+
+/// @}
+
+/*!
+@name Error API
+@{
+*/
+
+/*!
+@brief
+ Parsing error type, as returned by
+ \link argpar_error_type(const argpar_error_t *) argpar_error_type()\endlink.
+*/
+typedef enum argpar_error_type
+{
+ /// Unknown option error
+ ARGPAR_ERROR_TYPE_UNKNOWN_OPT,
+
+ /// Missing option argument error
+ ARGPAR_ERROR_TYPE_MISSING_OPT_ARG,
+
+ /// Unexpected option argument error
+ ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG,
+} argpar_error_type_t;
+
+/*!
+@struct argpar_error
+
+@brief
+ Opaque parsing error type
+*/
+typedef struct argpar_error argpar_error_t;
+
+/*!
+@brief
+ Returns the type of the parsing error object \p error.
+
+@param[in] error
+ Parsing error of which to get the type.
+
+@returns
+ Type of \p error.
+
+@pre
+ \p error is not \c NULL.
+*/
+argpar_error_type_t argpar_error_type(const argpar_error_t *error) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the index of the original argument (in \p argv, as passed to
+ argpar_iter_create()) for which the parsing error described by
+ \p error occurred.
+
+@param[in] error
+ Parsing error of which to get the original argument index.
+
+@returns
+ Original argument index of \p error.
+
+@pre
+ \p error is not \c NULL.
+*/
+unsigned int argpar_error_orig_index(const argpar_error_t *error) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the name of the unknown option for which the parsing error
+ described by \p error occurred.
+
+The returned name includes any <code>-</code> or <code>\--</code>
+prefix.
+
+With the long option with argument form, for example
+<code>\--mireille=deyglun</code>, this function only returns the name
+part (<code>\--mireille</code> in the last example).
+
+@param[in] error
+ Parsing error of which to get the name of the unknown option.
+
+@returns
+ Name of the unknown option of \p error.
+
+@pre
+ \p error is not \c NULL.
+@pre
+ The type of \p error, as returned by
+ \link argpar_error_type(const argpar_error_t *) argpar_error_type()\endlink,
+ is #ARGPAR_ERROR_TYPE_UNKNOWN_OPT.
+*/
+const char *argpar_error_unknown_opt_name(const argpar_error_t *error) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Returns the descriptor of the option for which the parsing error
+ described by \p error occurred.
+
+@param[in] error
+ Parsing error of which to get the option descriptor.
+@param[out] is_short
+ @parblock
+ If not \c NULL, this function sets \p *is_short to:
+
+ - \c true if the option for which \p error occurred is a short
+ option.
+
+ - \c false if the option for which \p error occurred is a long
+ option.
+ @endparblock
+
+@returns
+ Descriptor of the option of \p error.
+
+@pre
+ \p error is not \c NULL.
+@pre
+ The type of \p error, as returned by
+ \link argpar_error_type(const argpar_error_t *) argpar_error_type()\endlink,
+ is #ARGPAR_ERROR_TYPE_MISSING_OPT_ARG or
+ #ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG.
+*/
+const argpar_opt_descr_t *argpar_error_opt_descr(const argpar_error_t *error,
+ bool *is_short) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Destroys the parsing error \p error.
+
+@param[in] error
+ Parsing error to destroy (may be \c NULL).
+*/
+void argpar_error_destroy(const argpar_error_t *error) ARGPAR_NOEXCEPT;
+
+/// @}
+
+/*!
+@name Iterator API
+@{
+*/
+
+/*!
+@brief
+ Option descriptor
+
+argpar_iter_create() accepts an array of instances of such a type,
+terminated with #ARGPAR_OPT_DESCR_SENTINEL, as its \p descrs parameter.
+
+The typical usage is, for example:
+
+@code
+const argpar_opt_descr_t descrs[] = {
+ { 0, 'd', NULL, false },
+ { 1, '\0', "squeeze", true },
+ { 2, 'm', "meow", true },
+ ARGPAR_OPT_DESCR_SENTINEL,
+};
+@endcode
+*/
+typedef struct argpar_opt_descr
+{
+ /// Numeric ID, to uniquely identify this descriptor
+ const int id;
+
+ /// Short option character, or <code>'\0'</code>
+ const char short_name;
+
+ /// Long option name (without the <code>\--</code> prefix), or \c NULL
+ const char * const long_name;
+
+ /// \c true if this option has an argument
+ const bool with_arg;
+} argpar_opt_descr_t;
+
+/*!
+@brief
+ Sentinel for an option descriptor array
+
+The typical usage is, for example:
+
+@code
+const argpar_opt_descr_t descrs[] = {
+ { 0, 'd', NULL, false },
+ { 1, '\0', "squeeze", true },
+ { 2, 'm', "meow", true },
+ ARGPAR_OPT_DESCR_SENTINEL,
+};
+@endcode
+*/
+#define ARGPAR_OPT_DESCR_SENTINEL \
+ { \
+ -1, '\0', NULL, false \
+ }
+
+/*!
+@struct argpar_iter
+
+@brief
+ Opaque argpar iterator type
+
+argpar_iter_create() returns a pointer to such a type.
+*/
+typedef struct argpar_iter argpar_iter_t;
+
+/*!
+@brief
+ Creates and returns an argument parsing iterator to parse the
+ original arguments \p argv of which the count is \p argc using the
+ option descriptors \p descrs.
+
+This function initializes the returned structure, but doesn't actually
+start parsing the arguments.
+
+argpar considers \em all the elements of \p argv, including the first
+one, so that you would typically pass <code>(argc - 1)</code> as \p argc
+and <code>\&argv[1]</code> as \p argv from what <code>main()</code>
+receives, or ignore the parsing item of the first call to
+argpar_iter_next().
+
+\p *argv and \p *descrs must \em not change for all of:
+
+- The lifetime of the returned iterator (until you call
+ argpar_iter_destroy()).
+
+- The lifetime of any parsing item (until you call
+ argpar_item_destroy()) which argpar_iter_next() creates from the
+ returned iterator.
+
+- The lifetime of any parsing error (until you call
+ argpar_error_destroy()) which argpar_iter_next() creates from the
+ returned iterator.
+
+@param[in] argc
+ Number of original arguments to parse in \p argv.
+@param[in] argv
+ Original arguments to parse, of which the count is \p argc.
+@param[in] descrs
+ @parblock
+ Option descriptor array, terminated with #ARGPAR_OPT_DESCR_SENTINEL.
+
+ May contain duplicate entries.
+ @endparblock
+
+@returns
+ New argument parsing iterator, or \c NULL on memory error.
+
+@pre
+ \p argc is greater than 0.
+@pre
+ \p argv is not \c NULL.
+@pre
+ The first \p argc elements of \p argv are not \c NULL.
+@pre
+ \p descrs is not \c NULL.
+
+@sa
+ argpar_iter_destroy() -- Destroys an argument parsing iterator.
+*/
+argpar_iter_t *argpar_iter_create(unsigned int argc, const char * const *argv,
+ const argpar_opt_descr_t *descrs) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Destroys the argument parsing iterator \p iter.
+
+@param[in] iter
+ Argument parsing iterator to destroy (may be \c NULL).
+
+@sa
+ argpar_iter_create() -- Creates an argument parsing iterator.
+*/
+void argpar_iter_destroy(argpar_iter_t *iter) ARGPAR_NOEXCEPT;
+
+/*!
+@brief
+ Return type of argpar_iter_next().
+
+Error status enumerators have a negative value.
+*/
+typedef enum argpar_iter_next_status
+{
+ /// Success
+ ARGPAR_ITER_NEXT_STATUS_OK,
+
+ /// End of iteration (no more original arguments to parse)
+ ARGPAR_ITER_NEXT_STATUS_END,
+
+ /// Parsing error
+ ARGPAR_ITER_NEXT_STATUS_ERROR = -1,
+
+ /// Memory error
+ ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY = -12,
+} argpar_iter_next_status_t;
+
+/*!
+@brief
+ Sets \p *item to the next item of the argument parsing iterator
+ \p iter and advances \p iter.
+
+If there are no more original arguments to parse, this function returns
+#ARGPAR_ITER_NEXT_STATUS_END.
+
+@param[in] iter
+ Argument parsing iterator from which to get the next parsing item.
+@param[out] item
+ @parblock
+ On success, \p *item is the next parsing item of \p iter.
+
+ Destroy \p *item with argpar_item_destroy().
+ @endparblock
+@param[out] error
+ @parblock
+ When this function returns #ARGPAR_ITER_NEXT_STATUS_ERROR,
+ if this parameter is not \c NULL, \p *error contains details about
+ the error.
+
+ Destroy \p *error with argpar_error_destroy().
+ @endparblock
+
+@returns
+ Status code.
+
+@pre
+ \p iter is not \c NULL.
+@pre
+ \p item is not \c NULL.
+*/
+argpar_iter_next_status_t argpar_iter_next(argpar_iter_t *iter, const argpar_item_t **item,
+ const argpar_error_t **error) ARGPAR_NOEXCEPT;
/*
* Returns the number of ingested elements from `argv`, as passed to
* argpar_iter_create() to create `*iter`, that were required to produce
* 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);
+/*!
+@brief
+ Returns the number of ingested original arguments (in
+ \p argv, as passed to argpar_iter_create() to create \p iter) that
+ the parser ingested to produce the \em previous parsing items.
-/*
- * Destroys `_item` (`const struct argpar_item *`) and sets it to
- * `NULL`.
- */
-#define ARGPAR_ITEM_DESTROY_AND_RESET(_item) \
- { \
- argpar_item_destroy(_item); \
- _item = NULL; \
- }
+@param[in] iter
+ Argument parsing iterator of which to get the number of ingested
+ original arguments.
+
+@returns
+ Number of original arguments which \p iter ingested.
+
+@pre
+ \p iter is not \c NULL.
+*/
+unsigned int argpar_iter_ingested_orig_args(const argpar_iter_t *iter) ARGPAR_NOEXCEPT;
+
+/// @}
+
+/// @}
+
+#if defined(__cplusplus)
+}
+#endif
#endif /* ARGPAR_ARGPAR_H */
projects / argpar.git / blobdiff