Add select-first (gg) key support to NoteTree (#126)

Author: panarch

core/src/state/notebook.rs

@@ -101,6 +101,7 @@ impl NotebookState {
             NoteTree(NoteTreeState::Numbering(n)) => {
                 format!("Steps: '{n}' selected")
             }
+            NoteTree(NoteTreeState::GatewayMode) => "Gateway mode".to_owned(),
             NoteTree(NoteTreeState::MoveMode) => match &self.selected {
                 SelectedItem::Note(Note { name, .. }) => {
                     format!("Note move mode: '{name}'")
@@ -267,6 +268,7 @@ impl NotebookState {
                     "[j]     Select next".to_owned(),
                     "[k]     Select previous".to_owned(),
                     "[G]     Select last".to_owned(),
+                    "[g]     Enter gateway mode".to_owned(),
                     "[1-9]   Add steps".to_owned(),
                     "[>]     Expand width".to_owned(),
                     "[<]     Shrink width".to_owned(),
@@ -313,6 +315,9 @@ impl NotebookState {
                     "[Esc] Cancel".to_owned(),
                 ]
             }
+            NoteTree(NoteTreeState::GatewayMode) => {
+                vec!["[g]   Select first".to_owned(), "[Esc] Cancel".to_owned()]
+            }
             NoteTree(NoteTreeState::MoveMode) => {
                 vec![
                     "[j]     Select next".to_owned(),

core/src/state/notebook/inner_state/note_tree.rs

@@ -2,6 +2,7 @@ use crate::{Event, NotebookTransition, Result, db::Db, state::notebook::Notebook
 
 mod directory_more_actions;
 mod directory_selected;
+mod gateway;
 mod move_mode;
 mod note_more_actions;
 mod note_selected;
@@ -14,6 +15,7 @@ pub enum NoteTreeState {
     DirectorySelected,
     DirectoryMoreActions,
     Numbering(usize),
+    GatewayMode,
     MoveMode,
 }
 
@@ -31,6 +33,7 @@ pub async fn consume(
         NoteMoreActions => note_more_actions::consume(db, state, event).await,
         DirectoryMoreActions => directory_more_actions::consume(db, state, event).await,
         Numbering(n) => numbering::consume(state, n, event).await,
+        GatewayMode => gateway::consume(state, event).await,
         MoveMode => move_mode::consume(db, state, event).await,
     }
 }

core/src/state/notebook/inner_state/note_tree/directory_selected.rs

@@ -81,6 +81,13 @@ pub async fn consume(
             Ok(NotebookTransition::None)
         }
         Key(KeyEvent::CapG) => Ok(NotebookTransition::NoteTree(NoteTreeTransition::SelectLast)),
+        Key(KeyEvent::G) => {
+            state.inner_state = InnerState::NoteTree(NoteTreeState::GatewayMode);
+
+            Ok(NotebookTransition::NoteTree(
+                NoteTreeTransition::GatewayMode,
+            ))
+        }
         Key(KeyEvent::AngleBracketOpen) => Ok(NotebookTransition::NoteTree(
             NoteTreeTransition::ShrinkWidth(1),
         )),

core/src/state/notebook/inner_state/note_tree/gateway.rs

@@ -0,0 +1,36 @@
+use crate::{
+    Error, Event, KeyEvent, NotebookTransition, Result,
+    state::notebook::{InnerState, NoteTreeState, NotebookState, SelectedItem},
+    transition::NoteTreeTransition,
+};
+
+pub async fn consume(state: &mut NotebookState, event: Event) -> Result<NotebookTransition> {
+    use Event::*;
+
+    match event {
+        Key(KeyEvent::G) => {
+            state.inner_state = leave_gateway_mode(&state.selected)?;
+
+            Ok(NotebookTransition::NoteTree(
+                NoteTreeTransition::SelectFirst,
+            ))
+        }
+        Key(KeyEvent::Esc) => {
+            state.inner_state = leave_gateway_mode(&state.selected)?;
+
+            Ok(NotebookTransition::None)
+        }
+        event @ Key(_) => Ok(NotebookTransition::Inedible(event)),
+        _ => Err(Error::Wip(
+            "todo: NoteTree::GatewayMode::consume".to_owned(),
+        )),
+    }
+}
+
+fn leave_gateway_mode(selected: &SelectedItem) -> Result<InnerState> {
+    match selected {
+        SelectedItem::Directory(_) => Ok(InnerState::NoteTree(NoteTreeState::DirectorySelected)),
+        SelectedItem::Note(_) => Ok(InnerState::NoteTree(NoteTreeState::NoteSelected)),
+        SelectedItem::None => Err(Error::Wip("todo: cannot leave gateway mode".to_owned())),
+    }
+}

core/src/state/notebook/inner_state/note_tree/note_selected.rs

@@ -70,6 +70,13 @@ pub async fn consume(
             Ok(NotebookTransition::None)
         }
         Key(KeyEvent::CapG) => Ok(NotebookTransition::NoteTree(NoteTreeTransition::SelectLast)),
+        Key(KeyEvent::G) => {
+            state.inner_state = InnerState::NoteTree(NoteTreeState::GatewayMode);
+
+            Ok(NotebookTransition::NoteTree(
+                NoteTreeTransition::GatewayMode,
+            ))
+        }
         Key(KeyEvent::AngleBracketOpen) => Ok(NotebookTransition::NoteTree(
             NoteTreeTransition::ShrinkWidth(1),
         )),

core/src/transition.rs

@@ -94,9 +94,11 @@ pub enum NoteTreeTransition {
 
     SelectNext(usize),
     SelectPrev(usize),
+    SelectFirst,
     SelectLast,
     ExpandWidth(usize),
     ShrinkWidth(usize),
+    GatewayMode,
 }
 
 pub enum MoveModeTransition {

tui/src/context/notebook.rs

@@ -46,6 +46,7 @@ pub const DIRECTORY_ACTIONS: [&str; 5] = [
 pub enum ContextState {
     NoteTreeBrowsing,
     NoteTreeNumbering,
+    NoteTreeGateway,
     NoteActionsDialog,
     DirectoryActionsDialog,
     MoveMode,
@@ -228,6 +229,19 @@ impl NotebookContext {
         }
     }
 
+    pub fn select_first(&mut self) {
+        let i = self
+            .tree_items
+            .iter()
+            .enumerate()
+            .find(|(_, item)| item.selectable)
+            .map(|(i, _)| i);
+
+        if i.is_some() {
+            self.tree_state.select(i);
+        }
+    }
+
     pub fn select_last(&mut self) {
         let i = self
             .tree_items
@@ -326,7 +340,9 @@ impl NotebookContext {
 
         match self.state {
             ContextState::NoteTreeBrowsing => self.consume_on_note_tree_browsing(code),
-            ContextState::NoteTreeNumbering | ContextState::MoveMode => Action::PassThrough,
+            ContextState::NoteTreeGateway
+            | ContextState::NoteTreeNumbering
+            | ContextState::MoveMode => Action::PassThrough,
             ContextState::EditorNormalMode { idle } => self.consume_on_editor_normal(input, idle),
             ContextState::EditorVisualMode => Action::PassThrough,
             ContextState::EditorInsertMode => self.consume_on_editor_insert(input),

tui/src/transitions/notebook.rs

@@ -34,6 +34,7 @@ impl App {
                 NoteTreeState::NoteSelected | NoteTreeState::DirectorySelected,
             ) => ContextState::NoteTreeBrowsing,
             InnerState::NoteTree(NoteTreeState::Numbering(_)) => ContextState::NoteTreeNumbering,
+            InnerState::NoteTree(NoteTreeState::GatewayMode) => ContextState::NoteTreeGateway,
             InnerState::NoteTree(NoteTreeState::NoteMoreActions) => ContextState::NoteActionsDialog,
             InnerState::NoteTree(NoteTreeState::DirectoryMoreActions) => {
                 ContextState::DirectoryActionsDialog

tui/src/transitions/notebook/note_tree.rs

@@ -80,6 +80,13 @@ impl App {
                 let event = get_select_event(selected);
                 self.glues.dispatch(event).await.log_unwrap();
             }
+            NoteTreeTransition::SelectFirst => {
+                self.context.notebook.select_first();
+
+                let selected = self.context.notebook.selected();
+                let event = get_select_event(selected);
+                self.glues.dispatch(event).await.log_unwrap();
+            }
             NoteTreeTransition::SelectLast => {
                 self.context.notebook.select_last();
 
@@ -100,7 +107,8 @@ impl App {
 
                 self.context.notebook.tree_width = width;
             }
-            NoteTreeTransition::ShowNoteActionsDialog(_)
+            NoteTreeTransition::GatewayMode
+            | NoteTreeTransition::ShowNoteActionsDialog(_)
             | NoteTreeTransition::ShowDirectoryActionsDialog(_) => {}
         }
 

tui/src/views/body/notebook/note_tree.rs

@@ -22,7 +22,10 @@ const NOTE_SYMBOL: &str = "󱇗 ";
 pub fn draw(frame: &mut Frame, area: Rect, context: &mut NotebookContext) {
     let note_tree_focused = matches!(
         context.state,
-        ContextState::NoteTreeBrowsing | ContextState::NoteTreeNumbering | ContextState::MoveMode
+        ContextState::NoteTreeBrowsing
+            | ContextState::NoteTreeNumbering
+            | ContextState::NoteTreeGateway
+            | ContextState::MoveMode
     );
     let title = "[Browser]";
     let title = if note_tree_focused {