Struct aopt_help::store::Store

pub struct Store<'a> { /* private fields */ }

Implementations

impl<'a> Store<'a>

pub fn new<S: Into<Cow<'a, str>>>(
    name: S,
    hint: S,
    help: S,
    type: S,
    optional: bool,
    position: bool
) -> Self

pub fn name(&self) -> Cow<'a, str>

Examples found in repository

src/cmd.rs (line 75)

    pub fn find_store<S: Into<Cow<'a, str>>>(&self, name: S) -> Option<&Store<'a>> {
        let name = name.into();
        self.stores.iter().find(|v| v.name() == name)
    }

    pub fn find_store_mut<S: Into<Cow<'a, str>>>(&mut self, name: S) -> Option<&mut Store<'a>> {
        let name = name.into();
        self.stores.iter_mut().find(|v| v.name() == name)
    }

    pub fn find_block<S: Into<Cow<'a, str>>>(&self, name: S) -> Option<&Block<'a, Cow<'a, str>>> {
        let name = name.into();
        self.blocks.iter().find(|v| v.name() == name)
    }

    pub fn find_block_mut<S: Into<Cow<'a, str>>>(
        &mut self,
        name: S,
    ) -> Option<&mut Block<'a, Cow<'a, str>>> {
        let name = name.into();
        self.blocks.iter_mut().find(|v| v.name() == name)
    }

    pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self {
        self.name = name.into();
        self
    }

    pub fn set_hint<S: Into<Cow<'a, str>>>(&mut self, hint: S) -> &mut Self {
        self.hint = hint.into();
        self
    }

    pub fn set_help<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.help = help.into();
        self
    }

    pub fn set_foot<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.foot = help.into();
        self
    }

    pub fn set_head<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.head = help.into();
        self
    }

    pub fn add_store<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        store: Store<'a>,
    ) -> Result<&mut Self, Error> {
        let name: Cow<'a, str> = block.into();

        if self.find_store(name.clone()).is_some() {
            Err(Error::DuplicatedStoreName(store.name().to_string()))
        } else {
            let block = self
                .find_block_mut(name.clone())
                .ok_or_else(|| Error::InvalidBlockName(name.to_string()))?;

            block.attach(store.name());
            self.stores.push(store);
            Ok(self)
        }
    }

    pub fn add_block(&mut self, block: Block<'a, Cow<'a, str>>) -> Result<&mut Self, Error> {
        let name = block.name();

        if self.find_block(name.clone()).is_some() {
            Err(Error::DuplicatedBlockName(name.to_string()))
        } else {
            self.blocks.push(block);
            Ok(self)
        }
    }

    pub fn new_store<S: Into<Cow<'a, str>>>(
        &mut self,
        block: S,
        name: S,
    ) -> Result<AddStore2Block<'a, '_>, Error> {
        let name = name.into();

        if self.find_store(name.clone()).is_some() {
            Err(Error::DuplicatedStoreName(name.to_string()))
        } else {
            let block = block.into();
            let block = self
                .blocks
                .iter_mut()
                .find(|v| v.name() == block)
                .ok_or_else(|| Error::InvalidBlockName(block.to_string()))?;
            let stores = &mut self.stores;

            Ok(AddStore2Block::new(block, stores, name))
        }
    }

    pub fn new_block<S: Into<Cow<'a, str>>>(&mut self, name: S) -> Result<BlockMut<'a, '_>, Error> {
        let name = name.into();

        if self.find_block(name.clone()).is_some() {
            Err(Error::DuplicatedBlockName(name.to_string()))
        } else {
            Ok(BlockMut::new(self, name))
        }
    }
}

impl<'a> Deref for Command<'a> {
    type Target = Vec<Store<'a>>;

    fn deref(&self) -> &Self::Target {
        &self.stores
    }
}

impl<'a> DerefMut for Command<'a> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.stores
    }
}

impl<'b> HelpDisplay for Command<'b> {
    fn gen_help<'a, P>(&self, policy: &P) -> Option<Cow<'a, str>>
    where
        Self: 'a,
        P: HelpPolicy<'a, Self>,
    {
        policy.format(self)
    }
}

pub struct AddStore2Block<'a, 'b> {
    store: Store<'a>,

    block: &'b mut Block<'a, Cow<'a, str>>,

    stores: &'b mut Vec<Store<'a>>,

    added: bool,
}

