edtui 0.8.5

pub(crate) mod line_wrapper;
pub mod status_line;
pub mod theme;
#[cfg(feature = "syntax-highlighting")]
pub use crate::syntax_higlighting::SyntaxHighlighter;
use crate::{helper::max_col, internal::InternalLine, state::EditorState, EditorMode, Index2};
use line_wrapper::LineWrapper;
use ratatui::{prelude::*, widgets::Widget};
pub use status_line::EditorStatusLine;
use std::cmp::min;
use theme::EditorTheme;

/// Creates the view for the editor. [`EditorView`] and [`EditorState`] are
/// the core classes of edtui.
///
/// ## Example
///
/// ```rust
/// use edtui::EditorState;
/// use edtui::EditorTheme;
/// use edtui::EditorView;
///
/// let theme = EditorTheme::default();
/// let mut state = EditorState::default();
///
/// EditorView::new(&mut state)
///     .wrap(true)
///     .theme(theme);
/// ```
pub struct EditorView<'a, 'b> {
    pub(crate) state: &'a mut EditorState,
    pub(crate) theme: EditorTheme<'b>,
    pub(crate) wrap: bool,
    #[cfg(feature = "syntax-highlighting")]
    pub(crate) syntax_highlighter: Option<SyntaxHighlighter>,
}

impl<'a, 'b> EditorView<'a, 'b> {
    /// Creates a new instance of [`EditorView`].
    #[must_use]
    pub fn new(state: &'a mut EditorState) -> Self {
        Self {
            state,
            theme: EditorTheme::default(),
            wrap: true,
            #[cfg(feature = "syntax-highlighting")]
            syntax_highlighter: None,
        }
    }

    /// Set the theme for the [`EditorView`]
    /// See [`EditorTheme`] for the customizable parameters.
    #[must_use]
    pub fn theme(mut self, theme: EditorTheme<'b>) -> Self {
        self.theme = theme;
        self
    }

    #[cfg(feature = "syntax-highlighting")]
    /// Set the syntax highlighter for the [`EditorView`]
    /// See [`SyntaxHighlighter`] for the more information.
    ///
    /// ```rust
    /// #[cfg(feature = "syntax-highlighting")]
    /// {
    ///     use edtui::EditorState;
    ///     use edtui::EditorView;
    ///     use edtui::SyntaxHighlighter;
    ///
    ///     let syntax_highlighter = SyntaxHighlighter::new("dracula", "rs");
    ///     EditorView::new(&mut EditorState::default())
    ///         .syntax_highlighter(Some(syntax_highlighter));
    /// }
    /// ```
    #[must_use]
    pub fn syntax_highlighter(mut self, syntax_highlighter: Option<SyntaxHighlighter>) -> Self {
        self.syntax_highlighter = syntax_highlighter;
        self
    }

    /// Sets whether overflowing lines should wrap onto the next line.
    ///
    /// # Note
    /// Line wrapping currently has issues when used with mouse events.
    #[must_use]
    pub fn wrap(mut self, wrap: bool) -> Self {
        self.wrap = wrap;
        self
    }

