ferrodock 1.35.0

//! Window-wide keyboard shortcuts: what each key does, and the list the
//! "?" overlay shows.

use eframe::egui::{self, Event, Key, Modifiers};

use super::components::shortcuts::Section;

/// What a key press asks the app to do.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Shortcut {
    Palette,
    Help,
    Settings,
    SelectAll,
    /// Switch to the page with this index.
    Page(usize),
    /// Move the selection in the list up (-1) or down (+1).
    Step(i32),
    CloseDetails,
    FocusSearch,
    Refresh,
    /// A key the open page handles itself, e.g. `S` for start/stop.
    PageKey(Key),
}

/// "⌘" on macOS, "Ctrl+" elsewhere, for showing shortcuts.
pub const COMMAND: &str = if cfg!(target_os = "macos") {
    "⌘"
} else {
    "Ctrl+"
};

/// Keys a page can react to (see [`super::page::Page::shortcut`]).
const PAGE_KEYS: [Key; 6] = [Key::S, Key::R, Key::P, Key::L, Key::Delete, Key::Backspace];

/// Reads this frame's shortcuts. Single-key shortcuts are skipped while a
/// text field has focus, so typing never triggers them.
pub fn read(ctx: &egui::Context) -> Vec<Shortcut> {
    let typing = ctx.egui_wants_keyboard_input();
    ctx.input_mut(|i| {
        let mut found = Vec::new();
        if i.consume_key(Modifiers::COMMAND, Key::K) {
            found.push(Shortcut::Palette);
        }
        if i.consume_key(Modifiers::COMMAND, Key::Comma) {
            found.push(Shortcut::Settings);
        }
        let digits = [
            Key::Num1,
            Key::Num2,
            Key::Num3,
            Key::Num4,
            Key::Num5,
            Key::Num6,
        ];
        for (index, key) in digits.into_iter().enumerate() {
            if i.consume_key(Modifiers::COMMAND, key) {
                found.push(Shortcut::Page(index));
            }
        }
        if i.consume_key(Modifiers::NONE, Key::F5) || i.consume_key(Modifiers::COMMAND, Key::R) {
            found.push(Shortcut::Refresh);
        }
        if typing {
            return found;
        }
        if i.consume_key(Modifiers::COMMAND, Key::A) {
            found.push(Shortcut::SelectAll);
        }
        // Typed characters, taken out of the frame's input so the search
        // box that "/" focuses doesn't also get the "/".
        let mut typed = |text: &str| {
            let before = i.events.len();
            i.events
                .retain(|e| !matches!(e, Event::Text(t) if t == text));
            i.events.len() < before
        };
        if typed("?") {
            found.push(Shortcut::Help);
        }
        if typed("/") {
            found.push(Shortcut::FocusSearch);
        }
        if i.consume_key(Modifiers::NONE, Key::ArrowDown) || i.consume_key(Modifiers::NONE, Key::J)
        {
            found.push(Shortcut::Step(1));
        }
        if i.consume_key(Modifiers::NONE, Key::ArrowUp) || i.consume_key(Modifiers::NONE, Key::K) {
            found.push(Shortcut::Step(-1));
        }
        if i.consume_key(Modifiers::NONE, Key::Escape) {
            found.push(Shortcut::CloseDetails);
        }
        for key in PAGE_KEYS {
            if i.consume_key(Modifiers::NONE, key) {
                found.push(Shortcut::PageKey(key));
            }
        }
        found
    })
}

/// Everything the "?" overlay lists.
pub fn help(page_titles: &[&'static str]) -> Vec<Section> {
    let pages = page_titles
        .iter()
        .enumerate()
        .map(|(i, title)| (format!("{COMMAND}{}", i + 1), *title))
        .collect();
    vec![
        (
            "Anywhere",
            vec![
                (format!("{COMMAND}K"), "Command palette"),
                (format!("{COMMAND},"), "Settings"),
                ("/".into(), "Search this page"),
                ("F5".into(), "Refresh"),
                ("?".into(), "This list"),
            ],
        ),
        (
            "Lists",
            vec![
                ("↑ ↓  or  J K".into(), "Select previous / next"),
                ("Esc".into(), "Close the details pane, clear the selection"),
                (
                    format!("{COMMAND}click  ⇧click"),
                    "Select several containers",
                ),
                (format!("{COMMAND}A"), "Select all"),
            ],
        ),
        (
            "Selected container",
            vec![
                ("S".into(), "Start or stop"),
                ("R".into(), "Restart"),
                ("P".into(), "Pause or resume"),
                ("L".into(), "Show logs"),
                ("⌫ / Delete".into(), "Remove (asks first)"),
            ],
        ),
        ("Pages", pages),
    ]
}

#[cfg(test)]
mod tests {
    use super::*;

    /// The shortcuts of one frame with these events, and the events left
    /// for the widgets drawn after.
    fn frame(events: Vec<Event>) -> (Vec<Shortcut>, Vec<Event>) {
        let ctx = egui::Context::default();
        let mut result = (Vec::new(), Vec::new());
        let input = egui::RawInput {
            events,
            ..Default::default()
        };
        let mut output = ctx.run_ui(input, |ui| {
            result.0 = read(ui.ctx());
            result.1 = ui.input(|i| i.events.clone());
        });
        // No renderer here to hand the font atlas to.
        output.textures_delta.clear();
        result
    }

    #[test]
    fn slash_focuses_the_search_without_typing_into_it() {
        let (found, left) = frame(vec![Event::Text("/".into())]);
        assert_eq!(found, [Shortcut::FocusSearch]);
        assert!(left.is_empty(), "{left:?}");
        // Other text is left alone.
        let (found, left) = frame(vec![Event::Text("a".into())]);
        assert!(found.is_empty());
        assert_eq!(left, [Event::Text("a".into())]);
    }
}