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