parse-options already knows how to read into a string_list, and it knows
how to read into an strvec as a passthrough (that is, including the
argument as well as its value). string_list and strvec serve similar
purposes but are somewhat painful to convert between; so, let's teach
parse-options to read values of string arguments directly into an
strvec without preserving the argument name.
This is useful if collecting generic arguments to pass through to
another command, for example, 'git hook run --arg "--quiet" --arg
"--format=pretty" some-hook'. The resulting strvec would contain
{ "--quiet", "--format=pretty" }.
The implementation is based on that of OPT_STRING_LIST.
Signed-off-by: Emily Shaffer <emilyshaffer@xxxxxxxxxx>
---
Notes:
Since v7, updated the reference doc to make the intended usage for OPT_STRVEC
more clear.
Since v4, fixed one or two more places where I missed the argv_array->strvec
rename.
Documentation/technical/api-parse-options.txt | 7 +++++
parse-options-cb.c | 16 +++++++++++
parse-options.h | 4 +++
t/helper/test-parse-options.c | 6 +++++
t/t0040-parse-options.sh | 27 +++++++++++++++++++
5 files changed, 60 insertions(+)
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 5a60bbfa7f..f79b17e7fc 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -173,6 +173,13 @@ There are some macros to easily define options:
The string argument is stored as an element in `string_list`.
Use of `--no-option` will clear the list of preceding values.
+`OPT_STRVEC(short, long, &struct strvec, arg_str, description)`::
+ Introduce an option with a string argument, meant to be specified
+ multiple times.
+ The string argument is stored as an element in `strvec`, and later
+ arguments are added to the same `strvec`.
+ Use of `--no-option` will clear the list of preceding values.
+
`OPT_INTEGER(short, long, &int_var, description)`::
Introduce an option with integer argument.
The integer is put into `int_var`.
diff --git a/parse-options-cb.c b/parse-options-cb.c
index 3c811e1e4a..8227499eb6 100644
--- a/parse-options-cb.c
+++ b/parse-options-cb.c
@@ -207,6 +207,22 @@ int parse_opt_string_list(const struct option *opt, const char *arg, int unset)
return 0;
}
+int parse_opt_strvec(const struct option *opt, const char *arg, int unset)
+{
+ struct strvec *v = opt->value;
+
+ if (unset) {
+ strvec_clear(v);
+ return 0;
+ }
+
+ if (!arg)
+ return -1;
+
+ strvec_push(v, arg);
+ return 0;
+}
+
int parse_opt_noop_cb(const struct option *opt, const char *arg, int unset)
{
return 0;
diff --git a/parse-options.h b/parse-options.h
index a845a9d952..fcb0f1f31e 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -178,6 +178,9 @@ struct option {
#define OPT_STRING_LIST(s, l, v, a, h) \
{ OPTION_CALLBACK, (s), (l), (v), (a), \
(h), 0, &parse_opt_string_list }
+#define OPT_STRVEC(s, l, v, a, h) \
+ { OPTION_CALLBACK, (s), (l), (v), (a), \
+ (h), 0, &parse_opt_strvec }
#define OPT_UYN(s, l, v, h) { OPTION_CALLBACK, (s), (l), (v), NULL, \
(h), PARSE_OPT_NOARG, &parse_opt_tertiary }
#define OPT_EXPIRY_DATE(s, l, v, h) \
@@ -297,6 +300,7 @@ int parse_opt_commits(const struct option *, const char *, int);
int parse_opt_commit(const struct option *, const char *, int);
int parse_opt_tertiary(const struct option *, const char *, int);
int parse_opt_string_list(const struct option *, const char *, int);
+int parse_opt_strvec(const struct option *, const char *, int);
int parse_opt_noop_cb(const struct option *, const char *, int);
enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
const struct option *,
diff --git a/t/helper/test-parse-options.c b/t/helper/test-parse-options.c
index 2051ce57db..922af56156 100644
--- a/t/helper/test-parse-options.c
+++ b/t/helper/test-parse-options.c
@@ -2,6 +2,7 @@
#include "cache.h"
#include "parse-options.h"
#include "string-list.h"
+#include "strvec.h"
#include "trace2.h"
static int boolean = 0;
@@ -15,6 +16,7 @@ static char *string = NULL;
static char *file = NULL;
static int ambiguous;
static struct string_list list = STRING_LIST_INIT_NODUP;
+static struct strvec vector = STRVEC_INIT;
static struct {
int called;
@@ -133,6 +135,7 @@ int cmd__parse_options(int argc, const char **argv)
OPT_STRING('o', NULL, &string, "str", "get another string"),
OPT_NOOP_NOARG(0, "obsolete"),
OPT_STRING_LIST(0, "list", &list, "str", "add str to list"),
+ OPT_STRVEC(0, "vector", &vector, "str", "add str to strvec"),
OPT_GROUP("Magic arguments"),
OPT_ARGUMENT("quux", NULL, "means --quux"),
OPT_NUMBER_CALLBACK(&integer, "set integer to NUM",
@@ -183,6 +186,9 @@ int cmd__parse_options(int argc, const char **argv)
for (i = 0; i < list.nr; i++)
show(&expect, &ret, "list: %s", list.items[i].string);
+ for (i = 0; i < vector.nr; i++)
+ show(&expect, &ret, "vector: %s", vector.v[i]);
+
for (i = 0; i < argc; i++)
show(&expect, &ret, "arg %02d: %s", i, argv[i]);
diff --git a/t/t0040-parse-options.sh b/t/t0040-parse-options.sh
index ad4746d899..485e0170bf 100755
--- a/t/t0040-parse-options.sh
+++ b/t/t0040-parse-options.sh
@@ -35,6 +35,7 @@ String options
--st <st> get another string (pervert ordering)
-o <str> get another string
--list <str> add str to list
+ --vector <str> add str to strvec
Magic arguments
--quux means --quux
@@ -386,6 +387,32 @@ test_expect_success '--no-list resets list' '
test_cmp expect output
'
+cat >expect <<\EOF
+boolean: 0
+integer: 0
+magnitude: 0
+timestamp: 0
+string: (not set)
+abbrev: 7
+verbose: -1
+quiet: 0
+dry run: no
+file: (not set)
+vector: foo
+vector: bar
+vector: baz
+EOF
+test_expect_success '--vector keeps list of strings' '
+ test-tool parse-options --vector foo --vector=bar --vector=baz >output &&
+ test_cmp expect output
+'
+
+test_expect_success '--no-vector resets list' '
+ test-tool parse-options --vector=other --vector=irrelevant --vector=options \
+ --no-vector --vector=foo --vector=bar --vector=baz >output &&
+ test_cmp expect output
+'
+
test_expect_success 'multiple quiet levels' '
test-tool parse-options --expect="quiet: 3" -q -q -q
'
--
2.31.1.818.g46aad6cb9e-goog
