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