use std::hash::{Hash, Hasher};
use std::sync::Arc;
use crate::cell::Cell;
use crate::rect::Rect;
use crate::style::Style;
use unicode_width::UnicodeWidthChar;
const MAX_CELL_SYMBOL_BYTES: usize = 32;
pub(crate) const MAX_IMAGE_PIXELS: u64 = 16_777_216;
#[inline]
fn sanitize_cell_char(ch: char) -> char {
let c = ch as u32;
if c < 0x20 || c == 0x7f || (0x80..=0x9f).contains(&c) {
'\u{FFFD}'
} else {
ch
}
}
#[derive(Clone, Debug)]
#[allow(dead_code)]
pub(crate) struct KittyPlacement {
pub content_hash: u64,
pub rgba: Arc<Vec<u8>>,
pub src_width: u32,
pub src_height: u32,
pub x: u32,
pub y: u32,
pub cols: u32,
pub rows: u32,
pub crop_y: u32,
pub crop_h: u32,
}
pub(crate) fn hash_rgba(data: &[u8]) -> u64 {
let mut hasher = std::collections::hash_map::DefaultHasher::new();
data.hash(&mut hasher);
hasher.finish()
}
impl PartialEq for KittyPlacement {
fn eq(&self, other: &Self) -> bool {
self.content_hash == other.content_hash
&& self.x == other.x
&& self.y == other.y
&& self.cols == other.cols
&& self.rows == other.rows
&& self.crop_y == other.crop_y
&& self.crop_h == other.crop_h
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct KittyClipInfo {
pub top_clip_rows: u32,
pub original_height: u32,
}
pub struct Buffer {
pub area: Rect,
pub content: Vec<Cell>,
pub(crate) clip_stack: Vec<Rect>,
pub(crate) raw_sequences: Vec<(u32, u32, String)>,
pub(crate) kitty_placements: Vec<KittyPlacement>,
pub(crate) cursor_pos: Option<(u32, u32)>,
pub(crate) kitty_clip_info_stack: Vec<KittyClipInfo>,
pub(crate) line_hashes: Vec<u64>,
pub(crate) line_dirty: Vec<bool>,
}
impl Buffer {
pub fn empty(area: Rect) -> Self {
let size = area.area() as usize;
let height = area.height as usize;
Self {
area,
content: vec![Cell::default(); size],
clip_stack: Vec::new(),
raw_sequences: Vec::new(),
kitty_placements: Vec::new(),
cursor_pos: None,
kitty_clip_info_stack: Vec::new(),
line_hashes: vec![0; height],
line_dirty: vec![true; height],
}
}
pub(crate) fn push_kitty_clip(&mut self, info: KittyClipInfo) {
self.kitty_clip_info_stack.push(info);
}
pub(crate) fn pop_kitty_clip(&mut self) -> Option<KittyClipInfo> {
self.kitty_clip_info_stack.pop()
}
pub(crate) fn current_kitty_clip(&self) -> Option<&KittyClipInfo> {
self.kitty_clip_info_stack.last()
}
pub(crate) fn set_cursor_pos(&mut self, x: u32, y: u32) {
self.cursor_pos = Some((x, y));
}
#[cfg(feature = "crossterm")]
pub(crate) fn cursor_pos(&self) -> Option<(u32, u32)> {
self.cursor_pos
}
pub fn raw_sequence(&mut self, x: u32, y: u32, seq: String) {
if let Some(clip) = self.effective_clip() {
if x >= clip.right() || y >= clip.bottom() {
return;
}
}
self.raw_sequences.push((x, y, seq));
}
pub(crate) fn kitty_place(&mut self, mut p: KittyPlacement) {
if let Some(clip) = self.effective_clip() {
if p.x >= clip.right()
|| p.y >= clip.bottom()
|| p.x + p.cols <= clip.x
|| p.y + p.rows <= clip.y
{
return;
}
}
if let Some(info) = self.current_kitty_clip() {
let top_clip_rows = info.top_clip_rows;
let original_height = info.original_height;
if original_height > 0 && (top_clip_rows > 0 || p.rows < original_height) {
let ratio = p.src_height as f64 / original_height as f64;
p.crop_y = (top_clip_rows as f64 * ratio) as u32;
let bottom_clip = original_height.saturating_sub(top_clip_rows + p.rows);
let bottom_pixels = (bottom_clip as f64 * ratio) as u32;
p.crop_h = p.src_height.saturating_sub(p.crop_y + bottom_pixels);
}
}
self.kitty_placements.push(p);
}
pub fn push_clip(&mut self, rect: Rect) {
let effective = if let Some(current) = self.clip_stack.last() {
intersect_rects(*current, rect)
} else {
rect
};
self.clip_stack.push(effective);
}
pub fn pop_clip(&mut self) {
self.clip_stack.pop();
}
fn effective_clip(&self) -> Option<&Rect> {
self.clip_stack.last()
}
#[inline]
fn index_of(&self, x: u32, y: u32) -> usize {
((y - self.area.y) * self.area.width + (x - self.area.x)) as usize
}
#[inline]
pub fn in_bounds(&self, x: u32, y: u32) -> bool {
x >= self.area.x && x < self.area.right() && y >= self.area.y && y < self.area.bottom()
}
#[inline]
pub fn get(&self, x: u32, y: u32) -> &Cell {
assert!(
self.in_bounds(x, y),
"Buffer::get({x}, {y}) out of bounds for area {:?}",
self.area
);
&self.content[self.index_of(x, y)]
}
#[inline]
pub fn get_mut(&mut self, x: u32, y: u32) -> &mut Cell {
assert!(
self.in_bounds(x, y),
"Buffer::get_mut({x}, {y}) out of bounds for area {:?}",
self.area
);
let idx = self.index_of(x, y);
&mut self.content[idx]
}
#[inline]
pub fn try_get(&self, x: u32, y: u32) -> Option<&Cell> {
if self.in_bounds(x, y) {
Some(&self.content[self.index_of(x, y)])
} else {
None
}
}
#[inline]
pub fn try_get_mut(&mut self, x: u32, y: u32) -> Option<&mut Cell> {
if self.in_bounds(x, y) {
let idx = self.index_of(x, y);
Some(&mut self.content[idx])
} else {
None
}
}
pub fn set_string(&mut self, x: u32, y: u32, s: &str, style: Style) {
self.set_string_inner(x, y, s, style, None);
}
pub fn set_string_linked(&mut self, x: u32, y: u32, s: &str, style: Style, url: &str) {
let link = sanitize_osc8_url(url).map(compact_str::CompactString::new);
self.set_string_inner(x, y, s, style, link.as_ref());
}
fn set_string_inner(
&mut self,
mut x: u32,
y: u32,
s: &str,
style: Style,
link: Option<&compact_str::CompactString>,
) {
if y >= self.area.bottom() {
return;
}
self.mark_row_dirty(y);
let clip = self.effective_clip().copied();
for ch in s.chars() {
if x >= self.area.right() {
break;
}
let ch = sanitize_cell_char(ch);
let char_width = UnicodeWidthChar::width(ch).unwrap_or(0) as u32;
if char_width == 0 {
if x > self.area.x {
let prev_in_clip = clip.map_or(true, |clip| {
(x - 1) >= clip.x
&& (x - 1) < clip.right()
&& y >= clip.y
&& y < clip.bottom()
});
if prev_in_clip {
let prev = self.get_mut(x - 1, y);
if prev.symbol.len() + ch.len_utf8() <= MAX_CELL_SYMBOL_BYTES {
prev.symbol.push(ch);
}
}
}
continue;
}
let in_clip = clip.map_or(true, |clip| {
x >= clip.x && x < clip.right() && y >= clip.y && y < clip.bottom()
});
if !in_clip {
x = x.saturating_add(char_width);
continue;
}
let cell = self.get_mut(x, y);
cell.set_char(ch);
cell.set_style(style);
cell.hyperlink = link.cloned();
if char_width > 1 {
let next_x = x + 1;
if next_x < self.area.right() {
let next = self.get_mut(next_x, y);
next.symbol.clear();
next.style = style;
next.hyperlink = link.cloned();
}
}
x = x.saturating_add(char_width);
}
}
pub fn set_char(&mut self, x: u32, y: u32, ch: char, style: Style) {
let in_clip = self.effective_clip().map_or(true, |clip| {
x >= clip.x && x < clip.right() && y >= clip.y && y < clip.bottom()
});
if !self.in_bounds(x, y) || !in_clip {
return;
}
self.mark_row_dirty(y);
let cell = self.get_mut(x, y);
cell.set_char(ch);
cell.set_style(style);
}
#[inline]
pub(crate) fn mark_row_dirty(&mut self, y: u32) {
if y < self.area.y {
return;
}
let idx = (y - self.area.y) as usize;
if let Some(slot) = self.line_dirty.get_mut(idx) {
*slot = true;
}
}
#[cfg(any(feature = "crossterm", test))]
pub(crate) fn recompute_line_hashes(&mut self) {
let height = self.area.height;
if height == 0 {
return;
}
let expected_len = height as usize;
if self.line_hashes.len() != expected_len {
self.line_hashes.resize(expected_len, 0);
}
if self.line_dirty.len() != expected_len {
self.line_dirty.resize(expected_len, true);
}
let width = self.area.width as usize;
for (idx, dirty) in self.line_dirty.iter_mut().enumerate() {
if !*dirty {
continue;
}
let row_start = idx * width;
let row_end = row_start + width;
let mut hasher = std::collections::hash_map::DefaultHasher::new();
for cell in &self.content[row_start..row_end] {
cell.symbol.as_str().hash(&mut hasher);
cell.style.hash(&mut hasher);
cell.hyperlink.as_deref().hash(&mut hasher);
}
self.line_hashes[idx] = hasher.finish();
*dirty = false;
}
}
#[inline]
#[cfg(any(feature = "crossterm", test))]
pub(crate) fn row_clean(&self, y: u32) -> bool {
if y < self.area.y {
return false;
}
let idx = (y - self.area.y) as usize;
self.line_dirty
.get(idx)
.copied()
.map(|d| !d)
.unwrap_or(false)
}
#[inline]
#[cfg(any(feature = "crossterm", test))]
pub(crate) fn row_hash(&self, y: u32) -> Option<u64> {
if y < self.area.y {
return None;
}
let idx = (y - self.area.y) as usize;
self.line_hashes.get(idx).copied()
}
pub fn diff<'a>(&'a self, other: &'a Buffer) -> Vec<(u32, u32, &'a Cell)> {
let mut updates = Vec::new();
for y in self.area.y..self.area.bottom() {
for x in self.area.x..self.area.right() {
let cur = self.get(x, y);
let prev = other.get(x, y);
if cur != prev {
updates.push((x, y, cur));
}
}
}
updates
}
pub fn reset(&mut self) {
for cell in &mut self.content {
cell.reset();
}
self.clip_stack.clear();
self.raw_sequences.clear();
self.kitty_placements.clear();
self.cursor_pos = None;
self.kitty_clip_info_stack.clear();
for d in &mut self.line_dirty {
*d = true;
}
}
pub fn reset_with_bg(&mut self, bg: crate::style::Color) {
for cell in &mut self.content {
cell.reset();
cell.style.bg = Some(bg);
}
self.clip_stack.clear();
self.raw_sequences.clear();
self.kitty_placements.clear();
self.cursor_pos = None;
self.kitty_clip_info_stack.clear();
for d in &mut self.line_dirty {
*d = true;
}
}
pub fn resize(&mut self, area: Rect) {
self.area = area;
let size = area.area() as usize;
self.content.resize(size, Cell::default());
let height = area.height as usize;
self.line_hashes.resize(height, 0);
self.line_dirty.resize(height, true);
self.reset();
}
pub fn snapshot_format(&self) -> String {
let mut out = String::new();
let width = self.area.width;
let height = self.area.height;
if width == 0 || height == 0 {
return out;
}
for y in self.area.y..self.area.bottom() {
if y > self.area.y {
out.push('\n');
}
let mut current_style: Option<Style> = None;
let mut run_text = String::new();
for x in self.area.x..self.area.right() {
let cell = self.get(x, y);
let style = cell.style;
let sym: &str = if cell.symbol.is_empty() {
" "
} else {
cell.symbol.as_str()
};
match current_style {
Some(s) if s == style => {
run_text.push_str(sym);
}
_ => {
if let Some(s) = current_style.take() {
flush_run(&mut out, s, &run_text);
run_text.clear();
}
current_style = Some(style);
run_text.push_str(sym);
}
}
}
if let Some(s) = current_style {
flush_run(&mut out, s, &run_text);
}
}
out
}
}
fn flush_run(out: &mut String, style: Style, text: &str) {
if style == Style::default() {
out.push_str(text);
return;
}
out.push('[');
let mut first = true;
if let Some(fg) = style.fg {
out.push_str("fg=");
write_color(out, fg);
first = false;
}
if let Some(bg) = style.bg {
if !first {
out.push(',');
}
out.push_str("bg=");
write_color(out, bg);
first = false;
}
let mods = style.modifiers;
let pairs: [(crate::style::Modifiers, &str); 6] = [
(crate::style::Modifiers::BOLD, "bold"),
(crate::style::Modifiers::DIM, "dim"),
(crate::style::Modifiers::ITALIC, "italic"),
(crate::style::Modifiers::UNDERLINE, "underline"),
(crate::style::Modifiers::REVERSED, "reversed"),
(crate::style::Modifiers::STRIKETHROUGH, "strikethrough"),
];
for (bit, name) in pairs {
if mods.contains(bit) {
if !first {
out.push(',');
}
out.push_str(name);
first = false;
}
}
out.push(']');
out.push('"');
for ch in text.chars() {
match ch {
'"' => out.push_str("\\\""),
'\\' => out.push_str("\\\\"),
other => out.push(other),
}
}
out.push('"');
out.push_str("[/]");
}
fn write_color(out: &mut String, color: crate::style::Color) {
use crate::style::Color;
match color {
Color::Reset => out.push_str("reset"),
Color::Black => out.push_str("black"),
Color::Red => out.push_str("red"),
Color::Green => out.push_str("green"),
Color::Yellow => out.push_str("yellow"),
Color::Blue => out.push_str("blue"),
Color::Magenta => out.push_str("magenta"),
Color::Cyan => out.push_str("cyan"),
Color::White => out.push_str("white"),
Color::DarkGray => out.push_str("dark_gray"),
Color::LightRed => out.push_str("light_red"),
Color::LightGreen => out.push_str("light_green"),
Color::LightYellow => out.push_str("light_yellow"),
Color::LightBlue => out.push_str("light_blue"),
Color::LightMagenta => out.push_str("light_magenta"),
Color::LightCyan => out.push_str("light_cyan"),
Color::LightWhite => out.push_str("light_white"),
Color::Rgb(r, g, b) => {
use std::fmt::Write;
let _ = write!(out, "#{:02x}{:02x}{:02x}", r, g, b);
}
Color::Indexed(idx) => {
use std::fmt::Write;
let _ = write!(out, "idx{}", idx);
}
}
}
const MAX_OSC8_URL_BYTES: usize = 2048;
#[inline]
pub(crate) fn is_valid_osc8_url(url: &str) -> bool {
if url.is_empty() || url.len() > MAX_OSC8_URL_BYTES {
return false;
}
url.bytes().all(|b| b >= 0x20 && b != 0x7f)
}
pub(crate) fn sanitize_osc8_url(url: &str) -> Option<String> {
if is_valid_osc8_url(url) {
Some(url.to_string())
} else {
None
}
}
fn intersect_rects(a: Rect, b: Rect) -> Rect {
let x = a.x.max(b.x);
let y = a.y.max(b.y);
let right = a.right().min(b.right());
let bottom = a.bottom().min(b.bottom());
let width = right.saturating_sub(x);
let height = bottom.saturating_sub(y);
Rect::new(x, y, width, height)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn clip_stack_intersects_nested_regions() {
let mut buf = Buffer::empty(Rect::new(0, 0, 10, 5));
buf.push_clip(Rect::new(1, 1, 6, 3));
buf.push_clip(Rect::new(4, 0, 6, 4));
buf.set_char(3, 2, 'x', Style::new());
buf.set_char(4, 2, 'y', Style::new());
assert_eq!(buf.get(3, 2).symbol, " ");
assert_eq!(buf.get(4, 2).symbol, "y");
}
#[test]
fn set_string_advances_even_when_clipped() {
let mut buf = Buffer::empty(Rect::new(0, 0, 8, 1));
buf.push_clip(Rect::new(2, 0, 6, 1));
buf.set_string(0, 0, "abcd", Style::new());
assert_eq!(buf.get(2, 0).symbol, "c");
assert_eq!(buf.get(3, 0).symbol, "d");
}
#[test]
fn pop_clip_restores_previous_clip() {
let mut buf = Buffer::empty(Rect::new(0, 0, 6, 1));
buf.push_clip(Rect::new(0, 0, 2, 1));
buf.push_clip(Rect::new(4, 0, 2, 1));
buf.set_char(1, 0, 'a', Style::new());
buf.pop_clip();
buf.set_char(1, 0, 'b', Style::new());
assert_eq!(buf.get(1, 0).symbol, "b");
}
#[test]
fn reset_clears_clip_stack() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 1));
buf.push_clip(Rect::new(0, 0, 0, 0));
buf.reset();
buf.set_char(0, 0, 'z', Style::new());
assert_eq!(buf.get(0, 0).symbol, "z");
}
#[test]
fn set_string_replaces_control_chars_with_replacement() {
let mut buf = Buffer::empty(Rect::new(0, 0, 6, 1));
buf.set_string(0, 0, "a\x1bbc", Style::new());
assert_eq!(buf.get(0, 0).symbol, "a");
assert_eq!(buf.get(1, 0).symbol, "\u{FFFD}");
assert_eq!(buf.get(2, 0).symbol, "b");
assert_eq!(buf.get(3, 0).symbol, "c");
}
#[test]
fn zero_width_combining_does_not_append_control_bytes() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 1));
buf.set_char(0, 0, 'a', Style::new());
buf.set_string(1, 0, "\x07", Style::new());
let symbol = buf.get(1, 0).symbol.as_str();
assert!(!symbol.contains('\x07'), "BEL leaked into cell symbol");
}
#[test]
fn set_string_caps_combining_overflow() {
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 1));
buf.set_char(0, 0, 'a', Style::new());
let combining: String = "\u{0301}".repeat(200);
buf.set_string(1, 0, &combining, Style::new());
assert!(
buf.get(0, 0).symbol.len() <= MAX_CELL_SYMBOL_BYTES,
"cell symbol exceeded MAX_CELL_SYMBOL_BYTES cap"
);
}
#[test]
fn sanitize_osc8_url_rejects_control_chars_and_esc() {
assert!(sanitize_osc8_url("https://example.com").is_some());
assert!(sanitize_osc8_url("https://example.com?q=1&r=2").is_some());
assert!(sanitize_osc8_url("https://example.com\x07attack").is_none());
assert!(sanitize_osc8_url("https://example.com\x1b]52;c;hi\x1b\\").is_none());
assert!(sanitize_osc8_url("").is_none());
assert!(sanitize_osc8_url(&"a".repeat(2049)).is_none());
}
#[test]
fn is_valid_osc8_url_matches_sanitize() {
let oversize = "x".repeat(2049);
let cases: &[&str] = &[
"https://example.com",
"http://localhost:8080/path?q=1#frag",
"ftp://[::1]/file",
"",
&oversize,
"https://evil.com\x1b]52;c;inject\x1b\\",
"https://evil.com\x07bel",
"https://example.com\x7f",
"https://example.com\x00",
];
for url in cases {
assert_eq!(
is_valid_osc8_url(url),
sanitize_osc8_url(url).is_some(),
"is_valid_osc8_url and sanitize_osc8_url disagree on {url:?}"
);
}
}
#[test]
fn set_string_inner_parity_no_link() {
let area = Rect::new(0, 0, 20, 1);
let mut buf_a = Buffer::empty(area);
let mut buf_b = Buffer::empty(area);
let style = Style::new();
buf_a.set_string(0, 0, "Hello wide世界", style);
buf_b.set_string_linked(0, 0, "Hello wide世界", style, "");
for x in 0..20 {
let ca = buf_a.get(x, 0);
let cb = buf_b.get(x, 0);
assert_eq!(ca.symbol, cb.symbol, "symbol mismatch at x={x}");
assert_eq!(ca.style, cb.style, "style mismatch at x={x}");
assert_eq!(
cb.hyperlink, None,
"invalid URL must produce None hyperlink at x={x}"
);
}
}
#[test]
fn set_string_linked_attaches_hyperlink_to_wide_char_pair() {
let area = Rect::new(0, 0, 4, 1);
let mut buf = Buffer::empty(area);
buf.set_string_linked(0, 0, "世", Style::new(), "https://example.com");
let leading = buf.get(0, 0);
let trailing = buf.get(1, 0);
assert_eq!(leading.symbol, "世");
assert!(trailing.symbol.is_empty(), "wide-char trailing must blank");
assert!(leading.hyperlink.is_some());
assert_eq!(leading.hyperlink, trailing.hyperlink);
}
#[test]
fn try_get_out_of_bounds_returns_none() {
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 2));
assert!(buf.try_get(0, 0).is_some());
assert!(buf.try_get(2, 0).is_none());
assert!(buf.try_get(0, 2).is_none());
assert!(buf.try_get_mut(5, 5).is_none());
}
#[test]
fn kitty_clip_stack_restores_outer_on_pop() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 4));
assert!(buf.current_kitty_clip().is_none());
let outer = KittyClipInfo {
top_clip_rows: 2,
original_height: 10,
};
let inner = KittyClipInfo {
top_clip_rows: 5,
original_height: 20,
};
buf.push_kitty_clip(outer);
assert_eq!(buf.current_kitty_clip(), Some(&outer));
buf.push_kitty_clip(inner);
assert_eq!(buf.current_kitty_clip(), Some(&inner));
let popped_inner = buf.pop_kitty_clip();
assert_eq!(popped_inner, Some(inner));
assert_eq!(buf.current_kitty_clip(), Some(&outer));
let popped_outer = buf.pop_kitty_clip();
assert_eq!(popped_outer, Some(outer));
assert!(buf.current_kitty_clip().is_none());
}
#[test]
fn kitty_clip_stack_cleared_on_reset() {
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 2));
buf.push_kitty_clip(KittyClipInfo {
top_clip_rows: 1,
original_height: 2,
});
buf.push_kitty_clip(KittyClipInfo {
top_clip_rows: 3,
original_height: 4,
});
buf.reset();
assert!(buf.kitty_clip_info_stack.is_empty());
assert!(buf.current_kitty_clip().is_none());
}
#[test]
fn kitty_clip_pop_on_empty_stack_is_none() {
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 2));
assert!(buf.pop_kitty_clip().is_none());
}
#[test]
fn snapshot_format_default_style_unannotated() {
let mut buf = Buffer::empty(Rect::new(0, 0, 5, 1));
buf.set_string(0, 0, "abc", Style::new());
assert_eq!(buf.snapshot_format(), "abc ");
}
#[test]
fn snapshot_format_color_runs_grouped() {
use crate::style::Color;
let mut buf = Buffer::empty(Rect::new(0, 0, 6, 1));
buf.set_string(0, 0, "abc", Style::new().fg(Color::Red));
buf.set_string(3, 0, "def", Style::new().fg(Color::Blue));
let snap = buf.snapshot_format();
assert_eq!(snap, "[fg=red]\"abc\"[/][fg=blue]\"def\"[/]");
}
#[test]
fn snapshot_format_modifier_transitions() {
let mut buf = Buffer::empty(Rect::new(0, 0, 6, 1));
buf.set_string(0, 0, "ab", Style::new().bold());
buf.set_string(2, 0, "cd", Style::new());
buf.set_string(4, 0, "ef", Style::new().bold());
let snap = buf.snapshot_format();
assert_eq!(snap, "[bold]\"ab\"[/]cd[bold]\"ef\"[/]");
}
#[test]
fn snapshot_format_deterministic() {
use crate::style::Color;
let mut buf = Buffer::empty(Rect::new(0, 0, 8, 2));
buf.set_string(0, 0, "hello", Style::new().fg(Color::Cyan).bold());
buf.set_string(0, 1, "world", Style::new().bg(Color::Rgb(10, 20, 30)));
let a = buf.snapshot_format();
let b = buf.snapshot_format();
assert_eq!(a, b, "snapshot_format must be deterministic");
assert_eq!(a.len(), b.len());
}
#[test]
fn snapshot_format_empty_buffer_is_spaces() {
let buf = Buffer::empty(Rect::new(0, 0, 4, 2));
assert_eq!(buf.snapshot_format(), " \n ");
}
#[test]
fn snapshot_format_zero_dim_returns_empty() {
let buf_a = Buffer::empty(Rect::new(0, 0, 0, 4));
let buf_b = Buffer::empty(Rect::new(0, 0, 4, 0));
assert_eq!(buf_a.snapshot_format(), "");
assert_eq!(buf_b.snapshot_format(), "");
}
#[test]
fn snapshot_format_rgb_uses_hex_codes() {
use crate::style::Color;
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 1));
buf.set_string(0, 0, "x", Style::new().fg(Color::Rgb(0xff, 0x00, 0xab)));
let snap = buf.snapshot_format();
assert!(
snap.contains("fg=#ff00ab"),
"expected hex RGB code, got {snap:?}"
);
}
#[test]
fn snapshot_format_indexed_color() {
use crate::style::Color;
let mut buf = Buffer::empty(Rect::new(0, 0, 2, 1));
buf.set_string(0, 0, "x", Style::new().fg(Color::Indexed(42)));
assert!(buf.snapshot_format().contains("fg=idx42"));
}
#[test]
fn snapshot_format_modifiers_canonical_order() {
let mut buf = Buffer::empty(Rect::new(0, 0, 1, 1));
let style = Style::new().strikethrough().italic().bold();
buf.set_string(0, 0, "x", style);
let snap = buf.snapshot_format();
let bold_idx = snap.find("bold").expect("bold present");
let italic_idx = snap.find("italic").expect("italic present");
let strike_idx = snap.find("strikethrough").expect("strikethrough present");
assert!(bold_idx < italic_idx);
assert!(italic_idx < strike_idx);
}
#[test]
fn snapshot_format_escapes_quote_and_backslash() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 1));
buf.set_string(0, 0, "a\"b\\", Style::new().bold());
let snap = buf.snapshot_format();
assert!(
snap.contains("\"a\\\"b\\\\\""),
"expected escapes, got {snap:?}"
);
}
#[test]
fn snapshot_format_multi_row_uses_newlines() {
let mut buf = Buffer::empty(Rect::new(0, 0, 3, 3));
buf.set_string(0, 0, "aaa", Style::new());
buf.set_string(0, 1, "bbb", Style::new());
buf.set_string(0, 2, "ccc", Style::new());
assert_eq!(buf.snapshot_format(), "aaa\nbbb\nccc");
}
#[test]
fn line_dirty_initial_state_is_all_dirty() {
let buf = Buffer::empty(Rect::new(0, 0, 4, 3));
assert_eq!(buf.line_dirty.len(), 3);
assert!(buf.line_dirty.iter().all(|d| *d));
}
#[test]
fn set_string_marks_row_dirty() {
let mut buf = Buffer::empty(Rect::new(0, 0, 8, 4));
buf.recompute_line_hashes();
assert!(buf.line_dirty.iter().all(|d| !*d));
buf.set_string(0, 1, "hello", Style::new());
assert!(!buf.line_dirty[0]);
assert!(buf.line_dirty[1]);
assert!(!buf.line_dirty[2]);
assert!(!buf.line_dirty[3]);
}
#[test]
fn set_char_marks_row_dirty() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 3));
buf.recompute_line_hashes();
buf.set_char(2, 2, 'X', Style::new());
assert!(!buf.line_dirty[0]);
assert!(!buf.line_dirty[1]);
assert!(buf.line_dirty[2]);
}
#[test]
fn recompute_line_hashes_clears_dirty_and_caches_hashes() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 2));
buf.set_string(0, 0, "abcd", Style::new());
buf.set_string(0, 1, "wxyz", Style::new());
buf.recompute_line_hashes();
assert!(buf.line_dirty.iter().all(|d| !*d));
assert_ne!(buf.line_hashes[0], buf.line_hashes[1]);
assert!(buf.row_clean(0));
assert!(buf.row_clean(1));
}
#[test]
fn row_clean_returns_false_for_unrecomputed_or_dirty_row() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 2));
assert!(!buf.row_clean(0));
buf.recompute_line_hashes();
assert!(buf.row_clean(0));
buf.set_string(0, 0, "z", Style::new());
assert!(!buf.row_clean(0));
}
#[test]
fn identical_buffers_share_line_hashes_after_recompute() {
let area = Rect::new(0, 0, 5, 3);
let mut a = Buffer::empty(area);
let mut b = Buffer::empty(area);
a.set_string(0, 0, "hello", Style::new());
b.set_string(0, 0, "hello", Style::new());
a.set_string(0, 1, "world", Style::new());
b.set_string(0, 1, "world", Style::new());
a.recompute_line_hashes();
b.recompute_line_hashes();
assert_eq!(a.row_hash(0), b.row_hash(0));
assert_eq!(a.row_hash(1), b.row_hash(1));
assert_eq!(a.row_hash(2), b.row_hash(2));
}
#[test]
fn different_styles_yield_different_line_hashes() {
use crate::style::Color;
let area = Rect::new(0, 0, 3, 1);
let mut a = Buffer::empty(area);
let mut b = Buffer::empty(area);
a.set_string(0, 0, "abc", Style::new().fg(Color::Red));
b.set_string(0, 0, "abc", Style::new().fg(Color::Blue));
a.recompute_line_hashes();
b.recompute_line_hashes();
assert_ne!(a.row_hash(0), b.row_hash(0));
}
#[test]
fn resize_keeps_line_arrays_in_sync() {
let mut buf = Buffer::empty(Rect::new(0, 0, 4, 3));
buf.recompute_line_hashes();
buf.resize(Rect::new(0, 0, 4, 5));
assert_eq!(buf.line_dirty.len(), 5);
assert_eq!(buf.line_hashes.len(), 5);
assert!(buf.line_dirty.iter().all(|d| *d));
buf.resize(Rect::new(0, 0, 4, 2));
assert_eq!(buf.line_dirty.len(), 2);
assert_eq!(buf.line_hashes.len(), 2);
assert!(buf.line_dirty.iter().all(|d| *d));
}
}