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->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
  65             con = focused;
  66         }
  67
  68         /* If the currently focused container is a floating container, we
  69          * attach the new container to the workspace */
  70         if (con->type == CT_FLOATING_CON)
  71             con = con->parent;
  72         DLOG("con = %p\n", con);
  73     }
  74
  75     assert(con != NULL);
  76
  77     /* 3. create the container and attach it to its parent */
  78     Con *new = con_new(con);
  79
  80     /* 4: re-calculate child->percent for each child */
  81     con_fix_percent(con);
  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             if (next->type == CT_DOCKAREA) {
 184                 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
 185                 con_focus(con_descend_focused(output_get_content(next->parent)));
 186             } else {
 187                 con_focus(next);
 188             }
 189         }
 190         else {
 191             DLOG("not focusing because we're not killing anybody");
 192         }
 193     } else {
 194         DLOG("not focusing, was not mapped\n");
 195     }
 196
 197     /* check if the parent container is empty now and close it */
 198     if (!dont_kill_parent)
 199         CALL(parent, on_remove_child);
 200 }
 201
 202 /*
 203  * Closes the current container using tree_close().
 204  *
 205  */
 206 void tree_close_con() {
 207     assert(focused != NULL);
 208     if (focused->type == CT_WORKSPACE) {
 209         LOG("Cannot close workspace\n");
 210         return;
 211     }
 212
 213     /* There *should* be no possibility to focus outputs / root container */
 214     assert(focused->type != CT_OUTPUT);
 215     assert(focused->type != CT_ROOT);
 216
 217     /* Kill con */
 218     tree_close(focused, true, false);
 219 }
 220
 221 /*
 222  * Splits (horizontally or vertically) the given container by creating a new
 223  * container which contains the old one and the future ones.
 224  *
 225  */
 226 void tree_split(Con *con, orientation_t orientation) {
 227     /* for a workspace, we just need to change orientation */
 228     if (con->type == CT_WORKSPACE) {
 229         DLOG("Workspace, simply changing orientation to %d\n", orientation);
 230         con->orientation = orientation;
 231         return;
 232     }
 233
 234     Con *parent = con->parent;
 235     /* if we are in a container whose parent contains only one
 236      * child (its split functionality is unused so far), we just change the
 237      * orientation (more intuitive than splitting again) */
 238     if (con_num_children(parent) == 1) {
 239         parent->orientation = orientation;
 240         DLOG("Just changing orientation of existing container\n");
 241         return;
 242     }
 243
 244     DLOG("Splitting in orientation %d\n", orientation);
 245
 246     /* 2: replace it with a new Con */
 247     Con *new = con_new(NULL);
 248     TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
 249     TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
 250     new->parent = parent;
 251     new->orientation = orientation;
 252
 253     /* 3: swap 'percent' (resize factor) */
 254     new->percent = con->percent;
 255     con->percent = 0.0;
 256
 257     /* 4: add it as a child to the new Con */
 258     con_attach(con, new, false);
 259 }
 260
 261 /*
 262  * Moves focus one level up.
 263  *
 264  */
 265 void level_up() {
 266     /* We can focus up to the workspace, but not any higher in the tree */
 267     if ((focused->parent->type != CT_CON &&
 268         focused->parent->type != CT_WORKSPACE) ||
 269         focused->type == CT_WORKSPACE) {
 270         printf("cannot go up\n");
 271         return;
 272     }
 273     con_focus(focused->parent);
 274 }
 275
 276 /*
 277  * Moves focus one level down.
 278  *
 279  */
 280 void level_down() {
 281     /* Go down the focus stack of the current node */
 282     Con *next = TAILQ_FIRST(&(focused->focus_head));
 283     if (next == TAILQ_END(&(focused->focus_head))) {
 284         printf("cannot go down\n");
 285         return;
 286     }
 287     con_focus(next);
 288 }
 289
 290 static void mark_unmapped(Con *con) {
 291     Con *current;
 292
 293     con->mapped = false;
 294     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
 295         mark_unmapped(current);
 296     if (con->type == CT_WORKSPACE) {
 297         /* We need to call mark_unmapped on floating nodes aswell since we can
 298          * make containers floating. */
 299         TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 300             mark_unmapped(current);
 301     }
 302 }
 303
 304 /*
 305  * Renders the tree, that is rendering all outputs using render_con() and
 306  * pushing the changes to X11 using x_push_changes().
 307  *
 308  */
 309 void tree_render() {
 310     if (croot == NULL)
 311         return;
 312
 313     DLOG("-- BEGIN RENDERING --\n");
 314     /* Reset map state for all nodes in tree */
 315     /* TODO: a nicer method to walk all nodes would be good, maybe? */
 316     mark_unmapped(croot);
 317     croot->mapped = true;
 318
 319     /* We start rendering at an output */
 320     Con *output;
 321     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 322         DLOG("output %p / %s\n", output, output->name);
 323         render_con(output, false);
 324     }
 325     x_push_changes(croot);
 326     DLOG("-- END RENDERING --\n");
 327 }
 328
 329 /*
 330  * Changes focus in the given way (next/previous) and given orientation
 331  * (horizontal/vertical).
 332  *
 333  */
 334 void tree_next(char way, orientation_t orientation) {
 335     /* 1: get the first parent with the same orientation */
 336     Con *parent = focused->parent;
 337     while (focused->type != CT_WORKSPACE &&
 338            (con_orientation(parent) != orientation ||
 339             con_num_children(parent) == 1)) {
 340         LOG("need to go one level further up\n");
 341         /* if the current parent is an output, we are at a workspace
 342          * and the orientation still does not match */
 343         if (parent->type == CT_WORKSPACE)
 344             return;
 345         parent = parent->parent;
 346     }
 347     Con *current = TAILQ_FIRST(&(parent->focus_head));
 348     assert(current != TAILQ_END(&(parent->focus_head)));
 349
 350     if (TAILQ_EMPTY(&(parent->nodes_head))) {
 351         DLOG("Nothing to focus here, move along...\n");
 352         return;
 353     }
 354
 355     /* 2: chose next (or previous) */
 356     Con *next;
 357     if (way == 'n') {
 358         next = TAILQ_NEXT(current, nodes);
 359         /* if we are at the end of the list, we need to wrap */
 360         if (next == TAILQ_END(&(parent->nodes_head)))
 361             next = TAILQ_FIRST(&(parent->nodes_head));
 362     } else {
 363         next = TAILQ_PREV(current, nodes_head, nodes);
 364         /* if we are at the end of the list, we need to wrap */
 365         if (next == TAILQ_END(&(parent->nodes_head)))
 366             next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
 367     }
 368
 369     /* 3: focus choice comes in here. at the moment we will go down
 370      * until we find a window */
 371     /* TODO: check for window, atm we only go down as far as possible */
 372     con_focus(con_descend_focused(next));
 373 }
 374
 375 /*
 376  * tree_flatten() removes pairs of redundant split containers, e.g.:
 377  *       [workspace, horizontal]
 378  *   [v-split]           [child3]
 379  *   [h-split]
 380  * [child1] [child2]
 381  * In this example, the v-split and h-split container are redundant.
 382  * Such a situation can be created by moving containers in a direction which is
 383  * not the orientation of their parent container. i3 needs to create a new
 384  * split container then and if you move containers this way multiple times,
 385  * redundant chains of split-containers can be the result.
 386  *
 387  */
 388 void tree_flatten(Con *con) {
 389     Con *current, *child, *parent = con->parent;
 390     DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
 391
 392     /* We only consider normal containers without windows */
 393     if (con->type != CT_CON || con->window != NULL)
 394         goto recurse;
 395
 396     /* Ensure it got only one child */
 397     child = TAILQ_FIRST(&(con->nodes_head));
 398     if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
 399         goto recurse;
 400
 401     /* The child must have a different orientation than the con but the same as
 402      * the con’s parent to be redundant */
 403     if (con->orientation == NO_ORIENTATION ||
 404         child->orientation == NO_ORIENTATION ||
 405         con->orientation == child->orientation ||
 406         child->orientation != parent->orientation)
 407         goto recurse;
 408
 409     DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
 410     /* 1: save focus */
 411     Con *focus_next = TAILQ_FIRST(&(child->focus_head));
 412
 413     DLOG("detaching...\n");
 414     /* 2: re-attach the children to the parent before con */
 415     while (!TAILQ_EMPTY(&(child->nodes_head))) {
 416         current = TAILQ_FIRST(&(child->nodes_head));
 417         DLOG("detaching current=%p / %s\n", current, current->name);
 418         con_detach(current);
 419         DLOG("re-attaching\n");
 420         /* We don’t use con_attach() here because for a CT_CON, the special
 421          * case handling of con_attach() does not trigger. So all it would do
 422          * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
 423          * directly use the TAILQ macros. */
 424         current->parent = parent;
 425         TAILQ_INSERT_BEFORE(con, current, nodes);
 426         DLOG("attaching to focus list\n");
 427         TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
 428         current->percent = con->percent;
 429     }
 430     DLOG("re-attached all\n");
 431
 432     /* 3: restore focus, if con was focused */
 433     if (focus_next != NULL &&
 434         TAILQ_FIRST(&(parent->focus_head)) == con) {
 435         DLOG("restoring focus to focus_next=%p\n", focus_next);
 436         TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
 437         TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
 438         DLOG("restored focus.\n");
 439     }
 440
 441     /* 4: close the redundant cons */
 442     DLOG("closing redundant cons\n");
 443     tree_close(con, false, true);
 444
 445     /* Well, we got to abort the recursion here because we destroyed the
 446      * container. However, if tree_flatten() is called sufficiently often,
 447      * there can’t be the situation of having two pairs of redundant containers
 448      * at once. Therefore, we can safely abort the recursion on this level
 449      * after flattening. */
 450     return;
 451
 452 recurse:
 453     /* We cannot use normal foreach here because tree_flatten might close the
 454      * current container. */
 455     current = TAILQ_FIRST(&(con->nodes_head));
 456     while (current != NULL) {
 457         Con *next = TAILQ_NEXT(current, nodes);
 458         tree_flatten(current);
 459         current = next;
 460     }
 461
 462     current = TAILQ_FIRST(&(con->floating_head));
 463     while (current != NULL) {
 464         Con *next = TAILQ_NEXT(current, floating_windows);
 465         tree_flatten(current);
 466         current = next;
 467     }
 468 }