2 #define I3__FILE__ "tree.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
9 * tree.c: Everything that primarily modifies the layout tree data structure.
17 struct all_cons_head all_cons = TAILQ_HEAD_INITIALIZER(all_cons);
20 * Create the pseudo-output __i3. Output-independent workspaces such as
21 * __i3_scratch will live there.
24 static Con *_create___i3(void) {
25 Con *__i3 = con_new(croot, NULL);
27 __i3->name = sstrdup("__i3");
28 __i3->type = CT_OUTPUT;
29 __i3->layout = L_OUTPUT;
30 con_fix_percent(croot);
31 x_set_name(__i3, "[i3 con] pseudo-output __i3");
32 /* For retaining the correct position/size of a scratchpad window, the
33 * dimensions of the real outputs should be multiples of the __i3
34 * pseudo-output. Ensuring that is the job of scratchpad_fix_resolution()
35 * which gets called after this function and after detecting all the
36 * outputs (or whenever an output changes). */
37 __i3->rect.width = 1280;
38 __i3->rect.height = 1024;
40 /* Add a content container. */
41 DLOG("adding main content container\n");
42 Con *content = con_new(NULL, NULL);
43 content->type = CT_CON;
45 content->name = sstrdup("content");
46 content->layout = L_SPLITH;
48 x_set_name(content, "[i3 con] content __i3");
49 con_attach(content, __i3, false);
51 /* Attach the __i3_scratch workspace. */
52 Con *ws = con_new(NULL, NULL);
53 ws->type = CT_WORKSPACE;
55 ws->name = sstrdup("__i3_scratch");
56 ws->layout = L_SPLITH;
57 con_attach(ws, content, false);
58 x_set_name(ws, "[i3 con] workspace __i3_scratch");
59 ws->fullscreen_mode = CF_OUTPUT;
65 * Loads tree from 'path' (used for in-place restarts).
68 bool tree_restore(const char *path, xcb_get_geometry_reply_t *geometry) {
69 char *globbed = resolve_tilde(path);
71 if (!path_exists(globbed)) {
72 LOG("%s does not exist, not restoring tree\n", globbed);
77 /* TODO: refactor the following */
78 croot = con_new(NULL, NULL);
86 tree_append_json(focused, globbed, NULL);
89 DLOG("appended tree, using new root\n");
90 croot = TAILQ_FIRST(&(croot->nodes_head));
91 DLOG("new root = %p\n", croot);
92 Con *out = TAILQ_FIRST(&(croot->nodes_head));
93 DLOG("out = %p\n", out);
94 Con *ws = TAILQ_FIRST(&(out->nodes_head));
95 DLOG("ws = %p\n", ws);
97 /* For in-place restarting into v4.2, we need to make sure the new
98 * pseudo-output __i3 is present. */
99 if (strcmp(out->name, "__i3") != 0) {
100 DLOG("Adding pseudo-output __i3 during inplace restart\n");
101 Con *__i3 = _create___i3();
102 /* Ensure that it is the first output, other places in the code make
103 * that assumption. */
104 TAILQ_REMOVE(&(croot->nodes_head), __i3, nodes);
105 TAILQ_INSERT_HEAD(&(croot->nodes_head), __i3, nodes);
108 restore_open_placeholder_windows(croot);
114 * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
115 * root node are created in randr.c for each Output.
118 void tree_init(xcb_get_geometry_reply_t *geometry) {
119 croot = con_new(NULL, NULL);
121 croot->name = "root";
122 croot->type = CT_ROOT;
123 croot->layout = L_SPLITH;
124 croot->rect = (Rect){
134 * Opens an empty container in the current container
137 Con *tree_open_con(Con *con, i3Window *window) {
139 /* every focusable Con has a parent (outputs have parent root) */
140 con = focused->parent;
141 /* If the parent is an output, we are on a workspace. In this case,
142 * the new container needs to be opened as a leaf of the workspace. */
143 if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
147 /* If the currently focused container is a floating container, we
148 * attach the new container to the currently focused spot in its
150 if (con->type == CT_FLOATING_CON) {
151 con = con_descend_tiling_focused(con->parent);
152 if (con->type != CT_WORKSPACE)
155 DLOG("con = %p\n", con);
160 /* 3. create the container and attach it to its parent */
161 Con *new = con_new(con, window);
162 new->layout = L_SPLITH;
164 /* 4: re-calculate child->percent for each child */
165 con_fix_percent(con);
170 static bool _is_con_mapped(Con *con) {
173 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
174 if (_is_con_mapped(child))
181 * Closes the given container including all children.
182 * Returns true if the container was killed or false if just WM_DELETE was sent
183 * and the window is expected to kill itself.
185 * The dont_kill_parent flag is specified when the function calls itself
186 * recursively while deleting a containers children.
188 * The force_set_focus flag is specified in the case of killing a floating
189 * window: tree_close_internal() will be invoked for the CT_FLOATINGCON (the parent
190 * container) and focus should be set there.
193 bool tree_close_internal(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus) {
194 bool was_mapped = con->mapped;
195 Con *parent = con->parent;
198 /* Even if the container itself is not mapped, its children may be
199 * mapped (for example split containers don't have a mapped window on
200 * their own but usually contain mapped children). */
201 was_mapped = _is_con_mapped(con);
204 /* remove the urgency hint of the workspace (if set) */
206 con_set_urgency(con, false);
207 con_update_parents_urgency(con);
208 workspace_update_urgent_flag(con_get_workspace(con));
211 /* Get the container which is next focused */
212 Con *next = con_next_focused(con);
213 DLOG("next = %p, focused = %p\n", next, focused);
215 DLOG("closing %p, kill_window = %d\n", con, kill_window);
216 Con *child, *nextchild;
217 bool abort_kill = false;
218 /* We cannot use TAILQ_FOREACH because the children get deleted
219 * in their parent’s nodes_head */
220 for (child = TAILQ_FIRST(&(con->nodes_head)); child;) {
221 nextchild = TAILQ_NEXT(child, nodes);
222 DLOG("killing child=%p\n", child);
223 if (!tree_close_internal(child, kill_window, true, false))
229 DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
233 if (con->window != NULL) {
234 if (kill_window != DONT_KILL_WINDOW) {
235 x_window_kill(con->window->id, kill_window);
238 xcb_void_cookie_t cookie;
239 /* Ignore any further events by clearing the event mask,
241 * then reparent it to the root window. */
242 xcb_change_window_attributes(conn, con->window->id,
243 XCB_CW_EVENT_MASK, (uint32_t[]){XCB_NONE});
244 xcb_unmap_window(conn, con->window->id);
245 cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
247 /* Ignore X11 errors for the ReparentWindow request.
248 * X11 Errors are returned when the window was already destroyed */
249 add_ignore_event(cookie.sequence, 0);
251 /* We are no longer handling this window, thus set WM_STATE to
252 * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
253 long data[] = {XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE};
254 cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
255 con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
257 /* Remove the window from the save set. All windows in the save set
258 * will be mapped when i3 closes its connection (e.g. when
259 * restarting). This is not what we want, since some apps keep
260 * unmapped windows around and don’t expect them to suddenly be
261 * mapped. See http://bugs.i3wm.org/1617 */
262 xcb_change_save_set(conn, XCB_SET_MODE_DELETE, con->window->id);
264 /* Ignore X11 errors for the ReparentWindow request.
265 * X11 Errors are returned when the window was already destroyed */
266 add_ignore_event(cookie.sequence, 0);
268 ipc_send_window_event("close", con);
269 window_free(con->window);
273 Con *ws = con_get_workspace(con);
275 /* Figure out which container to focus next before detaching 'con'. */
276 if (con_is_floating(con)) {
277 if (con == focused) {
278 DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
279 next = con_next_focused(parent);
281 dont_kill_parent = true;
282 DLOG("Alright, focusing %p\n", next);
288 /* Detach the container so that it will not be rendered anymore. */
291 /* disable urgency timer, if needed */
292 if (con->urgency_timer != NULL) {
293 DLOG("Removing urgency timer of con %p\n", con);
294 workspace_update_urgent_flag(ws);
295 ev_timer_stop(main_loop, con->urgency_timer);
296 FREE(con->urgency_timer);
299 if (con->type != CT_FLOATING_CON) {
300 /* If the container is *not* floating, we might need to re-distribute
301 * percentage values for the resized containers. */
302 con_fix_percent(parent);
305 /* Render the tree so that the surrounding containers take up the space
306 * which 'con' does no longer occupy. If we don’t render here, there will
307 * be a gap in our containers and that could trigger an EnterNotify for an
308 * underlying container, see ticket #660.
310 * Rendering has to be avoided when dont_kill_parent is set (when
311 * tree_close_internal calls itself recursively) because the tree is in a
312 * non-renderable state during that time. */
313 if (!dont_kill_parent)
316 /* kill the X11 part of this container */
319 if (con_is_floating(con)) {
320 DLOG("Container was floating, killing floating container\n");
321 tree_close_internal(parent, DONT_KILL_WINDOW, false, (con == focused));
322 DLOG("parent container killed\n");
326 FREE(con->deco_render_params);
327 TAILQ_REMOVE(&all_cons, con, all_cons);
328 while (!TAILQ_EMPTY(&(con->swallow_head))) {
329 Match *match = TAILQ_FIRST(&(con->swallow_head));
330 TAILQ_REMOVE(&(con->swallow_head), match, matches);
336 /* in the case of floating windows, we already focused another container
337 * when closing the parent, so we can exit now. */
339 DLOG("No next container, i will just exit now\n");
343 if (was_mapped || con == focused) {
344 if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
345 DLOG("focusing %p / %s\n", next, next->name);
346 if (next->type == CT_DOCKAREA) {
347 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
348 con_focus(con_descend_focused(output_get_content(next->parent)));
350 if (!force_set_focus && con != focused)
351 DLOG("not changing focus, the container was not focused before\n");
356 DLOG("not focusing because we're not killing anybody\n");
359 DLOG("not focusing, was not mapped\n");
362 /* check if the parent container is empty now and close it */
363 if (!dont_kill_parent)
364 CALL(parent, on_remove_child);
370 * Splits (horizontally or vertically) the given container by creating a new
371 * container which contains the old one and the future ones.
374 void tree_split(Con *con, orientation_t orientation) {
375 if (con_is_floating(con)) {
376 DLOG("Floating containers can't be split.\n");
380 if (con->type == CT_WORKSPACE) {
381 if (con_num_children(con) < 2) {
382 DLOG("Just changing orientation of workspace\n");
383 con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
386 /* if there is more than one container on the workspace
387 * move them into a new container and handle this instead */
388 con = workspace_encapsulate(con);
392 Con *parent = con->parent;
394 /* Force re-rendering to make the indicator border visible. */
395 con_force_split_parents_redraw(con);
397 /* if we are in a container whose parent contains only one
398 * child (its split functionality is unused so far), we just change the
399 * orientation (more intuitive than splitting again) */
400 if (con_num_children(parent) == 1 &&
401 (parent->layout == L_SPLITH ||
402 parent->layout == L_SPLITV)) {
403 parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
404 DLOG("Just changing orientation of existing container\n");
408 DLOG("Splitting in orientation %d\n", orientation);
410 /* 2: replace it with a new Con */
411 Con *new = con_new(NULL, NULL);
412 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
413 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
414 new->parent = parent;
415 new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
417 /* 3: swap 'percent' (resize factor) */
418 new->percent = con->percent;
421 /* 4: add it as a child to the new Con */
422 con_attach(con, new, false);
426 * Moves focus one level up. Returns true if focus changed.
429 bool level_up(void) {
430 /* Skip over floating containers and go directly to the grandparent
431 * (which should always be a workspace) */
432 if (focused->parent->type == CT_FLOATING_CON) {
433 con_focus(focused->parent->parent);
437 /* We can focus up to the workspace, but not any higher in the tree */
438 if ((focused->parent->type != CT_CON &&
439 focused->parent->type != CT_WORKSPACE) ||
440 focused->type == CT_WORKSPACE) {
441 ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
444 con_focus(focused->parent);
449 * Moves focus one level down. Returns true if focus changed.
452 bool level_down(void) {
453 /* Go down the focus stack of the current node */
454 Con *next = TAILQ_FIRST(&(focused->focus_head));
455 if (next == TAILQ_END(&(focused->focus_head))) {
456 DLOG("cannot go down\n");
458 } else if (next->type == CT_FLOATING_CON) {
459 /* Floating cons shouldn't be directly focused; try immediately
460 * going to the grandchild of the focused con. */
461 Con *child = TAILQ_FIRST(&(next->focus_head));
462 if (child == TAILQ_END(&(next->focus_head))) {
463 DLOG("cannot go down\n");
466 next = TAILQ_FIRST(&(next->focus_head));
473 static void mark_unmapped(Con *con) {
477 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
478 mark_unmapped(current);
479 if (con->type == CT_WORKSPACE) {
480 /* We need to call mark_unmapped on floating nodes aswell since we can
481 * make containers floating. */
482 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
483 mark_unmapped(current);
488 * Renders the tree, that is rendering all outputs using render_con() and
489 * pushing the changes to X11 using x_push_changes().
492 void tree_render(void) {
496 DLOG("-- BEGIN RENDERING --\n");
497 /* Reset map state for all nodes in tree */
498 /* TODO: a nicer method to walk all nodes would be good, maybe? */
499 mark_unmapped(croot);
500 croot->mapped = true;
502 render_con(croot, false);
504 x_push_changes(croot);
505 DLOG("-- END RENDERING --\n");
509 * Recursive function to walk the tree until a con can be found to focus.
512 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
513 /* When dealing with fullscreen containers, it's necessary to go up to the
514 * workspace level, because 'focus $dir' will start at the con's real
515 * position in the tree, and it may not be possible to get to the edge
516 * normally due to fullscreen focusing restrictions. */
517 if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
518 con = con_get_workspace(con);
520 /* Stop recursing at workspaces after attempting to switch to next
521 * workspace if possible. */
522 if (con->type == CT_WORKSPACE) {
523 if (con_get_fullscreen_con(con, CF_GLOBAL)) {
524 DLOG("Cannot change workspace while in global fullscreen mode.\n");
527 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
532 DLOG("Current output is %s\n", current_output->name);
534 /* Try to find next output */
535 direction_t direction;
536 if (way == 'n' && orientation == HORIZ)
538 else if (way == 'p' && orientation == HORIZ)
540 else if (way == 'n' && orientation == VERT)
542 else if (way == 'p' && orientation == VERT)
547 next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
550 DLOG("Next output is %s\n", next_output->name);
552 /* Find visible workspace on next output */
553 Con *workspace = NULL;
554 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
556 /* Show next workspace and focus appropriate container if possible. */
560 workspace_show(workspace);
562 /* If a workspace has an active fullscreen container, one of its
563 * children should always be focused. The above workspace_show()
564 * should be adequate for that, so return. */
565 if (con_get_fullscreen_con(workspace, CF_OUTPUT))
568 Con *focus = con_descend_direction(workspace, direction);
570 /* special case: if there was no tiling con to focus and the workspace
571 * has a floating con in the focus stack, focus the top of the focus
572 * stack (which may be floating) */
573 if (focus == workspace)
574 focus = con_descend_focused(workspace);
578 x_set_warp_to(&(focus->rect));
583 Con *parent = con->parent;
585 if (con->type == CT_FLOATING_CON) {
586 if (orientation != HORIZ)
589 /* left/right focuses the previous/next floating container */
592 next = TAILQ_NEXT(con, floating_windows);
594 next = TAILQ_PREV(con, floating_head, floating_windows);
596 /* If there is no next/previous container, wrap */
599 next = TAILQ_FIRST(&(parent->floating_head));
601 next = TAILQ_LAST(&(parent->floating_head), floating_head);
604 /* Still no next/previous container? bail out */
608 /* Raise the floating window on top of other windows preserving
609 * relative stack order */
610 while (TAILQ_LAST(&(parent->floating_head), floating_head) != next) {
611 Con *last = TAILQ_LAST(&(parent->floating_head), floating_head);
612 TAILQ_REMOVE(&(parent->floating_head), last, floating_windows);
613 TAILQ_INSERT_HEAD(&(parent->floating_head), last, floating_windows);
616 con_focus(con_descend_focused(next));
620 /* If the orientation does not match or there is no other con to focus, we
621 * need to go higher in the hierarchy */
622 if (con_orientation(parent) != orientation ||
623 con_num_children(parent) == 1)
624 return _tree_next(parent, way, orientation, wrap);
626 Con *current = TAILQ_FIRST(&(parent->focus_head));
627 /* TODO: when can the following happen (except for floating windows, which
628 * are handled above)? */
629 if (TAILQ_EMPTY(&(parent->nodes_head))) {
630 DLOG("nothing to focus\n");
636 next = TAILQ_NEXT(current, nodes);
638 next = TAILQ_PREV(current, nodes_head, nodes);
641 if (!config.force_focus_wrapping) {
642 /* If there is no next/previous container, we check if we can focus one
643 * when going higher (without wrapping, though). If so, we are done, if
645 if (_tree_next(parent, way, orientation, false))
653 next = TAILQ_FIRST(&(parent->nodes_head));
655 next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
658 /* Don't violate fullscreen focus restrictions. */
659 if (!con_fullscreen_permits_focusing(next))
662 /* 3: focus choice comes in here. at the moment we will go down
663 * until we find a window */
664 /* TODO: check for window, atm we only go down as far as possible */
665 con_focus(con_descend_focused(next));
670 * Changes focus in the given way (next/previous) and given orientation
671 * (horizontal/vertical).
674 void tree_next(char way, orientation_t orientation) {
675 _tree_next(focused, way, orientation, true);
679 * tree_flatten() removes pairs of redundant split containers, e.g.:
680 * [workspace, horizontal]
684 * In this example, the v-split and h-split container are redundant.
685 * Such a situation can be created by moving containers in a direction which is
686 * not the orientation of their parent container. i3 needs to create a new
687 * split container then and if you move containers this way multiple times,
688 * redundant chains of split-containers can be the result.
691 void tree_flatten(Con *con) {
692 Con *current, *child, *parent = con->parent;
693 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
695 /* We only consider normal containers without windows */
696 if (con->type != CT_CON ||
697 parent->layout == L_OUTPUT || /* con == "content" */
701 /* Ensure it got only one child */
702 child = TAILQ_FIRST(&(con->nodes_head));
703 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
706 DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
708 /* The child must have a different orientation than the con but the same as
709 * the con’s parent to be redundant */
710 if (!con_is_split(con) ||
711 !con_is_split(child) ||
712 (con->layout != L_SPLITH && con->layout != L_SPLITV) ||
713 (child->layout != L_SPLITH && child->layout != L_SPLITV) ||
714 con_orientation(con) == con_orientation(child) ||
715 con_orientation(child) != con_orientation(parent))
718 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
720 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
722 DLOG("detaching...\n");
723 /* 2: re-attach the children to the parent before con */
724 while (!TAILQ_EMPTY(&(child->nodes_head))) {
725 current = TAILQ_FIRST(&(child->nodes_head));
726 DLOG("detaching current=%p / %s\n", current, current->name);
728 DLOG("re-attaching\n");
729 /* We don’t use con_attach() here because for a CT_CON, the special
730 * case handling of con_attach() does not trigger. So all it would do
731 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
732 * directly use the TAILQ macros. */
733 current->parent = parent;
734 TAILQ_INSERT_BEFORE(con, current, nodes);
735 DLOG("attaching to focus list\n");
736 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
737 current->percent = con->percent;
739 DLOG("re-attached all\n");
741 /* 3: restore focus, if con was focused */
742 if (focus_next != NULL &&
743 TAILQ_FIRST(&(parent->focus_head)) == con) {
744 DLOG("restoring focus to focus_next=%p\n", focus_next);
745 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
746 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
747 DLOG("restored focus.\n");
750 /* 4: close the redundant cons */
751 DLOG("closing redundant cons\n");
752 tree_close_internal(con, DONT_KILL_WINDOW, true, false);
754 /* Well, we got to abort the recursion here because we destroyed the
755 * container. However, if tree_flatten() is called sufficiently often,
756 * there can’t be the situation of having two pairs of redundant containers
757 * at once. Therefore, we can safely abort the recursion on this level
758 * after flattening. */
762 /* We cannot use normal foreach here because tree_flatten might close the
763 * current container. */
764 current = TAILQ_FIRST(&(con->nodes_head));
765 while (current != NULL) {
766 Con *next = TAILQ_NEXT(current, nodes);
767 tree_flatten(current);
771 current = TAILQ_FIRST(&(con->floating_head));
772 while (current != NULL) {
773 Con *next = TAILQ_NEXT(current, floating_windows);
774 tree_flatten(current);