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