]> git.sur5r.net Git - i3/i3/blob - src/workspace.c
Merge branch 'next'
[i3/i3] / 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\":\"init\"}");
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         xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
116         /* t_ws (to workspace) is just a convenience pointer to the workspace we’re switching to */
117         Workspace *t_ws = workspace_get(workspace-1);
118
119         DLOG("show_workspace(%d)\n", workspace);
120
121         /* Store current_row/current_col */
122         c_ws->current_row = current_row;
123         c_ws->current_col = current_col;
124
125         /* Check if the workspace has not been used yet */
126         workspace_initialize(t_ws, c_ws->output, false);
127
128         if (c_ws->output != t_ws->output) {
129                 /* We need to switch to the other output first */
130                 DLOG("moving over to other output.\n");
131
132                 /* Store the old client */
133                 Client *old_client = CUR_CELL->currently_focused;
134
135                 c_ws = t_ws->output->current_workspace;
136                 current_col = c_ws->current_col;
137                 current_row = c_ws->current_row;
138                 if (CUR_CELL->currently_focused != NULL)
139                         need_warp = true;
140                 else {
141                         Rect *dims = &(c_ws->output->rect);
142                         xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0,
143                                          dims->x + (dims->width / 2), dims->y + (dims->height / 2));
144                 }
145
146                 /* Re-decorate the old client, it’s not focused anymore */
147                 if ((old_client != NULL) && !old_client->dock)
148                         redecorate_window(conn, old_client);
149                 else xcb_flush(conn);
150
151                 /* We need to check if a global fullscreen-client is blocking
152                  * the t_ws and if necessary switch that to local fullscreen */
153                 Client* client = c_ws->fullscreen_client;
154                 if (client != NULL && client->workspace != c_ws) {
155                         if (c_ws->fullscreen_client->workspace != c_ws)
156                                 c_ws->fullscreen_client = NULL;
157                         client_enter_fullscreen(conn, client, false);
158                 }
159         }
160
161         /* Check if we need to change something or if we’re already there */
162         if (c_ws->output->current_workspace->num == (workspace-1)) {
163                 Client *last_focused = SLIST_FIRST(&(c_ws->focus_stack));
164                 if (last_focused != SLIST_END(&(c_ws->focus_stack)))
165                         set_focus(conn, last_focused, true);
166                 if (need_warp) {
167                         client_warp_pointer_into(conn, last_focused);
168                         xcb_flush(conn);
169                 }
170
171                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
172
173                 return;
174         }
175
176         Workspace *old_workspace = c_ws;
177         c_ws = t_ws->output->current_workspace = workspace_get(workspace-1);
178
179         /* Unmap all clients of the old workspace */
180         workspace_unmap_clients(conn, old_workspace);
181
182         current_row = c_ws->current_row;
183         current_col = c_ws->current_col;
184         DLOG("new current row = %d, current col = %d\n", current_row, current_col);
185
186         ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"focus\"}");
187
188         workspace_map_clients(conn, c_ws);
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
296 /*
297  * Gets the first unused workspace for the given screen, taking into account
298  * the preferred_output setting of every workspace (workspace assignments).
299  *
300  */
301 Workspace *get_first_workspace_for_output(Output *output) {
302         Workspace *result = NULL;
303
304         Workspace *ws;
305         TAILQ_FOREACH(ws, workspaces, workspaces) {
306                 if (ws->preferred_output == NULL ||
307                     get_output_by_name(ws->preferred_output) != output)
308                         continue;
309
310                 result = ws;
311                 break;
312         }
313
314         if (result == NULL) {
315                 /* No assignment found, returning first unused workspace */
316                 TAILQ_FOREACH(ws, workspaces, workspaces) {
317                         if (ws->output != NULL)
318                                 continue;
319
320                         result = ws;
321                         break;
322                 }
323         }
324
325         if (result == NULL) {
326                 DLOG("No existing free workspace found to assign, creating a new one\n");
327
328                 int last_ws = 0;
329                 TAILQ_FOREACH(ws, workspaces, workspaces)
330                         last_ws = ws->num;
331                 result = workspace_get(last_ws + 1);
332         }
333
334         workspace_initialize(result, output, false);
335         return result;
336 }
337
338 /*
339  * Maps all clients (and stack windows) of the given workspace.
340  *
341  */
342 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws) {
343         Client *client;
344
345         ignore_enter_notify_forall(conn, ws, true);
346
347         /* Map all clients on the new workspace */
348         FOR_TABLE(ws)
349                 CIRCLEQ_FOREACH(client, &(ws->table[cols][rows]->clients), clients)
350                         client_map(conn, client);
351
352         /* Map all floating clients */
353         if (!ws->floating_hidden)
354                 TAILQ_FOREACH(client, &(ws->floating_clients), floating_clients)
355                         client_map(conn, client);
356
357         /* Map all stack windows, if any */
358         struct Stack_Window *stack_win;
359         SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
360                 if (stack_win->container->workspace == ws && stack_win->rect.height > 0)
361                         xcb_map_window(conn, stack_win->window);
362
363         ignore_enter_notify_forall(conn, ws, false);
364 }
365
366 /*
367  * Unmaps all clients (and stack windows) of the given workspace.
368  *
369  * This needs to be called separately when temporarily rendering
370  * a workspace which is not the active workspace to force
371  * reconfiguration of all clients, like in src/xinerama.c when
372  * re-assigning a workspace to another screen.
373  *
374  */
375 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws) {
376         Client *client;
377         struct Stack_Window *stack_win;
378
379         /* Ignore notify events because they would cause focus to be changed */
380         ignore_enter_notify_forall(conn, u_ws, true);
381
382         /* Unmap all clients of the given workspace */
383         int unmapped_clients = 0;
384         FOR_TABLE(u_ws)
385                 CIRCLEQ_FOREACH(client, &(u_ws->table[cols][rows]->clients), clients) {
386                         DLOG("unmapping normal client %p / %p / %p\n", client, client->frame, client->child);
387                         client_unmap(conn, client);
388                         unmapped_clients++;
389                 }
390
391         /* To find floating clients, we traverse the focus stack */
392         SLIST_FOREACH(client, &(u_ws->focus_stack), focus_clients) {
393                 if (!client_is_floating(client))
394                         continue;
395
396                 DLOG("unmapping floating client %p / %p / %p\n", client, client->frame, client->child);
397
398                 client_unmap(conn, client);
399                 unmapped_clients++;
400         }
401
402         /* If we did not unmap any clients, the workspace is empty and we can destroy it, at least
403          * if it is not the current workspace. */
404         if (unmapped_clients == 0 && u_ws != c_ws) {
405                 /* Re-assign the workspace of all dock clients which use this workspace */
406                 Client *dock;
407                 DLOG("workspace %p is empty\n", u_ws);
408                 SLIST_FOREACH(dock, &(u_ws->output->dock_clients), dock_clients) {
409                         if (dock->workspace != u_ws)
410                                 continue;
411
412                         DLOG("Re-assigning dock client to c_ws (%p)\n", c_ws);
413                         dock->workspace = c_ws;
414                 }
415                 u_ws->output = NULL;
416         }
417
418         /* Unmap the stack windows on the given workspace, if any */
419         SLIST_FOREACH(stack_win, &stack_wins, stack_windows)
420                 if (stack_win->container->workspace == u_ws)
421                         xcb_unmap_window(conn, stack_win->window);
422
423         ignore_enter_notify_forall(conn, u_ws, false);
424 }
425
426 /*
427  * Goes through all clients on the given workspace and updates the workspace’s
428  * urgent flag accordingly.
429  *
430  */
431 void workspace_update_urgent_flag(Workspace *ws) {
432         Client *current;
433         bool old_flag = ws->urgent;
434         bool urgent = false;
435
436         SLIST_FOREACH(current, &(ws->focus_stack), focus_clients) {
437                 if (!current->urgent)
438                         continue;
439
440                 urgent = true;
441                 break;
442         }
443
444         ws->urgent = urgent;
445
446         if (old_flag != urgent)
447                 ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
448 }
449
450 /*
451  * Returns the width of the workspace.
452  *
453  */
454 int workspace_width(Workspace *ws) {
455         return ws->rect.width;
456 }
457
458 /*
459  * Returns the effective height of the workspace (without the internal bar and
460  * without dock clients).
461  *
462  */
463 int workspace_height(Workspace *ws) {
464         int height = ws->rect.height;
465         i3Font *font = load_font(global_conn, config.font);
466
467         /* Reserve space for dock clients */
468         Client *client;
469         SLIST_FOREACH(client, &(ws->output->dock_clients), dock_clients)
470                 height -= client->desired_height;
471
472         /* Space for the internal bar */
473         if (!config.disable_workspace_bar)
474                 height -= (font->height + 6);
475
476         return height;
477 }
478
479 /*
480  * Returns the width of the workspace.
481  *
482  */
483 int workspace_width(Workspace *ws) {
484         return ws->rect.width;
485 }
486
487 /*
488  * Returns the effective height of the workspace (without the internal bar and
489  * without dock clients).
490  *
491  */
492 int workspace_height(Workspace *ws) {
493         int height = ws->rect.height;
494         i3Font *font = load_font(global_conn, config.font);
495
496         /* Reserve space for dock clients */
497         Client *client;
498         SLIST_FOREACH(client, &(ws->screen->dock_clients), dock_clients)
499                 height -= client->desired_height;
500
501         /* Space for the internal bar */
502         height -= (font->height + 6);
503
504         return height;
505 }