quvyta-framework 0.1.29

//! Routing keys: focused widgets, key listeners, layers and keymap actions.

use std::time::Duration;

use super::Engine;
use super::clipboard::ClipboardRead;
use crate::event::{Event, KeyEvent, KeyKind};
use crate::keymap::{Key, KeyChord, Modifiers, Scope};
use crate::runtime::App;
use crate::runtime::selection::CopyKind;
use crate::widget::{ClipboardKey, WidgetId};

/// Enter or Space presses of the same key closer together than this, with no other key between,
/// are a held key repeating, not new presses.
///
/// A terminal without the kitty keyboard protocol cannot say a key is held: it sends the hold as
/// fast presses, and without this a held Enter would press a button again and again. The guess
/// is only made where it cannot lose text:
///
/// - Where the keys go to a widget that takes text ([`PaintCx::takes_text`]) nothing is guessed.
///   Text that arrives in one read has its keys well within the window, and each one is text;
///   holding Space there types spaces, as holding a letter types letters.
/// - A held key repeats alone, so any other key in between ends the run: typed words stay apart
///   even in an application's own widget that does not say it takes text.
///
/// Whether keys arrived in one read is not asked: repeats of a held key that queue up while a
/// slow frame is drawn arrive in one read too, so it cannot tell typing from holding on a button.
///
/// [`PaintCx::takes_text`]: crate::widget::PaintCx::takes_text
const HELD_KEY_WINDOW: Duration = Duration::from_millis(100);

/// The key that cuts, the same fixed chord a text field cuts its text with. It has no keymap
/// action: without a claim it means nothing outside a field.
const CUT: KeyChord = KeyChord { key: Key::Char('x'), mods: Modifiers { ctrl: true, alt: false, shift: false } };

/// Global keymap actions the runtime or its widgets own. Other global actions, such as `help`
/// and `palette`, are passed to [`App::action`].
const RUNTIME_ACTIONS: [&str; 7] = ["quit", "focus-next", "focus-prev", "debug", "copy", "paste", "toggle-panel"];

impl<A: App> Engine<A> {
    pub(super) fn keyboard_targets(&self) -> Vec<WidgetId> {
        match self.interaction.key_capture.or(self.interaction.focused) {
            Some(id) => self.frame.routed_ancestry(id),
            None => self.frame.top_layer().into_iter().collect(),
        }
    }

    /// Whether the widget keys go to first takes typed text, see [`PaintCx::takes_text`].
    ///
    /// [`PaintCx::takes_text`]: crate::widget::PaintCx::takes_text
    fn keys_take_text(&self) -> bool {
        self.keyboard_targets().first().is_some_and(|id| self.frame.text_takers.contains(id))
    }

    /// Offers `key` to the widgets listening to it, see [`PaintCx::listen_key`]. Releases match
    /// the key alone, since modifiers are often let go first.
    pub(super) fn offer_to_listeners(&mut self, key: KeyEvent, now: Duration) -> bool {
        let listeners: Vec<WidgetId> = self
            .frame
            .listeners
            .iter()
            .filter(
                |(chord, _)| {
                    if key.kind == KeyKind::Release { chord.key == key.chord.key } else { *chord == key.chord }
                },
            )
            .map(|(_, id)| *id)
            .filter(|id| self.frame.reachable(*id))
            .collect();
        let mut used = false;
        for id in listeners {
            used |= self.dispatch(&[id], &Event::Key(key), now).is_some();
        }
        used
    }