    /// Returns a reference to the [`EditorState`].
    #[must_use]
    pub fn get_state(&'a self) -> &'a EditorState {
        self.state
    }

    /// Returns a mutable reference to the [`EditorState`].
    #[must_use]
    pub fn get_state_mut(&'a mut self) -> &'a mut EditorState {
        self.state
    }
}

impl Widget for EditorView<'_, '_> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        // Draw the border.
        buf.set_style(area, self.theme.base);
        let area = match &self.theme.block {
            Some(b) => {
                let inner_area = b.inner(area);
                b.clone().render(area, buf);
                inner_area
            }
            None => area,
        };

        // Split into main section and status line
        let [main, status] = Layout::vertical([
            Constraint::Min(0),
            Constraint::Length(u16::from(self.theme.status_line.is_some())),
        ])
        .areas(area);
        let width = main.width as usize;
        let height = main.height as usize;
        let lines = &self.state.lines;

        // Retrieve the displayed cursor position. The column of the displayed
        // cursor is clamped to the maximum line length.
        let cursor = displayed_cursor(self.state);

        // Store the offset from the current buffer to the textarea inside the state.
        // This is required to calculate mouse positions correctly.
        self.state.view.set_editor_to_textarea_offset(area);

        // Update the view offset. Requuires the screen size and the position
        // of the cursor. Updates the view offset only if the cursor is out
        // side of the view port. The state is stored in the `ViewOffset`.
        let size = (width, height);
        let offset = self
            .state
            .view
            .update_viewport_offset(size, cursor, lines, self.wrap);

        // Predetermine search highlighted selections.
        let mut search_selection = None;
        if self.state.mode == EditorMode::Search {
            search_selection = self.state.search.selected_range();
        };
        let selections = vec![&self.state.selection, &search_selection];

        let mut y = (main.top() as usize) as u16;
        let mut num_rows = 0;
        for (i, line) in lines.iter_row().skip(offset.y).enumerate() {
            let row_index = offset.y + i;
            num_rows += 1;

            // Wrap lines
            let internal_line = InternalLine::new(
                line,
                self.theme.base,
                self.theme.selection_style,
                offset.y + i,
                offset.x,
            );

            #[cfg(feature = "syntax-highlighting")]
            let spans = {
                if let Some(syntax_highlighter) = &self.syntax_highlighter {
                    internal_line.into_highlighted_spans(&selections, syntax_highlighter)
                } else {
                    internal_line.into_spans(&selections)
                }
            };

            #[cfg(not(feature = "syntax-highlighting"))]
            let spans = { internal_line.into_spans(&selections) };

            let (line_widths, wrapped_spans) = if self.wrap {
                LineWrapper::wrap_spans(spans, main.width as usize)
            } else {
                let spans_width = spans_width(&spans);
                (vec![spans_width], vec![spans])
            };
            let line_count = wrapped_spans.len();

            // Rendering the content line by line.
            let mut y_line = y;
            for (i, span) in wrapped_spans.into_iter().enumerate() {
                let area = Rect::new(main.left(), y_line, main.width, main.height);
                span.into_iter().collect::<Line>().render(area, buf);

                // Increment the y position if there are more lines left to render.
                if i + 1 < line_count {
                    y_line += 1;
                }

                if y_line >= main.bottom() {
                    break;
                }
            }

            // Rendering of the the cursor. Must take line wrapping into account.
            if row_index == cursor.row {
                let relative_position = LineWrapper::find_position(&line_widths, cursor.col);
                let relative_position_col = relative_position.col.saturating_sub(offset.x);
                let x_cursor = main.left() + min(width, relative_position_col) as u16;
                let y_cursor = y + relative_position.row as u16;
                if let Some(cell) = buf.cell_mut(Position::new(x_cursor, y_cursor)) {
                    cell.set_style(self.theme.cursor_style);
                }
            }

            // Increment y after rendering the current visual line.
            y = y_line + 1;
            if y >= main.bottom() {
                break;
            }
        }

        // Render the cursor even if the editor has no content
        if num_rows == 0 {
            if let Some(cell) = buf.cell_mut(Position::new(main.left(), main.top())) {
                cell.set_style(self.theme.cursor_style);
            }
        }

        // Save the total number of lines displayed in the viewport.
        // This is necessary to correctly handle scrolling.
        self.state.view.update_num_rows(num_rows);

        // Render the status line.
        if let Some(s) = self.theme.status_line {
            s.mode(self.state.mode.name())
                .search(if self.state.mode == EditorMode::Search {
                    Some(self.state.search_pattern())
                } else {
                    None
                })
                .render(status, buf);
        }
    }
}

fn crop_first(s: &str, pos: usize) -> &str {
    match s.char_indices().nth(pos) {
        Some((pos, _)) => &s[pos..],
        None => "",
    }
}

pub(crate) fn spans_width(spans: &[Span]) -> usize {
    spans.iter().fold(0, |sum, span| sum + span.width())
}

/// Retrieves the displayed cursor position based on the editor state.
///
/// Ensures that the displayed cursor position doesn't exceed the line length.
/// If the internal cursor position exceeds the maximum column, clamp it to
/// the maximum.
fn displayed_cursor(state: &EditorState) -> Index2 {
    let max_col = max_col(&state.lines, &state.cursor, state.mode);
    Index2::new(state.cursor.row, state.cursor.col.min(max_col))
}