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

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * workspace.c: Functions for modifying workspaces
  11  *
  12  */
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <limits.h>
  17 #include <err.h>
  18
  19 #include "util.h"
  20 #include "data.h"
  21 #include "i3.h"
  22 #include "config.h"
  23 #include "xcb.h"
  24 #include "table.h"
  25 #include "randr.h"
  26 #include "layout.h"
  27 #include "workspace.h"
  28 #include "client.h"
  29 #include "log.h"
  30 #include "ewmh.h"
  31 #include "ipc.h"
  32
  33 /*
  34  * Returns a pointer to the workspace with the given number (starting at 0),
  35  * creating the workspace if necessary (by allocating the necessary amount of
  36  * memory and initializing the data structures correctly).
  37  *
  38  */
  39 Workspace *workspace_get(int number) {
  40         Workspace *ws = NULL;
  41         TAILQ_FOREACH(ws, workspaces, workspaces)
  42                 if (ws->num == number)
  43                         return ws;
  44
  45         /* If we are still there, we could not find the requested workspace. */
  46         int last_ws = TAILQ_LAST(workspaces, workspaces_head)->num;
  47
  48         DLOG("We need to initialize that one, last ws = %d\n", last_ws);
  49
  50         for (int c = last_ws; c < number; c++) {
  51                 DLOG("Creating new ws\n");
  52
  53                 ws = scalloc(sizeof(Workspace));
  54                 ws->num = c+1;
  55                 TAILQ_INIT(&(ws->floating_clients));
  56                 expand_table_cols(ws);
  57                 expand_table_rows(ws);
  58                 workspace_set_name(ws, NULL);
  59
  60                 TAILQ_INSERT_TAIL(workspaces, ws, workspaces);
  61
  62                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"create\"}");
  63         }
  64         DLOG("done\n");
  65
  66         ewmh_update_workarea();
  67
  68         return ws;
  69 }
  70
  71 /*
  72  * Sets the name (or just its number) for the given workspace. This has to
  73  * be called for every workspace as the rendering function
  74  * (render_internal_bar) relies on workspace->name and workspace->name_len
  75  * being ready-to-use.
  76  *
  77  */
  78 void workspace_set_name(Workspace *ws, const char *name) {
  79         char *label;
  80         int ret;
  81
  82         if (name != NULL)
  83                 ret = asprintf(&label, "%d: %s", ws->num + 1, name);
  84         else ret = asprintf(&label, "%d", ws->num + 1);
  85
  86         if (ret == -1)
  87                 errx(1, "asprintf() failed");
  88
  89         FREE(ws->name);
  90         FREE(ws->utf8_name);
  91
  92         ws->name = convert_utf8_to_ucs2(label, &(ws->name_len));
  93         if (config.font != NULL)
  94                 ws->text_width = predict_text_width(global_conn, config.font, ws->name, ws->name_len);
  95         else ws->text_width = 0;
  96         ws->utf8_name = label;
  97 }
  98
  99 /*
 100  * Returns true if the workspace is currently visible. Especially important for
 101  * multi-monitor environments, as they can have multiple currenlty active
 102  * workspaces.
 103  *
 104  */
 105 bool workspace_is_visible(Workspace *ws) {
 106         return (ws->output != NULL && ws->output->current_workspace == ws);
 107 }
 108
 109 /*
 110  * Switches to the given workspace
 111  *
 112  */
 113 void workspace_show(xcb_connection_t *conn, int workspace) {
 114         bool need_warp = false;
 115         /* t_ws (to workspace) is just a convenience pointer to the workspace we’re switching to */
 116         Workspace *t_ws = workspace_get(workspace-1);
 117
 118         DLOG("show_workspace(%d)\n", workspace);
 119
 120         /* Store current_row/current_col */
 121         c_ws->current_row = current_row;
 122         c_ws->current_col = current_col;
 123
 124         /* Check if the workspace has not been used yet */
 125         workspace_initialize(t_ws, c_ws->output, false);
 126
 127         if (c_ws->output != t_ws->output) {
 128                 /* We need to switch to the other output first */
 129                 DLOG("moving over to other output.\n");
 130
 131                 /* Store the old client */
 132                 Client *old_client = CUR_CELL->currently_focused;
 133
 134                 c_ws = t_ws->output->current_workspace;
 135                 current_col = c_ws->current_col;
 136                 current_row = c_ws->current_row;
 137                 if (CUR_CELL->currently_focused != NULL)
 138                         need_warp = true;
 139                 else {
 140                         Rect *dims = &(c_ws->output->rect);
 141                         xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0,
 142                                          dims->x + (dims->width / 2), dims->y + (dims->height / 2));
 143                 }
 144
 145                 /* Re-decorate the old client, it’s not focused anymore */
 146                 if ((old_client != NULL) && !old_client->dock)
 147                         redecorate_window(conn, old_client);
 148                 else xcb_flush(conn);
 149
 150                 /* We need to check if a global fullscreen-client is blocking
 151                  * the t_ws and if necessary switch that to local fullscreen */
 152                 Client* client = c_ws->fullscreen_client;
 153                 if (client != NULL && client->workspace != c_ws) {
 154                         if (c_ws->fullscreen_client->workspace != c_ws)
 155                                 c_ws->fullscreen_client = NULL;
 156                         client_enter_fullscreen(conn, client, false);
 157                 }
 158         }
 159
 160         /* Check if we need to change something or if we’re already there */
 161         if (c_ws->output->current_workspace->num == (workspace-1)) {
 162                 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
 163                 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
 164                         set_focus(conn, last_focused, true);
 165                 if (need_warp) {
 166                         client_warp_pointer_into(conn, last_focused);
 167                         xcb_flush(conn);
 168                 }
 169
 170                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
 171
 172                 return;
 173         }
 174
 175         Workspace *old_workspace = c_ws;
 176         c_ws = t_ws->output->current_workspace = workspace_get(workspace-1);
 177
 178         current_row = c_ws->current_row;
 179         current_col = c_ws->current_col;
 180         DLOG("new current row = %d, current col = %d\n", current_row, current_col);
 181
 182         /* Map new clients before unmapping old clients to prevent wallpaper flickering */
 183         workspace_map_clients(conn, c_ws);
 184
 185         /* Unmap all clients of the old workspace */
 186         workspace_unmap_clients(conn, old_workspace);
 187
 188         ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
 189
 190         /* POTENTIAL TO IMPROVE HERE: due to the call to _map_clients first and
 191          * render_layout afterwards, there is a short flickering on the source
 192          * workspace (assign ws 3 to output 0, ws 4 to output 1, create single
 193          * client on ws 4, move it to ws 3, switch to ws 3, you’ll see the
 194          * flickering). */
 195
 196         /* Restore focus on the new workspace */
 197         Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
 198         if (last_focused != SLIST_END(&(c_ws->focus_stack)))
 199                 set_focus(conn, last_focused, true);
 200         else xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, root, XCB_CURRENT_TIME);
 201
 202         render_layout(conn);
 203
 204         /* We can warp the pointer only after the window has been
 205          * reconfigured in render_layout, otherwise the pointer will
 206          * be warped to the old position, which will not work when we
 207          * moved it to another output. */
 208         if (last_focused != SLIST_END(&(c_ws->focus_stack)) && need_warp) {
 209                 client_warp_pointer_into(conn, last_focused);
 210                 xcb_flush(conn);
 211         }
 212 }
 213
 214 /*
 215  * Assigns the given workspace to the given output by correctly updating its
 216  * state and reconfiguring all the clients on this workspace.
 217  *
 218  * This is called when initializing a output and when re-assigning it to a
 219  * different output which just got available (if you configured it to be on
 220  * output 1 and you just plugged in output 1).
 221  *
 222  */
 223 void workspace_assign_to(Workspace *ws, Output *output, bool hide_it) {
 224         Client *client;
 225         bool empty = true;
 226         bool visible = workspace_is_visible(ws);
 227
 228         ws->output = output;
 229
 230         /* Copy the dimensions from the virtual output */
 231         memcpy(&(ws->rect), &(ws->output->rect), sizeof(Rect));
 232
 233         ewmh_update_workarea();
 234
 235         /* Force reconfiguration for each client on that workspace */
 236         SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
 237                 client->force_reconfigure = true;
 238                 empty = false;
 239         }
 240
 241         if (empty)
 242                 return;
 243
 244         /* Render the workspace to reconfigure the clients. However, they will be visible now, so… */
 245         render_workspace(global_conn, output, ws);
 246
 247         /* …unless we want to see them at the moment, we should hide that workspace */
 248         if (visible && !hide_it)
 249                 return;
 250
 251         /* however, if this is the current workspace, we only need to adjust
 252          * the output’s current_workspace pointer (and must not unmap the
 253          * windows) */
 254         if (c_ws == ws) {
 255                 DLOG("Need to adjust output->current_workspace...\n");
 256                 output->current_workspace = c_ws;
 257                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
 258                 return;
 259         }
 260
 261         workspace_unmap_clients(global_conn, ws);
 262 }
 263
 264 /*
 265  * Initializes the given workspace if it is not already initialized. The given
 266  * screen is to be understood as a fallback, if the workspace itself either
 267  * was not assigned to a particular screen or cannot be placed there because
 268  * the screen is not attached at the moment.
 269  *
 270  */
 271 void workspace_initialize(Workspace *ws, Output *output, bool recheck) {
 272         Output *old_output;
 273
 274         if (ws->output != NULL && !recheck) {
 275                 DLOG("Workspace already initialized\n");
 276                 return;
 277         }
 278
 279         old_output = ws->output;
 280
 281         /* If this workspace has no preferred output or if the output it wants
 282          * to be on is not available at the moment, we initialize it with
 283          * the output which was given */
 284         if (ws->preferred_output == NULL ||
 285             (ws->output = get_output_by_name(ws->preferred_output)) == NULL)
 286                 ws->output = output;
 287
 288         DLOG("old_output = %p, ws->output = %p\n", old_output, ws->output);
 289         /* If the assignment did not change, we do not need to update anything */
 290         if (old_output != NULL && ws->output == old_output)
 291                 return;
 292
 293         workspace_assign_to(ws, ws->output, false);
 294
 295         ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"init\"}");
 296 }
 297
 298 /*
 299  * Gets the first unused workspace for the given screen, taking into account
 300  * the preferred_output setting of every workspace (workspace assignments).
 301  *
 302  */
 303 Workspace *get_first_workspace_for_output(Output *output) {
 304         Workspace *result = NULL;
 305
 306         Workspace *ws;
 307         TAILQ_FOREACH(ws, workspaces, workspaces) {
 308                 if (ws->preferred_output == NULL ||
 309                     get_output_by_name(ws->preferred_output) != output)
 310                         continue;
 311
 312                 result = ws;
 313                 break;
 314         }
 315
 316         if (result == NULL) {
 317                 /* No assignment found, returning first unused workspace */
 318                 TAILQ_FOREACH(ws, workspaces, workspaces) {
 319                         if (ws->output != NULL)
 320                                 continue;
 321
 322                         result = ws;
 323                         break;
 324                 }
 325         }
 326
 327         if (result == NULL) {
 328                 DLOG("No existing free workspace found to assign, creating a new one\n");
 329
 330                 int last_ws = 0;
 331                 TAILQ_FOREACH(ws, workspaces, workspaces)
 332                         last_ws = ws->num;
 333                 result = workspace_get(last_ws + 1);
 334         }
 335
 336         workspace_initialize(result, output, false);
 337         return result;
 338 }
 339
 340 /*
 341  * Maps all clients (and stack windows) of the given workspace.
 342  *
 343  */
 344 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws) {
 345         Client *client;
 346
 347         ignore_enter_notify_forall(conn, ws, true);
 348
 349         /* Map all clients on the new workspace */
 350         FOR_TABLE(ws)
 351                 CIRCLEQ_FOREACH(client, &(ws->table[cols][rows]->clients), clients)
 352                         client_map(conn, client);
 353
 354         /* Map all floating clients */
 355         if (!ws->floating_hidden)
 356                 TAILQ_FOREACH(client, &(ws->floating_clients), floating_clients)
 357                         client_map(conn, client);
 358
 359         /* Map all stack windows, if any */
 360         struct Stack_Window *stack_win;
 361         SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
 362                 if (stack_win->container->workspace == ws && stack_win->rect.height > 0)
 363                         xcb_map_window(conn, stack_win->window);
 364
 365         ignore_enter_notify_forall(conn, ws, false);
 366 }
 367
 368 /*
 369  * Unmaps all clients (and stack windows) of the given workspace.
 370  *
 371  * This needs to be called separately when temporarily rendering
 372  * a workspace which is not the active workspace to force
 373  * reconfiguration of all clients, like in src/xinerama.c when
 374  * re-assigning a workspace to another screen.
 375  *
 376  */
 377 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws) {
 378         Client *client;
 379         struct Stack_Window *stack_win;
 380
 381         /* Ignore notify events because they would cause focus to be changed */
 382         ignore_enter_notify_forall(conn, u_ws, true);
 383
 384         /* Unmap all clients of the given workspace */
 385         int unmapped_clients = 0;
 386         FOR_TABLE(u_ws)
 387                 CIRCLEQ_FOREACH(client, &(u_ws->table[cols][rows]->clients), clients) {
 388                         DLOG("unmapping normal client %p / %p / %p\n", client, client->frame, client->child);
 389                         client_unmap(conn, client);
 390                         unmapped_clients++;
 391                 }
 392
 393         /* To find floating clients, we traverse the focus stack */
 394         SLIST_FOREACH(client, &(u_ws->focus_stack), focus_clients) {
 395                 if (!client_is_floating(client))
 396                         continue;
 397
 398                 DLOG("unmapping floating client %p / %p / %p\n", client, client->frame, client->child);
 399
 400                 client_unmap(conn, client);
 401                 unmapped_clients++;
 402         }
 403
 404         /* If we did not unmap any clients, the workspace is empty and we can destroy it, at least
 405          * if it is not the current workspace. */
 406         if (unmapped_clients == 0 && u_ws != c_ws) {
 407                 /* Re-assign the workspace of all dock clients which use this workspace */
 408                 Client *dock;
 409                 DLOG("workspace %p is empty\n", u_ws);
 410                 SLIST_FOREACH(dock, &(u_ws->output->dock_clients), dock_clients) {
 411                         if (dock->workspace != u_ws)
 412                                 continue;
 413
 414                         DLOG("Re-assigning dock client to c_ws (%p)\n", c_ws);
 415                         dock->workspace = c_ws;
 416                 }
 417                 u_ws->output = NULL;
 418         }
 419
 420         /* Unmap the stack windows on the given workspace, if any */
 421         SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
 422                 if (stack_win->container->workspace == u_ws)
 423                         xcb_unmap_window(conn, stack_win->window);
 424
 425         ignore_enter_notify_forall(conn, u_ws, false);
 426 }
 427
 428 /*
 429  * Goes through all clients on the given workspace and updates the workspace’s
 430  * urgent flag accordingly.
 431  *
 432  */
 433 void workspace_update_urgent_flag(Workspace *ws) {
 434         Client *current;
 435         bool old_flag = ws->urgent;
 436         bool urgent = false;
 437
 438         SLIST_FOREACH(current, &(ws->focus_stack), focus_clients) {
 439                 if (!current->urgent)
 440                         continue;
 441
 442                 urgent = true;
 443                 break;
 444         }
 445
 446         ws->urgent = urgent;
 447
 448         if (old_flag != urgent)
 449                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
 450 }
 451
 452 /*
 453  * Returns the width of the workspace.
 454  *
 455  */
 456 int workspace_width(Workspace *ws) {
 457         return ws->rect.width;
 458 }
 459
 460 /*
 461  * Returns the effective height of the workspace (without the internal bar and
 462  * without dock clients).
 463  *
 464  */
 465 int workspace_height(Workspace *ws) {
 466         int height = ws->rect.height;
 467         i3Font *font = load_font(global_conn, config.font);
 468
 469         /* Reserve space for dock clients */
 470         Client *client;
 471         SLIST_FOREACH(client, &(ws->output->dock_clients), dock_clients)
 472                 height -= client->desired_height;
 473
 474         /* Space for the internal bar */
 475         if (!config.disable_workspace_bar)
 476                 height -= (font->height + 6);
 477
 478         return height;
 479 }