^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) #ifndef __SUBCMD_PARSE_OPTIONS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) #define __SUBCMD_PARSE_OPTIONS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) #include <stdbool.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #include <stdint.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #ifndef NORETURN
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #define NORETURN __attribute__((__noreturn__))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) enum parse_opt_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) /* special types */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) OPTION_END,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) OPTION_ARGUMENT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) OPTION_GROUP,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /* options with no arguments */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) OPTION_BIT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) OPTION_BOOLEAN,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) OPTION_INCR,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) OPTION_SET_UINT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) OPTION_SET_PTR,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) /* options with arguments (usually) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) OPTION_STRING,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) OPTION_INTEGER,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) OPTION_LONG,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) OPTION_ULONG,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) OPTION_CALLBACK,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) OPTION_U64,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) OPTION_UINTEGER,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) enum parse_opt_flags {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) PARSE_OPT_KEEP_DASHDASH = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) PARSE_OPT_STOP_AT_NON_OPTION = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) PARSE_OPT_KEEP_ARGV0 = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) PARSE_OPT_KEEP_UNKNOWN = 8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) PARSE_OPT_NO_INTERNAL_HELP = 16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) enum parse_opt_option_flags {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) PARSE_OPT_OPTARG = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) PARSE_OPT_NOARG = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) PARSE_OPT_NONEG = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) PARSE_OPT_HIDDEN = 8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) PARSE_OPT_LASTARG_DEFAULT = 16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) PARSE_OPT_DISABLED = 32,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) PARSE_OPT_EXCLUSIVE = 64,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) PARSE_OPT_NOEMPTY = 128,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) PARSE_OPT_NOBUILD = 256,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) PARSE_OPT_CANSKIP = 512,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) struct option;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) * `type`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * holds the type of the option, you must have an OPTION_END last in your
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) * array.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * `short_name`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) * the character to use as a short option name, '\0' if none.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) * `long_name`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * the long option name, without the leading dashes, NULL if none.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * `value`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * stores pointers to the values to be filled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * `argh`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * token to explain the kind of argument this option wants. Keep it
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * homogeneous across the repository.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * `help`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * the short help associated to what the option does.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * Must never be NULL (except for OPTION_END).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * OPTION_GROUP uses this pointer to store the group header.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) * `flags`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) * mask of parse_opt_option_flags.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) * PARSE_OPT_OPTARG: says that the argument is optional (not for BOOLEANs)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) * PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * PARSE_OPT_NONEG: says that this option cannot be negated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) * the long one.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) * `callback`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) * pointer to the callback to use for OPTION_CALLBACK.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) * `defval`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * default value to fill (*->value) with for PARSE_OPT_OPTARG.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) * OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * the value when met.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * CALLBACKS can use it like they want.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) * `set`::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) * whether an option was set by the user
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) struct option {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) enum parse_opt_type type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) int short_name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) const char *long_name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) void *value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) const char *argh;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) const char *help;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) const char *build_opt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) int flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) parse_opt_cb *callback;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) intptr_t defval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) bool *set;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) void *data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) const struct option *parent;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define OPT_END() { .type = OPTION_END }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define OPT_PARENT(p) { .type = OPTION_END, .parent = (p) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define OPT_ARGUMENT(l, h) { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define OPT_GROUP(h) { .type = OPTION_GROUP, .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define OPT_BIT(s, l, v, h, b) { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h), .defval = (b) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) #define OPT_BOOLEAN(s, l, v, h) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) #define OPT_BOOLEAN_FLAG(s, l, v, h, f) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h), .flags = (f) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define OPT_BOOLEAN_SET(s, l, v, os, h) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) .value = check_vtype(v, bool *), .help = (h), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) .set = check_vtype(os, bool *)}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define OPT_INCR(s, l, v, h) { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) #define OPT_SET_UINT(s, l, v, h, i) { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h), .defval = (i) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define OPT_SET_PTR(s, l, v, h, p) { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) #define OPT_INTEGER(s, l, v, h) { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) #define OPT_UINTEGER(s, l, v, h) { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #define OPT_LONG(s, l, v, h) { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) #define OPT_ULONG(s, l, v, h) { .type = OPTION_ULONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned long *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) #define OPT_U64(s, l, v, h) { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #define OPT_STRING(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) #define OPT_STRING_OPTARG(s, l, v, a, h, d) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) .value = check_vtype(v, const char **), .argh =(a), .help = (h), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) #define OPT_STRING_OPTARG_SET(s, l, v, os, a, h, d) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) .value = check_vtype(v, const char **), .argh = (a), .help = (h), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) .flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) .set = check_vtype(os, bool *)}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) #define OPT_STRING_NOEMPTY(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h), .flags = PARSE_OPT_NOEMPTY}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) #define OPT_DATE(s, l, v, h) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) #define OPT_CALLBACK(s, l, v, a, h, f) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) #define OPT_CALLBACK_SET(s, l, v, os, a, h, f) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .set = check_vtype(os, bool *)}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) .value = (v), .arg = (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) .flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) #define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) { .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) .value = (v), .argh = (a), .help = (h), .callback = (f), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) .flags = PARSE_OPT_OPTARG, .data = (d) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) /* parse_options() will filter out the processed options and leave the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) * non-option argments in argv[].
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) * Returns the number of arguments left in argv[].
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) * NOTE: parse_options() and parse_options_subcommand() may call exit() in the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) * case of an error (or for 'special' options like --list-cmds or --list-opts).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) extern int parse_options(int argc, const char **argv,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) const struct option *options,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) const char * const usagestr[], int flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) extern int parse_options_subcommand(int argc, const char **argv,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) const struct option *options,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) const char *const subcommands[],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) const char *usagestr[], int flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) extern NORETURN void usage_with_options(const char * const *usagestr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) const struct option *options);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) extern NORETURN __attribute__((format(printf,3,4)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) void usage_with_options_msg(const char * const *usagestr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) const struct option *options,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) const char *fmt, ...);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) /*----- incremantal advanced APIs -----*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) PARSE_OPT_HELP = -1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) PARSE_OPT_DONE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) PARSE_OPT_LIST_OPTS,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) PARSE_OPT_LIST_SUBCMDS,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) PARSE_OPT_UNKNOWN,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) * It's okay for the caller to consume argv/argc in the usual way.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) * Other fields of that structure are private to parse-options and should not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) * be modified in any way.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) struct parse_opt_ctx_t {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) const char **argv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) const char **out;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) int argc, cpidx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) const char *opt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) const struct option *excl_opt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) int flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) extern int parse_options_usage(const char * const *usagestr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) const struct option *opts,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) const char *optstr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) bool short_opt);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) /*----- some often used options -----*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) #define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) #define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) #define OPT__VERBOSITY(var) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) { OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) #define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) #define OPT__ABBREV(var) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) "use <n> digits to display SHA-1s", \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) extern const char *parse_options_fix_filename(const char *prefix, const char *file);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) const char *build_opt, bool can_skip);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) #endif /* __SUBCMD_PARSE_OPTIONS_H */
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags