wayland/src
Jonas Ådahl 493ab79bd2 proxy: Add API to tag proxy objects
When an application and a toolkit share the same Wayland connection,
it will receive events with each others objects. For example if the
toolkit manages a set of surfaces, and the application another set, if
both the toolkit and application listen to pointer focus events,
they'll receive focus events for each others surfaces.

In order for the toolkit and application layers to identify whether a
surface is managed by itself or not, it cannot only rely on retrieving
the proxy user data, without going through all it's own proxy objects
finding whether it's one of them.

By adding the ability to "tag" a proxy object, the toolkit and
application can use the tag to identify what the user data pointer
points to something known.

To create a tag, the recommended way is to define a statically allocated
constant char array containing some descriptive string. The tag will be
the pointer to the non-const pointer to the beginning of the array.

For example, to identify whether a focus event is for a surface managed
by the code in question:

	static const char *my_tag = "my tag";

	static void
	pointer_enter(void *data,
		      struct wl_pointer *wl_pointer,
		      uint32_t serial,
		      struct wl_surface *surface,
		      wl_fixed_t surface_x,
		      wl_fixed_t surface_y)
	{
		struct window *window;
		const char * const *tag;

		tag = wl_proxy_get_tag((struct wl_proxy *) surface);

		if (tag != &my_tag)
			return;

		window = wl_surface_get_user_data(surface);

		...
	}

	...

	static void
	init_window_surface(struct window *window)
	{
		struct wl_surface *surface;

		surface = wl_compositor_create_surface(compositor);
		wl_surface_set_user_data(surface, window);
		wl_proxy_set_tag((struct wl_proxy *) surface,
				 &my_tag);
	}

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2019-07-29 16:47:36 +00:00
..
.gitignore ignore: Add *.dtd.embed 2016-03-10 22:24:20 -08:00
connection.c connection: do not abort when dup(fd) fails 2019-07-09 17:30:13 +00:00
dtddata.S dtddata: Use standard permission notice 2017-01-26 14:49:55 +00:00
event-loop.c Use wl_container_of internally 2019-06-05 09:58:14 +00:00
scanner.c log: remove "%m" from format strings by using strerror(errno) 2019-05-02 22:14:53 +02:00
wayland-client-core.h proxy: Add API to tag proxy objects 2019-07-29 16:47:36 +00:00
wayland-client-uninstalled.pc.in build: remove white space in -uninstalled.pc.in files 2018-02-16 14:41:08 +00:00
wayland-client.c proxy: Add API to tag proxy objects 2019-07-29 16:47:36 +00:00
wayland-client.h doc: Formalize file comment in wayland-client.h, wayland-server.h 2016-05-11 11:03:27 -07:00
wayland-client.pc.in Export the Wayland protocol XML file 2013-09-21 21:48:56 -07:00
wayland-os.c src: Update boilerplate from MIT X11 license to MIT Expat license 2015-06-12 15:31:24 -07:00
wayland-os.h src: Update boilerplate from MIT X11 license to MIT Expat license 2015-06-12 15:31:24 -07:00
wayland-private.h Use wl_container_of internally 2019-06-05 09:58:14 +00:00
wayland-scanner-uninstalled.pc.in build: remove white space in -uninstalled.pc.in files 2018-02-16 14:41:08 +00:00
wayland-scanner.pc.in build: Add wayland-scanner.pc. 2013-07-03 16:38:12 -04:00
wayland-server-core.h proto, server: Add internal server error message. (v2) 2019-01-29 15:58:19 +02:00
wayland-server-uninstalled.pc.in build: remove white space in -uninstalled.pc.in files 2018-02-16 14:41:08 +00:00
wayland-server.c Use wl_container_of internally 2019-06-05 09:58:14 +00:00
wayland-server.h wayland-server: Finally remove deprecated struct wl_buffer definition 2018-07-25 12:08:16 -05:00
wayland-server.pc.in Export the Wayland protocol XML file 2013-09-21 21:48:56 -07:00
wayland-shm.c log: remove "%m" from format strings by using strerror(errno) 2019-05-02 22:14:53 +02:00
wayland-util.c Avoid pointer arithmetic on void * 2019-06-05 10:01:07 +00:00
wayland-util.h wayland-util.h: add forward declaration for wl_object 2019-03-07 11:33:26 +02:00
wayland-version.h.in src: Update boilerplate from MIT X11 license to MIT Expat license 2015-06-12 15:31:24 -07:00