RGBCube/uutils-coreutils
1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-07-28 03:27:44 +00:00
Code Issues Activity

dircolors -p: generate it dynamically

Browse source
This commit is contained in:
Sylvestre Ledru 2023-12-02 15:06:09 +01:00
parent 5d19f79cd0
commit e4b8750434
3 changed files with 75 additions and 275 deletions
Download patch file Download diff file Expand all files Collapse all files

225
src/uu/dircolors/src/colors.rs
View file

@ -1,225 +0,0 @@
// This file is part of the uutils coreutils package.
//
// For the full copyright and license information, please view the LICENSE
// file that was distributed with this source code.
// spell-checker:ignore (ToDO) EIGHTBIT ETERM MULTIHARDLINK cpio dtterm jfbterm konsole kterm mlterm rmvb rxvt stat'able svgz tmux webm xspf COLORTERM tzst avif tzst mjpg mjpeg webp dpkg rpmnew rpmorig rpmsave
pub const INTERNAL_DB: &str = r#"# Configuration file for dircolors, a utility to help you set the
# LS_COLORS environment variable used by GNU ls with the --color option.
# Copyright (C) 1996-2022 Free Software Foundation, Inc.
# Copying and distribution of this file, with or without modification,
# are permitted provided the copyright notice and this notice are preserved.
# The keywords COLOR, OPTIONS, and EIGHTBIT (honored by the
# slackware version of dircolors) are recognized but ignored.
# Global config options can be specified before TERM or COLORTERM entries
# Below are TERM or COLORTERM entries, which can be glob patterns, which
# restrict following config to systems with matching environment variables.
COLORTERM ?*
TERM Eterm
TERM ansi
TERM *color*
TERM con[0-9]*x[0-9]*
TERM cons25
TERM console
TERM cygwin
TERM *direct*
TERM dtterm
TERM gnome
TERM hurd
TERM jfbterm
TERM konsole
TERM kterm
TERM linux
TERM linux-c
TERM mlterm
TERM putty
TERM rxvt*
TERM screen*
TERM st
TERM terminator
TERM tmux*
TERM vt100
TERM xterm*
# Below are the color init strings for the basic file types.
# One can use codes for 256 or more colors supported by modern terminals.
# The default color codes use the capabilities of an 8 color terminal
# with some additional attributes as per the following codes:
# Attribute codes:
# 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
# Text color codes:
# 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
# Background color codes:
# 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
#NORMAL 00 # no color code at all
#FILE 00 # regular file: use no color at all
RESET 0 # reset to "normal" color
DIR 01;34 # directory
LINK 01;36 # symbolic link. (If you set this to 'target' instead of a
# numerical value, the color is as for the file pointed to.)
MULTIHARDLINK 00 # regular file with more than one link
FIFO 40;33 # pipe
SOCK 01;35 # socket
DOOR 01;35 # door
BLK 40;33;01 # block device driver
CHR 40;33;01 # character device driver
ORPHAN 40;31;01 # symlink to nonexistent file, or non-stat'able file ...
MISSING 00 # ... and the files they point to
SETUID 37;41 # file that is setuid (u+s)
SETGID 30;43 # file that is setgid (g+s)
CAPABILITY 00 # file with capability (very expensive to lookup)
STICKY_OTHER_WRITABLE 30;42 # dir that is sticky and other-writable (+t,o+w)
OTHER_WRITABLE 34;42 # dir that is other-writable (o+w) and not sticky
STICKY 37;44 # dir with the sticky bit set (+t) and not other-writable
# This is for files with execute permission:
EXEC 01;32
# List any file extensions like '.gz' or '.tar' that you would like ls
# to color below. Put the extension, a space, and the color init string.
# (and any comments you want to add after a '#')
# If you use DOS-style suffixes, you may want to uncomment the following:
#.cmd 01;32 # executables (bright green)
#.exe 01;32
#.com 01;32
#.btm 01;32
#.bat 01;32
# Or if you want to color scripts even if they do not have the
# executable bit actually set.
#.sh 01;32
#.csh 01;32
# archives or compressed (bright red)
.tar 01;31
.tgz 01;31
.arc 01;31
.arj 01;31
.taz 01;31
.lha 01;31
.lz4 01;31
.lzh 01;31
.lzma 01;31
.tlz 01;31
.txz 01;31
.tzo 01;31
.t7z 01;31
.zip 01;31
.z 01;31
.dz 01;31
.gz 01;31
.lrz 01;31
.lz 01;31
.lzo 01;31
.xz 01;31
.zst 01;31
.tzst 01;31
.bz2 01;31
.bz 01;31
.tbz 01;31
.tbz2 01;31
.tz 01;31
.deb 01;31
.rpm 01;31
.jar 01;31
.war 01;31
.ear 01;31
.sar 01;31
.rar 01;31
.alz 01;31
.ace 01;31
.zoo 01;31
.cpio 01;31
.7z 01;31
.rz 01;31
.cab 01;31
.wim 01;31
.swm 01;31
.dwm 01;31
.esd 01;31
# image formats
.avif 01;35
.jpg 01;35
.jpeg 01;35
.mjpg 01;35
.mjpeg 01;35
.gif 01;35
.bmp 01;35
.pbm 01;35
.pgm 01;35
.ppm 01;35
.tga 01;35
.xbm 01;35
.xpm 01;35
.tif 01;35
.tiff 01;35
.png 01;35
.svg 01;35
.svgz 01;35
.mng 01;35
.pcx 01;35
.mov 01;35
.mpg 01;35
.mpeg 01;35
.m2v 01;35
.mkv 01;35
.webm 01;35
.webp 01;35
.ogm 01;35
.mp4 01;35
.m4v 01;35
.mp4v 01;35
.vob 01;35
.qt 01;35
.nuv 01;35
.wmv 01;35
.asf 01;35
.rm 01;35
.rmvb 01;35
.flc 01;35
.avi 01;35
.fli 01;35
.flv 01;35
.gl 01;35
.dl 01;35
.xcf 01;35
.xwd 01;35
.yuv 01;35
.cgm 01;35
.emf 01;35
# https://wiki.xiph.org/MIME_Types_and_File_Extensions
.ogv 01;35
.ogx 01;35
# audio formats
.aac 00;36
.au 00;36
.flac 00;36
.m4a 00;36
.mid 00;36
.midi 00;36
.mka 00;36
.mp3 00;36
.mpc 00;36
.ogg 00;36
.ra 00;36
.wav 00;36
# https://wiki.xiph.org/MIME_Types_and_File_Extensions
.oga 00;36
.opus 00;36
.spx 00;36
.xspf 00;36
# backup files
*~ 00;90
*# 00;90
.bak 00;90
.old 00;90
.orig 00;90
.part 00;90
.rej 00;90
.swp 00;90
.tmp 00;90
.dpkg-dist 00;90
.dpkg-old 00;90
.ucf-dist 00;90
.ucf-new 00;90
.ucf-old 00;90
.rpmnew 00;90
.rpmorig 00;90
.rpmsave 00;90
# Subsequent TERM or COLORTERM entries, can be used to add / override
# config specific to those matching environment variables."#;