impl<'a, 'b> AddStore2Block<'a, 'b> {
    pub fn new<S: Into<Cow<'a, str>>>(
        block: &'b mut Block<'a, Cow<'a, str>>,
        stores: &'b mut Vec<Store<'a>>,
        name: S,
    ) -> Self {
        let mut store = Store::default();

        store.set_optional(true);
        store.set_name(name);
        Self {
            block,
            store,
            stores,
            added: false,
        }
    }

    pub fn set_optional(&mut self, optional: bool) -> &mut Self {
        self.store.set_optional(optional);
        self
    }

    pub fn set_position(&mut self, position: bool) -> &mut Self {
        self.store.set_position(position);
        self
    }

    pub fn set_hint<S: Into<Cow<'a, str>>>(&mut self, hint: S) -> &mut Self {
        self.store.set_hint(hint);
        self
    }

    pub fn set_help<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.store.set_help(help);
        self
    }

    pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self {
        self.store.set_name(name);
        self
    }

    pub fn set_type<S: Into<Cow<'a, str>>>(&mut self, type_name: S) -> &mut Self {
        self.store.set_type(type_name);
        self
    }

    pub fn submit(mut self) {
        if !self.added {
            let store = std::mem::take(&mut self.store);

            self.block.attach(store.name());
            self.stores.push(store);
            self.added = true;
        }
    }
}

impl<'a, 'b> Drop for AddStore2Block<'a, 'b> {
    fn drop(&mut self) {
        if !self.added {
            let store = std::mem::take(&mut self.store);

            self.block.attach(store.name());
            self.stores.push(store);
            self.added = true;
        }
    }

src/format/policy.rs (line 70)

    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_command_usage(&self, item: &Command<'a>) -> Cow<'a, str> {
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in item.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, item);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in item.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        let usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let args = args.join(" ");

        if !self.name.is_empty() {
            ret += &self.name;
            ret += " ";
        }
        if !item.name().is_empty() {
            ret += &item.name();
            ret += " ";
        }
        if !usage.is_empty() {
            ret += &usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
    ) -> Cow<'a, str> {
        let style = &self.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
    fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
        let usage = self.get_command_usage(item);
        let mut blocks = vec![usage];
        let head = item.head();
        let foot = item.foot();
        let block_spacing = "\n".repeat(1 + self.style.block_spacing);

        if !head.is_empty() {
            blocks.push(head);
        }
        for block in item.block() {
            if !block.is_empty() {
                let help = self.get_block_help(block, item);

                if !help.is_empty() {
                    blocks.push(help);
                }
            }
        }
        if !foot.is_empty() {
            blocks.push(foot);
        }
        Some(blocks.join(&block_spacing).into())
    }
}

pub struct DefaultAppPolicy<'a, I> {
    styles: Vec<Style>, // style for every block

    show_global: bool,

    hiding_pos: bool,

    marker: PhantomData<&'a I>,
}

impl<'a, I> Default for DefaultAppPolicy<'a, I> {
    fn default() -> Self {
        Self {
            styles: Default::default(),
            show_global: true,
            hiding_pos: true,
            marker: Default::default(),
        }
    }
}

impl<'a, I> DefaultAppPolicy<'a, I> {
    pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
        Self {
            styles,
            show_global,
            hiding_pos: true,
            marker: PhantomData::default(),
        }
    }
}

impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
        let global = app.global();
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in global.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, global);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in global.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        // all the option usage
        let global_usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
        let args = args.join(" ");

        if !global.name().is_empty() {
            ret += &global.name();
            ret += " ";
        }
        if !global_usage.is_empty() {
            ret += &global_usage;
            ret += " ";
        }
        if !command_usage.is_empty() {
            ret += &command_usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

    pub fn get_global_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let style = &app.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        if item.is_empty() {
            return "".into();
        }
        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }

pub fn hint(&self) -> Cow<'a, str>

Examples found in repository

src/format/policy.rs (line 71)

    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_command_usage(&self, item: &Command<'a>) -> Cow<'a, str> {
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in item.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, item);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in item.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        let usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let args = args.join(" ");

        if !self.name.is_empty() {
            ret += &self.name;
            ret += " ";
        }
        if !item.name().is_empty() {
            ret += &item.name();
            ret += " ";
        }
        if !usage.is_empty() {
            ret += &usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
    ) -> Cow<'a, str> {
        let style = &self.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
    fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
        let usage = self.get_command_usage(item);
        let mut blocks = vec![usage];
        let head = item.head();
        let foot = item.foot();
        let block_spacing = "\n".repeat(1 + self.style.block_spacing);

        if !head.is_empty() {
            blocks.push(head);
        }
        for block in item.block() {
            if !block.is_empty() {
                let help = self.get_block_help(block, item);

                if !help.is_empty() {
                    blocks.push(help);
                }
            }
        }
        if !foot.is_empty() {
            blocks.push(foot);
        }
        Some(blocks.join(&block_spacing).into())
    }
}

