2016-04-17 19:56:06 +00:00
|
|
|
|
use std::ffi::OsStr;
|
|
|
|
|
|
2016-04-17 19:38:37 +00:00
|
|
|
|
use getopts;
|
|
|
|
|
|
|
|
|
|
use fs::feature::xattr;
|
2017-06-25 23:53:48 +00:00
|
|
|
|
use output::details;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
mod dir_action;
|
|
|
|
|
pub use self::dir_action::{DirAction, RecurseOptions};
|
|
|
|
|
|
|
|
|
|
mod filter;
|
|
|
|
|
pub use self::filter::{FileFilter, SortField, SortCase};
|
|
|
|
|
|
|
|
|
|
mod help;
|
2017-06-23 21:50:29 +00:00
|
|
|
|
use self::help::HelpString;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
mod misfire;
|
|
|
|
|
pub use self::misfire::Misfire;
|
|
|
|
|
|
|
|
|
|
mod view;
|
2017-06-24 21:39:15 +00:00
|
|
|
|
pub use self::view::{View, Mode};
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/// These **options** represent a parsed, error-checked versions of the
|
|
|
|
|
/// user’s command-line options.
|
2016-10-30 14:31:25 +00:00
|
|
|
|
#[derive(PartialEq, Debug, Clone)]
|
2016-04-17 19:38:37 +00:00
|
|
|
|
pub struct Options {
|
|
|
|
|
|
|
|
|
|
/// The action to perform when encountering a directory rather than a
|
|
|
|
|
/// regular file.
|
|
|
|
|
pub dir_action: DirAction,
|
|
|
|
|
|
|
|
|
|
/// How to sort and filter files before outputting them.
|
|
|
|
|
pub filter: FileFilter,
|
|
|
|
|
|
|
|
|
|
/// The type of output to use (lines, grid, or details).
|
|
|
|
|
pub view: View,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Options {
|
|
|
|
|
|
2017-05-18 23:08:13 +00:00
|
|
|
|
// Even though the arguments go in as OsStrings, they come out
|
|
|
|
|
// as Strings. Invalid UTF-8 won’t be parsed, but it won’t make
|
|
|
|
|
// exa core dump either.
|
|
|
|
|
//
|
|
|
|
|
// https://github.com/rust-lang-nursery/getopts/pull/29
|
|
|
|
|
|
2016-04-17 19:38:37 +00:00
|
|
|
|
/// Call getopts on the given slice of command-line strings.
|
|
|
|
|
#[allow(unused_results)]
|
2017-05-18 23:08:13 +00:00
|
|
|
|
pub fn getopts<C>(args: C) -> Result<(Options, Vec<String>), Misfire>
|
|
|
|
|
where C: IntoIterator, C::Item: AsRef<OsStr> {
|
2016-04-17 19:38:37 +00:00
|
|
|
|
let mut opts = getopts::Options::new();
|
|
|
|
|
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("v", "version", "show version of exa");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
opts.optflag("?", "help", "show list of command-line options");
|
|
|
|
|
|
|
|
|
|
// Display options
|
2016-10-30 16:42:33 +00:00
|
|
|
|
opts.optflag("1", "oneline", "display one entry per line");
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("l", "long", "display extended file metadata in a table");
|
|
|
|
|
opts.optflag("G", "grid", "display entries as a grid (default)");
|
|
|
|
|
opts.optflag("x", "across", "sort the grid across, rather than downwards");
|
2016-10-30 16:42:33 +00:00
|
|
|
|
opts.optflag("R", "recurse", "recurse into directories");
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("T", "tree", "recurse into directories as a tree");
|
|
|
|
|
opts.optflag("F", "classify", "display type indicator by file names (one of */=@|)");
|
|
|
|
|
opts.optopt ("", "color", "when to use terminal colours", "WHEN");
|
|
|
|
|
opts.optopt ("", "colour", "when to use terminal colours", "WHEN");
|
|
|
|
|
opts.optflag("", "color-scale", "highlight levels of file sizes distinctly");
|
|
|
|
|
opts.optflag("", "colour-scale", "highlight levels of file sizes distinctly");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
// Filtering and sorting options
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("", "group-directories-first", "sort directories before other files");
|
2017-06-26 22:48:55 +00:00
|
|
|
|
opts.optflagmulti("a", "all", "don't hide hidden and 'dot' files");
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("d", "list-dirs", "list directories like regular files");
|
|
|
|
|
opts.optopt ("L", "level", "limit the depth of recursion", "DEPTH");
|
|
|
|
|
opts.optflag("r", "reverse", "reverse the sert order");
|
|
|
|
|
opts.optopt ("s", "sort", "which field to sort by", "WORD");
|
|
|
|
|
opts.optopt ("I", "ignore-glob", "ignore files that match these glob patterns", "GLOB1|GLOB2...");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
// Long view options
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("b", "binary", "list file sizes with binary prefixes");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
opts.optflag("B", "bytes", "list file sizes in bytes, without prefixes");
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("g", "group", "list each file's group");
|
|
|
|
|
opts.optflag("h", "header", "add a header row to each column");
|
|
|
|
|
opts.optflag("H", "links", "list each file's number of hard links");
|
|
|
|
|
opts.optflag("i", "inode", "list each file's inode number");
|
|
|
|
|
opts.optflag("m", "modified", "use the modified timestamp field");
|
|
|
|
|
opts.optflag("S", "blocks", "list each file's number of file system blocks");
|
|
|
|
|
opts.optopt ("t", "time", "which timestamp field to show", "WORD");
|
|
|
|
|
opts.optflag("u", "accessed", "use the accessed timestamp field");
|
|
|
|
|
opts.optflag("U", "created", "use the created timestamp field");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
|
|
|
|
if cfg!(feature="git") {
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("", "git", "list each file's git status");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if xattr::ENABLED {
|
2017-05-06 22:00:45 +00:00
|
|
|
|
opts.optflag("@", "extended", "list each file's extended attribute keys and sizes");
|
2016-04-17 19:38:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let matches = match opts.parse(args) {
|
|
|
|
|
Ok(m) => m,
|
|
|
|
|
Err(e) => return Err(Misfire::InvalidOptions(e)),
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
if matches.opt_present("help") {
|
2017-06-23 21:50:29 +00:00
|
|
|
|
let help = HelpString {
|
|
|
|
|
only_long: matches.opt_present("long"),
|
|
|
|
|
git: cfg!(feature="git"),
|
|
|
|
|
xattrs: xattr::ENABLED,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
return Err(Misfire::Help(help));
|
2016-04-17 19:38:37 +00:00
|
|
|
|
}
|
|
|
|
|
else if matches.opt_present("version") {
|
|
|
|
|
return Err(Misfire::Version);
|
|
|
|
|
}
|
|
|
|
|
|
2017-03-26 16:35:50 +00:00
|
|
|
|
let options = Options::deduce(&matches)?;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
Ok((options, matches.free))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Whether the View specified in this set of options includes a Git
|
|
|
|
|
/// status column. It’s only worth trying to discover a repository if the
|
|
|
|
|
/// results will end up being displayed.
|
|
|
|
|
pub fn should_scan_for_git(&self) -> bool {
|
2017-06-24 21:39:15 +00:00
|
|
|
|
match self.view.mode {
|
2017-06-25 23:53:48 +00:00
|
|
|
|
Mode::Details(details::Options { columns: Some(cols), .. }) |
|
|
|
|
|
Mode::GridDetails(_, details::Options { columns: Some(cols), .. }) => cols.should_scan_for_git(),
|
2016-04-17 19:38:37 +00:00
|
|
|
|
_ => false,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Determines the complete set of options based on the given command-line
|
|
|
|
|
/// arguments, after they’ve been parsed.
|
|
|
|
|
fn deduce(matches: &getopts::Matches) -> Result<Options, Misfire> {
|
2017-03-31 16:09:32 +00:00
|
|
|
|
let dir_action = DirAction::deduce(matches)?;
|
|
|
|
|
let filter = FileFilter::deduce(matches)?;
|
2017-06-26 07:28:32 +00:00
|
|
|
|
let view = View::deduce(matches)?;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
|
2017-05-18 21:43:32 +00:00
|
|
|
|
Ok(Options { dir_action, view, filter })
|
2016-04-17 19:38:37 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod test {
|
|
|
|
|
use super::{Options, Misfire, SortField, SortCase};
|
2017-06-27 00:13:50 +00:00
|
|
|
|
use fs::DotFilter;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
use fs::feature::xattr;
|
|
|
|
|
|
|
|
|
|
fn is_helpful<T>(misfire: Result<T, Misfire>) -> bool {
|
|
|
|
|
match misfire {
|
|
|
|
|
Err(Misfire::Help(_)) => true,
|
|
|
|
|
_ => false,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn help() {
|
|
|
|
|
let opts = Options::getopts(&[ "--help".to_string() ]);
|
|
|
|
|
assert!(is_helpful(opts))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn help_with_file() {
|
|
|
|
|
let opts = Options::getopts(&[ "--help".to_string(), "me".to_string() ]);
|
|
|
|
|
assert!(is_helpful(opts))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn files() {
|
|
|
|
|
let args = Options::getopts(&[ "this file".to_string(), "that file".to_string() ]).unwrap().1;
|
|
|
|
|
assert_eq!(args, vec![ "this file".to_string(), "that file".to_string() ])
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn no_args() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let nothing: Vec<String> = Vec::new();
|
|
|
|
|
let args = Options::getopts(¬hing).unwrap().1;
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert!(args.is_empty()); // Listing the `.` directory is done in main.rs
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn file_sizes() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--long", "--binary", "--bytes" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Conflict("binary", "bytes"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_binary() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--binary" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("binary", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_bytes() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--bytes" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("bytes", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn long_across() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--long", "--across" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts, Err(Misfire::Useless("across", true, "long")))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn oneline_across() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--oneline", "--across" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts, Err(Misfire::Useless("across", true, "oneline")))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_header() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--header" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("header", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_group() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--group" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("group", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_inode() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--inode" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("inode", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_links() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--links" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("links", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn just_blocks() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--blocks" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("blocks", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_sort_size() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--sort=size" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap().0.filter.sort_field, SortField::Size);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_sort_name() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--sort=name" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap().0.filter.sort_field, SortField::Name(SortCase::Sensitive));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_sort_name_lowercase() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--sort=Name" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap().0.filter.sort_field, SortField::Name(SortCase::Insensitive));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
#[cfg(feature="git")]
|
|
|
|
|
fn just_git() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--git" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("git", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn extended_without_long() {
|
|
|
|
|
if xattr::ENABLED {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--extended" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless("extended", false, "long"))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn level_without_recurse_or_tree() {
|
2016-04-17 19:56:06 +00:00
|
|
|
|
let opts = Options::getopts(&[ "--level", "69105" ]);
|
2016-04-17 19:38:37 +00:00
|
|
|
|
assert_eq!(opts.unwrap_err(), Misfire::Useless2("level", "recurse", "tree"))
|
|
|
|
|
}
|
2017-06-26 22:48:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn nowt() {
|
|
|
|
|
let nothing: Vec<String> = Vec::new();
|
|
|
|
|
let dots = Options::getopts(¬hing).unwrap().0.filter.dot_filter;
|
|
|
|
|
assert_eq!(dots, DotFilter::JustFiles);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn all() {
|
|
|
|
|
let dots = Options::getopts(&[ "--all".to_string() ]).unwrap().0.filter.dot_filter;
|
2017-06-27 00:13:50 +00:00
|
|
|
|
assert_eq!(dots, DotFilter::Dotfiles);
|
2017-06-26 22:48:55 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn allall() {
|
|
|
|
|
let dots = Options::getopts(&[ "-a".to_string(), "-a".to_string() ]).unwrap().0.filter.dot_filter;
|
2017-06-27 00:13:50 +00:00
|
|
|
|
assert_eq!(dots, DotFilter::DotfilesAndDots);
|
2017-06-26 22:48:55 +00:00
|
|
|
|
}
|
2016-04-17 19:38:37 +00:00
|
|
|
|
}
|