-# 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
+# define ARGPAR_NOEXCEPT noexcept
#else
-# define ARGPAR_NOEXCEPT
+# define ARGPAR_NOEXCEPT
#endif
typedef struct argpar_opt_descr argpar_opt_descr_t;
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,
+typedef enum argpar_item_type
+{
+ /// Option
+ ARGPAR_ITEM_TYPE_OPT,
- /// Non-option
- ARGPAR_ITEM_TYPE_NON_OPT,
+ /// Non-option
+ ARGPAR_ITEM_TYPE_NON_OPT,
} argpar_item_type_t;
/*!
@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;
+const argpar_opt_descr_t *argpar_item_opt_descr(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@brief
@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;
+const char *argpar_item_non_opt_arg(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@brief
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;
+unsigned int argpar_item_non_opt_orig_index(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@brief
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;
+unsigned int argpar_item_non_opt_non_opt_index(const argpar_item_t *item) ARGPAR_NOEXCEPT;
/*!
@brief
@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;
/*!
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; \
- }
+#define ARGPAR_ITEM_DESTROY_AND_RESET(_item) \
+ { \
+ argpar_item_destroy(_item); \
+ _item = NULL; \
+ }
/// @}
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,
+typedef enum argpar_error_type
+{
+ /// Unknown option error
+ ARGPAR_ERROR_TYPE_UNKNOWN_OPT,
- /// Missing option argument error
- ARGPAR_ERROR_TYPE_MISSING_OPT_ARG,
+ /// Missing option argument error
+ ARGPAR_ERROR_TYPE_MISSING_OPT_ARG,
- /// Unexpected option argument error
- ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG,
+ /// Unexpected option argument error
+ ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG,
} argpar_error_type_t;
/*!
@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;
+argpar_error_type_t argpar_error_type(const argpar_error_t *error) ARGPAR_NOEXCEPT;
/*!
@brief
@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;
+unsigned int argpar_error_orig_index(const argpar_error_t *error) ARGPAR_NOEXCEPT;
/*!
@brief
\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;
+const char *argpar_error_unknown_opt_name(const argpar_error_t *error) ARGPAR_NOEXCEPT;
/*!
@brief
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;
+ bool *is_short) ARGPAR_NOEXCEPT;
/*!
@brief
@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;
/// @}
};
@endcode
*/
-typedef struct argpar_opt_descr {
- /// Numeric ID, to uniquely identify this descriptor
- const int id;
+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;
+ /// 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;
+ /// 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;
+ /// \c true if this option has an argument
+ const bool with_arg;
} argpar_opt_descr_t;
/*!
};
@endcode
*/
-#define ARGPAR_OPT_DESCR_SENTINEL { -1, '\0', NULL, false }
+#define ARGPAR_OPT_DESCR_SENTINEL \
+ { \
+ -1, '\0', NULL, false \
+ }
/*!
@struct argpar_iter
@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;
+ const argpar_opt_descr_t *descrs) ARGPAR_NOEXCEPT;
/*!
@brief
@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;
/*!
Error status enumerators have a negative value.
*/
-typedef enum argpar_iter_next_status {
- /// Success
- ARGPAR_ITER_NEXT_STATUS_OK,
+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,
+ /// End of iteration (no more original arguments to parse)
+ ARGPAR_ITER_NEXT_STATUS_END,
- /// Parsing error
- ARGPAR_ITER_NEXT_STATUS_ERROR = -1,
+ /// Parsing error
+ ARGPAR_ITER_NEXT_STATUS_ERROR = -1,
- /// Memory error
- ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY = -12,
+ /// Memory error
+ ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY = -12,
} argpar_iter_next_status_t;
/*!
@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;
+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
@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;
+unsigned int argpar_iter_ingested_orig_args(const argpar_iter_t *iter) ARGPAR_NOEXCEPT;
/// @}