pub struct DefaultAppPolicy<'a, I> {
    styles: Vec<Style>, // style for every block

    show_global: bool,

    hiding_pos: bool,

    marker: PhantomData<&'a I>,
}

impl<'a, I> Default for DefaultAppPolicy<'a, I> {
    fn default() -> Self {
        Self {
            styles: Default::default(),
            show_global: true,
            hiding_pos: true,
            marker: Default::default(),
        }
    }
}

impl<'a, I> DefaultAppPolicy<'a, I> {
    pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
        Self {
            styles,
            show_global,
            hiding_pos: true,
            marker: PhantomData::default(),
        }
    }
}

impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
        let global = app.global();
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in global.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, global);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in global.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        // all the option usage
        let global_usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
        let args = args.join(" ");

        if !global.name().is_empty() {
            ret += &global.name();
            ret += " ";
        }
        if !global_usage.is_empty() {
            ret += &global_usage;
            ret += " ";
        }
        if !command_usage.is_empty() {
            ret += &command_usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

    pub fn get_global_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let style = &app.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        if item.is_empty() {
            return "".into();
        }
        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }

pub fn help(&self) -> Cow<'a, str>

Examples found in repository

src/format/policy.rs (line 168)

    pub fn get_block_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
    ) -> Cow<'a, str> {
        let style = &self.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
    fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
        let usage = self.get_command_usage(item);
        let mut blocks = vec![usage];
        let head = item.head();
        let foot = item.foot();
        let block_spacing = "\n".repeat(1 + self.style.block_spacing);

        if !head.is_empty() {
            blocks.push(head);
        }
        for block in item.block() {
            if !block.is_empty() {
                let help = self.get_block_help(block, item);

                if !help.is_empty() {
                    blocks.push(help);
                }
            }
        }
        if !foot.is_empty() {
            blocks.push(foot);
        }
        Some(blocks.join(&block_spacing).into())
    }
}

pub struct DefaultAppPolicy<'a, I> {
    styles: Vec<Style>, // style for every block

    show_global: bool,

    hiding_pos: bool,

    marker: PhantomData<&'a I>,
}

impl<'a, I> Default for DefaultAppPolicy<'a, I> {
    fn default() -> Self {
        Self {
            styles: Default::default(),
            show_global: true,
            hiding_pos: true,
            marker: Default::default(),
        }
    }
}

impl<'a, I> DefaultAppPolicy<'a, I> {
    pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
        Self {
            styles,
            show_global,
            hiding_pos: true,
            marker: PhantomData::default(),
        }
    }
}

impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
        let global = app.global();
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in global.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, global);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in global.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        // all the option usage
        let global_usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
        let args = args.join(" ");

        if !global.name().is_empty() {
            ret += &global.name();
            ret += " ";
        }
        if !global_usage.is_empty() {
            ret += &global_usage;
            ret += " ";
        }
        if !command_usage.is_empty() {
            ret += &command_usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        block: &Block<'a, Cow<'a, str>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let head = block.head();
        let foot = block.foot();
        let count = block.len();
        let mut data = vec![vec![]; count];
        let styles = &self.styles;
        let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
        let mut any_filled = false;

        if block.is_empty() {
            return "".into();
        }
        for (name, data_mut) in block.iter().zip(data.iter_mut()) {
            if let Some(command) = app.find_cmd(name.clone()) {
                let hint = command.hint();
                let help = command.help();

                if !hint.is_empty() {
                    data_mut.push(hint);
                    any_filled = true;
                }
                if !help.is_empty() {
                    data_mut.push(help);
                    any_filled = true;
                }
            } else {
                panic!("Unknow command {} in block {}", name, block.name());
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }

        if !wrapped_lines.is_empty() {
            // pop last line spacing
            wrapped_lines.last_mut().unwrap().pop();
        }

        let mut usages = vec![];
        let wrapped_output = wrapped_lines.join("");

        if !head.is_empty() {
            usages.push(head);
        }
        if !foot.is_empty() {
            usages.push(foot);
        }
        if !wrapped_output.is_empty() {
            usages.push(wrapped_output.into());
        }

        usages.join(line_spacing).into()
    }

    pub fn get_global_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
        app: &AppHelp<'a, W>,
    ) -> Cow<'a, str> {
        let style = &app.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        if item.is_empty() {
            return "".into();
        }
        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }

