2 #define I3__FILE__ "ewmh.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
9 * ewmh.c: Get/set certain EWMH properties easily.
14 xcb_window_t ewmh_window;
17 * Updates _NET_CURRENT_DESKTOP with the current desktop number.
19 * EWMH: The index of the current desktop. This is always an integer between 0
20 * and _NET_NUMBER_OF_DESKTOPS - 1.
23 void ewmh_update_current_desktop(void) {
24 const uint32_t idx = ewmh_get_workspace_index(focused);
25 if (idx != NET_WM_DESKTOP_NONE) {
26 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A__NET_CURRENT_DESKTOP, XCB_ATOM_CARDINAL, 32, 1, &idx);
31 * Updates _NET_NUMBER_OF_DESKTOPS which we interpret as the number of
32 * noninternal workspaces.
34 void ewmh_update_number_of_desktops(void) {
38 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
40 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
41 if (STARTS_WITH(ws->name, "__"))
47 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root,
48 A__NET_NUMBER_OF_DESKTOPS, XCB_ATOM_CARDINAL, 32, 1, &idx);
52 * Updates _NET_DESKTOP_NAMES: "The names of all virtual desktops. This is a
53 * list of NULL-terminated strings in UTF-8 encoding"
55 void ewmh_update_desktop_names(void) {
59 /* count the size of the property message to set */
60 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
62 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
63 if (STARTS_WITH(ws->name, "__"))
65 msg_length += strlen(ws->name) + 1;
69 char desktop_names[msg_length];
70 int current_position = 0;
72 /* fill the buffer with the names of the i3 workspaces */
73 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
75 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
76 if (STARTS_WITH(ws->name, "__"))
79 for (size_t i = 0; i < strlen(ws->name) + 1; i++) {
80 desktop_names[current_position++] = ws->name[i];
85 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root,
86 A__NET_DESKTOP_NAMES, A_UTF8_STRING, 8, msg_length, desktop_names);
90 * Updates _NET_DESKTOP_VIEWPORT, which is an array of pairs of cardinals that
91 * define the top left corner of each desktop's viewport.
93 void ewmh_update_desktop_viewport(void) {
96 /* count number of desktops */
97 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
99 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
100 if (STARTS_WITH(ws->name, "__"))
107 uint32_t viewports[num_desktops * 2];
109 int current_position = 0;
110 /* fill the viewport buffer */
111 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
113 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
114 if (STARTS_WITH(ws->name, "__"))
117 viewports[current_position++] = output->rect.x;
118 viewports[current_position++] = output->rect.y;
122 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root,
123 A__NET_DESKTOP_VIEWPORT, XCB_ATOM_CARDINAL, 32, current_position, &viewports);
126 static void ewmh_update_wm_desktop_recursively(Con *con, const uint32_t desktop) {
127 /* Recursively call this to descend through the entire subtree. */
129 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
130 ewmh_update_wm_desktop_recursively(child, desktop);
132 /* If con is a workspace, we also need to go through the floating windows on it. */
133 if (con->type == CT_WORKSPACE) {
134 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
135 ewmh_update_wm_desktop_recursively(child, desktop);
139 if (!con_has_managed_window(con))
142 const xcb_window_t window = con->window->id;
144 uint32_t wm_desktop = desktop;
145 /* Sticky windows are only actually sticky when they are floating or inside
146 * a floating container. This is technically still slightly wrong, since
147 * sticky windows will only be on all workspaces on this output, but we
148 * ignore multi-monitor situations for this since the spec isn't too
149 * precise on this anyway. */
150 if (con_is_sticky(con) && con_is_floating(con)) {
151 wm_desktop = NET_WM_DESKTOP_ALL;
154 /* If this is the cached value, we don't need to do anything. */
155 if (con->window->wm_desktop == wm_desktop)
157 con->window->wm_desktop = wm_desktop;
159 if (wm_desktop != NET_WM_DESKTOP_NONE) {
160 DLOG("Setting _NET_WM_DESKTOP = %d for window 0x%08x.\n", wm_desktop, window);
161 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, A__NET_WM_DESKTOP, XCB_ATOM_CARDINAL, 32, 1, &wm_desktop);
163 /* If we can't determine the workspace index, delete the property. We'd
164 * rather not set it than lie. */
165 ELOG("Failed to determine the proper EWMH desktop index for window 0x%08x, deleting _NET_WM_DESKTOP.\n", window);
166 xcb_delete_property(conn, window, A__NET_WM_DESKTOP);
171 * Updates _NET_WM_DESKTOP for all windows.
172 * A request will only be made if the cached value differs from the calculated value.
175 void ewmh_update_wm_desktop(void) {
176 uint32_t desktop = 0;
179 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
181 TAILQ_FOREACH(workspace, &(output_get_content(output)->nodes_head), nodes) {
182 if (con_is_internal(workspace))
185 ewmh_update_wm_desktop_recursively(workspace, desktop);
192 * Updates _NET_ACTIVE_WINDOW with the currently focused window.
194 * EWMH: The window ID of the currently active window or None if no window has
198 void ewmh_update_active_window(xcb_window_t window) {
199 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root,
200 A__NET_ACTIVE_WINDOW, XCB_ATOM_WINDOW, 32, 1, &window);
204 * Updates _NET_WM_VISIBLE_NAME.
207 void ewmh_update_visible_name(xcb_window_t window, const char *name) {
209 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, A__NET_WM_VISIBLE_NAME, A_UTF8_STRING, 8, strlen(name), name);
211 xcb_delete_property(conn, window, A__NET_WM_VISIBLE_NAME);
216 * i3 currently does not support _NET_WORKAREA, because it does not correspond
217 * to i3’s concept of workspaces. See also:
218 * http://bugs.i3wm.org/539
219 * http://bugs.i3wm.org/301
220 * http://bugs.i3wm.org/1038
222 * We need to actively delete this property because some display managers (e.g.
225 * EWMH: Contains a geometry for each desktop. These geometries specify an area
226 * that is completely contained within the viewport. Work area SHOULD be used by
227 * desktop applications to place desktop icons appropriately.
230 void ewmh_update_workarea(void) {
231 xcb_delete_property(conn, root, A__NET_WORKAREA);
235 * Updates the _NET_CLIENT_LIST hint.
238 void ewmh_update_client_list(xcb_window_t *list, int num_windows) {
241 XCB_PROP_MODE_REPLACE,
251 * Updates the _NET_CLIENT_LIST_STACKING hint.
254 void ewmh_update_client_list_stacking(xcb_window_t *stack, int num_windows) {
257 XCB_PROP_MODE_REPLACE,
259 A__NET_CLIENT_LIST_STACKING,
267 * Set or remove _NET_WM_STATE_STICKY on the window.
270 void ewmh_update_sticky(xcb_window_t window, bool sticky) {
272 DLOG("Setting _NET_WM_STATE_STICKY for window = %d.\n", window);
273 xcb_add_property_atom(conn, window, A__NET_WM_STATE, A__NET_WM_STATE_STICKY);
275 DLOG("Removing _NET_WM_STATE_STICKY for window = %d.\n", window);
276 xcb_remove_property_atom(conn, window, A__NET_WM_STATE, A__NET_WM_STATE_STICKY);
281 * Set up the EWMH hints on the root window.
284 void ewmh_setup_hints(void) {
285 xcb_atom_t supported_atoms[] = {
286 #define xmacro(atom) A_##atom,
287 #include "atoms.xmacro"
291 /* Set up the window manager’s name. According to EWMH, section "Root Window
292 * Properties", to indicate that an EWMH-compliant window manager is
293 * present, a child window has to be created (and kept alive as long as the
294 * window manager is running) which has the _NET_SUPPORTING_WM_CHECK and
296 ewmh_window = xcb_generate_id(conn);
297 /* We create the window and put it at (-1, -1) so that it is off-screen. */
300 XCB_COPY_FROM_PARENT, /* depth */
301 ewmh_window, /* window id */
303 -1, -1, 1, 1, /* dimensions (x, y, w, h) */
305 XCB_WINDOW_CLASS_INPUT_ONLY, /* window class */
306 XCB_COPY_FROM_PARENT, /* visual */
307 XCB_CW_OVERRIDE_REDIRECT,
309 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, ewmh_window, A__NET_SUPPORTING_WM_CHECK, XCB_ATOM_WINDOW, 32, 1, &ewmh_window);
310 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, ewmh_window, A__NET_WM_NAME, A_UTF8_STRING, 8, strlen("i3"), "i3");
311 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A__NET_SUPPORTING_WM_CHECK, XCB_ATOM_WINDOW, 32, 1, &ewmh_window);
313 /* I’m not entirely sure if we need to keep _NET_WM_NAME on root. */
314 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A__NET_WM_NAME, A_UTF8_STRING, 8, strlen("i3"), "i3");
316 /* only send the first 32 atoms (last one is _NET_CLOSE_WINDOW) increment that number when adding supported atoms */
317 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, root, A__NET_SUPPORTED, XCB_ATOM_ATOM, 32, /* number of atoms */ 32, supported_atoms);
319 /* We need to map this window to be able to set the input focus to it if no other window is available to be focused. */
320 xcb_map_window(conn, ewmh_window);
321 xcb_configure_window(conn, ewmh_window, XCB_CONFIG_WINDOW_STACK_MODE, (uint32_t[]){XCB_STACK_MODE_BELOW});
325 * Returns the workspace container as enumerated by the EWMH desktop model.
326 * Returns NULL if no workspace could be found for the index.
328 * This is the reverse of ewmh_get_workspace_index.
331 Con *ewmh_get_workspace_by_index(uint32_t idx) {
332 if (idx == NET_WM_DESKTOP_NONE)
335 uint32_t current_index = 0;
338 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
340 TAILQ_FOREACH(workspace, &(output_get_content(output)->nodes_head), nodes) {
341 if (con_is_internal(workspace))
344 if (current_index == idx)
355 * Returns the EWMH desktop index for the workspace the given container is on.
356 * Returns NET_WM_DESKTOP_NONE if the desktop index cannot be determined.
358 * This is the reverse of ewmh_get_workspace_by_index.
361 uint32_t ewmh_get_workspace_index(Con *con) {
364 Con *workspace = con_get_workspace(con);
366 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
368 TAILQ_FOREACH(current, &(output_get_content(output)->nodes_head), nodes) {
369 if (con_is_internal(current))
372 if (current == workspace)
379 return NET_WM_DESKTOP_NONE;