2 * Copyright © 2013 Ran Benita <ran234@gmail.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
30 #include "xkbcommon/xkbcommon-x11.h"
31 #include "tools-common.h"
34 * Note: This program only handles the core keyboard device for now.
35 * It should be straigtforward to change struct keyboard to a list of
36 * keyboards with device IDs, as in test/interactive-evdev.c. This would
39 * - Initially listing the keyboard devices.
40 * - Listening to device changes.
41 * - Matching events to their devices.
43 * XKB itself knows about xinput1 devices, and most requests and events are
46 * In order to list the devices and react to changes, you need xinput1/2.
47 * You also need xinput for the key press/release event, since the core
48 * protocol key press event does not carry a device ID to match on.
52 xcb_connection_t *conn;
53 uint8_t first_xkb_event;
54 struct xkb_context *ctx;
56 struct xkb_keymap *keymap;
57 struct xkb_state *state;
61 static bool terminate;
64 select_xkb_events_for_device(xcb_connection_t *conn, int32_t device_id)
68 (XCB_XKB_EVENT_TYPE_NEW_KEYBOARD_NOTIFY |
69 XCB_XKB_EVENT_TYPE_MAP_NOTIFY |
70 XCB_XKB_EVENT_TYPE_STATE_NOTIFY),
72 required_nkn_details =
73 (XCB_XKB_NKN_DETAIL_KEYCODES),
76 (XCB_XKB_MAP_PART_KEY_TYPES |
77 XCB_XKB_MAP_PART_KEY_SYMS |
78 XCB_XKB_MAP_PART_MODIFIER_MAP |
79 XCB_XKB_MAP_PART_EXPLICIT_COMPONENTS |
80 XCB_XKB_MAP_PART_KEY_ACTIONS |
81 XCB_XKB_MAP_PART_VIRTUAL_MODS |
82 XCB_XKB_MAP_PART_VIRTUAL_MOD_MAP),
84 required_state_details =
85 (XCB_XKB_STATE_PART_MODIFIER_BASE |
86 XCB_XKB_STATE_PART_MODIFIER_LATCH |
87 XCB_XKB_STATE_PART_MODIFIER_LOCK |
88 XCB_XKB_STATE_PART_GROUP_BASE |
89 XCB_XKB_STATE_PART_GROUP_LATCH |
90 XCB_XKB_STATE_PART_GROUP_LOCK),
93 static const xcb_xkb_select_events_details_t details = {
94 .affectNewKeyboard = required_nkn_details,
95 .newKeyboardDetails = required_nkn_details,
96 .affectState = required_state_details,
97 .stateDetails = required_state_details,
100 xcb_void_cookie_t cookie =
101 xcb_xkb_select_events_aux_checked(conn,
103 required_events, /* affectWhich */
106 required_map_parts, /* affectMap */
107 required_map_parts, /* map */
108 &details); /* details */
110 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
120 update_keymap(struct keyboard *kbd)
122 struct xkb_keymap *new_keymap;
123 struct xkb_state *new_state;
125 new_keymap = xkb_x11_keymap_new_from_device(kbd->ctx, kbd->conn,
127 XKB_KEYMAP_COMPILE_NO_FLAGS);
131 new_state = xkb_x11_state_new_from_device(new_keymap, kbd->conn,
137 printf("Keymap updated!\n");
139 xkb_state_unref(kbd->state);
140 xkb_keymap_unref(kbd->keymap);
141 kbd->keymap = new_keymap;
142 kbd->state = new_state;
146 xkb_keymap_unref(new_keymap);
152 init_kbd(struct keyboard *kbd, xcb_connection_t *conn, uint8_t first_xkb_event,
153 int32_t device_id, struct xkb_context *ctx)
158 kbd->first_xkb_event = first_xkb_event;
162 kbd->device_id = device_id;
164 ret = update_keymap(kbd);
168 ret = select_xkb_events_for_device(conn, device_id);
175 xkb_state_unref(kbd->state);
176 xkb_keymap_unref(kbd->keymap);
182 deinit_kbd(struct keyboard *kbd)
184 xkb_state_unref(kbd->state);
185 xkb_keymap_unref(kbd->keymap);
189 process_xkb_event(xcb_generic_event_t *gevent, struct keyboard *kbd)
193 uint8_t response_type;
196 xcb_timestamp_t time;
199 xcb_xkb_new_keyboard_notify_event_t new_keyboard_notify;
200 xcb_xkb_map_notify_event_t map_notify;
201 xcb_xkb_state_notify_event_t state_notify;
202 } *event = (union xkb_event *) gevent;
204 if (event->any.deviceID != kbd->device_id)
208 * XkbNewKkdNotify and XkbMapNotify together capture all sorts of keymap
209 * updates (e.g. xmodmap, xkbcomp, setxkbmap), with minimal redundent
212 switch (event->any.xkbType) {
213 case XCB_XKB_NEW_KEYBOARD_NOTIFY:
214 if (event->new_keyboard_notify.changed & XCB_XKB_NKN_DETAIL_KEYCODES)
218 case XCB_XKB_MAP_NOTIFY:
222 case XCB_XKB_STATE_NOTIFY:
223 xkb_state_update_mask(kbd->state,
224 event->state_notify.baseMods,
225 event->state_notify.latchedMods,
226 event->state_notify.lockedMods,
227 event->state_notify.baseGroup,
228 event->state_notify.latchedGroup,
229 event->state_notify.lockedGroup);
235 process_event(xcb_generic_event_t *gevent, struct keyboard *kbd)
237 switch (gevent->response_type) {
238 case XCB_KEY_PRESS: {
239 xcb_key_press_event_t *event = (xcb_key_press_event_t *) gevent;
240 xkb_keycode_t keycode = event->detail;
242 tools_print_keycode_state(kbd->state, NULL, keycode,
243 XKB_CONSUMED_MODE_XKB);
251 if (gevent->response_type == kbd->first_xkb_event)
252 process_xkb_event(gevent, kbd);
258 loop(xcb_connection_t *conn, struct keyboard *kbd)
261 xcb_generic_event_t *event;
263 switch (xcb_connection_has_error(conn)) {
268 "Closed connection to X server: connection error\n");
270 case XCB_CONN_CLOSED_EXT_NOTSUPPORTED:
272 "Closed connection to X server: extension not supported\n");
276 "Closed connection to X server: error code %d\n",
277 xcb_connection_has_error(conn));
281 event = xcb_wait_for_event(conn);
286 process_event(event, kbd);
294 create_capture_window(xcb_connection_t *conn)
296 xcb_generic_error_t *error;
297 xcb_void_cookie_t cookie;
298 xcb_screen_t *screen =
299 xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
300 xcb_window_t window = xcb_generate_id(conn);
301 uint32_t values[2] = {
303 XCB_EVENT_MASK_KEY_PRESS,
306 cookie = xcb_create_window_checked(conn, XCB_COPY_FROM_PARENT,
307 window, screen->root,
309 XCB_WINDOW_CLASS_INPUT_OUTPUT,
311 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
313 if ((error = xcb_request_check(conn, cookie)) != NULL) {
318 cookie = xcb_map_window_checked(conn, window);
319 if ((error = xcb_request_check(conn, cookie)) != NULL) {
328 main(int argc, char *argv[])
331 xcb_connection_t *conn;
332 uint8_t first_xkb_event;
333 int32_t core_kbd_device_id;
334 struct xkb_context *ctx;
335 struct keyboard core_kbd;
337 setlocale(LC_ALL, "");
339 conn = xcb_connect(NULL, NULL);
340 if (!conn || xcb_connection_has_error(conn)) {
341 fprintf(stderr, "Couldn't connect to X server: error code %d\n",
342 conn ? xcb_connection_has_error(conn) : -1);
347 ret = xkb_x11_setup_xkb_extension(conn,
348 XKB_X11_MIN_MAJOR_XKB_VERSION,
349 XKB_X11_MIN_MINOR_XKB_VERSION,
350 XKB_X11_SETUP_XKB_EXTENSION_NO_FLAGS,
351 NULL, NULL, &first_xkb_event, NULL);
353 fprintf(stderr, "Couldn't setup XKB extension\n");
357 ctx = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
360 fprintf(stderr, "Couldn't create xkb context\n");
364 core_kbd_device_id = xkb_x11_get_core_keyboard_device_id(conn);
365 if (core_kbd_device_id == -1) {
367 fprintf(stderr, "Couldn't find core keyboard device\n");
371 ret = init_kbd(&core_kbd, conn, first_xkb_event, core_kbd_device_id, ctx);
373 fprintf(stderr, "Couldn't initialize core keyboard device\n");
377 ret = create_capture_window(conn);
379 fprintf(stderr, "Couldn't create a capture window\n");
383 tools_disable_stdin_echo();
384 ret = loop(conn, &core_kbd);
385 tools_enable_stdin_echo();
388 deinit_kbd(&core_kbd);
390 xkb_context_unref(ctx);
392 xcb_disconnect(conn);
394 exit(ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE);