4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * util.c: Utility functions, which can be useful everywhere.
22 #include <xcb/xcb_icccm.h>
31 static iconv_t conversion_descriptor = 0;
32 struct keyvalue_table_head by_parent = TAILQ_HEAD_INITIALIZER(by_parent);
33 struct keyvalue_table_head by_child = TAILQ_HEAD_INITIALIZER(by_child);
35 int min(int a, int b) {
36 return (a < b ? a : b);
39 int max(int a, int b) {
40 return (a > b ? a : b);
44 * Logs the given message to stdout while prefixing the current time to it.
45 * This is to be called by LOG() which includes filename/linenumber
48 void slog(char *fmt, ...) {
53 /* Get current time */
54 time_t t = time(NULL);
55 /* Convert time to local time (determined by the locale) */
56 struct tm *tmp = localtime(&t);
57 /* Generate time prefix */
58 strftime(timebuf, sizeof(timebuf), "%x %X - ", tmp);
59 printf("%s", timebuf);
65 * Prints the message (see printf()) to stderr, then exits the program.
68 void die(char *fmt, ...) {
72 vfprintf(stderr, fmt, args);
79 * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
80 * the called functions returns NULL, meaning that there is no more memory available
83 void *smalloc(size_t size) {
84 void *result = malloc(size);
85 exit_if_null(result, "Too less memory for malloc(%d)\n", size);
89 void *scalloc(size_t size) {
90 void *result = calloc(size, 1);
91 exit_if_null(result, "Too less memory for calloc(%d)\n", size);
95 char *sstrdup(const char *str) {
96 char *result = strdup(str);
97 exit_if_null(result, "Too less memory for strdup()\n");
102 * The table_* functions emulate the behaviour of libxcb-wm, which in libxcb 0.3.4 suddenly
106 bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value) {
107 struct keyvalue_element *element = scalloc(sizeof(struct keyvalue_element));
109 element->value = value;
111 TAILQ_INSERT_TAIL(head, element, elements);
115 void *table_remove(struct keyvalue_table_head *head, uint32_t key) {
116 struct keyvalue_element *element;
118 TAILQ_FOREACH(element, head, elements)
119 if (element->key == key) {
120 void *value = element->value;
121 TAILQ_REMOVE(head, element, elements);
129 void *table_get(struct keyvalue_table_head *head, uint32_t key) {
130 struct keyvalue_element *element;
132 TAILQ_FOREACH(element, head, elements)
133 if (element->key == key)
134 return element->value;
140 * Starts the given application by passing it through a shell. We use double fork
141 * to avoid zombie processes. As the started application’s parent exits (immediately),
142 * the application is reparented to init (process-id 1), which correctly handles
143 * childs, so we don’t have to do it :-).
145 * The shell is determined by looking for the SHELL environment variable. If it
146 * does not exist, /bin/sh is used.
149 void start_application(const char *command) {
153 /* Stores the path of the shell */
154 static const char *shell = NULL;
157 if ((shell = getenv("SHELL")) == NULL)
160 /* This is the child */
161 execl(shell, shell, "-c", command, NULL);
170 * Checks a generic cookie for errors and quits with the given message if there
174 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
175 xcb_generic_error_t *error = xcb_request_check(conn, cookie);
177 fprintf(stderr, "ERROR: %s : %d\n", err_message , error->error_code);
178 xcb_disconnect(conn);
184 * Converts the given string to UCS-2 big endian for use with
185 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
186 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
187 * returned. It has to be freed when done.
190 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
191 size_t input_size = strlen(input) + 1;
192 /* UCS-2 consumes exactly two bytes for each glyph */
193 int buffer_size = input_size * 2;
195 char *buffer = smalloc(buffer_size);
196 size_t output_size = buffer_size;
197 /* We need to use an additional pointer, because iconv() modifies it */
198 char *output = buffer;
200 /* We convert the input into UCS-2 big endian */
201 if (conversion_descriptor == 0) {
202 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
203 if (conversion_descriptor == 0) {
204 fprintf(stderr, "error opening the conversion context\n");
209 /* Get the conversion descriptor back to original state */
210 iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
212 /* Convert our text */
213 int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
214 if (rc == (size_t)-1) {
215 perror("Converting to UCS-2 failed");
216 if (real_strlen != NULL)
221 if (real_strlen != NULL)
222 *real_strlen = ((buffer_size - output_size) / 2) - 1;
228 * Removes the given client from the container, either because it will be inserted into another
229 * one or because it was unmapped
232 void remove_client_from_container(xcb_connection_t *conn, Client *client, Container *container) {
233 CIRCLEQ_REMOVE(&(container->clients), client, clients);
235 SLIST_REMOVE(&(container->workspace->focus_stack), client, Client, focus_clients);
237 /* If the container will be empty now and is in stacking mode, we need to
238 unmap the stack_win */
239 if (CIRCLEQ_EMPTY(&(container->clients)) && container->mode == MODE_STACK) {
240 struct Stack_Window *stack_win = &(container->stack_win);
241 stack_win->rect.height = 0;
242 xcb_unmap_window(conn, stack_win->window);
247 * Returns the client which comes next in focus stack (= was selected before) for
248 * the given container, optionally excluding the given client.
251 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
253 SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
254 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
260 * Sets the given client as focused by updating the data structures correctly,
261 * updating the X input focus and finally re-decorating both windows (to signalize
262 * the user the new focus situation)
265 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
266 /* The dock window cannot be focused, but enter notifies are still handled correctly */
270 /* Store the old client */
271 Client *old_client = CUR_CELL->currently_focused;
273 /* Check if the focus needs to be changed at all */
274 if (!set_anyways && (old_client == client)) {
275 LOG("old_client == client, not changing focus\n");
279 /* Store current_row/current_col */
280 c_ws->current_row = current_row;
281 c_ws->current_col = current_col;
282 c_ws = client->container->workspace;
284 /* Update container */
285 client->container->currently_focused = client;
287 current_col = client->container->col;
288 current_row = client->container->row;
290 LOG("set_focus(frame %08x, child %08x, name %s)\n", client->frame, client->child, client->name);
291 /* Set focus to the entered window, and flush xcb buffer immediately */
292 xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
293 //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
295 /* Get the client which was last focused in this particular container, it may be a different
296 one than old_client */
297 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
299 /* In stacking containers, raise the client in respect to the one which was focused before */
300 if (client->container->mode == MODE_STACK) {
301 /* We need to get the client again, this time excluding the current client, because
302 * we might have just gone into stacking mode and need to raise */
303 Client *last_focused = get_last_focused_client(conn, client->container, client);
305 if (last_focused != NULL) {
306 LOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
307 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
308 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
312 /* If it is the same one as old_client, we save us the unnecessary redecorate */
313 if ((last_focused != NULL) && (last_focused != old_client))
314 redecorate_window(conn, last_focused);
316 /* If we’re in stacking mode, this renders the container to update changes in the title
317 bars and to raise the focused client */
318 if ((old_client != NULL) && (old_client != client) && !old_client->dock)
319 redecorate_window(conn, old_client);
321 SLIST_REMOVE(&(client->container->workspace->focus_stack), client, Client, focus_clients);
322 SLIST_INSERT_HEAD(&(client->container->workspace->focus_stack), client, focus_clients);
324 /* redecorate_window flushes, so we don’t need to */
325 redecorate_window(conn, client);
329 * Called when the user switches to another mode or when the container is
330 * destroyed and thus needs to be cleaned up.
333 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
334 /* When going out of stacking mode, we need to close the window */
335 struct Stack_Window *stack_win = &(container->stack_win);
337 SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
339 xcb_free_gc(conn, stack_win->gc);
340 xcb_destroy_window(conn, stack_win->window);
342 stack_win->rect.width = -1;
343 stack_win->rect.height = -1;
347 * Switches the layout of the given container taking care of the necessary house-keeping
350 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
351 if (mode == MODE_STACK) {
352 /* When we’re already in stacking mode, nothing has to be done */
353 if (container->mode == MODE_STACK)
356 /* When entering stacking mode, we need to open a window on which we can draw the
357 title bars of the clients, it has height 1 because we don’t bother here with
358 calculating the correct height - it will be adjusted when rendering anyways. */
359 Rect rect = {container->x, container->y, container->width, 1 };
364 /* Don’t generate events for our new window, it should *not* be managed */
365 mask |= XCB_CW_OVERRIDE_REDIRECT;
368 /* We want to know when… */
369 mask |= XCB_CW_EVENT_MASK;
370 values[1] = XCB_EVENT_MASK_ENTER_WINDOW | /* …mouse is moved into our window */
371 XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed */
372 XCB_EVENT_MASK_EXPOSURE; /* …our window needs to be redrawn */
374 struct Stack_Window *stack_win = &(container->stack_win);
375 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, mask, values);
377 /* Generate a graphics context for the titlebar */
378 stack_win->gc = xcb_generate_id(conn);
379 xcb_create_gc(conn, stack_win->gc, stack_win->window, 0, 0);
381 stack_win->container = container;
383 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
385 if (container->mode == MODE_STACK)
386 leave_stack_mode(conn, container);
388 container->mode = mode;
390 /* Force reconfiguration of each client */
393 CIRCLEQ_FOREACH(client, &(container->clients), clients)
394 client->force_reconfigure = true;
398 if (container->currently_focused != NULL)
399 set_focus(conn, container->currently_focused, true);
403 * Warps the pointer into the given client (in the middle of it, to be specific), therefore
407 void warp_pointer_into(xcb_connection_t *conn, Client *client) {
408 int mid_x = client->rect.width / 2,
409 mid_y = client->rect.height / 2;
410 xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, mid_x, mid_y);
414 * Toggles fullscreen mode for the given client. It updates the data structures and
415 * reconfigures (= resizes/moves) the client and its frame to the full size of the
416 * screen. When leaving fullscreen, re-rendering the layout is forced.
419 void toggle_fullscreen(xcb_connection_t *conn, Client *client) {
420 /* clients without a container (docks) cannot be focused */
421 assert(client->container != NULL);
423 Workspace *workspace = client->container->workspace;
425 if (!client->fullscreen) {
426 if (workspace->fullscreen_client != NULL) {
427 LOG("Not entering fullscreen mode, there already is a fullscreen client.\n");
430 client->fullscreen = true;
431 workspace->fullscreen_client = client;
432 LOG("Entering fullscreen mode...\n");
433 /* We just entered fullscreen mode, let’s configure the window */
434 uint32_t mask = XCB_CONFIG_WINDOW_X |
435 XCB_CONFIG_WINDOW_Y |
436 XCB_CONFIG_WINDOW_WIDTH |
437 XCB_CONFIG_WINDOW_HEIGHT;
438 uint32_t values[4] = {workspace->rect.x,
440 workspace->rect.width,
441 workspace->rect.height};
443 LOG("child itself will be at %dx%d with size %dx%d\n",
444 values[0], values[1], values[2], values[3]);
446 xcb_configure_window(conn, client->frame, mask, values);
448 /* Child’s coordinates are relative to the parent (=frame) */
451 xcb_configure_window(conn, client->child, mask, values);
453 /* Raise the window */
454 values[0] = XCB_STACK_MODE_ABOVE;
455 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_STACK_MODE, values);
457 Rect child_rect = workspace->rect;
458 child_rect.x = child_rect.y = 0;
459 fake_configure_notify(conn, child_rect, client->child);
461 LOG("leaving fullscreen mode\n");
462 client->fullscreen = false;
463 workspace->fullscreen_client = NULL;
464 /* Because the coordinates of the window haven’t changed, it would not be
465 re-configured if we don’t set the following flag */
466 client->force_reconfigure = true;
467 /* We left fullscreen mode, redraw the whole layout to ensure enternotify events are disabled */
475 * Returns true if the client supports the given protocol atom (like WM_DELETE_WINDOW)
478 static bool client_supports_protocol(xcb_connection_t *conn, Client *client, xcb_atom_t atom) {
479 xcb_get_property_cookie_t cookie;
480 xcb_get_wm_protocols_reply_t protocols;
483 cookie = xcb_get_wm_protocols_unchecked(conn, client->child, atoms[WM_PROTOCOLS]);
484 if (xcb_get_wm_protocols_reply(conn, cookie, &protocols, NULL) != 1)
487 /* Check if the client’s protocols have the requested atom set */
488 for (uint32_t i = 0; i < protocols.atoms_len; i++)
489 if (protocols.atoms[i] == atom)
492 xcb_get_wm_protocols_reply_wipe(&protocols);
498 * Kills the given window using WM_DELETE_WINDOW or xcb_kill_window
501 void kill_window(xcb_connection_t *conn, Client *window) {
502 /* If the client does not support WM_DELETE_WINDOW, we kill it the hard way */
503 if (!client_supports_protocol(conn, window, atoms[WM_DELETE_WINDOW])) {
504 LOG("Killing window the hard way\n");
505 xcb_kill_client(conn, window->child);
509 xcb_client_message_event_t ev;
511 memset(&ev, 0, sizeof(xcb_client_message_event_t));
513 ev.response_type = XCB_CLIENT_MESSAGE;
514 ev.window = window->child;
515 ev.type = atoms[WM_PROTOCOLS];
517 ev.data.data32[0] = atoms[WM_DELETE_WINDOW];
518 ev.data.data32[1] = XCB_CURRENT_TIME;
520 LOG("Sending WM_DELETE to the client\n");
521 xcb_send_event(conn, false, window->child, XCB_EVENT_MASK_NO_EVENT, (char*)&ev);