Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a method to register the help flag #109

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a method to register the help flag #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39e91de
Add helpflag() to `Options`
keiichiw Dec 14, 2021
44a2da3
Don't use "help" as sample data unrelated to helpflag()
keiichiw Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 89 additions & 27 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
//!
//! let mut opts = Options::new();
//! opts.optopt("o", "", "set output file name", "NAME");
//! opts.optflag("h", "help", "print this help menu");
//! opts.helpflag("print this help menu");
//! let matches = match opts.parse(&args[1..]) {
//! Ok(m) => { m }
//! Err(f) => { panic!(f.to_string()) }
Expand Down Expand Up @@ -186,25 +186,26 @@ impl Options {
desc: desc.to_string(),
hasarg,
occur,
is_help: false,
});
self
}

/// Create a long option that is optional and does not take an argument.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
///
/// # Example
///
/// ```
/// # use getopts::Options;
/// let mut opts = Options::new();
/// opts.optflag("h", "help", "help flag");
/// opts.optflag("f", "foo", "sample flag");
///
/// let matches = opts.parse(&["-h"]).unwrap();
/// assert!(matches.opt_present("h"));
/// let matches = opts.parse(&["-f"]).unwrap();
/// assert!(matches.opt_present("f"));
/// ```
pub fn optflag(&mut self, short_name: &str, long_name: &str, desc: &str) -> &mut Options {
validate_names(short_name, long_name);
Expand All @@ -215,15 +216,16 @@ impl Options {
desc: desc.to_string(),
hasarg: No,
occur: Optional,
is_help: false,
});
self
}

/// Create a long option that can occur more than once and does not
/// take an argument.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
///
/// # Example
Expand All @@ -245,14 +247,15 @@ impl Options {
desc: desc.to_string(),
hasarg: No,
occur: Multi,
is_help: false,
});
self
}

/// Create a long option that is optional and takes an optional argument.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
/// * `hint` - Hint that is used in place of the argument in the usage help,
/// e.g. `"FILE"` for a `-o FILE` option
Expand Down Expand Up @@ -285,15 +288,16 @@ impl Options {
desc: desc.to_string(),
hasarg: Maybe,
occur: Optional,
is_help: false,
});
self
}

/// Create a long option that is optional, takes an argument, and may occur
/// multiple times.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
/// * `hint` - Hint that is used in place of the argument in the usage help,
/// e.g. `"FILE"` for a `-o FILE` option
Expand Down Expand Up @@ -327,14 +331,15 @@ impl Options {
desc: desc.to_string(),
hasarg: Yes,
occur: Multi,
is_help: false,
});
self
}

/// Create a long option that is optional and takes an argument.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
/// * `hint` - Hint that is used in place of the argument in the usage help,
/// e.g. `"FILE"` for a `-o FILE` option
Expand Down Expand Up @@ -368,14 +373,15 @@ impl Options {
desc: desc.to_string(),
hasarg: Yes,
occur: Optional,
is_help: false,
});
self
}

/// Create a long option that is required and takes an argument.
///
/// * `short_name` - e.g. `"h"` for a `-h` option, or `""` for none
/// * `long_name` - e.g. `"help"` for a `--help` option, or `""` for none
/// * `short_name` - e.g. `"f"` for a `-f` option, or `""` for none
/// * `long_name` - e.g. `"foo"` for a `--foo` option, or `""` for none
/// * `desc` - Description for usage help
/// * `hint` - Hint that is used in place of the argument in the usage help,
/// e.g. `"FILE"` for a `-o FILE` option
Expand Down Expand Up @@ -411,6 +417,41 @@ impl Options {
desc: desc.to_string(),
hasarg: Yes,
occur: Req,
is_help: false,
});
self
}

