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 */
128 DLOG("Inserting con = %p after last focused tiling con %p\n",
130 TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
131 } else TAILQ_INSERT_TAIL(nodes_head, con, nodes);
135 /* We insert to the TAIL because con_focus() will correct this.
136 * This way, we have the option to insert Cons without having
138 TAILQ_INSERT_TAIL(&(parent->focus_head), con, focused);
142 * Detaches the given container from its current parent
145 void con_detach(Con *con) {
146 if (con->type == CT_FLOATING_CON) {
147 TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
148 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
150 TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
151 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
156 * Sets input focus to the given container. Will be updated in X11 in the next
157 * run of x_push_changes().
160 void con_focus(Con *con) {
162 DLOG("con_focus = %p\n", con);
164 /* 1: set focused-pointer to the new con */
165 /* 2: exchange the position of the container in focus stack of the parent all the way up */
166 TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
167 TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
168 if (con->parent->parent != NULL)
169 con_focus(con->parent);
174 workspace_update_urgent_flag(con_get_workspace(con));
176 DLOG("con_focus done = %p\n", con);
180 * Returns true when this node is a leaf node (has no children)
183 bool con_is_leaf(Con *con) {
184 return TAILQ_EMPTY(&(con->nodes_head));
188 * Returns true if this node accepts a window (if the node swallows windows,
189 * it might already have swallowed enough and cannot hold any more).
192 bool con_accepts_window(Con *con) {
193 /* 1: workspaces never accept direct windows */
194 if (con->type == CT_WORKSPACE)
197 if (con->orientation != NO_ORIENTATION) {
198 DLOG("container %p does not accepts windows, orientation != NO_ORIENTATION\n", con);
202 /* TODO: if this is a swallowing container, we need to check its max_clients */
203 return (con->window == NULL);
207 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
211 Con *con_get_output(Con *con) {
213 while (result != NULL && result->type != CT_OUTPUT)
214 result = result->parent;
215 /* We must be able to get an output because focus can never be set higher
216 * in the tree (root node cannot be focused). */
217 assert(result != NULL);
222 * Gets the workspace container this node is on.
225 Con *con_get_workspace(Con *con) {
227 while (result != NULL && result->type != CT_WORKSPACE)
228 result = result->parent;
229 assert(result != NULL);
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)
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 which wants to swallow this window
373 Con *con_for_window(i3Window *window, Match **store_match) {
376 DLOG("searching con for window %p\n", window);
377 DLOG("class == %s\n", window->class_class);
379 TAILQ_FOREACH(con, &all_cons, all_cons)
380 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
381 if (!match_matches_window(match, window))
383 if (store_match != NULL)
384 *store_match = match;
392 * Returns the number of children of this container.
395 int con_num_children(Con *con) {
399 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
406 * Updates the percent attribute of the children of the given container. This
407 * function needs to be called when a window is added or removed from a
411 void con_fix_percent(Con *con) {
413 int children = con_num_children(con);
415 // calculate how much we have distributed and how many containers
416 // with a percentage set we have
418 int children_with_percent = 0;
419 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
420 if (child->percent > 0.0) {
421 total += child->percent;
422 ++children_with_percent;
426 // if there were children without a percentage set, set to a value that
427 // will make those children proportional to all others
428 if (children_with_percent != children) {
429 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
430 if (child->percent <= 0.0) {
431 if (children_with_percent == 0)
432 total += (child->percent = 1.0);
433 else total += (child->percent = total / children_with_percent);
438 // if we got a zero, just distribute the space equally, otherwise
439 // distribute according to the proportions we got
441 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
442 child->percent = 1.0 / children;
443 } else if (total != 1.0) {
444 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
445 child->percent /= total;
450 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
451 * entered when there already is a fullscreen container on this workspace.
454 void con_toggle_fullscreen(Con *con) {
455 Con *workspace, *fullscreen;
457 if (con->type == CT_WORKSPACE) {
458 DLOG("You cannot make a workspace fullscreen.\n");
462 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
463 if (con->fullscreen_mode == CF_NONE) {
464 /* 1: check if there already is a fullscreen con */
465 workspace = con_get_workspace(con);
466 if ((fullscreen = con_get_fullscreen_con(workspace)) != NULL) {
467 LOG("Not entering fullscreen mode, container (%p/%s) "
468 "already is in fullscreen mode\n",
469 fullscreen, fullscreen->name);
471 /* 2: enable fullscreen */
472 con->fullscreen_mode = CF_OUTPUT;
475 /* 1: disable fullscreen */
476 con->fullscreen_mode = CF_NONE;
478 DLOG("mode now: %d\n", con->fullscreen_mode);
480 /* update _NET_WM_STATE if this container has a window */
481 /* TODO: when a window is assigned to a container which is already
482 * fullscreened, this state needs to be pushed to the client, too */
483 if (con->window == NULL)
487 unsigned int num = 0;
489 if (con->fullscreen_mode != CF_NONE)
490 values[num++] = atoms[_NET_WM_STATE_FULLSCREEN];
492 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
493 atoms[_NET_WM_STATE], ATOM, 32, num, values);
497 * Moves the given container to the currently focused container on the given
499 * TODO: is there a better place for this function?
502 void con_move_to_workspace(Con *con, Con *workspace) {
503 if (con->type == CT_WORKSPACE) {
504 DLOG("Moving workspaces is not yet implemented.\n");
508 if (con_is_floating(con)) {
509 DLOG("Using FLOATINGCON instead\n");
513 /* 1: save the container which is going to be focused after the current
514 * container is moved away */
515 Con *focus_next = con_next_focused(con);
517 /* 2: get the focused container of this workspace */
518 Con *next = con_descend_focused(workspace);
520 /* 3: we go up one level, but only when next is a normal container */
521 if (next->type != CT_WORKSPACE)
524 /* 4: if the target container is floating, we get the workspace instead.
525 * Only tiling windows need to get inserted next to the current container.
527 Con *floatingcon = con_inside_floating(next);
528 if (floatingcon != NULL) {
529 DLOG("floatingcon, going up even further\n");
530 next = floatingcon->parent;
533 DLOG("Re-attaching container to %p / %s\n", next, next->name);
534 /* 5: re-attach the con to the parent of this focused container */
535 Con *parent = con->parent;
537 con_attach(con, next, false);
539 /* 6: fix the percentages */
540 con_fix_percent(parent);
542 con_fix_percent(next);
544 /* 7: focus the con on the target workspace (the X focus is only updated by
545 * calling tree_render(), so for the "real" focus this is a no-op) */
548 /* 8: keep focus on the current workspace */
549 con_focus(focus_next);
551 CALL(parent, on_remove_child);
555 * Returns the orientation of the given container (for stacked containers,
556 * vertical orientation is used regardless of the actual orientation of the
560 int con_orientation(Con *con) {
561 /* stacking containers behave like they are in vertical orientation */
562 if (con->layout == L_STACKED)
565 if (con->layout == L_TABBED)
568 return con->orientation;
572 * Returns the container which will be focused next when the given container
573 * is not available anymore. Called in tree_close and con_move_to_workspace
574 * to properly restore focus.
577 Con *con_next_focused(Con *con) {
579 /* floating containers are attached to a workspace, so we focus either the
580 * next floating container (if any) or the workspace itself. */
581 if (con->type == CT_FLOATING_CON) {
582 DLOG("selecting next for CT_FLOATING_CON\n");
583 next = TAILQ_NEXT(con, floating_windows);
584 if (next == TAILQ_END(&(parent->floating_head))) {
585 Con *ws = con_get_workspace(con);
587 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
588 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
589 next = TAILQ_FIRST(&(next->focus_head));
591 DLOG("skipping container itself, we want the next client\n");
592 next = TAILQ_NEXT(next, focused);
595 if (next == TAILQ_END(&(ws->focus_head))) {
596 DLOG("Focus list empty, returning ws\n");
603 /* try to focus the next container on the same level as this one */
604 next = TAILQ_NEXT(con, focused);
606 /* if that was not possible, go up to its parent */
607 if (next == TAILQ_END(&(parent->nodes_head)))
610 /* now go down the focus stack as far as
611 * possible, excluding the current container */
612 while (!TAILQ_EMPTY(&(next->focus_head)) &&
613 TAILQ_FIRST(&(next->focus_head)) != con)
614 next = TAILQ_FIRST(&(next->focus_head));
620 * Get the next/previous container in the specified orientation. This may
621 * travel up until it finds a container with suitable orientation.
624 Con *con_get_next(Con *con, char way, orientation_t orientation) {
625 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
626 /* 1: get the first parent with the same orientation */
628 while (con_orientation(cur->parent) != orientation) {
629 DLOG("need to go one level further up\n");
630 if (cur->parent->type == CT_WORKSPACE) {
631 LOG("that's a workspace, we can't go further up\n");
637 /* 2: chose next (or previous) */
640 next = TAILQ_NEXT(cur, nodes);
641 /* if we are at the end of the list, we need to wrap */
642 if (next == TAILQ_END(&(parent->nodes_head)))
645 next = TAILQ_PREV(cur, nodes_head, nodes);
646 /* if we are at the end of the list, we need to wrap */
647 if (next == TAILQ_END(&(cur->nodes_head)))
650 DLOG("next = %p\n", next);
656 * Returns the focused con inside this client, descending the tree as far as
657 * possible. This comes in handy when attaching a con to a workspace at the
658 * currently focused position, for example.
661 Con *con_descend_focused(Con *con) {
663 while (!TAILQ_EMPTY(&(next->focus_head)))
664 next = TAILQ_FIRST(&(next->focus_head));
669 * Returns a "relative" Rect which contains the amount of pixels that need to
670 * be added to the original Rect to get the final position (obviously the
671 * amount of pixels for normal, 1pixel and borderless are different).
674 Rect con_border_style_rect(Con *con) {
675 switch (con_border_style(con)) {
677 return (Rect){2, 0, -(2 * 2), -2};
680 return (Rect){1, 1, -2, -2};
683 return (Rect){0, 0, 0, 0};
691 * Use this function to get a container’s border style. This is important
692 * because when inside a stack, the border style is always BS_NORMAL.
693 * For tabbed mode, the same applies, with one exception: when the container is
694 * borderless and the only element in the tabbed container, the border is not
698 int con_border_style(Con *con) {
699 Con *fs = con_get_fullscreen_con(con->parent);
701 DLOG("this one is fullscreen! overriding BS_NONE\n");
705 if (con->parent->layout == L_STACKED)
706 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
708 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
709 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
711 return con->border_style;
715 * This function changes the layout of a given container. Use it to handle
716 * special cases like changing a whole workspace to stacked/tabbed (creates a
717 * new split container before).
720 void con_set_layout(Con *con, int layout) {
721 /* When the container type is CT_WORKSPACE, the user wants to change the
722 * whole workspace into stacked/tabbed mode. To do this and still allow
723 * intuitive operations (like level-up and then opening a new window), we
724 * need to create a new split container. */
725 if (con->type == CT_WORKSPACE) {
726 DLOG("Creating new split container\n");
727 /* 1: create a new split container */
728 Con *new = con_new(NULL);
731 /* 2: set the requested layout on the split con */
732 new->layout = layout;
734 /* 3: While the layout is irrelevant in stacked/tabbed mode, it needs
735 * to be set. Otherwise, this con will not be interpreted as a split
737 new->orientation = HORIZ;
739 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
740 if (old_focused == TAILQ_END(&(con->focus_head)))
743 /* 4: move the existing cons of this workspace below the new con */
744 DLOG("Moving cons\n");
746 while (!TAILQ_EMPTY(&(con->nodes_head))) {
747 child = TAILQ_FIRST(&(con->nodes_head));
749 con_attach(child, new, true);
752 /* 4: attach the new split container to the workspace */
753 DLOG("Attaching new split to ws\n");
754 con_attach(new, con, false);
757 con_focus(old_focused);
764 con->layout = layout;
768 * Callback which will be called when removing a child from the given con.
769 * Kills the container if it is empty and replaces it with the child if there
770 * is exactly one child.
773 static void con_on_remove_child(Con *con) {
774 DLOG("on_remove_child\n");
776 /* Nothing to do for workspaces */
777 if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT || con->type == CT_ROOT) {
778 DLOG("not handling, type = %d\n", con->type);
782 /* TODO: check if this container would swallow any other client and
783 * don’t close it automatically. */
784 int children = con_num_children(con);
786 DLOG("Container empty, closing\n");
787 tree_close(con, false, false);