//! Structs representing output of puppet backend use crate::theme::ColorPair; use crate::theme::Effect; use crate::Vec2; use enumset::EnumSet; use std::ops::Index; use std::ops::IndexMut; use std::rc::Rc; use std::string::ToString; use unicode_segmentation::UnicodeSegmentation; use unicode_width::UnicodeWidthStr; /// Style of observed cell #[derive(Debug, Clone, Eq, PartialEq)] pub struct ObservedStyle { /// Colors: front and back pub colors: ColorPair, /// Effects enabled on observed cell pub effects: EnumSet, } /// Contents of observed cell #[derive(Debug, Clone, Eq, PartialEq)] pub enum GraphemePart { /// Represents begin of wide character Begin(String), /// Represents a cell that is filled with continuation of some character that begun in cell with lower x-index. Continuation, } impl GraphemePart { /// Returns true iff GraphemePart is Continuation pub fn is_continuation(&self) -> bool { match *self { GraphemePart::Continuation => true, _ => false, } } /// Returns Some(String) if GraphemePart is Begin(String), else None. pub fn as_option(&self) -> Option<&String> { match *self { GraphemePart::Begin(ref string) => Some(string), GraphemePart::Continuation => None, } } /// Returns String if GraphemePart is Begin(String), panics otherwise. pub fn unwrap(&self) -> String { match *self { GraphemePart::Begin(ref s) => s.clone(), _ => panic!("unwrapping GraphemePart::Continuation"), } } } /// Represents a single cell of terminal. #[derive(Debug, Clone, Eq, PartialEq)] pub struct ObservedCell { /// Absolute position pub pos: Vec2, /// Style pub style: Rc, /// Part of grapheme - either it's beginning or continuation when character is multi-cell long. pub letter: GraphemePart, } impl ObservedCell { /// Constructor pub fn new( pos: Vec2, style: Rc, letter: Option, ) -> Self { let letter: GraphemePart = match letter { Some(s) => GraphemePart::Begin(s), None => GraphemePart::Continuation, }; ObservedCell { pos, style, letter } } } /// Puppet backend output /// /// Represents single frame. #[derive(Debug, Clone)] pub struct ObservedScreen { /// Size size: Vec2, /// Contents. Each cell can be set or empty. contents: Vec>, } impl ObservedScreen { /// Creates empty ObservedScreen pub fn new(size: Vec2) -> Self { let contents: Vec> = vec![None; size.x * size.y]; ObservedScreen { size, contents } } fn flatten_index(&self, index: Vec2) -> usize { assert!(index.x < self.size.x); assert!(index.y < self.size.y); index.y * self.size.x + index.x } fn unflatten_index(&self, index: usize) -> Vec2 { assert!(index < self.contents.len()); Vec2::new(index / self.size.x, index % self.size.x) } /// Sets all cells to empty cells with given style pub fn clear(&mut self, style: &Rc) { for idx in 0..self.contents.len() { self.contents[idx] = Some(ObservedCell::new( self.unflatten_index(idx), style.clone(), None, )) } } /// Size pub fn size(&self) -> Vec2 { self.size } /// Returns a rectangular subset of observed screen. pub fn piece(&self, min: Vec2, max: Vec2) -> ObservedPiece { ObservedPiece::new(self, min, max) } /// Prints the piece to stdout. pub fn print_stdout(&self) { println!("captured piece:"); print!("x"); for x in 0..self.size().x { print!("{}", x % 10); } println!("x"); for y in 0..self.size().y { print!("{}", y % 10); for x in 0..self.size().x { let pos = Vec2::new(x, y); let cell_op: &Option = &self[pos]; if cell_op.is_some() { let cell = cell_op.as_ref().unwrap(); if cell.letter.is_continuation() { print!("c"); continue; } else { let letter = cell.letter.unwrap(); if letter == " " { print!(" "); } else { print!("{}", letter); } } } else { print!("."); } } print!("|"); println!(); } print!("x"); for _x in 0..self.size().x { print!("-"); } println!("x"); } /// Returns occurences of given string pattern pub fn find_occurences(&self, pattern: &str) -> Vec { // TODO(njskalski): test for two-cell letters. // TODO(njskalski): fails with whitespaces like "\t". let mut hits: Vec = vec![]; for y in self.min().y..self.max().y { 'x: for x in self.min().x..self.max().x { // check candidate. if pattern.len() > self.size().x - x { continue; } let mut pattern_cursor: usize = 0; let mut pos_cursor: usize = 0; loop { let pattern_symbol = pattern .graphemes(true) .nth(pattern_cursor) .unwrap_or_else(|| { panic!( "Found no char at cursor {} in {}", pattern_cursor, &pattern ) }); let pos_it = Vec2::new(x + pos_cursor, y); let found_symbol: Option<&String> = if let Some(ref cell) = self[pos_it] { cell.letter.as_option() } else { None }; match found_symbol { Some(screen_symbol) => { if pattern_symbol == screen_symbol { pattern_cursor += 1; pos_cursor += screen_symbol.width(); } else { continue 'x; } } None => { if pattern_symbol == " " { pattern_cursor += 1; pos_cursor += 1; } else { continue 'x; } } }; if pattern_cursor == pattern.graphemes(true).count() { break; }; } if pattern_cursor == pattern.graphemes(true).count() { hits.push(ObservedLine::new( self, Vec2::new(x, y), pos_cursor, )); } } } hits } } /// Represents rectangular piece of observed screen (Puppet backend output) pub trait ObservedPieceInterface { /// Minimums of coordinates fn min(&self) -> Vec2; /// Maximums of coordinates fn max(&self) -> Vec2; /// Reference of ObservablePiece this one is a subsection of or Self fn parent(&self) -> &ObservedScreen; /// Size of piece fn size(&self) -> Vec2 { self.max() - self.min() } /// Returns a string representation of consecutive lines of this piece. fn as_strings(&self) -> Vec { let mut v: Vec = vec![]; for y in self.min().y..self.max().y { let mut s = String::new(); for x in self.min().x..self.max().x { match &self.parent()[Vec2::new(x, y)] { None => s.push(' '), Some(cell) => { if let GraphemePart::Begin(lex) = &cell.letter { s.push_str(&lex); } } } } v.push(s); } v } /// Returns expanded sibling of this piece /// /// Asserts if request can be satisfied. fn expanded(&self, up_left: Vec2, down_right: Vec2) -> ObservedPiece { assert!(self.min().x >= up_left.x); assert!(self.min().y >= up_left.y); assert!(self.max().x + down_right.x <= self.parent().size.x); assert!(self.max().y + down_right.y <= self.parent().size.y); ObservedPiece::new( self.parent(), self.min() - up_left, self.max() + down_right, ) } } /// Represents a piece or whole of observed screen. pub struct ObservedPiece<'a> { min: Vec2, max: Vec2, parent: &'a ObservedScreen, } impl<'a> ObservedPiece<'a> { fn new(parent: &'a ObservedScreen, min: Vec2, max: Vec2) -> Self { ObservedPiece { min, max, parent } } } impl ObservedPieceInterface for ObservedScreen { fn min(&self) -> Vec2 { Vec2::new(0, 0) } fn max(&self) -> Vec2 { self.size } fn parent(&self) -> &ObservedScreen { self } } impl<'a> ObservedPieceInterface for ObservedPiece<'a> { fn min(&self) -> Vec2 { self.min } fn max(&self) -> Vec2 { self.max } fn parent(&self) -> &ObservedScreen { self.parent } } /// Represents a single line of observed screen. pub struct ObservedLine<'a> { line_start: Vec2, line_len: usize, parent: &'a ObservedScreen, } impl<'a> ObservedLine<'a> { fn new( parent: &'a ObservedScreen, line_start: Vec2, line_len: usize, ) -> Self { ObservedLine { parent, line_start, line_len, } } /// Returns the same line, but expanded. /// /// Asserts whether request can be satisfied pub fn expanded_line(&self, left: usize, right: usize) -> Self { assert!(left <= self.line_start.x); assert!( self.line_start.x + self.line_len + right <= self.parent.size.x ); ObservedLine { parent: self.parent, line_start: Vec2::new(self.line_start.x - left, self.line_start.y), line_len: self.line_len + left + right, } } } impl<'a> ObservedPieceInterface for ObservedLine<'a> { fn min(&self) -> Vec2 { self.line_start } fn max(&self) -> Vec2 { self.line_start + (self.line_len, 1) } fn parent(&self) -> &ObservedScreen { self.parent } } impl<'a> ToString for ObservedLine<'a> { fn to_string(&self) -> String { self.as_strings().remove(0) } } impl Index for dyn ObservedPieceInterface { type Output = Option; fn index(&self, index: Vec2) -> &Self::Output { assert!(self.max() - self.min() > index); let parent_index = self.min() + index; &self.parent()[parent_index] } } impl Index for ObservedScreen { type Output = Option; fn index(&self, index: Vec2) -> &Self::Output { let idx = self.flatten_index(index); &self.contents[idx] } } impl IndexMut for ObservedScreen { fn index_mut(&mut self, index: Vec2) -> &mut Option { let idx = self.flatten_index(index); &mut self.contents[idx] } } #[cfg(test)] mod tests { use super::*; use crate::backend::puppet::DEFAULT_OBSERVED_STYLE; /// Expecting fake_screen to be square, # will be replaced with blank. fn get_observed_screen(fake_screen: &Vec<&str>) -> ObservedScreen { let observed_style: Rc = Rc::new(DEFAULT_OBSERVED_STYLE.clone()); let height = fake_screen.len(); let width = fake_screen[0].width(); let size = Vec2::new(width, height); let mut os = ObservedScreen::new(size); for y in 0..fake_screen.len() { let mut x: usize = 0; for letter in fake_screen[y].graphemes(true) { let idx = os.flatten_index(Vec2::new(x, y)); os.contents[idx] = if letter == "#" { None } else { Some(ObservedCell::new( Vec2::new(x, y), observed_style.clone(), Some(letter.to_owned()), )) }; x += letter.width(); } } os } #[test] fn test_test() { let fake_screen: Vec<&'static str> = vec!["..hello***", "!!##$$$$$*", ".hello^^^^"]; let os = get_observed_screen(&fake_screen); assert_eq!( os[Vec2::new(0, 0)].as_ref().unwrap().letter.as_option(), Some(&".".to_owned()) ); assert_eq!(os[Vec2::new(2, 1)], None); } #[test] fn find_occurrences_no_blanks() { let fake_screen: Vec<&'static str> = vec!["..hello***", "!!##$$$$$*", ".hello^^^^"]; let os = get_observed_screen(&fake_screen); let hits = os.find_occurences("hello"); assert_eq!(hits.len(), 2); assert_eq!(hits[0].size(), Vec2::new(5, 1)); assert_eq!(hits[1].size(), Vec2::new(5, 1)); assert_eq!(hits[0].to_string(), "hello"); assert_eq!(hits[1].to_string(), "hello"); assert_eq!(hits[0].min(), Vec2::new(2, 0)); assert_eq!(hits[0].max(), Vec2::new(7, 1)); assert_eq!(hits[1].min(), Vec2::new(1, 2)); assert_eq!(hits[1].max(), Vec2::new(6, 3)); } #[test] fn find_occurrences_some_blanks() { let fake_screen: Vec<&'static str> = vec!["__hello world_", "hello!world___", "___hello#world"]; let os = get_observed_screen(&fake_screen); let hits = os.find_occurences("hello world"); assert_eq!(hits.len(), 2); assert_eq!(hits[0].size(), Vec2::new(11, 1)); assert_eq!(hits[1].size(), Vec2::new(11, 1)); assert_eq!(hits[0].to_string(), "hello world"); assert_eq!(hits[1].to_string(), "hello world"); assert_eq!(hits[0].min(), Vec2::new(2, 0)); assert_eq!(hits[0].max(), Vec2::new(13, 1)); assert_eq!(hits[1].min(), Vec2::new(3, 2)); assert_eq!(hits[1].max(), Vec2::new(14, 3)); } #[test] fn test_expand_lines() { let fake_screen: Vec<&'static str> = vec!["abc hello#efg"]; let os = get_observed_screen(&fake_screen); let hits = os.find_occurences("hello"); assert_eq!(hits.len(), 1); let hit = hits.first().unwrap(); assert_eq!(hit.size(), Vec2::new(5, 1)); let expanded_left = hit.expanded_line(3, 0); assert_eq!(expanded_left.size(), Vec2::new(8, 1)); assert_eq!(expanded_left.to_string(), "bc hello"); let expanded_left = hit.expanded_line(4, 0); assert_eq!(expanded_left.size(), Vec2::new(9, 1)); assert_eq!(expanded_left.to_string(), "abc hello"); let expanded_right = hit.expanded_line(0, 2); assert_eq!(expanded_right.size(), Vec2::new(7, 1)); assert_eq!(expanded_right.to_string(), "hello e"); let expanded_right = hit.expanded_line(0, 4); assert_eq!(expanded_right.size(), Vec2::new(9, 1)); assert_eq!(expanded_right.to_string(), "hello efg"); } #[test] fn test_expand_lines_weird_symbol_1() { let fake_screen: Vec<&'static str> = vec!["abc ▸ #efg"]; let os = get_observed_screen(&fake_screen); let hits = os.find_occurences("root"); assert_eq!(hits.len(), 1); let hit = hits.first().unwrap(); assert_eq!(hit.size(), Vec2::new(4, 1)); let expanded_left = hit.expanded_line(3, 0); assert_eq!(expanded_left.size(), Vec2::new(7, 1)); assert_eq!(expanded_left.to_string(), "▸ efg"); } #[test] fn test_expand_lines_weird_symbol_2() { let fake_screen: Vec<&'static str> = vec!["abc ▸ #efg"]; let os = get_observed_screen(&fake_screen); let hits = os.find_occurences("▸"); assert_eq!(hits.len(), 1); let hit = hits.first().unwrap(); assert_eq!(hit.size(), Vec2::new(1, 1)); let expanded_left = hit.expanded_line(3, 0); assert_eq!(expanded_left.size(), Vec2::new(4, 1)); assert_eq!(expanded_left.to_string(), "bc ▸"); let expanded_right = hit.expanded_line(0, 9); assert_eq!(expanded_right.size(), Vec2::new(10, 1)); assert_eq!(expanded_right.to_string(), "▸ e"); } }