nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-26 16:54:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

auto merge of #19365 : frewsxcv/rust/getopts-cleanup, r=alexcrichton

Browse Source 
* Remove public reexports, as a part of #19253
* Rename getopts::Fail_ to getopts::Fail
 * Didn't see a reason for the suffixed '_'
* Removed getopts::FailType
 * Looked like it was only beings used for tests; refactored the tests
   to stop requiring it
* A few other non-breaking trivial refactoring changes

[breaking-change]
This commit is contained in:
bors 2014-11-30 06:56:41 +00:00
commit dfaad04b7a
1 changed files with 42 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
src/libgetopts/lib.rs
View File

@ -92,11 +92,10 @@
#[cfg(test)] #[phase(plugin, link)] extern crate log; #[cfg(test)] #[phase(plugin, link)] extern crate log;
pub use self::Name::*; use self::Name::*;
pub use self::HasArg::*; use self::HasArg::*;
pub use self::Occur::*; use self::Occur::*;
pub use self::Fail_::*; use self::Fail::*;
pub use self::FailType::*;
use self::Optval::*; use self::Optval::*;
use std::fmt; use std::fmt;
@ -191,7 +190,7 @@ pub struct Matches {
/// expected format. Use the `Show` implementation to output detailed /// expected format. Use the `Show` implementation to output detailed
/// information. /// information.
#[deriving(Clone, PartialEq, Eq)] #[deriving(Clone, PartialEq, Eq)]
pub enum Fail_ { pub enum Fail {
/// The option requires an argument but none was passed. /// The option requires an argument but none was passed.
ArgumentMissing(String), ArgumentMissing(String),
/// The passed option is not declared among the possible options. /// The passed option is not declared among the possible options.
@ -204,19 +203,8 @@ pub enum Fail_ {
UnexpectedArgument(String), UnexpectedArgument(String),
} }
/// The type of failure that occurred.
#[deriving(PartialEq, Eq)]
#[allow(missing_docs)]
pub enum FailType {
ArgumentMissing_,
UnrecognizedOption_,
OptionMissing_,
OptionDuplicated_,
UnexpectedArgument_,
}
/// The result of parsing a command line with a set of options. /// The result of parsing a command line with a set of options.
pub type Result = result::Result<Matches, Fail_>; pub type Result = result::Result<Matches, Fail>;
impl Name { impl Name {
fn from_str(nm: &str) -> Name { fn from_str(nm: &str) -> Name {
@ -264,7 +252,7 @@ impl OptGroup {
(1,_) => Opt { (1,_) => Opt {
name: Long((long_name)), name: Long((long_name)),
hasarg: hasarg, hasarg: hasarg,
occur: occur, occur: occur,
aliases: vec!( aliases: vec!(
Opt { Opt {
name: Short(short_name.as_slice().char_at(0)), name: Short(short_name.as_slice().char_at(0)),
@ -366,11 +354,12 @@ impl Matches {
pub fn opt_default(&self, nm: &str, def: &str) -> Option<String> { pub fn opt_default(&self, nm: &str, def: &str) -> Option<String> {
let vals = self.opt_vals(nm); let vals = self.opt_vals(nm);
if vals.is_empty() { if vals.is_empty() {
return None; None
} } else {
match vals[0] { match vals[0] {
Val(ref s) => Some((*s).clone()), Val(ref s) => Some((*s).clone()),
_ => Some(def.to_string()) _ => Some(def.to_string())
}
} }
} }
@ -534,15 +523,15 @@ pub fn opt(short_name: &str,
} }
} }
impl Fail_ { impl Fail {
/// Convert a `Fail_` enum into an error string. /// Convert a `Fail` enum into an error string.
#[deprecated="use `Show` (`{}` format specifier)"] #[deprecated="use `Show` (`{}` format specifier)"]
pub fn to_err_msg(self) -> String { pub fn to_err_msg(self) -> String {
self.to_string() self.to_string()
} }
} }
impl fmt::Show for Fail_ { impl fmt::Show for Fail {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self { match *self {
ArgumentMissing(ref nm) => { ArgumentMissing(ref nm) => {
@ -570,7 +559,7 @@ impl fmt::Show for Fail_ {
/// `opt_str`, etc. to interrogate results. /// `opt_str`, etc. to interrogate results.
/// # Panics /// # Panics
/// ///
/// Returns `Err(Fail_)` on failure: use the `Show` implementation of `Fail_` to display /// Returns `Err(Fail)` on failure: use the `Show` implementation of `Fail` to display
/// information about it. /// information about it.
pub fn getopts(args: &[String], optgrps: &[OptGroup]) -> Result { pub fn getopts(args: &[String], optgrps: &[OptGroup]) -> Result {
let opts: Vec<Opt> = optgrps.iter().map(|x| x.long_to_short()).collect(); let opts: Vec<Opt> = optgrps.iter().map(|x| x.long_to_short()).collect();
@ -681,21 +670,15 @@ pub fn getopts(args: &[String], optgrps: &[OptGroup]) -> Result {
} }
i += 1; i += 1;
} }
i = 0u; for i in range(0u, n_opts) {
while i < n_opts {
let n = vals[i].len(); let n = vals[i].len();
let occ = opts[i].occur; let occ = opts[i].occur;
if occ == Req { if occ == Req && n == 0 {
if n == 0 { return Err(OptionMissing(opts[i].name.to_string()));
return Err(OptionMissing(opts[i].name.to_string()));
}
} }
if occ != Multi { if occ != Multi && n > 1 {
if n > 1 { return Err(OptionDuplicated(opts[i].name.to_string()));
return Err(OptionDuplicated(opts[i].name.to_string()));
}
} }
i += 1;
} }
Ok(Matches { Ok(Matches {
opts: opts, opts: opts,
@ -966,20 +949,11 @@ fn test_split_within() {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use super::Fail::*;
use std::result::{Err, Ok}; use std::result::{Err, Ok};
use std::result; use std::result;
fn check_fail_type(f: Fail_, ft: FailType) {
match f {
ArgumentMissing(_) => assert!(ft == ArgumentMissing_),
UnrecognizedOption(_) => assert!(ft == UnrecognizedOption_),
OptionMissing(_) => assert!(ft == OptionMissing_),
OptionDuplicated(_) => assert!(ft == OptionDuplicated_),
UnexpectedArgument(_) => assert!(ft == UnexpectedArgument_)
}
}
// Tests for reqopt // Tests for reqopt
#[test] #[test]
fn test_reqopt() { fn test_reqopt() {
@ -1013,7 +987,7 @@ mod tests {
let opts = vec!(reqopt("t", "test", "testing", "TEST")); let opts = vec!(reqopt("t", "test", "testing", "TEST"));
let rs = getopts(args.as_slice(), opts.as_slice()); let rs = getopts(args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, OptionMissing_), Err(OptionMissing(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1024,12 +998,12 @@ mod tests {
let opts = vec!(reqopt("t", "test", "testing", "TEST")); let opts = vec!(reqopt("t", "test", "testing", "TEST"));
let rs = getopts(long_args.as_slice(), opts.as_slice()); let rs = getopts(long_args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
let short_args = vec!("-t".to_string()); let short_args = vec!("-t".to_string());
match getopts(short_args.as_slice(), opts.as_slice()) { match getopts(short_args.as_slice(), opts.as_slice()) {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1040,7 +1014,7 @@ mod tests {
let opts = vec!(reqopt("t", "test", "testing", "TEST")); let opts = vec!(reqopt("t", "test", "testing", "TEST"));
let rs = getopts(args.as_slice(), opts.as_slice()); let rs = getopts(args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, OptionDuplicated_), Err(OptionDuplicated(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1092,12 +1066,12 @@ mod tests {
let opts = vec!(optopt("t", "test", "testing", "TEST")); let opts = vec!(optopt("t", "test", "testing", "TEST"));
let rs = getopts(long_args.as_slice(), opts.as_slice()); let rs = getopts(long_args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
let short_args = vec!("-t".to_string()); let short_args = vec!("-t".to_string());
match getopts(short_args.as_slice(), opts.as_slice()) { match getopts(short_args.as_slice(), opts.as_slice()) {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1108,7 +1082,7 @@ mod tests {
let opts = vec!(optopt("t", "test", "testing", "TEST")); let opts = vec!(optopt("t", "test", "testing", "TEST"));
let rs = getopts(args.as_slice(), opts.as_slice()); let rs = getopts(args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, OptionDuplicated_), Err(OptionDuplicated(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1156,9 +1130,7 @@ mod tests {
let opts = vec!(optflag("t", "test", "testing")); let opts = vec!(optflag("t", "test", "testing"));
let rs = getopts(args.as_slice(), opts.as_slice()); let rs = getopts(args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => { Err(UnexpectedArgument(_)) => {},
check_fail_type(f, UnexpectedArgument_);
}
_ => panic!() _ => panic!()
} }
} }
@ -1169,7 +1141,7 @@ mod tests {
let opts = vec!(optflag("t", "test", "testing")); let opts = vec!(optflag("t", "test", "testing"));
let rs = getopts(args.as_slice(), opts.as_slice()); let rs = getopts(args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, OptionDuplicated_), Err(OptionDuplicated(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1317,12 +1289,12 @@ mod tests {
let opts = vec!(optmulti("t", "test", "testing", "TEST")); let opts = vec!(optmulti("t", "test", "testing", "TEST"));
let rs = getopts(long_args.as_slice(), opts.as_slice()); let rs = getopts(long_args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
let short_args = vec!("-t".to_string()); let short_args = vec!("-t".to_string());
match getopts(short_args.as_slice(), opts.as_slice()) { match getopts(short_args.as_slice(), opts.as_slice()) {
Err(f) => check_fail_type(f, ArgumentMissing_), Err(ArgumentMissing(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1352,12 +1324,12 @@ mod tests {
let opts = vec!(optmulti("t", "test", "testing", "TEST")); let opts = vec!(optmulti("t", "test", "testing", "TEST"));
let rs = getopts(long_args.as_slice(), opts.as_slice()); let rs = getopts(long_args.as_slice(), opts.as_slice());
match rs { match rs {
Err(f) => check_fail_type(f, UnrecognizedOption_), Err(UnrecognizedOption(_)) => {},
_ => panic!() _ => panic!()
} }
let short_args = vec!("-u".to_string()); let short_args = vec!("-u".to_string());
match getopts(short_args.as_slice(), opts.as_slice()) { match getopts(short_args.as_slice(), opts.as_slice()) {
Err(f) => check_fail_type(f, UnrecognizedOption_), Err(UnrecognizedOption(_)) => {},
_ => panic!() _ => panic!()
} }
} }
@ -1493,14 +1465,14 @@ mod tests {
#[test] #[test]
fn test_long_to_short() { fn test_long_to_short() {
let mut short = Opt { let mut short = Opt {
name: Long("banana".to_string()), name: Name::Long("banana".to_string()),
hasarg: Yes, hasarg: HasArg::Yes,
occur: Req, occur: Occur::Req,
aliases: Vec::new(), aliases: Vec::new(),
}; };
short.aliases = vec!(Opt { name: Short('b'), short.aliases = vec!(Opt { name: Name::Short('b'),
hasarg: Yes, hasarg: HasArg::Yes,
occur: Req, occur: Occur::Req,
aliases: Vec::new() }); aliases: Vec::new() });
let verbose = reqopt("b", "banana", "some bananas", "VAL"); let verbose = reqopt("b", "banana", "some bananas", "VAL");