2 #define I3__FILE__ "tree.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 * 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);
87 tree_append_json(globbed);
89 printf("appended tree, using new root\n");
90 croot = TAILQ_FIRST(&(croot->nodes_head));
91 printf("new root = %p\n", croot);
92 Con *out = TAILQ_FIRST(&(croot->nodes_head));
93 printf("out = %p\n", out);
94 Con *ws = TAILQ_FIRST(&(out->nodes_head));
95 printf("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);
112 * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
113 * root node are created in randr.c for each Output.
116 void tree_init(xcb_get_geometry_reply_t *geometry) {
117 croot = con_new(NULL, NULL);
119 croot->name = "root";
120 croot->type = CT_ROOT;
121 croot->layout = L_SPLITH;
122 croot->rect = (Rect){
133 * Opens an empty container in the current container
136 Con *tree_open_con(Con *con, i3Window *window) {
138 /* every focusable Con has a parent (outputs have parent root) */
139 con = focused->parent;
140 /* If the parent is an output, we are on a workspace. In this case,
141 * the new container needs to be opened as a leaf of the workspace. */
142 if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
146 /* If the currently focused container is a floating container, we
147 * attach the new container to the currently focused spot in its
149 if (con->type == CT_FLOATING_CON) {
150 con = con_descend_tiling_focused(con->parent);
151 if (con->type != CT_WORKSPACE)
154 DLOG("con = %p\n", con);
159 /* 3. create the container and attach it to its parent */
160 Con *new = con_new(con, window);
161 new->layout = L_SPLITH;
163 /* 4: re-calculate child->percent for each child */
164 con_fix_percent(con);
169 static bool _is_con_mapped(Con *con) {
172 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
173 if (_is_con_mapped(child))
180 * Closes the given container including all children.
181 * Returns true if the container was killed or false if just WM_DELETE was sent
182 * and the window is expected to kill itself.
184 * The dont_kill_parent flag is specified when the function calls itself
185 * recursively while deleting a containers children.
187 * The force_set_focus flag is specified in the case of killing a floating
188 * window: tree_close() will be invoked for the CT_FLOATINGCON (the parent
189 * container) and focus should be set there.
192 bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus) {
193 bool was_mapped = con->mapped;
194 Con *parent = con->parent;
197 /* Even if the container itself is not mapped, its children may be
198 * mapped (for example split containers don't have a mapped window on
199 * their own but usually contain mapped children). */
200 was_mapped = _is_con_mapped(con);
203 /* remove the urgency hint of the workspace (if set) */
206 con_update_parents_urgency(con);
207 workspace_update_urgent_flag(con_get_workspace(con));
210 /* Get the container which is next focused */
211 Con *next = con_next_focused(con);
212 DLOG("next = %p, focused = %p\n", next, focused);
214 DLOG("closing %p, kill_window = %d\n", con, kill_window);
215 Con *child, *nextchild;
216 bool abort_kill = false;
217 /* We cannot use TAILQ_FOREACH because the children get deleted
218 * in their parent’s nodes_head */
219 for (child = TAILQ_FIRST(&(con->nodes_head)); child; ) {
220 nextchild = TAILQ_NEXT(child, nodes);
221 DLOG("killing child=%p\n", child);
222 if (!tree_close(child, kill_window, true, false))
228 DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
232 if (con->window != NULL) {
233 if (kill_window != DONT_KILL_WINDOW) {
234 x_window_kill(con->window->id, kill_window);
237 xcb_void_cookie_t cookie;
238 /* Ignore any further events by clearing the event mask,
240 * then reparent it to the root window. */
241 xcb_change_window_attributes(conn, con->window->id,
242 XCB_CW_EVENT_MASK, (uint32_t[]){ XCB_NONE });
243 xcb_unmap_window(conn, con->window->id);
244 cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
246 /* Ignore X11 errors for the ReparentWindow request.
247 * X11 Errors are returned when the window was already destroyed */
248 add_ignore_event(cookie.sequence, 0);
250 /* We are no longer handling this window, thus set WM_STATE to
251 * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
252 long data[] = { XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE };
253 cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
254 con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
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 FREE(con->window->class_class);
261 FREE(con->window->class_instance);
262 i3string_free(con->window->name);
266 Con *ws = con_get_workspace(con);
268 /* Figure out which container to focus next before detaching 'con'. */
269 if (con_is_floating(con)) {
270 if (con == focused) {
271 DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
272 next = con_next_focused(parent);
274 dont_kill_parent = true;
275 DLOG("Alright, focusing %p\n", next);
281 /* Detach the container so that it will not be rendered anymore. */
284 /* disable urgency timer, if needed */
285 if (con->urgency_timer != NULL) {
286 DLOG("Removing urgency timer of con %p\n", con);
287 workspace_update_urgent_flag(ws);
288 ev_timer_stop(main_loop, con->urgency_timer);
289 FREE(con->urgency_timer);
292 if (con->type != CT_FLOATING_CON) {
293 /* If the container is *not* floating, we might need to re-distribute
294 * percentage values for the resized containers. */
295 con_fix_percent(parent);
298 /* Render the tree so that the surrounding containers take up the space
299 * which 'con' does no longer occupy. If we don’t render here, there will
300 * be a gap in our containers and that could trigger an EnterNotify for an
301 * underlying container, see ticket #660.
303 * Rendering has to be avoided when dont_kill_parent is set (when
304 * tree_close calls itself recursively) because the tree is in a
305 * non-renderable state during that time. */
306 if (!dont_kill_parent)
309 /* kill the X11 part of this container */
312 if (con_is_floating(con)) {
313 DLOG("Container was floating, killing floating container\n");
314 tree_close(parent, DONT_KILL_WINDOW, false, (con == focused));
315 DLOG("parent container killed\n");
319 FREE(con->deco_render_params);
320 TAILQ_REMOVE(&all_cons, con, all_cons);
323 /* in the case of floating windows, we already focused another container
324 * when closing the parent, so we can exit now. */
326 DLOG("No next container, i will just exit now\n");
330 if (was_mapped || con == focused) {
331 if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
332 DLOG("focusing %p / %s\n", next, next->name);
333 if (next->type == CT_DOCKAREA) {
334 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
335 con_focus(con_descend_focused(output_get_content(next->parent)));
337 if (!force_set_focus && con != focused)
338 DLOG("not changing focus, the container was not focused before\n");
339 else con_focus(next);
343 DLOG("not focusing because we're not killing anybody\n");
346 DLOG("not focusing, was not mapped\n");
349 /* check if the parent container is empty now and close it */
350 if (!dont_kill_parent)
351 CALL(parent, on_remove_child);
357 * Closes the current container using tree_close().
360 void tree_close_con(kill_window_t kill_window) {
361 assert(focused != NULL);
362 if (focused->type == CT_WORKSPACE) {
363 LOG("Cannot close workspace\n");
367 /* There *should* be no possibility to focus outputs / root container */
368 assert(focused->type != CT_OUTPUT);
369 assert(focused->type != CT_ROOT);
372 tree_close(focused, kill_window, false, false);
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->type == CT_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 DLOG("Just changing orientation of workspace\n");
389 con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
392 /* if there is more than one container on the workspace
393 * move them into a new container and handle this instead */
394 con = workspace_encapsulate(con);
398 Con *parent = con->parent;
400 /* Force re-rendering to make the indicator border visible. */
401 FREE(con->deco_render_params);
402 FREE(parent->deco_render_params);
404 /* if we are in a container whose parent contains only one
405 * child (its split functionality is unused so far), we just change the
406 * orientation (more intuitive than splitting again) */
407 if (con_num_children(parent) == 1 &&
408 (parent->layout == L_SPLITH ||
409 parent->layout == L_SPLITV)) {
410 parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
411 DLOG("Just changing orientation of existing container\n");
415 DLOG("Splitting in orientation %d\n", orientation);
417 /* 2: replace it with a new Con */
418 Con *new = con_new(NULL, NULL);
419 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
420 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
421 new->parent = parent;
422 new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
424 /* 3: swap 'percent' (resize factor) */
425 new->percent = con->percent;
428 /* 4: add it as a child to the new Con */
429 con_attach(con, new, false);
433 * Moves focus one level up. Returns true if focus changed.
436 bool level_up(void) {
437 /* Skip over floating containers and go directly to the grandparent
438 * (which should always be a workspace) */
439 if (focused->parent->type == CT_FLOATING_CON) {
440 con_focus(focused->parent->parent);
444 /* We can focus up to the workspace, but not any higher in the tree */
445 if ((focused->parent->type != CT_CON &&
446 focused->parent->type != CT_WORKSPACE) ||
447 focused->type == CT_WORKSPACE) {
448 ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
451 con_focus(focused->parent);
456 * Moves focus one level down. Returns true if focus changed.
459 bool level_down(void) {
460 /* Go down the focus stack of the current node */
461 Con *next = TAILQ_FIRST(&(focused->focus_head));
462 if (next == TAILQ_END(&(focused->focus_head))) {
463 DLOG("cannot go down\n");
466 else if (next->type == CT_FLOATING_CON) {
467 /* Floating cons shouldn't be directly focused; try immediately
468 * going to the grandchild of the focused con. */
469 Con *child = TAILQ_FIRST(&(next->focus_head));
470 if (child == TAILQ_END(&(next->focus_head))) {
471 DLOG("cannot go down\n");
475 next = TAILQ_FIRST(&(next->focus_head));
482 static void mark_unmapped(Con *con) {
486 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
487 mark_unmapped(current);
488 if (con->type == CT_WORKSPACE) {
489 /* We need to call mark_unmapped on floating nodes aswell since we can
490 * make containers floating. */
491 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
492 mark_unmapped(current);
497 * Renders the tree, that is rendering all outputs using render_con() and
498 * pushing the changes to X11 using x_push_changes().
501 void tree_render(void) {
505 DLOG("-- BEGIN RENDERING --\n");
506 /* Reset map state for all nodes in tree */
507 /* TODO: a nicer method to walk all nodes would be good, maybe? */
508 mark_unmapped(croot);
509 croot->mapped = true;
511 render_con(croot, false);
513 x_push_changes(croot);
514 DLOG("-- END RENDERING --\n");
518 * Recursive function to walk the tree until a con can be found to focus.
521 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
522 /* When dealing with fullscreen containers, it's necessary to go up to the
523 * workspace level, because 'focus $dir' will start at the con's real
524 * position in the tree, and it may not be possible to get to the edge
525 * normally due to fullscreen focusing restrictions. */
526 if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
527 con = con_get_workspace(con);
529 /* Stop recursing at workspaces after attempting to switch to next
530 * workspace if possible. */
531 if (con->type == CT_WORKSPACE) {
532 if (con_get_fullscreen_con(con, CF_GLOBAL)) {
533 DLOG("Cannot change workspace while in global fullscreen mode.\n");
536 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
541 DLOG("Current output is %s\n", current_output->name);
543 /* Try to find next output */
544 direction_t direction;
545 if (way == 'n' && orientation == HORIZ)
547 else if (way == 'p' && orientation == HORIZ)
549 else if (way == 'n' && orientation == VERT)
551 else if (way == 'p' && orientation == VERT)
556 next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
559 DLOG("Next output is %s\n", next_output->name);
561 /* Find visible workspace on next output */
562 Con *workspace = NULL;
563 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
565 /* Show next workspace and focus appropriate container if possible. */
569 workspace_show(workspace);
571 /* If a workspace has an active fullscreen container, one of its
572 * children should always be focused. The above workspace_show()
573 * should be adequate for that, so return. */
574 if (con_get_fullscreen_con(workspace, CF_OUTPUT))
577 Con *focus = con_descend_direction(workspace, direction);
580 x_set_warp_to(&(focus->rect));
585 Con *parent = con->parent;
587 if (con->type == CT_FLOATING_CON) {
588 /* left/right focuses the previous/next floating container */
589 if (orientation == HORIZ) {
592 next = TAILQ_NEXT(con, floating_windows);
593 else next = TAILQ_PREV(con, floating_head, floating_windows);
595 /* If there is no next/previous container, wrap */
598 next = TAILQ_FIRST(&(parent->floating_head));
599 else next = TAILQ_LAST(&(parent->floating_head), floating_head);
602 /* Still no next/previous container? bail out */
606 con_focus(con_descend_focused(next));
609 /* up/down cycles through the Z-index */
610 /* TODO: implement cycling through the z-index */
615 /* If the orientation does not match or there is no other con to focus, we
616 * need to go higher in the hierarchy */
617 if (con_orientation(parent) != orientation ||
618 con_num_children(parent) == 1)
619 return _tree_next(parent, way, orientation, wrap);
621 Con *current = TAILQ_FIRST(&(parent->focus_head));
622 /* TODO: when can the following happen (except for floating windows, which
623 * are handled above)? */
624 if (TAILQ_EMPTY(&(parent->nodes_head))) {
625 DLOG("nothing to focus\n");
631 next = TAILQ_NEXT(current, nodes);
632 else next = TAILQ_PREV(current, nodes_head, nodes);
635 if (!config.force_focus_wrapping) {
636 /* If there is no next/previous container, we check if we can focus one
637 * when going higher (without wrapping, though). If so, we are done, if
639 if (_tree_next(parent, way, orientation, false))
647 next = TAILQ_FIRST(&(parent->nodes_head));
648 else next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
651 /* Don't violate fullscreen focus restrictions. */
652 if (!con_fullscreen_permits_focusing(next))
655 /* 3: focus choice comes in here. at the moment we will go down
656 * until we find a window */
657 /* TODO: check for window, atm we only go down as far as possible */
658 con_focus(con_descend_focused(next));
663 * Changes focus in the given way (next/previous) and given orientation
664 * (horizontal/vertical).
667 void tree_next(char way, orientation_t orientation) {
668 _tree_next(focused, way, orientation, true);
672 * tree_flatten() removes pairs of redundant split containers, e.g.:
673 * [workspace, horizontal]
677 * In this example, the v-split and h-split container are redundant.
678 * Such a situation can be created by moving containers in a direction which is
679 * not the orientation of their parent container. i3 needs to create a new
680 * split container then and if you move containers this way multiple times,
681 * redundant chains of split-containers can be the result.
684 void tree_flatten(Con *con) {
685 Con *current, *child, *parent = con->parent;
686 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
688 /* We only consider normal containers without windows */
689 if (con->type != CT_CON ||
690 parent->layout == L_OUTPUT || /* con == "content" */
694 /* Ensure it got only one child */
695 child = TAILQ_FIRST(&(con->nodes_head));
696 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
699 DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
701 /* The child must have a different orientation than the con but the same as
702 * the con’s parent to be redundant */
703 if (!con_is_split(con) ||
704 !con_is_split(child) ||
705 con_orientation(con) == con_orientation(child) ||
706 con_orientation(child) != con_orientation(parent))
709 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
711 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
713 DLOG("detaching...\n");
714 /* 2: re-attach the children to the parent before con */
715 while (!TAILQ_EMPTY(&(child->nodes_head))) {
716 current = TAILQ_FIRST(&(child->nodes_head));
717 DLOG("detaching current=%p / %s\n", current, current->name);
719 DLOG("re-attaching\n");
720 /* We don’t use con_attach() here because for a CT_CON, the special
721 * case handling of con_attach() does not trigger. So all it would do
722 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
723 * directly use the TAILQ macros. */
724 current->parent = parent;
725 TAILQ_INSERT_BEFORE(con, current, nodes);
726 DLOG("attaching to focus list\n");
727 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
728 current->percent = con->percent;
730 DLOG("re-attached all\n");
732 /* 3: restore focus, if con was focused */
733 if (focus_next != NULL &&
734 TAILQ_FIRST(&(parent->focus_head)) == con) {
735 DLOG("restoring focus to focus_next=%p\n", focus_next);
736 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
737 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
738 DLOG("restored focus.\n");
741 /* 4: close the redundant cons */
742 DLOG("closing redundant cons\n");
743 tree_close(con, DONT_KILL_WINDOW, true, false);
745 /* Well, we got to abort the recursion here because we destroyed the
746 * container. However, if tree_flatten() is called sufficiently often,
747 * there can’t be the situation of having two pairs of redundant containers
748 * at once. Therefore, we can safely abort the recursion on this level
749 * after flattening. */
753 /* We cannot use normal foreach here because tree_flatten might close the
754 * current container. */
755 current = TAILQ_FIRST(&(con->nodes_head));
756 while (current != NULL) {
757 Con *next = TAILQ_NEXT(current, nodes);
758 tree_flatten(current);
762 current = TAILQ_FIRST(&(con->floating_head));
763 while (current != NULL) {
764 Con *next = TAILQ_NEXT(current, floating_windows);
765 tree_flatten(current);