[PATCH 2/2] Add a hacky client to test multiple pointer/keyboard resources

Kristian Høgsberg hoegsberg at gmail.com
Sat Sep 21 21:47:43 PDT 2013


On Thu, Sep 19, 2013 at 05:32:01PM +0100, Neil Roberts wrote:
> ** I don't expect this patch to be landed but it might be useful if
>    anyone wants to test the multi-resource stuff **
> 
> This adds a hacked version of simple-shm which can create multiple
> pointer and keyboard resources. The resources are created with the
> command line options -p and -k. Both take an integer argument which
> specifies the time in seconds after the program is started when the
> resource should be created. It can also take a second time with a
> colon separator to specify when the resource should be released.
> 
> For example:
> 
>  weston-multi-resource -p5 -p7 -k9 -p12:14
> 
> That would create a pointer after 5 seconds, a second pointer 2
> seconds later, a keyboard 2 seconds after that, a third pointer after
> a further 3 seconds and finally after 2 more seconds it would release
> that final pointer resource.
> 
> This can be used along with WAYLAND_DEBUG to check that it gets the
> right events for example if the pointer is created while the client's
> surface already has focus and so on.

No, I think this is exactly the kind of clients we have in weston.
Most clients test a few specific features in a minimal way and that's
that.  And lacking a fully automated test case, at least having a
simple client that makes it easy to test and verify the feature is
critical.

Looking through the code, it seems like we should try to find a way to
share code a little better.  window.c started out this way, but now it
feels like too much of a framework and it's hard to pick out a few
helper functions.

Kristian

