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 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
  38
  39 int min(int a, int b);
  40 int max(int a, int b);
  41 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  42 Rect rect_add(Rect a, Rect 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 realloc which exits if realloc returns NULL (meaning
  67  * that there is no more memory available).
  68  *
  69  */
  70 void *srealloc(void *ptr, size_t size);
  71
  72 /**
  73  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  74  * there is no more memory available)
  75  *
  76  */
  77 char *sstrdup(const char *str);
  78
  79 /**
  80  * Starts the given application by passing it through a shell. We use double
  81  * fork to avoid zombie processes. As the started application’s parent exits
  82  * (immediately), the application is reparented to init (process-id 1), which
  83  * correctly handles childs, so we don’t have to do it :-).
  84  *
  85  * The shell is determined by looking for the SHELL environment variable. If
  86  * it does not exist, /bin/sh is used.
  87  *
  88  */
  89 void start_application(const char *command);
  90
  91 /**
  92  * Checks a generic cookie for errors and quits with the given message if
  93  * there was an error.
  94  *
  95  */
  96 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
  97                  char *err_message);
  98
  99 /**
 100  * Converts the given string to UCS-2 big endian for use with
 101  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
 102  * buffer containing the UCS-2 encoded string (16 bit per glyph) is
 103  * returned. It has to be freed when done.
 104  *
 105  */
 106 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 107
 108 /*
 109  * This function resolves ~ in pathnames.
 110  * It may resolve wildcards in the first part of the path, but if no match
 111  * or multiple matches are found, it just returns a copy of path as given.
 112  *
 113  */
 114 char *resolve_tilde(const char *path);
 115
 116 /*
 117  * Checks if the given path exists by calling stat().
 118  *
 119  */
 120 bool path_exists(const char *path);
 121
 122 /*
 123  * Restart i3 in-place
 124  * appends -a to argument list to disable autostart
 125  *
 126  */
 127 void i3_restart(bool forget_layout);
 128
 129 #endif