option-parser: Add repeating positional arguments

Author: any1

include/option-parser.h

@@ -27,6 +27,7 @@ struct wv_option {
 	const char* default_;
 	const char* positional;
 	bool is_subcommand;
+	bool is_repeating;
 };
 
 struct wv_option_value {
@@ -64,4 +65,7 @@ const char* option_parser_get_value(const struct option_parser* self,
 const char* option_parser_get_value_no_default(const struct option_parser* self,
 		const char* name);
 
+const char* option_parser_get_value_with_offset(const struct option_parser* self,
+		const char* name, int index);
+
 void option_parser_print_cmd_summary(const char* summary, FILE* stream);

src/option-parser.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Andri Yngvason
+ * Copyright (c) 2022 - 2024 Andri Yngvason
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -97,10 +97,15 @@ void option_parser_print_usage(struct option_parser* self, FILE* stream)
 	print_string_tolower(stream, self->name);
 	fprintf(stream, "]");
 	int optional_paren_count = 0;
+	int end = self->n_opts;
 	for (int i = 0; i < self->n_opts; ++i) {
 		const struct wv_option* opt = &self->options[i];
 		if (!opt->positional)
 			continue;
+		if (opt->is_repeating) {
+			end = i;
+			break;
+		}
 		const char* open = "<";
 		const char* close = ">";
 		if (opt->default_) {
@@ -116,6 +121,15 @@ void option_parser_print_usage(struct option_parser* self, FILE* stream)
 	}
 	for (int i = 0; i < optional_paren_count; ++i)
 		fprintf(stream, "]");
+
+	for (int i = end; i < self->n_opts; ++i) {
+		const struct wv_option* opt = &self->options[i];
+		if (!opt->positional)
+			continue;
+		assert(opt->is_repeating);
+
+		fprintf(stream, " [%s...]", opt->positional);
+	}
 }
 
 int option_parser_print_arguments(struct option_parser* self, FILE* stream)
@@ -301,7 +315,8 @@ static int parse_positional_arg(struct option_parser* self, char argc,
 	if (append_value(self, opt, argv[i]) < 0)
 		return -1;
 
-	self->position += 1;
+	if (!opt->is_repeating)
+		self->position += 1;
 
 	return opt->is_subcommand ? 0 : 1;
 }
@@ -394,6 +409,30 @@ const char* option_parser_get_value(const struct option_parser* self,
 	return NULL;
 }
 
+const char* option_parser_get_value_with_offset(const struct option_parser* self,
+		const char* name, int index)
+{
+	const struct wv_option* opt;
+
+	for (int i = 0; i < self->n_values; ++i) {
+		const struct wv_option_value* value = &self->values[i];
+		opt = value->option;
+
+		if (!opt->positional || !opt->is_repeating)
+			continue;
+
+		if (strcmp(opt->positional, name) != 0)
+			continue;
+
+		if (index-- > 0)
+			continue;
+
+		return value->value;
+	}
+
+	return NULL;
+}
+
 void option_parser_print_cmd_summary(const char* summary, FILE* stream)
 {
 	struct table_printer printer;

test/option-parser-test.c

@@ -289,6 +289,46 @@ static int test_defaults_overridden(void)
 	return 0;
 }
 
+static int test_repeating_positional_option(void)
+{
+	static const struct wv_option options[] = {
+		{ .positional = "first" },
+		{ .positional = "second", .is_repeating = true },
+		{ 'a', "option-a", NULL, "Description of a" },
+		{ },
+	};
+
+	struct option_parser parser;
+	option_parser_init(&parser, options);
+
+	const char* argv[] = {
+		"executable",
+		"non-repeating",
+		"one",
+		"-a",
+		"two",
+		"three",
+	};
+
+	ASSERT_INT_EQ(0, option_parser_parse(&parser, ARRAY_SIZE(argv), argv));
+
+	ASSERT_STR_EQ("non-repeating", option_parser_get_value(&parser,
+				"first"));
+	ASSERT_STR_EQ("one", option_parser_get_value_with_offset(&parser,
+				"second", 0));
+	ASSERT_STR_EQ("two", option_parser_get_value_with_offset(&parser,
+				"second", 1));
+	ASSERT_STR_EQ("three", option_parser_get_value_with_offset(&parser,
+				"second", 2));
+	ASSERT_FALSE(option_parser_get_value_with_offset(&parser, "second", 3));
+
+	ASSERT_TRUE(option_parser_get_value(&parser, "a"));
+
+	ASSERT_INT_EQ(0, parser.remaining_argc);
+
+	return 0;
+}
+
 int main()
 {
 	int r = 0;
@@ -310,5 +350,6 @@ int main()
 	RUN_TEST(test_subcommand_with_arguments);
 	RUN_TEST(test_defaults_not_set);
 	RUN_TEST(test_defaults_overridden);
+	RUN_TEST(test_repeating_positional_option);
 	return r;
 }