2 #define I3__FILE__ "workspace.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
9 * workspace.c: Modifying workspaces, accessing them, moving containers to
15 /* Stores a copy of the name of the last used workspace for the workspace
16 * back-and-forth switching. */
17 static char *previous_workspace_name = NULL;
20 * Sets ws->layout to splith/splitv if default_orientation was specified in the
21 * configfile. Otherwise, it uses splith/splitv depending on whether the output
22 * is higher than wide.
25 static void _workspace_apply_default_orientation(Con *ws) {
26 /* If default_orientation is set to NO_ORIENTATION we determine
27 * orientation depending on output resolution. */
28 if (config.default_orientation == NO_ORIENTATION) {
29 Con *output = con_get_output(ws);
30 ws->layout = (output->rect.height > output->rect.width) ? L_SPLITV : L_SPLITH;
31 DLOG("Auto orientation. Workspace size set to (%d,%d), setting layout to %d.\n",
32 output->rect.width, output->rect.height, ws->layout);
34 ws->layout = (config.default_orientation == HORIZ) ? L_SPLITH : L_SPLITV;
39 * Returns a pointer to the workspace with the given number (starting at 0),
40 * creating the workspace if necessary (by allocating the necessary amount of
41 * memory and initializing the data structures correctly).
44 Con *workspace_get(const char *num, bool *created) {
45 Con *output, *workspace = NULL;
47 TAILQ_FOREACH(output, &(croot->nodes_head), nodes)
48 GREP_FIRST(workspace, output_get_content(output), !strcasecmp(child->name, num));
50 if (workspace == NULL) {
51 LOG("Creating new workspace \"%s\"\n", num);
52 /* unless an assignment is found, we will create this workspace on the current output */
53 output = con_get_output(focused);
54 /* look for assignments */
55 struct Workspace_Assignment *assignment;
56 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
57 if (strcmp(assignment->name, num) != 0)
60 LOG("Found workspace assignment to output \"%s\"\n", assignment->output);
61 GREP_FIRST(output, croot, !strcmp(child->name, assignment->output));
64 Con *content = output_get_content(output);
65 LOG("got output %p with content %p\n", output, content);
66 /* We need to attach this container after setting its type. con_attach
67 * will handle CT_WORKSPACEs differently */
68 workspace = con_new(NULL, NULL);
70 sasprintf(&name, "[i3 con] workspace %s", num);
71 x_set_name(workspace, name);
73 workspace->type = CT_WORKSPACE;
74 FREE(workspace->name);
75 workspace->name = sstrdup(num);
76 workspace->workspace_layout = config.default_layout;
77 /* We set ->num to the number if this workspace’s name begins with a
78 * positive number. Otherwise it’s a named ws and num will be -1. */
80 long parsed_num = strtol(num, &endptr, 10);
81 if (parsed_num == LONG_MIN ||
82 parsed_num == LONG_MAX ||
86 else workspace->num = parsed_num;
87 LOG("num = %d\n", workspace->num);
89 workspace->parent = content;
90 _workspace_apply_default_orientation(workspace);
92 con_attach(workspace, content, false);
94 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"init\"}");
98 else if (created != NULL) {
106 * Returns a pointer to a new workspace in the given output. The workspace
107 * is created attached to the tree hierarchy through the given content
111 Con *create_workspace_on_output(Output *output, Con *content) {
112 /* add a workspace to this output */
116 Con *ws = con_new(NULL, NULL);
117 ws->type = CT_WORKSPACE;
119 /* try the configured workspace bindings first to find a free name */
121 TAILQ_FOREACH(bind, bindings, bindings) {
122 DLOG("binding with command %s\n", bind->command);
123 if (strlen(bind->command) < strlen("workspace ") ||
124 strncasecmp(bind->command, "workspace", strlen("workspace")) != 0)
126 DLOG("relevant command = %s\n", bind->command);
127 char *target = bind->command + strlen("workspace ");
128 /* We check if this is the workspace
129 * next/prev/next_on_output/prev_on_output/back_and_forth/number command.
130 * Beware: The workspace names "next", "prev", "next_on_output",
131 * "prev_on_output", "number", "back_and_forth" and "current" are OK,
132 * so we check before stripping the double quotes */
133 if (strncasecmp(target, "next", strlen("next")) == 0 ||
134 strncasecmp(target, "prev", strlen("prev")) == 0 ||
135 strncasecmp(target, "next_on_output", strlen("next_on_output")) == 0 ||
136 strncasecmp(target, "prev_on_output", strlen("prev_on_output")) == 0 ||
137 strncasecmp(target, "number", strlen("number")) == 0 ||
138 strncasecmp(target, "back_and_forth", strlen("back_and_forth")) == 0 ||
139 strncasecmp(target, "current", strlen("current")) == 0)
144 ws->name = strdup(target);
145 if (ws->name[strlen(ws->name)-1] == '"')
146 ws->name[strlen(ws->name)-1] = '\0';
147 DLOG("trying name *%s*\n", ws->name);
149 /* Ensure that this workspace is not assigned to a different output —
150 * otherwise we would create it, then move it over to its output, then
151 * find a new workspace, etc… */
152 bool assigned = false;
153 struct Workspace_Assignment *assignment;
154 TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
155 if (strcmp(assignment->name, ws->name) != 0 ||
156 strcmp(assignment->output, output->name) == 0)
167 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
168 GREP_FIRST(current, output_get_content(out), !strcasecmp(child->name, ws->name));
170 exists = (current != NULL);
172 /* Set ->num to the number of the workspace, if the name actually
173 * is a number or starts with a number */
175 long parsed_num = strtol(ws->name, &endptr, 10);
176 if (parsed_num == LONG_MIN ||
177 parsed_num == LONG_MAX ||
181 else ws->num = parsed_num;
182 LOG("Used number %d for workspace with name %s\n", ws->num, ws->name);
189 /* get the next unused workspace number */
190 DLOG("Getting next unused workspace by number\n");
196 sasprintf(&(ws->name), "%d", c);
199 TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
200 GREP_FIRST(current, output_get_content(out), !strcasecmp(child->name, ws->name));
201 exists = (current != NULL);
203 DLOG("result for ws %s / %d: exists = %d\n", ws->name, c, exists);
207 con_attach(ws, content, false);
209 sasprintf(&name, "[i3 con] workspace %s", ws->name);
210 x_set_name(ws, name);
213 ws->fullscreen_mode = CF_OUTPUT;
215 ws->workspace_layout = config.default_layout;
216 _workspace_apply_default_orientation(ws);
223 * Returns true if the workspace is currently visible. Especially important for
224 * multi-monitor environments, as they can have multiple currenlty active
228 bool workspace_is_visible(Con *ws) {
229 Con *output = con_get_output(ws);
232 Con *fs = con_get_fullscreen_con(output, CF_OUTPUT);
233 LOG("workspace visible? fs = %p, ws = %p\n", fs, ws);
238 * XXX: we need to clean up all this recursive walking code.
241 Con *_get_sticky(Con *con, const char *sticky_group, Con *exclude) {
244 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
245 if (current != exclude &&
246 current->sticky_group != NULL &&
247 current->window != NULL &&
248 strcmp(current->sticky_group, sticky_group) == 0)
251 Con *recurse = _get_sticky(current, sticky_group, exclude);
256 TAILQ_FOREACH(current, &(con->floating_head), floating_windows) {
257 if (current != exclude &&
258 current->sticky_group != NULL &&
259 current->window != NULL &&
260 strcmp(current->sticky_group, sticky_group) == 0)
263 Con *recurse = _get_sticky(current, sticky_group, exclude);
272 * Reassigns all child windows in sticky containers. Called when the user
273 * changes workspaces.
275 * XXX: what about sticky containers which contain containers?
278 static void workspace_reassign_sticky(Con *con) {
280 /* 1: go through all containers */
282 /* handle all children and floating windows of this node */
283 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
284 if (current->sticky_group == NULL) {
285 workspace_reassign_sticky(current);
289 LOG("Ah, this one is sticky: %s / %p\n", current->name, current);
290 /* 2: find a window which we can re-assign */
291 Con *output = con_get_output(current);
292 Con *src = _get_sticky(output, current->sticky_group, current);
295 LOG("No window found for this sticky group\n");
296 workspace_reassign_sticky(current);
300 x_move_win(src, current);
301 current->window = src->window;
302 current->mapped = true;
306 x_reparent_child(current, src);
308 LOG("re-assigned window from src %p to dest %p\n", src, current);
311 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
312 workspace_reassign_sticky(current);
316 static void _workspace_show(Con *workspace) {
317 Con *current, *old = NULL;
319 /* safe-guard against showing i3-internal workspaces like __i3_scratch */
320 if (workspace->name[0] == '_' && workspace->name[1] == '_')
323 /* disable fullscreen for the other workspaces and get the workspace we are
325 TAILQ_FOREACH(current, &(workspace->parent->nodes_head), nodes) {
326 if (current->fullscreen_mode == CF_OUTPUT)
328 current->fullscreen_mode = CF_NONE;
331 /* enable fullscreen for the target workspace. If it happens to be the
332 * same one we are currently on anyways, we can stop here. */
333 workspace->fullscreen_mode = CF_OUTPUT;
334 current = con_get_workspace(focused);
335 if (workspace == current) {
336 DLOG("Not switching, already there.\n");
340 /* Remember currently focused workspace for switching back to it later with
341 * the 'workspace back_and_forth' command.
342 * NOTE: We have to duplicate the name as the original will be freed when
343 * the corresponding workspace is cleaned up.
344 * NOTE: Internal cons such as __i3_scratch (when a scratchpad window is
345 * focused) are skipped, see bug #868. */
346 if (current && !con_is_internal(current)) {
347 FREE(previous_workspace_name);
349 previous_workspace_name = sstrdup(current->name);
350 DLOG("Setting previous_workspace_name = %s\n", previous_workspace_name);
354 workspace_reassign_sticky(workspace);
356 LOG("switching to %p\n", workspace);
357 Con *next = con_descend_focused(workspace);
359 if (old && TAILQ_EMPTY(&(old->nodes_head)) && TAILQ_EMPTY(&(old->floating_head))) {
360 /* check if this workspace is currently visible */
361 if (!workspace_is_visible(old)) {
362 LOG("Closing old workspace (%p / %s), it is empty\n", old, old->name);
363 tree_close(old, DONT_KILL_WINDOW, false, false);
364 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
368 /* Memorize current output */
369 Con *old_output = con_get_output(focused);
372 workspace->fullscreen_mode = CF_OUTPUT;
373 LOG("focused now = %p / %s\n", focused, focused->name);
375 /* Set mouse pointer */
376 Con *new_output = con_get_output(focused);
377 if (old_output != new_output) {
378 x_set_warp_to(&next->rect);
381 /* Update the EWMH hints */
382 ewmh_update_current_desktop();
384 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
388 * Switches to the given workspace
391 void workspace_show(Con *workspace) {
392 _workspace_show(workspace);
396 * Looks up the workspace by name and switches to it.
399 void workspace_show_by_name(const char *num) {
401 bool changed_num_workspaces;
402 workspace = workspace_get(num, &changed_num_workspaces);
403 _workspace_show(workspace);
407 * Focuses the next workspace.
410 Con* workspace_next(void) {
411 Con *current = con_get_workspace(focused);
415 if (current->num == -1) {
416 /* If currently a named workspace, find next named workspace. */
417 next = TAILQ_NEXT(current, nodes);
419 /* If currently a numbered workspace, find next numbered workspace. */
420 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
421 /* Skip outputs starting with __, they are internal. */
422 if (output->name[0] == '_' && output->name[1] == '_')
424 NODES_FOREACH(output_get_content(output)) {
425 if (child->type != CT_WORKSPACE)
427 if (child->num == -1)
429 /* Need to check child against current and next because we are
430 * traversing multiple lists and thus are not guaranteed the
431 * relative order between the list of workspaces. */
432 if (current->num < child->num && (!next || child->num < next->num))
438 /* Find next named workspace. */
440 bool found_current = false;
441 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
442 /* Skip outputs starting with __, they are internal. */
443 if (output->name[0] == '_' && output->name[1] == '_')
445 NODES_FOREACH(output_get_content(output)) {
446 if (child->type != CT_WORKSPACE)
448 if (child == current) {
450 } else if (child->num == -1 && (current->num != -1 || found_current)) {
452 goto workspace_next_end;
458 /* Find first workspace. */
460 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
461 /* Skip outputs starting with __, they are internal. */
462 if (output->name[0] == '_' && output->name[1] == '_')
464 NODES_FOREACH(output_get_content(output)) {
465 if (child->type != CT_WORKSPACE)
467 if (!next || (child->num != -1 && child->num < next->num))
477 * Focuses the previous workspace.
480 Con* workspace_prev(void) {
481 Con *current = con_get_workspace(focused);
485 if (current->num == -1) {
486 /* If named workspace, find previous named workspace. */
487 prev = TAILQ_PREV(current, nodes_head, nodes);
488 if (prev && prev->num != -1)
491 /* If numbered workspace, find previous numbered workspace. */
492 TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
493 /* Skip outputs starting with __, they are internal. */
494 if (output->name[0] == '_' && output->name[1] == '_')
496 NODES_FOREACH_REVERSE(output_get_content(output)) {
497 if (child->type != CT_WORKSPACE || child->num == -1)
499 /* Need to check child against current and previous because we
500 * are traversing multiple lists and thus are not guaranteed
501 * the relative order between the list of workspaces. */
502 if (current->num > child->num && (!prev || child->num > prev->num))
508 /* Find previous named workspace. */
510 bool found_current = false;
511 TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
512 /* Skip outputs starting with __, they are internal. */
513 if (output->name[0] == '_' && output->name[1] == '_')
515 NODES_FOREACH_REVERSE(output_get_content(output)) {
516 if (child->type != CT_WORKSPACE)
518 if (child == current) {
519 found_current = true;
520 } else if (child->num == -1 && (current->num != -1 || found_current)) {
522 goto workspace_prev_end;
528 /* Find last workspace. */
530 TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
531 /* Skip outputs starting with __, they are internal. */
532 if (output->name[0] == '_' && output->name[1] == '_')
534 NODES_FOREACH_REVERSE(output_get_content(output)) {
535 if (child->type != CT_WORKSPACE)
537 if (!prev || child->num > prev->num)
549 * Focuses the next workspace on the same output.
552 Con* workspace_next_on_output(void) {
553 Con *current = con_get_workspace(focused);
555 Con *output = con_get_output(focused);
557 if (current->num == -1) {
558 /* If currently a named workspace, find next named workspace. */
559 next = TAILQ_NEXT(current, nodes);
561 /* If currently a numbered workspace, find next numbered workspace. */
562 NODES_FOREACH(output_get_content(output)) {
563 if (child->type != CT_WORKSPACE)
565 if (child->num == -1)
567 /* Need to check child against current and next because we are
568 * traversing multiple lists and thus are not guaranteed the
569 * relative order between the list of workspaces. */
570 if (current->num < child->num && (!next || child->num < next->num))
575 /* Find next named workspace. */
577 bool found_current = false;
578 NODES_FOREACH(output_get_content(output)) {
579 if (child->type != CT_WORKSPACE)
581 if (child == current) {
583 } else if (child->num == -1 && (current->num != -1 || found_current)) {
585 goto workspace_next_on_output_end;
590 /* Find first workspace. */
592 NODES_FOREACH(output_get_content(output)) {
593 if (child->type != CT_WORKSPACE)
595 if (!next || (child->num != -1 && child->num < next->num))
599 workspace_next_on_output_end:
604 * Focuses the previous workspace on same output.
607 Con* workspace_prev_on_output(void) {
608 Con *current = con_get_workspace(focused);
610 Con *output = con_get_output(focused);
611 DLOG("output = %s\n", output->name);
613 if (current->num == -1) {
614 /* If named workspace, find previous named workspace. */
615 prev = TAILQ_PREV(current, nodes_head, nodes);
616 if (prev && prev->num != -1)
619 /* If numbered workspace, find previous numbered workspace. */
620 NODES_FOREACH_REVERSE(output_get_content(output)) {
621 if (child->type != CT_WORKSPACE || child->num == -1)
623 /* Need to check child against current and previous because we
624 * are traversing multiple lists and thus are not guaranteed
625 * the relative order between the list of workspaces. */
626 if (current->num > child->num && (!prev || child->num > prev->num))
631 /* Find previous named workspace. */
633 bool found_current = false;
634 NODES_FOREACH_REVERSE(output_get_content(output)) {
635 if (child->type != CT_WORKSPACE)
637 if (child == current) {
638 found_current = true;
639 } else if (child->num == -1 && (current->num != -1 || found_current)) {
641 goto workspace_prev_on_output_end;
646 /* Find last workspace. */
648 NODES_FOREACH_REVERSE(output_get_content(output)) {
649 if (child->type != CT_WORKSPACE)
651 if (!prev || child->num > prev->num)
656 workspace_prev_on_output_end:
661 * Focuses the previously focused workspace.
664 void workspace_back_and_forth(void) {
665 if (!previous_workspace_name) {
666 DLOG("No previous workspace name set. Not switching.");
670 workspace_show_by_name(previous_workspace_name);
673 static bool get_urgency_flag(Con *con) {
675 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
676 if (child->urgent || get_urgency_flag(child))
679 TAILQ_FOREACH(child, &(con->floating_head), floating_windows)
680 if (child->urgent || get_urgency_flag(child))
687 * Goes through all clients on the given workspace and updates the workspace’s
688 * urgent flag accordingly.
691 void workspace_update_urgent_flag(Con *ws) {
692 bool old_flag = ws->urgent;
693 ws->urgent = get_urgency_flag(ws);
694 DLOG("Workspace urgency flag changed from %d to %d\n", old_flag, ws->urgent);
696 if (old_flag != ws->urgent)
697 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
701 * 'Forces' workspace orientation by moving all cons into a new split-con with
702 * the same layout as the workspace and then changing the workspace layout.
705 void ws_force_orientation(Con *ws, orientation_t orientation) {
706 /* 1: create a new split container */
707 Con *split = con_new(NULL, NULL);
711 /* 2: copy layout from workspace */
712 split->layout = ws->layout;
714 Con *old_focused = TAILQ_FIRST(&(ws->focus_head));
716 /* 3: move the existing cons of this workspace below the new con */
717 DLOG("Moving cons\n");
718 while (!TAILQ_EMPTY(&(ws->nodes_head))) {
719 Con *child = TAILQ_FIRST(&(ws->nodes_head));
721 con_attach(child, split, true);
724 /* 4: switch workspace layout */
725 ws->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
726 DLOG("split->layout = %d, ws->layout = %d\n", split->layout, ws->layout);
728 /* 5: attach the new split container to the workspace */
729 DLOG("Attaching new split (%p) to ws (%p)\n", split, ws);
730 con_attach(split, ws, false);
732 /* 6: fix the percentages */
736 con_focus(old_focused);
740 * Called when a new con (with a window, not an empty or split con) should be
741 * attached to the workspace (for example when managing a new window or when
742 * moving an existing window to the workspace level).
744 * Depending on the workspace_layout setting, this function either returns the
745 * workspace itself (default layout) or creates a new stacked/tabbed con and
749 Con *workspace_attach_to(Con *ws) {
750 DLOG("Attaching a window to workspace %p / %s\n", ws, ws->name);
752 if (ws->workspace_layout == L_DEFAULT) {
753 DLOG("Default layout, just attaching it to the workspace itself.\n");
757 DLOG("Non-default layout, creating a new split container\n");
758 /* 1: create a new split container */
759 Con *new = con_new(NULL, NULL);
763 /* 2: set the requested layout on the split con */
764 new->layout = ws->workspace_layout;
766 /* 4: attach the new split container to the workspace */
767 DLOG("Attaching new split %p to workspace %p\n", new, ws);
768 con_attach(new, ws, false);