pub fn optional(&self) -> bool

Examples found in repository

src/format/policy.rs (line 75)

    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_command_usage(&self, item: &Command<'a>) -> Cow<'a, str> {
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in item.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, item);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in item.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        let usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let args = args.join(" ");

        if !self.name.is_empty() {
            ret += &self.name;
            ret += " ";
        }
        if !item.name().is_empty() {
            ret += &item.name();
            ret += " ";
        }
        if !usage.is_empty() {
            ret += &usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
    ) -> Cow<'a, str> {
        let style = &self.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
    fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
        let usage = self.get_command_usage(item);
        let mut blocks = vec![usage];
        let head = item.head();
        let foot = item.foot();
        let block_spacing = "\n".repeat(1 + self.style.block_spacing);

        if !head.is_empty() {
            blocks.push(head);
        }
        for block in item.block() {
            if !block.is_empty() {
                let help = self.get_block_help(block, item);

                if !help.is_empty() {
                    blocks.push(help);
                }
            }
        }
        if !foot.is_empty() {
            blocks.push(foot);
        }
        Some(blocks.join(&block_spacing).into())
    }
}

pub struct DefaultAppPolicy<'a, I> {
    styles: Vec<Style>, // style for every block

    show_global: bool,

    hiding_pos: bool,

    marker: PhantomData<&'a I>,
}

impl<'a, I> Default for DefaultAppPolicy<'a, I> {
    fn default() -> Self {
        Self {
            styles: Default::default(),
            show_global: true,
            hiding_pos: true,
            marker: Default::default(),
        }
    }
}

impl<'a, I> DefaultAppPolicy<'a, I> {
    pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
        Self {
            styles,
            show_global,
            hiding_pos: true,
            marker: PhantomData::default(),
        }
    }
}

impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

pub fn position(&self) -> bool

Examples found in repository

src/cmd.rs (line 70)

    pub fn has_position(&self) -> bool {
        self.stores.iter().any(|store| store.position())
    }

src/format/policy.rs (line 74)

    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

    pub fn get_command_usage(&self, item: &Command<'a>) -> Cow<'a, str> {
        let mut usages = vec![];
        let mut args = vec![];
        let mut block_hint = vec![];

        for block in item.block() {
            let (mut block_usages, mut block_args) = self.get_block_usage(block, item);

            if !block_usages.is_empty() {
                usages.append(&mut block_usages);
            }
            // if not omit args, using the args, otherwise using hint of block
            if !block_args.is_empty() {
                args.append(&mut block_args);
            }
        }
        for block in item.block() {
            if !block.is_empty() {
                let arg = block.hint();

                if !arg.is_empty() {
                    block_hint.push(arg);
                }
            }
        }

        let mut ret = String::from("Usage: ");
        let usage = usages.join(" ");
        let block_hint = block_hint.join(" ");
        let args = args.join(" ");

        if !self.name.is_empty() {
            ret += &self.name;
            ret += " ";
        }
        if !item.name().is_empty() {
            ret += &item.name();
            ret += " ";
        }
        if !usage.is_empty() {
            ret += &usage;
            ret += " ";
        }
        if self.hiding_pos {
            if !block_hint.is_empty() {
                ret += &block_hint;
                ret += " ";
            }
        } else {
            if !args.is_empty() {
                ret += &args;
                ret += " ";
            }
        }
        ret.into()
    }

    pub fn get_block_help(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &Vec<Store<'a>>,
    ) -> Cow<'a, str> {
        let style = &self.style;
        let count = item.len();
        let head = item.head();
        let foot = item.foot();
        let line_spacing = &"\n".repeat(1 + style.line_spacing);
        let mut output = if head.is_empty() { vec![] } else { vec![head] };
        let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
        let blocks = item.as_slice();
        let styles = &self.styles;
        let mut any_filled = false;

        for idx in 0..count {
            for store in stores {
                if store.name() == blocks[idx] {
                    let hint = store.hint();
                    let help = store.help();

                    if !hint.is_empty() {
                        data[idx].push(hint);
                        any_filled = true;
                    }
                    if !help.is_empty() {
                        data[idx].push(help);
                        any_filled = true;
                    }
                }
            }
        }
        if !any_filled {
            return "".into();
        }
        let mut wrapper = Wrapper::new(&data);

        if !styles.is_empty() {
            wrapper.wrap_with(styles);
        } else {
            wrapper.wrap();
        }
        let wrapped = wrapper.get_output();
        let mut wrapped_lines = vec![];

        for wrapped_line in wrapped {
            let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
            let first_style = wrapped_line[0].get_style();
            let first_row_spacing = &" ".repeat(first_style.row_spacing);
            let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);

            for i in 0..max_len {
                let rows = &wrapped_line
                    .iter()
                    .map(|v| v.get_line(i))
                    .collect::<Vec<String>>();
                let mut line = rows.join(first_row_spacing);

                line.push_str(first_line_spacing);
                wrapped_lines.push(line);
            }
        }
        let wrapped_output = wrapped_lines.join("");

        if !wrapped_output.is_empty() {
            output.push(wrapped_output.into());
        }
        if !foot.is_empty() {
            output.push(foot);
        }
        let output = output.join(line_spacing);
        let output = output.trim_end().to_owned();

        output.into()
    }
}

impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
    fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
        let usage = self.get_command_usage(item);
        let mut blocks = vec![usage];
        let head = item.head();
        let foot = item.foot();
        let block_spacing = "\n".repeat(1 + self.style.block_spacing);

        if !head.is_empty() {
            blocks.push(head);
        }
        for block in item.block() {
            if !block.is_empty() {
                let help = self.get_block_help(block, item);

                if !help.is_empty() {
                    blocks.push(help);
                }
            }
        }
        if !foot.is_empty() {
            blocks.push(foot);
        }
        Some(blocks.join(&block_spacing).into())
    }
}

pub struct DefaultAppPolicy<'a, I> {
    styles: Vec<Style>, // style for every block

    show_global: bool,

    hiding_pos: bool,

    marker: PhantomData<&'a I>,
}

impl<'a, I> Default for DefaultAppPolicy<'a, I> {
    fn default() -> Self {
        Self {
            styles: Default::default(),
            show_global: true,
            hiding_pos: true,
            marker: Default::default(),
        }
    }
}

impl<'a, I> DefaultAppPolicy<'a, I> {
    pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
        Self {
            styles,
            show_global,
            hiding_pos: true,
            marker: PhantomData::default(),
        }
    }
}

impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
    pub fn get_block_usage(
        &self,
        item: &Block<'a, Cow<'a, str>>,
        stores: &[Store<'a>],
    ) -> (Vec<String>, Vec<String>) {
        let mut usages = vec![];
        let mut args = vec![];

        for store in item.iter() {
            if let Some(store) = stores.iter().find(|v| &v.name() == store) {
                let hint = store.hint();

                if !hint.is_empty() {
                    if store.position() {
                        if store.optional() {
                            args.push(format!("[{}]", hint));
                        } else {
                            args.push(format!("<{}>", hint));
                        }
                    } else if store.optional() {
                        usages.push(format!("[{}]", hint));
                    } else {
                        usages.push(format!("<{}>", hint));
                    }
                }
            }
        }
        (usages, args)
    }

pub fn type(&self) -> Cow<'a, str>

pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self

Examples found in repository

src/lib.rs (line 327)

    pub fn new<S: Into<Cow<'a, str>>>(block: &'b mut Block<'a, Store<'a>>, name: S) -> Self {
        let mut store = Store::default();

        store.set_optional(true);
        store.set_name(name);
        Self {
            block,
            store,
            added: false,
        }
    }

    pub fn set_optional(mut self, optional: bool) -> Self {
        self.store.set_optional(optional);
        self
    }

    pub fn set_position(mut self, position: bool) -> Self {
        self.store.set_position(position);
        self
    }

    pub fn set_hint<S: Into<Cow<'a, str>>>(mut self, hint: S) -> Self {
        self.store.set_hint(hint);
        self
    }

    pub fn set_help<S: Into<Cow<'a, str>>>(mut self, help: S) -> Self {
        self.store.set_help(help);
        self
    }

    pub fn set_name<S: Into<Cow<'a, str>>>(mut self, name: S) -> Self {
        self.store.set_name(name);
        self
    }

