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