egui_selectable_table/

row_selection.rs

use egui::Ui;
use egui::ahash::{HashMap, HashMapExt, HashSet, HashSetExt};
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use std::fmt::Write as _;
use std::hash::Hash;

use crate::{ColumnOperations, ColumnOrdering, SelectableRow, SelectableTable};

/// Functions related to selection of rows and columns
#[allow(clippy::too_many_lines)]
impl<Row, F, Conf> SelectableTable<Row, F, Conf>
where
    Row: Clone + Send + Sync,
    F: Eq
        + Hash
        + Clone
        + Ord
        + Send
        + Sync
        + Default
        + ColumnOperations<Row, F, Conf>
        + ColumnOrdering<Row>,
    Conf: Default,
{
    pub(crate) fn select_single_row_cell(&mut self, id: i64, column_name: &F) {
        self.active_columns.insert(column_name.clone());
        self.active_rows.insert(id);

        // Should never panic, if it does, either a library issue or it was used incorrectly
        let target_index = self.indexed_ids.get(&id).expect("target_index not found");
        let target_row = self
            .formatted_rows
            .get_mut(*target_index)
            .expect("target_row not found");

        if self.select_full_row {
            self.active_columns.extend(self.all_columns.clone());

            target_row.selected_columns.extend(self.all_columns.clone());
        } else {
            target_row.selected_columns.insert(column_name.clone());
        }

        self.active_rows.insert(id);
    }

    /// Marks a row as selected, optionally selecting specific columns within the row.
    ///
    /// If a list of columns is provided, only those columns are marked as selected for the row.
    /// If no column list is provided, all columns in the row are marked as selected.
    ///
    /// # Parameters:
    /// - `id`: The unique identifier of the row to mark as selected.
    /// - `column`: An optional list of columns (`Vec<F>`) to mark as selected within the row. If `None`, all columns are selected.
    ///
    /// # Example:
    /// ```rust,ignore
    /// table.mark_row_as_selected(42, Some(vec!["Name", "Age"]));
    /// table.mark_row_as_selected(43, None); // Selects all columns in row 43
    /// ```
    pub fn mark_row_as_selected(&mut self, id: i64, column: Option<Vec<F>>) {
        let Some(target_index) = self.indexed_ids.get(&id) else {
            return;
        };

        let Some(target_row) = self.formatted_rows.get_mut(*target_index) else {
            return;
        };

        self.active_rows.insert(id);

        if let Some(column_list) = column {
            self.active_columns.extend(column_list.clone());

            target_row.selected_columns.extend(column_list);
        } else {
            self.active_columns.extend(self.all_columns.clone());

            target_row.selected_columns.extend(self.all_columns.clone());
        }
    }

    pub(crate) fn select_dragged_row_cell(
        &mut self,
        id: i64,
        column_name: &F,
        is_ctrl_pressed: bool,
    ) {
        // If both same then the mouse is still on the same column on the same row so nothing to process
        if self.last_active_row == Some(id) && self.last_active_column == Some(column_name.clone())
        {
            return;
        }

        if self.formatted_rows.is_empty() {
            return;
        }

        self.active_columns.insert(column_name.clone());
        self.beyond_drag_point = true;

        let drag_start = self.drag_started_on.clone().expect("Drag start not found");

        // Number of the column of drag starting point and the current cell that we are trying to select
        let drag_start_num = self.column_to_num(&drag_start.1);
        let ongoing_column_num = self.column_to_num(column_name);

        let mut new_column_set = HashSet::new();

        let get_previous = ongoing_column_num > drag_start_num;
        let mut ongoing_val = Some(drag_start.1.clone());

        // row1: column(drag started here) column column
        // row2: column                    column column
        // row3: column                    column column
        // row4: column                    column column (currently here)
        //
        // The goal of this is to ensure from the drag starting point to all the columns till the currently here
        // are considered selected and the rest are removed from active selection even if it was considered active
        //
        // During fast mouse movement active rows can contain columns that are not in the range we are targeting
        // We go from one point to the other point and ensure except those columns nothing else is selected
        //
        // No active row removal if ctrl is being pressed!
        if is_ctrl_pressed {
            self.active_columns.insert(column_name.clone());
        } else if ongoing_column_num == drag_start_num {
            new_column_set.insert(drag_start.1.clone());
            self.active_columns = new_column_set;
        } else {
            while let Some(col) = ongoing_val {
                let next_column = if get_previous {
                    self.next_column(&col)
                } else {
                    self.previous_column(&col)
                };

                new_column_set.insert(col);

                if &next_column == column_name {
                    new_column_set.insert(next_column);
                    ongoing_val = None;
                } else {
                    ongoing_val = Some(next_column);
                }
            }
            self.active_columns = new_column_set;
        }

        let current_row_index = self
            .indexed_ids
            .get(&id)
            .expect("Current row index not found");
        // The row the mouse pointer is on
        let current_row = self
            .formatted_rows
            .get_mut(*current_row_index)
            .expect("Current row not found");

        // If this row already selects the column that we are trying to select, it means the mouse
        // moved backwards from an active column to another active column.
        //
        // Row: column1 column2 (mouse is here) column3 column4
        //
        // In this case, if column 3 or 4 is also found in the active selection then
        // the mouse moved backwards
        let row_contains_column = current_row.selected_columns.contains(column_name);

        let mut no_checking = false;
        // If we have some data of the last row and column that the mouse was on, then try to unselect
        if row_contains_column
            && self.last_active_row.is_some()
            && self.last_active_column.is_some()
        {
            if let (Some(last_active_column), Some(last_active_row)) =
                (self.last_active_column.clone(), self.last_active_row)
            {
                // Remove the last column selection from the current row where the mouse is if
                // the previous row and the current one matches
                //
                // column column column
                // column column column
                // column column (mouse is currently here) column(mouse was here)
                //
                // We unselect the bottom right corner column
                if &last_active_column != column_name && last_active_row == id {
                    current_row.selected_columns.remove(&last_active_column);
                    self.active_columns.remove(&last_active_column);
                }

                // Get the last row where the mouse was
                let last_row_index = self
                    .indexed_ids
                    .get(&last_active_row)
                    .expect("Last row not found");
                let last_row = self
                    .formatted_rows
                    .get_mut(*last_row_index)
                    .expect("Last row not found");

                self.last_active_row = Some(id);

                // If on the same row as the last row, then unselect the column from all other select row
                if id == last_row.id {
                    if &last_active_column != column_name {
                        self.last_active_column = Some(column_name.clone());
                    }
                } else {
                    no_checking = true;
                    // Mouse went 1 row above or below. So just clear all selection from that previous row
                    last_row.selected_columns.clear();
                }
            }
        } else {
            // We are in a new row which we have not selected before
            self.active_rows.insert(current_row.id);
            self.last_active_row = Some(id);
            self.last_active_column = Some(column_name.clone());
            current_row
                .selected_columns
                .clone_from(&self.active_columns);
        }

        let current_row_index = self
            .indexed_ids
            .get(&id)
            .expect("Current row index not found")
            .to_owned();

        // Get the row number where the drag started on
        let drag_start_index = self
            .indexed_ids
            .get(&drag_start.0)
            .expect("Could not find drag start")
            .to_owned();

        if !no_checking {
            // If drag started on row 1, currently on row 5, check from row 4 to 1 and select all columns
            // else go through all rows till a row without any selected column is found. Applied both by incrementing or decrementing index.
            // In case of fast mouse movement following drag started point mitigates the risk of some rows not getting selected
            self.check_row_selection(true, current_row_index, drag_start_index);
            self.check_row_selection(false, current_row_index, drag_start_index);
        }
        self.remove_row_selection(current_row_index, drag_start_index, is_ctrl_pressed);
    }

    fn check_row_selection(&mut self, check_previous: bool, index: usize, drag_start: usize) {
        if index == 0 && check_previous {
            return;
        }

        if index + 1 == self.formatted_rows.len() && !check_previous {
            return;
        }

        let index = if check_previous { index - 1 } else { index + 1 };

        let current_row = self
            .formatted_rows
            .get(index)
            .expect("Current row not found");

        // If for example drag started on row 5 and ended on row 10 but missed drag on row 7
        // Mark the rows as selected till the drag start row is hit (if recursively going that way)
        let unselected_row = if (check_previous && index >= drag_start)
            || (!check_previous && index <= drag_start)
        {
            false
        } else {
            current_row.selected_columns.is_empty()
        };

        let target_row = self
            .formatted_rows
            .get_mut(index)
            .expect("Target row not found");

        if !unselected_row {
            if self.select_full_row {
                target_row.selected_columns.extend(self.all_columns.clone());
            } else {
                target_row.selected_columns.clone_from(&self.active_columns);
            }
            self.active_rows.insert(target_row.id);

            if check_previous {
                if index != 0 {
                    self.check_row_selection(check_previous, index, drag_start);
                }
            } else if index + 1 != self.formatted_rows.len() {
                self.check_row_selection(check_previous, index, drag_start);
            }
        }
    }

    fn remove_row_selection(
        &mut self,
        current_index: usize,
        drag_start: usize,
        is_ctrl_pressed: bool,
    ) {
        let active_ids = self.active_rows.clone();
        for id in active_ids {
            let ongoing_index = self
                .indexed_ids
                .get(&id)
                .expect("Could not get ongoing index")
                .to_owned();
            let target_row = self
                .formatted_rows
                .get_mut(ongoing_index)
                .expect("target row not found");

            if current_index > drag_start {
                if ongoing_index >= drag_start && ongoing_index <= current_index {
                    if self.select_full_row {
                        target_row.selected_columns.extend(self.all_columns.clone());
                    } else {
                        target_row.selected_columns.clone_from(&self.active_columns);
                    }
                } else if !is_ctrl_pressed {
                    target_row.selected_columns.clear();
                    self.active_rows.remove(&target_row.id);
                }
            } else if ongoing_index <= drag_start && ongoing_index >= current_index {
                if self.select_full_row {
                    target_row.selected_columns.extend(self.all_columns.clone());
                } else {
                    target_row.selected_columns.clone_from(&self.active_columns);
                }
            } else if !is_ctrl_pressed {
                target_row.selected_columns.clear();
                self.active_rows.remove(&target_row.id);
            }
        }
    }

    /// Unselects all currently selected rows and columns.
    ///
    /// Clears the selection in both rows and columns, and resets internal tracking of active rows
    /// and columns. After this call, there will be no selected rows or columns in the table.
    ///
    /// # Panics:
    /// This method will panic if the indexed ID or the corresponding row cannot be found.
    ///
    /// # Example:
    /// ```rust,ignore
    /// table.unselect_all(); // Unselects everything in the table.
    /// ```
    pub fn unselect_all(&mut self) {
        for id in &self.active_rows {
            let id_index = self.indexed_ids.get(id).expect("Could not get id index");
            let target_row = self
                .formatted_rows
                .get_mut(*id_index)
                .expect("Could not get row");
            target_row.selected_columns.clear();
        }
        self.active_columns.clear();
        self.last_active_row = None;
        self.last_active_column = None;
        self.active_rows.clear();
    }

    /// Selects all rows and columns in the table.
    ///
    /// After calling this method, all rows will have all columns selected and visible immediately.
    ///
    /// # Example:
    /// ```rust,ignore
    /// table.select_all(); // Selects all rows and columns.
    /// ```
    pub fn select_all(&mut self) {
        let mut all_rows = Vec::new();

        for row in &mut self.formatted_rows {
            row.selected_columns.extend(self.all_columns.clone());
            all_rows.push(row.id);
        }

        self.active_columns.extend(self.all_columns.clone());
        self.active_rows.extend(all_rows);
        self.last_active_row = None;
        self.last_active_column = None;
    }

    /// Retrieves the currently selected rows.
    ///
    /// This method returns a vector of the rows that have one or more columns selected.
    ///
    /// If the `select_full_row` flag is enabled, it will ensure that all columns are selected for
    /// each active row.
    ///
    /// # Returns:
    /// A `Vec` of `SelectableRow` instances that are currently selected.
    ///
    /// # Example:
    /// ```rust,ignore
    /// let selected_rows = table.get_selected_rows();
    /// ```
    pub fn get_selected_rows(&mut self) -> Vec<SelectableRow<Row, F>> {
        let mut selected_rows = Vec::new();
        if self.select_full_row {
            self.active_columns.extend(self.all_columns.clone());
        }

        // Cannot use active rows to iter as that does not maintain any proper format
        for row in &self.formatted_rows {
            if row.selected_columns.is_empty() {
                continue;
            }
            selected_rows.push(row.clone());

            // We already got all the active rows if this matches
            if selected_rows.len() == self.active_rows.len() {
                break;
            }
        }
        selected_rows
    }

    /// Retrieves the currently selected rows but in no particular order. Can be faster than
    /// [`get_selected_rows`](#method.get_selected_rows) as it uses rayon for parallel processing
    /// and only checks the active rows instead of every single row.
    ///
    /// This method returns a vector of the rows that have one or more columns selected.
    ///
    /// If the `select_full_row` flag is enabled, it will ensure that all columns are selected for
    /// each active row.
    ///
    /// # Returns:
    /// A `Vec` of `SelectableRow` instances that are currently selected.
    ///
    /// # Example:
    /// ```rust,ignore
    /// let selected_rows = table.get_selected_rows();
    /// ```
    pub fn get_selected_rows_unsorted(&mut self) -> Vec<SelectableRow<Row, F>> {
        if self.select_full_row {
            self.active_columns.extend(self.all_columns.clone());
        }

        self.active_rows
            .par_iter()
            .map(|row_id| {
                let row_index = self
                    .indexed_ids
                    .get(row_id)
                    .expect("Could not get id index");
                let target_row = self
                    .formatted_rows
                    .get(*row_index)
                    .expect("Could not get row");

                target_row.clone()
            })
            .collect()
    }

    /// Copies selected cells to the system clipboard in a tabular format.
    ///
    /// This method copies only the selected cells from each row to the clipboard, and ensures
    /// that the column widths align for better readability when pasted into a text editor or spreadsheet.
    ///
    /// # Parameters:
    /// - `ui`: The UI context used for clipboard interaction.
    ///
    /// # Example:
    /// ```rust,ignore
    /// table.copy_selected_cells(&mut ui);
    /// ```
    pub fn copy_selected_cells(&mut self, ui: &mut Ui) {
        let mut selected_rows = Vec::new();
        if self.select_full_row {
            self.active_columns.extend(self.all_columns.clone());
        }

        let mut column_max_length = HashMap::new();

        // Iter through all the rows and find the rows that have at least one column as selected.
        // Keep track of the biggest length of a value of a column
        // active rows cannot be used here because hashset does not maintain an order.
        // So iterating will give the rows in a different order than what is shown in the ui
        for row in &self.formatted_rows {
            if row.selected_columns.is_empty() {
                continue;
            }

            for column in &self.active_columns {
                if row.selected_columns.contains(column) {
                    let column_text = column.column_text(&row.row_data);
                    let field_length = column_text.len();
                    let entry = column_max_length.entry(column).or_insert(0);
                    if field_length > *entry {
                        column_max_length.insert(column, field_length);
                    }
                }
            }
            selected_rows.push(row);
            // We already got all the active rows if this matches
            if selected_rows.len() == self.active_rows.len() {
                break;
            }
        }

        let mut to_copy = String::new();

        // Target is to ensure a fixed length after each column value of a row.
        // If for example highest len is 10 but the current row's
        // column value is 5, we will add the column value and add 5 more space after that
        // to ensure alignment
        for row in selected_rows {
            let mut ongoing_column = self.first_column();
            let mut row_text = String::new();
            loop {
                if self.active_columns.contains(&ongoing_column)
                    && row.selected_columns.contains(&ongoing_column)
                {
                    let column_text = ongoing_column.column_text(&row.row_data);
                    let _ = write!(
                        row_text,
                        "{:<width$}",
                        column_text,
                        width = column_max_length[&ongoing_column] + 1
                    );
                } else if self.active_columns.contains(&ongoing_column)
                    && !row.selected_columns.contains(&ongoing_column)
                {
                    let _ = write!(
                        row_text,
                        "{:<width$}",
                        "",
                        width = column_max_length[&ongoing_column] + 1
                    );
                }
                if self.last_column() == ongoing_column {
                    break;
                }
                ongoing_column = self.next_column(&ongoing_column);
            }
            to_copy.push_str(&row_text);
            to_copy.push('\n');
        }
        ui.ctx().copy_text(to_copy);
    }

    /// Enables the selection of full rows in the table.
    ///
    /// After calling this method, selecting any column in a row will result in the entire row being selected.
    ///
    /// # Returns:
    /// A new instance of the table with full row selection enabled.
    ///
    /// # Example:
    /// ```rust,ignore
    /// let table = SelectableTable::new(vec![col1, col2, col3])
    ///     .select_full_row();
    /// ```
    #[must_use]
    pub const fn select_full_row(mut self) -> Self {
        self.select_full_row = true;
        self
    }

    /// Sets whether the table should select full rows when a column is selected.
    ///
    /// # Parameters:
    /// - `status`: `true` to enable full row selection, `false` to disable it.
    ///
    /// # Example:
    /// ```rust,ignore
    /// table.set_select_full_row(true); // Enable full row selection.
    /// ```
    pub const fn set_select_full_row(&mut self, status: bool) {
        self.select_full_row = status;
    }

    /// Returns the total number of currently selected rows.
    ///
    /// # Returns:
    /// - `usize`: The number of selected rows.
    ///
    /// # Example:
    /// ```rust,ignore
    /// let selected_count = table.get_total_selected_rows();
    /// println!("{} rows selected", selected_count);
    /// ```
    pub fn get_total_selected_rows(&mut self) -> usize {
        self.active_rows.len()
    }
}