* Copyright (c) 2020-2021 Simon Marchi <simon.marchi@efficios.com>
*/
-#include <assert.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#define ARGPAR_ZALLOC(_type) ARGPAR_CALLOC(_type, 1)
-#define ARGPAR_ASSERT(_cond) assert(_cond)
-
-#ifdef __MINGW_PRINTF_FORMAT
-# define ARGPAR_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
+#ifdef NDEBUG
+/*
+ * Force usage of the assertion condition to prevent unused variable warnings
+ * when `assert()` are disabled by the `NDEBUG` definition.
+ */
+# define ARGPAR_ASSERT(_cond) ((void) sizeof((void) (_cond), 0))
#else
-# define ARGPAR_PRINTF_FORMAT printf
+# include <assert.h>
+# define ARGPAR_ASSERT(_cond) assert(_cond)
#endif
/*
* Data provided by the user to argpar_iter_create(); immutable
* afterwards.
*/
- unsigned int argc;
- const char * const *argv;
- const struct argpar_opt_descr *descrs;
+ struct {
+ unsigned int argc;
+ const char * const *argv;
+ const struct argpar_opt_descr *descrs;
+ } user;
/*
* Index of the argument to process in the next
int non_opt_index;
/*
- * Current character of the current short option group: if it's
- * not `NULL`, the parser is in within a short option group,
- * therefore it must resume there in the next
- * argpar_iter_next() call.
+ * Current character within the current short option group: if
+ * it's not `NULL`, the parser is within a short option group,
+ * therefore it must resume there in the next argpar_iter_next()
+ * call.
*/
- const char *short_opt_ch;
+ const char *short_opt_group_ch;
/* Temporary character buffer which only grows */
struct {
unsigned int non_opt_index;
};
-static __attribute__((format(ARGPAR_PRINTF_FORMAT, 1, 0)))
-char *argpar_vasprintf(const char * const fmt, va_list args)
-{
- int len1, len2;
- char *str;
- va_list args2;
-
- va_copy(args2, args);
- len1 = vsnprintf(NULL, 0, fmt, args);
- if (len1 < 0) {
- str = NULL;
- goto end;
- }
+/* Parsing error */
+struct argpar_error {
+ /* Error type */
+ enum argpar_error_type type;
- str = malloc(len1 + 1);
- if (!str) {
- goto end;
- }
-
- len2 = vsnprintf(str, len1 + 1, fmt, args2);
- ARGPAR_ASSERT(len1 == len2);
-
-end:
- va_end(args2);
- return str;
-}
-
-
-static __attribute__((format(ARGPAR_PRINTF_FORMAT, 1, 2)))
-char *argpar_asprintf(const char * const fmt, ...)
-{
- va_list args;
- char *str;
-
- va_start(args, fmt);
- str = argpar_vasprintf(fmt, args);
- va_end(args);
- return str;
-}
-
-static __attribute__((format(ARGPAR_PRINTF_FORMAT, 2, 3)))
-bool try_append_string_printf(char ** const str, const char *fmt, ...)
-{
- char *new_str = NULL;
- char *addendum = NULL;
- bool success;
- va_list args;
-
- if (!str) {
- success = true;
- goto end;
- }
-
- ARGPAR_ASSERT(str);
- va_start(args, fmt);
- addendum = argpar_vasprintf(fmt, args);
- va_end(args);
-
- if (!addendum) {
- success = false;
- goto end;
- }
+ /* Original argument index */
+ unsigned int orig_index;
- new_str = argpar_asprintf("%s%s", *str ? *str : "", addendum);
- if (!new_str) {
- success = false;
- goto end;
- }
+ /* Name of unknown option; owned by this */
+ char *unknown_opt_name;
- free(*str);
- *str = new_str;
- success = true;
+ /* Option descriptor */
+ const struct argpar_opt_descr *opt_descr;
-end:
- free(addendum);
- return success;
-}
+ /* `true` if a short option caused the error */
+ bool is_short;
+};
ARGPAR_HIDDEN
enum argpar_item_type argpar_item_type(const struct argpar_item * const item)
return;
}
+/*
+ * Creates and returns an option parsing item for the descriptor `descr`
+ * and having the argument `arg` (copied; may be `NULL`).
+ *
+ * Returns `NULL` on memory error.
+ */
static
struct argpar_item_opt *create_opt_item(
const struct argpar_opt_descr * const descr,
return opt_item;
}
+/*
+ * Creates and returns a non-option parsing item for the original
+ * argument `arg` having the original index `orig_index` and the
+ * non-option index `non_opt_index`.
+ *
+ * Returns `NULL` on memory error.
+ */
static
struct argpar_item_non_opt *create_non_opt_item(const char * const arg,
const unsigned int orig_index,
return non_opt_item;
}
+/*
+ * If `error` is not `NULL`, sets the error `error` to a new parsing
+ * error object, setting its `unknown_opt_name`, `opt_descr`, and
+ * `is_short` members from the parameters.
+ *
+ * `unknown_opt_name` is the unknown option name without any `-` or `--`
+ * prefix: `is_short` controls which type of unknown option it is.
+ *
+ * Returns 0 on success (including if `error` is `NULL`) or -1 on memory
+ * error.
+ */
+static
+int set_error(struct argpar_error ** const error,
+ enum argpar_error_type type,
+ const char * const unknown_opt_name,
+ const struct argpar_opt_descr * const opt_descr,
+ const bool is_short)
+{
+ int ret = 0;
+
+ if (!error) {
+ goto end;
+ }
+
+ *error = ARGPAR_ZALLOC(struct argpar_error);
+ if (!*error) {
+ goto error;
+ }
+
+ (*error)->type = type;
+
+ if (unknown_opt_name) {
+ (*error)->unknown_opt_name = ARGPAR_CALLOC(char,
+ strlen(unknown_opt_name) + 1 + (is_short ? 1 : 2));
+ if (!(*error)->unknown_opt_name) {
+ goto error;
+ }
+
+ if (is_short) {
+ strcpy((*error)->unknown_opt_name, "-");
+ } else {
+ strcpy((*error)->unknown_opt_name, "--");
+ }
+
+ strcat((*error)->unknown_opt_name, unknown_opt_name);
+ }
+
+ (*error)->opt_descr = opt_descr;
+ (*error)->is_short = is_short;
+ goto end;
+
+error:
+ argpar_error_destroy(*error);
+ ret = -1;
+
+end:
+ return ret;
+}
+
+ARGPAR_HIDDEN
+enum argpar_error_type argpar_error_type(
+ const struct argpar_error * const error)
+{
+ ARGPAR_ASSERT(error);
+ return error->type;
+}
+
+ARGPAR_HIDDEN
+unsigned int argpar_error_orig_index(const struct argpar_error * const error)
+{
+ ARGPAR_ASSERT(error);
+ return error->orig_index;
+}
+
+ARGPAR_HIDDEN
+const char *argpar_error_unknown_opt_name(
+ const struct argpar_error * const error)
+{
+ ARGPAR_ASSERT(error);
+ ARGPAR_ASSERT(error->type == ARGPAR_ERROR_TYPE_UNKNOWN_OPT);
+ ARGPAR_ASSERT(error->unknown_opt_name);
+ return error->unknown_opt_name;
+}
+
+ARGPAR_HIDDEN
+const struct argpar_opt_descr *argpar_error_opt_descr(
+ const struct argpar_error * const error, bool * const is_short)
+{
+ ARGPAR_ASSERT(error);
+ ARGPAR_ASSERT(error->type == ARGPAR_ERROR_TYPE_MISSING_OPT_ARG ||
+ error->type == ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG);
+ ARGPAR_ASSERT(error->opt_descr);
+
+ if (is_short) {
+ *is_short = error->is_short;
+ }
+
+ return error->opt_descr;
+}
+
+ARGPAR_HIDDEN
+void argpar_error_destroy(const struct argpar_error * const error)
+{
+ if (error) {
+ free(error->unknown_opt_name);
+ free((void *) error);
+ }
+}
+
+/*
+ * Finds and returns the _first_ descriptor having the short option name
+ * `short_name` or the long option name `long_name` within the option
+ * descriptors `descrs`.
+ *
+ * `short_name` may be `'\0'` to not consider it.
+ *
+ * `long_name` may be `NULL` to not consider it.
+ *
+ * Returns `NULL` if no descriptor is found.
+ */
static
const struct argpar_opt_descr *find_descr(
const struct argpar_opt_descr * const descrs,
return !descr->short_name && !descr->long_name ? NULL : descr;
}
+/* Return type of parse_short_opt_group() and parse_long_opt() */
enum parse_orig_arg_opt_ret {
PARSE_ORIG_ARG_OPT_RET_OK,
- PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT = -1,
- PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG = -2,
- PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG = -4,
- PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY = -5,
+ PARSE_ORIG_ARG_OPT_RET_ERROR = -1,
+ PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY = -2,
};
+/*
+ * Parses the short option group argument `short_opt_group`, starting
+ * where needed depending on the state of `iter`.
+ *
+ * On success, sets `*item`.
+ *
+ * On error (except for `PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY`), sets
+ * `*error`.
+ */
static
-enum parse_orig_arg_opt_ret parse_short_opts(const char * const short_opts,
+enum parse_orig_arg_opt_ret parse_short_opt_group(
+ const char * const short_opt_group,
const char * const next_orig_arg,
const struct argpar_opt_descr * const descrs,
struct argpar_iter * const iter,
- char ** const error, struct argpar_item ** const item)
+ struct argpar_error ** const error,
+ struct argpar_item ** const item)
{
enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK;
bool used_next_orig_arg = false;
const struct argpar_opt_descr *descr;
struct argpar_item_opt *opt_item;
- ARGPAR_ASSERT(strlen(short_opts) != 0);
+ ARGPAR_ASSERT(strlen(short_opt_group) != 0);
- if (!iter->short_opt_ch) {
- iter->short_opt_ch = short_opts;
+ if (!iter->short_opt_group_ch) {
+ iter->short_opt_group_ch = short_opt_group;
}
/* Find corresponding option descriptor */
- descr = find_descr(descrs, *iter->short_opt_ch, NULL);
+ descr = find_descr(descrs, *iter->short_opt_group_ch, NULL);
if (!descr) {
- try_append_string_printf(error, "Unknown option `-%c`",
- *iter->short_opt_ch);
- ret = PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT;
+ const char unknown_opt_name[] =
+ {*iter->short_opt_group_ch, '\0'};
+
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR;
+
+ if (set_error(error, ARGPAR_ERROR_TYPE_UNKNOWN_OPT,
+ unknown_opt_name, NULL, true)) {
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY;
+ }
+
goto error;
}
if (descr->with_arg) {
- if (iter->short_opt_ch[1]) {
+ if (iter->short_opt_group_ch[1]) {
/* `-oarg` form */
- opt_arg = &iter->short_opt_ch[1];
+ opt_arg = &iter->short_opt_group_ch[1];
} else {
/* `-o arg` form */
opt_arg = next_orig_arg;
* We accept `-o ''` (empty option argument), but not
* `-o` alone if an option argument is expected.
*/
- if (!opt_arg || (iter->short_opt_ch[1] &&
+ if (!opt_arg || (iter->short_opt_group_ch[1] &&
strlen(opt_arg) == 0)) {
- try_append_string_printf(error,
- "Missing required argument for option `-%c`",
- *iter->short_opt_ch);
- used_next_orig_arg = false;
- ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG;
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR;
+
+ if (set_error(error, ARGPAR_ERROR_TYPE_MISSING_OPT_ARG,
+ NULL, descr, true)) {
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY;
+ }
+
goto error;
}
}
}
*item = &opt_item->base;
- iter->short_opt_ch++;
+ iter->short_opt_group_ch++;
- if (descr->with_arg || !*iter->short_opt_ch) {
+ if (descr->with_arg || !*iter->short_opt_group_ch) {
/* Option has an argument: no more options */
- iter->short_opt_ch = NULL;
+ iter->short_opt_group_ch = NULL;
if (used_next_orig_arg) {
iter->i += 2;
return ret;
}
+/*
+ * Parses the long option argument `long_opt_arg`.
+ *
+ * On success, sets `*item`.
+ *
+ * On error (except for `PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY`), sets
+ * `*error`.
+ */
static
enum parse_orig_arg_opt_ret parse_long_opt(const char * const long_opt_arg,
const char * const next_orig_arg,
const struct argpar_opt_descr * const descrs,
struct argpar_iter * const iter,
- char ** const error, struct argpar_item ** const item)
+ struct argpar_error ** const error,
+ struct argpar_item ** const item)
{
enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK;
const struct argpar_opt_descr *descr;
/* Find corresponding option descriptor */
descr = find_descr(descrs, '\0', long_opt_name);
if (!descr) {
- try_append_string_printf(error, "Unknown option `--%s`",
- long_opt_name);
- ret = PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT;
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR;
+
+ if (set_error(error, ARGPAR_ERROR_TYPE_UNKNOWN_OPT,
+ long_opt_name, NULL, false)) {
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY;
+ }
+
goto error;
}
} else {
/* `--long-opt arg` style */
if (!next_orig_arg) {
- try_append_string_printf(error,
- "Missing required argument for option `--%s`",
- long_opt_name);
- ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG;
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR;
+
+ if (set_error(error, ARGPAR_ERROR_TYPE_MISSING_OPT_ARG,
+ NULL, descr, false)) {
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY;
+ }
+
goto error;
}
* Unexpected `--opt=arg` style for a long option which
* doesn't accept an argument.
*/
- try_append_string_printf(error,
- "Unexpected argument for option `--%s`", long_opt_name);
- ret = PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG;
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR;
+
+ if (set_error(error, ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG,
+ NULL, descr, false)) {
+ ret = PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY;
+ }
+
goto error;
}
return ret;
}
+/*
+ * Parses the original argument `orig_arg`.
+ *
+ * On success, sets `*item`.
+ *
+ * On error (except for `PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY`), sets
+ * `*error`.
+ */
static
enum parse_orig_arg_opt_ret parse_orig_arg_opt(const char * const orig_arg,
const char * const next_orig_arg,
const struct argpar_opt_descr * const descrs,
- struct argpar_iter * const iter, char ** const error,
+ struct argpar_iter * const iter,
+ struct argpar_error ** const error,
struct argpar_item ** const item)
{
enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK;
next_orig_arg, descrs, iter, error, item);
} else {
/* Short option */
- ret = parse_short_opts(&orig_arg[1],
+ ret = parse_short_opt_group(&orig_arg[1],
next_orig_arg, descrs, iter, error, item);
}
return ret;
}
-static
-bool try_prepend_while_parsing_arg_to_error(char ** const error,
- const unsigned int i, const char * const arg)
-{
- char *new_error;
- bool success;
-
- if (!error) {
- success = true;
- goto end;
- }
-
- ARGPAR_ASSERT(*error);
- new_error = argpar_asprintf("While parsing argument #%u (`%s`): %s",
- i + 1, arg, *error);
- if (!new_error) {
- success = false;
- goto end;
- }
-
- free(*error);
- *error = new_error;
- success = true;
-
-end:
- return success;
-}
-
ARGPAR_HIDDEN
struct argpar_iter *argpar_iter_create(const unsigned int argc,
const char * const * const argv,
goto end;
}
- iter->argc = argc;
- iter->argv = argv;
- iter->descrs = descrs;
+ iter->user.argc = argc;
+ iter->user.argv = argv;
+ iter->user.descrs = descrs;
iter->tmp_buf.size = 128;
iter->tmp_buf.data = ARGPAR_CALLOC(char, iter->tmp_buf.size);
if (!iter->tmp_buf.data) {
ARGPAR_HIDDEN
enum argpar_iter_next_status argpar_iter_next(
struct argpar_iter * const iter,
- const struct argpar_item ** const item, char ** const error)
+ const struct argpar_item ** const item,
+ const struct argpar_error ** const error)
{
enum argpar_iter_next_status status;
enum parse_orig_arg_opt_ret parse_orig_arg_opt_ret;
const char *orig_arg;
const char *next_orig_arg;
+ struct argpar_error ** const nc_error = (struct argpar_error **) error;
- ARGPAR_ASSERT(iter->i <= iter->argc);
+ ARGPAR_ASSERT(iter->i <= iter->user.argc);
if (error) {
- *error = NULL;
+ *nc_error = NULL;
}
- if (iter->i == iter->argc) {
+ if (iter->i == iter->user.argc) {
status = ARGPAR_ITER_NEXT_STATUS_END;
goto end;
}
- orig_arg = iter->argv[iter->i];
+ orig_arg = iter->user.argv[iter->i];
next_orig_arg =
- iter->i < (iter->argc - 1) ? iter->argv[iter->i + 1] : NULL;
+ iter->i < (iter->user.argc - 1) ?
+ iter->user.argv[iter->i + 1] : NULL;
if (strcmp(orig_arg, "-") == 0 || strcmp(orig_arg, "--") == 0 ||
orig_arg[0] != '-') {
/* Option argument */
parse_orig_arg_opt_ret = parse_orig_arg_opt(orig_arg,
- next_orig_arg, iter->descrs, iter, error,
+ next_orig_arg, iter->user.descrs, iter, nc_error,
(struct argpar_item **) item);
switch (parse_orig_arg_opt_ret) {
case PARSE_ORIG_ARG_OPT_RET_OK:
status = ARGPAR_ITER_NEXT_STATUS_OK;
break;
- case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT:
- case PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG:
- case PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG:
- try_prepend_while_parsing_arg_to_error(error, iter->i,
- orig_arg);
-
- switch (parse_orig_arg_opt_ret) {
- case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT:
- status = ARGPAR_ITER_NEXT_STATUS_ERROR_UNKNOWN_OPT;
- break;
- case PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG:
- status = ARGPAR_ITER_NEXT_STATUS_ERROR_MISSING_OPT_ARG;
- break;
- case PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG:
- status = ARGPAR_ITER_NEXT_STATUS_ERROR_UNEXPECTED_OPT_ARG;
- break;
- default:
- abort();
+ case PARSE_ORIG_ARG_OPT_RET_ERROR:
+ if (error) {
+ ARGPAR_ASSERT(*error);
+ (*nc_error)->orig_index = iter->i;
}
-
+ status = ARGPAR_ITER_NEXT_STATUS_ERROR;
break;
case PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY:
status = ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY;
projects / argpar.git / blobdiff