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,
29 static void con_on_remove_child(Con *con);
32 * force parent split containers to be redrawn
35 static void con_force_split_parents_redraw(Con *con) {
38 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
39 if (!con_is_leaf(parent))
40 FREE(parent->deco_render_params);
41 parent = parent->parent;
46 * Create a new container (and attach it to the given parent, if not NULL).
47 * This function only initializes the data structures.
50 Con *con_new_skeleton(Con *parent, i3Window *window) {
51 Con *new = scalloc(sizeof(Con));
52 new->on_remove_child = con_on_remove_child;
53 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
54 new->aspect_ratio = 0.0;
57 new->border_style = config.default_border;
58 new->current_border_width = -1;
60 new->depth = window->depth;
62 new->depth = XCB_COPY_FROM_PARENT;
64 DLOG("opening window %d\n", cnt);
66 /* TODO: remove window coloring after test-phase */
67 DLOG("color %s\n", colors[cnt]);
68 new->name = strdup(colors[cnt]);
69 //uint32_t cp = get_colorpixel(colors[cnt]);
71 if ((cnt % (sizeof(colors) / sizeof(char*))) == 0)
74 TAILQ_INIT(&(new->floating_head));
75 TAILQ_INIT(&(new->nodes_head));
76 TAILQ_INIT(&(new->focus_head));
77 TAILQ_INIT(&(new->swallow_head));
80 con_attach(new, parent, false);
85 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
88 Con *con_new(Con *parent, i3Window *window) {
89 Con *new = con_new_skeleton(parent, window);
90 x_con_init(new, new->depth);
95 * Attaches the given container to the given parent. This happens when moving
96 * a container or when inserting a new container at a specific place in the
99 * ignore_focus is to just insert the Con at the end (useful when creating a
100 * new split container *around* some containers, that is, detaching and
101 * attaching them in order without wanting to mess with the focus in between).
104 void con_attach(Con *con, Con *parent, bool ignore_focus) {
105 con->parent = parent;
108 struct nodes_head *nodes_head = &(parent->nodes_head);
109 struct focus_head *focus_head = &(parent->focus_head);
111 /* Workspaces are handled differently: they need to be inserted at the
113 if (con->type == CT_WORKSPACE) {
114 DLOG("it's a workspace. num = %d\n", con->num);
115 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
116 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
118 current = TAILQ_FIRST(nodes_head);
119 if (con->num < current->num) {
120 /* we need to insert the container at the beginning */
121 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
123 while (current->num != -1 && con->num > current->num) {
124 current = TAILQ_NEXT(current, nodes);
125 if (current == TAILQ_END(nodes_head)) {
130 /* we need to insert con after current, if current is not NULL */
132 TAILQ_INSERT_BEFORE(current, con, nodes);
133 else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
136 goto add_to_focus_head;
139 if (con->type == CT_FLOATING_CON) {
140 DLOG("Inserting into floating containers\n");
141 TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
144 /* Get the first tiling container in focus stack */
145 TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
146 if (loop->type == CT_FLOATING_CON)
153 /* When the container is not a split container (but contains a window)
154 * and is attached to a workspace, we check if the user configured a
155 * workspace_layout. This is done in workspace_attach_to, which will
156 * provide us with the container to which we should attach (either the
157 * workspace or a new split container with the configured
160 if (con->window != NULL &&
161 parent->type == CT_WORKSPACE &&
162 parent->workspace_layout != L_DEFAULT) {
163 DLOG("Parent is a workspace. Applying default layout...\n");
164 Con *target = workspace_attach_to(parent);
166 /* Attach the original con to this new split con instead */
167 nodes_head = &(target->nodes_head);
168 focus_head = &(target->focus_head);
169 con->parent = target;
175 /* Insert the container after the tiling container, if found.
176 * When adding to a CT_OUTPUT, just append one after another. */
177 if (current && parent->type != CT_OUTPUT) {
178 DLOG("Inserting con = %p after last focused tiling con %p\n",
180 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
181 } else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
185 /* We insert to the TAIL because con_focus() will correct this.
186 * This way, we have the option to insert Cons without having
188 TAILQ_INSERT_TAIL(focus_head, con, focused);
189 con_force_split_parents_redraw(con);
193 * Detaches the given container from its current parent
196 void con_detach(Con *con) {
197 con_force_split_parents_redraw(con);
198 if (con->type == CT_FLOATING_CON) {
199 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
200 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
202 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
203 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
208 * Sets input focus to the given container. Will be updated in X11 in the next
209 * run of x_push_changes().
212 void con_focus(Con *con) {
214 DLOG("con_focus = %p\n", con);
216 /* 1: set focused-pointer to the new con */
217 /* 2: exchange the position of the container in focus stack of the parent all the way up */
218 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
219 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
220 if (con->parent->parent != NULL)
221 con_focus(con->parent);
224 /* We can't blindly reset non-leaf containers since they might have
225 * other urgent children. Therefore we only reset leafs and propagate
226 * the changes upwards via con_update_parents_urgency() which does proper
227 * checks before resetting the urgency.
229 if (con->urgent && con_is_leaf(con)) {
231 con_update_parents_urgency(con);
232 workspace_update_urgent_flag(con_get_workspace(con));
237 * Returns true when this node is a leaf node (has no children)
240 bool con_is_leaf(Con *con) {
241 return TAILQ_EMPTY(&(con->nodes_head));
245 * Returns true if this node has regular or floating children.
248 bool con_has_children(Con *con) {
249 return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
253 * Returns true if a container should be considered split.
256 bool con_is_split(Con *con) {
257 if (con_is_leaf(con))
260 switch (con->layout) {
271 * Returns true if this node accepts a window (if the node swallows windows,
272 * it might already have swallowed enough and cannot hold any more).
275 bool con_accepts_window(Con *con) {
276 /* 1: workspaces never accept direct windows */
277 if (con->type == CT_WORKSPACE)
280 if (con_is_split(con)) {
281 DLOG("container %p does not accept windows, it is a split container.\n", con);
285 /* TODO: if this is a swallowing container, we need to check its max_clients */
286 return (con->window == NULL);
290 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
294 Con *con_get_output(Con *con) {
296 while (result != NULL && result->type != CT_OUTPUT)
297 result = result->parent;
298 /* We must be able to get an output because focus can never be set higher
299 * in the tree (root node cannot be focused). */
300 assert(result != NULL);
305 * Gets the workspace container this node is on.
308 Con *con_get_workspace(Con *con) {
310 while (result != NULL && result->type != CT_WORKSPACE)
311 result = result->parent;
316 * Searches parenst of the given 'con' until it reaches one with the specified
317 * 'orientation'. Aborts when it comes across a floating_con.
320 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
321 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
322 Con *parent = con->parent;
323 if (parent->type == CT_FLOATING_CON)
325 while (con_orientation(parent) != orientation) {
326 DLOG("Need to go one level further up\n");
327 parent = parent->parent;
328 /* Abort when we reach a floating con, or an output con */
330 (parent->type == CT_FLOATING_CON ||
331 parent->type == CT_OUTPUT ||
332 (parent->parent && parent->parent->type == CT_OUTPUT)))
337 DLOG("Result: %p\n", parent);
342 * helper data structure for the breadth-first-search in
343 * con_get_fullscreen_con()
349 TAILQ_ENTRY(bfs_entry) entries;
353 * Returns the first fullscreen node below this node.
356 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode) {
357 Con *current, *child;
359 /* TODO: is breadth-first-search really appropriate? (check as soon as
360 * fullscreen levels and fullscreen for containers is implemented) */
361 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
362 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
364 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
366 while (!TAILQ_EMPTY(&bfs_head)) {
367 entry = TAILQ_FIRST(&bfs_head);
368 current = entry->con;
369 if (current != con && current->fullscreen_mode == fullscreen_mode) {
370 /* empty the queue */
371 while (!TAILQ_EMPTY(&bfs_head)) {
372 entry = TAILQ_FIRST(&bfs_head);
373 TAILQ_REMOVE(&bfs_head, entry, entries);
379 TAILQ_REMOVE(&bfs_head, entry, entries);
382 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
383 entry = smalloc(sizeof(struct bfs_entry));
385 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
388 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
389 entry = smalloc(sizeof(struct bfs_entry));
391 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
399 * Returns true if the container is internal, such as __i3_scratch
402 bool con_is_internal(Con *con) {
403 return (con->name[0] == '_' && con->name[1] == '_');
407 * Returns true if the node is floating.
410 bool con_is_floating(Con *con) {
412 DLOG("checking if con %p is floating\n", con);
413 return (con->floating >= FLOATING_AUTO_ON);
417 * Checks if the given container is either floating or inside some floating
418 * container. It returns the FLOATING_CON container.
421 Con *con_inside_floating(Con *con) {
423 if (con->type == CT_FLOATING_CON)
426 if (con->floating >= FLOATING_AUTO_ON)
429 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
432 return con_inside_floating(con->parent);
436 * Checks if the given container is inside a focused container.
439 bool con_inside_focused(Con *con) {
444 return con_inside_focused(con->parent);
448 * Returns the container with the given client window ID or NULL if no such
452 Con *con_by_window_id(xcb_window_t window) {
454 TAILQ_FOREACH(con, &all_cons, all_cons)
455 if (con->window != NULL && con->window->id == window)
461 * Returns the container with the given frame ID or NULL if no such container
465 Con *con_by_frame_id(xcb_window_t frame) {
467 TAILQ_FOREACH(con, &all_cons, all_cons)
468 if (con->frame == frame)
474 * Returns the first container below 'con' which wants to swallow this window
478 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
481 //DLOG("searching con for window %p starting at con %p\n", window, con);
482 //DLOG("class == %s\n", window->class_class);
484 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
485 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
486 if (!match_matches_window(match, window))
488 if (store_match != NULL)
489 *store_match = match;
492 Con *result = con_for_window(child, window, store_match);
497 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
498 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
499 if (!match_matches_window(match, window))
501 if (store_match != NULL)
502 *store_match = match;
505 Con *result = con_for_window(child, window, store_match);
514 * Returns the number of children of this container.
517 int con_num_children(Con *con) {
521 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
528 * Updates the percent attribute of the children of the given container. This
529 * function needs to be called when a window is added or removed from a
533 void con_fix_percent(Con *con) {
535 int children = con_num_children(con);
537 // calculate how much we have distributed and how many containers
538 // with a percentage set we have
540 int children_with_percent = 0;
541 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
542 if (child->percent > 0.0) {
543 total += child->percent;
544 ++children_with_percent;
548 // if there were children without a percentage set, set to a value that
549 // will make those children proportional to all others
550 if (children_with_percent != children) {
551 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
552 if (child->percent <= 0.0) {
553 if (children_with_percent == 0)
554 total += (child->percent = 1.0);
555 else total += (child->percent = total / children_with_percent);
560 // if we got a zero, just distribute the space equally, otherwise
561 // distribute according to the proportions we got
563 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
564 child->percent = 1.0 / children;
565 } else if (total != 1.0) {
566 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
567 child->percent /= total;
572 * Toggles fullscreen mode for the given container. If there already is a
573 * fullscreen container on this workspace, fullscreen will be disabled and then
574 * enabled for the container the user wants to have in fullscreen mode.
577 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
578 Con *workspace, *fullscreen;
580 if (con->type == CT_WORKSPACE) {
581 DLOG("You cannot make a workspace fullscreen.\n");
585 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
586 if (con->fullscreen_mode == CF_NONE) {
587 /* 1: check if there already is a fullscreen con */
588 if (fullscreen_mode == CF_GLOBAL)
589 fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
591 workspace = con_get_workspace(con);
592 fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
594 if (fullscreen != NULL) {
595 /* Disable fullscreen for the currently fullscreened
596 * container and enable it for the one the user wants
597 * to have in fullscreen mode. */
598 LOG("Disabling fullscreen for (%p/%s) upon user request\n",
599 fullscreen, fullscreen->name);
600 fullscreen->fullscreen_mode = CF_NONE;
603 /* 2: enable fullscreen */
604 con->fullscreen_mode = fullscreen_mode;
606 /* 1: disable fullscreen */
607 con->fullscreen_mode = CF_NONE;
610 DLOG("mode now: %d\n", con->fullscreen_mode);
612 /* update _NET_WM_STATE if this container has a window */
613 /* TODO: when a window is assigned to a container which is already
614 * fullscreened, this state needs to be pushed to the client, too */
615 if (con->window == NULL)
619 unsigned int num = 0;
621 if (con->fullscreen_mode != CF_NONE)
622 values[num++] = A__NET_WM_STATE_FULLSCREEN;
624 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
625 A__NET_WM_STATE, XCB_ATOM_ATOM, 32, num, values);
629 * Moves the given container to the currently focused container on the given
632 * The fix_coordinates flag will translate the current coordinates (offset from
633 * the monitor position basically) to appropriate coordinates on the
634 * destination workspace.
635 * Not enabling this behaviour comes in handy when this function gets called by
636 * floating_maybe_reassign_ws, which will only "move" a floating window when it
637 * *already* changed its coordinates to a different output.
639 * The dont_warp flag disables pointer warping and will be set when this
640 * function is called while dragging a floating window.
642 * TODO: is there a better place for this function?
645 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp) {
646 /* Prevent moving if this would violate the fullscreen focus restrictions. */
647 if (!con_fullscreen_permits_focusing(workspace)) {
648 LOG("Cannot move out of a fullscreen container");
652 if (con_is_floating(con)) {
653 DLOG("Using FLOATINGCON instead\n");
657 Con *source_ws = con_get_workspace(con);
658 if (workspace == source_ws) {
659 DLOG("Not moving, already there\n");
663 if (con->type == CT_WORKSPACE) {
664 /* Re-parent all of the old workspace's floating windows. */
666 while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
667 child = TAILQ_FIRST(&(source_ws->floating_head));
668 con_move_to_workspace(child, workspace, true, true);
671 /* If there are no non-floating children, ignore the workspace. */
672 if (con_is_leaf(con))
675 con = workspace_encapsulate(con);
677 ELOG("Workspace failed to move its contents into a container!\n");
682 /* Save the current workspace. So we can call workspace_show() by the end
683 * of this function. */
684 Con *current_ws = con_get_workspace(focused);
686 Con *source_output = con_get_output(con),
687 *dest_output = con_get_output(workspace);
689 /* 1: save the container which is going to be focused after the current
690 * container is moved away */
691 Con *focus_next = con_next_focused(con);
693 /* 2: get the focused container of this workspace */
694 Con *next = con_descend_focused(workspace);
696 /* 3: we go up one level, but only when next is a normal container */
697 if (next->type != CT_WORKSPACE) {
698 DLOG("next originally = %p / %s / type %d\n", next, next->name, next->type);
702 /* 4: if the target container is floating, we get the workspace instead.
703 * Only tiling windows need to get inserted next to the current container.
705 Con *floatingcon = con_inside_floating(next);
706 if (floatingcon != NULL) {
707 DLOG("floatingcon, going up even further\n");
708 next = floatingcon->parent;
711 if (con->type == CT_FLOATING_CON) {
712 Con *ws = con_get_workspace(next);
713 DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
717 if (source_output != dest_output) {
718 /* Take the relative coordinates of the current output, then add them
719 * to the coordinate space of the correct output */
720 if (fix_coordinates && con->type == CT_FLOATING_CON) {
721 floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
722 } else DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
724 /* If moving to a visible workspace, call show so it can be considered
725 * focused. Must do before attaching because workspace_show checks to see
726 * if focused container is in its area. */
727 if (workspace_is_visible(workspace)) {
728 workspace_show(workspace);
730 /* Don’t warp if told so (when dragging floating windows with the
731 * mouse for example) */
735 x_set_warp_to(&(con->rect));
739 /* If moving a fullscreen container and the destination already has a
740 * fullscreen window on it, un-fullscreen the target's fullscreen con. */
741 Con *fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
742 if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
743 con_toggle_fullscreen(fullscreen, CF_OUTPUT);
747 DLOG("Re-attaching container to %p / %s\n", next, next->name);
748 /* 5: re-attach the con to the parent of this focused container */
749 Con *parent = con->parent;
751 con_attach(con, next, false);
753 /* 6: fix the percentages */
754 con_fix_percent(parent);
756 con_fix_percent(next);
758 /* 7: focus the con on the target workspace, but only within that
759 * workspace, that is, don’t move focus away if the target workspace is
761 * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
762 * we don’t focus when there is a fullscreen con on that workspace. */
763 if (!con_is_internal(workspace) && !fullscreen) {
764 /* We need to save the focused workspace on the output in case the
765 * new workspace is hidden and it's necessary to immediately switch
766 * back to the originally-focused workspace. */
767 Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
768 con_focus(con_descend_focused(con));
770 /* Restore focus if the output's focused workspace has changed. */
771 if (con_get_workspace(focused) != old_focus)
772 con_focus(old_focus);
775 /* 8: when moving to another workspace, we leave the focus on the current
776 * workspace. (see also #809) */
778 /* Descend focus stack in case focus_next is a workspace which can
779 * occur if we move to the same workspace. Also show current workspace
780 * to ensure it is focused. */
781 workspace_show(current_ws);
783 /* Set focus only if con was on current workspace before moving.
784 * Otherwise we would give focus to some window on different workspace. */
785 if (source_ws == current_ws)
786 con_focus(con_descend_focused(focus_next));
788 /* If anything within the container is associated with a startup sequence,
789 * delete it so child windows won't be created on the old workspace. */
790 struct Startup_Sequence *sequence;
791 xcb_get_property_cookie_t cookie;
792 xcb_get_property_reply_t *startup_id_reply;
794 if (!con_is_leaf(con)) {
796 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
800 cookie = xcb_get_property(conn, false, child->window->id,
801 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
802 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
804 sequence = startup_sequence_get(child->window, startup_id_reply, true);
805 if (sequence != NULL)
806 startup_sequence_delete(sequence);
811 cookie = xcb_get_property(conn, false, con->window->id,
812 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
813 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
815 sequence = startup_sequence_get(con->window, startup_id_reply, true);
816 if (sequence != NULL)
817 startup_sequence_delete(sequence);
820 CALL(parent, on_remove_child);
824 * Returns the orientation of the given container (for stacked containers,
825 * vertical orientation is used regardless of the actual orientation of the
829 int con_orientation(Con *con) {
830 switch (con->layout) {
832 /* stacking containers behave like they are in vertical orientation */
837 /* tabbed containers behave like they are in vertical orientation */
842 DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
848 DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
853 DLOG("con_orientation() ran into default\n");
859 * Returns the container which will be focused next when the given container
860 * is not available anymore. Called in tree_close and con_move_to_workspace
861 * to properly restore focus.
864 Con *con_next_focused(Con *con) {
866 /* floating containers are attached to a workspace, so we focus either the
867 * next floating container (if any) or the workspace itself. */
868 if (con->type == CT_FLOATING_CON) {
869 DLOG("selecting next for CT_FLOATING_CON\n");
870 next = TAILQ_NEXT(con, floating_windows);
871 DLOG("next = %p\n", next);
873 next = TAILQ_PREV(con, floating_head, floating_windows);
874 DLOG("using prev, next = %p\n", next);
877 Con *ws = con_get_workspace(con);
879 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
880 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
881 next = TAILQ_FIRST(&(next->focus_head));
883 DLOG("skipping container itself, we want the next client\n");
884 next = TAILQ_NEXT(next, focused);
887 if (next == TAILQ_END(&(ws->focus_head))) {
888 DLOG("Focus list empty, returning ws\n");
892 /* Instead of returning the next CT_FLOATING_CON, we descend it to
893 * get an actual window to focus. */
894 next = con_descend_focused(next);
899 /* dock clients cannot be focused, so we focus the workspace instead */
900 if (con->parent->type == CT_DOCKAREA) {
901 DLOG("selecting workspace for dock client\n");
902 return con_descend_focused(output_get_content(con->parent->parent));
905 /* if 'con' is not the first entry in the focus stack, use the first one as
906 * it’s currently focused already */
907 Con *first = TAILQ_FIRST(&(con->parent->focus_head));
909 DLOG("Using first entry %p\n", first);
912 /* try to focus the next container on the same level as this one or fall
913 * back to its parent */
914 if (!(next = TAILQ_NEXT(con, focused)))
918 /* now go down the focus stack as far as
919 * possible, excluding the current container */
920 while (!TAILQ_EMPTY(&(next->focus_head)) &&
921 TAILQ_FIRST(&(next->focus_head)) != con)
922 next = TAILQ_FIRST(&(next->focus_head));
928 * Get the next/previous container in the specified orientation. This may
929 * travel up until it finds a container with suitable orientation.
932 Con *con_get_next(Con *con, char way, orientation_t orientation) {
933 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
934 /* 1: get the first parent with the same orientation */
936 while (con_orientation(cur->parent) != orientation) {
937 DLOG("need to go one level further up\n");
938 if (cur->parent->type == CT_WORKSPACE) {
939 LOG("that's a workspace, we can't go further up\n");
945 /* 2: chose next (or previous) */
948 next = TAILQ_NEXT(cur, nodes);
949 /* if we are at the end of the list, we need to wrap */
950 if (next == TAILQ_END(&(parent->nodes_head)))
953 next = TAILQ_PREV(cur, nodes_head, nodes);
954 /* if we are at the end of the list, we need to wrap */
955 if (next == TAILQ_END(&(cur->nodes_head)))
958 DLOG("next = %p\n", next);
964 * Returns the focused con inside this client, descending the tree as far as
965 * possible. This comes in handy when attaching a con to a workspace at the
966 * currently focused position, for example.
969 Con *con_descend_focused(Con *con) {
971 while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
972 next = TAILQ_FIRST(&(next->focus_head));
977 * Returns the focused con inside this client, descending the tree as far as
978 * possible. This comes in handy when attaching a con to a workspace at the
979 * currently focused position, for example.
981 * Works like con_descend_focused but considers only tiling cons.
984 Con *con_descend_tiling_focused(Con *con) {
992 TAILQ_FOREACH(child, &(next->focus_head), focused) {
993 if (child->type == CT_FLOATING_CON)
999 } while (before != next && next != focused);
1004 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1005 * direction is D_LEFT, then we return the rightmost container and if direction
1006 * is D_RIGHT, we return the leftmost container. This is because if we are
1007 * moving D_LEFT, and thus want the rightmost container.
1010 Con *con_descend_direction(Con *con, direction_t direction) {
1013 int orientation = con_orientation(con);
1014 DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1015 if (direction == D_LEFT || direction == D_RIGHT) {
1016 if (orientation == HORIZ) {
1017 /* If the direction is horizontal, we can use either the first
1018 * (D_RIGHT) or the last con (D_LEFT) */
1019 if (direction == D_RIGHT)
1020 most = TAILQ_FIRST(&(con->nodes_head));
1021 else most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1022 } else if (orientation == VERT) {
1023 /* Wrong orientation. We use the last focused con. Within that con,
1024 * we recurse to chose the left/right con or at least the last
1026 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1027 if (current->type != CT_FLOATING_CON) {
1033 /* If the con has no orientation set, it’s not a split container
1034 * but a container with a client window, so stop recursing */
1039 if (direction == D_UP || direction == D_DOWN) {
1040 if (orientation == VERT) {
1041 /* If the direction is vertical, we can use either the first
1042 * (D_DOWN) or the last con (D_UP) */
1043 if (direction == D_UP)
1044 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1045 else most = TAILQ_FIRST(&(con->nodes_head));
1046 } else if (orientation == HORIZ) {
1047 /* Wrong orientation. We use the last focused con. Within that con,
1048 * we recurse to chose the top/bottom con or at least the last
1050 TAILQ_FOREACH(current, &(con->focus_head), focused) {
1051 if (current->type != CT_FLOATING_CON) {
1057 /* If the con has no orientation set, it’s not a split container
1058 * but a container with a client window, so stop recursing */
1065 return con_descend_direction(most, direction);
1069 * Returns a "relative" Rect which contains the amount of pixels that need to
1070 * be added to the original Rect to get the final position (obviously the
1071 * amount of pixels for normal, 1pixel and borderless are different).
1074 Rect con_border_style_rect(Con *con) {
1075 adjacent_t borders_to_hide = ADJ_NONE;
1076 int border_width = con->current_border_width;
1077 DLOG("The border width for con is set to: %d\n", con->current_border_width);
1079 if (con->current_border_width < 0)
1080 border_width = config.default_border_width;
1081 DLOG("Effective border width is set to: %d\n", border_width);
1082 /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1083 int border_style = con_border_style(con);
1084 if (border_style == BS_NONE)
1085 return (Rect){ 0, 0, 0, 0 };
1086 borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1087 if (border_style == BS_NORMAL) {
1088 result = (Rect){border_width, 0 , -(2 * border_width), -(border_width)};
1090 result = (Rect){border_width, border_width, -(2 * border_width), -(2 * border_width)};
1093 /* Floating windows are never adjacent to any other window, so
1094 don’t hide their border(s). This prevents bug #998. */
1095 if (con_is_floating(con))
1098 if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1099 result.x -= border_width;
1100 result.width += border_width;
1102 if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1103 result.width += border_width;
1105 if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1106 result.y -= border_width;
1107 result.height += border_width;
1109 if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1110 result.height += border_width;
1117 * Returns adjacent borders of the window. We need this if hide_edge_borders is
1120 adjacent_t con_adjacent_borders(Con *con) {
1121 adjacent_t result = ADJ_NONE;
1122 Con *workspace = con_get_workspace(con);
1123 if (con->rect.x == workspace->rect.x)
1124 result |= ADJ_LEFT_SCREEN_EDGE;
1125 if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1126 result |= ADJ_RIGHT_SCREEN_EDGE;
1127 if (con->rect.y == workspace->rect.y)
1128 result |= ADJ_UPPER_SCREEN_EDGE;
1129 if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1130 result |= ADJ_LOWER_SCREEN_EDGE;
1135 * Use this function to get a container’s border style. This is important
1136 * because when inside a stack, the border style is always BS_NORMAL.
1137 * For tabbed mode, the same applies, with one exception: when the container is
1138 * borderless and the only element in the tabbed container, the border is not
1141 * For children of a CT_DOCKAREA, the border style is always none.
1144 int con_border_style(Con *con) {
1145 Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1147 DLOG("this one is fullscreen! overriding BS_NONE\n");
1151 if (con->parent->layout == L_STACKED)
1152 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1154 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1155 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1157 if (con->parent->type == CT_DOCKAREA)
1160 return con->border_style;
1164 * Sets the given border style on con, correctly keeping the position/size of a
1168 void con_set_border_style(Con *con, int border_style, int border_width) {
1169 /* Handle the simple case: non-floating containerns */
1170 if (!con_is_floating(con)) {
1171 con->border_style = border_style;
1172 con->current_border_width = border_width;
1176 /* For floating containers, we want to keep the position/size of the
1177 * *window* itself. We first add the border pixels to con->rect to make
1178 * con->rect represent the absolute position of the window. Then, we change
1179 * the border and subtract the new border pixels. Afterwards, we update
1180 * parent->rect to contain con. */
1181 DLOG("This is a floating container\n");
1183 Rect bsr = con_border_style_rect(con);
1184 con->rect.x += bsr.x;
1185 con->rect.y += bsr.y;
1186 con->rect.width += bsr.width;
1187 con->rect.height += bsr.height;
1189 /* Change the border style, get new border/decoration values. */
1190 con->border_style = border_style;
1191 con->current_border_width = border_width;
1192 bsr = con_border_style_rect(con);
1194 (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1196 con->rect.x -= bsr.x;
1197 con->rect.y -= bsr.y;
1198 con->rect.width -= bsr.width;
1199 con->rect.height -= bsr.height;
1201 Con *parent = con->parent;
1202 parent->rect.x = con->rect.x;
1203 parent->rect.y = con->rect.y - deco_height;
1204 parent->rect.width = con->rect.width;
1205 parent->rect.height = con->rect.height + deco_height;
1209 * This function changes the layout of a given container. Use it to handle
1210 * special cases like changing a whole workspace to stacked/tabbed (creates a
1211 * new split container before).
1214 void con_set_layout(Con *con, layout_t layout) {
1215 DLOG("con_set_layout(%p, %d), con->type = %d\n",
1216 con, layout, con->type);
1218 /* Users can focus workspaces, but not any higher in the hierarchy.
1219 * Focus on the workspace is a special case, since in every other case, the
1220 * user means "change the layout of the parent split container". */
1221 if (con->type != CT_WORKSPACE)
1224 /* We fill in last_split_layout when switching to a different layout
1225 * since there are many places in the code that don’t use
1226 * con_set_layout(). */
1227 if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1228 con->last_split_layout = con->layout;
1230 /* When the container type is CT_WORKSPACE, the user wants to change the
1231 * whole workspace into stacked/tabbed mode. To do this and still allow
1232 * intuitive operations (like level-up and then opening a new window), we
1233 * need to create a new split container. */
1234 if (con->type == CT_WORKSPACE &&
1235 (layout == L_STACKED || layout == L_TABBED)) {
1236 if (con_num_children(con) == 0) {
1237 DLOG("Setting workspace_layout to %d\n", layout);
1238 con->workspace_layout = layout;
1240 DLOG("Creating new split container\n");
1241 /* 1: create a new split container */
1242 Con *new = con_new(NULL, NULL);
1245 /* 2: Set the requested layout on the split container and mark it as
1247 new->layout = layout;
1248 new->last_split_layout = con->last_split_layout;
1250 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1251 if (old_focused == TAILQ_END(&(con->focus_head)))
1254 /* 3: move the existing cons of this workspace below the new con */
1255 DLOG("Moving cons\n");
1257 while (!TAILQ_EMPTY(&(con->nodes_head))) {
1258 child = TAILQ_FIRST(&(con->nodes_head));
1260 con_attach(child, new, true);
1263 /* 4: attach the new split container to the workspace */
1264 DLOG("Attaching new split to ws\n");
1265 con_attach(new, con, false);
1268 con_focus(old_focused);
1270 tree_flatten(croot);
1272 con_force_split_parents_redraw(con);
1276 if (layout == L_DEFAULT) {
1277 /* Special case: the layout formerly known as "default" (in combination
1278 * with an orientation). Since we switched to splith/splitv layouts,
1279 * using the "default" layout (which "only" should happen when using
1280 * legacy configs) is using the last split layout (either splith or
1281 * splitv) in order to still do the same thing.
1283 * Starting from v4.6 though, we will nag users about using "layout
1284 * default", and in v4.9 we will remove it entirely (with an
1285 * appropriate i3-migrate-config mechanism). */
1286 con->layout = con->last_split_layout;
1287 /* In case last_split_layout was not initialized… */
1288 if (con->layout == L_DEFAULT)
1289 con->layout = L_SPLITH;
1291 con->layout = layout;
1293 con_force_split_parents_redraw(con);
1297 * This function toggles the layout of a given container. toggle_mode can be
1298 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1299 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1303 void con_toggle_layout(Con *con, const char *toggle_mode) {
1305 /* Users can focus workspaces, but not any higher in the hierarchy.
1306 * Focus on the workspace is a special case, since in every other case, the
1307 * user means "change the layout of the parent split container". */
1308 if (con->type != CT_WORKSPACE)
1309 parent = con->parent;
1310 DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1312 if (strcmp(toggle_mode, "split") == 0) {
1313 /* Toggle between splits. When the current layout is not a split
1314 * layout, we just switch back to last_split_layout. Otherwise, we
1315 * change to the opposite split layout. */
1316 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV)
1317 con_set_layout(con, parent->last_split_layout);
1319 if (parent->layout == L_SPLITH)
1320 con_set_layout(con, L_SPLITV);
1321 else con_set_layout(con, L_SPLITH);
1324 if (parent->layout == L_STACKED)
1325 con_set_layout(con, L_TABBED);
1326 else if (parent->layout == L_TABBED) {
1327 if (strcmp(toggle_mode, "all") == 0)
1328 con_set_layout(con, L_SPLITH);
1329 else 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);
1337 else con_set_layout(con, L_STACKED);
1339 con_set_layout(con, L_STACKED);
1346 * Callback which will be called when removing a child from the given con.
1347 * Kills the container if it is empty and replaces it with the child if there
1348 * is exactly one child.
1351 static void con_on_remove_child(Con *con) {
1352 DLOG("on_remove_child\n");
1354 /* Every container 'above' (in the hierarchy) the workspace content should
1355 * not be closed when the last child was removed */
1356 if (con->type == CT_OUTPUT ||
1357 con->type == CT_ROOT ||
1358 con->type == CT_DOCKAREA ||
1359 (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1360 DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1364 /* For workspaces, close them only if they're not visible anymore */
1365 if (con->type == CT_WORKSPACE) {
1366 if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1367 LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1368 tree_close(con, DONT_KILL_WINDOW, false, false);
1369 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
1374 con_force_split_parents_redraw(con);
1375 con->urgent = con_has_urgent_child(con);
1376 con_update_parents_urgency(con);
1378 /* TODO: check if this container would swallow any other client and
1379 * don’t close it automatically. */
1380 int children = con_num_children(con);
1381 if (children == 0) {
1382 DLOG("Container empty, closing\n");
1383 tree_close(con, DONT_KILL_WINDOW, false, false);
1389 * Determines the minimum size of the given con by looking at its children (for
1390 * split/stacked/tabbed cons). Will be called when resizing floating cons
1393 Rect con_minimum_size(Con *con) {
1394 DLOG("Determining minimum size for con %p\n", con);
1396 if (con_is_leaf(con)) {
1397 DLOG("leaf node, returning 75x50\n");
1398 return (Rect){ 0, 0, 75, 50 };
1401 if (con->type == CT_FLOATING_CON) {
1402 DLOG("floating con\n");
1403 Con *child = TAILQ_FIRST(&(con->nodes_head));
1404 return con_minimum_size(child);
1407 if (con->layout == L_STACKED || con->layout == L_TABBED) {
1408 uint32_t max_width = 0, max_height = 0, deco_height = 0;
1410 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1411 Rect min = con_minimum_size(child);
1412 deco_height += child->deco_rect.height;
1413 max_width = max(max_width, min.width);
1414 max_height = max(max_height, min.height);
1416 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1417 max_width, max_height, deco_height);
1418 return (Rect){ 0, 0, max_width, max_height + deco_height };
1421 /* For horizontal/vertical split containers we sum up the width (h-split)
1422 * or height (v-split) and use the maximum of the height (h-split) or width
1423 * (v-split) as minimum size. */
1424 if (con_is_split(con)) {
1425 uint32_t width = 0, height = 0;
1427 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1428 Rect min = con_minimum_size(child);
1429 if (con->layout == L_SPLITH) {
1431 height = max(height, min.height);
1433 height += min.height;
1434 width = max(width, min.width);
1437 DLOG("split container, returning width = %d x height = %d\n", width, height);
1438 return (Rect){ 0, 0, width, height };
1441 ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1442 con->type, con->layout, con_is_split(con));
1447 * Returns true if changing the focus to con would be allowed considering
1448 * the fullscreen focus constraints. Specifically, if a fullscreen container or
1449 * any of its descendants is focused, this function returns true if and only if
1450 * focusing con would mean that focus would still be visible on screen, i.e.,
1451 * the newly focused container would not be obscured by a fullscreen container.
1453 * In the simplest case, if a fullscreen container or any of its descendants is
1454 * fullscreen, this functions returns true if con is the fullscreen container
1455 * itself or any of its descendants, as this means focus wouldn't escape the
1456 * boundaries of the fullscreen container.
1458 * In case the fullscreen container is of type CF_OUTPUT, this function returns
1459 * true if con is on a different workspace, as focus wouldn't be obscured by
1460 * the fullscreen container that is constrained to a different workspace.
1462 * Note that this same logic can be applied to moving containers. If a
1463 * container can be focused under the fullscreen focus constraints, it can also
1464 * become a parent or sibling to the currently focused container.
1467 bool con_fullscreen_permits_focusing(Con *con) {
1468 /* No focus, no problem. */
1472 /* Find the first fullscreen ascendent. */
1474 while (fs && fs->fullscreen_mode == CF_NONE)
1477 /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1478 * there always has to be a workspace con in the hierarchy. */
1480 /* The most common case is we hit the workspace level. In this
1481 * situation, changing focus is also harmless. */
1482 assert(fs->fullscreen_mode != CF_NONE);
1483 if (fs->type == CT_WORKSPACE)
1486 /* Allow it if the container itself is the fullscreen container. */
1490 /* If fullscreen is per-output, the focus being in a different workspace is
1491 * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1492 if (fs->fullscreen_mode == CF_OUTPUT &&
1493 con_get_workspace(con) != con_get_workspace(fs)) {
1497 /* Allow it only if the container to be focused is contained within the
1498 * current fullscreen container. */
1500 if (con->parent == fs)
1505 /* Focusing con would hide it behind a fullscreen window, disallow it. */
1511 * Checks if the given container has an urgent child.
1514 bool con_has_urgent_child(Con *con) {
1517 if (con_is_leaf(con))
1520 /* We are not interested in floating windows since they can only be
1521 * attached to a workspace → nodes_head instead of focus_head */
1522 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1523 if (con_has_urgent_child(child))
1531 * Make all parent containers urgent if con is urgent or clear the urgent flag
1532 * of all parent containers if there are no more urgent children left.
1535 void con_update_parents_urgency(Con *con) {
1536 Con *parent = con->parent;
1538 bool new_urgency_value = con->urgent;
1539 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
1540 if (new_urgency_value) {
1541 parent->urgent = true;
1543 /* We can only reset the urgency when the parent
1544 * has no other urgent children */
1545 if (!con_has_urgent_child(parent))
1546 parent->urgent = false;
1548 parent = parent->parent;
1553 * Set urgency flag to the container, all the parent containers and the workspace.
1556 void con_set_urgency(Con *con, bool urgent) {
1557 if (focused == con) {
1558 DLOG("Ignoring urgency flag for current client\n");
1559 con->window->urgent.tv_sec = 0;
1560 con->window->urgent.tv_usec = 0;
1564 if (con->urgency_timer == NULL) {
1565 con->urgent = urgent;
1567 DLOG("Discarding urgency WM_HINT because timer is running\n");
1572 gettimeofday(&con->window->urgent, NULL);
1574 con->window->urgent.tv_sec = 0;
1575 con->window->urgent.tv_usec = 0;
1579 con_update_parents_urgency(con);
1581 if (con->urgent == urgent)
1582 LOG("Urgency flag changed to %d\n", con->urgent);
1585 /* Set the urgency flag on the workspace, if a workspace could be found
1586 * (for dock clients, that is not the case). */
1587 if ((ws = con_get_workspace(con)) != NULL)
1588 workspace_update_urgent_flag(ws);
1592 * Create a string representing the subtree under con.
1595 char *con_get_tree_representation(Con *con) {
1596 /* this code works as follows:
1597 * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
1598 * 2) append the tree representation of the children to the string
1599 * 3) add closing bracket
1601 * The recursion ends when we hit a leaf, in which case we return the
1602 * class_instance of the contained window.
1605 /* end of recursion */
1606 if (con_is_leaf(con)) {
1608 return sstrdup("nowin");
1610 if (!con->window->class_instance)
1611 return sstrdup("noinstance");
1613 return sstrdup(con->window->class_instance);
1617 /* 1) add the Layout type to buf */
1618 if (con->layout == L_DEFAULT)
1619 buf = sstrdup("D[");
1620 else if (con->layout == L_SPLITV)
1621 buf = sstrdup("V[");
1622 else if (con->layout == L_SPLITH)
1623 buf = sstrdup("H[");
1624 else if (con->layout == L_TABBED)
1625 buf = sstrdup("T[");
1626 else if (con->layout == L_STACKED)
1627 buf = sstrdup("S[");
1629 ELOG("BUG: Code not updated to account for new layout type\n");
1633 /* 2) append representation of children */
1635 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1636 char *child_txt = con_get_tree_representation(child);
1639 sasprintf(&tmp_buf, "%s%s%s", buf,
1640 (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
1645 /* 3) close the brackets */
1647 sasprintf(&complete_buf, "%s]", buf);
1650 return complete_buf;