2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2010 Michael Stapelberg and contributors (see also: LICENSE)
7 * con.c contains all functions which deal with containers directly (creating
8 * containers, searching containers, getting specific properties from
27 static void con_on_remove_child(Con *con);
30 * Create a new container (and attach it to the given parent, if not NULL).
31 * This function initializes the data structures and creates the appropriate
32 * X11 IDs using x_con_init().
35 Con *con_new(Con *parent) {
36 Con *new = scalloc(sizeof(Con));
37 new->on_remove_child = con_on_remove_child;
38 TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
40 new->border_style = config.default_border;
42 DLOG("opening window %d\n", cnt);
44 /* TODO: remove window coloring after test-phase */
45 DLOG("color %s\n", colors[cnt]);
46 new->name = strdup(colors[cnt]);
47 //uint32_t cp = get_colorpixel(colors[cnt]);
49 if ((cnt % (sizeof(colors) / sizeof(char*))) == 0)
54 // TODO: this needs to be integrated into src/x.c and updated on config file reloads
55 xcb_change_window_attributes(conn, new->frame, XCB_CW_BACK_PIXEL, &config.client.background);
57 TAILQ_INIT(&(new->floating_head));
58 TAILQ_INIT(&(new->nodes_head));
59 TAILQ_INIT(&(new->focus_head));
60 TAILQ_INIT(&(new->swallow_head));
63 con_attach(new, parent, false);
69 * Attaches the given container to the given parent. This happens when moving
70 * a container or when inserting a new container at a specific place in the
73 * ignore_focus is to just insert the Con at the end (useful when creating a
74 * new split container *around* some containers, that is, detaching and
75 * attaching them in order without wanting to mess with the focus in between).
78 void con_attach(Con *con, Con *parent, bool ignore_focus) {
82 struct nodes_head *nodes_head = &(parent->nodes_head);
84 /* Workspaces are handled differently: they need to be inserted at the
86 if (con->type == CT_WORKSPACE) {
87 DLOG("it's a workspace. num = %d\n", con->num);
88 if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
89 TAILQ_INSERT_TAIL(nodes_head, con, nodes);
91 current = TAILQ_FIRST(nodes_head);
92 if (con->num < current->num) {
93 /* we need to insert the container at the beginning */
94 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
96 while (current->num != -1 && con->num > current->num) {
97 current = TAILQ_NEXT(current, nodes);
98 if (current == TAILQ_END(nodes_head)) {
103 /* we need to insert con after current, if current is not NULL */
105 TAILQ_INSERT_BEFORE(current, con, nodes);
106 else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
109 goto add_to_focus_head;
112 if (con->type == CT_FLOATING_CON) {
113 DLOG("Inserting into floating containers\n");
114 TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
117 /* Get the first tiling container in focus stack */
118 TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
119 if (loop->type == CT_FLOATING_CON)
126 /* Insert the container after the tiling container, if found.
127 * When adding to a CT_OUTPUT, just append one after another. */
128 if (current && parent->type != CT_OUTPUT) {
129 DLOG("Inserting con = %p after last focused tiling con %p\n",
131 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
132 } else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
136 /* We insert to the TAIL because con_focus() will correct this.
137 * This way, we have the option to insert Cons without having
139 TAILQ_INSERT_TAIL(&(parent->focus_head), con, focused);
143 * Detaches the given container from its current parent
146 void con_detach(Con *con) {
147 if (con->type == CT_FLOATING_CON) {
148 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
149 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
151 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
152 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
157 * Sets input focus to the given container. Will be updated in X11 in the next
158 * run of x_push_changes().
161 void con_focus(Con *con) {
163 DLOG("con_focus = %p\n", con);
165 /* 1: set focused-pointer to the new con */
166 /* 2: exchange the position of the container in focus stack of the parent all the way up */
167 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
168 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
169 if (con->parent->parent != NULL)
170 con_focus(con->parent);
175 workspace_update_urgent_flag(con_get_workspace(con));
177 DLOG("con_focus done = %p\n", con);
181 * Returns true when this node is a leaf node (has no children)
184 bool con_is_leaf(Con *con) {
185 return TAILQ_EMPTY(&(con->nodes_head));
189 * Returns true if this node accepts a window (if the node swallows windows,
190 * it might already have swallowed enough and cannot hold any more).
193 bool con_accepts_window(Con *con) {
194 /* 1: workspaces never accept direct windows */
195 if (con->type == CT_WORKSPACE)
198 if (con->orientation != NO_ORIENTATION) {
199 DLOG("container %p does not accepts windows, orientation != NO_ORIENTATION\n", con);
203 /* TODO: if this is a swallowing container, we need to check its max_clients */
204 return (con->window == NULL);
208 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
212 Con *con_get_output(Con *con) {
214 while (result != NULL && result->type != CT_OUTPUT)
215 result = result->parent;
216 /* We must be able to get an output because focus can never be set higher
217 * in the tree (root node cannot be focused). */
218 assert(result != NULL);
223 * Gets the workspace container this node is on.
226 Con *con_get_workspace(Con *con) {
228 while (result != NULL && result->type != CT_WORKSPACE)
229 result = result->parent;
234 * Searches parenst of the given 'con' until it reaches one with the specified
235 * 'orientation'. Aborts when it comes across a floating_con.
238 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
239 DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
240 Con *parent = con->parent;
241 if (parent->type == CT_FLOATING_CON)
243 while (con_orientation(parent) != orientation) {
244 DLOG("Need to go one level further up\n");
245 parent = parent->parent;
246 /* Abort when we reach a floating con */
247 if (parent && parent->type == CT_FLOATING_CON)
252 DLOG("Result: %p\n", parent);
257 * helper data structure for the breadth-first-search in
258 * con_get_fullscreen_con()
264 TAILQ_ENTRY(bfs_entry) entries;
268 * Returns the first fullscreen node below this node.
271 Con *con_get_fullscreen_con(Con *con) {
272 Con *current, *child;
274 /* TODO: is breadth-first-search really appropriate? (check as soon as
275 * fullscreen levels and fullscreen for containers is implemented) */
276 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
277 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
279 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
281 while (!TAILQ_EMPTY(&bfs_head)) {
282 entry = TAILQ_FIRST(&bfs_head);
283 current = entry->con;
284 if (current != con && current->fullscreen_mode != CF_NONE) {
285 /* empty the queue */
286 while (!TAILQ_EMPTY(&bfs_head)) {
287 entry = TAILQ_FIRST(&bfs_head);
288 TAILQ_REMOVE(&bfs_head, entry, entries);
294 TAILQ_REMOVE(&bfs_head, entry, entries);
297 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
298 entry = smalloc(sizeof(struct bfs_entry));
300 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
303 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
304 entry = smalloc(sizeof(struct bfs_entry));
306 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
314 * Returns true if the node is floating.
317 bool con_is_floating(Con *con) {
319 DLOG("checking if con %p is floating\n", con);
320 return (con->floating >= FLOATING_AUTO_ON);
324 * Checks if the given container is either floating or inside some floating
325 * container. It returns the FLOATING_CON container.
328 Con *con_inside_floating(Con *con) {
330 if (con->type == CT_FLOATING_CON)
333 if (con->floating >= FLOATING_AUTO_ON)
336 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
339 return con_inside_floating(con->parent);
343 * Returns the container with the given client window ID or NULL if no such
347 Con *con_by_window_id(xcb_window_t window) {
349 TAILQ_FOREACH(con, &all_cons, all_cons)
350 if (con->window != NULL && con->window->id == window)
356 * Returns the container with the given frame ID or NULL if no such container
360 Con *con_by_frame_id(xcb_window_t frame) {
362 TAILQ_FOREACH(con, &all_cons, all_cons)
363 if (con->frame == frame)
369 * Returns the first container below 'con' which wants to swallow this window
373 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
376 DLOG("searching con for window %p starting at con %p\n", window, con);
377 DLOG("class == %s\n", window->class_class);
379 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
380 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
381 if (!match_matches_window(match, window))
383 if (store_match != NULL)
384 *store_match = match;
387 Con *result = con_for_window(child, window, store_match);
392 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
393 TAILQ_FOREACH(match, &(child->swallow_head), matches) {
394 if (!match_matches_window(match, window))
396 if (store_match != NULL)
397 *store_match = match;
400 Con *result = con_for_window(child, window, store_match);
409 * Returns the number of children of this container.
412 int con_num_children(Con *con) {
416 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
423 * Updates the percent attribute of the children of the given container. This
424 * function needs to be called when a window is added or removed from a
428 void con_fix_percent(Con *con) {
430 int children = con_num_children(con);
432 // calculate how much we have distributed and how many containers
433 // with a percentage set we have
435 int children_with_percent = 0;
436 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
437 if (child->percent > 0.0) {
438 total += child->percent;
439 ++children_with_percent;
443 // if there were children without a percentage set, set to a value that
444 // will make those children proportional to all others
445 if (children_with_percent != children) {
446 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
447 if (child->percent <= 0.0) {
448 if (children_with_percent == 0)
449 total += (child->percent = 1.0);
450 else total += (child->percent = total / children_with_percent);
455 // if we got a zero, just distribute the space equally, otherwise
456 // distribute according to the proportions we got
458 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
459 child->percent = 1.0 / children;
460 } else if (total != 1.0) {
461 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
462 child->percent /= total;
467 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
468 * entered when there already is a fullscreen container on this workspace.
471 void con_toggle_fullscreen(Con *con) {
472 Con *workspace, *fullscreen;
474 if (con->type == CT_WORKSPACE) {
475 DLOG("You cannot make a workspace fullscreen.\n");
479 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
480 if (con->fullscreen_mode == CF_NONE) {
481 /* 1: check if there already is a fullscreen con */
482 workspace = con_get_workspace(con);
483 if ((fullscreen = con_get_fullscreen_con(workspace)) != NULL) {
484 LOG("Not entering fullscreen mode, container (%p/%s) "
485 "already is in fullscreen mode\n",
486 fullscreen, fullscreen->name);
488 /* 2: enable fullscreen */
489 con->fullscreen_mode = CF_OUTPUT;
492 /* 1: disable fullscreen */
493 con->fullscreen_mode = CF_NONE;
495 DLOG("mode now: %d\n", con->fullscreen_mode);
497 /* update _NET_WM_STATE if this container has a window */
498 /* TODO: when a window is assigned to a container which is already
499 * fullscreened, this state needs to be pushed to the client, too */
500 if (con->window == NULL)
504 unsigned int num = 0;
506 if (con->fullscreen_mode != CF_NONE)
507 values[num++] = atoms[_NET_WM_STATE_FULLSCREEN];
509 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
510 atoms[_NET_WM_STATE], ATOM, 32, num, values);
514 * Moves the given container to the currently focused container on the given
516 * TODO: is there a better place for this function?
519 void con_move_to_workspace(Con *con, Con *workspace) {
520 if (con->type == CT_WORKSPACE) {
521 DLOG("Moving workspaces is not yet implemented.\n");
525 if (con_is_floating(con)) {
526 DLOG("Using FLOATINGCON instead\n");
530 /* 1: save the container which is going to be focused after the current
531 * container is moved away */
532 Con *focus_next = con_next_focused(con);
534 /* 2: get the focused container of this workspace */
535 Con *next = con_descend_focused(workspace);
537 /* 3: we go up one level, but only when next is a normal container */
538 if (next->type != CT_WORKSPACE)
541 /* 4: if the target container is floating, we get the workspace instead.
542 * Only tiling windows need to get inserted next to the current container.
544 Con *floatingcon = con_inside_floating(next);
545 if (floatingcon != NULL) {
546 DLOG("floatingcon, going up even further\n");
547 next = floatingcon->parent;
550 DLOG("Re-attaching container to %p / %s\n", next, next->name);
551 /* 5: re-attach the con to the parent of this focused container */
552 Con *parent = con->parent;
554 con_attach(con, next, false);
556 /* 6: fix the percentages */
557 con_fix_percent(parent);
559 con_fix_percent(next);
561 /* 7: focus the con on the target workspace (the X focus is only updated by
562 * calling tree_render(), so for the "real" focus this is a no-op) */
565 /* 8: keep focus on the current workspace */
566 con_focus(focus_next);
568 CALL(parent, on_remove_child);
572 * Returns the orientation of the given container (for stacked containers,
573 * vertical orientation is used regardless of the actual orientation of the
577 int con_orientation(Con *con) {
578 /* stacking containers behave like they are in vertical orientation */
579 if (con->layout == L_STACKED)
582 if (con->layout == L_TABBED)
585 return con->orientation;
589 * Returns the container which will be focused next when the given container
590 * is not available anymore. Called in tree_close and con_move_to_workspace
591 * to properly restore focus.
594 Con *con_next_focused(Con *con) {
596 /* floating containers are attached to a workspace, so we focus either the
597 * next floating container (if any) or the workspace itself. */
598 if (con->type == CT_FLOATING_CON) {
599 DLOG("selecting next for CT_FLOATING_CON\n");
600 next = TAILQ_NEXT(con, floating_windows);
601 if (next == TAILQ_END(&(parent->floating_head))) {
602 Con *ws = con_get_workspace(con);
604 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
605 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
606 next = TAILQ_FIRST(&(next->focus_head));
608 DLOG("skipping container itself, we want the next client\n");
609 next = TAILQ_NEXT(next, focused);
612 if (next == TAILQ_END(&(ws->focus_head))) {
613 DLOG("Focus list empty, returning ws\n");
620 /* dock clients cannot be focused, so we focus the workspace instead */
621 if (con->parent->type == CT_DOCKAREA) {
622 DLOG("selecting workspace for dock client\n");
623 return con_descend_focused(output_get_content(con->parent->parent));
626 /* try to focus the next container on the same level as this one */
627 next = TAILQ_NEXT(con, focused);
629 /* if that was not possible, go up to its parent */
630 if (next == TAILQ_END(&(parent->nodes_head)))
633 /* now go down the focus stack as far as
634 * possible, excluding the current container */
635 while (!TAILQ_EMPTY(&(next->focus_head)) &&
636 TAILQ_FIRST(&(next->focus_head)) != con)
637 next = TAILQ_FIRST(&(next->focus_head));
643 * Get the next/previous container in the specified orientation. This may
644 * travel up until it finds a container with suitable orientation.
647 Con *con_get_next(Con *con, char way, orientation_t orientation) {
648 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
649 /* 1: get the first parent with the same orientation */
651 while (con_orientation(cur->parent) != orientation) {
652 DLOG("need to go one level further up\n");
653 if (cur->parent->type == CT_WORKSPACE) {
654 LOG("that's a workspace, we can't go further up\n");
660 /* 2: chose next (or previous) */
663 next = TAILQ_NEXT(cur, nodes);
664 /* if we are at the end of the list, we need to wrap */
665 if (next == TAILQ_END(&(parent->nodes_head)))
668 next = TAILQ_PREV(cur, nodes_head, nodes);
669 /* if we are at the end of the list, we need to wrap */
670 if (next == TAILQ_END(&(cur->nodes_head)))
673 DLOG("next = %p\n", next);
679 * Returns the focused con inside this client, descending the tree as far as
680 * possible. This comes in handy when attaching a con to a workspace at the
681 * currently focused position, for example.
684 Con *con_descend_focused(Con *con) {
686 while (!TAILQ_EMPTY(&(next->focus_head)))
687 next = TAILQ_FIRST(&(next->focus_head));
692 * Returns a "relative" Rect which contains the amount of pixels that need to
693 * be added to the original Rect to get the final position (obviously the
694 * amount of pixels for normal, 1pixel and borderless are different).
697 Rect con_border_style_rect(Con *con) {
698 switch (con_border_style(con)) {
700 return (Rect){2, 0, -(2 * 2), -2};
703 return (Rect){1, 1, -2, -2};
706 return (Rect){0, 0, 0, 0};
714 * Use this function to get a container’s border style. This is important
715 * because when inside a stack, the border style is always BS_NORMAL.
716 * For tabbed mode, the same applies, with one exception: when the container is
717 * borderless and the only element in the tabbed container, the border is not
720 * For children of a CT_DOCKAREA, the border style is always none.
723 int con_border_style(Con *con) {
724 Con *fs = con_get_fullscreen_con(con->parent);
726 DLOG("this one is fullscreen! overriding BS_NONE\n");
730 if (con->parent->layout == L_STACKED)
731 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
733 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
734 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
736 if (con->parent->type == CT_DOCKAREA)
739 return con->border_style;
743 * This function changes the layout of a given container. Use it to handle
744 * special cases like changing a whole workspace to stacked/tabbed (creates a
745 * new split container before).
748 void con_set_layout(Con *con, int layout) {
749 /* When the container type is CT_WORKSPACE, the user wants to change the
750 * whole workspace into stacked/tabbed mode. To do this and still allow
751 * intuitive operations (like level-up and then opening a new window), we
752 * need to create a new split container. */
753 if (con->type == CT_WORKSPACE) {
754 DLOG("Creating new split container\n");
755 /* 1: create a new split container */
756 Con *new = con_new(NULL);
759 /* 2: set the requested layout on the split con */
760 new->layout = layout;
762 /* 3: While the layout is irrelevant in stacked/tabbed mode, it needs
763 * to be set. Otherwise, this con will not be interpreted as a split
765 new->orientation = HORIZ;
767 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
768 if (old_focused == TAILQ_END(&(con->focus_head)))
771 /* 4: move the existing cons of this workspace below the new con */
772 DLOG("Moving cons\n");
774 while (!TAILQ_EMPTY(&(con->nodes_head))) {
775 child = TAILQ_FIRST(&(con->nodes_head));
777 con_attach(child, new, true);
780 /* 4: attach the new split container to the workspace */
781 DLOG("Attaching new split to ws\n");
782 con_attach(new, con, false);
785 con_focus(old_focused);
792 con->layout = layout;
796 * Callback which will be called when removing a child from the given con.
797 * Kills the container if it is empty and replaces it with the child if there
798 * is exactly one child.
801 static void con_on_remove_child(Con *con) {
802 DLOG("on_remove_child\n");
804 /* Every container 'above' (in the hierarchy) the workspace content should
805 * not be closed when the last child was removed */
806 if (con->type == CT_WORKSPACE ||
807 con->type == CT_OUTPUT ||
808 con->type == CT_ROOT ||
809 con->type == CT_DOCKAREA) {
810 DLOG("not handling, type = %d\n", con->type);
814 /* TODO: check if this container would swallow any other client and
815 * don’t close it automatically. */
816 int children = con_num_children(con);
818 DLOG("Container empty, closing\n");
819 tree_close(con, false, false);
825 * Determines the minimum size of the given con by looking at its children (for
826 * split/stacked/tabbed cons). Will be called when resizing floating cons
829 Rect con_minimum_size(Con *con) {
830 DLOG("Determining minimum size for con %p\n", con);
832 if (con_is_leaf(con)) {
833 DLOG("leaf node, returning 75x50\n");
834 return (Rect){ 0, 0, 75, 50 };
837 if (con->type == CT_FLOATING_CON) {
838 DLOG("floating con\n");
839 Con *child = TAILQ_FIRST(&(con->nodes_head));
840 return con_minimum_size(child);
843 if (con->layout == L_STACKED || con->layout == L_TABBED) {
844 uint32_t max_width = 0, max_height = 0, deco_height = 0;
846 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
847 Rect min = con_minimum_size(child);
848 deco_height += child->deco_rect.height;
849 max_width = max(max_width, min.width);
850 max_height = max(max_height, min.height);
852 DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
853 max_width, max_height, deco_height);
854 return (Rect){ 0, 0, max_width, max_height + deco_height };
857 /* For horizontal/vertical split containers we sum up the width (h-split)
858 * or height (v-split) and use the maximum of the height (h-split) or width
859 * (v-split) as minimum size. */
860 if (con->orientation == HORIZ || con->orientation == VERT) {
861 uint32_t width = 0, height = 0;
863 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
864 Rect min = con_minimum_size(child);
865 if (con->orientation == HORIZ) {
867 height = max(height, min.height);
869 height += min.height;
870 width = max(width, min.width);
873 DLOG("split container, returning width = %d x height = %d\n", width, height);
874 return (Rect){ 0, 0, width, height };
877 ELOG("Unhandled case, type = %d, layout = %d, orientation = %d\n",
878 con->type, con->layout, con->orientation);