65
src/uu/dircolors/src/dircolors.rs
View file

@ -10,9 +10,10 @@ use std::env;
use std::fs::File; use std::fs::File;
use std::io::{BufRead, BufReader}; use std::io::{BufRead, BufReader};
use std::path::Path; use std::path::Path;
use std::fmt::Write;
use clap::{crate_version, Arg, ArgAction, Command}; use clap::{crate_version, Arg, ArgAction, Command};
use uucore::colors::{FILE_ATTRIBUTE_CODES, FILE_COLORS, FILE_TYPES}; use uucore::colors::{FILE_ATTRIBUTE_CODES, FILE_COLORS, FILE_TYPES, TERMS};
use uucore::display::Quotable; use uucore::display::Quotable;
use uucore::error::{UResult, USimpleError, UUsageError}; use uucore::error::{UResult, USimpleError, UUsageError};
use uucore::{help_about, help_section, help_usage}; use uucore::{help_about, help_section, help_usage};
@ -29,9 +30,6 @@ const USAGE: &str = help_usage!("dircolors.md");
const ABOUT: &str = help_about!("dircolors.md"); const ABOUT: &str = help_about!("dircolors.md");
const AFTER_HELP: &str = help_section!("after help", "dircolors.md"); const AFTER_HELP: &str = help_section!("after help", "dircolors.md");
mod colors;
use self::colors::INTERNAL_DB;
#[derive(PartialEq, Eq, Debug)] #[derive(PartialEq, Eq, Debug)]
pub enum OutputFmt { pub enum OutputFmt {
Shell, Shell,
@ -181,7 +179,8 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
), ),
)); ));
} }
println!("{INTERNAL_DB}");
println!("{}", generate_dircolors_config());
return Ok(()); return Ok(());
} }
@ -222,6 +221,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
)); ));
} else if files[0].eq("-") { } else if files[0].eq("-") {
let fin = BufReader::new(std::io::stdin()); let fin = BufReader::new(std::io::stdin());
// For example, for echo "owt 40;33"|dircolors -b -
result = parse(fin.lines().map_while(Result::ok), &out_format, files[0]); result = parse(fin.lines().map_while(Result::ok), &out_format, files[0]);
} else { } else {
let path = Path::new(files[0]); let path = Path::new(files[0]);
@ -368,7 +368,7 @@ enum ParseState {
use uucore::{format_usage, parse_glob}; use uucore::{format_usage, parse_glob};
#[allow(clippy::cognitive_complexity)] #[allow(clippy::cognitive_complexity)]
fn parse<T>(lines: T, fmt: &OutputFmt, fp: &str) -> Result<String, String> fn parse<T>(user_input: T, fmt: &OutputFmt, fp: &str) -> Result<String, String>
where where
T: IntoIterator, T: IntoIterator,
T::Item: Borrow<str>, T::Item: Borrow<str>,
@ -384,7 +384,7 @@ where
let mut state = ParseState::Global; let mut state = ParseState::Global;
for (num, line) in lines.into_iter().enumerate() { for (num, line) in user_input.into_iter().enumerate() {
let num = num + 1; let num = num + 1;
let line = line.borrow().purify(); let line = line.borrow().purify();
if line.is_empty() { if line.is_empty() {
@ -396,13 +396,12 @@ where
let (key, val) = line.split_two(); let (key, val) = line.split_two();
if val.is_empty() { if val.is_empty() {
return Err(format!( return Err(format!(
"{}:{}: invalid line; missing second token", "{}:{}: invalid line; missing second token",
fp.maybe_quote(), fp.maybe_quote(),
num num
)); ));
} }
let lower = key.to_lowercase(); let lower = key.to_lowercase();
if lower == "term" || lower == "colorterm" { if lower == "term" || lower == "colorterm" {
if term.fnmatch(val) { if term.fnmatch(val) {
state = ParseState::Matched; state = ParseState::Matched;
@ -417,6 +416,7 @@ where
} }
if state != ParseState::Pass { if state != ParseState::Pass {
let search_key = lower.as_str(); let search_key = lower.as_str();
if key.starts_with('.') { if key.starts_with('.') {
if *fmt == OutputFmt::Display { if *fmt == OutputFmt::Display {
result.push_str(format!("\x1b[{val}m*{key}\t{val}\x1b[0m\n").as_str()); result.push_str(format!("\x1b[{val}m*{key}\t{val}\x1b[0m\n").as_str());
@ -482,6 +482,53 @@ fn escape(s: &str) -> String {
result result
} }
pub fn generate_dircolors_config() -> String {
let mut config = String::new();
// Adding the complete header comments as in the original file
writeln!(config, "# Configuration file for dircolors, a utility to help you set the").unwrap();
writeln!(config, "# LS_COLORS environment variable used by GNU ls with the --color option.").unwrap();
writeln!(config, "# The keywords COLOR, OPTIONS, and EIGHTBIT (honored by the").unwrap();
writeln!(config, "# slackware version of dircolors) are recognized but ignored.").unwrap();
writeln!(config, "# Global config options can be specified before TERM or COLORTERM entries").unwrap();
writeln!(config, "# Below are TERM or COLORTERM entries, which can be glob patterns, which").unwrap();
writeln!(config, "# restrict following config to systems with matching environment variables.").unwrap();
writeln!(config, "COLORTERM ?*").unwrap();
for term in TERMS.iter() {
writeln!(config, "TERM {}", term).unwrap();
}
// Adding file types and their color codes with header
writeln!(config, "# Below are the color init strings for the basic file types.").unwrap();
writeln!(config, "# One can use codes for 256 or more colors supported by modern terminals.").unwrap();
writeln!(config, "# The default color codes use the capabilities of an 8 color terminal").unwrap();
writeln!(config, "# with some additional attributes as per the following codes:").unwrap();
writeln!(config, "# Attribute codes:").unwrap();
writeln!(config, "# 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed").unwrap();
writeln!(config, "# Text color codes:").unwrap();
writeln!(config, "# 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white").unwrap();
writeln!(config, "# Background color codes:").unwrap();
writeln!(config, "# 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white").unwrap();
writeln!(config, "#NORMAL 00 # no color code at all").unwrap();
writeln!(config, "#FILE 00 # regular file: use no color at all").unwrap();
for (name, _, code) in FILE_TYPES.iter() {
writeln!(config, "{} {}", name, code).unwrap();
}
writeln!(config, "# List any file extensions like '.gz' or '.tar' that you would like ls").unwrap();
writeln!(config, "# to color below. Put the extension, a space, and the color init string.").unwrap();
for (ext, color) in FILE_COLORS.iter() {
writeln!(config, "{} {}", ext, color).unwrap();
}
writeln!(config, "# Subsequent TERM or COLORTERM entries, can be used to add / override").unwrap();
write!(config, "# config specific to those matching environment variables.").unwrap();
config
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::escape; use super::escape;

60
tests/fixtures/dircolors/internal.expected vendored
View file

@ -1,8 +1,5 @@
# Configuration file for dircolors, a utility to help you set the # Configuration file for dircolors, a utility to help you set the
# LS_COLORS environment variable used by GNU ls with the --color option. # LS_COLORS environment variable used by GNU ls with the --color option.
# Copyright (C) 1996-2022 Free Software Foundation, Inc.
# Copying and distribution of this file, with or without modification,
# are permitted provided the copyright notice and this notice are preserved.
# The keywords COLOR, OPTIONS, and EIGHTBIT (honored by the # The keywords COLOR, OPTIONS, and EIGHTBIT (honored by the
# slackware version of dircolors) are recognized but ignored. # slackware version of dircolors) are recognized but ignored.
# Global config options can be specified before TERM or COLORTERM entries # Global config options can be specified before TERM or COLORTERM entries
@ -46,40 +43,26 @@ TERM xterm*
# 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
#NORMAL 00 # no color code at all #NORMAL 00 # no color code at all
#FILE 00 # regular file: use no color at all #FILE 00 # regular file: use no color at all
RESET 0 # reset to "normal" color RESET 0
DIR 01;34 # directory DIR 01;34
LINK 01;36 # symbolic link. (If you set this to 'target' instead of a LINK 01;36
# numerical value, the color is as for the file pointed to.) MULTIHARDLINK 00
MULTIHARDLINK 00 # regular file with more than one link FIFO 40;33
FIFO 40;33 # pipe SOCK 01;35
SOCK 01;35 # socket DOOR 01;35
DOOR 01;35 # door BLK 40;33;01
BLK 40;33;01 # block device driver CHR 40;33;01
CHR 40;33;01 # character device driver ORPHAN 40;31;01
ORPHAN 40;31;01 # symlink to nonexistent file, or non-stat'able file ... MISSING 00
MISSING 00 # ... and the files they point to SETUID 37;41
SETUID 37;41 # file that is setuid (u+s) SETGID 30;43
SETGID 30;43 # file that is setgid (g+s) CAPABILITY 00
CAPABILITY 00 # file with capability (very expensive to lookup) STICKY_OTHER_WRITABLE 30;42
STICKY_OTHER_WRITABLE 30;42 # dir that is sticky and other-writable (+t,o+w) OTHER_WRITABLE 34;42
OTHER_WRITABLE 34;42 # dir that is other-writable (o+w) and not sticky STICKY 37;44
STICKY 37;44 # dir with the sticky bit set (+t) and not other-writable
# This is for files with execute permission:
EXEC 01;32 EXEC 01;32
# List any file extensions like '.gz' or '.tar' that you would like ls # List any file extensions like '.gz' or '.tar' that you would like ls
# to color below. Put the extension, a space, and the color init string. # to color below. Put the extension, a space, and the color init string.
# (and any comments you want to add after a '#')
# If you use DOS-style suffixes, you may want to uncomment the following:
#.cmd 01;32 # executables (bright green)
#.exe 01;32
#.com 01;32
#.btm 01;32
#.bat 01;32
# Or if you want to color scripts even if they do not have the
# executable bit actually set.
#.sh 01;32
#.csh 01;32
# archives or compressed (bright red)
.tar 01;31 .tar 01;31
.tgz 01;31 .tgz 01;31
.arc 01;31 .arc 01;31
@ -126,7 +109,6 @@ EXEC 01;32
.swm 01;31 .swm 01;31
.dwm 01;31 .dwm 01;31
.esd 01;31 .esd 01;31
# image formats
.avif 01;35 .avif 01;35
.jpg 01;35 .jpg 01;35
.jpeg 01;35 .jpeg 01;35
@ -176,10 +158,8 @@ EXEC 01;32
.yuv 01;35 .yuv 01;35
.cgm 01;35 .cgm 01;35
.emf 01;35 .emf 01;35
# https://wiki.xiph.org/MIME_Types_and_File_Extensions
.ogv 01;35 .ogv 01;35
.ogx 01;35 .ogx 01;35
# audio formats
.aac 00;36 .aac 00;36
.au 00;36 .au 00;36
.flac 00;36 .flac 00;36
@ -192,14 +172,12 @@ EXEC 01;32
.ogg 00;36 .ogg 00;36
.ra 00;36 .ra 00;36
.wav 00;36 .wav 00;36
# https://wiki.xiph.org/MIME_Types_and_File_Extensions
.oga 00;36 .oga 00;36
.opus 00;36 .opus 00;36
.spx 00;36 .spx 00;36
.xspf 00;36 .xspf 00;36
# backup files ~ 00;90
*~ 00;90 # 00;90
*# 00;90
.bak 00;90 .bak 00;90
.old 00;90 .old 00;90
.orig 00;90 .orig 00;90