2 * Copyright (C) 2021 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
8 #include "argpar-utils.h"
12 #include <common/error.h>
13 #include <common/string-utils/string-utils.h>
16 * Given argpar error status `status` and error `error`, return a formatted
17 * error message describing the error.
19 * `argv` is the argument vector that was being parsed.
21 * `context_fmt`, if non-NULL, is formatted using `args` and prepended to the
24 * Add `argc_offset` the the argument index mentioned in the error message.
26 * The returned string must be freed by the caller.
29 char *format_arg_error_v(const struct argpar_error
*error
, int argc_offset
,
30 const char **argv
, const char *context_fmt
, va_list args
)
37 ret
= vasprintf(&str
, context_fmt
, args
);
40 * If vasprintf fails, the content of str is undefined,
41 * and we shouldn't try to free it.
47 ret
= strutils_append_str(&str
, ": ");
53 switch (argpar_error_type(error
))
55 case ARGPAR_ERROR_TYPE_MISSING_OPT_ARG
:
57 int orig_index
= argpar_error_orig_index(error
);
58 const char *arg
= argv
[orig_index
];
60 ret
= strutils_appendf(&str
,
61 WHILE_PARSING_ARG_N_ARG_FMT
"Missing required argument for option `%s`",
62 orig_index
+ 1 + argc_offset
, argv
[orig_index
], arg
);
69 case ARGPAR_ERROR_TYPE_UNEXPECTED_OPT_ARG
:
72 const struct argpar_opt_descr
*descr
=
73 argpar_error_opt_descr(error
, &is_short
);
74 int orig_index
= argpar_error_orig_index(error
);
75 const char *arg
= argv
[orig_index
];
78 ret
= strutils_appendf(&str
,
79 WHILE_PARSING_ARG_N_ARG_FMT
"Unexpected argument for option `-%c`",
80 orig_index
+ 1 + argc_offset
, arg
, descr
->short_name
);
82 ret
= strutils_appendf(&str
,
83 WHILE_PARSING_ARG_N_ARG_FMT
"Unexpected argument for option `--%s`",
84 orig_index
+ 1 + argc_offset
, arg
, descr
->long_name
);
93 case ARGPAR_ERROR_TYPE_UNKNOWN_OPT
:
95 int orig_index
= argpar_error_orig_index(error
);
96 const char *unknown_opt
= argpar_error_unknown_opt_name(error
);
98 ret
= strutils_appendf(&str
,
99 WHILE_PARSING_ARG_N_ARG_FMT
"Unknown option `%s`",
100 orig_index
+ 1 + argc_offset
, argv
[orig_index
], unknown_opt
);
121 enum parse_next_item_status
parse_next_item(struct argpar_iter
*iter
,
122 const struct argpar_item
**item
, int argc_offset
,
123 const char **argv
, bool unknown_opt_is_error
,
124 const struct argpar_error
**error_out
,
125 const char *context_fmt
, ...)
127 enum argpar_iter_next_status status
;
128 const struct argpar_error
*error
= NULL
;
129 enum parse_next_item_status ret
;
131 ARGPAR_ITEM_DESTROY_AND_RESET(*item
);
132 status
= argpar_iter_next(iter
, item
, &error
);
135 case ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY
:
136 ERR("Failed to get next argpar item.");
137 ret
= PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
;
139 case ARGPAR_ITER_NEXT_STATUS_ERROR
:
144 if (argpar_error_type(error
) == ARGPAR_ERROR_TYPE_UNKNOWN_OPT
&&
145 !unknown_opt_is_error
) {
146 ret
= PARSE_NEXT_ITEM_STATUS_END
;
150 va_start(args
, context_fmt
);
151 err_str
= format_arg_error_v(error
, argc_offset
, argv
,
159 ERR("%s", "Failed to format argpar error.");
162 ret
= PARSE_NEXT_ITEM_STATUS_ERROR
;
165 case ARGPAR_ITER_NEXT_STATUS_END
:
166 ret
= PARSE_NEXT_ITEM_STATUS_END
;
168 case ARGPAR_ITER_NEXT_STATUS_OK
:
169 ret
= PARSE_NEXT_ITEM_STATUS_OK
;
176 argpar_error_destroy(*error_out
);
181 argpar_error_destroy(error
);