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
  13 #include "data.h"
  14
  15 #ifndef _UTIL_H
  16 #define _UTIL_H
  17
  18 #define exit_if_null(pointer, ...) { if (pointer == NULL) die(__VA_ARGS__); }
  19 #define STARTS_WITH(string, needle) (strncasecmp(string, needle, strlen(needle)) == 0)
  20 #define CIRCLEQ_NEXT_OR_NULL(head, elm, field) (CIRCLEQ_NEXT(elm, field) != CIRCLEQ_END(head) ? \
  21                                                 CIRCLEQ_NEXT(elm, field) : NULL)
  22 #define CIRCLEQ_PREV_OR_NULL(head, elm, field) (CIRCLEQ_PREV(elm, field) != CIRCLEQ_END(head) ? \
  23                                                 CIRCLEQ_PREV(elm, field) : NULL)
  24 #define FOR_TABLE(workspace) \
  25                         for (int cols = 0; cols < workspace->cols; cols++) \
  26                                 for (int rows = 0; rows < workspace->rows; rows++)
  27 #define FREE(pointer) do { \
  28         if (pointer == NULL) { \
  29                 free(pointer); \
  30                 pointer = NULL; \
  31         } \
  32 } \
  33 while (0)
  34
  35 /* ##__VA_ARGS__ means: leave out __VA_ARGS__ completely if it is empty, that is,
  36    delete the preceding comma */
  37 #define LOG(fmt, ...) slog("%s:%s:%d - " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
  38
  39
  40 int min(int a, int b);
  41 int max(int a, int b);
  42
  43 /**
  44  * Logs the given message to stdout while prefixing the current time to it.
  45  * This is to be called by LOG() which includes filename/linenumber
  46  *
  47  */
  48 void slog(char *fmt, ...);
  49
  50 /**
  51  * Prints the message (see printf()) to stderr, then exits the program.
  52  *
  53  */
  54 void die(char *fmt, ...);
  55
  56 /**
  57  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there
  58  * is no more memory available)
  59  *
  60  */
  61 void *smalloc(size_t size);
  62
  63 /**
  64  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there
  65  * is no more memory available)
  66  *
  67  */
  68 void *scalloc(size_t size);
  69
  70 /**
  71  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there
  72  * is no more memory available)
  73  *
  74  */
  75 char *sstrdup(const char *str);
  76
  77 /**
  78  * Starts the given application by passing it through a shell. We use double fork
  79  * to avoid zombie processes. As the started application’s parent exits (immediately),
  80  * the application is reparented to init (process-id 1), which correctly handles
  81  * childs, so we don’t have to do it :-).
  82  *
  83  * The shell is determined by looking for the SHELL environment variable. If it
  84  * does not exist, /bin/sh is used.
  85  *
  86  */
  87 void start_application(const char *command);
  88
  89 /**
  90  * Checks a generic cookie for errors and quits with the given message if there
  91  * was an error.
  92  *
  93  */
  94 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message);
  95
  96 /**
  97  * Converts the given string to UCS-2 big endian for use with
  98  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
  99  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 100  * returned. It has to be freed when done.
 101  *
 102  */
 103 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 104
 105 /**
 106  * Removes the given client from the container, either because it will be inserted into another
 107  * one or because it was unmapped
 108  *
 109  */
 110 void remove_client_from_container(xcb_connection_t *conn, Client *client, Container *container);
 111
 112 /**
 113  * Returns the client which comes next in focus stack (= was selected before) for
 114  * the given container, optionally excluding the given client.
 115  *
 116  */
 117 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude);
 118
 119 /**
 120  * Sets the given client as focused by updating the data structures correctly,
 121  * updating the X input focus and finally re-decorating both windows (to signalize
 122  * the user the new focus situation)
 123  *
 124  */
 125 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways);
 126
 127 /**
 128  * Called when the user switches to another mode or when the container is
 129  * destroyed and thus needs to be cleaned up.
 130  *
 131  */
 132 void leave_stack_mode(xcb_connection_t *conn, Container *container);
 133
 134 /**
 135  * Switches the layout of the given container taking care of the necessary house-keeping
 136  *
 137  */
 138 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode);
 139
 140 /**
 141  * Warps the pointer into the given client (in the middle of it, to be specific), therefore
 142  * selecting it
 143  *
 144  */
 145 void warp_pointer_into(xcb_connection_t *conn, Client *client);
 146
 147 /**
 148  * Toggles fullscreen mode for the given client. It updates the data structures and
 149  * reconfigures (= resizes/moves) the client and its frame to the full size of the
 150  * screen. When leaving fullscreen, re-rendering the layout is forced.
 151  *
 152  */
 153 void toggle_fullscreen(xcb_connection_t *conn, Client *client);
 154
 155 /**
 156  * Kills the given window using WM_DELETE_WINDOW or xcb_kill_window
 157  *
 158  */
 159 void kill_window(xcb_connection_t *conn, Client *window);
 160
 161 #endif