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 <err.h>
  12
  13 #include "data.h"
  14
  15 #ifndef _UTIL_H
  16 #define _UTIL_H
  17
  18 #define die(...) errx(EXIT_FAILURE, __VA_ARGS__);
  19 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
  20 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
  21 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
  22                                                 CIRCLEQ_NEXT(elm, field) : NULL)
  23 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
  24                                                 CIRCLEQ_PREV(elm, field) : NULL)
  25 #define FOR_TABLE(workspace) \
  26                         for (int cols = 0; cols < (workspace)->cols; cols++) \
  27                                 for (int rows = 0; rows < (workspace)->rows; rows++)
  28 #define FREE(pointer) do { \
  29         if (pointer != NULL) { \
  30                 free(pointer); \
  31                 pointer = NULL; \
  32         } \
  33 } \
  34 while (0)
  35
  36 #define CALL(obj, member, ...) obj->member(obj, ## __VA_ARGS__)
  37
  38 int min(int a, int b);
  39 int max(int a, int b);
  40 bool rect_contains(Rect rect, uint32_t x, uint32_t y);
  41 Rect rect_add(Rect a, Rect b);
  42
  43 /**
  44  * Updates *destination with new_value and returns true if it was changed or false
  45  * if it was the same
  46  *
  47  */
  48 bool update_if_necessary(uint32_t *destination, const uint32_t new_value);
  49
  50 /**
  51  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  52  * there is no more memory available)
  53  *
  54  */
  55 void *smalloc(size_t size);
  56
  57 /**
  58  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  59  * there is no more memory available)
  60  *
  61  */
  62 void *scalloc(size_t size);
  63
  64 /**
  65  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  66  * that there is no more memory available).
  67  *
  68  */
  69 void *srealloc(void *ptr, size_t size);
  70
  71 /**
  72  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  73  * there is no more memory available)
  74  *
  75  */
  76 char *sstrdup(const char *str);
  77
  78 /**
  79  * Starts the given application by passing it through a shell. We use double
  80  * fork to avoid zombie processes. As the started application’s parent exits
  81  * (immediately), the application is reparented to init (process-id 1), which
  82  * correctly handles childs, so we don’t have to do it :-).
  83  *
  84  * The shell is determined by looking for the SHELL environment variable. If
  85  * it does not exist, /bin/sh is used.
  86  *
  87  */
  88 void start_application(const char *command);
  89
  90 /**
  91  * Checks a generic cookie for errors and quits with the given message if
  92  * there was an error.
  93  *
  94  */
  95 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie,
  96                  char *err_message);
  97
  98 /**
  99  * Converts the given string to UCS-2 big endian for use with
 100  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen, a
 101  * buffer containing the UCS-2 encoded string (16 bit per glyph) is
 102  * returned. It has to be freed when done.
 103  *
 104  */
 105 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 106
 107 /**
 108  * This function resolves ~ in pathnames.
 109  * It may resolve wildcards in the first part of the path, but if no match
 110  * or multiple matches are found, it just returns a copy of path as given.
 111  *
 112  */
 113 char *resolve_tilde(const char *path);
 114
 115 /**
 116  * Checks if the given path exists by calling stat().
 117  *
 118  */
 119 bool path_exists(const char *path);
 120
 121
 122 /**
 123  * Returns the name of a temporary file with the specified prefix.
 124  *
 125  */
 126 char *get_process_filename(const char *prefix);
 127
 128 /**
 129  * Restart i3 in-place
 130  * appends -a to argument list to disable autostart
 131  *
 132  */
 133 void i3_restart(bool forget_layout);
 134
 135 #endif