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

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * util.c: Utility functions, which can be useful everywhere.
  11  *
  12  */
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <unistd.h>
  16 #include <string.h>
  17 #include <sys/wait.h>
  18 #include <stdarg.h>
  19 #include <assert.h>
  20 #include <iconv.h>
  21 #if defined(__OpenBSD__)
  22 #include <sys/cdefs.h>
  23 #endif
  24
  25 #include <xcb/xcb_icccm.h>
  26
  27 #include "i3.h"
  28 #include "data.h"
  29 #include "table.h"
  30 #include "layout.h"
  31 #include "util.h"
  32 #include "xcb.h"
  33 #include "client.h"
  34 #include "log.h"
  35
  36 static iconv_t conversion_descriptor = 0;
  37 struct keyvalue_table_head by_parent = TAILQ_HEAD_INITIALIZER(by_parent);
  38 struct keyvalue_table_head by_child = TAILQ_HEAD_INITIALIZER(by_child);
  39
  40 int min(int a, int b) {
  41         return (a < b ? a : b);
  42 }
  43
  44 int max(int a, int b) {
  45         return (a > b ? a : b);
  46 }
  47
  48 /*
  49  * The s* functions (safe) are wrappers around malloc, strdup, …, which exits if one of
  50  * the called functions returns NULL, meaning that there is no more memory available
  51  *
  52  */
  53 void *smalloc(size_t size) {
  54         void *result = malloc(size);
  55         exit_if_null(result, "Error: out of memory (malloc(%zd))\n", size);
  56         return result;
  57 }
  58
  59 void *scalloc(size_t size) {
  60         void *result = calloc(size, 1);
  61         exit_if_null(result, "Error: out of memory (calloc(%zd))\n", size);
  62         return result;
  63 }
  64
  65 char *sstrdup(const char *str) {
  66         char *result = strdup(str);
  67         exit_if_null(result, "Error: out of memory (strdup())\n");
  68         return result;
  69 }
  70
  71 /*
  72  * The table_* functions emulate the behaviour of libxcb-wm, which in libxcb 0.3.4 suddenly
  73  * vanished. Great.
  74  *
  75  */
  76 bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value) {
  77         struct keyvalue_element *element = scalloc(sizeof(struct keyvalue_element));
  78         element->key = key;
  79         element->value = value;
  80
  81         TAILQ_INSERT_TAIL(head, element, elements);
  82         return true;
  83 }
  84
  85 void *table_remove(struct keyvalue_table_head *head, uint32_t key) {
  86         struct keyvalue_element *element;
  87
  88         TAILQ_FOREACH(element, head, elements)
  89                 if (element->key == key) {
  90                         void *value = element->value;
  91                         TAILQ_REMOVE(head, element, elements);
  92                         free(element);
  93                         return value;
  94                 }
  95
  96         return NULL;
  97 }
  98
  99 void *table_get(struct keyvalue_table_head *head, uint32_t key) {
 100         struct keyvalue_element *element;
 101
 102         TAILQ_FOREACH(element, head, elements)
 103                 if (element->key == key)
 104                         return element->value;
 105
 106         return NULL;
 107 }
 108
 109 /*
 110  * Starts the given application by passing it through a shell. We use double fork
 111  * to avoid zombie processes. As the started application’s parent exits (immediately),
 112  * the application is reparented to init (process-id 1), which correctly handles
 113  * childs, so we don’t have to do it :-).
 114  *
 115  * The shell is determined by looking for the SHELL environment variable. If it
 116  * does not exist, /bin/sh is used.
 117  *
 118  */
 119 void start_application(const char *command) {
 120         if (fork() == 0) {
 121                 /* Child process */
 122                 if (fork() == 0) {
 123                         /* Stores the path of the shell */
 124                         static const char *shell = NULL;
 125
 126                         if (shell == NULL)
 127                                 if ((shell = getenv("SHELL")) == NULL)
 128                                         shell = "/bin/sh";
 129
 130                         /* This is the child */
 131                         execl(shell, shell, "-c", command, (void*)NULL);
 132                         /* not reached */
 133                 }
 134                 exit(0);
 135         }
 136         wait(0);
 137 }
 138
 139 /*
 140  * Checks a generic cookie for errors and quits with the given message if there
 141  * was an error.
 142  *
 143  */
 144 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message) {
 145         xcb_generic_error_t *error = xcb_request_check(conn, cookie);
 146         if (error != NULL) {
 147                 fprintf(stderr, "ERROR: %s : %d\n", err_message , error->error_code);
 148                 xcb_disconnect(conn);
 149                 exit(-1);
 150         }
 151 }
 152
 153 /*
 154  * Converts the given string to UCS-2 big endian for use with
 155  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 156  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 157  * returned. It has to be freed when done.
 158  *
 159  */
 160 char *convert_utf8_to_ucs2(char *input, int *real_strlen) {
 161         size_t input_size = strlen(input) + 1;
 162         /* UCS-2 consumes exactly two bytes for each glyph */
 163         int buffer_size = input_size * 2;
 164
 165         char *buffer = smalloc(buffer_size);
 166         size_t output_size = buffer_size;
 167         /* We need to use an additional pointer, because iconv() modifies it */
 168         char *output = buffer;
 169
 170         /* We convert the input into UCS-2 big endian */
 171         if (conversion_descriptor == 0) {
 172                 conversion_descriptor = iconv_open("UCS-2BE", "UTF-8");
 173                 if (conversion_descriptor == 0) {
 174                         fprintf(stderr, "error opening the conversion context\n");
 175                         exit(1);
 176                 }
 177         }
 178
 179         /* Get the conversion descriptor back to original state */
 180         iconv(conversion_descriptor, NULL, NULL, NULL, NULL);
 181
 182         /* Convert our text */
 183         int rc = iconv(conversion_descriptor, (void*)&input, &input_size, &output, &output_size);
 184         if (rc == (size_t)-1) {
 185                 perror("Converting to UCS-2 failed");
 186                 if (real_strlen != NULL)
 187                         *real_strlen = 0;
 188                 return NULL;
 189         }
 190
 191         if (real_strlen != NULL)
 192                 *real_strlen = ((buffer_size - output_size) / 2) - 1;
 193
 194         return buffer;
 195 }
 196
 197 /*
 198  * Returns the client which comes next in focus stack (= was selected before) for
 199  * the given container, optionally excluding the given client.
 200  *
 201  */
 202 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude) {
 203         Client *current;
 204         SLIST_FOREACH(current, &(container->workspace->focus_stack), focus_clients)
 205                 if ((current->container == container) && ((exclude == NULL) || (current != exclude)))
 206                         return current;
 207         return NULL;
 208 }
 209
 210
 211 /*
 212  * Sets the given client as focused by updating the data structures correctly,
 213  * updating the X input focus and finally re-decorating both windows (to signalize
 214  * the user the new focus situation)
 215  *
 216  */
 217 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways) {
 218         /* The dock window cannot be focused, but enter notifies are still handled correctly */
 219         if (client->dock)
 220                 return;
 221
 222         /* Store the old client */
 223         Client *old_client = SLIST_FIRST(&(c_ws->focus_stack));
 224
 225         /* Check if the focus needs to be changed at all */
 226         if (!set_anyways && (old_client == client))
 227                 return;
 228
 229         /* Store current_row/current_col */
 230         c_ws->current_row = current_row;
 231         c_ws->current_col = current_col;
 232         c_ws = client->workspace;
 233         /* Load current_col/current_row if we switch to a client without a container */
 234         current_col = c_ws->current_col;
 235         current_row = c_ws->current_row;
 236
 237         /* Update container */
 238         if (client->container != NULL) {
 239                 client->container->currently_focused = client;
 240
 241                 current_col = client->container->col;
 242                 current_row = client->container->row;
 243         }
 244
 245         CLIENT_LOG(client);
 246         /* Set focus to the entered window, and flush xcb buffer immediately */
 247         xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, client->child, XCB_CURRENT_TIME);
 248         //xcb_warp_pointer(conn, XCB_NONE, client->child, 0, 0, 0, 0, 10, 10);
 249
 250         if (client->container != NULL) {
 251                 /* Get the client which was last focused in this particular container, it may be a different
 252                    one than old_client */
 253                 Client *last_focused = get_last_focused_client(conn, client->container, NULL);
 254
 255                 /* In stacking containers, raise the client in respect to the one which was focused before */
 256                 if ((client->container->mode == MODE_STACK || client->container->mode == MODE_TABBED) &&
 257                     client->container->workspace->fullscreen_client == NULL) {
 258                         /* We need to get the client again, this time excluding the current client, because
 259                          * we might have just gone into stacking mode and need to raise */
 260                         Client *last_focused = get_last_focused_client(conn, client->container, client);
 261
 262                         if (last_focused != NULL) {
 263                                 DLOG("raising above frame %p / child %p\n", last_focused->frame, last_focused->child);
 264                                 uint32_t values[] = { last_focused->frame, XCB_STACK_MODE_ABOVE };
 265                                 xcb_configure_window(conn, client->frame, XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
 266                         }
 267                 }
 268
 269                 /* If it is the same one as old_client, we save us the unnecessary redecorate */
 270                 if ((last_focused != NULL) && (last_focused != old_client))
 271                         redecorate_window(conn, last_focused);
 272         }
 273
 274         /* If the last client was a floating client, we need to go to the next
 275          * tiling client in stack and re-decorate it. */
 276         if (old_client != NULL && client_is_floating(old_client)) {
 277                 DLOG("Coming from floating client, searching next tiling...\n");
 278                 Client *current;
 279                 SLIST_FOREACH(current, &(client->workspace->focus_stack), focus_clients) {
 280                         if (client_is_floating(current))
 281                                 continue;
 282
 283                         DLOG("Found window: %p / child %p\n", current->frame, current->child);
 284                         redecorate_window(conn, current);
 285                         break;
 286                 }
 287
 288         }
 289
 290         SLIST_REMOVE(&(client->workspace->focus_stack), client, Client, focus_clients);
 291         SLIST_INSERT_HEAD(&(client->workspace->focus_stack), client, focus_clients);
 292
 293         /* If we’re in stacking mode, this renders the container to update changes in the title
 294            bars and to raise the focused client */
 295         if ((old_client != NULL) && (old_client != client) && !old_client->dock)
 296                 redecorate_window(conn, old_client);
 297
 298         /* redecorate_window flushes, so we don’t need to */
 299         redecorate_window(conn, client);
 300 }
 301
 302 /*
 303  * Called when the user switches to another mode or when the container is
 304  * destroyed and thus needs to be cleaned up.
 305  *
 306  */
 307 void leave_stack_mode(xcb_connection_t *conn, Container *container) {
 308         /* When going out of stacking mode, we need to close the window */
 309         struct Stack_Window *stack_win = &(container->stack_win);
 310
 311         SLIST_REMOVE(&stack_wins, stack_win, Stack_Window, stack_windows);
 312
 313         xcb_free_gc(conn, stack_win->pixmap.gc);
 314         xcb_free_pixmap(conn, stack_win->pixmap.id);
 315         xcb_destroy_window(conn, stack_win->window);
 316
 317         stack_win->rect.width = -1;
 318         stack_win->rect.height = -1;
 319 }
 320
 321 /*
 322  * Switches the layout of the given container taking care of the necessary house-keeping
 323  *
 324  */
 325 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode) {
 326         if (mode == MODE_STACK || mode == MODE_TABBED) {
 327                 /* When we’re already in stacking mode, nothing has to be done */
 328                 if ((mode == MODE_STACK && container->mode == MODE_STACK) ||
 329                     (mode == MODE_TABBED && container->mode == MODE_TABBED))
 330                         return;
 331
 332                 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
 333                         goto after_stackwin;
 334
 335                 /* When entering stacking mode, we need to open a window on
 336                  * which we can draw the title bars of the clients, it has
 337                  * height 1 because we don’t bother here with calculating the
 338                  * correct height - it will be adjusted when rendering anyways.
 339                  * Also, we need to use max(width, 1) because windows cannot
 340                  * be created with either width == 0 or height == 0. */
 341                 Rect rect = {container->x, container->y, max(container->width, 1), 1};
 342
 343                 uint32_t mask = 0;
 344                 uint32_t values[2];
 345
 346                 /* Don’t generate events for our new window, it should *not* be managed */
 347                 mask |= XCB_CW_OVERRIDE_REDIRECT;
 348                 values[0] = 1;
 349
 350                 /* We want to know when… */
 351                 mask |= XCB_CW_EVENT_MASK;
 352                 values[1] =     XCB_EVENT_MASK_ENTER_WINDOW |   /* …mouse is moved into our window */
 353                                 XCB_EVENT_MASK_BUTTON_PRESS |   /* …mouse is pressed */
 354                                 XCB_EVENT_MASK_EXPOSURE;        /* …our window needs to be redrawn */
 355
 356                 struct Stack_Window *stack_win = &(container->stack_win);
 357                 stack_win->window = create_window(conn, rect, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_CURSOR_LEFT_PTR, false, mask, values);
 358
 359                 stack_win->rect.height = 0;
 360
 361                 /* Initialize the entry for our cached pixmap. It will be
 362                  * created as soon as it’s needed (see cached_pixmap_prepare). */
 363                 memset(&(stack_win->pixmap), 0, sizeof(struct Cached_Pixmap));
 364                 stack_win->pixmap.referred_rect = &stack_win->rect;
 365                 stack_win->pixmap.referred_drawable = stack_win->window;
 366
 367                 stack_win->container = container;
 368
 369                 SLIST_INSERT_HEAD(&stack_wins, stack_win, stack_windows);
 370         } else {
 371                 if (container->mode == MODE_STACK || container->mode == MODE_TABBED)
 372                         leave_stack_mode(conn, container);
 373         }
 374 after_stackwin:
 375         container->mode = mode;
 376
 377         /* Force reconfiguration of each client */
 378         Client *client;
 379
 380         CIRCLEQ_FOREACH(client, &(container->clients), clients)
 381                 client->force_reconfigure = true;
 382
 383         render_layout(conn);
 384
 385         if (container->currently_focused != NULL) {
 386                 /* We need to make sure that this client is above *each* of the
 387                  * other clients in this container */
 388                 Client *last_focused = get_last_focused_client(conn, container, container->currently_focused);
 389
 390                 CIRCLEQ_FOREACH(client, &(container->clients), clients) {
 391                         if (client == container->currently_focused || client == last_focused)
 392                                 continue;
 393
 394                         DLOG("setting %08x below %08x / %08x\n", client->frame, container->currently_focused->frame);
 395                         uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
 396                         xcb_configure_window(conn, client->frame,
 397                                              XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
 398                 }
 399
 400                 if (last_focused != NULL) {
 401                         DLOG("Putting last_focused directly underneath the currently focused\n");
 402                         uint32_t values[] = { container->currently_focused->frame, XCB_STACK_MODE_BELOW };
 403                         xcb_configure_window(conn, last_focused->frame,
 404                                              XCB_CONFIG_WINDOW_SIBLING | XCB_CONFIG_WINDOW_STACK_MODE, values);
 405                 }
 406
 407
 408                 set_focus(conn, container->currently_focused, true);
 409         }
 410 }
 411
 412 /*
 413  * Gets the first matching client for the given window class/window title.
 414  * If the paramater specific is set to a specific client, only this one
 415  * will be checked.
 416  *
 417  */
 418 Client *get_matching_client(xcb_connection_t *conn, const char *window_classtitle,
 419                             Client *specific) {
 420         char *to_class, *to_title, *to_title_ucs = NULL;
 421         int to_title_ucs_len = 0;
 422         Client *matching = NULL;
 423
 424         to_class = sstrdup(window_classtitle);
 425
 426         /* If a title was specified, split both strings at the slash */
 427         if ((to_title = strstr(to_class, "/")) != NULL) {
 428                 *(to_title++) = '\0';
 429                 /* Convert to UCS-2 */
 430                 to_title_ucs = convert_utf8_to_ucs2(to_title, &to_title_ucs_len);
 431         }
 432
 433         /* If we were given a specific client we only check if that one matches */
 434         if (specific != NULL) {
 435                 if (client_matches_class_name(specific, to_class, to_title, to_title_ucs, to_title_ucs_len))
 436                         matching = specific;
 437                 goto done;
 438         }
 439
 440         DLOG("Getting clients for class \"%s\" / title \"%s\"\n", to_class, to_title);
 441         Workspace *ws;
 442         TAILQ_FOREACH(ws, workspaces, workspaces) {
 443                 if (ws->screen == NULL)
 444                         continue;
 445
 446                 Client *client;
 447                 SLIST_FOREACH(client, &(ws->focus_stack), focus_clients) {
 448                         DLOG("Checking client with class=%s, name=%s\n", client->window_class, client->name);
 449                         if (!client_matches_class_name(client, to_class, to_title, to_title_ucs, to_title_ucs_len))
 450                                 continue;
 451
 452                         matching = client;
 453                         goto done;
 454                 }
 455         }
 456
 457 done:
 458         free(to_class);
 459         FREE(to_title_ucs);
 460         return matching;
 461 }
 462
 463 #if defined(__OpenBSD__)
 464
 465 /*
 466  * Taken from FreeBSD
 467  * Find the first occurrence of the byte string s in byte string l.
 468  *
 469  */
 470 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len) {
 471         register char *cur, *last;
 472         const char *cl = (const char *)l;
 473         const char *cs = (const char *)s;
 474
 475         /* we need something to compare */
 476         if (l_len == 0 || s_len == 0)
 477                 return NULL;
 478
 479         /* "s" must be smaller or equal to "l" */
 480         if (l_len < s_len)
 481                 return NULL;
 482
 483         /* special case where s_len == 1 */
 484         if (s_len == 1)
 485                 return memchr(l, (int)*cs, l_len);
 486
 487         /* the last position where its possible to find "s" in "l" */
 488         last = (char *)cl + l_len - s_len;
 489
 490         for (cur = (char *)cl; cur <= last; cur++)
 491                 if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
 492                         return cur;
 493
 494         return NULL;
 495 }
 496
 497 #endif
 498