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,
28 static void con_on_remove_child(Con *con);
31 * force parent split containers to be redrawn
34 static void con_force_split_parents_redraw(Con *con) {
37 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
38 if (!con_is_leaf(parent))
39 FREE(parent->deco_render_params);
40 parent = parent->parent;
45 * Create a new container (and attach it to the given parent, if not NULL).
46 * This function only initializes the data structures.
49 Con *con_new_skeleton(Con *parent, i3Window *window) {
50 Con *new = scalloc(sizeof(Con));
51 new->on_remove_child = con_on_remove_child;
52 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
53 new->aspect_ratio = 0.0;
56 new->border_style = config.default_border;
57 new->current_border_width = -1;
59 new->depth = window->depth;
61 new->depth = XCB_COPY_FROM_PARENT;
63 DLOG("opening window %d\n", cnt);
65 /* TODO: remove window coloring after test-phase */
66 DLOG("color %s\n", colors[cnt]);
67 new->name = strdup(colors[cnt]);
68 //uint32_t cp = get_colorpixel(colors[cnt]);
70 if ((cnt % (sizeof(colors) / sizeof(char *))) == 0)
73 TAILQ_INIT(&(new->floating_head));
74 TAILQ_INIT(&(new->nodes_head));
75 TAILQ_INIT(&(new->focus_head));
76 TAILQ_INIT(&(new->swallow_head));
79 con_attach(new, parent, false);
84 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
87 Con *con_new(Con *parent, i3Window *window) {
88 Con *new = con_new_skeleton(parent, window);
89 x_con_init(new, new->depth);
94 * Attaches the given container to the given parent. This happens when moving
95 * a container or when inserting a new container at a specific place in the
98 * ignore_focus is to just insert the Con at the end (useful when creating a
99 * new split container *around* some containers, that is, detaching and
100 * attaching them in order without wanting to mess with the focus in between).
103 void con_attach(Con *con, Con *parent, bool ignore_focus) {
104 con->parent = parent;
107 struct nodes_head *nodes_head = &(parent->nodes_head);
108 struct focus_head *focus_head = &(parent->focus_head);
110 /* Workspaces are handled differently: they need to be inserted at the
112 if (con->type == CT_WORKSPACE) {
113 DLOG("it's a workspace. num = %d\n", con->num);
114 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
115 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
117 current = TAILQ_FIRST(nodes_head);
118 if (con->num < current->num) {
119 /* we need to insert the container at the beginning */
120 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
122 while (current->num != -1 && con->num > current->num) {
123 current = TAILQ_NEXT(current, nodes);
124 if (current == TAILQ_END(nodes_head)) {
129 /* we need to insert con after current, if current is not NULL */
131 TAILQ_INSERT_BEFORE(current, con, nodes);
133 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);
182 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
186 /* We insert to the TAIL because con_focus() will correct this.
187 * This way, we have the option to insert Cons without having
189 TAILQ_INSERT_TAIL(focus_head, con, focused);
190 con_force_split_parents_redraw(con);
194 * Detaches the given container from its current parent
197 void con_detach(Con *con) {
198 con_force_split_parents_redraw(con);
199 if (con->type == CT_FLOATING_CON) {
200 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
201 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
203 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
204 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
209 * Sets input focus to the given container. Will be updated in X11 in the next
210 * run of x_push_changes().
213 void con_focus(Con *con) {
215 DLOG("con_focus = %p\n", con);
217 /* 1: set focused-pointer to the new con */
218 /* 2: exchange the position of the container in focus stack of the parent all the way up */
219 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
220 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
221 if (con->parent->parent != NULL)
222 con_focus(con->parent);
225 /* We can't blindly reset non-leaf containers since they might have
226 * other urgent children. Therefore we only reset leafs and propagate
227 * the changes upwards via con_update_parents_urgency() which does proper
228 * checks before resetting the urgency.
230 if (con->urgent && con_is_leaf(con)) {
232 con_update_parents_urgency(con);
233 workspace_update_urgent_flag(con_get_workspace(con));
238 * Returns true when this node is a leaf node (has no children)
241 bool con_is_leaf(Con *con) {
242 return TAILQ_EMPTY(&(con->nodes_head));
246 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
247 * excluding dock containers)
249 bool con_has_managed_window(Con *con) {
250 return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
254 * Returns true if this node has regular or floating children.
257 bool con_has_children(Con *con) {
258 return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
262 * Returns true if a container should be considered split.
265 bool con_is_split(Con *con) {
266 if (con_is_leaf(con))
269 switch (con->layout) {
280 * Returns true if this node accepts a window (if the node swallows windows,
281 * it might already have swallowed enough and cannot hold any more).
284 bool con_accepts_window(Con *con) {
285 /* 1: workspaces never accept direct windows */
286 if (con->type == CT_WORKSPACE)
289 if (con_is_split(con)) {
290 DLOG("container %p does not accept windows, it is a split container.\n", con);
294 /* TODO: if this is a swallowing container, we need to check its max_clients */
295 return (con->window == NULL);
299 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
303 Con *con_get_output(Con *con) {
305 while (result != NULL && result->type != CT_OUTPUT)
306 result = result->parent;
307 /* We must be able to get an output because focus can never be set higher
308 * in the tree (root node cannot be focused). */
309 assert(result != NULL);
314 * Gets the workspace container this node is on.
317 Con *con_get_workspace(Con *con) {
319 while (result != NULL && result->type != CT_WORKSPACE)
320 result = result->parent;
325 * Searches parenst of the given 'con' until it reaches one with the specified
326 * 'orientation'. Aborts when it comes across a floating_con.
329 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
330 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
331 Con *parent = con->parent;
332 if (parent->type == CT_FLOATING_CON)
334 while (con_orientation(parent) != orientation) {
335 DLOG("Need to go one level further up\n");
336 parent = parent->parent;
337 /* Abort when we reach a floating con, or an output con */
339 (parent->type == CT_FLOATING_CON ||
340 parent->type == CT_OUTPUT ||
341 (parent->parent && parent->parent->type == CT_OUTPUT)))
346 DLOG("Result: %p\n", parent);
351 * helper data structure for the breadth-first-search in
352 * con_get_fullscreen_con()
358 TAILQ_ENTRY(bfs_entry) entries;
362 * Returns the first fullscreen node below this node.
365 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode) {
366 Con *current, *child;
368 /* TODO: is breadth-first-search really appropriate? (check as soon as
369 * fullscreen levels and fullscreen for containers is implemented) */
370 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
371 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
373 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
375 while (!TAILQ_EMPTY(&bfs_head)) {
376 entry = TAILQ_FIRST(&bfs_head);
377 current = entry->con;
378 if (current != con && current->fullscreen_mode == fullscreen_mode) {
379 /* empty the queue */
380 while (!TAILQ_EMPTY(&bfs_head)) {
381 entry = TAILQ_FIRST(&bfs_head);
382 TAILQ_REMOVE(&bfs_head, entry, entries);
388 TAILQ_REMOVE(&bfs_head, entry, entries);
391 TAILQ_FOREACH (child, &(current->nodes_head), nodes) {
392 entry = smalloc(sizeof(struct bfs_entry));
394 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
397 TAILQ_FOREACH (child, &(current->floating_head), floating_windows) {
398 entry = smalloc(sizeof(struct bfs_entry));
400 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
408 * Returns true if the container is internal, such as __i3_scratch
411 bool con_is_internal(Con *con) {
412 return (con->name[0] == '_' && con->name[1] == '_');
416 * Returns true if the node is floating.
419 bool con_is_floating(Con *con) {
421 DLOG("checking if con %p is floating\n", con);
422 return (con->floating >= FLOATING_AUTO_ON);
426 * Checks if the given container is either floating or inside some floating
427 * container. It returns the FLOATING_CON container.
430 Con *con_inside_floating(Con *con) {
432 if (con->type == CT_FLOATING_CON)
435 if (con->floating >= FLOATING_AUTO_ON)
438 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
441 return con_inside_floating(con->parent);
445 * Checks if the given container is inside a focused container.
448 bool con_inside_focused(Con *con) {
453 return con_inside_focused(con->parent);
457 * Returns the container with the given client window ID or NULL if no such
461 Con *con_by_window_id(xcb_window_t window) {
463 TAILQ_FOREACH (con, &all_cons, all_cons)
464 if (con->window != NULL && con->window->id == window)
470 * Returns the container with the given frame ID or NULL if no such container
474 Con *con_by_frame_id(xcb_window_t frame) {
476 TAILQ_FOREACH (con, &all_cons, all_cons)
477 if (con->frame == frame)
483 * Returns the first container below 'con' which wants to swallow this window
487 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
490 //DLOG("searching con for window %p starting at con %p\n", window, con);
491 //DLOG("class == %s\n", window->class_class);
493 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
494 TAILQ_FOREACH (match, &(child->swallow_head), matches) {
495 if (!match_matches_window(match, window))
497 if (store_match != NULL)
498 *store_match = match;
501 Con *result = con_for_window(child, window, store_match);
506 TAILQ_FOREACH (child, &(con->floating_head), floating_windows) {
507 TAILQ_FOREACH (match, &(child->swallow_head), matches) {
508 if (!match_matches_window(match, window))
510 if (store_match != NULL)
511 *store_match = match;
514 Con *result = con_for_window(child, window, store_match);
523 * Returns the number of children of this container.
526 int con_num_children(Con *con) {
530 TAILQ_FOREACH (child, &(con->nodes_head), nodes)
537 * Updates the percent attribute of the children of the given container. This
538 * function needs to be called when a window is added or removed from a
542 void con_fix_percent(Con *con) {
544 int children = con_num_children(con);
546 // calculate how much we have distributed and how many containers
547 // with a percentage set we have
549 int children_with_percent = 0;
550 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
551 if (child->percent > 0.0) {
552 total += child->percent;
553 ++children_with_percent;
557 // if there were children without a percentage set, set to a value that
558 // will make those children proportional to all others
559 if (children_with_percent != children) {
560 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
561 if (child->percent <= 0.0) {
562 if (children_with_percent == 0)
563 total += (child->percent = 1.0);
565 total += (child->percent = total / children_with_percent);
570 // if we got a zero, just distribute the space equally, otherwise
571 // distribute according to the proportions we got
573 TAILQ_FOREACH (child, &(con->nodes_head), nodes)
574 child->percent = 1.0 / children;
575 } else if (total != 1.0) {
576 TAILQ_FOREACH (child, &(con->nodes_head), nodes)
577 child->percent /= total;
582 * Toggles fullscreen mode for the given container. If there already is a
583 * fullscreen container on this workspace, fullscreen will be disabled and then
584 * enabled for the container the user wants to have in fullscreen mode.
587 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
588 Con *workspace, *fullscreen;
590 if (con->type == CT_WORKSPACE) {
591 DLOG("You cannot make a workspace fullscreen.\n");
595 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
596 if (con->fullscreen_mode == CF_NONE) {
597 /* 1: check if there already is a fullscreen con */
598 if (fullscreen_mode == CF_GLOBAL)
599 fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
601 workspace = con_get_workspace(con);
602 fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
604 if (fullscreen != NULL) {
605 /* Disable fullscreen for the currently fullscreened
606 * container and enable it for the one the user wants
607 * to have in fullscreen mode. */
608 LOG("Disabling fullscreen for (%p/%s) upon user request\n",
609 fullscreen, fullscreen->name);
610 fullscreen->fullscreen_mode = CF_NONE;
613 /* 2: enable fullscreen */
614 con->fullscreen_mode = fullscreen_mode;
616 /* 1: disable fullscreen */
617 con->fullscreen_mode = CF_NONE;
620 DLOG("mode now: %d\n", con->fullscreen_mode);
622 /* Send an ipc window "fullscreen_mode" event */
623 ipc_send_window_event("fullscreen_mode", con);
625 /* update _NET_WM_STATE if this container has a window */
626 /* TODO: when a window is assigned to a container which is already
627 * fullscreened, this state needs to be pushed to the client, too */
628 if (con->window == NULL)
632 unsigned int num = 0;
634 if (con->fullscreen_mode != CF_NONE)
635 values[num++] = A__NET_WM_STATE_FULLSCREEN;
637 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
638 A__NET_WM_STATE, XCB_ATOM_ATOM, 32, num, values);
642 * Moves the given container to the currently focused container on the given
645 * The fix_coordinates flag will translate the current coordinates (offset from
646 * the monitor position basically) to appropriate coordinates on the
647 * destination workspace.
648 * Not enabling this behaviour comes in handy when this function gets called by
649 * floating_maybe_reassign_ws, which will only "move" a floating window when it
650 * *already* changed its coordinates to a different output.
652 * The dont_warp flag disables pointer warping and will be set when this
653 * function is called while dragging a floating window.
655 * TODO: is there a better place for this function?
658 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp) {
659 /* Prevent moving if this would violate the fullscreen focus restrictions. */
660 if (!con_fullscreen_permits_focusing(workspace)) {
661 LOG("Cannot move out of a fullscreen container");
665 if (con_is_floating(con)) {
666 DLOG("Using FLOATINGCON instead\n");
670 Con *source_ws = con_get_workspace(con);
671 if (workspace == source_ws) {
672 DLOG("Not moving, already there\n");
676 if (con->type == CT_WORKSPACE) {
677 /* Re-parent all of the old workspace's floating windows. */
679 while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
680 child = TAILQ_FIRST(&(source_ws->floating_head));
681 con_move_to_workspace(child, workspace, true, true);
684 /* If there are no non-floating children, ignore the workspace. */
685 if (con_is_leaf(con))
688 con = workspace_encapsulate(con);
690 ELOG("Workspace failed to move its contents into a container!\n");
695 /* Save the current workspace. So we can call workspace_show() by the end
696 * of this function. */
697 Con *current_ws = con_get_workspace(focused);
699 Con *source_output = con_get_output(con),
700 *dest_output = con_get_output(workspace);
702 /* 1: save the container which is going to be focused after the current
703 * container is moved away */
704 Con *focus_next = con_next_focused(con);
706 /* 2: get the focused container of this workspace */
707 Con *next = con_descend_focused(workspace);
709 /* 3: we go up one level, but only when next is a normal container */
710 if (next->type != CT_WORKSPACE) {
711 DLOG("next originally = %p / %s / type %d\n", next, next->name, next->type);
715 /* 4: if the target container is floating, we get the workspace instead.
716 * Only tiling windows need to get inserted next to the current container.
718 Con *floatingcon = con_inside_floating(next);
719 if (floatingcon != NULL) {
720 DLOG("floatingcon, going up even further\n");
721 next = floatingcon->parent;
724 if (con->type == CT_FLOATING_CON) {
725 Con *ws = con_get_workspace(next);
726 DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
730 if (source_output != dest_output) {
731 /* Take the relative coordinates of the current output, then add them
732 * to the coordinate space of the correct output */
733 if (fix_coordinates && con->type == CT_FLOATING_CON) {
734 floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
736 DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
738 /* If moving to a visible workspace, call show so it can be considered
739 * focused. Must do before attaching because workspace_show checks to see
740 * if focused container is in its area. */
741 if (workspace_is_visible(workspace)) {
742 workspace_show(workspace);
744 /* Don’t warp if told so (when dragging floating windows with the
745 * mouse for example) */
749 x_set_warp_to(&(con->rect));
753 /* If moving a fullscreen container and the destination already has a
754 * fullscreen window on it, un-fullscreen the target's fullscreen con. */
755 Con *fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
756 if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
757 con_toggle_fullscreen(fullscreen, CF_OUTPUT);
761 DLOG("Re-attaching container to %p / %s\n", next, next->name);
762 /* 5: re-attach the con to the parent of this focused container */
763 Con *parent = con->parent;
765 con_attach(con, next, false);
767 /* 6: fix the percentages */
768 con_fix_percent(parent);
770 con_fix_percent(next);
772 /* 7: focus the con on the target workspace, but only within that
773 * workspace, that is, don’t move focus away if the target workspace is
775 * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
776 * we don’t focus when there is a fullscreen con on that workspace. */
777 if (!con_is_internal(workspace) && !fullscreen) {
778 /* We need to save the focused workspace on the output in case the
779 * new workspace is hidden and it's necessary to immediately switch
780 * back to the originally-focused workspace. */
781 Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
782 con_focus(con_descend_focused(con));
784 /* Restore focus if the output's focused workspace has changed. */
785 if (con_get_workspace(focused) != old_focus)
786 con_focus(old_focus);
789 /* 8: when moving to another workspace, we leave the focus on the current
790 * workspace. (see also #809) */
792 /* Descend focus stack in case focus_next is a workspace which can
793 * occur if we move to the same workspace. Also show current workspace
794 * to ensure it is focused. */
795 workspace_show(current_ws);
797 /* Set focus only if con was on current workspace before moving.
798 * Otherwise we would give focus to some window on different workspace. */
799 if (source_ws == current_ws)
800 con_focus(con_descend_focused(focus_next));
802 /* If anything within the container is associated with a startup sequence,
803 * delete it so child windows won't be created on the old workspace. */
804 struct Startup_Sequence *sequence;
805 xcb_get_property_cookie_t cookie;
806 xcb_get_property_reply_t *startup_id_reply;
808 if (!con_is_leaf(con)) {
810 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
814 cookie = xcb_get_property(conn, false, child->window->id,
815 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
816 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
818 sequence = startup_sequence_get(child->window, startup_id_reply, true);
819 if (sequence != NULL)
820 startup_sequence_delete(sequence);
825 cookie = xcb_get_property(conn, false, con->window->id,
826 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
827 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
829 sequence = startup_sequence_get(con->window, startup_id_reply, true);
830 if (sequence != NULL)
831 startup_sequence_delete(sequence);
834 CALL(parent, on_remove_child);
838 * Returns the orientation of the given container (for stacked containers,
839 * vertical orientation is used regardless of the actual orientation of the
843 orientation_t con_orientation(Con *con) {
844 switch (con->layout) {
846 /* stacking containers behave like they are in vertical orientation */
851 /* tabbed containers behave like they are in vertical orientation */
856 DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
862 DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
867 DLOG("con_orientation() ran into default\n");
873 * Returns the container which will be focused next when the given container
874 * is not available anymore. Called in tree_close and con_move_to_workspace
875 * to properly restore focus.
878 Con *con_next_focused(Con *con) {
880 /* floating containers are attached to a workspace, so we focus either the
881 * next floating container (if any) or the workspace itself. */
882 if (con->type == CT_FLOATING_CON) {
883 DLOG("selecting next for CT_FLOATING_CON\n");
884 next = TAILQ_NEXT(con, floating_windows);
885 DLOG("next = %p\n", next);
887 next = TAILQ_PREV(con, floating_head, floating_windows);
888 DLOG("using prev, next = %p\n", next);
891 Con *ws = con_get_workspace(con);
893 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
894 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
895 next = TAILQ_FIRST(&(next->focus_head));
897 DLOG("skipping container itself, we want the next client\n");
898 next = TAILQ_NEXT(next, focused);
901 if (next == TAILQ_END(&(ws->focus_head))) {
902 DLOG("Focus list empty, returning ws\n");
906 /* Instead of returning the next CT_FLOATING_CON, we descend it to
907 * get an actual window to focus. */
908 next = con_descend_focused(next);
913 /* dock clients cannot be focused, so we focus the workspace instead */
914 if (con->parent->type == CT_DOCKAREA) {
915 DLOG("selecting workspace for dock client\n");
916 return con_descend_focused(output_get_content(con->parent->parent));
919 /* if 'con' is not the first entry in the focus stack, use the first one as
920 * it’s currently focused already */
921 Con *first = TAILQ_FIRST(&(con->parent->focus_head));
923 DLOG("Using first entry %p\n", first);
926 /* try to focus the next container on the same level as this one or fall
927 * back to its parent */
928 if (!(next = TAILQ_NEXT(con, focused)))
932 /* now go down the focus stack as far as
933 * possible, excluding the current container */
934 while (!TAILQ_EMPTY(&(next->focus_head)) &&
935 TAILQ_FIRST(&(next->focus_head)) != con)
936 next = TAILQ_FIRST(&(next->focus_head));
942 * Get the next/previous container in the specified orientation. This may
943 * travel up until it finds a container with suitable orientation.
946 Con *con_get_next(Con *con, char way, orientation_t orientation) {
947 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
948 /* 1: get the first parent with the same orientation */
950 while (con_orientation(cur->parent) != orientation) {
951 DLOG("need to go one level further up\n");
952 if (cur->parent->type == CT_WORKSPACE) {
953 LOG("that's a workspace, we can't go further up\n");
959 /* 2: chose next (or previous) */
962 next = TAILQ_NEXT(cur, nodes);
963 /* if we are at the end of the list, we need to wrap */
964 if (next == TAILQ_END(&(parent->nodes_head)))
967 next = TAILQ_PREV(cur, nodes_head, nodes);
968 /* if we are at the end of the list, we need to wrap */
969 if (next == TAILQ_END(&(cur->nodes_head)))
972 DLOG("next = %p\n", next);
978 * Returns the focused con inside this client, descending the tree as far as
979 * possible. This comes in handy when attaching a con to a workspace at the
980 * currently focused position, for example.
983 Con *con_descend_focused(Con *con) {
985 while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
986 next = TAILQ_FIRST(&(next->focus_head));
991 * Returns the focused con inside this client, descending the tree as far as
992 * possible. This comes in handy when attaching a con to a workspace at the
993 * currently focused position, for example.
995 * Works like con_descend_focused but considers only tiling cons.
998 Con *con_descend_tiling_focused(Con *con) {
1002 if (next == focused)
1006 TAILQ_FOREACH (child, &(next->focus_head), focused) {
1007 if (child->type == CT_FLOATING_CON)
1013 } while (before != next && next != focused);
1018 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1019 * direction is D_LEFT, then we return the rightmost container and if direction
1020 * is D_RIGHT, we return the leftmost container. This is because if we are
1021 * moving D_LEFT, and thus want the rightmost container.
1024 Con *con_descend_direction(Con *con, direction_t direction) {
1027 int orientation = con_orientation(con);
1028 DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1029 if (direction == D_LEFT || direction == D_RIGHT) {
1030 if (orientation == HORIZ) {
1031 /* If the direction is horizontal, we can use either the first
1032 * (D_RIGHT) or the last con (D_LEFT) */
1033 if (direction == D_RIGHT)
1034 most = TAILQ_FIRST(&(con->nodes_head));
1036 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1037 } else if (orientation == VERT) {
1038 /* Wrong orientation. We use the last focused con. Within that con,
1039 * we recurse to chose the left/right con or at least the last
1041 TAILQ_FOREACH (current, &(con->focus_head), focused) {
1042 if (current->type != CT_FLOATING_CON) {
1048 /* If the con has no orientation set, it’s not a split container
1049 * but a container with a client window, so stop recursing */
1054 if (direction == D_UP || direction == D_DOWN) {
1055 if (orientation == VERT) {
1056 /* If the direction is vertical, we can use either the first
1057 * (D_DOWN) or the last con (D_UP) */
1058 if (direction == D_UP)
1059 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1061 most = TAILQ_FIRST(&(con->nodes_head));
1062 } else if (orientation == HORIZ) {
1063 /* Wrong orientation. We use the last focused con. Within that con,
1064 * we recurse to chose the top/bottom con or at least the last
1066 TAILQ_FOREACH (current, &(con->focus_head), focused) {
1067 if (current->type != CT_FLOATING_CON) {
1073 /* If the con has no orientation set, it’s not a split container
1074 * but a container with a client window, so stop recursing */
1081 return con_descend_direction(most, direction);
1085 * Returns a "relative" Rect which contains the amount of pixels that need to
1086 * be added to the original Rect to get the final position (obviously the
1087 * amount of pixels for normal, 1pixel and borderless are different).
1090 Rect con_border_style_rect(Con *con) {
1091 adjacent_t borders_to_hide = ADJ_NONE;
1092 int border_width = con->current_border_width;
1093 DLOG("The border width for con is set to: %d\n", con->current_border_width);
1095 if (con->current_border_width < 0) {
1096 if (con_is_floating(con)) {
1097 border_width = config.default_floating_border_width;
1099 border_width = config.default_border_width;
1102 DLOG("Effective border width is set to: %d\n", border_width);
1103 /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1104 int border_style = con_border_style(con);
1105 if (border_style == BS_NONE)
1106 return (Rect) {0, 0, 0, 0};
1107 borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1108 if (border_style == BS_NORMAL) {
1109 result = (Rect) {border_width, 0, -(2 * border_width), -(border_width)};
1111 result = (Rect) {border_width, border_width, -(2 * border_width), -(2 * border_width)};
1114 /* Floating windows are never adjacent to any other window, so
1115 don’t hide their border(s). This prevents bug #998. */
1116 if (con_is_floating(con))
1119 if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1120 result.x -= border_width;
1121 result.width += border_width;
1123 if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1124 result.width += border_width;
1126 if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1127 result.y -= border_width;
1128 result.height += border_width;
1130 if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1131 result.height += border_width;
1137 * Returns adjacent borders of the window. We need this if hide_edge_borders is
1140 adjacent_t con_adjacent_borders(Con *con) {
1141 adjacent_t result = ADJ_NONE;
1142 Con *workspace = con_get_workspace(con);
1143 if (con->rect.x == workspace->rect.x)
1144 result |= ADJ_LEFT_SCREEN_EDGE;
1145 if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1146 result |= ADJ_RIGHT_SCREEN_EDGE;
1147 if (con->rect.y == workspace->rect.y)
1148 result |= ADJ_UPPER_SCREEN_EDGE;
1149 if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1150 result |= ADJ_LOWER_SCREEN_EDGE;
1155 * Use this function to get a container’s border style. This is important
1156 * because when inside a stack, the border style is always BS_NORMAL.
1157 * For tabbed mode, the same applies, with one exception: when the container is
1158 * borderless and the only element in the tabbed container, the border is not
1161 * For children of a CT_DOCKAREA, the border style is always none.
1164 int con_border_style(Con *con) {
1165 Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1167 DLOG("this one is fullscreen! overriding BS_NONE\n");
1171 if (con->parent->layout == L_STACKED)
1172 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1174 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1175 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1177 if (con->parent->type == CT_DOCKAREA)
1180 return con->border_style;
1184 * Sets the given border style on con, correctly keeping the position/size of a
1188 void con_set_border_style(Con *con, int border_style, int border_width) {
1189 /* Handle the simple case: non-floating containerns */
1190 if (!con_is_floating(con)) {
1191 con->border_style = border_style;
1192 con->current_border_width = border_width;
1196 /* For floating containers, we want to keep the position/size of the
1197 * *window* itself. We first add the border pixels to con->rect to make
1198 * con->rect represent the absolute position of the window (same for
1199 * parent). Then, we change the border style and subtract the new border
1200 * pixels. For the parent, we do the same also for the decoration. */
1201 DLOG("This is a floating container\n");
1203 Con *parent = con->parent;
1204 Rect bsr = con_border_style_rect(con);
1205 int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1207 con->rect = rect_add(con->rect, bsr);
1208 parent->rect = rect_add(parent->rect, bsr);
1209 parent->rect.y += deco_height;
1210 parent->rect.height -= deco_height;
1212 /* Change the border style, get new border/decoration values. */
1213 con->border_style = border_style;
1214 con->current_border_width = border_width;
1215 bsr = con_border_style_rect(con);
1216 deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1218 con->rect = rect_sub(con->rect, bsr);
1219 parent->rect = rect_sub(parent->rect, bsr);
1220 parent->rect.y -= deco_height;
1221 parent->rect.height += deco_height;
1225 * This function changes the layout of a given container. Use it to handle
1226 * special cases like changing a whole workspace to stacked/tabbed (creates a
1227 * new split container before).
1230 void con_set_layout(Con *con, layout_t layout) {
1231 DLOG("con_set_layout(%p, %d), con->type = %d\n",
1232 con, layout, con->type);
1234 /* Users can focus workspaces, but not any higher in the hierarchy.
1235 * Focus on the workspace is a special case, since in every other case, the
1236 * user means "change the layout of the parent split container". */
1237 if (con->type != CT_WORKSPACE)
1240 /* We fill in last_split_layout when switching to a different layout
1241 * since there are many places in the code that don’t use
1242 * con_set_layout(). */
1243 if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1244 con->last_split_layout = con->layout;
1246 /* When the container type is CT_WORKSPACE, the user wants to change the
1247 * whole workspace into stacked/tabbed mode. To do this and still allow
1248 * intuitive operations (like level-up and then opening a new window), we
1249 * need to create a new split container. */
1250 if (con->type == CT_WORKSPACE &&
1251 (layout == L_STACKED || layout == L_TABBED)) {
1252 if (con_num_children(con) == 0) {
1253 DLOG("Setting workspace_layout to %d\n", layout);
1254 con->workspace_layout = layout;
1256 DLOG("Creating new split container\n");
1257 /* 1: create a new split container */
1258 Con *new = con_new(NULL, NULL);
1261 /* 2: Set the requested layout on the split container and mark it as
1263 new->layout = layout;
1264 new->last_split_layout = con->last_split_layout;
1266 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1267 if (old_focused == TAILQ_END(&(con->focus_head)))
1270 /* 3: move the existing cons of this workspace below the new con */
1271 DLOG("Moving cons\n");
1273 while (!TAILQ_EMPTY(&(con->nodes_head))) {
1274 child = TAILQ_FIRST(&(con->nodes_head));
1276 con_attach(child, new, true);
1279 /* 4: attach the new split container to the workspace */
1280 DLOG("Attaching new split to ws\n");
1281 con_attach(new, con, false);
1284 con_focus(old_focused);
1286 tree_flatten(croot);
1288 con_force_split_parents_redraw(con);
1292 if (layout == L_DEFAULT) {
1293 /* Special case: the layout formerly known as "default" (in combination
1294 * with an orientation). Since we switched to splith/splitv layouts,
1295 * using the "default" layout (which "only" should happen when using
1296 * legacy configs) is using the last split layout (either splith or
1297 * splitv) in order to still do the same thing.
1299 * Starting from v4.6 though, we will nag users about using "layout
1300 * default", and in v4.9 we will remove it entirely (with an
1301 * appropriate i3-migrate-config mechanism). */
1302 con->layout = con->last_split_layout;
1303 /* In case last_split_layout was not initialized… */
1304 if (con->layout == L_DEFAULT)
1305 con->layout = L_SPLITH;
1307 con->layout = layout;
1309 con_force_split_parents_redraw(con);
1313 * This function toggles the layout of a given container. toggle_mode can be
1314 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1315 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1319 void con_toggle_layout(Con *con, const char *toggle_mode) {
1321 /* Users can focus workspaces, but not any higher in the hierarchy.
1322 * Focus on the workspace is a special case, since in every other case, the
1323 * user means "change the layout of the parent split container". */
1324 if (con->type != CT_WORKSPACE)
1325 parent = con->parent;
1326 DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1328 if (strcmp(toggle_mode, "split") == 0) {
1329 /* Toggle between splits. When the current layout is not a split
1330 * layout, we just switch back to last_split_layout. Otherwise, we
1331 * change to the opposite split layout. */
1332 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV)
1333 con_set_layout(con, parent->last_split_layout);
1335 if (parent->layout == L_SPLITH)
1336 con_set_layout(con, L_SPLITV);
1338 con_set_layout(con, L_SPLITH);
1341 if (parent->layout == L_STACKED)
1342 con_set_layout(con, L_TABBED);
1343 else if (parent->layout == L_TABBED) {
1344 if (strcmp(toggle_mode, "all") == 0)
1345 con_set_layout(con, L_SPLITH);
1347 con_set_layout(con, parent->last_split_layout);
1348 } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1349 if (strcmp(toggle_mode, "all") == 0) {
1350 /* When toggling through all modes, we toggle between
1351 * splith/splitv, whereas normally we just directly jump to
1353 if (parent->layout == L_SPLITH)
1354 con_set_layout(con, L_SPLITV);
1356 con_set_layout(con, L_STACKED);
1358 con_set_layout(con, L_STACKED);
1365 * Callback which will be called when removing a child from the given con.
1366 * Kills the container if it is empty and replaces it with the child if there
1367 * is exactly one child.
1370 static void con_on_remove_child(Con *con) {
1371 DLOG("on_remove_child\n");
1373 /* Every container 'above' (in the hierarchy) the workspace content should
1374 * not be closed when the last child was removed */
1375 if (con->type == CT_OUTPUT ||
1376 con->type == CT_ROOT ||
1377 con->type == CT_DOCKAREA ||
1378 (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1379 DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1383 /* For workspaces, close them only if they're not visible anymore */
1384 if (con->type == CT_WORKSPACE) {
1385 if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1386 LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1387 tree_close(con, DONT_KILL_WINDOW, false, false);
1388 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
1393 con_force_split_parents_redraw(con);
1394 con->urgent = con_has_urgent_child(con);
1395 con_update_parents_urgency(con);
1397 /* TODO: check if this container would swallow any other client and
1398 * don’t close it automatically. */
1399 int children = con_num_children(con);
1400 if (children == 0) {
1401 DLOG("Container empty, closing\n");
1402 tree_close(con, DONT_KILL_WINDOW, false, false);
1408 * Determines the minimum size of the given con by looking at its children (for
1409 * split/stacked/tabbed cons). Will be called when resizing floating cons
1412 Rect con_minimum_size(Con *con) {
1413 DLOG("Determining minimum size for con %p\n", con);
1415 if (con_is_leaf(con)) {
1416 DLOG("leaf node, returning 75x50\n");
1417 return (Rect) {0, 0, 75, 50};
1420 if (con->type == CT_FLOATING_CON) {
1421 DLOG("floating con\n");
1422 Con *child = TAILQ_FIRST(&(con->nodes_head));
1423 return con_minimum_size(child);
1426 if (con->layout == L_STACKED || con->layout == L_TABBED) {
1427 uint32_t max_width = 0, max_height = 0, deco_height = 0;
1429 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1430 Rect min = con_minimum_size(child);
1431 deco_height += child->deco_rect.height;
1432 max_width = max(max_width, min.width);
1433 max_height = max(max_height, min.height);
1435 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1436 max_width, max_height, deco_height);
1437 return (Rect) {0, 0, max_width, max_height + deco_height};
1440 /* For horizontal/vertical split containers we sum up the width (h-split)
1441 * or height (v-split) and use the maximum of the height (h-split) or width
1442 * (v-split) as minimum size. */
1443 if (con_is_split(con)) {
1444 uint32_t width = 0, height = 0;
1446 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1447 Rect min = con_minimum_size(child);
1448 if (con->layout == L_SPLITH) {
1450 height = max(height, min.height);
1452 height += min.height;
1453 width = max(width, min.width);
1456 DLOG("split container, returning width = %d x height = %d\n", width, height);
1457 return (Rect) {0, 0, width, height};
1460 ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1461 con->type, con->layout, con_is_split(con));
1466 * Returns true if changing the focus to con would be allowed considering
1467 * the fullscreen focus constraints. Specifically, if a fullscreen container or
1468 * any of its descendants is focused, this function returns true if and only if
1469 * focusing con would mean that focus would still be visible on screen, i.e.,
1470 * the newly focused container would not be obscured by a fullscreen container.
1472 * In the simplest case, if a fullscreen container or any of its descendants is
1473 * fullscreen, this functions returns true if con is the fullscreen container
1474 * itself or any of its descendants, as this means focus wouldn't escape the
1475 * boundaries of the fullscreen container.
1477 * In case the fullscreen container is of type CF_OUTPUT, this function returns
1478 * true if con is on a different workspace, as focus wouldn't be obscured by
1479 * the fullscreen container that is constrained to a different workspace.
1481 * Note that this same logic can be applied to moving containers. If a
1482 * container can be focused under the fullscreen focus constraints, it can also
1483 * become a parent or sibling to the currently focused container.
1486 bool con_fullscreen_permits_focusing(Con *con) {
1487 /* No focus, no problem. */
1491 /* Find the first fullscreen ascendent. */
1493 while (fs && fs->fullscreen_mode == CF_NONE)
1496 /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1497 * there always has to be a workspace con in the hierarchy. */
1499 /* The most common case is we hit the workspace level. In this
1500 * situation, changing focus is also harmless. */
1501 assert(fs->fullscreen_mode != CF_NONE);
1502 if (fs->type == CT_WORKSPACE)
1505 /* Allow it if the container itself is the fullscreen container. */
1509 /* If fullscreen is per-output, the focus being in a different workspace is
1510 * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1511 if (fs->fullscreen_mode == CF_OUTPUT &&
1512 con_get_workspace(con) != con_get_workspace(fs)) {
1516 /* Allow it only if the container to be focused is contained within the
1517 * current fullscreen container. */
1519 if (con->parent == fs)
1524 /* Focusing con would hide it behind a fullscreen window, disallow it. */
1530 * Checks if the given container has an urgent child.
1533 bool con_has_urgent_child(Con *con) {
1536 if (con_is_leaf(con))
1539 /* We are not interested in floating windows since they can only be
1540 * attached to a workspace → nodes_head instead of focus_head */
1541 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1542 if (con_has_urgent_child(child))
1550 * Make all parent containers urgent if con is urgent or clear the urgent flag
1551 * of all parent containers if there are no more urgent children left.
1554 void con_update_parents_urgency(Con *con) {
1555 Con *parent = con->parent;
1557 bool new_urgency_value = con->urgent;
1558 while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
1559 if (new_urgency_value) {
1560 parent->urgent = true;
1562 /* We can only reset the urgency when the parent
1563 * has no other urgent children */
1564 if (!con_has_urgent_child(parent))
1565 parent->urgent = false;
1567 parent = parent->parent;
1572 * Set urgency flag to the container, all the parent containers and the workspace.
1575 void con_set_urgency(Con *con, bool urgent) {
1576 if (focused == con) {
1577 DLOG("Ignoring urgency flag for current client\n");
1578 con->window->urgent.tv_sec = 0;
1579 con->window->urgent.tv_usec = 0;
1583 if (con->urgency_timer == NULL) {
1584 con->urgent = urgent;
1586 DLOG("Discarding urgency WM_HINT because timer is running\n");
1591 gettimeofday(&con->window->urgent, NULL);
1593 con->window->urgent.tv_sec = 0;
1594 con->window->urgent.tv_usec = 0;
1598 con_update_parents_urgency(con);
1600 if (con->urgent == urgent)
1601 LOG("Urgency flag changed to %d\n", con->urgent);
1604 /* Set the urgency flag on the workspace, if a workspace could be found
1605 * (for dock clients, that is not the case). */
1606 if ((ws = con_get_workspace(con)) != NULL)
1607 workspace_update_urgent_flag(ws);
1611 * Create a string representing the subtree under con.
1614 char *con_get_tree_representation(Con *con) {
1615 /* this code works as follows:
1616 * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
1617 * 2) append the tree representation of the children to the string
1618 * 3) add closing bracket
1620 * The recursion ends when we hit a leaf, in which case we return the
1621 * class_instance of the contained window.
1624 /* end of recursion */
1625 if (con_is_leaf(con)) {
1627 return sstrdup("nowin");
1629 if (!con->window->class_instance)
1630 return sstrdup("noinstance");
1632 return sstrdup(con->window->class_instance);
1636 /* 1) add the Layout type to buf */
1637 if (con->layout == L_DEFAULT)
1638 buf = sstrdup("D[");
1639 else if (con->layout == L_SPLITV)
1640 buf = sstrdup("V[");
1641 else if (con->layout == L_SPLITH)
1642 buf = sstrdup("H[");
1643 else if (con->layout == L_TABBED)
1644 buf = sstrdup("T[");
1645 else if (con->layout == L_STACKED)
1646 buf = sstrdup("S[");
1648 ELOG("BUG: Code not updated to account for new layout type\n");
1652 /* 2) append representation of children */
1654 TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1655 char *child_txt = con_get_tree_representation(child);
1658 sasprintf(&tmp_buf, "%s%s%s", buf,
1659 (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
1664 /* 3) close the brackets */
1666 sasprintf(&complete_buf, "%s]", buf);
1669 return complete_buf;