4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * workspace.c: Functions for modifying workspaces
27 #include "workspace.h"
32 * Returns a pointer to the workspace with the given number (starting at 0),
33 * creating the workspace if necessary (by allocating the necessary amount of
34 * memory and initializing the data structures correctly).
37 Workspace *workspace_get(int number) {
39 TAILQ_FOREACH(ws, workspaces, workspaces)
40 if (ws->num == number)
43 /* If we are still there, we could not find the requested workspace. */
44 int last_ws = TAILQ_LAST(workspaces, workspaces_head)->num;
46 DLOG("We need to initialize that one, last ws = %d\n", last_ws);
48 for (int c = last_ws; c < number; c++) {
49 DLOG("Creating new ws\n");
51 ws = scalloc(sizeof(Workspace));
53 TAILQ_INIT(&(ws->floating_clients));
54 expand_table_cols(ws);
55 expand_table_rows(ws);
56 workspace_set_name(ws, NULL);
58 TAILQ_INSERT_TAIL(workspaces, ws, workspaces);
66 * Sets the name (or just its number) for the given workspace. This has to
67 * be called for every workspace as the rendering function
68 * (render_internal_bar) relies on workspace->name and workspace->name_len
72 void workspace_set_name(Workspace *ws, const char *name) {
77 ret = asprintf(&label, "%d: %s", ws->num + 1, name);
78 else ret = asprintf(&label, "%d", ws->num + 1);
81 errx(1, "asprintf() failed");
85 ws->name = convert_utf8_to_ucs2(label, &(ws->name_len));
86 if (config.font != NULL)
87 ws->text_width = predict_text_width(global_conn, config.font, ws->name, ws->name_len);
88 else ws->text_width = 0;
94 * Returns true if the workspace is currently visible. Especially important for
95 * multi-monitor environments, as they can have multiple currenlty active
99 bool workspace_is_visible(Workspace *ws) {
100 return (ws->screen->current_workspace == ws);
104 * Switches to the given workspace
107 void workspace_show(xcb_connection_t *conn, int workspace) {
108 bool need_warp = false;
109 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
110 /* t_ws (to workspace) is just a convenience pointer to the workspace we’re switching to */
111 Workspace *t_ws = workspace_get(workspace-1);
113 DLOG("show_workspace(%d)\n", workspace);
115 /* Store current_row/current_col */
116 c_ws->current_row = current_row;
117 c_ws->current_col = current_col;
119 /* Check if the workspace has not been used yet */
120 workspace_initialize(t_ws, c_ws->screen, false);
122 if (c_ws->screen != t_ws->screen) {
123 /* We need to switch to the other screen first */
124 DLOG("moving over to other screen.\n");
126 /* Store the old client */
127 Client *old_client = CUR_CELL->currently_focused;
129 c_ws = t_ws->screen->current_workspace;
130 current_col = c_ws->current_col;
131 current_row = c_ws->current_row;
132 if (CUR_CELL->currently_focused != NULL)
135 Rect *dims = &(c_ws->screen->rect);
136 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0,
137 dims->x + (dims->width / 2), dims->y + (dims->height / 2));
140 /* Re-decorate the old client, it’s not focused anymore */
141 if ((old_client != NULL) && !old_client->dock)
142 redecorate_window(conn, old_client);
143 else xcb_flush(conn);
146 /* Check if we need to change something or if we’re already there */
147 if (c_ws->screen->current_workspace->num == (workspace-1)) {
148 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
149 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
150 set_focus(conn, last_focused, true);
152 client_warp_pointer_into(conn, last_focused);
159 Workspace *old_workspace = c_ws;
160 c_ws = t_ws->screen->current_workspace = workspace_get(workspace-1);
162 /* Unmap all clients of the old workspace */
163 workspace_unmap_clients(conn, old_workspace);
165 current_row = c_ws->current_row;
166 current_col = c_ws->current_col;
167 DLOG("new current row = %d, current col = %d\n", current_row, current_col);
169 workspace_map_clients(conn, c_ws);
171 /* POTENTIAL TO IMPROVE HERE: due to the call to _map_clients first and
172 * render_layout afterwards, there is a short flickering on the source
173 * workspace (assign ws 3 to screen 0, ws 4 to screen 1, create single
174 * client on ws 4, move it to ws 3, switch to ws 3, you’ll see the
177 /* Restore focus on the new workspace */
178 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
179 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
180 set_focus(conn, last_focused, true);
181 else xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, root, XCB_CURRENT_TIME);
185 /* We can warp the pointer only after the window has been
186 * reconfigured in render_layout, otherwise the pointer will
187 * be warped to the old position, which will not work when we
188 * moved it to another screen. */
189 if (last_focused != SLIST_END(&(c_ws->focus_stack)) && need_warp) {
190 client_warp_pointer_into(conn, last_focused);
197 * Parses the preferred_screen property of a workspace. You can either specify
198 * the screen number (it is not given that the screen numbering always stays
199 * the same) or the screen coordinates (exact coordinates, e.g. 1280 will match
200 * the screen starting at x=1280, but 1281 will not). For coordinates, you can
201 * either specify an x coordinate ("1280") or an y coordinate ("x800") or both
205 static i3Screen *get_screen_from_preference(struct screens_head *slist, char *preference) {
208 int preferred_screen = strtol(preference, &rest, 10);
210 DLOG("Getting screen for preference \"%s\" (%d)\n", preference, preferred_screen);
212 if ((rest == preference) || (preferred_screen >= num_screens)) {
213 int x = INT_MAX, y = INT_MAX;
214 if (strchr(preference, 'x') != NULL) {
215 /* Check if only the y coordinate was specified */
216 if (*preference == 'x')
217 y = atoi(preference+1);
219 x = atoi(preference);
220 y = atoi(strchr(preference, 'x') + 1);
223 x = atoi(preference);
226 DLOG("Looking for screen at %d x %d\n", x, y);
228 TAILQ_FOREACH(screen, slist, screens)
229 if ((x == INT_MAX || screen->rect.x == x) &&
230 (y == INT_MAX || screen->rect.y == y)) {
231 DLOG("found %p\n", screen);
235 DLOG("none found\n");
239 TAILQ_FOREACH(screen, slist, screens)
240 if (c++ == preferred_screen)
248 * Assigns the given workspace to the given screen by correctly updating its
249 * state and reconfiguring all the clients on this workspace.
251 * This is called when initializing a screen and when re-assigning it to a
252 * different screen which just got available (if you configured it to be on
253 * screen 1 and you just plugged in screen 1).
256 void workspace_assign_to(Workspace *ws, i3Screen *screen) {
262 /* Copy the dimensions from the virtual screen */
263 memcpy(&(ws->rect), &(ws->screen->rect), sizeof(Rect));
265 /* Force reconfiguration for each client on that workspace */
267 CIRCLEQ_FOREACH(client, &(ws->table[cols][rows]->clients), clients) {
268 client->force_reconfigure = true;
275 /* Render the workspace to reconfigure the clients. However, they will be visible now, so… */
276 render_workspace(global_conn, screen, ws);
278 /* …unless we want to see them at the moment, we should hide that workspace */
279 if (workspace_is_visible(ws))
282 workspace_unmap_clients(global_conn, ws);
285 DLOG("Need to adjust c_ws...\n");
286 c_ws = screen->current_workspace;
291 * Initializes the given workspace if it is not already initialized. The given
292 * screen is to be understood as a fallback, if the workspace itself either
293 * was not assigned to a particular screen or cannot be placed there because
294 * the screen is not attached at the moment.
297 void workspace_initialize(Workspace *ws, i3Screen *screen, bool recheck) {
298 i3Screen *old_screen;
300 if (ws->screen != NULL && !recheck) {
301 DLOG("Workspace already initialized\n");
305 old_screen = ws->screen;
307 /* If this workspace has no preferred screen or if the screen it wants
308 * to be on is not available at the moment, we initialize it with
309 * the screen which was given */
310 if (ws->preferred_screen == NULL ||
311 (ws->screen = get_screen_from_preference(virtual_screens, ws->preferred_screen)) == NULL)
314 DLOG("old_screen = %p, ws->screen = %p\n", old_screen, ws->screen);
315 /* If the assignment did not change, we do not need to update anything */
316 if (old_screen != NULL && ws->screen == old_screen)
319 workspace_assign_to(ws, ws->screen);
323 * Gets the first unused workspace for the given screen, taking into account
324 * the preferred_screen setting of every workspace (workspace assignments).
327 Workspace *get_first_workspace_for_screen(struct screens_head *slist, i3Screen *screen) {
328 Workspace *result = NULL;
331 TAILQ_FOREACH(ws, workspaces, workspaces) {
332 if (ws->preferred_screen == NULL ||
333 !screens_are_equal(get_screen_from_preference(slist, ws->preferred_screen), screen))
340 if (result == NULL) {
341 /* No assignment found, returning first unused workspace */
343 TAILQ_FOREACH(ws, workspaces, workspaces) {
344 if (ws->screen != NULL)
352 if (result == NULL) {
353 DLOG("No existing free workspace found to assign, creating a new one\n");
357 TAILQ_FOREACH(ws, workspaces, workspaces)
359 result = workspace_get(last_ws + 1);
362 workspace_initialize(result, screen, false);
367 * Maps all clients (and stack windows) of the given workspace.
370 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws) {
373 ignore_enter_notify_forall(conn, ws, true);
375 /* Map all clients on the new workspace */
377 CIRCLEQ_FOREACH(client, &(ws->table[cols][rows]->clients), clients)
378 client_map(conn, client);
380 /* Map all floating clients */
381 if (!ws->floating_hidden)
382 TAILQ_FOREACH(client, &(ws->floating_clients), floating_clients)
383 client_map(conn, client);
385 /* Map all stack windows, if any */
386 struct Stack_Window *stack_win;
387 SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
388 if (stack_win->container->workspace == ws)
389 xcb_map_window(conn, stack_win->window);
391 ignore_enter_notify_forall(conn, ws, false);
395 * Unmaps all clients (and stack windows) of the given workspace.
397 * This needs to be called separately when temporarily rendering
398 * a workspace which is not the active workspace to force
399 * reconfiguration of all clients, like in src/xinerama.c when
400 * re-assigning a workspace to another screen.
403 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws) {
405 struct Stack_Window *stack_win;
407 /* Ignore notify events because they would cause focus to be changed */
408 ignore_enter_notify_forall(conn, u_ws, true);
410 /* Unmap all clients of the given workspace */
411 int unmapped_clients = 0;
413 CIRCLEQ_FOREACH(client, &(u_ws->table[cols][rows]->clients), clients) {
414 DLOG("unmapping normal client %p / %p / %p\n", client, client->frame, client->child);
415 client_unmap(conn, client);
419 /* To find floating clients, we traverse the focus stack */
420 SLIST_FOREACH(client, &(u_ws->focus_stack), focus_clients) {
421 if (!client_is_floating(client))
424 DLOG("unmapping floating client %p / %p / %p\n", client, client->frame, client->child);
426 client_unmap(conn, client);
430 /* If we did not unmap any clients, the workspace is empty and we can destroy it, at least
431 * if it is not the current workspace. */
432 if (unmapped_clients == 0 && u_ws != c_ws) {
433 /* Re-assign the workspace of all dock clients which use this workspace */
435 DLOG("workspace %p is empty\n", u_ws);
436 SLIST_FOREACH(dock, &(u_ws->screen->dock_clients), dock_clients) {
437 if (dock->workspace != u_ws)
440 DLOG("Re-assigning dock client to c_ws (%p)\n", c_ws);
441 dock->workspace = c_ws;
446 /* Unmap the stack windows on the given workspace, if any */
447 SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
448 if (stack_win->container->workspace == u_ws)
449 xcb_unmap_window(conn, stack_win->window);
451 ignore_enter_notify_forall(conn, u_ws, false);
455 * Goes through all clients on the given workspace and updates the workspace’s
456 * urgent flag accordingly.
459 void workspace_update_urgent_flag(Workspace *ws) {
462 SLIST_FOREACH(current, &(ws->focus_stack), focus_clients) {
463 if (!current->urgent)
474 * Returns the width of the workspace.
477 int workspace_width(Workspace *ws) {
478 return ws->rect.width;
482 * Returns the effective height of the workspace (without the internal bar and
483 * without dock clients).
486 int workspace_height(Workspace *ws) {
487 int height = ws->rect.height;
488 i3Font *font = load_font(global_conn, config.font);
490 /* Reserve space for dock clients */
492 SLIST_FOREACH(client, &(ws->screen->dock_clients), dock_clients)
493 height -= client->desired_height;
495 /* Space for the internal bar */
496 height -= (font->height + 6);