]> git.sur5r.net Git - i3/i3/blob - src/con.c
Allow assign to workspace by number
[i3/i3] / src / con.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * con.c: Functions which deal with containers directly (creating containers,
8  *        searching containers, getting specific properties from containers,
9  *        …).
10  *
11  */
12 #include "all.h"
13
14 #include "yajl_utils.h"
15
16 static void con_on_remove_child(Con *con);
17
18 /*
19  * force parent split containers to be redrawn
20  *
21  */
22 void con_force_split_parents_redraw(Con *con) {
23     Con *parent = con;
24
25     while (parent != NULL && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
26         if (!con_is_leaf(parent)) {
27             FREE(parent->deco_render_params);
28         }
29
30         parent = parent->parent;
31     }
32 }
33
34 /*
35  * Create a new container (and attach it to the given parent, if not NULL).
36  * This function only initializes the data structures.
37  *
38  */
39 Con *con_new_skeleton(Con *parent, i3Window *window) {
40     Con *new = scalloc(1, sizeof(Con));
41     new->on_remove_child = con_on_remove_child;
42     TAILQ_INSERT_TAIL(&all_cons, new, all_cons);
43     new->type = CT_CON;
44     new->window = window;
45     new->border_style = config.default_border;
46     new->current_border_width = -1;
47     if (window) {
48         new->depth = window->depth;
49         new->window->aspect_ratio = 0.0;
50     } else {
51         new->depth = root_depth;
52     }
53     DLOG("opening window\n");
54
55     TAILQ_INIT(&(new->floating_head));
56     TAILQ_INIT(&(new->nodes_head));
57     TAILQ_INIT(&(new->focus_head));
58     TAILQ_INIT(&(new->swallow_head));
59     TAILQ_INIT(&(new->marks_head));
60
61     if (parent != NULL)
62         con_attach(new, parent, false);
63
64     return new;
65 }
66
67 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
68  *
69  */
70 Con *con_new(Con *parent, i3Window *window) {
71     Con *new = con_new_skeleton(parent, window);
72     x_con_init(new);
73     return new;
74 }
75
76 static void _con_attach(Con *con, Con *parent, Con *previous, bool ignore_focus) {
77     con->parent = parent;
78     Con *loop;
79     Con *current = previous;
80     struct nodes_head *nodes_head = &(parent->nodes_head);
81     struct focus_head *focus_head = &(parent->focus_head);
82
83     /* Workspaces are handled differently: they need to be inserted at the
84      * right position. */
85     if (con->type == CT_WORKSPACE) {
86         DLOG("it's a workspace. num = %d\n", con->num);
87         if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
88             TAILQ_INSERT_TAIL(nodes_head, con, nodes);
89         } else {
90             current = TAILQ_FIRST(nodes_head);
91             if (con->num < current->num) {
92                 /* we need to insert the container at the beginning */
93                 TAILQ_INSERT_HEAD(nodes_head, con, nodes);
94             } else {
95                 while (current->num != -1 && con->num > current->num) {
96                     current = TAILQ_NEXT(current, nodes);
97                     if (current == TAILQ_END(nodes_head)) {
98                         current = NULL;
99                         break;
100                     }
101                 }
102                 /* we need to insert con after current, if current is not NULL */
103                 if (current)
104                     TAILQ_INSERT_BEFORE(current, con, nodes);
105                 else
106                     TAILQ_INSERT_TAIL(nodes_head, con, nodes);
107             }
108         }
109         goto add_to_focus_head;
110     }
111
112     if (con->type == CT_FLOATING_CON) {
113         DLOG("Inserting into floating containers\n");
114         TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
115     } else {
116         if (!ignore_focus) {
117             /* Get the first tiling container in focus stack */
118             TAILQ_FOREACH(loop, &(parent->focus_head), focused) {
119                 if (loop->type == CT_FLOATING_CON)
120                     continue;
121                 current = loop;
122                 break;
123             }
124         }
125
126         /* When the container is not a split container (but contains a window)
127          * and is attached to a workspace, we check if the user configured a
128          * workspace_layout. This is done in workspace_attach_to, which will
129          * provide us with the container to which we should attach (either the
130          * workspace or a new split container with the configured
131          * workspace_layout).
132          */
133         if (con->window != NULL &&
134             parent->type == CT_WORKSPACE &&
135             parent->workspace_layout != L_DEFAULT) {
136             DLOG("Parent is a workspace. Applying default layout...\n");
137             Con *target = workspace_attach_to(parent);
138
139             /* Attach the original con to this new split con instead */
140             nodes_head = &(target->nodes_head);
141             focus_head = &(target->focus_head);
142             con->parent = target;
143             current = NULL;
144
145             DLOG("done\n");
146         }
147
148         /* Insert the container after the tiling container, if found.
149          * When adding to a CT_OUTPUT, just append one after another. */
150         if (current != NULL && parent->type != CT_OUTPUT) {
151             DLOG("Inserting con = %p after con %p\n", con, current);
152             TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
153         } else
154             TAILQ_INSERT_TAIL(nodes_head, con, nodes);
155     }
156
157 add_to_focus_head:
158     /* We insert to the TAIL because con_focus() will correct this.
159      * This way, we have the option to insert Cons without having
160      * to focus them. */
161     TAILQ_INSERT_TAIL(focus_head, con, focused);
162     con_force_split_parents_redraw(con);
163 }
164
165 /*
166  * Attaches the given container to the given parent. This happens when moving
167  * a container or when inserting a new container at a specific place in the
168  * tree.
169  *
170  * ignore_focus is to just insert the Con at the end (useful when creating a
171  * new split container *around* some containers, that is, detaching and
172  * attaching them in order without wanting to mess with the focus in between).
173  *
174  */
175 void con_attach(Con *con, Con *parent, bool ignore_focus) {
176     _con_attach(con, parent, NULL, ignore_focus);
177 }
178
179 /*
180  * Detaches the given container from its current parent
181  *
182  */
183 void con_detach(Con *con) {
184     con_force_split_parents_redraw(con);
185     if (con->type == CT_FLOATING_CON) {
186         TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
187         TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
188     } else {
189         TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
190         TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
191     }
192 }
193
194 /*
195  * Sets input focus to the given container. Will be updated in X11 in the next
196  * run of x_push_changes().
197  *
198  */
199 void con_focus(Con *con) {
200     assert(con != NULL);
201     DLOG("con_focus = %p\n", con);
202
203     /* 1: set focused-pointer to the new con */
204     /* 2: exchange the position of the container in focus stack of the parent all the way up */
205     TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
206     TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
207     if (con->parent->parent != NULL)
208         con_focus(con->parent);
209
210     focused = con;
211     /* We can't blindly reset non-leaf containers since they might have
212      * other urgent children. Therefore we only reset leafs and propagate
213      * the changes upwards via con_update_parents_urgency() which does proper
214      * checks before resetting the urgency.
215      */
216     if (con->urgent && con_is_leaf(con)) {
217         con_set_urgency(con, false);
218         con_update_parents_urgency(con);
219         workspace_update_urgent_flag(con_get_workspace(con));
220         ipc_send_window_event("urgent", con);
221     }
222 }
223
224 /*
225  * Closes the given container.
226  *
227  */
228 void con_close(Con *con, kill_window_t kill_window) {
229     assert(con != NULL);
230     DLOG("Closing con = %p.\n", con);
231
232     /* We never close output or root containers. */
233     if (con->type == CT_OUTPUT || con->type == CT_ROOT) {
234         DLOG("con = %p is of type %d, not closing anything.\n", con, con->type);
235         return;
236     }
237
238     if (con->type == CT_WORKSPACE) {
239         DLOG("con = %p is a workspace, closing all children instead.\n", con);
240         Con *child, *nextchild;
241         for (child = TAILQ_FIRST(&(con->focus_head)); child;) {
242             nextchild = TAILQ_NEXT(child, focused);
243             DLOG("killing child = %p.\n", child);
244             tree_close_internal(child, kill_window, false, false);
245             child = nextchild;
246         }
247
248         return;
249     }
250
251     tree_close_internal(con, kill_window, false, false);
252 }
253
254 /*
255  * Returns true when this node is a leaf node (has no children)
256  *
257  */
258 bool con_is_leaf(Con *con) {
259     return TAILQ_EMPTY(&(con->nodes_head));
260 }
261
262 /*
263  * Returns true when this con is a leaf node with a managed X11 window (e.g.,
264  * excluding dock containers)
265  */
266 bool con_has_managed_window(Con *con) {
267     return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
268 }
269
270 /**
271  * Returns true if this node has regular or floating children.
272  *
273  */
274 bool con_has_children(Con *con) {
275     return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
276 }
277
278 /*
279  * Returns true if a container should be considered split.
280  *
281  */
282 bool con_is_split(Con *con) {
283     if (con_is_leaf(con))
284         return false;
285
286     switch (con->layout) {
287         case L_DOCKAREA:
288         case L_OUTPUT:
289             return false;
290
291         default:
292             return true;
293     }
294 }
295
296 /*
297  * This will only return true for containers which have some parent with
298  * a tabbed / stacked parent of which they are not the currently focused child.
299  *
300  */
301 bool con_is_hidden(Con *con) {
302     Con *current = con;
303
304     /* ascend to the workspace level and memorize the highest-up container
305      * which is stacked or tabbed. */
306     while (current != NULL && current->type != CT_WORKSPACE) {
307         Con *parent = current->parent;
308         if (parent != NULL && (parent->layout == L_TABBED || parent->layout == L_STACKED)) {
309             if (TAILQ_FIRST(&(parent->focus_head)) != current)
310                 return true;
311         }
312
313         current = parent;
314     }
315
316     return false;
317 }
318
319 /*
320  * Returns whether the container or any of its children is sticky.
321  *
322  */
323 bool con_is_sticky(Con *con) {
324     if (con->sticky)
325         return true;
326
327     Con *child;
328     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
329         if (con_is_sticky(child))
330             return true;
331     }
332
333     return false;
334 }
335
336 /*
337  * Returns true if this node accepts a window (if the node swallows windows,
338  * it might already have swallowed enough and cannot hold any more).
339  *
340  */
341 bool con_accepts_window(Con *con) {
342     /* 1: workspaces never accept direct windows */
343     if (con->type == CT_WORKSPACE)
344         return false;
345
346     if (con_is_split(con)) {
347         DLOG("container %p does not accept windows, it is a split container.\n", con);
348         return false;
349     }
350
351     /* TODO: if this is a swallowing container, we need to check its max_clients */
352     return (con->window == NULL);
353 }
354
355 /*
356  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
357  * node is on.
358  *
359  */
360 Con *con_get_output(Con *con) {
361     Con *result = con;
362     while (result != NULL && result->type != CT_OUTPUT)
363         result = result->parent;
364     /* We must be able to get an output because focus can never be set higher
365      * in the tree (root node cannot be focused). */
366     assert(result != NULL);
367     return result;
368 }
369
370 /*
371  * Gets the workspace container this node is on.
372  *
373  */
374 Con *con_get_workspace(Con *con) {
375     Con *result = con;
376     while (result != NULL && result->type != CT_WORKSPACE)
377         result = result->parent;
378     return result;
379 }
380
381 /*
382  * Searches parenst of the given 'con' until it reaches one with the specified
383  * 'orientation'. Aborts when it comes across a floating_con.
384  *
385  */
386 Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
387     DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
388     Con *parent = con->parent;
389     if (parent->type == CT_FLOATING_CON)
390         return NULL;
391     while (con_orientation(parent) != orientation) {
392         DLOG("Need to go one level further up\n");
393         parent = parent->parent;
394         /* Abort when we reach a floating con, or an output con */
395         if (parent &&
396             (parent->type == CT_FLOATING_CON ||
397              parent->type == CT_OUTPUT ||
398              (parent->parent && parent->parent->type == CT_OUTPUT)))
399             parent = NULL;
400         if (parent == NULL)
401             break;
402     }
403     DLOG("Result: %p\n", parent);
404     return parent;
405 }
406
407 /*
408  * helper data structure for the breadth-first-search in
409  * con_get_fullscreen_con()
410  *
411  */
412 struct bfs_entry {
413     Con *con;
414
415     TAILQ_ENTRY(bfs_entry)
416     entries;
417 };
418
419 /*
420  * Returns the first fullscreen node below this node.
421  *
422  */
423 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode) {
424     Con *current, *child;
425
426     /* TODO: is breadth-first-search really appropriate? (check as soon as
427      * fullscreen levels and fullscreen for containers is implemented) */
428     TAILQ_HEAD(bfs_head, bfs_entry)
429     bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
430
431     struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
432     entry->con = con;
433     TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
434
435     while (!TAILQ_EMPTY(&bfs_head)) {
436         entry = TAILQ_FIRST(&bfs_head);
437         current = entry->con;
438         if (current != con && current->fullscreen_mode == fullscreen_mode) {
439             /* empty the queue */
440             while (!TAILQ_EMPTY(&bfs_head)) {
441                 entry = TAILQ_FIRST(&bfs_head);
442                 TAILQ_REMOVE(&bfs_head, entry, entries);
443                 free(entry);
444             }
445             return current;
446         }
447
448         TAILQ_REMOVE(&bfs_head, entry, entries);
449         free(entry);
450
451         TAILQ_FOREACH(child, &(current->nodes_head), nodes) {
452             entry = smalloc(sizeof(struct bfs_entry));
453             entry->con = child;
454             TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
455         }
456
457         TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
458             entry = smalloc(sizeof(struct bfs_entry));
459             entry->con = child;
460             TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
461         }
462     }
463
464     return NULL;
465 }
466
467 /**
468  * Returns true if the container is internal, such as __i3_scratch
469  *
470  */
471 bool con_is_internal(Con *con) {
472     return (con->name[0] == '_' && con->name[1] == '_');
473 }
474
475 /*
476  * Returns true if the node is floating.
477  *
478  */
479 bool con_is_floating(Con *con) {
480     assert(con != NULL);
481     DLOG("checking if con %p is floating\n", con);
482     return (con->floating >= FLOATING_AUTO_ON);
483 }
484
485 /*
486  * Returns true if the container is a docked container.
487  *
488  */
489 bool con_is_docked(Con *con) {
490     if (con->parent == NULL)
491         return false;
492
493     if (con->parent->type == CT_DOCKAREA)
494         return true;
495
496     return con_is_docked(con->parent);
497 }
498
499 /*
500  * Checks if the given container is either floating or inside some floating
501  * container. It returns the FLOATING_CON container.
502  *
503  */
504 Con *con_inside_floating(Con *con) {
505     assert(con != NULL);
506     if (con->type == CT_FLOATING_CON)
507         return con;
508
509     if (con->floating >= FLOATING_AUTO_ON)
510         return con->parent;
511
512     if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
513         return NULL;
514
515     return con_inside_floating(con->parent);
516 }
517
518 /*
519  * Checks if the given container is inside a focused container.
520  *
521  */
522 bool con_inside_focused(Con *con) {
523     if (con == focused)
524         return true;
525     if (!con->parent)
526         return false;
527     return con_inside_focused(con->parent);
528 }
529
530 /*
531  * Checks if the container has the given parent as an actual parent.
532  *
533  */
534 bool con_has_parent(Con *con, Con *parent) {
535     Con *current = con->parent;
536     if (current == NULL) {
537         return false;
538     }
539
540     if (current == parent) {
541         return true;
542     }
543
544     return con_has_parent(current, parent);
545 }
546
547 /*
548  * Returns the container with the given client window ID or NULL if no such
549  * container exists.
550  *
551  */
552 Con *con_by_window_id(xcb_window_t window) {
553     Con *con;
554     TAILQ_FOREACH(con, &all_cons, all_cons)
555     if (con->window != NULL && con->window->id == window)
556         return con;
557     return NULL;
558 }
559
560 /*
561  * Returns the container with the given container ID or NULL if no such
562  * container exists.
563  *
564  */
565 Con *con_by_con_id(long target) {
566     Con *con;
567     TAILQ_FOREACH(con, &all_cons, all_cons) {
568         if (con == (Con *)target) {
569             return con;
570         }
571     }
572
573     return NULL;
574 }
575
576 /*
577  * Returns the container with the given frame ID or NULL if no such container
578  * exists.
579  *
580  */
581 Con *con_by_frame_id(xcb_window_t frame) {
582     Con *con;
583     TAILQ_FOREACH(con, &all_cons, all_cons)
584     if (con->frame.id == frame)
585         return con;
586     return NULL;
587 }
588
589 /*
590  * Returns the container with the given mark or NULL if no such container
591  * exists.
592  *
593  */
594 Con *con_by_mark(const char *mark) {
595     Con *con;
596     TAILQ_FOREACH(con, &all_cons, all_cons) {
597         if (con_has_mark(con, mark))
598             return con;
599     }
600
601     return NULL;
602 }
603
604 /*
605  * Returns true if and only if the given containers holds the mark.
606  *
607  */
608 bool con_has_mark(Con *con, const char *mark) {
609     mark_t *current;
610     TAILQ_FOREACH(current, &(con->marks_head), marks) {
611         if (strcmp(current->name, mark) == 0)
612             return true;
613     }
614
615     return false;
616 }
617
618 /*
619  * Toggles the mark on a container.
620  * If the container already has this mark, the mark is removed.
621  * Otherwise, the mark is assigned to the container.
622  *
623  */
624 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode) {
625     assert(con != NULL);
626     DLOG("Toggling mark \"%s\" on con = %p.\n", mark, con);
627
628     if (con_has_mark(con, mark)) {
629         con_unmark(con, mark);
630     } else {
631         con_mark(con, mark, mode);
632     }
633 }
634
635 /*
636  * Assigns a mark to the container.
637  *
638  */
639 void con_mark(Con *con, const char *mark, mark_mode_t mode) {
640     assert(con != NULL);
641     DLOG("Setting mark \"%s\" on con = %p.\n", mark, con);
642
643     con_unmark(NULL, mark);
644     if (mode == MM_REPLACE) {
645         DLOG("Removing all existing marks on con = %p.\n", con);
646
647         mark_t *current;
648         while (!TAILQ_EMPTY(&(con->marks_head))) {
649             current = TAILQ_FIRST(&(con->marks_head));
650             con_unmark(con, current->name);
651         }
652     }
653
654     mark_t *new = scalloc(1, sizeof(mark_t));
655     new->name = sstrdup(mark);
656     TAILQ_INSERT_TAIL(&(con->marks_head), new, marks);
657     ipc_send_window_event("mark", con);
658
659     con->mark_changed = true;
660 }
661
662 /*
663  * Removes marks from containers.
664  * If con is NULL, all containers are considered.
665  * If name is NULL, this removes all existing marks.
666  * Otherwise, it will only remove the given mark (if it is present).
667  *
668  */
669 void con_unmark(Con *con, const char *name) {
670     Con *current;
671     if (name == NULL) {
672         DLOG("Unmarking all containers.\n");
673         TAILQ_FOREACH(current, &all_cons, all_cons) {
674             if (con != NULL && current != con)
675                 continue;
676
677             if (TAILQ_EMPTY(&(current->marks_head)))
678                 continue;
679
680             mark_t *mark;
681             while (!TAILQ_EMPTY(&(current->marks_head))) {
682                 mark = TAILQ_FIRST(&(current->marks_head));
683                 FREE(mark->name);
684                 TAILQ_REMOVE(&(current->marks_head), mark, marks);
685                 FREE(mark);
686
687                 ipc_send_window_event("mark", current);
688             }
689
690             current->mark_changed = true;
691         }
692     } else {
693         DLOG("Removing mark \"%s\".\n", name);
694         current = (con == NULL) ? con_by_mark(name) : con;
695         if (current == NULL) {
696             DLOG("No container found with this mark, so there is nothing to do.\n");
697             return;
698         }
699
700         DLOG("Found mark on con = %p. Removing it now.\n", current);
701         current->mark_changed = true;
702
703         mark_t *mark;
704         TAILQ_FOREACH(mark, &(current->marks_head), marks) {
705             if (strcmp(mark->name, name) != 0)
706                 continue;
707
708             FREE(mark->name);
709             TAILQ_REMOVE(&(current->marks_head), mark, marks);
710             FREE(mark);
711
712             ipc_send_window_event("mark", current);
713             break;
714         }
715     }
716 }
717
718 /*
719  * Returns the first container below 'con' which wants to swallow this window
720  * TODO: priority
721  *
722  */
723 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
724     Con *child;
725     Match *match;
726     //DLOG("searching con for window %p starting at con %p\n", window, con);
727     //DLOG("class == %s\n", window->class_class);
728
729     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
730         TAILQ_FOREACH(match, &(child->swallow_head), matches) {
731             if (!match_matches_window(match, window))
732                 continue;
733             if (store_match != NULL)
734                 *store_match = match;
735             return child;
736         }
737         Con *result = con_for_window(child, window, store_match);
738         if (result != NULL)
739             return result;
740     }
741
742     TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
743         TAILQ_FOREACH(match, &(child->swallow_head), matches) {
744             if (!match_matches_window(match, window))
745                 continue;
746             if (store_match != NULL)
747                 *store_match = match;
748             return child;
749         }
750         Con *result = con_for_window(child, window, store_match);
751         if (result != NULL)
752             return result;
753     }
754
755     return NULL;
756 }
757
758 /*
759  * Returns the number of children of this container.
760  *
761  */
762 int con_num_children(Con *con) {
763     Con *child;
764     int children = 0;
765
766     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
767     children++;
768
769     return children;
770 }
771
772 /**
773  * Returns the number of visible non-floating children of this container.
774  * For example, if the container contains a hsplit which has two children,
775  * this will return 2 instead of 1.
776  */
777 int con_num_visible_children(Con *con) {
778     if (con == NULL)
779         return 0;
780
781     int children = 0;
782     Con *current = NULL;
783     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
784         /* Visible leaf nodes are a child. */
785         if (!con_is_hidden(current) && con_is_leaf(current))
786             children++;
787         /* All other containers need to be recursed. */
788         else
789             children += con_num_visible_children(current);
790     }
791
792     return children;
793 }
794
795 /*
796  * Count the number of windows (i.e., leaf containers).
797  *
798  */
799 int con_num_windows(Con *con) {
800     if (con == NULL)
801         return 0;
802
803     if (con_has_managed_window(con))
804         return 1;
805
806     int num = 0;
807     Con *current = NULL;
808     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
809         num += con_num_windows(current);
810     }
811
812     return num;
813 }
814
815 /*
816  * Updates the percent attribute of the children of the given container. This
817  * function needs to be called when a window is added or removed from a
818  * container.
819  *
820  */
821 void con_fix_percent(Con *con) {
822     Con *child;
823     int children = con_num_children(con);
824
825     // calculate how much we have distributed and how many containers
826     // with a percentage set we have
827     double total = 0.0;
828     int children_with_percent = 0;
829     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
830         if (child->percent > 0.0) {
831             total += child->percent;
832             ++children_with_percent;
833         }
834     }
835
836     // if there were children without a percentage set, set to a value that
837     // will make those children proportional to all others
838     if (children_with_percent != children) {
839         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
840             if (child->percent <= 0.0) {
841                 if (children_with_percent == 0) {
842                     total += (child->percent = 1.0);
843                 } else {
844                     total += (child->percent = total / children_with_percent);
845                 }
846             }
847         }
848     }
849
850     // if we got a zero, just distribute the space equally, otherwise
851     // distribute according to the proportions we got
852     if (total == 0.0) {
853         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
854             child->percent = 1.0 / children;
855         }
856     } else if (total != 1.0) {
857         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
858             child->percent /= total;
859         }
860     }
861 }
862
863 /*
864  * Toggles fullscreen mode for the given container. If there already is a
865  * fullscreen container on this workspace, fullscreen will be disabled and then
866  * enabled for the container the user wants to have in fullscreen mode.
867  *
868  */
869 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
870     if (con->type == CT_WORKSPACE) {
871         DLOG("You cannot make a workspace fullscreen.\n");
872         return;
873     }
874
875     DLOG("toggling fullscreen for %p / %s\n", con, con->name);
876
877     if (con->fullscreen_mode == CF_NONE)
878         con_enable_fullscreen(con, fullscreen_mode);
879     else
880         con_disable_fullscreen(con);
881 }
882
883 /*
884  * Sets the specified fullscreen mode for the given container, sends the
885  * “fullscreen_mode” event and changes the XCB fullscreen property of the
886  * container’s window, if any.
887  *
888  */
889 static void con_set_fullscreen_mode(Con *con, fullscreen_mode_t fullscreen_mode) {
890     con->fullscreen_mode = fullscreen_mode;
891
892     DLOG("mode now: %d\n", con->fullscreen_mode);
893
894     /* Send an ipc window "fullscreen_mode" event */
895     ipc_send_window_event("fullscreen_mode", con);
896
897     /* update _NET_WM_STATE if this container has a window */
898     /* TODO: when a window is assigned to a container which is already
899      * fullscreened, this state needs to be pushed to the client, too */
900     if (con->window == NULL)
901         return;
902
903     if (con->fullscreen_mode != CF_NONE) {
904         DLOG("Setting _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
905         xcb_add_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
906     } else {
907         DLOG("Removing _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
908         xcb_remove_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
909     }
910 }
911
912 /*
913  * Enables fullscreen mode for the given container, if necessary.
914  *
915  * If the container’s mode is already CF_OUTPUT or CF_GLOBAL, the container is
916  * kept fullscreen but its mode is set to CF_GLOBAL and CF_OUTPUT,
917  * respectively.
918  *
919  * Other fullscreen containers will be disabled first, if they hide the new
920  * one.
921  *
922  */
923 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode) {
924     if (con->type == CT_WORKSPACE) {
925         DLOG("You cannot make a workspace fullscreen.\n");
926         return;
927     }
928
929     assert(fullscreen_mode == CF_GLOBAL || fullscreen_mode == CF_OUTPUT);
930
931     if (fullscreen_mode == CF_GLOBAL)
932         DLOG("enabling global fullscreen for %p / %s\n", con, con->name);
933     else
934         DLOG("enabling fullscreen for %p / %s\n", con, con->name);
935
936     if (con->fullscreen_mode == fullscreen_mode) {
937         DLOG("fullscreen already enabled for %p / %s\n", con, con->name);
938         return;
939     }
940
941     Con *con_ws = con_get_workspace(con);
942
943     /* Disable any fullscreen container that would conflict the new one. */
944     Con *fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
945     if (fullscreen == NULL)
946         fullscreen = con_get_fullscreen_con(con_ws, CF_OUTPUT);
947     if (fullscreen != NULL)
948         con_disable_fullscreen(fullscreen);
949
950     /* Set focus to new fullscreen container. Unless in global fullscreen mode
951      * and on another workspace restore focus afterwards.
952      * Switch to the container’s workspace if mode is global. */
953     Con *cur_ws = con_get_workspace(focused);
954     Con *old_focused = focused;
955     if (fullscreen_mode == CF_GLOBAL && cur_ws != con_ws)
956         workspace_show(con_ws);
957     con_focus(con);
958     if (fullscreen_mode != CF_GLOBAL && cur_ws != con_ws)
959         con_focus(old_focused);
960
961     con_set_fullscreen_mode(con, fullscreen_mode);
962 }
963
964 /*
965  * Disables fullscreen mode for the given container regardless of the mode, if
966  * necessary.
967  *
968  */
969 void con_disable_fullscreen(Con *con) {
970     if (con->type == CT_WORKSPACE) {
971         DLOG("You cannot make a workspace fullscreen.\n");
972         return;
973     }
974
975     DLOG("disabling fullscreen for %p / %s\n", con, con->name);
976
977     if (con->fullscreen_mode == CF_NONE) {
978         DLOG("fullscreen already disabled for %p / %s\n", con, con->name);
979         return;
980     }
981
982     con_set_fullscreen_mode(con, CF_NONE);
983 }
984
985 static bool _con_move_to_con(Con *con, Con *target, bool behind_focused, bool fix_coordinates, bool dont_warp, bool ignore_focus, bool fix_percentage) {
986     Con *orig_target = target;
987
988     /* Prevent moving if this would violate the fullscreen focus restrictions. */
989     Con *target_ws = con_get_workspace(target);
990     if (!con_fullscreen_permits_focusing(target_ws)) {
991         LOG("Cannot move out of a fullscreen container.\n");
992         return false;
993     }
994
995     if (con_is_floating(con)) {
996         DLOG("Container is floating, using parent instead.\n");
997         con = con->parent;
998     }
999
1000     Con *source_ws = con_get_workspace(con);
1001
1002     if (con->type == CT_WORKSPACE) {
1003         /* Re-parent all of the old workspace's floating windows. */
1004         Con *child;
1005         while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
1006             child = TAILQ_FIRST(&(source_ws->floating_head));
1007             con_move_to_workspace(child, target_ws, true, true, false);
1008         }
1009
1010         /* If there are no non-floating children, ignore the workspace. */
1011         if (con_is_leaf(con))
1012             return false;
1013
1014         con = workspace_encapsulate(con);
1015         if (con == NULL) {
1016             ELOG("Workspace failed to move its contents into a container!\n");
1017             return false;
1018         }
1019     }
1020
1021     /* Save the urgency state so that we can restore it. */
1022     bool urgent = con->urgent;
1023
1024     /* Save the current workspace. So we can call workspace_show() by the end
1025      * of this function. */
1026     Con *current_ws = con_get_workspace(focused);
1027
1028     Con *source_output = con_get_output(con),
1029         *dest_output = con_get_output(target_ws);
1030
1031     /* 1: save the container which is going to be focused after the current
1032      * container is moved away */
1033     Con *focus_next = con_next_focused(con);
1034
1035     /* 2: we go up one level, but only when target is a normal container */
1036     if (target->type != CT_WORKSPACE) {
1037         DLOG("target originally = %p / %s / type %d\n", target, target->name, target->type);
1038         target = target->parent;
1039     }
1040
1041     /* 3: if the target container is floating, we get the workspace instead.
1042      * Only tiling windows need to get inserted next to the current container.
1043      * */
1044     Con *floatingcon = con_inside_floating(target);
1045     if (floatingcon != NULL) {
1046         DLOG("floatingcon, going up even further\n");
1047         target = floatingcon->parent;
1048     }
1049
1050     if (con->type == CT_FLOATING_CON) {
1051         Con *ws = con_get_workspace(target);
1052         DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
1053         target = ws;
1054     }
1055
1056     if (source_output != dest_output) {
1057         /* Take the relative coordinates of the current output, then add them
1058          * to the coordinate space of the correct output */
1059         if (fix_coordinates && con->type == CT_FLOATING_CON) {
1060             floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
1061         } else
1062             DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
1063
1064         /* If moving to a visible workspace, call show so it can be considered
1065          * focused. Must do before attaching because workspace_show checks to see
1066          * if focused container is in its area. */
1067         if (!ignore_focus && workspace_is_visible(target_ws)) {
1068             workspace_show(target_ws);
1069
1070             /* Don’t warp if told so (when dragging floating windows with the
1071              * mouse for example) */
1072             if (dont_warp)
1073                 x_set_warp_to(NULL);
1074             else
1075                 x_set_warp_to(&(con->rect));
1076         }
1077     }
1078
1079     /* If moving a fullscreen container and the destination already has a
1080      * fullscreen window on it, un-fullscreen the target's fullscreen con. */
1081     Con *fullscreen = con_get_fullscreen_con(target_ws, CF_OUTPUT);
1082     if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
1083         con_toggle_fullscreen(fullscreen, CF_OUTPUT);
1084         fullscreen = NULL;
1085     }
1086
1087     DLOG("Re-attaching container to %p / %s\n", target, target->name);
1088     /* 4: re-attach the con to the parent of this focused container */
1089     Con *parent = con->parent;
1090     con_detach(con);
1091     _con_attach(con, target, behind_focused ? NULL : orig_target, !behind_focused);
1092
1093     /* 5: fix the percentages */
1094     if (fix_percentage) {
1095         con_fix_percent(parent);
1096         con->percent = 0.0;
1097         con_fix_percent(target);
1098     }
1099
1100     /* 6: focus the con on the target workspace, but only within that
1101      * workspace, that is, don’t move focus away if the target workspace is
1102      * invisible.
1103      * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
1104      * we don’t focus when there is a fullscreen con on that workspace. We
1105      * also don't do it if the caller requested to ignore focus. */
1106     if (!ignore_focus && !con_is_internal(target_ws) && !fullscreen) {
1107         /* We need to save the focused workspace on the output in case the
1108          * new workspace is hidden and it's necessary to immediately switch
1109          * back to the originally-focused workspace. */
1110         Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
1111         con_focus(con_descend_focused(con));
1112
1113         /* Restore focus if the output's focused workspace has changed. */
1114         if (con_get_workspace(focused) != old_focus)
1115             con_focus(old_focus);
1116     }
1117
1118     /* 7: when moving to another workspace, we leave the focus on the current
1119      * workspace. (see also #809) */
1120
1121     /* Descend focus stack in case focus_next is a workspace which can
1122      * occur if we move to the same workspace.  Also show current workspace
1123      * to ensure it is focused. */
1124     if (!ignore_focus) {
1125         workspace_show(current_ws);
1126         if (dont_warp) {
1127             DLOG("x_set_warp_to(NULL) because dont_warp is set\n");
1128             x_set_warp_to(NULL);
1129         }
1130     }
1131
1132     /* Set focus only if con was on current workspace before moving.
1133      * Otherwise we would give focus to some window on different workspace. */
1134     if (!ignore_focus && source_ws == current_ws)
1135         con_focus(con_descend_focused(focus_next));
1136
1137     /* 8. If anything within the container is associated with a startup sequence,
1138      * delete it so child windows won't be created on the old workspace. */
1139     struct Startup_Sequence *sequence;
1140     xcb_get_property_cookie_t cookie;
1141     xcb_get_property_reply_t *startup_id_reply;
1142
1143     if (!con_is_leaf(con)) {
1144         Con *child;
1145         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1146             if (!child->window)
1147                 continue;
1148
1149             cookie = xcb_get_property(conn, false, child->window->id,
1150                                       A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1151             startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1152
1153             sequence = startup_sequence_get(child->window, startup_id_reply, true);
1154             if (sequence != NULL)
1155                 startup_sequence_delete(sequence);
1156         }
1157     }
1158
1159     if (con->window) {
1160         cookie = xcb_get_property(conn, false, con->window->id,
1161                                   A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1162         startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1163
1164         sequence = startup_sequence_get(con->window, startup_id_reply, true);
1165         if (sequence != NULL)
1166             startup_sequence_delete(sequence);
1167     }
1168
1169     /* 9. If the container was marked urgent, move the urgency hint. */
1170     if (urgent) {
1171         workspace_update_urgent_flag(source_ws);
1172         con_set_urgency(con, true);
1173     }
1174
1175     /* Ensure the container will be redrawn. */
1176     FREE(con->deco_render_params);
1177
1178     CALL(parent, on_remove_child);
1179
1180     ipc_send_window_event("move", con);
1181     ewmh_update_wm_desktop();
1182     return true;
1183 }
1184
1185 /*
1186  * Moves the given container to the given mark.
1187  *
1188  */
1189 bool con_move_to_mark(Con *con, const char *mark) {
1190     Con *target = con_by_mark(mark);
1191     if (target == NULL) {
1192         DLOG("found no container with mark \"%s\"\n", mark);
1193         return false;
1194     }
1195
1196     /* For floating target containers, we just send the window to the same workspace. */
1197     if (con_is_floating(target)) {
1198         DLOG("target container is floating, moving container to target's workspace.\n");
1199         con_move_to_workspace(con, con_get_workspace(target), true, false, false);
1200         return true;
1201     }
1202
1203     if (con->type == CT_WORKSPACE) {
1204         DLOG("target container is a workspace, simply moving the container there.\n");
1205         con_move_to_workspace(con, target, true, false, false);
1206         return true;
1207     }
1208
1209     /* For split containers, we use the currently focused container within it.
1210      * This allows setting marks on, e.g., tabbed containers which will move
1211      * con to a new tab behind the focused tab. */
1212     if (con_is_split(target)) {
1213         DLOG("target is a split container, descending to the currently focused child.\n");
1214         target = TAILQ_FIRST(&(target->focus_head));
1215     }
1216
1217     if (con == target || con_has_parent(target, con)) {
1218         DLOG("cannot move the container to or inside itself, aborting.\n");
1219         return false;
1220     }
1221
1222     return _con_move_to_con(con, target, false, true, false, false, true);
1223 }
1224
1225 /*
1226  * Moves the given container to the currently focused container on the given
1227  * workspace.
1228  *
1229  * The fix_coordinates flag will translate the current coordinates (offset from
1230  * the monitor position basically) to appropriate coordinates on the
1231  * destination workspace.
1232  * Not enabling this behaviour comes in handy when this function gets called by
1233  * floating_maybe_reassign_ws, which will only "move" a floating window when it
1234  * *already* changed its coordinates to a different output.
1235  *
1236  * The dont_warp flag disables pointer warping and will be set when this
1237  * function is called while dragging a floating window.
1238  *
1239  * If ignore_focus is set, the container will be moved without modifying focus
1240  * at all.
1241  *
1242  * TODO: is there a better place for this function?
1243  *
1244  */
1245 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp, bool ignore_focus) {
1246     assert(workspace->type == CT_WORKSPACE);
1247
1248     Con *source_ws = con_get_workspace(con);
1249     if (workspace == source_ws) {
1250         DLOG("Not moving, already there\n");
1251         return;
1252     }
1253
1254     Con *target = con_descend_focused(workspace);
1255     _con_move_to_con(con, target, true, fix_coordinates, dont_warp, ignore_focus, true);
1256 }
1257
1258 /*
1259  * Moves the given container to the currently focused container on the
1260  * visible workspace on the given output.
1261  *
1262  */
1263 void con_move_to_output(Con *con, Output *output) {
1264     Con *ws = NULL;
1265     GREP_FIRST(ws, output_get_content(output->con), workspace_is_visible(child));
1266     assert(ws != NULL);
1267     DLOG("Moving con %p to output %s\n", con, output->name);
1268     con_move_to_workspace(con, ws, false, false, false);
1269 }
1270
1271 /*
1272  * Returns the orientation of the given container (for stacked containers,
1273  * vertical orientation is used regardless of the actual orientation of the
1274  * container).
1275  *
1276  */
1277 orientation_t con_orientation(Con *con) {
1278     switch (con->layout) {
1279         case L_SPLITV:
1280         /* stacking containers behave like they are in vertical orientation */
1281         case L_STACKED:
1282             return VERT;
1283
1284         case L_SPLITH:
1285         /* tabbed containers behave like they are in vertical orientation */
1286         case L_TABBED:
1287             return HORIZ;
1288
1289         case L_DEFAULT:
1290             DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
1291             assert(false);
1292             return HORIZ;
1293
1294         case L_DOCKAREA:
1295         case L_OUTPUT:
1296             DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
1297             assert(false);
1298             return HORIZ;
1299
1300         default:
1301             DLOG("con_orientation() ran into default\n");
1302             assert(false);
1303     }
1304 }
1305
1306 /*
1307  * Returns the container which will be focused next when the given container
1308  * is not available anymore. Called in tree_close_internal and con_move_to_workspace
1309  * to properly restore focus.
1310  *
1311  */
1312 Con *con_next_focused(Con *con) {
1313     Con *next;
1314     /* floating containers are attached to a workspace, so we focus either the
1315      * next floating container (if any) or the workspace itself. */
1316     if (con->type == CT_FLOATING_CON) {
1317         DLOG("selecting next for CT_FLOATING_CON\n");
1318         next = TAILQ_NEXT(con, floating_windows);
1319         DLOG("next = %p\n", next);
1320         if (!next) {
1321             next = TAILQ_PREV(con, floating_head, floating_windows);
1322             DLOG("using prev, next = %p\n", next);
1323         }
1324         if (!next) {
1325             Con *ws = con_get_workspace(con);
1326             next = ws;
1327             DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
1328             while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
1329                 next = TAILQ_FIRST(&(next->focus_head));
1330                 if (next == con) {
1331                     DLOG("skipping container itself, we want the next client\n");
1332                     next = TAILQ_NEXT(next, focused);
1333                 }
1334             }
1335             if (next == TAILQ_END(&(ws->focus_head))) {
1336                 DLOG("Focus list empty, returning ws\n");
1337                 next = ws;
1338             }
1339         } else {
1340             /* Instead of returning the next CT_FLOATING_CON, we descend it to
1341              * get an actual window to focus. */
1342             next = con_descend_focused(next);
1343         }
1344         return next;
1345     }
1346
1347     /* dock clients cannot be focused, so we focus the workspace instead */
1348     if (con->parent->type == CT_DOCKAREA) {
1349         DLOG("selecting workspace for dock client\n");
1350         return con_descend_focused(output_get_content(con->parent->parent));
1351     }
1352
1353     /* if 'con' is not the first entry in the focus stack, use the first one as
1354      * it’s currently focused already */
1355     Con *first = TAILQ_FIRST(&(con->parent->focus_head));
1356     if (first != con) {
1357         DLOG("Using first entry %p\n", first);
1358         next = first;
1359     } else {
1360         /* try to focus the next container on the same level as this one or fall
1361          * back to its parent */
1362         if (!(next = TAILQ_NEXT(con, focused))) {
1363             next = con->parent;
1364         }
1365     }
1366
1367     /* now go down the focus stack as far as
1368      * possible, excluding the current container */
1369     while (!TAILQ_EMPTY(&(next->focus_head)) && TAILQ_FIRST(&(next->focus_head)) != con) {
1370         next = TAILQ_FIRST(&(next->focus_head));
1371     }
1372
1373     return next;
1374 }
1375
1376 /*
1377  * Get the next/previous container in the specified orientation. This may
1378  * travel up until it finds a container with suitable orientation.
1379  *
1380  */
1381 Con *con_get_next(Con *con, char way, orientation_t orientation) {
1382     DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
1383     /* 1: get the first parent with the same orientation */
1384     Con *cur = con;
1385     while (con_orientation(cur->parent) != orientation) {
1386         DLOG("need to go one level further up\n");
1387         if (cur->parent->type == CT_WORKSPACE) {
1388             LOG("that's a workspace, we can't go further up\n");
1389             return NULL;
1390         }
1391         cur = cur->parent;
1392     }
1393
1394     /* 2: chose next (or previous) */
1395     Con *next;
1396     if (way == 'n') {
1397         next = TAILQ_NEXT(cur, nodes);
1398         /* if we are at the end of the list, we need to wrap */
1399         if (next == TAILQ_END(&(parent->nodes_head)))
1400             return NULL;
1401     } else {
1402         next = TAILQ_PREV(cur, nodes_head, nodes);
1403         /* if we are at the end of the list, we need to wrap */
1404         if (next == TAILQ_END(&(cur->nodes_head)))
1405             return NULL;
1406     }
1407     DLOG("next = %p\n", next);
1408
1409     return next;
1410 }
1411
1412 /*
1413  * Returns the focused con inside this client, descending the tree as far as
1414  * possible. This comes in handy when attaching a con to a workspace at the
1415  * currently focused position, for example.
1416  *
1417  */
1418 Con *con_descend_focused(Con *con) {
1419     Con *next = con;
1420     while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
1421         next = TAILQ_FIRST(&(next->focus_head));
1422     return next;
1423 }
1424
1425 /*
1426  * Returns the focused con inside this client, descending the tree as far as
1427  * possible. This comes in handy when attaching a con to a workspace at the
1428  * currently focused position, for example.
1429  *
1430  * Works like con_descend_focused but considers only tiling cons.
1431  *
1432  */
1433 Con *con_descend_tiling_focused(Con *con) {
1434     Con *next = con;
1435     Con *before;
1436     Con *child;
1437     if (next == focused)
1438         return next;
1439     do {
1440         before = next;
1441         TAILQ_FOREACH(child, &(next->focus_head), focused) {
1442             if (child->type == CT_FLOATING_CON)
1443                 continue;
1444
1445             next = child;
1446             break;
1447         }
1448     } while (before != next && next != focused);
1449     return next;
1450 }
1451
1452 /*
1453  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1454  * direction is D_LEFT, then we return the rightmost container and if direction
1455  * is D_RIGHT, we return the leftmost container.  This is because if we are
1456  * moving D_LEFT, and thus want the rightmost container.
1457  *
1458  */
1459 Con *con_descend_direction(Con *con, direction_t direction) {
1460     Con *most = NULL;
1461     Con *current;
1462     int orientation = con_orientation(con);
1463     DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1464     if (direction == D_LEFT || direction == D_RIGHT) {
1465         if (orientation == HORIZ) {
1466             /* If the direction is horizontal, we can use either the first
1467              * (D_RIGHT) or the last con (D_LEFT) */
1468             if (direction == D_RIGHT)
1469                 most = TAILQ_FIRST(&(con->nodes_head));
1470             else
1471                 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1472         } else if (orientation == VERT) {
1473             /* Wrong orientation. We use the last focused con. Within that con,
1474              * we recurse to chose the left/right con or at least the last
1475              * focused one. */
1476             TAILQ_FOREACH(current, &(con->focus_head), focused) {
1477                 if (current->type != CT_FLOATING_CON) {
1478                     most = current;
1479                     break;
1480                 }
1481             }
1482         } else {
1483             /* If the con has no orientation set, it’s not a split container
1484              * but a container with a client window, so stop recursing */
1485             return con;
1486         }
1487     }
1488
1489     if (direction == D_UP || direction == D_DOWN) {
1490         if (orientation == VERT) {
1491             /* If the direction is vertical, we can use either the first
1492              * (D_DOWN) or the last con (D_UP) */
1493             if (direction == D_UP)
1494                 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1495             else
1496                 most = TAILQ_FIRST(&(con->nodes_head));
1497         } else if (orientation == HORIZ) {
1498             /* Wrong orientation. We use the last focused con. Within that con,
1499              * we recurse to chose the top/bottom con or at least the last
1500              * focused one. */
1501             TAILQ_FOREACH(current, &(con->focus_head), focused) {
1502                 if (current->type != CT_FLOATING_CON) {
1503                     most = current;
1504                     break;
1505                 }
1506             }
1507         } else {
1508             /* If the con has no orientation set, it’s not a split container
1509              * but a container with a client window, so stop recursing */
1510             return con;
1511         }
1512     }
1513
1514     if (!most)
1515         return con;
1516     return con_descend_direction(most, direction);
1517 }
1518
1519 /*
1520  * Returns a "relative" Rect which contains the amount of pixels that need to
1521  * be added to the original Rect to get the final position (obviously the
1522  * amount of pixels for normal, 1pixel and borderless are different).
1523  *
1524  */
1525 Rect con_border_style_rect(Con *con) {
1526     if (config.hide_edge_borders == HEBM_SMART && con_num_visible_children(con_get_workspace(con)) <= 1) {
1527         if (!con_is_floating(con)) {
1528             return (Rect){0, 0, 0, 0};
1529         }
1530     }
1531
1532     adjacent_t borders_to_hide = ADJ_NONE;
1533     int border_width = con->current_border_width;
1534     DLOG("The border width for con is set to: %d\n", con->current_border_width);
1535     Rect result;
1536     if (con->current_border_width < 0) {
1537         if (con_is_floating(con)) {
1538             border_width = config.default_floating_border_width;
1539         } else {
1540             border_width = config.default_border_width;
1541         }
1542     }
1543     DLOG("Effective border width is set to: %d\n", border_width);
1544     /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1545     int border_style = con_border_style(con);
1546     if (border_style == BS_NONE)
1547         return (Rect){0, 0, 0, 0};
1548     if (border_style == BS_NORMAL) {
1549         result = (Rect){border_width, 0, -(2 * border_width), -(border_width)};
1550     } else {
1551         result = (Rect){border_width, border_width, -(2 * border_width), -(2 * border_width)};
1552     }
1553
1554     borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1555     if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1556         result.x -= border_width;
1557         result.width += border_width;
1558     }
1559     if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1560         result.width += border_width;
1561     }
1562     if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1563         result.y -= border_width;
1564         result.height += border_width;
1565     }
1566     if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1567         result.height += border_width;
1568     }
1569     return result;
1570 }
1571
1572 /*
1573  * Returns adjacent borders of the window. We need this if hide_edge_borders is
1574  * enabled.
1575  */
1576 adjacent_t con_adjacent_borders(Con *con) {
1577     adjacent_t result = ADJ_NONE;
1578     /* Floating windows are never adjacent to any other window, so
1579        don’t hide their border(s). This prevents bug #998. */
1580     if (con_is_floating(con))
1581         return result;
1582
1583     Con *workspace = con_get_workspace(con);
1584     if (con->rect.x == workspace->rect.x)
1585         result |= ADJ_LEFT_SCREEN_EDGE;
1586     if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1587         result |= ADJ_RIGHT_SCREEN_EDGE;
1588     if (con->rect.y == workspace->rect.y)
1589         result |= ADJ_UPPER_SCREEN_EDGE;
1590     if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1591         result |= ADJ_LOWER_SCREEN_EDGE;
1592     return result;
1593 }
1594
1595 /*
1596  * Use this function to get a container’s border style. This is important
1597  * because when inside a stack, the border style is always BS_NORMAL.
1598  * For tabbed mode, the same applies, with one exception: when the container is
1599  * borderless and the only element in the tabbed container, the border is not
1600  * rendered.
1601  *
1602  * For children of a CT_DOCKAREA, the border style is always none.
1603  *
1604  */
1605 int con_border_style(Con *con) {
1606     Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1607     if (fs == con) {
1608         DLOG("this one is fullscreen! overriding BS_NONE\n");
1609         return BS_NONE;
1610     }
1611
1612     if (con->parent->layout == L_STACKED)
1613         return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1614
1615     if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1616         return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1617
1618     if (con->parent->type == CT_DOCKAREA)
1619         return BS_NONE;
1620
1621     return con->border_style;
1622 }
1623
1624 /*
1625  * Sets the given border style on con, correctly keeping the position/size of a
1626  * floating window.
1627  *
1628  */
1629 void con_set_border_style(Con *con, int border_style, int border_width) {
1630     /* Handle the simple case: non-floating containerns */
1631     if (!con_is_floating(con)) {
1632         con->border_style = border_style;
1633         con->current_border_width = border_width;
1634         return;
1635     }
1636
1637     /* For floating containers, we want to keep the position/size of the
1638      * *window* itself. We first add the border pixels to con->rect to make
1639      * con->rect represent the absolute position of the window (same for
1640      * parent). Then, we change the border style and subtract the new border
1641      * pixels. For the parent, we do the same also for the decoration. */
1642     DLOG("This is a floating container\n");
1643
1644     Con *parent = con->parent;
1645     Rect bsr = con_border_style_rect(con);
1646     int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1647
1648     con->rect = rect_add(con->rect, bsr);
1649     parent->rect = rect_add(parent->rect, bsr);
1650     parent->rect.y += deco_height;
1651     parent->rect.height -= deco_height;
1652
1653     /* Change the border style, get new border/decoration values. */
1654     con->border_style = border_style;
1655     con->current_border_width = border_width;
1656     bsr = con_border_style_rect(con);
1657     deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1658
1659     con->rect = rect_sub(con->rect, bsr);
1660     parent->rect = rect_sub(parent->rect, bsr);
1661     parent->rect.y -= deco_height;
1662     parent->rect.height += deco_height;
1663 }
1664
1665 /*
1666  * This function changes the layout of a given container. Use it to handle
1667  * special cases like changing a whole workspace to stacked/tabbed (creates a
1668  * new split container before).
1669  *
1670  */
1671 void con_set_layout(Con *con, layout_t layout) {
1672     DLOG("con_set_layout(%p, %d), con->type = %d\n",
1673          con, layout, con->type);
1674
1675     /* Users can focus workspaces, but not any higher in the hierarchy.
1676      * Focus on the workspace is a special case, since in every other case, the
1677      * user means "change the layout of the parent split container". */
1678     if (con->type != CT_WORKSPACE)
1679         con = con->parent;
1680
1681     /* We fill in last_split_layout when switching to a different layout
1682      * since there are many places in the code that don’t use
1683      * con_set_layout(). */
1684     if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1685         con->last_split_layout = con->layout;
1686
1687     /* When the container type is CT_WORKSPACE, the user wants to change the
1688      * whole workspace into stacked/tabbed mode. To do this and still allow
1689      * intuitive operations (like level-up and then opening a new window), we
1690      * need to create a new split container. */
1691     if (con->type == CT_WORKSPACE) {
1692         if (con_num_children(con) == 0) {
1693             layout_t ws_layout = (layout == L_STACKED || layout == L_TABBED) ? layout : L_DEFAULT;
1694             DLOG("Setting workspace_layout to %d\n", ws_layout);
1695             con->workspace_layout = ws_layout;
1696             DLOG("Setting layout to %d\n", layout);
1697             con->layout = layout;
1698         } else if (layout == L_STACKED || layout == L_TABBED) {
1699             DLOG("Creating new split container\n");
1700             /* 1: create a new split container */
1701             Con *new = con_new(NULL, NULL);
1702             new->parent = con;
1703
1704             /* 2: Set the requested layout on the split container and mark it as
1705              * split. */
1706             new->layout = layout;
1707             new->last_split_layout = con->last_split_layout;
1708
1709             /* Save the container that was focused before we move containers
1710              * around, but only if the container is visible (otherwise focus
1711              * will be restored properly automatically when switching). */
1712             Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1713             if (old_focused == TAILQ_END(&(con->focus_head)))
1714                 old_focused = NULL;
1715             if (old_focused != NULL &&
1716                 !workspace_is_visible(con_get_workspace(old_focused)))
1717                 old_focused = NULL;
1718
1719             /* 3: move the existing cons of this workspace below the new con */
1720             DLOG("Moving cons\n");
1721             Con *child;
1722             while (!TAILQ_EMPTY(&(con->nodes_head))) {
1723                 child = TAILQ_FIRST(&(con->nodes_head));
1724                 con_detach(child);
1725                 con_attach(child, new, true);
1726             }
1727
1728             /* 4: attach the new split container to the workspace */
1729             DLOG("Attaching new split to ws\n");
1730             con_attach(new, con, false);
1731
1732             if (old_focused)
1733                 con_focus(old_focused);
1734
1735             tree_flatten(croot);
1736         }
1737         con_force_split_parents_redraw(con);
1738         return;
1739     }
1740
1741     if (layout == L_DEFAULT) {
1742         /* Special case: the layout formerly known as "default" (in combination
1743          * with an orientation). Since we switched to splith/splitv layouts,
1744          * using the "default" layout (which "only" should happen when using
1745          * legacy configs) is using the last split layout (either splith or
1746          * splitv) in order to still do the same thing. */
1747         con->layout = con->last_split_layout;
1748         /* In case last_split_layout was not initialized… */
1749         if (con->layout == L_DEFAULT)
1750             con->layout = L_SPLITH;
1751     } else {
1752         con->layout = layout;
1753     }
1754     con_force_split_parents_redraw(con);
1755 }
1756
1757 /*
1758  * This function toggles the layout of a given container. toggle_mode can be
1759  * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1760  * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1761  * layouts).
1762  *
1763  */
1764 void con_toggle_layout(Con *con, const char *toggle_mode) {
1765     Con *parent = con;
1766     /* Users can focus workspaces, but not any higher in the hierarchy.
1767      * Focus on the workspace is a special case, since in every other case, the
1768      * user means "change the layout of the parent split container". */
1769     if (con->type != CT_WORKSPACE)
1770         parent = con->parent;
1771     DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1772
1773     const char delim[] = " ";
1774
1775     if (strcasecmp(toggle_mode, "split") == 0 || strstr(toggle_mode, delim)) {
1776         /* L_DEFAULT is used as a placeholder value to distinguish if
1777          * the first layout has already been saved. (it can never be L_DEFAULT) */
1778         layout_t new_layout = L_DEFAULT;
1779         bool current_layout_found = false;
1780         char *tm_dup = sstrdup(toggle_mode);
1781         char *cur_tok = strtok(tm_dup, delim);
1782
1783         for (layout_t layout; cur_tok != NULL; cur_tok = strtok(NULL, delim)) {
1784             if (strcasecmp(cur_tok, "split") == 0) {
1785                 /* Toggle between splits. When the current layout is not a split
1786                  * layout, we just switch back to last_split_layout. Otherwise, we
1787                  * change to the opposite split layout. */
1788                 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV) {
1789                     layout = parent->last_split_layout;
1790                 } else {
1791                     layout = (parent->layout == L_SPLITH) ? L_SPLITV : L_SPLITH;
1792                 }
1793             } else {
1794                 bool success = layout_from_name(cur_tok, &layout);
1795                 if (!success || layout == L_DEFAULT) {
1796                     ELOG("The token '%s' was not recognized and has been skipped.\n", cur_tok);
1797                     continue;
1798                 }
1799             }
1800
1801             /* If none of the specified layouts match the current,
1802              * fall back to the first layout in the list */
1803             if (new_layout == L_DEFAULT) {
1804                 new_layout = layout;
1805             }
1806
1807             /* We found the active layout in the last iteration, so
1808              * now let's activate the current layout (next in list) */
1809             if (current_layout_found) {
1810                 new_layout = layout;
1811                 free(tm_dup);
1812                 break;
1813             }
1814
1815             if (parent->layout == layout) {
1816                 current_layout_found = true;
1817             }
1818         }
1819
1820         con_set_layout(con, new_layout);
1821     } else if (strcasecmp(toggle_mode, "all") == 0 || strcasecmp(toggle_mode, "default") == 0) {
1822         if (parent->layout == L_STACKED)
1823             con_set_layout(con, L_TABBED);
1824         else if (parent->layout == L_TABBED) {
1825             if (strcasecmp(toggle_mode, "all") == 0)
1826                 con_set_layout(con, L_SPLITH);
1827             else
1828                 con_set_layout(con, parent->last_split_layout);
1829         } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1830             if (strcasecmp(toggle_mode, "all") == 0) {
1831                 /* When toggling through all modes, we toggle between
1832                  * splith/splitv, whereas normally we just directly jump to
1833                  * stacked. */
1834                 if (parent->layout == L_SPLITH)
1835                     con_set_layout(con, L_SPLITV);
1836                 else
1837                     con_set_layout(con, L_STACKED);
1838             } else {
1839                 con_set_layout(con, L_STACKED);
1840             }
1841         }
1842     }
1843 }
1844
1845 /*
1846  * Callback which will be called when removing a child from the given con.
1847  * Kills the container if it is empty and replaces it with the child if there
1848  * is exactly one child.
1849  *
1850  */
1851 static void con_on_remove_child(Con *con) {
1852     DLOG("on_remove_child\n");
1853
1854     /* Every container 'above' (in the hierarchy) the workspace content should
1855      * not be closed when the last child was removed */
1856     if (con->type == CT_OUTPUT ||
1857         con->type == CT_ROOT ||
1858         con->type == CT_DOCKAREA ||
1859         (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1860         DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1861         return;
1862     }
1863
1864     /* For workspaces, close them only if they're not visible anymore */
1865     if (con->type == CT_WORKSPACE) {
1866         if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1867             LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1868             yajl_gen gen = ipc_marshal_workspace_event("empty", con, NULL);
1869             tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1870
1871             const unsigned char *payload;
1872             ylength length;
1873             y(get_buf, &payload, &length);
1874             ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1875
1876             y(free);
1877         }
1878         return;
1879     }
1880
1881     con_force_split_parents_redraw(con);
1882     con->urgent = con_has_urgent_child(con);
1883     con_update_parents_urgency(con);
1884
1885     /* TODO: check if this container would swallow any other client and
1886      * don’t close it automatically. */
1887     int children = con_num_children(con);
1888     if (children == 0) {
1889         DLOG("Container empty, closing\n");
1890         tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1891         return;
1892     }
1893 }
1894
1895 /*
1896  * Determines the minimum size of the given con by looking at its children (for
1897  * split/stacked/tabbed cons). Will be called when resizing floating cons
1898  *
1899  */
1900 Rect con_minimum_size(Con *con) {
1901     DLOG("Determining minimum size for con %p\n", con);
1902
1903     if (con_is_leaf(con)) {
1904         DLOG("leaf node, returning 75x50\n");
1905         return (Rect){0, 0, 75, 50};
1906     }
1907
1908     if (con->type == CT_FLOATING_CON) {
1909         DLOG("floating con\n");
1910         Con *child = TAILQ_FIRST(&(con->nodes_head));
1911         return con_minimum_size(child);
1912     }
1913
1914     if (con->layout == L_STACKED || con->layout == L_TABBED) {
1915         uint32_t max_width = 0, max_height = 0, deco_height = 0;
1916         Con *child;
1917         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1918             Rect min = con_minimum_size(child);
1919             deco_height += child->deco_rect.height;
1920             max_width = max(max_width, min.width);
1921             max_height = max(max_height, min.height);
1922         }
1923         DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1924              max_width, max_height, deco_height);
1925         return (Rect){0, 0, max_width, max_height + deco_height};
1926     }
1927
1928     /* For horizontal/vertical split containers we sum up the width (h-split)
1929      * or height (v-split) and use the maximum of the height (h-split) or width
1930      * (v-split) as minimum size. */
1931     if (con_is_split(con)) {
1932         uint32_t width = 0, height = 0;
1933         Con *child;
1934         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1935             Rect min = con_minimum_size(child);
1936             if (con->layout == L_SPLITH) {
1937                 width += min.width;
1938                 height = max(height, min.height);
1939             } else {
1940                 height += min.height;
1941                 width = max(width, min.width);
1942             }
1943         }
1944         DLOG("split container, returning width = %d x height = %d\n", width, height);
1945         return (Rect){0, 0, width, height};
1946     }
1947
1948     ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1949          con->type, con->layout, con_is_split(con));
1950     assert(false);
1951 }
1952
1953 /*
1954  * Returns true if changing the focus to con would be allowed considering
1955  * the fullscreen focus constraints. Specifically, if a fullscreen container or
1956  * any of its descendants is focused, this function returns true if and only if
1957  * focusing con would mean that focus would still be visible on screen, i.e.,
1958  * the newly focused container would not be obscured by a fullscreen container.
1959  *
1960  * In the simplest case, if a fullscreen container or any of its descendants is
1961  * fullscreen, this functions returns true if con is the fullscreen container
1962  * itself or any of its descendants, as this means focus wouldn't escape the
1963  * boundaries of the fullscreen container.
1964  *
1965  * In case the fullscreen container is of type CF_OUTPUT, this function returns
1966  * true if con is on a different workspace, as focus wouldn't be obscured by
1967  * the fullscreen container that is constrained to a different workspace.
1968  *
1969  * Note that this same logic can be applied to moving containers. If a
1970  * container can be focused under the fullscreen focus constraints, it can also
1971  * become a parent or sibling to the currently focused container.
1972  *
1973  */
1974 bool con_fullscreen_permits_focusing(Con *con) {
1975     /* No focus, no problem. */
1976     if (!focused)
1977         return true;
1978
1979     /* Find the first fullscreen ascendent. */
1980     Con *fs = focused;
1981     while (fs && fs->fullscreen_mode == CF_NONE)
1982         fs = fs->parent;
1983
1984     /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1985      * there always has to be a workspace con in the hierarchy. */
1986     assert(fs != NULL);
1987     /* The most common case is we hit the workspace level. In this
1988      * situation, changing focus is also harmless. */
1989     assert(fs->fullscreen_mode != CF_NONE);
1990     if (fs->type == CT_WORKSPACE)
1991         return true;
1992
1993     /* Allow it if the container itself is the fullscreen container. */
1994     if (con == fs)
1995         return true;
1996
1997     /* If fullscreen is per-output, the focus being in a different workspace is
1998      * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1999     if (fs->fullscreen_mode == CF_OUTPUT &&
2000         con_get_workspace(con) != con_get_workspace(fs)) {
2001         return true;
2002     }
2003
2004     /* Allow it only if the container to be focused is contained within the
2005      * current fullscreen container. */
2006     do {
2007         if (con->parent == fs)
2008             return true;
2009         con = con->parent;
2010     } while (con);
2011
2012     /* Focusing con would hide it behind a fullscreen window, disallow it. */
2013     return false;
2014 }
2015
2016 /*
2017  *
2018  * Checks if the given container has an urgent child.
2019  *
2020  */
2021 bool con_has_urgent_child(Con *con) {
2022     Con *child;
2023
2024     if (con_is_leaf(con))
2025         return con->urgent;
2026
2027     /* We are not interested in floating windows since they can only be
2028      * attached to a workspace → nodes_head instead of focus_head */
2029     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2030         if (con_has_urgent_child(child))
2031             return true;
2032     }
2033
2034     return false;
2035 }
2036
2037 /*
2038  * Make all parent containers urgent if con is urgent or clear the urgent flag
2039  * of all parent containers if there are no more urgent children left.
2040  *
2041  */
2042 void con_update_parents_urgency(Con *con) {
2043     Con *parent = con->parent;
2044
2045     /* Urgency hints should not be set on any container higher up in the
2046      * hierarchy than the workspace level. Unfortunately, since the content
2047      * container has type == CT_CON, that’s not easy to verify in the loop
2048      * below, so we need another condition to catch that case: */
2049     if (con->type == CT_WORKSPACE)
2050         return;
2051
2052     bool new_urgency_value = con->urgent;
2053     while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
2054         if (new_urgency_value) {
2055             parent->urgent = true;
2056         } else {
2057             /* We can only reset the urgency when the parent
2058              * has no other urgent children */
2059             if (!con_has_urgent_child(parent))
2060                 parent->urgent = false;
2061         }
2062         parent = parent->parent;
2063     }
2064 }
2065
2066 /*
2067  * Set urgency flag to the container, all the parent containers and the workspace.
2068  *
2069  */
2070 void con_set_urgency(Con *con, bool urgent) {
2071     if (urgent && focused == con) {
2072         DLOG("Ignoring urgency flag for current client\n");
2073         return;
2074     }
2075
2076     const bool old_urgent = con->urgent;
2077
2078     if (con->urgency_timer == NULL) {
2079         con->urgent = urgent;
2080     } else
2081         DLOG("Discarding urgency WM_HINT because timer is running\n");
2082
2083     //CLIENT_LOG(con);
2084     if (con->window) {
2085         if (con->urgent) {
2086             gettimeofday(&con->window->urgent, NULL);
2087         } else {
2088             con->window->urgent.tv_sec = 0;
2089             con->window->urgent.tv_usec = 0;
2090         }
2091     }
2092
2093     con_update_parents_urgency(con);
2094
2095     Con *ws;
2096     /* Set the urgency flag on the workspace, if a workspace could be found
2097      * (for dock clients, that is not the case). */
2098     if ((ws = con_get_workspace(con)) != NULL)
2099         workspace_update_urgent_flag(ws);
2100
2101     if (con->urgent != old_urgent) {
2102         LOG("Urgency flag changed to %d\n", con->urgent);
2103         ipc_send_window_event("urgent", con);
2104     }
2105 }
2106
2107 /*
2108  * Create a string representing the subtree under con.
2109  *
2110  */
2111 char *con_get_tree_representation(Con *con) {
2112     /* this code works as follows:
2113      *  1) create a string with the layout type (D/V/H/T/S) and an opening bracket
2114      *  2) append the tree representation of the children to the string
2115      *  3) add closing bracket
2116      *
2117      * The recursion ends when we hit a leaf, in which case we return the
2118      * class_instance of the contained window.
2119      */
2120
2121     /* end of recursion */
2122     if (con_is_leaf(con)) {
2123         if (!con->window)
2124             return sstrdup("nowin");
2125
2126         if (!con->window->class_instance)
2127             return sstrdup("noinstance");
2128
2129         return sstrdup(con->window->class_instance);
2130     }
2131
2132     char *buf;
2133     /* 1) add the Layout type to buf */
2134     if (con->layout == L_DEFAULT)
2135         buf = sstrdup("D[");
2136     else if (con->layout == L_SPLITV)
2137         buf = sstrdup("V[");
2138     else if (con->layout == L_SPLITH)
2139         buf = sstrdup("H[");
2140     else if (con->layout == L_TABBED)
2141         buf = sstrdup("T[");
2142     else if (con->layout == L_STACKED)
2143         buf = sstrdup("S[");
2144     else {
2145         ELOG("BUG: Code not updated to account for new layout type\n");
2146         assert(false);
2147     }
2148
2149     /* 2) append representation of children */
2150     Con *child;
2151     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2152         char *child_txt = con_get_tree_representation(child);
2153
2154         char *tmp_buf;
2155         sasprintf(&tmp_buf, "%s%s%s", buf,
2156                   (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
2157         free(buf);
2158         buf = tmp_buf;
2159         free(child_txt);
2160     }
2161
2162     /* 3) close the brackets */
2163     char *complete_buf;
2164     sasprintf(&complete_buf, "%s]", buf);
2165     free(buf);
2166
2167     return complete_buf;
2168 }
2169
2170 /*
2171  * Returns the container's title considering the current title format.
2172  *
2173  */
2174 i3String *con_parse_title_format(Con *con) {
2175     assert(con->title_format != NULL);
2176
2177     i3Window *win = con->window;
2178
2179     /* We need to ensure that we only escape the window title if pango
2180      * is used by the current font. */
2181     const bool pango_markup = font_is_pango();
2182
2183     char *title;
2184     char *class;
2185     char *instance;
2186     if (win == NULL) {
2187         title = pango_escape_markup(con_get_tree_representation(con));
2188         class = sstrdup("i3-frame");
2189         instance = sstrdup("i3-frame");
2190     } else {
2191         title = pango_escape_markup(sstrdup((win->name == NULL) ? "" : i3string_as_utf8(win->name)));
2192         class = pango_escape_markup(sstrdup((win->class_class == NULL) ? "" : win->class_class));
2193         instance = pango_escape_markup(sstrdup((win->class_instance == NULL) ? "" : win->class_instance));
2194     }
2195
2196     placeholder_t placeholders[] = {
2197         {.name = "%title", .value = title},
2198         {.name = "%class", .value = class},
2199         {.name = "%instance", .value = instance}};
2200     const size_t num = sizeof(placeholders) / sizeof(placeholder_t);
2201
2202     char *formatted_str = format_placeholders(con->title_format, &placeholders[0], num);
2203     i3String *formatted = i3string_from_utf8(formatted_str);
2204     i3string_set_markup(formatted, pango_markup);
2205     FREE(formatted_str);
2206
2207     for (size_t i = 0; i < num; i++) {
2208         FREE(placeholders[i].value);
2209     }
2210
2211     return formatted;
2212 }
2213
2214 /*
2215  * Swaps the two containers.
2216  *
2217  */
2218 bool con_swap(Con *first, Con *second) {
2219     assert(first != NULL);
2220     assert(second != NULL);
2221     DLOG("Swapping containers %p / %p\n", first, second);
2222
2223     if (first->type != CT_CON) {
2224         ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", first, first->type);
2225         return false;
2226     }
2227
2228     if (second->type != CT_CON) {
2229         ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", second, second->type);
2230         return false;
2231     }
2232
2233     if (con_is_floating(first) || con_is_floating(second)) {
2234         ELOG("Floating windows cannot be swapped.\n");
2235         return false;
2236     }
2237
2238     if (first == second) {
2239         DLOG("Swapping container %p with itself, nothing to do.\n", first);
2240         return false;
2241     }
2242
2243     if (con_has_parent(first, second) || con_has_parent(second, first)) {
2244         ELOG("Cannot swap containers %p and %p because they are in a parent-child relationship.\n", first, second);
2245         return false;
2246     }
2247
2248     Con *old_focus = focused;
2249
2250     Con *first_ws = con_get_workspace(first);
2251     Con *second_ws = con_get_workspace(second);
2252     Con *current_ws = con_get_workspace(old_focus);
2253     const bool focused_within_first = (first == old_focus || con_has_parent(old_focus, first));
2254     const bool focused_within_second = (second == old_focus || con_has_parent(old_focus, second));
2255
2256     if (!con_fullscreen_permits_focusing(first_ws)) {
2257         DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", first_ws->name);
2258         return false;
2259     }
2260
2261     if (!con_fullscreen_permits_focusing(second_ws)) {
2262         DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", second_ws->name);
2263         return false;
2264     }
2265
2266     double first_percent = first->percent;
2267     double second_percent = second->percent;
2268
2269     /* De- and reattaching the containers will insert them at the tail of the
2270      * focus_heads. We will need to fix this. But we need to make sure first
2271      * and second don't get in each other's way if they share the same parent,
2272      * so we select the closest previous focus_head that isn't involved. */
2273     Con *first_prev_focus_head = first;
2274     while (first_prev_focus_head == first || first_prev_focus_head == second) {
2275         first_prev_focus_head = TAILQ_PREV(first_prev_focus_head, focus_head, focused);
2276     }
2277
2278     Con *second_prev_focus_head = second;
2279     while (second_prev_focus_head == second || second_prev_focus_head == first) {
2280         second_prev_focus_head = TAILQ_PREV(second_prev_focus_head, focus_head, focused);
2281     }
2282
2283     /* We use a fake container to mark the spot of where the second container needs to go. */
2284     Con *fake = con_new(NULL, NULL);
2285     fake->layout = L_SPLITH;
2286     _con_attach(fake, first->parent, first, true);
2287
2288     bool result = true;
2289     /* Swap the containers. We set the ignore_focus flag here because after the
2290      * container is attached, the focus order is not yet correct and would
2291      * result in wrong windows being focused. */
2292
2293     /* Move first to second. */
2294     result &= _con_move_to_con(first, second, false, false, false, true, false);
2295
2296     /* If we moved the container holding the focused window to another
2297      * workspace we need to ensure the visible workspace has the focused
2298      * container.
2299      * We don't need to check this for the second container because we've only
2300      * moved the first one at this point.*/
2301     if (first_ws != second_ws && focused_within_first) {
2302         con_focus(con_descend_focused(current_ws));
2303     }
2304
2305     /* Move second to where first has been originally. */
2306     result &= _con_move_to_con(second, fake, false, false, false, true, false);
2307
2308     /* If swapping the containers didn't work we don't need to mess with the focus. */
2309     if (!result) {
2310         goto swap_end;
2311     }
2312
2313     /* Swapping will have inserted the containers at the tail of their parents'
2314      * focus head. We fix this now by putting them in the position of the focus
2315      * head the container they swapped with was in. */
2316     TAILQ_REMOVE(&(first->parent->focus_head), first, focused);
2317     TAILQ_REMOVE(&(second->parent->focus_head), second, focused);
2318
2319     if (second_prev_focus_head == NULL) {
2320         TAILQ_INSERT_HEAD(&(first->parent->focus_head), first, focused);
2321     } else {
2322         TAILQ_INSERT_AFTER(&(first->parent->focus_head), second_prev_focus_head, first, focused);
2323     }
2324
2325     if (first_prev_focus_head == NULL) {
2326         TAILQ_INSERT_HEAD(&(second->parent->focus_head), second, focused);
2327     } else {
2328         TAILQ_INSERT_AFTER(&(second->parent->focus_head), first_prev_focus_head, second, focused);
2329     }
2330
2331     /* If the focus was within any of the swapped containers, do the following:
2332      * - If swapping took place within a workspace, ensure the previously
2333      *   focused container stays focused.
2334      * - Otherwise, focus the container that has been swapped in.
2335      *
2336      * To understand why fixing the focus_head previously wasn't enough,
2337      * consider the scenario
2338      *   H[ V[ A X ] V[ Y B ] ]
2339      * with B being focused, but X being the focus_head within its parent. If
2340      * we swap A and B now, fixing the focus_head would focus X, but since B
2341      * was the focused container before it should stay focused.
2342      */
2343     if (focused_within_first) {
2344         if (first_ws == second_ws) {
2345             con_focus(old_focus);
2346         } else {
2347             con_focus(con_descend_focused(second));
2348         }
2349     } else if (focused_within_second) {
2350         if (first_ws == second_ws) {
2351             con_focus(old_focus);
2352         } else {
2353             con_focus(con_descend_focused(first));
2354         }
2355     }
2356
2357     /* We need to copy each other's percentages to ensure that the geometry
2358      * doesn't change during the swap. This needs to happen _before_ we close
2359      * the fake container as closing the tree will recalculate percentages. */
2360     first->percent = second_percent;
2361     second->percent = first_percent;
2362     fake->percent = 0.0;
2363
2364 swap_end:
2365     /* We don't actually need this since percentages-wise we haven't changed
2366      * anything, but we'll better be safe than sorry and just make sure as we'd
2367      * otherwise crash i3. */
2368     con_fix_percent(first->parent);
2369     con_fix_percent(second->parent);
2370
2371     /* We can get rid of the fake container again now. */
2372     con_close(fake, DONT_KILL_WINDOW);
2373
2374     con_force_split_parents_redraw(first);
2375     con_force_split_parents_redraw(second);
2376
2377     return result;
2378 }