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 /* Ignore X11 errors for the ReparentWindow request.
252 * X11 Errors are returned when the window was already destroyed */
253 add_ignore_event(cookie.sequence, 0);
255 ipc_send_window_event("close", con);
256 window_free(con->window);
260 Con *ws = con_get_workspace(con);
262 /* Figure out which container to focus next before detaching 'con'. */
263 Con *next = (con == focused) ? con_next_focused(con) : NULL;
264 DLOG("next = %p, focused = %p\n", next, focused);
266 /* Detach the container so that it will not be rendered anymore. */
269 /* disable urgency timer, if needed */
270 if (con->urgency_timer != NULL) {
271 DLOG("Removing urgency timer of con %p\n", con);
272 workspace_update_urgent_flag(ws);
273 ev_timer_stop(main_loop, con->urgency_timer);
274 FREE(con->urgency_timer);
277 if (con->type != CT_FLOATING_CON) {
278 /* If the container is *not* floating, we might need to re-distribute
279 * percentage values for the resized containers. */
280 con_fix_percent(parent);
283 /* Render the tree so that the surrounding containers take up the space
284 * which 'con' does no longer occupy. If we don’t render here, there will
285 * be a gap in our containers and that could trigger an EnterNotify for an
286 * underlying container, see ticket #660.
288 * Rendering has to be avoided when dont_kill_parent is set (when
289 * tree_close_internal calls itself recursively) because the tree is in a
290 * non-renderable state during that time. */
291 if (!dont_kill_parent)
294 /* kill the X11 part of this container */
298 DLOG("Closing a workspace container, updating EWMH atoms\n");
299 ewmh_update_number_of_desktops();
300 ewmh_update_desktop_names();
301 ewmh_update_wm_desktop();
309 DLOG("not changing focus, the container was not focused before\n");
312 /* check if the parent container is empty now and close it */
313 if (!dont_kill_parent)
314 CALL(parent, on_remove_child);
320 * Splits (horizontally or vertically) the given container by creating a new
321 * container which contains the old one and the future ones.
324 void tree_split(Con *con, orientation_t orientation) {
325 if (con_is_floating(con)) {
326 DLOG("Floating containers can't be split.\n");
330 if (con->type == CT_WORKSPACE) {
331 if (con_num_children(con) < 2) {
332 if (con_num_children(con) == 0) {
333 DLOG("Changing workspace_layout to L_DEFAULT\n");
334 con->workspace_layout = L_DEFAULT;
336 DLOG("Changing orientation of workspace\n");
337 con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
340 /* if there is more than one container on the workspace
341 * move them into a new container and handle this instead */
342 con = workspace_encapsulate(con);
346 Con *parent = con->parent;
348 /* Force re-rendering to make the indicator border visible. */
349 con_force_split_parents_redraw(con);
351 /* if we are in a container whose parent contains only one
352 * child (its split functionality is unused so far), we just change the
353 * orientation (more intuitive than splitting again) */
354 if (con_num_children(parent) == 1 &&
355 (parent->layout == L_SPLITH ||
356 parent->layout == L_SPLITV)) {
357 parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
358 DLOG("Just changing orientation of existing container\n");
362 DLOG("Splitting in orientation %d\n", orientation);
364 /* 2: replace it with a new Con */
365 Con *new = con_new(NULL, NULL);
366 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
367 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
368 new->parent = parent;
369 new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
371 /* 3: swap 'percent' (resize factor) */
372 new->percent = con->percent;
375 /* 4: add it as a child to the new Con */
376 con_attach(con, new, false);
380 * Moves focus one level up. Returns true if focus changed.
383 bool level_up(void) {
384 /* Skip over floating containers and go directly to the grandparent
385 * (which should always be a workspace) */
386 if (focused->parent->type == CT_FLOATING_CON) {
387 con_activate(focused->parent->parent);
391 /* We can focus up to the workspace, but not any higher in the tree */
392 if ((focused->parent->type != CT_CON &&
393 focused->parent->type != CT_WORKSPACE) ||
394 focused->type == CT_WORKSPACE) {
395 ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
398 con_activate(focused->parent);
403 * Moves focus one level down. Returns true if focus changed.
406 bool level_down(void) {
407 /* Go down the focus stack of the current node */
408 Con *next = TAILQ_FIRST(&(focused->focus_head));
409 if (next == TAILQ_END(&(focused->focus_head))) {
410 DLOG("cannot go down\n");
412 } else if (next->type == CT_FLOATING_CON) {
413 /* Floating cons shouldn't be directly focused; try immediately
414 * going to the grandchild of the focused con. */
415 Con *child = TAILQ_FIRST(&(next->focus_head));
416 if (child == TAILQ_END(&(next->focus_head))) {
417 DLOG("cannot go down\n");
420 next = TAILQ_FIRST(&(next->focus_head));
427 static void mark_unmapped(Con *con) {
431 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
432 mark_unmapped(current);
433 if (con->type == CT_WORKSPACE) {
434 /* We need to call mark_unmapped on floating nodes as well since we can
435 * make containers floating. */
436 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
437 mark_unmapped(current);
442 * Renders the tree, that is rendering all outputs using render_con() and
443 * pushing the changes to X11 using x_push_changes().
446 void tree_render(void) {
450 DLOG("-- BEGIN RENDERING --\n");
451 /* Reset map state for all nodes in tree */
452 /* TODO: a nicer method to walk all nodes would be good, maybe? */
453 mark_unmapped(croot);
454 croot->mapped = true;
458 x_push_changes(croot);
459 DLOG("-- END RENDERING --\n");
463 * Recursive function to walk the tree until a con can be found to focus.
466 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
467 /* When dealing with fullscreen containers, it's necessary to go up to the
468 * workspace level, because 'focus $dir' will start at the con's real
469 * position in the tree, and it may not be possible to get to the edge
470 * normally due to fullscreen focusing restrictions. */
471 if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
472 con = con_get_workspace(con);
474 /* Stop recursing at workspaces after attempting to switch to next
475 * workspace if possible. */
476 if (con->type == CT_WORKSPACE) {
477 if (con_get_fullscreen_con(con, CF_GLOBAL)) {
478 DLOG("Cannot change workspace while in global fullscreen mode.\n");
481 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
486 DLOG("Current output is %s\n", output_primary_name(current_output));
488 /* Try to find next output */
489 direction_t direction;
490 if (way == 'n' && orientation == HORIZ)
492 else if (way == 'p' && orientation == HORIZ)
494 else if (way == 'n' && orientation == VERT)
496 else if (way == 'p' && orientation == VERT)
501 next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
504 DLOG("Next output is %s\n", output_primary_name(next_output));
506 /* Find visible workspace on next output */
507 Con *workspace = NULL;
508 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
510 /* Show next workspace and focus appropriate container if possible. */
514 /* Use descend_focused first to give higher priority to floating or
515 * tiling fullscreen containers. */
516 Con *focus = con_descend_focused(workspace);
517 if (focus->fullscreen_mode == CF_NONE) {
518 Con *focus_tiling = con_descend_tiling_focused(workspace);
519 /* If descend_tiling returned a workspace then focus is either a
520 * floating container or the same workspace. */
521 if (focus_tiling != workspace) {
522 focus = focus_tiling;
526 workspace_show(workspace);
528 x_set_warp_to(&(focus->rect));
532 Con *parent = con->parent;
534 if (con->type == CT_FLOATING_CON) {
535 if (orientation != HORIZ)
538 /* left/right focuses the previous/next floating container */
541 next = TAILQ_NEXT(con, floating_windows);
543 next = TAILQ_PREV(con, floating_head, floating_windows);
545 /* If there is no next/previous container, wrap */
548 next = TAILQ_FIRST(&(parent->floating_head));
550 next = TAILQ_LAST(&(parent->floating_head), floating_head);
553 /* Still no next/previous container? bail out */
557 /* Raise the floating window on top of other windows preserving
558 * relative stack order */
559 while (TAILQ_LAST(&(parent->floating_head), floating_head) != next) {
560 Con *last = TAILQ_LAST(&(parent->floating_head), floating_head);
561 TAILQ_REMOVE(&(parent->floating_head), last, floating_windows);
562 TAILQ_INSERT_HEAD(&(parent->floating_head), last, floating_windows);
565 con_activate(con_descend_focused(next));
569 /* If the orientation does not match or there is no other con to focus, we
570 * need to go higher in the hierarchy */
571 if (con_orientation(parent) != orientation ||
572 con_num_children(parent) == 1)
573 return _tree_next(parent, way, orientation, wrap);
575 Con *current = TAILQ_FIRST(&(parent->focus_head));
576 /* TODO: when can the following happen (except for floating windows, which
577 * are handled above)? */
578 if (TAILQ_EMPTY(&(parent->nodes_head))) {
579 DLOG("nothing to focus\n");
585 next = TAILQ_NEXT(current, nodes);
587 next = TAILQ_PREV(current, nodes_head, nodes);
590 if (config.focus_wrapping != FOCUS_WRAPPING_FORCE) {
591 /* If there is no next/previous container, we check if we can focus one
592 * when going higher (without wrapping, though). If so, we are done, if
594 if (_tree_next(parent, way, orientation, false))
602 next = TAILQ_FIRST(&(parent->nodes_head));
604 next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
607 /* Don't violate fullscreen focus restrictions. */
608 if (!con_fullscreen_permits_focusing(next))
611 /* 3: focus choice comes in here. at the moment we will go down
612 * until we find a window */
613 /* TODO: check for window, atm we only go down as far as possible */
614 con_activate(con_descend_focused(next));
619 * Changes focus in the given way (next/previous) and given orientation
620 * (horizontal/vertical).
623 void tree_next(char way, orientation_t orientation) {
624 _tree_next(focused, way, orientation,
625 config.focus_wrapping != FOCUS_WRAPPING_OFF);
629 * tree_flatten() removes pairs of redundant split containers, e.g.:
630 * [workspace, horizontal]
634 * In this example, the v-split and h-split container are redundant.
635 * Such a situation can be created by moving containers in a direction which is
636 * not the orientation of their parent container. i3 needs to create a new
637 * split container then and if you move containers this way multiple times,
638 * redundant chains of split-containers can be the result.
641 void tree_flatten(Con *con) {
642 Con *current, *child, *parent = con->parent;
643 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
645 /* We only consider normal containers without windows */
646 if (con->type != CT_CON ||
647 parent->layout == L_OUTPUT || /* con == "content" */
651 /* Ensure it got only one child */
652 child = TAILQ_FIRST(&(con->nodes_head));
653 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
656 DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
658 /* The child must have a different orientation than the con but the same as
659 * the con’s parent to be redundant */
660 if (!con_is_split(con) ||
661 !con_is_split(child) ||
662 (con->layout != L_SPLITH && con->layout != L_SPLITV) ||
663 (child->layout != L_SPLITH && child->layout != L_SPLITV) ||
664 con_orientation(con) == con_orientation(child) ||
665 con_orientation(child) != con_orientation(parent))
668 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
670 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
672 DLOG("detaching...\n");
673 /* 2: re-attach the children to the parent before con */
674 while (!TAILQ_EMPTY(&(child->nodes_head))) {
675 current = TAILQ_FIRST(&(child->nodes_head));
676 DLOG("detaching current=%p / %s\n", current, current->name);
678 DLOG("re-attaching\n");
679 /* We don’t use con_attach() here because for a CT_CON, the special
680 * case handling of con_attach() does not trigger. So all it would do
681 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
682 * directly use the TAILQ macros. */
683 current->parent = parent;
684 TAILQ_INSERT_BEFORE(con, current, nodes);
685 DLOG("attaching to focus list\n");
686 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
687 current->percent = con->percent;
689 DLOG("re-attached all\n");
691 /* 3: restore focus, if con was focused */
692 if (focus_next != NULL &&
693 TAILQ_FIRST(&(parent->focus_head)) == con) {
694 DLOG("restoring focus to focus_next=%p\n", focus_next);
695 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
696 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
697 DLOG("restored focus.\n");
700 /* 4: close the redundant cons */
701 DLOG("closing redundant cons\n");
702 tree_close_internal(con, DONT_KILL_WINDOW, true);
704 /* Well, we got to abort the recursion here because we destroyed the
705 * container. However, if tree_flatten() is called sufficiently often,
706 * there can’t be the situation of having two pairs of redundant containers
707 * at once. Therefore, we can safely abort the recursion on this level
708 * after flattening. */
712 /* We cannot use normal foreach here because tree_flatten might close the
713 * current container. */
714 current = TAILQ_FIRST(&(con->nodes_head));
715 while (current != NULL) {
716 Con *next = TAILQ_NEXT(current, nodes);
717 tree_flatten(current);
721 current = TAILQ_FIRST(&(con->floating_head));
722 while (current != NULL) {
723 Con *next = TAILQ_NEXT(current, floating_windows);
724 tree_flatten(current);