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

cargo-apk: Reimplement "default" (--) subcommand trailing args for cargo #363

Merged
merged 3 commits into from
Nov 23, 2022
Merged

cargo-apk: Reimplement "default" (--) subcommand trailing args for cargo #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b1c777
cargo-apk: Reimplement "default" subcommand trailing args for `cargo`…
MarijnS95 Oct 17, 2022
bbda575
cargo-apk: Separate unrecognized `cargo` arguments from cargo-apk `Args`
MarijnS95 Nov 22, 2022
e2b9db4
Add `args: Args` back to `Ndk` subcommand to see them in `-h`
MarijnS95 Nov 22, 2022
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
6 changes: 5 additions & 1 deletion cargo-apk/src/apk.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ impl<'a> ApkBuilder<'a> {
Ok(())
}

pub fn default(&self, cargo_cmd: &str) -> Result<(), Error> {
pub fn default(&self, cargo_cmd: &str, cargo_args: &[String]) -> Result<(), Error> {
for target in &self.build_targets {
let mut cargo = cargo_ndk(
&self.ndk,
Expand All @@ -322,6 +322,10 @@ impl<'a> ApkBuilder<'a> {
cargo.arg("--target").arg(triple);
}

for additional_arg in cargo_args {
cargo.arg(additional_arg);
}

if !cargo.status()?.success() {
return Err(NdkError::CmdFailed(cargo).into());
}
Expand Down
223 changes: 218 additions & 5 deletions cargo-apk/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
use std::collections::HashMap;

use cargo_apk::{ApkBuilder, Error};
use cargo_subcommand::Subcommand;
use clap::Parser;
use clap::{CommandFactory, FromArgMatches, Parser};

#[derive(Parser)]
struct Cmd {
Expand All @@ -17,7 +19,8 @@ enum ApkCmd {
},
}

#[derive(Parser)]
#[derive(Clone, Debug, Eq, PartialEq, Parser)]
#[group(skip)]
struct Args {
#[clap(flatten)]
subcommand_args: cargo_subcommand::Args,
Expand All @@ -27,7 +30,6 @@ struct Args {
}

#[derive(clap::Subcommand)]
#[clap(trailing_var_arg = true)]
enum ApkSubCmd {
/// Analyze the current package and report errors, but don't build object files nor an apk
#[clap(visible_alias = "c")]
Expand All @@ -44,9 +46,18 @@ enum ApkSubCmd {
/// Invoke `cargo` under the detected NDK environment
#[clap(name = "--")]
Ndk {
/// `cargo` subcommand to run
cargo_cmd: String,

// This struct will be filled up later by arguments that are intermixed
// with unknown args and ended up in `cargo_args` below.
#[clap(flatten)]
args: Args,

/// Arguments passed to cargo. Some arguments will be used to configure
/// the environment similar to other `cargo apk` commands
#[clap(trailing_var_arg = true, allow_hyphen_values = true)]
cargo_args: Vec<String>,
},
/// Run a binary or example apk of the local package
#[clap(visible_alias = "r")]
Expand All @@ -66,6 +77,61 @@ enum ApkSubCmd {
Version,
}

fn split_apk_and_cargo_args(mut args: Args, input: Vec<String>) -> (Args, Vec<String>) {
// Clap doesn't support parsing unknown args properly:
// https://github.com/clap-rs/clap/issues/1404
// https://github.com/clap-rs/clap/issues/4498
// Introspect the `Args` struct and extract every known arg, and whether it takes a value. Use
// this information to separate out known args from unknown args, and re-parse all the known
// args into an existing `args: Args` struct instance.

let known_args_taking_value = Args::command()
.get_arguments()
.flat_map(|arg| {
assert!(!arg.is_positional());
arg.get_short_and_visible_aliases()
.iter()
.flat_map(|shorts| shorts.iter().map(|short| format!("-{}", short)))
.chain(
arg.get_long_and_visible_aliases()
.iter()
.flat_map(|longs| longs.iter().map(|short| format!("--{}", short))),
)
.map(|arg_str| (arg_str, arg.get_action().takes_values()))
// Collect to prevent lifetime issues on temporaries created above
.collect::<Vec<_>>()
})
.collect::<HashMap<_, _>>();

#[derive(Debug, Default)]
struct SplitArgs {
apk_args: Vec<String>,
cargo_args: Vec<String>,
next_takes_value: bool,
}

let split_args = input
.into_iter()
.fold(SplitArgs::default(), |mut split_args, elem| {
let known_arg = known_args_taking_value.get(&elem);
if known_arg.is_some() || split_args.next_takes_value {
// Recognized arg or value for previously recognized arg
split_args.apk_args.push(elem)
} else {
split_args.cargo_args.push(elem)
}

split_args.next_takes_value = known_arg.copied().unwrap_or(false);
split_args
});

let m = Args::command()
.no_binary_name(true)
.get_matches_from(&split_args.apk_args);
args.update_from_arg_matches(&m).unwrap();
(args, split_args.cargo_args)
}

fn main() -> anyhow::Result<()> {
env_logger::init();
let Cmd {
Expand All @@ -84,10 +150,16 @@ fn main() -> anyhow::Result<()> {
builder.build(artifact)?;
}
}
ApkSubCmd::Ndk { cargo_cmd, args } => {
ApkSubCmd::Ndk {
cargo_cmd,
args,
cargo_args,
} => {
let (args, cargo_args) = split_apk_and_cargo_args(args, cargo_args);

let cmd = Subcommand::new(args.subcommand_args)?;
let builder = ApkBuilder::from_subcommand(&cmd, args.device)?;
builder.default(&cargo_cmd)?;
builder.default(&cargo_cmd, &cargo_args)?;
}
ApkSubCmd::Run { args, no_logcat } => {
let cmd = Subcommand::new(args.subcommand_args)?;
Expand All @@ -107,3 +179,144 @@ fn main() -> anyhow::Result<()> {
}
Ok(())
}

#[test]
fn test_split_apk_and_cargo_args() {
// Set up a default because cargo-subcommand doesn't derive/implement Default
let args_default = Args::parse_from(std::iter::empty::<&str>());

assert_eq!(
split_apk_and_cargo_args(args_default.clone(), vec!["--quiet".to_string()]),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec![]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec!["unrecognized".to_string(), "--quiet".to_string()]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec!["unrecognized".to_string()]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec!["--unrecognized".to_string(), "--quiet".to_string()]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec!["--unrecognized".to_string()]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec!["-p".to_string(), "foo".to_string()]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
package: vec!["foo".to_string()],
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec![]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec![
"-p".to_string(),
"foo".to_string(),
"--unrecognized".to_string(),
"--quiet".to_string()
]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
package: vec!["foo".to_string()],
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec!["--unrecognized".to_string()]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec![
"--no-deps".to_string(),
"-p".to_string(),
"foo".to_string(),
"--unrecognized".to_string(),
"--quiet".to_string()
]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
package: vec!["foo".to_string()],
..args_default.subcommand_args.clone()
},
..args_default.clone()
},
vec!["--no-deps".to_string(), "--unrecognized".to_string()]
)
);

assert_eq!(
split_apk_and_cargo_args(
args_default.clone(),
vec![
"--no-deps".to_string(),
"--device".to_string(),
"adb:test".to_string(),
"--unrecognized".to_string(),
"--quiet".to_string()
]
),
(
Args {
subcommand_args: cargo_subcommand::Args {
quiet: true,
..args_default.subcommand_args
},
device: Some("adb:test".to_string()),
},
vec!["--no-deps".to_string(), "--unrecognized".to_string()]
)
);
}