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