git.sur5r.net Git - i3/i3/blob - src/workspace.c

   1 #undef I3__FILE__
   2 #define I3__FILE__ "workspace.c"
   3 /*
   4  * vim:ts=4:sw=4:expandtab
   5  *
   6  * i3 - an improved dynamic tiling window manager
   7  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   8  *
   9  * workspace.c: Modifying workspaces, accessing them, moving containers to
  10  *              workspaces.
  11  *
  12  */
  13 #include "all.h"
  14 #include "yajl_utils.h"
  15
  16 /* Stores a copy of the name of the last used workspace for the workspace
  17  * back-and-forth switching. */
  18 static char *previous_workspace_name = NULL;
  19
  20 /*
  21  * Sets ws->layout to splith/splitv if default_orientation was specified in the
  22  * configfile. Otherwise, it uses splith/splitv depending on whether the output
  23  * is higher than wide.
  24  *
  25  */
  26 static void _workspace_apply_default_orientation(Con *ws) {
  27     /* If default_orientation is set to NO_ORIENTATION we determine
  28      * orientation depending on output resolution. */
  29     if (config.default_orientation == NO_ORIENTATION) {
  30         Con *output = con_get_output(ws);
  31         ws->layout = (output->rect.height > output->rect.width) ? L_SPLITV : L_SPLITH;
  32         ws->rect = output->rect;
  33         DLOG("Auto orientation. Workspace size set to (%d,%d), setting layout to %d.\n",
  34              output->rect.width, output->rect.height, ws->layout);
  35     } else {
  36         ws->layout = (config.default_orientation == HORIZ) ? L_SPLITH : L_SPLITV;
  37     }
  38 }
  39
  40 /*
  41  * Returns a pointer to the workspace with the given number (starting at 0),
  42  * creating the workspace if necessary (by allocating the necessary amount of
  43  * memory and initializing the data structures correctly).
  44  *
  45  */
  46 Con *workspace_get(const char *num, bool *created) {
  47     Con *output, *workspace = NULL;
  48
  49     TAILQ_FOREACH(output, &(croot->nodes_head), nodes)
  50     GREP_FIRST(workspace, output_get_content(output), !strcasecmp(child->name, num));
  51
  52     if (workspace == NULL) {
  53         LOG("Creating new workspace \"%s\"\n", num);
  54         /* unless an assignment is found, we will create this workspace on the current output */
  55         output = con_get_output(focused);
  56         /* look for assignments */
  57         struct Workspace_Assignment *assignment;
  58
  59         /* We set workspace->num to the number if this workspace’s name begins
  60          * with a positive number. Otherwise it’s a named ws and num will be
  61          * -1. */
  62         long parsed_num = ws_name_to_number(num);
  63
  64         TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
  65             if (strcmp(assignment->name, num) == 0) {
  66                 DLOG("Found workspace name assignment to output \"%s\"\n", assignment->output);
  67                 GREP_FIRST(output, croot, !strcmp(child->name, assignment->output));
  68                 break;
  69             } else if (parsed_num != -1 && name_is_digits(assignment->name) && ws_name_to_number(assignment->name) == parsed_num) {
  70                 DLOG("Found workspace number assignment to output \"%s\"\n", assignment->output);
  71                 GREP_FIRST(output, croot, !strcmp(child->name, assignment->output));
  72             }
  73         }
  74
  75         Con *content = output_get_content(output);
  76         LOG("got output %p with content %p\n", output, content);
  77         /* We need to attach this container after setting its type. con_attach
  78          * will handle CT_WORKSPACEs differently */
  79         workspace = con_new(NULL, NULL);
  80         char *name;
  81         sasprintf(&name, "[i3 con] workspace %s", num);
  82         x_set_name(workspace, name);
  83         free(name);
  84         workspace->type = CT_WORKSPACE;
  85         FREE(workspace->name);
  86         workspace->name = sstrdup(num);
  87         workspace->workspace_layout = config.default_layout;
  88         workspace->num = parsed_num;
  89         LOG("num = %d\n", workspace->num);
  90
  91         workspace->parent = content;
  92         _workspace_apply_default_orientation(workspace);
  93
  94         con_attach(workspace, content, false);
  95
  96         ipc_send_workspace_event("init", workspace, NULL);
  97         ewmh_update_number_of_desktops();
  98         ewmh_update_desktop_names();
  99         ewmh_update_desktop_viewport();
 100         if (created != NULL)
 101             *created = true;
 102     } else if (created != NULL) {
 103         *created = false;
 104     }
 105
 106     return workspace;
 107 }
 108
 109 /*
 110  * Returns a pointer to a new workspace in the given output. The workspace
 111  * is created attached to the tree hierarchy through the given content
 112  * container.
 113  *
 114  */
 115 Con *create_workspace_on_output(Output *output, Con *content) {
 116     /* add a workspace to this output */
 117     Con *out, *current;
 118     char *name;
 119     bool exists = true;
 120     Con *ws = con_new(NULL, NULL);
 121     ws->type = CT_WORKSPACE;
 122
 123     /* try the configured workspace bindings first to find a free name */
 124     Binding *bind;
 125     TAILQ_FOREACH(bind, bindings, bindings) {
 126         DLOG("binding with command %s\n", bind->command);
 127         if (strlen(bind->command) < strlen("workspace ") ||
 128             strncasecmp(bind->command, "workspace", strlen("workspace")) != 0)
 129             continue;
 130         DLOG("relevant command = %s\n", bind->command);
 131         const char *target = bind->command + strlen("workspace ");
 132         while (*target == ' ' || *target == '\t')
 133             target++;
 134         /* We check if this is the workspace
 135          * next/prev/next_on_output/prev_on_output/back_and_forth/number command.
 136          * Beware: The workspace names "next", "prev", "next_on_output",
 137          * "prev_on_output", "number", "back_and_forth" and "current" are OK,
 138          * so we check before stripping the double quotes */
 139         if (strncasecmp(target, "next", strlen("next")) == 0 ||
 140             strncasecmp(target, "prev", strlen("prev")) == 0 ||
 141             strncasecmp(target, "next_on_output", strlen("next_on_output")) == 0 ||
 142             strncasecmp(target, "prev_on_output", strlen("prev_on_output")) == 0 ||
 143             strncasecmp(target, "number", strlen("number")) == 0 ||
 144             strncasecmp(target, "back_and_forth", strlen("back_and_forth")) == 0 ||
 145             strncasecmp(target, "current", strlen("current")) == 0)
 146             continue;
 147         char *target_name = parse_string(&target, false);
 148         if (target_name == NULL)
 149             continue;
 150         if (strncasecmp(target_name, "__", strlen("__")) == 0) {
 151             LOG("Cannot create workspace \"%s\". Names starting with __ are i3-internal.\n", target);
 152             free(target_name);
 153             continue;
 154         }
 155         FREE(ws->name);
 156         ws->name = target_name;
 157         DLOG("trying name *%s*\n", ws->name);
 158
 159         /* Ensure that this workspace is not assigned to a different output —
 160          * otherwise we would create it, then move it over to its output, then
 161          * find a new workspace, etc… */
 162         bool assigned = false;
 163         struct Workspace_Assignment *assignment;
 164         TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
 165             if (strcmp(assignment->name, ws->name) != 0 ||
 166                 strcmp(assignment->output, output->name) == 0)
 167                 continue;
 168
 169             assigned = true;
 170             break;
 171         }
 172
 173         if (assigned)
 174             continue;
 175
 176         current = NULL;
 177         TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
 178         GREP_FIRST(current, output_get_content(out), !strcasecmp(child->name, ws->name));
 179
 180         exists = (current != NULL);
 181         if (!exists) {
 182             /* Set ->num to the number of the workspace, if the name actually
 183              * is a number or starts with a number */
 184             ws->num = ws_name_to_number(ws->name);
 185             LOG("Used number %d for workspace with name %s\n", ws->num, ws->name);
 186
 187             break;
 188         }
 189     }
 190
 191     if (exists) {
 192         /* get the next unused workspace number */
 193         DLOG("Getting next unused workspace by number\n");
 194         int c = 0;
 195         while (exists) {
 196             c++;
 197
 198             ws->num = c;
 199
 200             current = NULL;
 201             TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
 202             GREP_FIRST(current, output_get_content(out), child->num == ws->num);
 203             exists = (current != NULL);
 204
 205             DLOG("result for ws %d: exists = %d\n", c, exists);
 206         }
 207         sasprintf(&(ws->name), "%d", c);
 208     }
 209     con_attach(ws, content, false);
 210
 211     sasprintf(&name, "[i3 con] workspace %s", ws->name);
 212     x_set_name(ws, name);
 213     free(name);
 214
 215     ws->fullscreen_mode = CF_OUTPUT;
 216
 217     ws->workspace_layout = config.default_layout;
 218     _workspace_apply_default_orientation(ws);
 219
 220     return ws;
 221 }
 222
 223 /*
 224  * Returns true if the workspace is currently visible. Especially important for
 225  * multi-monitor environments, as they can have multiple currenlty active
 226  * workspaces.
 227  *
 228  */
 229 bool workspace_is_visible(Con *ws) {
 230     Con *output = con_get_output(ws);
 231     if (output == NULL)
 232         return false;
 233     Con *fs = con_get_fullscreen_con(output, CF_OUTPUT);
 234     LOG("workspace visible? fs = %p, ws = %p\n", fs, ws);
 235     return (fs == ws);
 236 }
 237
 238 /*
 239  * XXX: we need to clean up all this recursive walking code.
 240  *
 241  */
 242 Con *_get_sticky(Con *con, const char *sticky_group, Con *exclude) {
 243     Con *current;
 244
 245     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
 246         if (current != exclude &&
 247             current->sticky_group != NULL &&
 248             current->window != NULL &&
 249             strcmp(current->sticky_group, sticky_group) == 0)
 250             return current;
 251
 252         Con *recurse = _get_sticky(current, sticky_group, exclude);
 253         if (recurse != NULL)
 254             return recurse;
 255     }
 256
 257     TAILQ_FOREACH(current, &(con->floating_head), floating_windows) {
 258         if (current != exclude &&
 259             current->sticky_group != NULL &&
 260             current->window != NULL &&
 261             strcmp(current->sticky_group, sticky_group) == 0)
 262             return current;
 263
 264         Con *recurse = _get_sticky(current, sticky_group, exclude);
 265         if (recurse != NULL)
 266             return recurse;
 267     }
 268
 269     return NULL;
 270 }
 271
 272 /*
 273  * Reassigns all child windows in sticky containers. Called when the user
 274  * changes workspaces.
 275  *
 276  * XXX: what about sticky containers which contain containers?
 277  *
 278  */
 279 static void workspace_reassign_sticky(Con *con) {
 280     Con *current;
 281     /* 1: go through all containers */
 282
 283     /* handle all children and floating windows of this node */
 284     TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
 285         if (current->sticky_group == NULL) {
 286             workspace_reassign_sticky(current);
 287             continue;
 288         }
 289
 290         LOG("Ah, this one is sticky: %s / %p\n", current->name, current);
 291         /* 2: find a window which we can re-assign */
 292         Con *output = con_get_output(current);
 293         Con *src = _get_sticky(output, current->sticky_group, current);
 294
 295         if (src == NULL) {
 296             LOG("No window found for this sticky group\n");
 297             workspace_reassign_sticky(current);
 298             continue;
 299         }
 300
 301         x_move_win(src, current);
 302         current->window = src->window;
 303         current->mapped = true;
 304         src->window = NULL;
 305         src->mapped = false;
 306
 307         x_reparent_child(current, src);
 308
 309         LOG("re-assigned window from src %p to dest %p\n", src, current);
 310     }
 311
 312     TAILQ_FOREACH(current, &(con->floating_head), floating_windows)
 313     workspace_reassign_sticky(current);
 314 }
 315
 316 /*
 317  * Callback to reset the urgent flag of the given con to false. May be started by
 318  * _workspace_show to avoid urgency hints being lost by switching to a workspace
 319  * focusing the con.
 320  *
 321  */
 322 static void workspace_defer_update_urgent_hint_cb(EV_P_ ev_timer *w, int revents) {
 323     Con *con = w->data;
 324
 325     ev_timer_stop(main_loop, con->urgency_timer);
 326     FREE(con->urgency_timer);
 327
 328     if (con->urgent) {
 329         DLOG("Resetting urgency flag of con %p by timer\n", con);
 330         con_set_urgency(con, false);
 331         con_update_parents_urgency(con);
 332         workspace_update_urgent_flag(con_get_workspace(con));
 333         ipc_send_window_event("urgent", con);
 334         tree_render();
 335     }
 336 }
 337
 338 static void _workspace_show(Con *workspace) {
 339     Con *current, *old = NULL;
 340
 341     /* safe-guard against showing i3-internal workspaces like __i3_scratch */
 342     if (con_is_internal(workspace))
 343         return;
 344
 345     /* disable fullscreen for the other workspaces and get the workspace we are
 346      * currently on. */
 347     TAILQ_FOREACH(current, &(workspace->parent->nodes_head), nodes) {
 348         if (current->fullscreen_mode == CF_OUTPUT)
 349             old = current;
 350         current->fullscreen_mode = CF_NONE;
 351     }
 352
 353     /* enable fullscreen for the target workspace. If it happens to be the
 354      * same one we are currently on anyways, we can stop here. */
 355     workspace->fullscreen_mode = CF_OUTPUT;
 356     current = con_get_workspace(focused);
 357     if (workspace == current) {
 358         DLOG("Not switching, already there.\n");
 359         return;
 360     }
 361
 362     /* Remember currently focused workspace for switching back to it later with
 363      * the 'workspace back_and_forth' command.
 364      * NOTE: We have to duplicate the name as the original will be freed when
 365      * the corresponding workspace is cleaned up.
 366      * NOTE: Internal cons such as __i3_scratch (when a scratchpad window is
 367      * focused) are skipped, see bug #868. */
 368     if (current && !con_is_internal(current)) {
 369         FREE(previous_workspace_name);
 370         if (current) {
 371             previous_workspace_name = sstrdup(current->name);
 372             DLOG("Setting previous_workspace_name = %s\n", previous_workspace_name);
 373         }
 374     }
 375
 376     workspace_reassign_sticky(workspace);
 377
 378     DLOG("switching to %p / %s\n", workspace, workspace->name);
 379     Con *next = con_descend_focused(workspace);
 380
 381     /* Memorize current output */
 382     Con *old_output = con_get_output(focused);
 383
 384     /* Display urgency hint for a while if the newly visible workspace would
 385      * focus and thereby immediately destroy it */
 386     if (next->urgent && (int)(config.workspace_urgency_timer * 1000) > 0) {
 387         /* focus for now… */
 388         next->urgent = false;
 389         con_focus(next);
 390
 391         /* … but immediately reset urgency flags; they will be set to false by
 392          * the timer callback in case the container is focused at the time of
 393          * its expiration */
 394         focused->urgent = true;
 395         workspace->urgent = true;
 396
 397         if (focused->urgency_timer == NULL) {
 398             DLOG("Deferring reset of urgency flag of con %p on newly shown workspace %p\n",
 399                  focused, workspace);
 400             focused->urgency_timer = scalloc(1, sizeof(struct ev_timer));
 401             /* use a repeating timer to allow for easy resets */
 402             ev_timer_init(focused->urgency_timer, workspace_defer_update_urgent_hint_cb,
 403                           config.workspace_urgency_timer, config.workspace_urgency_timer);
 404             focused->urgency_timer->data = focused;
 405             ev_timer_start(main_loop, focused->urgency_timer);
 406         } else {
 407             DLOG("Resetting urgency timer of con %p on workspace %p\n",
 408                  focused, workspace);
 409             ev_timer_again(main_loop, focused->urgency_timer);
 410         }
 411     } else
 412         con_focus(next);
 413
 414     ipc_send_workspace_event("focus", workspace, current);
 415
 416     DLOG("old = %p / %s\n", old, (old ? old->name : "(null)"));
 417     /* Close old workspace if necessary. This must be done *after* doing
 418      * urgency handling, because tree_close() will do a con_focus() on the next
 419      * client, which will clear the urgency flag too early. Also, there is no
 420      * way for con_focus() to know about when to clear urgency immediately and
 421      * when to defer it. */
 422     if (old && TAILQ_EMPTY(&(old->nodes_head)) && TAILQ_EMPTY(&(old->floating_head))) {
 423         /* check if this workspace is currently visible */
 424         if (!workspace_is_visible(old)) {
 425             LOG("Closing old workspace (%p / %s), it is empty\n", old, old->name);
 426             yajl_gen gen = ipc_marshal_workspace_event("empty", old, NULL);
 427             tree_close(old, DONT_KILL_WINDOW, false, false);
 428
 429             const unsigned char *payload;
 430             ylength length;
 431             y(get_buf, &payload, &length);
 432             ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
 433
 434             y(free);
 435
 436             ewmh_update_number_of_desktops();
 437             ewmh_update_desktop_names();
 438             ewmh_update_desktop_viewport();
 439         }
 440     }
 441
 442     workspace->fullscreen_mode = CF_OUTPUT;
 443     LOG("focused now = %p / %s\n", focused, focused->name);
 444
 445     /* Set mouse pointer */
 446     Con *new_output = con_get_output(focused);
 447     if (old_output != new_output) {
 448         x_set_warp_to(&next->rect);
 449     }
 450
 451     /* Update the EWMH hints */
 452     ewmh_update_current_desktop();
 453
 454     /* Floating containers which are sticky need to be moved to the new workspace,
 455      * but only on the same output. */
 456     if (current != NULL && old_output == new_output) {
 457         Con *prev = focused;
 458         Con *child;
 459
 460         /* We can't simply iterate over the floating containers since moving a
 461          * sticky container to the target workspace will modify that list.
 462          * Instead, we first count the number of sticky containers, then memorize
 463          * all of them and finally loop over that list to move them to the new
 464          * workspace. */
 465         int num_sticky = 0;
 466         TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
 467             if (con_is_sticky(child))
 468                 num_sticky++;
 469         }
 470
 471         Con *sticky_cons[num_sticky];
 472         int ctr = 0;
 473         TAILQ_FOREACH(child, &(current->floating_head), floating_windows) {
 474             if (con_is_sticky(child))
 475                 sticky_cons[ctr++] = child;
 476         }
 477
 478         for (int i = 0; i < num_sticky; i++) {
 479             con_move_to_workspace(sticky_cons[i], workspace, true, false);
 480
 481             /* We want sticky containers to be at the end of the focus head. */
 482             TAILQ_REMOVE(&(workspace->focus_head), sticky_cons[i], focused);
 483             TAILQ_INSERT_TAIL(&(workspace->focus_head), sticky_cons[i], focused);
 484         }
 485
 486         /* Focus the correct container since moving the sticky containers
 487          * changed the focus. However, if no container was focused before,
 488          * we can leave the focus at the sticky container. */
 489         if (prev != croot)
 490             con_focus(prev);
 491     }
 492 }
 493
 494 /*
 495  * Switches to the given workspace
 496  *
 497  */
 498 void workspace_show(Con *workspace) {
 499     _workspace_show(workspace);
 500 }
 501
 502 /*
 503  * Looks up the workspace by name and switches to it.
 504  *
 505  */
 506 void workspace_show_by_name(const char *num) {
 507     Con *workspace;
 508     workspace = workspace_get(num, NULL);
 509     _workspace_show(workspace);
 510 }
 511
 512 /*
 513  * Focuses the next workspace.
 514  *
 515  */
 516 Con *workspace_next(void) {
 517     Con *current = con_get_workspace(focused);
 518     Con *next = NULL;
 519     Con *output;
 520
 521     if (current->num == -1) {
 522         /* If currently a named workspace, find next named workspace. */
 523         next = TAILQ_NEXT(current, nodes);
 524     } else {
 525         /* If currently a numbered workspace, find next numbered workspace. */
 526         TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 527             /* Skip outputs starting with __, they are internal. */
 528             if (con_is_internal(output))
 529                 continue;
 530             NODES_FOREACH(output_get_content(output)) {
 531                 if (child->type != CT_WORKSPACE)
 532                     continue;
 533                 if (child->num == -1)
 534                     break;
 535                 /* Need to check child against current and next because we are
 536                  * traversing multiple lists and thus are not guaranteed the
 537                  * relative order between the list of workspaces. */
 538                 if (current->num < child->num && (!next || child->num < next->num))
 539                     next = child;
 540             }
 541         }
 542     }
 543
 544     /* Find next named workspace. */
 545     if (!next) {
 546         bool found_current = false;
 547         TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 548             /* Skip outputs starting with __, they are internal. */
 549             if (con_is_internal(output))
 550                 continue;
 551             NODES_FOREACH(output_get_content(output)) {
 552                 if (child->type != CT_WORKSPACE)
 553                     continue;
 554                 if (child == current) {
 555                     found_current = 1;
 556                 } else if (child->num == -1 && (current->num != -1 || found_current)) {
 557                     next = child;
 558                     goto workspace_next_end;
 559                 }
 560             }
 561         }
 562     }
 563
 564     /* Find first workspace. */
 565     if (!next) {
 566         TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 567             /* Skip outputs starting with __, they are internal. */
 568             if (con_is_internal(output))
 569                 continue;
 570             NODES_FOREACH(output_get_content(output)) {
 571                 if (child->type != CT_WORKSPACE)
 572                     continue;
 573                 if (!next || (child->num != -1 && child->num < next->num))
 574                     next = child;
 575             }
 576         }
 577     }
 578 workspace_next_end:
 579     return next;
 580 }
 581
 582 /*
 583  * Focuses the previous workspace.
 584  *
 585  */
 586 Con *workspace_prev(void) {
 587     Con *current = con_get_workspace(focused);
 588     Con *prev = NULL;
 589     Con *output;
 590
 591     if (current->num == -1) {
 592         /* If named workspace, find previous named workspace. */
 593         prev = TAILQ_PREV(current, nodes_head, nodes);
 594         if (prev && prev->num != -1)
 595             prev = NULL;
 596     } else {
 597         /* If numbered workspace, find previous numbered workspace. */
 598         TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
 599             /* Skip outputs starting with __, they are internal. */
 600             if (con_is_internal(output))
 601                 continue;
 602             NODES_FOREACH_REVERSE(output_get_content(output)) {
 603                 if (child->type != CT_WORKSPACE || child->num == -1)
 604                     continue;
 605                 /* Need to check child against current and previous because we
 606                  * are traversing multiple lists and thus are not guaranteed
 607                  * the relative order between the list of workspaces. */
 608                 if (current->num > child->num && (!prev || child->num > prev->num))
 609                     prev = child;
 610             }
 611         }
 612     }
 613
 614     /* Find previous named workspace. */
 615     if (!prev) {
 616         bool found_current = false;
 617         TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
 618             /* Skip outputs starting with __, they are internal. */
 619             if (con_is_internal(output))
 620                 continue;
 621             NODES_FOREACH_REVERSE(output_get_content(output)) {
 622                 if (child->type != CT_WORKSPACE)
 623                     continue;
 624                 if (child == current) {
 625                     found_current = true;
 626                 } else if (child->num == -1 && (current->num != -1 || found_current)) {
 627                     prev = child;
 628                     goto workspace_prev_end;
 629                 }
 630             }
 631         }
 632     }
 633
 634     /* Find last workspace. */
 635     if (!prev) {
 636         TAILQ_FOREACH_REVERSE(output, &(croot->nodes_head), nodes_head, nodes) {
 637             /* Skip outputs starting with __, they are internal. */
 638             if (con_is_internal(output))
 639                 continue;
 640             NODES_FOREACH_REVERSE(output_get_content(output)) {
 641                 if (child->type != CT_WORKSPACE)
 642                     continue;
 643                 if (!prev || child->num > prev->num)
 644                     prev = child;
 645             }
 646         }
 647     }
 648
 649 workspace_prev_end:
 650     return prev;
 651 }
 652
 653 /*
 654  * Focuses the next workspace on the same output.
 655  *
 656  */
 657 Con *workspace_next_on_output(void) {
 658     Con *current = con_get_workspace(focused);
 659     Con *next = NULL;
 660     Con *output = con_get_output(focused);
 661
 662     if (current->num == -1) {
 663         /* If currently a named workspace, find next named workspace. */
 664         next = TAILQ_NEXT(current, nodes);
 665     } else {
 666         /* If currently a numbered workspace, find next numbered workspace. */
 667         NODES_FOREACH(output_get_content(output)) {
 668             if (child->type != CT_WORKSPACE)
 669                 continue;
 670             if (child->num == -1)
 671                 break;
 672             /* Need to check child against current and next because we are
 673              * traversing multiple lists and thus are not guaranteed the
 674              * relative order between the list of workspaces. */
 675             if (current->num < child->num && (!next || child->num < next->num))
 676                 next = child;
 677         }
 678     }
 679
 680     /* Find next named workspace. */
 681     if (!next) {
 682         bool found_current = false;
 683         NODES_FOREACH(output_get_content(output)) {
 684             if (child->type != CT_WORKSPACE)
 685                 continue;
 686             if (child == current) {
 687                 found_current = 1;
 688             } else if (child->num == -1 && (current->num != -1 || found_current)) {
 689                 next = child;
 690                 goto workspace_next_on_output_end;
 691             }
 692         }
 693     }
 694
 695     /* Find first workspace. */
 696     if (!next) {
 697         NODES_FOREACH(output_get_content(output)) {
 698             if (child->type != CT_WORKSPACE)
 699                 continue;
 700             if (!next || (child->num != -1 && child->num < next->num))
 701                 next = child;
 702         }
 703     }
 704 workspace_next_on_output_end:
 705     return next;
 706 }
 707
 708 /*
 709  * Focuses the previous workspace on same output.
 710  *
 711  */
 712 Con *workspace_prev_on_output(void) {
 713     Con *current = con_get_workspace(focused);
 714     Con *prev = NULL;
 715     Con *output = con_get_output(focused);
 716     DLOG("output = %s\n", output->name);
 717
 718     if (current->num == -1) {
 719         /* If named workspace, find previous named workspace. */
 720         prev = TAILQ_PREV(current, nodes_head, nodes);
 721         if (prev && prev->num != -1)
 722             prev = NULL;
 723     } else {
 724         /* If numbered workspace, find previous numbered workspace. */
 725         NODES_FOREACH_REVERSE(output_get_content(output)) {
 726             if (child->type != CT_WORKSPACE || child->num == -1)
 727                 continue;
 728             /* Need to check child against current and previous because we
 729              * are traversing multiple lists and thus are not guaranteed
 730              * the relative order between the list of workspaces. */
 731             if (current->num > child->num && (!prev || child->num > prev->num))
 732                 prev = child;
 733         }
 734     }
 735
 736     /* Find previous named workspace. */
 737     if (!prev) {
 738         bool found_current = false;
 739         NODES_FOREACH_REVERSE(output_get_content(output)) {
 740             if (child->type != CT_WORKSPACE)
 741                 continue;
 742             if (child == current) {
 743                 found_current = true;
 744             } else if (child->num == -1 && (current->num != -1 || found_current)) {
 745                 prev = child;
 746                 goto workspace_prev_on_output_end;
 747             }
 748         }
 749     }
 750
 751     /* Find last workspace. */
 752     if (!prev) {
 753         NODES_FOREACH_REVERSE(output_get_content(output)) {
 754             if (child->type != CT_WORKSPACE)
 755                 continue;
 756             if (!prev || child->num > prev->num)
 757                 prev = child;
 758         }
 759     }
 760
 761 workspace_prev_on_output_end:
 762     return prev;
 763 }
 764
 765 /*
 766  * Focuses the previously focused workspace.
 767  *
 768  */
 769 void workspace_back_and_forth(void) {
 770     if (!previous_workspace_name) {
 771         DLOG("No previous workspace name set. Not switching.\n");
 772         return;
 773     }
 774
 775     workspace_show_by_name(previous_workspace_name);
 776 }
 777
 778 /*
 779  * Returns the previously focused workspace con, or NULL if unavailable.
 780  *
 781  */
 782 Con *workspace_back_and_forth_get(void) {
 783     if (!previous_workspace_name) {
 784         DLOG("No previous workspace name set.\n");
 785         return NULL;
 786     }
 787
 788     Con *workspace;
 789     workspace = workspace_get(previous_workspace_name, NULL);
 790
 791     return workspace;
 792 }
 793
 794 static bool get_urgency_flag(Con *con) {
 795     Con *child;
 796     TAILQ_FOREACH(child, &(con->nodes_head), nodes)
 797     if (child->urgent || get_urgency_flag(child))
 798         return true;
 799
 800     TAILQ_FOREACH(child, &(con->floating_head), floating_windows)
 801     if (child->urgent || get_urgency_flag(child))
 802         return true;
 803
 804     return false;
 805 }
 806
 807 /*
 808  * Goes through all clients on the given workspace and updates the workspace’s
 809  * urgent flag accordingly.
 810  *
 811  */
 812 void workspace_update_urgent_flag(Con *ws) {
 813     bool old_flag = ws->urgent;
 814     ws->urgent = get_urgency_flag(ws);
 815     DLOG("Workspace urgency flag changed from %d to %d\n", old_flag, ws->urgent);
 816
 817     if (old_flag != ws->urgent)
 818         ipc_send_workspace_event("urgent", ws, NULL);
 819 }
 820
 821 /*
 822  * 'Forces' workspace orientation by moving all cons into a new split-con with
 823  * the same layout as the workspace and then changing the workspace layout.
 824  *
 825  */
 826 void ws_force_orientation(Con *ws, orientation_t orientation) {
 827     /* 1: create a new split container */
 828     Con *split = con_new(NULL, NULL);
 829     split->parent = ws;
 830
 831     /* 2: copy layout from workspace */
 832     split->layout = ws->layout;
 833
 834     Con *old_focused = TAILQ_FIRST(&(ws->focus_head));
 835
 836     /* 3: move the existing cons of this workspace below the new con */
 837     DLOG("Moving cons\n");
 838     while (!TAILQ_EMPTY(&(ws->nodes_head))) {
 839         Con *child = TAILQ_FIRST(&(ws->nodes_head));
 840         con_detach(child);
 841         con_attach(child, split, true);
 842     }
 843
 844     /* 4: switch workspace layout */
 845     ws->layout = (orientation == HORIZ) ? L_SPLITH : L_SPLITV;
 846     DLOG("split->layout = %d, ws->layout = %d\n", split->layout, ws->layout);
 847
 848     /* 5: attach the new split container to the workspace */
 849     DLOG("Attaching new split (%p) to ws (%p)\n", split, ws);
 850     con_attach(split, ws, false);
 851
 852     /* 6: fix the percentages */
 853     con_fix_percent(ws);
 854
 855     if (old_focused)
 856         con_focus(old_focused);
 857 }
 858
 859 /*
 860  * Called when a new con (with a window, not an empty or split con) should be
 861  * attached to the workspace (for example when managing a new window or when
 862  * moving an existing window to the workspace level).
 863  *
 864  * Depending on the workspace_layout setting, this function either returns the
 865  * workspace itself (default layout) or creates a new stacked/tabbed con and
 866  * returns that.
 867  *
 868  */
 869 Con *workspace_attach_to(Con *ws) {
 870     DLOG("Attaching a window to workspace %p / %s\n", ws, ws->name);
 871
 872     if (ws->workspace_layout == L_DEFAULT) {
 873         DLOG("Default layout, just attaching it to the workspace itself.\n");
 874         return ws;
 875     }
 876
 877     DLOG("Non-default layout, creating a new split container\n");
 878     /* 1: create a new split container */
 879     Con *new = con_new(NULL, NULL);
 880     new->parent = ws;
 881
 882     /* 2: set the requested layout on the split con */
 883     new->layout = ws->workspace_layout;
 884
 885     /* 4: attach the new split container to the workspace */
 886     DLOG("Attaching new split %p to workspace %p\n", new, ws);
 887     con_attach(new, ws, false);
 888
 889     /* 5: fix the percentages */
 890     con_fix_percent(ws);
 891
 892     return new;
 893 }
 894
 895 /**
 896  * Creates a new container and re-parents all of children from the given
 897  * workspace into it.
 898  *
 899  * The container inherits the layout from the workspace.
 900  */
 901 Con *workspace_encapsulate(Con *ws) {
 902     if (TAILQ_EMPTY(&(ws->nodes_head))) {
 903         ELOG("Workspace %p / %s has no children to encapsulate\n", ws, ws->name);
 904         return NULL;
 905     }
 906
 907     Con *new = con_new(NULL, NULL);
 908     new->parent = ws;
 909     new->layout = ws->layout;
 910
 911     DLOG("Moving children of workspace %p / %s into container %p\n",
 912          ws, ws->name, new);
 913
 914     Con *child;
 915     while (!TAILQ_EMPTY(&(ws->nodes_head))) {
 916         child = TAILQ_FIRST(&(ws->nodes_head));
 917         con_detach(child);
 918         con_attach(child, new, true);
 919     }
 920
 921     con_attach(new, ws, true);
 922
 923     return new;
 924 }
 925
 926 /**
 927  * Move the given workspace to the specified output.
 928  * This returns true if and only if moving the workspace was successful.
 929  */
 930 bool workspace_move_to_output(Con *ws, char *name) {
 931     LOG("Trying to move workspace %p / %s to output \"%s\".\n", ws, ws->name, name);
 932
 933     Con *current_output_con = con_get_output(ws);
 934     if (!current_output_con) {
 935         ELOG("Could not get the output container for workspace %p / %s.\n", ws, ws->name);
 936         return false;
 937     }
 938
 939     Output *current_output = get_output_by_name(current_output_con->name);
 940     if (!current_output) {
 941         ELOG("Cannot get current output. This is a bug in i3.\n");
 942         return false;
 943     }
 944     Output *output = get_output_from_string(current_output, name);
 945     if (!output) {
 946         ELOG("Could not get output from string \"%s\"\n", name);
 947         return false;
 948     }
 949
 950     Con *content = output_get_content(output->con);
 951     LOG("got output %p with content %p\n", output, content);
 952
 953     Con *previously_visible_ws = TAILQ_FIRST(&(content->nodes_head));
 954     LOG("Previously visible workspace = %p / %s\n", previously_visible_ws, previously_visible_ws->name);
 955
 956     bool workspace_was_visible = workspace_is_visible(ws);
 957     if (con_num_children(ws->parent) == 1) {
 958         LOG("Creating a new workspace to replace \"%s\" (last on its output).\n", ws->name);
 959
 960         /* check if we can find a workspace assigned to this output */
 961         bool used_assignment = false;
 962         struct Workspace_Assignment *assignment;
 963         TAILQ_FOREACH(assignment, &ws_assignments, ws_assignments) {
 964             if (assignment->output == NULL || strcmp(assignment->output, current_output->name) != 0)
 965                 continue;
 966
 967             /* check if this workspace is already attached to the tree */
 968             Con *workspace = NULL, *out;
 969             TAILQ_FOREACH(out, &(croot->nodes_head), nodes)
 970             GREP_FIRST(workspace, output_get_content(out),
 971                        !strcasecmp(child->name, assignment->name));
 972             if (workspace != NULL)
 973                 continue;
 974
 975             /* so create the workspace referenced to by this assignment */
 976             LOG("Creating workspace from assignment %s.\n", assignment->name);
 977             workspace_get(assignment->name, NULL);
 978             used_assignment = true;
 979             break;
 980         }
 981
 982         /* if we couldn't create the workspace using an assignment, create
 983          * it on the output */
 984         if (!used_assignment)
 985             create_workspace_on_output(current_output, ws->parent);
 986
 987         /* notify the IPC listeners */
 988         ipc_send_workspace_event("init", ws, NULL);
 989     }
 990     DLOG("Detaching\n");
 991
 992     /* detach from the old output and attach to the new output */
 993     Con *old_content = ws->parent;
 994     con_detach(ws);
 995     if (workspace_was_visible) {
 996         /* The workspace which we just detached was visible, so focus
 997          * the next one in the focus-stack. */
 998         Con *focus_ws = TAILQ_FIRST(&(old_content->focus_head));
 999         LOG("workspace was visible, focusing %p / %s now\n", focus_ws, focus_ws->name);
1000         workspace_show(focus_ws);
1001     }
1002     con_attach(ws, content, false);
1003
1004     /* fix the coordinates of the floating containers */
1005     Con *floating_con;
1006     TAILQ_FOREACH(floating_con, &(ws->floating_head), floating_windows)
1007     floating_fix_coordinates(floating_con, &(old_content->rect), &(content->rect));
1008
1009     ipc_send_workspace_event("move", ws, NULL);
1010     if (workspace_was_visible) {
1011         /* Focus the moved workspace on the destination output. */
1012         workspace_show(ws);
1013     }
1014
1015     /* NB: We cannot simply work with previously_visible_ws since it might
1016      * have been cleaned up by workspace_show() already, depending on the
1017      * focus order/number of other workspaces on the output.
1018      * Instead, we loop through the available workspaces and only work with
1019      * previously_visible_ws if we still find it. */
1020     TAILQ_FOREACH(ws, &(content->nodes_head), nodes) {
1021         if (ws != previously_visible_ws)
1022             continue;
1023
1024         /* Call the on_remove_child callback of the workspace which previously
1025          * was visible on the destination output. Since it is no longer
1026          * visible, it might need to get cleaned up. */
1027         CALL(previously_visible_ws, on_remove_child);
1028         break;
1029     }
1030
1031     return true;
1032 }