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));
96 /* tree_append_json failed. Continuing here would segfault. */
99 DLOG("new root = %p\n", croot);
100 Con *out = TAILQ_FIRST(&(croot->nodes_head));
101 DLOG("out = %p\n", out);
102 Con *ws = TAILQ_FIRST(&(out->nodes_head));
103 DLOG("ws = %p\n", ws);
105 /* For in-place restarting into v4.2, we need to make sure the new
106 * pseudo-output __i3 is present. */
107 if (strcmp(out->name, "__i3") != 0) {
108 DLOG("Adding pseudo-output __i3 during inplace restart\n");
109 Con *__i3 = _create___i3();
110 /* Ensure that it is the first output, other places in the code make
111 * that assumption. */
112 TAILQ_REMOVE(&(croot->nodes_head), __i3, nodes);
113 TAILQ_INSERT_HEAD(&(croot->nodes_head), __i3, nodes);
116 restore_open_placeholder_windows(croot);
126 * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
127 * root node are created in randr.c for each Output.
130 void tree_init(xcb_get_geometry_reply_t *geometry) {
131 croot = con_new(NULL, NULL);
133 croot->name = "root";
134 croot->type = CT_ROOT;
135 croot->layout = L_SPLITH;
136 croot->rect = (Rect){
146 * Opens an empty container in the current container
149 Con *tree_open_con(Con *con, i3Window *window) {
151 /* every focusable Con has a parent (outputs have parent root) */
152 con = focused->parent;
153 /* If the parent is an output, we are on a workspace. In this case,
154 * the new container needs to be opened as a leaf of the workspace. */
155 if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
159 /* If the currently focused container is a floating container, we
160 * attach the new container to the currently focused spot in its
162 if (con->type == CT_FLOATING_CON) {
163 con = con_descend_tiling_focused(con->parent);
164 if (con->type != CT_WORKSPACE)
167 DLOG("con = %p\n", con);
172 /* 3. create the container and attach it to its parent */
173 Con *new = con_new(con, window);
174 new->layout = L_SPLITH;
176 /* 4: re-calculate child->percent for each child */
177 con_fix_percent(con);
183 * Closes the given container including all children.
184 * Returns true if the container was killed or false if just WM_DELETE was sent
185 * and the window is expected to kill itself.
187 * The dont_kill_parent flag is specified when the function calls itself
188 * recursively while deleting a containers children.
191 bool tree_close_internal(Con *con, kill_window_t kill_window, bool dont_kill_parent) {
192 Con *parent = con->parent;
194 /* remove the urgency hint of the workspace (if set) */
196 con_set_urgency(con, false);
197 con_update_parents_urgency(con);
198 workspace_update_urgent_flag(con_get_workspace(con));
201 DLOG("closing %p, kill_window = %d\n", con, kill_window);
202 Con *child, *nextchild;
203 bool abort_kill = false;
204 /* We cannot use TAILQ_FOREACH because the children get deleted
205 * in their parent’s nodes_head */
206 for (child = TAILQ_FIRST(&(con->nodes_head)); child;) {
207 nextchild = TAILQ_NEXT(child, nodes);
208 DLOG("killing child=%p\n", child);
209 if (!tree_close_internal(child, kill_window, true)) {
216 DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
220 if (con->window != NULL) {
221 if (kill_window != DONT_KILL_WINDOW) {
222 x_window_kill(con->window->id, kill_window);
225 xcb_void_cookie_t cookie;
226 /* Ignore any further events by clearing the event mask,
228 * then reparent it to the root window. */
229 xcb_change_window_attributes(conn, con->window->id,
230 XCB_CW_EVENT_MASK, (uint32_t[]){XCB_NONE});
231 xcb_unmap_window(conn, con->window->id);
232 cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
234 /* Ignore X11 errors for the ReparentWindow request.
235 * X11 Errors are returned when the window was already destroyed */
236 add_ignore_event(cookie.sequence, 0);
238 /* We are no longer handling this window, thus set WM_STATE to
239 * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
240 long data[] = {XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE};
241 cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
242 con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
244 /* Remove the window from the save set. All windows in the save set
245 * will be mapped when i3 closes its connection (e.g. when
246 * restarting). This is not what we want, since some apps keep
247 * unmapped windows around and don’t expect them to suddenly be
248 * mapped. See https://bugs.i3wm.org/1617 */
249 xcb_change_save_set(conn, XCB_SET_MODE_DELETE, con->window->id);
251 /* Stop receiving ShapeNotify events. */
252 if (shape_supported) {
253 xcb_shape_select_input(conn, con->window->id, false);
256 /* Ignore X11 errors for the ReparentWindow request.
257 * X11 Errors are returned when the window was already destroyed */
258 add_ignore_event(cookie.sequence, 0);
260 ipc_send_window_event("close", con);
261 window_free(con->window);
265 Con *ws = con_get_workspace(con);
267 /* Figure out which container to focus next before detaching 'con'. */
268 Con *next = (con == focused) ? con_next_focused(con) : NULL;
269 DLOG("next = %p, focused = %p\n", next, focused);
271 /* Detach the container so that it will not be rendered anymore. */
274 /* disable urgency timer, if needed */
275 if (con->urgency_timer != NULL) {
276 DLOG("Removing urgency timer of con %p\n", con);
277 workspace_update_urgent_flag(ws);
278 ev_timer_stop(main_loop, con->urgency_timer);
279 FREE(con->urgency_timer);
282 if (con->type != CT_FLOATING_CON) {
283 /* If the container is *not* floating, we might need to re-distribute
284 * percentage values for the resized containers. */
285 con_fix_percent(parent);
288 /* Render the tree so that the surrounding containers take up the space
289 * which 'con' does no longer occupy. If we don’t render here, there will
290 * be a gap in our containers and that could trigger an EnterNotify for an
291 * underlying container, see ticket #660.
293 * Rendering has to be avoided when dont_kill_parent is set (when
294 * tree_close_internal calls itself recursively) because the tree is in a
295 * non-renderable state during that time. */
296 if (!dont_kill_parent)
299 /* kill the X11 part of this container */
303 DLOG("Closing a workspace container, updating EWMH atoms\n");
304 ewmh_update_number_of_desktops();
305 ewmh_update_desktop_names();
306 ewmh_update_wm_desktop();
314 DLOG("not changing focus, the container was not focused before\n");
317 /* check if the parent container is empty now and close it */
318 if (!dont_kill_parent)
319 CALL(parent, on_remove_child);
325 * Splits (horizontally or vertically) the given container by creating a new
326 * container which contains the old one and the future ones.
329 void tree_split(Con *con, orientation_t orientation) {
330 if (con_is_floating(con)) {
331 DLOG("Floating containers can't be split.\n");
335 if (con->type == CT_WORKSPACE) {
336 if (con_num_children(con) < 2) {
337 if (con_num_children(con) == 0) {
338 DLOG("Changing workspace_layout to L_DEFAULT\n");
339 con->workspace_layout = L_DEFAULT;
341 DLOG("Changing orientation of workspace\n");
342 con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
345 /* if there is more than one container on the workspace
346 * move them into a new container and handle this instead */
347 con = workspace_encapsulate(con);
351 Con *parent = con->parent;
353 /* Force re-rendering to make the indicator border visible. */
354 con_force_split_parents_redraw(con);
356 /* if we are in a container whose parent contains only one
357 * child (its split functionality is unused so far), we just change the
358 * orientation (more intuitive than splitting again) */
359 if (con_num_children(parent) == 1 &&
360 (parent->layout == L_SPLITH ||
361 parent->layout == L_SPLITV)) {
362 parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
363 DLOG("Just changing orientation of existing container\n");
367 DLOG("Splitting in orientation %d\n", orientation);
369 /* 2: replace it with a new Con */
370 Con *new = con_new(NULL, NULL);
371 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
372 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
373 new->parent = parent;
374 new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
376 /* 3: swap 'percent' (resize factor) */
377 new->percent = con->percent;
380 /* 4: add it as a child to the new Con */
381 con_attach(con, new, false);
385 * Moves focus one level up. Returns true if focus changed.
388 bool level_up(void) {
389 /* Skip over floating containers and go directly to the grandparent
390 * (which should always be a workspace) */
391 if (focused->parent->type == CT_FLOATING_CON) {
392 con_activate(focused->parent->parent);
396 /* We can focus up to the workspace, but not any higher in the tree */
397 if ((focused->parent->type != CT_CON &&
398 focused->parent->type != CT_WORKSPACE) ||
399 focused->type == CT_WORKSPACE) {
400 ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
403 con_activate(focused->parent);
408 * Moves focus one level down. Returns true if focus changed.
411 bool level_down(void) {
412 /* Go down the focus stack of the current node */
413 Con *next = TAILQ_FIRST(&(focused->focus_head));
414 if (next == TAILQ_END(&(focused->focus_head))) {
415 DLOG("cannot go down\n");
417 } else if (next->type == CT_FLOATING_CON) {
418 /* Floating cons shouldn't be directly focused; try immediately
419 * going to the grandchild of the focused con. */
420 Con *child = TAILQ_FIRST(&(next->focus_head));
421 if (child == TAILQ_END(&(next->focus_head))) {
422 DLOG("cannot go down\n");
425 next = TAILQ_FIRST(&(next->focus_head));
432 static void mark_unmapped(Con *con) {
436 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
437 mark_unmapped(current);
438 if (con->type == CT_WORKSPACE) {
439 /* We need to call mark_unmapped on floating nodes as well since we can
440 * make containers floating. */
441 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
442 mark_unmapped(current);
447 * Renders the tree, that is rendering all outputs using render_con() and
448 * pushing the changes to X11 using x_push_changes().
451 void tree_render(void) {
455 DLOG("-- BEGIN RENDERING --\n");
456 /* Reset map state for all nodes in tree */
457 /* TODO: a nicer method to walk all nodes would be good, maybe? */
458 mark_unmapped(croot);
459 croot->mapped = true;
463 x_push_changes(croot);
464 DLOG("-- END RENDERING --\n");
468 * Recursive function to walk the tree until a con can be found to focus.
471 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
472 /* When dealing with fullscreen containers, it's necessary to go up to the
473 * workspace level, because 'focus $dir' will start at the con's real
474 * position in the tree, and it may not be possible to get to the edge
475 * normally due to fullscreen focusing restrictions. */
476 if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
477 con = con_get_workspace(con);
479 /* Stop recursing at workspaces after attempting to switch to next
480 * workspace if possible. */
481 if (con->type == CT_WORKSPACE) {
482 if (con_get_fullscreen_con(con, CF_GLOBAL)) {
483 DLOG("Cannot change workspace while in global fullscreen mode.\n");
486 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
491 DLOG("Current output is %s\n", output_primary_name(current_output));
493 /* Try to find next output */
494 direction_t direction;
495 if (way == 'n' && orientation == HORIZ)
497 else if (way == 'p' && orientation == HORIZ)
499 else if (way == 'n' && orientation == VERT)
501 else if (way == 'p' && orientation == VERT)
506 next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
509 DLOG("Next output is %s\n", output_primary_name(next_output));
511 /* Find visible workspace on next output */
512 Con *workspace = NULL;
513 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
515 /* Show next workspace and focus appropriate container if possible. */
519 /* Use descend_focused first to give higher priority to floating or
520 * tiling fullscreen containers. */
521 Con *focus = con_descend_focused(workspace);
522 if (focus->fullscreen_mode == CF_NONE) {
523 Con *focus_tiling = con_descend_tiling_focused(workspace);
524 /* If descend_tiling returned a workspace then focus is either a
525 * floating container or the same workspace. */
526 if (focus_tiling != workspace) {
527 focus = focus_tiling;
531 workspace_show(workspace);
533 x_set_warp_to(&(focus->rect));
537 Con *parent = con->parent;
539 if (con->type == CT_FLOATING_CON) {
540 if (orientation != HORIZ)
543 /* left/right focuses the previous/next floating container */
546 next = TAILQ_NEXT(con, floating_windows);
548 next = TAILQ_PREV(con, floating_head, floating_windows);
550 /* If there is no next/previous container, wrap */
553 next = TAILQ_FIRST(&(parent->floating_head));
555 next = TAILQ_LAST(&(parent->floating_head), floating_head);
558 /* Still no next/previous container? bail out */
562 /* Raise the floating window on top of other windows preserving
563 * relative stack order */
564 while (TAILQ_LAST(&(parent->floating_head), floating_head) != next) {
565 Con *last = TAILQ_LAST(&(parent->floating_head), floating_head);
566 TAILQ_REMOVE(&(parent->floating_head), last, floating_windows);
567 TAILQ_INSERT_HEAD(&(parent->floating_head), last, floating_windows);
570 con_activate(con_descend_focused(next));
574 /* If the orientation does not match or there is no other con to focus, we
575 * need to go higher in the hierarchy */
576 if (con_orientation(parent) != orientation ||
577 con_num_children(parent) == 1)
578 return _tree_next(parent, way, orientation, wrap);
580 Con *current = TAILQ_FIRST(&(parent->focus_head));
581 /* TODO: when can the following happen (except for floating windows, which
582 * are handled above)? */
583 if (TAILQ_EMPTY(&(parent->nodes_head))) {
584 DLOG("nothing to focus\n");
590 next = TAILQ_NEXT(current, nodes);
592 next = TAILQ_PREV(current, nodes_head, nodes);
595 if (config.focus_wrapping != FOCUS_WRAPPING_FORCE) {
596 /* If there is no next/previous container, we check if we can focus one
597 * when going higher (without wrapping, though). If so, we are done, if
599 if (_tree_next(parent, way, orientation, false))
607 next = TAILQ_FIRST(&(parent->nodes_head));
609 next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
612 /* Don't violate fullscreen focus restrictions. */
613 if (!con_fullscreen_permits_focusing(next))
616 /* 3: focus choice comes in here. at the moment we will go down
617 * until we find a window */
618 /* TODO: check for window, atm we only go down as far as possible */
619 con_activate(con_descend_focused(next));
624 * Changes focus in the given way (next/previous) and given orientation
625 * (horizontal/vertical).
628 void tree_next(char way, orientation_t orientation) {
629 _tree_next(focused, way, orientation,
630 config.focus_wrapping != FOCUS_WRAPPING_OFF);
634 * tree_flatten() removes pairs of redundant split containers, e.g.:
635 * [workspace, horizontal]
639 * In this example, the v-split and h-split container are redundant.
640 * Such a situation can be created by moving containers in a direction which is
641 * not the orientation of their parent container. i3 needs to create a new
642 * split container then and if you move containers this way multiple times,
643 * redundant chains of split-containers can be the result.
646 void tree_flatten(Con *con) {
647 Con *current, *child, *parent = con->parent;
648 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
650 /* We only consider normal containers without windows */
651 if (con->type != CT_CON ||
652 parent->layout == L_OUTPUT || /* con == "content" */
656 /* Ensure it got only one child */
657 child = TAILQ_FIRST(&(con->nodes_head));
658 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
661 DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
663 /* The child must have a different orientation than the con but the same as
664 * the con’s parent to be redundant */
665 if (!con_is_split(con) ||
666 !con_is_split(child) ||
667 (con->layout != L_SPLITH && con->layout != L_SPLITV) ||
668 (child->layout != L_SPLITH && child->layout != L_SPLITV) ||
669 con_orientation(con) == con_orientation(child) ||
670 con_orientation(child) != con_orientation(parent))
673 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
675 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
677 DLOG("detaching...\n");
678 /* 2: re-attach the children to the parent before con */
679 while (!TAILQ_EMPTY(&(child->nodes_head))) {
680 current = TAILQ_FIRST(&(child->nodes_head));
681 DLOG("detaching current=%p / %s\n", current, current->name);
683 DLOG("re-attaching\n");
684 /* We don’t use con_attach() here because for a CT_CON, the special
685 * case handling of con_attach() does not trigger. So all it would do
686 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
687 * directly use the TAILQ macros. */
688 current->parent = parent;
689 TAILQ_INSERT_BEFORE(con, current, nodes);
690 DLOG("attaching to focus list\n");
691 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
692 current->percent = con->percent;
694 DLOG("re-attached all\n");
696 /* 3: restore focus, if con was focused */
697 if (focus_next != NULL &&
698 TAILQ_FIRST(&(parent->focus_head)) == con) {
699 DLOG("restoring focus to focus_next=%p\n", focus_next);
700 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
701 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
702 DLOG("restored focus.\n");
705 /* 4: close the redundant cons */
706 DLOG("closing redundant cons\n");
707 tree_close_internal(con, DONT_KILL_WINDOW, true);
709 /* Well, we got to abort the recursion here because we destroyed the
710 * container. However, if tree_flatten() is called sufficiently often,
711 * there can’t be the situation of having two pairs of redundant containers
712 * at once. Therefore, we can safely abort the recursion on this level
713 * after flattening. */
717 /* We cannot use normal foreach here because tree_flatten might close the
718 * current container. */
719 current = TAILQ_FIRST(&(con->nodes_head));
720 while (current != NULL) {
721 Con *next = TAILQ_NEXT(current, nodes);
722 tree_flatten(current);
726 current = TAILQ_FIRST(&(con->floating_head));
727 while (current != NULL) {
728 Con *next = TAILQ_NEXT(current, floating_windows);
729 tree_flatten(current);