> ---
>  clients/Makefile.am      |   9 +-
>  clients/multi-resource.c | 596 +++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 604 insertions(+), 1 deletion(-)
>  create mode 100644 clients/multi-resource.c
> 
> diff --git a/clients/Makefile.am b/clients/Makefile.am
> index 24c6489..d4bee2a 100644
> --- a/clients/Makefile.am
> +++ b/clients/Makefile.am
> @@ -32,7 +32,8 @@ AM_CPPFLAGS =					\
>  if BUILD_SIMPLE_CLIENTS
>  simple_clients_programs =			\
>  	weston-simple-shm			\
> -	weston-simple-touch
> +	weston-simple-touch			\
> +	weston-multi-resource
>  
>  weston_simple_shm_SOURCES = simple-shm.c 	\
>  	../shared/os-compatibility.c		\
> @@ -45,6 +46,12 @@ weston_simple_touch_SOURCES = simple-touch.c	\
>  	../shared/os-compatibility.h
>  weston_simple_touch_CPPFLAGS = $(SIMPLE_CLIENT_CFLAGS)
>  weston_simple_touch_LDADD = $(SIMPLE_CLIENT_LIBS)
> +
> +weston_multi_resource_SOURCES = multi-resource.c	\
> +	../shared/os-compatibility.c			\
> +	../shared/os-compatibility.h
> +weston_multi_resource_CPPFLAGS = $(SIMPLE_CLIENT_CFLAGS)
> +weston_multi_resource_LDADD = $(SIMPLE_CLIENT_LIBS)
>  endif
>  
>  if BUILD_SIMPLE_EGL_CLIENTS
> diff --git a/clients/multi-resource.c b/clients/multi-resource.c
> new file mode 100644
> index 0000000..1c2e5c9
> --- /dev/null
> +++ b/clients/multi-resource.c
> @@ -0,0 +1,596 @@
> +/*
> + * Copyright © 2011 Benjamin Franzke
> + * Copyright © 2010, 2013 Intel Corporation
> + *
> + * Permission to use, copy, modify, distribute, and sell this software and its
> + * documentation for any purpose is hereby granted without fee, provided that
> + * the above copyright notice appear in all copies and that both that copyright
> + * notice and this permission notice appear in supporting documentation, and
> + * that the name of the copyright holders not be used in advertising or
> + * publicity pertaining to distribution of the software without specific,
> + * written prior permission.  The copyright holders make no representations
> + * about the suitability of this software for any purpose.  It is provided "as
> + * is" without express or implied warranty.
> + *
> + * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
> + * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
> + * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
> + * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
> + * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
> + * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
> + * OF THIS SOFTWARE.
> + */
> +
> +#include <config.h>
> +
> +#include <stdio.h>
> +#include <stdlib.h>
> +#include <errno.h>
> +#include <string.h>
> +#include <stdbool.h>
> +#include <assert.h>
> +#include <unistd.h>
> +#include <sys/mman.h>
> +#include <signal.h>
> +#include <time.h>
> +#include <sys/poll.h>
> +#include <float.h>
> +
> +#include <wayland-client.h>
> +#include "../shared/os-compatibility.h"
> +
> +struct device {
> +	enum { KEYBOARD, POINTER } type;
> +
> +	int start_time;
> +	int end_time;
> +	struct wl_list link;
> +
> +	union {
> +		struct wl_keyboard *keyboard;
> +		struct wl_pointer *pointer;
> +	} p;
> +};
> +
> +struct display {
> +	struct wl_display *display;
> +	struct wl_registry *registry;
> +	struct wl_compositor *compositor;
> +	struct wl_shell *shell;
> +	struct wl_seat *seat;
> +	struct wl_shm *shm;
> +	uint32_t formats;
> +	struct wl_list devices;
> +};
> +
> +struct window {
> +	struct display *display;
> +	int width, height;
> +	struct wl_surface *surface;
> +	struct wl_shell_surface *shell_surface;
> +};
> +
> +static void
> +buffer_release(void *data, struct wl_buffer *buffer)
> +{
> +	wl_buffer_destroy(buffer);
> +}
> +
> +static const struct wl_buffer_listener buffer_listener = {
> +	buffer_release
> +};
> +
> +static int
> +attach_buffer(struct window *window, int width, int height)
> +{
> +	struct wl_shm_pool *pool;
> +	struct wl_buffer *buffer;
> +	int fd, size, stride;
> +
> +	stride = width * 4;
> +	size = stride * height;
> +
> +	fd = os_create_anonymous_file(size);
> +	if (fd < 0) {
> +		fprintf(stderr, "creating a buffer file for %d B failed: %m\n",
> +			size);
> +		return -1;
> +	}
> +
> +	pool = wl_shm_create_pool(window->display->shm, fd, size);
> +	buffer = wl_shm_pool_create_buffer(pool, 0,
> +					   width, height,
> +					   stride,
> +					   WL_SHM_FORMAT_XRGB8888);
> +	wl_surface_attach(window->surface, buffer, 0, 0);
> +	wl_buffer_add_listener(buffer, &buffer_listener, buffer);
> +	wl_shm_pool_destroy(pool);
> +	close(fd);
> +
> +	return 0;
> +}
> +
> +static void
> +handle_ping(void *data, struct wl_shell_surface *shell_surface,
> +							uint32_t serial)
> +{
> +	wl_shell_surface_pong(shell_surface, serial);
> +}
> +
> +static void
> +handle_configure(void *data, struct wl_shell_surface *shell_surface,
> +		 uint32_t edges, int32_t width, int32_t height)
> +{
> +}
> +
> +static void
> +handle_popup_done(void *data, struct wl_shell_surface *shell_surface)
> +{
> +}
> +
> +static const struct wl_shell_surface_listener shell_surface_listener = {
> +	handle_ping,
> +	handle_configure,
> +	handle_popup_done
> +};
> +
> +static struct window *
> +create_window(struct display *display, int width, int height)
> +{
> +	struct window *window;
> +
> +	window = calloc(1, sizeof *window);
> +	if (!window)
> +		return NULL;
> +
> +	window->display = display;
> +	window->width = width;
> +	window->height = height;
> +	window->surface = wl_compositor_create_surface(display->compositor);
> +	window->shell_surface = wl_shell_get_shell_surface(display->shell,
> +							   window->surface);
> +
> +	if (window->shell_surface)
> +		wl_shell_surface_add_listener(window->shell_surface,
> +					      &shell_surface_listener, window);
> +
> +	wl_shell_surface_set_title(window->shell_surface, "simple-shm");
> +
> +	wl_shell_surface_set_toplevel(window->shell_surface);
> +
> +	wl_surface_damage(window->surface, 0, 0, width, height);
> +	attach_buffer(window, width, height);
> +	wl_surface_commit(window->surface);
> +
> +	return window;
> +}
> +
> +static void
> +destroy_window(struct window *window)
> +{
> +	wl_shell_surface_destroy(window->shell_surface);
> +	wl_surface_destroy(window->surface);
> +	free(window);
> +}
> +
> +static void
> +shm_format(void *data, struct wl_shm *wl_shm, uint32_t format)
> +{
> +	struct display *d = data;
> +
> +	d->formats |= (1 << format);
> +}
> +
> +struct wl_shm_listener shm_listener = {
> +	shm_format
> +};
> +
> +static void
> +registry_handle_global(void *data, struct wl_registry *registry,
> +		       uint32_t id, const char *interface, uint32_t version)
> +{
> +	struct display *d = data;
> +
> +	if (strcmp(interface, "wl_compositor") == 0) {
> +		d->compositor =
> +			wl_registry_bind(registry,
> +					 id, &wl_compositor_interface, 1);
> +	} else if (strcmp(interface, "wl_shell") == 0) {
> +		d->shell = wl_registry_bind(registry,
> +					    id, &wl_shell_interface, 1);
> +	} else if (strcmp(interface, "wl_shm") == 0) {
> +		d->shm = wl_registry_bind(registry,
> +					  id, &wl_shm_interface, 1);
> +		wl_shm_add_listener(d->shm, &shm_listener, d);
> +	} else if (strcmp(interface, "wl_seat") == 0 &&
> +		   d->seat == NULL) {
> +		d->seat = wl_registry_bind(registry,
> +					   id, &wl_seat_interface, 3);
> +	}
> +}
> +
> +static void
> +registry_handle_global_remove(void *data, struct wl_registry *registry,
> +			      uint32_t name)
> +{
> +}
> +
> +static const struct wl_registry_listener registry_listener = {
> +	registry_handle_global,
> +	registry_handle_global_remove
> +};
> +
> +static struct display *
> +create_display(void)
> +{
> +	struct display *display;
> +
> +	display = malloc(sizeof *display);
> +	if (display == NULL) {
> +		fprintf(stderr, "out of memory\n");
> +		exit(1);
> +	}
> +	memset(display, 0, sizeof *display);
> +	display->display = wl_display_connect(NULL);
> +	assert(display->display);
> +
> +	display->formats = 0;
> +	display->registry = wl_display_get_registry(display->display);
> +	wl_registry_add_listener(display->registry,
> +				 &registry_listener, display);
> +	wl_display_roundtrip(display->display);
> +	if (display->shm == NULL) {
> +		fprintf(stderr, "No wl_shm global\n");
> +		exit(1);
> +	}
> +
> +	wl_display_roundtrip(display->display);
> +
> +	if (!(display->formats & (1 << WL_SHM_FORMAT_XRGB8888))) {
> +		fprintf(stderr, "WL_SHM_FORMAT_XRGB32 not available\n");
> +		exit(1);
> +	}
> +
> +	wl_display_get_fd(display->display);
> +
> +	wl_list_init(&display->devices);
> +
> +	return display;
> +}
> +
> +static void
> +pointer_handle_enter(void *data, struct wl_pointer *pointer,
> +		     uint32_t serial, struct wl_surface *surface,
> +		     wl_fixed_t sx_w, wl_fixed_t sy_w)
> +{
> +}
> +
> +static void
> +pointer_handle_leave(void *data, struct wl_pointer *pointer,
> +		     uint32_t serial, struct wl_surface *surface)
> +{
> +}
> +
> +static void
> +pointer_handle_motion(void *data, struct wl_pointer *pointer,
> +		      uint32_t time, wl_fixed_t sx_w, wl_fixed_t sy_w)
> +{
> +}
> +
> +static void
> +pointer_handle_button(void *data, struct wl_pointer *pointer, uint32_t serial,
> +		      uint32_t time, uint32_t button, uint32_t state_w)
> +{
> +}
> +
> +static void
> +pointer_handle_axis(void *data, struct wl_pointer *pointer,
> +		    uint32_t time, uint32_t axis, wl_fixed_t value)
> +{
> +}
> +
> +static const struct wl_pointer_listener pointer_listener = {
> +	pointer_handle_enter,
> +	pointer_handle_leave,
> +	pointer_handle_motion,
> +	pointer_handle_button,
> +	pointer_handle_axis,
> +};
> +
> +static void
> +keyboard_handle_keymap(void *data, struct wl_keyboard *keyboard,
> +		       uint32_t format, int fd, uint32_t size)
> +{
> +}
> +
> +static void
> +keyboard_handle_enter(void *data, struct wl_keyboard *keyboard,
> +		      uint32_t serial, struct wl_surface *surface,
> +		      struct wl_array *keys)
> +{
> +}
> +
> +static void
> +keyboard_handle_leave(void *data, struct wl_keyboard *keyboard,
> +		      uint32_t serial, struct wl_surface *surface)
> +{
> +}
> +
> +static void
> +keyboard_handle_key(void *data, struct wl_keyboard *keyboard,
> +		    uint32_t serial, uint32_t time, uint32_t key,
> +		    uint32_t state_w)
> +{
> +}
> +
> +static void
> +keyboard_handle_modifiers(void *data, struct wl_keyboard *keyboard,
> +			  uint32_t serial, uint32_t mods_depressed,
> +			  uint32_t mods_latched, uint32_t mods_locked,
> +			  uint32_t group)
> +{
> +}
> +
> +static const struct wl_keyboard_listener keyboard_listener = {
> +	keyboard_handle_keymap,
> +	keyboard_handle_enter,
> +	keyboard_handle_leave,
> +	keyboard_handle_key,
> +	keyboard_handle_modifiers,
> +};
> +
> +static void
> +start_device(struct display *display, struct device *device)
> +{
> +	if (display->seat == NULL)
> +		return;
> +
> +	switch (device->type) {
> +	case KEYBOARD:
> +		if (device->p.keyboard == NULL) {
> +			device->p.keyboard =
> +				wl_seat_get_keyboard(display->seat);
> +			wl_keyboard_add_listener(device->p.keyboard,
> +						 &keyboard_listener,
> +						 NULL);
> +		}
> +		break;
> +	case POINTER:
> +		if (device->p.pointer == NULL) {
> +			device->p.pointer =
> +				wl_seat_get_pointer(display->seat);
> +			wl_pointer_add_listener(device->p.pointer,
> +						&pointer_listener,
> +						NULL);
> +		}
> +		break;
> +	}
> +}
> +
> +static void
> +destroy_device(struct device *device)
> +{
> +	switch (device->type) {
> +	case KEYBOARD:
> +		if (device->p.keyboard)
> +			wl_keyboard_release(device->p.keyboard);
> +		break;
> +	case POINTER:
> +		if (device->p.pointer)
> +			wl_pointer_release(device->p.pointer);
> +		break;
> +	}
> +
> +	wl_list_remove(&device->link);
> +	free(device);
> +}
> +
> +static void
> +destroy_devices(struct display *display)
> +{
> +	struct device *device, *tmp;
> +
> +	wl_list_for_each_safe(device, tmp, &display->devices, link)
> +	destroy_device(device);
> +}
> +
> +static void
> +destroy_display(struct display *display)
> +{
> +	destroy_devices(display);
> +
> +	if (display->shm)
> +		wl_shm_destroy(display->shm);
> +
> +	if (display->shell)
> +		wl_shell_destroy(display->shell);
> +
> +	if (display->seat)
> +		wl_seat_destroy(display->seat);
> +
> +	if (display->compositor)
> +		wl_compositor_destroy(display->compositor);
> +
> +	wl_registry_destroy(display->registry);
> +	wl_display_flush(display->display);
> +	wl_display_disconnect(display->display);
> +	free(display);
> +}
> +
> +static int running = 1;
> +
> +static void
> +signal_int(int signum)
> +{
> +	running = 0;
> +}
> +
> +static int
> +create_device(struct display *display, const char *time_desc, int type)
> +{
> +	int start_time;
> +	int end_time = -1;
> +	char *tail;
> +	struct device *device;
> +
> +	if (time_desc == NULL) {
> +		fprintf(stderr, "missing time description\n");
> +		return -1;
> +	}
> +
> +	errno = 0;
> +	start_time = strtoul(time_desc, &tail, 10);
> +	if (errno)
> +		goto error;
> +
> +	if (*tail == ':') {
> +		end_time = strtoul(tail + 1, &tail, 10);
> +		if (errno || *tail != '\0')
> +			goto error;
> +	} else if (*tail != '\0') {
> +		goto error;
> +	}
> +
> +	device = malloc(sizeof *device);
> +	memset(device, 0, sizeof(*device));
> +	device->type = type;
> +	device->start_time = start_time;
> +	device->end_time = end_time;
> +	wl_list_insert(&display->devices, &device->link);
> +
> +	return 0;
> +
> +error:
> +	fprintf(stderr, "invalid time description\n");
> +	return -1;
> +}
> +
> +static struct timespec begin_time;
> +
> +static void
> +reset_timer(void)
> +{
> +	clock_gettime(CLOCK_MONOTONIC, &begin_time);
> +}
> +
> +static double
> +read_timer(void)
> +{
> +	struct timespec t;
> +
> +	clock_gettime(CLOCK_MONOTONIC, &t);
> +	return (double)(t.tv_sec - begin_time.tv_sec) +
> +	       1e-9 * (t.tv_nsec - begin_time.tv_nsec);
> +}
> +
> +static void
> +main_loop(struct display *display)
> +{
> +	reset_timer();
> +
> +	while (running) {
> +		struct device *device, *tmp;
> +		struct pollfd fds[1];
> +		double sleep_time = DBL_MAX;
> +		double now;
> +
> +		if (wl_display_dispatch_pending(display->display) == -1)
> +			break;
> +		if (wl_display_flush(display->display) == -1)
> +			break;
> +
> +		now = read_timer();
> +
> +		wl_list_for_each(device, &display->devices, link) {
> +			double next_time = device->start_time - now;
> +			if (next_time < 0.0) {
> +				sleep_time = 0.0;
> +				break;
> +			} else if (next_time < sleep_time) {
> +				sleep_time = next_time;
> +			}
> +			next_time = device->end_time - now;
> +			if (next_time < 0.0) {
> +				sleep_time = 0.0;
> +				break;
> +			} else if (next_time < sleep_time) {
> +				sleep_time = next_time;
> +			}
> +		}
> +
> +		fds[0].fd = wl_display_get_fd(display->display);
> +		fds[0].events = POLLIN;
> +		fds[0].revents = 0;
> +
> +		poll(fds,
> +		     sizeof fds / sizeof fds[0],
> +		     sleep_time == DBL_MAX ? -1 : ceil(sleep_time * 1000.0));
> +
> +		if (fds[0].revents &&
> +		    wl_display_dispatch(display->display) == -1)
> +			break;
> +
> +		now = read_timer();
> +
> +		wl_list_for_each_safe(device, tmp, &display->devices, link) {
> +			if (device->start_time <= now)
> +				start_device(display, device);
> +			if (device->end_time >= 0 && device->end_time <= now)
> +				destroy_device(device);
> +		}
> +	}
> +}
> +
> +int
> +main(int argc, char **argv)
> +{
> +	struct sigaction sigint;
> +	struct display *display;
> +	struct window *window;
> +	int i;
> +
> +	display = create_display();
> +	window = create_window(display, 250, 250);
> +	if (!window)
> +		return 1;
> +
> +	for (i = 1; i < argc; i++) {
> +		if (!strncmp(argv[i], "-p", 2)) {
> +			char *arg;
> +			if (argv[i][2]) {
> +				arg = argv[i] + 2;
> +			} else {
> +				arg = argv[i + 1];
> +				i++;
> +			}
> +			if (create_device(display, arg, POINTER) == -1)
> +				return 1;
> +		} else if (!strncmp(argv[i], "-k", 2)) {
> +			char *arg;
> +			if (argv[i][2]) {
> +				arg = argv[i] + 2;
> +			} else {
> +				arg = argv[i + 1];
> +				i++;
> +			}
> +			if (create_device(display, arg, KEYBOARD) == -1)
> +				return 1;
> +		} else {
> +			fprintf(stderr, "unknown argument %s\n", argv[i]);
> +			return 1;
> +		}
> +	}
> +
> +	sigint.sa_handler = signal_int;
> +	sigemptyset(&sigint.sa_mask);
> +	sigint.sa_flags = SA_RESETHAND;
> +	sigaction(SIGINT, &sigint, NULL);
> +
> +	main_loop(display);
> +
> +	fprintf(stderr, "multi-resource exiting\n");
> +	destroy_window(window);
> +	destroy_display(display);
> +
> +	return 0;
> +}
> -- 
> 1.8.3.1
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel


More information about the wayland-devel mailing list