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