#include "argpar.h"
+/*
+ * 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
+
#define ARGPAR_REALLOC(_ptr, _type, _nmemb) \
((_type *) realloc(_ptr, (_nmemb) * sizeof(_type)))
-# Non-option item: <code>magie</code>.
*/
-/*
- * 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
-
/* Internal: `noexcept` specifier if C++ ≥ 11 */
#if defined(__cplusplus) && (__cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1900))
# define ARGPAR_NOEXCEPT noexcept
@pre
\p item is not \c NULL.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
argpar_item_type_t argpar_item_type(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@pre
\p item has the type #ARGPAR_ITEM_TYPE_OPT.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
const argpar_opt_descr_t *argpar_item_opt_descr(
const argpar_item_t *item) ARGPAR_NOEXCEPT;
@pre
\p item has the type #ARGPAR_ITEM_TYPE_OPT.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
const char *argpar_item_opt_arg(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@pre
\p item has the type #ARGPAR_ITEM_TYPE_NON_OPT.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
const char *argpar_item_non_opt_arg(
const argpar_item_t *item) ARGPAR_NOEXCEPT;
argpar_item_non_opt_non_opt_index() -- Returns the non-option index
of a non-option parsing item.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
unsigned int argpar_item_non_opt_orig_index(
const argpar_item_t *item) ARGPAR_NOEXCEPT;
argpar_item_non_opt_orig_index() -- Returns the original argument
index of a non-option parsing item.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
unsigned int argpar_item_non_opt_non_opt_index(
const argpar_item_t *item) ARGPAR_NOEXCEPT;
@param[in] item
Parsing item to destroy (may be \c NULL).
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
void argpar_item_destroy(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@pre
\p error is not \c NULL.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
argpar_error_type_t argpar_error_type(
const argpar_error_t *error) ARGPAR_NOEXCEPT;
@pre
\p error is not \c NULL.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
unsigned int argpar_error_orig_index(
const argpar_error_t *error) ARGPAR_NOEXCEPT;
\link argpar_error_type(const argpar_error_t *) argpar_error_type()\endlink,
is #ARGPAR_ERROR_TYPE_UNKNOWN_OPT.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
const char *argpar_error_unknown_opt_name(
const argpar_error_t *error) ARGPAR_NOEXCEPT;
is #ARGPAR_ERROR_TYPE_MISSING_OPT_ARG or
#ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
const argpar_opt_descr_t *argpar_error_opt_descr(const argpar_error_t *error,
bool *is_short) ARGPAR_NOEXCEPT;
@param[in] error
Parsing error to destroy (may be \c NULL).
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
void argpar_error_destroy(const argpar_error_t *error) ARGPAR_NOEXCEPT;
/// @}
@sa
argpar_iter_destroy() -- Destroys an argument parsing iterator.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
argpar_iter_t *argpar_iter_create(unsigned int argc, const char * const *argv,
const argpar_opt_descr_t *descrs) ARGPAR_NOEXCEPT;
@sa
argpar_iter_create() -- Creates an argument parsing iterator.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
void argpar_iter_destroy(argpar_iter_t *iter) ARGPAR_NOEXCEPT;
/*!
@pre
\p item is not \c NULL.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
argpar_iter_next_status_t argpar_iter_next(argpar_iter_t *iter,
const argpar_item_t **item,
const argpar_error_t **error) ARGPAR_NOEXCEPT;
@pre
\p iter is not \c NULL.
*/
-/// @cond hidden_macro
-ARGPAR_HIDDEN
-/// @endcond
unsigned int argpar_iter_ingested_orig_args(
const argpar_iter_t *iter) ARGPAR_NOEXCEPT;