2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2010 Michael Stapelberg and contributors (see also: LICENSE)
7 * workspace.c: Functions for modifying workspaces
15 * Returns a pointer to the workspace with the given number (starting at 0),
16 * creating the workspace if necessary (by allocating the necessary amount of
17 * memory and initializing the data structures correctly).
20 Con *workspace_get(const char *num) {
21 Con *output, *workspace = NULL, *current;
23 /* TODO: could that look like this in the future?
24 GET_MATCHING_NODE(workspace, croot, strcasecmp(current->name, num) != 0);
26 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
27 TAILQ_FOREACH(current, &(output->nodes_head), nodes) {
28 if (strcasecmp(current->name, num) != 0)
36 LOG("getting ws %s\n", num);
37 if (workspace == NULL) {
38 LOG("need to create this one\n");
39 output = con_get_output(focused);
40 LOG("got output %p\n", output);
41 workspace = con_new(output);
43 asprintf(&name, "[i3 con] workspace %s", num);
44 x_set_name(workspace, name);
46 workspace->type = CT_WORKSPACE;
47 workspace->name = strdup(num);
48 workspace->orientation = HORIZ;
50 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"init\"}");
53 //ewmh_update_workarea();
61 * Sets the name (or just its number) for the given workspace. This has to
62 * be called for every workspace as the rendering function
63 * (render_internal_bar) relies on workspace->name and workspace->name_len
67 void workspace_set_name(Workspace *ws, const char *name) {
72 ret = asprintf(&label, "%d: %s", ws->num + 1, name);
73 else ret = asprintf(&label, "%d", ws->num + 1);
76 errx(1, "asprintf() failed");
81 ws->name = convert_utf8_to_ucs2(label, &(ws->name_len));
82 if (config.font != NULL)
83 ws->text_width = predict_text_width(global_conn, config.font, ws->name, ws->name_len);
84 else ws->text_width = 0;
85 ws->utf8_name = label;
90 * Returns true if the workspace is currently visible. Especially important for
91 * multi-monitor environments, as they can have multiple currenlty active
95 bool workspace_is_visible(Con *ws) {
96 Con *output = con_get_output(ws);
99 Con *fs = con_get_fullscreen_con(output);
100 LOG("workspace visible? fs = %p, ws = %p\n", fs, ws);
105 * XXX: we need to clean up all this recursive walking code.
108 Con *_get_sticky(Con *con, const char *sticky_group, Con *exclude) {
111 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
112 if (current != exclude &&
113 current->sticky_group != NULL &&
114 current->window != NULL &&
115 strcmp(current->sticky_group, sticky_group) == 0)
118 Con *recurse = _get_sticky(current, sticky_group, exclude);
123 TAILQ_FOREACH(current, &(con->floating_head), floating_windows) {
124 if (current != exclude &&
125 current->sticky_group != NULL &&
126 current->window != NULL &&
127 strcmp(current->sticky_group, sticky_group) == 0)
130 Con *recurse = _get_sticky(current, sticky_group, exclude);
139 * Reassigns all child windows in sticky containers. Called when the user
140 * changes workspaces.
142 * XXX: what about sticky containers which contain containers?
145 static void workspace_reassign_sticky(Con *con) {
147 /* 1: go through all containers */
149 /* handle all children and floating windows of this node */
150 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
151 if (current->sticky_group == NULL) {
152 workspace_reassign_sticky(current);
156 LOG("Ah, this one is sticky: %s / %p\n", current->name, current);
157 /* 2: find a window which we can re-assign */
158 Con *output = con_get_output(current);
159 Con *src = _get_sticky(output, current->sticky_group, current);
162 LOG("No window found for this sticky group\n");
163 workspace_reassign_sticky(current);
167 x_move_win(src, current);
168 current->window = src->window;
169 current->mapped = true;
173 x_reparent_child(current, src);
175 LOG("re-assigned window from src %p to dest %p\n", src, current);
178 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
179 workspace_reassign_sticky(current);
183 * Switches to the given workspace
186 void workspace_show(const char *num) {
187 Con *workspace, *current, *old;
189 old = con_get_workspace(focused);
191 workspace = workspace_get(num);
192 if (workspace == old)
194 workspace->fullscreen_mode = CF_OUTPUT;
195 /* disable fullscreen */
196 TAILQ_FOREACH(current, &(workspace->parent->nodes_head), nodes)
197 current->fullscreen_mode = CF_NONE;
199 workspace_reassign_sticky(workspace);
201 LOG("switching to %p\n", workspace);
202 Con *next = workspace;
204 while (!TAILQ_EMPTY(&(next->focus_head)))
205 next = TAILQ_FIRST(&(next->focus_head));
208 if (TAILQ_EMPTY(&(old->nodes_head)) && TAILQ_EMPTY(&(old->floating_head))) {
209 /* check if this workspace is currently visible */
210 if (!workspace_is_visible(old)) {
211 LOG("Closing old workspace (%p / %s), it is empty\n", old, old->name);
212 tree_close(old, false, false);
217 workspace->fullscreen_mode = CF_OUTPUT;
218 LOG("focused now = %p / %s\n", focused, focused->name);
220 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
223 /* Check if the workspace has not been used yet */
224 workspace_initialize(t_ws, c_ws->output, false);
226 if (c_ws->output != t_ws->output) {
227 /* We need to switch to the other output first */
228 DLOG("moving over to other output.\n");
230 /* Store the old client */
231 Client *old_client = CUR_CELL->currently_focused;
233 c_ws = t_ws->output->current_workspace;
234 current_col = c_ws->current_col;
235 current_row = c_ws->current_row;
236 if (CUR_CELL->currently_focused != NULL)
239 Rect *dims = &(c_ws->output->rect);
240 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0,
241 dims->x + (dims->width / 2), dims->y + (dims->height / 2));
244 /* Re-decorate the old client, it’s not focused anymore */
245 if ((old_client != NULL) && !old_client->dock)
246 redecorate_window(conn, old_client);
247 else xcb_flush(conn);
249 /* We need to check if a global fullscreen-client is blocking
250 * the t_ws and if necessary switch that to local fullscreen */
251 Client* client = c_ws->fullscreen_client;
252 if (client != NULL && client->workspace != c_ws) {
253 if (c_ws->fullscreen_client->workspace != c_ws)
254 c_ws->fullscreen_client = NULL;
255 client_enter_fullscreen(conn, client, false);
259 /* Check if we need to change something or if we’re already there */
260 if (c_ws->output->current_workspace->num == (workspace-1)) {
261 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
262 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
263 set_focus(conn, last_focused, true);
265 client_warp_pointer_into(conn, last_focused);
269 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
274 Workspace *old_workspace = c_ws;
275 c_ws = t_ws->output->current_workspace = workspace_get(workspace-1);
277 /* Unmap all clients of the old workspace */
278 workspace_unmap_clients(conn, old_workspace);
280 current_row = c_ws->current_row;
281 current_col = c_ws->current_col;
282 DLOG("new current row = %d, current col = %d\n", current_row, current_col);
284 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
286 workspace_map_clients(conn, c_ws);
288 /* POTENTIAL TO IMPROVE HERE: due to the call to _map_clients first and
289 * render_layout afterwards, there is a short flickering on the source
290 * workspace (assign ws 3 to output 0, ws 4 to output 1, create single
291 * client on ws 4, move it to ws 3, switch to ws 3, you’ll see the
294 /* Restore focus on the new workspace */
295 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
296 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
297 set_focus(conn, last_focused, true);
298 else xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, root, XCB_CURRENT_TIME);
302 /* We can warp the pointer only after the window has been
303 * reconfigured in render_layout, otherwise the pointer will
304 * be warped to the old position, which will not work when we
305 * moved it to another output. */
306 if (last_focused != SLIST_END(&(c_ws->focus_stack)) && need_warp) {
307 client_warp_pointer_into(conn, last_focused);
315 * Assigns the given workspace to the given output by correctly updating its
316 * state and reconfiguring all the clients on this workspace.
318 * This is called when initializing a output and when re-assigning it to a
319 * different output which just got available (if you configured it to be on
320 * output 1 and you just plugged in output 1).
323 void workspace_assign_to(Workspace *ws, Output *output, bool hide_it) {
326 bool visible = workspace_is_visible(ws);
330 /* Copy the dimensions from the virtual output */
331 memcpy(&(ws->rect), &(ws->output->rect), sizeof(Rect));
333 ewmh_update_workarea();
335 /* Force reconfiguration for each client on that workspace */
336 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
337 client->force_reconfigure = true;
344 /* Render the workspace to reconfigure the clients. However, they will be visible now, so… */
345 render_workspace(global_conn, output, ws);
347 /* …unless we want to see them at the moment, we should hide that workspace */
348 if (visible && !hide_it)
351 /* however, if this is the current workspace, we only need to adjust
352 * the output’s current_workspace pointer (and must not unmap the
355 DLOG("Need to adjust output->current_workspace...\n");
356 output->current_workspace = c_ws;
357 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
361 workspace_unmap_clients(global_conn, ws);
365 * Initializes the given workspace if it is not already initialized. The given
366 * screen is to be understood as a fallback, if the workspace itself either
367 * was not assigned to a particular screen or cannot be placed there because
368 * the screen is not attached at the moment.
371 void workspace_initialize(Workspace *ws, Output *output, bool recheck) {
374 if (ws->output != NULL && !recheck) {
375 DLOG("Workspace already initialized\n");
379 old_output = ws->output;
381 /* If this workspace has no preferred output or if the output it wants
382 * to be on is not available at the moment, we initialize it with
383 * the output which was given */
384 if (ws->preferred_output == NULL ||
385 (ws->output = get_output_by_name(ws->preferred_output)) == NULL)
388 DLOG("old_output = %p, ws->output = %p\n", old_output, ws->output);
389 /* If the assignment did not change, we do not need to update anything */
390 if (old_output != NULL && ws->output == old_output)
393 workspace_assign_to(ws, ws->output, false);
397 * Gets the first unused workspace for the given screen, taking into account
398 * the preferred_output setting of every workspace (workspace assignments).
401 Workspace *get_first_workspace_for_output(Output *output) {
402 Workspace *result = NULL;
405 TAILQ_FOREACH(ws, workspaces, workspaces) {
406 if (ws->preferred_output == NULL ||
407 get_output_by_name(ws->preferred_output) != output)
414 if (result == NULL) {
415 /* No assignment found, returning first unused workspace */
416 TAILQ_FOREACH(ws, workspaces, workspaces) {
417 if (ws->output != NULL)
425 if (result == NULL) {
426 DLOG("No existing free workspace found to assign, creating a new one\n");
429 TAILQ_FOREACH(ws, workspaces, workspaces)
431 result = workspace_get(last_ws + 1);
434 workspace_initialize(result, output, false);
439 * Maps all clients (and stack windows) of the given workspace.
442 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws) {
445 ignore_enter_notify_forall(conn, ws, true);
447 /* Map all clients on the new workspace */
449 CIRCLEQ_FOREACH(client, &(ws->table[cols][rows]->clients), clients)
450 client_map(conn, client);
452 /* Map all floating clients */
453 if (!ws->floating_hidden)
454 TAILQ_FOREACH(client, &(ws->floating_clients), floating_clients)
455 client_map(conn, client);
457 /* Map all stack windows, if any */
458 struct Stack_Window *stack_win;
459 SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
460 if (stack_win->container->workspace == ws && stack_win->rect.height > 0)
461 xcb_map_window(conn, stack_win->window);
463 ignore_enter_notify_forall(conn, ws, false);
467 * Unmaps all clients (and stack windows) of the given workspace.
469 * This needs to be called separately when temporarily rendering
470 * a workspace which is not the active workspace to force
471 * reconfiguration of all clients, like in src/xinerama.c when
472 * re-assigning a workspace to another screen.
475 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws) {
477 struct Stack_Window *stack_win;
479 /* Ignore notify events because they would cause focus to be changed */
480 ignore_enter_notify_forall(conn, u_ws, true);
482 /* Unmap all clients of the given workspace */
483 int unmapped_clients = 0;
485 CIRCLEQ_FOREACH(client, &(u_ws->table[cols][rows]->clients), clients) {
486 DLOG("unmapping normal client %p / %p / %p\n", client, client->frame, client->child);
487 client_unmap(conn, client);
491 /* To find floating clients, we traverse the focus stack */
492 SLIST_FOREACH(client, &(u_ws->focus_stack), focus_clients) {
493 if (!client_is_floating(client))
496 DLOG("unmapping floating client %p / %p / %p\n", client, client->frame, client->child);
498 client_unmap(conn, client);
502 /* If we did not unmap any clients, the workspace is empty and we can destroy it, at least
503 * if it is not the current workspace. */
504 if (unmapped_clients == 0 && u_ws != c_ws) {
505 /* Re-assign the workspace of all dock clients which use this workspace */
507 DLOG("workspace %p is empty\n", u_ws);
508 SLIST_FOREACH(dock, &(u_ws->output->dock_clients), dock_clients) {
509 if (dock->workspace != u_ws)
512 DLOG("Re-assigning dock client to c_ws (%p)\n", c_ws);
513 dock->workspace = c_ws;
518 /* Unmap the stack windows on the given workspace, if any */
519 SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
520 if (stack_win->container->workspace == u_ws)
521 xcb_unmap_window(conn, stack_win->window);
523 ignore_enter_notify_forall(conn, u_ws, false);
527 static bool get_urgency_flag(Con *con) {
529 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
530 if (child->urgent || get_urgency_flag(child))
533 TAILQ_FOREACH(child, &(con->floating_head), floating_windows)
534 if (child->urgent || get_urgency_flag(child))
541 * Goes through all clients on the given workspace and updates the workspace’s
542 * urgent flag accordingly.
545 void workspace_update_urgent_flag(Con *ws) {
546 bool old_flag = ws->urgent;
547 ws->urgent = get_urgency_flag(ws);
548 DLOG("Workspace urgency flag changed from %d to %d\n", old_flag, ws->urgent);
550 if (old_flag != ws->urgent)
551 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
557 * Returns the width of the workspace.
560 int workspace_width(Workspace *ws) {
561 return ws->rect.width;
565 * Returns the effective height of the workspace (without the internal bar and
566 * without dock clients).
569 int workspace_height(Workspace *ws) {
570 int height = ws->rect.height;
571 i3Font *font = load_font(global_conn, config.font);
573 /* Reserve space for dock clients */
575 SLIST_FOREACH(client, &(ws->output->dock_clients), dock_clients)
576 height -= client->desired_height;
578 /* Space for the internal bar */
579 if (!config.disable_workspace_bar)
580 height -= (font->height + 6);