2 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 #define argpar_realloc(_ptr, _type, _nmemb) ((_type *) realloc(_ptr, (_nmemb) * sizeof(_type)))
33 #define argpar_calloc(_type, _nmemb) ((_type *) calloc((_nmemb), sizeof(_type)))
34 #define argpar_zalloc(_type) argpar_calloc(_type, 1)
36 #define ARGPAR_ASSERT(_cond) assert(_cond)
39 char *argpar_vasprintf(const char *fmt
, va_list args
)
47 len1
= vsnprintf(NULL
, 0, fmt
, args
);
53 str
= malloc(len1
+ 1);
58 len2
= vsnprintf(str
, len1
+ 1, fmt
, args2
);
60 ARGPAR_ASSERT(len1
== len2
);
69 char *argpar_asprintf(const char *fmt
, ...)
75 str
= argpar_vasprintf(fmt
, args
);
82 bool argpar_string_append_printf(char **str
, const char *fmt
, ...)
92 addendum
= argpar_vasprintf(fmt
, args
);
100 new_str
= argpar_asprintf("%s%s", *str
? *str
: "", addendum
);
118 void destroy_item(struct argpar_item
* const item
)
124 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
125 struct argpar_item_opt
* const opt_item
= (void *) item
;
127 free((void *) opt_item
->arg
);
137 bool push_item(struct argpar_item_array
* const array
,
138 struct argpar_item
* const item
)
142 ARGPAR_ASSERT(array
);
145 if (array
->n_items
== array
->n_alloc
) {
146 unsigned int new_n_alloc
= array
->n_alloc
* 2;
147 struct argpar_item
**new_items
;
149 new_items
= argpar_realloc(array
->items
,
150 struct argpar_item
*, new_n_alloc
);
156 array
->n_alloc
= new_n_alloc
;
157 array
->items
= new_items
;
160 array
->items
[array
->n_items
] = item
;
170 void destroy_item_array(struct argpar_item_array
* const array
)
175 for (i
= 0; i
< array
->n_items
; i
++) {
176 destroy_item(array
->items
[i
]);
185 struct argpar_item_array
*new_item_array(void)
187 struct argpar_item_array
*ret
;
188 const int initial_size
= 10;
190 ret
= argpar_zalloc(struct argpar_item_array
);
195 ret
->items
= argpar_calloc(struct argpar_item
*, initial_size
);
200 ret
->n_alloc
= initial_size
;
205 destroy_item_array(ret
);
213 struct argpar_item_opt
*create_opt_item(
214 const struct argpar_opt_descr
* const descr
,
215 const char * const arg
)
217 struct argpar_item_opt
*opt_item
=
218 argpar_zalloc(struct argpar_item_opt
);
224 opt_item
->base
.type
= ARGPAR_ITEM_TYPE_OPT
;
225 opt_item
->descr
= descr
;
228 opt_item
->arg
= strdup(arg
);
229 if (!opt_item
->arg
) {
237 destroy_item(&opt_item
->base
);
245 struct argpar_item_non_opt
*create_non_opt_item(const char * const arg
,
246 const unsigned int orig_index
,
247 const unsigned int non_opt_index
)
249 struct argpar_item_non_opt
* const non_opt_item
=
250 argpar_zalloc(struct argpar_item_non_opt
);
256 non_opt_item
->base
.type
= ARGPAR_ITEM_TYPE_NON_OPT
;
257 non_opt_item
->arg
= arg
;
258 non_opt_item
->orig_index
= orig_index
;
259 non_opt_item
->non_opt_index
= non_opt_index
;
266 const struct argpar_opt_descr
*find_descr(
267 const struct argpar_opt_descr
* const descrs
,
268 const char short_name
, const char * const long_name
)
270 const struct argpar_opt_descr
*descr
;
272 for (descr
= descrs
; descr
->short_name
|| descr
->long_name
; descr
++) {
273 if (short_name
&& descr
->short_name
&&
274 short_name
== descr
->short_name
) {
278 if (long_name
&& descr
->long_name
&&
279 strcmp(long_name
, descr
->long_name
) == 0) {
285 return !descr
->short_name
&& !descr
->long_name
? NULL
: descr
;
288 enum parse_orig_arg_opt_ret
{
289 PARSE_ORIG_ARG_OPT_RET_OK
,
290 PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
= -2,
291 PARSE_ORIG_ARG_OPT_RET_ERROR
= -1,
295 enum parse_orig_arg_opt_ret
parse_short_opts(const char * const short_opts
,
296 const char * const next_orig_arg
,
297 const struct argpar_opt_descr
* const descrs
,
298 struct argpar_parse_ret
* const parse_ret
,
299 bool * const used_next_orig_arg
)
301 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
302 const char *short_opt_ch
= short_opts
;
304 if (strlen(short_opts
) == 0) {
305 argpar_string_append_printf(&parse_ret
->error
, "Invalid argument");
309 while (*short_opt_ch
) {
310 const char *opt_arg
= NULL
;
311 const struct argpar_opt_descr
*descr
;
312 struct argpar_item_opt
*opt_item
;
314 /* Find corresponding option descriptor */
315 descr
= find_descr(descrs
, *short_opt_ch
, NULL
);
317 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
;
318 argpar_string_append_printf(&parse_ret
->error
,
319 "Unknown option `-%c`", *short_opt_ch
);
323 if (descr
->with_arg
) {
324 if (short_opt_ch
[1]) {
326 opt_arg
= &short_opt_ch
[1];
329 opt_arg
= next_orig_arg
;
330 *used_next_orig_arg
= true;
334 * We accept `-o ''` (empty option's argument),
335 * but not `-o` alone if an option's argument is
338 if (!opt_arg
|| (short_opt_ch
[1] && strlen(opt_arg
) == 0)) {
339 argpar_string_append_printf(&parse_ret
->error
,
340 "Missing required argument for option `-%c`",
342 *used_next_orig_arg
= false;
347 /* Create and append option argument */
348 opt_item
= create_opt_item(descr
, opt_arg
);
353 if (!push_item(parse_ret
->items
, &opt_item
->base
)) {
357 if (descr
->with_arg
) {
358 /* Option has an argument: no more options */
362 /* Go to next short option */
369 if (ret
== PARSE_ORIG_ARG_OPT_RET_OK
) {
370 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR
;
378 enum parse_orig_arg_opt_ret
parse_long_opt(const char * const long_opt_arg
,
379 const char * const next_orig_arg
,
380 const struct argpar_opt_descr
* const descrs
,
381 struct argpar_parse_ret
* const parse_ret
,
382 bool * const used_next_orig_arg
)
384 const size_t max_len
= 127;
385 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
386 const struct argpar_opt_descr
*descr
;
387 struct argpar_item_opt
*opt_item
;
389 /* Option's argument, if any */
390 const char *opt_arg
= NULL
;
392 /* Position of first `=`, if any */
395 /* Buffer holding option name when `long_opt_arg` contains `=` */
396 char buf
[max_len
+ 1];
399 const char *long_opt_name
= long_opt_arg
;
401 if (strlen(long_opt_arg
) == 0) {
402 argpar_string_append_printf(&parse_ret
->error
,
407 /* Find the first `=` in original argument */
408 eq_pos
= strchr(long_opt_arg
, '=');
410 const size_t long_opt_name_size
= eq_pos
- long_opt_arg
;
412 /* Isolate the option name */
413 if (long_opt_name_size
> max_len
) {
414 argpar_string_append_printf(&parse_ret
->error
,
415 "Invalid argument `--%s`", long_opt_arg
);
419 memcpy(buf
, long_opt_arg
, long_opt_name_size
);
420 buf
[long_opt_name_size
] = '\0';
424 /* Find corresponding option descriptor */
425 descr
= find_descr(descrs
, '\0', long_opt_name
);
427 argpar_string_append_printf(&parse_ret
->error
,
428 "Unknown option `--%s`", long_opt_name
);
429 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
;
433 /* Find option's argument if any */
434 if (descr
->with_arg
) {
436 /* `--long-opt=arg` style */
437 opt_arg
= eq_pos
+ 1;
439 /* `--long-opt arg` style */
440 if (!next_orig_arg
) {
441 argpar_string_append_printf(&parse_ret
->error
,
442 "Missing required argument for option `--%s`",
447 opt_arg
= next_orig_arg
;
448 *used_next_orig_arg
= true;
452 /* Create and append option argument */
453 opt_item
= create_opt_item(descr
, opt_arg
);
458 if (!push_item(parse_ret
->items
, &opt_item
->base
)) {
465 if (ret
== PARSE_ORIG_ARG_OPT_RET_OK
) {
466 ret
= PARSE_ORIG_ARG_OPT_RET_ERROR
;
474 enum parse_orig_arg_opt_ret
parse_orig_arg_opt(const char * const orig_arg
,
475 const char * const next_orig_arg
,
476 const struct argpar_opt_descr
* const descrs
,
477 struct argpar_parse_ret
* const parse_ret
,
478 bool * const used_next_orig_arg
)
480 enum parse_orig_arg_opt_ret ret
= PARSE_ORIG_ARG_OPT_RET_OK
;
482 ARGPAR_ASSERT(orig_arg
[0] == '-');
484 if (orig_arg
[1] == '-') {
486 ret
= parse_long_opt(&orig_arg
[2],
487 next_orig_arg
, descrs
, parse_ret
,
491 ret
= parse_short_opts(&orig_arg
[1],
492 next_orig_arg
, descrs
, parse_ret
,
500 bool prepend_while_parsing_arg_to_error(char **error
,
501 const unsigned int i
, const char * const arg
)
506 ARGPAR_ASSERT(error
);
507 ARGPAR_ASSERT(*error
);
509 new_error
= argpar_asprintf("While parsing argument #%u (`%s`): %s",
525 struct argpar_parse_ret
argpar_parse(unsigned int argc
,
526 const char * const *argv
,
527 const struct argpar_opt_descr
* const descrs
,
528 bool fail_on_unknown_opt
)
530 struct argpar_parse_ret parse_ret
= { 0 };
532 unsigned int non_opt_index
= 0;
534 parse_ret
.items
= new_item_array();
535 if (!parse_ret
.items
) {
539 for (i
= 0; i
< argc
; i
++) {
540 enum parse_orig_arg_opt_ret parse_orig_arg_opt_ret
;
541 bool used_next_orig_arg
= false;
542 const char * const orig_arg
= argv
[i
];
543 const char * const next_orig_arg
=
544 i
< argc
- 1 ? argv
[i
+ 1] : NULL
;
546 if (orig_arg
[0] != '-') {
547 /* Non-option argument */
548 struct argpar_item_non_opt
*non_opt_item
=
549 create_non_opt_item(orig_arg
, i
, non_opt_index
);
557 if (!push_item(parse_ret
.items
, &non_opt_item
->base
)) {
564 /* Option argument */
565 parse_orig_arg_opt_ret
= parse_orig_arg_opt(orig_arg
,
566 next_orig_arg
, descrs
, &parse_ret
, &used_next_orig_arg
);
567 switch (parse_orig_arg_opt_ret
) {
568 case PARSE_ORIG_ARG_OPT_RET_OK
:
570 case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT
:
571 ARGPAR_ASSERT(!used_next_orig_arg
);
573 if (fail_on_unknown_opt
) {
574 prepend_while_parsing_arg_to_error(
575 &parse_ret
.error
, i
, orig_arg
);
580 * The current original argument is not
581 * considered ingested because it triggered an
584 parse_ret
.ingested_orig_args
= i
;
585 free(parse_ret
.error
);
586 parse_ret
.error
= NULL
;
588 case PARSE_ORIG_ARG_OPT_RET_ERROR
:
589 prepend_while_parsing_arg_to_error(
590 &parse_ret
.error
, i
, orig_arg
);
596 if (used_next_orig_arg
) {
601 parse_ret
.ingested_orig_args
= argc
;
602 free(parse_ret
.error
);
603 parse_ret
.error
= NULL
;
607 /* That's how we indicate that an error occured */
608 destroy_item_array(parse_ret
.items
);
609 parse_ret
.items
= NULL
;
616 void argpar_parse_ret_fini(struct argpar_parse_ret
*ret
)
620 destroy_item_array(ret
->items
);