]> git.sur5r.net Git - i3/i3/blob - src/tree.c
Add more documentation to functions/header files
[i3/i3] / src / tree.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  */
4
5 #include "all.h"
6
7 struct Con *croot;
8 struct Con *focused;
9
10 struct all_cons_head all_cons = TAILQ_HEAD_INITIALIZER(all_cons);
11
12 /*
13  * Loads tree from ~/.i3/_restart.json (used for in-place restarts).
14  *
15  */
16 bool tree_restore() {
17     char *globbed = glob_path("~/.i3/_restart.json");
18
19     if (!path_exists(globbed)) {
20         LOG("%s does not exist, not restoring tree\n", globbed);
21         free(globbed);
22         return false;
23     }
24
25     /* TODO: refactor the following */
26     croot = con_new(NULL);
27     focused = croot;
28
29     tree_append_json(globbed);
30     char *old_restart = glob_path("~/.i3/_restart.json.old");
31     unlink(old_restart);
32     rename(globbed, old_restart);
33     free(globbed);
34     free(old_restart);
35
36     printf("appended tree, using new root\n");
37     croot = TAILQ_FIRST(&(croot->nodes_head));
38     printf("new root = %p\n", croot);
39     Con *out = TAILQ_FIRST(&(croot->nodes_head));
40     printf("out = %p\n", out);
41     Con *ws = TAILQ_FIRST(&(out->nodes_head));
42     printf("ws = %p\n", ws);
43     con_focus(ws);
44
45     return true;
46 }
47
48 /*
49  * Initializes the tree by creating the root node, adding all RandR outputs
50  * to the tree (that means randr_init() has to be called before) and
51  * assigning a workspace to each RandR output.
52  *
53  */
54 void tree_init() {
55     Output *output;
56
57     croot = con_new(NULL);
58     croot->name = "root";
59     croot->type = CT_ROOT;
60
61     Con *ws;
62     /* add the outputs */
63     TAILQ_FOREACH(output, &outputs, outputs) {
64         if (!output->active)
65             continue;
66
67         Con *oc = con_new(croot);
68         oc->name = strdup(output->name);
69         oc->type = CT_OUTPUT;
70         oc->rect = output->rect;
71
72         /* add a workspace to this output */
73         ws = con_new(oc);
74         ws->type = CT_WORKSPACE;
75         ws->name = strdup("1");
76         ws->fullscreen_mode = CF_OUTPUT;
77         ws->orientation = HORIZ;
78     }
79
80     con_focus(ws);
81 }
82
83 /*
84  * Opens an empty container in the current container
85  *
86  */
87 Con *tree_open_con(Con *con) {
88     if (con == NULL) {
89         /* every focusable Con has a parent (outputs have parent root) */
90         con = focused->parent;
91         /* If the parent is an output, we are on a workspace. In this case,
92          * the new container needs to be opened as a leaf of the workspace. */
93         if (con->type == CT_OUTPUT)
94             con = focused;
95     }
96
97     assert(con != NULL);
98
99     /* 3: re-calculate child->percent for each child */
100     con_fix_percent(con, WINDOW_ADD);
101
102     /* 4: add a new container leaf to this con */
103     Con *new = con_new(con);
104     con_focus(new);
105
106     return new;
107 }
108
109 /*
110  * vanishing is the container that is about to be closed (so any floating
111  * client which has old_parent == vanishing needs to be "re-parented").
112  *
113  */
114 static void fix_floating_parent(Con *con, Con *vanishing) {
115     Con *child;
116
117     if (con->old_parent == vanishing) {
118         LOG("Fixing vanishing old_parent (%p) of container %p to be %p\n",
119                 vanishing, con, vanishing->parent);
120         con->old_parent = vanishing->parent;
121     }
122
123     TAILQ_FOREACH(child, &(con->floating_head), floating_windows)
124         fix_floating_parent(child, vanishing);
125
126     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
127         fix_floating_parent(child, vanishing);
128 }
129
130 /*
131  * Closes the given container including all children
132  *
133  */
134 void tree_close(Con *con, bool kill_window) {
135     /* check floating clients and adjust old_parent if necessary */
136     fix_floating_parent(croot, con);
137
138     /* Get the container which is next focused */
139     Con *next;
140     if (con->type == CT_FLOATING_CON) {
141         next = TAILQ_NEXT(con, floating_windows);
142         if (next == TAILQ_END(&(con->parent->floating_head)))
143             next = con_get_workspace(con);
144     } else {
145         next = TAILQ_NEXT(con, focused);
146         if (next == TAILQ_END(&(con->parent->nodes_head))) {
147             next = con->parent;
148             while (!TAILQ_EMPTY(&(next->focus_head)) &&
149                    TAILQ_FIRST(&(next->focus_head)) != con)
150                 next = TAILQ_FIRST(&(next->focus_head));
151         }
152     }
153
154     DLOG("closing %p, kill_window = %d\n", con, kill_window);
155     Con *child;
156     /* We cannot use TAILQ_FOREACH because the children get deleted
157      * in their parent’s nodes_head */
158     while (!TAILQ_EMPTY(&(con->nodes_head))) {
159         child = TAILQ_FIRST(&(con->nodes_head));
160         tree_close(child, kill_window);
161     }
162
163     if (con->window != NULL) {
164         if (kill_window)
165             x_window_kill(con->window->id);
166         else {
167             /* un-parent the window */
168             xcb_reparent_window(conn, con->window->id, root, 0, 0);
169             /* TODO: client_unmap to set state to withdrawn */
170
171         }
172         free(con->window);
173     }
174
175     /* kill the X11 part of this container */
176     x_con_kill(con);
177
178     con_detach(con);
179     con_fix_percent(con->parent, WINDOW_REMOVE);
180
181     if (con_is_floating(con)) {
182         DLOG("Container was floating, killing floating container\n");
183
184         TAILQ_REMOVE(&(con->parent->parent->floating_head), con->parent, floating_windows);
185         TAILQ_REMOVE(&(con->parent->parent->focus_head), con->parent, focused);
186         tree_close(con->parent, false);
187         next = NULL;
188     }
189
190     free(con->name);
191     TAILQ_REMOVE(&all_cons, con, all_cons);
192     free(con);
193
194     /* in the case of floating windows, we already focused another container
195      * when closing the parent, so we can exit now. */
196     if (!next)
197         return;
198
199     DLOG("focusing %p / %s\n", next, next->name);
200     /* TODO: check if the container (or one of its children) was focused */
201     con_focus(next);
202 }
203
204 /*
205  * Closes the current container using tree_close().
206  *
207  */
208 void tree_close_con() {
209     assert(focused != NULL);
210     if (focused->type == CT_WORKSPACE) {
211         LOG("Cannot close workspace\n");
212         return;
213     }
214
215     /* Kill con */
216     tree_close(focused, true);
217 }
218
219 /*
220  * Splits (horizontally or vertically) the given container by creating a new
221  * container which contains the old one and the future ones.
222  *
223  */
224 void tree_split(Con *con, orientation_t orientation) {
225     /* for a workspace, we just need to change orientation */
226     if (con->type == CT_WORKSPACE) {
227         DLOG("Workspace, simply changing orientation to %d\n", orientation);
228         con->orientation = orientation;
229         return;
230     }
231
232     Con *parent = con->parent;
233     /* if we are in a container whose parent contains only one
234      * child and has the same orientation like we are trying to
235      * set, this operation is a no-op to not confuse the user */
236     if (parent->orientation == orientation &&
237         TAILQ_NEXT(con, nodes) == TAILQ_END(&(parent->nodes_head))) {
238         DLOG("Not splitting the same way again\n");
239         return;
240     }
241
242     DLOG("Splitting in orientation %d\n", orientation);
243
244     /* 2: replace it with a new Con */
245     Con *new = con_new(NULL);
246     TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
247     TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
248     new->parent = parent;
249     new->orientation = orientation;
250
251     /* 3: add it as a child to the new Con */
252     con_attach(con, new);
253 }
254
255 /*
256  * Moves focus one level up.
257  *
258  */
259 void level_up() {
260     /* We can focus up to the workspace, but not any higher in the tree */
261     if (focused->parent->type != CT_CON &&
262         focused->parent->type != CT_WORKSPACE) {
263         printf("cannot go up\n");
264         return;
265     }
266     con_focus(focused->parent);
267 }
268
269 /*
270  * Moves focus one level down.
271  *
272  */
273 void level_down() {
274     /* Go down the focus stack of the current node */
275     Con *next = TAILQ_FIRST(&(focused->focus_head));
276     if (next == TAILQ_END(&(focused->focus_head))) {
277         printf("cannot go down\n");
278         return;
279     }
280     con_focus(next);
281 }
282
283 static void mark_unmapped(Con *con) {
284     Con *current;
285
286     con->mapped = false;
287     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
288         mark_unmapped(current);
289 }
290
291 /*
292  * Renders the tree, that is rendering all outputs using render_con() and
293  * pushing the changes to X11 using x_push_changes().
294  *
295  */
296 void tree_render() {
297     if (croot == NULL)
298         return;
299
300     printf("-- BEGIN RENDERING --\n");
301     /* Reset map state for all nodes in tree */
302     /* TODO: a nicer method to walk all nodes would be good, maybe? */
303     mark_unmapped(croot);
304     croot->mapped = true;
305
306     /* We start rendering at an output */
307     Con *output;
308     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
309         printf("output %p / %s\n", output, output->name);
310         render_con(output);
311     }
312     x_push_changes(croot);
313     printf("-- END RENDERING --\n");
314 }
315
316 /*
317  * Changes focus in the given way (next/previous) and given orientation
318  * (horizontal/vertical).
319  *
320  */
321 void tree_next(char way, orientation_t orientation) {
322     /* 1: get the first parent with the same orientation */
323     Con *parent = focused->parent;
324     while (parent->orientation != orientation) {
325         LOG("need to go one level further up\n");
326         /* if the current parent is an output, we are at a workspace
327          * and the orientation still does not match */
328         if (parent->type == CT_WORKSPACE)
329             return;
330         parent = parent->parent;
331     }
332     Con *current = TAILQ_FIRST(&(parent->focus_head));
333     assert(current != TAILQ_END(&(parent->focus_head)));
334
335     /* 2: chose next (or previous) */
336     Con *next;
337     if (way == 'n') {
338         next = TAILQ_NEXT(current, nodes);
339         /* if we are at the end of the list, we need to wrap */
340         if (next == TAILQ_END(&(parent->nodes_head)))
341             next = TAILQ_FIRST(&(parent->nodes_head));
342     } else {
343         next = TAILQ_PREV(current, nodes_head, nodes);
344         /* if we are at the end of the list, we need to wrap */
345         if (next == TAILQ_END(&(parent->nodes_head)))
346             next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
347     }
348
349     /* 3: focus choice comes in here. at the moment we will go down
350      * until we find a window */
351     /* TODO: check for window, atm we only go down as far as possible */
352     while (!TAILQ_EMPTY(&(next->focus_head)))
353         next = TAILQ_FIRST(&(next->focus_head));
354
355     con_focus(next);
356 }
357
358 /*
359  * Moves the current container in the given way (next/previous) and given
360  * orientation (horizontal/vertical).
361  *
362  */
363 void tree_move(char way, orientation_t orientation) {
364     /* 1: get the first parent with the same orientation */
365     Con *parent = focused->parent;
366     if (focused->type == CT_WORKSPACE)
367         return;
368     bool level_changed = false;
369     while (parent->orientation != orientation) {
370         LOG("need to go one level further up\n");
371         /* if the current parent is an output, we are at a workspace
372          * and the orientation still does not match */
373         if (parent->type == CT_WORKSPACE)
374             return;
375         parent = parent->parent;
376         level_changed = true;
377     }
378     Con *current = TAILQ_FIRST(&(parent->focus_head));
379     assert(current != TAILQ_END(&(parent->focus_head)));
380
381     /* 2: chose next (or previous) */
382     Con *next = current;
383     if (way == 'n') {
384         LOG("i would insert it after %p / %s\n", next, next->name);
385         if (!level_changed) {
386             next = TAILQ_NEXT(next, nodes);
387             if (next == TAILQ_END(&(next->parent->nodes_head))) {
388                 LOG("cannot move further to the right\n");
389                 return;
390             }
391
392             /* if this is a split container, we need to go down */
393             while (!TAILQ_EMPTY(&(next->focus_head)))
394                 next = TAILQ_FIRST(&(next->focus_head));
395         }
396
397         con_detach(focused);
398         focused->parent = next->parent;
399
400         TAILQ_INSERT_AFTER(&(next->parent->nodes_head), next, focused, nodes);
401         TAILQ_INSERT_HEAD(&(next->parent->focus_head), focused, focused);
402         /* TODO: don’t influence focus handling? */
403     } else {
404         LOG("i would insert it before %p / %s\n", current, current->name);
405         bool gone_down = false;
406         if (!level_changed) {
407             next = TAILQ_PREV(next, nodes_head, nodes);
408             if (next == TAILQ_END(&(next->parent->nodes_head))) {
409                 LOG("cannot move further\n");
410                 return;
411             }
412
413             /* if this is a split container, we need to go down */
414             while (!TAILQ_EMPTY(&(next->focus_head))) {
415                 gone_down = true;
416                 next = TAILQ_FIRST(&(next->focus_head));
417             }
418         }
419
420         con_detach(focused);
421         focused->parent = next->parent;
422
423         /* After going down in the tree, we insert the container *after*
424          * the currently focused one even though the command used "before".
425          * This is to keep the user experience clear, since the before/after
426          * only signifies the direction of the movement on top-level */
427         if (gone_down)
428             TAILQ_INSERT_AFTER(&(next->parent->nodes_head), next, focused, nodes);
429         else TAILQ_INSERT_BEFORE(next, focused, nodes);
430         TAILQ_INSERT_HEAD(&(next->parent->focus_head), focused, focused);
431         /* TODO: don’t influence focus handling? */
432     }
433 }