src/vendor/clap/src/args/arg_builder/flag.rs

   1 // Std
   2 use std::convert::From;
   3 use std::fmt::{Display, Formatter, Result};
   4 use std::rc::Rc;
   5 use std::result::Result as StdResult;
   6 use std::ffi::{OsStr, OsString};
   7 use std::mem;
   8
   9 // Third Party
  10 use vec_map::{self, VecMap};
  11
  12 // Internal
  13 use Arg;
  14 use args::{ArgSettings, Base, Switched, AnyArg, DispOrder};
  15
  16 #[derive(Default, Clone, Debug)]
  17 #[doc(hidden)]
  18 pub struct FlagBuilder<'n, 'e>
  19     where 'n: 'e
  20 {
  21     pub b: Base<'n, 'e>,
  22     pub s: Switched<'e>,
  23 }
  24
  25 impl<'n, 'e> FlagBuilder<'n, 'e> {
  26     pub fn new(name: &'n str) -> Self { FlagBuilder { b: Base::new(name), ..Default::default() } }
  27 }
  28
  29 impl<'a, 'b, 'z> From<&'z Arg<'a, 'b>> for FlagBuilder<'a, 'b> {
  30     fn from(a: &'z Arg<'a, 'b>) -> Self {
  31         FlagBuilder {
  32             b: Base::from(a),
  33             s: Switched::from(a),
  34         }
  35     }
  36 }
  37
  38 impl<'a, 'b> From<Arg<'a, 'b>> for FlagBuilder<'a, 'b> {
  39     fn from(mut a: Arg<'a, 'b>) -> Self {
  40         FlagBuilder {
  41             b: mem::replace(&mut a.b, Base::default()),
  42             s: mem::replace(&mut a.s, Switched::default()),
  43         }
  44     }
  45 }
  46
  47 impl<'n, 'e> Display for FlagBuilder<'n, 'e> {
  48     fn fmt(&self, f: &mut Formatter) -> Result {
  49         if let Some(l) = self.s.long {
  50             try!(write!(f, "--{}", l));
  51         } else {
  52             try!(write!(f, "-{}", self.s.short.unwrap()));
  53         }
  54
  55         Ok(())
  56     }
  57 }
  58
  59 impl<'n, 'e> AnyArg<'n, 'e> for FlagBuilder<'n, 'e> {
  60     fn name(&self) -> &'n str { self.b.name }
  61     fn overrides(&self) -> Option<&[&'e str]> { self.b.overrides.as_ref().map(|o| &o[..]) }
  62     fn requires(&self) -> Option<&[(Option<&'e str>, &'n str)]> {
  63         self.b.requires.as_ref().map(|o| &o[..])
  64     }
  65     fn blacklist(&self) -> Option<&[&'e str]> { self.b.blacklist.as_ref().map(|o| &o[..]) }
  66     fn required_unless(&self) -> Option<&[&'e str]> { None }
  67     fn is_set(&self, s: ArgSettings) -> bool { self.b.settings.is_set(s) }
  68     fn has_switch(&self) -> bool { true }
  69     fn takes_value(&self) -> bool { false }
  70     fn set(&mut self, s: ArgSettings) { self.b.settings.set(s) }
  71     fn max_vals(&self) -> Option<u64> { None }
  72     fn val_names(&self) -> Option<&VecMap<&'e str>> { None }
  73     fn num_vals(&self) -> Option<u64> { None }
  74     fn possible_vals(&self) -> Option<&[&'e str]> { None }
  75     fn validator(&self) -> Option<&Rc<Fn(String) -> StdResult<(), String>>> { None }
  76     fn validator_os(&self) -> Option<&Rc<Fn(&OsStr) -> StdResult<(), OsString>>> { None }
  77     fn min_vals(&self) -> Option<u64> { None }
  78     fn short(&self) -> Option<char> { self.s.short }
  79     fn long(&self) -> Option<&'e str> { self.s.long }
  80     fn val_delim(&self) -> Option<char> { None }
  81     fn help(&self) -> Option<&'e str> { self.b.help }
  82     fn val_terminator(&self) -> Option<&'e str> { None }
  83     fn default_val(&self) -> Option<&'e OsStr> { None }
  84     fn default_vals_ifs(&self) -> Option<vec_map::Values<(&'n str, Option<&'e OsStr>, &'e OsStr)>> {
  85         None
  86     }
  87     fn longest_filter(&self) -> bool { self.s.long.is_some() }
  88     fn aliases(&self) -> Option<Vec<&'e str>> {
  89         if let Some(ref aliases) = self.s.aliases {
  90             let vis_aliases: Vec<_> = aliases.iter()
  91                 .filter_map(|&(n, v)| if v { Some(n) } else { None })
  92                 .collect();
  93             if vis_aliases.is_empty() {
  94                 None
  95             } else {
  96                 Some(vis_aliases)
  97             }
  98         } else {
  99             None
 100         }
 101     }
 102 }
 103
 104 impl<'n, 'e> DispOrder for FlagBuilder<'n, 'e> {
 105     fn disp_ord(&self) -> usize { self.s.disp_ord }
 106 }
 107
 108 impl<'n, 'e> PartialEq for FlagBuilder<'n, 'e> {
 109     fn eq(&self, other: &FlagBuilder<'n, 'e>) -> bool {
 110         self.b == other.b
 111     }
 112 }
 113
 114 #[cfg(test)]
 115 mod test {
 116     use args::settings::ArgSettings;
 117     use super::FlagBuilder;
 118
 119     #[test]
 120     fn flagbuilder_display() {
 121         let mut f = FlagBuilder::new("flg");
 122         f.b.settings.set(ArgSettings::Multiple);
 123         f.s.long = Some("flag");
 124
 125         assert_eq!(&*format!("{}", f), "--flag");
 126
 127         let mut f2 = FlagBuilder::new("flg");
 128         f2.s.short = Some('f');
 129
 130         assert_eq!(&*format!("{}", f2), "-f");
 131     }
 132
 133     #[test]
 134     fn flagbuilder_display_single_alias() {
 135         let mut f = FlagBuilder::new("flg");
 136         f.s.long = Some("flag");
 137         f.s.aliases = Some(vec![("als", true)]);
 138
 139         assert_eq!(&*format!("{}", f), "--flag");
 140     }
 141
 142     #[test]
 143     fn flagbuilder_display_multiple_aliases() {
 144         let mut f = FlagBuilder::new("flg");
 145         f.s.short = Some('f');
 146         f.s.aliases =
 147             Some(vec![("alias_not_visible", false), ("f2", true), ("f3", true), ("f4", true)]);
 148         assert_eq!(&*format!("{}", f), "-f");
 149     }
 150 }