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