Fail on INDICATE_SUPPLIED of non-optional args and incr/repeat/action

Author: kstrafe

src/collectors.m4

@@ -163,6 +163,11 @@ m4_define([__ADD_OPTIONAL_ARGUMENT], [m4_do(
 	[_FILL_IN_VALUES_FOR_AN_OPTIONAL_ARGUMENT([$1], [$3], _arg_varname, [$5], [$2], [$4])],
 	[m4_popdef([_arg_varname])],
 	[m4_define([_DISTINCT_OPTIONAL_ARGS_COUNT], m4_incr(_DISTINCT_OPTIONAL_ARGS_COUNT))],
+	[m4_case([$5],
+		[arg], [m4_set_add([_ALL_OPTIONAL_ARGUMENTS], [$1])],
+		[bool], [m4_set_add([_ALL_OPTIONAL_ARGUMENTS], [$1])],
+		[dnl]
+	)],
 )])
 
 
@@ -525,9 +530,10 @@ m4_define([_ARG_POSITIONAL_DOUBLEDASH], [m4_do(
 )])
 
 
-argbash_api([ARGBASH_INDICATE_SUPPLIED], [m4_do(
+argbash_api([ARGBASH_INDICATE_SUPPLIED], _CHECK_PASSED_ARGS_COUNT(1)[m4_do(
 	[[$0($@)]],
 	[m4_set_add_all([HAVE_SUPPLIED], $@)],
+	[CHECK_SUPPLIED_ARE_OPTIONAL([HAVE_SUPPLIED], [_ALL_OPTIONAL_ARGUMENTS], [FATAL_NON_OPTIONAL_SUPPLIED])],
 )])
 
 

src/utilities.m4

@@ -340,3 +340,20 @@ m4_define([UNDERLINE], [m4_do(
 	[m4_if(m4_len([$1]), 0, ,
 		[m4_for(idx, 1, m4_len([$1]), 1, [$2])])],
 )])
+
+
+dnl
+dnl $1: Set of arguments marked as supplied
+dnl $2: Set of all optional arguments
+dnl $3: Macro that gets called with the supplied arguments that are not optional, if any.
+m4_define([CHECK_SUPPLIED_ARE_OPTIONAL], [m4_do(
+	[m4_set_add_all([_temp_supplied_not_optional]m4_set_difference([$1], [$2]))],
+	[m4_if(m4_set_size([_temp_supplied_not_optional]), 0,
+		[],
+		[$3([_temp_supplied_not_optional])])],
+	[m4_set_delete([_temp_set_supplied])],
+)])
+
+
+m4_define([FATAL_NON_OPTIONAL_SUPPLIED],
+    [m4_fatal([ARGBASH_INDICATE_SUPPLIED: The following arguments are not optional:] m4_set_dump([$1], [, ]))])

tests/regressiontests/Makefile

@@ -126,6 +126,7 @@ TESTS_GEN += \
 	gen-test-bool-default \
 	gen-test-pos-opt \
 	gen-test-pos-opt2 \
+	gen-test-supplied-non-optional \
 	gen-test-more \
 	gen-test-illegal-pos \
 	gen-test-illegal-opt \
@@ -561,6 +562,9 @@ gen-test-pos-opt: $(TESTDIR)/gen-test-pos-opt.m4 $(ARGBASH_BIN)
 gen-test-pos-opt2: $(TESTDIR)/gen-test-pos-opt2.m4 $(ARGBASH_BIN)
 	ERROR="same_arg" $(REVERSE) $(ARGBASH_EXEC) $< > /dev/null
 
+gen-test-supplied-non-optional: $(TESTDIR)/gen-test-supplied-non-optional.m4 $(ARGBASH_BIN)
+	ERROR="ARGBASH_INDICATE_SUPPLIED: The following arguments are not optional: phantom, pos-arg-inf, pos-arg-multi, pos-arg-single, opt-arg-action, opt-arg-incr, opt-arg-repeat" $(REVERSE) $(ARGBASH_EXEC) $< > /dev/null
+
 gen-test-more: $(TESTDIR)/gen-test-more.m4 $(ARGBASH_BIN)
 	ERROR="is unknown" $(REVERSE) $(ARGBASH_EXEC) $< > /dev/null
 

tests/regressiontests/gen-test-supplied-non-optional.m4

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# ARG_OPTIONAL_SINGLE([opt-arg-single])
+# ARG_OPTIONAL_BOOLEAN([opt-arg-bool])
+# ARG_OPTIONAL_REPEATED([opt-arg-repeat])
+# ARG_OPTIONAL_INCREMENTAL([opt-arg-incr])
+# ARG_OPTIONAL_ACTION([opt-arg-action])
+# ARG_POSITIONAL_SINGLE([pos-arg-single])
+# ARG_POSITIONAL_MULTI([pos-arg-multi], [], 3)
+# ARG_POSITIONAL_INF([pos-arg-inf])
+# ARGBASH_INDICATE_SUPPLIED([opt-arg-single], [opt-arg-bool], [opt-arg-repeat], [opt-arg-incr], [opt-arg-action], [pos-arg-single], [pos-arg-multi], [pos-arg-inf], [phantom])
+# ARGBASH_GO
+

tests/regressiontests/make/tests/tests-base.m4

@@ -329,6 +329,7 @@ ADD_GENTEST_BASH([infinity-illegal], [number of expected positional arguments be
 ADD_GENTEST_BASH([bool-default], ['on' or 'off' are allowed as boolean defaults])
 ADD_GENTEST_BASH([pos-opt], [same-arg])
 ADD_GENTEST_BASH([pos-opt2], [same_arg])
+ADD_GENTEST_BASH([supplied-non-optional], [ARGBASH_INDICATE_SUPPLIED: The following arguments are not optional: phantom, pos-arg-inf, pos-arg-multi, pos-arg-single, opt-arg-action, opt-arg-incr, opt-arg-repeat])
 ADD_GENTEST_BASH([more], [is unknown])
 ADD_GENTEST_BASH([illegal-pos], [contains forbidden characters])
 ADD_GENTEST_BASH([illegal-opt], [one character])

tests/unittests/check-utils.m4

@@ -144,3 +144,14 @@ assert_equals(_DEFAULT_IF_NARGS_GREATER_THAN(4, 4, [], foo), [foo])
 assert_equals(_DEFAULT_IF_NARGS_GREATER_THAN(4, 5, [], foo), [foo])
 assert_equals(_DEFAULT_IF_NARGS_GREATER_THAN(4, 5, [], [BOMB]), [BOMB])
 assert_equals(_DEFAULT_IF_NARGS_GREATER_THAN(4, 5, [BOMB], foo), [BOMB])
+
+m4_define([ON_NOT_OPTIONAL], [called:][m4_set_dump([$1], [,])])
+m4_set_add_all([X], [a], [b], [c])
+m4_set_add_all([Y], [b], [c], [d])
+assert_equals(CHECK_SUPPLIED_ARE_OPTIONAL([X], [X], [ON_NOT_OPTIONAL]), [])
+assert_equals(CHECK_SUPPLIED_ARE_OPTIONAL([X], [Y], [ON_NOT_OPTIONAL]), [called:a])
+assert_equals(CHECK_SUPPLIED_ARE_OPTIONAL([Y], [X], [ON_NOT_OPTIONAL]), [called:d])
+m4_set_add_all([Y], [x], [y], [z])
+assert_equals(CHECK_SUPPLIED_ARE_OPTIONAL([Y], [X], [ON_NOT_OPTIONAL]), [called:z,y,x,d])
+m4_set_delete([X])
+m4_set_delete([Y])