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 * helper data structure for the breadth-first-search in
235 * con_get_fullscreen_con()
241 TAILQ_ENTRY(bfs_entry) entries;
245 * Returns the first fullscreen node below this node.
248 Con *con_get_fullscreen_con(Con *con) {
249 Con *current, *child;
251 /* TODO: is breadth-first-search really appropriate? (check as soon as
252 * fullscreen levels and fullscreen for containers is implemented) */
253 TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
254 struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
256 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
258 while (!TAILQ_EMPTY(&bfs_head)) {
259 entry = TAILQ_FIRST(&bfs_head);
260 current = entry->con;
261 if (current != con && current->fullscreen_mode != CF_NONE) {
262 /* empty the queue */
263 while (!TAILQ_EMPTY(&bfs_head)) {
264 entry = TAILQ_FIRST(&bfs_head);
265 TAILQ_REMOVE(&bfs_head, entry, entries);
271 TAILQ_REMOVE(&bfs_head, entry, entries);
274 TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
275 entry = smalloc(sizeof(struct bfs_entry));
277 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
280 TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
281 entry = smalloc(sizeof(struct bfs_entry));
283 TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
291 * Returns true if the node is floating.
294 bool con_is_floating(Con *con) {
296 DLOG("checking if con %p is floating\n", con);
297 return (con->floating >= FLOATING_AUTO_ON);
301 * Checks if the given container is either floating or inside some floating
302 * container. It returns the FLOATING_CON container.
305 Con *con_inside_floating(Con *con) {
307 if (con->type == CT_FLOATING_CON)
310 if (con->floating >= FLOATING_AUTO_ON)
313 if (con->type == CT_WORKSPACE)
316 return con_inside_floating(con->parent);
320 * Returns the container with the given client window ID or NULL if no such
324 Con *con_by_window_id(xcb_window_t window) {
326 TAILQ_FOREACH(con, &all_cons, all_cons)
327 if (con->window != NULL && con->window->id == window)
333 * Returns the container with the given frame ID or NULL if no such container
337 Con *con_by_frame_id(xcb_window_t frame) {
339 TAILQ_FOREACH(con, &all_cons, all_cons)
340 if (con->frame == frame)
346 * Returns the first container which wants to swallow this window
350 Con *con_for_window(i3Window *window, Match **store_match) {
353 DLOG("searching con for window %p\n", window);
354 DLOG("class == %s\n", window->class_class);
356 TAILQ_FOREACH(con, &all_cons, all_cons)
357 TAILQ_FOREACH(match, &(con->swallow_head), matches) {
358 if (!match_matches_window(match, window))
360 if (store_match != NULL)
361 *store_match = match;
369 * Returns the number of children of this container.
372 int con_num_children(Con *con) {
376 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
383 * Updates the percent attribute of the children of the given container. This
384 * function needs to be called when a window is added or removed from a
388 void con_fix_percent(Con *con) {
390 int children = con_num_children(con);
392 // calculate how much we have distributed and how many containers
393 // with a percentage set we have
395 int children_with_percent = 0;
396 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
397 if (child->percent > 0.0) {
398 total += child->percent;
399 ++children_with_percent;
403 // if there were children without a percentage set, set to a value that
404 // will make those children proportional to all others
405 if (children_with_percent != children) {
406 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
407 if (child->percent <= 0.0) {
408 if (children_with_percent == 0)
409 total += (child->percent = 1.0);
410 else total += (child->percent = total / children_with_percent);
415 // if we got a zero, just distribute the space equally, otherwise
416 // distribute according to the proportions we got
418 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
419 child->percent = 1.0 / children;
420 } else if (total != 1.0) {
421 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
422 child->percent /= total;
427 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
428 * entered when there already is a fullscreen container on this workspace.
431 void con_toggle_fullscreen(Con *con) {
432 Con *workspace, *fullscreen;
434 if (con->type == CT_WORKSPACE) {
435 DLOG("You cannot make a workspace fullscreen.\n");
439 DLOG("toggling fullscreen for %p / %s\n", con, con->name);
440 if (con->fullscreen_mode == CF_NONE) {
441 /* 1: check if there already is a fullscreen con */
442 workspace = con_get_workspace(con);
443 if ((fullscreen = con_get_fullscreen_con(workspace)) != NULL) {
444 LOG("Not entering fullscreen mode, container (%p/%s) "
445 "already is in fullscreen mode\n",
446 fullscreen, fullscreen->name);
448 /* 2: enable fullscreen */
449 con->fullscreen_mode = CF_OUTPUT;
452 /* 1: disable fullscreen */
453 con->fullscreen_mode = CF_NONE;
455 DLOG("mode now: %d\n", con->fullscreen_mode);
457 /* update _NET_WM_STATE if this container has a window */
458 /* TODO: when a window is assigned to a container which is already
459 * fullscreened, this state needs to be pushed to the client, too */
460 if (con->window == NULL)
464 unsigned int num = 0;
466 if (con->fullscreen_mode != CF_NONE)
467 values[num++] = atoms[_NET_WM_STATE_FULLSCREEN];
469 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
470 atoms[_NET_WM_STATE], ATOM, 32, num, values);
474 * Moves the given container to the currently focused container on the given
476 * TODO: is there a better place for this function?
479 void con_move_to_workspace(Con *con, Con *workspace) {
480 if (con->type == CT_WORKSPACE) {
481 DLOG("Moving workspaces is not yet implemented.\n");
485 if (con_is_floating(con)) {
486 DLOG("Using FLOATINGCON instead\n");
490 /* 1: save the container which is going to be focused after the current
491 * container is moved away */
492 Con *focus_next = con_next_focused(con);
494 /* 2: get the focused container of this workspace */
495 Con *next = con_descend_focused(workspace);
497 /* 3: we go up one level, but only when next is a normal container */
498 if (next->type != CT_WORKSPACE)
501 /* 4: if the target container is floating, we get the workspace instead.
502 * Only tiling windows need to get inserted next to the current container.
504 Con *floatingcon = con_inside_floating(next);
505 if (floatingcon != NULL) {
506 DLOG("floatingcon, going up even further\n");
507 next = floatingcon->parent;
510 DLOG("Re-attaching container to %p / %s\n", next, next->name);
511 /* 5: re-attach the con to the parent of this focused container */
512 Con *parent = con->parent;
514 con_attach(con, next, false);
516 /* 6: fix the percentages */
517 con_fix_percent(parent);
519 con_fix_percent(next);
521 /* 7: focus the con on the target workspace (the X focus is only updated by
522 * calling tree_render(), so for the "real" focus this is a no-op) */
525 /* 8: keep focus on the current workspace */
526 con_focus(focus_next);
528 CALL(parent, on_remove_child);
532 * Returns the orientation of the given container (for stacked containers,
533 * vertical orientation is used regardless of the actual orientation of the
537 int con_orientation(Con *con) {
538 /* stacking containers behave like they are in vertical orientation */
539 if (con->layout == L_STACKED)
542 if (con->layout == L_TABBED)
545 return con->orientation;
549 * Returns the container which will be focused next when the given container
550 * is not available anymore. Called in tree_close and con_move_to_workspace
551 * to properly restore focus.
554 Con *con_next_focused(Con *con) {
556 /* floating containers are attached to a workspace, so we focus either the
557 * next floating container (if any) or the workspace itself. */
558 if (con->type == CT_FLOATING_CON) {
559 DLOG("selecting next for CT_FLOATING_CON\n");
560 next = TAILQ_NEXT(con, floating_windows);
561 if (next == TAILQ_END(&(parent->floating_head))) {
562 Con *ws = con_get_workspace(con);
564 DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
565 while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
566 next = TAILQ_FIRST(&(next->focus_head));
568 DLOG("skipping container itself, we want the next client\n");
569 next = TAILQ_NEXT(next, focused);
572 if (next == TAILQ_END(&(ws->focus_head))) {
573 DLOG("Focus list empty, returning ws\n");
580 /* try to focus the next container on the same level as this one */
581 next = TAILQ_NEXT(con, focused);
583 /* if that was not possible, go up to its parent */
584 if (next == TAILQ_END(&(parent->nodes_head)))
587 /* now go down the focus stack as far as
588 * possible, excluding the current container */
589 while (!TAILQ_EMPTY(&(next->focus_head)) &&
590 TAILQ_FIRST(&(next->focus_head)) != con)
591 next = TAILQ_FIRST(&(next->focus_head));
597 * Get the next/previous container in the specified orientation. This may
598 * travel up until it finds a container with suitable orientation.
601 Con *con_get_next(Con *con, char way, orientation_t orientation) {
602 DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
603 /* 1: get the first parent with the same orientation */
605 while (con_orientation(cur->parent) != orientation) {
606 DLOG("need to go one level further up\n");
607 if (cur->parent->type == CT_WORKSPACE) {
608 LOG("that's a workspace, we can't go further up\n");
614 /* 2: chose next (or previous) */
617 next = TAILQ_NEXT(cur, nodes);
618 /* if we are at the end of the list, we need to wrap */
619 if (next == TAILQ_END(&(parent->nodes_head)))
622 next = TAILQ_PREV(cur, nodes_head, nodes);
623 /* if we are at the end of the list, we need to wrap */
624 if (next == TAILQ_END(&(cur->nodes_head)))
627 DLOG("next = %p\n", next);
633 * Returns the focused con inside this client, descending the tree as far as
634 * possible. This comes in handy when attaching a con to a workspace at the
635 * currently focused position, for example.
638 Con *con_descend_focused(Con *con) {
640 while (!TAILQ_EMPTY(&(next->focus_head)))
641 next = TAILQ_FIRST(&(next->focus_head));
646 * Returns a "relative" Rect which contains the amount of pixels that need to
647 * be added to the original Rect to get the final position (obviously the
648 * amount of pixels for normal, 1pixel and borderless are different).
651 Rect con_border_style_rect(Con *con) {
652 switch (con_border_style(con)) {
654 return (Rect){2, 0, -(2 * 2), -2};
657 return (Rect){1, 1, -2, -2};
660 return (Rect){0, 0, 0, 0};
668 * Use this function to get a container’s border style. This is important
669 * because when inside a stack, the border style is always BS_NORMAL.
670 * For tabbed mode, the same applies, with one exception: when the container is
671 * borderless and the only element in the tabbed container, the border is not
675 int con_border_style(Con *con) {
676 Con *fs = con_get_fullscreen_con(con->parent);
678 DLOG("this one is fullscreen! overriding BS_NONE\n");
682 if (con->parent->layout == L_STACKED)
683 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
685 if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
686 return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
688 return con->border_style;
692 * This function changes the layout of a given container. Use it to handle
693 * special cases like changing a whole workspace to stacked/tabbed (creates a
694 * new split container before).
697 void con_set_layout(Con *con, int layout) {
698 /* When the container type is CT_WORKSPACE, the user wants to change the
699 * whole workspace into stacked/tabbed mode. To do this and still allow
700 * intuitive operations (like level-up and then opening a new window), we
701 * need to create a new split container. */
702 if (con->type == CT_WORKSPACE) {
703 DLOG("Creating new split container\n");
704 /* 1: create a new split container */
705 Con *new = con_new(NULL);
708 /* 2: set the requested layout on the split con */
709 new->layout = layout;
711 /* 3: While the layout is irrelevant in stacked/tabbed mode, it needs
712 * to be set. Otherwise, this con will not be interpreted as a split
714 new->orientation = HORIZ;
716 Con *old_focused = TAILQ_FIRST(&(con->focus_head));
717 if (old_focused == TAILQ_END(&(con->focus_head)))
720 /* 4: move the existing cons of this workspace below the new con */
721 DLOG("Moving cons\n");
723 while (!TAILQ_EMPTY(&(con->nodes_head))) {
724 child = TAILQ_FIRST(&(con->nodes_head));
726 con_attach(child, new, true);
729 /* 4: attach the new split container to the workspace */
730 DLOG("Attaching new split to ws\n");
731 con_attach(new, con, false);
734 con_focus(old_focused);
741 con->layout = layout;
744 static void con_on_remove_child(Con *con) {
745 /* Nothing to do for workspaces */
746 if (con->type == CT_WORKSPACE)
749 /* TODO: check if this container would swallow any other client and
750 * don’t close it automatically. */
751 DLOG("on_remove_child\n");
752 if (con_num_children(con) == 0) {
753 DLOG("Container empty, closing\n");
754 tree_close(con, false, false);