    pub(super) fn handle_key(&mut self, key: KeyEvent, now: Duration) {
        if key.kind == KeyKind::Release {
            self.offer_to_listeners(key, now);
            return;
        }
        // A layer the keyboard opens has no opening press.
        self.press_target = None;
        // While the selection's menu is open its keys belong to the menu, which may copy.
        let menu_open = self.selection_menu.is_some() && self.interaction.key_capture == self.selection_menu;
        // Text selected with the mouse is what the clipboard keys are about while it is there.
        let text_selected = self.selection.is_some();
        if self.selection.is_some() && !menu_open {
            self.dirty = true;
            let copy = self.env.keymap().action_for(key.chord) == Some((Scope::Global, "copy"));
            if copy {
                if let Some(selection) = &mut self.selection {
                    selection.copy_pending = Some(CopyKind::Clean);
                }
                return;
            }
            self.selection = None;
        }
        let activation = matches!(key.chord.key, Key::Enter | Key::Space) && key.chord.mods == Modifiers::default();
        if !activation || self.keys_take_text() {
            self.last_activation_key = None;
        } else {
            let repeated = key.kind == KeyKind::Repeat
                || self
                    .last_activation_key
                    .is_some_and(|(last, at)| last == key.chord.key && now.saturating_sub(at) < HELD_KEY_WINDOW);
            self.last_activation_key = Some((key.chord.key, now));
            if repeated {
                // A held key must not press buttons again, but listeners measuring the hold
                // still hear it.
                self.offer_to_listeners(key, now);
                return;
            }
        }
        self.dirty = true;
        let targets = self.keyboard_targets();
        if self.dispatch(&targets, &Event::Key(key), now).is_some() {
            return;
        }
        if self.interaction.key_capture.is_some() {
            return;
        }
        if key.chord == KeyChord::plain(Key::Esc)
            && let Some(layer) = self.frame.layers.last().map(|layer| layer.id)
            && self.dispatch(&[layer], &Event::Key(key), now).is_some()
        {
            return;
        }
        if self.offer_to_listeners(key, now) {
            return;
        }
        if !text_selected && let Some(message) = self.clipboard_answer(key.chord) {
            self.update(message);
            return;
        }
        let Some((scope, action)) = self.env.keymap().action_for(key.chord).map(|(s, a)| (s, a.to_owned())) else {
            return;
        };
        if let Some(message) = self.focus_answer(scope, &action) {
            self.update(message);
            return;
        }
        self.run_action(scope, &action, self.frame.top_layer().is_none(), now);
    }

    /// The message the focused widget or one of its ancestors answers a pressed keymap action
    /// with, innermost first; see [`NodeMut::on_action`](crate::widget::NodeMut::on_action).
    /// The runtime's own actions are never answered, so they behave the same everywhere.
    fn focus_answer(&self, scope: Scope, action: &str) -> Option<A::Msg> {
        if scope == Scope::Global && RUNTIME_ACTIONS.contains(&action) {
            return None;
        }
        let tree = self.tree.as_ref()?;
        let focused = self.interaction.focused?;
        self.frame
            .routed_ancestry(focused)
            .into_iter()
            .find_map(|id| tree.find(id).and_then(|node| node.answer_action(scope, action)))
    }

    /// The message the focused widget or one of its ancestors answers a clipboard key with,
    /// innermost first; see [`NodeMut::on_clipboard`](crate::widget::NodeMut::on_clipboard).
    fn clipboard_answer(&self, chord: KeyChord) -> Option<A::Msg> {
        let key = if chord == CUT {
            ClipboardKey::Cut
        } else {
            match self.env.keymap().action_for(chord)? {
                (Scope::Global, "copy") => ClipboardKey::Copy,
                (Scope::Global, "paste") => ClipboardKey::Paste,
                _ => return None,
            }
        };
        let tree = self.tree.as_ref()?;
        let focused = self.interaction.focused?;
        self.frame
            .routed_ancestry(focused)
            .into_iter()
            .find_map(|id| tree.find(id).and_then(|node| node.answer_clipboard(key)))
    }

    /// Runs a keymap action. Global actions the runtime owns run here; other global actions and
    /// application actions reach [`App::action`] when `to_app` is true, which it is not while a
    /// modal layer pauses shortcuts.
    pub(super) fn run_action(&mut self, scope: Scope, action: &str, to_app: bool, now: Duration) {
        match (scope, action) {
            (Scope::Global, "quit") => self.ask_to_quit(),
            (Scope::Global, "focus-next") => self.move_focus(1),
            (Scope::Global, "focus-prev") => self.move_focus(-1),
            (Scope::Global, "debug") => self.debug = !self.debug,
            (Scope::Global, "paste") => self.read_clipboard(ClipboardRead::Paste, now),
            // Owned by the mouse selection and by side panels, which handle their keys first.
            (Scope::Global, name) if RUNTIME_ACTIONS.contains(&name) => {}
            (_, name) => {
                if to_app && let Some(message) = self.app.action(name) {
                    self.update(message);
                }
            }
        }
    }
}