Allow multiple '-o' options

The values of the multiple '-o' options are joined together with a comma.

When parsing the joined option definition, allow multiple consecutive
commas as separator. This requires that a comma as option-char must be
escaped. Update man page and tutorial regarding characters, that need to
be escaped.

Author: rakus

.gitignore

@@ -4,3 +4,4 @@ target/
 *.add.spl
 *.profraw
 *.log
+.vscode/

CHANGELOG.md

@@ -14,7 +14,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### CHANGED
 
-* Generated code to test whether shell function exists.
+* Allow multiple '-o' / '--options' and join their values before parsing.
+
+* Simplify Generated code to test whether shell function exists.
 
 ## [0.1.0] - 2023-09-09
 

doc/parseargs.1.adoc

@@ -25,7 +25,7 @@ Typical usage in a script:
 == OPTIONS
 
 *-o, --options* OPTION-DEFINITION::
-Define the options supported by the shell script.
+Define the options supported by the shell script. Can be given multiple times.
 See <<OD,*OPTION DEFINITION*>> below.
 
 *-n, --name* NAME::
@@ -82,12 +82,13 @@ option-names::
 The option-names consist of one or more option chars or strings separated by colons.
 A single char defines an option that is given with one leading dash (e.g. `l` for `-l`). +
 Allowed option chars are all ASCII characters, except `-`, whitspace and control-characters.
-The following characters has to be escaped with a backslash in the definition: `#%+:=\`.
+The following characters has to be escaped with a backslash: `,#%+:=\`.
 Some of this characters need a backslash escape, when used on the command line.
 +
 A string defines a long option that is given with two leading dashes (e.g. `long` for `--long`).
 String may consist of any ASCII character, except `=`, whitespace and control characters.
 The minus (`-`) is allowed, as long it isn't the first character.
+The following characters has to be escaped with a backslash: `,#%+:\`.
 
 option-type::
 Following option types are supported:

doc/tutorial.adoc

@@ -78,7 +78,12 @@ Always use exactly this notation.
 A simple `$@` (without the quotes) or `$*` might fail.
 See your shell documentation.
 
-IMPORTANT: The option character may be any ASCII character, except for `-` (minus), whitespace or control character.
+[IMPORTANT]
+====
+The option character may be any ASCII character, except for `-` (minus), whitespace or control characters.
+
+The characters `#`, `%`, `+`, `:`, `=`, `\` and `,` have to be escaped with a backslash.
+====
 
 The trailing `|| exit 1` is just a safety net, in case something goes wrong during eval.
 
@@ -201,8 +206,12 @@ Now we have two colon-separated options before the type marker (`#`, `=`).
 If a option is a single character, it defines a short option (`l` -> `-l`).
 With multiple characters it is a long option, that has two leading dashes (`long` -> `--long`).
 
+[IMPORTANT]
+====
+Long options may contain any ASCII character, except for  `=`, whitespace or control characters. The `-` (minus) is not allowed as the first character.
 
-IMPORTANT: Long options may contain any ASCII character, except for  `=`, whitespace or control character. The `-` (minus) is not allowed as the first character.
+The characters `#`, `%`, `+`, `:`, `\` and `,` have to be escaped with a backslash.
+====
 
 Now our example script enables long output by either using `-l` or `--long` and the output file can be set with `-o out.file` or `--out-file out.file` or even `--out-file=out.file`.
 

script-test/test-all-chars.sh

@@ -77,7 +77,6 @@ test_pa 'test "$opt" = true' -o '8#opt' -- -8
 test_pa 'test "$opt" = true' -o '9#opt' -- -9
 test_pa 'test "$opt" = true' -o '!#opt' -- -!
 test_pa 'test "$opt" = true' -o '$#opt' -- -$
-test_pa 'test "$opt" = true' -o ',#opt' -- -,
 test_pa 'test "$opt" = true' -o '.#opt' -- -.
 if [ -z "$IS_MSYS" ]; then
     test_pa 'test "$opt" = true' -o '/#opt' -- -/
@@ -113,5 +112,6 @@ test_pa 'test "$opt" = true' -o '\+#opt' -- -+
 test_pa 'test "$opt" = true' -o '\:#opt' -- -:
 test_pa 'test "$opt" = true' -o '\=#opt' -- -=
 test_pa 'test "$opt" = true' -o '\\#opt' -- -\\
+test_pa 'test "$opt" = true' -o '\,#opt' -- -,
 
 end_test

src/main.rs

@@ -45,7 +45,7 @@ const PARSEARGS_SHELL_VAR: &str = "PARSEARGS_SHELL";
 struct CmdLineArgs {
     /// Definition of supported shell options
     #[arg(short = 'o', long = "options", value_name = "OPT-DEFs")]
-    options: Option<String>,
+    options_list: Option<Vec<String>>,
 
     /// Name of calling shell script. Used as prefix for error messages.
     #[arg(short = 'n', long = "name")]
@@ -513,8 +513,8 @@ fn parseargs(cmd_line_args: CmdLineArgs) -> ! {
     };
 
     // parse the option definition string
-    let result = if cmd_line_args.options.is_some() {
-        opt_def::parse(&cmd_line_args.options.clone().unwrap())
+    let result = if cmd_line_args.options_list.is_some() {
+        opt_def::parse(&cmd_line_args.options_list.clone().unwrap().join(","))
     } else {
         Ok(Vec::new())
     };

src/opt_def.rs

@@ -608,6 +608,9 @@ pub fn parse(opt_def_str: &String) -> Result<Vec<OptConfig>, String> {
 fn parse_opt_def_list(ps: &mut ParserSource) -> Result<Vec<OptConfig>, ParsingError> {
     let mut opt_def_list: Vec<OptConfig> = Vec::new();
     loop {
+        // eat up consecutive commas
+        while ps.next_if(|c| c == ',').is_some() {}
+
         match parse_opt_def(ps) {
             Ok(od) => {
                 opt_def_list.push(od);

tests/code_gen.rs

@@ -262,6 +262,7 @@ fn test_mode_switch_option() {
         "parseargs: Options are mutual exclusive: -c/--copy, -m/--move",
     );
 }
+
 #[test]
 fn test_combined_options() {
     let expected = &[
@@ -453,3 +454,24 @@ fn test_posix() {
         &["set -- 'test' '-d' '--' 'test2'"],
     );
 }
+
+#[test]
+fn test_multiple_o_options() {
+    exec::test_code_gen(
+        &["-o", "d#debug", "-o", "l#long"],
+        &["-d", "-l"],
+        &["debug='true';", "long='true';", "set --"],
+    );
+
+    exec::test_code_gen(
+        &["-o", "d#debug,,", "-o", ",,l#long"],
+        &["-d", "-l"],
+        &["debug='true';", "long='true';", "set --"],
+    );
+
+    exec::test_code_gen(
+        &["-o", "d#debug", "-o", "l#long", "-o", "\\,#comma"],
+        &["-d", "-l", "-,"],
+        &["debug='true';", "long='true';", "comma='true';", "set --"],
+    );
+}