feat(record): support mouse click to select

Author: arxanas

scm-record/src/render.rs

@@ -21,6 +21,12 @@ pub(crate) struct RectSize {
     pub height: usize,
 }
 
+impl RectSize {
+    pub fn area(self) -> usize {
+        self.width * self.height
+    }
+}
+
 impl From<tui::layout::Rect> for RectSize {
     fn from(rect: tui::layout::Rect) -> Self {
         Rect::from(rect).into()
@@ -67,6 +73,14 @@ impl From<tui::layout::Rect> for Rect {
 }
 
 impl Rect {
+    /// The size of the `Rect`. (To get the area as a scalar, call `.size().area()`.)
+    pub fn size(self) -> RectSize {
+        RectSize {
+            width: self.width,
+            height: self.height,
+        }
+    }
+
     /// The (x, y) coordinate of the top-left corner of this `Rect`.
     fn top_left(self) -> (isize, isize) {
         (self.x, self.y)
@@ -80,6 +94,13 @@ impl Rect {
         )
     }
 
+    /// Whether or not this `Rect` contains the given point.
+    pub fn contains_point(self, x: isize, y: isize) -> bool {
+        let (x1, y1) = self.top_left();
+        let (x2, y2) = self.bottom_right();
+        x1 <= x && x < x2 && y1 <= y && y < y2
+    }
+
     /// Whether this `Rect` has zero area.
     pub fn is_empty(self) -> bool {
         self.width == 0 || self.height == 0

scm-record/src/ui.rs

@@ -14,7 +14,7 @@ use std::{fs, io, panic};
 
 use crossterm::event::{
     DisableMouseCapture, EnableMouseCapture, KeyCode, KeyEvent, KeyEventKind, KeyModifiers,
-    MouseEvent, MouseEventKind,
+    MouseButton, MouseEvent, MouseEventKind,
 };
 use crossterm::terminal::{
     disable_raw_mode, enable_raw_mode, is_raw_mode_enabled, EnterAlternateScreen,
@@ -68,6 +68,12 @@ enum SelectionKey {
     Line(LineKey),
 }
 
+impl Default for SelectionKey {
+    fn default() -> Self {
+        Self::None
+    }
+}
+
 /// A copy of the contents of the screen at a certain point in time.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 pub struct TestingScreenshot {
@@ -116,6 +122,7 @@ pub enum Event {
     FocusOuter,
     ToggleItem,
     ToggleItemAndAdvance,
+    Click { row: usize, column: usize },
 }
 
 impl From<crossterm::event::Event> for Event {
@@ -252,6 +259,16 @@ impl From<crossterm::event::Event> for Event {
                 state: _,
             }) => Self::ToggleItemAndAdvance,
 
+            Event::Mouse(MouseEvent {
+                kind: MouseEventKind::Down(MouseButton::Left),
+                column,
+                row,
+                modifiers: _,
+            }) => Self::Click {
+                row: row.into(),
+                column: column.into(),
+            },
+
             _event => Self::None,
         }
     }
@@ -763,6 +780,11 @@ impl<'a> Recorder<'a> {
                 let advanced_key = self.advance_to_next_of_kind();
                 StateUpdate::ToggleItemAndAdvance(self.selection_key, advanced_key)
             }
+
+            (_, Event::Click { row, column }) => {
+                let component_id = self.find_component_at(drawn_rects, row, column);
+                self.click_component(component_id)
+            }
         };
         Ok(state_update)
     }
@@ -994,6 +1016,37 @@ impl<'a> Recorder<'a> {
         }
     }
 
+    fn find_component_at(
+        &self,
+        drawn_rects: &HashMap<ComponentId, Rect>,
+        row: usize,
+        column: usize,
+    ) -> ComponentId {
+        let x = column.unwrap_isize();
+        let y = row.unwrap_isize() + self.scroll_offset_y;
+        drawn_rects
+            .iter()
+            .filter(|(_id, rect)| rect.contains_point(x, y))
+            .min_by(|(_, lhs), (_, rhs)| lhs.size().area().cmp(&rhs.size().area()))
+            .map(|(id, _rect)| id.clone())
+            .unwrap_or(ComponentId::App)
+    }
+
+    fn click_component(&self, component_id: ComponentId) -> StateUpdate {
+        match component_id {
+            ComponentId::App | ComponentId::QuitDialog => StateUpdate::None,
+            ComponentId::SelectableItem(selection_key) => StateUpdate::SelectItem(selection_key),
+            ComponentId::TristateBox => {
+                // TODO: implement toggling the checkbox
+                StateUpdate::None
+            }
+            ComponentId::QuitDialogButton(QuitDialogButtonId::GoBack) => {
+                StateUpdate::SetQuitDialog(None)
+            }
+            ComponentId::QuitDialogButton(QuitDialogButtonId::Quit) => StateUpdate::QuitCancel,
+        }
+    }
+
     fn toggle_item(&mut self, selection: SelectionKey) -> Result<(), RecordError> {
         match selection {
             SelectionKey::None => {}

scm-record/tests/test_scm_record.rs

@@ -789,3 +789,53 @@ fn test_state_binary_selected_contents() -> eyre::Result<()> {
 
     Ok(())
 }
+
+#[test]
+fn test_mouse_support() -> eyre::Result<()> {
+    let state = example_contents();
+
+    let initial = TestingScreenshot::default();
+    let first_click = TestingScreenshot::default();
+    let click_scrolled_item = TestingScreenshot::default();
+    let event_source = EventSource::testing(
+        80,
+        6,
+        [
+            initial.event(),
+            Event::Click { row: 5, column: 8 },
+            first_click.event(),
+            Event::Click { row: 5, column: 8 },
+            click_scrolled_item.event(),
+            Event::QuitAccept,
+        ],
+    );
+    let recorder = Recorder::new(state, event_source);
+    recorder.run()?;
+
+    insta::assert_display_snapshot!(initial, @r###"
+    "(~) foo/bar                                                                     "
+    "        ⋮                                                                       "
+    "       18 this is some text                                                     "
+    "       19 this is some text                                                     "
+    "       20 this is some text                                                     "
+    "  [~] Section 1/1                                                               "
+    "###);
+    insta::assert_display_snapshot!(first_click, @r###"
+    "       20 this is some text                                                     "
+    "  (~) Section 1/1                                                               "
+    "    [×] - before text 1                                                         "
+    "    [×] - before text 2                                                         "
+    "    [×] + after text 1                                                          "
+    "    [ ] + after text 2                                                          "
+    "###);
+    insta::assert_display_snapshot!(click_scrolled_item, @r###"
+    "       20 this is some text                                                     "
+    "  [~] Section 1/1                                                               "
+    "    [×] - before text 1                                                         "
+    "    [×] - before text 2                                                         "
+    "    [×] + after text 1                                                          "
+    "    ( ) + after text 2                                                          "
+    "###);
+
+    Ok(())
+}