Struct KeymapPolicy 

pub struct KeymapPolicy { /* private fields */ }

Seat keymap state: the base text, its reverse keysym map, and the overlay slots.

Implementations

impl KeymapPolicy

pub fn empty() -> Self

Placeholder policy before the seat keymap is known; rebuild_base fills it in.

pub fn with_overlay_range(first: u32, last: u32) -> Self

Policy with a custom overlay keycode range (inclusive, xkb numbering). The seat uses empty()’s above-255 range (pure-Wayland clients resolve it fine); the virtual-keyboard client typing into a nested compositor uses a sub-256 range so XWayland apps under that compositor stay reachable.

pub fn rebuild_base(&mut self, base_text: String) -> bool

Replace the base keymap text and rebuild the reverse map. Overlay assignments are retained (same keycodes), so keycodes already handed out stay valid across the swap. Returns whether base_text compiled. A string that does not is rejected without touching any state, so the caller needs no separate validation pass — compiling a keymap is the expensive part of installing one and doing it twice is pure cost.

pub fn has_base(&self) -> bool

True once a base keymap has been installed.

pub fn resolve(&self, keysym: u32) -> Option<(u32, u32)>

Resolve keysym without binding: base first, then an existing overlay slot.

pub fn resolves_plain(&self, keysym: u32) -> bool

True when keysym resolves at level 0 (base or overlay) — i.e. typable without synthetic modifiers.

pub fn bind_many( &mut self, keysyms: &[u32], pressed: &HashSet<u32>, ) -> (Vec<(u32, u32)>, bool)

Resolve every keysym, overlay-binding the unresolvable ones. Returns one (keycode, level) per input keysym ((0, 0) when it cannot be bound) plus whether the keymap changed and must be re-applied — at most ONE swap per call, however many new keysyms were bound. Slots whose keycode is in pressed are never recycled.

pub fn bind_many_plain( &mut self, keysyms: &[u32], pressed: &HashSet<u32>, ) -> (Vec<u32>, bool)

Like bind_many but only accepts level-0 resolutions: a keysym reachable in the base solely behind a modifier (e.g. A behind Shift) is overlay-bound instead, so the caller can inject it without synthesizing modifiers. Returns keycodes (0 = unbindable).

pub fn set_manual_overlay(&mut self, binds: &[(u32, u32)])

Replace the externally-owned overlay binds (keycode -> keysym). selkies resolves its own keysyms and re-sends the whole set on every change, so a full replace is the contract. They then ride along in every keymap_text, so a base-layout swap or a computer-use policy bind re-applies them instead of dropping them.

pub fn keymap_text(&self) -> String

The full seat keymap: the base text with every occupied policy overlay slot and every externally-owned bind spliced into the xkb_keycodes and xkb_symbols sections (and maximum raised to cover them). With neither, the base text verbatim. A manual bind sharing a keycode with a policy slot is emitted last, so its symbol wins.