git.sur5r.net Git - i3/i3/blob - 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(const char *path) {
  17     char *globbed = resolve_tilde(path);
  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
  31     printf("appended tree, using new root\n");
  32     croot = TAILQ_FIRST(&(croot->nodes_head));
  33     printf("new root = %p\n", croot);
  34     Con *out = TAILQ_FIRST(&(croot->nodes_head));
  35     printf("out = %p\n", out);
  36     Con *ws = TAILQ_FIRST(&(out->nodes_head));
  37     printf("ws = %p\n", ws);
  38
  39     return true;
  40 }
  41
  42 /*
  43  * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
  44  * root node are created in randr.c for each Output.
  45  *
  46  */
  47 void tree_init() {
  48     croot = con_new(NULL);
  49     FREE(croot->name);
  50     croot->name = "root";
  51     croot->type = CT_ROOT;
  52 }
  53
  54 /*
  55  * Opens an empty container in the current container
  56  *
  57  */
  58 Con *tree_open_con(Con *con) {
  59     if (con == NULL) {
  60         /* every focusable Con has a parent (outputs have parent root) */
  61         con = focused->parent;
  62         /* If the parent is an output, we are on a workspace. In this case,
  63          * the new container needs to be opened as a leaf of the workspace. */
  64         if (con->type == CT_OUTPUT)
  65             con = focused;
  66         /* If the currently focused container is a floating container, we
  67          * attach the new container to the workspace */
  68         if (con->type == CT_FLOATING_CON)
  69             con = con->parent;
  70     }
  71
  72     assert(con != NULL);
  73
  74     /* 3. create the container and attach it to its parent */
  75     Con *new = con_new(con);
  76
  77     /* 4: re-calculate child->percent for each child */
  78     con_fix_percent(con);
  79
  80     /* 5: focus the new container */
  81     con_focus(new);
  82
  83     return new;
  84 }
  85
  86 static bool _is_con_mapped(Con *con) {
  87     Con *child;
  88
  89     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
  90         if (_is_con_mapped(child))
  91             return true;
  92
  93     return con->mapped;
  94 }
  95
  96 /*
  97  * Closes the given container including all children
  98  *
  99  */
 100 void tree_close(Con *con, bool kill_window, bool dont_kill_parent) {
 101     bool was_mapped = con->mapped;
 102     Con *parent = con->parent;
 103
 104     if (!was_mapped) {
 105         /* Even if the container itself is not mapped, its children may be
 106          * mapped (for example split containers don't have a mapped window on
 107          * their own but usually contain mapped children). */
 108         was_mapped = _is_con_mapped(con);
 109     }
 110
 111     /* Get the container which is next focused */
 112     Con *next = con_next_focused(con);
 113     DLOG("next = %p, focused = %p\n", next, focused);
 114
 115     DLOG("closing %p, kill_window = %d\n", con, kill_window);
 116     Con *child;
 117     /* We cannot use TAILQ_FOREACH because the children get deleted
 118      * in their parent’s nodes_head */
 119     while (!TAILQ_EMPTY(&(con->nodes_head))) {
 120         child = TAILQ_FIRST(&(con->nodes_head));
 121         DLOG("killing child=%p\n", child);
 122         tree_close(child, kill_window, true);
 123     }
 124
 125     if (con->window != NULL) {
 126         if (kill_window)
 127             x_window_kill(con->window->id);
 128         else {
 129             /* un-parent the window */
 130             xcb_reparent_window(conn, con->window->id, root, 0, 0);
 131             /* TODO: client_unmap to set state to withdrawn */
 132
 133         }
 134         FREE(con->window->class_class);
 135         FREE(con->window->class_instance);
 136         FREE(con->window->name_x);
 137         FREE(con->window->name_json);
 138         free(con->window);
 139     }
 140
 141     /* kill the X11 part of this container */
 142     x_con_kill(con);
 143
 144     con_detach(con);
 145     if (con->type != CT_FLOATING_CON) {
 146         /* If the container is *not* floating, we might need to re-distribute
 147          * percentage values for the resized containers. */
 148         con_fix_percent(parent);
 149     }
 150
 151     if (con_is_floating(con)) {
 152         Con *ws = con_get_workspace(con);
 153         DLOG("Container was floating, killing floating container\n");
 154         tree_close(parent, false, false);
 155         DLOG("parent container killed\n");
 156         if (con == focused) {
 157             DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
 158             /* go down the focus stack as far as possible */
 159             next = con_descend_focused(ws);
 160
 161             dont_kill_parent = true;
 162             DLOG("Alright, focusing %p\n", next);
 163         } else {
 164             next = NULL;
 165         }
 166     }
 167
 168     free(con->name);
 169     TAILQ_REMOVE(&all_cons, con, all_cons);
 170     free(con);
 171
 172     /* in the case of floating windows, we already focused another container
 173      * when closing the parent, so we can exit now. */
 174     if (!next) {
 175         DLOG("No next container, i will just exit now\n");
 176         return;
 177     }
 178
 179     if (was_mapped || con == focused) {
 180         if (kill_window || !dont_kill_parent || con == focused) {
 181             DLOG("focusing %p / %s\n", next, next->name);
 182             /* TODO: check if the container (or one of its children) was focused */
 183             con_focus(next);
 184         }
 185         else {
 186             DLOG("not focusing because we're not killing anybody");
 187         }
 188     } else {
 189         DLOG("not focusing, was not mapped\n");
 190     }
 191
 192     /* check if the parent container is empty now and close it */
 193     if (!dont_kill_parent)
 194         CALL(parent, on_remove_child);
 195 }
 196
 197 /*
 198  * Closes the current container using tree_close().
 199  *
 200  */
 201 void tree_close_con() {
 202     assert(focused != NULL);
 203     if (focused->type == CT_WORKSPACE) {
 204         LOG("Cannot close workspace\n");
 205         return;
 206     }
 207
 208     /* There *should* be no possibility to focus outputs / root container */
 209     assert(focused->type != CT_OUTPUT);
 210     assert(focused->type != CT_ROOT);
 211
 212     /* Kill con */
 213     tree_close(focused, true, false);
 214 }
 215
 216 /*
 217  * Splits (horizontally or vertically) the given container by creating a new
 218  * container which contains the old one and the future ones.
 219  *
 220  */
 221 void tree_split(Con *con, orientation_t orientation) {
 222     /* for a workspace, we just need to change orientation */
 223     if (con->type == CT_WORKSPACE) {
 224         DLOG("Workspace, simply changing orientation to %d\n", orientation);
 225         con->orientation = orientation;
 226         return;
 227     }
 228
 229     Con *parent = con->parent;
 230     /* if we are in a container whose parent contains only one
 231      * child (its split functionality is unused so far), we just change the
 232      * orientation (more intuitive than splitting again) */
 233     if (con_num_children(parent) == 1) {
 234         parent->orientation = orientation;
 235         DLOG("Just changing orientation of existing container\n");
 236         return;
 237     }
 238
 239     DLOG("Splitting in orientation %d\n", orientation);
 240
 241     /* 2: replace it with a new Con */
 242     Con *new = con_new(NULL);
 243     TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
 244     TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
 245     new->parent = parent;
 246     new->orientation = orientation;
 247
 248     /* 3: swap 'percent' (resize factor) */
 249     new->percent = con->percent;
 250     con->percent = 0.0;
 251
 252     /* 4: add it as a child to the new Con */
 253     con_attach(con, new, false);
 254 }
 255
 256 /*
 257  * Moves focus one level up.
 258  *
 259  */
 260 void level_up() {
 261     /* We can focus up to the workspace, but not any higher in the tree */
 262     if (focused->parent->type != CT_CON &&
 263         focused->parent->type != CT_WORKSPACE) {
 264         printf("cannot go up\n");
 265         return;
 266     }
 267     con_focus(focused->parent);
 268 }
 269
 270 /*
 271  * Moves focus one level down.
 272  *
 273  */
 274 void level_down() {
 275     /* Go down the focus stack of the current node */
 276     Con *next = TAILQ_FIRST(&(focused->focus_head));
 277     if (next == TAILQ_END(&(focused->focus_head))) {
 278         printf("cannot go down\n");
 279         return;
 280     }
 281     con_focus(next);
 282 }
 283
 284 static void mark_unmapped(Con *con) {
 285     Con *current;
 286
 287     con->mapped = false;
 288     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
 289         mark_unmapped(current);
 290     if (con->type == CT_WORKSPACE) {
 291         /* We need to call mark_unmapped on floating nodes aswell since we can
 292          * make containers floating. */
 293         TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 294             mark_unmapped(current);
 295     }
 296 }
 297
 298 /*
 299  * Renders the tree, that is rendering all outputs using render_con() and
 300  * pushing the changes to X11 using x_push_changes().
 301  *
 302  */
 303 void tree_render() {
 304     if (croot == NULL)
 305         return;
 306
 307     DLOG("-- BEGIN RENDERING --\n");
 308     /* Reset map state for all nodes in tree */
 309     /* TODO: a nicer method to walk all nodes would be good, maybe? */
 310     mark_unmapped(croot);
 311     croot->mapped = true;
 312
 313     /* We start rendering at an output */
 314     Con *output;
 315     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 316         DLOG("output %p / %s\n", output, output->name);
 317         render_con(output, false);
 318     }
 319     x_push_changes(croot);
 320     DLOG("-- END RENDERING --\n");
 321 }
 322
 323 /*
 324  * Changes focus in the given way (next/previous) and given orientation
 325  * (horizontal/vertical).
 326  *
 327  */
 328 void tree_next(char way, orientation_t orientation) {
 329     /* 1: get the first parent with the same orientation */
 330     Con *parent = focused->parent;
 331     while (focused->type != CT_WORKSPACE &&
 332            con_orientation(parent) != orientation) {
 333         LOG("need to go one level further up\n");
 334         /* if the current parent is an output, we are at a workspace
 335          * and the orientation still does not match */
 336         if (parent->type == CT_WORKSPACE)
 337             return;
 338         parent = parent->parent;
 339     }
 340     Con *current = TAILQ_FIRST(&(parent->focus_head));
 341     assert(current != TAILQ_END(&(parent->focus_head)));
 342
 343     if (TAILQ_EMPTY(&(parent->nodes_head))) {
 344         DLOG("Nothing to focus here, move along...\n");
 345         return;
 346     }
 347
 348     /* 2: chose next (or previous) */
 349     Con *next;
 350     if (way == 'n') {
 351         next = TAILQ_NEXT(current, nodes);
 352         /* if we are at the end of the list, we need to wrap */
 353         if (next == TAILQ_END(&(parent->nodes_head)))
 354             next = TAILQ_FIRST(&(parent->nodes_head));
 355     } else {
 356         next = TAILQ_PREV(current, nodes_head, nodes);
 357         /* if we are at the end of the list, we need to wrap */
 358         if (next == TAILQ_END(&(parent->nodes_head)))
 359             next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
 360     }
 361
 362     /* 3: focus choice comes in here. at the moment we will go down
 363      * until we find a window */
 364     /* TODO: check for window, atm we only go down as far as possible */
 365     con_focus(con_descend_focused(next));
 366 }
 367
 368 /*
 369  * tree_flatten() removes pairs of redundant split containers, e.g.:
 370  *       [workspace, horizontal]
 371  *   [v-split]           [child3]
 372  *   [h-split]
 373  * [child1] [child2]
 374  * In this example, the v-split and h-split container are redundant.
 375  * Such a situation can be created by moving containers in a direction which is
 376  * not the orientation of their parent container. i3 needs to create a new
 377  * split container then and if you move containers this way multiple times,
 378  * redundant chains of split-containers can be the result.
 379  *
 380  */
 381 void tree_flatten(Con *con) {
 382     Con *current, *child, *parent = con->parent;
 383     DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
 384
 385     /* We only consider normal containers without windows */
 386     if (con->type != CT_CON || con->window != NULL)
 387         goto recurse;
 388
 389     /* Ensure it got only one child */
 390     child = TAILQ_FIRST(&(con->nodes_head));
 391     if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
 392         goto recurse;
 393
 394     /* The child must have a different orientation than the con but the same as
 395      * the con’s parent to be redundant */
 396     if (con->orientation == NO_ORIENTATION ||
 397         child->orientation == NO_ORIENTATION ||
 398         con->orientation == child->orientation ||
 399         child->orientation != parent->orientation)
 400         goto recurse;
 401
 402     DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
 403     /* 1: save focus */
 404     Con *focus_next = TAILQ_FIRST(&(child->focus_head));
 405
 406     DLOG("detaching...\n");
 407     /* 2: re-attach the children to the parent before con */
 408     while (!TAILQ_EMPTY(&(child->nodes_head))) {
 409         current = TAILQ_FIRST(&(child->nodes_head));
 410         DLOG("detaching current=%p / %s\n", current, current->name);
 411         con_detach(current);
 412         DLOG("re-attaching\n");
 413         /* We don’t use con_attach() here because for a CT_CON, the special
 414          * case handling of con_attach() does not trigger. So all it would do
 415          * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
 416          * directly use the TAILQ macros. */
 417         current->parent = parent;
 418         TAILQ_INSERT_BEFORE(con, current, nodes);
 419         DLOG("attaching to focus list\n");
 420         TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
 421         current->percent = con->percent;
 422     }
 423     DLOG("re-attached all\n");
 424
 425     /* 3: restore focus, if con was focused */
 426     if (focus_next != NULL &&
 427         TAILQ_FIRST(&(parent->focus_head)) == con) {
 428         DLOG("restoring focus to focus_next=%p\n", focus_next);
 429         TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
 430         TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
 431         DLOG("restored focus.\n");
 432     }
 433
 434     /* 4: close the redundant cons */
 435     DLOG("closing redundant cons\n");
 436     tree_close(con, false, true);
 437
 438     /* Well, we got to abort the recursion here because we destroyed the
 439      * container. However, if tree_flatten() is called sufficiently often,
 440      * there can’t be the situation of having two pairs of redundant containers
 441      * at once. Therefore, we can safely abort the recursion on this level
 442      * after flattening. */
 443     return;
 444
 445 recurse:
 446     /* We cannot use normal foreach here because tree_flatten might close the
 447      * current container. */
 448     current = TAILQ_FIRST(&(con->nodes_head));
 449     while (current != NULL) {
 450         Con *next = TAILQ_NEXT(current, nodes);
 451         tree_flatten(current);
 452         current = next;
 453     }
 454
 455     current = TAILQ_FIRST(&(con->floating_head));
 456     while (current != NULL) {
 457         Con *next = TAILQ_NEXT(current, floating_windows);
 458         tree_flatten(current);
 459         current = next;
 460     }
 461 }