mirror of
				https://codeberg.org/dwl/dwl-patches.git
				synced 2025-10-31 20:14:33 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			595 lines
		
	
	
		
			22 KiB
		
	
	
	
		
			Diff
		
	
	
	
	
	
			
		
		
	
	
			595 lines
		
	
	
		
			22 KiB
		
	
	
	
		
			Diff
		
	
	
	
	
	
| From 5bbb9d70ab0a8322d1556ac0983eb3140b1c5dcd Mon Sep 17 00:00:00 2001
 | |
| From: choc <notchoc@proton.me>
 | |
| Date: Mon, 23 Oct 2023 10:35:17 +0800
 | |
| Subject: [PATCH] implement dwl-ipc-unstable-v2
 | |
|  https://codeberg.org/dwl/dwl-patches/wiki/ipc
 | |
| 
 | |
| ---
 | |
|  Makefile                          |  13 +-
 | |
|  config.def.h                      |   1 +
 | |
|  dwl.c                             | 257 ++++++++++++++++++++++++++----
 | |
|  protocols/dwl-ipc-unstable-v2.xml | 181 +++++++++++++++++++++
 | |
|  4 files changed, 415 insertions(+), 37 deletions(-)
 | |
|  create mode 100644 protocols/dwl-ipc-unstable-v2.xml
 | |
| 
 | |
| diff --git a/Makefile b/Makefile
 | |
| index a67fdd3..2b45b2c 100644
 | |
| --- a/Makefile
 | |
| +++ b/Makefile
 | |
