sokey

Sokol keyboard event coalescing with layout-aware logical keys.

What it does

sokol_app delivers keyboard input as three separate event types (KEY_DOWN, CHAR, KEY_UP). sokey coalesces them into a single KeyEvent per logical press/release that carries:

• physical — sokol's positional keycode (right answer for arrows, F-keys, modifier-only chords like Cmd+Q)
• logical — layout-aware unmodified key (right answer for game action bindings and vim-style commands; matches the cap the user sees with the active layout)
• text — UTF-8 of what the OS would type into a text field (right answer for in-game text input, with shift, dead-keys, IME applied)
• mods — modifier state at event time
• kind — down / up / repeat

Both game-style action mapping and text input read from the same stream; each consumer picks the field it needs.

Status

• macOS: layout-aware via Carbon's TIS / UCKeyTranslate.
• Windows: stub — logical returns null. Falls back to positional.
• Linux: stub — same.

Usage

const sapp = @import("sokol").app;
const sokey = @import("sokey");

export fn event(ev_ptr: [*c]const sapp.Event) void {
    sokey.feed(&ev_ptr[0]);
}

fn frame() void {
    sokey.flushPending();
    while (sokey.poll()) |ke| {
        // ke.physical, ke.logical, ke.text(), ke.mods, ke.kind
    }
}

pub fn main() void {
    sokey.disablePressAndHold(); // macOS QoL: hold-to-repeat
    sapp.run(.{ .event_cb = event, .frame_cb = frame, … });
}

Tests

zig build test