Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for quoted arguments containing spaces #13

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add support for quoted arguments containing spaces #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
300cfb3
Add support for quoted args containing spaces
DrewTChrist Apr 13, 2023
c735745
Fix unwrap and clippy complaints
DrewTChrist Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 46 additions & 21 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ where
/// (and hence doesn't take a value).
/// * Returns `Err(())` if `parameter_name` was not in `item.parameter_list`
/// or `item` wasn't an Item::Callback
#[allow(clippy::result_unit_err)]
pub fn argument_finder<'a, T>(
item: &'a Item<'a, T>,
argument_list: &'a [&'a str],
Expand Down Expand Up @@ -349,7 +350,7 @@ where
match parts.next() {
Some(arg) => match menu.items.iter().find(|i| i.command == arg) {
Some(item) => {
self.print_long_help(&item);
self.print_long_help(item);
}
None => {
writeln!(self.context, "I can't help with {:?}", arg).unwrap();
Expand All @@ -358,7 +359,7 @@ where
_ => {
writeln!(self.context, "AVAILABLE ITEMS:").unwrap();
for item in menu.items {
self.print_short_help(&item);
self.print_short_help(item);
}
if self.depth != 0 {
self.print_short_help(&Item {
Expand Down Expand Up @@ -562,44 +563,68 @@ where
) {
let mandatory_parameter_count = parameters
.iter()
.filter(|p| match p {
Parameter::Mandatory { .. } => true,
_ => false,
})
.filter(|p| matches!(p, Parameter::Mandatory { .. },))
.count();
let positional_parameter_count = parameters
.iter()
.filter(|p| match p {
Parameter::Mandatory { .. } => true,
Parameter::Optional { .. } => true,
_ => false,
})
.filter(|p| matches!(p, Parameter::Mandatory { .. } | Parameter::Optional { .. }))
.count();
if command.len() >= item.command.len() {
// Maybe arguments
let mut argument_buffer: [&str; 16] = [""; 16];
let mut argument_count = 0;
let mut positional_arguments = 0;
for (slot, arg) in argument_buffer
.iter_mut()
.zip(command[item.command.len()..].split_whitespace())
{
*slot = arg;
argument_count += 1;
if arg.starts_with("--") {
// buffer of characters and lengths
let mut buf = [([0u8; 32], 0_usize); 16];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

32 x 16 bytes is quite a big increase of memory usage compared to what we had before.

If this remains it should be a const generic.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or it might be better to de-escape the buffer in place. Any de-escaped string must be the same length or shorter than the input string, and so that should always fit into the buffer that's available.

let mut quoted = false;
let mut next = 0;
let chars = command[item.command.len()..].chars();
for c in chars {
match c {
'"' => {
quoted = !quoted;
}
' ' => {
if quoted {
buf[argument_count].0[next] = c as u8;
next += 1;
} else {
argument_count += 1;
buf[argument_count].1 = next;
next = 0;
}
}
_ => {
buf[argument_count].0[next] = c as u8;
next += 1;
}
}
buf[argument_count].1 = next;
}
let mut index = 0;
for arr in buf.iter() {
if arr.1 != 0 {
if let Ok(value) = core::str::from_utf8(&arr.0[0..arr.1]) {
argument_buffer[index] = value;
index += 1;
}
}
}
for arg in argument_buffer.iter() {
if let Some(arg) = arg.strip_prefix("--") {
// Validate named argument
let mut found = false;
for param in parameters.iter() {
match param {
Parameter::Named { parameter_name, .. } => {
if &arg[2..] == *parameter_name {
if &arg == parameter_name {
found = true;
break;
}
}
Parameter::NamedValue { parameter_name, .. } => {
if arg.contains('=') {
if let Some(given_name) = arg[2..].split('=').next() {
if let Some(given_name) = arg.split('=').next() {
if given_name == *parameter_name {
found = true;
break;
Expand All @@ -616,7 +641,7 @@ where
writeln!(context, "Error: Did not understand {:?}", arg).unwrap();
return;
}
} else {
} else if !arg.is_empty() {
positional_arguments += 1;
}
}
Expand Down