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