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