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");
59  ws->fullscreen_mode = CF_OUTPUT;
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  };
85  focused = croot;
86 
87  tree_append_json(globbed);
88 
89  printf("appended tree, using new root\n");
90  croot = TAILQ_FIRST(&(croot->nodes_head));
91  printf("new root = %p\n", croot);
92  Con *out = TAILQ_FIRST(&(croot->nodes_head));
93  printf("out = %p\n", out);
94  Con *ws = TAILQ_FIRST(&(out->nodes_head));
95  printf("ws = %p\n", ws);
96 
97  /* For in-place restarting into v4.2, we need to make sure the new
98  * pseudo-output __i3 is present. */
99  if (strcmp(out->name, "__i3") != 0) {
100  DLOG("Adding pseudo-output __i3 during inplace restart\n");
101  Con *__i3 = _create___i3();
102  /* Ensure that it is the first output, other places in the code make
103  * that assumption. */
104  TAILQ_REMOVE(&(croot->nodes_head), __i3, nodes);
105  TAILQ_INSERT_HEAD(&(croot->nodes_head), __i3, nodes);
106  }
107 
108  return true;
109 }
110 
111 /*
112  * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
113  * root node are created in randr.c for each Output.
114  *
115  */
116 void tree_init(xcb_get_geometry_reply_t *geometry) {
117  croot = con_new(NULL, NULL);
118  FREE(croot->name);
119  croot->name = "root";
120  croot->type = CT_ROOT;
121  croot->layout = L_SPLITH;
122  croot->rect = (Rect){
123  geometry->x,
124  geometry->y,
125  geometry->width,
126  geometry->height
127  };
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  /* Get the container which is next focused */
204  Con *next = con_next_focused(con);
205  DLOG("next = %p, focused = %p\n", next, focused);
206 
207  DLOG("closing %p, kill_window = %d\n", con, kill_window);
208  Con *child, *nextchild;
209  bool abort_kill = false;
210  /* We cannot use TAILQ_FOREACH because the children get deleted
211  * in their parent’s nodes_head */
212  for (child = TAILQ_FIRST(&(con->nodes_head)); child; ) {
213  nextchild = TAILQ_NEXT(child, nodes);
214  DLOG("killing child=%p\n", child);
215  if (!tree_close(child, kill_window, true, false))
216  abort_kill = true;
217  child = nextchild;
218  }
219 
220  if (abort_kill) {
221  DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
222  return false;
223  }
224 
225  if (con->window != NULL) {
226  if (kill_window != DONT_KILL_WINDOW) {
227  x_window_kill(con->window->id, kill_window);
228  return false;
229  } else {
230  xcb_void_cookie_t cookie;
231  /* un-parent the window */
232  cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
233 
234  /* Ignore X11 errors for the ReparentWindow request.
235  * X11 Errors are returned when the window was already destroyed */
236  add_ignore_event(cookie.sequence, 0);
237 
238  /* We are no longer handling this window, thus set WM_STATE to
239  * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
240  long data[] = { XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE };
241  cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
242  con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
243 
244  /* Ignore X11 errors for the ReparentWindow request.
245  * X11 Errors are returned when the window was already destroyed */
246  add_ignore_event(cookie.sequence, 0);
247  }
248  FREE(con->window->class_class);
249  FREE(con->window->class_instance);
250  i3string_free(con->window->name);
251  free(con->window);
252  }
253 
254  /* kill the X11 part of this container */
255  x_con_kill(con);
256 
257  con_detach(con);
258  if (con->type != CT_FLOATING_CON) {
259  /* If the container is *not* floating, we might need to re-distribute
260  * percentage values for the resized containers. */
261  con_fix_percent(parent);
262  }
263 
264  if (con_is_floating(con)) {
265  Con *ws = con_get_workspace(con);
266  DLOG("Container was floating, killing floating container\n");
267  tree_close(parent, DONT_KILL_WINDOW, false, (con == focused));
268  DLOG("parent container killed\n");
269  if (con == focused) {
270  DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
271  /* go down the focus stack as far as possible */
272  next = con_descend_focused(ws);
273 
274  dont_kill_parent = true;
275  DLOG("Alright, focusing %p\n", next);
276  } else {
277  next = NULL;
278  }
279  }
280 
281  free(con->name);
282  FREE(con->deco_render_params);
284  free(con);
285 
286  /* in the case of floating windows, we already focused another container
287  * when closing the parent, so we can exit now. */
288  if (!next) {
289  DLOG("No next container, i will just exit now\n");
290  return true;
291  }
292 
293  if (was_mapped || con == focused) {
294  if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
295  DLOG("focusing %p / %s\n", next, next->name);
296  if (next->type == CT_DOCKAREA) {
297  /* Instead of focusing the dockarea, we need to restore focus to the workspace */
299  } else {
300  if (!force_set_focus && con != focused)
301  DLOG("not changing focus, the container was not focused before\n");
302  else con_focus(next);
303  }
304  }
305  else {
306  DLOG("not focusing because we're not killing anybody\n");
307  }
308  } else {
309  DLOG("not focusing, was not mapped\n");
310  }
311 
312  /* check if the parent container is empty now and close it */
313  if (!dont_kill_parent)
314  CALL(parent, on_remove_child);
315 
316  return true;
317 }
318 
319 /*
320  * Closes the current container using tree_close().
321  *
322  */
323 void tree_close_con(kill_window_t kill_window) {
324  assert(focused != NULL);
325  if (focused->type == CT_WORKSPACE) {
326  LOG("Cannot close workspace\n");
327  return;
328  }
329 
330  /* There *should* be no possibility to focus outputs / root container */
331  assert(focused->type != CT_OUTPUT);
332  assert(focused->type != CT_ROOT);
333 
334  /* Kill con */
335  tree_close(focused, kill_window, false, false);
336 }
337 
338 /*
339  * Splits (horizontally or vertically) the given container by creating a new
340  * container which contains the old one and the future ones.
341  *
342  */
343 void tree_split(Con *con, orientation_t orientation) {
344  /* for a workspace, we just need to change orientation */
345  if (con->type == CT_WORKSPACE) {
346  DLOG("Workspace, simply changing orientation to %d\n", orientation);
347  con->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
348  return;
349  }
350 
351  Con *parent = con->parent;
352 
353  /* Force re-rendering to make the indicator border visible. */
354  FREE(con->deco_render_params);
355  FREE(parent->deco_render_params);
356 
357  /* if we are in a container whose parent contains only one
358  * child (its split functionality is unused so far), we just change the
359  * orientation (more intuitive than splitting again) */
360  if (con_num_children(parent) == 1 &&
361  (parent->layout == L_SPLITH ||
362  parent->layout == L_SPLITV)) {
363  parent->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
364  DLOG("Just changing orientation of existing container\n");
365  return;
366  }
367 
368  DLOG("Splitting in orientation %d\n", orientation);
369 
370  /* 2: replace it with a new Con */
371  Con *new = con_new(NULL, NULL);
372  TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
373  TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
374  new->parent = parent;
375  new->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
376  new->split = true;
377 
378  /* 3: swap 'percent' (resize factor) */
379  new->percent = con->percent;
380  con->percent = 0.0;
381 
382  /* 4: add it as a child to the new Con */
383  con_attach(con, new, false);
384 }
385 
386 /*
387  * Moves focus one level up. Returns true if focus changed.
388  *
389  */
390 bool level_up(void) {
391  /* We can focus up to the workspace, but not any higher in the tree */
392  if ((focused->parent->type != CT_CON &&
393  focused->parent->type != CT_WORKSPACE) ||
394  focused->type == CT_WORKSPACE) {
395  ELOG("'focus parent': Focus is already on the workspace, cannot go higher than that.\n");
396  return false;
397  }
398  con_focus(focused->parent);
399  return true;
400 }
401 
402 /*
403  * Moves focus one level down. Returns true if focus changed.
404  *
405  */
406 bool level_down(void) {
407  /* Go down the focus stack of the current node */
408  Con *next = TAILQ_FIRST(&(focused->focus_head));
409  if (next == TAILQ_END(&(focused->focus_head))) {
410  printf("cannot go down\n");
411  return false;
412  }
413  con_focus(next);
414  return true;
415 }
416 
417 static void mark_unmapped(Con *con) {
418  Con *current;
419 
420  con->mapped = false;
421  TAILQ_FOREACH(current, &(con->nodes_head), nodes)
422  mark_unmapped(current);
423  if (con->type == CT_WORKSPACE) {
424  /* We need to call mark_unmapped on floating nodes aswell since we can
425  * make containers floating. */
426  TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
427  mark_unmapped(current);
428  }
429 }
430 
431 /*
432  * Renders the tree, that is rendering all outputs using render_con() and
433  * pushing the changes to X11 using x_push_changes().
434  *
435  */
436 void tree_render(void) {
437  if (croot == NULL)
438  return;
439 
440  DLOG("-- BEGIN RENDERING --\n");
441  /* Reset map state for all nodes in tree */
442  /* TODO: a nicer method to walk all nodes would be good, maybe? */
443  mark_unmapped(croot);
444  croot->mapped = true;
445 
446  render_con(croot, false);
447 
448  x_push_changes(croot);
449  DLOG("-- END RENDERING --\n");
450 }
451 
452 /*
453  * Recursive function to walk the tree until a con can be found to focus.
454  *
455  */
456 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
457  /* Stop recursing at workspaces after attempting to switch to next
458  * workspace if possible. */
459  if (con->type == CT_WORKSPACE) {
460  Output *current_output = get_output_containing(con->rect.x, con->rect.y);
461  Output *next_output;
462 
463  if (!current_output)
464  return false;
465  DLOG("Current output is %s\n", current_output->name);
466 
467  /* Try to find next output */
468  direction_t direction;
469  if (way == 'n' && orientation == HORIZ)
470  direction = D_RIGHT;
471  else if (way == 'p' && orientation == HORIZ)
472  direction = D_LEFT;
473  else if (way == 'n' && orientation == VERT)
474  direction = D_DOWN;
475  else if (way == 'p' && orientation == VERT)
476  direction = D_UP;
477  else
478  return false;
479 
480  next_output = get_output_next(direction, current_output);
481  if (!next_output)
482  return false;
483  DLOG("Next output is %s\n", next_output->name);
484 
485  /* Find visible workspace on next output */
486  Con *workspace = NULL;
487  GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
488 
489  /* Show next workspace and focus appropriate container if possible. */
490  if (!workspace)
491  return false;
492 
493  workspace_show(workspace);
494  Con *focus = con_descend_direction(workspace, direction);
495  if (focus) {
496  con_focus(focus);
497  x_set_warp_to(&(focus->rect));
498  }
499  return true;
500  }
501 
502  Con *parent = con->parent;
503 
504  if (con->type == CT_FLOATING_CON) {
505  /* left/right focuses the previous/next floating container */
506  if (orientation == HORIZ) {
507  Con *next;
508  if (way == 'n')
509  next = TAILQ_NEXT(con, floating_windows);
510  else next = TAILQ_PREV(con, floating_head, floating_windows);
511 
512  /* If there is no next/previous container, wrap */
513  if (!next) {
514  if (way == 'n')
515  next = TAILQ_FIRST(&(parent->floating_head));
516  else next = TAILQ_LAST(&(parent->floating_head), floating_head);
517  }
518 
519  /* Still no next/previous container? bail out */
520  if (!next)
521  return false;
522 
524  return true;
525  } else {
526  /* up/down cycles through the Z-index */
527  /* TODO: implement cycling through the z-index */
528  return false;
529  }
530  }
531 
532  /* If the orientation does not match or there is no other con to focus, we
533  * need to go higher in the hierarchy */
534  if (con_orientation(parent) != orientation ||
535  con_num_children(parent) == 1)
536  return _tree_next(parent, way, orientation, wrap);
537 
538  Con *current = TAILQ_FIRST(&(parent->focus_head));
539  /* TODO: when can the following happen (except for floating windows, which
540  * are handled above)? */
541  if (TAILQ_EMPTY(&(parent->nodes_head))) {
542  DLOG("nothing to focus\n");
543  return false;
544  }
545 
546  Con *next;
547  if (way == 'n')
548  next = TAILQ_NEXT(current, nodes);
549  else next = TAILQ_PREV(current, nodes_head, nodes);
550 
551  if (!next) {
553  /* If there is no next/previous container, we check if we can focus one
554  * when going higher (without wrapping, though). If so, we are done, if
555  * not, we wrap */
556  if (_tree_next(parent, way, orientation, false))
557  return true;
558 
559  if (!wrap)
560  return false;
561  }
562 
563  if (way == 'n')
564  next = TAILQ_FIRST(&(parent->nodes_head));
565  else next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
566  }
567 
568  /* Don't violate fullscreen focus restrictions. */
570  return false;
571 
572  /* 3: focus choice comes in here. at the moment we will go down
573  * until we find a window */
574  /* TODO: check for window, atm we only go down as far as possible */
576  return true;
577 }
578 
579 /*
580  * Changes focus in the given way (next/previous) and given orientation
581  * (horizontal/vertical).
582  *
583  */
584 void tree_next(char way, orientation_t orientation) {
585  _tree_next(focused, way, orientation, true);
586 }
587 
588 /*
589  * tree_flatten() removes pairs of redundant split containers, e.g.:
590  * [workspace, horizontal]
591  * [v-split] [child3]
592  * [h-split]
593  * [child1] [child2]
594  * In this example, the v-split and h-split container are redundant.
595  * Such a situation can be created by moving containers in a direction which is
596  * not the orientation of their parent container. i3 needs to create a new
597  * split container then and if you move containers this way multiple times,
598  * redundant chains of split-containers can be the result.
599  *
600  */
601 void tree_flatten(Con *con) {
602  Con *current, *child, *parent = con->parent;
603  DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
604 
605  /* We only consider normal containers without windows */
606  if (con->type != CT_CON ||
607  parent->layout == L_OUTPUT || /* con == "content" */
608  con->window != NULL)
609  goto recurse;
610 
611  /* Ensure it got only one child */
612  child = TAILQ_FIRST(&(con->nodes_head));
613  if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
614  goto recurse;
615 
616  DLOG("child = %p, con = %p, parent = %p\n", child, con, parent);
617 
618  /* The child must have a different orientation than the con but the same as
619  * the con’s parent to be redundant */
620  if (!con->split ||
621  !child->split ||
622  con_orientation(con) == con_orientation(child) ||
623  con_orientation(child) != con_orientation(parent))
624  goto recurse;
625 
626  DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
627  /* 1: save focus */
628  Con *focus_next = TAILQ_FIRST(&(child->focus_head));
629 
630  DLOG("detaching...\n");
631  /* 2: re-attach the children to the parent before con */
632  while (!TAILQ_EMPTY(&(child->nodes_head))) {
633  current = TAILQ_FIRST(&(child->nodes_head));
634  DLOG("detaching current=%p / %s\n", current, current->name);
635  con_detach(current);
636  DLOG("re-attaching\n");
637  /* We don’t use con_attach() here because for a CT_CON, the special
638  * case handling of con_attach() does not trigger. So all it would do
639  * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
640  * directly use the TAILQ macros. */
641  current->parent = parent;
642  TAILQ_INSERT_BEFORE(con, current, nodes);
643  DLOG("attaching to focus list\n");
644  TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
645  current->percent = con->percent;
646  }
647  DLOG("re-attached all\n");
648 
649  /* 3: restore focus, if con was focused */
650  if (focus_next != NULL &&
651  TAILQ_FIRST(&(parent->focus_head)) == con) {
652  DLOG("restoring focus to focus_next=%p\n", focus_next);
653  TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
654  TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
655  DLOG("restored focus.\n");
656  }
657 
658  /* 4: close the redundant cons */
659  DLOG("closing redundant cons\n");
660  tree_close(con, DONT_KILL_WINDOW, true, false);
661 
662  /* Well, we got to abort the recursion here because we destroyed the
663  * container. However, if tree_flatten() is called sufficiently often,
664  * there can’t be the situation of having two pairs of redundant containers
665  * at once. Therefore, we can safely abort the recursion on this level
666  * after flattening. */
667  return;
668 
669 recurse:
670  /* We cannot use normal foreach here because tree_flatten might close the
671  * current container. */
672  current = TAILQ_FIRST(&(con->nodes_head));
673  while (current != NULL) {
674  Con *next = TAILQ_NEXT(current, nodes);
675  tree_flatten(current);
676  current = next;
677  }
678 
679  current = TAILQ_FIRST(&(con->floating_head));
680  while (current != NULL) {
681  Con *next = TAILQ_NEXT(current, floating_windows);
682  tree_flatten(current);
683  current = next;
684  }
685 }