2 * SPDX-License-Identifier: MIT
4 * Copyright (c) 2019-2021 Philippe Proulx <pproulx@efficios.com>
5 * Copyright (c) 2020-2021 Simon Marchi <simon.marchi@efficios.com>
17 #define ARGPAR_REALLOC(_ptr, _type, _nmemb) \
18 ((_type *) realloc(_ptr, (_nmemb) * sizeof(_type)))
20 #define ARGPAR_CALLOC(_type, _nmemb) \
21 ((_type *) calloc((_nmemb), sizeof(_type)))
23 #define ARGPAR_ZALLOC(_type) ARGPAR_CALLOC(_type, 1)
25 #define ARGPAR_ASSERT(_cond) assert(_cond)
27 #ifdef __MINGW_PRINTF_FORMAT
28 # define ARGPAR_PRINTF_FORMAT __MINGW_PRINTF_FORMAT
30 # define ARGPAR_PRINTF_FORMAT printf
36 * Such a structure contains the state of an iterator between calls to
41 * Data provided by the user to argpar_iter_create(); immutable
45 const char * const *argv
;
46 const struct argpar_opt_descr
*descrs
;
49 * Index of the argument to process in the next
50 * argpar_iter_next() call.
54 /* Counter of non-option arguments */
58 * Current character of the current short option group: if it's
59 * not `NULL`, the parser is in within a short option group,
60 * therefore it must resume there in the next
61 * argpar_iter_next() call.
63 const char *short_opt_ch
;
65 /* Temporary character buffer which only grows */
72 /* Base parsing item */
74 enum argpar_item_type type
;
77 /* Option parsing item */
78 struct argpar_item_opt
{
79 struct argpar_item base
;
81 /* Corresponding descriptor */
82 const struct argpar_opt_descr
*descr
;
84 /* Argument, or `NULL` if none; owned by this */
88 /* Non-option parsing item */
89 struct argpar_item_non_opt
{
90 struct argpar_item base
;
93 * Complete argument, pointing to one of the entries of the
94 * original arguments (`argv`).
99 * Index of this argument amongst all original arguments
102 unsigned int orig_index
;
104 /* Index of this argument amongst other non-option arguments */
105 unsigned int non_opt_index
;
108 static __attribute__((format(ARGPAR_PRINTF_FORMAT
, 1, 0)))
109 char *argpar_vasprintf(const char * const fmt
, va_list args
)
115 va_copy(args2
, args
);
116 len1
= vsnprintf(NULL
, 0, fmt
, args
);
122 str
= malloc(len1
+ 1);
127 len2
= vsnprintf(str
, len1
+ 1, fmt
, args2
);
128 ARGPAR_ASSERT(len1
== len2
);
136 static __attribute__((format(ARGPAR_PRINTF_FORMAT
, 1, 2)))
137 char *argpar_asprintf(const char * const fmt
, ...)
143 str
= argpar_vasprintf(fmt
, args
);
148 static __attribute__((format(ARGPAR_PRINTF_FORMAT
, 2, 3)))
149 bool try_append_string_printf(char ** const str
, const char *fmt
, ...)
151 char *new_str
= NULL
;
152 char *addendum
= NULL
;
163 addendum
= argpar_vasprintf(fmt
, args
);
171 new_str
= argpar_asprintf("%s%s", *str
? *str
: "", addendum
);
187 enum argpar_item_type
argpar_item_type(const struct argpar_item
* const item
)
194 const struct argpar_opt_descr
*argpar_item_opt_descr(
195 const struct argpar_item
* const item
)
198 ARGPAR_ASSERT(item
->type
== ARGPAR_ITEM_TYPE_OPT
);
199 return ((const struct argpar_item_opt
*) item
)->descr
;
203 const char *argpar_item_opt_arg(const struct argpar_item
* const item
)
206 ARGPAR_ASSERT(item
->type
== ARGPAR_ITEM_TYPE_OPT
);
207 return ((const struct argpar_item_opt
*) item
)->arg
;
211 const char *argpar_item_non_opt_arg(const struct argpar_item
* const item
)
214 ARGPAR_ASSERT(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
215 return ((const struct argpar_item_non_opt
*) item
)->arg
;
219 unsigned int argpar_item_non_opt_orig_index(
220 const struct argpar_item
* const item
)
223 ARGPAR_ASSERT(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
224 return ((const struct argpar_item_non_opt
*) item
)->orig_index
;
228 unsigned int argpar_item_non_opt_non_opt_index(
229 const struct argpar_item
* const item
)
232 ARGPAR_ASSERT(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
233 return ((const struct argpar_item_non_opt
*) item
)->non_opt_index
;
237 void argpar_item_destroy(const struct argpar_item
* const item
)
243 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
244 struct argpar_item_opt
* const opt_item
=
245 (struct argpar_item_opt
*) item
;
257 struct argpar_item_opt
*create_opt_item(
258 const struct argpar_opt_descr
* const descr
,
259 const char * const arg
)
261 struct argpar_item_opt
*opt_item
=
262 ARGPAR_ZALLOC(struct argpar_item_opt
);
268 opt_item
->base
.type
= ARGPAR_ITEM_TYPE_OPT
;
269 opt_item
->descr
= descr
;
272 opt_item
->arg
= strdup(arg
);
273 if (!opt_item
->arg
) {
281 argpar_item_destroy(&opt_item
->base
);
289 struct argpar_item_non_opt
*create_non_opt_item(const char * const arg
,
290 const unsigned int orig_index
,
291 const unsigned int non_opt_index
)
293 struct argpar_item_non_opt
* const non_opt_item
=
294 ARGPAR_ZALLOC(struct argpar_item_non_opt
);
300 non_opt_item
->base
.type
= ARGPAR_ITEM_TYPE_NON_OPT
;
301 non_opt_item
->arg
= arg
;
302 non_opt_item
->orig_index
= orig_index
;
303 non_opt_item
->non_opt_index
= non_opt_index
;
310 const struct argpar_opt_descr
*find_descr(
311 const struct argpar_opt_descr
* const descrs
,
312 const char short_name
, const char * const long_name
)
314 const struct argpar_opt_descr
*descr
;
316 for (descr
= descrs
; descr
->short_name
|| descr
->long_name
; descr
++) {
317 if (short_name
&& descr
->short_name
&&
318 short_name
== descr
->short_name
) {
322 if (long_name
&& descr
->long_name
&&
323 strcmp(long_name
, descr
->long_name
) == 0) {
329 return !descr
->short_name
&& !descr
->long_name
? NULL
: descr
;
332 enum parse_orig_arg_opt_ret
{
333 PARSE_ORIG_ARG_OPT_RET_OK
,
334 PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
= -1,
335 PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG
= -2,
336 PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG
= -4,
337 PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY
= -5,
341 enum parse_orig_arg_opt_ret
parse_short_opts(const char * const short_opts
,
342 const char * const next_orig_arg
,
343 const struct argpar_opt_descr
* const descrs
,
344 struct argpar_iter
* const iter
,
345 char ** const error
, struct argpar_item
** const item
)
347 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
348 bool used_next_orig_arg
= false;
349 const char *opt_arg
= NULL
;
350 const struct argpar_opt_descr
*descr
;
351 struct argpar_item_opt
*opt_item
;
353 ARGPAR_ASSERT(strlen(short_opts
) != 0);
355 if (!iter
->short_opt_ch
) {
356 iter
->short_opt_ch
= short_opts
;
359 /* Find corresponding option descriptor */
360 descr
= find_descr(descrs
, *iter
->short_opt_ch
, NULL
);
362 try_append_string_printf(error
, "Unknown option `-%c`",
363 *iter
->short_opt_ch
);
364 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
;
368 if (descr
->with_arg
) {
369 if (iter
->short_opt_ch
[1]) {
371 opt_arg
= &iter
->short_opt_ch
[1];
374 opt_arg
= next_orig_arg
;
375 used_next_orig_arg
= true;
379 * We accept `-o ''` (empty option argument), but not
380 * `-o` alone if an option argument is expected.
382 if (!opt_arg
|| (iter
->short_opt_ch
[1] &&
383 strlen(opt_arg
) == 0)) {
384 try_append_string_printf(error
,
385 "Missing required argument for option `-%c`",
386 *iter
->short_opt_ch
);
387 used_next_orig_arg
= false;
388 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG
;
393 /* Create and append option argument */
394 opt_item
= create_opt_item(descr
, opt_arg
);
396 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY
;
400 *item
= &opt_item
->base
;
401 iter
->short_opt_ch
++;
403 if (descr
->with_arg
|| !*iter
->short_opt_ch
) {
404 /* Option has an argument: no more options */
405 iter
->short_opt_ch
= NULL
;
407 if (used_next_orig_arg
) {
417 ARGPAR_ASSERT(ret
!= PARSE_ORIG_ARG_OPT_RET_OK
);
424 enum parse_orig_arg_opt_ret
parse_long_opt(const char * const long_opt_arg
,
425 const char * const next_orig_arg
,
426 const struct argpar_opt_descr
* const descrs
,
427 struct argpar_iter
* const iter
,
428 char ** const error
, struct argpar_item
** const item
)
430 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
431 const struct argpar_opt_descr
*descr
;
432 struct argpar_item_opt
*opt_item
;
433 bool used_next_orig_arg
= false;
435 /* Option's argument, if any */
436 const char *opt_arg
= NULL
;
438 /* Position of first `=`, if any */
442 const char *long_opt_name
= long_opt_arg
;
444 ARGPAR_ASSERT(strlen(long_opt_arg
) != 0);
446 /* Find the first `=` in original argument */
447 eq_pos
= strchr(long_opt_arg
, '=');
449 const size_t long_opt_name_size
= eq_pos
- long_opt_arg
;
451 /* Isolate the option name */
452 while (long_opt_name_size
> iter
->tmp_buf
.size
- 1) {
453 iter
->tmp_buf
.size
*= 2;
454 iter
->tmp_buf
.data
= ARGPAR_REALLOC(iter
->tmp_buf
.data
,
455 char, iter
->tmp_buf
.size
);
456 if (!iter
->tmp_buf
.data
) {
457 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY
;
462 memcpy(iter
->tmp_buf
.data
, long_opt_arg
, long_opt_name_size
);
463 iter
->tmp_buf
.data
[long_opt_name_size
] = '\0';
464 long_opt_name
= iter
->tmp_buf
.data
;
467 /* Find corresponding option descriptor */
468 descr
= find_descr(descrs
, '\0', long_opt_name
);
470 try_append_string_printf(error
, "Unknown option `--%s`",
472 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
;
476 /* Find option's argument if any */
477 if (descr
->with_arg
) {
479 /* `--long-opt=arg` style */
480 opt_arg
= eq_pos
+ 1;
482 /* `--long-opt arg` style */
483 if (!next_orig_arg
) {
484 try_append_string_printf(error
,
485 "Missing required argument for option `--%s`",
487 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG
;
491 opt_arg
= next_orig_arg
;
492 used_next_orig_arg
= true;
496 * Unexpected `--opt=arg` style for a long option which
497 * doesn't accept an argument.
499 try_append_string_printf(error
,
500 "Unexpected argument for option `--%s`", long_opt_name
);
501 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG
;
505 /* Create and append option argument */
506 opt_item
= create_opt_item(descr
, opt_arg
);
511 if (used_next_orig_arg
) {
517 *item
= &opt_item
->base
;
521 ARGPAR_ASSERT(ret
!= PARSE_ORIG_ARG_OPT_RET_OK
);
528 enum parse_orig_arg_opt_ret
parse_orig_arg_opt(const char * const orig_arg
,
529 const char * const next_orig_arg
,
530 const struct argpar_opt_descr
* const descrs
,
531 struct argpar_iter
* const iter
, char ** const error
,
532 struct argpar_item
** const item
)
534 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
536 ARGPAR_ASSERT(orig_arg
[0] == '-');
538 if (orig_arg
[1] == '-') {
540 ret
= parse_long_opt(&orig_arg
[2],
541 next_orig_arg
, descrs
, iter
, error
, item
);
544 ret
= parse_short_opts(&orig_arg
[1],
545 next_orig_arg
, descrs
, iter
, error
, item
);
552 bool try_prepend_while_parsing_arg_to_error(char ** const error
,
553 const unsigned int i
, const char * const arg
)
563 ARGPAR_ASSERT(*error
);
564 new_error
= argpar_asprintf("While parsing argument #%u (`%s`): %s",
580 struct argpar_iter
*argpar_iter_create(const unsigned int argc
,
581 const char * const * const argv
,
582 const struct argpar_opt_descr
* const descrs
)
584 struct argpar_iter
*iter
= ARGPAR_ZALLOC(struct argpar_iter
);
592 iter
->descrs
= descrs
;
593 iter
->tmp_buf
.size
= 128;
594 iter
->tmp_buf
.data
= ARGPAR_CALLOC(char, iter
->tmp_buf
.size
);
595 if (!iter
->tmp_buf
.data
) {
596 argpar_iter_destroy(iter
);
606 void argpar_iter_destroy(struct argpar_iter
* const iter
)
609 free(iter
->tmp_buf
.data
);
615 enum argpar_iter_next_status
argpar_iter_next(
616 struct argpar_iter
* const iter
,
617 const struct argpar_item
** const item
, char ** const error
)
619 enum argpar_iter_next_status status
;
620 enum parse_orig_arg_opt_ret parse_orig_arg_opt_ret
;
621 const char *orig_arg
;
622 const char *next_orig_arg
;
624 ARGPAR_ASSERT(iter
->i
<= iter
->argc
);
630 if (iter
->i
== iter
->argc
) {
631 status
= ARGPAR_ITER_NEXT_STATUS_END
;
635 orig_arg
= iter
->argv
[iter
->i
];
637 iter
->i
< (iter
->argc
- 1) ? iter
->argv
[iter
->i
+ 1] : NULL
;
639 if (strcmp(orig_arg
, "-") == 0 || strcmp(orig_arg
, "--") == 0 ||
640 orig_arg
[0] != '-') {
641 /* Non-option argument */
642 const struct argpar_item_non_opt
* const non_opt_item
=
643 create_non_opt_item(orig_arg
, iter
->i
,
644 iter
->non_opt_index
);
647 status
= ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY
;
651 iter
->non_opt_index
++;
653 *item
= &non_opt_item
->base
;
654 status
= ARGPAR_ITER_NEXT_STATUS_OK
;
658 /* Option argument */
659 parse_orig_arg_opt_ret
= parse_orig_arg_opt(orig_arg
,
660 next_orig_arg
, iter
->descrs
, iter
, error
,
661 (struct argpar_item
**) item
);
662 switch (parse_orig_arg_opt_ret
) {
663 case PARSE_ORIG_ARG_OPT_RET_OK
:
664 status
= ARGPAR_ITER_NEXT_STATUS_OK
;
666 case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
:
667 case PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG
:
668 case PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG
:
669 try_prepend_while_parsing_arg_to_error(error
, iter
->i
,
672 switch (parse_orig_arg_opt_ret
) {
673 case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
:
674 status
= ARGPAR_ITER_NEXT_STATUS_ERROR_UNKNOWN_OPT
;
676 case PARSE_ORIG_ARG_OPT_RET_ERROR_MISSING_OPT_ARG
:
677 status
= ARGPAR_ITER_NEXT_STATUS_ERROR_MISSING_OPT_ARG
;
679 case PARSE_ORIG_ARG_OPT_RET_ERROR_UNEXPECTED_OPT_ARG
:
680 status
= ARGPAR_ITER_NEXT_STATUS_ERROR_UNEXPECTED_OPT_ARG
;
687 case PARSE_ORIG_ARG_OPT_RET_ERROR_MEMORY
:
688 status
= ARGPAR_ITER_NEXT_STATUS_ERROR_MEMORY
;
699 unsigned int argpar_iter_ingested_orig_args(
700 const struct argpar_iter
* const iter
)