blob: 92cc48c41da891b554082a23f8c382fce669aa51 [file] [log] [blame]
use std::borrow::Cow;
use crate::{
grid::config::SpannedConfig, grid::dimension::SpannedGridDimension, grid::records::Records,
};
pub(crate) fn get_table_widths<R: Records>(records: R, cfg: &SpannedConfig) -> Vec<usize> {
SpannedGridDimension::width(records, cfg)
}
pub(crate) fn get_table_widths_with_total<R: Records>(
records: R,
cfg: &SpannedConfig,
) -> (Vec<usize>, usize) {
let widths = SpannedGridDimension::width(records, cfg);
let total_width = get_table_total_width(&widths, cfg);
(widths, total_width)
}
fn get_table_total_width(list: &[usize], cfg: &SpannedConfig) -> usize {
let margin = cfg.get_margin();
list.iter().sum::<usize>()
+ cfg.count_vertical(list.len())
+ margin.left.size
+ margin.right.size
}
/// The function cuts the string to a specific width.
///
/// BE AWARE: width is expected to be in bytes.
pub(crate) fn cut_str(s: &str, width: usize) -> Cow<'_, str> {
#[cfg(feature = "color")]
{
const REPLACEMENT: char = '\u{FFFD}';
let stripped = ansi_str::AnsiStr::ansi_strip(s);
let (length, count_unknowns, _) = split_at_pos(&stripped, width);
let mut buf = ansi_str::AnsiStr::ansi_cut(s, ..length);
if count_unknowns > 0 {
let mut b = buf.into_owned();
b.extend(std::iter::repeat(REPLACEMENT).take(count_unknowns));
buf = Cow::Owned(b);
}
buf
}
#[cfg(not(feature = "color"))]
{
cut_str_basic(s, width)
}
}
/// The function cuts the string to a specific width.
///
/// BE AWARE: width is expected to be in bytes.
#[cfg(not(feature = "color"))]
pub(crate) fn cut_str_basic(s: &str, width: usize) -> Cow<'_, str> {
const REPLACEMENT: char = '\u{FFFD}';
let (length, count_unknowns, _) = split_at_pos(s, width);
let buf = &s[..length];
if count_unknowns == 0 {
return Cow::Borrowed(buf);
}
let mut buf = buf.to_owned();
buf.extend(std::iter::repeat(REPLACEMENT).take(count_unknowns));
Cow::Owned(buf)
}
/// The function splits a string in the position and
/// returns a exact number of bytes before the position and in case of a split in an unicode grapheme
/// a width of a character which was tried to be splited in.
///
/// BE AWARE: pos is expected to be in bytes.
pub(crate) fn split_at_pos(s: &str, pos: usize) -> (usize, usize, usize) {
let mut length = 0;
let mut i = 0;
for c in s.chars() {
if i == pos {
break;
};
let c_width = unicode_width::UnicodeWidthChar::width(c).unwrap_or_default();
// We cut the chars which takes more then 1 symbol to display,
// in order to archive the necessary width.
if i + c_width > pos {
let count = pos - i;
return (length, count, c.len_utf8());
}
i += c_width;
length += c.len_utf8();
}
(length, 0, 0)
}
/// Strip OSC codes from `s`. If `s` is a single OSC8 hyperlink, with no other text, then return
/// (s_with_all_hyperlinks_removed, Some(url)). If `s` does not meet this description, then return
/// (s_with_all_hyperlinks_removed, None). Any ANSI color sequences in `s` will be retained. See
/// <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>
///
/// The function is based on Dan Davison <https://github.com/dandavison> delta <https://github.com/dandavison/delta> ansi library.
#[cfg(feature = "color")]
pub(crate) fn strip_osc(text: &str) -> (String, Option<String>) {
#[derive(Debug)]
enum ExtractOsc8HyperlinkState {
ExpectOsc8Url,
ExpectFirstText,
ExpectMoreTextOrTerminator,
SeenOneHyperlink,
WillNotReturnUrl,
}
use ExtractOsc8HyperlinkState::*;
let mut url = None;
let mut state = ExpectOsc8Url;
let mut buf = String::with_capacity(text.len());
for el in ansitok::parse_ansi(text) {
match el.kind() {
ansitok::ElementKind::Osc => match state {
ExpectOsc8Url => {
url = Some(&text[el.start()..el.end()]);
state = ExpectFirstText;
}
ExpectMoreTextOrTerminator => state = SeenOneHyperlink,
_ => state = WillNotReturnUrl,
},
ansitok::ElementKind::Sgr => buf.push_str(&text[el.start()..el.end()]),
ansitok::ElementKind::Csi => buf.push_str(&text[el.start()..el.end()]),
ansitok::ElementKind::Esc => {}
ansitok::ElementKind::Text => {
buf.push_str(&text[el.start()..el.end()]);
match state {
ExpectFirstText => state = ExpectMoreTextOrTerminator,
ExpectMoreTextOrTerminator => {}
_ => state = WillNotReturnUrl,
}
}
}
}
match state {
WillNotReturnUrl => (buf, None),
_ => {
let url = url.and_then(|s| {
s.strip_prefix("\x1b]8;;")
.and_then(|s| s.strip_suffix('\x1b'))
});
if let Some(url) = url {
(buf, Some(url.to_string()))
} else {
(buf, None)
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::grid::util::string::string_width;
#[cfg(feature = "color")]
use owo_colors::{colors::Yellow, OwoColorize};
#[test]
fn strip_test() {
assert_eq!(cut_str("123456", 0), "");
assert_eq!(cut_str("123456", 3), "123");
assert_eq!(cut_str("123456", 10), "123456");
assert_eq!(cut_str("a week ago", 4), "a we");
assert_eq!(cut_str("😳😳😳😳😳", 0), "");
assert_eq!(cut_str("😳😳😳😳😳", 3), "😳�");
assert_eq!(cut_str("😳😳😳😳😳", 4), "😳😳");
assert_eq!(cut_str("😳😳😳😳😳", 20), "😳😳😳😳😳");
assert_eq!(cut_str("🏳️🏳️", 0), "");
assert_eq!(cut_str("🏳️🏳️", 1), "🏳");
assert_eq!(cut_str("🏳️🏳️", 2), "🏳\u{fe0f}🏳");
assert_eq!(string_width("🏳️🏳️"), string_width("🏳\u{fe0f}🏳"));
assert_eq!(cut_str("🎓", 1), "�");
assert_eq!(cut_str("🎓", 2), "🎓");
assert_eq!(cut_str("🥿", 1), "�");
assert_eq!(cut_str("🥿", 2), "🥿");
assert_eq!(cut_str("🩰", 1), "�");
assert_eq!(cut_str("🩰", 2), "🩰");
assert_eq!(cut_str("👍🏿", 1), "�");
assert_eq!(cut_str("👍🏿", 2), "👍");
assert_eq!(cut_str("👍🏿", 3), "👍�");
assert_eq!(cut_str("👍🏿", 4), "👍🏿");
assert_eq!(cut_str("🇻🇬", 1), "🇻");
assert_eq!(cut_str("🇻🇬", 2), "🇻🇬");
assert_eq!(cut_str("🇻🇬", 3), "🇻🇬");
assert_eq!(cut_str("🇻🇬", 4), "🇻🇬");
}
#[cfg(feature = "color")]
#[test]
fn strip_color_test() {
let numbers = "123456".red().on_bright_black().to_string();
assert_eq!(cut_str(&numbers, 0), "\u{1b}[31;100m\u{1b}[39m\u{1b}[49m");
assert_eq!(
cut_str(&numbers, 3),
"\u{1b}[31;100m123\u{1b}[39m\u{1b}[49m"
);
assert_eq!(cut_str(&numbers, 10), "\u{1b}[31;100m123456\u{1b}[0m");
let emojies = "😳😳😳😳😳".red().on_bright_black().to_string();
assert_eq!(cut_str(&emojies, 0), "\u{1b}[31;100m\u{1b}[39m\u{1b}[49m");
assert_eq!(
cut_str(&emojies, 3),
"\u{1b}[31;100m😳\u{1b}[39m\u{1b}[49m�"
);
assert_eq!(
cut_str(&emojies, 4),
"\u{1b}[31;100m😳😳\u{1b}[39m\u{1b}[49m"
);
assert_eq!(cut_str(&emojies, 20), "\u{1b}[31;100m😳😳😳😳😳\u{1b}[0m");
let emojies = "🏳️🏳️".red().on_bright_black().to_string();
assert_eq!(cut_str(&emojies, 0), "\u{1b}[31;100m\u{1b}[39m\u{1b}[49m");
assert_eq!(cut_str(&emojies, 1), "\u{1b}[31;100m🏳\u{1b}[39m\u{1b}[49m");
assert_eq!(
cut_str(&emojies, 2),
"\u{1b}[31;100m🏳\u{fe0f}🏳\u{1b}[39m\u{1b}[49m"
);
assert_eq!(
string_width(&emojies),
string_width("\u{1b}[31;100m🏳\u{fe0f}🏳\u{1b}[39m\u{1b}[49m")
);
}
#[test]
#[cfg(feature = "color")]
fn test_color_strip() {
let s = "Collored string"
.fg::<Yellow>()
.on_truecolor(12, 200, 100)
.blink()
.to_string();
assert_eq!(
cut_str(&s, 1),
"\u{1b}[5m\u{1b}[48;2;12;200;100m\u{1b}[33mC\u{1b}[25m\u{1b}[39m\u{1b}[49m"
)
}
}