i3
tree.c
Go to the documentation of this file.
1 #undef I3__FILE__
2 #define I3__FILE__ "tree.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  * tree.c: Everything that primarily modifies the layout tree data structure.
10  *
11  */
12 #include "all.h"
13 
14 struct Con *croot;
15 struct Con *focused;
16 
17 struct all_cons_head all_cons = TAILQ_HEAD_INITIALIZER(all_cons);
18 
19 /*
20  * Create the pseudo-output __i3. Output-independent workspaces such as
21  * __i3_scratch will live there.
22  *
23  */
24 static Con *_create___i3(void) {
25  Con *__i3 = con_new(croot, NULL);
26  FREE(__i3->name);
27  __i3->name = sstrdup("__i3");
28  __i3->type = CT_OUTPUT;
29  __i3->layout = L_OUTPUT;
30  con_fix_percent(croot);
31  x_set_name(__i3, "[i3 con] pseudo-output __i3");
32  /* For retaining the correct position/size of a scratchpad window, the
33  * dimensions of the real outputs should be multiples of the __i3
34  * pseudo-output. Ensuring that is the job of scratchpad_fix_resolution()
35  * which gets called after this function and after detecting all the
36  * outputs (or whenever an output changes). */
37  __i3->rect.width = 1280;
38  __i3->rect.height = 1024;
39 
40  /* Add a content container. */
41  DLOG("adding main content container\n");
42  Con *content = con_new(NULL, NULL);
43  content->type = CT_CON;
44  FREE(content->name);
45  content->name = sstrdup("content");
46  content->layout = L_SPLITH;
47 
48  x_set_name(content, "[i3 con] content __i3");
49  con_attach(content, __i3, false);
50 
51  /* Attach the __i3_scratch workspace. */
52  Con *ws = con_new(NULL, NULL);
53  ws->type = CT_WORKSPACE;
54  ws->num = -1;
55  ws->name = sstrdup("__i3_scratch");
56  ws->layout = L_SPLITH;
57  con_attach(ws, content, false);
58  x_set_name(ws, "[i3 con] workspace __i3_scratch");
60 
61  return __i3;
62 }
63 
64 /*
65  * Loads tree from 'path' (used for in-place restarts).
66  *
67  */
68 bool tree_restore(const char *path, xcb_get_geometry_reply_t *geometry) {
69  char *globbed = resolve_tilde(path);
70 
71  if (!path_exists(globbed)) {
72  LOG("%s does not exist, not restoring tree\n", globbed);
73  free(globbed);
74  return false;
75  }
76 
77  /* TODO: refactor the following */
78  croot = con_new(NULL, NULL);
79  croot->rect = (Rect){
80  geometry->x,
81  geometry->y,
82  geometry->width,
83  geometry->height};
84  focused = croot;
85 
86  tree_append_json(focused, globbed, NULL);
87 
88  DLOG("appended tree, using new root\n");
89  croot = TAILQ_FIRST(&(croot->nodes_head));
90  DLOG("new root = %p\n", croot);
91  Con *out = TAILQ_FIRST(&(croot->nodes_head));
92  DLOG("out = %p\n", out);
93  Con *ws = TAILQ_FIRST(&(out->nodes_head));
94  DLOG("ws = %p\n", ws);
95 
96  /* For in-place restarting into v4.2, we need to make sure the new
97  * pseudo-output __i3 is present. */
98  if (strcmp(out->name, "__i3") != 0) {
99  DLOG("Adding pseudo-output __i3 during inplace restart\n");
100  Con *__i3 = _create___i3();
101  /* Ensure that it is the first output, other places in the code make
102  * that assumption. */
103  TAILQ_REMOVE(&(croot->nodes_head), __i3, nodes);
104  TAILQ_INSERT_HEAD(&(croot->nodes_head), __i3, nodes);
105  }
106 
108 
109  return true;
110 }
111 
112 /*
113  * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
114  * root node are created in randr.c for each Output.
115  *
116  */
117 void tree_init(xcb_get_geometry_reply_t *geometry) {
118  croot = con_new(NULL, NULL);
119  FREE(croot->name);
120  croot->name = "root";
121  croot->type = CT_ROOT;
122  croot->layout = L_SPLITH;
123  croot->rect = (Rect){
124  geometry->x,
125  geometry->y,
126  geometry->width,
127  geometry->height};
128 
129  _create___i3();
130 }
131 
132 /*
133  * Opens an empty container in the current container
134  *
135  */
136 Con *tree_open_con(Con *con, i3Window *window) {
137  if (con == NULL) {
138  /* every focusable Con has a parent (outputs have parent root) */
139  con = focused->parent;
140  /* If the parent is an output, we are on a workspace. In this case,
141  * the new container needs to be opened as a leaf of the workspace. */
142  if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
143  con = focused;
144  }
145 
146  /* If the currently focused container is a floating container, we
147  * attach the new container to the currently focused spot in its
148  * workspace. */
149  if (con->type == CT_FLOATING_CON) {
151  if (con->type != CT_WORKSPACE)
152  con = con->parent;
153  }
154  DLOG("con = %p\n", con);
155  }
156 
157  assert(con != NULL);
158 
159  /* 3. create the container and attach it to its parent */
160  Con *new = con_new(con, window);
161  new->layout = L_SPLITH;
162 
163  /* 4: re-calculate child->percent for each child */
164  con_fix_percent(con);
165 
166  return new;
167 }
168 
169 static bool _is_con_mapped(Con *con) {
170  Con *child;
171 
172  TAILQ_FOREACH(child, &(con->nodes_head), nodes)
173  if (_is_con_mapped(child))
174  return true;
175 
176  return con->mapped;
177 }
178 
179 /*
180  * Closes the given container including all children.
181  * Returns true if the container was killed or false if just WM_DELETE was sent
182  * and the window is expected to kill itself.
183  *
184  * The dont_kill_parent flag is specified when the function calls itself
185  * recursively while deleting a containers children.
186  *
187  * The force_set_focus flag is specified in the case of killing a floating
188  * window: tree_close() will be invoked for the CT_FLOATINGCON (the parent
189  * container) and focus should be set there.
190  *
191  */
192 bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus) {
193  bool was_mapped = con->mapped;
194  Con *parent = con->parent;
195 
196  if (!was_mapped) {
197  /* Even if the container itself is not mapped, its children may be
198  * mapped (for example split containers don't have a mapped window on
199  * their own but usually contain mapped children). */
200  was_mapped = _is_con_mapped(con);
201  }
202 
203  /* remove the urgency hint of the workspace (if set) */
204  if (con->urgent) {
205  con->urgent = false;
208  }
209 
210  /* Get the container which is next focused */
211  Con *next = con_next_focused(con);
212  DLOG("next = %p, focused = %p\n", next, focused);
213 
214  DLOG("closing %p, kill_window = %d\n", con, kill_window);
215  Con *child, *nextchild;
216  bool abort_kill = false;
217  /* We cannot use TAILQ_FOREACH because the children get deleted
218  * in their parent’s nodes_head */
219  for (child = TAILQ_FIRST(&(con->nodes_head)); child;) {
220  nextchild = TAILQ_NEXT(child, nodes);
221  DLOG("killing child=%p\n", child);
222  if (!tree_close(child, kill_window, true, false))
223  abort_kill = true;
224  child = nextchild;
225  }
226 
227  if (abort_kill) {
228  DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
229  return false;
230  }
231 
232  if (con->window != NULL) {
233  if (kill_window != DONT_KILL_WINDOW) {
234  x_window_kill(con->window->id, kill_window);
235  return false;
236  } else {
237  xcb_void_cookie_t cookie;
238  /* Ignore any further events by clearing the event mask,
239  * unmap the window,
240  * then reparent it to the root window. */
241  xcb_change_window_attributes(conn, con->window->id,
242  XCB_CW_EVENT_MASK, (uint32_t[]){XCB_NONE});
243  xcb_unmap_window(conn, con->window->id);
244  cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
245 
246  /* Ignore X11 errors for the ReparentWindow request.
247  * X11 Errors are returned when the window was already destroyed */
248  add_ignore_event(cookie.sequence, 0);
249 
250  /* We are no longer handling this window, thus set WM_STATE to
251  * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
252  long data[] = {XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE};
253  cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
254  con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
255 
256  /* Remove the window from the save set. All windows in the save set
257  * will be mapped when i3 closes its connection (e.g. when
258  * restarting). This is not what we want, since some apps keep
259  * unmapped windows around and don’t expect them to suddenly be
260  * mapped. See http://bugs.i3wm.org/1617 */
261  xcb_change_save_set(conn, XCB_SET_MODE_DELETE, con->window->id);
262 
263  /* Ignore X11 errors for the ReparentWindow request.
264  * X11 Errors are returned when the window was already destroyed */
265  add_ignore_event(cookie.sequence, 0);
266  }
267  ipc_send_window_event("close", con);
268  FREE(con->window->class_class);
269  FREE(con->window->class_instance);
270  i3string_free(con->window->name);
271  FREE(con->window->ran_assignments);
272  FREE(con->window);
273  }
274 
275  Con *ws = con_get_workspace(con);
276 
277  /* Figure out which container to focus next before detaching 'con'. */
278  if (con_is_floating(con)) {
279  if (con == focused) {
280  DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
281  next = con_next_focused(parent);
282 
283  dont_kill_parent = true;
284  DLOG("Alright, focusing %p\n", next);
285  } else {
286  next = NULL;
287  }
288  }
289 
290  /* Detach the container so that it will not be rendered anymore. */
291  con_detach(con);
292 
293  /* disable urgency timer, if needed */
294  if (con->urgency_timer != NULL) {
295  DLOG("Removing urgency timer of con %p\n", con);
297  ev_timer_stop(main_loop, con->urgency_timer);
298  FREE(con->urgency_timer);
299  }
300 
301  if (con->type != CT_FLOATING_CON) {
302  /* If the container is *not* floating, we might need to re-distribute
303  * percentage values for the resized containers. */
304  con_fix_percent(parent);
305  }
306 
307  /* Render the tree so that the surrounding containers take up the space
308  * which 'con' does no longer occupy. If we don’t render here, there will
309  * be a gap in our containers and that could trigger an EnterNotify for an
310  * underlying container, see ticket #660.
311  *
312  * Rendering has to be avoided when dont_kill_parent is set (when
313  * tree_close calls itself recursively) because the tree is in a
314  * non-renderable state during that time. */
315  if (!dont_kill_parent)
316  tree_render();
317 
318  /* kill the X11 part of this container */
319  x_con_kill(con);
320 
321  if (con_is_floating(con)) {
322  DLOG("Container was floating, killing floating container\n");
323  tree_close(parent, DONT_KILL_WINDOW, false, (con == focused));
324  DLOG("parent container killed\n");
325  }
326 
327  free(con->name);
328  FREE(con->deco_render_params);
330  free(con);
331 
332  /* in the case of floating windows, we already focused another container
333  * when closing the parent, so we can exit now. */
334  if (!next) {
335  DLOG("No next container, i will just exit now\n");
336  return true;
337  }
338 
339  if (was_mapped || con == focused) {
340  if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
341  DLOG("focusing %p / %s\n", next, next->name);
342  if (next->type == CT_DOCKAREA) {
343  /* Instead of focusing the dockarea, we need to restore focus to the workspace */
345  } else {
346  if (!force_set_focus && con != focused)
347  DLOG("not changing focus, the container was not focused before\n");
348  else
349  con_focus(next);
350  }
351  } else {
352  DLOG("not focusing because we're not killing anybody\n");
353  }
354  } else {
355  DLOG("not focusing, was not mapped\n");
356  }
357 
358  /* check if the parent container is empty now and close it */
359  if (!dont_kill_parent)
360  CALL(parent, on_remove_child);
361 
362  return true;
363 }
364 
365 /*
366  * Closes the current container using tree_close().
367  *
368  */
369 void tree_close_con(kill_window_t kill_window) {
370  assert(focused != NULL);
371 
372  /* There *should* be no possibility to focus outputs / root container */
373  assert(focused->type != CT_OUTPUT);
374  assert(focused->type != CT_ROOT);
375 
376  if (focused->type == CT_WORKSPACE) {
377  DLOG("Workspaces cannot be close, closing all children instead\n");
378  Con *child, *nextchild;
379  for (child = TAILQ_FIRST(&(focused->focus_head)); child;) {
380  nextchild = TAILQ_NEXT(child, focused);
381  DLOG("killing child=%p\n", child);
382  tree_close(child, kill_window, false, false);
383  child = nextchild;
384  }
385 
386  return;
387  }
388 
389  /* Kill con */
390  tree_close(focused, kill_window, false, false);
391 }
392 
393 /*
394  * Splits (horizontally or vertically) the given container by creating a new
395  * container which contains the old one and the future ones.
396  *
397  */
398 void tree_split(Con *con, orientation_t orientation) {
399  if (con_is_floating(con)) {
400  DLOG("Floating containers can't be split.\n");
401  return;
402  }
403 
404  if (con->type == CT_WORKSPACE) {
405  if (con_num_children(con) < 2) {
406  DLOG("Just changing orientation of workspace\n");
407  con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
408  return;
409  } else {
410  /* if there is more than one container on the workspace
411  * move them into a new container and handle this instead */
412  con = workspace_encapsulate(con);
413  }
414  }
415 
416  Con *parent = con->parent;
417 
418  /* Force re-rendering to make the indicator border visible. */
420 
421  /* if we are in a container whose parent contains only one
422  * child (its split functionality is unused so far), we just change the
423  * orientation (more intuitive than splitting again) */
424  if (con_num_children(parent) == 1 &&
425  (parent->layout == L_SPLITH ||
426  parent->layout == L_SPLITV)) {
427  parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
428  DLOG("Just changing orientation of existing container\n");
429  return;
430  }
431 
432  DLOG("Splitting in orientation %d\n", orientation);
433 
434  /* 2: replace it with a new Con */
435  Con *new = con_new(NULL, NULL);
436  TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
437  TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
438  new->parent = parent;
439  new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
440 
441  /* 3: swap 'percent' (resize factor) */
442  new->percent = con->percent;
443  con->percent = 0.0;
444 
445  /* 4: add it as a child to the new Con */
446  con_attach(con, new, false);
447 }
448 
449 /*
450  * Moves focus one level up. Returns true if focus changed.
451  *
452  */
453 bool level_up(void) {
454  /* Skip over floating containers and go directly to the grandparent
455  * (which should always be a workspace) */
456  if (focused->parent->type == CT_FLOATING_CON) {
457  con_focus(focused->parent->parent);
458  return true;
459  }
460 
461  /* We can focus up to the workspace, but not any higher in the tree */
462  if ((focused->parent->type != CT_CON &&
463  focused->parent->type != CT_WORKSPACE) ||
464  focused->type == CT_WORKSPACE) {
465  ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
466  return false;
467  }
468  con_focus(focused->parent);
469  return true;
470 }
471 
472 /*
473  * Moves focus one level down. Returns true if focus changed.
474  *
475  */
476 bool level_down(void) {
477  /* Go down the focus stack of the current node */
478  Con *next = TAILQ_FIRST(&(focused->focus_head));
479  if (next == TAILQ_END(&(focused->focus_head))) {
480  DLOG("cannot go down\n");
481  return false;
482  } else if (next->type == CT_FLOATING_CON) {
483  /* Floating cons shouldn't be directly focused; try immediately
484  * going to the grandchild of the focused con. */
485  Con *child = TAILQ_FIRST(&(next->focus_head));
486  if (child == TAILQ_END(&(next->focus_head))) {
487  DLOG("cannot go down\n");
488  return false;
489  } else
490  next = TAILQ_FIRST(&(next->focus_head));
491  }
492 
493  con_focus(next);
494  return true;
495 }
496 
497 static void mark_unmapped(Con *con) {
498  Con *current;
499 
500  con->mapped = false;
501  TAILQ_FOREACH(current, &(con->nodes_head), nodes)
502  mark_unmapped(current);
503  if (con->type == CT_WORKSPACE) {
504  /* We need to call mark_unmapped on floating nodes aswell since we can
505  * make containers floating. */
506  TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
507  mark_unmapped(current);
508  }
509 }
510 
511 /*
512  * Renders the tree, that is rendering all outputs using render_con() and
513  * pushing the changes to X11 using x_push_changes().
514  *
515  */
516 void tree_render(void) {
517  if (croot == NULL)
518  return;
519 
520  DLOG("-- BEGIN RENDERING --\n");
521  /* Reset map state for all nodes in tree */
522  /* TODO: a nicer method to walk all nodes would be good, maybe? */
523  mark_unmapped(croot);
524  croot->mapped = true;
525 
526  render_con(croot, false);
527 
528  x_push_changes(croot);
529  DLOG("-- END RENDERING --\n");
530 }
531 
532 /*
533  * Recursive function to walk the tree until a con can be found to focus.
534  *
535  */
536 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
537  /* When dealing with fullscreen containers, it's necessary to go up to the
538  * workspace level, because 'focus $dir' will start at the con's real
539  * position in the tree, and it may not be possible to get to the edge
540  * normally due to fullscreen focusing restrictions. */
541  if (con->fullscreen_mode == CF_OUTPUT && con->type != CT_WORKSPACE)
542  con = con_get_workspace(con);
543 
544  /* Stop recursing at workspaces after attempting to switch to next
545  * workspace if possible. */
546  if (con->type == CT_WORKSPACE) {
547  if (con_get_fullscreen_con(con, CF_GLOBAL)) {
548  DLOG("Cannot change workspace while in global fullscreen mode.\n");
549  return false;
550  }
551  Output *current_output = get_output_containing(con->rect.x, con->rect.y);
552  Output *next_output;
553 
554  if (!current_output)
555  return false;
556  DLOG("Current output is %s\n", current_output->name);
557 
558  /* Try to find next output */
559  direction_t direction;
560  if (way == 'n' && orientation == HORIZ)
561  direction = D_RIGHT;
562  else if (way == 'p' && orientation == HORIZ)
563  direction = D_LEFT;
564  else if (way == 'n' && orientation == VERT)
565  direction = D_DOWN;
566  else if (way == 'p' && orientation == VERT)
567  direction = D_UP;
568  else
569  return false;
570 
571  next_output = get_output_next(direction, current_output, CLOSEST_OUTPUT);
572  if (!next_output)
573  return false;
574  DLOG("Next output is %s\n", next_output->name);
575 
576  /* Find visible workspace on next output */
577  Con *workspace = NULL;
578  GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
579 
580  /* Show next workspace and focus appropriate container if possible. */
581  if (!workspace)
582  return false;
583 
584  workspace_show(workspace);
585 
586  /* If a workspace has an active fullscreen container, one of its
587  * children should always be focused. The above workspace_show()
588  * should be adequate for that, so return. */
589  if (con_get_fullscreen_con(workspace, CF_OUTPUT))
590  return true;
591 
592  Con *focus = con_descend_direction(workspace, direction);
593 
594  /* special case: if there was no tiling con to focus and the workspace
595  * has a floating con in the focus stack, focus the top of the focus
596  * stack (which may be floating) */
597  if (focus == workspace)
598  focus = con_descend_focused(workspace);
599 
600  if (focus) {
601  con_focus(focus);
602  x_set_warp_to(&(focus->rect));
603  }
604  return true;
605  }
606 
607  Con *parent = con->parent;
608 
609  if (con->type == CT_FLOATING_CON) {
610  if (orientation != HORIZ)
611  return false;
612 
613  /* left/right focuses the previous/next floating container */
614  Con *next;
615  if (way == 'n')
616  next = TAILQ_NEXT(con, floating_windows);
617  else
618  next = TAILQ_PREV(con, floating_head, floating_windows);
619 
620  /* If there is no next/previous container, wrap */
621  if (!next) {
622  if (way == 'n')
623  next = TAILQ_FIRST(&(parent->floating_head));
624  else
625  next = TAILQ_LAST(&(parent->floating_head), floating_head);
626  }
627 
628  /* Still no next/previous container? bail out */
629  if (!next)
630  return false;
631 
632  /* Raise the floating window on top of other windows preserving
633  * relative stack order */
634  while (TAILQ_LAST(&(parent->floating_head), floating_head) != next) {
635  Con *last = TAILQ_LAST(&(parent->floating_head), floating_head);
636  TAILQ_REMOVE(&(parent->floating_head), last, floating_windows);
637  TAILQ_INSERT_HEAD(&(parent->floating_head), last, floating_windows);
638  }
639 
641  return true;
642  }
643 
644  /* If the orientation does not match or there is no other con to focus, we
645  * need to go higher in the hierarchy */
646  if (con_orientation(parent) != orientation ||
647  con_num_children(parent) == 1)
648  return _tree_next(parent, way, orientation, wrap);
649 
650  Con *current = TAILQ_FIRST(&(parent->focus_head));
651  /* TODO: when can the following happen (except for floating windows, which
652  * are handled above)? */
653  if (TAILQ_EMPTY(&(parent->nodes_head))) {
654  DLOG("nothing to focus\n");
655  return false;
656  }
657 
658  Con *next;
659  if (way == 'n')
660  next = TAILQ_NEXT(current, nodes);
661  else
662  next = TAILQ_PREV(current, nodes_head, nodes);
663 
664  if (!next) {
666  /* If there is no next/previous container, we check if we can focus one
667  * when going higher (without wrapping, though). If so, we are done, if
668  * not, we wrap */
669  if (_tree_next(parent, way, orientation, false))
670  return true;
671 
672  if (!wrap)
673  return false;
674  }
675 
676  if (way == 'n')
677  next = TAILQ_FIRST(&(parent->nodes_head));
678  else
679  next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
680  }
681 
682  /* Don't violate fullscreen focus restrictions. */
684  return false;
685 
686  /* 3: focus choice comes in here. at the moment we will go down
687  * until we find a window */
688  /* TODO: check for window, atm we only go down as far as possible */
690  return true;
691 }
692 
693 /*
694  * Changes focus in the given way (next/previous) and given orientation
695  * (horizontal/vertical).
696  *
697  */
698 void tree_next(char way, orientation_t orientation) {
699  _tree_next(focused, way, orientation, true);
700 }
701 
702 /*
703  * tree_flatten() removes pairs of redundant split containers, e.g.:
704  * [workspace, horizontal]
705  * [v-split] [child3]
706  * [h-split]
707  * [child1] [child2]
708  * In this example, the v-split and h-split container are redundant.
709  * Such a situation can be created by moving containers in a direction which is
710  * not the orientation of their parent container. i3 needs to create a new
711  * split container then and if you move containers this way multiple times,
712  * redundant chains of split-containers can be the result.
713  *
714  */
715 void tree_flatten(Con *con) {
716  Con *current, *child, *parent = con->parent;
717  DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
718 
719  /* We only consider normal containers without windows */
720  if (con->type != CT_CON ||
721  parent->layout == L_OUTPUT || /* con == "content" */
722  con->window != NULL)
723  goto recurse;
724 
725  /* Ensure it got only one child */
726  child = TAILQ_FIRST(&(con->nodes_head));
727  if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
728  goto recurse;
729 
730  DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
731 
732  /* The child must have a different orientation than the con but the same as
733  * the con’s parent to be redundant */
734  if (!con_is_split(con) ||
735  !con_is_split(child) ||
736  (con->layout != L_SPLITH && con->layout != L_SPLITV) ||
737  (child->layout != L_SPLITH && child->layout != L_SPLITV) ||
738  con_orientation(con) == con_orientation(child) ||
739  con_orientation(child) != con_orientation(parent))
740  goto recurse;
741 
742  DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
743  /* 1: save focus */
744  Con *focus_next = TAILQ_FIRST(&(child->focus_head));
745 
746  DLOG("detaching...\n");
747  /* 2: re-attach the children to the parent before con */
748  while (!TAILQ_EMPTY(&(child->nodes_head))) {
749  current = TAILQ_FIRST(&(child->nodes_head));
750  DLOG("detaching current=%p / %s\n", current, current->name);
751  con_detach(current);
752  DLOG("re-attaching\n");
753  /* We don’t use con_attach() here because for a CT_CON, the special
754  * case handling of con_attach() does not trigger. So all it would do
755  * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
756  * directly use the TAILQ macros. */
757  current->parent = parent;
758  TAILQ_INSERT_BEFORE(con, current, nodes);
759  DLOG("attaching to focus list\n");
760  TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
761  current->percent = con->percent;
762  }
763  DLOG("re-attached all\n");
764 
765  /* 3: restore focus, if con was focused */
766  if (focus_next != NULL &&
767  TAILQ_FIRST(&(parent->focus_head)) == con) {
768  DLOG("restoring focus to focus_next=%p\n", focus_next);
769  TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
770  TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
771  DLOG("restored focus.\n");
772  }
773 
774  /* 4: close the redundant cons */
775  DLOG("closing redundant cons\n");
776  tree_close(con, DONT_KILL_WINDOW, true, false);
777 
778  /* Well, we got to abort the recursion here because we destroyed the
779  * container. However, if tree_flatten() is called sufficiently often,
780  * there can’t be the situation of having two pairs of redundant containers
781  * at once. Therefore, we can safely abort the recursion on this level
782  * after flattening. */
783  return;
784 
785 recurse:
786  /* We cannot use normal foreach here because tree_flatten might close the
787  * current container. */
788  current = TAILQ_FIRST(&(con->nodes_head));
789  while (current != NULL) {
790  Con *next = TAILQ_NEXT(current, nodes);
791  tree_flatten(current);
792  current = next;
793  }
794 
795  current = TAILQ_FIRST(&(con->floating_head));
796  while (current != NULL) {
797  Con *next = TAILQ_NEXT(current, floating_windows);
798  tree_flatten(current);
799  current = next;
800  }
801 }
struct Con * parent
Definition: data.h:529
void tree_next(char way, orientation_t orientation)
Changes focus in the given way (next/previous) and given orientation (horizontal/vertical).
Definition: tree.c:698
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
static bool _is_con_mapped(Con *con)
Definition: tree.c:169
bool mapped
Definition: data.h:497
bool urgent
Definition: data.h:501
char * name
Name of the output.
Definition: data.h:328
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition: con.c:400
void tree_render(void)
Renders the tree, that is rendering all outputs using render_con() and pushing the changes to X11 usi...
Definition: tree.c:516
direction_t
Definition: data.h:53
uint32_t y
Definition: data.h:132
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:402
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition: con.c:83
Config config
Definition: config.c:17
xcb_connection_t * conn
Definition: main.c:43
Con * workspace_encapsulate(Con *ws)
Creates a new container and re-parents all of children from the given workspace into it...
Definition: workspace.c:859
double percent
Definition: data.h:547
Output * get_output_next(direction_t direction, Output *current, output_close_far_t close_far)
Gets the output which is the next one in the given direction.
Definition: randr.c:161
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:298
Definition: data.h:56
#define TAILQ_INSERT_BEFORE(listelm, elm, field)
Definition: queue.h:394
#define LOG(fmt,...)
Definition: libi3.h:76
bool workspace_is_visible(Con *ws)
Returns true if the workspace is currently visible.
Definition: workspace.c:229
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition: con.c:177
#define TAILQ_LAST(head, headname)
Definition: queue.h:339
void workspace_show(Con *workspace)
Switches to the given workspace.
Definition: workspace.c:459
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1029
struct Rect rect
Definition: data.h:531
struct all_cons_head all_cons
Definition: tree.c:17
struct Rect Rect
Definition: data.h:43
#define TAILQ_REPLACE(head, elm, elm2, field)
Definition: queue.h:413
Con * tree_open_con(Con *con, i3Window *window)
Opens an empty container in the current container.
Definition: tree.c:136
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1044
void con_force_split_parents_redraw(Con *con)
force parent split containers to be redrawn
Definition: con.c:23
struct ev_loop * main_loop
Definition: main.c:65
#define TAILQ_FIRST(head)
Definition: queue.h:336
Definition: data.h:53
struct Window * window
Definition: data.h:564
char * class_instance
Definition: data.h:358
bool level_up(void)
Moves focus one level up.
Definition: tree.c:453
void x_window_kill(xcb_window_t window, kill_window_t kill_window)
Kills the given X11 window using WM_DELETE_WINDOW (if supported).
Definition: x.c:272
An Output is a physical output on your graphics driver.
Definition: data.h:313
#define TAILQ_NEXT(elm, field)
Definition: queue.h:338
Con * con_new(Con *parent, i3Window *window)
Definition: con.c:67
void tree_append_json(Con *con, const char *filename, char **errormsg)
Definition: load_layout.c:511
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:344
Con * con_descend_direction(Con *con, direction_t direction)
Definition: con.c:1070
void x_set_warp_to(Rect *rect)
Set warp_to coordinates.
Definition: x.c:1143
enum Con::@18 type
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:1613
#define DLOG(fmt,...)
Definition: libi3.h:86
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:924
void tree_split(Con *con, orientation_t orientation)
Splits (horizontally or vertically) the given container by creating a new container which contains th...
Definition: tree.c:398
#define XCB_ICCCM_WM_STATE_WITHDRAWN
Definition: xcb_compat.h:20
Con * con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode)
Returns the first fullscreen node below this node.
Definition: con.c:346
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:192
bool tree_restore(const char *path, xcb_get_geometry_reply_t *geometry)
Loads tree from ~/.i3/_restart.json (used for in-place restarts).
Definition: tree.c:68
uint32_t height
Definition: data.h:134
struct deco_render_params * deco_render_params
Cache for the decoration rendering.
Definition: data.h:570
Definition: data.h:54
#define TAILQ_INSERT_HEAD(head, elm, field)
Definition: queue.h:366
Con * con
Pointer to the Con which represents this output.
Definition: data.h:331
void x_push_changes(Con *con)
Pushes all changes (state of each node, see x_push_node() and the window stack) to X11...
Definition: x.c:884
int num
the workspace number, if this Con is of type CT_WORKSPACE and the workspace is not a named workspace ...
Definition: data.h:527
char * name
Definition: data.h:537
fullscreen_mode_t fullscreen_mode
Definition: data.h:580
Definition: data.h:99
bool level_down(void)
Moves focus one level down.
Definition: tree.c:476
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:1545
void x_set_name(Con *con, const char *name)
Sets the WM_NAME property (so, no UTF8, but used only for debugging anyways) of the given name...
Definition: x.c:1101
void con_focus(Con *con)
Sets input focus to the given container.
Definition: con.c:193
void add_ignore_event(const int sequence, const int response_type)
Adds the given sequence to the list of events which are ignored.
#define TAILQ_EMPTY(head)
Definition: queue.h:344
int con_num_children(Con *con)
Returns the number of children of this container.
Definition: con.c:507
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:773
void tree_flatten(Con *con)
tree_flatten() removes pairs of redundant split containers, e.g.
Definition: tree.c:715
void i3string_free(i3String *str)
Free an i3String.
void restore_open_placeholder_windows(Con *parent)
Open placeholder windows for all children of parent.
char * resolve_tilde(const char *path)
This function resolves ~ in pathnames.
Definition: util.c:168
bool con_is_split(Con *con)
Definition: con.c:246
Definition: data.h:55
#define TAILQ_PREV(elm, headname, field)
Definition: queue.h:342
bool force_focus_wrapping
Think of the following layout: Horizontal workspace with a tabbed con on the left of the screen and a...
Definition: config.h:142
#define ELOG(fmt,...)
Definition: libi3.h:81
Definition: data.h:58
#define GREP_FIRST(dest, head, condition)
Definition: util.h:39
layout_t layout
Definition: data.h:595
orientation_t con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition: con.c:889
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:496
uint32_t x
Definition: data.h:131
Definition: data.h:97
orientation_t
Definition: data.h:57
#define TAILQ_END(head)
Definition: queue.h:337
Output * get_output_containing(unsigned int x, unsigned int y)
Returns the active (!) output which contains the coordinates x, y or NULL if there is no output which...
Definition: randr.c:80
#define CALL(obj, member,...)
Definition: util.h:56
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:376
struct Con * croot
Definition: tree.c:14
xcb_window_t root
Definition: main.c:56
void tree_init(xcb_get_geometry_reply_t *geometry)
Initializes the tree by creating the root node, adding all RandR outputs to the tree (that means rand...
Definition: tree.c:117
#define TAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:324
static void mark_unmapped(Con *con)
Definition: tree.c:497
bool path_exists(const char *path)
Checks if the given path exists by calling stat().
Definition: util.c:198
Con * output_get_content(Con *output)
Returns the output container below the given output container.
Definition: output.c:18
i3String * name
The name of the window.
Definition: data.h:361
xcb_window_t id
Definition: data.h:345
char * class_class
Definition: data.h:357
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:347
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition: con.c:523
struct Con * focused
Definition: tree.c:15
Definition: data.h:59
void tree_close_con(kill_window_t kill_window)
Closes the current container using tree_close().
Definition: tree.c:369
#define FREE(pointer)
Definition: util.h:48
void ipc_send_window_event(const char *property, Con *con)
For the window events we send, along the usual "change" field, also the window container, in "container".
Definition: ipc.c:1155
Assignment ** ran_assignments
Definition: data.h:355
static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap)
Definition: tree.c:536
void x_con_kill(Con *con)
Kills the window decoration associated with the given container.
Definition: x.c:228
void render_con(Con *con, bool render_fullscreen)
"Renders" the given container (and its children), meaning that all rects are updated correctly...
Definition: render.c:126
kill_window_t
parameter to specify whether tree_close() and x_window_kill() should kill only this specific window o...
Definition: data.h:66
uint32_t width
Definition: data.h:133
Definition: data.h:98
struct ev_timer * urgency_timer
Definition: data.h:567
static Con * _create___i3(void)
Definition: tree.c:24