| @@ -14,10 +14,11 @@ DWLCFLAGS = `$(PKG_CONFIG) --cflags $(PKGS)` $(DWLCPPFLAGS) $(DWLDEVCFLAGS) $(CF
 | |
|  LDLIBS    = `$(PKG_CONFIG) --libs $(PKGS)` $(LIBS)
 | |
|  
 | |
|  all: dwl
 | |
| -dwl: dwl.o util.o
 | |
| -	$(CC) dwl.o util.o $(LDLIBS) $(LDFLAGS) $(DWLCFLAGS) -o $@
 | |
| -dwl.o: dwl.c config.mk config.h client.h cursor-shape-v1-protocol.h pointer-constraints-unstable-v1-protocol.h wlr-layer-shell-unstable-v1-protocol.h xdg-shell-protocol.h
 | |
| +dwl: dwl.o util.o dwl-ipc-unstable-v2-protocol.o
 | |
| +	$(CC) dwl.o util.o dwl-ipc-unstable-v2-protocol.o $(LDLIBS) $(LDFLAGS) $(DWLCFLAGS) -o $@
 | |
| +dwl.o: dwl.c config.mk config.h client.h cursor-shape-v1-protocol.h pointer-constraints-unstable-v1-protocol.h wlr-layer-shell-unstable-v1-protocol.h xdg-shell-protocol.h dwl-ipc-unstable-v2-protocol.h
 | |
|  util.o: util.c util.h
 | |
| +dwl-ipc-unstable-v2-protocol.o: dwl-ipc-unstable-v2-protocol.c dwl-ipc-unstable-v2-protocol.h
 | |
|  
 | |
|  # wayland-scanner is a tool which generates C headers and rigging for Wayland
 | |
|  # protocols, which are specified in XML. wlroots requires you to rig these up
 | |
| @@ -37,6 +38,12 @@ wlr-layer-shell-unstable-v1-protocol.h:
 | |
|  xdg-shell-protocol.h:
 | |
|  	$(WAYLAND_SCANNER) server-header \
 | |
|  		$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
 | |
| +dwl-ipc-unstable-v2-protocol.h:
 | |
| +	$(WAYLAND_SCANNER) server-header \
 | |
| +		protocols/dwl-ipc-unstable-v2.xml $@
 | |
| +dwl-ipc-unstable-v2-protocol.c:
 | |
| +	$(WAYLAND_SCANNER) private-code \
 | |
| +		protocols/dwl-ipc-unstable-v2.xml $@
 | |
|  
 | |
|  config.h:
 | |
|  	cp config.def.h $@
 | |
| diff --git a/config.def.h b/config.def.h
 | |
| index 9009517..3467fed 100644
 | |
| --- a/config.def.h
 | |
| +++ b/config.def.h
 | |
| @@ -122,6 +122,7 @@ static const Key keys[] = {
 | |
|  	/* modifier                  key                 function        argument */
 | |
|  	{ MODKEY,                    XKB_KEY_p,          spawn,          {.v = menucmd} },
 | |
|  	{ MODKEY|WLR_MODIFIER_SHIFT, XKB_KEY_Return,     spawn,          {.v = termcmd} },
 | |
| +	{ MODKEY,                    XKB_KEY_b,          togglebar,      {0} },
 | |
|  	{ MODKEY,                    XKB_KEY_j,          focusstack,     {.i = +1} },
 | |
|  	{ MODKEY,                    XKB_KEY_k,          focusstack,     {.i = -1} },
 | |
|  	{ MODKEY,                    XKB_KEY_i,          incnmaster,     {.i = +1} },
 | |
| diff --git a/dwl.c b/dwl.c
 | |
| index d508d79..5f8af37 100644
 | |
| --- a/dwl.c
 | |
| +++ b/dwl.c
 | |
| @@ -64,6 +64,7 @@
 | |
|  #include <xcb/xcb_icccm.h>
 | |
|  #endif
 | |
|  
 | |
| +#include "dwl-ipc-unstable-v2-protocol.h"
 | |
|  #include "util.h"
 | |
|  
 | |
|  /* macros */
 | |
| @@ -141,6 +142,12 @@ typedef struct {
 | |
|  	uint32_t resize; /* configure serial of a pending resize */
 | |
|  } Client;
 | |
|  
 | |
| +typedef struct {
 | |
| +	struct wl_list link;
 | |
| +	struct wl_resource *resource;
 | |
| +	Monitor *mon;
 | |
| +} DwlIpcOutput;
 | |
| +
 | |
|  typedef struct {
 | |
|  	uint32_t mod;
 | |
|  	xkb_keysym_t keysym;
 | |
| @@ -186,6 +193,7 @@ typedef struct {
 | |
|  
 | |
|  struct Monitor {
 | |
|  	struct wl_list link;
 | |
| +	struct wl_list dwl_ipc_outputs;
 | |
|  	struct wlr_output *wlr_output;
 | |
|  	struct wlr_scene_output *scene_output;
 | |
|  	struct wlr_scene_rect *fullscreen_bg; /* See createmon() for info */
 | |
| @@ -278,6 +286,17 @@ static void destroypointerconstraint(struct wl_listener *listener, void *data);
 | |
|  static void destroysessionlock(struct wl_listener *listener, void *data);
 | |
|  static void destroysessionmgr(struct wl_listener *listener, void *data);
 | |
|  static Monitor *dirtomon(enum wlr_direction dir);
 | |
| +static void dwl_ipc_manager_bind(struct wl_client *client, void *data, uint32_t version, uint32_t id);
 | |
| +static void dwl_ipc_manager_destroy(struct wl_resource *resource);
 | |
| +static void dwl_ipc_manager_get_output(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *output);
 | |
| +static void dwl_ipc_manager_release(struct wl_client *client, struct wl_resource *resource);
 | |
| +static void dwl_ipc_output_destroy(struct wl_resource *resource);
 | |
| +static void dwl_ipc_output_printstatus(Monitor *monitor);
 | |
| +static void dwl_ipc_output_printstatus_to(DwlIpcOutput *ipc_output);
 | |
| +static void dwl_ipc_output_set_client_tags(struct wl_client *client, struct wl_resource *resource, uint32_t and_tags, uint32_t xor_tags);
 | |
| +static void dwl_ipc_output_set_layout(struct wl_client *client, struct wl_resource *resource, uint32_t index);
 | |
| +static void dwl_ipc_output_set_tags(struct wl_client *client, struct wl_resource *resource, uint32_t tagmask, uint32_t toggle_tagset);
 | |
| +static void dwl_ipc_output_release(struct wl_client *client, struct wl_resource *resource);
 | |
|  static void focusclient(Client *c, int lift);
 | |
|  static void focusmon(const Arg *arg);
 | |
|  static void focusstack(const Arg *arg);
 | |
| @@ -330,6 +349,7 @@ static void startdrag(struct wl_listener *listener, void *data);
 | |
|  static void tag(const Arg *arg);
 | |
|  static void tagmon(const Arg *arg);
 | |
|  static void tile(Monitor *m);
 | |
| +static void togglebar(const Arg *arg);
 | |
|  static void togglefloating(const Arg *arg);
 | |
|  static void togglefullscreen(const Arg *arg);
 | |
|  static void toggletag(const Arg *arg);
 | |
| @@ -405,6 +425,9 @@ static struct wlr_box sgeom;
 | |
|  static struct wl_list mons;
 | |
|  static Monitor *selmon;
 | |
|  
 | |
| +static struct zdwl_ipc_manager_v2_interface dwl_manager_implementation = {.release = dwl_ipc_manager_release, .get_output = dwl_ipc_manager_get_output};
 | |
| +static struct zdwl_ipc_output_v2_interface dwl_output_implementation = {.release = dwl_ipc_output_release, .set_tags = dwl_ipc_output_set_tags, .set_layout = dwl_ipc_output_set_layout, .set_client_tags = dwl_ipc_output_set_client_tags};
 | |
| +
 | |
|  #ifdef XWAYLAND
 | |
|  static void activatex11(struct wl_listener *listener, void *data);
 | |
|  static void associatex11(struct wl_listener *listener, void *data);
 | |
| @@ -684,6 +707,10 @@ cleanupmon(struct wl_listener *listener, void *data)
 | |
|  	LayerSurface *l, *tmp;
 | |
|  	size_t i;
 | |
|  
 | |
| +	DwlIpcOutput *ipc_output, *ipc_output_tmp;
 | |
| +	wl_list_for_each_safe(ipc_output, ipc_output_tmp, &m->dwl_ipc_outputs, link)
 | |
| +		wl_resource_destroy(ipc_output->resource);
 | |
| +
 | |
|  	/* m->layers[i] are intentionally not unlinked */
 | |
|  	for (i = 0; i < LENGTH(m->layers); i++) {
 | |
|  		wl_list_for_each_safe(l, tmp, &m->layers[i], link)
 | |
| @@ -876,6 +903,8 @@ createmon(struct wl_listener *listener, void *data)
 | |
|  	m = wlr_output->data = ecalloc(1, sizeof(*m));
 | |
|  	m->wlr_output = wlr_output;
 | |
|  
 | |
| +	wl_list_init(&m->dwl_ipc_outputs);
 | |
| +
 | |
|  	for (i = 0; i < LENGTH(m->layers); i++)
 | |
|  		wl_list_init(&m->layers[i]);
 | |
|  
 | |
| @@ -1233,6 +1262,190 @@ dirtomon(enum wlr_direction dir)
 | |
|  	return selmon;
 | |
|  }
 | |
|  
 | |
| +void
 | |
| +dwl_ipc_manager_bind(struct wl_client *client, void *data, uint32_t version, uint32_t id)
 | |
| +{
 | |
| +	struct wl_resource *manager_resource = wl_resource_create(client, &zdwl_ipc_manager_v2_interface, version, id);
 | |
| +	if (!manager_resource) {
 | |
| +		wl_client_post_no_memory(client);
 | |
| +		return;
 | |
| +	}
 | |
| +	wl_resource_set_implementation(manager_resource, &dwl_manager_implementation, NULL, dwl_ipc_manager_destroy);
 | |
| +
 | |
| +	zdwl_ipc_manager_v2_send_tags(manager_resource, TAGCOUNT);
 | |
| +
 | |
| +	for (unsigned int i = 0; i < LENGTH(layouts); i++)
 | |
| +		zdwl_ipc_manager_v2_send_layout(manager_resource, layouts[i].symbol);
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_manager_destroy(struct wl_resource *resource)
 | |
| +{
 | |
| +	/* No state to destroy */
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_manager_get_output(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *output)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	Monitor *monitor = wlr_output_from_resource(output)->data;
 | |
| +	struct wl_resource *output_resource = wl_resource_create(client, &zdwl_ipc_output_v2_interface, wl_resource_get_version(resource), id);
 | |
| +	if (!output_resource)
 | |
| +		return;
 | |
| +
 | |
| +	ipc_output = ecalloc(1, sizeof(*ipc_output));
 | |
| +	ipc_output->resource = output_resource;
 | |
| +	ipc_output->mon = monitor;
 | |
| +	wl_resource_set_implementation(output_resource, &dwl_output_implementation, ipc_output, dwl_ipc_output_destroy);
 | |
| +	wl_list_insert(&monitor->dwl_ipc_outputs, &ipc_output->link);
 | |
| +	dwl_ipc_output_printstatus_to(ipc_output);
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_manager_release(struct wl_client *client, struct wl_resource *resource)
 | |
| +{
 | |
| +	wl_resource_destroy(resource);
 | |
| +}
 | |
| +
 | |
| +static void
 | |
| +dwl_ipc_output_destroy(struct wl_resource *resource)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output = wl_resource_get_user_data(resource);
 | |
| +	wl_list_remove(&ipc_output->link);
 | |
| +	free(ipc_output);
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_printstatus(Monitor *monitor)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	wl_list_for_each(ipc_output, &monitor->dwl_ipc_outputs, link)
 | |
| +		dwl_ipc_output_printstatus_to(ipc_output);
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_printstatus_to(DwlIpcOutput *ipc_output)
 | |
| +{
 | |
| +	Monitor *monitor = ipc_output->mon;
 | |
| +	Client *c, *focused;
 | |
| +	int tagmask, state, numclients, focused_client, tag;
 | |
| +	const char *title, *appid;
 | |
| +	focused = focustop(monitor);
 | |
| +	zdwl_ipc_output_v2_send_active(ipc_output->resource, monitor == selmon);
 | |
| +
 | |
| +	for (tag = 0 ; tag < TAGCOUNT; tag++) {
 | |
| +		numclients = state = focused_client = 0;
 | |
| +		tagmask = 1 << tag;
 | |
| +		if ((tagmask & monitor->tagset[monitor->seltags]) != 0)
 | |
| +			state |= ZDWL_IPC_OUTPUT_V2_TAG_STATE_ACTIVE;
 | |
| +
 | |
| +		wl_list_for_each(c, &clients, link) {
 | |
| +			if (c->mon != monitor)
 | |
| +				continue;
 | |
| +			if (!(c->tags & tagmask))
 | |
| +				continue;
 | |
| +			if (c == focused)
 | |
| +				focused_client = 1;
 | |
| +			if (c->isurgent)
 | |
| +				state |= ZDWL_IPC_OUTPUT_V2_TAG_STATE_URGENT;
 | |
| +
 | |
| +			numclients++;
 | |
| +		}
 | |
| +		zdwl_ipc_output_v2_send_tag(ipc_output->resource, tag, state, numclients, focused_client);
 | |
| +	}
 | |
| +	title = focused ? client_get_title(focused) : "";
 | |
| +	appid = focused ? client_get_appid(focused) : "";
 | |
| +
 | |
| +	zdwl_ipc_output_v2_send_layout(ipc_output->resource, monitor->lt[monitor->sellt] - layouts);
 | |
| +	zdwl_ipc_output_v2_send_title(ipc_output->resource, title ? title : broken);
 | |
| +	zdwl_ipc_output_v2_send_appid(ipc_output->resource, appid ? appid : broken);
 | |
| +	zdwl_ipc_output_v2_send_layout_symbol(ipc_output->resource, monitor->ltsymbol);
 | |
| +	if (wl_resource_get_version(ipc_output->resource) >= ZDWL_IPC_OUTPUT_V2_FULLSCREEN_SINCE_VERSION) {
 | |
| +		zdwl_ipc_output_v2_send_fullscreen(ipc_output->resource, focused ? focused->isfullscreen : 0);
 | |
| +	}
 | |
| +	if (wl_resource_get_version(ipc_output->resource) >= ZDWL_IPC_OUTPUT_V2_FLOATING_SINCE_VERSION) {
 | |
| +		zdwl_ipc_output_v2_send_floating(ipc_output->resource, focused ? focused->isfloating : 0);
 | |
| +	}
 | |
| +	zdwl_ipc_output_v2_send_frame(ipc_output->resource);
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_set_client_tags(struct wl_client *client, struct wl_resource *resource, uint32_t and_tags, uint32_t xor_tags)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	Monitor *monitor;
 | |
| +	Client *selected_client;
 | |
| +	unsigned int newtags = 0;
 | |
| +
 | |
| +	ipc_output = wl_resource_get_user_data(resource);
 | |
| +	if (!ipc_output)
 | |
| +		return;
 | |
| +
 | |
| +	monitor = ipc_output->mon;
 | |
| +	selected_client = focustop(monitor);
 | |
| +	if (!selected_client)
 | |
| +		return;
 | |
| +
 | |
| +	newtags = (selected_client->tags & and_tags) ^ xor_tags;
 | |
| +	if (!newtags)
 | |
| +		return;
 | |
| +
 | |
| +	selected_client->tags = newtags;
 | |
| +	focusclient(focustop(selmon), 1);
 | |
| +	arrange(selmon);
 | |
| +	printstatus();
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_set_layout(struct wl_client *client, struct wl_resource *resource, uint32_t index)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	Monitor *monitor;
 | |
| +
 | |
| +	ipc_output = wl_resource_get_user_data(resource);
 | |
| +	if (!ipc_output)
 | |
| +		return;
 | |
| +
 | |
| +	monitor = ipc_output->mon;
 | |
| +	if (index >= LENGTH(layouts))
 | |
| +		return;
 | |
| +	if (index != monitor->lt[monitor->sellt] - layouts)
 | |
| +		monitor->sellt ^= 1;
 | |
| +
 | |
| +	monitor->lt[monitor->sellt] = &layouts[index];
 | |
| +	arrange(monitor);
 | |
| +	printstatus();
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_set_tags(struct wl_client *client, struct wl_resource *resource, uint32_t tagmask, uint32_t toggle_tagset)
 | |
| +{
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	Monitor *monitor;
 | |
| +	unsigned int newtags = tagmask & TAGMASK;
 | |
| +
 | |
| +	ipc_output = wl_resource_get_user_data(resource);
 | |
| +	if (!ipc_output)
 | |
| +		return;
 | |
| +	monitor = ipc_output->mon;
 | |
| +
 | |
| +	if (!newtags || newtags == monitor->tagset[monitor->seltags])
 | |
| +		return;
 | |
| +	if (toggle_tagset)
 | |
| +		monitor->seltags ^= 1;
 | |
| +
 | |
| +	monitor->tagset[monitor->seltags] = newtags;
 | |
| +	focusclient(focustop(monitor), 1);
 | |
| +	arrange(monitor);
 | |
| +	printstatus();
 | |
| +}
 | |
| +
 | |
| +void
 | |
| +dwl_ipc_output_release(struct wl_client *client, struct wl_resource *resource)
 | |
| +{
 | |
| +	wl_resource_destroy(resource);
 | |
| +}
 | |
| +
 | |
|  void
 | |
|  focusclient(Client *c, int lift)
 | |
|  {
 | |
| @@ -1905,41 +2118,9 @@ void
 | |
|  printstatus(void)
 | |
|  {
 | |
|  	Monitor *m = NULL;
 | |
| -	Client *c;
 | |
| -	uint32_t occ, urg, sel;
 | |
| -	const char *appid, *title;
 | |
|  
 | |
| -	wl_list_for_each(m, &mons, link) {
 | |
| -		occ = urg = 0;
 | |
| -		wl_list_for_each(c, &clients, link) {
 | |
| -			if (c->mon != m)
 | |
| -				continue;
 | |
| -			occ |= c->tags;
 | |
| -			if (c->isurgent)
 | |
| -				urg |= c->tags;
 | |
| -		}
 | |
| -		if ((c = focustop(m))) {
 | |
| -			title = client_get_title(c);
 | |
| -			appid = client_get_appid(c);
 | |
| -			printf("%s title %s\n", m->wlr_output->name, title ? title : broken);
 | |
| -			printf("%s appid %s\n", m->wlr_output->name, appid ? appid : broken);
 | |
| -			printf("%s fullscreen %d\n", m->wlr_output->name, c->isfullscreen);
 | |
| -			printf("%s floating %d\n", m->wlr_output->name, c->isfloating);
 | |
| -			sel = c->tags;
 | |
| -		} else {
 | |
| -			printf("%s title \n", m->wlr_output->name);
 | |
| -			printf("%s appid \n", m->wlr_output->name);
 | |
| -			printf("%s fullscreen \n", m->wlr_output->name);
 | |
| -			printf("%s floating \n", m->wlr_output->name);
 | |
| -			sel = 0;
 | |
| -		}
 | |
| -
 | |
| -		printf("%s selmon %u\n", m->wlr_output->name, m == selmon);
 | |
| -		printf("%s tags %"PRIu32" %"PRIu32" %"PRIu32" %"PRIu32"\n",
 | |
| -			m->wlr_output->name, occ, m->tagset[m->seltags], sel, urg);
 | |
| -		printf("%s layout %s\n", m->wlr_output->name, m->ltsymbol);
 | |
| -	}
 | |
| -	fflush(stdout);
 | |
| +	wl_list_for_each(m, &mons, link)
 | |
| +		dwl_ipc_output_printstatus(m);
 | |
|  }
 | |
|  
 | |
|  void
 | |
| @@ -2502,6 +2683,7 @@ setup(void)
 | |
|  	LISTEN_STATIC(&output_mgr->events.test, outputmgrtest);
 | |
|  
 | |
|  	wlr_scene_set_presentation(scene, wlr_presentation_create(dpy, backend));
 | |
| +	wl_global_create(dpy, &zdwl_ipc_manager_v2_interface, 2, NULL, dwl_ipc_manager_bind);
 | |
|  
 | |
|  	/* Make sure XWayland clients don't connect to the parent X server,
 | |
|  	 * e.g when running in the x11 backend or the wayland backend and the
 | |
| @@ -2600,6 +2782,13 @@ tile(Monitor *m)
 | |
|  	}
 | |
|  }
 | |
|  
 | |
| +void
 | |
| +togglebar(const Arg *arg) {
 | |
| +	DwlIpcOutput *ipc_output;
 | |
| +	wl_list_for_each(ipc_output, &selmon->dwl_ipc_outputs, link)
 | |
| +		zdwl_ipc_output_v2_send_toggle_visibility(ipc_output->resource);
 | |
| +}
 | |
| +
 | |
|  void
 | |
|  togglefloating(const Arg *arg)
 | |
|  {
 | |
| diff --git a/protocols/dwl-ipc-unstable-v2.xml b/protocols/dwl-ipc-unstable-v2.xml
 | |
| new file mode 100644
 | |
| index 0000000..0a6e7e5
 | |
| --- /dev/null
 | |
| +++ b/protocols/dwl-ipc-unstable-v2.xml
 | |
| @@ -0,0 +1,181 @@
 | |
| +<?xml version="1.0" encoding="utf-8"?>
 | |
| +<!--
 | |
| +This is largely ripped from somebar's ipc patchset; just with some personal modifications.
 | |
| +I would probably just submit raphi's patchset but I don't think that would be polite.
 | |
| +-->
 | |
| +<protocol name="dwl_ipc_unstable_v2">
 | |
| +  <description summary="inter-proccess-communication about dwl's state">
 | |
| +      This protocol allows clients to update and get updates from dwl.
 | |
| +
 | |
| +      Warning! The protocol described in this file is experimental and
 | |
| +      backward incompatible changes may be made. Backward compatible
 | |
| +      changes may be added together with the corresponding interface
 | |
| +      version bump.
 | |
| +      Backward incompatible changes are done by bumping the version
 | |
| +      number in the protocol and interface names and resetting the
 | |
| +      interface version. Once the protocol is to be declared stable,
 | |
| +      the 'z' prefix and the version number in the protocol and
 | |
| +      interface names are removed and the interface version number is
 | |
| +      reset.
 | |
| +  </description>
 | |
| +
 | |
| +  <interface name="zdwl_ipc_manager_v2" version="2">
 | |
| +    <description summary="manage dwl state">
 | |
| +      This interface is exposed as a global in wl_registry.
 | |
| +
 | |
| +      Clients can use this interface to get a dwl_ipc_output.
 | |
| +      After binding the client will recieve the dwl_ipc_manager.tags and dwl_ipc_manager.layout events.
 | |
| +      The dwl_ipc_manager.tags and dwl_ipc_manager.layout events expose tags and layouts to the client.
 | |
| +    </description>
 | |
| +
 | |
| +    <request name="release" type="destructor">
 | |
| +      <description summary="release dwl_ipc_manager">
 | |
| +        Indicates that the client will not the dwl_ipc_manager object anymore.
 | |
| +        Objects created through this instance are not affected.
 | |
| +      </description>
 | |
| +    </request>
 | |
| +
 | |
| +    <request name="get_output">
 | |
| +      <description summary="get a dwl_ipc_outout for a wl_output">
 | |
| +        Get a dwl_ipc_outout for the specified wl_output.
 | |
| +      </description>
 | |
| +      <arg name="id" type="new_id" interface="zdwl_ipc_output_v2"/>
 | |
| +      <arg name="output" type="object" interface="wl_output"/>
 | |
| +    </request>
 | |
| +
 | |
| +    <event name="tags">
 | |
| +      <description summary="Announces tag amount">
 | |
| +        This event is sent after binding.
 | |
| +        A roundtrip after binding guarantees the client recieved all tags.
 | |
| +      </description>
 | |
| +      <arg name="amount" type="uint"/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="layout">
 | |
| +      <description summary="Announces a layout">
 | |
| +        This event is sent after binding.
 | |
| +        A roundtrip after binding guarantees the client recieved all layouts.
 | |
| +      </description>
 | |
| +      <arg name="name" type="string"/>
 | |
| +    </event>
 | |
| +  </interface>
 | |
| +
 | |
| +  <interface name="zdwl_ipc_output_v2" version="2">
 | |
| +    <description summary="control dwl output">
 | |
| +      Observe and control a dwl output.
 | |
| +
 | |
| +      Events are double-buffered:
 | |
| +      Clients should cache events and redraw when a dwl_ipc_output.frame event is sent.
 | |
| +
 | |
| +      Request are not double-buffered:
 | |
| +      The compositor will update immediately upon request.
 | |
| +    </description>
 | |
| +
 | |
| +    <enum name="tag_state">
 | |
| +      <entry name="none" value="0" summary="no state"/>
 | |
| +      <entry name="active" value="1" summary="tag is active"/>
 | |
| +      <entry name="urgent" value="2" summary="tag has at least one urgent client"/>
 | |
| +    </enum>
 | |
| +
 | |
| +    <request name="release" type="destructor">
 | |
| +      <description summary="release dwl_ipc_outout">
 | |
| +        Indicates to that the client no longer needs this dwl_ipc_output.
 | |
| +      </description>
 | |
| +    </request>
 | |
| +
 | |
| +    <event name="toggle_visibility">
 | |
| +      <description summary="Toggle client visibilty">
 | |
| +        Indicates the client should hide or show themselves.
 | |
| +        If the client is visible then hide, if hidden then show.
 | |
| +      </description>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="active">
 | |
| +      <description summary="Update the selected output.">
 | |
| +        Indicates if the output is active. Zero is invalid, nonzero is valid.
 | |
| +      </description>
 | |
| +      <arg name="active" type="uint"/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="tag">
 | |
| +      <description summary="Update the state of a tag.">
 | |
| +        Indicates that a tag has been updated.
 | |
| +      </description>
 | |
| +      <arg name="tag" type="uint" summary="Index of the tag"/>
 | |
| +      <arg name="state" type="uint" enum="tag_state" summary="The state of the tag."/>
 | |
| +      <arg name="clients" type="uint" summary="The number of clients in the tag."/>
 | |
| +      <arg name="focused" type="uint" summary="If there is a focused client. Nonzero being valid, zero being invalid."/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="layout">
 | |
| +      <description summary="Update the layout.">
 | |
| +        Indicates a new layout is selected.
 | |
| +      </description>
 | |
| +      <arg name="layout" type="uint" summary="Index of the layout."/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="title">
 | |
| +      <description summary="Update the title.">
 | |
| +        Indicates the title has changed.
 | |
| +      </description>
 | |
| +      <arg name="title" type="string" summary="The new title name."/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="appid" since="1">
 | |
| +      <description summary="Update the appid.">
 | |
| +        Indicates the appid has changed.
 | |
| +      </description>
 | |
| +      <arg name="appid" type="string" summary="The new appid."/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="layout_symbol" since="1">
 | |
| +      <description summary="Update the current layout symbol">
 | |
| +          Indicates the layout has changed. Since layout symbols are dynamic.
 | |
| +          As opposed to the zdwl_ipc_manager.layout event, this should take precendence when displaying.
 | |
| +          You can ignore the zdwl_ipc_output.layout event.
 | |
| +      </description>
 | |
| +      <arg name="layout" type="string" summary="The new layout"/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="frame">
 | |
| +      <description summary="The update sequence is done.">
 | |
| +        Indicates that a sequence of status updates have finished and the client should redraw.
 | |
| +      </description>
 | |
| +    </event>
 | |
| +
 | |
| +    <request name="set_tags">
 | |
| +      <description summary="Set the active tags of this output"/>
 | |
| +      <arg name="tagmask" type="uint" summary="bitmask of the tags that should be set."/>
 | |
| +      <arg name="toggle_tagset" type="uint" summary="toggle the selected tagset, zero for invalid, nonzero for valid."/>
 | |
| +    </request>
 | |
| +
 | |
| +    <request name="set_client_tags">
 | |
| +      <description summary="Set the tags of the focused client.">
 | |
| +        The tags are updated as follows:
 | |
| +        new_tags = (current_tags AND and_tags) XOR xor_tags
 | |
| +      </description>
 | |
| +      <arg name="and_tags" type="uint"/>
 | |
| +      <arg name="xor_tags" type="uint"/>
 | |
| +    </request>
 | |
| +
 | |
| +    <request name="set_layout">
 | |
| +      <description summary="Set the layout of this output"/>
 | |
| +      <arg name="index" type="uint" summary="index of a layout recieved by dwl_ipc_manager.layout"/>
 | |
| +    </request>
 | |
| +
 | |
| +    <!-- Version 2 -->
 | |
| +    <event name="fullscreen" since="2">
 | |
| +      <description summary="Update fullscreen status">
 | |
| +          Indicates if the selected client on this output is fullscreen.
 | |
| +      </description>
 | |
| +      <arg name="is_fullscreen" type="uint" summary="If the selected client is fullscreen. Nonzero is valid, zero invalid"/>
 | |
| +    </event>
 | |
| +
 | |
| +    <event name="floating" since="2">
 | |
| +      <description summary="Update the floating status">
 | |
| +          Indicates if the selected client on this output is floating.
 | |
| +      </description>
 | |
| +      <arg name="is_floating" type="uint" summary="If the selected client is floating. Nonzero is valid, zero invalid"/>
 | |
| +    </event>
 | |
| +  </interface>
 | |
| +</protocol>
 | |
| -- 
 | |
| 2.44.0
 | |
| 
 | 
