ghostty/macos/Sources/Ghostty/Ghostty.MenuShortcutManager.swift

import AppKit
import SwiftUI
import GhosttyKit

extension Ghostty {
    /// The manager that's responsible for updating shortcuts of Ghostty's app menu
    @MainActor
    class MenuShortcutManager {

        /// Ghostty menu items indexed by their normalized shortcut. This avoids traversing
        /// the entire menu tree on every key equivalent event.
        ///
        /// We store a weak reference so this cache can never be the owner of menu items.
        /// If multiple items map to the same shortcut, the most recent one wins.
        private var menuItemsByShortcut: [MenuShortcutKey: Weak<NSMenuItem>] = [:]

        /// Reset our shortcut index since we're about to rebuild all menu bindings.
        func reset() {
            menuItemsByShortcut.removeAll(keepingCapacity: true)
        }

        /// Syncs a single menu shortcut for the given action. The action string is the same
        /// action string used for the Ghostty configuration.
        func syncMenuShortcut(_ config: Ghostty.Config, action: String?, menuItem: NSMenuItem?) {
            guard let menu = menuItem else { return }

            if !updateMenuShortcut(config, action: action, menuItem: menu) {
                menu.keyEquivalent = ""
                menu.keyEquivalentModifierMask = []
                menu.allowsAutomaticKeyEquivalentLocalization = true
                menu.allowsAutomaticKeyEquivalentMirroring = true
            }
        }

        /// Attempts to perform a menu key equivalent only for menu items that represent
        /// Ghostty keybind actions. This is important because it lets our surface dispatch
        /// bindings through the menu so they flash but also lets our surface override macOS built-ins
        /// like Cmd+H.
        func performGhosttyBindingMenuKeyEquivalent(with event: NSEvent) -> Bool {
            // Physical bindings take precedence over Unicode bindings in the core.
            let physicalKey = MenuShortcutKey(
                physicalKeyCode: event.keyCode,
                modifiers: event.modifierFlags)
            if let result = performMenuItem(for: physicalKey) {
                return result
            }

            guard let key = MenuShortcutKey(event: event) else { return false }
            return performMenuItem(for: key) ?? false
        }

        private func performMenuItem(for key: MenuShortcutKey) -> Bool? {
            // If we don't have an entry for this key combo, no Ghostty-owned
            // menu shortcut exists for this event.
            guard let weakItem = menuItemsByShortcut[key] else {
                return nil
            }

            // Weak references can be nil if a menu item was deallocated after sync.
            guard let item = weakItem.value else {
                menuItemsByShortcut.removeValue(forKey: key)
                return false
            }

            guard let parentMenu = item.menu else {
                return false
            }

            // Keep enablement state fresh in case menu validation hasn't run yet.
            parentMenu.update()
            guard item.isEnabled else {
                return false
            }

            let index = parentMenu.index(of: item)
            guard index >= 0 else {
                return false
            }

            parentMenu.performActionForItem(at: index)
            return true
        }
    }
}

private extension Ghostty.MenuShortcutManager {
    /// Syncs a single menu shortcut for the given action. The action string is the same
    /// action string used for the Ghostty configuration.
    ///
    /// - Returns: Whether the menu item is updated and saved in ``menuItemsByShortcut``
    func updateMenuShortcut(_ config: Ghostty.Config, action: String?, menuItem menu: NSMenuItem) -> Bool {
        guard
            let action,
            let trigger = config.keybindTrigger(for: action),
            let shortcut = Ghostty.keyboardShortcut(for: trigger)
        else { return false }

        let isPhysical = trigger.tag == GHOSTTY_TRIGGER_PHYSICAL
        let physicalKeyCode = isPhysical ? Ghostty.Input.Key(cKey: trigger.key.physical)?.keyCode : nil
        // Build a direct lookup for key-equivalent dispatch so we don't need to
        // linearly walk the full menu hierarchy at event time.
        guard let key = MenuShortcutKey(shortcut, physicalKeyCode: physicalKeyCode) else {
            return false
        }

        menu.keyEquivalent = shortcut.key.character.description
        menu.keyEquivalentModifierMask = key.modifierFlags
        // The key equivalent was already localized from the physical keycode.
        menu.allowsAutomaticKeyEquivalentLocalization = !isPhysical
        menu.allowsAutomaticKeyEquivalentMirroring = !isPhysical

        // Later registrations intentionally override earlier ones for the same key.
        menuItemsByShortcut[key] = .init(menu)
        return true
    }
}

extension Ghostty.MenuShortcutManager {
    /// Hashable key for a menu shortcut match, normalized for quick lookup.
    struct MenuShortcutKey: Hashable {
        private enum Identity: Hashable {
            case keyEquivalent(String)
            case physicalKeyCode(UInt16)
        }

        private static let shortcutModifiers: NSEvent.ModifierFlags = [.shift, .control, .option, .command]

        private let identity: Identity
        private let modifiersRawValue: UInt

        var modifierFlags: NSEvent.ModifierFlags {
            NSEvent.ModifierFlags(rawValue: modifiersRawValue)
        }

        init?(keyEquivalent: String, modifiers: NSEvent.ModifierFlags) {
            let normalized = keyEquivalent.lowercased()
            guard !normalized.isEmpty else { return nil }
            var mods = modifiers.intersection(Self.shortcutModifiers)
            if
                keyEquivalent.lowercased() != keyEquivalent.uppercased(),
                normalized.uppercased() == keyEquivalent {
                // If key equivalent is case sensitive and
                // it's originally uppercased, then we need to add `shift` to the modifiers
                mods.insert(.shift)
            }
            self.identity = .keyEquivalent(normalized)
            self.modifiersRawValue = mods.rawValue
        }

        init(physicalKeyCode: UInt16, modifiers: NSEvent.ModifierFlags) {
            self.identity = .physicalKeyCode(physicalKeyCode)
            self.modifiersRawValue = modifiers.intersection(Self.shortcutModifiers).rawValue
        }

        init?(event: NSEvent) {
            guard let keyEquivalent = event.charactersIgnoringModifiers else { return nil }
            self.init(keyEquivalent: keyEquivalent, modifiers: event.modifierFlags)
        }

        /// Create from a SwiftUI `KeyboardShortcut`.
        init?(_ shortcut: KeyboardShortcut, physicalKeyCode: UInt16? = nil) {
            let modifiers = NSEvent.ModifierFlags(swiftUIFlags: shortcut.modifiers)
            if let physicalKeyCode {
                self.init(physicalKeyCode: physicalKeyCode, modifiers: modifiers)
            } else {
                self.init(
                    keyEquivalent: shortcut.key.character.description,
                    modifiers: modifiers)
            }
        }
    }
}