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             if (next->type == CT_DOCKAREA) {
 224                 /* Instead of focusing the dockarea, we need to restore focus to the workspace */
 225                 con_focus(con_descend_focused(output_get_content(next->parent)));
 226             } else {
 227                 if (con != focused)
 228                     DLOG("not changing focus, the container was not focused before\n");
 229                 else con_focus(next);
 230             }
 231         }
 232         else {
 233             DLOG("not focusing because we're not killing anybody");
 234         }
 235     } else {
 236         DLOG("not focusing, was not mapped\n");
 237     }
 238
 239     /* check if the parent container is empty now and close it */
 240     if (!dont_kill_parent)
 241         CALL(parent, on_remove_child);
 242
 243     return true;
 244 }
 245
 246 /*
 247  * Closes the current container using tree_close().
 248  *
 249  */
 250 void tree_close_con(kill_window_t kill_window) {
 251     assert(focused != NULL);
 252     if (focused->type == CT_WORKSPACE) {
 253         LOG("Cannot close workspace\n");
 254         return;
 255     }
 256
 257     /* There *should* be no possibility to focus outputs / root container */
 258     assert(focused->type != CT_OUTPUT);
 259     assert(focused->type != CT_ROOT);
 260
 261     /* Kill con */
 262     tree_close(focused, kill_window, false);
 263 }
 264
 265 /*
 266  * Splits (horizontally or vertically) the given container by creating a new
 267  * container which contains the old one and the future ones.
 268  *
 269  */
 270 void tree_split(Con *con, orientation_t orientation) {
 271     /* for a workspace, we just need to change orientation */
 272     if (con->type == CT_WORKSPACE) {
 273         DLOG("Workspace, simply changing orientation to %d\n", orientation);
 274         con->orientation = orientation;
 275         return;
 276     }
 277
 278     Con *parent = con->parent;
 279     /* if we are in a container whose parent contains only one
 280      * child (its split functionality is unused so far), we just change the
 281      * orientation (more intuitive than splitting again) */
 282     if (con_num_children(parent) == 1) {
 283         parent->orientation = orientation;
 284         DLOG("Just changing orientation of existing container\n");
 285         return;
 286     }
 287
 288     DLOG("Splitting in orientation %d\n", orientation);
 289
 290     /* 2: replace it with a new Con */
 291     Con *new = con_new(NULL, NULL);
 292     TAILQ_REPLACE(&(parent->nodes_head), con, new, nodes);
 293     TAILQ_REPLACE(&(parent->focus_head), con, new, focused);
 294     new->parent = parent;
 295     new->orientation = orientation;
 296
 297     /* 3: swap 'percent' (resize factor) */
 298     new->percent = con->percent;
 299     con->percent = 0.0;
 300
 301     /* 4: add it as a child to the new Con */
 302     con_attach(con, new, false);
 303 }
 304
 305 /*
 306  * Moves focus one level up.
 307  *
 308  */
 309 void level_up() {
 310     /* We cannot go up when we are in fullscreen mode at the moment, that would
 311      * be totally not intuitive */
 312     if (focused->fullscreen_mode != CF_NONE) {
 313         LOG("Currently in fullscreen, not going up\n");
 314         return;
 315     }
 316     /* We can focus up to the workspace, but not any higher in the tree */
 317     if ((focused->parent->type != CT_CON &&
 318         focused->parent->type != CT_WORKSPACE) ||
 319         focused->type == CT_WORKSPACE) {
 320         LOG("Cannot go up any further\n");
 321         return;
 322     }
 323     con_focus(focused->parent);
 324 }
 325
 326 /*
 327  * Moves focus one level down.
 328  *
 329  */
 330 void level_down() {
 331     /* Go down the focus stack of the current node */
 332     Con *next = TAILQ_FIRST(&(focused->focus_head));
 333     if (next == TAILQ_END(&(focused->focus_head))) {
 334         printf("cannot go down\n");
 335         return;
 336     }
 337     con_focus(next);
 338 }
 339
 340 static void mark_unmapped(Con *con) {
 341     Con *current;
 342
 343     con->mapped = false;
 344     TAILQ_FOREACH(current, &(con->nodes_head), nodes)
 345         mark_unmapped(current);
 346     if (con->type == CT_WORKSPACE) {
 347         /* We need to call mark_unmapped on floating nodes aswell since we can
 348          * make containers floating. */
 349         TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 350             mark_unmapped(current);
 351     }
 352 }
 353
 354 /*
 355  * Renders the tree, that is rendering all outputs using render_con() and
 356  * pushing the changes to X11 using x_push_changes().
 357  *
 358  */
 359 void tree_render() {
 360     if (croot == NULL)
 361         return;
 362
 363     DLOG("-- BEGIN RENDERING --\n");
 364     /* Reset map state for all nodes in tree */
 365     /* TODO: a nicer method to walk all nodes would be good, maybe? */
 366     mark_unmapped(croot);
 367     croot->mapped = true;
 368
 369     render_con(croot, false);
 370
 371     x_push_changes(croot);
 372     DLOG("-- END RENDERING --\n");
 373 }
 374
 375 /*
 376  * Recursive function to walk the tree until a con can be found to focus.
 377  *
 378  */
 379 static bool _tree_next(Con *con, char way, orientation_t orientation, bool wrap) {
 380     /* Stop recursing at workspaces after attempting to switch to next
 381      * workspace if possible. */
 382     if (con->type == CT_WORKSPACE) {
 383         Output *current_output = get_output_containing(con->rect.x, con->rect.y);
 384         Output *next_output;
 385
 386         if (!current_output)
 387             return false;
 388         DLOG("Current output is %s\n", current_output->name);
 389
 390         /* Try to find next output */
 391         direction_t direction;
 392         if (way == 'n' && orientation == HORIZ)
 393             direction = D_RIGHT;
 394         else if (way == 'p' && orientation == HORIZ)
 395             direction = D_LEFT;
 396         else if (way == 'n' && orientation == VERT)
 397             direction = D_DOWN;
 398         else if (way == 'p' && orientation == VERT)
 399             direction = D_UP;
 400         else
 401             return false;
 402
 403         next_output = get_output_next(direction, current_output);
 404         if (!next_output)
 405             return false;
 406         DLOG("Next output is %s\n", next_output->name);
 407
 408         /* Find visible workspace on next output */
 409         Con *workspace = NULL;
 410         GREP_FIRST(workspace, output_get_content(next_output->con), workspace_is_visible(child));
 411
 412         /* Show next workspace and focus appropriate container if possible. */
 413         if (!workspace)
 414             return false;
 415
 416         workspace_show(workspace->name);
 417         Con *focus = con_descend_direction(workspace, direction);
 418         if (focus) {
 419             con_focus(focus);
 420             x_set_warp_to(&(focus->rect));
 421         }
 422         return true;
 423     }
 424
 425     Con *parent = con->parent;
 426
 427     if (con->type == CT_FLOATING_CON) {
 428         /* left/right focuses the previous/next floating container */
 429         if (orientation == HORIZ) {
 430             Con *next;
 431             if (way == 'n')
 432                 next = TAILQ_NEXT(con, floating_windows);
 433             else next = TAILQ_PREV(con, floating_head, floating_windows);
 434
 435             /* If there is no next/previous container, wrap */
 436             if (!next) {
 437                 if (way == 'n')
 438                     next = TAILQ_FIRST(&(parent->floating_head));
 439                 else next = TAILQ_LAST(&(parent->floating_head), floating_head);
 440             }
 441
 442             /* Still no next/previous container? bail out */
 443             if (!next)
 444                 return false;
 445
 446             con_focus(con_descend_focused(next));
 447             return true;
 448         } else {
 449             /* up/down cycles through the Z-index */
 450             /* TODO: implement cycling through the z-index */
 451             return false;
 452         }
 453     }
 454
 455     /* If the orientation does not match or there is no other con to focus, we
 456      * need to go higher in the hierarchy */
 457     if (con_orientation(parent) != orientation ||
 458         con_num_children(parent) == 1)
 459         return _tree_next(parent, way, orientation, wrap);
 460
 461     Con *current = TAILQ_FIRST(&(parent->focus_head));
 462     /* TODO: when can the following happen (except for floating windows, which
 463      * are handled above)? */
 464     if (TAILQ_EMPTY(&(parent->nodes_head))) {
 465         DLOG("nothing to focus\n");
 466         return false;
 467     }
 468
 469     Con *next;
 470     if (way == 'n')
 471         next = TAILQ_NEXT(current, nodes);
 472     else next = TAILQ_PREV(current, nodes_head, nodes);
 473
 474     if (!next) {
 475         if (!config.force_focus_wrapping) {
 476             /* If there is no next/previous container, we check if we can focus one
 477              * when going higher (without wrapping, though). If so, we are done, if
 478              * not, we wrap */
 479             if (_tree_next(parent, way, orientation, false))
 480                 return true;
 481
 482             if (!wrap)
 483                 return false;
 484         }
 485
 486         if (way == 'n')
 487             next = TAILQ_FIRST(&(parent->nodes_head));
 488         else next = TAILQ_LAST(&(parent->nodes_head), nodes_head);
 489     }
 490
 491     /* 3: focus choice comes in here. at the moment we will go down
 492      * until we find a window */
 493     /* TODO: check for window, atm we only go down as far as possible */
 494     con_focus(con_descend_focused(next));
 495     return true;
 496 }
 497
 498 /*
 499  * Changes focus in the given way (next/previous) and given orientation
 500  * (horizontal/vertical).
 501  *
 502  */
 503 void tree_next(char way, orientation_t orientation) {
 504     _tree_next(focused, way, orientation, true);
 505 }
 506
 507 /*
 508  * tree_flatten() removes pairs of redundant split containers, e.g.:
 509  *       [workspace, horizontal]
 510  *   [v-split]           [child3]
 511  *   [h-split]
 512  * [child1] [child2]
 513  * In this example, the v-split and h-split container are redundant.
 514  * Such a situation can be created by moving containers in a direction which is
 515  * not the orientation of their parent container. i3 needs to create a new
 516  * split container then and if you move containers this way multiple times,
 517  * redundant chains of split-containers can be the result.
 518  *
 519  */
 520 void tree_flatten(Con *con) {
 521     Con *current, *child, *parent = con->parent;
 522     DLOG("Checking if I can flatten con = %p / %s\n", con, con->name);
 523
 524     /* We only consider normal containers without windows */
 525     if (con->type != CT_CON || con->window != NULL)
 526         goto recurse;
 527
 528     /* Ensure it got only one child */
 529     child = TAILQ_FIRST(&(con->nodes_head));
 530     if (child == NULL || TAILQ_NEXT(child, nodes) != NULL)
 531         goto recurse;
 532
 533     /* The child must have a different orientation than the con but the same as
 534      * the con’s parent to be redundant */
 535     if (con->orientation == NO_ORIENTATION ||
 536         child->orientation == NO_ORIENTATION ||
 537         con->orientation == child->orientation ||
 538         child->orientation != parent->orientation)
 539         goto recurse;
 540
 541     DLOG("Alright, I have to flatten this situation now. Stay calm.\n");
 542     /* 1: save focus */
 543     Con *focus_next = TAILQ_FIRST(&(child->focus_head));
 544
 545     DLOG("detaching...\n");
 546     /* 2: re-attach the children to the parent before con */
 547     while (!TAILQ_EMPTY(&(child->nodes_head))) {
 548         current = TAILQ_FIRST(&(child->nodes_head));
 549         DLOG("detaching current=%p / %s\n", current, current->name);
 550         con_detach(current);
 551         DLOG("re-attaching\n");
 552         /* We don’t use con_attach() here because for a CT_CON, the special
 553          * case handling of con_attach() does not trigger. So all it would do
 554          * is calling TAILQ_INSERT_AFTER, but with the wrong container. So we
 555          * directly use the TAILQ macros. */
 556         current->parent = parent;
 557         TAILQ_INSERT_BEFORE(con, current, nodes);
 558         DLOG("attaching to focus list\n");
 559         TAILQ_INSERT_TAIL(&(parent->focus_head), current, focused);
 560         current->percent = con->percent;
 561     }
 562     DLOG("re-attached all\n");
 563
 564     /* 3: restore focus, if con was focused */
 565     if (focus_next != NULL &&
 566         TAILQ_FIRST(&(parent->focus_head)) == con) {
 567         DLOG("restoring focus to focus_next=%p\n", focus_next);
 568         TAILQ_REMOVE(&(parent->focus_head), focus_next, focused);
 569         TAILQ_INSERT_HEAD(&(parent->focus_head), focus_next, focused);
 570         DLOG("restored focus.\n");
 571     }
 572
 573     /* 4: close the redundant cons */
 574     DLOG("closing redundant cons\n");
 575     tree_close(con, DONT_KILL_WINDOW, true);
 576
 577     /* Well, we got to abort the recursion here because we destroyed the
 578      * container. However, if tree_flatten() is called sufficiently often,
 579      * there can’t be the situation of having two pairs of redundant containers
 580      * at once. Therefore, we can safely abort the recursion on this level
 581      * after flattening. */
 582     return;
 583
 584 recurse:
 585     /* We cannot use normal foreach here because tree_flatten might close the
 586      * current container. */
 587     current = TAILQ_FIRST(&(con->nodes_head));
 588     while (current != NULL) {
 589         Con *next = TAILQ_NEXT(current, nodes);
 590         tree_flatten(current);
 591         current = next;
 592     }
 593
 594     current = TAILQ_FIRST(&(con->floating_head));
 595     while (current != NULL) {
 596         Con *next = TAILQ_NEXT(current, floating_windows);
 597         tree_flatten(current);
 598         current = next;
 599     }
 600 }