2016-06-24 10:23:08 +00:00
|
|
|
/// A convenience macro for loading the YAML file at compile time (relative to the current file,
|
2016-01-26 19:02:10 +00:00
|
|
|
/// like modules work). That YAML object can then be passed to this function.
|
|
|
|
///
|
|
|
|
/// # Panics
|
|
|
|
///
|
|
|
|
/// The YAML file must be properly formatted or this function will panic!(). A good way to
|
|
|
|
/// ensure this doesn't happen is to run your program with the `--help` switch. If this passes
|
|
|
|
/// without error, you needn't worry because the YAML is properly formatted.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// The following example shows how to load a properly formatted YAML file to build an instnace
|
|
|
|
/// of an `App` struct.
|
|
|
|
///
|
|
|
|
/// ```ignore
|
2016-10-05 09:28:59 +00:00
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
2016-01-26 19:02:10 +00:00
|
|
|
/// # use clap::App;
|
2016-10-05 09:28:59 +00:00
|
|
|
/// # fn main() {
|
2016-01-26 19:02:10 +00:00
|
|
|
/// let yml = load_yaml!("app.yml");
|
|
|
|
/// let app = App::from_yaml(yml);
|
|
|
|
///
|
|
|
|
/// // continued logic goes here, such as `app.get_matches()` etc.
|
2016-10-05 09:28:59 +00:00
|
|
|
/// # }
|
2016-01-26 19:02:10 +00:00
|
|
|
/// ```
|
2015-08-31 03:26:17 +00:00
|
|
|
#[cfg(feature = "yaml")]
|
|
|
|
#[macro_export]
|
|
|
|
macro_rules! load_yaml {
|
|
|
|
($yml:expr) => (
|
2016-02-04 06:14:28 +00:00
|
|
|
&::clap::YamlLoader::load_from_str(include_str!($yml)).expect("failed to load YAML file")[0]
|
2015-08-31 03:26:17 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2016-05-14 20:25:00 +00:00
|
|
|
/// Convenience macro getting a typed value `T` where `T` implements [`std::str::FromStr`] from an
|
2016-01-26 19:02:10 +00:00
|
|
|
/// argument value. This macro returns a `Result<T,String>` which allows you as the developer to
|
|
|
|
/// decide what you'd like to do on a failed parse. There are two types of errors, parse failures
|
|
|
|
/// and those where the argument wasn't present (such as a non-required argument). You can use
|
2016-05-14 20:25:00 +00:00
|
|
|
/// it to get a single value, or a iterator as with the [`ArgMatches::values_of`]
|
2015-04-14 19:02:50 +00:00
|
|
|
///
|
2016-01-21 06:48:30 +00:00
|
|
|
/// # Examples
|
2015-04-14 19:02:50 +00:00
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
|
|
|
/// let matches = App::new("myapp")
|
2015-04-14 20:10:47 +00:00
|
|
|
/// .arg_from_usage("[length] 'Set the length to use as a pos whole num, i.e. 20'")
|
2015-05-01 18:38:27 +00:00
|
|
|
/// .get_matches();
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// let len = value_t!(matches.value_of("length"), u32).unwrap_or_else(|e| e.exit());
|
|
|
|
/// let also_len = value_t!(matches, "length", u32).unwrap_or_else(|e| e.exit());
|
2015-04-14 19:02:50 +00:00
|
|
|
///
|
|
|
|
/// println!("{} + 2: {}", len, len + 2);
|
|
|
|
/// # }
|
|
|
|
/// ```
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`std::str::FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`ArgMatches::values_of`]: ./struct.ArgMatches.html#method.values_of
|
|
|
|
/// [`Result<T,String>`]: https://doc.rust-lang.org/std/result/enum.Result.html
|
2016-01-21 06:48:30 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! value_t {
|
|
|
|
($m:ident, $v:expr, $t:ty) => {
|
2016-01-22 04:18:52 +00:00
|
|
|
value_t!($m.value_of($v), $t)
|
2016-01-21 06:48:30 +00:00
|
|
|
};
|
|
|
|
($m:ident.value_of($v:expr), $t:ty) => {
|
|
|
|
if let Some(v) = $m.value_of($v) {
|
|
|
|
match v.parse::<$t>() {
|
|
|
|
Ok(val) => Ok(val),
|
|
|
|
Err(_) =>
|
2016-05-30 08:07:44 +00:00
|
|
|
Err(::clap::Error::value_validation_auto(
|
2016-01-21 06:48:30 +00:00
|
|
|
format!("The argument '{}' isn't a valid value", v))),
|
|
|
|
}
|
|
|
|
} else {
|
2016-05-30 08:07:44 +00:00
|
|
|
Err(::clap::Error::argument_not_found_auto($v))
|
2016-01-22 04:18:52 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2016-05-14 20:25:00 +00:00
|
|
|
/// Convenience macro getting a typed value `T` where `T` implements [`std::str::FromStr`] or
|
|
|
|
/// exiting upon error, instead of returning a [`Result`] type.
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// **NOTE:** This macro is for backwards compatibility sake. Prefer
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`value_t!(/* ... */).unwrap_or_else(|e| e.exit())`]
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
|
|
|
/// let matches = App::new("myapp")
|
|
|
|
/// .arg_from_usage("[length] 'Set the length to use as a pos whole num, i.e. 20'")
|
|
|
|
/// .get_matches();
|
|
|
|
///
|
|
|
|
/// let len = value_t_or_exit!(matches.value_of("length"), u32);
|
|
|
|
/// let also_len = value_t_or_exit!(matches, "length", u32);
|
|
|
|
///
|
|
|
|
/// println!("{} + 2: {}", len, len + 2);
|
|
|
|
/// # }
|
|
|
|
/// ```
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`std::str::FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html
|
|
|
|
/// [`value_t!(/* ... */).unwrap_or_else(|e| e.exit())`]: ./macro.value_t!.html
|
2016-01-22 04:18:52 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! value_t_or_exit {
|
|
|
|
($m:ident, $v:expr, $t:ty) => {
|
2016-02-02 07:15:05 +00:00
|
|
|
value_t_or_exit!($m.value_of($v), $t)
|
2016-01-22 04:18:52 +00:00
|
|
|
};
|
|
|
|
($m:ident.value_of($v:expr), $t:ty) => {
|
|
|
|
if let Some(v) = $m.value_of($v) {
|
|
|
|
match v.parse::<$t>() {
|
|
|
|
Ok(val) => val,
|
|
|
|
Err(_) =>
|
2016-05-30 08:07:44 +00:00
|
|
|
::clap::Error::value_validation_auto(
|
2016-01-22 04:18:52 +00:00
|
|
|
format!("The argument '{}' isn't a valid value", v)).exit(),
|
|
|
|
}
|
|
|
|
} else {
|
2016-05-30 08:07:44 +00:00
|
|
|
::clap::Error::argument_not_found_auto($v).exit()
|
2016-01-21 06:48:30 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2016-05-14 20:25:00 +00:00
|
|
|
/// Convenience macro getting a typed value [`Vec<T>`] where `T` implements [`std::str::FromStr`]
|
|
|
|
/// This macro returns a [`clap::Result<Vec<T>>`] which allows you as the developer to decide
|
|
|
|
/// what you'd like to do on a failed parse.
|
2015-04-14 19:02:50 +00:00
|
|
|
///
|
2016-01-21 06:48:30 +00:00
|
|
|
/// # Examples
|
2015-04-14 19:02:50 +00:00
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
|
|
|
/// let matches = App::new("myapp")
|
2015-04-14 20:10:47 +00:00
|
|
|
/// .arg_from_usage("[seq]... 'A sequence of pos whole nums, i.e. 20 45'")
|
2015-05-01 18:38:27 +00:00
|
|
|
/// .get_matches();
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// let vals = values_t!(matches.values_of("seq"), u32).unwrap_or_else(|e| e.exit());
|
|
|
|
/// for v in &vals {
|
|
|
|
/// println!("{} + 2: {}", v, v + 2);
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// let vals = values_t!(matches, "seq", u32).unwrap_or_else(|e| e.exit());
|
|
|
|
/// for v in &vals {
|
2015-05-01 18:38:27 +00:00
|
|
|
/// println!("{} + 2: {}", v, v + 2);
|
|
|
|
/// }
|
2015-04-14 19:02:50 +00:00
|
|
|
/// # }
|
|
|
|
/// ```
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`std::str::FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`Vec<T>`]: https://doc.rust-lang.org/std/vec/struct.Vec.html
|
|
|
|
/// [`clap::Result<Vec<T>>`]: ./type.Result.html
|
2016-01-21 05:18:53 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! values_t {
|
2016-01-22 04:18:52 +00:00
|
|
|
($m:ident, $v:expr, $t:ty) => {
|
2016-01-21 06:48:30 +00:00
|
|
|
values_t!($m.values_of($v), $t)
|
2015-05-01 18:38:27 +00:00
|
|
|
};
|
2016-01-21 06:48:30 +00:00
|
|
|
($m:ident.values_of($v:expr), $t:ty) => {
|
2016-01-22 04:18:52 +00:00
|
|
|
if let Some(vals) = $m.values_of($v) {
|
|
|
|
let mut tmp = vec![];
|
|
|
|
let mut err = None;
|
|
|
|
for pv in vals {
|
|
|
|
match pv.parse::<$t>() {
|
|
|
|
Ok(rv) => tmp.push(rv),
|
|
|
|
Err(..) => {
|
2016-05-30 08:07:44 +00:00
|
|
|
err = Some(::clap::Error::value_validation_auto(
|
2016-01-22 04:18:52 +00:00
|
|
|
format!("The argument '{}' isn't a valid value", pv)));
|
|
|
|
break
|
|
|
|
}
|
2015-05-15 19:34:41 +00:00
|
|
|
}
|
|
|
|
}
|
2016-01-22 04:18:52 +00:00
|
|
|
match err {
|
|
|
|
Some(e) => Err(e),
|
|
|
|
None => Ok(tmp),
|
|
|
|
}
|
|
|
|
} else {
|
2016-05-30 08:07:44 +00:00
|
|
|
Err(::clap::Error::argument_not_found_auto($v))
|
2015-05-15 20:41:39 +00:00
|
|
|
}
|
2015-05-01 18:38:27 +00:00
|
|
|
};
|
2015-04-17 14:20:56 +00:00
|
|
|
}
|
|
|
|
|
2016-05-14 20:25:00 +00:00
|
|
|
/// Convenience macro getting a typed value [`Vec<T>`] where `T` implements [`std::str::FromStr`]
|
|
|
|
/// or exiting upon error.
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// **NOTE:** This macro is for backwards compatibility sake. Prefer
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`values_t!(/* ... */).unwrap_or_else(|e| e.exit())`]
|
2016-01-22 04:18:52 +00:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
|
|
|
/// let matches = App::new("myapp")
|
|
|
|
/// .arg_from_usage("[seq]... 'A sequence of pos whole nums, i.e. 20 45'")
|
|
|
|
/// .get_matches();
|
|
|
|
///
|
|
|
|
/// let vals = values_t_or_exit!(matches.values_of("seq"), u32);
|
|
|
|
/// for v in &vals {
|
|
|
|
/// println!("{} + 2: {}", v, v + 2);
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// // type for example only
|
|
|
|
/// let vals: Vec<u32> = values_t_or_exit!(matches, "seq", u32);
|
|
|
|
/// for v in &vals {
|
|
|
|
/// println!("{} + 2: {}", v, v + 2);
|
|
|
|
/// }
|
|
|
|
/// # }
|
|
|
|
/// ```
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`values_t!(/* ... */).unwrap_or_else(|e| e.exit())`]: ./macro.values_t!.html
|
|
|
|
/// [`std::str::FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`Vec<T>`]: https://doc.rust-lang.org/std/vec/struct.Vec.html
|
2016-01-22 04:18:52 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! values_t_or_exit {
|
|
|
|
($m:ident, $v:expr, $t:ty) => {
|
|
|
|
values_t_or_exit!($m.values_of($v), $t)
|
|
|
|
};
|
|
|
|
($m:ident.values_of($v:expr), $t:ty) => {
|
|
|
|
if let Some(vals) = $m.values_of($v) {
|
|
|
|
vals.map(|v| v.parse::<$t>().unwrap_or_else(|_|{
|
2016-05-30 08:07:44 +00:00
|
|
|
::clap::Error::value_validation_auto(
|
2016-01-22 04:18:52 +00:00
|
|
|
format!("One or more arguments aren't valid values")).exit()
|
|
|
|
})).collect::<Vec<$t>>()
|
|
|
|
} else {
|
2016-05-30 08:07:44 +00:00
|
|
|
::clap::Error::argument_not_found_auto($v).exit()
|
2016-01-22 04:18:52 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
2016-01-21 06:48:30 +00:00
|
|
|
|
2016-01-31 13:03:09 +00:00
|
|
|
// _clap_count_exprs! is derived from https://github.com/DanielKeep/rust-grabbag
|
|
|
|
// commit: 82a35ca5d9a04c3b920622d542104e3310ee5b07
|
|
|
|
// License: MIT
|
|
|
|
// Copyright ⓒ 2015 grabbag contributors.
|
|
|
|
// Licensed under the MIT license (see LICENSE or <http://opensource.org
|
|
|
|
// /licenses/MIT>) or the Apache License, Version 2.0 (see LICENSE of
|
|
|
|
// <http://www.apache.org/licenses/LICENSE-2.0>), at your option. All
|
|
|
|
// files in the project carrying such notice may not be copied, modified,
|
|
|
|
// or distributed except according to those terms.
|
|
|
|
//
|
|
|
|
/// Counts the number of comma-delimited expressions passed to it. The result is a compile-time
|
|
|
|
/// evaluable expression, suitable for use as a static array size, or the value of a `const`.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// # #[macro_use] extern crate clap;
|
|
|
|
/// # fn main() {
|
|
|
|
/// const COUNT: usize = _clap_count_exprs!(a, 5+1, "hi there!".into_string());
|
|
|
|
/// assert_eq!(COUNT, 3);
|
|
|
|
/// # }
|
|
|
|
/// ```
|
|
|
|
#[macro_export]
|
|
|
|
macro_rules! _clap_count_exprs {
|
|
|
|
() => { 0 };
|
|
|
|
($e:expr) => { 1 };
|
|
|
|
($e:expr, $($es:expr),+) => { 1 + _clap_count_exprs!($($es),*) };
|
|
|
|
}
|
|
|
|
|
2015-05-01 18:38:27 +00:00
|
|
|
/// Convenience macro to generate more complete enums with variants to be used as a type when
|
2016-01-26 19:02:10 +00:00
|
|
|
/// parsing arguments. This enum also provides a `variants()` function which can be used to
|
2016-05-14 20:25:00 +00:00
|
|
|
/// retrieve a `Vec<&'static str>` of the variant names, as well as implementing [`FromStr`] and
|
|
|
|
/// [`Display`] automatically.
|
2015-04-17 14:20:56 +00:00
|
|
|
///
|
2016-01-26 19:02:10 +00:00
|
|
|
/// **NOTE:** Case insensitivity is supported for ASCII characters only
|
2015-05-05 16:33:02 +00:00
|
|
|
///
|
2016-05-14 20:25:00 +00:00
|
|
|
/// **NOTE:** This macro automatically implements [`std::str::FromStr`] and [`std::fmt::Display`]
|
2015-05-15 19:34:41 +00:00
|
|
|
///
|
2016-01-26 19:02:10 +00:00
|
|
|
/// **NOTE:** These enums support pub (or not) and uses of the #[derive()] traits
|
2015-04-17 14:20:56 +00:00
|
|
|
///
|
2015-09-22 02:06:15 +00:00
|
|
|
/// # Examples
|
2015-04-17 14:20:56 +00:00
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::{App, Arg};
|
|
|
|
/// arg_enum!{
|
2015-05-01 18:38:27 +00:00
|
|
|
/// #[derive(Debug)]
|
|
|
|
/// pub enum Foo {
|
|
|
|
/// Bar,
|
|
|
|
/// Baz,
|
|
|
|
/// Qux
|
|
|
|
/// }
|
2015-04-17 14:20:56 +00:00
|
|
|
/// }
|
|
|
|
/// // Foo enum can now be used via Foo::Bar, or Foo::Baz, etc
|
|
|
|
/// // and implements std::str::FromStr to use with the value_t! macros
|
|
|
|
/// fn main() {
|
2015-05-01 18:38:27 +00:00
|
|
|
/// let m = App::new("app")
|
|
|
|
/// .arg_from_usage("<foo> 'the foo'")
|
|
|
|
/// .get_matches();
|
2016-01-22 04:18:52 +00:00
|
|
|
/// let f = value_t!(m, "foo", Foo).unwrap_or_else(|e| e.exit());
|
2015-04-17 14:20:56 +00:00
|
|
|
///
|
2015-05-01 18:38:27 +00:00
|
|
|
/// // Use f like any other Foo variant...
|
2015-04-17 14:20:56 +00:00
|
|
|
/// }
|
|
|
|
/// ```
|
2016-05-14 20:25:00 +00:00
|
|
|
/// [`FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`std::str::FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
|
|
|
|
/// [`Display`]: https://doc.rust-lang.org/std/fmt/trait.Display.html
|
|
|
|
/// [`std::fmt::Display`]: https://doc.rust-lang.org/std/fmt/trait.Display.html
|
2015-04-17 14:20:56 +00:00
|
|
|
#[macro_export]
|
|
|
|
macro_rules! arg_enum {
|
2016-01-21 06:48:30 +00:00
|
|
|
(@as_item $($i:item)*) => ($($i)*);
|
|
|
|
(@impls ( $($tts:tt)* ) -> ($e:ident, $($v:ident),+)) => {
|
|
|
|
arg_enum!(@as_item
|
|
|
|
$($tts)*
|
2015-04-17 14:20:56 +00:00
|
|
|
|
2015-05-01 18:38:27 +00:00
|
|
|
impl ::std::str::FromStr for $e {
|
|
|
|
type Err = String;
|
2015-04-17 14:20:56 +00:00
|
|
|
|
2016-04-01 20:03:29 +00:00
|
|
|
fn from_str(s: &str) -> ::std::result::Result<Self,Self::Err> {
|
2015-05-05 08:33:27 +00:00
|
|
|
use ::std::ascii::AsciiExt;
|
2015-05-01 18:38:27 +00:00
|
|
|
match s {
|
2015-05-05 08:33:27 +00:00
|
|
|
$(stringify!($v) |
|
2016-01-21 06:48:30 +00:00
|
|
|
_ if s.eq_ignore_ascii_case(stringify!($v)) => Ok($e::$v)),+,
|
|
|
|
_ => Err({
|
|
|
|
let v = vec![
|
|
|
|
$(stringify!($v),)+
|
|
|
|
];
|
2016-02-02 10:05:54 +00:00
|
|
|
format!("valid values: {}",
|
|
|
|
v.join(" ,"))
|
2016-01-21 06:48:30 +00:00
|
|
|
}),
|
2015-05-01 18:38:27 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-05-15 19:34:41 +00:00
|
|
|
impl ::std::fmt::Display for $e {
|
|
|
|
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
|
|
|
|
match *self {
|
|
|
|
$($e::$v => write!(f, stringify!($v)),)+
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-05-15 20:41:39 +00:00
|
|
|
impl $e {
|
2015-07-08 00:06:15 +00:00
|
|
|
#[allow(dead_code)]
|
2016-01-31 13:03:09 +00:00
|
|
|
pub fn variants() -> [&'static str; _clap_count_exprs!($(stringify!($v)),+)] {
|
|
|
|
[
|
2015-05-15 20:41:39 +00:00
|
|
|
$(stringify!($v),)+
|
|
|
|
]
|
|
|
|
}
|
2016-01-21 06:48:30 +00:00
|
|
|
});
|
2015-05-01 18:38:27 +00:00
|
|
|
};
|
2016-06-28 04:09:25 +00:00
|
|
|
($(#[$($m:meta),+])+ pub enum $e:ident { $($v:ident $(=$val:expr)*),+ } ) => {
|
2016-01-21 06:48:30 +00:00
|
|
|
arg_enum!(@impls
|
2016-06-28 04:09:25 +00:00
|
|
|
($(#[$($m),+])+
|
2016-01-21 06:48:30 +00:00
|
|
|
pub enum $e {
|
2016-06-28 04:09:25 +00:00
|
|
|
$($v$(=$val)*),+
|
2016-01-21 06:48:30 +00:00
|
|
|
}) -> ($e, $($v),+)
|
|
|
|
);
|
2015-05-01 18:38:27 +00:00
|
|
|
};
|
2016-06-28 04:09:25 +00:00
|
|
|
($(#[$($m:meta),+])+ enum $e:ident { $($v:ident $(=$val:expr)*),+ } ) => {
|
2016-01-21 06:48:30 +00:00
|
|
|
arg_enum!(@impls
|
2016-06-28 04:09:25 +00:00
|
|
|
($(#[$($m),+])+
|
2016-01-21 06:48:30 +00:00
|
|
|
enum $e {
|
2016-06-28 04:09:25 +00:00
|
|
|
$($v$(=$val)*),+
|
2016-01-21 06:48:30 +00:00
|
|
|
}) -> ($e, $($v),+)
|
|
|
|
);
|
|
|
|
};
|
2016-06-28 04:09:25 +00:00
|
|
|
(pub enum $e:ident { $($v:ident $(=$val:expr)*),+ } ) => {
|
2016-01-21 06:48:30 +00:00
|
|
|
arg_enum!(@impls
|
|
|
|
(pub enum $e {
|
2016-06-28 04:09:25 +00:00
|
|
|
$($v$(=$val)*),+
|
2016-01-21 06:48:30 +00:00
|
|
|
}) -> ($e, $($v),+)
|
|
|
|
);
|
|
|
|
};
|
2016-06-28 04:09:25 +00:00
|
|
|
(enum $e:ident { $($v:ident $(=$val:expr)*),+ } ) => {
|
2016-01-21 06:48:30 +00:00
|
|
|
arg_enum!(@impls
|
|
|
|
(enum $e {
|
2016-06-28 04:09:25 +00:00
|
|
|
$($v$(=$val)*),+
|
2016-01-21 06:48:30 +00:00
|
|
|
}) -> ($e, $($v),+)
|
|
|
|
);
|
2015-05-01 18:38:27 +00:00
|
|
|
};
|
2015-04-19 02:20:43 +00:00
|
|
|
}
|
2015-04-19 18:06:08 +00:00
|
|
|
|
2016-04-12 05:37:36 +00:00
|
|
|
/// Allows you to pull the version from your Cargo.toml at compile time as
|
2016-01-26 19:02:10 +00:00
|
|
|
/// MAJOR.MINOR.PATCH_PKGVERSION_PRE
|
2015-04-19 18:06:08 +00:00
|
|
|
///
|
2015-09-22 02:06:15 +00:00
|
|
|
/// # Examples
|
2016-01-26 19:02:10 +00:00
|
|
|
///
|
2015-04-19 18:06:08 +00:00
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
2015-05-01 18:38:27 +00:00
|
|
|
/// let m = App::new("app")
|
2016-01-21 05:18:53 +00:00
|
|
|
/// .version(crate_version!())
|
2015-05-01 18:38:27 +00:00
|
|
|
/// .get_matches();
|
2015-04-19 18:06:08 +00:00
|
|
|
/// # }
|
|
|
|
/// ```
|
|
|
|
#[macro_export]
|
|
|
|
macro_rules! crate_version {
|
2015-05-01 18:38:27 +00:00
|
|
|
() => {
|
2016-01-21 06:48:30 +00:00
|
|
|
env!("CARGO_PKG_VERSION")
|
|
|
|
};
|
2015-04-19 18:06:08 +00:00
|
|
|
}
|
2015-09-08 12:53:31 +00:00
|
|
|
|
2016-05-06 21:35:53 +00:00
|
|
|
/// Allows you to pull the authors for the app from your Cargo.toml at
|
|
|
|
/// compile time as
|
2016-04-12 05:37:36 +00:00
|
|
|
/// "author1 lastname. <author1@example.com>",
|
|
|
|
/// "author2 lastname. <author2@example.com>"
|
2016-04-11 23:17:44 +00:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```no_run
|
|
|
|
/// # #[macro_use]
|
|
|
|
/// # extern crate clap;
|
|
|
|
/// # use clap::App;
|
|
|
|
/// # fn main() {
|
|
|
|
/// let m = App::new("app")
|
|
|
|
/// .author(crate_authors!())
|
|
|
|
/// .get_matches();
|
|
|
|
/// # }
|
|
|
|
/// ```
|
2016-07-23 22:56:42 +00:00
|
|
|
#[macro_export]
|
2016-04-11 23:17:44 +00:00
|
|
|
macro_rules! crate_authors {
|
|
|
|
() => {
|
|
|
|
env!("CARGO_PKG_AUTHORS")
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2016-10-15 21:37:59 +00:00
|
|
|
/// Build `App`, `Arg`s, `SubCommand`s and `Group`s with Usage-string like input
|
|
|
|
/// but without the parsing.
|
|
|
|
#[macro_export]
|
2015-09-08 12:53:31 +00:00
|
|
|
macro_rules! clap_app {
|
|
|
|
(@app ($builder:expr)) => { $builder };
|
|
|
|
(@app ($builder:expr) (@arg $name:ident: $($tail:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @app
|
2016-05-06 21:35:53 +00:00
|
|
|
($builder.arg(
|
|
|
|
clap_app!{ @arg ($crate::Arg::with_name(stringify!($name))) (-) $($tail)* }))
|
2015-09-08 12:53:31 +00:00
|
|
|
$($tt)*
|
|
|
|
}
|
|
|
|
};
|
|
|
|
(@app ($builder:expr) (@setting $setting:ident) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @app
|
|
|
|
($builder.setting($crate::AppSettings::$setting))
|
|
|
|
$($tt)*
|
|
|
|
}
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Treat the application builder as an argument to set it's attributes
|
2015-09-08 12:53:31 +00:00
|
|
|
(@app ($builder:expr) (@attributes $($attr:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @app (clap_app!{ @arg ($builder) $($attr)* }) $($tt)* }
|
|
|
|
};
|
|
|
|
(@app ($builder:expr) (@group $name:ident => $($tail:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @app
|
|
|
|
(clap_app!{ @group ($builder, $crate::ArgGroup::with_name(stringify!($name))) $($tail)* })
|
|
|
|
$($tt)*
|
|
|
|
}
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Handle subcommand creation
|
2015-09-08 12:53:31 +00:00
|
|
|
(@app ($builder:expr) (@subcommand $name:ident => $($tail:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @app
|
|
|
|
($builder.subcommand(
|
|
|
|
clap_app!{ @app ($crate::SubCommand::with_name(stringify!($name))) $($tail)* }
|
|
|
|
))
|
|
|
|
$($tt)*
|
|
|
|
}
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Yaml like function calls - used for setting various meta directly against the app
|
2015-09-08 12:53:31 +00:00
|
|
|
(@app ($builder:expr) ($ident:ident: $($v:expr),*) $($tt:tt)*) => {
|
2016-05-06 21:35:53 +00:00
|
|
|
// clap_app!{ @app ($builder.$ident($($v),*)) $($tt)* }
|
2015-09-09 04:00:17 +00:00
|
|
|
clap_app!{ @app
|
|
|
|
($builder.$ident($($v),*))
|
|
|
|
$($tt)*
|
|
|
|
}
|
2015-09-08 12:53:31 +00:00
|
|
|
};
|
|
|
|
|
2016-05-06 21:35:53 +00:00
|
|
|
// Add members to group and continue argument handling with the parent builder
|
2016-01-21 05:18:53 +00:00
|
|
|
(@group ($builder:expr, $group:expr)) => { $builder.group($group) };
|
2015-09-08 12:53:31 +00:00
|
|
|
(@group ($builder:expr, $group:expr) (@attributes $($attr:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @group ($builder, clap_app!{ @arg ($group) (-) $($attr)* }) $($tt)* }
|
|
|
|
};
|
|
|
|
(@group ($builder:expr, $group:expr) (@arg $name:ident: $($tail:tt)*) $($tt:tt)*) => {
|
|
|
|
clap_app!{ @group
|
|
|
|
(clap_app!{ @app ($builder) (@arg $name: $($tail)*) },
|
2016-01-21 05:18:53 +00:00
|
|
|
$group.arg(stringify!($name)))
|
2015-09-08 12:53:31 +00:00
|
|
|
$($tt)*
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2016-05-06 21:35:53 +00:00
|
|
|
// No more tokens to munch
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt) => { $arg };
|
2016-05-06 21:35:53 +00:00
|
|
|
// Shorthand tokens influenced by the usage_string
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt --$long:ident $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.long(stringify!($long))) $modes $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) $modes:tt -$short:ident $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.short(stringify!($short))) $modes $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) (-) <$var:ident> $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.value_name(stringify!($var))) (+) +takes_value +required $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) (+) <$var:ident> $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.value_name(stringify!($var))) (+) $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) (-) [$var:ident] $($tail:tt)*) => {
|
2015-09-10 12:23:58 +00:00
|
|
|
clap_app!{ @arg ($arg.value_name(stringify!($var))) (+) +takes_value $($tail)* }
|
2015-09-08 12:53:31 +00:00
|
|
|
};
|
|
|
|
(@arg ($arg:expr) (+) [$var:ident] $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.value_name(stringify!($var))) (+) $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) $modes:tt ... $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg) $modes +multiple $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Shorthand magic
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt #{$n:expr, $m:expr} $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg) $modes min_values($n) max_values($m) $($tail)* }
|
|
|
|
};
|
|
|
|
(@arg ($arg:expr) $modes:tt * $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg) $modes +required $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// !foo -> .foo(false)
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt !$ident $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.$ident(false)) $modes $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// foo -> .foo(true)
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt +$ident:ident $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.$ident(true)) $modes $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Validator
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt {$fn_:expr} $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.validator($fn_)) $modes $($tail)* }
|
|
|
|
};
|
|
|
|
(@as_expr $expr:expr) => { $expr };
|
2016-05-06 21:35:53 +00:00
|
|
|
// Help
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt $desc:tt) => { $arg.help(clap_app!{ @as_expr $desc }) };
|
2016-05-06 21:35:53 +00:00
|
|
|
// Handle functions that need to be called multiple times for each argument
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt $ident:ident[$($target:ident)*] $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg $( .$ident(stringify!($target)) )*) $modes $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Inherit builder's functions
|
2015-09-08 12:53:31 +00:00
|
|
|
(@arg ($arg:expr) $modes:tt $ident:ident($($expr:expr)*) $($tail:tt)*) => {
|
|
|
|
clap_app!{ @arg ($arg.$ident($($expr)*)) $modes $($tail)* }
|
|
|
|
};
|
|
|
|
|
2016-05-06 21:35:53 +00:00
|
|
|
// Build a subcommand outside of an app.
|
2015-09-08 12:53:31 +00:00
|
|
|
(@subcommand $name:ident => $($tail:tt)*) => {
|
|
|
|
clap_app!{ @app ($crate::SubCommand::with_name(stringify!($name))) $($tail)* }
|
|
|
|
};
|
2016-05-06 21:35:53 +00:00
|
|
|
// Start the magic
|
2016-12-13 06:42:11 +00:00
|
|
|
(($name:expr) => $($tail:tt)*) => {{
|
|
|
|
clap_app!{ @app ($crate::App::new($name)) $($tail)*}
|
|
|
|
}};
|
|
|
|
|
2015-09-08 12:53:31 +00:00
|
|
|
($name:ident => $($tail:tt)*) => {{
|
|
|
|
clap_app!{ @app ($crate::App::new(stringify!($name))) $($tail)*}
|
|
|
|
}};
|
|
|
|
}
|
2016-01-26 19:02:10 +00:00
|
|
|
|
|
|
|
macro_rules! impl_settings {
|
|
|
|
($n:ident, $($v:ident => $c:ident),+) => {
|
|
|
|
pub fn set(&mut self, s: $n) {
|
|
|
|
match s {
|
|
|
|
$($n::$v => self.0.insert($c)),+
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn unset(&mut self, s: $n) {
|
|
|
|
match s {
|
|
|
|
$($n::$v => self.0.remove($c)),+
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn is_set(&self, s: $n) -> bool {
|
|
|
|
match s {
|
|
|
|
$($n::$v => self.0.contains($c)),+
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
// Convenience for writing to stderr thanks to https://github.com/BurntSushi
|
|
|
|
macro_rules! wlnerr(
|
|
|
|
($($arg:tt)*) => ({
|
|
|
|
use std::io::{Write, stderr};
|
|
|
|
writeln!(&mut stderr(), $($arg)*).ok();
|
|
|
|
})
|
|
|
|
);
|
|
|
|
macro_rules! werr(
|
|
|
|
($($arg:tt)*) => ({
|
|
|
|
use std::io::{Write, stderr};
|
|
|
|
write!(&mut stderr(), $($arg)*).ok();
|
|
|
|
})
|
|
|
|
);
|
|
|
|
|
|
|
|
#[cfg(feature = "debug")]
|
|
|
|
#[cfg_attr(feature = "debug", macro_use)]
|
|
|
|
mod debug_macros {
|
|
|
|
macro_rules! debugln {
|
2016-08-28 03:42:31 +00:00
|
|
|
($fmt:expr) => (println!(concat!("*DEBUG:clap: ", $fmt)));
|
|
|
|
($fmt:expr, $($arg:tt)*) => (println!(concat!("*DEBUG:clap: ",$fmt), $($arg)*));
|
2016-01-26 19:02:10 +00:00
|
|
|
}
|
|
|
|
macro_rules! sdebugln {
|
|
|
|
($fmt:expr) => (println!($fmt));
|
|
|
|
($fmt:expr, $($arg:tt)*) => (println!($fmt, $($arg)*));
|
|
|
|
}
|
|
|
|
macro_rules! debug {
|
2016-08-28 03:42:31 +00:00
|
|
|
($fmt:expr) => (print!(concat!("*DEBUG:clap: ", $fmt)));
|
|
|
|
($fmt:expr, $($arg:tt)*) => (print!(concat!("*DEBUG:clap: ",$fmt), $($arg)*));
|
2016-01-26 19:02:10 +00:00
|
|
|
}
|
|
|
|
macro_rules! sdebug {
|
|
|
|
($fmt:expr) => (print!($fmt));
|
|
|
|
($fmt:expr, $($arg:tt)*) => (print!($fmt, $($arg)*));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(not(feature = "debug"))]
|
|
|
|
#[cfg_attr(not(feature = "debug"), macro_use)]
|
|
|
|
mod debug_macros {
|
|
|
|
macro_rules! debugln {
|
|
|
|
($fmt:expr) => ();
|
|
|
|
($fmt:expr, $($arg:tt)*) => ();
|
|
|
|
}
|
|
|
|
macro_rules! sdebugln {
|
|
|
|
($fmt:expr) => ();
|
|
|
|
($fmt:expr, $($arg:tt)*) => ();
|
|
|
|
}
|
|
|
|
macro_rules! sdebug {
|
|
|
|
($fmt:expr) => ();
|
|
|
|
($fmt:expr, $($arg:tt)*) => ();
|
|
|
|
}
|
|
|
|
macro_rules! debug {
|
|
|
|
($fmt:expr) => ();
|
|
|
|
($fmt:expr, $($arg:tt)*) => ();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Helper/deduplication macro for printing the correct number of spaces in help messages
|
|
|
|
// used in:
|
|
|
|
// src/args/arg_builder/*.rs
|
|
|
|
// src/app/mod.rs
|
|
|
|
macro_rules! write_spaces {
|
|
|
|
($num:expr, $w:ident) => ({
|
|
|
|
debugln!("macro=write_spaces!;");
|
|
|
|
for _ in 0..$num {
|
2016-11-12 17:12:05 +00:00
|
|
|
try!(write!($w, " "));
|
2016-01-26 19:02:10 +00:00
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2016-04-03 04:06:37 +00:00
|
|
|
// Helper/deduplication macro for printing the correct number of spaces in help messages
|
|
|
|
// used in:
|
|
|
|
// src/args/arg_builder/*.rs
|
|
|
|
// src/app/mod.rs
|
|
|
|
macro_rules! write_nspaces {
|
|
|
|
($dst:expr, $num:expr) => ({
|
2016-10-19 22:54:36 +00:00
|
|
|
debugln!("macro=write_spaces!;num={}", $num);
|
2016-04-03 04:06:37 +00:00
|
|
|
for _ in 0..$num {
|
2016-11-12 17:12:05 +00:00
|
|
|
try!($dst.write(b" "));
|
2016-04-03 04:06:37 +00:00
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2016-01-26 19:02:10 +00:00
|
|
|
// convenience macro for remove an item from a vec
|
|
|
|
macro_rules! vec_remove {
|
2016-02-02 10:46:28 +00:00
|
|
|
($vec:expr, $to_rem:expr) => {
|
2016-10-31 04:35:23 +00:00
|
|
|
debugln!("macro=vec_remove!;to_rem={:?}", $to_rem);
|
2016-02-02 10:46:28 +00:00
|
|
|
for i in (0 .. $vec.len()).rev() {
|
|
|
|
let should_remove = &$vec[i] == $to_rem;
|
|
|
|
if should_remove { $vec.swap_remove(i); }
|
2016-01-26 19:02:10 +00:00
|
|
|
}
|
2016-02-02 10:46:28 +00:00
|
|
|
};
|
2016-01-26 19:02:10 +00:00
|
|
|
}
|
2016-02-02 10:46:28 +00:00
|
|
|
|
|
|
|
// convenience macro for remove an item from a vec
|
|
|
|
macro_rules! vec_remove_all {
|
|
|
|
($vec:expr, $to_rem:expr) => {
|
2016-10-31 04:35:23 +00:00
|
|
|
debugln!("macro=vec_remove_all!;to_rem={:?}", $to_rem);
|
2016-02-02 10:46:28 +00:00
|
|
|
for i in (0 .. $vec.len()).rev() {
|
|
|
|
let should_remove = $to_rem.contains(&$vec[i]);
|
|
|
|
if should_remove { $vec.swap_remove(i); }
|
|
|
|
}
|
|
|
|
};
|
2016-02-04 06:14:28 +00:00
|
|
|
}
|