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