src/cmd.rs (line 228)

    pub fn new<S: Into<Cow<'a, str>>>(
        block: &'b mut Block<'a, Cow<'a, str>>,
        stores: &'b mut Vec<Store<'a>>,
        name: S,
    ) -> Self {
        let mut store = Store::default();

        store.set_optional(true);
        store.set_name(name);
        Self {
            block,
            store,
            stores,
            added: false,
        }
    }

    pub fn set_optional(&mut self, optional: bool) -> &mut Self {
        self.store.set_optional(optional);
        self
    }

    pub fn set_position(&mut self, position: bool) -> &mut Self {
        self.store.set_position(position);
        self
    }

    pub fn set_hint<S: Into<Cow<'a, str>>>(&mut self, hint: S) -> &mut Self {
        self.store.set_hint(hint);
        self
    }

    pub fn set_help<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.store.set_help(help);
        self
    }

    pub fn set_name<S: Into<Cow<'a, str>>>(&mut self, name: S) -> &mut Self {
        self.store.set_name(name);
        self
    }

pub fn set_hint<S: Into<Cow<'a, str>>>(&mut self, hint: S) -> &mut Self

Examples found in repository

src/lib.rs (line 346)

    pub fn set_hint<S: Into<Cow<'a, str>>>(mut self, hint: S) -> Self {
        self.store.set_hint(hint);
        self
    }

src/cmd.rs (line 248)

    pub fn set_hint<S: Into<Cow<'a, str>>>(&mut self, hint: S) -> &mut Self {
        self.store.set_hint(hint);
        self
    }

pub fn set_help<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self

Examples found in repository

src/lib.rs (line 351)

    pub fn set_help<S: Into<Cow<'a, str>>>(mut self, help: S) -> Self {
        self.store.set_help(help);
        self
    }

src/cmd.rs (line 253)

    pub fn set_help<S: Into<Cow<'a, str>>>(&mut self, help: S) -> &mut Self {
        self.store.set_help(help);
        self
    }

pub fn set_optional(&mut self, optional: bool) -> &mut Self

Examples found in repository

src/lib.rs (line 326)

    pub fn new<S: Into<Cow<'a, str>>>(block: &'b mut Block<'a, Store<'a>>, name: S) -> Self {
        let mut store = Store::default();

        store.set_optional(true);
        store.set_name(name);
        Self {
            block,
            store,
            added: false,
        }
    }

    pub fn set_optional(mut self, optional: bool) -> Self {
        self.store.set_optional(optional);
        self
    }

src/cmd.rs (line 227)

    pub fn new<S: Into<Cow<'a, str>>>(
        block: &'b mut Block<'a, Cow<'a, str>>,
        stores: &'b mut Vec<Store<'a>>,
        name: S,
    ) -> Self {
        let mut store = Store::default();

        store.set_optional(true);
        store.set_name(name);
        Self {
            block,
            store,
            stores,
            added: false,
        }
    }

    pub fn set_optional(&mut self, optional: bool) -> &mut Self {
        self.store.set_optional(optional);
        self
    }

pub fn set_position(&mut self, position: bool) -> &mut Self

Examples found in repository

src/lib.rs (line 341)

    pub fn set_position(mut self, position: bool) -> Self {
        self.store.set_position(position);
        self
    }

src/cmd.rs (line 243)

    pub fn set_position(&mut self, position: bool) -> &mut Self {
        self.store.set_position(position);
        self
    }

pub fn set_type<S: Into<Cow<'a, str>>>(&mut self, type_name: S) -> &mut Self

Examples found in repository

src/lib.rs (line 361)

    pub fn set_type<S: Into<Cow<'a, str>>>(mut self, type_name: S) -> Self {
        self.store.set_type(type_name);
        self
    }

src/cmd.rs (line 263)

    pub fn set_type<S: Into<Cow<'a, str>>>(&mut self, type_name: S) -> &mut Self {
        self.store.set_type(type_name);
        self
    }

Trait Implementations

impl<'a> Clone for Store<'a>

fn clone(&self) -> Store<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Store<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Store<'a>

fn default() -> Store<'a>

Returns the “default value” for a type.

impl<'b> HelpDisplay for Store<'b>

fn gen_help<'a, P>(&self, policy: &P) -> Option<Cow<'a, str>>where
    Self: 'a,
    P: HelpPolicy<'a, Self>,