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 * con.c: Functions which deal with containers directly (creating containers,
8 * searching containers, getting specific properties from containers,
14 #include "yajl_utils.h"
16 static void con_on_remove_child(Con *con);
19 * force parent split containers to be redrawn
22 void con_force_split_parents_redraw(Con *con) {
25 while (parent != NULL && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
26 if (!con_is_leaf(parent)) {
27 FREE(parent->deco_render_params);
30 parent = parent->parent;
35 * Create a new container (and attach it to the given parent, if not NULL).
36 * This function only initializes the data structures.
39 Con *con_new_skeleton(Con *parent, i3Window *window) {
40 Con *new = scalloc(1, sizeof(Con));
41 new->on_remove_child = con_on_remove_child;
42 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
45 new->border_style = config.default_border;
46 new->current_border_width = -1;
48 new->depth = window->depth;
49 new->window->aspect_ratio = 0.0;
51 new->depth = root_depth;
53 DLOG("opening window\n");
55 TAILQ_INIT(&(new->floating_head));
56 TAILQ_INIT(&(new->nodes_head));
57 TAILQ_INIT(&(new->focus_head));
58 TAILQ_INIT(&(new->swallow_head));
59 TAILQ_INIT(&(new->marks_head));
62 con_attach(new, parent, false);
67 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
70 Con *con_new(Con *parent, i3Window *window) {
71 Con *new = con_new_skeleton(parent, window);
76 static void _con_attach(Con *con, Con *parent, Con *previous, bool ignore_focus) {
79 Con *current = previous;
80 struct nodes_head *nodes_head = &(parent->nodes_head);
81 struct focus_head *focus_head = &(parent->focus_head);
83 /* Workspaces are handled differently: they need to be inserted at the
85 if (con->type == CT_WORKSPACE) {
86 DLOG("it's a workspace. num = %d\n", con->num);
87 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
88 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
90 current = TAILQ_FIRST(nodes_head);
91 if (con->num < current->num) {
92 /* we need to insert the container at the beginning */
93 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
95 while (current->num != -1 && con->num > current->num) {
96 current = TAILQ_NEXT(current, nodes);
97 if (current == TAILQ_END(nodes_head)) {
102 /* we need to insert con after current, if current is not NULL */
104 TAILQ_INSERT_BEFORE(current, con, nodes);
106 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
109 goto add_to_focus_head;
112 if (con->type == CT_FLOATING_CON) {
113 DLOG("Inserting into floating containers\n");
114 TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
117 /* Get the first tiling container in focus stack */
118 TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
119 if (loop->type == CT_FLOATING_CON)
126 /* When the container is not a split container (but contains a window)
127 * and is attached to a workspace, we check if the user configured a
128 * workspace_layout. This is done in workspace_attach_to, which will
129 * provide us with the container to which we should attach (either the
130 * workspace or a new split container with the configured
133 if (con->window != NULL &&
134 parent->type == CT_WORKSPACE &&
135 parent->workspace_layout != L_DEFAULT) {
136 DLOG("Parent is a workspace. Applying default layout...\n");
137 Con *target = workspace_attach_to(parent);
139 /* Attach the original con to this new split con instead */
140 nodes_head = &(target->nodes_head);
141 focus_head = &(target->focus_head);
142 con->parent = target;
148 /* Insert the container after the tiling container, if found.
149 * When adding to a CT_OUTPUT, just append one after another. */
150 if (current != NULL && parent->type != CT_OUTPUT) {
151 DLOG("Inserting con = %p after con %p\n", con, current);
152 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
154 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
158 /* We insert to the TAIL because con_focus() will correct this.
159 * This way, we have the option to insert Cons without having
161 TAILQ_INSERT_TAIL(focus_head, con, focused);
162 con_force_split_parents_redraw(con);
166 * Attaches the given container to the given parent. This happens when moving
167 * a container or when inserting a new container at a specific place in the
170 * ignore_focus is to just insert the Con at the end (useful when creating a
171 * new split container *around* some containers, that is, detaching and
172 * attaching them in order without wanting to mess with the focus in between).
175 void con_attach(Con *con, Con *parent, bool ignore_focus) {
176 _con_attach(con, parent, NULL, ignore_focus);
180 * Detaches the given container from its current parent
183 void con_detach(Con *con) {
184 con_force_split_parents_redraw(con);
185 if (con->type == CT_FLOATING_CON) {
186 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
187 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
189 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
190 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
195 * Sets input focus to the given container. Will be updated in X11 in the next
196 * run of x_push_changes().
199 void con_focus(Con *con) {
201 DLOG("con_focus = %p\n", con);
203 /* 1: set focused-pointer to the new con */
204 /* 2: exchange the position of the container in focus stack of the parent all the way up */
205 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
206 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
207 if (con->parent->parent != NULL)
208 con_focus(con->parent);
211 /* We can't blindly reset non-leaf containers since they might have
212 * other urgent children. Therefore we only reset leafs and propagate
213 * the changes upwards via con_update_parents_urgency() which does proper
214 * checks before resetting the urgency.
216 if (con->urgent && con_is_leaf(con)) {
217 con_set_urgency(con, false);
218 con_update_parents_urgency(con);
219 workspace_update_urgent_flag(con_get_workspace(con));
220 ipc_send_window_event("urgent", con);
225 * Closes the given container.
228 void con_close(Con *con, kill_window_t kill_window) {
230 DLOG("Closing con = %p.\n", con);
232 /* We never close output or root containers. */
233 if (con->type == CT_OUTPUT || con->type == CT_ROOT) {
234 DLOG("con = %p is of type %d, not closing anything.\n", con, con->type);
238 if (con->type == CT_WORKSPACE) {
239 DLOG("con = %p is a workspace, closing all children instead.\n", con);
240 Con *child, *nextchild;
241 for (child = TAILQ_FIRST(&(con->focus_head)); child;) {
242 nextchild = TAILQ_NEXT(child, focused);
243 DLOG("killing child = %p.\n", child);
244 tree_close_internal(child, kill_window, false, false);
251 tree_close_internal(con, kill_window, false, false);
255 * Returns true when this node is a leaf node (has no children)
258 bool con_is_leaf(Con *con) {
259 return TAILQ_EMPTY(&(con->nodes_head));
263 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
264 * excluding dock containers)
266 bool con_has_managed_window(Con *con) {
267 return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
271 * Returns true if this node has regular or floating children.
274 bool con_has_children(Con *con) {
275 return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
279 * Returns true if a container should be considered split.
282 bool con_is_split(Con *con) {
283 if (con_is_leaf(con))
286 switch (con->layout) {
297 * This will only return true for containers which have some parent with
298 * a tabbed / stacked parent of which they are not the currently focused child.
301 bool con_is_hidden(Con *con) {
304 /* ascend to the workspace level and memorize the highest-up container
305 * which is stacked or tabbed. */
306 while (current != NULL && current->type != CT_WORKSPACE) {
307 Con *parent = current->parent;
308 if (parent != NULL && (parent->layout == L_TABBED || parent->layout == L_STACKED)) {
309 if (TAILQ_FIRST(&(parent->focus_head)) != current)
320 * Returns whether the container or any of its children is sticky.
323 bool con_is_sticky(Con *con) {
328 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
329 if (con_is_sticky(child))
337 * Returns true if this node accepts a window (if the node swallows windows,
338 * it might already have swallowed enough and cannot hold any more).
341 bool con_accepts_window(Con *con) {
342 /* 1: workspaces never accept direct windows */
343 if (con->type == CT_WORKSPACE)
346 if (con_is_split(con)) {
347 DLOG("container %p does not accept windows, it is a split container.\n", con);
351 /* TODO: if this is a swallowing container, we need to check its max_clients */
352 return (con->window == NULL);
356 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
360 Con *con_get_output(Con *con) {
362 while (result != NULL && result->type != CT_OUTPUT)
363 result = result->parent;
364 /* We must be able to get an output because focus can never be set higher
365 * in the tree (root node cannot be focused). */
366 assert(result != NULL);
371 * Gets the workspace container this node is on.
374 Con *con_get_workspace(Con *con) {
376 while (result != NULL && result->type != CT_WORKSPACE)
377 result = result->parent;
382 * Searches parenst of the given 'con' until it reaches one with the specified
383 * 'orientation'. Aborts when it comes across a floating_con.
386 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
387 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
388 Con *parent = con->parent;
389 if (parent->type == CT_FLOATING_CON)
391 while (con_orientation(parent) != orientation) {
392 DLOG("Need to go one level further up\n");
393 parent = parent->parent;
394 /* Abort when we reach a floating con, or an output con */
396 (parent->type == CT_FLOATING_CON ||
397 parent->type == CT_OUTPUT ||
398 (parent->parent && parent->parent->type == CT_OUTPUT)))
403 DLOG("Result: %p\n", parent);
408 * helper data structure for the breadth-first-search in
409 * con_get_fullscreen_con()
415 TAILQ_ENTRY(bfs_entry)
420 * Returns the first fullscreen node below this node.
423 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode) {
424 Con *current, *child;
426 /* TODO: is breadth-first-search really appropriate? (check as soon as
427 * fullscreen levels and fullscreen for containers is implemented) */
428 TAILQ_HEAD(bfs_head, bfs_entry)
429 bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
431 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
433 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
435 while (!TAILQ_EMPTY(&bfs_head)) {
436 entry = TAILQ_FIRST(&bfs_head);
437 current = entry->con;
438 if (current != con && current->fullscreen_mode == fullscreen_mode) {
439 /* empty the queue */
440 while (!TAILQ_EMPTY(&bfs_head)) {
441 entry = TAILQ_FIRST(&bfs_head);
442 TAILQ_REMOVE(&bfs_head, entry, entries);
448 TAILQ_REMOVE(&bfs_head, entry, entries);
451 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
452 entry = smalloc(sizeof(struct bfs_entry));
454 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
457 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
458 entry = smalloc(sizeof(struct bfs_entry));
460 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
468 * Returns true if the container is internal, such as __i3_scratch
471 bool con_is_internal(Con *con) {
472 return (con->name[0] == '_' && con->name[1] == '_');
476 * Returns true if the node is floating.
479 bool con_is_floating(Con *con) {
481 DLOG("checking if con %p is floating\n", con);
482 return (con->floating >= FLOATING_AUTO_ON);
486 * Returns true if the container is a docked container.
489 bool con_is_docked(Con *con) {
490 if (con->parent == NULL)
493 if (con->parent->type == CT_DOCKAREA)
496 return con_is_docked(con->parent);
500 * Checks if the given container is either floating or inside some floating
501 * container. It returns the FLOATING_CON container.
504 Con *con_inside_floating(Con *con) {
506 if (con->type == CT_FLOATING_CON)
509 if (con->floating >= FLOATING_AUTO_ON)
512 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
515 return con_inside_floating(con->parent);
519 * Checks if the given container is inside a focused container.
522 bool con_inside_focused(Con *con) {
527 return con_inside_focused(con->parent);
531 * Checks if the container has the given parent as an actual parent.
534 bool con_has_parent(Con *con, Con *parent) {
535 Con *current = con->parent;
536 if (current == NULL) {
540 if (current == parent) {
544 return con_has_parent(current, parent);
548 * Returns the container with the given client window ID or NULL if no such
552 Con *con_by_window_id(xcb_window_t window) {
554 TAILQ_FOREACH(con, &all_cons, all_cons)
555 if (con->window != NULL && con->window->id == window)
561 * Returns the container with the given frame ID or NULL if no such container
565 Con *con_by_frame_id(xcb_window_t frame) {
567 TAILQ_FOREACH(con, &all_cons, all_cons)
568 if (con->frame.id == frame)
574 * Returns the container with the given mark or NULL if no such container
578 Con *con_by_mark(const char *mark) {
580 TAILQ_FOREACH(con, &all_cons, all_cons) {
581 if (con_has_mark(con, mark))
589 * Returns true if and only if the given containers holds the mark.
592 bool con_has_mark(Con *con, const char *mark) {
594 TAILQ_FOREACH(current, &(con->marks_head), marks) {
595 if (strcmp(current->name, mark) == 0)
603 * Toggles the mark on a container.
604 * If the container already has this mark, the mark is removed.
605 * Otherwise, the mark is assigned to the container.
608 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode) {
610 DLOG("Toggling mark \"%s\" on con = %p.\n", mark, con);
612 if (con_has_mark(con, mark)) {
613 con_unmark(con, mark);
615 con_mark(con, mark, mode);
620 * Assigns a mark to the container.
623 void con_mark(Con *con, const char *mark, mark_mode_t mode) {
625 DLOG("Setting mark \"%s\" on con = %p.\n", mark, con);
627 con_unmark(NULL, mark);
628 if (mode == MM_REPLACE) {
629 DLOG("Removing all existing marks on con = %p.\n", con);
632 while (!TAILQ_EMPTY(&(con->marks_head))) {
633 current = TAILQ_FIRST(&(con->marks_head));
634 con_unmark(con, current->name);
638 mark_t *new = scalloc(1, sizeof(mark_t));
639 new->name = sstrdup(mark);
640 TAILQ_INSERT_TAIL(&(con->marks_head), new, marks);
641 ipc_send_window_event("mark", con);
643 con->mark_changed = true;
647 * Removes marks from containers.
648 * If con is NULL, all containers are considered.
649 * If name is NULL, this removes all existing marks.
650 * Otherwise, it will only remove the given mark (if it is present).
653 void con_unmark(Con *con, const char *name) {
656 DLOG("Unmarking all containers.\n");
657 TAILQ_FOREACH(current, &all_cons, all_cons) {
658 if (con != NULL && current != con)
661 if (TAILQ_EMPTY(&(current->marks_head)))
665 while (!TAILQ_EMPTY(&(current->marks_head))) {
666 mark = TAILQ_FIRST(&(current->marks_head));
668 TAILQ_REMOVE(&(current->marks_head), mark, marks);
671 ipc_send_window_event("mark", current);
674 current->mark_changed = true;
677 DLOG("Removing mark \"%s\".\n", name);
678 current = (con == NULL) ? con_by_mark(name) : con;
679 if (current == NULL) {
680 DLOG("No container found with this mark, so there is nothing to do.\n");
684 DLOG("Found mark on con = %p. Removing it now.\n", current);
685 current->mark_changed = true;
688 TAILQ_FOREACH(mark, &(current->marks_head), marks) {
689 if (strcmp(mark->name, name) != 0)
693 TAILQ_REMOVE(&(current->marks_head), mark, marks);
696 ipc_send_window_event("mark", current);
703 * Returns the first container below 'con' which wants to swallow this window
707 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
710 //DLOG("searching con for window %p starting at con %p\n", window, con);
711 //DLOG("class == %s\n", window->class_class);
713 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
714 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
715 if (!match_matches_window(match, window))
717 if (store_match != NULL)
718 *store_match = match;
721 Con *result = con_for_window(child, window, store_match);
726 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
727 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
728 if (!match_matches_window(match, window))
730 if (store_match != NULL)
731 *store_match = match;
734 Con *result = con_for_window(child, window, store_match);
743 * Returns the number of children of this container.
746 int con_num_children(Con *con) {
750 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
757 * Returns the number of visible non-floating children of this container.
758 * For example, if the container contains a hsplit which has two children,
759 * this will return 2 instead of 1.
761 int con_num_visible_children(Con *con) {
767 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
768 /* Visible leaf nodes are a child. */
769 if (!con_is_hidden(current) && con_is_leaf(current))
771 /* All other containers need to be recursed. */
773 children += con_num_visible_children(current);
780 * Count the number of windows (i.e., leaf containers).
783 int con_num_windows(Con *con) {
787 if (con_has_managed_window(con))
792 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
793 num += con_num_windows(current);
800 * Updates the percent attribute of the children of the given container. This
801 * function needs to be called when a window is added or removed from a
805 void con_fix_percent(Con *con) {
807 int children = con_num_children(con);
809 // calculate how much we have distributed and how many containers
810 // with a percentage set we have
812 int children_with_percent = 0;
813 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
814 if (child->percent > 0.0) {
815 total += child->percent;
816 ++children_with_percent;
820 // if there were children without a percentage set, set to a value that
821 // will make those children proportional to all others
822 if (children_with_percent != children) {
823 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
824 if (child->percent <= 0.0) {
825 if (children_with_percent == 0) {
826 total += (child->percent = 1.0);
828 total += (child->percent = total / children_with_percent);
834 // if we got a zero, just distribute the space equally, otherwise
835 // distribute according to the proportions we got
837 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
838 child->percent = 1.0 / children;
840 } else if (total != 1.0) {
841 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
842 child->percent /= total;
848 * Toggles fullscreen mode for the given container. If there already is a
849 * fullscreen container on this workspace, fullscreen will be disabled and then
850 * enabled for the container the user wants to have in fullscreen mode.
853 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
854 if (con->type == CT_WORKSPACE) {
855 DLOG("You cannot make a workspace fullscreen.\n");
859 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
861 if (con->fullscreen_mode == CF_NONE)
862 con_enable_fullscreen(con, fullscreen_mode);
864 con_disable_fullscreen(con);
868 * Sets the specified fullscreen mode for the given container, sends the
869 * “fullscreen_mode” event and changes the XCB fullscreen property of the
870 * container’s window, if any.
873 static void con_set_fullscreen_mode(Con *con, fullscreen_mode_t fullscreen_mode) {
874 con->fullscreen_mode = fullscreen_mode;
876 DLOG("mode now: %d\n", con->fullscreen_mode);
878 /* Send an ipc window "fullscreen_mode" event */
879 ipc_send_window_event("fullscreen_mode", con);
881 /* update _NET_WM_STATE if this container has a window */
882 /* TODO: when a window is assigned to a container which is already
883 * fullscreened, this state needs to be pushed to the client, too */
884 if (con->window == NULL)
887 if (con->fullscreen_mode != CF_NONE) {
888 DLOG("Setting _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
889 xcb_add_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
891 DLOG("Removing _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
892 xcb_remove_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
897 * Enables fullscreen mode for the given container, if necessary.
899 * If the container’s mode is already CF_OUTPUT or CF_GLOBAL, the container is
900 * kept fullscreen but its mode is set to CF_GLOBAL and CF_OUTPUT,
903 * Other fullscreen containers will be disabled first, if they hide the new
907 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode) {
908 if (con->type == CT_WORKSPACE) {
909 DLOG("You cannot make a workspace fullscreen.\n");
913 assert(fullscreen_mode == CF_GLOBAL || fullscreen_mode == CF_OUTPUT);
915 if (fullscreen_mode == CF_GLOBAL)
916 DLOG("enabling global fullscreen for %p / %s\n", con, con->name);
918 DLOG("enabling fullscreen for %p / %s\n", con, con->name);
920 if (con->fullscreen_mode == fullscreen_mode) {
921 DLOG("fullscreen already enabled for %p / %s\n", con, con->name);
925 Con *con_ws = con_get_workspace(con);
927 /* Disable any fullscreen container that would conflict the new one. */
928 Con *fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
929 if (fullscreen == NULL)
930 fullscreen = con_get_fullscreen_con(con_ws, CF_OUTPUT);
931 if (fullscreen != NULL)
932 con_disable_fullscreen(fullscreen);
934 /* Set focus to new fullscreen container. Unless in global fullscreen mode
935 * and on another workspace restore focus afterwards.
936 * Switch to the container’s workspace if mode is global. */
937 Con *cur_ws = con_get_workspace(focused);
938 Con *old_focused = focused;
939 if (fullscreen_mode == CF_GLOBAL && cur_ws != con_ws)
940 workspace_show(con_ws);
942 if (fullscreen_mode != CF_GLOBAL && cur_ws != con_ws)
943 con_focus(old_focused);
945 con_set_fullscreen_mode(con, fullscreen_mode);
949 * Disables fullscreen mode for the given container regardless of the mode, if
953 void con_disable_fullscreen(Con *con) {
954 if (con->type == CT_WORKSPACE) {
955 DLOG("You cannot make a workspace fullscreen.\n");
959 DLOG("disabling fullscreen for %p / %s\n", con, con->name);
961 if (con->fullscreen_mode == CF_NONE) {
962 DLOG("fullscreen already disabled for %p / %s\n", con, con->name);
966 con_set_fullscreen_mode(con, CF_NONE);
969 static bool _con_move_to_con(Con *con, Con *target, bool behind_focused, bool fix_coordinates, bool dont_warp, bool ignore_focus, bool fix_percentage) {
970 Con *orig_target = target;
972 /* Prevent moving if this would violate the fullscreen focus restrictions. */
973 Con *target_ws = con_get_workspace(target);
974 if (!con_fullscreen_permits_focusing(target_ws)) {
975 LOG("Cannot move out of a fullscreen container.\n");
979 if (con_is_floating(con)) {
980 DLOG("Container is floating, using parent instead.\n");
984 Con *source_ws = con_get_workspace(con);
986 if (con->type == CT_WORKSPACE) {
987 /* Re-parent all of the old workspace's floating windows. */
989 while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
990 child = TAILQ_FIRST(&(source_ws->floating_head));
991 con_move_to_workspace(child, target_ws, true, true, false);
994 /* If there are no non-floating children, ignore the workspace. */
995 if (con_is_leaf(con))
998 con = workspace_encapsulate(con);
1000 ELOG("Workspace failed to move its contents into a container!\n");
1005 /* Save the urgency state so that we can restore it. */
1006 bool urgent = con->urgent;
1008 /* Save the current workspace. So we can call workspace_show() by the end
1009 * of this function. */
1010 Con *current_ws = con_get_workspace(focused);
1012 Con *source_output = con_get_output(con),
1013 *dest_output = con_get_output(target_ws);
1015 /* 1: save the container which is going to be focused after the current
1016 * container is moved away */
1017 Con *focus_next = con_next_focused(con);
1019 /* 2: we go up one level, but only when target is a normal container */
1020 if (target->type != CT_WORKSPACE) {
1021 DLOG("target originally = %p / %s / type %d\n", target, target->name, target->type);
1022 target = target->parent;
1025 /* 3: if the target container is floating, we get the workspace instead.
1026 * Only tiling windows need to get inserted next to the current container.
1028 Con *floatingcon = con_inside_floating(target);
1029 if (floatingcon != NULL) {
1030 DLOG("floatingcon, going up even further\n");
1031 target = floatingcon->parent;
1034 if (con->type == CT_FLOATING_CON) {
1035 Con *ws = con_get_workspace(target);
1036 DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
1040 if (source_output != dest_output) {
1041 /* Take the relative coordinates of the current output, then add them
1042 * to the coordinate space of the correct output */
1043 if (fix_coordinates && con->type == CT_FLOATING_CON) {
1044 floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
1046 DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
1048 /* If moving to a visible workspace, call show so it can be considered
1049 * focused. Must do before attaching because workspace_show checks to see
1050 * if focused container is in its area. */
1051 if (!ignore_focus && workspace_is_visible(target_ws)) {
1052 workspace_show(target_ws);
1054 /* Don’t warp if told so (when dragging floating windows with the
1055 * mouse for example) */
1057 x_set_warp_to(NULL);
1059 x_set_warp_to(&(con->rect));
1063 /* If moving a fullscreen container and the destination already has a
1064 * fullscreen window on it, un-fullscreen the target's fullscreen con. */
1065 Con *fullscreen = con_get_fullscreen_con(target_ws, CF_OUTPUT);
1066 if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
1067 con_toggle_fullscreen(fullscreen, CF_OUTPUT);
1071 DLOG("Re-attaching container to %p / %s\n", target, target->name);
1072 /* 4: re-attach the con to the parent of this focused container */
1073 Con *parent = con->parent;
1075 _con_attach(con, target, behind_focused ? NULL : orig_target, !behind_focused);
1077 /* 5: fix the percentages */
1078 if (fix_percentage) {
1079 con_fix_percent(parent);
1081 con_fix_percent(target);
1084 /* 6: focus the con on the target workspace, but only within that
1085 * workspace, that is, don’t move focus away if the target workspace is
1087 * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
1088 * we don’t focus when there is a fullscreen con on that workspace. We
1089 * also don't do it if the caller requested to ignore focus. */
1090 if (!ignore_focus && !con_is_internal(target_ws) && !fullscreen) {
1091 /* We need to save the focused workspace on the output in case the
1092 * new workspace is hidden and it's necessary to immediately switch
1093 * back to the originally-focused workspace. */
1094 Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
1095 con_focus(con_descend_focused(con));
1097 /* Restore focus if the output's focused workspace has changed. */
1098 if (con_get_workspace(focused) != old_focus)
1099 con_focus(old_focus);
1102 /* 7: when moving to another workspace, we leave the focus on the current
1103 * workspace. (see also #809) */
1105 /* Descend focus stack in case focus_next is a workspace which can
1106 * occur if we move to the same workspace. Also show current workspace
1107 * to ensure it is focused. */
1108 if (!ignore_focus) {
1109 workspace_show(current_ws);
1111 DLOG("x_set_warp_to(NULL) because dont_warp is set\n");
1112 x_set_warp_to(NULL);
1116 /* Set focus only if con was on current workspace before moving.
1117 * Otherwise we would give focus to some window on different workspace. */
1118 if (!ignore_focus && source_ws == current_ws)
1119 con_focus(con_descend_focused(focus_next));
1121 /* 8. If anything within the container is associated with a startup sequence,
1122 * delete it so child windows won't be created on the old workspace. */
1123 struct Startup_Sequence *sequence;
1124 xcb_get_property_cookie_t cookie;
1125 xcb_get_property_reply_t *startup_id_reply;
1127 if (!con_is_leaf(con)) {
1129 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1133 cookie = xcb_get_property(conn, false, child->window->id,
1134 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1135 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1137 sequence = startup_sequence_get(child->window, startup_id_reply, true);
1138 if (sequence != NULL)
1139 startup_sequence_delete(sequence);
1144 cookie = xcb_get_property(conn, false, con->window->id,
1145 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1146 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1148 sequence = startup_sequence_get(con->window, startup_id_reply, true);
1149 if (sequence != NULL)
1150 startup_sequence_delete(sequence);
1153 /* 9. If the container was marked urgent, move the urgency hint. */
1155 workspace_update_urgent_flag(source_ws);
1156 con_set_urgency(con, true);
1159 /* Ensure the container will be redrawn. */
1160 FREE(con->deco_render_params);
1162 CALL(parent, on_remove_child);
1164 ipc_send_window_event("move", con);
1165 ewmh_update_wm_desktop();
1170 * Moves the given container to the given mark.
1173 bool con_move_to_mark(Con *con, const char *mark) {
1174 Con *target = con_by_mark(mark);
1175 if (target == NULL) {
1176 DLOG("found no container with mark \"%s\"\n", mark);
1180 /* For floating target containers, we just send the window to the same workspace. */
1181 if (con_is_floating(target)) {
1182 DLOG("target container is floating, moving container to target's workspace.\n");
1183 con_move_to_workspace(con, con_get_workspace(target), true, false, false);
1187 if (con->type == CT_WORKSPACE) {
1188 DLOG("target container is a workspace, simply moving the container there.\n");
1189 con_move_to_workspace(con, target, true, false, false);
1193 /* For split containers, we use the currently focused container within it.
1194 * This allows setting marks on, e.g., tabbed containers which will move
1195 * con to a new tab behind the focused tab. */
1196 if (con_is_split(target)) {
1197 DLOG("target is a split container, descending to the currently focused child.\n");
1198 target = TAILQ_FIRST(&(target->focus_head));
1201 if (con == target || con_has_parent(target, con)) {
1202 DLOG("cannot move the container to or inside itself, aborting.\n");
1206 return _con_move_to_con(con, target, false, true, false, false, true);
1210 * Moves the given container to the currently focused container on the given
1213 * The fix_coordinates flag will translate the current coordinates (offset from
1214 * the monitor position basically) to appropriate coordinates on the
1215 * destination workspace.
1216 * Not enabling this behaviour comes in handy when this function gets called by
1217 * floating_maybe_reassign_ws, which will only "move" a floating window when it
1218 * *already* changed its coordinates to a different output.
1220 * The dont_warp flag disables pointer warping and will be set when this
1221 * function is called while dragging a floating window.
1223 * If ignore_focus is set, the container will be moved without modifying focus
1226 * TODO: is there a better place for this function?
1229 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp, bool ignore_focus) {
1230 assert(workspace->type == CT_WORKSPACE);
1232 Con *source_ws = con_get_workspace(con);
1233 if (workspace == source_ws) {
1234 DLOG("Not moving, already there\n");
1238 Con *target = con_descend_focused(workspace);
1239 _con_move_to_con(con, target, true, fix_coordinates, dont_warp, ignore_focus, true);
1243 * Moves the given container to the currently focused container on the
1244 * visible workspace on the given output.
1247 void con_move_to_output(Con *con, Output *output) {
1249 GREP_FIRST(ws, output_get_content(output->con), workspace_is_visible(child));
1251 DLOG("Moving con %p to output %s\n", con, output->name);
1252 con_move_to_workspace(con, ws, false, false, false);
1256 * Returns the orientation of the given container (for stacked containers,
1257 * vertical orientation is used regardless of the actual orientation of the
1261 orientation_t con_orientation(Con *con) {
1262 switch (con->layout) {
1264 /* stacking containers behave like they are in vertical orientation */
1269 /* tabbed containers behave like they are in vertical orientation */
1274 DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
1280 DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
1285 DLOG("con_orientation() ran into default\n");
1291 * Returns the container which will be focused next when the given container
1292 * is not available anymore. Called in tree_close_internal and con_move_to_workspace
1293 * to properly restore focus.
1296 Con *con_next_focused(Con *con) {
1298 /* floating containers are attached to a workspace, so we focus either the
1299 * next floating container (if any) or the workspace itself. */
1300 if (con->type == CT_FLOATING_CON) {
1301 DLOG("selecting next for CT_FLOATING_CON\n");
1302 next = TAILQ_NEXT(con, floating_windows);
1303 DLOG("next = %p\n", next);
1305 next = TAILQ_PREV(con, floating_head, floating_windows);
1306 DLOG("using prev, next = %p\n", next);
1309 Con *ws = con_get_workspace(con);
1311 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
1312 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
1313 next = TAILQ_FIRST(&(next->focus_head));
1315 DLOG("skipping container itself, we want the next client\n");
1316 next = TAILQ_NEXT(next, focused);
1319 if (next == TAILQ_END(&(ws->focus_head))) {
1320 DLOG("Focus list empty, returning ws\n");
1324 /* Instead of returning the next CT_FLOATING_CON, we descend it to
1325 * get an actual window to focus. */
1326 next = con_descend_focused(next);
1331 /* dock clients cannot be focused, so we focus the workspace instead */
1332 if (con->parent->type == CT_DOCKAREA) {
1333 DLOG("selecting workspace for dock client\n");
1334 return con_descend_focused(output_get_content(con->parent->parent));
1337 /* if 'con' is not the first entry in the focus stack, use the first one as
1338 * it’s currently focused already */
1339 Con *first = TAILQ_FIRST(&(con->parent->focus_head));
1341 DLOG("Using first entry %p\n", first);
1344 /* try to focus the next container on the same level as this one or fall
1345 * back to its parent */
1346 if (!(next = TAILQ_NEXT(con, focused))) {
1351 /* now go down the focus stack as far as
1352 * possible, excluding the current container */
1353 while (!TAILQ_EMPTY(&(next->focus_head)) && TAILQ_FIRST(&(next->focus_head)) != con) {
1354 next = TAILQ_FIRST(&(next->focus_head));
1361 * Get the next/previous container in the specified orientation. This may
1362 * travel up until it finds a container with suitable orientation.
1365 Con *con_get_next(Con *con, char way, orientation_t orientation) {
1366 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
1367 /* 1: get the first parent with the same orientation */
1369 while (con_orientation(cur->parent) != orientation) {
1370 DLOG("need to go one level further up\n");
1371 if (cur->parent->type == CT_WORKSPACE) {
1372 LOG("that's a workspace, we can't go further up\n");
1378 /* 2: chose next (or previous) */
1381 next = TAILQ_NEXT(cur, nodes);
1382 /* if we are at the end of the list, we need to wrap */
1383 if (next == TAILQ_END(&(parent->nodes_head)))
1386 next = TAILQ_PREV(cur, nodes_head, nodes);
1387 /* if we are at the end of the list, we need to wrap */
1388 if (next == TAILQ_END(&(cur->nodes_head)))
1391 DLOG("next = %p\n", next);
1397 * Returns the focused con inside this client, descending the tree as far as
1398 * possible. This comes in handy when attaching a con to a workspace at the
1399 * currently focused position, for example.
1402 Con *con_descend_focused(Con *con) {
1404 while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
1405 next = TAILQ_FIRST(&(next->focus_head));
1410 * Returns the focused con inside this client, descending the tree as far as
1411 * possible. This comes in handy when attaching a con to a workspace at the
1412 * currently focused position, for example.
1414 * Works like con_descend_focused but considers only tiling cons.
1417 Con *con_descend_tiling_focused(Con *con) {
1421 if (next == focused)
1425 TAILQ_FOREACH(child, &(next->focus_head), focused) {
1426 if (child->type == CT_FLOATING_CON)
1432 } while (before != next && next != focused);
1437 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1438 * direction is D_LEFT, then we return the rightmost container and if direction
1439 * is D_RIGHT, we return the leftmost container. This is because if we are
1440 * moving D_LEFT, and thus want the rightmost container.
1443 Con *con_descend_direction(Con *con, direction_t direction) {
1446 int orientation = con_orientation(con);
1447 DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1448 if (direction == D_LEFT || direction == D_RIGHT) {
1449 if (orientation == HORIZ) {
1450 /* If the direction is horizontal, we can use either the first
1451 * (D_RIGHT) or the last con (D_LEFT) */
1452 if (direction == D_RIGHT)
1453 most = TAILQ_FIRST(&(con->nodes_head));
1455 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1456 } else if (orientation == VERT) {
1457 /* Wrong orientation. We use the last focused con. Within that con,
1458 * we recurse to chose the left/right con or at least the last
1460 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1461 if (current->type != CT_FLOATING_CON) {
1467 /* If the con has no orientation set, it’s not a split container
1468 * but a container with a client window, so stop recursing */
1473 if (direction == D_UP || direction == D_DOWN) {
1474 if (orientation == VERT) {
1475 /* If the direction is vertical, we can use either the first
1476 * (D_DOWN) or the last con (D_UP) */
1477 if (direction == D_UP)
1478 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1480 most = TAILQ_FIRST(&(con->nodes_head));
1481 } else if (orientation == HORIZ) {
1482 /* Wrong orientation. We use the last focused con. Within that con,
1483 * we recurse to chose the top/bottom con or at least the last
1485 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1486 if (current->type != CT_FLOATING_CON) {
1492 /* If the con has no orientation set, it’s not a split container
1493 * but a container with a client window, so stop recursing */
1500 return con_descend_direction(most, direction);
1504 * Returns a "relative" Rect which contains the amount of pixels that need to
1505 * be added to the original Rect to get the final position (obviously the
1506 * amount of pixels for normal, 1pixel and borderless are different).
1509 Rect con_border_style_rect(Con *con) {
1510 if (config.hide_edge_borders == HEBM_SMART && con_num_visible_children(con_get_workspace(con)) <= 1) {
1511 if (!con_is_floating(con)) {
1512 return (Rect){0, 0, 0, 0};
1516 adjacent_t borders_to_hide = ADJ_NONE;
1517 int border_width = con->current_border_width;
1518 DLOG("The border width for con is set to: %d\n", con->current_border_width);
1520 if (con->current_border_width < 0) {
1521 if (con_is_floating(con)) {
1522 border_width = config.default_floating_border_width;
1524 border_width = config.default_border_width;
1527 DLOG("Effective border width is set to: %d\n", border_width);
1528 /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1529 int border_style = con_border_style(con);
1530 if (border_style == BS_NONE)
1531 return (Rect){0, 0, 0, 0};
1532 if (border_style == BS_NORMAL) {
1533 result = (Rect){border_width, 0, -(2 * border_width), -(border_width)};
1535 result = (Rect){border_width, border_width, -(2 * border_width), -(2 * border_width)};
1538 borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1539 if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1540 result.x -= border_width;
1541 result.width += border_width;
1543 if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1544 result.width += border_width;
1546 if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1547 result.y -= border_width;
1548 result.height += border_width;
1550 if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1551 result.height += border_width;
1557 * Returns adjacent borders of the window. We need this if hide_edge_borders is
1560 adjacent_t con_adjacent_borders(Con *con) {
1561 adjacent_t result = ADJ_NONE;
1562 /* Floating windows are never adjacent to any other window, so
1563 don’t hide their border(s). This prevents bug #998. */
1564 if (con_is_floating(con))
1567 Con *workspace = con_get_workspace(con);
1568 if (con->rect.x == workspace->rect.x)
1569 result |= ADJ_LEFT_SCREEN_EDGE;
1570 if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1571 result |= ADJ_RIGHT_SCREEN_EDGE;
1572 if (con->rect.y == workspace->rect.y)
1573 result |= ADJ_UPPER_SCREEN_EDGE;
1574 if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1575 result |= ADJ_LOWER_SCREEN_EDGE;
1580 * Use this function to get a container’s border style. This is important
1581 * because when inside a stack, the border style is always BS_NORMAL.
1582 * For tabbed mode, the same applies, with one exception: when the container is
1583 * borderless and the only element in the tabbed container, the border is not
1586 * For children of a CT_DOCKAREA, the border style is always none.
1589 int con_border_style(Con *con) {
1590 Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1592 DLOG("this one is fullscreen! overriding BS_NONE\n");
1596 if (con->parent->layout == L_STACKED)
1597 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1599 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1600 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1602 if (con->parent->type == CT_DOCKAREA)
1605 return con->border_style;
1609 * Sets the given border style on con, correctly keeping the position/size of a
1613 void con_set_border_style(Con *con, int border_style, int border_width) {
1614 /* Handle the simple case: non-floating containerns */
1615 if (!con_is_floating(con)) {
1616 con->border_style = border_style;
1617 con->current_border_width = border_width;
1621 /* For floating containers, we want to keep the position/size of the
1622 * *window* itself. We first add the border pixels to con->rect to make
1623 * con->rect represent the absolute position of the window (same for
1624 * parent). Then, we change the border style and subtract the new border
1625 * pixels. For the parent, we do the same also for the decoration. */
1626 DLOG("This is a floating container\n");
1628 Con *parent = con->parent;
1629 Rect bsr = con_border_style_rect(con);
1630 int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1632 con->rect = rect_add(con->rect, bsr);
1633 parent->rect = rect_add(parent->rect, bsr);
1634 parent->rect.y += deco_height;
1635 parent->rect.height -= deco_height;
1637 /* Change the border style, get new border/decoration values. */
1638 con->border_style = border_style;
1639 con->current_border_width = border_width;
1640 bsr = con_border_style_rect(con);
1641 deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1643 con->rect = rect_sub(con->rect, bsr);
1644 parent->rect = rect_sub(parent->rect, bsr);
1645 parent->rect.y -= deco_height;
1646 parent->rect.height += deco_height;
1650 * This function changes the layout of a given container. Use it to handle
1651 * special cases like changing a whole workspace to stacked/tabbed (creates a
1652 * new split container before).
1655 void con_set_layout(Con *con, layout_t layout) {
1656 DLOG("con_set_layout(%p, %d), con->type = %d\n",
1657 con, layout, con->type);
1659 /* Users can focus workspaces, but not any higher in the hierarchy.
1660 * Focus on the workspace is a special case, since in every other case, the
1661 * user means "change the layout of the parent split container". */
1662 if (con->type != CT_WORKSPACE)
1665 /* We fill in last_split_layout when switching to a different layout
1666 * since there are many places in the code that don’t use
1667 * con_set_layout(). */
1668 if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1669 con->last_split_layout = con->layout;
1671 /* When the container type is CT_WORKSPACE, the user wants to change the
1672 * whole workspace into stacked/tabbed mode. To do this and still allow
1673 * intuitive operations (like level-up and then opening a new window), we
1674 * need to create a new split container. */
1675 if (con->type == CT_WORKSPACE) {
1676 if (con_num_children(con) == 0) {
1677 layout_t ws_layout = (layout == L_STACKED || layout == L_TABBED) ? layout : L_DEFAULT;
1678 DLOG("Setting workspace_layout to %d\n", ws_layout);
1679 con->workspace_layout = ws_layout;
1680 DLOG("Setting layout to %d\n", layout);
1681 con->layout = layout;
1682 } else if (layout == L_STACKED || layout == L_TABBED) {
1683 DLOG("Creating new split container\n");
1684 /* 1: create a new split container */
1685 Con *new = con_new(NULL, NULL);
1688 /* 2: Set the requested layout on the split container and mark it as
1690 new->layout = layout;
1691 new->last_split_layout = con->last_split_layout;
1693 /* Save the container that was focused before we move containers
1694 * around, but only if the container is visible (otherwise focus
1695 * will be restored properly automatically when switching). */
1696 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1697 if (old_focused == TAILQ_END(&(con->focus_head)))
1699 if (old_focused != NULL &&
1700 !workspace_is_visible(con_get_workspace(old_focused)))
1703 /* 3: move the existing cons of this workspace below the new con */
1704 DLOG("Moving cons\n");
1706 while (!TAILQ_EMPTY(&(con->nodes_head))) {
1707 child = TAILQ_FIRST(&(con->nodes_head));
1709 con_attach(child, new, true);
1712 /* 4: attach the new split container to the workspace */
1713 DLOG("Attaching new split to ws\n");
1714 con_attach(new, con, false);
1717 con_focus(old_focused);
1719 tree_flatten(croot);
1721 con_force_split_parents_redraw(con);
1725 if (layout == L_DEFAULT) {
1726 /* Special case: the layout formerly known as "default" (in combination
1727 * with an orientation). Since we switched to splith/splitv layouts,
1728 * using the "default" layout (which "only" should happen when using
1729 * legacy configs) is using the last split layout (either splith or
1730 * splitv) in order to still do the same thing. */
1731 con->layout = con->last_split_layout;
1732 /* In case last_split_layout was not initialized… */
1733 if (con->layout == L_DEFAULT)
1734 con->layout = L_SPLITH;
1736 con->layout = layout;
1738 con_force_split_parents_redraw(con);
1742 * This function toggles the layout of a given container. toggle_mode can be
1743 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1744 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1748 void con_toggle_layout(Con *con, const char *toggle_mode) {
1750 /* Users can focus workspaces, but not any higher in the hierarchy.
1751 * Focus on the workspace is a special case, since in every other case, the
1752 * user means "change the layout of the parent split container". */
1753 if (con->type != CT_WORKSPACE)
1754 parent = con->parent;
1755 DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1757 const char delim[] = " ";
1759 if (strcasecmp(toggle_mode, "split") == 0 || strstr(toggle_mode, delim)) {
1760 /* L_DEFAULT is used as a placeholder value to distinguish if
1761 * the first layout has already been saved. (it can never be L_DEFAULT) */
1762 layout_t new_layout = L_DEFAULT;
1763 bool current_layout_found = false;
1764 char *tm_dup = sstrdup(toggle_mode);
1765 char *cur_tok = strtok(tm_dup, delim);
1767 for (layout_t layout; cur_tok != NULL; cur_tok = strtok(NULL, delim)) {
1768 if (strcasecmp(cur_tok, "split") == 0) {
1769 /* Toggle between splits. When the current layout is not a split
1770 * layout, we just switch back to last_split_layout. Otherwise, we
1771 * change to the opposite split layout. */
1772 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV) {
1773 layout = parent->last_split_layout;
1775 layout = (parent->layout == L_SPLITH) ? L_SPLITV : L_SPLITH;
1778 bool success = layout_from_name(cur_tok, &layout);
1779 if (!success || layout == L_DEFAULT) {
1780 ELOG("The token '%s' was not recognized and has been skipped.\n", cur_tok);
1785 /* If none of the specified layouts match the current,
1786 * fall back to the first layout in the list */
1787 if (new_layout == L_DEFAULT) {
1788 new_layout = layout;
1791 /* We found the active layout in the last iteration, so
1792 * now let's activate the current layout (next in list) */
1793 if (current_layout_found) {
1794 new_layout = layout;
1799 if (parent->layout == layout) {
1800 current_layout_found = true;
1804 con_set_layout(con, new_layout);
1805 } else if (strcasecmp(toggle_mode, "all") == 0 || strcasecmp(toggle_mode, "default") == 0) {
1806 if (parent->layout == L_STACKED)
1807 con_set_layout(con, L_TABBED);
1808 else if (parent->layout == L_TABBED) {
1809 if (strcasecmp(toggle_mode, "all") == 0)
1810 con_set_layout(con, L_SPLITH);
1812 con_set_layout(con, parent->last_split_layout);
1813 } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1814 if (strcasecmp(toggle_mode, "all") == 0) {
1815 /* When toggling through all modes, we toggle between
1816 * splith/splitv, whereas normally we just directly jump to
1818 if (parent->layout == L_SPLITH)
1819 con_set_layout(con, L_SPLITV);
1821 con_set_layout(con, L_STACKED);
1823 con_set_layout(con, L_STACKED);
1830 * Callback which will be called when removing a child from the given con.
1831 * Kills the container if it is empty and replaces it with the child if there
1832 * is exactly one child.
1835 static void con_on_remove_child(Con *con) {
1836 DLOG("on_remove_child\n");
1838 /* Every container 'above' (in the hierarchy) the workspace content should
1839 * not be closed when the last child was removed */
1840 if (con->type == CT_OUTPUT ||
1841 con->type == CT_ROOT ||
1842 con->type == CT_DOCKAREA ||
1843 (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1844 DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1848 /* For workspaces, close them only if they're not visible anymore */
1849 if (con->type == CT_WORKSPACE) {
1850 if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1851 LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1852 yajl_gen gen = ipc_marshal_workspace_event("empty", con, NULL);
1853 tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1855 const unsigned char *payload;
1857 y(get_buf, &payload, &length);
1858 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1865 con_force_split_parents_redraw(con);
1866 con->urgent = con_has_urgent_child(con);
1867 con_update_parents_urgency(con);
1869 /* TODO: check if this container would swallow any other client and
1870 * don’t close it automatically. */
1871 int children = con_num_children(con);
1872 if (children == 0) {
1873 DLOG("Container empty, closing\n");
1874 tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1880 * Determines the minimum size of the given con by looking at its children (for
1881 * split/stacked/tabbed cons). Will be called when resizing floating cons
1884 Rect con_minimum_size(Con *con) {
1885 DLOG("Determining minimum size for con %p\n", con);
1887 if (con_is_leaf(con)) {
1888 DLOG("leaf node, returning 75x50\n");
1889 return (Rect){0, 0, 75, 50};
1892 if (con->type == CT_FLOATING_CON) {
1893 DLOG("floating con\n");
1894 Con *child = TAILQ_FIRST(&(con->nodes_head));
1895 return con_minimum_size(child);
1898 if (con->layout == L_STACKED || con->layout == L_TABBED) {
1899 uint32_t max_width = 0, max_height = 0, deco_height = 0;
1901 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1902 Rect min = con_minimum_size(child);
1903 deco_height += child->deco_rect.height;
1904 max_width = max(max_width, min.width);
1905 max_height = max(max_height, min.height);
1907 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1908 max_width, max_height, deco_height);
1909 return (Rect){0, 0, max_width, max_height + deco_height};
1912 /* For horizontal/vertical split containers we sum up the width (h-split)
1913 * or height (v-split) and use the maximum of the height (h-split) or width
1914 * (v-split) as minimum size. */
1915 if (con_is_split(con)) {
1916 uint32_t width = 0, height = 0;
1918 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1919 Rect min = con_minimum_size(child);
1920 if (con->layout == L_SPLITH) {
1922 height = max(height, min.height);
1924 height += min.height;
1925 width = max(width, min.width);
1928 DLOG("split container, returning width = %d x height = %d\n", width, height);
1929 return (Rect){0, 0, width, height};
1932 ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1933 con->type, con->layout, con_is_split(con));
1938 * Returns true if changing the focus to con would be allowed considering
1939 * the fullscreen focus constraints. Specifically, if a fullscreen container or
1940 * any of its descendants is focused, this function returns true if and only if
1941 * focusing con would mean that focus would still be visible on screen, i.e.,
1942 * the newly focused container would not be obscured by a fullscreen container.
1944 * In the simplest case, if a fullscreen container or any of its descendants is
1945 * fullscreen, this functions returns true if con is the fullscreen container
1946 * itself or any of its descendants, as this means focus wouldn't escape the
1947 * boundaries of the fullscreen container.
1949 * In case the fullscreen container is of type CF_OUTPUT, this function returns
1950 * true if con is on a different workspace, as focus wouldn't be obscured by
1951 * the fullscreen container that is constrained to a different workspace.
1953 * Note that this same logic can be applied to moving containers. If a
1954 * container can be focused under the fullscreen focus constraints, it can also
1955 * become a parent or sibling to the currently focused container.
1958 bool con_fullscreen_permits_focusing(Con *con) {
1959 /* No focus, no problem. */
1963 /* Find the first fullscreen ascendent. */
1965 while (fs && fs->fullscreen_mode == CF_NONE)
1968 /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1969 * there always has to be a workspace con in the hierarchy. */
1971 /* The most common case is we hit the workspace level. In this
1972 * situation, changing focus is also harmless. */
1973 assert(fs->fullscreen_mode != CF_NONE);
1974 if (fs->type == CT_WORKSPACE)
1977 /* Allow it if the container itself is the fullscreen container. */
1981 /* If fullscreen is per-output, the focus being in a different workspace is
1982 * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1983 if (fs->fullscreen_mode == CF_OUTPUT &&
1984 con_get_workspace(con) != con_get_workspace(fs)) {
1988 /* Allow it only if the container to be focused is contained within the
1989 * current fullscreen container. */
1991 if (con->parent == fs)
1996 /* Focusing con would hide it behind a fullscreen window, disallow it. */
2002 * Checks if the given container has an urgent child.
2005 bool con_has_urgent_child(Con *con) {
2008 if (con_is_leaf(con))
2011 /* We are not interested in floating windows since they can only be
2012 * attached to a workspace → nodes_head instead of focus_head */
2013 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2014 if (con_has_urgent_child(child))
2022 * Make all parent containers urgent if con is urgent or clear the urgent flag
2023 * of all parent containers if there are no more urgent children left.
2026 void con_update_parents_urgency(Con *con) {
2027 Con *parent = con->parent;
2029 /* Urgency hints should not be set on any container higher up in the
2030 * hierarchy than the workspace level. Unfortunately, since the content
2031 * container has type == CT_CON, that’s not easy to verify in the loop
2032 * below, so we need another condition to catch that case: */
2033 if (con->type == CT_WORKSPACE)
2036 bool new_urgency_value = con->urgent;
2037 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
2038 if (new_urgency_value) {
2039 parent->urgent = true;
2041 /* We can only reset the urgency when the parent
2042 * has no other urgent children */
2043 if (!con_has_urgent_child(parent))
2044 parent->urgent = false;
2046 parent = parent->parent;
2051 * Set urgency flag to the container, all the parent containers and the workspace.
2054 void con_set_urgency(Con *con, bool urgent) {
2055 if (urgent && focused == con) {
2056 DLOG("Ignoring urgency flag for current client\n");
2060 const bool old_urgent = con->urgent;
2062 if (con->urgency_timer == NULL) {
2063 con->urgent = urgent;
2065 DLOG("Discarding urgency WM_HINT because timer is running\n");
2070 gettimeofday(&con->window->urgent, NULL);
2072 con->window->urgent.tv_sec = 0;
2073 con->window->urgent.tv_usec = 0;
2077 con_update_parents_urgency(con);
2080 /* Set the urgency flag on the workspace, if a workspace could be found
2081 * (for dock clients, that is not the case). */
2082 if ((ws = con_get_workspace(con)) != NULL)
2083 workspace_update_urgent_flag(ws);
2085 if (con->urgent != old_urgent) {
2086 LOG("Urgency flag changed to %d\n", con->urgent);
2087 ipc_send_window_event("urgent", con);
2092 * Create a string representing the subtree under con.
2095 char *con_get_tree_representation(Con *con) {
2096 /* this code works as follows:
2097 * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
2098 * 2) append the tree representation of the children to the string
2099 * 3) add closing bracket
2101 * The recursion ends when we hit a leaf, in which case we return the
2102 * class_instance of the contained window.
2105 /* end of recursion */
2106 if (con_is_leaf(con)) {
2108 return sstrdup("nowin");
2110 if (!con->window->class_instance)
2111 return sstrdup("noinstance");
2113 return sstrdup(con->window->class_instance);
2117 /* 1) add the Layout type to buf */
2118 if (con->layout == L_DEFAULT)
2119 buf = sstrdup("D[");
2120 else if (con->layout == L_SPLITV)
2121 buf = sstrdup("V[");
2122 else if (con->layout == L_SPLITH)
2123 buf = sstrdup("H[");
2124 else if (con->layout == L_TABBED)
2125 buf = sstrdup("T[");
2126 else if (con->layout == L_STACKED)
2127 buf = sstrdup("S[");
2129 ELOG("BUG: Code not updated to account for new layout type\n");
2133 /* 2) append representation of children */
2135 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2136 char *child_txt = con_get_tree_representation(child);
2139 sasprintf(&tmp_buf, "%s%s%s", buf,
2140 (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
2146 /* 3) close the brackets */
2148 sasprintf(&complete_buf, "%s]", buf);
2151 return complete_buf;
2155 * Returns the container's title considering the current title format.
2158 i3String *con_parse_title_format(Con *con) {
2159 assert(con->title_format != NULL);
2161 i3Window *win = con->window;
2163 /* We need to ensure that we only escape the window title if pango
2164 * is used by the current font. */
2165 const bool pango_markup = font_is_pango();
2171 title = pango_escape_markup(con_get_tree_representation(con));
2172 class = sstrdup("i3-frame");
2173 instance = sstrdup("i3-frame");
2175 title = pango_escape_markup(sstrdup((win->name == NULL) ? "" : i3string_as_utf8(win->name)));
2176 class = pango_escape_markup(sstrdup((win->class_class == NULL) ? "" : win->class_class));
2177 instance = pango_escape_markup(sstrdup((win->class_instance == NULL) ? "" : win->class_instance));
2180 placeholder_t placeholders[] = {
2181 {.name = "%title", .value = title},
2182 {.name = "%class", .value = class},
2183 {.name = "%instance", .value = instance}};
2184 const size_t num = sizeof(placeholders) / sizeof(placeholder_t);
2186 char *formatted_str = format_placeholders(con->title_format, &placeholders[0], num);
2187 i3String *formatted = i3string_from_utf8(formatted_str);
2188 i3string_set_markup(formatted, pango_markup);
2189 FREE(formatted_str);
2191 for (size_t i = 0; i < num; i++) {
2192 FREE(placeholders[i].value);
2199 * Swaps the two containers.
2202 bool con_swap(Con *first, Con *second) {
2203 assert(first != NULL);
2204 assert(second != NULL);
2205 DLOG("Swapping containers %p / %p\n", first, second);
2207 if (first->type != CT_CON) {
2208 ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", first, first->type);
2212 if (second->type != CT_CON) {
2213 ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", second, second->type);
2217 if (con_is_floating(first) || con_is_floating(second)) {
2218 ELOG("Floating windows cannot be swapped.\n");
2222 if (first == second) {
2223 DLOG("Swapping container %p with itself, nothing to do.\n", first);
2227 if (con_has_parent(first, second) || con_has_parent(second, first)) {
2228 ELOG("Cannot swap containers %p and %p because they are in a parent-child relationship.\n", first, second);
2232 Con *old_focus = focused;
2234 Con *first_ws = con_get_workspace(first);
2235 Con *second_ws = con_get_workspace(second);
2236 Con *current_ws = con_get_workspace(old_focus);
2237 const bool focused_within_first = (first == old_focus || con_has_parent(old_focus, first));
2238 const bool focused_within_second = (second == old_focus || con_has_parent(old_focus, second));
2240 if (!con_fullscreen_permits_focusing(first_ws)) {
2241 DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", first_ws->name);
2245 if (!con_fullscreen_permits_focusing(second_ws)) {
2246 DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", second_ws->name);
2250 double first_percent = first->percent;
2251 double second_percent = second->percent;
2253 /* De- and reattaching the containers will insert them at the tail of the
2254 * focus_heads. We will need to fix this. But we need to make sure first
2255 * and second don't get in each other's way if they share the same parent,
2256 * so we select the closest previous focus_head that isn't involved. */
2257 Con *first_prev_focus_head = first;
2258 while (first_prev_focus_head == first || first_prev_focus_head == second) {
2259 first_prev_focus_head = TAILQ_PREV(first_prev_focus_head, focus_head, focused);
2262 Con *second_prev_focus_head = second;
2263 while (second_prev_focus_head == second || second_prev_focus_head == first) {
2264 second_prev_focus_head = TAILQ_PREV(second_prev_focus_head, focus_head, focused);
2267 /* We use a fake container to mark the spot of where the second container needs to go. */
2268 Con *fake = con_new(NULL, NULL);
2269 fake->layout = L_SPLITH;
2270 _con_attach(fake, first->parent, first, true);
2273 /* Swap the containers. We set the ignore_focus flag here because after the
2274 * container is attached, the focus order is not yet correct and would
2275 * result in wrong windows being focused. */
2277 /* Move first to second. */
2278 result &= _con_move_to_con(first, second, false, false, false, true, false);
2280 /* If we moved the container holding the focused window to another
2281 * workspace we need to ensure the visible workspace has the focused
2283 * We don't need to check this for the second container because we've only
2284 * moved the first one at this point.*/
2285 if (first_ws != second_ws && focused_within_first) {
2286 con_focus(con_descend_focused(current_ws));
2289 /* Move second to where first has been originally. */
2290 result &= _con_move_to_con(second, fake, false, false, false, true, false);
2292 /* If swapping the containers didn't work we don't need to mess with the focus. */
2297 /* Swapping will have inserted the containers at the tail of their parents'
2298 * focus head. We fix this now by putting them in the position of the focus
2299 * head the container they swapped with was in. */
2300 TAILQ_REMOVE(&(first->parent->focus_head), first, focused);
2301 TAILQ_REMOVE(&(second->parent->focus_head), second, focused);
2303 if (second_prev_focus_head == NULL) {
2304 TAILQ_INSERT_HEAD(&(first->parent->focus_head), first, focused);
2306 TAILQ_INSERT_AFTER(&(first->parent->focus_head), second_prev_focus_head, first, focused);
2309 if (first_prev_focus_head == NULL) {
2310 TAILQ_INSERT_HEAD(&(second->parent->focus_head), second, focused);
2312 TAILQ_INSERT_AFTER(&(second->parent->focus_head), first_prev_focus_head, second, focused);
2315 /* If the focus was within any of the swapped containers, do the following:
2316 * - If swapping took place within a workspace, ensure the previously
2317 * focused container stays focused.
2318 * - Otherwise, focus the container that has been swapped in.
2320 * To understand why fixing the focus_head previously wasn't enough,
2321 * consider the scenario
2322 * H[ V[ A X ] V[ Y B ] ]
2323 * with B being focused, but X being the focus_head within its parent. If
2324 * we swap A and B now, fixing the focus_head would focus X, but since B
2325 * was the focused container before it should stay focused.
2327 if (focused_within_first) {
2328 if (first_ws == second_ws) {
2329 con_focus(old_focus);
2331 con_focus(con_descend_focused(second));
2333 } else if (focused_within_second) {
2334 if (first_ws == second_ws) {
2335 con_focus(old_focus);
2337 con_focus(con_descend_focused(first));
2341 /* We need to copy each other's percentages to ensure that the geometry
2342 * doesn't change during the swap. This needs to happen _before_ we close
2343 * the fake container as closing the tree will recalculate percentages. */
2344 first->percent = second_percent;
2345 second->percent = first_percent;
2346 fake->percent = 0.0;
2349 /* We don't actually need this since percentages-wise we haven't changed
2350 * anything, but we'll better be safe than sorry and just make sure as we'd
2351 * otherwise crash i3. */
2352 con_fix_percent(first->parent);
2353 con_fix_percent(second->parent);
2355 /* We can get rid of the fake container again now. */
2356 con_close(fake, DONT_KILL_WINDOW);
2358 con_force_split_parents_redraw(first);
2359 con_force_split_parents_redraw(second);