tmux-copyrat/src/view.rs

918 lines
30 KiB
Rust
Raw Normal View History

2020-05-22 15:03:39 +02:00
use super::{colors, state};
2020-05-26 08:11:45 +02:00
2020-05-27 10:04:42 +02:00
use crate::error::ParseError;
2020-05-24 21:02:11 +02:00
use clap::Clap;
2020-06-02 20:03:16 +02:00
use std::char;
2020-05-28 09:24:33 +02:00
use std::io;
2020-05-27 10:04:42 +02:00
use std::str::FromStr;
2020-05-28 09:24:33 +02:00
use termion::{self, color, cursor, event, style};
2020-06-02 20:03:16 +02:00
pub struct View<'a> {
2020-05-25 23:06:00 +02:00
state: &'a mut state::State<'a>,
matches: Vec<state::Match<'a>>,
focus_index: usize,
multi: bool,
2020-05-25 23:32:37 +02:00
hint_alignment: &'a HintAlignment,
2020-05-25 23:06:00 +02:00
rendering_colors: &'a ViewColors,
hint_style: Option<HintStyle>,
2020-05-23 09:30:09 +02:00
}
/// Holds color-related data, for clarity.
///
/// - `focus_*` colors are used to render the currently focused matched text.
/// - `normal_*` colors are used to render other matched text.
/// - `hint_*` colors are used to render the hints.
2020-05-24 21:02:11 +02:00
#[derive(Clap, Debug)]
pub struct ViewColors {
2020-05-25 23:06:00 +02:00
/// Foreground color for matches.
#[clap(long, default_value = "green",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub match_fg: Box<dyn color::Color>,
2020-05-24 21:02:11 +02:00
2020-05-25 23:06:00 +02:00
/// Background color for matches.
#[clap(long, default_value = "black",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub match_bg: Box<dyn color::Color>,
2020-05-24 21:02:11 +02:00
2020-05-25 23:06:00 +02:00
/// Foreground color for the focused match.
#[clap(long, default_value = "blue",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub focused_fg: Box<dyn color::Color>,
2020-05-24 21:02:11 +02:00
2020-05-25 23:06:00 +02:00
/// Background color for the focused match.
#[clap(long, default_value = "black",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub focused_bg: Box<dyn color::Color>,
2020-05-24 21:02:11 +02:00
2020-05-25 23:06:00 +02:00
/// Foreground color for hints.
#[clap(long, default_value = "white",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub hint_fg: Box<dyn color::Color>,
2020-05-24 21:02:11 +02:00
2020-05-25 23:06:00 +02:00
/// Background color for hints.
#[clap(long, default_value = "black",
2020-05-24 21:02:11 +02:00
parse(try_from_str = colors::parse_color))]
2020-05-27 10:04:42 +02:00
pub hint_bg: Box<dyn color::Color>,
2020-06-02 20:03:16 +02:00
}
2020-05-22 15:03:39 +02:00
/// Describes if, during rendering, a hint should aligned to the leading edge of
/// the matched text, or to its trailing edge.
2020-05-24 21:02:11 +02:00
#[derive(Debug, Clap)]
2020-05-23 09:30:09 +02:00
pub enum HintAlignment {
2020-05-25 23:06:00 +02:00
Leading,
Trailing,
2020-05-22 15:03:39 +02:00
}
2020-05-27 10:04:42 +02:00
impl FromStr for HintAlignment {
type Err = ParseError;
fn from_str(s: &str) -> Result<HintAlignment, ParseError> {
match s {
"leading" => Ok(HintAlignment::Leading),
"trailing" => Ok(HintAlignment::Trailing),
_ => Err(ParseError::ExpectedString(String::from(
"leading or trailing",
))),
}
}
}
2020-05-22 15:03:39 +02:00
/// Describes the style of contrast to be used during rendering of the hint's
/// text.
///
/// # Note
/// In practice, this is wrapped in an `Option`, so that the hint's text can be rendered with no style.
2020-05-23 09:30:09 +02:00
pub enum HintStyle {
2020-05-29 16:23:46 +02:00
/// The hint's text will be bold (leveraging `termion::style::Bold`).
Bold,
2020-05-28 07:07:51 +02:00
/// The hint's text will be italicized (leveraging `termion::style::Italic`).
Italic,
2020-05-25 23:06:00 +02:00
/// The hint's text will be underlined (leveraging `termion::style::Underline`).
Underline,
/// The hint's text will be surrounded by these chars.
Surround(char, char),
2020-05-22 15:03:39 +02:00
}
/// Returned value after the `View` has finished listening to events.
2020-06-02 20:03:16 +02:00
enum CaptureEvent {
2020-05-25 23:06:00 +02:00
/// Exit with no selected matches,
Exit,
/// A vector of matched text and whether it was selected with uppercase.
Hint(Vec<(String, bool)>),
2020-06-02 20:03:16 +02:00
}
impl<'a> View<'a> {
2020-05-25 23:06:00 +02:00
pub fn new(
state: &'a mut state::State<'a>,
multi: bool,
reversed: bool,
2020-05-26 08:11:45 +02:00
unique_hint: bool,
2020-05-25 23:32:37 +02:00
hint_alignment: &'a HintAlignment,
2020-05-25 23:06:00 +02:00
rendering_colors: &'a ViewColors,
hint_style: Option<HintStyle>,
) -> View<'a> {
2020-05-26 08:11:45 +02:00
let matches = state.matches(reversed, unique_hint);
2020-05-25 23:06:00 +02:00
let focus_index = if reversed { matches.len() - 1 } else { 0 };
View {
state,
matches,
focus_index,
multi,
hint_alignment,
rendering_colors,
hint_style,
}
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Move focus onto the previous hint.
pub fn prev(&mut self) {
if self.focus_index > 0 {
self.focus_index -= 1;
}
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Move focus onto the next hint.
pub fn next(&mut self) {
if self.focus_index < self.matches.len() - 1 {
self.focus_index += 1;
}
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Render entire state lines on provided writer.
///
/// This renders the basic content on which matches and hints can be rendered.
///
/// # Notes
/// - All trailing whitespaces are trimmed, empty lines are skipped.
/// - This writes directly on the writer, avoiding extra allocation.
2020-05-28 09:24:33 +02:00
fn render_lines(stdout: &mut dyn io::Write, lines: &Vec<&str>) -> () {
2020-05-25 23:06:00 +02:00
for (index, line) in lines.iter().enumerate() {
let trimmed_line = line.trim_end();
if !trimmed_line.is_empty() {
write!(
stdout,
"{goto}{text}",
goto = cursor::Goto(1, index as u16 + 1),
text = &trimmed_line,
)
.unwrap();
}
}
2020-05-22 15:03:39 +02:00
}
2020-05-25 23:06:00 +02:00
/// Render the Match's `text` field on provided writer.
///
/// If a Mach is "focused", then it is rendered with a specific color.
///
/// # Note
/// This writes directly on the writer, avoiding extra allocation.
fn render_matched_text(
2020-05-28 09:24:33 +02:00
stdout: &mut dyn io::Write,
2020-05-25 23:06:00 +02:00
text: &str,
focused: bool,
offset: (usize, usize),
colors: &ViewColors,
) {
// To help identify it, the match thas has focus is rendered with a dedicated color.
let (text_fg_color, text_bg_color) = if focused {
(&colors.focused_fg, &colors.focused_bg)
} else {
(&colors.match_fg, &colors.match_bg)
};
// Render just the Match's text on top of existing content.
2020-05-22 15:03:39 +02:00
write!(
stdout,
2020-05-25 23:06:00 +02:00
"{goto}{bg_color}{fg_color}{text}{fg_reset}{bg_reset}",
2020-05-22 15:03:39 +02:00
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
2020-05-25 23:06:00 +02:00
fg_color = color::Fg(text_fg_color.as_ref()),
bg_color = color::Bg(text_bg_color.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
text = &text,
)
.unwrap();
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Render a Match's `hint` field on the provided writer.
///
/// This renders the hint according to some provided style:
/// - just colors
/// - underlined with colors
/// - surrounding the hint's text with some delimiters, see
/// `HintStyle::Delimited`.
///
/// # Note
/// This writes directly on the writer, avoiding extra allocation.
fn render_matched_hint(
2020-05-28 09:24:33 +02:00
stdout: &mut dyn io::Write,
2020-05-25 23:06:00 +02:00
hint_text: &str,
offset: (usize, usize),
colors: &ViewColors,
hint_style: &Option<HintStyle>,
) {
let fg_color = color::Fg(colors.hint_fg.as_ref());
let bg_color = color::Bg(colors.hint_bg.as_ref());
let fg_reset = color::Fg(color::Reset);
let bg_reset = color::Bg(color::Reset);
match hint_style {
None => {
write!(
stdout,
"{goto}{bg_color}{fg_color}{hint}{fg_reset}{bg_reset}",
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
fg_color = fg_color,
bg_color = bg_color,
fg_reset = fg_reset,
bg_reset = bg_reset,
hint = hint_text,
)
.unwrap();
}
Some(hint_style) => match hint_style {
2020-05-29 16:23:46 +02:00
HintStyle::Bold => {
write!(
stdout,
"{goto}{bg_color}{fg_color}{sty}{hint}{sty_reset}{fg_reset}{bg_reset}",
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
fg_color = fg_color,
bg_color = bg_color,
fg_reset = fg_reset,
bg_reset = bg_reset,
sty = style::Bold,
sty_reset = style::NoBold,
hint = hint_text,
)
.unwrap();
}
2020-05-28 07:07:51 +02:00
HintStyle::Italic => {
write!(
stdout,
"{goto}{bg_color}{fg_color}{sty}{hint}{sty_reset}{fg_reset}{bg_reset}",
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
fg_color = fg_color,
bg_color = bg_color,
fg_reset = fg_reset,
bg_reset = bg_reset,
sty = style::Italic,
sty_reset = style::NoItalic,
hint = hint_text,
)
.unwrap();
}
2020-05-25 23:06:00 +02:00
HintStyle::Underline => {
write!(
stdout,
"{goto}{bg_color}{fg_color}{sty}{hint}{sty_reset}{fg_reset}{bg_reset}",
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
fg_color = fg_color,
bg_color = bg_color,
fg_reset = fg_reset,
bg_reset = bg_reset,
sty = style::Underline,
sty_reset = style::NoUnderline,
hint = hint_text,
)
.unwrap();
}
HintStyle::Surround(opening, closing) => {
write!(
stdout,
"{goto}{bg_color}{fg_color}{bra}{hint}{bra_close}{fg_reset}{bg_reset}",
goto = cursor::Goto(offset.0 as u16 + 1, offset.1 as u16 + 1),
fg_color = fg_color,
bg_color = bg_color,
fg_reset = fg_reset,
bg_reset = bg_reset,
bra = opening,
bra_close = closing,
hint = hint_text,
)
.unwrap();
}
},
}
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Render the view on the provided writer.
///
/// This renders in 3 phases:
/// - all lines are rendered verbatim
/// - each Match's `text` is rendered as an overlay on top of it
/// - each Match's `hint` text is rendered as a final overlay
///
/// Depending on the value of `self.hint_alignment`, the hint can be rendered
/// on the leading edge of the underlying Match's `text`,
/// or on the trailing edge.
///
/// # Note
/// Multibyte characters are taken into account, so that the Match's `text`
/// and `hint` are rendered in their proper position.
2020-05-28 09:24:33 +02:00
fn render(&self, stdout: &mut dyn io::Write) -> () {
2020-05-25 23:06:00 +02:00
write!(stdout, "{}", cursor::Hide).unwrap();
// 1. Trim all lines and render non-empty ones.
View::render_lines(stdout, self.state.lines);
for (index, mat) in self.matches.iter().enumerate() {
// 2. Render the match's text.
// If multibyte characters occur before the hint (in the "prefix"), then
// their compouding takes less space on screen when printed: for
// instance ´ + e = é. Consequently the hint offset has to be adjusted
// to the left.
let offset_x = {
let line = &self.state.lines[mat.y as usize];
let prefix = &line[0..mat.x as usize];
let adjust = prefix.len() - prefix.chars().count();
(mat.x as usize) - (adjust)
};
let offset_y = mat.y as usize;
let text = &mat.text;
let focused = index == self.focus_index;
View::render_matched_text(
stdout,
text,
focused,
(offset_x, offset_y),
&self.rendering_colors,
);
// 3. Render the hint (e.g. "eo") as an overlay on top of the rendered matched text,
// aligned at its leading or the trailing edge.
if let Some(ref hint) = mat.hint {
let extra_offset = match self.hint_alignment {
HintAlignment::Leading => 0,
HintAlignment::Trailing => text.len() - hint.len(),
};
View::render_matched_hint(
stdout,
hint,
(offset_x + extra_offset, offset_y),
&self.rendering_colors,
&self.hint_style,
);
}
}
stdout.flush().unwrap();
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
/// Listen to keys entered on stdin, moving focus accordingly, and selecting
/// one or multiple matches.
///
/// # Panics
/// This function panics if termion cannot read the entered keys on stdin.
/// This function also panics if the user types Insert on a line without hints.
2020-05-28 09:24:33 +02:00
fn listen(&mut self, reader: &mut dyn io::Read, writer: &mut dyn io::Write) -> CaptureEvent {
use termion::input::TermRead; // Trait for `reader.keys().next()`.
2020-05-25 23:06:00 +02:00
if self.matches.is_empty() {
return CaptureEvent::Exit;
}
2020-05-25 23:06:00 +02:00
let mut chosen = vec![];
let mut typed_hint: String = "".to_owned();
let longest_hint = self
.matches
.iter()
.filter_map(|m| m.hint.clone())
.max_by(|x, y| x.len().cmp(&y.len()))
.unwrap()
.clone();
2020-05-28 09:24:33 +02:00
self.render(writer);
2020-05-25 23:06:00 +02:00
loop {
// This is an option of a result of a key... Let's pop error cases first.
2020-05-28 09:24:33 +02:00
let next_key = reader.keys().next();
2020-05-25 23:06:00 +02:00
if next_key.is_none() {
// Nothing in the buffer. Wait for a bit...
std::thread::sleep(std::time::Duration::from_millis(100));
continue;
}
2020-05-25 23:06:00 +02:00
let key_res = next_key.unwrap();
if let Err(err) = key_res {
// Termion not being able to read from stdin is an unrecoverable error.
panic!(err);
}
2020-05-25 23:06:00 +02:00
match key_res.unwrap() {
// Clears an ongoing multi-hint selection, or exit.
2020-05-28 09:24:33 +02:00
event::Key::Esc => {
2020-05-25 23:06:00 +02:00
if self.multi && !typed_hint.is_empty() {
typed_hint.clear();
} else {
break;
}
}
// In multi-selection mode, this appends the selected hint to the
// vector of selections. In normal mode, this returns with the hint
// selected.
2020-05-28 09:24:33 +02:00
event::Key::Insert => match self.matches.get(self.focus_index) {
2020-05-25 23:06:00 +02:00
Some(mat) => {
chosen.push((mat.text.to_string(), false));
if !self.multi {
return CaptureEvent::Hint(chosen);
}
}
None => panic!("Match not found?"),
},
// Move focus to next/prev match.
2020-05-28 09:24:33 +02:00
event::Key::Up => self.prev(),
event::Key::Down => self.next(),
event::Key::Left => self.prev(),
event::Key::Right => self.next(),
2020-05-25 23:06:00 +02:00
// Pressing space finalizes an ongoing multi-hint selection (without
// selecting the focused match). Pressing other characters attempts at
// finding a match with a corresponding hint.
2020-05-28 09:24:33 +02:00
event::Key::Char(ch) => {
2020-05-25 23:06:00 +02:00
if ch == ' ' && self.multi {
return CaptureEvent::Hint(chosen);
}
let key = ch.to_string();
let lower_key = key.to_lowercase();
typed_hint.push_str(&lower_key);
// Find the match that corresponds to the entered key.
2020-05-29 16:23:46 +02:00
let selection = self.matches
.iter()
// Avoid cloning typed_hint for comparison.
.find(|&mat| mat.hint.as_deref().unwrap_or_default() == &typed_hint);
2020-05-25 23:06:00 +02:00
match selection {
Some(mat) => {
chosen.push((mat.text.to_string(), key != lower_key));
if self.multi {
typed_hint.clear();
} else {
return CaptureEvent::Hint(chosen);
}
}
None => {
// TODO: use a Trie or another data structure to determine
// if the entered key belongs to a longer hint.
if !self.multi && typed_hint.len() >= longest_hint.len() {
break;
}
}
}
}
// Unknown keys are ignored.
_ => (),
}
2020-05-25 23:06:00 +02:00
// Render on stdout if we did not exit earlier (move focus,
// multi-selection).
2020-05-28 09:24:33 +02:00
self.render(writer);
2020-05-25 23:06:00 +02:00
}
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
CaptureEvent::Exit
2020-06-02 20:03:16 +02:00
}
2020-05-25 23:06:00 +02:00
pub fn present(&mut self) -> Vec<(String, bool)> {
2020-05-28 09:24:33 +02:00
use std::io::Write;
use termion::raw::IntoRawMode;
use termion::screen::AlternateScreen;
let mut stdin = termion::async_stdin();
let mut stdout = AlternateScreen::from(
io::stdout()
.into_raw_mode()
.expect("Cannot access alternate screen."),
);
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
let hints = match self.listen(&mut stdin, &mut stdout) {
CaptureEvent::Exit => vec![],
CaptureEvent::Hint(chosen) => chosen,
};
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
write!(stdout, "{}", cursor::Show).unwrap();
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
hints
}
2020-06-02 20:03:16 +02:00
}
#[cfg(test)]
mod tests {
2020-05-25 23:06:00 +02:00
use super::*;
use crate::alphabets;
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
#[test]
fn test_render_all_lines() {
let content = "some text
2020-05-22 15:03:39 +02:00
* e006b06 - (12 days ago) swapper: Make quotes
path: /usr/local/bin/git
path: /usr/local/bin/cargo";
2020-05-25 23:06:00 +02:00
let lines: Vec<&str> = content.split('\n').collect();
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let mut writer = vec![];
View::render_lines(&mut writer, &lines);
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let goto1 = cursor::Goto(1, 1);
let goto2 = cursor::Goto(1, 2);
let goto3 = cursor::Goto(1, 3);
let goto6 = cursor::Goto(1, 6);
assert_eq!(
2020-05-22 15:03:39 +02:00
writer,
format!(
"{}some text{}* e006b06 - (12 days ago) swapper: Make quotes{}path: /usr/local/bin/git{}path: /usr/local/bin/cargo",
goto1, goto2, goto3, goto6,
)
.as_bytes()
);
2020-05-25 23:06:00 +02:00
}
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
#[test]
fn test_render_focused_matched_text() {
let mut writer = vec![];
let text = "https://en.wikipedia.org/wiki/Barcelona";
let focused = true;
let offset: (usize, usize) = (3, 1);
let colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
View::render_matched_text(&mut writer, text, focused, offset, &colors);
assert_eq!(
writer,
format!(
"{goto}{bg}{fg}{text}{fg_reset}{bg_reset}",
goto = cursor::Goto(4, 2),
fg = color::Fg(colors.focused_fg.as_ref()),
bg = color::Bg(colors.focused_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
text = &text,
)
.as_bytes()
);
}
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
#[test]
fn test_render_matched_text() {
let mut writer = vec![];
let text = "https://en.wikipedia.org/wiki/Barcelona";
let focused = false;
let offset: (usize, usize) = (3, 1);
let colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
View::render_matched_text(&mut writer, text, focused, offset, &colors);
assert_eq!(
writer,
format!(
"{goto}{bg}{fg}{text}{fg_reset}{bg_reset}",
goto = cursor::Goto(4, 2),
fg = color::Fg(colors.match_fg.as_ref()),
bg = color::Bg(colors.match_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
text = &text,
)
.as_bytes()
);
}
#[test]
fn test_render_unstyled_matched_hint() {
let mut writer = vec![];
let hint_text = "eo";
let offset: (usize, usize) = (3, 1);
let colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
let extra_offset = 0;
let hint_style = None;
View::render_matched_hint(
&mut writer,
hint_text,
(offset.0 + extra_offset, offset.1),
&colors,
&hint_style,
);
assert_eq!(
writer,
format!(
"{goto}{bg}{fg}{text}{fg_reset}{bg_reset}",
goto = cursor::Goto(4, 2),
fg = color::Fg(colors.hint_fg.as_ref()),
bg = color::Bg(colors.hint_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
text = "eo",
)
.as_bytes()
);
}
#[test]
fn test_render_underlined_matched_hint() {
let mut writer = vec![];
let hint_text = "eo";
let offset: (usize, usize) = (3, 1);
let colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
let extra_offset = 0;
let hint_style = Some(HintStyle::Underline);
View::render_matched_hint(
&mut writer,
hint_text,
(offset.0 + extra_offset, offset.1),
&colors,
&hint_style,
);
assert_eq!(
writer,
format!(
"{goto}{bg}{fg}{sty}{text}{sty_reset}{fg_reset}{bg_reset}",
goto = cursor::Goto(4, 2),
fg = color::Fg(colors.hint_fg.as_ref()),
bg = color::Bg(colors.hint_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
sty = style::Underline,
sty_reset = style::NoUnderline,
text = "eo",
)
.as_bytes()
);
}
#[test]
fn test_render_bracketed_matched_hint() {
let mut writer = vec![];
let hint_text = "eo";
let offset: (usize, usize) = (3, 1);
let colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
let extra_offset = 0;
let hint_style = Some(HintStyle::Surround('{', '}'));
View::render_matched_hint(
&mut writer,
hint_text,
(offset.0 + extra_offset, offset.1),
&colors,
&hint_style,
);
assert_eq!(
writer,
format!(
"{goto}{bg}{fg}{bra}{text}{bra_close}{fg_reset}{bg_reset}",
goto = cursor::Goto(4, 2),
fg = color::Fg(colors.hint_fg.as_ref()),
bg = color::Bg(colors.hint_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset),
bra = '{',
bra_close = '}',
text = "eo",
)
.as_bytes()
);
}
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
#[test]
/// Simulates rendering without any match.
fn test_render_full_without_matches() {
let content = "lorem 127.0.0.1 lorem
2020-05-22 15:03:39 +02:00
Barcelona https://en.wikipedia.org/wiki/Barcelona - ";
2020-05-25 23:06:00 +02:00
let lines = content.split('\n').collect();
let custom_regexes = [].to_vec();
let alphabet = alphabets::Alphabet("abcd".to_string());
let mut state = state::State::new(&lines, &alphabet, &custom_regexes);
let rendering_colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
let hint_alignment = HintAlignment::Leading;
// create a view without any match
let view = View {
state: &mut state,
matches: vec![], // no matches
focus_index: 0,
multi: false,
2020-05-25 23:32:37 +02:00
hint_alignment: &hint_alignment,
2020-05-25 23:06:00 +02:00
rendering_colors: &rendering_colors,
hint_style: None,
};
let mut writer = vec![];
view.render(&mut writer);
let hide = cursor::Hide;
let goto1 = cursor::Goto(1, 1);
let goto3 = cursor::Goto(1, 3);
let expected = format!(
"{hide}{goto1}lorem 127.0.0.1 lorem\
2020-05-22 15:03:39 +02:00
{goto3}Barcelona https://en.wikipedia.org/wiki/Barcelona -",
2020-05-25 23:06:00 +02:00
hide = hide,
goto1 = goto1,
goto3 = goto3,
);
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
// println!("{:?}", writer);
// println!("{:?}", expected.as_bytes());
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
// println!("matches: {}", view.matches.len());
// println!("lines: {}", lines.len());
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
assert_eq!(writer, expected.as_bytes());
}
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
#[test]
/// Simulates rendering with matches.
fn test_render_full_with_matches() {
let content = "lorem 127.0.0.1 lorem
2020-05-22 15:03:39 +02:00
Barcelona https://en.wikipedia.org/wiki/Barcelona - ";
2020-05-25 23:06:00 +02:00
let lines = content.split('\n').collect();
let custom_regexes = [].to_vec();
let alphabet = alphabets::Alphabet("abcd".to_string());
let mut state = state::State::new(&lines, &alphabet, &custom_regexes);
let multi = false;
let reversed = true;
2020-05-26 08:11:45 +02:00
let unique_hint = false;
2020-05-25 23:06:00 +02:00
let rendering_colors = ViewColors {
focused_fg: Box::new(color::Red),
focused_bg: Box::new(color::Blue),
match_fg: Box::new(color::Green),
match_bg: Box::new(color::Magenta),
hint_fg: Box::new(color::Yellow),
hint_bg: Box::new(color::Cyan),
};
let hint_alignment = HintAlignment::Leading;
let hint_style = None;
let view = View::new(
&mut state,
multi,
reversed,
2020-05-26 08:11:45 +02:00
unique_hint,
2020-05-25 23:32:37 +02:00
&hint_alignment,
2020-05-25 23:06:00 +02:00
&rendering_colors,
hint_style,
);
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let mut writer = vec![];
view.render(&mut writer);
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let expected_content = {
let hide = cursor::Hide;
let goto1 = cursor::Goto(1, 1);
let goto3 = cursor::Goto(1, 3);
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
format!(
"{hide}{goto1}lorem 127.0.0.1 lorem\
2020-05-22 15:03:39 +02:00
{goto3}Barcelona https://en.wikipedia.org/wiki/Barcelona -",
2020-05-25 23:06:00 +02:00
hide = hide,
goto1 = goto1,
goto3 = goto3,
)
};
2020-06-02 20:03:16 +02:00
2020-05-25 23:06:00 +02:00
let expected_match1_text = {
let goto7_1 = cursor::Goto(7, 1);
format!(
"{goto7_1}{match_bg}{match_fg}127.0.0.1{fg_reset}{bg_reset}",
goto7_1 = goto7_1,
match_fg = color::Fg(rendering_colors.match_fg.as_ref()),
match_bg = color::Bg(rendering_colors.match_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset)
)
};
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let expected_match1_hint = {
let goto7_1 = cursor::Goto(7, 1);
format!(
"{goto7_1}{hint_bg}{hint_fg}b{fg_reset}{bg_reset}",
goto7_1 = goto7_1,
hint_fg = color::Fg(rendering_colors.hint_fg.as_ref()),
hint_bg = color::Bg(rendering_colors.hint_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset)
)
};
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let expected_match2_text = {
let goto11_3 = cursor::Goto(11, 3);
format!(
2020-05-23 09:30:09 +02:00
"{goto11_3}{focus_bg}{focus_fg}https://en.wikipedia.org/wiki/Barcelona{fg_reset}{bg_reset}",
2020-05-22 15:03:39 +02:00
goto11_3 = goto11_3,
2020-05-24 21:02:11 +02:00
focus_fg = color::Fg(rendering_colors.focused_fg.as_ref()),
focus_bg = color::Bg(rendering_colors.focused_bg.as_ref()),
2020-05-22 15:03:39 +02:00
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset)
)
2020-05-25 23:06:00 +02:00
};
let expected_match2_hint = {
let goto11_3 = cursor::Goto(11, 3);
format!(
"{goto11_3}{hint_bg}{hint_fg}a{fg_reset}{bg_reset}",
goto11_3 = goto11_3,
hint_fg = color::Fg(rendering_colors.hint_fg.as_ref()),
hint_bg = color::Bg(rendering_colors.hint_bg.as_ref()),
fg_reset = color::Fg(color::Reset),
bg_reset = color::Bg(color::Reset)
)
};
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
let expected = [
expected_content,
expected_match1_text,
expected_match1_hint,
expected_match2_text,
expected_match2_hint,
]
.concat();
2020-05-22 15:03:39 +02:00
2020-05-25 23:06:00 +02:00
// println!("{:?}", writer);
// println!("{:?}", expected.as_bytes());
// let diff_point = writer
// .iter()
// .zip(expected.as_bytes().iter())
// .enumerate()
// .find(|(_idx, (&l, &r))| l != r);
// println!("{:?}", diff_point);
assert_eq!(2, view.matches.len());
assert_eq!(writer, expected.as_bytes());
}
2020-06-02 20:03:16 +02:00
}