clap-v3 3.0.0-beta.1

A simple to use, efficient, and full-featured Command Line Argument Parser
Documentation
// Std
use std::collections::HashMap;
use std::ffi::OsStr;
use std::mem;
use std::ops::Deref;

// Internal
use crate::build::{Arg, ArgSettings};
use crate::parse::{ArgMatches, MatchedArg, SubCommand};

type Id = u64;

#[doc(hidden)]
#[derive(Debug)]
pub struct ArgMatcher(pub ArgMatches);

impl Default for ArgMatcher {
    fn default() -> Self {
        ArgMatcher(ArgMatches::default())
    }
}

impl Deref for ArgMatcher {
    type Target = ArgMatches;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl ArgMatcher {
    pub fn into_inner(self) -> ArgMatches {
        self.0
    }

    #[allow(dead_code)]
    pub fn is_present(&self, name: Id) -> bool {
        self.0._id_is_present(name)
    }

    pub fn propagate_globals(&mut self, global_arg_vec: &[Id]) {
        debugln!(
            "ArgMatcher::get_global_values: global_arg_vec={:?}",
            global_arg_vec
        );
        let mut vals_map = HashMap::new();
        self.fill_in_global_values(global_arg_vec, &mut vals_map);
    }

    fn fill_in_global_values(
        &mut self,
        global_arg_vec: &[Id],
        vals_map: &mut HashMap<Id, MatchedArg>,
    ) {
        for &global_arg in global_arg_vec {
            if let Some(ma) = self.get(global_arg) {
                // We have to check if the parent's global arg wasn't used but still exists
                // such as from a default value.
                //
                // For example, `myprog subcommand --global-arg=value` where --global-arg defines
                // a default value of `other` myprog would have an existing MatchedArg for
                // --global-arg where the value is `other`, however the occurs will be 0.
                let to_update = if let Some(parent_ma) = vals_map.get(&global_arg) {
                    if parent_ma.occurs > 0 && ma.occurs == 0 {
                        parent_ma.clone()
                    } else {
                        ma.clone()
                    }
                } else {
                    ma.clone()
                };
                vals_map.insert(global_arg, to_update);
            }
        }
        if let Some(ref mut sc) = self.0.subcommand {
            let mut am = ArgMatcher(mem::replace(&mut sc.matches, ArgMatches::new()));
            am.fill_in_global_values(global_arg_vec, vals_map);
            mem::swap(&mut am.0, &mut sc.matches);
        }

        for (&name, matched_arg) in vals_map.iter_mut() {
            self.0.args.insert(name, matched_arg.clone());
        }
    }

    pub fn get_mut(&mut self, arg: Id) -> Option<&mut MatchedArg> {
        self.0.args.get_mut(&arg)
    }

    pub fn get(&self, arg: Id) -> Option<&MatchedArg> {
        self.0.args.get(&arg)
    }

    pub fn remove(&mut self, arg: Id) {
        self.0.args.swap_remove(&arg);
    }

    #[allow(dead_code)]
    pub fn remove_all(&mut self, args: &[Id]) {
        for arg in args {
            self.0.args.swap_remove(arg);
        }
    }

    pub fn insert(&mut self, name: Id) {
        self.0.args.insert(name, MatchedArg::new());
    }

    pub fn contains(&self, arg: Id) -> bool {
        self.0.args.contains_key(&arg)
    }

    pub fn is_empty(&self) -> bool {
        self.0.args.is_empty()
    }

    pub fn arg_names(&self) -> indexmap::map::Keys<Id, MatchedArg> {
        self.0.args.keys()
    }

    pub fn entry(&mut self, arg: Id) -> indexmap::map::Entry<Id, MatchedArg> {
        self.0.args.entry(arg)
    }

    pub fn subcommand(&mut self, sc: SubCommand) {
        self.0.subcommand = Some(Box::new(sc));
    }

    pub fn subcommand_name(&self) -> Option<&str> {
        self.0.subcommand_name()
    }

    pub fn iter(&self) -> indexmap::map::Iter<Id, MatchedArg> {
        self.0.args.iter()
    }

    pub fn inc_occurrence_of(&mut self, arg: Id) {
        debugln!("ArgMatcher::inc_occurrence_of: arg={}", arg);
        if let Some(a) = self.get_mut(arg) {
            a.occurs += 1;
            return;
        }
        debugln!("ArgMatcher::inc_occurrence_of: first instance");
        self.insert(arg);
    }

    pub fn add_val_to(&mut self, arg: Id, val: &OsStr) {
        let ma = self.entry(arg).or_insert(MatchedArg {
            occurs: 0, // @TODO @question Shouldn't this be 1 if we're already adding a value to this arg?
            indices: Vec::with_capacity(1),
            vals: Vec::with_capacity(1),
        });
        ma.vals.push(val.to_owned());
    }

    pub fn add_index_to(&mut self, arg: Id, idx: usize) {
        let ma = self.entry(arg).or_insert(MatchedArg {
            occurs: 0,
            indices: Vec::with_capacity(1),
            vals: Vec::new(),
        });
        ma.indices.push(idx);
    }

    pub fn needs_more_vals(&self, o: &Arg) -> bool {
        debugln!("ArgMatcher::needs_more_vals: o={}", o.name);
        if let Some(ma) = self.get(o.id) {
            if let Some(num) = o.num_vals {
                debugln!("ArgMatcher::needs_more_vals: num_vals...{}", num);
                return if o.is_set(ArgSettings::MultipleValues) {
                    ((ma.vals.len() as u64) % num) != 0
                } else {
                    num != (ma.vals.len() as u64)
                };
            } else if let Some(num) = o.max_vals {
                debugln!("ArgMatcher::needs_more_vals: max_vals...{}", num);
                return (ma.vals.len() as u64) <= num;
            } else if o.min_vals.is_some() {
                debugln!("ArgMatcher::needs_more_vals: min_vals...true");
                return true;
            }
            return o.is_set(ArgSettings::MultipleValues);
        }
        true
    }
}