Merge pull request #82 from tertsdiepraam/new-positional

New positional argument system
uutils · Feb 5, 2024 · 57af536 · 57af536
2 parents 7304047 + 5c7bf4e
commit 57af536
Show file tree

Hide file tree

Showing 10 changed files with 534 additions and 54 deletions.
diff --git a/derive/src/attributes.rs b/derive/src/attributes.rs
@@ -13,6 +13,7 @@ pub struct ArgumentsAttr {
     pub file: Option<String>,
     pub exit_code: i32,
     pub parse_echo_style: bool,
+    pub options_first: bool,
 }
 
 impl Default for ArgumentsAttr {
@@ -23,6 +24,7 @@ impl Default for ArgumentsAttr {
             file: None,
             exit_code: 1,
             parse_echo_style: false,
+            options_first: false,
         }
     }
 }
@@ -55,6 +57,9 @@ impl ArgumentsAttr {
                 "parse_echo_style" => {
                     args.parse_echo_style = true;
                 }
+                "options_first" => {
+                    args.options_first = true;
+                }
                 _ => return Err(meta.error("unrecognized argument for arguments attribute")),
             };
             Ok(())

diff --git a/derive/src/lib.rs b/derive/src/lib.rs
@@ -67,6 +67,20 @@ pub fn arguments(input: TokenStream) -> TokenStream {
         quote!(parser.next()?)
     };
 
+    // If options_first is set and we find the first positional argument, we
+    // immediately return all of them.
+    let positional = if arguments_attr.options_first {
+        quote!(
+            // Unwrap is fine because this is called when we have just parsed a
+            // value and therefore are not partially within an option.
+            let mut values = parser.raw_args().unwrap().collect::<Vec<OsString>>();
+            values.insert(0, value);
+            Ok(Some(::uutils_args::Argument::MultiPositional(values)))
+        )
+    } else {
+        quote!(Ok(Some(::uutils_args::Argument::Positional(value))))
+    };
+
     let expanded = quote!(
         impl #impl_generics Arguments for #name #ty_generics #where_clause {
             const EXIT_CODE: i32 = #exit_code;
@@ -91,7 +105,7 @@ pub fn arguments(input: TokenStream) -> TokenStream {
                 match arg {
                     lexopt::Arg::Short(short) => { #short },
                     lexopt::Arg::Long(long) => { #long },
-                    lexopt::Arg::Value(value) => { Ok(Some(::uutils_args::Argument::Positional(value))) },
+                    lexopt::Arg::Value(value) => { #positional },
                 }
             }
 

diff --git a/src/error.rs b/src/error.rs
@@ -28,7 +28,7 @@ pub enum ErrorKind {
     UnexpectedOption(String, Vec<String>),
 
     /// No more positional arguments were expected, but one was given anyway.
-    UnexpectedArgument(OsString),
+    UnexpectedArgument(String),
 
     /// A value was passed to an option that didn't expect a value.
     UnexpectedValue {
@@ -99,7 +99,7 @@ impl Display for ErrorKind {
                 Ok(())
             }
             ErrorKind::UnexpectedArgument(arg) => {
-                write!(f, "Found an invalid argument '{}'.", arg.to_string_lossy())
+                write!(f, "Found an invalid argument '{}'.", arg)
             }
             ErrorKind::UnexpectedValue { option, value } => {
                 write!(
@@ -144,7 +144,9 @@ impl From<lexopt::Error> for ErrorKind {
         match other {
             lexopt::Error::MissingValue { option } => Self::MissingValue { option },
             lexopt::Error::UnexpectedOption(s) => Self::UnexpectedOption(s, Vec::new()),
-            lexopt::Error::UnexpectedArgument(s) => Self::UnexpectedArgument(s),
+            lexopt::Error::UnexpectedArgument(s) => {
+                Self::UnexpectedArgument(s.to_string_lossy().to_string())
+            }
             lexopt::Error::UnexpectedValue { option, value } => {
                 Self::UnexpectedValue { option, value }
             }

diff --git a/src/lib.rs b/src/lib.rs
@@ -11,6 +11,7 @@
 
 mod error;
 pub mod internal;
+pub mod positional;
 mod value;
 
 #[cfg(doc)]
@@ -64,6 +65,7 @@ pub enum Argument<T: Arguments> {
     Help,
     Version,
     Positional(OsString),
+    MultiPositional(Vec<OsString>),
     Custom(T),
 }
 
@@ -142,6 +144,9 @@ impl<T: Arguments> ArgumentIter<T> {
                 Argument::Positional(arg) => {
                     self.positional_arguments.push(arg);
                 }
+                Argument::MultiPositional(args) => {
+                    self.positional_arguments.extend(args);
+                }
                 Argument::Custom(arg) => return Ok(Some(arg)),
             }
         }