use crate::{ Action, ActionRegistry, DispatchPhase, EntityId, FocusId, KeyBinding, KeyContext, KeyMatch, Keymap, Keystroke, KeystrokeMatcher, WindowContext, }; use collections::FxHashMap; use parking_lot::Mutex; use smallvec::{smallvec, SmallVec}; use std::{ any::{Any, TypeId}, mem, rc::Rc, sync::Arc, }; #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)] pub struct DispatchNodeId(usize); pub(crate) struct DispatchTree { node_stack: Vec, pub(crate) context_stack: Vec, nodes: Vec, focusable_node_ids: FxHashMap, view_node_ids: FxHashMap, keystroke_matchers: FxHashMap, KeystrokeMatcher>, keymap: Arc>, action_registry: Rc, } #[derive(Default)] pub(crate) struct DispatchNode { pub key_listeners: Vec, pub action_listeners: Vec, pub context: Option, focus_id: Option, view_id: Option, parent: Option, } type KeyListener = Rc; #[derive(Clone)] pub(crate) struct DispatchActionListener { pub(crate) action_type: TypeId, pub(crate) listener: Rc, } impl DispatchTree { pub fn new(keymap: Arc>, action_registry: Rc) -> Self { Self { node_stack: Vec::new(), context_stack: Vec::new(), nodes: Vec::new(), focusable_node_ids: FxHashMap::default(), view_node_ids: FxHashMap::default(), keystroke_matchers: FxHashMap::default(), keymap, action_registry, } } pub fn clear(&mut self) { self.node_stack.clear(); self.context_stack.clear(); self.nodes.clear(); self.focusable_node_ids.clear(); self.view_node_ids.clear(); self.keystroke_matchers.clear(); } pub fn push_node( &mut self, context: Option, focus_id: Option, view_id: Option, ) { let parent = self.node_stack.last().copied(); let node_id = DispatchNodeId(self.nodes.len()); self.nodes.push(DispatchNode { parent, focus_id, view_id, ..Default::default() }); self.node_stack.push(node_id); if let Some(context) = context { self.active_node().context = Some(context.clone()); self.context_stack.push(context); } if let Some(focus_id) = focus_id { self.focusable_node_ids.insert(focus_id, node_id); } if let Some(view_id) = view_id { self.view_node_ids.insert(view_id, node_id); } } pub fn pop_node(&mut self) { let node = &self.nodes[self.active_node_id().0]; if node.context.is_some() { self.context_stack.pop(); } self.node_stack.pop(); } fn move_node(&mut self, source: &mut DispatchNode) { self.push_node(source.context.take(), source.focus_id, source.view_id); let target = self.active_node(); target.key_listeners = mem::take(&mut source.key_listeners); target.action_listeners = mem::take(&mut source.action_listeners); } pub fn reuse_view(&mut self, view_id: EntityId, source: &mut Self) -> SmallVec<[EntityId; 8]> { let view_source_node_id = source .view_node_ids .get(&view_id) .expect("view should exist in previous dispatch tree"); let view_source_node = &mut source.nodes[view_source_node_id.0]; self.move_node(view_source_node); let mut grafted_view_ids = smallvec![view_id]; let mut source_stack = vec![*view_source_node_id]; for (source_node_id, source_node) in source .nodes .iter_mut() .enumerate() .skip(view_source_node_id.0 + 1) { let source_node_id = DispatchNodeId(source_node_id); while let Some(source_ancestor) = source_stack.last() { if source_node.parent != Some(*source_ancestor) { source_stack.pop(); self.pop_node(); } else { break; } } if source_stack.is_empty() { break; } else { source_stack.push(source_node_id); self.move_node(source_node); if let Some(view_id) = source_node.view_id { grafted_view_ids.push(view_id); } } } while !source_stack.is_empty() { source_stack.pop(); self.pop_node(); } grafted_view_ids } pub fn clear_pending_keystrokes(&mut self) { self.keystroke_matchers.clear(); } /// Preserve keystroke matchers from previous frames to support multi-stroke /// bindings across multiple frames. pub fn preserve_pending_keystrokes(&mut self, old_tree: &mut Self, focus_id: Option) { if let Some(node_id) = focus_id.and_then(|focus_id| self.focusable_node_id(focus_id)) { let dispatch_path = self.dispatch_path(node_id); self.context_stack.clear(); for node_id in dispatch_path { let node = self.node(node_id); if let Some(context) = node.context.clone() { self.context_stack.push(context); } if let Some((context_stack, matcher)) = old_tree .keystroke_matchers .remove_entry(self.context_stack.as_slice()) { self.keystroke_matchers.insert(context_stack, matcher); } } } } pub fn on_key_event(&mut self, listener: KeyListener) { self.active_node().key_listeners.push(listener); } pub fn on_action( &mut self, action_type: TypeId, listener: Rc, ) { self.active_node() .action_listeners .push(DispatchActionListener { action_type, listener, }); } pub fn focus_contains(&self, parent: FocusId, child: FocusId) -> bool { if parent == child { return true; } if let Some(parent_node_id) = self.focusable_node_ids.get(&parent) { let mut current_node_id = self.focusable_node_ids.get(&child).copied(); while let Some(node_id) = current_node_id { if node_id == *parent_node_id { return true; } current_node_id = self.nodes[node_id.0].parent; } } false } pub fn available_actions(&self, target: DispatchNodeId) -> Vec> { let mut actions = Vec::>::new(); for node_id in self.dispatch_path(target) { let node = &self.nodes[node_id.0]; for DispatchActionListener { action_type, .. } in &node.action_listeners { if let Err(ix) = actions.binary_search_by_key(action_type, |a| a.as_any().type_id()) { // Intentionally silence these errors without logging. // If an action cannot be built by default, it's not available. let action = self.action_registry.build_action_type(action_type).ok(); if let Some(action) = action { actions.insert(ix, action); } } } } actions } pub fn is_action_available(&self, action: &dyn Action, target: DispatchNodeId) -> bool { for node_id in self.dispatch_path(target) { let node = &self.nodes[node_id.0]; if node .action_listeners .iter() .any(|listener| listener.action_type == action.as_any().type_id()) { return true; } } false } pub fn bindings_for_action( &self, action: &dyn Action, context_stack: &Vec, ) -> Vec { let keymap = self.keymap.lock(); keymap .bindings_for_action(action) .filter(|binding| { for i in 0..context_stack.len() { let context = &context_stack[0..=i]; if keymap.binding_enabled(binding, context) { return true; } } false }) .cloned() .collect() } pub fn dispatch_key( &mut self, keystroke: &Keystroke, context: &[KeyContext], ) -> Vec> { if !self.keystroke_matchers.contains_key(context) { let keystroke_contexts = context.iter().cloned().collect(); self.keystroke_matchers.insert( keystroke_contexts, KeystrokeMatcher::new(self.keymap.clone()), ); } let keystroke_matcher = self.keystroke_matchers.get_mut(context).unwrap(); if let KeyMatch::Some(actions) = keystroke_matcher.match_keystroke(keystroke, context) { // Clear all pending keystrokes when an action has been found. for keystroke_matcher in self.keystroke_matchers.values_mut() { keystroke_matcher.clear_pending(); } actions } else { vec![] } } pub fn has_pending_keystrokes(&self) -> bool { self.keystroke_matchers .iter() .any(|(_, matcher)| matcher.has_pending_keystrokes()) } pub fn dispatch_path(&self, target: DispatchNodeId) -> SmallVec<[DispatchNodeId; 32]> { let mut dispatch_path: SmallVec<[DispatchNodeId; 32]> = SmallVec::new(); let mut current_node_id = Some(target); while let Some(node_id) = current_node_id { dispatch_path.push(node_id); current_node_id = self.nodes[node_id.0].parent; } dispatch_path.reverse(); // Reverse the path so it goes from the root to the focused node. dispatch_path } pub fn focus_path(&self, focus_id: FocusId) -> SmallVec<[FocusId; 8]> { let mut focus_path: SmallVec<[FocusId; 8]> = SmallVec::new(); let mut current_node_id = self.focusable_node_ids.get(&focus_id).copied(); while let Some(node_id) = current_node_id { let node = self.node(node_id); if let Some(focus_id) = node.focus_id { focus_path.push(focus_id); } current_node_id = node.parent; } focus_path.reverse(); // Reverse the path so it goes from the root to the focused node. focus_path } pub fn view_path(&self, view_id: EntityId) -> SmallVec<[EntityId; 8]> { let mut view_path: SmallVec<[EntityId; 8]> = SmallVec::new(); let mut current_node_id = self.view_node_ids.get(&view_id).copied(); while let Some(node_id) = current_node_id { let node = self.node(node_id); if let Some(view_id) = node.view_id { view_path.push(view_id); } current_node_id = node.parent; } view_path.reverse(); // Reverse the path so it goes from the root to the view node. view_path } pub fn node(&self, node_id: DispatchNodeId) -> &DispatchNode { &self.nodes[node_id.0] } fn active_node(&mut self) -> &mut DispatchNode { let active_node_id = self.active_node_id(); &mut self.nodes[active_node_id.0] } pub fn focusable_node_id(&self, target: FocusId) -> Option { self.focusable_node_ids.get(&target).copied() } pub fn root_node_id(&self) -> DispatchNodeId { debug_assert!(!self.nodes.is_empty()); DispatchNodeId(0) } fn active_node_id(&self) -> DispatchNodeId { *self.node_stack.last().unwrap() } } #[cfg(test)] mod tests { use std::{rc::Rc, sync::Arc}; use parking_lot::Mutex; use crate::{Action, ActionRegistry, DispatchTree, KeyBinding, KeyContext, Keymap}; #[derive(PartialEq, Eq)] struct TestAction; impl Action for TestAction { fn name(&self) -> &'static str { "test::TestAction" } fn debug_name() -> &'static str where Self: ::std::marker::Sized, { "test::TestAction" } fn partial_eq(&self, action: &dyn Action) -> bool { action .as_any() .downcast_ref::() .map_or(false, |a| self == a) } fn boxed_clone(&self) -> std::boxed::Box { Box::new(TestAction) } fn as_any(&self) -> &dyn ::std::any::Any { self } fn build(_value: serde_json::Value) -> anyhow::Result> where Self: Sized, { Ok(Box::new(TestAction)) } } #[test] fn test_keybinding_for_action_bounds() { let keymap = Keymap::new(vec![KeyBinding::new( "cmd-n", TestAction, Some("ProjectPanel"), )]); let mut registry = ActionRegistry::default(); registry.load_action::(); let keymap = Arc::new(Mutex::new(keymap)); let tree = DispatchTree::new(keymap, Rc::new(registry)); let contexts = vec![ KeyContext::parse("Workspace").unwrap(), KeyContext::parse("ProjectPanel").unwrap(), ]; let keybinding = tree.bindings_for_action(&TestAction, &contexts); assert!(keybinding[0].action.partial_eq(&TestAction)) } }