#!/usr/bin/env python # License: GPLv3 Copyright: 2024, Kovid Goyal import sys from functools import partial from typing import Any from kitty.conf.types import Definition from kitty.fast_data_types import add_timer, get_boss from kitty.typing_compat import BossType from ..tui.handler import result_handler definition = Definition( '!kittens.command_palette', ) agr = definition.add_group egr = definition.end_group map = definition.add_map # shortcuts {{{ agr('shortcuts', 'Keyboard shortcuts') map('Move selection up', 'selection_up --allow-fallback=shifted,ascii ctrl+k selection_up', ) map('Move selection up', 'selection_up --allow-fallback=shifted,ascii ctrl+p selection_up', ) map('Move selection down', 'selection_down --allow-fallback=shifted,ascii ctrl+j selection_down', ) map('Move selection down', 'selection_down --allow-fallback=shifted,ascii ctrl+n selection_down', ) egr() # }}} def collect_keys_data(opts: Any) -> dict[str, Any]: """Collect all keybinding data from options into a JSON-serializable dict.""" from kitty.actions import get_all_actions, groups from kitty.options.utils import KeyDefinition from kitty.types import Shortcut # Build action->group and action->help lookups action_to_group: dict[str, str] = {} action_to_help: dict[str, str] = {} action_to_long_help: dict[str, str] = {} for group_key, actions in get_all_actions().items(): for action in actions: action_to_group[action.name] = groups[group_key] action_to_help[action.name] = action.short_help action_to_long_help[action.name] = action.long_help modes: dict[str, dict[str, list[dict[str, str]]]] = {} def as_sc(k: 'Any', v: KeyDefinition) -> Shortcut: if v.is_sequence: return Shortcut((v.trigger,) + v.rest) return Shortcut((k,)) for mode_name, mode in opts.keyboard_modes.items(): categories: dict[str, list[dict[str, str]]] = {} for key, defns in mode.keymap.items(): # Use last non-duplicate definition seen: set[tuple[Any, ...]] = set() uniq: list[KeyDefinition] = [] for d in reversed(defns): uid = d.unique_identity_within_keymap if uid not in seen: seen.add(uid) uniq.append(d) for d in uniq: sc = as_sc(key, d) key_repr = sc.human_repr(opts.kitty_mod) action_repr = d.human_repr() # Determine category from first word of action definition action_name = d.definition.split()[0] if d.definition else 'no_op' category = action_to_group.get(action_name, 'Miscellaneous') help_text = action_to_help.get(action_name, '') long_help = action_to_long_help.get(action_name, '') categories.setdefault(category, []).append({ 'key': key_repr, 'action': action_name, 'action_display': action_repr, 'definition': d.definition or action_name, 'help': help_text, 'long_help': long_help, }) # Sort within categories for cat in categories: categories[cat].sort(key=lambda b: b['key']) # Order categories by the groups order ordered: dict[str, list[dict[str, str]]] = {} for group_title in groups.values(): if group_title in categories: ordered[group_title] = categories.pop(group_title) # Add any remaining for cat_name, binds in sorted(categories.items()): ordered[cat_name] = binds modes[mode_name] = ordered # Move push_keyboard_mode bindings from the default mode into the # respective keyboard mode's section so they appear alongside its shortcuts. if '' in modes: new_default_cats: dict[str, list[dict[str, str]]] = {} for cat_name, bindings in modes[''].items(): keep: list[dict[str, str]] = [] for b in bindings: if b['action'] == 'push_keyboard_mode': parts = b['definition'].split() target = parts[1] if len(parts) > 1 else '' if target and target in modes: if 'Enter mode' not in modes[target]: new_target: dict[str, list[dict[str, str]]] = {'Enter mode': [b]} new_target.update(modes[target]) modes[target] = new_target else: modes[target]['Enter mode'].append(b) continue keep.append(b) if keep: new_default_cats[cat_name] = keep modes[''] = new_default_cats # Add unmapped actions (actions with no keyboard shortcut). # Collect all action names that already appear in a binding. mapped_actions: set[str] = set() for mode_cats in modes.values(): for bindings in mode_cats.values(): for b in bindings: mapped_actions.add(b['action']) default_mode_cats = modes.setdefault('', {}) for group_key, actions in get_all_actions().items(): category = groups[group_key] for action in actions: if action.name not in mapped_actions: default_mode_cats.setdefault(category, []).append({ 'key': '', 'action': action.name, 'action_display': action.name, 'definition': action.name, 'help': action.short_help, 'long_help': action.long_help, }) # Re-sort each category: mapped entries (non-empty key) by key first, # then unmapped entries (empty key) sorted by action name. for cat in default_mode_cats: default_mode_cats[cat].sort(key=lambda b: (b['key'] == '', b['key'] or b['action'])) # Re-order default_mode_cats by groups ordering (adding unmapped actions may # have appended new categories at the end, breaking the established order). reordered: dict[str, list[dict[str, str]]] = {} for group_title in groups.values(): if group_title in default_mode_cats: reordered[group_title] = default_mode_cats[group_title] for cat_name, binds in default_mode_cats.items(): if cat_name not in reordered: reordered[cat_name] = binds modes[''] = reordered # Emit explicit mode and category ordering since JSON maps lose insertion order mode_order = list(modes.keys()) category_order: dict[str, list[str]] = {} for mode_name, cats in modes.items(): category_order[mode_name] = list(cats.keys()) # Mouse mappings mouse: list[dict[str, str]] = [] for event, action in opts.mousemap.items(): key_repr = event.human_repr(opts.kitty_mod) mouse.append({'key': key_repr, 'action': action, 'action_display': action, 'help': '', 'long_help': ''}) mouse.sort(key=lambda b: b['key']) return { 'modes': modes, 'mouse': mouse, 'mode_order': mode_order, 'category_order': category_order, } def main(args: list[str]) -> None: raise SystemExit('This kitten must be used only from a kitty.conf mapping') def callback(target_window_id: int, action: str, timer_id: int | None) -> None: boss = get_boss() w = boss.window_id_map.get(target_window_id) boss.combine(action, w) @result_handler(has_ready_notification=True) def handle_result(args: list[str], data: dict[str, Any], target_window_id: int, boss: BossType) -> None: if data and (action := data.get('action')): # run action after event loop tick so command palette overlay is closed add_timer(partial(callback, target_window_id, action), 0, False) help_text = 'Browse and trigger keyboard shortcuts and actions' usage = '' OPTIONS = r''' '''.format if __name__ == '__main__': main(sys.argv) elif __name__ == '__doc__': cd = sys.cli_docs # type: ignore cd['usage'] = usage cd['options'] = OPTIONS cd['help_text'] = help_text cd['short_desc'] = help_text elif __name__ == '__conf__': sys.options_definition = definition # type: ignore