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