mirror of
https://github.com/Llewellynvdm/exa.git
synced 2024-06-08 18:22:20 +00:00
3419afa7cf
This commit significantly refactors the way that options are parsed. It introduces the Theme type which contains both styling and extension configuration, converts the option-parsing process into a being a pure function, and removes some rather gnarly old code. The main purpose of the refactoring is to fix GH-318, "Tests fail when not connected to a terminal". Even though exa was compiling fine on my machine and on Travis, it was failing for automated build scripts. This was because of what the option-parsing code was trying to accomplish: it wasn't just providing a struct of the user's settings, it was also checking the terminal, providing a View directly. This has been changed so that the options module now _only_ looks at the command-line arguments and environment variables. Instead of returning a View, it returns the user's _preference_, and it's then up to the 'main' module to examine the terminal width and figure out if the view is doable, downgrading it if necessary. The code that used to determine the view was horrible and I'm pleased it can be cut out. Also, the terminal width used to be in a lazy_static because it was queried multiple times, and now it's not in one because it's only queried once, which is a good sign for things going in the right direction. There are also some naming and organisational changes around themes. The blanket terms "Colours" and "Styles" have been yeeted in favour of "Theme", which handles both extensions and UI colours. The FileStyle struct has been replaced with file_name::Options, making it similar to the views in how it has an Options struct and a Render struct. Finally, eight unit tests have been removed because they turned out to be redundant (testing --colour and --color) after examining the tangled code, and the default theme has been put in its own file in preparation for more themes.
218 lines
7.6 KiB
Rust
218 lines
7.6 KiB
Rust
use ansi_term::Style;
|
||
|
||
use crate::theme::lsc::Pair;
|
||
|
||
|
||
#[derive(Debug, Default, PartialEq)]
|
||
pub struct UiStyles {
|
||
pub colourful: bool,
|
||
|
||
pub filekinds: FileKinds,
|
||
pub perms: Permissions,
|
||
pub size: Size,
|
||
pub users: Users,
|
||
pub links: Links,
|
||
pub git: Git,
|
||
|
||
pub punctuation: Style,
|
||
pub date: Style,
|
||
pub inode: Style,
|
||
pub blocks: Style,
|
||
pub header: Style,
|
||
pub octal: Style,
|
||
|
||
pub symlink_path: Style,
|
||
pub control_char: Style,
|
||
pub broken_symlink: Style,
|
||
pub broken_path_overlay: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct FileKinds {
|
||
pub normal: Style,
|
||
pub directory: Style,
|
||
pub symlink: Style,
|
||
pub pipe: Style,
|
||
pub block_device: Style,
|
||
pub char_device: Style,
|
||
pub socket: Style,
|
||
pub special: Style,
|
||
pub executable: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct Permissions {
|
||
pub user_read: Style,
|
||
pub user_write: Style,
|
||
pub user_execute_file: Style,
|
||
pub user_execute_other: Style,
|
||
|
||
pub group_read: Style,
|
||
pub group_write: Style,
|
||
pub group_execute: Style,
|
||
|
||
pub other_read: Style,
|
||
pub other_write: Style,
|
||
pub other_execute: Style,
|
||
|
||
pub special_user_file: Style,
|
||
pub special_other: Style,
|
||
|
||
pub attribute: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct Size {
|
||
pub major: Style,
|
||
pub minor: Style,
|
||
|
||
pub number_byte: Style,
|
||
pub number_kilo: Style,
|
||
pub number_mega: Style,
|
||
pub number_giga: Style,
|
||
pub number_huge: Style,
|
||
|
||
pub unit_byte: Style,
|
||
pub unit_kilo: Style,
|
||
pub unit_mega: Style,
|
||
pub unit_giga: Style,
|
||
pub unit_huge: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct Users {
|
||
pub user_you: Style,
|
||
pub user_someone_else: Style,
|
||
pub group_yours: Style,
|
||
pub group_not_yours: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct Links {
|
||
pub normal: Style,
|
||
pub multi_link_file: Style,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
||
pub struct Git {
|
||
pub new: Style,
|
||
pub modified: Style,
|
||
pub deleted: Style,
|
||
pub renamed: Style,
|
||
pub typechange: Style,
|
||
pub ignored: Style,
|
||
pub conflicted: Style,
|
||
}
|
||
|
||
impl UiStyles {
|
||
pub fn plain() -> Self {
|
||
Self::default()
|
||
}
|
||
}
|
||
|
||
|
||
impl UiStyles {
|
||
|
||
/// Sets a value on this set of colours using one of the keys understood
|
||
/// by the `LS_COLORS` environment variable. Invalid keys set nothing, but
|
||
/// return false.
|
||
pub fn set_ls(&mut self, pair: &Pair<'_>) -> bool {
|
||
match pair.key {
|
||
"di" => self.filekinds.directory = pair.to_style(), // DIR
|
||
"ex" => self.filekinds.executable = pair.to_style(), // EXEC
|
||
"fi" => self.filekinds.normal = pair.to_style(), // FILE
|
||
"pi" => self.filekinds.pipe = pair.to_style(), // FIFO
|
||
"so" => self.filekinds.socket = pair.to_style(), // SOCK
|
||
"bd" => self.filekinds.block_device = pair.to_style(), // BLK
|
||
"cd" => self.filekinds.char_device = pair.to_style(), // CHR
|
||
"ln" => self.filekinds.symlink = pair.to_style(), // LINK
|
||
"or" => self.broken_symlink = pair.to_style(), // ORPHAN
|
||
_ => return false,
|
||
// Codes we don’t do anything with:
|
||
// MULTIHARDLINK, DOOR, SETUID, SETGID, CAPABILITY,
|
||
// STICKY_OTHER_WRITABLE, OTHER_WRITABLE, STICKY, MISSING
|
||
}
|
||
true
|
||
}
|
||
|
||
/// Sets a value on this set of colours using one of the keys understood
|
||
/// by the `EXA_COLORS` environment variable. Invalid keys set nothing,
|
||
/// but return false. This doesn’t take the `LS_COLORS` keys into account,
|
||
/// so `set_ls` should have been run first.
|
||
pub fn set_exa(&mut self, pair: &Pair<'_>) -> bool {
|
||
match pair.key {
|
||
"ur" => self.perms.user_read = pair.to_style(),
|
||
"uw" => self.perms.user_write = pair.to_style(),
|
||
"ux" => self.perms.user_execute_file = pair.to_style(),
|
||
"ue" => self.perms.user_execute_other = pair.to_style(),
|
||
"gr" => self.perms.group_read = pair.to_style(),
|
||
"gw" => self.perms.group_write = pair.to_style(),
|
||
"gx" => self.perms.group_execute = pair.to_style(),
|
||
"tr" => self.perms.other_read = pair.to_style(),
|
||
"tw" => self.perms.other_write = pair.to_style(),
|
||
"tx" => self.perms.other_execute = pair.to_style(),
|
||
"su" => self.perms.special_user_file = pair.to_style(),
|
||
"sf" => self.perms.special_other = pair.to_style(),
|
||
"xa" => self.perms.attribute = pair.to_style(),
|
||
|
||
"sn" => self.set_number_style(pair.to_style()),
|
||
"sb" => self.set_unit_style(pair.to_style()),
|
||
"nb" => self.size.number_byte = pair.to_style(),
|
||
"nk" => self.size.number_kilo = pair.to_style(),
|
||
"nm" => self.size.number_mega = pair.to_style(),
|
||
"ng" => self.size.number_giga = pair.to_style(),
|
||
"nh" => self.size.number_huge = pair.to_style(),
|
||
"ub" => self.size.unit_byte = pair.to_style(),
|
||
"uk" => self.size.unit_kilo = pair.to_style(),
|
||
"um" => self.size.unit_mega = pair.to_style(),
|
||
"ug" => self.size.unit_giga = pair.to_style(),
|
||
"uh" => self.size.unit_huge = pair.to_style(),
|
||
"df" => self.size.major = pair.to_style(),
|
||
"ds" => self.size.minor = pair.to_style(),
|
||
|
||
"uu" => self.users.user_you = pair.to_style(),
|
||
"un" => self.users.user_someone_else = pair.to_style(),
|
||
"gu" => self.users.group_yours = pair.to_style(),
|
||
"gn" => self.users.group_not_yours = pair.to_style(),
|
||
|
||
"lc" => self.links.normal = pair.to_style(),
|
||
"lm" => self.links.multi_link_file = pair.to_style(),
|
||
|
||
"ga" => self.git.new = pair.to_style(),
|
||
"gm" => self.git.modified = pair.to_style(),
|
||
"gd" => self.git.deleted = pair.to_style(),
|
||
"gv" => self.git.renamed = pair.to_style(),
|
||
"gt" => self.git.typechange = pair.to_style(),
|
||
|
||
"xx" => self.punctuation = pair.to_style(),
|
||
"da" => self.date = pair.to_style(),
|
||
"in" => self.inode = pair.to_style(),
|
||
"bl" => self.blocks = pair.to_style(),
|
||
"hd" => self.header = pair.to_style(),
|
||
"lp" => self.symlink_path = pair.to_style(),
|
||
"cc" => self.control_char = pair.to_style(),
|
||
"bO" => self.broken_path_overlay = pair.to_style(),
|
||
|
||
_ => return false,
|
||
}
|
||
|
||
true
|
||
}
|
||
|
||
pub fn set_number_style(&mut self, style: Style) {
|
||
self.size.number_byte = style;
|
||
self.size.number_kilo = style;
|
||
self.size.number_mega = style;
|
||
self.size.number_giga = style;
|
||
self.size.number_huge = style;
|
||
}
|
||
|
||
pub fn set_unit_style(&mut self, style: Style) {
|
||
self.size.unit_byte = style;
|
||
self.size.unit_kilo = style;
|
||
self.size.unit_mega = style;
|
||
self.size.unit_giga = style;
|
||
self.size.unit_huge = style;
|
||
}
|
||
}
|