/// Create an optional flag `-h`/`--help` that does not take an argument and
/// works even if an required flag option is missing.
///
/// * `desc` - Description for usage help.
///
/// # Example
///
/// ```
/// # use getopts::Options;
/// let mut opts = Options::new();
/// opts.helpflag("print this help menu");
/// opts.reqopt("m", "mandatory", "madatory text option", "TEXT");
///
/// let result = opts.parse(&["--help"]);
/// // Success even without the required option.
/// assert!(result.is_ok());
///
/// let matches = opts.parse(&["-h", "--mandatory", "foo"]).unwrap();
/// assert!(matches.opt_present("h"));
/// assert!(matches.opt_present("m"));
/// ```
pub fn helpflag(&mut self, desc: &str) -> &mut Options {
self.grps.push(OptGroup {
short_name: "h".to_string(),
long_name: "help".to_string(),
hint: "".to_string(),
desc: desc.to_string(),
hasarg: No,
occur: Multi,
is_help: true,
});
self
}
Expand Down Expand Up @@ -529,9 +570,7 @@ impl Options {
// FloatingFrees is in use.
if let Some(i_arg) = i_arg.take() {
vals[opt_id].push((arg_pos, Val(i_arg)));
} else if was_long
|| args.peek().map_or(true, |n| is_arg(&n))
{
} else if was_long || args.peek().map_or(true, |n| is_arg(&n)) {
vals[opt_id].push((arg_pos, Given));
} else {
vals[opt_id].push((arg_pos, Val(args.next().unwrap())));
Expand All @@ -552,8 +591,14 @@ impl Options {
arg_pos += 1;
}
debug_assert_eq!(vals.len(), opts.len());
let help_exists = opts
.iter()
.zip(vals.iter())
.any(|(opt, vs)| opt.is_help && !vs.is_empty());
for (vals, opt) in vals.iter().zip(opts.iter()) {
if opt.occur == Req && vals.is_empty() {
println!("vals={:?}, opt={:?}", vals, opt);

if !help_exists && opt.occur == Req && vals.is_empty() {
return Err(OptionMissing(opt.name.to_string()));
}
if opt.occur != Multi && vals.len() > 1 {
Expand All @@ -565,7 +610,12 @@ impl Options {
// in option does not exist in `free` and must be replaced with `None`
args_end = args_end.filter(|pos| pos != &free.len());

Ok(Matches { opts, vals, free, args_end })
Ok(Matches {
opts,
vals,
free,
args_end,
})
}

/// Derive a short one-line usage summary from a set of long options.
Expand Down Expand Up @@ -711,10 +761,10 @@ pub enum ParsingStyle {
#[derive(Clone, Debug, PartialEq, Eq)]
enum Name {
/// A string representing the long name of an option.
/// For example: "help"
/// For example: "verbose"
Long(String),
/// A char representing the short name of an option.
/// For example: 'h'
/// For example: 'v'
Short(char),
}

Expand Down Expand Up @@ -749,17 +799,19 @@ struct Opt {
hasarg: HasArg,
/// How often it can occur
occur: Occur,
/// Whether this option is a help flag.
is_help: bool,
/// Which options it aliases
aliases: Vec<Opt>,
}

/// One group of options, e.g., both `-h` and `--help`, along with
/// One group of options, e.g., both `-v` and `--verbose`, along with
/// their shared description and properties.
#[derive(Debug, Clone, PartialEq, Eq)]
struct OptGroup {
/// Short name of the option, e.g. `h` for a `-h` option
/// Short name of the option, e.g. `v` for a `-v` option
short_name: String,
/// Long name of the option, e.g. `help` for a `--help` option
/// Long name of the option, e.g. `verbose` for a `--verbose` option
long_name: String,
/// Hint for argument, e.g. `FILE` for a `-o FILE` option
hint: String,
Expand All @@ -769,6 +821,8 @@ struct OptGroup {
hasarg: HasArg,
/// How often it can occur
occur: Occur,
/// Whether this option is a help flag.
is_help: bool,
}

/// Describes whether an option is given at all or has a value.
Expand Down Expand Up @@ -842,6 +896,7 @@ impl OptGroup {
long_name,
hasarg,
occur,
is_help,
..
} = (*self).clone();

Expand All @@ -851,22 +906,26 @@ impl OptGroup {
name: Long(long_name),
hasarg,
occur,
is_help,
aliases: Vec::new(),
},
(1, 0) => Opt {
name: Short(short_name.as_bytes()[0] as char),
hasarg,
occur,
is_help,
aliases: Vec::new(),
},
(1, _) => Opt {
name: Long(long_name),
hasarg,
occur,
is_help,
aliases: vec![Opt {
name: Short(short_name.as_bytes()[0] as char),
hasarg: hasarg,
occur: occur,
is_help: false,
aliases: Vec::new(),
}],
},
Expand Down Expand Up @@ -915,7 +974,10 @@ impl Matches {
///
/// This function will panic if the option name is not defined.
pub fn opt_positions(&self, name: &str) -> Vec<usize> {
self.opt_vals(name).into_iter().map(|(pos, _)| pos).collect()
self.opt_vals(name)
.into_iter()
.map(|(pos, _)| pos)
.collect()
}

/// Returns true if any of several options were matched.
Expand Down
Loading