Support key binds mapping

Cargo.toml

@@ -28,6 +28,7 @@ semver = "1.0.23"
 serde = { version = "1.0.204", features = ["derive"] }
 serde_json = "1.0.122"
 sha1 = "0.10.6"
+strum = "0.26.3"
 toml = "0.8.19"
 tui-input = "0.9.0"
 tui-tree-widget = "0.21.0"

assets/default-keybind.toml

@@ -0,0 +1,30 @@
+Quit = ["q", "ctrl-c"]
+NavigateUp = ["k", "up"]
+NavigateDown = ["j", "down"]
+NavigateRight = ["l", "right"]
+NavigateLeft = ["h", "left"]
+
+# close widget or cancel progress but not quit app
+CloseOrCancel = ["esc"]
+HelpToggle = ["?"]
+GoToTop = ["g"]
+GoToBottom = ["shift-g"]
+GoToNext = ["n"]
+GoToPrevious = ["shift-N"]
+ScrollDown = ["ctrl-e"]
+ScrollUp = ["ctrl-y"]
+PageUp = ["ctrl-b"]
+PageDown = ["ctrl-f"]
+HalfPageUp = ["ctrl-u"]
+HalfPageDown = ["ctrl-d"]
+SelectTop = ["shift-h"]
+SelectMiddle = ["shift-m"]
+SelectBottom = ["shift-l"]
+ShowDetails = ["enter"]
+Search = ["/"]
+
+# copy part of information, ex: copy the short commit hash not all
+ShortCopy = ["c"]
+FullCopy = ["shift-c"]
+
+RefListToggle = ["tab"]

flake.nix

@@ -0,0 +1,32 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    rust-overlay = {
+      url = "github:oxalica/rust-overlay";
+      inputs.nixpkgs.follows = "nixpkgs";
+      inputs.flake-utils.follows = "flake-utils";
+    };
+
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, rust-overlay, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        overlays = [ (import rust-overlay) ];
+        pkgs = import nixpkgs {
+          inherit system overlays;
+        };
+      in
+      with pkgs;
+      {
+        devShells = rec {
+          default =  mkShell {
+            buildInputs = [
+              rust-bin.stable.latest.default
+            ];
+          };
+        };
+      }
+    );
+}

src/app.rs

@@ -12,11 +12,11 @@ use ratatui::{
 use crate::{
     color::ColorSet,
     config::Config,
-    event::{AppEvent, Receiver, Sender},
+    event::{AppEvent, Receiver, Sender, UserEvent},
     external::copy_to_clipboard,
     git::Repository,
     graph::{Graph, GraphImage},
-    key_code_char,
+    keybind::KeyBind,
     protocol::ImageProtocol,
     view::View,
     widget::commit_list::{CommitInfo, CommitListState},
@@ -46,16 +46,20 @@ pub struct App<'a> {
     view: View<'a>,
     status_line: StatusLine,
 
+    keybind: &'a KeyBind,
     config: &'a Config,
     image_protocol: ImageProtocol,
+    insert_mode: bool,
     tx: Sender,
 }
 
 impl<'a> App<'a> {
+    #[allow(clippy::too_many_arguments)]
     pub fn new(
         repository: &'a Repository,
         graph: &'a Graph,
         graph_image: &'a GraphImage,
+        keybind: &'a KeyBind,
         config: &'a Config,
         color_set: &'a ColorSet,
         image_protocol: ImageProtocol,
@@ -94,8 +98,10 @@ impl<'a> App<'a> {
             repository,
             status_line: StatusLine::None,
             view,
+            keybind,
             config,
             image_protocol,
+            insert_mode: false,
             tx,
         }
     }
@@ -111,31 +117,47 @@ impl App<'_> {
             terminal.draw(|f| self.render(f))?;
 
             match rx.recv() {
-                AppEvent::Key(key) => match key {
-                    key_code_char!('c', Ctrl) => {
-                        return Ok(());
-                    }
-                    _ => {
-                        match self.status_line {
-                            StatusLine::None | StatusLine::Input(_, _) => {
-                                // do nothing
+                AppEvent::Key(key) => {
+                    match self.keybind.get(&key) {
+                        Some(UserEvent::Quit) => {
+                            self.tx.send(AppEvent::Quit);
+                        }
+                        Some(UserEvent::CloseOrCancel) => {
+                            if self.insert_mode {
+                                self.insert_mode = false;
                             }
-                            StatusLine::NotificationInfo(_)
-                            | StatusLine::NotificationSuccess(_)
-                            | StatusLine::NotificationWarn(_) => {
-                                // Clear message and pass key input as is
-                                self.clear_status_line();
+                            self.view.handle_user_event(&UserEvent::CloseOrCancel);
+                        }
+                        Some(ue) => {
+                            match self.status_line {
+                                StatusLine::None | StatusLine::Input(_, _) => {
+                                    // do nothing
+                                }
+                                StatusLine::NotificationInfo(_)
+                                | StatusLine::NotificationSuccess(_)
+                                | StatusLine::NotificationWarn(_) => {
+                                    // Clear message and pass key input as is
+                                    self.clear_status_line();
+                                }
+                                StatusLine::NotificationError(_) => {
+                                    // Clear message and cancel key input
+                                    self.clear_status_line();
+                                    continue;
+                                }
                             }
-                            StatusLine::NotificationError(_) => {
-                                // Clear message and cancel key input
-                                self.clear_status_line();
-                                continue;
+                            if self.insert_mode {
+                                self.view.insert_key(key);
+                            } else {
+                                self.view.handle_user_event(ue);
+                            }
+                        }
+                        None => {
+                            if self.insert_mode {
+                                self.view.insert_key(key);
                             }
                         }
-
-                        self.view.handle_key(key);
                     }
-                },
+                }
                 AppEvent::Resize(w, h) => {
                     let _ = (w, h);
                 }
@@ -187,6 +209,9 @@ impl App<'_> {
                 AppEvent::NotifyError(msg) => {
                     self.error_notification(msg);
                 }
+                AppEvent::Insert => {
+                    self.insert_mode = true;
+                }
             }
         }
     }
@@ -286,7 +311,12 @@ impl App<'_> {
 
     fn open_help(&mut self) {
         let before_view = std::mem::take(&mut self.view);
-        self.view = View::of_help(before_view, self.image_protocol, self.tx.clone());
+        self.view = View::of_help(
+            before_view,
+            self.image_protocol,
+            self.tx.clone(),
+            self.keybind,
+        );
     }
 
     fn close_help(&mut self) {

src/config.rs

@@ -1,5 +1,7 @@
 use serde::Deserialize;
 
+use crate::keybind::KeyBind;
+
 const APP_DIR_NAME: &str = "serie";
 const CONFIG_FILE_NAME: &str = "config.toml";
 
@@ -15,6 +17,7 @@ const DEFAULT_DETAIL_DATE_LOCAL: bool = true;
 pub struct Config {
     #[serde(default)]
     pub ui: UiConfig,
+    pub custom_keybind_patch: Option<KeyBind>,
 }
 
 #[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize)]
@@ -131,6 +134,7 @@ mod tests {
                     date_local: true,
                 },
             },
+            custom_keybind_patch: None,
         };
         assert_eq!(actual, expected);
     }
@@ -163,6 +167,7 @@ mod tests {
                     date_local: false,
                 },
             },
+            custom_keybind_patch: None,
         };
         assert_eq!(actual, expected);
     }
@@ -188,6 +193,7 @@ mod tests {
                     date_local: true,
                 },
             },
+            custom_keybind_patch: None,
         };
         assert_eq!(actual, expected);
     }