git.sur5r.net Git - i3/i3/blob - include/util.h

   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  */
  11 #include <xcb/xcb.h>
  12 #include <err.h>
  13
  14 #include "data.h"
  15
  16 #ifndef _UTIL_H
  17 #define _UTIL_H
  18
  19 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
  20 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
  21 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
  22 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
  23                                                 CIRCLEQ_NEXT(elm, field) : NULL)
  24 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
  25                                                 CIRCLEQ_PREV(elm, field) : NULL)
  26 #define FOR_TABLE(workspace) \
  27                         for (int cols = 0; cols < (workspace)->cols; cols++) \
  28                                 for (int rows = 0; rows < (workspace)->rows; rows++)
  29 #define FREE(pointer) do { \
  30         if (pointer != NULL) { \
  31                 free(pointer); \
  32                 pointer = NULL; \
  33         } \
  34 } \
  35 while (0)
  36
  37 int min(int a, int b);
  38 int max(int a, int b);
  39 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  40 Rect rect_add(Rect a, Rect b);
  41
  42 /**
  43  * Updates *destination with new_value and returns true if it was changed or false
  44  * if it was the same
  45  *
  46  */
  47 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  48
  49 /**
  50  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  51  * there is no more memory available)
  52  *
  53  */
  54 void *smalloc(size_t size);
  55
  56 /**
  57  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  58  * there is no more memory available)
  59  *
  60  */
  61 void *scalloc(size_t size);
  62
  63 /**
  64  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  65  * that there is no more memory available).
  66  *
  67  */
  68 void *srealloc(void *ptr, size_t size);
  69
  70 /**
  71  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  72  * there is no more memory available)
  73  *
  74  */
  75 char *sstrdup(const char *str);
  76
  77 /**
  78  * Starts the given application by passing it through a shell. We use double
  79  * fork to avoid zombie processes. As the started application’s parent exits
  80  * (immediately), the application is reparented to init (process-id 1), which
  81  * correctly handles childs, so we don’t have to do it :-).
  82  *
  83  * The shell is determined by looking for the SHELL environment variable. If
  84  * it does not exist, /bin/sh is used.
  85  *
  86  */
  87 void start_application(const char *command);
  88
  89 /**
  90  * Checks a generic cookie for errors and quits with the given message if
  91  * there was an error.
  92  *
  93  */
  94 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
  95                  char *err_message);
  96
  97 /**
  98  * Converts the given string to UCS-2 big endian for use with
  99  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
 100  * buffer containing the UCS-2 encoded string (16 bit per glyph) is
 101  * returned. It has to be freed when done.
 102  *
 103  */
 104 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 105
 106 #if 0
 107 /**
 108  * Returns the client which comes next in focus stack (= was selected before) for
 109  * the given container, optionally excluding the given client.
 110  *
 111  */
 112 Client *get_last_focused_client(xcb_connection_t *conn, Container *container,
 113                                 Client *exclude);
 114 #endif
 115
 116 #if 0
 117 /**
 118  * Sets the given client as focused by updating the data structures correctly,
 119  * updating the X input focus and finally re-decorating both windows (to
 120  * signalize the user the new focus situation)
 121  *
 122  */
 123 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways);
 124
 125 /**
 126  * Called when the user switches to another mode or when the container is
 127  * destroyed and thus needs to be cleaned up.
 128  *
 129  */
 130 void leave_stack_mode(xcb_connection_t *conn, Container *container);
 131
 132 /**
 133  * Switches the layout of the given container taking care of the necessary
 134  * house-keeping
 135  *
 136  */
 137 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode);
 138
 139 /**
 140  * Gets the first matching client for the given window class/window title.
 141  * If the paramater specific is set to a specific client, only this one
 142  * will be checked.
 143  *
 144  */
 145 Client *get_matching_client(xcb_connection_t *conn,
 146                             const char *window_classtitle, Client *specific);
 147 #endif
 148
 149 /*
 150  * Restart i3 in-place
 151  * appends -a to argument list to disable autostart
 152  *
 153  */
 154 void i3_restart();
 155
 156 #if defined(__OpenBSD__)
 157 /* OpenBSD does not provide memmem(), so we provide FreeBSD’s implementation */
 158 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 159 #endif
 160
 161 #endif