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) {
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 initializes the data structures and creates the appropriate
48 * X11 IDs using x_con_init().
51 Con *con_new(Con *parent, i3Window *window) {
52 Con *new = scalloc(sizeof(Con));
53 new->on_remove_child = con_on_remove_child;
54 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
57 new->border_style = config.default_border;
58 new->current_border_width = -1;
60 DLOG("opening window %d\n", cnt);
62 /* TODO: remove window coloring after test-phase */
63 DLOG("color %s\n", colors[cnt]);
64 new->name = strdup(colors[cnt]);
65 //uint32_t cp = get_colorpixel(colors[cnt]);
67 if ((cnt % (sizeof(colors) / sizeof(char*))) == 0)
70 x_con_init(new, window->depth);
72 x_con_init(new, XCB_COPY_FROM_PARENT);
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);
86 * Attaches the given container to the given parent. This happens when moving
87 * a container or when inserting a new container at a specific place in the
90 * ignore_focus is to just insert the Con at the end (useful when creating a
91 * new split container *around* some containers, that is, detaching and
92 * attaching them in order without wanting to mess with the focus in between).
95 void con_attach(Con *con, Con *parent, bool ignore_focus) {
99 struct nodes_head *nodes_head = &(parent->nodes_head);
100 struct focus_head *focus_head = &(parent->focus_head);
102 /* Workspaces are handled differently: they need to be inserted at the
104 if (con->type == CT_WORKSPACE) {
105 DLOG("it's a workspace. num = %d\n", con->num);
106 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
107 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
109 current = TAILQ_FIRST(nodes_head);
110 if (con->num < current->num) {
111 /* we need to insert the container at the beginning */
112 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
114 while (current->num != -1 && con->num > current->num) {
115 current = TAILQ_NEXT(current, nodes);
116 if (current == TAILQ_END(nodes_head)) {
121 /* we need to insert con after current, if current is not NULL */
123 TAILQ_INSERT_BEFORE(current, con, nodes);
124 else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
127 goto add_to_focus_head;
130 if (con->type == CT_FLOATING_CON) {
131 DLOG("Inserting into floating containers\n");
132 TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
135 /* Get the first tiling container in focus stack */
136 TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
137 if (loop->type == CT_FLOATING_CON)
144 /* When the container is not a split container (but contains a window)
145 * and is attached to a workspace, we check if the user configured a
146 * workspace_layout. This is done in workspace_attach_to, which will
147 * provide us with the container to which we should attach (either the
148 * workspace or a new split container with the configured
151 if (con->window != NULL &&
152 parent->type == CT_WORKSPACE &&
153 parent->workspace_layout != L_DEFAULT) {
154 DLOG("Parent is a workspace. Applying default layout...\n");
155 Con *target = workspace_attach_to(parent);
157 /* Attach the original con to this new split con instead */
158 nodes_head = &(target->nodes_head);
159 focus_head = &(target->focus_head);
160 con->parent = target;
166 /* Insert the container after the tiling container, if found.
167 * When adding to a CT_OUTPUT, just append one after another. */
168 if (current && parent->type != CT_OUTPUT) {
169 DLOG("Inserting con = %p after last focused tiling con %p\n",
171 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
172 } else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
176 /* We insert to the TAIL because con_focus() will correct this.
177 * This way, we have the option to insert Cons without having
179 TAILQ_INSERT_TAIL(focus_head, con, focused);
180 con_force_split_parents_redraw(con);
184 * Detaches the given container from its current parent
187 void con_detach(Con *con) {
188 con_force_split_parents_redraw(con);
189 if (con->type == CT_FLOATING_CON) {
190 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
191 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
193 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
194 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
199 * Sets input focus to the given container. Will be updated in X11 in the next
200 * run of x_push_changes().
203 void con_focus(Con *con) {
205 DLOG("con_focus = %p\n", con);
207 /* 1: set focused-pointer to the new con */
208 /* 2: exchange the position of the container in focus stack of the parent all the way up */
209 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
210 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
211 if (con->parent->parent != NULL)
212 con_focus(con->parent);
215 /* We can't blindly reset non-leaf containers since they might have
216 * other urgent children. Therefore we only reset leafs and propagate
217 * the changes upwards via con_update_parents_urgency() which does proper
218 * checks before resetting the urgency.
220 if (con->urgent && con_is_leaf(con)) {
222 con_update_parents_urgency(con);
223 workspace_update_urgent_flag(con_get_workspace(con));
228 * Returns true when this node is a leaf node (has no children)
231 bool con_is_leaf(Con *con) {
232 return TAILQ_EMPTY(&(con->nodes_head));
236 * Returns true if this node accepts a window (if the node swallows windows,
237 * it might already have swallowed enough and cannot hold any more).
240 bool con_accepts_window(Con *con) {
241 /* 1: workspaces never accept direct windows */
242 if (con->type == CT_WORKSPACE)
246 DLOG("container %p does not accept windows, it is a split container.\n", con);
250 /* TODO: if this is a swallowing container, we need to check its max_clients */
251 return (con->window == NULL);
255 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
259 Con *con_get_output(Con *con) {
261 while (result != NULL && result->type != CT_OUTPUT)
262 result = result->parent;
263 /* We must be able to get an output because focus can never be set higher
264 * in the tree (root node cannot be focused). */
265 assert(result != NULL);
270 * Gets the workspace container this node is on.
273 Con *con_get_workspace(Con *con) {
275 while (result != NULL && result->type != CT_WORKSPACE)
276 result = result->parent;
281 * Searches parenst of the given 'con' until it reaches one with the specified
282 * 'orientation'. Aborts when it comes across a floating_con.
285 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
286 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
287 Con *parent = con->parent;
288 if (parent->type == CT_FLOATING_CON)
290 while (con_orientation(parent) != orientation) {
291 DLOG("Need to go one level further up\n");
292 parent = parent->parent;
293 /* Abort when we reach a floating con, or an output con */
295 (parent->type == CT_FLOATING_CON ||
296 parent->type == CT_OUTPUT ||
297 (parent->parent && parent->parent->type == CT_OUTPUT)))
302 DLOG("Result: %p\n", parent);
307 * helper data structure for the breadth-first-search in
308 * con_get_fullscreen_con()
314 TAILQ_ENTRY(bfs_entry) entries;
318 * Returns the first fullscreen node below this node.
321 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode) {
322 Con *current, *child;
324 /* TODO: is breadth-first-search really appropriate? (check as soon as
325 * fullscreen levels and fullscreen for containers is implemented) */
326 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
327 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
329 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
331 while (!TAILQ_EMPTY(&bfs_head)) {
332 entry = TAILQ_FIRST(&bfs_head);
333 current = entry->con;
334 if (current != con && current->fullscreen_mode == fullscreen_mode) {
335 /* empty the queue */
336 while (!TAILQ_EMPTY(&bfs_head)) {
337 entry = TAILQ_FIRST(&bfs_head);
338 TAILQ_REMOVE(&bfs_head, entry, entries);
344 TAILQ_REMOVE(&bfs_head, entry, entries);
347 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
348 entry = smalloc(sizeof(struct bfs_entry));
350 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
353 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
354 entry = smalloc(sizeof(struct bfs_entry));
356 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
364 * Returns true if the container is internal, such as __i3_scratch
367 bool con_is_internal(Con *con) {
368 return (con->name[0] == '_' && con->name[1] == '_');
372 * Returns true if the node is floating.
375 bool con_is_floating(Con *con) {
377 DLOG("checking if con %p is floating\n", con);
378 return (con->floating >= FLOATING_AUTO_ON);
382 * Checks if the given container is either floating or inside some floating
383 * container. It returns the FLOATING_CON container.
386 Con *con_inside_floating(Con *con) {
388 if (con->type == CT_FLOATING_CON)
391 if (con->floating >= FLOATING_AUTO_ON)
394 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
397 return con_inside_floating(con->parent);
401 * Checks if the given container is inside a focused container.
404 bool con_inside_focused(Con *con) {
409 return con_inside_focused(con->parent);
413 * Returns the container with the given client window ID or NULL if no such
417 Con *con_by_window_id(xcb_window_t window) {
419 TAILQ_FOREACH(con, &all_cons, all_cons)
420 if (con->window != NULL && con->window->id == window)
426 * Returns the container with the given frame ID or NULL if no such container
430 Con *con_by_frame_id(xcb_window_t frame) {
432 TAILQ_FOREACH(con, &all_cons, all_cons)
433 if (con->frame == frame)
439 * Returns the first container below 'con' which wants to swallow this window
443 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
446 //DLOG("searching con for window %p starting at con %p\n", window, con);
447 //DLOG("class == %s\n", window->class_class);
449 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
450 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
451 if (!match_matches_window(match, window))
453 if (store_match != NULL)
454 *store_match = match;
457 Con *result = con_for_window(child, window, store_match);
462 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
463 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
464 if (!match_matches_window(match, window))
466 if (store_match != NULL)
467 *store_match = match;
470 Con *result = con_for_window(child, window, store_match);
479 * Returns the number of children of this container.
482 int con_num_children(Con *con) {
486 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
493 * Updates the percent attribute of the children of the given container. This
494 * function needs to be called when a window is added or removed from a
498 void con_fix_percent(Con *con) {
500 int children = con_num_children(con);
502 // calculate how much we have distributed and how many containers
503 // with a percentage set we have
505 int children_with_percent = 0;
506 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
507 if (child->percent > 0.0) {
508 total += child->percent;
509 ++children_with_percent;
513 // if there were children without a percentage set, set to a value that
514 // will make those children proportional to all others
515 if (children_with_percent != children) {
516 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
517 if (child->percent <= 0.0) {
518 if (children_with_percent == 0)
519 total += (child->percent = 1.0);
520 else total += (child->percent = total / children_with_percent);
525 // if we got a zero, just distribute the space equally, otherwise
526 // distribute according to the proportions we got
528 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
529 child->percent = 1.0 / children;
530 } else if (total != 1.0) {
531 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
532 child->percent /= total;
537 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
538 * entered when there already is a fullscreen container on this workspace.
541 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
542 Con *workspace, *fullscreen;
544 if (con->type == CT_WORKSPACE) {
545 DLOG("You cannot make a workspace fullscreen.\n");
549 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
550 if (con->fullscreen_mode == CF_NONE) {
551 /* 1: check if there already is a fullscreen con */
552 if (fullscreen_mode == CF_GLOBAL)
553 fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
555 workspace = con_get_workspace(con);
556 fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
558 if (fullscreen != NULL) {
559 /* Disable fullscreen for the currently fullscreened
560 * container and enable it for the one the user wants
561 * to have in fullscreen mode. */
562 LOG("Disabling fullscreen for (%p/%s) upon user request\n",
563 fullscreen, fullscreen->name);
564 fullscreen->fullscreen_mode = CF_NONE;
567 /* 2: enable fullscreen */
568 con->fullscreen_mode = fullscreen_mode;
570 /* 1: disable fullscreen */
571 con->fullscreen_mode = CF_NONE;
574 DLOG("mode now: %d\n", con->fullscreen_mode);
576 /* update _NET_WM_STATE if this container has a window */
577 /* TODO: when a window is assigned to a container which is already
578 * fullscreened, this state needs to be pushed to the client, too */
579 if (con->window == NULL)
583 unsigned int num = 0;
585 if (con->fullscreen_mode != CF_NONE)
586 values[num++] = A__NET_WM_STATE_FULLSCREEN;
588 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
589 A__NET_WM_STATE, XCB_ATOM_ATOM, 32, num, values);
593 * Moves the given container to the currently focused container on the given
596 * The fix_coordinates flag will translate the current coordinates (offset from
597 * the monitor position basically) to appropriate coordinates on the
598 * destination workspace.
599 * Not enabling this behaviour comes in handy when this function gets called by
600 * floating_maybe_reassign_ws, which will only "move" a floating window when it
601 * *already* changed its coordinates to a different output.
603 * The dont_warp flag disables pointer warping and will be set when this
604 * function is called while dragging a floating window.
606 * TODO: is there a better place for this function?
609 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp) {
610 if (con->type == CT_WORKSPACE) {
611 DLOG("Moving workspaces is not yet implemented.\n");
615 /* Prevent moving if this would violate the fullscreen focus restrictions. */
616 if (!con_fullscreen_permits_focusing(workspace)) {
617 LOG("Cannot move out of a fullscreen container");
621 if (con_is_floating(con)) {
622 DLOG("Using FLOATINGCON instead\n");
626 Con *source_ws = con_get_workspace(con);
627 if (workspace == source_ws) {
628 DLOG("Not moving, already there\n");
632 /* Save the current workspace. So we can call workspace_show() by the end
633 * of this function. */
634 Con *current_ws = con_get_workspace(focused);
636 Con *source_output = con_get_output(con),
637 *dest_output = con_get_output(workspace);
639 /* 1: save the container which is going to be focused after the current
640 * container is moved away */
641 Con *focus_next = con_next_focused(con);
643 /* 2: get the focused container of this workspace */
644 Con *next = con_descend_focused(workspace);
646 /* 3: we go up one level, but only when next is a normal container */
647 if (next->type != CT_WORKSPACE) {
648 DLOG("next originally = %p / %s / type %d\n", next, next->name, next->type);
652 /* 4: if the target container is floating, we get the workspace instead.
653 * Only tiling windows need to get inserted next to the current container.
655 Con *floatingcon = con_inside_floating(next);
656 if (floatingcon != NULL) {
657 DLOG("floatingcon, going up even further\n");
658 next = floatingcon->parent;
661 if (con->type == CT_FLOATING_CON) {
662 Con *ws = con_get_workspace(next);
663 DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
667 if (source_output != dest_output) {
668 /* Take the relative coordinates of the current output, then add them
669 * to the coordinate space of the correct output */
670 if (fix_coordinates && con->type == CT_FLOATING_CON) {
671 floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
672 } else DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
674 /* If moving to a visible workspace, call show so it can be considered
675 * focused. Must do before attaching because workspace_show checks to see
676 * if focused container is in its area. */
677 if (workspace_is_visible(workspace)) {
678 workspace_show(workspace);
680 /* Don’t warp if told so (when dragging floating windows with the
681 * mouse for example) */
685 x_set_warp_to(&(con->rect));
689 DLOG("Re-attaching container to %p / %s\n", next, next->name);
690 /* 5: re-attach the con to the parent of this focused container */
691 Con *parent = con->parent;
693 con_attach(con, next, false);
695 /* 6: fix the percentages */
696 con_fix_percent(parent);
698 con_fix_percent(next);
700 /* 7: focus the con on the target workspace (the X focus is only updated by
701 * calling tree_render(), so for the "real" focus this is a no-op).
702 * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
703 * we don’t focus when there is a fullscreen con on that workspace. */
704 if (!con_is_internal(workspace) &&
705 con_get_fullscreen_con(workspace, CF_OUTPUT) == NULL)
706 con_focus(con_descend_focused(con));
708 /* 8: when moving to a visible workspace on a different output, we keep the
709 * con focused. Otherwise, we leave the focus on the current workspace as we
710 * don’t want to focus invisible workspaces */
711 if (source_output != dest_output &&
712 workspace_is_visible(workspace) &&
713 !con_is_internal(workspace)) {
714 DLOG("Moved to a different output, focusing target\n");
716 /* Descend focus stack in case focus_next is a workspace which can
717 * occur if we move to the same workspace. Also show current workspace
718 * to ensure it is focused. */
719 workspace_show(current_ws);
721 /* Set focus only if con was on current workspace before moving.
722 * Otherwise we would give focus to some window on different workspace. */
723 if (source_ws == current_ws)
724 con_focus(con_descend_focused(focus_next));
727 CALL(parent, on_remove_child);
731 * Returns the orientation of the given container (for stacked containers,
732 * vertical orientation is used regardless of the actual orientation of the
736 int con_orientation(Con *con) {
737 switch (con->layout) {
739 /* stacking containers behave like they are in vertical orientation */
744 /* tabbed containers behave like they are in vertical orientation */
749 DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
755 DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
760 DLOG("con_orientation() ran into default\n");
766 * Returns the container which will be focused next when the given container
767 * is not available anymore. Called in tree_close and con_move_to_workspace
768 * to properly restore focus.
771 Con *con_next_focused(Con *con) {
773 /* floating containers are attached to a workspace, so we focus either the
774 * next floating container (if any) or the workspace itself. */
775 if (con->type == CT_FLOATING_CON) {
776 DLOG("selecting next for CT_FLOATING_CON\n");
777 next = TAILQ_NEXT(con, floating_windows);
778 DLOG("next = %p\n", next);
780 next = TAILQ_PREV(con, floating_head, floating_windows);
781 DLOG("using prev, next = %p\n", next);
784 Con *ws = con_get_workspace(con);
786 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
787 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
788 next = TAILQ_FIRST(&(next->focus_head));
790 DLOG("skipping container itself, we want the next client\n");
791 next = TAILQ_NEXT(next, focused);
794 if (next == TAILQ_END(&(ws->focus_head))) {
795 DLOG("Focus list empty, returning ws\n");
799 /* Instead of returning the next CT_FLOATING_CON, we descend it to
800 * get an actual window to focus. */
801 next = con_descend_focused(next);
806 /* dock clients cannot be focused, so we focus the workspace instead */
807 if (con->parent->type == CT_DOCKAREA) {
808 DLOG("selecting workspace for dock client\n");
809 return con_descend_focused(output_get_content(con->parent->parent));
812 /* if 'con' is not the first entry in the focus stack, use the first one as
813 * it’s currently focused already */
814 Con *first = TAILQ_FIRST(&(con->parent->focus_head));
816 DLOG("Using first entry %p\n", first);
819 /* try to focus the next container on the same level as this one or fall
820 * back to its parent */
821 if (!(next = TAILQ_NEXT(con, focused)))
825 /* now go down the focus stack as far as
826 * possible, excluding the current container */
827 while (!TAILQ_EMPTY(&(next->focus_head)) &&
828 TAILQ_FIRST(&(next->focus_head)) != con)
829 next = TAILQ_FIRST(&(next->focus_head));
835 * Get the next/previous container in the specified orientation. This may
836 * travel up until it finds a container with suitable orientation.
839 Con *con_get_next(Con *con, char way, orientation_t orientation) {
840 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
841 /* 1: get the first parent with the same orientation */
843 while (con_orientation(cur->parent) != orientation) {
844 DLOG("need to go one level further up\n");
845 if (cur->parent->type == CT_WORKSPACE) {
846 LOG("that's a workspace, we can't go further up\n");
852 /* 2: chose next (or previous) */
855 next = TAILQ_NEXT(cur, nodes);
856 /* if we are at the end of the list, we need to wrap */
857 if (next == TAILQ_END(&(parent->nodes_head)))
860 next = TAILQ_PREV(cur, nodes_head, nodes);
861 /* if we are at the end of the list, we need to wrap */
862 if (next == TAILQ_END(&(cur->nodes_head)))
865 DLOG("next = %p\n", next);
871 * Returns the focused con inside this client, descending the tree as far as
872 * possible. This comes in handy when attaching a con to a workspace at the
873 * currently focused position, for example.
876 Con *con_descend_focused(Con *con) {
878 while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
879 next = TAILQ_FIRST(&(next->focus_head));
884 * Returns the focused con inside this client, descending the tree as far as
885 * possible. This comes in handy when attaching a con to a workspace at the
886 * currently focused position, for example.
888 * Works like con_descend_focused but considers only tiling cons.
891 Con *con_descend_tiling_focused(Con *con) {
899 TAILQ_FOREACH(child, &(next->focus_head), focused) {
900 if (child->type == CT_FLOATING_CON)
906 } while (before != next && next != focused);
911 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
912 * direction is D_LEFT, then we return the rightmost container and if direction
913 * is D_RIGHT, we return the leftmost container. This is because if we are
914 * moving D_LEFT, and thus want the rightmost container.
917 Con *con_descend_direction(Con *con, direction_t direction) {
919 int orientation = con_orientation(con);
920 DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
921 if (direction == D_LEFT || direction == D_RIGHT) {
922 if (orientation == HORIZ) {
923 /* If the direction is horizontal, we can use either the first
924 * (D_RIGHT) or the last con (D_LEFT) */
925 if (direction == D_RIGHT)
926 most = TAILQ_FIRST(&(con->nodes_head));
927 else most = TAILQ_LAST(&(con->nodes_head), nodes_head);
928 } else if (orientation == VERT) {
929 /* Wrong orientation. We use the last focused con. Within that con,
930 * we recurse to chose the left/right con or at least the last
932 most = TAILQ_FIRST(&(con->focus_head));
934 /* If the con has no orientation set, it’s not a split container
935 * but a container with a client window, so stop recursing */
940 if (direction == D_UP || direction == D_DOWN) {
941 if (orientation == VERT) {
942 /* If the direction is vertical, we can use either the first
943 * (D_DOWN) or the last con (D_UP) */
944 if (direction == D_UP)
945 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
946 else most = TAILQ_FIRST(&(con->nodes_head));
947 } else if (orientation == HORIZ) {
948 /* Wrong orientation. We use the last focused con. Within that con,
949 * we recurse to chose the top/bottom con or at least the last
951 most = TAILQ_FIRST(&(con->focus_head));
953 /* If the con has no orientation set, it’s not a split container
954 * but a container with a client window, so stop recursing */
961 return con_descend_direction(most, direction);
965 * Returns a "relative" Rect which contains the amount of pixels that need to
966 * be added to the original Rect to get the final position (obviously the
967 * amount of pixels for normal, 1pixel and borderless are different).
970 Rect con_border_style_rect(Con *con) {
971 adjacent_t borders_to_hide = ADJ_NONE;
972 int border_width = con->current_border_width;
973 DLOG("The border width for con is set to: %d\n", con->current_border_width);
975 if (con->current_border_width < 0)
976 border_width = config.default_border_width;
977 DLOG("Effective border width is set to: %d\n", border_width);
978 /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
979 int border_style = con_border_style(con);
980 if (border_style == BS_NONE)
981 return (Rect){ 0, 0, 0, 0 };
982 borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
983 if (border_style == BS_NORMAL) {
984 result = (Rect){border_width, 0 , -(2 * border_width), -(border_width)};
986 result = (Rect){border_width, border_width, -(2 * border_width), -(2 * border_width)};
988 if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
989 result.x -= border_width;
990 result.width += border_width;
992 if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
993 result.width += border_width;
995 if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
996 result.y -= border_width;
997 result.height += border_width;
999 if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1000 result.height += border_width;
1007 * Returns adjacent borders of the window. We need this if hide_edge_borders is
1010 adjacent_t con_adjacent_borders(Con *con) {
1011 adjacent_t result = ADJ_NONE;
1012 Con *workspace = con_get_workspace(con);
1013 if (con->rect.x == workspace->rect.x)
1014 result |= ADJ_LEFT_SCREEN_EDGE;
1015 if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1016 result |= ADJ_RIGHT_SCREEN_EDGE;
1017 if (con->rect.y == workspace->rect.y)
1018 result |= ADJ_UPPER_SCREEN_EDGE;
1019 if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1020 result |= ADJ_LOWER_SCREEN_EDGE;
1025 * Use this function to get a container’s border style. This is important
1026 * because when inside a stack, the border style is always BS_NORMAL.
1027 * For tabbed mode, the same applies, with one exception: when the container is
1028 * borderless and the only element in the tabbed container, the border is not
1031 * For children of a CT_DOCKAREA, the border style is always none.
1034 int con_border_style(Con *con) {
1035 Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1037 DLOG("this one is fullscreen! overriding BS_NONE\n");
1041 if (con->parent->layout == L_STACKED)
1042 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1044 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1045 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1047 if (con->parent->type == CT_DOCKAREA)
1050 return con->border_style;
1054 * Sets the given border style on con, correctly keeping the position/size of a
1058 void con_set_border_style(Con *con, int border_style, int border_width) {
1059 /* Handle the simple case: non-floating containerns */
1060 if (!con_is_floating(con)) {
1061 con->border_style = border_style;
1062 con->current_border_width = border_width;
1066 /* For floating containers, we want to keep the position/size of the
1067 * *window* itself. We first add the border pixels to con->rect to make
1068 * con->rect represent the absolute position of the window. Then, we change
1069 * the border and subtract the new border pixels. Afterwards, we update
1070 * parent->rect to contain con. */
1071 DLOG("This is a floating container\n");
1073 Rect bsr = con_border_style_rect(con);
1074 con->rect.x += bsr.x;
1075 con->rect.y += bsr.y;
1076 con->rect.width += bsr.width;
1077 con->rect.height += bsr.height;
1079 /* Change the border style, get new border/decoration values. */
1080 con->border_style = border_style;
1081 con->current_border_width = border_width;
1082 bsr = con_border_style_rect(con);
1084 (con->border_style == BS_NORMAL ? config.font.height + 5 : 0);
1086 con->rect.x -= bsr.x;
1087 con->rect.y -= bsr.y;
1088 con->rect.width -= bsr.width;
1089 con->rect.height -= bsr.height;
1091 Con *parent = con->parent;
1092 parent->rect.x = con->rect.x;
1093 parent->rect.y = con->rect.y - deco_height;
1094 parent->rect.width = con->rect.width;
1095 parent->rect.height = con->rect.height + deco_height;
1099 * This function changes the layout of a given container. Use it to handle
1100 * special cases like changing a whole workspace to stacked/tabbed (creates a
1101 * new split container before).
1104 void con_set_layout(Con *con, int layout) {
1105 DLOG("con_set_layout(%p, %d), con->type = %d\n",
1106 con, layout, con->type);
1108 /* Users can focus workspaces, but not any higher in the hierarchy.
1109 * Focus on the workspace is a special case, since in every other case, the
1110 * user means "change the layout of the parent split container". */
1111 if (con->type != CT_WORKSPACE)
1114 /* We fill in last_split_layout when switching to a different layout
1115 * since there are many places in the code that don’t use
1116 * con_set_layout(). */
1117 if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1118 con->last_split_layout = con->layout;
1120 /* When the container type is CT_WORKSPACE, the user wants to change the
1121 * whole workspace into stacked/tabbed mode. To do this and still allow
1122 * intuitive operations (like level-up and then opening a new window), we
1123 * need to create a new split container. */
1124 if (con->type == CT_WORKSPACE &&
1125 (layout == L_STACKED || layout == L_TABBED)) {
1126 if (con_num_children(con) == 0) {
1127 DLOG("Setting workspace_layout to %d\n", layout);
1128 con->workspace_layout = layout;
1130 DLOG("Creating new split container\n");
1131 /* 1: create a new split container */
1132 Con *new = con_new(NULL, NULL);
1135 /* 2: Set the requested layout on the split container and mark it as
1137 new->layout = layout;
1138 new->last_split_layout = con->last_split_layout;
1141 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1142 if (old_focused == TAILQ_END(&(con->focus_head)))
1145 /* 3: move the existing cons of this workspace below the new con */
1146 DLOG("Moving cons\n");
1148 while (!TAILQ_EMPTY(&(con->nodes_head))) {
1149 child = TAILQ_FIRST(&(con->nodes_head));
1151 con_attach(child, new, true);
1154 /* 4: attach the new split container to the workspace */
1155 DLOG("Attaching new split to ws\n");
1156 con_attach(new, con, false);
1159 con_focus(old_focused);
1161 tree_flatten(croot);
1163 con_force_split_parents_redraw(con);
1167 if (layout == L_DEFAULT) {
1168 /* Special case: the layout formerly known as "default" (in combination
1169 * with an orientation). Since we switched to splith/splitv layouts,
1170 * using the "default" layout (which "only" should happen when using
1171 * legacy configs) is using the last split layout (either splith or
1172 * splitv) in order to still do the same thing.
1174 * Starting from v4.6 though, we will nag users about using "layout
1175 * default", and in v4.9 we will remove it entirely (with an
1176 * appropriate i3-migrate-config mechanism). */
1177 con->layout = con->last_split_layout;
1178 /* In case last_split_layout was not initialized… */
1179 if (con->layout == L_DEFAULT)
1180 con->layout = L_SPLITH;
1182 con->layout = layout;
1184 con_force_split_parents_redraw(con);
1188 * This function toggles the layout of a given container. toggle_mode can be
1189 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1190 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1194 void con_toggle_layout(Con *con, const char *toggle_mode) {
1196 /* Users can focus workspaces, but not any higher in the hierarchy.
1197 * Focus on the workspace is a special case, since in every other case, the
1198 * user means "change the layout of the parent split container". */
1199 if (con->type != CT_WORKSPACE)
1200 parent = con->parent;
1201 DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1203 if (strcmp(toggle_mode, "split") == 0) {
1204 /* Toggle between splits. When the current layout is not a split
1205 * layout, we just switch back to last_split_layout. Otherwise, we
1206 * change to the opposite split layout. */
1207 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV)
1208 con_set_layout(con, parent->last_split_layout);
1210 if (parent->layout == L_SPLITH)
1211 con_set_layout(con, L_SPLITV);
1212 else con_set_layout(con, L_SPLITH);
1215 if (parent->layout == L_STACKED)
1216 con_set_layout(con, L_TABBED);
1217 else if (parent->layout == L_TABBED) {
1218 if (strcmp(toggle_mode, "all") == 0)
1219 con_set_layout(con, L_SPLITH);
1220 else con_set_layout(con, parent->last_split_layout);
1221 } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1222 if (strcmp(toggle_mode, "all") == 0) {
1223 /* When toggling through all modes, we toggle between
1224 * splith/splitv, whereas normally we just directly jump to
1226 if (parent->layout == L_SPLITH)
1227 con_set_layout(con, L_SPLITV);
1228 else con_set_layout(con, L_STACKED);
1230 con_set_layout(con, L_STACKED);
1237 * Callback which will be called when removing a child from the given con.
1238 * Kills the container if it is empty and replaces it with the child if there
1239 * is exactly one child.
1242 static void con_on_remove_child(Con *con) {
1243 DLOG("on_remove_child\n");
1245 /* Every container 'above' (in the hierarchy) the workspace content should
1246 * not be closed when the last child was removed */
1247 if (con->type == CT_OUTPUT ||
1248 con->type == CT_ROOT ||
1249 con->type == CT_DOCKAREA) {
1250 DLOG("not handling, type = %d\n", con->type);
1254 /* For workspaces, close them only if they're not visible anymore */
1255 if (con->type == CT_WORKSPACE) {
1256 if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1257 LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1258 tree_close(con, DONT_KILL_WINDOW, false, false);
1259 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
1264 con_force_split_parents_redraw(con);
1266 /* TODO: check if this container would swallow any other client and
1267 * don’t close it automatically. */
1268 int children = con_num_children(con);
1269 if (children == 0) {
1270 DLOG("Container empty, closing\n");
1271 tree_close(con, DONT_KILL_WINDOW, false, false);
1277 * Determines the minimum size of the given con by looking at its children (for
1278 * split/stacked/tabbed cons). Will be called when resizing floating cons
1281 Rect con_minimum_size(Con *con) {
1282 DLOG("Determining minimum size for con %p\n", con);
1284 if (con_is_leaf(con)) {
1285 DLOG("leaf node, returning 75x50\n");
1286 return (Rect){ 0, 0, 75, 50 };
1289 if (con->type == CT_FLOATING_CON) {
1290 DLOG("floating con\n");
1291 Con *child = TAILQ_FIRST(&(con->nodes_head));
1292 return con_minimum_size(child);
1295 if (con->layout == L_STACKED || con->layout == L_TABBED) {
1296 uint32_t max_width = 0, max_height = 0, deco_height = 0;
1298 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1299 Rect min = con_minimum_size(child);
1300 deco_height += child->deco_rect.height;
1301 max_width = max(max_width, min.width);
1302 max_height = max(max_height, min.height);
1304 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1305 max_width, max_height, deco_height);
1306 return (Rect){ 0, 0, max_width, max_height + deco_height };
1309 /* For horizontal/vertical split containers we sum up the width (h-split)
1310 * or height (v-split) and use the maximum of the height (h-split) or width
1311 * (v-split) as minimum size. */
1313 uint32_t width = 0, height = 0;
1315 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1316 Rect min = con_minimum_size(child);
1317 if (con->layout == L_SPLITH) {
1319 height = max(height, min.height);
1321 height += min.height;
1322 width = max(width, min.width);
1325 DLOG("split container, returning width = %d x height = %d\n", width, height);
1326 return (Rect){ 0, 0, width, height };
1329 ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1330 con->type, con->layout, con->split);
1335 * Returns true if changing the focus to con would be allowed considering
1336 * the fullscreen focus constraints. Specifically, if a fullscreen container or
1337 * any of its descendants is focused, this function returns true if and only if
1338 * focusing con would mean that focus would still be visible on screen, i.e.,
1339 * the newly focused container would not be obscured by a fullscreen container.
1341 * In the simplest case, if a fullscreen container or any of its descendants is
1342 * fullscreen, this functions returns true if con is the fullscreen container
1343 * itself or any of its descendants, as this means focus wouldn't escape the
1344 * boundaries of the fullscreen container.
1346 * In case the fullscreen container is of type CF_OUTPUT, this function returns
1347 * true if con is on a different workspace, as focus wouldn't be obscured by
1348 * the fullscreen container that is constrained to a different workspace.
1350 * Note that this same logic can be applied to moving containers. If a
1351 * container can be focused under the fullscreen focus constraints, it can also
1352 * become a parent or sibling to the currently focused container.
1355 bool con_fullscreen_permits_focusing(Con *con) {
1356 /* No focus, no problem. */
1360 /* Find the first fullscreen ascendent. */
1362 while (fs && fs->fullscreen_mode == CF_NONE)
1365 /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1366 * there always has to be a workspace con in the hierarchy. */
1368 /* The most common case is we hit the workspace level. In this
1369 * situation, changing focus is also harmless. */
1370 assert(fs->fullscreen_mode != CF_NONE);
1371 if (fs->type == CT_WORKSPACE)
1374 /* Allow it if the container itself is the fullscreen container. */
1378 /* If fullscreen is per-output, the focus being in a different workspace is
1379 * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1380 if (fs->fullscreen_mode == CF_OUTPUT &&
1381 con_get_workspace(con) != con_get_workspace(fs)) {
1385 /* Allow it only if the container to be focused is contained within the
1386 * current fullscreen container. */
1388 if (con->parent == fs)
1393 /* Focusing con would hide it behind a fullscreen window, disallow it. */
1399 * Checks if the given container has an urgent child.
1402 bool con_has_urgent_child(Con *con) {
1405 if (con_is_leaf(con))
1408 /* We are not interested in floating windows since they can only be
1409 * attached to a workspace → nodes_head instead of focus_head */
1410 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1411 if (con_has_urgent_child(child))
1419 * Make all parent containers urgent if con is urgent or clear the urgent flag
1420 * of all parent containers if there are no more urgent children left.
1423 void con_update_parents_urgency(Con *con) {
1424 Con *parent = con->parent;
1426 bool new_urgency_value = con->urgent;
1427 while (parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
1428 if (new_urgency_value) {
1429 parent->urgent = true;
1431 /* We can only reset the urgency when the parent
1432 * has no other urgent children */
1433 if (!con_has_urgent_child(parent))
1434 parent->urgent = false;
1436 parent = parent->parent;
1441 * Create a string representing the subtree under con.
1444 char *con_get_tree_representation(Con *con) {
1445 /* this code works as follows:
1446 * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
1447 * 2) append the tree representation of the children to the string
1448 * 3) add closing bracket
1450 * The recursion ends when we hit a leaf, in which case we return the
1451 * class_instance of the contained window.
1454 /* end of recursion */
1455 if (con_is_leaf(con)) {
1457 return sstrdup("nowin");
1459 if (!con->window->class_instance)
1460 return sstrdup("noinstance");
1462 return sstrdup(con->window->class_instance);
1466 /* 1) add the Layout type to buf */
1467 if (con->layout == L_DEFAULT)
1468 buf = sstrdup("D[");
1469 else if (con->layout == L_SPLITV)
1470 buf = sstrdup("V[");
1471 else if (con->layout == L_SPLITH)
1472 buf = sstrdup("H[");
1473 else if (con->layout == L_TABBED)
1474 buf = sstrdup("T[");
1475 else if (con->layout == L_STACKED)
1476 buf = sstrdup("S[");
1478 /* 2) append representation of children */
1480 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1481 char *child_txt = con_get_tree_representation(child);
1484 sasprintf(&tmp_buf, "%s%s%s", buf,
1485 (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
1490 /* 3) close the brackets */
1492 sasprintf(&complete_buf, "%s]", buf);
1495 return complete_buf;