i3
con.c
Go to the documentation of this file.
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-2011 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 
16 char *colors[] = {
17  "#ff0000",
18  "#00FF00",
19  "#0000FF",
20  "#ff00ff",
21  "#00ffff",
22  "#ffff00",
23  "#aa0000",
24  "#00aa00",
25  "#0000aa",
26  "#aa00aa"};
27 
28 static void con_on_remove_child(Con *con);
29 
30 /*
31  * force parent split containers to be redrawn
32  *
33  */
35  Con *parent = con;
36 
37  while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
38  if (!con_is_leaf(parent))
39  FREE(parent->deco_render_params);
40  parent = parent->parent;
41  }
42 }
43 
44 /*
45  * Create a new container (and attach it to the given parent, if not NULL).
46  * This function only initializes the data structures.
47  *
48  */
49 Con *con_new_skeleton(Con *parent, i3Window *window) {
50  Con *new = scalloc(sizeof(Con));
51  new->on_remove_child = con_on_remove_child;
53  new->aspect_ratio = 0.0;
54  new->type = CT_CON;
55  new->window = window;
56  new->border_style = config.default_border;
57  new->current_border_width = -1;
58  if (window)
59  new->depth = window->depth;
60  else
61  new->depth = XCB_COPY_FROM_PARENT;
62  static int cnt = 0;
63  DLOG("opening window %d\n", cnt);
64 
65  /* TODO: remove window coloring after test-phase */
66  DLOG("color %s\n", colors[cnt]);
67  new->name = strdup(colors[cnt]);
68  //uint32_t cp = get_colorpixel(colors[cnt]);
69  cnt++;
70  if ((cnt % (sizeof(colors) / sizeof(char *))) == 0)
71  cnt = 0;
72 
73  TAILQ_INIT(&(new->floating_head));
74  TAILQ_INIT(&(new->nodes_head));
75  TAILQ_INIT(&(new->focus_head));
76  TAILQ_INIT(&(new->swallow_head));
77 
78  if (parent != NULL)
79  con_attach(new, parent, false);
80 
81  return new;
82 }
83 
84 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
85  *
86  */
87 Con *con_new(Con *parent, i3Window *window) {
88  Con *new = con_new_skeleton(parent, window);
89  x_con_init(new, new->depth);
90  return new;
91 }
92 
93 /*
94  * Attaches the given container to the given parent. This happens when moving
95  * a container or when inserting a new container at a specific place in the
96  * tree.
97  *
98  * ignore_focus is to just insert the Con at the end (useful when creating a
99  * new split container *around* some containers, that is, detaching and
100  * attaching them in order without wanting to mess with the focus in between).
101  *
102  */
103 void con_attach(Con *con, Con *parent, bool ignore_focus) {
104  con->parent = parent;
105  Con *loop;
106  Con *current = NULL;
107  struct nodes_head *nodes_head = &(parent->nodes_head);
108  struct focus_head *focus_head = &(parent->focus_head);
109 
110  /* Workspaces are handled differently: they need to be inserted at the
111  * right position. */
112  if (con->type == CT_WORKSPACE) {
113  DLOG("it's a workspace. num = %d\n", con->num);
114  if (con->num == -1 || TAILQ_EMPTY(nodes_head)) {
115  TAILQ_INSERT_TAIL(nodes_head, con, nodes);
116  } else {
117  current = TAILQ_FIRST(nodes_head);
118  if (con->num < current->num) {
119  /* we need to insert the container at the beginning */
120  TAILQ_INSERT_HEAD(nodes_head, con, nodes);
121  } else {
122  while (current->num != -1 && con->num > current->num) {
123  current = TAILQ_NEXT(current, nodes);
124  if (current == TAILQ_END(nodes_head)) {
125  current = NULL;
126  break;
127  }
128  }
129  /* we need to insert con after current, if current is not NULL */
130  if (current)
131  TAILQ_INSERT_BEFORE(current, con, nodes);
132  else
133  TAILQ_INSERT_TAIL(nodes_head, con, nodes);
134  }
135  }
136  goto add_to_focus_head;
137  }
138 
139  if (con->type == CT_FLOATING_CON) {
140  DLOG("Inserting into floating containers\n");
141  TAILQ_INSERT_TAIL(&(parent->floating_head), con, floating_windows);
142  } else {
143  if (!ignore_focus) {
144  /* Get the first tiling container in focus stack */
145  TAILQ_FOREACH (loop, &(parent->focus_head), focused) {
146  if (loop->type == CT_FLOATING_CON)
147  continue;
148  current = loop;
149  break;
150  }
151  }
152 
153  /* When the container is not a split container (but contains a window)
154  * and is attached to a workspace, we check if the user configured a
155  * workspace_layout. This is done in workspace_attach_to, which will
156  * provide us with the container to which we should attach (either the
157  * workspace or a new split container with the configured
158  * workspace_layout).
159  */
160  if (con->window != NULL &&
161  parent->type == CT_WORKSPACE &&
162  parent->workspace_layout != L_DEFAULT) {
163  DLOG("Parent is a workspace. Applying default layout...\n");
164  Con *target = workspace_attach_to(parent);
165 
166  /* Attach the original con to this new split con instead */
167  nodes_head = &(target->nodes_head);
168  focus_head = &(target->focus_head);
169  con->parent = target;
170  current = NULL;
171 
172  DLOG("done\n");
173  }
174 
175  /* Insert the container after the tiling container, if found.
176  * When adding to a CT_OUTPUT, just append one after another. */
177  if (current && parent->type != CT_OUTPUT) {
178  DLOG("Inserting con = %p after last focused tiling con %p\n",
179  con, current);
180  TAILQ_INSERT_AFTER(nodes_head, current, con, nodes);
181  } else
182  TAILQ_INSERT_TAIL(nodes_head, con, nodes);
183  }
184 
185 add_to_focus_head:
186  /* We insert to the TAIL because con_focus() will correct this.
187  * This way, we have the option to insert Cons without having
188  * to focus them. */
189  TAILQ_INSERT_TAIL(focus_head, con, focused);
191 }
192 
193 /*
194  * Detaches the given container from its current parent
195  *
196  */
197 void con_detach(Con *con) {
199  if (con->type == CT_FLOATING_CON) {
200  TAILQ_REMOVE(&(con->parent->floating_head), con, floating_windows);
201  TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
202  } else {
203  TAILQ_REMOVE(&(con->parent->nodes_head), con, nodes);
204  TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
205  }
206 }
207 
208 /*
209  * Sets input focus to the given container. Will be updated in X11 in the next
210  * run of x_push_changes().
211  *
212  */
213 void con_focus(Con *con) {
214  assert(con != NULL);
215  DLOG("con_focus = %p\n", con);
216 
217  /* 1: set focused-pointer to the new con */
218  /* 2: exchange the position of the container in focus stack of the parent all the way up */
219  TAILQ_REMOVE(&(con->parent->focus_head), con, focused);
220  TAILQ_INSERT_HEAD(&(con->parent->focus_head), con, focused);
221  if (con->parent->parent != NULL)
222  con_focus(con->parent);
223 
224  focused = con;
225  /* We can't blindly reset non-leaf containers since they might have
226  * other urgent children. Therefore we only reset leafs and propagate
227  * the changes upwards via con_update_parents_urgency() which does proper
228  * checks before resetting the urgency.
229  */
230  if (con->urgent && con_is_leaf(con)) {
231  con->urgent = false;
234  }
235 }
236 
237 /*
238  * Returns true when this node is a leaf node (has no children)
239  *
240  */
241 bool con_is_leaf(Con *con) {
242  return TAILQ_EMPTY(&(con->nodes_head));
243 }
244 
245 /*
246  * Returns true when this con is a leaf node with a managed X11 window (e.g.,
247  * excluding dock containers)
248  */
250  return (con != NULL && con->window != NULL && con->window->id != XCB_WINDOW_NONE && con_get_workspace(con) != NULL);
251 }
252 
257 bool con_has_children(Con *con) {
258  return (!con_is_leaf(con) || !TAILQ_EMPTY(&(con->floating_head)));
259 }
260 
261 /*
262  * Returns true if a container should be considered split.
263  *
264  */
265 bool con_is_split(Con *con) {
266  if (con_is_leaf(con))
267  return false;
268 
269  switch (con->layout) {
270  case L_DOCKAREA:
271  case L_OUTPUT:
272  return false;
273 
274  default:
275  return true;
276  }
277 }
278 
279 /*
280  * Returns true if this node accepts a window (if the node swallows windows,
281  * it might already have swallowed enough and cannot hold any more).
282  *
283  */
285  /* 1: workspaces never accept direct windows */
286  if (con->type == CT_WORKSPACE)
287  return false;
288 
289  if (con_is_split(con)) {
290  DLOG("container %p does not accept windows, it is a split container.\n", con);
291  return false;
292  }
293 
294  /* TODO: if this is a swallowing container, we need to check its max_clients */
295  return (con->window == NULL);
296 }
297 
298 /*
299  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
300  * node is on.
301  *
302  */
304  Con *result = con;
305  while (result != NULL && result->type != CT_OUTPUT)
306  result = result->parent;
307  /* We must be able to get an output because focus can never be set higher
308  * in the tree (root node cannot be focused). */
309  assert(result != NULL);
310  return result;
311 }
312 
313 /*
314  * Gets the workspace container this node is on.
315  *
316  */
318  Con *result = con;
319  while (result != NULL && result->type != CT_WORKSPACE)
320  result = result->parent;
321  return result;
322 }
323 
324 /*
325  * Searches parenst of the given 'con' until it reaches one with the specified
326  * 'orientation'. Aborts when it comes across a floating_con.
327  *
328  */
330  DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
331  Con *parent = con->parent;
332  if (parent->type == CT_FLOATING_CON)
333  return NULL;
334  while (con_orientation(parent) != orientation) {
335  DLOG("Need to go one level further up\n");
336  parent = parent->parent;
337  /* Abort when we reach a floating con, or an output con */
338  if (parent &&
339  (parent->type == CT_FLOATING_CON ||
340  parent->type == CT_OUTPUT ||
341  (parent->parent && parent->parent->type == CT_OUTPUT)))
342  parent = NULL;
343  if (parent == NULL)
344  break;
345  }
346  DLOG("Result: %p\n", parent);
347  return parent;
348 }
349 
350 /*
351  * helper data structure for the breadth-first-search in
352  * con_get_fullscreen_con()
353  *
354  */
355 struct bfs_entry {
357 
358  TAILQ_ENTRY(bfs_entry) entries;
359 };
360 
361 /*
362  * Returns the first fullscreen node below this node.
363  *
364  */
366  Con *current, *child;
367 
368  /* TODO: is breadth-first-search really appropriate? (check as soon as
369  * fullscreen levels and fullscreen for containers is implemented) */
370  TAILQ_HEAD(bfs_head, bfs_entry) bfs_head = TAILQ_HEAD_INITIALIZER(bfs_head);
371  struct bfs_entry *entry = smalloc(sizeof(struct bfs_entry));
372  entry->con = con;
373  TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
374 
375  while (!TAILQ_EMPTY(&bfs_head)) {
376  entry = TAILQ_FIRST(&bfs_head);
377  current = entry->con;
378  if (current != con && current->fullscreen_mode == fullscreen_mode) {
379  /* empty the queue */
380  while (!TAILQ_EMPTY(&bfs_head)) {
381  entry = TAILQ_FIRST(&bfs_head);
382  TAILQ_REMOVE(&bfs_head, entry, entries);
383  free(entry);
384  }
385  return current;
386  }
387 
388  TAILQ_REMOVE(&bfs_head, entry, entries);
389  free(entry);
390 
391  TAILQ_FOREACH (child, &(current->nodes_head), nodes) {
392  entry = smalloc(sizeof(struct bfs_entry));
393  entry->con = child;
394  TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
395  }
396 
397  TAILQ_FOREACH (child, &(current->floating_head), floating_windows) {
398  entry = smalloc(sizeof(struct bfs_entry));
399  entry->con = child;
400  TAILQ_INSERT_TAIL(&bfs_head, entry, entries);
401  }
402  }
403 
404  return NULL;
405 }
406 
412  return (con->name[0] == '_' && con->name[1] == '_');
413 }
414 
415 /*
416  * Returns true if the node is floating.
417  *
418  */
420  assert(con != NULL);
421  DLOG("checking if con %p is floating\n", con);
422  return (con->floating >= FLOATING_AUTO_ON);
423 }
424 
425 /*
426  * Checks if the given container is either floating or inside some floating
427  * container. It returns the FLOATING_CON container.
428  *
429  */
431  assert(con != NULL);
432  if (con->type == CT_FLOATING_CON)
433  return con;
434 
435  if (con->floating >= FLOATING_AUTO_ON)
436  return con->parent;
437 
438  if (con->type == CT_WORKSPACE || con->type == CT_OUTPUT)
439  return NULL;
440 
441  return con_inside_floating(con->parent);
442 }
443 
444 /*
445  * Checks if the given container is inside a focused container.
446  *
447  */
449  if (con == focused)
450  return true;
451  if (!con->parent)
452  return false;
453  return con_inside_focused(con->parent);
454 }
455 
456 /*
457  * Returns the container with the given client window ID or NULL if no such
458  * container exists.
459  *
460  */
461 Con *con_by_window_id(xcb_window_t window) {
462  Con *con;
464  if (con->window != NULL && con->window->id == window)
465  return con;
466  return NULL;
467 }
468 
469 /*
470  * Returns the container with the given frame ID or NULL if no such container
471  * exists.
472  *
473  */
474 Con *con_by_frame_id(xcb_window_t frame) {
475  Con *con;
477  if (con->frame == frame)
478  return con;
479  return NULL;
480 }
481 
482 /*
483  * Returns the first container below 'con' which wants to swallow this window
484  * TODO: priority
485  *
486  */
487 Con *con_for_window(Con *con, i3Window *window, Match **store_match) {
488  Con *child;
489  Match *match;
490  //DLOG("searching con for window %p starting at con %p\n", window, con);
491  //DLOG("class == %s\n", window->class_class);
492 
493  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
494  TAILQ_FOREACH (match, &(child->swallow_head), matches) {
495  if (!match_matches_window(match, window))
496  continue;
497  if (store_match != NULL)
498  *store_match = match;
499  return child;
500  }
501  Con *result = con_for_window(child, window, store_match);
502  if (result != NULL)
503  return result;
504  }
505 
506  TAILQ_FOREACH (child, &(con->floating_head), floating_windows) {
507  TAILQ_FOREACH (match, &(child->swallow_head), matches) {
508  if (!match_matches_window(match, window))
509  continue;
510  if (store_match != NULL)
511  *store_match = match;
512  return child;
513  }
514  Con *result = con_for_window(child, window, store_match);
515  if (result != NULL)
516  return result;
517  }
518 
519  return NULL;
520 }
521 
522 /*
523  * Returns the number of children of this container.
524  *
525  */
527  Con *child;
528  int children = 0;
529 
530  TAILQ_FOREACH (child, &(con->nodes_head), nodes)
531  children++;
532 
533  return children;
534 }
535 
536 /*
537  * Updates the percent attribute of the children of the given container. This
538  * function needs to be called when a window is added or removed from a
539  * container.
540  *
541  */
543  Con *child;
544  int children = con_num_children(con);
545 
546  // calculate how much we have distributed and how many containers
547  // with a percentage set we have
548  double total = 0.0;
549  int children_with_percent = 0;
550  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
551  if (child->percent > 0.0) {
552  total += child->percent;
553  ++children_with_percent;
554  }
555  }
556 
557  // if there were children without a percentage set, set to a value that
558  // will make those children proportional to all others
559  if (children_with_percent != children) {
560  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
561  if (child->percent <= 0.0) {
562  if (children_with_percent == 0)
563  total += (child->percent = 1.0);
564  else
565  total += (child->percent = total / children_with_percent);
566  }
567  }
568  }
569 
570  // if we got a zero, just distribute the space equally, otherwise
571  // distribute according to the proportions we got
572  if (total == 0.0) {
573  TAILQ_FOREACH (child, &(con->nodes_head), nodes)
574  child->percent = 1.0 / children;
575  } else if (total != 1.0) {
576  TAILQ_FOREACH (child, &(con->nodes_head), nodes)
577  child->percent /= total;
578  }
579 }
580 
581 /*
582  * Toggles fullscreen mode for the given container. If there already is a
583  * fullscreen container on this workspace, fullscreen will be disabled and then
584  * enabled for the container the user wants to have in fullscreen mode.
585  *
586  */
587 void con_toggle_fullscreen(Con *con, int fullscreen_mode) {
588  Con *workspace, *fullscreen;
589 
590  if (con->type == CT_WORKSPACE) {
591  DLOG("You cannot make a workspace fullscreen.\n");
592  return;
593  }
594 
595  DLOG("toggling fullscreen for %p / %s\n", con, con->name);
596  if (con->fullscreen_mode == CF_NONE) {
597  /* 1: check if there already is a fullscreen con */
598  if (fullscreen_mode == CF_GLOBAL)
599  fullscreen = con_get_fullscreen_con(croot, CF_GLOBAL);
600  else {
601  workspace = con_get_workspace(con);
602  fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
603  }
604  if (fullscreen != NULL) {
605  /* Disable fullscreen for the currently fullscreened
606  * container and enable it for the one the user wants
607  * to have in fullscreen mode. */
608  LOG("Disabling fullscreen for (%p/%s) upon user request\n",
609  fullscreen, fullscreen->name);
610  fullscreen->fullscreen_mode = CF_NONE;
611  }
612 
613  /* 2: enable fullscreen */
614  con->fullscreen_mode = fullscreen_mode;
615  } else {
616  /* 1: disable fullscreen */
617  con->fullscreen_mode = CF_NONE;
618  }
619 
620  DLOG("mode now: %d\n", con->fullscreen_mode);
621 
622  /* Send an ipc window "fullscreen_mode" event */
623  ipc_send_window_event("fullscreen_mode", con);
624 
625  /* update _NET_WM_STATE if this container has a window */
626  /* TODO: when a window is assigned to a container which is already
627  * fullscreened, this state needs to be pushed to the client, too */
628  if (con->window == NULL)
629  return;
630 
631  uint32_t values[1];
632  unsigned int num = 0;
633 
634  if (con->fullscreen_mode != CF_NONE)
635  values[num++] = A__NET_WM_STATE_FULLSCREEN;
636 
637  xcb_change_property(conn, XCB_PROP_MODE_REPLACE, con->window->id,
638  A__NET_WM_STATE, XCB_ATOM_ATOM, 32, num, values);
639 }
640 
641 /*
642  * Moves the given container to the currently focused container on the given
643  * workspace.
644  *
645  * The fix_coordinates flag will translate the current coordinates (offset from
646  * the monitor position basically) to appropriate coordinates on the
647  * destination workspace.
648  * Not enabling this behaviour comes in handy when this function gets called by
649  * floating_maybe_reassign_ws, which will only "move" a floating window when it
650  * *already* changed its coordinates to a different output.
651  *
652  * The dont_warp flag disables pointer warping and will be set when this
653  * function is called while dragging a floating window.
654  *
655  * TODO: is there a better place for this function?
656  *
657  */
658 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp) {
659  /* Prevent moving if this would violate the fullscreen focus restrictions. */
660  if (!con_fullscreen_permits_focusing(workspace)) {
661  LOG("Cannot move out of a fullscreen container");
662  return;
663  }
664 
665  if (con_is_floating(con)) {
666  DLOG("Using FLOATINGCON instead\n");
667  con = con->parent;
668  }
669 
670  Con *source_ws = con_get_workspace(con);
671  if (workspace == source_ws) {
672  DLOG("Not moving, already there\n");
673  return;
674  }
675 
676  if (con->type == CT_WORKSPACE) {
677  /* Re-parent all of the old workspace's floating windows. */
678  Con *child;
679  while (!TAILQ_EMPTY(&(source_ws->floating_head))) {
680  child = TAILQ_FIRST(&(source_ws->floating_head));
681  con_move_to_workspace(child, workspace, true, true);
682  }
683 
684  /* If there are no non-floating children, ignore the workspace. */
685  if (con_is_leaf(con))
686  return;
687 
688  con = workspace_encapsulate(con);
689  if (con == NULL) {
690  ELOG("Workspace failed to move its contents into a container!\n");
691  return;
692  }
693  }
694 
695  /* Save the current workspace. So we can call workspace_show() by the end
696  * of this function. */
697  Con *current_ws = con_get_workspace(focused);
698 
699  Con *source_output = con_get_output(con),
700  *dest_output = con_get_output(workspace);
701 
702  /* 1: save the container which is going to be focused after the current
703  * container is moved away */
704  Con *focus_next = con_next_focused(con);
705 
706  /* 2: get the focused container of this workspace */
707  Con *next = con_descend_focused(workspace);
708 
709  /* 3: we go up one level, but only when next is a normal container */
710  if (next->type != CT_WORKSPACE) {
711  DLOG("next originally = %p / %s / type %d\n", next, next->name, next->type);
712  next = next->parent;
713  }
714 
715  /* 4: if the target container is floating, we get the workspace instead.
716  * Only tiling windows need to get inserted next to the current container.
717  * */
718  Con *floatingcon = con_inside_floating(next);
719  if (floatingcon != NULL) {
720  DLOG("floatingcon, going up even further\n");
721  next = floatingcon->parent;
722  }
723 
724  if (con->type == CT_FLOATING_CON) {
725  Con *ws = con_get_workspace(next);
726  DLOG("This is a floating window, using workspace %p / %s\n", ws, ws->name);
727  next = ws;
728  }
729 
730  if (source_output != dest_output) {
731  /* Take the relative coordinates of the current output, then add them
732  * to the coordinate space of the correct output */
733  if (fix_coordinates && con->type == CT_FLOATING_CON) {
734  floating_fix_coordinates(con, &(source_output->rect), &(dest_output->rect));
735  } else
736  DLOG("Not fixing coordinates, fix_coordinates flag = %d\n", fix_coordinates);
737 
738  /* If moving to a visible workspace, call show so it can be considered
739  * focused. Must do before attaching because workspace_show checks to see
740  * if focused container is in its area. */
741  if (workspace_is_visible(workspace)) {
742  workspace_show(workspace);
743 
744  /* Don’t warp if told so (when dragging floating windows with the
745  * mouse for example) */
746  if (dont_warp)
747  x_set_warp_to(NULL);
748  else
749  x_set_warp_to(&(con->rect));
750  }
751  }
752 
753  /* If moving a fullscreen container and the destination already has a
754  * fullscreen window on it, un-fullscreen the target's fullscreen con. */
755  Con *fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
756  if (con->fullscreen_mode != CF_NONE && fullscreen != NULL) {
757  con_toggle_fullscreen(fullscreen, CF_OUTPUT);
758  fullscreen = NULL;
759  }
760 
761  DLOG("Re-attaching container to %p / %s\n", next, next->name);
762  /* 5: re-attach the con to the parent of this focused container */
763  Con *parent = con->parent;
764  con_detach(con);
765  con_attach(con, next, false);
766 
767  /* 6: fix the percentages */
768  con_fix_percent(parent);
769  con->percent = 0.0;
770  con_fix_percent(next);
771 
772  /* 7: focus the con on the target workspace, but only within that
773  * workspace, that is, don’t move focus away if the target workspace is
774  * invisible.
775  * We don’t focus the con for i3 pseudo workspaces like __i3_scratch and
776  * we don’t focus when there is a fullscreen con on that workspace. */
777  if (!con_is_internal(workspace) && !fullscreen) {
778  /* We need to save the focused workspace on the output in case the
779  * new workspace is hidden and it's necessary to immediately switch
780  * back to the originally-focused workspace. */
781  Con *old_focus = TAILQ_FIRST(&(output_get_content(dest_output)->focus_head));
783 
784  /* Restore focus if the output's focused workspace has changed. */
785  if (con_get_workspace(focused) != old_focus)
786  con_focus(old_focus);
787  }
788 
789  /* 8: when moving to another workspace, we leave the focus on the current
790  * workspace. (see also #809) */
791 
792  /* Descend focus stack in case focus_next is a workspace which can
793  * occur if we move to the same workspace. Also show current workspace
794  * to ensure it is focused. */
795  workspace_show(current_ws);
796 
797  /* Set focus only if con was on current workspace before moving.
798  * Otherwise we would give focus to some window on different workspace. */
799  if (source_ws == current_ws)
800  con_focus(con_descend_focused(focus_next));
801 
802  /* If anything within the container is associated with a startup sequence,
803  * delete it so child windows won't be created on the old workspace. */
804  struct Startup_Sequence *sequence;
805  xcb_get_property_cookie_t cookie;
806  xcb_get_property_reply_t *startup_id_reply;
807 
808  if (!con_is_leaf(con)) {
809  Con *child;
810  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
811  if (!child->window)
812  continue;
813 
814  cookie = xcb_get_property(conn, false, child->window->id,
815  A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
816  startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
817 
818  sequence = startup_sequence_get(child->window, startup_id_reply, true);
819  if (sequence != NULL)
820  startup_sequence_delete(sequence);
821  }
822  }
823 
824  if (con->window) {
825  cookie = xcb_get_property(conn, false, con->window->id,
826  A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
827  startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
828 
829  sequence = startup_sequence_get(con->window, startup_id_reply, true);
830  if (sequence != NULL)
831  startup_sequence_delete(sequence);
832  }
833 
834  CALL(parent, on_remove_child);
835 }
836 
837 /*
838  * Returns the orientation of the given container (for stacked containers,
839  * vertical orientation is used regardless of the actual orientation of the
840  * container).
841  *
842  */
844  switch (con->layout) {
845  case L_SPLITV:
846  /* stacking containers behave like they are in vertical orientation */
847  case L_STACKED:
848  return VERT;
849 
850  case L_SPLITH:
851  /* tabbed containers behave like they are in vertical orientation */
852  case L_TABBED:
853  return HORIZ;
854 
855  case L_DEFAULT:
856  DLOG("Someone called con_orientation() on a con with L_DEFAULT, this is a bug in the code.\n");
857  assert(false);
858  return HORIZ;
859 
860  case L_DOCKAREA:
861  case L_OUTPUT:
862  DLOG("con_orientation() called on dockarea/output (%d) container %p\n", con->layout, con);
863  assert(false);
864  return HORIZ;
865 
866  default:
867  DLOG("con_orientation() ran into default\n");
868  assert(false);
869  }
870 }
871 
872 /*
873  * Returns the container which will be focused next when the given container
874  * is not available anymore. Called in tree_close and con_move_to_workspace
875  * to properly restore focus.
876  *
877  */
879  Con *next;
880  /* floating containers are attached to a workspace, so we focus either the
881  * next floating container (if any) or the workspace itself. */
882  if (con->type == CT_FLOATING_CON) {
883  DLOG("selecting next for CT_FLOATING_CON\n");
884  next = TAILQ_NEXT(con, floating_windows);
885  DLOG("next = %p\n", next);
886  if (!next) {
887  next = TAILQ_PREV(con, floating_head, floating_windows);
888  DLOG("using prev, next = %p\n", next);
889  }
890  if (!next) {
891  Con *ws = con_get_workspace(con);
892  next = ws;
893  DLOG("no more floating containers for next = %p, restoring workspace focus\n", next);
894  while (next != TAILQ_END(&(ws->focus_head)) && !TAILQ_EMPTY(&(next->focus_head))) {
895  next = TAILQ_FIRST(&(next->focus_head));
896  if (next == con) {
897  DLOG("skipping container itself, we want the next client\n");
898  next = TAILQ_NEXT(next, focused);
899  }
900  }
901  if (next == TAILQ_END(&(ws->focus_head))) {
902  DLOG("Focus list empty, returning ws\n");
903  next = ws;
904  }
905  } else {
906  /* Instead of returning the next CT_FLOATING_CON, we descend it to
907  * get an actual window to focus. */
908  next = con_descend_focused(next);
909  }
910  return next;
911  }
912 
913  /* dock clients cannot be focused, so we focus the workspace instead */
914  if (con->parent->type == CT_DOCKAREA) {
915  DLOG("selecting workspace for dock client\n");
917  }
918 
919  /* if 'con' is not the first entry in the focus stack, use the first one as
920  * it’s currently focused already */
921  Con *first = TAILQ_FIRST(&(con->parent->focus_head));
922  if (first != con) {
923  DLOG("Using first entry %p\n", first);
924  next = first;
925  } else {
926  /* try to focus the next container on the same level as this one or fall
927  * back to its parent */
928  if (!(next = TAILQ_NEXT(con, focused)))
929  next = con->parent;
930  }
931 
932  /* now go down the focus stack as far as
933  * possible, excluding the current container */
934  while (!TAILQ_EMPTY(&(next->focus_head)) &&
935  TAILQ_FIRST(&(next->focus_head)) != con)
936  next = TAILQ_FIRST(&(next->focus_head));
937 
938  return next;
939 }
940 
941 /*
942  * Get the next/previous container in the specified orientation. This may
943  * travel up until it finds a container with suitable orientation.
944  *
945  */
946 Con *con_get_next(Con *con, char way, orientation_t orientation) {
947  DLOG("con_get_next(way=%c, orientation=%d)\n", way, orientation);
948  /* 1: get the first parent with the same orientation */
949  Con *cur = con;
950  while (con_orientation(cur->parent) != orientation) {
951  DLOG("need to go one level further up\n");
952  if (cur->parent->type == CT_WORKSPACE) {
953  LOG("that's a workspace, we can't go further up\n");
954  return NULL;
955  }
956  cur = cur->parent;
957  }
958 
959  /* 2: chose next (or previous) */
960  Con *next;
961  if (way == 'n') {
962  next = TAILQ_NEXT(cur, nodes);
963  /* if we are at the end of the list, we need to wrap */
964  if (next == TAILQ_END(&(parent->nodes_head)))
965  return NULL;
966  } else {
967  next = TAILQ_PREV(cur, nodes_head, nodes);
968  /* if we are at the end of the list, we need to wrap */
969  if (next == TAILQ_END(&(cur->nodes_head)))
970  return NULL;
971  }
972  DLOG("next = %p\n", next);
973 
974  return next;
975 }
976 
977 /*
978  * Returns the focused con inside this client, descending the tree as far as
979  * possible. This comes in handy when attaching a con to a workspace at the
980  * currently focused position, for example.
981  *
982  */
984  Con *next = con;
985  while (next != focused && !TAILQ_EMPTY(&(next->focus_head)))
986  next = TAILQ_FIRST(&(next->focus_head));
987  return next;
988 }
989 
990 /*
991  * Returns the focused con inside this client, descending the tree as far as
992  * possible. This comes in handy when attaching a con to a workspace at the
993  * currently focused position, for example.
994  *
995  * Works like con_descend_focused but considers only tiling cons.
996  *
997  */
999  Con *next = con;
1000  Con *before;
1001  Con *child;
1002  if (next == focused)
1003  return next;
1004  do {
1005  before = next;
1006  TAILQ_FOREACH (child, &(next->focus_head), focused) {
1007  if (child->type == CT_FLOATING_CON)
1008  continue;
1009 
1010  next = child;
1011  break;
1012  }
1013  } while (before != next && next != focused);
1014  return next;
1015 }
1016 
1017 /*
1018  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
1019  * direction is D_LEFT, then we return the rightmost container and if direction
1020  * is D_RIGHT, we return the leftmost container. This is because if we are
1021  * moving D_LEFT, and thus want the rightmost container.
1022  *
1023  */
1025  Con *most = NULL;
1026  Con *current;
1027  int orientation = con_orientation(con);
1028  DLOG("con_descend_direction(%p, orientation %d, direction %d)\n", con, orientation, direction);
1029  if (direction == D_LEFT || direction == D_RIGHT) {
1030  if (orientation == HORIZ) {
1031  /* If the direction is horizontal, we can use either the first
1032  * (D_RIGHT) or the last con (D_LEFT) */
1033  if (direction == D_RIGHT)
1034  most = TAILQ_FIRST(&(con->nodes_head));
1035  else
1036  most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1037  } else if (orientation == VERT) {
1038  /* Wrong orientation. We use the last focused con. Within that con,
1039  * we recurse to chose the left/right con or at least the last
1040  * focused one. */
1041  TAILQ_FOREACH (current, &(con->focus_head), focused) {
1042  if (current->type != CT_FLOATING_CON) {
1043  most = current;
1044  break;
1045  }
1046  }
1047  } else {
1048  /* If the con has no orientation set, it’s not a split container
1049  * but a container with a client window, so stop recursing */
1050  return con;
1051  }
1052  }
1053 
1054  if (direction == D_UP || direction == D_DOWN) {
1055  if (orientation == VERT) {
1056  /* If the direction is vertical, we can use either the first
1057  * (D_DOWN) or the last con (D_UP) */
1058  if (direction == D_UP)
1059  most = TAILQ_LAST(&(con->nodes_head), nodes_head);
1060  else
1061  most = TAILQ_FIRST(&(con->nodes_head));
1062  } else if (orientation == HORIZ) {
1063  /* Wrong orientation. We use the last focused con. Within that con,
1064  * we recurse to chose the top/bottom con or at least the last
1065  * focused one. */
1066  TAILQ_FOREACH (current, &(con->focus_head), focused) {
1067  if (current->type != CT_FLOATING_CON) {
1068  most = current;
1069  break;
1070  }
1071  }
1072  } else {
1073  /* If the con has no orientation set, it’s not a split container
1074  * but a container with a client window, so stop recursing */
1075  return con;
1076  }
1077  }
1078 
1079  if (!most)
1080  return con;
1081  return con_descend_direction(most, direction);
1082 }
1083 
1084 /*
1085  * Returns a "relative" Rect which contains the amount of pixels that need to
1086  * be added to the original Rect to get the final position (obviously the
1087  * amount of pixels for normal, 1pixel and borderless are different).
1088  *
1089  */
1091  adjacent_t borders_to_hide = ADJ_NONE;
1092  int border_width = con->current_border_width;
1093  DLOG("The border width for con is set to: %d\n", con->current_border_width);
1094  Rect result;
1095  if (con->current_border_width < 0) {
1096  if (con_is_floating(con)) {
1097  border_width = config.default_floating_border_width;
1098  } else {
1099  border_width = config.default_border_width;
1100  }
1101  }
1102  DLOG("Effective border width is set to: %d\n", border_width);
1103  /* Shortcut to avoid calling con_adjacent_borders() on dock containers. */
1104  int border_style = con_border_style(con);
1105  if (border_style == BS_NONE)
1106  return (Rect) {0, 0, 0, 0};
1107  borders_to_hide = con_adjacent_borders(con) & config.hide_edge_borders;
1108  if (border_style == BS_NORMAL) {
1109  result = (Rect) {border_width, 0, -(2 * border_width), -(border_width)};
1110  } else {
1111  result = (Rect) {border_width, border_width, -(2 * border_width), -(2 * border_width)};
1112  }
1113 
1114  /* Floating windows are never adjacent to any other window, so
1115  don’t hide their border(s). This prevents bug #998. */
1116  if (con_is_floating(con))
1117  return result;
1118 
1119  if (borders_to_hide & ADJ_LEFT_SCREEN_EDGE) {
1120  result.x -= border_width;
1121  result.width += border_width;
1122  }
1123  if (borders_to_hide & ADJ_RIGHT_SCREEN_EDGE) {
1124  result.width += border_width;
1125  }
1126  if (borders_to_hide & ADJ_UPPER_SCREEN_EDGE && (border_style != BS_NORMAL)) {
1127  result.y -= border_width;
1128  result.height += border_width;
1129  }
1130  if (borders_to_hide & ADJ_LOWER_SCREEN_EDGE) {
1131  result.height += border_width;
1132  }
1133  return result;
1134 }
1135 
1136 /*
1137  * Returns adjacent borders of the window. We need this if hide_edge_borders is
1138  * enabled.
1139  */
1141  adjacent_t result = ADJ_NONE;
1143  if (con->rect.x == workspace->rect.x)
1144  result |= ADJ_LEFT_SCREEN_EDGE;
1145  if (con->rect.x + con->rect.width == workspace->rect.x + workspace->rect.width)
1146  result |= ADJ_RIGHT_SCREEN_EDGE;
1147  if (con->rect.y == workspace->rect.y)
1148  result |= ADJ_UPPER_SCREEN_EDGE;
1149  if (con->rect.y + con->rect.height == workspace->rect.y + workspace->rect.height)
1150  result |= ADJ_LOWER_SCREEN_EDGE;
1151  return result;
1152 }
1153 
1154 /*
1155  * Use this function to get a container’s border style. This is important
1156  * because when inside a stack, the border style is always BS_NORMAL.
1157  * For tabbed mode, the same applies, with one exception: when the container is
1158  * borderless and the only element in the tabbed container, the border is not
1159  * rendered.
1160  *
1161  * For children of a CT_DOCKAREA, the border style is always none.
1162  *
1163  */
1166  if (fs == con) {
1167  DLOG("this one is fullscreen! overriding BS_NONE\n");
1168  return BS_NONE;
1169  }
1170 
1171  if (con->parent->layout == L_STACKED)
1172  return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1173 
1174  if (con->parent->layout == L_TABBED && con->border_style != BS_NORMAL)
1175  return (con_num_children(con->parent) == 1 ? con->border_style : BS_NORMAL);
1176 
1177  if (con->parent->type == CT_DOCKAREA)
1178  return BS_NONE;
1179 
1180  return con->border_style;
1181 }
1182 
1183 /*
1184  * Sets the given border style on con, correctly keeping the position/size of a
1185  * floating window.
1186  *
1187  */
1188 void con_set_border_style(Con *con, int border_style, int border_width) {
1189  /* Handle the simple case: non-floating containerns */
1190  if (!con_is_floating(con)) {
1191  con->border_style = border_style;
1192  con->current_border_width = border_width;
1193  return;
1194  }
1195 
1196  /* For floating containers, we want to keep the position/size of the
1197  * *window* itself. We first add the border pixels to con->rect to make
1198  * con->rect represent the absolute position of the window (same for
1199  * parent). Then, we change the border style and subtract the new border
1200  * pixels. For the parent, we do the same also for the decoration. */
1201  DLOG("This is a floating container\n");
1202 
1203  Con *parent = con->parent;
1204  Rect bsr = con_border_style_rect(con);
1205  int deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1206 
1207  con->rect = rect_add(con->rect, bsr);
1208  parent->rect = rect_add(parent->rect, bsr);
1209  parent->rect.y += deco_height;
1210  parent->rect.height -= deco_height;
1211 
1212  /* Change the border style, get new border/decoration values. */
1213  con->border_style = border_style;
1214  con->current_border_width = border_width;
1215  bsr = con_border_style_rect(con);
1216  deco_height = (con->border_style == BS_NORMAL ? render_deco_height() : 0);
1217 
1218  con->rect = rect_sub(con->rect, bsr);
1219  parent->rect = rect_sub(parent->rect, bsr);
1220  parent->rect.y -= deco_height;
1221  parent->rect.height += deco_height;
1222 }
1223 
1224 /*
1225  * This function changes the layout of a given container. Use it to handle
1226  * special cases like changing a whole workspace to stacked/tabbed (creates a
1227  * new split container before).
1228  *
1229  */
1230 void con_set_layout(Con *con, layout_t layout) {
1231  DLOG("con_set_layout(%p, %d), con->type = %d\n",
1232  con, layout, con->type);
1233 
1234  /* Users can focus workspaces, but not any higher in the hierarchy.
1235  * Focus on the workspace is a special case, since in every other case, the
1236  * user means "change the layout of the parent split container". */
1237  if (con->type != CT_WORKSPACE)
1238  con = con->parent;
1239 
1240  /* We fill in last_split_layout when switching to a different layout
1241  * since there are many places in the code that don’t use
1242  * con_set_layout(). */
1243  if (con->layout == L_SPLITH || con->layout == L_SPLITV)
1244  con->last_split_layout = con->layout;
1245 
1246  /* When the container type is CT_WORKSPACE, the user wants to change the
1247  * whole workspace into stacked/tabbed mode. To do this and still allow
1248  * intuitive operations (like level-up and then opening a new window), we
1249  * need to create a new split container. */
1250  if (con->type == CT_WORKSPACE &&
1251  (layout == L_STACKED || layout == L_TABBED)) {
1252  if (con_num_children(con) == 0) {
1253  DLOG("Setting workspace_layout to %d\n", layout);
1254  con->workspace_layout = layout;
1255  } else {
1256  DLOG("Creating new split container\n");
1257  /* 1: create a new split container */
1258  Con *new = con_new(NULL, NULL);
1259  new->parent = con;
1260 
1261  /* 2: Set the requested layout on the split container and mark it as
1262  * split. */
1263  new->layout = layout;
1264  new->last_split_layout = con->last_split_layout;
1265 
1266  Con *old_focused = TAILQ_FIRST(&(con->focus_head));
1267  if (old_focused == TAILQ_END(&(con->focus_head)))
1268  old_focused = NULL;
1269 
1270  /* 3: move the existing cons of this workspace below the new con */
1271  DLOG("Moving cons\n");
1272  Con *child;
1273  while (!TAILQ_EMPTY(&(con->nodes_head))) {
1274  child = TAILQ_FIRST(&(con->nodes_head));
1275  con_detach(child);
1276  con_attach(child, new, true);
1277  }
1278 
1279  /* 4: attach the new split container to the workspace */
1280  DLOG("Attaching new split to ws\n");
1281  con_attach(new, con, false);
1282 
1283  if (old_focused)
1284  con_focus(old_focused);
1285 
1287  }
1289  return;
1290  }
1291 
1292  if (layout == L_DEFAULT) {
1293  /* Special case: the layout formerly known as "default" (in combination
1294  * with an orientation). Since we switched to splith/splitv layouts,
1295  * using the "default" layout (which "only" should happen when using
1296  * legacy configs) is using the last split layout (either splith or
1297  * splitv) in order to still do the same thing.
1298  *
1299  * Starting from v4.6 though, we will nag users about using "layout
1300  * default", and in v4.9 we will remove it entirely (with an
1301  * appropriate i3-migrate-config mechanism). */
1302  con->layout = con->last_split_layout;
1303  /* In case last_split_layout was not initialized… */
1304  if (con->layout == L_DEFAULT)
1305  con->layout = L_SPLITH;
1306  } else {
1307  con->layout = layout;
1308  }
1310 }
1311 
1312 /*
1313  * This function toggles the layout of a given container. toggle_mode can be
1314  * either 'default' (toggle only between stacked/tabbed/last_split_layout),
1315  * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
1316  * layouts).
1317  *
1318  */
1319 void con_toggle_layout(Con *con, const char *toggle_mode) {
1320  Con *parent = con;
1321  /* Users can focus workspaces, but not any higher in the hierarchy.
1322  * Focus on the workspace is a special case, since in every other case, the
1323  * user means "change the layout of the parent split container". */
1324  if (con->type != CT_WORKSPACE)
1325  parent = con->parent;
1326  DLOG("con_toggle_layout(%p, %s), parent = %p\n", con, toggle_mode, parent);
1327 
1328  if (strcmp(toggle_mode, "split") == 0) {
1329  /* Toggle between splits. When the current layout is not a split
1330  * layout, we just switch back to last_split_layout. Otherwise, we
1331  * change to the opposite split layout. */
1332  if (parent->layout != L_SPLITH && parent->layout != L_SPLITV)
1333  con_set_layout(con, parent->last_split_layout);
1334  else {
1335  if (parent->layout == L_SPLITH)
1336  con_set_layout(con, L_SPLITV);
1337  else
1338  con_set_layout(con, L_SPLITH);
1339  }
1340  } else {
1341  if (parent->layout == L_STACKED)
1342  con_set_layout(con, L_TABBED);
1343  else if (parent->layout == L_TABBED) {
1344  if (strcmp(toggle_mode, "all") == 0)
1345  con_set_layout(con, L_SPLITH);
1346  else
1347  con_set_layout(con, parent->last_split_layout);
1348  } else if (parent->layout == L_SPLITH || parent->layout == L_SPLITV) {
1349  if (strcmp(toggle_mode, "all") == 0) {
1350  /* When toggling through all modes, we toggle between
1351  * splith/splitv, whereas normally we just directly jump to
1352  * stacked. */
1353  if (parent->layout == L_SPLITH)
1354  con_set_layout(con, L_SPLITV);
1355  else
1356  con_set_layout(con, L_STACKED);
1357  } else {
1358  con_set_layout(con, L_STACKED);
1359  }
1360  }
1361  }
1362 }
1363 
1364 /*
1365  * Callback which will be called when removing a child from the given con.
1366  * Kills the container if it is empty and replaces it with the child if there
1367  * is exactly one child.
1368  *
1369  */
1370 static void con_on_remove_child(Con *con) {
1371  DLOG("on_remove_child\n");
1372 
1373  /* Every container 'above' (in the hierarchy) the workspace content should
1374  * not be closed when the last child was removed */
1375  if (con->type == CT_OUTPUT ||
1376  con->type == CT_ROOT ||
1377  con->type == CT_DOCKAREA ||
1378  (con->parent != NULL && con->parent->type == CT_OUTPUT)) {
1379  DLOG("not handling, type = %d, name = %s\n", con->type, con->name);
1380  return;
1381  }
1382 
1383  /* For workspaces, close them only if they're not visible anymore */
1384  if (con->type == CT_WORKSPACE) {
1385  if (TAILQ_EMPTY(&(con->focus_head)) && !workspace_is_visible(con)) {
1386  LOG("Closing old workspace (%p / %s), it is empty\n", con, con->name);
1387  tree_close(con, DONT_KILL_WINDOW, false, false);
1388  ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"empty\"}");
1389  }
1390  return;
1391  }
1392 
1394  con->urgent = con_has_urgent_child(con);
1396 
1397  /* TODO: check if this container would swallow any other client and
1398  * don’t close it automatically. */
1399  int children = con_num_children(con);
1400  if (children == 0) {
1401  DLOG("Container empty, closing\n");
1402  tree_close(con, DONT_KILL_WINDOW, false, false);
1403  return;
1404  }
1405 }
1406 
1407 /*
1408  * Determines the minimum size of the given con by looking at its children (for
1409  * split/stacked/tabbed cons). Will be called when resizing floating cons
1410  *
1411  */
1413  DLOG("Determining minimum size for con %p\n", con);
1414 
1415  if (con_is_leaf(con)) {
1416  DLOG("leaf node, returning 75x50\n");
1417  return (Rect) {0, 0, 75, 50};
1418  }
1419 
1420  if (con->type == CT_FLOATING_CON) {
1421  DLOG("floating con\n");
1422  Con *child = TAILQ_FIRST(&(con->nodes_head));
1423  return con_minimum_size(child);
1424  }
1425 
1426  if (con->layout == L_STACKED || con->layout == L_TABBED) {
1427  uint32_t max_width = 0, max_height = 0, deco_height = 0;
1428  Con *child;
1429  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1430  Rect min = con_minimum_size(child);
1431  deco_height += child->deco_rect.height;
1432  max_width = max(max_width, min.width);
1433  max_height = max(max_height, min.height);
1434  }
1435  DLOG("stacked/tabbed now, returning %d x %d + deco_rect = %d\n",
1436  max_width, max_height, deco_height);
1437  return (Rect) {0, 0, max_width, max_height + deco_height};
1438  }
1439 
1440  /* For horizontal/vertical split containers we sum up the width (h-split)
1441  * or height (v-split) and use the maximum of the height (h-split) or width
1442  * (v-split) as minimum size. */
1443  if (con_is_split(con)) {
1444  uint32_t width = 0, height = 0;
1445  Con *child;
1446  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1447  Rect min = con_minimum_size(child);
1448  if (con->layout == L_SPLITH) {
1449  width += min.width;
1450  height = max(height, min.height);
1451  } else {
1452  height += min.height;
1453  width = max(width, min.width);
1454  }
1455  }
1456  DLOG("split container, returning width = %d x height = %d\n", width, height);
1457  return (Rect) {0, 0, width, height};
1458  }
1459 
1460  ELOG("Unhandled case, type = %d, layout = %d, split = %d\n",
1461  con->type, con->layout, con_is_split(con));
1462  assert(false);
1463 }
1464 
1465 /*
1466  * Returns true if changing the focus to con would be allowed considering
1467  * the fullscreen focus constraints. Specifically, if a fullscreen container or
1468  * any of its descendants is focused, this function returns true if and only if
1469  * focusing con would mean that focus would still be visible on screen, i.e.,
1470  * the newly focused container would not be obscured by a fullscreen container.
1471  *
1472  * In the simplest case, if a fullscreen container or any of its descendants is
1473  * fullscreen, this functions returns true if con is the fullscreen container
1474  * itself or any of its descendants, as this means focus wouldn't escape the
1475  * boundaries of the fullscreen container.
1476  *
1477  * In case the fullscreen container is of type CF_OUTPUT, this function returns
1478  * true if con is on a different workspace, as focus wouldn't be obscured by
1479  * the fullscreen container that is constrained to a different workspace.
1480  *
1481  * Note that this same logic can be applied to moving containers. If a
1482  * container can be focused under the fullscreen focus constraints, it can also
1483  * become a parent or sibling to the currently focused container.
1484  *
1485  */
1487  /* No focus, no problem. */
1488  if (!focused)
1489  return true;
1490 
1491  /* Find the first fullscreen ascendent. */
1492  Con *fs = focused;
1493  while (fs && fs->fullscreen_mode == CF_NONE)
1494  fs = fs->parent;
1495 
1496  /* fs must be non-NULL since the workspace con doesn’t have CF_NONE and
1497  * there always has to be a workspace con in the hierarchy. */
1498  assert(fs != NULL);
1499  /* The most common case is we hit the workspace level. In this
1500  * situation, changing focus is also harmless. */
1501  assert(fs->fullscreen_mode != CF_NONE);
1502  if (fs->type == CT_WORKSPACE)
1503  return true;
1504 
1505  /* Allow it if the container itself is the fullscreen container. */
1506  if (con == fs)
1507  return true;
1508 
1509  /* If fullscreen is per-output, the focus being in a different workspace is
1510  * sufficient to guarantee that change won't leave fullscreen in bad shape. */
1511  if (fs->fullscreen_mode == CF_OUTPUT &&
1512  con_get_workspace(con) != con_get_workspace(fs)) {
1513  return true;
1514  }
1515 
1516  /* Allow it only if the container to be focused is contained within the
1517  * current fullscreen container. */
1518  do {
1519  if (con->parent == fs)
1520  return true;
1521  con = con->parent;
1522  } while (con);
1523 
1524  /* Focusing con would hide it behind a fullscreen window, disallow it. */
1525  return false;
1526 }
1527 
1528 /*
1529  *
1530  * Checks if the given container has an urgent child.
1531  *
1532  */
1534  Con *child;
1535 
1536  if (con_is_leaf(con))
1537  return con->urgent;
1538 
1539  /* We are not interested in floating windows since they can only be
1540  * attached to a workspace → nodes_head instead of focus_head */
1541  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1542  if (con_has_urgent_child(child))
1543  return true;
1544  }
1545 
1546  return false;
1547 }
1548 
1549 /*
1550  * Make all parent containers urgent if con is urgent or clear the urgent flag
1551  * of all parent containers if there are no more urgent children left.
1552  *
1553  */
1555  Con *parent = con->parent;
1556 
1557  bool new_urgency_value = con->urgent;
1558  while (parent && parent->type != CT_WORKSPACE && parent->type != CT_DOCKAREA) {
1559  if (new_urgency_value) {
1560  parent->urgent = true;
1561  } else {
1562  /* We can only reset the urgency when the parent
1563  * has no other urgent children */
1564  if (!con_has_urgent_child(parent))
1565  parent->urgent = false;
1566  }
1567  parent = parent->parent;
1568  }
1569 }
1570 
1571 /*
1572  * Set urgency flag to the container, all the parent containers and the workspace.
1573  *
1574  */
1575 void con_set_urgency(Con *con, bool urgent) {
1576  if (focused == con) {
1577  DLOG("Ignoring urgency flag for current client\n");
1578  con->window->urgent.tv_sec = 0;
1579  con->window->urgent.tv_usec = 0;
1580  return;
1581  }
1582 
1583  if (con->urgency_timer == NULL) {
1584  con->urgent = urgent;
1585  } else
1586  DLOG("Discarding urgency WM_HINT because timer is running\n");
1587 
1588  //CLIENT_LOG(con);
1589  if (con->window) {
1590  if (con->urgent) {
1591  gettimeofday(&con->window->urgent, NULL);
1592  } else {
1593  con->window->urgent.tv_sec = 0;
1594  con->window->urgent.tv_usec = 0;
1595  }
1596  }
1597 
1599 
1600  if (con->urgent == urgent)
1601  LOG("Urgency flag changed to %d\n", con->urgent);
1602 
1603  Con *ws;
1604  /* Set the urgency flag on the workspace, if a workspace could be found
1605  * (for dock clients, that is not the case). */
1606  if ((ws = con_get_workspace(con)) != NULL)
1608 }
1609 
1610 /*
1611  * Create a string representing the subtree under con.
1612  *
1613  */
1615  /* this code works as follows:
1616  * 1) create a string with the layout type (D/V/H/T/S) and an opening bracket
1617  * 2) append the tree representation of the children to the string
1618  * 3) add closing bracket
1619  *
1620  * The recursion ends when we hit a leaf, in which case we return the
1621  * class_instance of the contained window.
1622  */
1623 
1624  /* end of recursion */
1625  if (con_is_leaf(con)) {
1626  if (!con->window)
1627  return sstrdup("nowin");
1628 
1629  if (!con->window->class_instance)
1630  return sstrdup("noinstance");
1631 
1632  return sstrdup(con->window->class_instance);
1633  }
1634 
1635  char *buf;
1636  /* 1) add the Layout type to buf */
1637  if (con->layout == L_DEFAULT)
1638  buf = sstrdup("D[");
1639  else if (con->layout == L_SPLITV)
1640  buf = sstrdup("V[");
1641  else if (con->layout == L_SPLITH)
1642  buf = sstrdup("H[");
1643  else if (con->layout == L_TABBED)
1644  buf = sstrdup("T[");
1645  else if (con->layout == L_STACKED)
1646  buf = sstrdup("S[");
1647  else {
1648  ELOG("BUG: Code not updated to account for new layout type\n");
1649  assert(false);
1650  }
1651 
1652  /* 2) append representation of children */
1653  Con *child;
1654  TAILQ_FOREACH (child, &(con->nodes_head), nodes) {
1655  char *child_txt = con_get_tree_representation(child);
1656 
1657  char *tmp_buf;
1658  sasprintf(&tmp_buf, "%s%s%s", buf,
1659  (TAILQ_FIRST(&(con->nodes_head)) == child ? "" : " "), child_txt);
1660  free(buf);
1661  buf = tmp_buf;
1662  }
1663 
1664  /* 3) close the brackets */
1665  char *complete_buf;
1666  sasprintf(&complete_buf, "%s]", buf);
1667  free(buf);
1668 
1669  return complete_buf;
1670 }
Definition: data.h:87
struct Con * parent
Definition: data.h:512
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
#define XCB_ATOM_ATOM
Definition: xcb_compat.h:45
void con_set_layout(Con *con, layout_t layout)
This function changes the layout of a given container.
Definition: con.c:1230
bool urgent
Definition: data.h:484
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition: con.c:419
direction_t
Definition: data.h:54
Definition: data.h:56
fullscreen_mode_t
Fullscreen modes.
Definition: data.h:473
Con * workspace_attach_to(Con *ws)
Called when a new con (with a window, not an empty or split con) should be attached to the workspace ...
Definition: workspace.c:818
Rect rect_add(Rect a, Rect b)
Definition: util.c:44
uint32_t y
Definition: data.h:124
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:386
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition: con.c:103
uint32_t height
Definition: data.h:33
Config config
Definition: config.c:19
xcb_connection_t * conn
Definition: main.c:47
int default_floating_border_width
Definition: config.h:101
Con * workspace_encapsulate(Con *ws)
Creates a new container and re-parents all of children from the given workspace into it...
Definition: workspace.c:847
double percent
Definition: data.h:530
int render_deco_height(void)
Definition: render.c:22
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:317
Definition: data.h:54
#define TAILQ_INSERT_BEFORE(listelm, elm, field)
Definition: queue.h:379
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:122
#define LOG(fmt,...)
Definition: libi3.h:76
bool workspace_is_visible(Con *ws)
Returns true if the workspace is currently visible.
Definition: workspace.c:232
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition: con.c:197
#define TAILQ_LAST(head, headname)
Definition: queue.h:326
void workspace_show(Con *workspace)
Switches to the given workspace.
Definition: workspace.c:447
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:983
struct Rect rect
Definition: data.h:514
bool con_accepts_window(Con *con)
Returns true if this node accepts a window (if the node swallows windows, it might already have swall...
Definition: con.c:284
struct all_cons_head all_cons
Definition: tree.c:17
struct Rect Rect
Definition: data.h:43
int current_border_width
Definition: data.h:541
Con * con_parent_with_orientation(Con *con, orientation_t orientation)
Searches parenst of the given &#39;con&#39; until it reaches one with the specified &#39;orientation&#39;.
Definition: con.c:329
void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp)
Moves the given container to the currently focused container on the given workspace.
Definition: con.c:658
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:998
uint16_t depth
Depth of the window.
Definition: data.h:379
#define TAILQ_FIRST(head)
Definition: queue.h:323
Definition: data.h:54
bool con_has_children(Con *con)
Returns true if this node has regular or floating children.
Definition: con.c:257
struct Window * window
Definition: data.h:547
uint32_t width
Definition: data.h:32
char * class_instance
Definition: data.h:346
layout_t
Container layouts.
Definition: data.h:84
#define TAILQ_NEXT(elm, field)
Definition: queue.h:325
Con * con_new(Con *parent, i3Window *window)
Definition: con.c:87
enum Con::@19 floating
floating? (= not in tiling layout) This cannot be simply a bool because we want to keep track of whet...
border_style_t border_style
Definition: data.h:579
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition: con.c:411
A &#39;Window&#39; is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:332
Con * con_descend_direction(Con *con, direction_t direction)
Definition: con.c:1024
void x_set_warp_to(Rect *rect)
Set warp_to coordinates.
Definition: x.c:1142
void ipc_send_event(const char *event, uint32_t message_type, const char *payload)
Sends the specified event to all IPC clients which are currently connected and subscribed to this kin...
Definition: ipc.c:75
void con_set_border_style(Con *con, int border_style, int border_width)
Sets the given border style on con, correctly keeping the position/size of a floating window...
Definition: con.c:1188
char * con_get_tree_representation(Con *con)
Create a string representing the subtree under con.
Definition: con.c:1614
enum Con::@18 type
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists...
Definition: con.c:461
void con_update_parents_urgency(Con *con)
Make all parent containers urgent if con is urgent or clear the urgent flag of all parent containers ...
Definition: con.c:1554
Definition: data.h:85
#define DLOG(fmt,...)
Definition: libi3.h:86
static void con_force_split_parents_redraw(Con *con)
Definition: con.c:34
void startup_sequence_delete(struct Startup_Sequence *sequence)
Deletes a startup sequence, ignoring whether its timeout has elapsed.
Definition: startup.c:104
Con * con_next_focused(Con *con)
Returns the container which will be focused next when the given container is not available anymore...
Definition: con.c:878
int sasprintf(char **strp, const char *fmt,...)
Safe-wrapper around asprintf which exits if it returns -1 (meaning that there is no more memory avail...
Definition: data.h:86
bool match_matches_window(Match *match, i3Window *window)
Check if a match data structure matches the given window.
Definition: match.c:84
struct Rect deco_rect
Definition: data.h:516
Con * con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode)
Returns the first fullscreen node below this node.
Definition: con.c:365
bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus)
Closes the given container including all children.
Definition: tree.c:190
Rect con_border_style_rect(Con *con)
Returns a &quot;relative&quot; Rect which contains the amount of pixels that need to be added to the original R...
Definition: con.c:1090
Definition: data.h:473
static void con_on_remove_child(Con *con)
Definition: con.c:1370
struct Startup_Sequence * startup_sequence_get(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader)
Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
Definition: startup.c:264
bool con_is_leaf(Con *con)
Returns true when this node is a leaf node (has no children)
Definition: con.c:241
bool con_has_managed_window(Con *con)
Returns true when this con is a leaf node with a managed X11 window (e.g., excluding dock containers)...
Definition: con.c:249
bool con_has_urgent_child(Con *con)
Checks if the given container has an urgent child.
Definition: con.c:1533
uint32_t height
Definition: data.h:126
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition: data.h:553
Con * con_for_window(Con *con, i3Window *window, Match **store_match)
Returns the first container below &#39;con&#39; which wants to swallow this window TODO: priority.
Definition: con.c:487
Definition: data.h:54
#define TAILQ_INSERT_HEAD(head, elm, field)
Definition: queue.h:352
Con * focused
Definition: tree.c:15
struct timeval urgent
When this window was marked urgent.
Definition: data.h:373
int num
the workspace number, if this Con is of type CT_WORKSPACE and the workspace is not a named workspace ...
Definition: data.h:510
Rect rect_sub(Rect a, Rect b)
Definition: util.c:51
char * name
Definition: data.h:520
fullscreen_mode_t fullscreen_mode
Definition: data.h:563
Definition: con.c:355
Definition: data.h:91
bool con_fullscreen_permits_focusing(Con *con)
Returns true if changing the focus to con would be allowed considering the fullscreen focus constrain...
Definition: con.c:1486
#define TAILQ_INIT(head)
Definition: queue.h:347
#define TAILQ_INSERT_AFTER(head, listelm, elm, field)
Definition: queue.h:369
void con_focus(Con *con)
Sets input focus to the given container.
Definition: con.c:213
Con * con_by_frame_id(xcb_window_t frame)
Returns the container with the given frame ID or NULL if no such container exists.
Definition: con.c:474
#define TAILQ_EMPTY(head)
Definition: queue.h:331
adjacent_t con_adjacent_borders(Con *con)
Returns adjacent borders of the window.
Definition: con.c:1140
int con_num_children(Con *con)
Returns the number of children of this container.
Definition: con.c:526
void workspace_update_urgent_flag(Con *ws)
Goes through all clients on the given workspace and updates the workspace’s urgent flag accordingly...
Definition: workspace.c:761
adjacent_t hide_edge_borders
Remove borders if they are adjacent to the screen edge.
Definition: config.h:126
void tree_flatten(Con *con)
tree_flatten() removes pairs of redundant split containers, e.g.
Definition: tree.c:694
int max(int a, int b)
Definition: util.c:33
bool con_is_split(Con *con)
Definition: con.c:265
Definition: data.h:54
#define TAILQ_PREV(elm, headname, field)
Definition: queue.h:329
#define TAILQ_ENTRY(type)
Definition: queue.h:314
#define ELOG(fmt,...)
Definition: libi3.h:81
Definition: data.h:55
A &quot;match&quot; is a data structure which acts like a mask or expression to match certain windows or not...
Definition: data.h:390
layout_t layout
Definition: data.h:578
orientation_t con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition: con.c:843
border_style_t default_border
The default border style for new windows.
Definition: config.h:171
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:479
uint32_t x
Definition: data.h:123
void * scalloc(size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
Definition: data.h:89
layout_t last_split_layout
Definition: data.h:578
int default_border_width
Definition: config.h:100
layout_t workspace_layout
Definition: data.h:578
orientation_t
Definition: data.h:55
Con * con
Definition: con.c:356
#define TAILQ_END(head)
Definition: queue.h:324
xcb_window_t frame
Definition: data.h:495
void con_toggle_layout(Con *con, const char *toggle_mode)
This function toggles the layout of a given container.
Definition: con.c:1319
int min(int a, int b)
Definition: util.c:29
bool con_inside_focused(Con *con)
Checks if the given container is inside a focused container.
Definition: con.c:448
#define CALL(obj, member,...)
Definition: util.h:54
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:362
int con_border_style(Con *con)
Use this function to get a container’s border style.
Definition: con.c:1164
struct Con * croot
Definition: tree.c:14
adjacent_t
describes if the window is adjacent to the output (physical screen) edges.
Definition: data.h:63
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:311
Definition: data.h:63
Con * output_get_content(Con *output)
Returns the output container below the given output container.
Definition: output.c:18
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on...
Definition: con.c:303
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition: con.c:430
Con * con_get_next(Con *con, char way, orientation_t orientation)
Get the next/previous container in the specified orientation.
Definition: con.c:946
xcb_window_t id
Definition: data.h:333
void * smalloc(size_t size)
Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there is no more memory a...
void floating_fix_coordinates(Con *con, Rect *old_rect, Rect *new_rect)
Fixes the coordinates of the floating window whenever the window gets reassigned to a different outpu...
Definition: floating.c:783
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:334
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition: con.c:542
Definition: data.h:55
char * colors[]
Definition: con.c:16
#define FREE(pointer)
Definition: util.h:46
void ipc_send_window_event(const char *property, Con *con)
For the window events we send, along the usual &quot;change&quot; field, also the window container, in &quot;container&quot;.
Definition: ipc.c:1091
Definition: data.h:56
#define TAILQ_HEAD(name, type)
Definition: queue.h:305
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition: con.c:1575
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition: con.c:587
char * workspace
workspace on which this startup was initiated
Definition: data.h:196
Con * con_new_skeleton(Con *parent, i3Window *window)
Create a new container (and attach it to the given parent, if not NULL).
Definition: con.c:49
uint32_t width
Definition: data.h:125
Definition: data.h:90
Stores internal information about a startup sequence, like the workspace it was initiated on...
Definition: data.h:192
void x_con_init(Con *con, uint16_t depth)
Initializes the X11 part for the given container.
Definition: x.c:94
struct ev_timer * urgency_timer
Definition: data.h:550
Rect con_minimum_size(Con *con)
Determines the minimum size of the given con by looking at its children (for split/stacked/tabbed con...
Definition: con.c:1412