Commit | Line | Data |
---|---|---|
fac21c87 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
fac21c87 | 3 | * |
0235b0db | 4 | * Copyright 2019 Philippe Proulx <pproulx@efficios.com> |
fac21c87 PP |
5 | */ |
6 | ||
65966041 SM |
7 | #include <assert.h> |
8 | #include <stdarg.h> | |
c4f23e30 | 9 | #include <stdbool.h> |
65966041 | 10 | #include <stdio.h> |
fac21c87 PP |
11 | #include <stdlib.h> |
12 | #include <string.h> | |
fac21c87 PP |
13 | |
14 | #include "argpar.h" | |
15 | ||
65966041 SM |
16 | #define argpar_realloc(_ptr, _type, _nmemb) ((_type *) realloc(_ptr, (_nmemb) * sizeof(_type))) |
17 | #define argpar_calloc(_type, _nmemb) ((_type *) calloc((_nmemb), sizeof(_type))) | |
18 | #define argpar_zalloc(_type) argpar_calloc(_type, 1) | |
19 | ||
20 | #define ARGPAR_ASSERT(_cond) assert(_cond) | |
21 | ||
8b305066 SM |
22 | #ifdef __MINGW_PRINTF_FORMAT |
23 | # define ARGPAR_PRINTF_FORMAT __MINGW_PRINTF_FORMAT | |
24 | #else | |
25 | # define ARGPAR_PRINTF_FORMAT printf | |
26 | #endif | |
27 | ||
28 | static __attribute__((format(ARGPAR_PRINTF_FORMAT, 1, 0))) | |
65966041 SM |
29 | char *argpar_vasprintf(const char *fmt, va_list args) |
30 | { | |
31 | int len1, len2; | |
32 | char *str; | |
33 | va_list args2; | |
34 | ||
35 | va_copy(args2, args); | |
36 | ||
37 | len1 = vsnprintf(NULL, 0, fmt, args); | |
38 | if (len1 < 0) { | |
39 | str = NULL; | |
40 | goto end; | |
41 | } | |
42 | ||
43 | str = malloc(len1 + 1); | |
44 | if (!str) { | |
45 | goto end; | |
46 | } | |
47 | ||
48 | len2 = vsnprintf(str, len1 + 1, fmt, args2); | |
49 | ||
50 | ARGPAR_ASSERT(len1 == len2); | |
51 | ||
52 | end: | |
1b8d11c4 | 53 | va_end(args2); |
65966041 SM |
54 | return str; |
55 | } | |
56 | ||
57 | ||
8b305066 | 58 | static __attribute__((format(ARGPAR_PRINTF_FORMAT, 1, 2))) |
65966041 SM |
59 | char *argpar_asprintf(const char *fmt, ...) |
60 | { | |
61 | va_list args; | |
62 | char *str; | |
63 | ||
64 | va_start(args, fmt); | |
65 | str = argpar_vasprintf(fmt, args); | |
66 | va_end(args); | |
67 | ||
68 | return str; | |
69 | } | |
70 | ||
8b305066 | 71 | static __attribute__((format(ARGPAR_PRINTF_FORMAT, 2, 3))) |
65966041 SM |
72 | bool argpar_string_append_printf(char **str, const char *fmt, ...) |
73 | { | |
74 | char *new_str = NULL; | |
75 | char *addendum; | |
76 | bool success; | |
77 | va_list args; | |
78 | ||
79 | ARGPAR_ASSERT(str); | |
80 | ||
81 | va_start(args, fmt); | |
82 | addendum = argpar_vasprintf(fmt, args); | |
83 | va_end(args); | |
84 | ||
85 | if (!addendum) { | |
86 | success = false; | |
87 | goto end; | |
88 | } | |
89 | ||
90 | new_str = argpar_asprintf("%s%s", *str ? *str : "", addendum); | |
91 | if (!new_str) { | |
92 | success = false; | |
93 | goto end; | |
94 | } | |
95 | ||
96 | free(*str); | |
97 | *str = new_str; | |
98 | ||
99 | success = true; | |
100 | ||
101 | end: | |
102 | free(addendum); | |
103 | ||
104 | return success; | |
105 | } | |
106 | ||
107 | static | |
108 | void destroy_item(struct argpar_item * const item) | |
fac21c87 PP |
109 | { |
110 | if (!item) { | |
111 | goto end; | |
112 | } | |
113 | ||
65966041 SM |
114 | if (item->type == ARGPAR_ITEM_TYPE_OPT) { |
115 | struct argpar_item_opt * const opt_item = (void *) item; | |
fac21c87 | 116 | |
65966041 | 117 | free((void *) opt_item->arg); |
fac21c87 PP |
118 | } |
119 | ||
65966041 | 120 | free(item); |
fac21c87 PP |
121 | |
122 | end: | |
123 | return; | |
124 | } | |
125 | ||
126 | static | |
65966041 SM |
127 | bool push_item(struct argpar_item_array * const array, |
128 | struct argpar_item * const item) | |
129 | { | |
130 | bool success; | |
131 | ||
132 | ARGPAR_ASSERT(array); | |
133 | ARGPAR_ASSERT(item); | |
134 | ||
135 | if (array->n_items == array->n_alloc) { | |
136 | unsigned int new_n_alloc = array->n_alloc * 2; | |
137 | struct argpar_item **new_items; | |
138 | ||
139 | new_items = argpar_realloc(array->items, | |
140 | struct argpar_item *, new_n_alloc); | |
141 | if (!new_items) { | |
142 | success = false; | |
143 | goto end; | |
144 | } | |
145 | ||
146 | array->n_alloc = new_n_alloc; | |
147 | array->items = new_items; | |
148 | } | |
149 | ||
150 | array->items[array->n_items] = item; | |
151 | array->n_items++; | |
152 | ||
153 | success = true; | |
154 | ||
155 | end: | |
156 | return success; | |
157 | } | |
158 | ||
159 | static | |
160 | void destroy_item_array(struct argpar_item_array * const array) | |
161 | { | |
162 | if (array) { | |
163 | unsigned int i; | |
164 | ||
165 | for (i = 0; i < array->n_items; i++) { | |
166 | destroy_item(array->items[i]); | |
167 | } | |
168 | ||
169 | free(array->items); | |
170 | free(array); | |
171 | } | |
172 | } | |
173 | ||
174 | static | |
175 | struct argpar_item_array *new_item_array(void) | |
176 | { | |
177 | struct argpar_item_array *ret; | |
178 | const int initial_size = 10; | |
179 | ||
180 | ret = argpar_zalloc(struct argpar_item_array); | |
181 | if (!ret) { | |
182 | goto end; | |
183 | } | |
184 | ||
185 | ret->items = argpar_calloc(struct argpar_item *, initial_size); | |
186 | if (!ret->items) { | |
187 | goto error; | |
188 | } | |
189 | ||
190 | ret->n_alloc = initial_size; | |
191 | ||
192 | goto end; | |
193 | ||
194 | error: | |
195 | destroy_item_array(ret); | |
196 | ret = NULL; | |
197 | ||
198 | end: | |
199 | return ret; | |
200 | } | |
201 | ||
202 | static | |
203 | struct argpar_item_opt *create_opt_item( | |
204 | const struct argpar_opt_descr * const descr, | |
fac21c87 PP |
205 | const char * const arg) |
206 | { | |
65966041 SM |
207 | struct argpar_item_opt *opt_item = |
208 | argpar_zalloc(struct argpar_item_opt); | |
fac21c87 PP |
209 | |
210 | if (!opt_item) { | |
211 | goto end; | |
212 | } | |
213 | ||
65966041 | 214 | opt_item->base.type = ARGPAR_ITEM_TYPE_OPT; |
fac21c87 PP |
215 | opt_item->descr = descr; |
216 | ||
217 | if (arg) { | |
65966041 | 218 | opt_item->arg = strdup(arg); |
2cdcf2d8 | 219 | if (!opt_item->arg) { |
fac21c87 PP |
220 | goto error; |
221 | } | |
222 | } | |
223 | ||
224 | goto end; | |
225 | ||
226 | error: | |
227 | destroy_item(&opt_item->base); | |
228 | opt_item = NULL; | |
229 | ||
230 | end: | |
231 | return opt_item; | |
232 | } | |
233 | ||
234 | static | |
65966041 | 235 | struct argpar_item_non_opt *create_non_opt_item(const char * const arg, |
fac21c87 PP |
236 | const unsigned int orig_index, |
237 | const unsigned int non_opt_index) | |
238 | { | |
65966041 SM |
239 | struct argpar_item_non_opt * const non_opt_item = |
240 | argpar_zalloc(struct argpar_item_non_opt); | |
fac21c87 PP |
241 | |
242 | if (!non_opt_item) { | |
243 | goto end; | |
244 | } | |
245 | ||
65966041 | 246 | non_opt_item->base.type = ARGPAR_ITEM_TYPE_NON_OPT; |
fac21c87 PP |
247 | non_opt_item->arg = arg; |
248 | non_opt_item->orig_index = orig_index; | |
249 | non_opt_item->non_opt_index = non_opt_index; | |
250 | ||
251 | end: | |
252 | return non_opt_item; | |
253 | } | |
254 | ||
255 | static | |
65966041 SM |
256 | const struct argpar_opt_descr *find_descr( |
257 | const struct argpar_opt_descr * const descrs, | |
fac21c87 PP |
258 | const char short_name, const char * const long_name) |
259 | { | |
65966041 | 260 | const struct argpar_opt_descr *descr; |
fac21c87 PP |
261 | |
262 | for (descr = descrs; descr->short_name || descr->long_name; descr++) { | |
263 | if (short_name && descr->short_name && | |
264 | short_name == descr->short_name) { | |
265 | goto end; | |
266 | } | |
267 | ||
268 | if (long_name && descr->long_name && | |
269 | strcmp(long_name, descr->long_name) == 0) { | |
270 | goto end; | |
271 | } | |
272 | } | |
273 | ||
274 | end: | |
275 | return !descr->short_name && !descr->long_name ? NULL : descr; | |
276 | } | |
277 | ||
278 | enum parse_orig_arg_opt_ret { | |
279 | PARSE_ORIG_ARG_OPT_RET_OK, | |
280 | PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT = -2, | |
281 | PARSE_ORIG_ARG_OPT_RET_ERROR = -1, | |
282 | }; | |
283 | ||
284 | static | |
285 | enum parse_orig_arg_opt_ret parse_short_opts(const char * const short_opts, | |
286 | const char * const next_orig_arg, | |
65966041 SM |
287 | const struct argpar_opt_descr * const descrs, |
288 | struct argpar_parse_ret * const parse_ret, | |
fac21c87 PP |
289 | bool * const used_next_orig_arg) |
290 | { | |
291 | enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK; | |
292 | const char *short_opt_ch = short_opts; | |
293 | ||
294 | if (strlen(short_opts) == 0) { | |
65966041 | 295 | argpar_string_append_printf(&parse_ret->error, "Invalid argument"); |
fac21c87 PP |
296 | goto error; |
297 | } | |
298 | ||
299 | while (*short_opt_ch) { | |
300 | const char *opt_arg = NULL; | |
65966041 SM |
301 | const struct argpar_opt_descr *descr; |
302 | struct argpar_item_opt *opt_item; | |
fac21c87 PP |
303 | |
304 | /* Find corresponding option descriptor */ | |
305 | descr = find_descr(descrs, *short_opt_ch, NULL); | |
306 | if (!descr) { | |
307 | ret = PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT; | |
65966041 | 308 | argpar_string_append_printf(&parse_ret->error, |
fac21c87 PP |
309 | "Unknown option `-%c`", *short_opt_ch); |
310 | goto error; | |
311 | } | |
312 | ||
313 | if (descr->with_arg) { | |
314 | if (short_opt_ch[1]) { | |
315 | /* `-oarg` form */ | |
316 | opt_arg = &short_opt_ch[1]; | |
317 | } else { | |
318 | /* `-o arg` form */ | |
319 | opt_arg = next_orig_arg; | |
320 | *used_next_orig_arg = true; | |
321 | } | |
322 | ||
323 | /* | |
324 | * We accept `-o ''` (empty option's argument), | |
325 | * but not `-o` alone if an option's argument is | |
326 | * expected. | |
327 | */ | |
328 | if (!opt_arg || (short_opt_ch[1] && strlen(opt_arg) == 0)) { | |
65966041 | 329 | argpar_string_append_printf(&parse_ret->error, |
fac21c87 PP |
330 | "Missing required argument for option `-%c`", |
331 | *short_opt_ch); | |
332 | *used_next_orig_arg = false; | |
333 | goto error; | |
334 | } | |
335 | } | |
336 | ||
337 | /* Create and append option argument */ | |
338 | opt_item = create_opt_item(descr, opt_arg); | |
339 | if (!opt_item) { | |
340 | goto error; | |
341 | } | |
342 | ||
65966041 SM |
343 | if (!push_item(parse_ret->items, &opt_item->base)) { |
344 | goto error; | |
345 | } | |
fac21c87 PP |
346 | |
347 | if (descr->with_arg) { | |
348 | /* Option has an argument: no more options */ | |
349 | break; | |
350 | } | |
351 | ||
352 | /* Go to next short option */ | |
353 | short_opt_ch++; | |
354 | } | |
355 | ||
356 | goto end; | |
357 | ||
358 | error: | |
359 | if (ret == PARSE_ORIG_ARG_OPT_RET_OK) { | |
360 | ret = PARSE_ORIG_ARG_OPT_RET_ERROR; | |
361 | } | |
362 | ||
363 | end: | |
364 | return ret; | |
365 | } | |
366 | ||
367 | static | |
368 | enum parse_orig_arg_opt_ret parse_long_opt(const char * const long_opt_arg, | |
369 | const char * const next_orig_arg, | |
65966041 SM |
370 | const struct argpar_opt_descr * const descrs, |
371 | struct argpar_parse_ret * const parse_ret, | |
fac21c87 PP |
372 | bool * const used_next_orig_arg) |
373 | { | |
374 | const size_t max_len = 127; | |
375 | enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK; | |
65966041 SM |
376 | const struct argpar_opt_descr *descr; |
377 | struct argpar_item_opt *opt_item; | |
fac21c87 PP |
378 | |
379 | /* Option's argument, if any */ | |
380 | const char *opt_arg = NULL; | |
381 | ||
382 | /* Position of first `=`, if any */ | |
383 | const char *eq_pos; | |
384 | ||
385 | /* Buffer holding option name when `long_opt_arg` contains `=` */ | |
386 | char buf[max_len + 1]; | |
387 | ||
388 | /* Option name */ | |
389 | const char *long_opt_name = long_opt_arg; | |
390 | ||
391 | if (strlen(long_opt_arg) == 0) { | |
65966041 SM |
392 | argpar_string_append_printf(&parse_ret->error, |
393 | "Invalid argument"); | |
fac21c87 PP |
394 | goto error; |
395 | } | |
396 | ||
397 | /* Find the first `=` in original argument */ | |
398 | eq_pos = strchr(long_opt_arg, '='); | |
399 | if (eq_pos) { | |
400 | const size_t long_opt_name_size = eq_pos - long_opt_arg; | |
401 | ||
402 | /* Isolate the option name */ | |
403 | if (long_opt_name_size > max_len) { | |
65966041 | 404 | argpar_string_append_printf(&parse_ret->error, |
fac21c87 PP |
405 | "Invalid argument `--%s`", long_opt_arg); |
406 | goto error; | |
407 | } | |
408 | ||
409 | memcpy(buf, long_opt_arg, long_opt_name_size); | |
410 | buf[long_opt_name_size] = '\0'; | |
411 | long_opt_name = buf; | |
412 | } | |
413 | ||
414 | /* Find corresponding option descriptor */ | |
415 | descr = find_descr(descrs, '\0', long_opt_name); | |
416 | if (!descr) { | |
65966041 | 417 | argpar_string_append_printf(&parse_ret->error, |
fac21c87 PP |
418 | "Unknown option `--%s`", long_opt_name); |
419 | ret = PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT; | |
420 | goto error; | |
421 | } | |
422 | ||
423 | /* Find option's argument if any */ | |
424 | if (descr->with_arg) { | |
425 | if (eq_pos) { | |
426 | /* `--long-opt=arg` style */ | |
427 | opt_arg = eq_pos + 1; | |
428 | } else { | |
429 | /* `--long-opt arg` style */ | |
430 | if (!next_orig_arg) { | |
65966041 | 431 | argpar_string_append_printf(&parse_ret->error, |
fac21c87 PP |
432 | "Missing required argument for option `--%s`", |
433 | long_opt_name); | |
434 | goto error; | |
435 | } | |
436 | ||
437 | opt_arg = next_orig_arg; | |
438 | *used_next_orig_arg = true; | |
439 | } | |
440 | } | |
441 | ||
442 | /* Create and append option argument */ | |
443 | opt_item = create_opt_item(descr, opt_arg); | |
444 | if (!opt_item) { | |
445 | goto error; | |
446 | } | |
447 | ||
65966041 SM |
448 | if (!push_item(parse_ret->items, &opt_item->base)) { |
449 | goto error; | |
450 | } | |
451 | ||
fac21c87 PP |
452 | goto end; |
453 | ||
454 | error: | |
455 | if (ret == PARSE_ORIG_ARG_OPT_RET_OK) { | |
456 | ret = PARSE_ORIG_ARG_OPT_RET_ERROR; | |
457 | } | |
458 | ||
459 | end: | |
460 | return ret; | |
461 | } | |
462 | ||
463 | static | |
464 | enum parse_orig_arg_opt_ret parse_orig_arg_opt(const char * const orig_arg, | |
465 | const char * const next_orig_arg, | |
65966041 SM |
466 | const struct argpar_opt_descr * const descrs, |
467 | struct argpar_parse_ret * const parse_ret, | |
fac21c87 PP |
468 | bool * const used_next_orig_arg) |
469 | { | |
470 | enum parse_orig_arg_opt_ret ret = PARSE_ORIG_ARG_OPT_RET_OK; | |
471 | ||
65966041 | 472 | ARGPAR_ASSERT(orig_arg[0] == '-'); |
fac21c87 PP |
473 | |
474 | if (orig_arg[1] == '-') { | |
475 | /* Long option */ | |
476 | ret = parse_long_opt(&orig_arg[2], | |
477 | next_orig_arg, descrs, parse_ret, | |
478 | used_next_orig_arg); | |
479 | } else { | |
480 | /* Short option */ | |
481 | ret = parse_short_opts(&orig_arg[1], | |
482 | next_orig_arg, descrs, parse_ret, | |
483 | used_next_orig_arg); | |
484 | } | |
485 | ||
486 | return ret; | |
487 | } | |
488 | ||
489 | static | |
65966041 | 490 | bool prepend_while_parsing_arg_to_error(char **error, |
fac21c87 PP |
491 | const unsigned int i, const char * const arg) |
492 | { | |
65966041 SM |
493 | char *new_error; |
494 | bool success; | |
fac21c87 | 495 | |
65966041 SM |
496 | ARGPAR_ASSERT(error); |
497 | ARGPAR_ASSERT(*error); | |
fac21c87 | 498 | |
65966041 SM |
499 | new_error = argpar_asprintf("While parsing argument #%u (`%s`): %s", |
500 | i + 1, arg, *error); | |
501 | if (!new_error) { | |
502 | success = false; | |
fac21c87 PP |
503 | goto end; |
504 | } | |
505 | ||
65966041 SM |
506 | free(*error); |
507 | *error = new_error; | |
508 | success = true; | |
fac21c87 PP |
509 | |
510 | end: | |
65966041 | 511 | return success; |
fac21c87 PP |
512 | } |
513 | ||
65966041 SM |
514 | ARGPAR_HIDDEN |
515 | struct argpar_parse_ret argpar_parse(unsigned int argc, | |
fac21c87 | 516 | const char * const *argv, |
65966041 | 517 | const struct argpar_opt_descr * const descrs, |
fac21c87 PP |
518 | bool fail_on_unknown_opt) |
519 | { | |
65966041 | 520 | struct argpar_parse_ret parse_ret = { 0 }; |
fac21c87 PP |
521 | unsigned int i; |
522 | unsigned int non_opt_index = 0; | |
523 | ||
65966041 | 524 | parse_ret.items = new_item_array(); |
fac21c87 PP |
525 | if (!parse_ret.items) { |
526 | goto error; | |
527 | } | |
528 | ||
529 | for (i = 0; i < argc; i++) { | |
530 | enum parse_orig_arg_opt_ret parse_orig_arg_opt_ret; | |
531 | bool used_next_orig_arg = false; | |
532 | const char * const orig_arg = argv[i]; | |
533 | const char * const next_orig_arg = | |
534 | i < argc - 1 ? argv[i + 1] : NULL; | |
535 | ||
536 | if (orig_arg[0] != '-') { | |
537 | /* Non-option argument */ | |
65966041 | 538 | struct argpar_item_non_opt *non_opt_item = |
fac21c87 PP |
539 | create_non_opt_item(orig_arg, i, non_opt_index); |
540 | ||
541 | if (!non_opt_item) { | |
542 | goto error; | |
543 | } | |
544 | ||
545 | non_opt_index++; | |
65966041 SM |
546 | |
547 | if (!push_item(parse_ret.items, &non_opt_item->base)) { | |
548 | goto error; | |
549 | } | |
550 | ||
fac21c87 PP |
551 | continue; |
552 | } | |
553 | ||
554 | /* Option argument */ | |
555 | parse_orig_arg_opt_ret = parse_orig_arg_opt(orig_arg, | |
556 | next_orig_arg, descrs, &parse_ret, &used_next_orig_arg); | |
557 | switch (parse_orig_arg_opt_ret) { | |
558 | case PARSE_ORIG_ARG_OPT_RET_OK: | |
559 | break; | |
560 | case PARSE_ORIG_ARG_OPT_RET_ERROR_UNKNOWN_OPT: | |
65966041 | 561 | ARGPAR_ASSERT(!used_next_orig_arg); |
fac21c87 PP |
562 | |
563 | if (fail_on_unknown_opt) { | |
564 | prepend_while_parsing_arg_to_error( | |
65966041 | 565 | &parse_ret.error, i, orig_arg); |
fac21c87 PP |
566 | goto error; |
567 | } | |
568 | ||
569 | /* | |
570 | * The current original argument is not | |
571 | * considered ingested because it triggered an | |
572 | * unknown option. | |
573 | */ | |
574 | parse_ret.ingested_orig_args = i; | |
65966041 | 575 | free(parse_ret.error); |
fac21c87 PP |
576 | parse_ret.error = NULL; |
577 | goto end; | |
578 | case PARSE_ORIG_ARG_OPT_RET_ERROR: | |
579 | prepend_while_parsing_arg_to_error( | |
65966041 | 580 | &parse_ret.error, i, orig_arg); |
fac21c87 PP |
581 | goto error; |
582 | default: | |
65966041 | 583 | abort(); |
fac21c87 PP |
584 | } |
585 | ||
586 | if (used_next_orig_arg) { | |
587 | i++; | |
588 | } | |
589 | } | |
590 | ||
591 | parse_ret.ingested_orig_args = argc; | |
65966041 | 592 | free(parse_ret.error); |
fac21c87 PP |
593 | parse_ret.error = NULL; |
594 | goto end; | |
595 | ||
596 | error: | |
118ae153 | 597 | /* That's how we indicate that an error occurred */ |
65966041 SM |
598 | destroy_item_array(parse_ret.items); |
599 | parse_ret.items = NULL; | |
fac21c87 PP |
600 | |
601 | end: | |
602 | return parse_ret; | |
603 | } | |
604 | ||
65966041 SM |
605 | ARGPAR_HIDDEN |
606 | void argpar_parse_ret_fini(struct argpar_parse_ret *ret) | |
fac21c87 | 607 | { |
65966041 | 608 | ARGPAR_ASSERT(ret); |
fac21c87 | 609 | |
65966041 SM |
610 | destroy_item_array(ret->items); |
611 | ret->items = NULL; | |
fac21c87 | 612 | |
65966041 SM |
613 | free(ret->error); |
614 | ret->error = NULL; | |
fac21c87 | 615 | } |