4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * client.c: holds all client-specific functions
19 #include <xcb/xcb_icccm.h>
29 #include "workspace.h"
34 * Removes the given client from the container, either because it will be inserted into another
35 * one or because it was unmapped
38 void client_remove_from_container(xcb_connection_t *conn, Client *client, Container *container, bool remove_from_focusstack) {
39 CIRCLEQ_REMOVE(&(container->clients), client, clients);
41 if (remove_from_focusstack)
42 SLIST_REMOVE(&(container->workspace->focus_stack), client, Client, focus_clients);
44 /* If the container will be empty now and is in stacking mode, we need to
45 unmap the stack_win */
46 if (CIRCLEQ_EMPTY(&(container->clients)) &&
47 (container->mode == MODE_STACK ||
48 container->mode == MODE_TABBED)) {
49 DLOG("Unmapping stack window\n");
50 struct Stack_Window *stack_win = &(container->stack_win);
51 stack_win->rect.height = 0;
52 xcb_unmap_window(conn, stack_win->window);
58 * Warps the pointer into the given client (in the middle of it, to be specific), therefore
62 void client_warp_pointer_into(xcb_connection_t *conn, Client *client) {
63 int mid_x = client->rect.width / 2,
64 mid_y = client->rect.height / 2;
65 xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, mid_x, mid_y);
69 * Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
72 static bool client_supports_protocol(xcb_connection_t *conn, Client *client, xcb_atom_t atom) {
73 xcb_get_property_cookie_t cookie;
74 xcb_get_wm_protocols_reply_t protocols;
77 cookie = xcb_get_wm_protocols_unchecked(conn, client->child, atoms[WM_PROTOCOLS]);
78 if (xcb_get_wm_protocols_reply(conn, cookie, &protocols, NULL) != 1)
81 /* Check if the client’s protocols have the requested atom set */
82 for (uint32_t i = 0; i < protocols.atoms_len; i++)
83 if (protocols.atoms[i] == atom)
86 xcb_get_wm_protocols_reply_wipe(&protocols);
92 * Kills the given window using WM_DELETE_WINDOW or xcb_kill_window
95 void client_kill(xcb_connection_t *conn, Client *window) {
96 /* If the client does not support WM_DELETE_WINDOW, we kill it the hard way */
97 if (!client_supports_protocol(conn, window, atoms[WM_DELETE_WINDOW])) {
98 LOG("Killing window the hard way\n");
99 xcb_kill_client(conn, window->child);
103 xcb_client_message_event_t ev;
105 memset(&ev, 0, sizeof(xcb_client_message_event_t));
107 ev.response_type = XCB_CLIENT_MESSAGE;
108 ev.window = window->child;
109 ev.type = atoms[WM_PROTOCOLS];
111 ev.data.data32[0] = atoms[WM_DELETE_WINDOW];
112 ev.data.data32[1] = XCB_CURRENT_TIME;
114 LOG("Sending WM_DELETE to the client\n");
115 xcb_send_event(conn, false, window->child, XCB_EVENT_MASK_NO_EVENT, (char*)&ev);
120 * Checks if the given window class and title match the given client
121 * Window title is passed as "normal" string and as UCS-2 converted string for
122 * matching _NET_WM_NAME capable clients as well as those using legacy hints.
125 bool client_matches_class_name(Client *client, char *to_class, char *to_title,
126 char *to_title_ucs, int to_title_ucs_len) {
127 /* Check if the given class is part of the window class */
128 if ((client->window_class_instance == NULL ||
129 strcasestr(client->window_class_instance, to_class) == NULL) &&
130 (client->window_class_class == NULL ||
131 strcasestr(client->window_class_class, to_class) == NULL))
134 /* If no title was given, we’re done */
135 if (to_title == NULL)
138 if (client->name_len > -1) {
139 /* UCS-2 converted window titles */
140 if (client->name == NULL || memmem(client->name, (client->name_len * 2), to_title_ucs, (to_title_ucs_len * 2)) == NULL)
144 if (client->name == NULL || strcasestr(client->name, to_title) == NULL)
152 * Enters fullscreen mode for the given client. This is called by toggle_fullscreen
153 * and when moving a fullscreen client to another screen.
156 void client_enter_fullscreen(xcb_connection_t *conn, Client *client, bool global) {
157 Workspace *workspace;
162 TAILQ_FOREACH(output, &outputs, outputs) {
166 if (output->current_workspace->fullscreen_client == NULL)
169 LOG("Not entering global fullscreen mode, there already "
170 "is a fullscreen client on output %s.\n", output->name);
174 r = (Rect) { UINT_MAX, UINT_MAX, 0,0 };
177 /* Set fullscreen_client for each active workspace.
178 * Expand the rectangle to contain all outputs. */
179 TAILQ_FOREACH(output, &outputs, outputs) {
183 output->current_workspace->fullscreen_client = client;
185 /* Temporarily abuse width/heigth as coordinates of the lower right corner */
186 if (r.x > output->rect.x)
187 r.x = output->rect.x;
188 if (r.y > output->rect.y)
189 r.y = output->rect.y;
190 if (r.x + r.width < output->rect.x + output->rect.width)
191 r.width = output->rect.x + output->rect.width;
192 if (r.y + r.height < output->rect.y + output->rect.height)
193 r.height = output->rect.y + output->rect.height;
196 /* Putting them back to their original meaning */
200 LOG("Entering global fullscreen mode...\n");
202 workspace = client->workspace;
203 if (workspace->fullscreen_client != NULL && workspace->fullscreen_client != client) {
204 LOG("Not entering fullscreen mode, there already is a fullscreen client.\n");
208 workspace->fullscreen_client = client;
211 LOG("Entering fullscreen mode...\n");
214 client->fullscreen = true;
216 /* We just entered fullscreen mode, let’s configure the window */
217 DLOG("child itself will be at %dx%d with size %dx%d\n",
218 r.x, r.y, r.width, r.height);
220 xcb_set_window_rect(conn, client->frame, r);
222 /* Child’s coordinates are relative to the parent (=frame) */
225 xcb_set_window_rect(conn, client->child, r);
227 /* Raise the window */
228 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
229 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_STACK_MODE, values);
231 fake_configure_notify(conn, r, client->child);
237 * Leaves fullscreen mode for the current client. This is called by toggle_fullscreen.
240 void client_leave_fullscreen(xcb_connection_t *conn, Client *client) {
241 LOG("leaving fullscreen mode\n");
242 client->fullscreen = false;
244 TAILQ_FOREACH(ws, workspaces, workspaces)
245 if (ws->fullscreen_client == client)
246 ws->fullscreen_client = NULL;
248 if (client_is_floating(client)) {
249 /* For floating clients it’s enough if we just reconfigure that window (in fact,
250 * re-rendering the layout will not update the client.) */
251 reposition_client(conn, client);
252 resize_client(conn, client);
253 /* redecorate_window flushes */
254 redecorate_window(conn, client);
256 client_set_below_floating(conn, client);
258 /* Because the coordinates of the window haven’t changed, it would not be
259 re-configured if we don’t set the following flag */
260 client->force_reconfigure = true;
261 /* We left fullscreen mode, redraw the whole layout to ensure enternotify events are disabled */
269 * Toggles fullscreen mode for the given client. It updates the data structures and
270 * reconfigures (= resizes/moves) the client and its frame to the full size of the
271 * screen. When leaving fullscreen, re-rendering the layout is forced.
274 void client_toggle_fullscreen(xcb_connection_t *conn, Client *client) {
275 /* dock clients cannot enter fullscreen mode */
276 assert(!client->dock);
278 if (!client->fullscreen) {
279 client_enter_fullscreen(conn, client, false);
281 client_leave_fullscreen(conn, client);
286 * Like client_toggle_fullscreen(), but putting it in global fullscreen-mode.
289 void client_toggle_fullscreen_global(xcb_connection_t *conn, Client *client) {
290 /* dock clients cannot enter fullscreen mode */
291 assert(!client->dock);
293 if (!client->fullscreen) {
294 client_enter_fullscreen(conn, client, true);
296 client_leave_fullscreen(conn, client);
301 * Sets the position of the given client in the X stack to the highest (tiling layer is always
302 * on the same position, so this doesn’t matter) below the first floating client, so that
303 * floating windows are always on top.
306 void client_set_below_floating(xcb_connection_t *conn, Client *client) {
307 /* Ensure that it is below all floating clients */
308 Workspace *ws = client->workspace;
309 Client *first_floating = TAILQ_FIRST(&(ws->floating_clients));
310 if (first_floating == TAILQ_END(&(ws->floating_clients)))
313 DLOG("Setting below floating\n");
314 uint32_t values[] = { first_floating->frame, XCB_STACK_MODE_BELOW };
315 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
317 if (client->workspace->fullscreen_client == NULL)
320 DLOG("(and below fullscreen)\n");
321 /* Ensure that the window is still below the fullscreen window */
322 values[0] = client->workspace->fullscreen_client->frame;
323 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
327 * Returns true if the client is floating. Makes the code more beatiful, as floating
328 * is not simply a boolean, but also saves whether the user selected the current state
329 * or whether it was automatically set.
332 bool client_is_floating(Client *client) {
333 return (client->floating >= FLOATING_AUTO_ON);
337 * Change the border type for the given client to normal (n), 1px border (p) or
338 * completely borderless (b) without actually re-rendering the layout. Useful
339 * for calling it when initializing a new client.
342 bool client_init_border(xcb_connection_t *conn, Client *client, char border_type) {
343 switch (border_type) {
345 LOG("Changing to normal border\n");
346 client->titlebar_position = TITLEBAR_TOP;
347 client->borderless = false;
350 LOG("Changing to 1px border\n");
351 client->titlebar_position = TITLEBAR_OFF;
352 client->borderless = false;
355 LOG("Changing to borderless\n");
356 client->titlebar_position = TITLEBAR_OFF;
357 client->borderless = true;
360 LOG("Unknown border mode\n");
366 * Change the border type for the given client to normal (n), 1px border (p) or
367 * completely borderless (b).
370 void client_change_border(xcb_connection_t *conn, Client *client, char border_type) {
371 if (!client_init_border(conn, client, border_type))
374 /* Ensure that the child’s position inside our window gets updated */
375 client->force_reconfigure = true;
377 /* For clients inside a container, we can simply render the container */
378 if (client->container != NULL)
379 render_container(conn, client->container);
381 /* If the client is floating, directly push its size */
382 if (client_is_floating(client))
383 resize_client(conn, client);
384 /* Otherwise, it may be a dock client, thus render the whole layout */
385 else render_layout(conn);
388 redecorate_window(conn, client);
392 * Unmap the client, correctly setting any state which is needed.
395 void client_unmap(xcb_connection_t *conn, Client *client) {
396 /* Set WM_STATE_WITHDRAWN, it seems like Java apps need it */
397 long data[] = { XCB_WM_STATE_WITHDRAWN, XCB_NONE };
398 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, client->child, atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
400 xcb_unmap_window(conn, client->frame);
404 * Map the client, correctly restoring any state needed.
407 void client_map(xcb_connection_t *conn, Client *client) {
408 /* Set WM_STATE_NORMAL because GTK applications don’t want to drag & drop if we don’t.
409 * Also, xprop(1) needs that to work. */
410 long data[] = { XCB_WM_STATE_NORMAL, XCB_NONE };
411 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, client->child, atoms[WM_STATE], atoms[WM_STATE], 32, 2, data);
413 xcb_map_window(conn, client->frame);
417 * Set the given mark for this client. Used for jumping to the client
418 * afterwards (like m<mark> and '<mark> in vim).
421 void client_mark(xcb_connection_t *conn, Client *client, const char *mark) {
422 if (client->mark != NULL)
424 client->mark = sstrdup(mark);
426 /* Make sure no other client has this mark set */
429 TAILQ_FOREACH(ws, workspaces, workspaces)
430 SLIST_FOREACH(current, &(ws->focus_stack), focus_clients) {
431 if (current == client ||
432 current->mark == NULL ||
433 strcmp(current->mark, mark) != 0)
437 current->mark = NULL;
438 /* We can break here since there can only be one other
439 * client with this mark. */
445 * Returns the minimum height of a specific window. The height is calculated
446 * by using 2 pixels (for the client window itself), possibly padding this to
447 * comply with the client’s base_height and then adding the decoration height.
450 uint32_t client_min_height(Client *client) {
451 uint32_t height = max(2, client->base_height);
452 i3Font *font = load_font(global_conn, config.font);
454 if (client->titlebar_position == TITLEBAR_OFF && client->borderless)
457 if (client->titlebar_position == TITLEBAR_OFF && !client->borderless)
460 return height + font->height + 2 + 2;
464 * See client_min_height.
467 uint32_t client_min_width(Client *client) {
468 uint32_t width = max(2, client->base_width);
470 if (client->titlebar_position == TITLEBAR_OFF && client->borderless)
473 if (client->titlebar_position == TITLEBAR_OFF && !client->borderless)
476 return width + 2 + 2;