2 #define I3__FILE__ "con.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 * con.c: Functions which deal with containers directly (creating containers,
10 * searching containers, getting specific properties from containers,
16 static void con_on_remove_child(Con *con);
19 * force parent split containers to be redrawn
22 static void con_force_split_parents_redraw(Con *con) {
25 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
26 if (!con_is_leaf(parent))
27 FREE(parent->deco_render_params);
28 parent = parent->parent;
33 * Create a new container (and attach it to the given parent, if not NULL).
34 * This function only initializes the data structures.
37 Con *con_new_skeleton(Con *parent, i3Window *window) {
38 Con *new = scalloc(sizeof(Con));
39 new->on_remove_child = con_on_remove_child;
40 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
41 new->aspect_ratio = 0.0;
44 new->border_style = config.default_border;
45 new->current_border_width = -1;
47 new->depth = window->depth;
49 new->depth = XCB_COPY_FROM_PARENT;
50 DLOG("opening window\n");
52 TAILQ_INIT(&(new->floating_head));
53 TAILQ_INIT(&(new->nodes_head));
54 TAILQ_INIT(&(new->focus_head));
55 TAILQ_INIT(&(new->swallow_head));
58 con_attach(new, parent, false);
63 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
66 Con *con_new(Con *parent, i3Window *window) {
67 Con *new = con_new_skeleton(parent, window);
68 x_con_init(new, new->depth);
73 * Attaches the given container to the given parent. This happens when moving
74 * a container or when inserting a new container at a specific place in the
77 * ignore_focus is to just insert the Con at the end (useful when creating a
78 * new split container *around* some containers, that is, detaching and
79 * attaching them in order without wanting to mess with the focus in between).
82 void con_attach(Con *con, Con *parent, bool ignore_focus) {
86 struct nodes_head *nodes_head = &(parent->nodes_head);
87 struct focus_head *focus_head = &(parent->focus_head);
89 /* Workspaces are handled differently: they need to be inserted at the
91 if (con->type == CT_WORKSPACE) {
92 DLOG("it's a workspace. num = %d\n", con->num);
93 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
94 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
96 current = TAILQ_FIRST(nodes_head);
97 if (con->num < current->num) {
98 /* we need to insert the container at the beginning */
99 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
101 while (current->num != -1 && con->num > current->num) {
102 current = TAILQ_NEXT(current, nodes);
103 if (current == TAILQ_END(nodes_head)) {
108 /* we need to insert con after current, if current is not NULL */
110 TAILQ_INSERT_BEFORE(current, con, nodes);
112 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
115 goto add_to_focus_head;
118 if (con->type == CT_FLOATING_CON) {
119 DLOG("Inserting into floating containers\n");
120 TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
123 /* Get the first tiling container in focus stack */
124 TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
125 if (loop->type == CT_FLOATING_CON)
132 /* When the container is not a split container (but contains a window)
133 * and is attached to a workspace, we check if the user configured a
134 * workspace_layout. This is done in workspace_attach_to, which will
135 * provide us with the container to which we should attach (either the
136 * workspace or a new split container with the configured
139 if (con->window != NULL &&
140 parent->type == CT_WORKSPACE &&
141 parent->workspace_layout != L_DEFAULT) {
142 DLOG("Parent is a workspace. Applying default layout...\n");
143 Con *target = workspace_attach_to(parent);
145 /* Attach the original con to this new split con instead */
146 nodes_head = &(target->nodes_head);
147 focus_head = &(target->focus_head);
148 con->parent = target;
154 /* Insert the container after the tiling container, if found.
155 * When adding to a CT_OUTPUT, just append one after another. */
156 if (current && parent->type != CT_OUTPUT) {
157 DLOG("Inserting con = %p after last focused tiling con %p\n",
159 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
161 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
165 /* We insert to the TAIL because con_focus() will correct this.
166 * This way, we have the option to insert Cons without having
168 TAILQ_INSERT_TAIL(focus_head, con, focused);
169 con_force_split_parents_redraw(con);
173 * Detaches the given container from its current parent
176 void con_detach(Con *con) {
177 con_force_split_parents_redraw(con);
178 if (con->type == CT_FLOATING_CON) {
179 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
180 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
182 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
183 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
188 * Sets input focus to the given container. Will be updated in X11 in the next
189 * run of x_push_changes().
192 void con_focus(Con *con) {
194 DLOG("con_focus = %p\n", con);
196 /* 1: set focused-pointer to the new con */
197 /* 2: exchange the position of the container in focus stack of the parent all the way up */
198 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
199 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
200 if (con->parent->parent != NULL)
201 con_focus(con->parent);
204 /* We can't blindly reset non-leaf containers since they might have
205 * other urgent children. Therefore we only reset leafs and propagate
206 * the changes upwards via con_update_parents_urgency() which does proper
207 * checks before resetting the urgency.
209 if (con->urgent && con_is_leaf(con)) {
211 con_update_parents_urgency(con);
212 workspace_update_urgent_flag(con_get_workspace(con));
213 ipc_send_window_event("urgent", con);
218 * Returns true when this node is a leaf node (has no children)
221 bool con_is_leaf(Con *con) {
222 return TAILQ_EMPTY(&(con->nodes_head));
226 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
227 * excluding dock containers)
229 bool con_has_managed_window(Con *con) {
230 return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
234 * Returns true if this node has regular or floating children.
237 bool con_has_children(Con *con) {
238 return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
242 * Returns true if a container should be considered split.
245 bool con_is_split(Con *con) {
246 if (con_is_leaf(con))
249 switch (con->layout) {
260 * Returns true if this node accepts a window (if the node swallows windows,
261 * it might already have swallowed enough and cannot hold any more).
264 bool con_accepts_window(Con *con) {
265 /* 1: workspaces never accept direct windows */
266 if (con->type == CT_WORKSPACE)
269 if (con_is_split(con)) {
270 DLOG("container %p does not accept windows, it is a split container.\n", con);
274 /* TODO: if this is a swallowing container, we need to check its max_clients */
275 return (con->window == NULL);
279 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
283 Con *con_get_output(Con *con) {
285 while (result != NULL && result->type != CT_OUTPUT)
286 result = result->parent;
287 /* We must be able to get an output because focus can never be set higher
288 * in the tree (root node cannot be focused). */
289 assert(result != NULL);
294 * Gets the workspace container this node is on.
297 Con *con_get_workspace(Con *con) {
299 while (result != NULL && result->type != CT_WORKSPACE)
300 result = result->parent;
305 * Searches parenst of the given 'con' until it reaches one with the specified
306 * 'orientation'. Aborts when it comes across a floating_con.
309 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
310 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
311 Con *parent = con->parent;
312 if (parent->type == CT_FLOATING_CON)
314 while (con_orientation(parent) != orientation) {
315 DLOG("Need to go one level further up\n");
316 parent = parent->parent;
317 /* Abort when we reach a floating con, or an output con */
319 (parent->type == CT_FLOATING_CON ||
320 parent->type == CT_OUTPUT ||
321 (parent->parent && parent->parent->type == CT_OUTPUT)))
326 DLOG("Result: %p\n", parent);
331 * helper data structure for the breadth-first-search in
332 * con_get_fullscreen_con()
338 TAILQ_ENTRY(bfs_entry) entries;
342 * Returns the first fullscreen node below this node.
345 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode) {
346 Con *current, *child;
348 /* TODO: is breadth-first-search really appropriate? (check as soon as
349 * fullscreen levels and fullscreen for containers is implemented) */
350 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
351 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
353 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
355 while (!TAILQ_EMPTY(&bfs_head)) {
356 entry = TAILQ_FIRST(&bfs_head);
357 current = entry->con;
358 if (current != con && current->fullscreen_mode == fullscreen_mode) {
359 /* empty the queue */
360 while (!TAILQ_EMPTY(&bfs_head)) {
361 entry = TAILQ_FIRST(&bfs_head);
362 TAILQ_REMOVE(&bfs_head, entry, entries);
368 TAILQ_REMOVE(&bfs_head, entry, entries);
371 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
372 entry = smalloc(sizeof(struct bfs_entry));
374 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
377 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
378 entry = smalloc(sizeof(struct bfs_entry));
380 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
388 * Returns true if the container is internal, such as __i3_scratch
391 bool con_is_internal(Con *con) {
392 return (con->name[0] == '_' && con->name[1] == '_');
396 * Returns true if the node is floating.
399 bool con_is_floating(Con *con) {
401 DLOG("checking if con %p is floating\n", con);
402 return (con->floating >= FLOATING_AUTO_ON);
406 * Checks if the given container is either floating or inside some floating
407 * container. It returns the FLOATING_CON container.
410 Con *con_inside_floating(Con *con) {
412 if (con->type == CT_FLOATING_CON)
415 if (con->floating >= FLOATING_AUTO_ON)
418 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
421 return con_inside_floating(con->parent);
425 * Checks if the given container is inside a focused container.
428 bool con_inside_focused(Con *con) {
433 return con_inside_focused(con->parent);
437 * Returns the container with the given client window ID or NULL if no such
441 Con *con_by_window_id(xcb_window_t window) {
443 TAILQ_FOREACH(con, &all_cons, all_cons)
444 if (con->window != NULL && con->window->id == window)
450 * Returns the container with the given frame ID or NULL if no such container
454 Con *con_by_frame_id(xcb_window_t frame) {
456 TAILQ_FOREACH(con, &all_cons, all_cons)
457 if (con->frame == frame)
463 * Returns the first container below 'con' which wants to swallow this window
467 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
470 //DLOG("searching con for window %p starting at con %p\n", window, con);
471 //DLOG("class == %s\n", window->class_class);
473 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
474 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
475 if (!match_matches_window(match, window))
477 if (store_match != NULL)
478 *store_match = match;
481 Con *result = con_for_window(child, window, store_match);
486 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
487 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
488 if (!match_matches_window(match, window))
490 if (store_match != NULL)
491 *store_match = match;
494 Con *result = con_for_window(child, window, store_match);
503 * Returns the number of children of this container.
506 int con_num_children(Con *con) {
510 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
517 * Updates the percent attribute of the children of the given container. This
518 * function needs to be called when a window is added or removed from a
522 void con_fix_percent(Con *con) {
524 int children = con_num_children(con);
526 // calculate how much we have distributed and how many containers
527 // with a percentage set we have
529 int children_with_percent = 0;
530 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
531 if (child->percent > 0.0) {
532 total += child->percent;
533 ++children_with_percent;
537 // if there were children without a percentage set, set to a value that
538 // will make those children proportional to all others
539 if (children_with_percent != children) {
540 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
541 if (child->percent <= 0.0) {
542 if (children_with_percent == 0)
543 total += (child->percent = 1.0);
545 total += (child->percent = total / children_with_percent);
550 // if we got a zero, just distribute the space equally, otherwise
551 // distribute according to the proportions we got
553 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
554 child->percent = 1.0 / children;
555 } else if (total != 1.0) {
556 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
557 child->percent /= total;
562 * Toggles fullscreen mode for the given container. If there already is a
563 * fullscreen container on this workspace, fullscreen will be disabled and then
564 * enabled for the container the user wants to have in fullscreen mode.
567 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
568 Con *workspace, *fullscreen;
570 if (con->type == CT_WORKSPACE) {
571 DLOG("You cannot make a workspace fullscreen.\n");
575 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
576 if (con->fullscreen_mode == CF_NONE) {
577 /* 1: check if there already is a fullscreen con */
578 if (fullscreen_mode == CF_GLOBAL)
579 fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
581 workspace = con_get_workspace(con);
582 fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
584 if (fullscreen != NULL) {
585 /* Disable fullscreen for the currently fullscreened
586 * container and enable it for the one the user wants
587 * to have in fullscreen mode. */
588 LOG("Disabling fullscreen for (%p/%s) upon user request\n",
589 fullscreen, fullscreen->name);
590 fullscreen->fullscreen_mode = CF_NONE;
593 /* 2: enable fullscreen */
594 con->fullscreen_mode = fullscreen_mode;
596 /* 1: disable fullscreen */
597 con->fullscreen_mode = CF_NONE;
600 DLOG("mode now: %d\n", con->fullscreen_mode);
602 /* Send an ipc window "fullscreen_mode" event */
603 ipc_send_window_event("fullscreen_mode", con);
605 /* update _NET_WM_STATE if this container has a window */
606 /* TODO: when a window is assigned to a container which is already
607 * fullscreened, this state needs to be pushed to the client, too */
608 if (con->window == NULL)
612 unsigned int num = 0;
614 if (con->fullscreen_mode != CF_NONE)
615 values[num++] = A__NET_WM_STATE_FULLSCREEN;
617 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
618 A__NET_WM_STATE, XCB_ATOM_ATOM, 32, num, values);
622 * Moves the given container to the currently focused container on the given
625 * The fix_coordinates flag will translate the current coordinates (offset from
626 * the monitor position basically) to appropriate coordinates on the
627 * destination workspace.
628 * Not enabling this behaviour comes in handy when this function gets called by
629 * floating_maybe_reassign_ws, which will only "move" a floating window when it
630 * *already* changed its coordinates to a different output.
632 * The dont_warp flag disables pointer warping and will be set when this
633 * function is called while dragging a floating window.
635 * TODO: is there a better place for this function?
638 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp) {
639 /* Prevent moving if this would violate the fullscreen focus restrictions. */
640 if (!con_fullscreen_permits_focusing(workspace)) {
641 LOG("Cannot move out of a fullscreen container");
645 if (con_is_floating(con)) {
646 DLOG("Using FLOATINGCON instead\n");
650 Con *source_ws = con_get_workspace(con);
651 if (workspace == source_ws) {
652 DLOG("Not moving, already there\n");
656 if (con->type == CT_WORKSPACE) {
657 /* Re-parent all of the old workspace's floating windows. */
659 while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
660 child = TAILQ_FIRST(&(source_ws->floating_head));
661 con_move_to_workspace(child, workspace, true, true);
664 /* If there are no non-floating children, ignore the workspace. */
665 if (con_is_leaf(con))
668 con = workspace_encapsulate(con);
670 ELOG("Workspace failed to move its contents into a container!\n");
675 /* Save the current workspace. So we can call workspace_show() by the end
676 * of this function. */
677 Con *current_ws = con_get_workspace(focused);
679 Con *source_output = con_get_output(con),
680 *dest_output = con_get_output(workspace);
682 /* 1: save the container which is going to be focused after the current
683 * container is moved away */
684 Con *focus_next = con_next_focused(con);
686 /* 2: get the focused container of this workspace */
687 Con *next = con_descend_focused(workspace);
689 /* 3: we go up one level, but only when next is a normal container */
690 if (next->type != CT_WORKSPACE) {
691 DLOG("next originally = %p / %s / type %d\n", next, next->name, next->type);
695 /* 4: if the target container is floating, we get the workspace instead.
696 * Only tiling windows need to get inserted next to the current container.
698 Con *floatingcon = con_inside_floating(next);
699 if (floatingcon != NULL) {
700 DLOG("floatingcon, going up even further\n");
701 next = floatingcon->parent;
704 if (con->type == CT_FLOATING_CON) {
705 Con *ws = con_get_workspace(next);
706 DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
710 if (source_output != dest_output) {
711 /* Take the relative coordinates of the current output, then add them
712 * to the coordinate space of the correct output */
713 if (fix_coordinates && con->type == CT_FLOATING_CON) {
714 floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
716 DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
718 /* If moving to a visible workspace, call show so it can be considered
719 * focused. Must do before attaching because workspace_show checks to see
720 * if focused container is in its area. */
721 if (workspace_is_visible(workspace)) {
722 workspace_show(workspace);
724 /* Don’t warp if told so (when dragging floating windows with the
725 * mouse for example) */
729 x_set_warp_to(&(con->rect));
733 /* If moving a fullscreen container and the destination already has a
734 * fullscreen window on it, un-fullscreen the target's fullscreen con. */
735 Con *fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
736 if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
737 con_toggle_fullscreen(fullscreen, CF_OUTPUT);
741 DLOG("Re-attaching container to %p / %s\n", next, next->name);
742 /* 5: re-attach the con to the parent of this focused container */
743 Con *parent = con->parent;
745 con_attach(con, next, false);
747 /* 6: fix the percentages */
748 con_fix_percent(parent);
750 con_fix_percent(next);
752 /* 7: focus the con on the target workspace, but only within that
753 * workspace, that is, don’t move focus away if the target workspace is
755 * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
756 * we don’t focus when there is a fullscreen con on that workspace. */
757 if (!con_is_internal(workspace) && !fullscreen) {
758 /* We need to save the focused workspace on the output in case the
759 * new workspace is hidden and it's necessary to immediately switch
760 * back to the originally-focused workspace. */
761 Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
762 con_focus(con_descend_focused(con));
764 /* Restore focus if the output's focused workspace has changed. */
765 if (con_get_workspace(focused) != old_focus)
766 con_focus(old_focus);
769 /* 8: when moving to another workspace, we leave the focus on the current
770 * workspace. (see also #809) */
772 /* Descend focus stack in case focus_next is a workspace which can
773 * occur if we move to the same workspace. Also show current workspace
774 * to ensure it is focused. */
775 workspace_show(current_ws);
777 /* Set focus only if con was on current workspace before moving.
778 * Otherwise we would give focus to some window on different workspace. */
779 if (source_ws == current_ws)
780 con_focus(con_descend_focused(focus_next));
782 /* If anything within the container is associated with a startup sequence,
783 * delete it so child windows won't be created on the old workspace. */
784 struct Startup_Sequence *sequence;
785 xcb_get_property_cookie_t cookie;
786 xcb_get_property_reply_t *startup_id_reply;
788 if (!con_is_leaf(con)) {
790 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
794 cookie = xcb_get_property(conn, false, child->window->id,
795 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
796 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
798 sequence = startup_sequence_get(child->window, startup_id_reply, true);
799 if (sequence != NULL)
800 startup_sequence_delete(sequence);
805 cookie = xcb_get_property(conn, false, con->window->id,
806 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
807 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
809 sequence = startup_sequence_get(con->window, startup_id_reply, true);
810 if (sequence != NULL)
811 startup_sequence_delete(sequence);
814 CALL(parent, on_remove_child);
816 ipc_send_window_event("move", con);
820 * Returns the orientation of the given container (for stacked containers,
821 * vertical orientation is used regardless of the actual orientation of the
825 orientation_t con_orientation(Con *con) {
826 switch (con->layout) {
828 /* stacking containers behave like they are in vertical orientation */
833 /* tabbed containers behave like they are in vertical orientation */
838 DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
844 DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
849 DLOG("con_orientation() ran into default\n");
855 * Returns the container which will be focused next when the given container
856 * is not available anymore. Called in tree_close and con_move_to_workspace
857 * to properly restore focus.
860 Con *con_next_focused(Con *con) {
862 /* floating containers are attached to a workspace, so we focus either the
863 * next floating container (if any) or the workspace itself. */
864 if (con->type == CT_FLOATING_CON) {
865 DLOG("selecting next for CT_FLOATING_CON\n");
866 next = TAILQ_NEXT(con, floating_windows);
867 DLOG("next = %p\n", next);
869 next = TAILQ_PREV(con, floating_head, floating_windows);
870 DLOG("using prev, next = %p\n", next);
873 Con *ws = con_get_workspace(con);
875 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
876 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
877 next = TAILQ_FIRST(&(next->focus_head));
879 DLOG("skipping container itself, we want the next client\n");
880 next = TAILQ_NEXT(next, focused);
883 if (next == TAILQ_END(&(ws->focus_head))) {
884 DLOG("Focus list empty, returning ws\n");
888 /* Instead of returning the next CT_FLOATING_CON, we descend it to
889 * get an actual window to focus. */
890 next = con_descend_focused(next);
895 /* dock clients cannot be focused, so we focus the workspace instead */
896 if (con->parent->type == CT_DOCKAREA) {
897 DLOG("selecting workspace for dock client\n");
898 return con_descend_focused(output_get_content(con->parent->parent));
901 /* if 'con' is not the first entry in the focus stack, use the first one as
902 * it’s currently focused already */
903 Con *first = TAILQ_FIRST(&(con->parent->focus_head));
905 DLOG("Using first entry %p\n", first);
908 /* try to focus the next container on the same level as this one or fall
909 * back to its parent */
910 if (!(next = TAILQ_NEXT(con, focused)))
914 /* now go down the focus stack as far as
915 * possible, excluding the current container */
916 while (!TAILQ_EMPTY(&(next->focus_head)) &&
917 TAILQ_FIRST(&(next->focus_head)) != con)
918 next = TAILQ_FIRST(&(next->focus_head));
924 * Get the next/previous container in the specified orientation. This may
925 * travel up until it finds a container with suitable orientation.
928 Con *con_get_next(Con *con, char way, orientation_t orientation) {
929 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
930 /* 1: get the first parent with the same orientation */
932 while (con_orientation(cur->parent) != orientation) {
933 DLOG("need to go one level further up\n");
934 if (cur->parent->type == CT_WORKSPACE) {
935 LOG("that's a workspace, we can't go further up\n");
941 /* 2: chose next (or previous) */
944 next = TAILQ_NEXT(cur, nodes);
945 /* if we are at the end of the list, we need to wrap */
946 if (next == TAILQ_END(&(parent->nodes_head)))
949 next = TAILQ_PREV(cur, nodes_head, nodes);
950 /* if we are at the end of the list, we need to wrap */
951 if (next == TAILQ_END(&(cur->nodes_head)))
954 DLOG("next = %p\n", next);
960 * Returns the focused con inside this client, descending the tree as far as
961 * possible. This comes in handy when attaching a con to a workspace at the
962 * currently focused position, for example.
965 Con *con_descend_focused(Con *con) {
967 while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
968 next = TAILQ_FIRST(&(next->focus_head));
973 * Returns the focused con inside this client, descending the tree as far as
974 * possible. This comes in handy when attaching a con to a workspace at the
975 * currently focused position, for example.
977 * Works like con_descend_focused but considers only tiling cons.
980 Con *con_descend_tiling_focused(Con *con) {
988 TAILQ_FOREACH(child, &(next->focus_head), focused) {
989 if (child->type == CT_FLOATING_CON)
995 } while (before != next && next != focused);
1000 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1001 * direction is D_LEFT, then we return the rightmost container and if direction
1002 * is D_RIGHT, we return the leftmost container. This is because if we are
1003 * moving D_LEFT, and thus want the rightmost container.
1006 Con *con_descend_direction(Con *con, direction_t direction) {
1009 int orientation = con_orientation(con);
1010 DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1011 if (direction == D_LEFT || direction == D_RIGHT) {
1012 if (orientation == HORIZ) {
1013 /* If the direction is horizontal, we can use either the first
1014 * (D_RIGHT) or the last con (D_LEFT) */
1015 if (direction == D_RIGHT)
1016 most = TAILQ_FIRST(&(con->nodes_head));
1018 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1019 } else if (orientation == VERT) {
1020 /* Wrong orientation. We use the last focused con. Within that con,
1021 * we recurse to chose the left/right con or at least the last
1023 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1024 if (current->type != CT_FLOATING_CON) {
1030 /* If the con has no orientation set, it’s not a split container
1031 * but a container with a client window, so stop recursing */
1036 if (direction == D_UP || direction == D_DOWN) {
1037 if (orientation == VERT) {
1038 /* If the direction is vertical, we can use either the first
1039 * (D_DOWN) or the last con (D_UP) */
1040 if (direction == D_UP)
1041 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1043 most = TAILQ_FIRST(&(con->nodes_head));
1044 } else if (orientation == HORIZ) {
1045 /* Wrong orientation. We use the last focused con. Within that con,
1046 * we recurse to chose the top/bottom con or at least the last
1048 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1049 if (current->type != CT_FLOATING_CON) {
1055 /* If the con has no orientation set, it’s not a split container
1056 * but a container with a client window, so stop recursing */
1063 return con_descend_direction(most, direction);
1067 * Returns a "relative" Rect which contains the amount of pixels that need to
1068 * be added to the original Rect to get the final position (obviously the
1069 * amount of pixels for normal, 1pixel and borderless are different).
1072 Rect con_border_style_rect(Con *con) {
1073 adjacent_t borders_to_hide = ADJ_NONE;
1074 int border_width = con->current_border_width;
1075 DLOG("The border width for con is set to: %d\n", con->current_border_width);
1077 if (con->current_border_width < 0) {
1078 if (con_is_floating(con)) {
1079 border_width = config.default_floating_border_width;
1081 border_width = config.default_border_width;
1084 DLOG("Effective border width is set to: %d\n", border_width);
1085 /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1086 int border_style = con_border_style(con);
1087 if (border_style == BS_NONE)
1088 return (Rect) {0, 0, 0, 0};
1089 borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1090 if (border_style == BS_NORMAL) {
1091 result = (Rect) {border_width, 0, -(2 * border_width), -(border_width)};
1093 result = (Rect) {border_width, border_width, -(2 * border_width), -(2 * border_width)};
1096 /* Floating windows are never adjacent to any other window, so
1097 don’t hide their border(s). This prevents bug #998. */
1098 if (con_is_floating(con))
1101 if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1102 result.x -= border_width;
1103 result.width += border_width;
1105 if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1106 result.width += border_width;
1108 if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1109 result.y -= border_width;
1110 result.height += border_width;
1112 if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1113 result.height += border_width;
1119 * Returns adjacent borders of the window. We need this if hide_edge_borders is
1122 adjacent_t con_adjacent_borders(Con *con) {
1123 adjacent_t result = ADJ_NONE;
1124 Con *workspace = con_get_workspace(con);
1125 if (con->rect.x == workspace->rect.x)
1126 result |= ADJ_LEFT_SCREEN_EDGE;
1127 if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1128 result |= ADJ_RIGHT_SCREEN_EDGE;
1129 if (con->rect.y == workspace->rect.y)
1130 result |= ADJ_UPPER_SCREEN_EDGE;
1131 if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1132 result |= ADJ_LOWER_SCREEN_EDGE;
1137 * Use this function to get a container’s border style. This is important
1138 * because when inside a stack, the border style is always BS_NORMAL.
1139 * For tabbed mode, the same applies, with one exception: when the container is
1140 * borderless and the only element in the tabbed container, the border is not
1143 * For children of a CT_DOCKAREA, the border style is always none.
1146 int con_border_style(Con *con) {
1147 Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1149 DLOG("this one is fullscreen! overriding BS_NONE\n");
1153 if (con->parent->layout == L_STACKED)
1154 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1156 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1157 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1159 if (con->parent->type == CT_DOCKAREA)
1162 return con->border_style;
1166 * Sets the given border style on con, correctly keeping the position/size of a
1170 void con_set_border_style(Con *con, int border_style, int border_width) {
1171 /* Handle the simple case: non-floating containerns */
1172 if (!con_is_floating(con)) {
1173 con->border_style = border_style;
1174 con->current_border_width = border_width;
1178 /* For floating containers, we want to keep the position/size of the
1179 * *window* itself. We first add the border pixels to con->rect to make
1180 * con->rect represent the absolute position of the window (same for
1181 * parent). Then, we change the border style and subtract the new border
1182 * pixels. For the parent, we do the same also for the decoration. */
1183 DLOG("This is a floating container\n");
1185 Con *parent = con->parent;
1186 Rect bsr = con_border_style_rect(con);
1187 int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1189 con->rect = rect_add(con->rect, bsr);
1190 parent->rect = rect_add(parent->rect, bsr);
1191 parent->rect.y += deco_height;
1192 parent->rect.height -= deco_height;
1194 /* Change the border style, get new border/decoration values. */
1195 con->border_style = border_style;
1196 con->current_border_width = border_width;
1197 bsr = con_border_style_rect(con);
1198 deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1200 con->rect = rect_sub(con->rect, bsr);
1201 parent->rect = rect_sub(parent->rect, bsr);
1202 parent->rect.y -= deco_height;
1203 parent->rect.height += deco_height;
1207 * This function changes the layout of a given container. Use it to handle
1208 * special cases like changing a whole workspace to stacked/tabbed (creates a
1209 * new split container before).
1212 void con_set_layout(Con *con, layout_t layout) {
1213 DLOG("con_set_layout(%p, %d), con->type = %d\n",
1214 con, layout, con->type);
1216 /* Users can focus workspaces, but not any higher in the hierarchy.
1217 * Focus on the workspace is a special case, since in every other case, the
1218 * user means "change the layout of the parent split container". */
1219 if (con->type != CT_WORKSPACE)
1222 /* We fill in last_split_layout when switching to a different layout
1223 * since there are many places in the code that don’t use
1224 * con_set_layout(). */
1225 if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1226 con->last_split_layout = con->layout;
1228 /* When the container type is CT_WORKSPACE, the user wants to change the
1229 * whole workspace into stacked/tabbed mode. To do this and still allow
1230 * intuitive operations (like level-up and then opening a new window), we
1231 * need to create a new split container. */
1232 if (con->type == CT_WORKSPACE &&
1233 (layout == L_STACKED || layout == L_TABBED)) {
1234 if (con_num_children(con) == 0) {
1235 DLOG("Setting workspace_layout to %d\n", layout);
1236 con->workspace_layout = layout;
1238 DLOG("Creating new split container\n");
1239 /* 1: create a new split container */
1240 Con *new = con_new(NULL, NULL);
1243 /* 2: Set the requested layout on the split container and mark it as
1245 new->layout = layout;
1246 new->last_split_layout = con->last_split_layout;
1248 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1249 if (old_focused == TAILQ_END(&(con->focus_head)))
1252 /* 3: move the existing cons of this workspace below the new con */
1253 DLOG("Moving cons\n");
1255 while (!TAILQ_EMPTY(&(con->nodes_head))) {
1256 child = TAILQ_FIRST(&(con->nodes_head));
1258 con_attach(child, new, true);
1261 /* 4: attach the new split container to the workspace */
1262 DLOG("Attaching new split to ws\n");
1263 con_attach(new, con, false);
1266 con_focus(old_focused);
1268 tree_flatten(croot);
1270 con_force_split_parents_redraw(con);
1274 if (layout == L_DEFAULT) {
1275 /* Special case: the layout formerly known as "default" (in combination
1276 * with an orientation). Since we switched to splith/splitv layouts,
1277 * using the "default" layout (which "only" should happen when using
1278 * legacy configs) is using the last split layout (either splith or
1279 * splitv) in order to still do the same thing.
1281 * Starting from v4.6 though, we will nag users about using "layout
1282 * default", and in v4.9 we will remove it entirely (with an
1283 * appropriate i3-migrate-config mechanism). */
1284 con->layout = con->last_split_layout;
1285 /* In case last_split_layout was not initialized… */
1286 if (con->layout == L_DEFAULT)
1287 con->layout = L_SPLITH;
1289 con->layout = layout;
1291 con_force_split_parents_redraw(con);
1295 * This function toggles the layout of a given container. toggle_mode can be
1296 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1297 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1301 void con_toggle_layout(Con *con, const char *toggle_mode) {
1303 /* Users can focus workspaces, but not any higher in the hierarchy.
1304 * Focus on the workspace is a special case, since in every other case, the
1305 * user means "change the layout of the parent split container". */
1306 if (con->type != CT_WORKSPACE)
1307 parent = con->parent;
1308 DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1310 if (strcmp(toggle_mode, "split") == 0) {
1311 /* Toggle between splits. When the current layout is not a split
1312 * layout, we just switch back to last_split_layout. Otherwise, we
1313 * change to the opposite split layout. */
1314 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV)
1315 con_set_layout(con, parent->last_split_layout);
1317 if (parent->layout == L_SPLITH)
1318 con_set_layout(con, L_SPLITV);
1320 con_set_layout(con, L_SPLITH);
1323 if (parent->layout == L_STACKED)
1324 con_set_layout(con, L_TABBED);
1325 else if (parent->layout == L_TABBED) {
1326 if (strcmp(toggle_mode, "all") == 0)
1327 con_set_layout(con, L_SPLITH);
1329 con_set_layout(con, parent->last_split_layout);
1330 } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1331 if (strcmp(toggle_mode, "all") == 0) {
1332 /* When toggling through all modes, we toggle between
1333 * splith/splitv, whereas normally we just directly jump to
1335 if (parent->layout == L_SPLITH)
1336 con_set_layout(con, L_SPLITV);
1338 con_set_layout(con, L_STACKED);
1340 con_set_layout(con, L_STACKED);
1347 * Callback which will be called when removing a child from the given con.
1348 * Kills the container if it is empty and replaces it with the child if there
1349 * is exactly one child.
1352 static void con_on_remove_child(Con *con) {
1353 DLOG("on_remove_child\n");
1355 /* Every container 'above' (in the hierarchy) the workspace content should
1356 * not be closed when the last child was removed */
1357 if (con->type == CT_OUTPUT ||
1358 con->type == CT_ROOT ||
1359 con->type == CT_DOCKAREA ||
1360 (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1361 DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1365 /* For workspaces, close them only if they're not visible anymore */
1366 if (con->type == CT_WORKSPACE) {
1367 if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1368 LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1369 tree_close(con, DONT_KILL_WINDOW, false, false);
1370 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
1375 con_force_split_parents_redraw(con);
1376 con->urgent = con_has_urgent_child(con);
1377 con_update_parents_urgency(con);
1379 /* TODO: check if this container would swallow any other client and
1380 * don’t close it automatically. */
1381 int children = con_num_children(con);
1382 if (children == 0) {
1383 DLOG("Container empty, closing\n");
1384 tree_close(con, DONT_KILL_WINDOW, false, false);
1390 * Determines the minimum size of the given con by looking at its children (for
1391 * split/stacked/tabbed cons). Will be called when resizing floating cons
1394 Rect con_minimum_size(Con *con) {
1395 DLOG("Determining minimum size for con %p\n", con);
1397 if (con_is_leaf(con)) {
1398 DLOG("leaf node, returning 75x50\n");
1399 return (Rect) {0, 0, 75, 50};
1402 if (con->type == CT_FLOATING_CON) {
1403 DLOG("floating con\n");
1404 Con *child = TAILQ_FIRST(&(con->nodes_head));
1405 return con_minimum_size(child);
1408 if (con->layout == L_STACKED || con->layout == L_TABBED) {
1409 uint32_t max_width = 0, max_height = 0, deco_height = 0;
1411 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1412 Rect min = con_minimum_size(child);
1413 deco_height += child->deco_rect.height;
1414 max_width = max(max_width, min.width);
1415 max_height = max(max_height, min.height);
1417 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1418 max_width, max_height, deco_height);
1419 return (Rect) {0, 0, max_width, max_height + deco_height};
1422 /* For horizontal/vertical split containers we sum up the width (h-split)
1423 * or height (v-split) and use the maximum of the height (h-split) or width
1424 * (v-split) as minimum size. */
1425 if (con_is_split(con)) {
1426 uint32_t width = 0, height = 0;
1428 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1429 Rect min = con_minimum_size(child);
1430 if (con->layout == L_SPLITH) {
1432 height = max(height, min.height);
1434 height += min.height;
1435 width = max(width, min.width);
1438 DLOG("split container, returning width = %d x height = %d\n", width, height);
1439 return (Rect) {0, 0, width, height};
1442 ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1443 con->type, con->layout, con_is_split(con));
1448 * Returns true if changing the focus to con would be allowed considering
1449 * the fullscreen focus constraints. Specifically, if a fullscreen container or
1450 * any of its descendants is focused, this function returns true if and only if
1451 * focusing con would mean that focus would still be visible on screen, i.e.,
1452 * the newly focused container would not be obscured by a fullscreen container.
1454 * In the simplest case, if a fullscreen container or any of its descendants is
1455 * fullscreen, this functions returns true if con is the fullscreen container
1456 * itself or any of its descendants, as this means focus wouldn't escape the
1457 * boundaries of the fullscreen container.
1459 * In case the fullscreen container is of type CF_OUTPUT, this function returns
1460 * true if con is on a different workspace, as focus wouldn't be obscured by
1461 * the fullscreen container that is constrained to a different workspace.
1463 * Note that this same logic can be applied to moving containers. If a
1464 * container can be focused under the fullscreen focus constraints, it can also
1465 * become a parent or sibling to the currently focused container.
1468 bool con_fullscreen_permits_focusing(Con *con) {
1469 /* No focus, no problem. */
1473 /* Find the first fullscreen ascendent. */
1475 while (fs && fs->fullscreen_mode == CF_NONE)
1478 /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1479 * there always has to be a workspace con in the hierarchy. */
1481 /* The most common case is we hit the workspace level. In this
1482 * situation, changing focus is also harmless. */
1483 assert(fs->fullscreen_mode != CF_NONE);
1484 if (fs->type == CT_WORKSPACE)
1487 /* Allow it if the container itself is the fullscreen container. */
1491 /* If fullscreen is per-output, the focus being in a different workspace is
1492 * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1493 if (fs->fullscreen_mode == CF_OUTPUT &&
1494 con_get_workspace(con) != con_get_workspace(fs)) {
1498 /* Allow it only if the container to be focused is contained within the
1499 * current fullscreen container. */
1501 if (con->parent == fs)
1506 /* Focusing con would hide it behind a fullscreen window, disallow it. */
1512 * Checks if the given container has an urgent child.
1515 bool con_has_urgent_child(Con *con) {
1518 if (con_is_leaf(con))
1521 /* We are not interested in floating windows since they can only be
1522 * attached to a workspace → nodes_head instead of focus_head */
1523 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1524 if (con_has_urgent_child(child))
1532 * Make all parent containers urgent if con is urgent or clear the urgent flag
1533 * of all parent containers if there are no more urgent children left.
1536 void con_update_parents_urgency(Con *con) {
1537 Con *parent = con->parent;
1539 bool new_urgency_value = con->urgent;
1540 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
1541 if (new_urgency_value) {
1542 parent->urgent = true;
1544 /* We can only reset the urgency when the parent
1545 * has no other urgent children */
1546 if (!con_has_urgent_child(parent))
1547 parent->urgent = false;
1549 parent = parent->parent;
1554 * Set urgency flag to the container, all the parent containers and the workspace.
1557 void con_set_urgency(Con *con, bool urgent) {
1558 if (focused == con) {
1559 DLOG("Ignoring urgency flag for current client\n");
1560 con->window->urgent.tv_sec = 0;
1561 con->window->urgent.tv_usec = 0;
1565 if (con->urgency_timer == NULL) {
1566 con->urgent = urgent;
1568 DLOG("Discarding urgency WM_HINT because timer is running\n");
1573 gettimeofday(&con->window->urgent, NULL);
1575 con->window->urgent.tv_sec = 0;
1576 con->window->urgent.tv_usec = 0;
1580 con_update_parents_urgency(con);
1583 /* Set the urgency flag on the workspace, if a workspace could be found
1584 * (for dock clients, that is not the case). */
1585 if ((ws = con_get_workspace(con)) != NULL)
1586 workspace_update_urgent_flag(ws);
1588 if (con->urgent == urgent) {
1589 LOG("Urgency flag changed to %d\n", con->urgent);
1590 ipc_send_window_event("urgent", con);
1595 * Create a string representing the subtree under con.
1598 char *con_get_tree_representation(Con *con) {
1599 /* this code works as follows:
1600 * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
1601 * 2) append the tree representation of the children to the string
1602 * 3) add closing bracket
1604 * The recursion ends when we hit a leaf, in which case we return the
1605 * class_instance of the contained window.
1608 /* end of recursion */
1609 if (con_is_leaf(con)) {
1611 return sstrdup("nowin");
1613 if (!con->window->class_instance)
1614 return sstrdup("noinstance");
1616 return sstrdup(con->window->class_instance);
1620 /* 1) add the Layout type to buf */
1621 if (con->layout == L_DEFAULT)
1622 buf = sstrdup("D[");
1623 else if (con->layout == L_SPLITV)
1624 buf = sstrdup("V[");
1625 else if (con->layout == L_SPLITH)
1626 buf = sstrdup("H[");
1627 else if (con->layout == L_TABBED)
1628 buf = sstrdup("T[");
1629 else if (con->layout == L_STACKED)
1630 buf = sstrdup("S[");
1632 ELOG("BUG: Code not updated to account for new layout type\n");
1636 /* 2) append representation of children */
1638 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1639 char *child_txt = con_get_tree_representation(child);
1642 sasprintf(&tmp_buf, "%s%s%s", buf,
1643 (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
1648 /* 3) close the brackets */
1650 sasprintf(&complete_buf, "%s]", buf);
1653 return complete_buf;