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