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 TAILQ_HEAD(keyvalue_table_head, keyvalue_element);
  40 extern struct keyvalue_table_head by_parent;
  41 extern struct keyvalue_table_head by_child;
  42
  43 int min(int a, int b);
  44 int max(int a, int b);
  45
  46 /**
  47  * Logs the given message to stdout while prefixing the current time to it.
  48  * This is to be called by LOG() which includes filename/linenumber
  49  *
  50  */
  51 void slog(char *fmt, ...);
  52
  53 /**
  54  * Prints the message (see printf()) to stderr, then exits the program.
  55  *
  56  */
  57 void die(char *fmt, ...);
  58
  59 /**
  60  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that there
  61  * is no more memory available)
  62  *
  63  */
  64 void *smalloc(size_t size);
  65
  66 /**
  67  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there
  68  * is no more memory available)
  69  *
  70  */
  71 void *scalloc(size_t size);
  72
  73 /**
  74  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there
  75  * is no more memory available)
  76  *
  77  */
  78 char *sstrdup(const char *str);
  79
  80 /**
  81  * Inserts an element into the given keyvalue-table using the given key.
  82  *
  83  */
  84 bool table_put(struct keyvalue_table_head *head, uint32_t key, void *value);
  85
  86 /**
  87  * Removes the element from the given keyvalue-table with the given key and returns its value;
  88  *
  89  */
  90 void *table_remove(struct keyvalue_table_head *head, uint32_t key);
  91
  92 /**
  93  * Returns the value of the element of the given keyvalue-table with the given key.
  94  *
  95  */
  96 void *table_get(struct keyvalue_table_head *head, uint32_t key);
  97
  98 /**
  99  * Starts the given application by passing it through a shell. We use double fork
 100  * to avoid zombie processes. As the started application’s parent exits (immediately),
 101  * the application is reparented to init (process-id 1), which correctly handles
 102  * childs, so we don’t have to do it :-).
 103  *
 104  * The shell is determined by looking for the SHELL environment variable. If it
 105  * does not exist, /bin/sh is used.
 106  *
 107  */
 108 void start_application(const char *command);
 109
 110 /**
 111  * Checks a generic cookie for errors and quits with the given message if there
 112  * was an error.
 113  *
 114  */
 115 void check_error(xcb_connection_t *conn, xcb_void_cookie_t cookie, char *err_message);
 116
 117 /**
 118  * Converts the given string to UCS-2 big endian for use with
 119  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 120  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 121  * returned. It has to be freed when done.
 122  *
 123  */
 124 char *convert_utf8_to_ucs2(char *input, int *real_strlen);
 125
 126 /**
 127  * Removes the given client from the container, either because it will be inserted into another
 128  * one or because it was unmapped
 129  *
 130  */
 131 void remove_client_from_container(xcb_connection_t *conn, Client *client, Container *container);
 132
 133 /**
 134  * Returns the client which comes next in focus stack (= was selected before) for
 135  * the given container, optionally excluding the given client.
 136  *
 137  */
 138 Client *get_last_focused_client(xcb_connection_t *conn, Container *container, Client *exclude);
 139
 140 /**
 141  * Unmaps all clients (and stack windows) of the given workspace.
 142  *
 143  * This needs to be called separately when temporarily rendering
 144  * a workspace which is not the active workspace to force
 145  * reconfiguration of all clients, like in src/xinerama.c when
 146  * re-assigning a workspace to another screen.
 147  *
 148  */
 149 void unmap_workspace(xcb_connection_t *conn, Workspace *u_ws);
 150
 151 /**
 152  * Sets the given client as focused by updating the data structures correctly,
 153  * updating the X input focus and finally re-decorating both windows (to signalize
 154  * the user the new focus situation)
 155  *
 156  */
 157 void set_focus(xcb_connection_t *conn, Client *client, bool set_anyways);
 158
 159 /**
 160  * Called when the user switches to another mode or when the container is
 161  * destroyed and thus needs to be cleaned up.
 162  *
 163  */
 164 void leave_stack_mode(xcb_connection_t *conn, Container *container);
 165
 166 /**
 167  * Switches the layout of the given container taking care of the necessary house-keeping
 168  *
 169  */
 170 void switch_layout_mode(xcb_connection_t *conn, Container *container, int mode);
 171
 172 /**
 173  * Warps the pointer into the given client (in the middle of it, to be specific), therefore
 174  * selecting it
 175  *
 176  */
 177 void warp_pointer_into(xcb_connection_t *conn, Client *client);
 178
 179 /**
 180  * Toggles fullscreen mode for the given client. It updates the data structures and
 181  * reconfigures (= resizes/moves) the client and its frame to the full size of the
 182  * screen. When leaving fullscreen, re-rendering the layout is forced.
 183  *
 184  */
 185 void toggle_fullscreen(xcb_connection_t *conn, Client *client);
 186
 187 /**
 188  * Kills the given window using WM_DELETE_WINDOW or xcb_kill_window
 189  *
 190  */
 191 void kill_window(xcb_connection_t *conn, Client *window);
 192
 193 #endif