2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * tree.c: Everything that primarily modifies the layout tree data structure.
15 struct all_cons_head all_cons = TAILQ_HEAD_INITIALIZER(all_cons);
18 * Create the pseudo-output __i3. Output-independent workspaces such as
19 * __i3_scratch will live there.
22 static Con *_create___i3(void) {
23 Con *__i3 = con_new(croot, NULL);
25 __i3->name = sstrdup("__i3");
26 __i3->type = CT_OUTPUT;
27 __i3->layout = L_OUTPUT;
28 con_fix_percent(croot);
29 x_set_name(__i3, "[i3 con] pseudo-output __i3");
30 /* For retaining the correct position/size of a scratchpad window, the
31 * dimensions of the real outputs should be multiples of the __i3
32 * pseudo-output. Ensuring that is the job of scratchpad_fix_resolution()
33 * which gets called after this function and after detecting all the
34 * outputs (or whenever an output changes). */
35 __i3->rect.width = 1280;
36 __i3->rect.height = 1024;
38 /* Add a content container. */
39 DLOG("adding main content container\n");
40 Con *content = con_new(NULL, NULL);
41 content->type = CT_CON;
43 content->name = sstrdup("content");
44 content->layout = L_SPLITH;
46 x_set_name(content, "[i3 con] content __i3");
47 con_attach(content, __i3, false);
49 /* Attach the __i3_scratch workspace. */
50 Con *ws = con_new(NULL, NULL);
51 ws->type = CT_WORKSPACE;
53 ws->name = sstrdup("__i3_scratch");
54 ws->layout = L_SPLITH;
55 con_attach(ws, content, false);
56 x_set_name(ws, "[i3 con] workspace __i3_scratch");
57 ws->fullscreen_mode = CF_OUTPUT;
63 * Loads tree from 'path' (used for in-place restarts).
66 bool tree_restore(const char *path, xcb_get_geometry_reply_t *geometry) {
68 char *globbed = resolve_tilde(path);
71 if (!path_exists(globbed)) {
72 LOG("%s does not exist, not restoring tree\n", globbed);
77 if ((len = slurp(globbed, &buf)) < 0) {
78 /* slurp already logged an error. */
82 /* TODO: refactor the following */
83 croot = con_new(NULL, NULL);
91 tree_append_json(focused, buf, len, NULL);
93 DLOG("appended tree, using new root\n");
94 croot = TAILQ_FIRST(&(croot->nodes_head));
95 DLOG("new root = %p\n", croot);
96 Con *out = TAILQ_FIRST(&(croot->nodes_head));
97 DLOG("out = %p\n", out);
98 Con *ws = TAILQ_FIRST(&(out->nodes_head));
99 DLOG("ws = %p\n", ws);
101 /* For in-place restarting into v4.2, we need to make sure the new
102 * pseudo-output __i3 is present. */
103 if (strcmp(out->name, "__i3") != 0) {
104 DLOG("Adding pseudo-output __i3 during inplace restart\n");
105 Con *__i3 = _create___i3();
106 /* Ensure that it is the first output, other places in the code make
107 * that assumption. */
108 TAILQ_REMOVE(&(croot->nodes_head), __i3, nodes);
109 TAILQ_INSERT_HEAD(&(croot->nodes_head), __i3, nodes);
112 restore_open_placeholder_windows(croot);
122 * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
123 * root node are created in randr.c for each Output.
126 void tree_init(xcb_get_geometry_reply_t *geometry) {
127 croot = con_new(NULL, NULL);
129 croot->name = "root";
130 croot->type = CT_ROOT;
131 croot->layout = L_SPLITH;
132 croot->rect = (Rect){
142 * Opens an empty container in the current container
145 Con *tree_open_con(Con *con, i3Window *window) {
147 /* every focusable Con has a parent (outputs have parent root) */
148 con = focused->parent;
149 /* If the parent is an output, we are on a workspace. In this case,
150 * the new container needs to be opened as a leaf of the workspace. */
151 if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
155 /* If the currently focused container is a floating container, we
156 * attach the new container to the currently focused spot in its
158 if (con->type == CT_FLOATING_CON) {
159 con = con_descend_tiling_focused(con->parent);
160 if (con->type != CT_WORKSPACE)
163 DLOG("con = %p\n", con);
168 /* 3. create the container and attach it to its parent */
169 Con *new = con_new(con, window);
170 new->layout = L_SPLITH;
172 /* 4: re-calculate child->percent for each child */
173 con_fix_percent(con);
178 static bool _is_con_mapped(Con *con) {
181 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
182 if (_is_con_mapped(child))
189 * Closes the given container including all children.
190 * Returns true if the container was killed or false if just WM_DELETE was sent
191 * and the window is expected to kill itself.
193 * The dont_kill_parent flag is specified when the function calls itself
194 * recursively while deleting a containers children.
196 * The force_set_focus flag is specified in the case of killing a floating
197 * window: tree_close_internal() will be invoked for the CT_FLOATINGCON (the parent
198 * container) and focus should be set there.
201 bool tree_close_internal(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus) {
202 bool was_mapped = con->mapped;
203 Con *parent = con->parent;
206 /* Even if the container itself is not mapped, its children may be
207 * mapped (for example split containers don't have a mapped window on
208 * their own but usually contain mapped children). */
209 was_mapped = _is_con_mapped(con);
212 /* remove the urgency hint of the workspace (if set) */
214 con_set_urgency(con, false);
215 con_update_parents_urgency(con);
216 workspace_update_urgent_flag(con_get_workspace(con));
219 /* Get the container which is next focused */
220 Con *next = con_next_focused(con);
221 DLOG("next = %p, focused = %p\n", next, focused);
223 DLOG("closing %p, kill_window = %d\n", con, kill_window);
224 Con *child, *nextchild;
225 bool abort_kill = false;
226 /* We cannot use TAILQ_FOREACH because the children get deleted
227 * in their parent’s nodes_head */
228 for (child = TAILQ_FIRST(&(con->nodes_head)); child;) {
229 nextchild = TAILQ_NEXT(child, nodes);
230 DLOG("killing child=%p\n", child);
231 if (!tree_close_internal(child, kill_window, true, false))
237 DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
241 if (con->window != NULL) {
242 if (kill_window != DONT_KILL_WINDOW) {
243 x_window_kill(con->window->id, kill_window);
246 xcb_void_cookie_t cookie;
247 /* Ignore any further events by clearing the event mask,
249 * then reparent it to the root window. */
250 xcb_change_window_attributes(conn, con->window->id,
251 XCB_CW_EVENT_MASK, (uint32_t[]){XCB_NONE});
252 xcb_unmap_window(conn, con->window->id);
253 cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
255 /* Ignore X11 errors for the ReparentWindow request.
256 * X11 Errors are returned when the window was already destroyed */
257 add_ignore_event(cookie.sequence, 0);
259 /* We are no longer handling this window, thus set WM_STATE to
260 * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
261 long data[] = {XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE};
262 cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
263 con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
265 /* Remove the window from the save set. All windows in the save set
266 * will be mapped when i3 closes its connection (e.g. when
267 * restarting). This is not what we want, since some apps keep
268 * unmapped windows around and don’t expect them to suddenly be
269 * mapped. See https://bugs.i3wm.org/1617 */
270 xcb_change_save_set(conn, XCB_SET_MODE_DELETE, con->window->id);
272 /* Ignore X11 errors for the ReparentWindow request.
273 * X11 Errors are returned when the window was already destroyed */
274 add_ignore_event(cookie.sequence, 0);
276 ipc_send_window_event("close", con);
277 window_free(con->window);
281 Con *ws = con_get_workspace(con);
283 /* Figure out which container to focus next before detaching 'con'. */
284 if (con_is_floating(con)) {
285 if (con == focused) {
286 DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
287 next = con_next_focused(parent);
289 dont_kill_parent = true;
290 DLOG("Alright, focusing %p\n", next);
296 /* Detach the container so that it will not be rendered anymore. */
299 /* disable urgency timer, if needed */
300 if (con->urgency_timer != NULL) {
301 DLOG("Removing urgency timer of con %p\n", con);
302 workspace_update_urgent_flag(ws);
303 ev_timer_stop(main_loop, con->urgency_timer);
304 FREE(con->urgency_timer);
307 if (con->type != CT_FLOATING_CON) {
308 /* If the container is *not* floating, we might need to re-distribute
309 * percentage values for the resized containers. */
310 con_fix_percent(parent);
313 /* Render the tree so that the surrounding containers take up the space
314 * which 'con' does no longer occupy. If we don’t render here, there will
315 * be a gap in our containers and that could trigger an EnterNotify for an
316 * underlying container, see ticket #660.
318 * Rendering has to be avoided when dont_kill_parent is set (when
319 * tree_close_internal calls itself recursively) because the tree is in a
320 * non-renderable state during that time. */
321 if (!dont_kill_parent)
324 /* kill the X11 part of this container */
327 if (con_is_floating(con)) {
328 DLOG("Container was floating, killing floating container\n");
329 tree_close_internal(parent, DONT_KILL_WINDOW, false, (con == focused));
330 DLOG("parent container killed\n");
334 DLOG("Closing a workspace container, updating EWMH atoms\n");
335 ewmh_update_number_of_desktops();
336 ewmh_update_desktop_names();
337 ewmh_update_wm_desktop();
342 /* in the case of floating windows, we already focused another container
343 * when closing the parent, so we can exit now. */
345 DLOG("No next container, i will just exit now\n");
349 if (was_mapped || con == focused) {
350 if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
351 DLOG("focusing %p / %s\n", next, next->name);
352 if (next->type == CT_DOCKAREA) {
353 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
354 con_activate(con_descend_focused(output_get_content(next->parent)));
356 if (!force_set_focus && con != focused)
357 DLOG("not changing focus, the container was not focused before\n");
362 DLOG("not focusing because we're not killing anybody\n");
365 DLOG("not focusing, was not mapped\n");
368 /* check if the parent container is empty now and close it */
369 if (!dont_kill_parent)
370 CALL(parent, on_remove_child);
376 * Splits (horizontally or vertically) the given container by creating a new
377 * container which contains the old one and the future ones.
380 void tree_split(Con *con, orientation_t orientation) {
381 if (con_is_floating(con)) {
382 DLOG("Floating containers can't be split.\n");
386 if (con->type == CT_WORKSPACE) {
387 if (con_num_children(con) < 2) {
388 if (con_num_children(con) == 0) {
389 DLOG("Changing workspace_layout to L_DEFAULT\n");
390 con->workspace_layout = L_DEFAULT;
392 DLOG("Changing orientation of workspace\n");
393 con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
396 /* if there is more than one container on the workspace
397 * move them into a new container and handle this instead */
398 con = workspace_encapsulate(con);
402 Con *parent = con->parent;
404 /* Force re-rendering to make the indicator border visible. */
405 con_force_split_parents_redraw(con);
407 /* if we are in a container whose parent contains only one
408 * child (its split functionality is unused so far), we just change the
409 * orientation (more intuitive than splitting again) */
410 if (con_num_children(parent) == 1 &&
411 (parent->layout == L_SPLITH ||
412 parent->layout == L_SPLITV)) {
413 parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
414 DLOG("Just changing orientation of existing container\n");
418 DLOG("Splitting in orientation %d\n", orientation);
420 /* 2: replace it with a new Con */
421 Con *new = con_new(NULL, NULL);
422 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
423 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
424 new->parent = parent;
425 new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
427 /* 3: swap 'percent' (resize factor) */
428 new->percent = con->percent;
431 /* 4: add it as a child to the new Con */
432 con_attach(con, new, false);
436 * Moves focus one level up. Returns true if focus changed.
439 bool level_up(void) {
440 /* Skip over floating containers and go directly to the grandparent
441 * (which should always be a workspace) */
442 if (focused->parent->type == CT_FLOATING_CON) {
443 con_activate(focused->parent->parent);
447 /* We can focus up to the workspace, but not any higher in the tree */
448 if ((focused->parent->type != CT_CON &&
449 focused->parent->type != CT_WORKSPACE) ||
450 focused->type == CT_WORKSPACE) {
451 ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
454 con_activate(focused->parent);
459 * Moves focus one level down. Returns true if focus changed.
462 bool level_down(void) {
463 /* Go down the focus stack of the current node */
464 Con *next = TAILQ_FIRST(&(focused->focus_head));
465 if (next == TAILQ_END(&(focused->focus_head))) {
466 DLOG("cannot go down\n");
468 } else if (next->type == CT_FLOATING_CON) {
469 /* Floating cons shouldn't be directly focused; try immediately
470 * going to the grandchild of the focused con. */
471 Con *child = TAILQ_FIRST(&(next->focus_head));
472 if (child == TAILQ_END(&(next->focus_head))) {
473 DLOG("cannot go down\n");
476 next = TAILQ_FIRST(&(next->focus_head));
483 static void mark_unmapped(Con *con) {
487 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
488 mark_unmapped(current);
489 if (con->type == CT_WORKSPACE) {
490 /* We need to call mark_unmapped on floating nodes as well since we can
491 * make containers floating. */
492 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
493 mark_unmapped(current);
498 * Renders the tree, that is rendering all outputs using render_con() and
499 * pushing the changes to X11 using x_push_changes().
502 void tree_render(void) {
506 DLOG("-- BEGIN RENDERING --\n");
507 /* Reset map state for all nodes in tree */
508 /* TODO: a nicer method to walk all nodes would be good, maybe? */
509 mark_unmapped(croot);
510 croot->mapped = true;
512 render_con(croot, false);
514 x_push_changes(croot);
515 DLOG("-- END RENDERING --\n");
519 * Recursive function to walk the tree until a con can be found to focus.
522 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
523 /* When dealing with fullscreen containers, it's necessary to go up to the
524 * workspace level, because 'focus $dir' will start at the con's real
525 * position in the tree, and it may not be possible to get to the edge
526 * normally due to fullscreen focusing restrictions. */
527 if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
528 con = con_get_workspace(con);
530 /* Stop recursing at workspaces after attempting to switch to next
531 * workspace if possible. */
532 if (con->type == CT_WORKSPACE) {
533 if (con_get_fullscreen_con(con, CF_GLOBAL)) {
534 DLOG("Cannot change workspace while in global fullscreen mode.\n");
537 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
542 DLOG("Current output is %s\n", output_primary_name(current_output));
544 /* Try to find next output */
545 direction_t direction;
546 if (way == 'n' && orientation == HORIZ)
548 else if (way == 'p' && orientation == HORIZ)
550 else if (way == 'n' && orientation == VERT)
552 else if (way == 'p' && orientation == VERT)
557 next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
560 DLOG("Next output is %s\n", output_primary_name(next_output));
562 /* Find visible workspace on next output */
563 Con *workspace = NULL;
564 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
566 /* Show next workspace and focus appropriate container if possible. */
570 Con *focus = con_descend_tiling_focused(workspace);
571 if (focus == workspace) {
572 focus = con_descend_focused(workspace);
575 workspace_show(workspace);
577 x_set_warp_to(&(focus->rect));
581 Con *parent = con->parent;
583 if (con->type == CT_FLOATING_CON) {
584 if (orientation != HORIZ)
587 /* left/right focuses the previous/next floating container */
590 next = TAILQ_NEXT(con, floating_windows);
592 next = TAILQ_PREV(con, floating_head, floating_windows);
594 /* If there is no next/previous container, wrap */
597 next = TAILQ_FIRST(&(parent->floating_head));
599 next = TAILQ_LAST(&(parent->floating_head), floating_head);
602 /* Still no next/previous container? bail out */
606 /* Raise the floating window on top of other windows preserving
607 * relative stack order */
608 while (TAILQ_LAST(&(parent->floating_head), floating_head) != next) {
609 Con *last = TAILQ_LAST(&(parent->floating_head), floating_head);
610 TAILQ_REMOVE(&(parent->floating_head), last, floating_windows);
611 TAILQ_INSERT_HEAD(&(parent->floating_head), last, floating_windows);
614 con_activate(con_descend_focused(next));
618 /* If the orientation does not match or there is no other con to focus, we
619 * need to go higher in the hierarchy */
620 if (con_orientation(parent) != orientation ||
621 con_num_children(parent) == 1)
622 return _tree_next(parent, way, orientation, wrap);
624 Con *current = TAILQ_FIRST(&(parent->focus_head));
625 /* TODO: when can the following happen (except for floating windows, which
626 * are handled above)? */
627 if (TAILQ_EMPTY(&(parent->nodes_head))) {
628 DLOG("nothing to focus\n");
634 next = TAILQ_NEXT(current, nodes);
636 next = TAILQ_PREV(current, nodes_head, nodes);
639 if (config.focus_wrapping != FOCUS_WRAPPING_FORCE) {
640 /* If there is no next/previous container, we check if we can focus one
641 * when going higher (without wrapping, though). If so, we are done, if
643 if (_tree_next(parent, way, orientation, false))
651 next = TAILQ_FIRST(&(parent->nodes_head));
653 next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
656 /* Don't violate fullscreen focus restrictions. */
657 if (!con_fullscreen_permits_focusing(next))
660 /* 3: focus choice comes in here. at the moment we will go down
661 * until we find a window */
662 /* TODO: check for window, atm we only go down as far as possible */
663 con_activate(con_descend_focused(next));
668 * Changes focus in the given way (next/previous) and given orientation
669 * (horizontal/vertical).
672 void tree_next(char way, orientation_t orientation) {
673 _tree_next(focused, way, orientation,
674 config.focus_wrapping != FOCUS_WRAPPING_OFF);
678 * tree_flatten() removes pairs of redundant split containers, e.g.:
679 * [workspace, horizontal]
683 * In this example, the v-split and h-split container are redundant.
684 * Such a situation can be created by moving containers in a direction which is
685 * not the orientation of their parent container. i3 needs to create a new
686 * split container then and if you move containers this way multiple times,
687 * redundant chains of split-containers can be the result.
690 void tree_flatten(Con *con) {
691 Con *current, *child, *parent = con->parent;
692 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
694 /* We only consider normal containers without windows */
695 if (con->type != CT_CON ||
696 parent->layout == L_OUTPUT || /* con == "content" */
700 /* Ensure it got only one child */
701 child = TAILQ_FIRST(&(con->nodes_head));
702 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
705 DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
707 /* The child must have a different orientation than the con but the same as
708 * the con’s parent to be redundant */
709 if (!con_is_split(con) ||
710 !con_is_split(child) ||
711 (con->layout != L_SPLITH && con->layout != L_SPLITV) ||
712 (child->layout != L_SPLITH && child->layout != L_SPLITV) ||
713 con_orientation(con) == con_orientation(child) ||
714 con_orientation(child) != con_orientation(parent))
717 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
719 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
721 DLOG("detaching...\n");
722 /* 2: re-attach the children to the parent before con */
723 while (!TAILQ_EMPTY(&(child->nodes_head))) {
724 current = TAILQ_FIRST(&(child->nodes_head));
725 DLOG("detaching current=%p / %s\n", current, current->name);
727 DLOG("re-attaching\n");
728 /* We don’t use con_attach() here because for a CT_CON, the special
729 * case handling of con_attach() does not trigger. So all it would do
730 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
731 * directly use the TAILQ macros. */
732 current->parent = parent;
733 TAILQ_INSERT_BEFORE(con, current, nodes);
734 DLOG("attaching to focus list\n");
735 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
736 current->percent = con->percent;
738 DLOG("re-attached all\n");
740 /* 3: restore focus, if con was focused */
741 if (focus_next != NULL &&
742 TAILQ_FIRST(&(parent->focus_head)) == con) {
743 DLOG("restoring focus to focus_next=%p\n", focus_next);
744 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
745 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
746 DLOG("restored focus.\n");
749 /* 4: close the redundant cons */
750 DLOG("closing redundant cons\n");
751 tree_close_internal(con, DONT_KILL_WINDOW, true, false);
753 /* Well, we got to abort the recursion here because we destroyed the
754 * container. However, if tree_flatten() is called sufficiently often,
755 * there can’t be the situation of having two pairs of redundant containers
756 * at once. Therefore, we can safely abort the recursion on this level
757 * after flattening. */
761 /* We cannot use normal foreach here because tree_flatten might close the
762 * current container. */
763 current = TAILQ_FIRST(&(con->nodes_head));
764 while (current != NULL) {
765 Con *next = TAILQ_NEXT(current, nodes);
766 tree_flatten(current);
770 current = TAILQ_FIRST(&(con->floating_head));
771 while (current != NULL) {
772 Con *next = TAILQ_NEXT(current, floating_windows);
773 tree_flatten(current);