Python script, ASCII text executable
1
"""
2
Kineboard: an experimental touchscreen keyboard using swipes to allow
3
having fewer touch targets.
4
Copyright 2025, roundabout-host.com <vlad@roundabout-host.com>
5
This program is free software: you can redistribute it and/or modify
6
it under the terms of the GNU General Public Licence as published by
7
the Free Software Foundation, either version 3 of the Licence, or
8
(at your option) any later version.
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
GNU General Public Licence for more details.
13
You should have received a copy of the GNU General Public Licence
14
along with this program. If not, see <https://www.gnu.org/licenses/>.
15
"""
16
import itertools
18
import sys
19
import os
20
import time
21
import ruamel.yaml as yaml
23
from pathlib import Path
24
os.environ["GI_TYPELIB_PATH"] = "/usr/local/lib/x86_64-linux-gnu/girepository-1.0"
26
from ctypes import CDLL
27
CDLL("libgtk4-layer-shell.so")
28
import gi
30
gi.require_version("Gtk", "4.0")
31
gi.require_version("Gtk4LayerShell", "1.0")
32
from gi.repository import Gtk, Gdk, GObject, Gtk4LayerShell, GLib, Gio, GObject
33
from pywayland.client import Display, EventQueue
35
from pywayland.protocol.wayland import WlRegistry, WlSeat
36
from pywayland.protocol.input_method_unstable_v1 import (
37
ZwpInputMethodContextV1,
38
ZwpInputMethodV1
39
)
40
from pywayland.protocol.input_method_unstable_v2 import (
41
ZwpInputMethodV2,
42
ZwpInputMethodManagerV2
43
)
44
from pywayland.protocol.virtual_keyboard_unstable_v1 import ZwpVirtualKeyboardManagerV1
45
from xkbcommon import xkb
47
import ctypes
49
from cffi import FFI
50
ffi = FFI()
51
ffi.cdef("""
52
void * gdk_wayland_display_get_wl_display (void * display);
53
void * gdk_wayland_surface_get_wl_surface (void * surface);
54
void * gdk_wayland_monitor_get_wl_output (void * monitor);
55
""")
56
gtk = ffi.dlopen("libgtk-4.so.1")
57
module_directory = Path(__file__).resolve().parent
60
custom_css = """
63
.kineboard-selected-character {
64
text-decoration: underline;
65
}
66
"""
67
css_provider = Gtk.CssProvider()
68
css_provider.load_from_data(custom_css)
69
Gtk.StyleContext.add_provider_for_display(
70
Gdk.Display.get_default(),
71
css_provider,
72
100
73
)
74
def get_layout_directories():
77
data_home = Path(os.getenv("XDG_DATA_HOME", Path.home() / ".local" / "share"))
78
data_dirs = [Path(d) for d in os.getenv("XDG_DATA_DIRS", "/usr/local/share:/usr/share").split(":")]
79
all_paths = [data_home / "kineboard" / "layouts"] + [d / "kineboard" / "layouts" for d in data_dirs]
80
return [d for d in all_paths if d.is_dir()]
81
class GestureZone(GObject.GEnum):
84
CENTRAL = 0
85
TOP_LEFT = 1
86
TOP_RIGHT = 2
87
BOTTOM_RIGHT = 3
88
BOTTOM_LEFT = 4
89
class SwipeButton(Gtk.Frame):
92
@GObject.Signal
93
def top_left(self):
94
pass
95
@GObject.Signal
97
def top_right(self):
98
pass
99
@GObject.Signal
101
def bottom_left(self):
102
pass
103
@GObject.Signal
105
def bottom_right(self):
106
pass
107
@GObject.Signal
109
def central(self):
110
pass
111
@GObject.Signal(arg_types=(int,))
113
def drag_changed(self, zone):
114
pass
115
def __init__(self, **kwargs):
117
Gtk.Frame.__init__(self, **kwargs)
118
self.gesture_drag = Gtk.GestureDrag()
119
self.gesture_drag.connect("drag-end", self.finish_drag)
120
self.gesture_drag.connect("drag-update", self.move_drag)
121
self.gesture_drag.connect("drag-begin", self.begin_drag)
122
self.add_controller(self.gesture_drag)
123
def finish_drag(self, gesture, offset_x, offset_y):
125
if abs(offset_x) / self.get_width() + abs(offset_y) / self.get_height() > 1 / 2:
126
if offset_x > 0 and offset_y > 0:
127
self.emit("bottom_right")
128
elif offset_x <= 0 and offset_y > 0:
129
self.emit("bottom_left")
130
elif offset_x > 0 and offset_y <= 0:
131
self.emit("top_right")
132
elif offset_x <= 0 and offset_y <= 0:
133
self.emit("top_left")
134
else:
135
self.emit("central")
136
def move_drag(self, gesture, offset_x, offset_y):
138
if abs(offset_x) / self.get_width() + abs(offset_y) / self.get_height() > 1 / 2:
139
if offset_x > 0 and offset_y > 0:
140
self.emit("drag_changed", GestureZone.BOTTOM_RIGHT)
141
elif offset_x <= 0 and offset_y > 0:
142
self.emit("drag_changed", GestureZone.BOTTOM_LEFT)
143
elif offset_x > 0 and offset_y <= 0:
144
self.emit("drag_changed", GestureZone.TOP_RIGHT)
145
elif offset_x <= 0 and offset_y <= 0:
146
self.emit("drag_changed", GestureZone.TOP_LEFT)
147
else:
148
self.emit("drag_changed", GestureZone.CENTRAL)
149
def begin_drag(self, gesture, start_x, start_y):
151
self.emit("drag_changed", GestureZone.CENTRAL)
152
class SwipeTyper(SwipeButton):
155
@GObject.Signal(arg_types=(str,))
156
def typed(self, character):
157
# Since the drag is finished, remove the underlines
158
for label in self.label_map.values():
159
label.remove_css_class("kineboard-selected-character")
160
def underline(self, zone):
162
for label in self.label_map.values():
163
label.remove_css_class("kineboard-selected-character")
164
self.label_map[zone].add_css_class("kineboard-selected-character")
165
def __init__(self, tl, tr, bl, br, c, **kwargs):
167
SwipeButton.__init__(self, **kwargs)
168
self.tl = tl
169
self.tr = tr
170
self.bl = bl
171
self.br = br
172
self.c = c
173
self.grid = Gtk.Grid(hexpand=True, vexpand=True, row_homogeneous=True, column_homogeneous=True, margin_top=4, margin_bottom=4, margin_start=4, margin_end=4)
174
self.set_child(self.grid)
175
self.tl_label = Gtk.Label(label=tl)
176
self.grid.attach(self.tl_label, 0, 0, 1, 1)
177
self.tr_label = Gtk.Label(label=tr)
178
self.grid.attach(self.tr_label, 2, 0, 1, 1)
179
self.bl_label = Gtk.Label(label=bl)
180
self.grid.attach(self.bl_label, 0, 2, 1, 1)
181
self.br_label = Gtk.Label(label=br)
182
self.grid.attach(self.br_label, 2, 2, 1, 1)
183
self.c_label = Gtk.Label(label=c)
184
self.grid.attach(self.c_label, 1, 1, 1, 1)
185
self.label_map = {
186
GestureZone.CENTRAL: self.c_label,
187
GestureZone.TOP_LEFT: self.tl_label,
188
GestureZone.TOP_RIGHT: self.tr_label,
189
GestureZone.BOTTOM_RIGHT: self.br_label,
190
GestureZone.BOTTOM_LEFT: self.bl_label
191
}
192
self.connect("top_left", lambda p: self.emit("typed", tl))
193
self.connect("top_right", lambda p: self.emit("typed", tr))
194
self.connect("bottom_left", lambda p: self.emit("typed", bl))
195
self.connect("bottom_right", lambda p: self.emit("typed", br))
196
self.connect("central", lambda p: self.emit("typed", c))
197
self.connect("drag_changed", lambda p, zone: self.underline(zone))
198
class Plane(Gtk.Grid):
201
def __init__(self, app, data, **kwargs):
202
Gtk.Grid.__init__(self, **kwargs)
203
self.app = app
204
self.all_characters = ""
205
for j, column in enumerate(data):
206
for k, key in enumerate(column):
207
widget = SwipeTyper(key["top_left"], key["top_right"], key["bottom_left"],
208
key["bottom_right"], key["central"])
209
widget.connect("typed", self.app.typed)
210
self.attach(widget, k, j, 1, 1)
211
self.all_characters += key["top_left"] + key["top_right"] + key["bottom_left"] + key["bottom_right"] + key["central"]
212
def make_xkb_keymap_from_unicodes(unicodes):
216
symbols = [
217
"key <LEFT> { [ Left ] };"
218
"key <RGHT> { [ Right ] };"
219
"key <UP> { [ Up ] };"
220
"key <DOWN> { [ Down ] };"
221
"key <TAB> { [ Tab ] };",
222
"key <LCTL> { [ Control_L ] };",
223
"key <LALT> { [ Alt_L ] };",
224
"key <LSHF> { [ Shift_L ] };",
225
"key <LSPR> { [ Super_L ] };",
226
"key <ESCP> { [ Escape ] };",
227
"key <BKSP> { [ BackSpace ] };",
228
"key <RTRN> { [ Return ] };",
229
]
230
keycodes = [
231
"<LEFT> = 4084;",
232
"<RGHT> = 4085;",
233
"<UP> = 4086;",
234
"<DOWN> = 4087;",
235
"<TAB> = 4088;",
236
"<LCTL> = 4089;",
237
"<LALT> = 4090;",
238
"<LSHF> = 4091;",
239
"<LSPR> = 4092;",
240
"<ESCP> = 4093;",
241
"<BKSP> = 4094;",
242
"<RTRN> = 4095;",
243
]
244
for i, char in enumerate(unicodes):
245
keycode = 0x1000 + i
246
keysym = f"U{ord(char):04X}"
247
symbols.append(f"key <K{i:03X}> {{ [ {keysym} ] }};")
248
keycodes.append(f"<K{i:03X}> = {keycode};")
249
return ("xkb_keymap { xkb_keycodes \"kineboard\" { minimum = 8; maximum = 65535; "
251
+ " ".join(keycodes) + " }; xkb_symbols \"kineboard\" { " + " ".join(symbols)
252
+ " }; xkb_types \"kineboard\" { type \"ONE_LEVEL\" { modifiers = none; level_name[Level1] = \"Any\"; }; }; xkb_compatibility \"kineboard\" {}; };")
253
from gi.repository import Gio, GLib
256
def register_client(client_id: str):
259
bus = Gio.bus_get_sync(Gio.BusType.SESSION, None)
260
proxy = Gio.DBusProxy.new_sync(
262
bus,
263
Gio.DBusProxyFlags.DO_NOT_LOAD_PROPERTIES |
264
Gio.DBusProxyFlags.DO_NOT_AUTO_START_AT_CONSTRUCTION,
265
None,
266
"org.gnome.SessionManager",
267
"/org/gnome/SessionManager",
268
"org.gnome.SessionManager",
269
None
270
)
271
startup_id = GLib.getenv("DESKTOP_AUTOSTART_ID") or ""
273
def on_registered(proxy, result, loop):
275
try:
276
proxy.call_finish(result)
277
except Exception as e:
278
print("cannot register client:", e)
279
loop.quit()
280
loop = GLib.MainLoop()
282
proxy.call(
284
"RegisterClient",
285
GLib.Variant("(ss)", (client_id, startup_id)),
286
Gio.DBusCallFlags.NONE,
287
-1,
288
None,
289
lambda p, r, l: on_registered(p, r, loop),
290
loop
291
)
292
loop.run()
294
return proxy
295
296
class ModifierButton(Gtk.ToggleButton):
298
def __init__(self, app, mask, **kwargs):
299
super().__init__(**kwargs)
300
self.app = app
301
self.mask = mask
302
self.connect("toggled", self.toggle_modifier)
304
def toggle_modifier(self, button):
306
if button.get_active():
307
self.app.depressed_modifiers |= self.mask
308
else:
309
self.app.depressed_modifiers &= ~self.mask
310
self.app.send_modifiers()
312
class Kineboard(Gtk.Application):
315
def __init__(self):
316
Gtk.Application.__init__(
317
self,
318
application_id="sm.puri.OSK0",
319
flags=Gio.ApplicationFlags.HANDLES_COMMAND_LINE
320
)
321
self.xkb_context = xkb.Context()
322
self.revealer = None
323
self.switcher = None
324
self.depressed_modifiers = 0
325
self.character_index = {}
326
self.keymap_fd = None
327
self.vk = None
328
self.keymap_text = ""
329
self.all_characters = ""
330
self.context = None
331
self.input_method_manager = None
332
self.input_method = None
333
self.registry = None
334
self.box = None
335
self.window = None
336
self.stack = None
337
self.display = None
338
self.wl_display = None
339
self.seat = None
340
self.vkm = None
341
self.serial = 0
342
self.extra_revealer = None
343
self.extra_viewport = None
344
self.extra_scroll = None
345
self.extra_controls = None
346
self.add_main_option(
347
"invoke",
348
ord("i"),
349
GLib.OptionFlags.NONE,
350
GLib.OptionArg.NONE,
351
"Manually bring up the keyboard",
352
None
353
)
354
self.add_main_option(
355
"hide",
356
ord("h"),
357
GLib.OptionFlags.NONE,
358
GLib.OptionArg.NONE,
359
"Hide the keyboard",
360
None
361
)
362
363
def send_modifiers(self):
364
self.vk.modifiers(self.depressed_modifiers, 0, 0, 0)
365
def do_startup(self):
367
Gtk.Application.do_startup(self)
368
register_client("sm.puri.OSK0")
369
self.display = Gdk.Display.get_default()
370
self.window = Gtk.Window(application=self, title="Demo", focus_on_click=False, focusable=False, can_focus=False)
371
Gtk4LayerShell.init_for_window(self.window)
372
Gtk4LayerShell.set_keyboard_mode(self.window, Gtk4LayerShell.KeyboardMode.NONE)
373
self.window.set_default_size(16384, -1) # large width so that it spans the bottom
374
Gtk4LayerShell.set_anchor(self.window, Gtk4LayerShell.Edge.BOTTOM, True)
375
Gtk4LayerShell.set_anchor(self.window, Gtk4LayerShell.Edge.LEFT, True)
376
Gtk4LayerShell.set_anchor(self.window, Gtk4LayerShell.Edge.RIGHT, True)
377
Gtk4LayerShell.auto_exclusive_zone_enable(self.window)
378
Gtk4LayerShell.set_namespace(self.window, "osk")
379
self.box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL)
380
self.main_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, margin_top=8)
381
self.window.set_child(self.main_box)
382
self.stack = Gtk.Stack()
383
self.box.append(self.stack)
384
layouts = itertools.chain.from_iterable((f for f in path.iterdir() if f.is_file()) for path in get_layout_directories())
385
self.all_characters = " "
386
self.switcher = Gtk.StackSidebar(stack=self.stack)
387
self.revealer = Gtk.Revealer(child=self.switcher, transition_type=Gtk.RevealerTransitionType.SLIDE_RIGHT)
388
self.box.prepend(self.revealer)
389
self.extra_controls = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=8,
391
margin_bottom=8, margin_start=8, margin_end=8)
392
self.extra_viewport = Gtk.Viewport(child=self.extra_controls)
393
self.extra_scroll = Gtk.ScrolledWindow(child=self.extra_viewport, propagate_natural_height=True)
394
self.extra_revealer = Gtk.Revealer(child=self.extra_scroll)
395
396
for layout in layouts:
397
stack = Gtk.Stack()
398
yaml_loader = yaml.YAML(typ="rt")
400
data = yaml_loader.load(layout)
401
controls = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=8, margin_top=0,
403
margin_bottom=8, margin_start=8, margin_end=8)
404
layout_button = Gtk.ToggleButton(child=Gtk.Image.new_from_icon_name("edit-symbolic"))
406
layout_button.set_size_request(48, -1)
407
layout_button.update_property([Gtk.AccessibleProperty.LABEL], ["Switch layout"])
408
controls.append(layout_button)
409
layout_button.bind_property("active", self.revealer, "reveal-child", GObject.BindingFlags.BIDIRECTIONAL)
410
control_button = Gtk.ToggleButton(child=Gtk.Image.new_from_icon_name("utilities-terminal-symbolic"))
412
control_button.set_size_request(48, -1)
413
control_button.update_property([Gtk.AccessibleProperty.LABEL], ["Terminal controls"])
414
controls.append(control_button)
415
control_button.bind_property("active", self.extra_revealer, "reveal-child", GObject.BindingFlags.BIDIRECTIONAL)
416
if len(data["keys"]) >= 2:
418
shift_button = Gtk.ToggleButton(
419
child=Gtk.Image.new_from_icon_name("go-up-symbolic")
420
)
421
shift_button.set_size_request(48, -1)
422
shift_button.update_property([Gtk.AccessibleProperty.LABEL], ["Shift"])
423
controls.append(shift_button)
424
def shift(button: Gtk.ToggleButton):
426
stack.set_visible_child_name(f"plane-{int(button.get_active())}")
427
shift_button.connect("toggled", shift)
429
space_bar = Gtk.Button(hexpand=True)
431
space_bar.update_property([Gtk.AccessibleProperty.LABEL], ["Space"])
432
space_bar.connect("clicked", lambda x: self.typed(x, " "))
433
controls.append(space_bar)
434
backspace_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("edit-clear-symbolic"))
436
backspace_button.set_size_request(48, -1)
437
backspace_button.update_property([Gtk.AccessibleProperty.LABEL], ["Backspace"])
438
backspace_button.connect("clicked", lambda x: self.send_keysym(0xFF6))
439
controls.append(backspace_button)
440
enter_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("keyboard-enter-symbolic"))
442
enter_button.set_size_request(48, -1)
443
enter_button.update_property([Gtk.AccessibleProperty.LABEL], ["Enter"])
444
enter_button.add_css_class("suggested-action")
445
enter_button.connect("clicked", lambda x: self.send_keysym(0xFF7))
446
controls.append(enter_button)
447
for i, layer in enumerate(data["keys"]):
449
grid = Plane(self, layer, row_spacing=8, column_spacing=8, row_homogeneous=True,
450
column_homogeneous=True, margin_bottom=8,
451
margin_end=8, margin_start=8)
452
self.all_characters += grid.all_characters
453
stack.add_named(grid, f"plane-{i}")
454
outer_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
456
outer_box.append(stack)
457
outer_box.append(controls)
458
self.stack.add_titled(outer_box, data["symbol"], data["symbol"])
459
self.main_box.append(self.extra_revealer)
461
self.main_box.append(self.box)
462
ctypes.pythonapi.PyCapsule_GetPointer.restype = ctypes.c_void_p
464
ctypes.pythonapi.PyCapsule_GetPointer.argtypes = (ctypes.py_object,)
465
self.wl_display = Display()
467
wl_display_ptr = gtk.gdk_wayland_display_get_wl_display(
468
ffi.cast("void *", ctypes.pythonapi.PyCapsule_GetPointer(self.display.__gpointer__, None)))
469
self.wl_display._ptr = wl_display_ptr
470
self.registry = self.wl_display.get_registry()
471
self.registry.dispatcher["global"] = self.on_global
472
self.registry.dispatcher["global_remove"] = self.on_global_remove
473
self.wl_display.roundtrip()
474
if self.input_method_manager:
476
self.input_method = self.input_method_manager.get_input_method(self.seat)
477
self.input_method.dispatcher["activate"] = self.activate_input
478
self.input_method.dispatcher["deactivate"] = self.deactivate_input
479
else:
480
dialog = Gtk.AlertDialog(message="Input method protocol not supported.")
481
dialog.show()
482
self.keymap_text = make_xkb_keymap_from_unicodes(self.all_characters)
484
xkb_keymap = self.xkb_context.keymap_new_from_string(self.keymap_text)
485
state = xkb_keymap.state_new()
486
487
escape_button = Gtk.Button(label="Escape")
488
escape_button.connect("clicked", lambda x: self.send_keysym(0xFF5))
489
self.extra_controls.append(escape_button)
490
self.extra_controls.append(ModifierButton(self, 1 << xkb_keymap.mod_get_index("Control"), label="Control"))
491
self.extra_controls.append(ModifierButton(self, 1 << xkb_keymap.mod_get_index("Mod1"), label="Alt"))
492
self.extra_controls.append(ModifierButton(self, 1 << xkb_keymap.mod_get_index("Shift"), label="Shift"))
493
self.extra_controls.append(ModifierButton(self, 1 << xkb_keymap.mod_get_index("Mod4"), label="Super"))
494
tab_button = Gtk.Button(label="Tab")
495
tab_button.connect("clicked", lambda x: self.send_keysym(0xFF0))
496
self.extra_controls.append(tab_button)
497
left_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("go-previous-symbolic"))
498
left_button.update_property([Gtk.AccessibleProperty.LABEL], ["Left"])
499
left_button.connect("clicked", lambda x: self.send_keysym(0xFEC))
500
self.extra_controls.append(left_button)
501
down_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("go-down-symbolic"))
502
down_button.update_property([Gtk.AccessibleProperty.LABEL], ["Down"])
503
down_button.connect("clicked", lambda x: self.send_keysym(0xFEF))
504
self.extra_controls.append(down_button)
505
up_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("go-up-symbolic"))
506
up_button.update_property([Gtk.AccessibleProperty.LABEL], ["Up"])
507
up_button.connect("clicked", lambda x: self.send_keysym(0xFEE))
508
self.extra_controls.append(up_button)
509
right_button = Gtk.Button(child=Gtk.Image.new_from_icon_name("go-next-symbolic"))
510
right_button.update_property([Gtk.AccessibleProperty.LABEL], ["Right"])
511
right_button.connect("clicked", lambda x: self.send_keysym(0xFED))
512
self.extra_controls.append(right_button)
513
514
self.character_index = {}
515
for i, character in enumerate(self.all_characters):
516
self.character_index[character] = i
517
self.vk = self.vkm.create_virtual_keyboard(self.seat)
518
self.keymap_fd = os.memfd_create("keymap")
520
os.write(self.keymap_fd, self.keymap_text.encode("utf-8"))
521
os.lseek(self.keymap_fd, 0, os.SEEK_SET)
522
self.vk.keymap(1, self.keymap_fd, len(self.keymap_text.encode("utf-8")))
523
def activate_input(self, im):
525
self.window.present()
526
def deactivate_input(self, im):
528
self.window.set_visible(False)
529
self.serial = 0
530
def on_global(self, registry, name, interface, version):
532
if interface == "zwp_input_method_manager_v2":
533
self.input_method_manager = registry.bind(name, ZwpInputMethodManagerV2, version)
534
elif interface == "wl_seat":
535
self.seat = registry.bind(name, WlSeat, version)
536
elif interface == "zwp_virtual_keyboard_manager_v1":
537
self.vkm = registry.bind(name, ZwpVirtualKeyboardManagerV1, version)
538
def on_global_remove(self, registry, name):
540
pass
541
def send_keysym(self, key):
543
clock = int(time.monotonic() * 1000)
544
if self.vk:
545
self.vk.key(clock, key, 1)
546
self.vk.key(clock, key, 0)
547
def typed(self, button, characters):
549
for char in characters:
550
self.send_keysym(0xFF8 + self.character_index[char])
551
def do_activate(self):
553
Gtk.Application.do_activate(self)
554
# self.window.present()
555
def do_command_line(self, command_line: Gio.ApplicationCommandLine):
557
options = command_line.get_options_dict()
558
args = command_line.get_arguments()[1:]
559
if options.contains("invoke"):
560
self.activate_input(None, None)
561
elif options.contains("hide"):
562
self.deactivate_input(None, None)
563
return 0
564
if __name__ == "__main__":
567
kineboard = Kineboard()
568
kineboard.run(sys.argv)
569