2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 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 * Loads tree from ~/.i3/_restart.json (used for in-place restarts).
21 bool tree_restore(const char *path, xcb_get_geometry_reply_t *geometry) {
22 char *globbed = resolve_tilde(path);
24 if (!path_exists(globbed)) {
25 LOG("%s does not exist, not restoring tree\n", globbed);
30 /* TODO: refactor the following */
31 croot = con_new(NULL, NULL);
40 tree_append_json(globbed);
42 printf("appended tree, using new root\n");
43 croot = TAILQ_FIRST(&(croot->nodes_head));
44 printf("new root = %p\n", croot);
45 Con *out = TAILQ_FIRST(&(croot->nodes_head));
46 printf("out = %p\n", out);
47 Con *ws = TAILQ_FIRST(&(out->nodes_head));
48 printf("ws = %p\n", ws);
54 * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
55 * root node are created in randr.c for each Output.
58 void tree_init(xcb_get_geometry_reply_t *geometry) {
59 croot = con_new(NULL, NULL);
62 croot->type = CT_ROOT;
72 * Opens an empty container in the current container
75 Con *tree_open_con(Con *con, i3Window *window) {
77 /* every focusable Con has a parent (outputs have parent root) */
78 con = focused->parent;
79 /* If the parent is an output, we are on a workspace. In this case,
80 * the new container needs to be opened as a leaf of the workspace. */
81 if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
85 /* If the currently focused container is a floating container, we
86 * attach the new container to the currently focused spot in its
88 if (con->type == CT_FLOATING_CON) {
89 con = con_descend_tiling_focused(con->parent);
90 if (con->type != CT_WORKSPACE)
93 DLOG("con = %p\n", con);
98 /* 3. create the container and attach it to its parent */
99 Con *new = con_new(con, window);
101 /* 4: re-calculate child->percent for each child */
102 con_fix_percent(con);
107 static bool _is_con_mapped(Con *con) {
110 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
111 if (_is_con_mapped(child))
118 * Closes the given container including all children.
119 * Returns true if the container was killed or false if just WM_DELETE was sent
120 * and the window is expected to kill itself.
122 * The dont_kill_parent flag is specified when the function calls itself
123 * recursively while deleting a containers children.
125 * The force_set_focus flag is specified in the case of killing a floating
126 * window: tree_close() will be invoked for the CT_FLOATINGCON (the parent
127 * container) and focus should be set there.
130 bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus) {
131 bool was_mapped = con->mapped;
132 Con *parent = con->parent;
135 /* Even if the container itself is not mapped, its children may be
136 * mapped (for example split containers don't have a mapped window on
137 * their own but usually contain mapped children). */
138 was_mapped = _is_con_mapped(con);
141 /* Get the container which is next focused */
142 Con *next = con_next_focused(con);
143 DLOG("next = %p, focused = %p\n", next, focused);
145 DLOG("closing %p, kill_window = %d\n", con, kill_window);
146 Con *child, *nextchild;
147 bool abort_kill = false;
148 /* We cannot use TAILQ_FOREACH because the children get deleted
149 * in their parent’s nodes_head */
150 for (child = TAILQ_FIRST(&(con->nodes_head)); child; ) {
151 nextchild = TAILQ_NEXT(child, nodes);
152 DLOG("killing child=%p\n", child);
153 if (!tree_close(child, kill_window, true, false))
159 DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
163 if (con->window != NULL) {
164 if (kill_window != DONT_KILL_WINDOW) {
165 x_window_kill(con->window->id, kill_window);
168 xcb_void_cookie_t cookie;
169 /* un-parent the window */
170 cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
172 /* Ignore X11 errors for the ReparentWindow request.
173 * X11 Errors are returned when the window was already destroyed */
174 add_ignore_event(cookie.sequence, 0);
176 /* We are no longer handling this window, thus set WM_STATE to
177 * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
178 long data[] = { XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE };
179 cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
180 con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
182 /* Ignore X11 errors for the ReparentWindow request.
183 * X11 Errors are returned when the window was already destroyed */
184 add_ignore_event(cookie.sequence, 0);
186 FREE(con->window->class_class);
187 FREE(con->window->class_instance);
188 FREE(con->window->name_x);
189 FREE(con->window->name_json);
193 /* kill the X11 part of this container */
197 if (con->type != CT_FLOATING_CON) {
198 /* If the container is *not* floating, we might need to re-distribute
199 * percentage values for the resized containers. */
200 con_fix_percent(parent);
203 if (con_is_floating(con)) {
204 Con *ws = con_get_workspace(con);
205 DLOG("Container was floating, killing floating container\n");
206 tree_close(parent, DONT_KILL_WINDOW, false, (con == focused));
207 DLOG("parent container killed\n");
208 if (con == focused) {
209 DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
210 /* go down the focus stack as far as possible */
211 next = con_descend_focused(ws);
213 dont_kill_parent = true;
214 DLOG("Alright, focusing %p\n", next);
221 FREE(con->deco_render_params);
222 TAILQ_REMOVE(&all_cons, con, all_cons);
225 /* in the case of floating windows, we already focused another container
226 * when closing the parent, so we can exit now. */
228 DLOG("No next container, i will just exit now\n");
232 if (was_mapped || con == focused) {
233 if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
234 DLOG("focusing %p / %s\n", next, next->name);
235 if (next->type == CT_DOCKAREA) {
236 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
237 con_focus(con_descend_focused(output_get_content(next->parent)));
239 if (!force_set_focus && con != focused)
240 DLOG("not changing focus, the container was not focused before\n");
241 else con_focus(next);
245 DLOG("not focusing because we're not killing anybody");
248 DLOG("not focusing, was not mapped\n");
251 /* check if the parent container is empty now and close it */
252 if (!dont_kill_parent)
253 CALL(parent, on_remove_child);
259 * Closes the current container using tree_close().
262 void tree_close_con(kill_window_t kill_window) {
263 assert(focused != NULL);
264 if (focused->type == CT_WORKSPACE) {
265 LOG("Cannot close workspace\n");
269 /* There *should* be no possibility to focus outputs / root container */
270 assert(focused->type != CT_OUTPUT);
271 assert(focused->type != CT_ROOT);
274 tree_close(focused, kill_window, false, false);
278 * Splits (horizontally or vertically) the given container by creating a new
279 * container which contains the old one and the future ones.
282 void tree_split(Con *con, orientation_t orientation) {
283 /* for a workspace, we just need to change orientation */
284 if (con->type == CT_WORKSPACE) {
285 DLOG("Workspace, simply changing orientation to %d\n", orientation);
286 con->orientation = orientation;
290 Con *parent = con->parent;
291 /* if we are in a container whose parent contains only one
292 * child (its split functionality is unused so far), we just change the
293 * orientation (more intuitive than splitting again) */
294 if (con_num_children(parent) == 1) {
295 parent->orientation = orientation;
296 DLOG("Just changing orientation of existing container\n");
300 DLOG("Splitting in orientation %d\n", orientation);
302 /* 2: replace it with a new Con */
303 Con *new = con_new(NULL, NULL);
304 TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
305 TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
306 new->parent = parent;
307 new->orientation = orientation;
309 /* 3: swap 'percent' (resize factor) */
310 new->percent = con->percent;
313 /* 4: add it as a child to the new Con */
314 con_attach(con, new, false);
318 * Moves focus one level up.
322 /* We cannot go up when we are in fullscreen mode at the moment, that would
323 * be totally not intuitive */
324 if (focused->fullscreen_mode != CF_NONE) {
325 LOG("Currently in fullscreen, not going up\n");
328 /* We can focus up to the workspace, but not any higher in the tree */
329 if ((focused->parent->type != CT_CON &&
330 focused->parent->type != CT_WORKSPACE) ||
331 focused->type == CT_WORKSPACE) {
332 LOG("Cannot go up any further\n");
335 con_focus(focused->parent);
339 * Moves focus one level down.
343 /* Go down the focus stack of the current node */
344 Con *next = TAILQ_FIRST(&(focused->focus_head));
345 if (next == TAILQ_END(&(focused->focus_head))) {
346 printf("cannot go down\n");
352 static void mark_unmapped(Con *con) {
356 TAILQ_FOREACH(current, &(con->nodes_head), nodes)
357 mark_unmapped(current);
358 if (con->type == CT_WORKSPACE) {
359 /* We need to call mark_unmapped on floating nodes aswell since we can
360 * make containers floating. */
361 TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
362 mark_unmapped(current);
367 * Renders the tree, that is rendering all outputs using render_con() and
368 * pushing the changes to X11 using x_push_changes().
375 DLOG("-- BEGIN RENDERING --\n");
376 /* Reset map state for all nodes in tree */
377 /* TODO: a nicer method to walk all nodes would be good, maybe? */
378 mark_unmapped(croot);
379 croot->mapped = true;
381 render_con(croot, false);
383 x_push_changes(croot);
384 DLOG("-- END RENDERING --\n");
388 * Recursive function to walk the tree until a con can be found to focus.
391 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
392 /* Stop recursing at workspaces after attempting to switch to next
393 * workspace if possible. */
394 if (con->type == CT_WORKSPACE) {
395 Output *current_output = get_output_containing(con->rect.x, con->rect.y);
400 DLOG("Current output is %s\n", current_output->name);
402 /* Try to find next output */
403 direction_t direction;
404 if (way == 'n' && orientation == HORIZ)
406 else if (way == 'p' && orientation == HORIZ)
408 else if (way == 'n' && orientation == VERT)
410 else if (way == 'p' && orientation == VERT)
415 next_output = get_output_next(direction, current_output);
418 DLOG("Next output is %s\n", next_output->name);
420 /* Find visible workspace on next output */
421 Con *workspace = NULL;
422 GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
424 /* Show next workspace and focus appropriate container if possible. */
428 workspace_show(workspace);
429 Con *focus = con_descend_direction(workspace, direction);
432 x_set_warp_to(&(focus->rect));
437 Con *parent = con->parent;
439 if (con->type == CT_FLOATING_CON) {
440 /* left/right focuses the previous/next floating container */
441 if (orientation == HORIZ) {
444 next = TAILQ_NEXT(con, floating_windows);
445 else next = TAILQ_PREV(con, floating_head, floating_windows);
447 /* If there is no next/previous container, wrap */
450 next = TAILQ_FIRST(&(parent->floating_head));
451 else next = TAILQ_LAST(&(parent->floating_head), floating_head);
454 /* Still no next/previous container? bail out */
458 con_focus(con_descend_focused(next));
461 /* up/down cycles through the Z-index */
462 /* TODO: implement cycling through the z-index */
467 /* If the orientation does not match or there is no other con to focus, we
468 * need to go higher in the hierarchy */
469 if (con_orientation(parent) != orientation ||
470 con_num_children(parent) == 1)
471 return _tree_next(parent, way, orientation, wrap);
473 Con *current = TAILQ_FIRST(&(parent->focus_head));
474 /* TODO: when can the following happen (except for floating windows, which
475 * are handled above)? */
476 if (TAILQ_EMPTY(&(parent->nodes_head))) {
477 DLOG("nothing to focus\n");
483 next = TAILQ_NEXT(current, nodes);
484 else next = TAILQ_PREV(current, nodes_head, nodes);
487 if (!config.force_focus_wrapping) {
488 /* If there is no next/previous container, we check if we can focus one
489 * when going higher (without wrapping, though). If so, we are done, if
491 if (_tree_next(parent, way, orientation, false))
499 next = TAILQ_FIRST(&(parent->nodes_head));
500 else next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
503 /* 3: focus choice comes in here. at the moment we will go down
504 * until we find a window */
505 /* TODO: check for window, atm we only go down as far as possible */
506 con_focus(con_descend_focused(next));
511 * Changes focus in the given way (next/previous) and given orientation
512 * (horizontal/vertical).
515 void tree_next(char way, orientation_t orientation) {
516 _tree_next(focused, way, orientation, true);
520 * tree_flatten() removes pairs of redundant split containers, e.g.:
521 * [workspace, horizontal]
525 * In this example, the v-split and h-split container are redundant.
526 * Such a situation can be created by moving containers in a direction which is
527 * not the orientation of their parent container. i3 needs to create a new
528 * split container then and if you move containers this way multiple times,
529 * redundant chains of split-containers can be the result.
532 void tree_flatten(Con *con) {
533 Con *current, *child, *parent = con->parent;
534 DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
536 /* We only consider normal containers without windows */
537 if (con->type != CT_CON || con->window != NULL)
540 /* Ensure it got only one child */
541 child = TAILQ_FIRST(&(con->nodes_head));
542 if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
545 /* The child must have a different orientation than the con but the same as
546 * the con’s parent to be redundant */
547 if (con->orientation == NO_ORIENTATION ||
548 child->orientation == NO_ORIENTATION ||
549 con->orientation == child->orientation ||
550 child->orientation != parent->orientation)
553 DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
555 Con *focus_next = TAILQ_FIRST(&(child->focus_head));
557 DLOG("detaching...\n");
558 /* 2: re-attach the children to the parent before con */
559 while (!TAILQ_EMPTY(&(child->nodes_head))) {
560 current = TAILQ_FIRST(&(child->nodes_head));
561 DLOG("detaching current=%p / %s\n", current, current->name);
563 DLOG("re-attaching\n");
564 /* We don’t use con_attach() here because for a CT_CON, the special
565 * case handling of con_attach() does not trigger. So all it would do
566 * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
567 * directly use the TAILQ macros. */
568 current->parent = parent;
569 TAILQ_INSERT_BEFORE(con, current, nodes);
570 DLOG("attaching to focus list\n");
571 TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
572 current->percent = con->percent;
574 DLOG("re-attached all\n");
576 /* 3: restore focus, if con was focused */
577 if (focus_next != NULL &&
578 TAILQ_FIRST(&(parent->focus_head)) == con) {
579 DLOG("restoring focus to focus_next=%p\n", focus_next);
580 TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
581 TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
582 DLOG("restored focus.\n");
585 /* 4: close the redundant cons */
586 DLOG("closing redundant cons\n");
587 tree_close(con, DONT_KILL_WINDOW, true, false);
589 /* Well, we got to abort the recursion here because we destroyed the
590 * container. However, if tree_flatten() is called sufficiently often,
591 * there can’t be the situation of having two pairs of redundant containers
592 * at once. Therefore, we can safely abort the recursion on this level
593 * after flattening. */
597 /* We cannot use normal foreach here because tree_flatten might close the
598 * current container. */
599 current = TAILQ_FIRST(&(con->nodes_head));
600 while (current != NULL) {
601 Con *next = TAILQ_NEXT(current, nodes);
602 tree_flatten(current);
606 current = TAILQ_FIRST(&(con->floating_head));
607 while (current != NULL) {
608 Con *next = TAILQ_NEXT(current, floating_windows);
609 tree_flatten(current);