Commit | Line | Data |
---|---|---|
ea76a8bb SM |
1 | /* |
2 | * Copyright (C) 2021 Simon Marchi <simon.marchi@efficios.com> | |
3 | * | |
4 | * SPDX-License-Identifier: GPL-2.0-only | |
5 | * | |
6 | */ | |
7 | ||
8 | #ifndef COMMON_ARGPAR_UTILS_H | |
9 | #define COMMON_ARGPAR_UTILS_H | |
10 | ||
11 | #include <stdarg.h> | |
12 | ||
13 | #include <common/macros.h> | |
14 | #include <common/argpar/argpar.h> | |
15 | #include <common/string-utils/format.h> | |
16 | ||
9d28679a SM |
17 | #define WHILE_PARSING_ARG_N_ARG_FMT "While parsing argument #%d (`%s`): " |
18 | ||
ea76a8bb SM |
19 | enum parse_next_item_status |
20 | { | |
21 | PARSE_NEXT_ITEM_STATUS_OK = 0, | |
22 | PARSE_NEXT_ITEM_STATUS_END = 1, | |
23 | PARSE_NEXT_ITEM_STATUS_ERROR = -1, | |
24 | }; | |
25 | ||
26 | /* | |
27 | * Parse the next argpar item using `iter`. | |
28 | * | |
29 | * The item in `*item` is always freed and cleared on entry. | |
30 | * | |
31 | * If an item is parsed successfully, return the new item in `*item` and return | |
32 | * PARSE_NEXT_ITEM_STATUS_OK. | |
33 | * | |
34 | * If the end of the argument list is reached, return | |
35 | * PARSE_NEXT_ITEM_STATUS_END. | |
36 | * | |
37 | * On error, print a descriptive error message and return | |
38 | * PARSE_NEXT_ITEM_STATUS_ERROR. If `context_fmt` is non-NULL, it is formatted | |
39 | * using the following arguments and prepended to the error message. | |
5f5ce3e6 | 40 | * Add `argc_offset` to the argument index mentioned in the error message. |
ea76a8bb SM |
41 | * |
42 | * If `unknown_opt_is_error` is true, an unknown option is considered an error. | |
43 | * Otherwise, it is considered as the end of the argument list. | |
44 | */ | |
5f5ce3e6 | 45 | LTTNG_HIDDEN |
ea76a8bb | 46 | enum parse_next_item_status parse_next_item(struct argpar_iter *iter, |
5f5ce3e6 SM |
47 | const struct argpar_item **item, int argc_offset, |
48 | const char **argv, bool unknown_opt_is_error, | |
49 | const char *context_fmt, ...); | |
ea76a8bb SM |
50 | |
51 | #endif |