mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-22 00:21:43 +01:00
komorebi users keep their bindings to komorebic in a file of skhd, whkd or sxhkd. On Plasma under Wayland no client sees the keys of another, and the program that runs a command on a key is KDE's global shortcut daemon, which runs inside KWin. A binding that is one combo, pressed, the same in every application, in a file without modes, can be a static shortcut: a .desktop file that KWin reads by itself, that shows in System Settings and that works with no komorebi process at all. komorebic hotkeys compile reads a file of any of the three formats, plans it with komorebi-hotkeys in the mode it is given (auto, engine or static; the default is the crate's), prints the diagnostics of reading and planning, and writes the static shortcuts to $XDG_DATA_HOME/kglobalaccel or --output, replacing the files it wrote before and no other. --strict refuses a file with a warning or an error before writing anything, --dry-run says what a write would change, and --reload hands each new file to the running KWin. komorebic export-kde-shortcuts keeps the spike's interface for an skhdrc, in the static mode. Both are thin: the reading, the plan and the files are the crate's. The bindings that need the engine are counted; the daemon does not run them yet. docgen gives a subcommand of a subcommand a page of its own (hotkeys-compile.md). KOMOREBI_CONFIG_HOME, or ~/.config/komorebi, is where komorebic looks for a file it is not given. komorebic check gains a section for the key bindings, between the configuration and the desktop: the first key binding file of the config home, how many bindings it has and where they go, the lines that cannot be read (a warning, and the first five) and the bindings not realized as their own daemon would (a note), and whether the generated files in the shortcut directory are the ones hotkeys compile would write now (a warning with how many to add, to change and to remove). --configuration-only keeps it, as it looks at files. The VM test vm-keys-static boots a Plasma session with shortcut files that hotkeys compile wrote into the system profile at build time, presses their keys through QEMU's keyboard, and sees each command run, a % in one of them included; then it writes a binding in the middle of the session with export-kde-shortcuts --reload and presses it. The library gains Keys, which sends a combo as KDE writes it through QEMU's sendkey.
50 lines
1.7 KiB
Python
50 lines
1.7 KiB
Python
"""Key presses on the test machine's keyboard, as a person types them."""
|
|
|
|
from komorebi_vm.machine import Machine
|
|
|
|
# QEMU names the left Super key `meta_l`; the others are named as KDE writes them
|
|
_MODIFIERS = {
|
|
"alt": "alt",
|
|
"ctrl": "ctrl",
|
|
"shift": "shift",
|
|
"meta": "meta_l",
|
|
"super": "meta_l",
|
|
}
|
|
|
|
|
|
class Keys:
|
|
"""The keyboard of a test machine.
|
|
|
|
A key press goes through QEMU's virtual keyboard (`machine.send_key`), so it
|
|
reaches the guest's kernel as a key of a real keyboard and KWin sees it as
|
|
it sees any other: a global shortcut fires on it, and a key that is not one
|
|
goes to the focused window. QEMU holds the keys for 100 ms, less than the
|
|
delay before a key repeats.
|
|
|
|
A combo is written as in KDE, in lower case, with `-` between the keys:
|
|
`alt-h`, `meta-shift-j`, `esc`. The key names after the modifiers are
|
|
QEMU's (`h`, `1`, `esc`, `ret`, `bracket_left`).
|
|
"""
|
|
|
|
def __init__(self, machine: Machine) -> None:
|
|
self.machine = machine
|
|
|
|
@staticmethod
|
|
def qemu(combo: str) -> str:
|
|
"""Returns `combo` as QEMU's `sendkey` writes it.
|
|
|
|
A modifier is any of `alt`, `ctrl`, `shift`, `meta` and `super`; the
|
|
last word is the key, which QEMU must know.
|
|
"""
|
|
*modifiers, key = combo.lower().split("-")
|
|
for modifier in modifiers:
|
|
if modifier not in _MODIFIERS:
|
|
raise ValueError(f"{modifier!r} in {combo!r} is not a modifier")
|
|
if not key:
|
|
raise ValueError(f"{combo!r} has no key")
|
|
return "-".join([*(_MODIFIERS[m] for m in modifiers), key])
|
|
|
|
def send(self, combo: str) -> None:
|
|
"""Presses the keys of `combo` together, and releases them."""
|
|
self.machine.send_key(self.qemu(combo))
|