1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/kernel.h>
6 #include <stdbool.h>
7 #include <stdint.h>
60  *   the character to use as a short option name, '\0' if none.
89  *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
118 #define OPT_ARGUMENT(l, h)          { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }  argument
119 #define OPT_GROUP(h)                { .type = OPTION_GROUP, .help = (h) }  argument
120 …ne OPT_BIT(s, l, v, h, b)      { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value =…  argument
121 …PT_BOOLEAN(s, l, v, h)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value =…  argument
122 …EAN_FLAG(s, l, v, h, f)     { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value …  argument
123 #define OPT_BOOLEAN_SET(s, l, v, os, h) \  argument
125 	.value = check_vtype(v, bool *), .help = (h), \
127 …e OPT_INCR(s, l, v, h)        { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value =…  argument
128 …_UINT(s, l, v, h, i)  { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = che…  argument
129 #define OPT_SET_PTR(s, l, v, h, p)  { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), …  argument
130 …PT_INTEGER(s, l, v, h)     { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value =…  argument
131 …NTEGER(s, l, v, h)    { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = che…  argument
132 …ARG(s, l, v, d, h)    { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = che…  argument
133 …e OPT_LONG(s, l, v, h)        { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value =…  argument
134 …ULONG(s, l, v, h)        { .type = OPTION_ULONG, .short_name = (s), .long_name = (l), .value = che…  argument
135 …ne OPT_U64(s, l, v, h)         { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value =…  argument
136 …s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vty…  argument
137 #define OPT_STRING_OPTARG(s, l, v, a, h, d) \  argument
139 	  .value = check_vtype(v, const char **), .argh =(a), .help = (h), \
141 #define OPT_STRING_OPTARG_SET(s, l, v, os, a, h, d) \  argument
143 	  .value = check_vtype(v, const char **), .argh = (a), .help = (h), \
146 …s, l, v, a, h)   { .type = OPTION_STRING,  .short_name = (s), .long_name = (l), .value = check_vty…  argument
147 #define OPT_DATE(s, l, v, h) \  argument
148 ….short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_…
149 #define OPT_CALLBACK(s, l, v, a, h, f) \  argument
150 …ALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = …
151 #define OPT_CALLBACK_SET(s, l, v, os, a, h, f) \  argument
152 …ALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = …
153 #define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \  argument
154 …ALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = …
155 #define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \  argument
156 …ALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = …
157 #define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \  argument
159 	.value = (v), .arg = (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
161 #define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \  argument
163 	  .value = (v), .argh = (a), .help = (h), .callback = (f), \
167  * non-option argments in argv[].
171  * case of an error (or for 'special' options like --list-cmds or --list-opts).
189 /*----- incremantal advanced APIs -----*/
192 	PARSE_OPT_HELP = -1,
201  * Other fields of that structure are private to parse-options and should not
219 /*----- some often used options -----*/
231 #define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
234 	  "use <n> digits to display SHA-1s", \