clap/clap_generate/src/generators/shells/bash.rs

// Std
use std::io::Write;

// Internal
use crate::utils;
use crate::Generator;
use clap::*;

/// Generate bash completion file
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct Bash;

impl Generator for Bash {
    fn file_name(&self, name: &str) -> String {
        format!("{}.bash", name)
    }

    fn generate(&self, app: &App, buf: &mut dyn Write) {
        let bin_name = app.get_bin_name().unwrap();

        w!(
            buf,
            format!(
                "_{name}() {{
    local i cur prev opts cmds
    COMPREPLY=()
    cur=\"${{COMP_WORDS[COMP_CWORD]}}\"
    prev=\"${{COMP_WORDS[COMP_CWORD-1]}}\"
    cmd=\"\"
    opts=\"\"

    for i in ${{COMP_WORDS[@]}}
    do
        case \"${{i}}\" in
            {name})
                cmd=\"{cmd}\"
                ;;{subcmds}
            *)
                ;;
        esac
    done

    case \"${{cmd}}\" in
        {cmd})
            opts=\"{name_opts}\"
            if [[ ${{cur}} == -* || ${{COMP_CWORD}} -eq 1 ]] ; then
                COMPREPLY=( $(compgen -W \"${{opts}}\" -- \"${{cur}}\") )
                return 0
            fi
            case \"${{prev}}\" in{name_opts_details}
                *)
                    COMPREPLY=()
                    ;;
            esac
            COMPREPLY=( $(compgen -W \"${{opts}}\" -- \"${{cur}}\") )
            return 0
            ;;{subcmd_details}
    esac
}}

complete -F _{name} -o bashdefault -o default {name}
",
                name = bin_name,
                cmd = bin_name.replace("-", "__"),
                name_opts = all_options_for_path(app, bin_name),
                name_opts_details = option_details_for_path(app, bin_name),
                subcmds = all_subcommands(app),
                subcmd_details = subcommand_details(app)
            )
            .as_bytes()
        );
    }
}

fn all_subcommands(app: &App) -> String {
    debug!("all_subcommands");

    let mut subcmds = vec![String::new()];
    let mut scs = utils::all_subcommands(app)
        .iter()
        .map(|x| x.0.clone())
        .collect::<Vec<_>>();

    scs.sort();
    scs.dedup();

    subcmds.extend(scs.iter().map(|sc| {
        format!(
            "{name})
                cmd+=\"__{fn_name}\"
                ;;",
            name = sc,
            fn_name = sc.replace("-", "__")
        )
    }));

    subcmds.join("\n            ")
}

fn subcommand_details(app: &App) -> String {
    debug!("subcommand_details");

    let mut subcmd_dets = vec![String::new()];
    let mut scs = utils::all_subcommands(app)
        .iter()
        .map(|x| x.1.replace(" ", "__"))
        .collect::<Vec<_>>();

    scs.sort();

    subcmd_dets.extend(scs.iter().map(|sc| {
        format!(
            "{subcmd})
            opts=\"{sc_opts}\"
            if [[ ${{cur}} == -* || ${{COMP_CWORD}} -eq {level} ]] ; then
                COMPREPLY=( $(compgen -W \"${{opts}}\" -- \"${{cur}}\") )
                return 0
            fi
            case \"${{prev}}\" in{opts_details}
                *)
                    COMPREPLY=()
                    ;;
            esac
            COMPREPLY=( $(compgen -W \"${{opts}}\" -- \"${{cur}}\") )
            return 0
            ;;",
            subcmd = sc.replace("-", "__"),
            sc_opts = all_options_for_path(app, &*sc),
            level = sc.split("__").map(|_| 1).sum::<u64>(),
            opts_details = option_details_for_path(app, &*sc)
        )
    }));

    subcmd_dets.join("\n        ")
}

fn option_details_for_path(app: &App, path: &str) -> String {
    debug!("option_details_for_path: path={}", path);

    let p = utils::find_subcommand_with_path(app, path.split("__").skip(1).collect());
    let mut opts = vec![String::new()];

    for o in p.get_opts() {
        if let Some(longs) = o.get_long_and_visible_aliases() {
            opts.extend(longs.iter().map(|long| {
                format!(
                    "--{})
                    COMPREPLY=({})
                    return 0
                    ;;",
                    long,
                    vals_for(o)
                )
            }));
        }

        if let Some(shorts) = o.get_short_and_visible_aliases() {
            opts.extend(shorts.iter().map(|short| {
                format!(
                    "-{})
                    COMPREPLY=({})
                    return 0
                    ;;",
                    short,
                    vals_for(o)
                )
            }));
        }
    }

    opts.join("\n                ")
}

fn vals_for(o: &Arg) -> String {
    debug!("vals_for: o={}", o.get_name());

    if let Some(vals) = o.get_possible_values() {
        format!(
            "$(compgen -W \"{}\" -- \"${{cur}}\")",
            vals.iter()
                .filter_map(ArgValue::get_visible_name)
                .collect::<Vec<_>>()
                .join(" ")
        )
    } else {
        String::from("$(compgen -f \"${cur}\")")
    }
}

fn all_options_for_path(app: &App, path: &str) -> String {
    debug!("all_options_for_path: path={}", path);

    let p = utils::find_subcommand_with_path(app, path.split("__").skip(1).collect());
    let scs: Vec<_> = utils::subcommands(p).iter().map(|x| x.0.clone()).collect();

    let opts = format!(
        "{shorts} {longs} {pos} {subcmds}",
        shorts = utils::shorts_and_visible_aliases(p)
            .iter()
            .fold(String::new(), |acc, s| format!("{} -{}", acc, s)),
        longs = utils::longs_and_visible_aliases(p)
            .iter()
            .fold(String::new(), |acc, l| format!("{} --{}", acc, l)),
        pos = p.get_positionals().fold(String::new(), |acc, p| {
            if let Some(vals) = p.get_possible_values() {
                format!(
                    "{} {}",
                    acc,
                    vals.iter()
                        .map(|x| x.get_name())
                        .collect::<Vec<_>>()
                        .join(" ")
                )
            } else {
                format!("{} {}", acc, p)
            }
        }),
        subcmds = scs.join(" "),
    );

    opts
}