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, xcb_get_geometry_reply_t *geometry) {
  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, NULL);
  27     croot->rect = (Rect){
  28         geometry->x,
  29         geometry->y,
  30         geometry->width,
  31         geometry->height
  32     };
  33     focused = croot;
  34
  35     tree_append_json(globbed);
  36
  37     printf("appended tree, using new root\n");
  38     croot = TAILQ_FIRST(&(croot->nodes_head));
  39     printf("new root = %p\n", croot);
  40     Con *out = TAILQ_FIRST(&(croot->nodes_head));
  41     printf("out = %p\n", out);
  42     Con *ws = TAILQ_FIRST(&(out->nodes_head));
  43     printf("ws = %p\n", ws);
  44
  45     return true;
  46 }
  47
  48 /*
  49  * Initializes the tree by creating the root node. The CT_OUTPUT Cons below the
  50  * root node are created in randr.c for each Output.
  51  *
  52  */
  53 void tree_init(xcb_get_geometry_reply_t *geometry) {
  54     croot = con_new(NULL, NULL);
  55     FREE(croot->name);
  56     croot->name = "root";
  57     croot->type = CT_ROOT;
  58     croot->rect = (Rect){
  59         geometry->x,
  60         geometry->y,
  61         geometry->width,
  62         geometry->height
  63     };
  64 }
  65
  66 /*
  67  * Opens an empty container in the current container
  68  *
  69  */
  70 Con *tree_open_con(Con *con, i3Window *window) {
  71     if (con == NULL) {
  72         /* every focusable Con has a parent (outputs have parent root) */
  73         con = focused->parent;
  74         /* If the parent is an output, we are on a workspace. In this case,
  75          * the new container needs to be opened as a leaf of the workspace. */
  76         if (con->parent->type == CT_OUTPUT && con->type != CT_DOCKAREA) {
  77             con = focused;
  78         }
  79
  80         /* If the currently focused container is a floating container, we
  81          * attach the new container to the currently focused spot in its
  82          * workspace. */
  83         if (con->type == CT_FLOATING_CON) {
  84             con = con_descend_tiling_focused(con->parent);
  85             if (con->type != CT_WORKSPACE)
  86                 con = con->parent;
  87         }
  88         DLOG("con = %p\n", con);
  89     }
  90
  91     assert(con != NULL);
  92
  93     /* 3. create the container and attach it to its parent */
  94     Con *new = con_new(con, window);
  95
  96     /* 4: re-calculate child->percent for each child */
  97     con_fix_percent(con);
  98
  99     return new;
 100 }
 101
 102 static bool _is_con_mapped(Con *con) {
 103     Con *child;
 104
 105     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
 106         if (_is_con_mapped(child))
 107             return true;
 108
 109     return con->mapped;
 110 }
 111
 112 /*
 113  * Closes the given container including all children.
 114  * Returns true if the container was killed or false if just WM_DELETE was sent
 115  * and the window is expected to kill itself.
 116  *
 117  */
 118 bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent) {
 119     bool was_mapped = con->mapped;
 120     Con *parent = con->parent;
 121
 122     if (!was_mapped) {
 123         /* Even if the container itself is not mapped, its children may be
 124          * mapped (for example split containers don't have a mapped window on
 125          * their own but usually contain mapped children). */
 126         was_mapped = _is_con_mapped(con);
 127     }
 128
 129     /* Get the container which is next focused */
 130     Con *next = con_next_focused(con);
 131     DLOG("next = %p, focused = %p\n", next, focused);
 132
 133     DLOG("closing %p, kill_window = %d\n", con, kill_window);
 134     Con *child, *nextchild;
 135     bool abort_kill = false;
 136     /* We cannot use TAILQ_FOREACH because the children get deleted
 137      * in their parent’s nodes_head */
 138     for (child = TAILQ_FIRST(&(con->nodes_head)); child; ) {
 139         nextchild = TAILQ_NEXT(child, nodes);
 140         DLOG("killing child=%p\n", child);
 141         if (!tree_close(child, kill_window, true))
 142             abort_kill = true;
 143         child = nextchild;
 144     }
 145
 146     if (abort_kill) {
 147         DLOG("One of the children could not be killed immediately (WM_DELETE sent), aborting.\n");
 148         return false;
 149     }
 150
 151     if (con->window != NULL) {
 152         if (kill_window != DONT_KILL_WINDOW) {
 153             x_window_kill(con->window->id, kill_window);
 154             return false;
 155         } else {
 156             xcb_void_cookie_t cookie;
 157             /* un-parent the window */
 158             cookie = xcb_reparent_window(conn, con->window->id, root, 0, 0);
 159
 160             /* Ignore X11 errors for the ReparentWindow request.
 161              * X11 Errors are returned when the window was already destroyed */
 162             add_ignore_event(cookie.sequence, 0);
 163
 164             /* We are no longer handling this window, thus set WM_STATE to
 165              * WM_STATE_WITHDRAWN (see ICCCM 4.1.3.1) */
 166             long data[] = { XCB_ICCCM_WM_STATE_WITHDRAWN, XCB_NONE };
 167             cookie = xcb_change_property(conn, XCB_PROP_MODE_REPLACE,
 168                         con->window->id, A_WM_STATE, A_WM_STATE, 32, 2, data);
 169
 170             /* Ignore X11 errors for the ReparentWindow request.
 171              * X11 Errors are returned when the window was already destroyed */
 172             add_ignore_event(cookie.sequence, 0);
 173         }
 174         FREE(con->window->class_class);
 175         FREE(con->window->class_instance);
 176         FREE(con->window->name_x);
 177         FREE(con->window->name_json);
 178         free(con->window);
 179     }
 180
 181     /* kill the X11 part of this container */
 182     x_con_kill(con);
 183
 184     con_detach(con);
 185     if (con->type != CT_FLOATING_CON) {
 186         /* If the container is *not* floating, we might need to re-distribute
 187          * percentage values for the resized containers. */
 188         con_fix_percent(parent);
 189     }
 190
 191     if (con_is_floating(con)) {
 192         Con *ws = con_get_workspace(con);
 193         DLOG("Container was floating, killing floating container\n");
 194         tree_close(parent, DONT_KILL_WINDOW, false);
 195         DLOG("parent container killed\n");
 196         if (con == focused) {
 197             DLOG("This is the focused container, i need to find another one to focus. I start looking at ws = %p\n", ws);
 198             /* go down the focus stack as far as possible */
 199             next = con_descend_focused(ws);
 200
 201             dont_kill_parent = true;
 202             DLOG("Alright, focusing %p\n", next);
 203         } else {
 204             next = NULL;
 205         }
 206     }
 207
 208     free(con->name);
 209     FREE(con->deco_render_params);
 210     TAILQ_REMOVE(&all_cons, con, all_cons);
 211     free(con);
 212
 213     /* in the case of floating windows, we already focused another container
 214      * when closing the parent, so we can exit now. */
 215     if (!next) {
 216         DLOG("No next container, i will just exit now\n");
 217         return true;
 218     }
 219
 220     if (was_mapped || con == focused) {
 221         if ((kill_window != DONT_KILL_WINDOW) || !dont_kill_parent || con == focused) {
 222             DLOG("focusing %p / %s\n", next, next->name);
 223             /* TODO: check if the container (or one of its children) was focused */
 224             if (next->type == CT_DOCKAREA) {
 225                 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
 226                 con_focus(con_descend_focused(output_get_content(next->parent)));
 227             } else {
 228                 con_focus(next);
 229             }
 230         }
 231         else {
 232             DLOG("not focusing because we're not killing anybody");
 233         }
 234     } else {
 235         DLOG("not focusing, was not mapped\n");
 236     }
 237
 238     /* check if the parent container is empty now and close it */
 239     if (!dont_kill_parent)
 240         CALL(parent, on_remove_child);
 241
 242     return true;
 243 }
 244
 245 /*
 246  * Closes the current container using tree_close().
 247  *
 248  */
 249 void tree_close_con(kill_window_t kill_window) {
 250     assert(focused != NULL);
 251     if (focused->type == CT_WORKSPACE) {
 252         LOG("Cannot close workspace\n");
 253         return;
 254     }
 255
 256     /* There *should* be no possibility to focus outputs / root container */
 257     assert(focused->type != CT_OUTPUT);
 258     assert(focused->type != CT_ROOT);
 259
 260     /* Kill con */
 261     tree_close(focused, kill_window, false);
 262 }
 263
 264 /*
 265  * Splits (horizontally or vertically) the given container by creating a new
 266  * container which contains the old one and the future ones.
 267  *
 268  */
 269 void tree_split(Con *con, orientation_t orientation) {
 270     /* for a workspace, we just need to change orientation */
 271     if (con->type == CT_WORKSPACE) {
 272         DLOG("Workspace, simply changing orientation to %d\n", orientation);
 273         con->orientation = orientation;
 274         return;
 275     }
 276
 277     Con *parent = con->parent;
 278     /* if we are in a container whose parent contains only one
 279      * child (its split functionality is unused so far), we just change the
 280      * orientation (more intuitive than splitting again) */
 281     if (con_num_children(parent) == 1) {
 282         parent->orientation = orientation;
 283         DLOG("Just changing orientation of existing container\n");
 284         return;
 285     }
 286
 287     DLOG("Splitting in orientation %d\n", orientation);
 288
 289     /* 2: replace it with a new Con */
 290     Con *new = con_new(NULL, NULL);
 291     TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
 292     TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
 293     new->parent = parent;
 294     new->orientation = orientation;
 295
 296     /* 3: swap 'percent' (resize factor) */
 297     new->percent = con->percent;
 298     con->percent = 0.0;
 299
 300     /* 4: add it as a child to the new Con */
 301     con_attach(con, new, false);
 302 }
 303
 304 /*
 305  * Moves focus one level up.
 306  *
 307  */
 308 void level_up() {
 309     /* We cannot go up when we are in fullscreen mode at the moment, that would
 310      * be totally not intuitive */
 311     if (focused->fullscreen_mode != CF_NONE) {
 312         LOG("Currently in fullscreen, not going up\n");
 313         return;
 314     }
 315     /* We can focus up to the workspace, but not any higher in the tree */
 316     if ((focused->parent->type != CT_CON &&
 317         focused->parent->type != CT_WORKSPACE) ||
 318         focused->type == CT_WORKSPACE) {
 319         LOG("Cannot go up any further\n");
 320         return;
 321     }
 322     con_focus(focused->parent);
 323 }
 324
 325 /*
 326  * Moves focus one level down.
 327  *
 328  */
 329 void level_down() {
 330     /* Go down the focus stack of the current node */
 331     Con *next = TAILQ_FIRST(&(focused->focus_head));
 332     if (next == TAILQ_END(&(focused->focus_head))) {
 333         printf("cannot go down\n");
 334         return;
 335     }
 336     con_focus(next);
 337 }
 338
 339 static void mark_unmapped(Con *con) {
 340     Con *current;
 341
 342     con->mapped = false;
 343     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
 344         mark_unmapped(current);
 345     if (con->type == CT_WORKSPACE) {
 346         /* We need to call mark_unmapped on floating nodes aswell since we can
 347          * make containers floating. */
 348         TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 349             mark_unmapped(current);
 350     }
 351 }
 352
 353 /*
 354  * Renders the tree, that is rendering all outputs using render_con() and
 355  * pushing the changes to X11 using x_push_changes().
 356  *
 357  */
 358 void tree_render() {
 359     if (croot == NULL)
 360         return;
 361
 362     DLOG("-- BEGIN RENDERING --\n");
 363     /* Reset map state for all nodes in tree */
 364     /* TODO: a nicer method to walk all nodes would be good, maybe? */
 365     mark_unmapped(croot);
 366     croot->mapped = true;
 367
 368     render_con(croot, false);
 369
 370     x_push_changes(croot);
 371     DLOG("-- END RENDERING --\n");
 372 }
 373
 374 /*
 375  * Recursive function to walk the tree until a con can be found to focus.
 376  *
 377  */
 378 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
 379     /* Stop recursing at workspaces after attempting to switch to next
 380      * workspace if possible. */
 381     if (con->type == CT_WORKSPACE) {
 382         Output *current_output = get_output_containing(con->rect.x, con->rect.y);
 383         Output *next_output;
 384
 385         if (!current_output)
 386             return false;
 387         DLOG("Current output is %s\n", current_output->name);
 388
 389         /* Try to find next output */
 390         direction_t direction;
 391         if (way == 'n' && orientation == HORIZ)
 392             direction = D_RIGHT;
 393         else if (way == 'p' && orientation == HORIZ)
 394             direction = D_LEFT;
 395         else if (way == 'n' && orientation == VERT)
 396             direction = D_DOWN;
 397         else if (way == 'p' && orientation == VERT)
 398             direction = D_UP;
 399         else
 400             return false;
 401
 402         next_output = get_output_next(direction, current_output);
 403         if (!next_output)
 404             return false;
 405         DLOG("Next output is %s\n", next_output->name);
 406
 407         /* Find visible workspace on next output */
 408         Con *workspace = NULL;
 409         GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
 410
 411         /* Show next workspace and focus appropriate container if possible. */
 412         if (!workspace)
 413             return false;
 414
 415         workspace_show(workspace->name);
 416         Con *focus = con_descend_direction(workspace, direction);
 417         if (focus) {
 418             con_focus(focus);
 419             x_set_warp_to(&(focus->rect));
 420         }
 421         return true;
 422     }
 423
 424     if (con->type == CT_FLOATING_CON) {
 425         /* TODO: implement focus for floating windows */
 426         return false;
 427     }
 428
 429     Con *parent = con->parent;
 430
 431     /* If the orientation does not match or there is no other con to focus, we
 432      * need to go higher in the hierarchy */
 433     if (con_orientation(parent) != orientation ||
 434         con_num_children(parent) == 1)
 435         return _tree_next(parent, way, orientation, wrap);
 436
 437     Con *current = TAILQ_FIRST(&(parent->focus_head));
 438     /* TODO: when can the following happen (except for floating windows, which
 439      * are handled above)? */
 440     if (TAILQ_EMPTY(&(parent->nodes_head))) {
 441         DLOG("nothing to focus\n");
 442         return false;
 443     }
 444
 445     Con *next;
 446     if (way == 'n')
 447         next = TAILQ_NEXT(current, nodes);
 448     else next = TAILQ_PREV(current, nodes_head, nodes);
 449
 450     if (!next) {
 451         if (!config.force_focus_wrapping) {
 452             /* If there is no next/previous container, we check if we can focus one
 453              * when going higher (without wrapping, though). If so, we are done, if
 454              * not, we wrap */
 455             if (_tree_next(parent, way, orientation, false))
 456                 return true;
 457
 458             if (!wrap)
 459                 return false;
 460         }
 461
 462         if (way == 'n')
 463             next = TAILQ_FIRST(&(parent->nodes_head));
 464         else next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
 465     }
 466
 467     /* 3: focus choice comes in here. at the moment we will go down
 468      * until we find a window */
 469     /* TODO: check for window, atm we only go down as far as possible */
 470     con_focus(con_descend_focused(next));
 471     return true;
 472 }
 473
 474 /*
 475  * Changes focus in the given way (next/previous) and given orientation
 476  * (horizontal/vertical).
 477  *
 478  */
 479 void tree_next(char way, orientation_t orientation) {
 480     _tree_next(focused, way, orientation, true);
 481 }
 482
 483 /*
 484  * tree_flatten() removes pairs of redundant split containers, e.g.:
 485  *       [workspace, horizontal]
 486  *   [v-split]           [child3]
 487  *   [h-split]
 488  * [child1] [child2]
 489  * In this example, the v-split and h-split container are redundant.
 490  * Such a situation can be created by moving containers in a direction which is
 491  * not the orientation of their parent container. i3 needs to create a new
 492  * split container then and if you move containers this way multiple times,
 493  * redundant chains of split-containers can be the result.
 494  *
 495  */
 496 void tree_flatten(Con *con) {
 497     Con *current, *child, *parent = con->parent;
 498     DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
 499
 500     /* We only consider normal containers without windows */
 501     if (con->type != CT_CON || con->window != NULL)
 502         goto recurse;
 503
 504     /* Ensure it got only one child */
 505     child = TAILQ_FIRST(&(con->nodes_head));
 506     if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
 507         goto recurse;
 508
 509     /* The child must have a different orientation than the con but the same as
 510      * the con’s parent to be redundant */
 511     if (con->orientation == NO_ORIENTATION ||
 512         child->orientation == NO_ORIENTATION ||
 513         con->orientation == child->orientation ||
 514         child->orientation != parent->orientation)
 515         goto recurse;
 516
 517     DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
 518     /* 1: save focus */
 519     Con *focus_next = TAILQ_FIRST(&(child->focus_head));
 520
 521     DLOG("detaching...\n");
 522     /* 2: re-attach the children to the parent before con */
 523     while (!TAILQ_EMPTY(&(child->nodes_head))) {
 524         current = TAILQ_FIRST(&(child->nodes_head));
 525         DLOG("detaching current=%p / %s\n", current, current->name);
 526         con_detach(current);
 527         DLOG("re-attaching\n");
 528         /* We don’t use con_attach() here because for a CT_CON, the special
 529          * case handling of con_attach() does not trigger. So all it would do
 530          * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
 531          * directly use the TAILQ macros. */
 532         current->parent = parent;
 533         TAILQ_INSERT_BEFORE(con, current, nodes);
 534         DLOG("attaching to focus list\n");
 535         TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
 536         current->percent = con->percent;
 537     }
 538     DLOG("re-attached all\n");
 539
 540     /* 3: restore focus, if con was focused */
 541     if (focus_next != NULL &&
 542         TAILQ_FIRST(&(parent->focus_head)) == con) {
 543         DLOG("restoring focus to focus_next=%p\n", focus_next);
 544         TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
 545         TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
 546         DLOG("restored focus.\n");
 547     }
 548
 549     /* 4: close the redundant cons */
 550     DLOG("closing redundant cons\n");
 551     tree_close(con, DONT_KILL_WINDOW, true);
 552
 553     /* Well, we got to abort the recursion here because we destroyed the
 554      * container. However, if tree_flatten() is called sufficiently often,
 555      * there can’t be the situation of having two pairs of redundant containers
 556      * at once. Therefore, we can safely abort the recursion on this level
 557      * after flattening. */
 558     return;
 559
 560 recurse:
 561     /* We cannot use normal foreach here because tree_flatten might close the
 562      * current container. */
 563     current = TAILQ_FIRST(&(con->nodes_head));
 564     while (current != NULL) {
 565         Con *next = TAILQ_NEXT(current, nodes);
 566         tree_flatten(current);
 567         current = next;
 568     }
 569
 570     current = TAILQ_FIRST(&(con->floating_head));
 571     while (current != NULL) {
 572         Con *next = TAILQ_NEXT(current, floating_windows);
 573         tree_flatten(current);
 574         current = next;
 575     }
 576 }