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, bool *created) {
21 Con *output, *workspace = NULL, *child;
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(child, &(output_get_content(output)->nodes_head), nodes) {
28 if (strcasecmp(child->name, num) != 0)
35 LOG("getting ws %s\n", num);
36 if (workspace == NULL) {
37 LOG("need to create this one\n");
38 output = con_get_output(focused);
39 Con *content = output_get_content(output);
40 LOG("got output %p with content %p\n", output, content);
41 /* We need to attach this container after setting its type. con_attach
42 * will handle CT_WORKSPACEs differently */
43 workspace = con_new(NULL);
45 asprintf(&name, "[i3 con] workspace %s", num);
46 x_set_name(workspace, name);
48 workspace->type = CT_WORKSPACE;
49 FREE(workspace->name);
50 workspace->name = sstrdup(num);
51 /* We set ->num to the number if this workspace’s name consists only of
52 * a positive number. Otherwise it’s a named ws and num will be -1. */
54 long parsed_num = strtol(num, &end, 10);
55 if (parsed_num == LONG_MIN ||
56 parsed_num == LONG_MAX ||
58 (end && *end != '\0'))
60 else workspace->num = parsed_num;
61 LOG("num = %d\n", workspace->num);
63 /* If default_orientation is set to NO_ORIENTATION we
64 * determine workspace orientation from workspace size.
65 * Otherwise we just set the orientation to default_orientation. */
66 if (config.default_orientation == NO_ORIENTATION) {
67 workspace->orientation = (output->rect.height > output->rect.width) ? VERT : HORIZ;
68 DLOG("Auto orientation. Output resolution set to (%d,%d), setting orientation to %d.\n",
69 workspace->rect.width, workspace->rect.height, workspace->orientation);
71 workspace->orientation = config.default_orientation;
74 con_attach(workspace, content, false);
76 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"init\"}");
80 else if (created != NULL) {
90 * Sets the name (or just its number) for the given workspace. This has to
91 * be called for every workspace as the rendering function
92 * (render_internal_bar) relies on workspace->name and workspace->name_len
96 void workspace_set_name(Workspace *ws, const char *name) {
101 ret = asprintf(&label, "%d: %s", ws->num + 1, name);
102 else ret = asprintf(&label, "%d", ws->num + 1);
105 errx(1, "asprintf() failed");
110 ws->name = convert_utf8_to_ucs2(label, &(ws->name_len));
111 if (config.font != NULL)
112 ws->text_width = predict_text_width(global_conn, config.font, ws->name, ws->name_len);
113 else ws->text_width = 0;
114 ws->utf8_name = label;
119 * Returns true if the workspace is currently visible. Especially important for
120 * multi-monitor environments, as they can have multiple currenlty active
124 bool workspace_is_visible(Con *ws) {
125 Con *output = con_get_output(ws);
128 Con *fs = con_get_fullscreen_con(output);
129 LOG("workspace visible? fs = %p, ws = %p\n", fs, ws);
134 * XXX: we need to clean up all this recursive walking code.
137 Con *_get_sticky(Con *con, const char *sticky_group, Con *exclude) {
140 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
141 if (current != exclude &&
142 current->sticky_group != NULL &&
143 current->window != NULL &&
144 strcmp(current->sticky_group, sticky_group) == 0)
147 Con *recurse = _get_sticky(current, sticky_group, exclude);
152 TAILQ_FOREACH(current, &(con->floating_head), floating_windows) {
153 if (current != exclude &&
154 current->sticky_group != NULL &&
155 current->window != NULL &&
156 strcmp(current->sticky_group, sticky_group) == 0)
159 Con *recurse = _get_sticky(current, sticky_group, exclude);
168 * Reassigns all child windows in sticky containers. Called when the user
169 * changes workspaces.
171 * XXX: what about sticky containers which contain containers?
174 static void workspace_reassign_sticky(Con *con) {
176 /* 1: go through all containers */
178 /* handle all children and floating windows of this node */
179 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
180 if (current->sticky_group == NULL) {
181 workspace_reassign_sticky(current);
185 LOG("Ah, this one is sticky: %s / %p\n", current->name, current);
186 /* 2: find a window which we can re-assign */
187 Con *output = con_get_output(current);
188 Con *src = _get_sticky(output, current->sticky_group, current);
191 LOG("No window found for this sticky group\n");
192 workspace_reassign_sticky(current);
196 x_move_win(src, current);
197 current->window = src->window;
198 current->mapped = true;
202 x_reparent_child(current, src);
204 LOG("re-assigned window from src %p to dest %p\n", src, current);
207 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
208 workspace_reassign_sticky(current);
212 * Switches to the given workspace
215 void workspace_show(const char *num) {
216 Con *workspace, *current, *old = NULL;
218 bool changed_num_workspaces;
219 workspace = workspace_get(num, &changed_num_workspaces);
221 /* disable fullscreen for the other workspaces and get the workspace we are
223 TAILQ_FOREACH(current, &(workspace->parent->nodes_head), nodes) {
224 if (current->fullscreen_mode == CF_OUTPUT)
226 current->fullscreen_mode = CF_NONE;
230 /* enable fullscreen for the target workspace. If it happens to be the
231 * same one we are currently on anyways, we can stop here. */
232 workspace->fullscreen_mode = CF_OUTPUT;
233 if (workspace == con_get_workspace(focused)) {
234 DLOG("Not switching, already there.\n");
238 workspace_reassign_sticky(workspace);
240 LOG("switching to %p\n", workspace);
241 Con *next = con_descend_focused(workspace);
243 if (old && TAILQ_EMPTY(&(old->nodes_head)) && TAILQ_EMPTY(&(old->floating_head))) {
244 /* check if this workspace is currently visible */
245 if (!workspace_is_visible(old)) {
246 LOG("Closing old workspace (%p / %s), it is empty\n", old, old->name);
247 tree_close(old, false, false);
248 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
249 changed_num_workspaces = true;
254 workspace->fullscreen_mode = CF_OUTPUT;
255 LOG("focused now = %p / %s\n", focused, focused->name);
257 /* Update the EWMH hints */
258 if (changed_num_workspaces)
259 ewmh_update_workarea();
260 ewmh_update_current_desktop();
262 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
265 /* Check if the workspace has not been used yet */
266 workspace_initialize(t_ws, c_ws->output, false);
268 if (c_ws->output != t_ws->output) {
269 /* We need to switch to the other output first */
270 DLOG("moving over to other output.\n");
272 /* Store the old client */
273 Client *old_client = CUR_CELL->currently_focused;
275 c_ws = t_ws->output->current_workspace;
276 current_col = c_ws->current_col;
277 current_row = c_ws->current_row;
278 if (CUR_CELL->currently_focused != NULL)
281 Rect *dims = &(c_ws->output->rect);
282 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0,
283 dims->x + (dims->width / 2), dims->y + (dims->height / 2));
286 /* Re-decorate the old client, it’s not focused anymore */
287 if ((old_client != NULL) && !old_client->dock)
288 redecorate_window(conn, old_client);
289 else xcb_flush(conn);
291 /* We need to check if a global fullscreen-client is blocking
292 * the t_ws and if necessary switch that to local fullscreen */
293 Client* client = c_ws->fullscreen_client;
294 if (client != NULL && client->workspace != c_ws) {
295 if (c_ws->fullscreen_client->workspace != c_ws)
296 c_ws->fullscreen_client = NULL;
297 client_enter_fullscreen(conn, client, false);
301 /* Check if we need to change something or if we’re already there */
302 if (c_ws->output->current_workspace->num == (workspace-1)) {
303 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
304 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
305 set_focus(conn, last_focused, true);
307 client_warp_pointer_into(conn, last_focused);
311 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
316 Workspace *old_workspace = c_ws;
317 c_ws = t_ws->output->current_workspace = workspace_get(workspace-1);
319 /* Unmap all clients of the old workspace */
320 workspace_unmap_clients(conn, old_workspace);
322 current_row = c_ws->current_row;
323 current_col = c_ws->current_col;
324 DLOG("new current row = %d, current col = %d\n", current_row, current_col);
326 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
328 workspace_map_clients(conn, c_ws);
330 /* POTENTIAL TO IMPROVE HERE: due to the call to _map_clients first and
331 * render_layout afterwards, there is a short flickering on the source
332 * workspace (assign ws 3 to output 0, ws 4 to output 1, create single
333 * client on ws 4, move it to ws 3, switch to ws 3, you’ll see the
336 /* Restore focus on the new workspace */
337 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
338 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
339 set_focus(conn, last_focused, true);
340 else xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, root, XCB_CURRENT_TIME);
344 /* We can warp the pointer only after the window has been
345 * reconfigured in render_layout, otherwise the pointer will
346 * be warped to the old position, which will not work when we
347 * moved it to another output. */
348 if (last_focused != SLIST_END(&(c_ws->focus_stack)) && need_warp) {
349 client_warp_pointer_into(conn, last_focused);
357 * Assigns the given workspace to the given output by correctly updating its
358 * state and reconfiguring all the clients on this workspace.
360 * This is called when initializing a output and when re-assigning it to a
361 * different output which just got available (if you configured it to be on
362 * output 1 and you just plugged in output 1).
365 void workspace_assign_to(Workspace *ws, Output *output, bool hide_it) {
368 bool visible = workspace_is_visible(ws);
372 /* Copy the dimensions from the virtual output */
373 memcpy(&(ws->rect), &(ws->output->rect), sizeof(Rect));
375 ewmh_update_workarea();
377 /* Force reconfiguration for each client on that workspace */
378 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
379 client->force_reconfigure = true;
386 /* Render the workspace to reconfigure the clients. However, they will be visible now, so… */
387 render_workspace(global_conn, output, ws);
389 /* …unless we want to see them at the moment, we should hide that workspace */
390 if (visible && !hide_it)
393 /* however, if this is the current workspace, we only need to adjust
394 * the output’s current_workspace pointer (and must not unmap the
397 DLOG("Need to adjust output->current_workspace...\n");
398 output->current_workspace = c_ws;
399 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
403 workspace_unmap_clients(global_conn, ws);
407 * Initializes the given workspace if it is not already initialized. The given
408 * screen is to be understood as a fallback, if the workspace itself either
409 * was not assigned to a particular screen or cannot be placed there because
410 * the screen is not attached at the moment.
413 void workspace_initialize(Workspace *ws, Output *output, bool recheck) {
416 if (ws->output != NULL && !recheck) {
417 DLOG("Workspace already initialized\n");
421 old_output = ws->output;
423 /* If this workspace has no preferred output or if the output it wants
424 * to be on is not available at the moment, we initialize it with
425 * the output which was given */
426 if (ws->preferred_output == NULL ||
427 (ws->output = get_output_by_name(ws->preferred_output)) == NULL)
430 DLOG("old_output = %p, ws->output = %p\n", old_output, ws->output);
431 /* If the assignment did not change, we do not need to update anything */
432 if (old_output != NULL && ws->output == old_output)
435 workspace_assign_to(ws, ws->output, false);
439 * Gets the first unused workspace for the given screen, taking into account
440 * the preferred_output setting of every workspace (workspace assignments).
443 Workspace *get_first_workspace_for_output(Output *output) {
444 Workspace *result = NULL;
447 TAILQ_FOREACH(ws, workspaces, workspaces) {
448 if (ws->preferred_output == NULL ||
449 get_output_by_name(ws->preferred_output) != output)
456 if (result == NULL) {
457 /* No assignment found, returning first unused workspace */
458 TAILQ_FOREACH(ws, workspaces, workspaces) {
459 if (ws->output != NULL)
467 if (result == NULL) {
468 DLOG("No existing free workspace found to assign, creating a new one\n");
471 TAILQ_FOREACH(ws, workspaces, workspaces)
473 result = workspace_get(last_ws + 1, NULL);
476 workspace_initialize(result, output, false);
482 static bool get_urgency_flag(Con *con) {
484 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
485 if (child->urgent || get_urgency_flag(child))
488 TAILQ_FOREACH(child, &(con->floating_head), floating_windows)
489 if (child->urgent || get_urgency_flag(child))
496 * Goes through all clients on the given workspace and updates the workspace’s
497 * urgent flag accordingly.
500 void workspace_update_urgent_flag(Con *ws) {
501 bool old_flag = ws->urgent;
502 ws->urgent = get_urgency_flag(ws);
503 DLOG("Workspace urgency flag changed from %d to %d\n", old_flag, ws->urgent);
505 if (old_flag != ws->urgent)
506 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
510 * 'Forces' workspace orientation by moving all cons into a new split-con with
511 * the same orientation as the workspace and then changing the workspace
515 void ws_force_orientation(Con *ws, orientation_t orientation) {
516 /* 1: create a new split container */
517 Con *split = con_new(NULL);
520 /* 2: copy layout and orientation from workspace */
521 split->layout = ws->layout;
522 split->orientation = ws->orientation;
524 Con *old_focused = TAILQ_FIRST(&(ws->focus_head));
526 /* 3: move the existing cons of this workspace below the new con */
527 DLOG("Moving cons\n");
528 while (!TAILQ_EMPTY(&(ws->nodes_head))) {
529 Con *child = TAILQ_FIRST(&(ws->nodes_head));
531 con_attach(child, split, true);
534 /* 4: switch workspace orientation */
535 ws->orientation = orientation;
537 /* 5: attach the new split container to the workspace */
538 DLOG("Attaching new split to ws\n");
539 con_attach(split, ws, false);
541 /* 6: fix the percentages */
545 con_focus(old_focused);