2 * Copyright © 2012 Collabora, Ltd.
3 * Copyright © 2013 Ran Benita <ran234@gmail.com>
4 * Copyright © 2016 Daniel Stone <daniel@fooishbar.org>
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
33 #include "xkbcommon/xkbcommon.h"
36 #include <wayland-client.h>
37 #include "xdg-shell-unstable-v6-client-protocol.h"
38 #include <wayland-util.h>
40 struct interactive_dpy {
41 struct wl_display *dpy;
42 struct wl_compositor *compositor;
43 struct zxdg_shell_v6 *shell;
47 struct xkb_context *ctx;
49 struct wl_surface *wl_surf;
50 struct zxdg_surface_v6 *xdg_surf;
51 struct zxdg_toplevel_v6 *xdg_top;
56 struct interactive_seat {
57 struct interactive_dpy *inter;
59 struct wl_seat *wl_seat;
60 struct wl_keyboard *wl_kbd;
61 struct wl_pointer *wl_pointer;
62 uint32_t version; /* ... of wl_seat */
63 uint32_t global_name; /* an ID of sorts */
64 char *name_str; /* a descriptor */
66 struct xkb_keymap *keymap;
67 struct xkb_state *state;
72 static bool terminate;
74 /* The following utility functions are taken from Weston's
75 * shared/os-compatibility.c. */
77 os_fd_set_cloexec(int fd)
84 flags = fcntl(fd, F_GETFD);
88 if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == -1)
95 set_cloexec_or_close(int fd)
97 if (os_fd_set_cloexec(fd) != 0) {
105 create_tmpfile_cloexec(char *tmpname)
110 fd = mkostemp(tmpname, O_CLOEXEC);
114 fd = mkstemp(tmpname);
116 fd = set_cloexec_or_close(fd);
125 * Create a new, unique, anonymous file of the given size, and
126 * return the file descriptor for it. The file descriptor is set
127 * CLOEXEC. The file is immediately suitable for mmap()'ing
128 * the given size at offset zero.
130 * The file should not have a permanent backing store like a disk,
131 * but may have if XDG_RUNTIME_DIR is not properly implemented in OS.
133 * The file name is deleted from the file system.
135 * The file is suitable for buffer sharing between processes by
136 * transmitting the file descriptor over Unix sockets using the
137 * SCM_RIGHTS methods.
139 * If the C library implements posix_fallocate(), it is used to
140 * guarantee that disk space is available for the file at the
141 * given size. If disk space is insufficent, errno is set to ENOSPC.
142 * If posix_fallocate() is not supported, program may receive
143 * SIGBUS on accessing mmap()'ed file contents instead.
146 os_create_anonymous_file(off_t size)
148 static const char template[] = "/weston-shared-XXXXXX";
154 path = getenv("XDG_RUNTIME_DIR");
160 name = malloc(strlen(path) + sizeof(template));
165 strcat(name, template);
167 fd = create_tmpfile_cloexec(name);
174 #ifdef HAVE_POSIX_FALLOCATE
175 ret = posix_fallocate(fd, 0, size);
182 ret = ftruncate(fd, size);
193 buffer_release(void *data, struct wl_buffer *buffer)
195 wl_buffer_destroy(buffer);
198 static const struct wl_buffer_listener buffer_listener = {
203 buffer_create(struct interactive_dpy *inter, uint32_t width, uint32_t height)
205 struct wl_shm_pool *pool;
206 struct wl_buffer *buf;
207 struct wl_region *opaque;
213 switch (inter->shm_format) {
214 case WL_SHM_FORMAT_ARGB8888:
215 case WL_SHM_FORMAT_XRGB8888:
216 case WL_SHM_FORMAT_ABGR8888:
217 case WL_SHM_FORMAT_XBGR8888:
220 case WL_SHM_FORMAT_RGB565:
221 case WL_SHM_FORMAT_BGR565:
225 fprintf(stderr, "Unsupported SHM format %d\n", inter->shm_format);
229 size = stride * height;
230 fd = os_create_anonymous_file(size);
232 fprintf(stderr, "Couldn't create surface buffer\n");
236 map = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
237 if (map == MAP_FAILED) {
238 fprintf(stderr, "Couldn't mmap surface buffer\n");
241 memset(map, 0xff, size);
244 pool = wl_shm_create_pool(inter->shm, fd, size);
245 buf = wl_shm_pool_create_buffer(pool, 0, width, height, stride,
247 wl_buffer_add_listener(buf, &buffer_listener, inter);
249 wl_surface_attach(inter->wl_surf, buf, 0, 0);
250 wl_surface_damage(inter->wl_surf, 0, 0, width, height);
252 opaque = wl_compositor_create_region(inter->compositor);
253 wl_region_add(opaque, 0, 0, width, height);
254 wl_surface_set_opaque_region(inter->wl_surf, opaque);
255 wl_region_destroy(opaque);
257 wl_shm_pool_destroy(pool);
262 surface_configure(void *data, struct zxdg_surface_v6 *surface,
265 struct interactive_dpy *inter = data;
267 zxdg_surface_v6_ack_configure(inter->xdg_surf, serial);
268 wl_surface_commit(inter->wl_surf);
271 static const struct zxdg_surface_v6_listener surface_listener = {
276 toplevel_configure(void *data, struct zxdg_toplevel_v6 *toplevel,
277 int32_t width, int32_t height, struct wl_array *states)
279 struct interactive_dpy *inter = data;
286 buffer_create(inter, width, height);
290 toplevel_close(void *data, struct zxdg_toplevel_v6 *toplevel)
295 static const struct zxdg_toplevel_v6_listener toplevel_listener = {
300 static void surface_create(struct interactive_dpy *inter)
302 inter->wl_surf = wl_compositor_create_surface(inter->compositor);
303 inter->xdg_surf = zxdg_shell_v6_get_xdg_surface(inter->shell,
305 zxdg_surface_v6_add_listener(inter->xdg_surf, &surface_listener, inter);
306 inter->xdg_top = zxdg_surface_v6_get_toplevel(inter->xdg_surf);
307 zxdg_toplevel_v6_add_listener(inter->xdg_top, &toplevel_listener, inter);
308 zxdg_toplevel_v6_set_title(inter->xdg_top, "xkbcommon event tester");
309 zxdg_toplevel_v6_set_app_id(inter->xdg_top,
310 "org.xkbcommon.test.interactive-wayland");
311 wl_surface_commit(inter->wl_surf);
315 shell_ping(void *data, struct zxdg_shell_v6 *shell, uint32_t serial)
317 zxdg_shell_v6_pong(shell, serial);
320 static const struct zxdg_shell_v6_listener shell_listener = {
325 kbd_keymap(void *data, struct wl_keyboard *wl_kbd, uint32_t format,
326 int fd, uint32_t size)
328 struct interactive_seat *seat = data;
331 buf = mmap(NULL, size, PROT_READ, MAP_SHARED, fd, 0);
332 if (buf == MAP_FAILED) {
333 fprintf(stderr, "Failed to mmap keymap: %d\n", errno);
338 seat->keymap = xkb_keymap_new_from_buffer(seat->inter->ctx, buf, size - 1,
339 XKB_KEYMAP_FORMAT_TEXT_V1, 0);
343 fprintf(stderr, "Failed to compile keymap!\n");
347 seat->state = xkb_state_new(seat->keymap);
349 fprintf(stderr, "Failed to create XKB state!\n");
355 kbd_enter(void *data, struct wl_keyboard *wl_kbd, uint32_t serial,
356 struct wl_surface *surf, struct wl_array *keys)
361 kbd_leave(void *data, struct wl_keyboard *wl_kbd, uint32_t serial,
362 struct wl_surface *surf)
367 kbd_key(void *data, struct wl_keyboard *wl_kbd, uint32_t serial, uint32_t time,
368 uint32_t key, uint32_t state)
370 struct interactive_seat *seat = data;
372 if (state != WL_KEYBOARD_KEY_STATE_PRESSED)
375 printf("%s: ", seat->name_str);
376 test_print_keycode_state(seat->state, NULL, key + 8,
377 XKB_CONSUMED_MODE_XKB);
380 if (xkb_state_key_get_one_sym(seat->state, key + 8) == XKB_KEY_Escape)
385 kbd_modifiers(void *data, struct wl_keyboard *wl_kbd, uint32_t serial,
386 uint32_t mods_depressed, uint32_t mods_latched,
387 uint32_t mods_locked, uint32_t group)
389 struct interactive_seat *seat = data;
391 xkb_state_update_mask(seat->state, mods_depressed, mods_latched,
392 mods_locked, 0, 0, group);
396 kbd_repeat_info(void *data, struct wl_keyboard *wl_kbd, int32_t rate,
401 static const struct wl_keyboard_listener kbd_listener = {
411 pointer_enter(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
412 struct wl_surface *surf, wl_fixed_t fsx, wl_fixed_t fsy)
417 pointer_leave(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
418 struct wl_surface *surf)
423 pointer_motion(void *data, struct wl_pointer *wl_pointer, uint32_t time,
424 wl_fixed_t fsx, wl_fixed_t fsy)
429 pointer_button(void *data, struct wl_pointer *wl_pointer, uint32_t serial,
430 uint32_t time, uint32_t button, uint32_t state)
432 struct interactive_seat *seat = data;
434 zxdg_toplevel_v6_move(seat->inter->xdg_top, seat->wl_seat, serial);
438 pointer_axis(void *data, struct wl_pointer *wl_pointer, uint32_t time,
439 uint32_t axis, wl_fixed_t value)
444 pointer_frame(void *data, struct wl_pointer *wl_pointer)
449 pointer_axis_source(void *data, struct wl_pointer *wl_pointer, uint32_t source)
454 pointer_axis_stop(void *data, struct wl_pointer *wl_pointer, uint32_t time,
460 pointer_axis_discrete(void *data, struct wl_pointer *wl_pointer, uint32_t time,
465 static const struct wl_pointer_listener pointer_listener = {
474 pointer_axis_discrete
478 seat_capabilities(void *data, struct wl_seat *wl_seat, uint32_t caps)
480 struct interactive_seat *seat = data;
482 if (!seat->wl_kbd && (caps & WL_SEAT_CAPABILITY_KEYBOARD)) {
483 seat->wl_kbd = wl_seat_get_keyboard(seat->wl_seat);
484 wl_keyboard_add_listener(seat->wl_kbd, &kbd_listener, seat);
486 else if (seat->wl_kbd && !(caps & WL_SEAT_CAPABILITY_KEYBOARD)) {
487 if (seat->version >= WL_SEAT_RELEASE_SINCE_VERSION)
488 wl_keyboard_release(seat->wl_kbd);
490 wl_keyboard_destroy(seat->wl_kbd);
492 xkb_state_unref(seat->state);
493 xkb_keymap_unref(seat->keymap);
500 if (!seat->wl_pointer && (caps & WL_SEAT_CAPABILITY_POINTER)) {
501 seat->wl_pointer = wl_seat_get_pointer(seat->wl_seat);
502 wl_pointer_add_listener(seat->wl_pointer, &pointer_listener,
505 else if (seat->wl_pointer && !(caps & WL_SEAT_CAPABILITY_POINTER)) {
506 if (seat->version >= WL_SEAT_RELEASE_SINCE_VERSION)
507 wl_pointer_release(seat->wl_pointer);
509 wl_pointer_destroy(seat->wl_pointer);
510 seat->wl_pointer = NULL;
515 seat_name(void *data, struct wl_seat *wl_seat, const char *name)
517 struct interactive_seat *seat = data;
519 free(seat->name_str);
520 seat->name_str = strdup(name);
523 static const struct wl_seat_listener seat_listener = {
529 seat_create(struct interactive_dpy *inter, struct wl_registry *registry,
530 uint32_t name, uint32_t version)
533 struct interactive_seat *seat = calloc(1, sizeof(*seat));
535 seat->global_name = name;
537 seat->wl_seat = wl_registry_bind(registry, name, &wl_seat_interface,
539 wl_seat_add_listener(seat->wl_seat, &seat_listener, seat);
540 ret = asprintf(&seat->name_str, "seat:%d",
541 wl_proxy_get_id((struct wl_proxy *) seat->wl_seat));
543 wl_list_insert(&inter->seats, &seat->link);
547 seat_destroy(struct interactive_seat *seat)
550 if (seat->version >= WL_SEAT_RELEASE_SINCE_VERSION)
551 wl_keyboard_release(seat->wl_kbd);
553 wl_keyboard_destroy(seat->wl_kbd);
555 xkb_state_unref(seat->state);
556 xkb_keymap_unref(seat->keymap);
559 if (seat->wl_pointer) {
560 if (seat->version >= WL_SEAT_RELEASE_SINCE_VERSION)
561 wl_pointer_release(seat->wl_pointer);
563 wl_pointer_destroy(seat->wl_pointer);
566 if (seat->version >= WL_SEAT_RELEASE_SINCE_VERSION)
567 wl_seat_release(seat->wl_seat);
569 wl_seat_destroy(seat->wl_seat);
571 free(seat->name_str);
572 wl_list_remove(&seat->link);
577 registry_global(void *data, struct wl_registry *registry, uint32_t name,
578 const char *interface, uint32_t version)
580 struct interactive_dpy *inter = data;
582 if (strcmp(interface, "wl_seat") == 0) {
583 seat_create(inter, registry, name, version);
585 else if (strcmp(interface, "zxdg_shell_v6") == 0) {
586 inter->shell = wl_registry_bind(registry, name,
587 &zxdg_shell_v6_interface,
589 zxdg_shell_v6_add_listener(inter->shell, &shell_listener, inter);
591 else if (strcmp(interface, "wl_compositor") == 0) {
592 inter->compositor = wl_registry_bind(registry, name,
593 &wl_compositor_interface,
596 else if (strcmp(interface, "wl_shm") == 0) {
597 inter->shm = wl_registry_bind(registry, name, &wl_shm_interface,
603 registry_delete(void *data, struct wl_registry *registry, uint32_t name)
605 struct interactive_dpy *inter = data;
606 struct interactive_seat *seat, *tmp;
608 wl_list_for_each_safe(seat, tmp, &inter->seats, link) {
609 if (seat->global_name != name)
616 static const struct wl_registry_listener registry_listener = {
622 dpy_disconnect(struct interactive_dpy *inter)
624 struct interactive_seat *seat, *tmp;
626 wl_list_for_each_safe(seat, tmp, &inter->seats, link)
630 zxdg_surface_v6_destroy(inter->xdg_surf);
632 zxdg_toplevel_v6_destroy(inter->xdg_top);
634 wl_surface_destroy(inter->wl_surf);
636 zxdg_shell_v6_destroy(inter->shell);
637 if (inter->compositor)
638 wl_compositor_destroy(inter->compositor);
640 wl_shm_destroy(inter->shm);
642 /* Do one last roundtrip to try to destroy our wl_buffer. */
643 wl_display_roundtrip(inter->dpy);
645 xkb_context_unref(inter->ctx);
646 wl_display_disconnect(inter->dpy);
650 main(int argc, char *argv[])
653 struct interactive_dpy inter;
654 struct wl_registry *registry;
656 setlocale(LC_ALL, "");
658 memset(&inter, 0, sizeof(inter));
659 wl_list_init(&inter.seats);
661 inter.dpy = wl_display_connect(NULL);
663 fprintf(stderr, "Couldn't connect to Wayland server\n");
668 inter.ctx = test_get_context(0);
671 fprintf(stderr, "Couldn't create xkb context\n");
675 registry = wl_display_get_registry(inter.dpy);
676 wl_registry_add_listener(registry, ®istry_listener, &inter);
678 /* The first roundtrip gets the list of advertised globals. */
679 wl_display_roundtrip(inter.dpy);
681 /* The second roundtrip dispatches the events sent after binding, e.g.
682 * after binding to wl_seat globals in the first roundtrip, we will get
683 * the wl_seat::capabilities event in this roundtrip. */
684 wl_display_roundtrip(inter.dpy);
686 if (!inter.shell || !inter.shm || !inter.compositor) {
687 fprintf(stderr, "Required Wayland interfaces %s%s%s unsupported\n",
688 (inter.shell) ? "" : "xdg_shell ",
689 (inter.shm) ? "" : "wl_shm",
690 (inter.compositor) ? "" : "wl_compositor");
695 surface_create(&inter);
697 test_disable_stdin_echo();
699 ret = wl_display_dispatch(inter.dpy);
700 } while (ret >= 0 && !terminate);
701 test_enable_stdin_echo();
703 wl_registry_destroy(registry);
705 dpy_disconnect(&inter);
707 exit(ret >= 0 ? EXIT_SUCCESS : EXIT_FAILURE);