galaxy/app/src/terminal/model/grid/selection_cursor.rs

use galaxy_terminal::model::grid::CellType;

use crate::terminal::model::index::Point;

use super::{grid_handler::GridHandler, CursorDirection, CursorState, Dimensions as _};

/// A structure to help with movement of the cursor for keyboard-driven
/// text selection.
pub struct SelectionCursor<'g> {
    /// Reference to the underlying grid.
    grid: &'g GridHandler,

    /// Current position of the cursor within the grid.
    pos: Point,

    /// The state of the cursor.
    cursor_state: CursorState,
}

impl<'g> SelectionCursor<'g> {
    pub fn new(grid: &'g GridHandler, pos: Point) -> Self {
        let mut cursor = Self {
            grid,
            pos,
            cursor_state: CursorState::Invalid,
        };
        if cursor.current_point_valid() {
            cursor.cursor_state = CursorState::Valid;
        }
        cursor
    }

    /// Returns the cursor's current position, if it is valid.
    pub fn position(&self) -> Option<Point> {
        matches!(self.cursor_state, CursorState::Valid).then_some(self.pos)
    }

    /// Moves the cursor forward by a single grapheme.
    pub fn move_forward(&mut self) {
        match self.cursor_state {
            CursorState::Valid if self.has_next() => {
                self.increment_cursor();
                // If the cursor is on top of a wide char, move it forward an
                // extra cell.
                if self.is_wide_char_or_spacer() {
                    self.increment_cursor();
                }
            }
            CursorState::Valid => {
                self.cursor_state = CursorState::Exhausted(CursorDirection::Right);
            }
            CursorState::Exhausted(CursorDirection::Left) => {
                self.cursor_state = CursorState::Valid;
            }
            _ => (),
        }
    }

    /// Moves the cursor backward by a single grapheme.
    pub fn move_backward(&mut self) {
        match self.cursor_state {
            CursorState::Valid if self.has_prev() => {
                self.decrement_cursor();
                // If the cursor is on top of a wide char, move it backward an
                // extra cell.
                if self.is_wide_char_or_spacer() {
                    self.decrement_cursor();
                }
            }
            CursorState::Valid => {
                self.cursor_state = CursorState::Exhausted(CursorDirection::Left);
            }
            CursorState::Exhausted(CursorDirection::Right) => {
                self.cursor_state = CursorState::Valid;
            }
            _ => (),
        }
    }

    /// Moves the cursor up a row.
    ///
    /// Unlike the horizontal movement functions, this is not grapheme-aware -
    /// the cursor may end up on top of a wide char spacer cell.
    pub fn move_up(&mut self) {
        match self.cursor_state {
            CursorState::Valid if self.pos.row > 0 => {
                self.pos.row -= 1;
            }
            CursorState::Valid => {
                self.cursor_state = CursorState::Exhausted(CursorDirection::Up);
            }
            CursorState::Exhausted(CursorDirection::Down) => {
                self.cursor_state = CursorState::Valid;
            }
            _ => (),
        }
    }

    /// Moves the cursor down a row.
    ///
    /// Unlike the horizontal movement functions, this is not grapheme-aware -
    /// the cursor may end up on top of a wide char spacer cell.
    pub fn move_down(&mut self) {
        match self.cursor_state {
            CursorState::Valid if self.pos.row < self.grid.total_rows() - 1 => {
                self.pos.row += 1;
            }
            CursorState::Valid => {
                self.cursor_state = CursorState::Exhausted(CursorDirection::Down);
            }
            CursorState::Exhausted(CursorDirection::Up) => {
                self.cursor_state = CursorState::Valid;
            }
            _ => (),
        }
    }

    fn increment_cursor(&mut self) {
        if self.pos.col == self.grid.columns() - 1 {
            self.pos.row += 1;
            self.pos.col = 0;
        } else {
            self.pos.col += 1
        }
    }

    fn decrement_cursor(&mut self) {
        if self.pos.col == 0 {
            self.pos.row -= 1;
            self.pos.col = self.grid.columns() - 1;
        } else {
            self.pos.col -= 1;
        }
    }

    /// Returns whether the current cursor point is on top of a wide char
    /// (either the first or second cell).
    fn is_wide_char_or_spacer(&self) -> bool {
        matches!(
            self.grid.cell_type(self.pos),
            Some(CellType::WideChar) | Some(CellType::WideCharSpacer)
        )
    }

    /// Returns whether the current cursor point is valid (i.e.: is within the
    /// bounds of the grid).
    fn current_point_valid(&self) -> bool {
        self.pos.row < self.grid.total_rows() && self.pos.col < self.grid.columns()
    }

    /// Returns whether the cursor would be valid if it were incremented.
    fn has_next(&self) -> bool {
        (self.pos.row != self.grid.total_rows() - 1 || self.pos.col != self.grid.columns() - 1)
            && self.current_point_valid()
    }

    /// Returns whether the cursor would be valid if it were decremented.
    fn has_prev(&self) -> bool {
        (self.pos.row != 0 || self.pos.col != 0) && self.current_point_valid()
    }
}

#[cfg(test)]
#[path = "selection_cursor_tests.rs"]
mod tests;