]> git.sur5r.net Git - i3/i3/blob - src/con.c
Merge pull request #2496 from Airblader/feature-917
[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 frame ID or NULL if no such container
562  * exists.
563  *
564  */
565 Con *con_by_frame_id(xcb_window_t frame) {
566     Con *con;
567     TAILQ_FOREACH(con, &all_cons, all_cons)
568     if (con->frame.id == frame)
569         return con;
570     return NULL;
571 }
572
573 /*
574  * Returns the container with the given mark or NULL if no such container
575  * exists.
576  *
577  */
578 Con *con_by_mark(const char *mark) {
579     Con *con;
580     TAILQ_FOREACH(con, &all_cons, all_cons) {
581         if (con_has_mark(con, mark))
582             return con;
583     }
584
585     return NULL;
586 }
587
588 /*
589  * Returns true if and only if the given containers holds the mark.
590  *
591  */
592 bool con_has_mark(Con *con, const char *mark) {
593     mark_t *current;
594     TAILQ_FOREACH(current, &(con->marks_head), marks) {
595         if (strcmp(current->name, mark) == 0)
596             return true;
597     }
598
599     return false;
600 }
601
602 /*
603  * Toggles the mark on a container.
604  * If the container already has this mark, the mark is removed.
605  * Otherwise, the mark is assigned to the container.
606  *
607  */
608 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode) {
609     assert(con != NULL);
610     DLOG("Toggling mark \"%s\" on con = %p.\n", mark, con);
611
612     if (con_has_mark(con, mark)) {
613         con_unmark(con, mark);
614     } else {
615         con_mark(con, mark, mode);
616     }
617 }
618
619 /*
620  * Assigns a mark to the container.
621  *
622  */
623 void con_mark(Con *con, const char *mark, mark_mode_t mode) {
624     assert(con != NULL);
625     DLOG("Setting mark \"%s\" on con = %p.\n", mark, con);
626
627     con_unmark(NULL, mark);
628     if (mode == MM_REPLACE) {
629         DLOG("Removing all existing marks on con = %p.\n", con);
630
631         mark_t *current;
632         while (!TAILQ_EMPTY(&(con->marks_head))) {
633             current = TAILQ_FIRST(&(con->marks_head));
634             con_unmark(con, current->name);
635         }
636     }
637
638     mark_t *new = scalloc(1, sizeof(mark_t));
639     new->name = sstrdup(mark);
640     TAILQ_INSERT_TAIL(&(con->marks_head), new, marks);
641     ipc_send_window_event("mark", con);
642
643     con->mark_changed = true;
644 }
645
646 /*
647  * Removes marks from containers.
648  * If con is NULL, all containers are considered.
649  * If name is NULL, this removes all existing marks.
650  * Otherwise, it will only remove the given mark (if it is present).
651  *
652  */
653 void con_unmark(Con *con, const char *name) {
654     Con *current;
655     if (name == NULL) {
656         DLOG("Unmarking all containers.\n");
657         TAILQ_FOREACH(current, &all_cons, all_cons) {
658             if (con != NULL && current != con)
659                 continue;
660
661             if (TAILQ_EMPTY(&(current->marks_head)))
662                 continue;
663
664             mark_t *mark;
665             while (!TAILQ_EMPTY(&(current->marks_head))) {
666                 mark = TAILQ_FIRST(&(current->marks_head));
667                 FREE(mark->name);
668                 TAILQ_REMOVE(&(current->marks_head), mark, marks);
669                 FREE(mark);
670
671                 ipc_send_window_event("mark", current);
672             }
673
674             current->mark_changed = true;
675         }
676     } else {
677         DLOG("Removing mark \"%s\".\n", name);
678         current = (con == NULL) ? con_by_mark(name) : con;
679         if (current == NULL) {
680             DLOG("No container found with this mark, so there is nothing to do.\n");
681             return;
682         }
683
684         DLOG("Found mark on con = %p. Removing it now.\n", current);
685         current->mark_changed = true;
686
687         mark_t *mark;
688         TAILQ_FOREACH(mark, &(current->marks_head), marks) {
689             if (strcmp(mark->name, name) != 0)
690                 continue;
691
692             FREE(mark->name);
693             TAILQ_REMOVE(&(current->marks_head), mark, marks);
694             FREE(mark);
695
696             ipc_send_window_event("mark", current);
697             break;
698         }
699     }
700 }
701
702 /*
703  * Returns the first container below 'con' which wants to swallow this window
704  * TODO: priority
705  *
706  */
707 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
708     Con *child;
709     Match *match;
710     //DLOG("searching con for window %p starting at con %p\n", window, con);
711     //DLOG("class == %s\n", window->class_class);
712
713     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
714         TAILQ_FOREACH(match, &(child->swallow_head), matches) {
715             if (!match_matches_window(match, window))
716                 continue;
717             if (store_match != NULL)
718                 *store_match = match;
719             return child;
720         }
721         Con *result = con_for_window(child, window, store_match);
722         if (result != NULL)
723             return result;
724     }
725
726     TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
727         TAILQ_FOREACH(match, &(child->swallow_head), matches) {
728             if (!match_matches_window(match, window))
729                 continue;
730             if (store_match != NULL)
731                 *store_match = match;
732             return child;
733         }
734         Con *result = con_for_window(child, window, store_match);
735         if (result != NULL)
736             return result;
737     }
738
739     return NULL;
740 }
741
742 /*
743  * Returns the number of children of this container.
744  *
745  */
746 int con_num_children(Con *con) {
747     Con *child;
748     int children = 0;
749
750     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
751     children++;
752
753     return children;
754 }
755
756 /**
757  * Returns the number of visible non-floating children of this container.
758  * For example, if the container contains a hsplit which has two children,
759  * this will return 2 instead of 1.
760  */
761 int con_num_visible_children(Con *con) {
762     if (con == NULL)
763         return 0;
764
765     int children = 0;
766     Con *current = NULL;
767     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
768         /* Visible leaf nodes are a child. */
769         if (!con_is_hidden(current) && con_is_leaf(current))
770             children++;
771         /* All other containers need to be recursed. */
772         else
773             children += con_num_visible_children(current);
774     }
775
776     return children;
777 }
778
779 /*
780  * Count the number of windows (i.e., leaf containers).
781  *
782  */
783 int con_num_windows(Con *con) {
784     if (con == NULL)
785         return 0;
786
787     if (con_has_managed_window(con))
788         return 1;
789
790     int num = 0;
791     Con *current = NULL;
792     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
793         num += con_num_windows(current);
794     }
795
796     return num;
797 }
798
799 /*
800  * Updates the percent attribute of the children of the given container. This
801  * function needs to be called when a window is added or removed from a
802  * container.
803  *
804  */
805 void con_fix_percent(Con *con) {
806     Con *child;
807     int children = con_num_children(con);
808
809     // calculate how much we have distributed and how many containers
810     // with a percentage set we have
811     double total = 0.0;
812     int children_with_percent = 0;
813     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
814         if (child->percent > 0.0) {
815             total += child->percent;
816             ++children_with_percent;
817         }
818     }
819
820     // if there were children without a percentage set, set to a value that
821     // will make those children proportional to all others
822     if (children_with_percent != children) {
823         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
824             if (child->percent <= 0.0) {
825                 if (children_with_percent == 0) {
826                     total += (child->percent = 1.0);
827                 } else {
828                     total += (child->percent = total / children_with_percent);
829                 }
830             }
831         }
832     }
833
834     // if we got a zero, just distribute the space equally, otherwise
835     // distribute according to the proportions we got
836     if (total == 0.0) {
837         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
838             child->percent = 1.0 / children;
839         }
840     } else if (total != 1.0) {
841         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
842             child->percent /= total;
843         }
844     }
845 }
846
847 /*
848  * Toggles fullscreen mode for the given container. If there already is a
849  * fullscreen container on this workspace, fullscreen will be disabled and then
850  * enabled for the container the user wants to have in fullscreen mode.
851  *
852  */
853 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
854     if (con->type == CT_WORKSPACE) {
855         DLOG("You cannot make a workspace fullscreen.\n");
856         return;
857     }
858
859     DLOG("toggling fullscreen for %p / %s\n", con, con->name);
860
861     if (con->fullscreen_mode == CF_NONE)
862         con_enable_fullscreen(con, fullscreen_mode);
863     else
864         con_disable_fullscreen(con);
865 }
866
867 /*
868  * Sets the specified fullscreen mode for the given container, sends the
869  * “fullscreen_mode” event and changes the XCB fullscreen property of the
870  * container’s window, if any.
871  *
872  */
873 static void con_set_fullscreen_mode(Con *con, fullscreen_mode_t fullscreen_mode) {
874     con->fullscreen_mode = fullscreen_mode;
875
876     DLOG("mode now: %d\n", con->fullscreen_mode);
877
878     /* Send an ipc window "fullscreen_mode" event */
879     ipc_send_window_event("fullscreen_mode", con);
880
881     /* update _NET_WM_STATE if this container has a window */
882     /* TODO: when a window is assigned to a container which is already
883      * fullscreened, this state needs to be pushed to the client, too */
884     if (con->window == NULL)
885         return;
886
887     if (con->fullscreen_mode != CF_NONE) {
888         DLOG("Setting _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
889         xcb_add_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
890     } else {
891         DLOG("Removing _NET_WM_STATE_FULLSCREEN for con = %p / window = %d.\n", con, con->window->id);
892         xcb_remove_property_atom(conn, con->window->id, A__NET_WM_STATE, A__NET_WM_STATE_FULLSCREEN);
893     }
894 }
895
896 /*
897  * Enables fullscreen mode for the given container, if necessary.
898  *
899  * If the container’s mode is already CF_OUTPUT or CF_GLOBAL, the container is
900  * kept fullscreen but its mode is set to CF_GLOBAL and CF_OUTPUT,
901  * respectively.
902  *
903  * Other fullscreen containers will be disabled first, if they hide the new
904  * one.
905  *
906  */
907 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode) {
908     if (con->type == CT_WORKSPACE) {
909         DLOG("You cannot make a workspace fullscreen.\n");
910         return;
911     }
912
913     assert(fullscreen_mode == CF_GLOBAL || fullscreen_mode == CF_OUTPUT);
914
915     if (fullscreen_mode == CF_GLOBAL)
916         DLOG("enabling global fullscreen for %p / %s\n", con, con->name);
917     else
918         DLOG("enabling fullscreen for %p / %s\n", con, con->name);
919
920     if (con->fullscreen_mode == fullscreen_mode) {
921         DLOG("fullscreen already enabled for %p / %s\n", con, con->name);
922         return;
923     }
924
925     Con *con_ws = con_get_workspace(con);
926
927     /* Disable any fullscreen container that would conflict the new one. */
928     Con *fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
929     if (fullscreen == NULL)
930         fullscreen = con_get_fullscreen_con(con_ws, CF_OUTPUT);
931     if (fullscreen != NULL)
932         con_disable_fullscreen(fullscreen);
933
934     /* Set focus to new fullscreen container. Unless in global fullscreen mode
935      * and on another workspace restore focus afterwards.
936      * Switch to the container’s workspace if mode is global. */
937     Con *cur_ws = con_get_workspace(focused);
938     Con *old_focused = focused;
939     if (fullscreen_mode == CF_GLOBAL && cur_ws != con_ws)
940         workspace_show(con_ws);
941     con_focus(con);
942     if (fullscreen_mode != CF_GLOBAL && cur_ws != con_ws)
943         con_focus(old_focused);
944
945     con_set_fullscreen_mode(con, fullscreen_mode);
946 }
947
948 /*
949  * Disables fullscreen mode for the given container regardless of the mode, if
950  * necessary.
951  *
952  */
953 void con_disable_fullscreen(Con *con) {
954     if (con->type == CT_WORKSPACE) {
955         DLOG("You cannot make a workspace fullscreen.\n");
956         return;
957     }
958
959     DLOG("disabling fullscreen for %p / %s\n", con, con->name);
960
961     if (con->fullscreen_mode == CF_NONE) {
962         DLOG("fullscreen already disabled for %p / %s\n", con, con->name);
963         return;
964     }
965
966     con_set_fullscreen_mode(con, CF_NONE);
967 }
968
969 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) {
970     Con *orig_target = target;
971
972     /* Prevent moving if this would violate the fullscreen focus restrictions. */
973     Con *target_ws = con_get_workspace(target);
974     if (!con_fullscreen_permits_focusing(target_ws)) {
975         LOG("Cannot move out of a fullscreen container.\n");
976         return false;
977     }
978
979     if (con_is_floating(con)) {
980         DLOG("Container is floating, using parent instead.\n");
981         con = con->parent;
982     }
983
984     Con *source_ws = con_get_workspace(con);
985
986     if (con->type == CT_WORKSPACE) {
987         /* Re-parent all of the old workspace's floating windows. */
988         Con *child;
989         while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
990             child = TAILQ_FIRST(&(source_ws->floating_head));
991             con_move_to_workspace(child, target_ws, true, true, false);
992         }
993
994         /* If there are no non-floating children, ignore the workspace. */
995         if (con_is_leaf(con))
996             return false;
997
998         con = workspace_encapsulate(con);
999         if (con == NULL) {
1000             ELOG("Workspace failed to move its contents into a container!\n");
1001             return false;
1002         }
1003     }
1004
1005     /* Save the urgency state so that we can restore it. */
1006     bool urgent = con->urgent;
1007
1008     /* Save the current workspace. So we can call workspace_show() by the end
1009      * of this function. */
1010     Con *current_ws = con_get_workspace(focused);
1011
1012     Con *source_output = con_get_output(con),
1013         *dest_output = con_get_output(target_ws);
1014
1015     /* 1: save the container which is going to be focused after the current
1016      * container is moved away */
1017     Con *focus_next = con_next_focused(con);
1018
1019     /* 2: we go up one level, but only when target is a normal container */
1020     if (target->type != CT_WORKSPACE) {
1021         DLOG("target originally = %p / %s / type %d\n", target, target->name, target->type);
1022         target = target->parent;
1023     }
1024
1025     /* 3: if the target container is floating, we get the workspace instead.
1026      * Only tiling windows need to get inserted next to the current container.
1027      * */
1028     Con *floatingcon = con_inside_floating(target);
1029     if (floatingcon != NULL) {
1030         DLOG("floatingcon, going up even further\n");
1031         target = floatingcon->parent;
1032     }
1033
1034     if (con->type == CT_FLOATING_CON) {
1035         Con *ws = con_get_workspace(target);
1036         DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
1037         target = ws;
1038     }
1039
1040     if (source_output != dest_output) {
1041         /* Take the relative coordinates of the current output, then add them
1042          * to the coordinate space of the correct output */
1043         if (fix_coordinates && con->type == CT_FLOATING_CON) {
1044             floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
1045         } else
1046             DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
1047
1048         /* If moving to a visible workspace, call show so it can be considered
1049          * focused. Must do before attaching because workspace_show checks to see
1050          * if focused container is in its area. */
1051         if (!ignore_focus && workspace_is_visible(target_ws)) {
1052             workspace_show(target_ws);
1053
1054             /* Don’t warp if told so (when dragging floating windows with the
1055              * mouse for example) */
1056             if (dont_warp)
1057                 x_set_warp_to(NULL);
1058             else
1059                 x_set_warp_to(&(con->rect));
1060         }
1061     }
1062
1063     /* If moving a fullscreen container and the destination already has a
1064      * fullscreen window on it, un-fullscreen the target's fullscreen con. */
1065     Con *fullscreen = con_get_fullscreen_con(target_ws, CF_OUTPUT);
1066     if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
1067         con_toggle_fullscreen(fullscreen, CF_OUTPUT);
1068         fullscreen = NULL;
1069     }
1070
1071     DLOG("Re-attaching container to %p / %s\n", target, target->name);
1072     /* 4: re-attach the con to the parent of this focused container */
1073     Con *parent = con->parent;
1074     con_detach(con);
1075     _con_attach(con, target, behind_focused ? NULL : orig_target, !behind_focused);
1076
1077     /* 5: fix the percentages */
1078     if (fix_percentage) {
1079         con_fix_percent(parent);
1080         con->percent = 0.0;
1081         con_fix_percent(target);
1082     }
1083
1084     /* 6: focus the con on the target workspace, but only within that
1085      * workspace, that is, don’t move focus away if the target workspace is
1086      * invisible.
1087      * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
1088      * we don’t focus when there is a fullscreen con on that workspace. We
1089      * also don't do it if the caller requested to ignore focus. */
1090     if (!ignore_focus && !con_is_internal(target_ws) && !fullscreen) {
1091         /* We need to save the focused workspace on the output in case the
1092          * new workspace is hidden and it's necessary to immediately switch
1093          * back to the originally-focused workspace. */
1094         Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
1095         con_focus(con_descend_focused(con));
1096
1097         /* Restore focus if the output's focused workspace has changed. */
1098         if (con_get_workspace(focused) != old_focus)
1099             con_focus(old_focus);
1100     }
1101
1102     /* 7: when moving to another workspace, we leave the focus on the current
1103      * workspace. (see also #809) */
1104
1105     /* Descend focus stack in case focus_next is a workspace which can
1106      * occur if we move to the same workspace.  Also show current workspace
1107      * to ensure it is focused. */
1108     if (!ignore_focus)
1109         workspace_show(current_ws);
1110
1111     /* Set focus only if con was on current workspace before moving.
1112      * Otherwise we would give focus to some window on different workspace. */
1113     if (!ignore_focus && source_ws == current_ws)
1114         con_focus(con_descend_focused(focus_next));
1115
1116     /* 8. If anything within the container is associated with a startup sequence,
1117      * delete it so child windows won't be created on the old workspace. */
1118     struct Startup_Sequence *sequence;
1119     xcb_get_property_cookie_t cookie;
1120     xcb_get_property_reply_t *startup_id_reply;
1121
1122     if (!con_is_leaf(con)) {
1123         Con *child;
1124         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1125             if (!child->window)
1126                 continue;
1127
1128             cookie = xcb_get_property(conn, false, child->window->id,
1129                                       A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1130             startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1131
1132             sequence = startup_sequence_get(child->window, startup_id_reply, true);
1133             if (sequence != NULL)
1134                 startup_sequence_delete(sequence);
1135         }
1136     }
1137
1138     if (con->window) {
1139         cookie = xcb_get_property(conn, false, con->window->id,
1140                                   A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
1141         startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
1142
1143         sequence = startup_sequence_get(con->window, startup_id_reply, true);
1144         if (sequence != NULL)
1145             startup_sequence_delete(sequence);
1146     }
1147
1148     /* 9. If the container was marked urgent, move the urgency hint. */
1149     if (urgent) {
1150         workspace_update_urgent_flag(source_ws);
1151         con_set_urgency(con, true);
1152     }
1153
1154     /* Ensure the container will be redrawn. */
1155     FREE(con->deco_render_params);
1156
1157     CALL(parent, on_remove_child);
1158
1159     ipc_send_window_event("move", con);
1160     ewmh_update_wm_desktop();
1161     return true;
1162 }
1163
1164 /*
1165  * Moves the given container to the given mark.
1166  *
1167  */
1168 bool con_move_to_mark(Con *con, const char *mark) {
1169     Con *target = con_by_mark(mark);
1170     if (target == NULL) {
1171         DLOG("found no container with mark \"%s\"\n", mark);
1172         return false;
1173     }
1174
1175     /* For floating target containers, we just send the window to the same workspace. */
1176     if (con_is_floating(target)) {
1177         DLOG("target container is floating, moving container to target's workspace.\n");
1178         con_move_to_workspace(con, con_get_workspace(target), true, false, false);
1179         return true;
1180     }
1181
1182     if (con->type == CT_WORKSPACE) {
1183         DLOG("target container is a workspace, simply moving the container there.\n");
1184         con_move_to_workspace(con, target, true, false, false);
1185         return true;
1186     }
1187
1188     /* For split containers, we use the currently focused container within it.
1189      * This allows setting marks on, e.g., tabbed containers which will move
1190      * con to a new tab behind the focused tab. */
1191     if (con_is_split(target)) {
1192         DLOG("target is a split container, descending to the currently focused child.\n");
1193         target = TAILQ_FIRST(&(target->focus_head));
1194     }
1195
1196     if (con == target || con_has_parent(target, con)) {
1197         DLOG("cannot move the container to or inside itself, aborting.\n");
1198         return false;
1199     }
1200
1201     return _con_move_to_con(con, target, false, true, false, false, true);
1202 }
1203
1204 /*
1205  * Moves the given container to the currently focused container on the given
1206  * workspace.
1207  *
1208  * The fix_coordinates flag will translate the current coordinates (offset from
1209  * the monitor position basically) to appropriate coordinates on the
1210  * destination workspace.
1211  * Not enabling this behaviour comes in handy when this function gets called by
1212  * floating_maybe_reassign_ws, which will only "move" a floating window when it
1213  * *already* changed its coordinates to a different output.
1214  *
1215  * The dont_warp flag disables pointer warping and will be set when this
1216  * function is called while dragging a floating window.
1217  *
1218  * If ignore_focus is set, the container will be moved without modifying focus
1219  * at all.
1220  *
1221  * TODO: is there a better place for this function?
1222  *
1223  */
1224 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp, bool ignore_focus) {
1225     assert(workspace->type == CT_WORKSPACE);
1226
1227     Con *source_ws = con_get_workspace(con);
1228     if (workspace == source_ws) {
1229         DLOG("Not moving, already there\n");
1230         return;
1231     }
1232
1233     Con *target = con_descend_focused(workspace);
1234     _con_move_to_con(con, target, true, fix_coordinates, dont_warp, ignore_focus, true);
1235 }
1236
1237 /*
1238  * Moves the given container to the currently focused container on the
1239  * visible workspace on the given output.
1240  *
1241  */
1242 void con_move_to_output(Con *con, Output *output) {
1243     Con *ws = NULL;
1244     GREP_FIRST(ws, output_get_content(output->con), workspace_is_visible(child));
1245     assert(ws != NULL);
1246     DLOG("Moving con %p to output %s\n", con, output->name);
1247     con_move_to_workspace(con, ws, false, false, false);
1248 }
1249
1250 /*
1251  * Returns the orientation of the given container (for stacked containers,
1252  * vertical orientation is used regardless of the actual orientation of the
1253  * container).
1254  *
1255  */
1256 orientation_t con_orientation(Con *con) {
1257     switch (con->layout) {
1258         case L_SPLITV:
1259         /* stacking containers behave like they are in vertical orientation */
1260         case L_STACKED:
1261             return VERT;
1262
1263         case L_SPLITH:
1264         /* tabbed containers behave like they are in vertical orientation */
1265         case L_TABBED:
1266             return HORIZ;
1267
1268         case L_DEFAULT:
1269             DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
1270             assert(false);
1271             return HORIZ;
1272
1273         case L_DOCKAREA:
1274         case L_OUTPUT:
1275             DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
1276             assert(false);
1277             return HORIZ;
1278
1279         default:
1280             DLOG("con_orientation() ran into default\n");
1281             assert(false);
1282     }
1283 }
1284
1285 /*
1286  * Returns the container which will be focused next when the given container
1287  * is not available anymore. Called in tree_close_internal and con_move_to_workspace
1288  * to properly restore focus.
1289  *
1290  */
1291 Con *con_next_focused(Con *con) {
1292     Con *next;
1293     /* floating containers are attached to a workspace, so we focus either the
1294      * next floating container (if any) or the workspace itself. */
1295     if (con->type == CT_FLOATING_CON) {
1296         DLOG("selecting next for CT_FLOATING_CON\n");
1297         next = TAILQ_NEXT(con, floating_windows);
1298         DLOG("next = %p\n", next);
1299         if (!next) {
1300             next = TAILQ_PREV(con, floating_head, floating_windows);
1301             DLOG("using prev, next = %p\n", next);
1302         }
1303         if (!next) {
1304             Con *ws = con_get_workspace(con);
1305             next = ws;
1306             DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
1307             while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
1308                 next = TAILQ_FIRST(&(next->focus_head));
1309                 if (next == con) {
1310                     DLOG("skipping container itself, we want the next client\n");
1311                     next = TAILQ_NEXT(next, focused);
1312                 }
1313             }
1314             if (next == TAILQ_END(&(ws->focus_head))) {
1315                 DLOG("Focus list empty, returning ws\n");
1316                 next = ws;
1317             }
1318         } else {
1319             /* Instead of returning the next CT_FLOATING_CON, we descend it to
1320              * get an actual window to focus. */
1321             next = con_descend_focused(next);
1322         }
1323         return next;
1324     }
1325
1326     /* dock clients cannot be focused, so we focus the workspace instead */
1327     if (con->parent->type == CT_DOCKAREA) {
1328         DLOG("selecting workspace for dock client\n");
1329         return con_descend_focused(output_get_content(con->parent->parent));
1330     }
1331
1332     /* if 'con' is not the first entry in the focus stack, use the first one as
1333      * it’s currently focused already */
1334     Con *first = TAILQ_FIRST(&(con->parent->focus_head));
1335     if (first != con) {
1336         DLOG("Using first entry %p\n", first);
1337         next = first;
1338     } else {
1339         /* try to focus the next container on the same level as this one or fall
1340          * back to its parent */
1341         if (!(next = TAILQ_NEXT(con, focused))) {
1342             next = con->parent;
1343         }
1344     }
1345
1346     /* now go down the focus stack as far as
1347      * possible, excluding the current container */
1348     while (!TAILQ_EMPTY(&(next->focus_head)) && TAILQ_FIRST(&(next->focus_head)) != con) {
1349         next = TAILQ_FIRST(&(next->focus_head));
1350     }
1351
1352     return next;
1353 }
1354
1355 /*
1356  * Get the next/previous container in the specified orientation. This may
1357  * travel up until it finds a container with suitable orientation.
1358  *
1359  */
1360 Con *con_get_next(Con *con, char way, orientation_t orientation) {
1361     DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
1362     /* 1: get the first parent with the same orientation */
1363     Con *cur = con;
1364     while (con_orientation(cur->parent) != orientation) {
1365         DLOG("need to go one level further up\n");
1366         if (cur->parent->type == CT_WORKSPACE) {
1367             LOG("that's a workspace, we can't go further up\n");
1368             return NULL;
1369         }
1370         cur = cur->parent;
1371     }
1372
1373     /* 2: chose next (or previous) */
1374     Con *next;
1375     if (way == 'n') {
1376         next = TAILQ_NEXT(cur, nodes);
1377         /* if we are at the end of the list, we need to wrap */
1378         if (next == TAILQ_END(&(parent->nodes_head)))
1379             return NULL;
1380     } else {
1381         next = TAILQ_PREV(cur, nodes_head, nodes);
1382         /* if we are at the end of the list, we need to wrap */
1383         if (next == TAILQ_END(&(cur->nodes_head)))
1384             return NULL;
1385     }
1386     DLOG("next = %p\n", next);
1387
1388     return next;
1389 }
1390
1391 /*
1392  * Returns the focused con inside this client, descending the tree as far as
1393  * possible. This comes in handy when attaching a con to a workspace at the
1394  * currently focused position, for example.
1395  *
1396  */
1397 Con *con_descend_focused(Con *con) {
1398     Con *next = con;
1399     while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
1400         next = TAILQ_FIRST(&(next->focus_head));
1401     return next;
1402 }
1403
1404 /*
1405  * Returns the focused con inside this client, descending the tree as far as
1406  * possible. This comes in handy when attaching a con to a workspace at the
1407  * currently focused position, for example.
1408  *
1409  * Works like con_descend_focused but considers only tiling cons.
1410  *
1411  */
1412 Con *con_descend_tiling_focused(Con *con) {
1413     Con *next = con;
1414     Con *before;
1415     Con *child;
1416     if (next == focused)
1417         return next;
1418     do {
1419         before = next;
1420         TAILQ_FOREACH(child, &(next->focus_head), focused) {
1421             if (child->type == CT_FLOATING_CON)
1422                 continue;
1423
1424             next = child;
1425             break;
1426         }
1427     } while (before != next && next != focused);
1428     return next;
1429 }
1430
1431 /*
1432  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1433  * direction is D_LEFT, then we return the rightmost container and if direction
1434  * is D_RIGHT, we return the leftmost container.  This is because if we are
1435  * moving D_LEFT, and thus want the rightmost container.
1436  *
1437  */
1438 Con *con_descend_direction(Con *con, direction_t direction) {
1439     Con *most = NULL;
1440     Con *current;
1441     int orientation = con_orientation(con);
1442     DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1443     if (direction == D_LEFT || direction == D_RIGHT) {
1444         if (orientation == HORIZ) {
1445             /* If the direction is horizontal, we can use either the first
1446              * (D_RIGHT) or the last con (D_LEFT) */
1447             if (direction == D_RIGHT)
1448                 most = TAILQ_FIRST(&(con->nodes_head));
1449             else
1450                 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1451         } else if (orientation == VERT) {
1452             /* Wrong orientation. We use the last focused con. Within that con,
1453              * we recurse to chose the left/right con or at least the last
1454              * focused one. */
1455             TAILQ_FOREACH(current, &(con->focus_head), focused) {
1456                 if (current->type != CT_FLOATING_CON) {
1457                     most = current;
1458                     break;
1459                 }
1460             }
1461         } else {
1462             /* If the con has no orientation set, it’s not a split container
1463              * but a container with a client window, so stop recursing */
1464             return con;
1465         }
1466     }
1467
1468     if (direction == D_UP || direction == D_DOWN) {
1469         if (orientation == VERT) {
1470             /* If the direction is vertical, we can use either the first
1471              * (D_DOWN) or the last con (D_UP) */
1472             if (direction == D_UP)
1473                 most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1474             else
1475                 most = TAILQ_FIRST(&(con->nodes_head));
1476         } else if (orientation == HORIZ) {
1477             /* Wrong orientation. We use the last focused con. Within that con,
1478              * we recurse to chose the top/bottom con or at least the last
1479              * focused one. */
1480             TAILQ_FOREACH(current, &(con->focus_head), focused) {
1481                 if (current->type != CT_FLOATING_CON) {
1482                     most = current;
1483                     break;
1484                 }
1485             }
1486         } else {
1487             /* If the con has no orientation set, it’s not a split container
1488              * but a container with a client window, so stop recursing */
1489             return con;
1490         }
1491     }
1492
1493     if (!most)
1494         return con;
1495     return con_descend_direction(most, direction);
1496 }
1497
1498 /*
1499  * Returns a "relative" Rect which contains the amount of pixels that need to
1500  * be added to the original Rect to get the final position (obviously the
1501  * amount of pixels for normal, 1pixel and borderless are different).
1502  *
1503  */
1504 Rect con_border_style_rect(Con *con) {
1505     if (config.hide_edge_borders == HEBM_SMART && con_num_visible_children(con_get_workspace(con)) <= 1) {
1506         if (!con_is_floating(con)) {
1507             return (Rect){0, 0, 0, 0};
1508         }
1509     }
1510
1511     adjacent_t borders_to_hide = ADJ_NONE;
1512     int border_width = con->current_border_width;
1513     DLOG("The border width for con is set to: %d\n", con->current_border_width);
1514     Rect result;
1515     if (con->current_border_width < 0) {
1516         if (con_is_floating(con)) {
1517             border_width = config.default_floating_border_width;
1518         } else {
1519             border_width = config.default_border_width;
1520         }
1521     }
1522     DLOG("Effective border width is set to: %d\n", border_width);
1523     /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1524     int border_style = con_border_style(con);
1525     if (border_style == BS_NONE)
1526         return (Rect){0, 0, 0, 0};
1527     if (border_style == BS_NORMAL) {
1528         result = (Rect){border_width, 0, -(2 * border_width), -(border_width)};
1529     } else {
1530         result = (Rect){border_width, border_width, -(2 * border_width), -(2 * border_width)};
1531     }
1532
1533     borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1534     if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1535         result.x -= border_width;
1536         result.width += border_width;
1537     }
1538     if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1539         result.width += border_width;
1540     }
1541     if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1542         result.y -= border_width;
1543         result.height += border_width;
1544     }
1545     if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1546         result.height += border_width;
1547     }
1548     return result;
1549 }
1550
1551 /*
1552  * Returns adjacent borders of the window. We need this if hide_edge_borders is
1553  * enabled.
1554  */
1555 adjacent_t con_adjacent_borders(Con *con) {
1556     adjacent_t result = ADJ_NONE;
1557     /* Floating windows are never adjacent to any other window, so
1558        don’t hide their border(s). This prevents bug #998. */
1559     if (con_is_floating(con))
1560         return result;
1561
1562     Con *workspace = con_get_workspace(con);
1563     if (con->rect.x == workspace->rect.x)
1564         result |= ADJ_LEFT_SCREEN_EDGE;
1565     if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1566         result |= ADJ_RIGHT_SCREEN_EDGE;
1567     if (con->rect.y == workspace->rect.y)
1568         result |= ADJ_UPPER_SCREEN_EDGE;
1569     if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1570         result |= ADJ_LOWER_SCREEN_EDGE;
1571     return result;
1572 }
1573
1574 /*
1575  * Use this function to get a container’s border style. This is important
1576  * because when inside a stack, the border style is always BS_NORMAL.
1577  * For tabbed mode, the same applies, with one exception: when the container is
1578  * borderless and the only element in the tabbed container, the border is not
1579  * rendered.
1580  *
1581  * For children of a CT_DOCKAREA, the border style is always none.
1582  *
1583  */
1584 int con_border_style(Con *con) {
1585     Con *fs = con_get_fullscreen_con(con->parent, CF_OUTPUT);
1586     if (fs == con) {
1587         DLOG("this one is fullscreen! overriding BS_NONE\n");
1588         return BS_NONE;
1589     }
1590
1591     if (con->parent->layout == L_STACKED)
1592         return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1593
1594     if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1595         return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1596
1597     if (con->parent->type == CT_DOCKAREA)
1598         return BS_NONE;
1599
1600     return con->border_style;
1601 }
1602
1603 /*
1604  * Sets the given border style on con, correctly keeping the position/size of a
1605  * floating window.
1606  *
1607  */
1608 void con_set_border_style(Con *con, int border_style, int border_width) {
1609     /* Handle the simple case: non-floating containerns */
1610     if (!con_is_floating(con)) {
1611         con->border_style = border_style;
1612         con->current_border_width = border_width;
1613         return;
1614     }
1615
1616     /* For floating containers, we want to keep the position/size of the
1617      * *window* itself. We first add the border pixels to con->rect to make
1618      * con->rect represent the absolute position of the window (same for
1619      * parent). Then, we change the border style and subtract the new border
1620      * pixels. For the parent, we do the same also for the decoration. */
1621     DLOG("This is a floating container\n");
1622
1623     Con *parent = con->parent;
1624     Rect bsr = con_border_style_rect(con);
1625     int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1626
1627     con->rect = rect_add(con->rect, bsr);
1628     parent->rect = rect_add(parent->rect, bsr);
1629     parent->rect.y += deco_height;
1630     parent->rect.height -= deco_height;
1631
1632     /* Change the border style, get new border/decoration values. */
1633     con->border_style = border_style;
1634     con->current_border_width = border_width;
1635     bsr = con_border_style_rect(con);
1636     deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1637
1638     con->rect = rect_sub(con->rect, bsr);
1639     parent->rect = rect_sub(parent->rect, bsr);
1640     parent->rect.y -= deco_height;
1641     parent->rect.height += deco_height;
1642 }
1643
1644 /*
1645  * This function changes the layout of a given container. Use it to handle
1646  * special cases like changing a whole workspace to stacked/tabbed (creates a
1647  * new split container before).
1648  *
1649  */
1650 void con_set_layout(Con *con, layout_t layout) {
1651     DLOG("con_set_layout(%p, %d), con->type = %d\n",
1652          con, layout, con->type);
1653
1654     /* Users can focus workspaces, but not any higher in the hierarchy.
1655      * Focus on the workspace is a special case, since in every other case, the
1656      * user means "change the layout of the parent split container". */
1657     if (con->type != CT_WORKSPACE)
1658         con = con->parent;
1659
1660     /* We fill in last_split_layout when switching to a different layout
1661      * since there are many places in the code that don’t use
1662      * con_set_layout(). */
1663     if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1664         con->last_split_layout = con->layout;
1665
1666     /* When the container type is CT_WORKSPACE, the user wants to change the
1667      * whole workspace into stacked/tabbed mode. To do this and still allow
1668      * intuitive operations (like level-up and then opening a new window), we
1669      * need to create a new split container. */
1670     if (con->type == CT_WORKSPACE) {
1671         if (con_num_children(con) == 0) {
1672             layout_t ws_layout = (layout == L_STACKED || layout == L_TABBED) ? layout : L_DEFAULT;
1673             DLOG("Setting workspace_layout to %d\n", ws_layout);
1674             con->workspace_layout = ws_layout;
1675             DLOG("Setting layout to %d\n", layout);
1676             con->layout = layout;
1677         } else if (layout == L_STACKED || layout == L_TABBED) {
1678             DLOG("Creating new split container\n");
1679             /* 1: create a new split container */
1680             Con *new = con_new(NULL, NULL);
1681             new->parent = con;
1682
1683             /* 2: Set the requested layout on the split container and mark it as
1684              * split. */
1685             new->layout = layout;
1686             new->last_split_layout = con->last_split_layout;
1687
1688             /* Save the container that was focused before we move containers
1689              * around, but only if the container is visible (otherwise focus
1690              * will be restored properly automatically when switching). */
1691             Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1692             if (old_focused == TAILQ_END(&(con->focus_head)))
1693                 old_focused = NULL;
1694             if (old_focused != NULL &&
1695                 !workspace_is_visible(con_get_workspace(old_focused)))
1696                 old_focused = NULL;
1697
1698             /* 3: move the existing cons of this workspace below the new con */
1699             DLOG("Moving cons\n");
1700             Con *child;
1701             while (!TAILQ_EMPTY(&(con->nodes_head))) {
1702                 child = TAILQ_FIRST(&(con->nodes_head));
1703                 con_detach(child);
1704                 con_attach(child, new, true);
1705             }
1706
1707             /* 4: attach the new split container to the workspace */
1708             DLOG("Attaching new split to ws\n");
1709             con_attach(new, con, false);
1710
1711             if (old_focused)
1712                 con_focus(old_focused);
1713
1714             tree_flatten(croot);
1715         }
1716         con_force_split_parents_redraw(con);
1717         return;
1718     }
1719
1720     if (layout == L_DEFAULT) {
1721         /* Special case: the layout formerly known as "default" (in combination
1722          * with an orientation). Since we switched to splith/splitv layouts,
1723          * using the "default" layout (which "only" should happen when using
1724          * legacy configs) is using the last split layout (either splith or
1725          * splitv) in order to still do the same thing. */
1726         con->layout = con->last_split_layout;
1727         /* In case last_split_layout was not initialized… */
1728         if (con->layout == L_DEFAULT)
1729             con->layout = L_SPLITH;
1730     } else {
1731         con->layout = layout;
1732     }
1733     con_force_split_parents_redraw(con);
1734 }
1735
1736 /*
1737  * This function toggles the layout of a given container. toggle_mode can be
1738  * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1739  * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1740  * layouts).
1741  *
1742  */
1743 void con_toggle_layout(Con *con, const char *toggle_mode) {
1744     Con *parent = con;
1745     /* Users can focus workspaces, but not any higher in the hierarchy.
1746      * Focus on the workspace is a special case, since in every other case, the
1747      * user means "change the layout of the parent split container". */
1748     if (con->type != CT_WORKSPACE)
1749         parent = con->parent;
1750     DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1751
1752     const char delim[] = " ";
1753
1754     if (strcasecmp(toggle_mode, "split") == 0 || strstr(toggle_mode, delim)) {
1755         /* L_DEFAULT is used as a placeholder value to distinguish if
1756          * the first layout has already been saved. (it can never be L_DEFAULT) */
1757         layout_t new_layout = L_DEFAULT;
1758         bool current_layout_found = false;
1759         char *tm_dup = sstrdup(toggle_mode);
1760         char *cur_tok = strtok(tm_dup, delim);
1761
1762         for (layout_t layout; cur_tok != NULL; cur_tok = strtok(NULL, delim)) {
1763             if (strcasecmp(cur_tok, "split") == 0) {
1764                 /* Toggle between splits. When the current layout is not a split
1765                  * layout, we just switch back to last_split_layout. Otherwise, we
1766                  * change to the opposite split layout. */
1767                 if (parent->layout != L_SPLITH && parent->layout != L_SPLITV) {
1768                     layout = parent->last_split_layout;
1769                 } else {
1770                     layout = (parent->layout == L_SPLITH) ? L_SPLITV : L_SPLITH;
1771                 }
1772             } else {
1773                 bool success = layout_from_name(cur_tok, &layout);
1774                 if (!success || layout == L_DEFAULT) {
1775                     ELOG("The token '%s' was not recognized and has been skipped.\n", cur_tok);
1776                     continue;
1777                 }
1778             }
1779
1780             /* If none of the specified layouts match the current,
1781              * fall back to the first layout in the list */
1782             if (new_layout == L_DEFAULT) {
1783                 new_layout = layout;
1784             }
1785
1786             /* We found the active layout in the last iteration, so
1787              * now let's activate the current layout (next in list) */
1788             if (current_layout_found) {
1789                 new_layout = layout;
1790                 free(tm_dup);
1791                 break;
1792             }
1793
1794             if (parent->layout == layout) {
1795                 current_layout_found = true;
1796             }
1797         }
1798
1799         con_set_layout(con, new_layout);
1800     } else if (strcasecmp(toggle_mode, "all") == 0 || strcasecmp(toggle_mode, "default") == 0) {
1801         if (parent->layout == L_STACKED)
1802             con_set_layout(con, L_TABBED);
1803         else if (parent->layout == L_TABBED) {
1804             if (strcasecmp(toggle_mode, "all") == 0)
1805                 con_set_layout(con, L_SPLITH);
1806             else
1807                 con_set_layout(con, parent->last_split_layout);
1808         } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1809             if (strcasecmp(toggle_mode, "all") == 0) {
1810                 /* When toggling through all modes, we toggle between
1811                  * splith/splitv, whereas normally we just directly jump to
1812                  * stacked. */
1813                 if (parent->layout == L_SPLITH)
1814                     con_set_layout(con, L_SPLITV);
1815                 else
1816                     con_set_layout(con, L_STACKED);
1817             } else {
1818                 con_set_layout(con, L_STACKED);
1819             }
1820         }
1821     }
1822 }
1823
1824 /*
1825  * Callback which will be called when removing a child from the given con.
1826  * Kills the container if it is empty and replaces it with the child if there
1827  * is exactly one child.
1828  *
1829  */
1830 static void con_on_remove_child(Con *con) {
1831     DLOG("on_remove_child\n");
1832
1833     /* Every container 'above' (in the hierarchy) the workspace content should
1834      * not be closed when the last child was removed */
1835     if (con->type == CT_OUTPUT ||
1836         con->type == CT_ROOT ||
1837         con->type == CT_DOCKAREA ||
1838         (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1839         DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1840         return;
1841     }
1842
1843     /* For workspaces, close them only if they're not visible anymore */
1844     if (con->type == CT_WORKSPACE) {
1845         if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1846             LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1847             yajl_gen gen = ipc_marshal_workspace_event("empty", con, NULL);
1848             tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1849
1850             const unsigned char *payload;
1851             ylength length;
1852             y(get_buf, &payload, &length);
1853             ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1854
1855             y(free);
1856         }
1857         return;
1858     }
1859
1860     con_force_split_parents_redraw(con);
1861     con->urgent = con_has_urgent_child(con);
1862     con_update_parents_urgency(con);
1863
1864     /* TODO: check if this container would swallow any other client and
1865      * don’t close it automatically. */
1866     int children = con_num_children(con);
1867     if (children == 0) {
1868         DLOG("Container empty, closing\n");
1869         tree_close_internal(con, DONT_KILL_WINDOW, false, false);
1870         return;
1871     }
1872 }
1873
1874 /*
1875  * Determines the minimum size of the given con by looking at its children (for
1876  * split/stacked/tabbed cons). Will be called when resizing floating cons
1877  *
1878  */
1879 Rect con_minimum_size(Con *con) {
1880     DLOG("Determining minimum size for con %p\n", con);
1881
1882     if (con_is_leaf(con)) {
1883         DLOG("leaf node, returning 75x50\n");
1884         return (Rect){0, 0, 75, 50};
1885     }
1886
1887     if (con->type == CT_FLOATING_CON) {
1888         DLOG("floating con\n");
1889         Con *child = TAILQ_FIRST(&(con->nodes_head));
1890         return con_minimum_size(child);
1891     }
1892
1893     if (con->layout == L_STACKED || con->layout == L_TABBED) {
1894         uint32_t max_width = 0, max_height = 0, deco_height = 0;
1895         Con *child;
1896         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1897             Rect min = con_minimum_size(child);
1898             deco_height += child->deco_rect.height;
1899             max_width = max(max_width, min.width);
1900             max_height = max(max_height, min.height);
1901         }
1902         DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1903              max_width, max_height, deco_height);
1904         return (Rect){0, 0, max_width, max_height + deco_height};
1905     }
1906
1907     /* For horizontal/vertical split containers we sum up the width (h-split)
1908      * or height (v-split) and use the maximum of the height (h-split) or width
1909      * (v-split) as minimum size. */
1910     if (con_is_split(con)) {
1911         uint32_t width = 0, height = 0;
1912         Con *child;
1913         TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
1914             Rect min = con_minimum_size(child);
1915             if (con->layout == L_SPLITH) {
1916                 width += min.width;
1917                 height = max(height, min.height);
1918             } else {
1919                 height += min.height;
1920                 width = max(width, min.width);
1921             }
1922         }
1923         DLOG("split container, returning width = %d x height = %d\n", width, height);
1924         return (Rect){0, 0, width, height};
1925     }
1926
1927     ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1928          con->type, con->layout, con_is_split(con));
1929     assert(false);
1930 }
1931
1932 /*
1933  * Returns true if changing the focus to con would be allowed considering
1934  * the fullscreen focus constraints. Specifically, if a fullscreen container or
1935  * any of its descendants is focused, this function returns true if and only if
1936  * focusing con would mean that focus would still be visible on screen, i.e.,
1937  * the newly focused container would not be obscured by a fullscreen container.
1938  *
1939  * In the simplest case, if a fullscreen container or any of its descendants is
1940  * fullscreen, this functions returns true if con is the fullscreen container
1941  * itself or any of its descendants, as this means focus wouldn't escape the
1942  * boundaries of the fullscreen container.
1943  *
1944  * In case the fullscreen container is of type CF_OUTPUT, this function returns
1945  * true if con is on a different workspace, as focus wouldn't be obscured by
1946  * the fullscreen container that is constrained to a different workspace.
1947  *
1948  * Note that this same logic can be applied to moving containers. If a
1949  * container can be focused under the fullscreen focus constraints, it can also
1950  * become a parent or sibling to the currently focused container.
1951  *
1952  */
1953 bool con_fullscreen_permits_focusing(Con *con) {
1954     /* No focus, no problem. */
1955     if (!focused)
1956         return true;
1957
1958     /* Find the first fullscreen ascendent. */
1959     Con *fs = focused;
1960     while (fs && fs->fullscreen_mode == CF_NONE)
1961         fs = fs->parent;
1962
1963     /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1964      * there always has to be a workspace con in the hierarchy. */
1965     assert(fs != NULL);
1966     /* The most common case is we hit the workspace level. In this
1967      * situation, changing focus is also harmless. */
1968     assert(fs->fullscreen_mode != CF_NONE);
1969     if (fs->type == CT_WORKSPACE)
1970         return true;
1971
1972     /* Allow it if the container itself is the fullscreen container. */
1973     if (con == fs)
1974         return true;
1975
1976     /* If fullscreen is per-output, the focus being in a different workspace is
1977      * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1978     if (fs->fullscreen_mode == CF_OUTPUT &&
1979         con_get_workspace(con) != con_get_workspace(fs)) {
1980         return true;
1981     }
1982
1983     /* Allow it only if the container to be focused is contained within the
1984      * current fullscreen container. */
1985     do {
1986         if (con->parent == fs)
1987             return true;
1988         con = con->parent;
1989     } while (con);
1990
1991     /* Focusing con would hide it behind a fullscreen window, disallow it. */
1992     return false;
1993 }
1994
1995 /*
1996  *
1997  * Checks if the given container has an urgent child.
1998  *
1999  */
2000 bool con_has_urgent_child(Con *con) {
2001     Con *child;
2002
2003     if (con_is_leaf(con))
2004         return con->urgent;
2005
2006     /* We are not interested in floating windows since they can only be
2007      * attached to a workspace → nodes_head instead of focus_head */
2008     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2009         if (con_has_urgent_child(child))
2010             return true;
2011     }
2012
2013     return false;
2014 }
2015
2016 /*
2017  * Make all parent containers urgent if con is urgent or clear the urgent flag
2018  * of all parent containers if there are no more urgent children left.
2019  *
2020  */
2021 void con_update_parents_urgency(Con *con) {
2022     Con *parent = con->parent;
2023
2024     /* Urgency hints should not be set on any container higher up in the
2025      * hierarchy than the workspace level. Unfortunately, since the content
2026      * container has type == CT_CON, that’s not easy to verify in the loop
2027      * below, so we need another condition to catch that case: */
2028     if (con->type == CT_WORKSPACE)
2029         return;
2030
2031     bool new_urgency_value = con->urgent;
2032     while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
2033         if (new_urgency_value) {
2034             parent->urgent = true;
2035         } else {
2036             /* We can only reset the urgency when the parent
2037              * has no other urgent children */
2038             if (!con_has_urgent_child(parent))
2039                 parent->urgent = false;
2040         }
2041         parent = parent->parent;
2042     }
2043 }
2044
2045 /*
2046  * Set urgency flag to the container, all the parent containers and the workspace.
2047  *
2048  */
2049 void con_set_urgency(Con *con, bool urgent) {
2050     if (urgent && focused == con) {
2051         DLOG("Ignoring urgency flag for current client\n");
2052         return;
2053     }
2054
2055     const bool old_urgent = con->urgent;
2056
2057     if (con->urgency_timer == NULL) {
2058         con->urgent = urgent;
2059     } else
2060         DLOG("Discarding urgency WM_HINT because timer is running\n");
2061
2062     //CLIENT_LOG(con);
2063     if (con->window) {
2064         if (con->urgent) {
2065             gettimeofday(&con->window->urgent, NULL);
2066         } else {
2067             con->window->urgent.tv_sec = 0;
2068             con->window->urgent.tv_usec = 0;
2069         }
2070     }
2071
2072     con_update_parents_urgency(con);
2073
2074     Con *ws;
2075     /* Set the urgency flag on the workspace, if a workspace could be found
2076      * (for dock clients, that is not the case). */
2077     if ((ws = con_get_workspace(con)) != NULL)
2078         workspace_update_urgent_flag(ws);
2079
2080     if (con->urgent != old_urgent) {
2081         LOG("Urgency flag changed to %d\n", con->urgent);
2082         ipc_send_window_event("urgent", con);
2083     }
2084 }
2085
2086 /*
2087  * Create a string representing the subtree under con.
2088  *
2089  */
2090 char *con_get_tree_representation(Con *con) {
2091     /* this code works as follows:
2092      *  1) create a string with the layout type (D/V/H/T/S) and an opening bracket
2093      *  2) append the tree representation of the children to the string
2094      *  3) add closing bracket
2095      *
2096      * The recursion ends when we hit a leaf, in which case we return the
2097      * class_instance of the contained window.
2098      */
2099
2100     /* end of recursion */
2101     if (con_is_leaf(con)) {
2102         if (!con->window)
2103             return sstrdup("nowin");
2104
2105         if (!con->window->class_instance)
2106             return sstrdup("noinstance");
2107
2108         return sstrdup(con->window->class_instance);
2109     }
2110
2111     char *buf;
2112     /* 1) add the Layout type to buf */
2113     if (con->layout == L_DEFAULT)
2114         buf = sstrdup("D[");
2115     else if (con->layout == L_SPLITV)
2116         buf = sstrdup("V[");
2117     else if (con->layout == L_SPLITH)
2118         buf = sstrdup("H[");
2119     else if (con->layout == L_TABBED)
2120         buf = sstrdup("T[");
2121     else if (con->layout == L_STACKED)
2122         buf = sstrdup("S[");
2123     else {
2124         ELOG("BUG: Code not updated to account for new layout type\n");
2125         assert(false);
2126     }
2127
2128     /* 2) append representation of children */
2129     Con *child;
2130     TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
2131         char *child_txt = con_get_tree_representation(child);
2132
2133         char *tmp_buf;
2134         sasprintf(&tmp_buf, "%s%s%s", buf,
2135                   (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
2136         free(buf);
2137         buf = tmp_buf;
2138         free(child_txt);
2139     }
2140
2141     /* 3) close the brackets */
2142     char *complete_buf;
2143     sasprintf(&complete_buf, "%s]", buf);
2144     free(buf);
2145
2146     return complete_buf;
2147 }
2148
2149 /*
2150  * Returns the container's title considering the current title format.
2151  *
2152  */
2153 i3String *con_parse_title_format(Con *con) {
2154     assert(con->title_format != NULL);
2155
2156     i3Window *win = con->window;
2157
2158     /* We need to ensure that we only escape the window title if pango
2159      * is used by the current font. */
2160     const bool pango_markup = font_is_pango();
2161
2162     char *title;
2163     char *class;
2164     char *instance;
2165     if (win == NULL) {
2166         title = pango_escape_markup(con_get_tree_representation(con));
2167         class = sstrdup("i3-frame");
2168         instance = sstrdup("i3-frame");
2169     } else {
2170         title = pango_escape_markup(sstrdup((win->name == NULL) ? "" : i3string_as_utf8(win->name)));
2171         class = pango_escape_markup(sstrdup((win->class_class == NULL) ? "" : win->class_class));
2172         instance = pango_escape_markup(sstrdup((win->class_instance == NULL) ? "" : win->class_instance));
2173     }
2174
2175     placeholder_t placeholders[] = {
2176         {.name = "%title", .value = title},
2177         {.name = "%class", .value = class},
2178         {.name = "%instance", .value = instance}};
2179     const size_t num = sizeof(placeholders) / sizeof(placeholder_t);
2180
2181     char *formatted_str = format_placeholders(con->title_format, &placeholders[0], num);
2182     i3String *formatted = i3string_from_utf8(formatted_str);
2183     i3string_set_markup(formatted, pango_markup);
2184     FREE(formatted_str);
2185
2186     for (size_t i = 0; i < num; i++) {
2187         FREE(placeholders[i].value);
2188     }
2189
2190     return formatted;
2191 }
2192
2193 /*
2194  * Swaps the two containers.
2195  *
2196  */
2197 bool con_swap(Con *first, Con *second) {
2198     assert(first != NULL);
2199     assert(second != NULL);
2200     DLOG("Swapping containers %p / %p\n", first, second);
2201
2202     if (first->type != CT_CON) {
2203         ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", first, first->type);
2204         return false;
2205     }
2206
2207     if (second->type != CT_CON) {
2208         ELOG("Only regular containers can be swapped, but found con = %p with type = %d.\n", second, second->type);
2209         return false;
2210     }
2211
2212     if (con_is_floating(first) || con_is_floating(second)) {
2213         ELOG("Floating windows cannot be swapped.\n");
2214         return false;
2215     }
2216
2217     if (first == second) {
2218         DLOG("Swapping container %p with itself, nothing to do.\n", first);
2219         return false;
2220     }
2221
2222     if (con_has_parent(first, second) || con_has_parent(second, first)) {
2223         ELOG("Cannot swap containers %p and %p because they are in a parent-child relationship.\n", first, second);
2224         return false;
2225     }
2226
2227     Con *old_focus = focused;
2228
2229     Con *first_ws = con_get_workspace(first);
2230     Con *second_ws = con_get_workspace(second);
2231     Con *current_ws = con_get_workspace(old_focus);
2232     const bool focused_within_first = (first == old_focus || con_has_parent(old_focus, first));
2233     const bool focused_within_second = (second == old_focus || con_has_parent(old_focus, second));
2234
2235     if (!con_fullscreen_permits_focusing(first_ws)) {
2236         DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", first_ws->name);
2237         return false;
2238     }
2239
2240     if (!con_fullscreen_permits_focusing(second_ws)) {
2241         DLOG("Cannot swap because target workspace \"%s\" is obscured.\n", second_ws->name);
2242         return false;
2243     }
2244
2245     double first_percent = first->percent;
2246     double second_percent = second->percent;
2247
2248     /* De- and reattaching the containers will insert them at the tail of the
2249      * focus_heads. We will need to fix this. But we need to make sure first
2250      * and second don't get in each other's way if they share the same parent,
2251      * so we select the closest previous focus_head that isn't involved. */
2252     Con *first_prev_focus_head = first;
2253     while (first_prev_focus_head == first || first_prev_focus_head == second) {
2254         first_prev_focus_head = TAILQ_PREV(first_prev_focus_head, focus_head, focused);
2255     }
2256
2257     Con *second_prev_focus_head = second;
2258     while (second_prev_focus_head == second || second_prev_focus_head == first) {
2259         second_prev_focus_head = TAILQ_PREV(second_prev_focus_head, focus_head, focused);
2260     }
2261
2262     /* We use a fake container to mark the spot of where the second container needs to go. */
2263     Con *fake = con_new(NULL, NULL);
2264     fake->layout = L_SPLITH;
2265     _con_attach(fake, first->parent, first, true);
2266
2267     bool result = true;
2268     /* Swap the containers. We set the ignore_focus flag here because after the
2269      * container is attached, the focus order is not yet correct and would
2270      * result in wrong windows being focused. */
2271
2272     /* Move first to second. */
2273     result &= _con_move_to_con(first, second, false, false, false, true, false);
2274
2275     /* If we moved the container holding the focused window to another
2276      * workspace we need to ensure the visible workspace has the focused
2277      * container.
2278      * We don't need to check this for the second container because we've only
2279      * moved the first one at this point.*/
2280     if (first_ws != second_ws && focused_within_first) {
2281         con_focus(con_descend_focused(current_ws));
2282     }
2283
2284     /* Move second to where first has been originally. */
2285     result &= _con_move_to_con(second, fake, false, false, false, true, false);
2286
2287     /* If swapping the containers didn't work we don't need to mess with the focus. */
2288     if (!result) {
2289         goto swap_end;
2290     }
2291
2292     /* Swapping will have inserted the containers at the tail of their parents'
2293      * focus head. We fix this now by putting them in the position of the focus
2294      * head the container they swapped with was in. */
2295     TAILQ_REMOVE(&(first->parent->focus_head), first, focused);
2296     TAILQ_REMOVE(&(second->parent->focus_head), second, focused);
2297
2298     if (second_prev_focus_head == NULL) {
2299         TAILQ_INSERT_HEAD(&(first->parent->focus_head), first, focused);
2300     } else {
2301         TAILQ_INSERT_AFTER(&(first->parent->focus_head), second_prev_focus_head, first, focused);
2302     }
2303
2304     if (first_prev_focus_head == NULL) {
2305         TAILQ_INSERT_HEAD(&(second->parent->focus_head), second, focused);
2306     } else {
2307         TAILQ_INSERT_AFTER(&(second->parent->focus_head), first_prev_focus_head, second, focused);
2308     }
2309
2310     /* If the focus was within any of the swapped containers, do the following:
2311      * - If swapping took place within a workspace, ensure the previously
2312      *   focused container stays focused.
2313      * - Otherwise, focus the container that has been swapped in.
2314      *
2315      * To understand why fixing the focus_head previously wasn't enough,
2316      * consider the scenario
2317      *   H[ V[ A X ] V[ Y B ] ]
2318      * with B being focused, but X being the focus_head within its parent. If
2319      * we swap A and B now, fixing the focus_head would focus X, but since B
2320      * was the focused container before it should stay focused.
2321      */
2322     if (focused_within_first) {
2323         if (first_ws == second_ws) {
2324             con_focus(old_focus);
2325         } else {
2326             con_focus(con_descend_focused(second));
2327         }
2328     } else if (focused_within_second) {
2329         if (first_ws == second_ws) {
2330             con_focus(old_focus);
2331         } else {
2332             con_focus(con_descend_focused(first));
2333         }
2334     }
2335
2336     /* We need to copy each other's percentages to ensure that the geometry
2337      * doesn't change during the swap. This needs to happen _before_ we close
2338      * the fake container as closing the tree will recalculate percentages. */
2339     first->percent = second_percent;
2340     second->percent = first_percent;
2341     fake->percent = 0.0;
2342
2343 swap_end:
2344     /* We don't actually need this since percentages-wise we haven't changed
2345      * anything, but we'll better be safe than sorry and just make sure as we'd
2346      * otherwise crash i3. */
2347     con_fix_percent(first->parent);
2348     con_fix_percent(second->parent);
2349
2350     /* We can get rid of the fake container again now. */
2351     con_close(fake, DONT_KILL_WINDOW);
2352
2353     con_force_split_parents_redraw(first);
2354     con_force_split_parents_redraw(second);
2355
2356     return result;
2357 }