git.sur5r.net Git - i3/i3/blob - include/libi3.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * libi3: contains functions which are used by i3 *and* accompanying tools such
   8  * as i3-msg, i3-config-wizard, …
   9  *
  10  */
  11 #ifndef _LIBI3_H
  12 #define _LIBI3_H
  13
  14 #include <stdbool.h>
  15 #include <stdarg.h>
  16 #include <stdio.h>
  17 #include <xcb/xcb.h>
  18 #include <xcb/xproto.h>
  19 #include <xcb/xcb_keysyms.h>
  20
  21 /**
  22  * Opaque data structure for storing strings.
  23  *
  24  */
  25 typedef struct _i3String i3String;
  26
  27 typedef struct Font i3Font;
  28
  29 /**
  30  * Data structure for cached font information:
  31  * - font id in X11 (load it once)
  32  * - font height (multiple calls needed to get it)
  33  *
  34  */
  35 struct Font {
  36     /** The xcb-id for the font */
  37     xcb_font_t id;
  38
  39     /** Font information gathered from the server */
  40     xcb_query_font_reply_t *info;
  41
  42     /** Font table for this font (may be NULL) */
  43     xcb_charinfo_t *table;
  44
  45     /** The height of the font, built from font_ascent + font_descent */
  46     int height;
  47 };
  48
  49 /* Since this file also gets included by utilities which don’t use the i3 log
  50  * infrastructure, we define a fallback. */
  51 #if !defined(ELOG)
  52 #define ELOG(fmt, ...) fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__)
  53 #endif
  54
  55 /**
  56  * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
  57  * the X11 root window and return NULL if it doesn’t work.
  58  *
  59  * The memory for the contents is dynamically allocated and has to be
  60  * free()d by the caller.
  61  *
  62  */
  63 char *root_atom_contents(const char *atomname);
  64
  65 /**
  66  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  67  * there is no more memory available)
  68  *
  69  */
  70 void *smalloc(size_t size);
  71
  72 /**
  73  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  74  * there is no more memory available)
  75  *
  76  */
  77 void *scalloc(size_t size);
  78
  79 /**
  80  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  81  * that there is no more memory available).
  82  *
  83  */
  84 void *srealloc(void *ptr, size_t size);
  85
  86 /**
  87  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  88  * there is no more memory available)
  89  *
  90  */
  91 char *sstrdup(const char *str);
  92
  93 /**
  94  * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
  95  * there is no more memory available)
  96  *
  97  */
  98 int sasprintf(char **strp, const char *fmt, ...);
  99
 100 /**
 101  * Build an i3String from an UTF-8 encoded string.
 102  * Returns the newly-allocated i3String.
 103  *
 104  */
 105 i3String *i3string_from_utf8(const char *from_utf8);
 106
 107 /**
 108  * Build an i3String from an UTF-8 encoded string with fixed length.
 109  * To be used when no proper NUL-terminaison is available.
 110  * Returns the newly-allocated i3String.
 111  *
 112  */
 113 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
 114
 115 /**
 116  * Build an i3String from an UCS-2 encoded string.
 117  * Returns the newly-allocated i3String.
 118  *
 119  */
 120 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
 121
 122 /**
 123  * Free an i3String.
 124  *
 125  */
 126 void i3string_free(i3String *str);
 127
 128 /**
 129  * Securely i3string_free by setting the pointer to NULL
 130  * to prevent accidentally using freed memory.
 131  *
 132  */
 133 #define I3STRING_FREE(str) \
 134 do { \
 135  if (str != NULL) { \
 136  i3string_free(str); \
 137  str = NULL; \
 138  } \
 139 } while (0)
 140
 141 /**
 142  * Returns the UTF-8 encoded version of the i3String.
 143  *
 144  */
 145 const char *i3string_as_utf8(i3String *str);
 146
 147 /**
 148  * Returns the UCS-2 encoded version of the i3String.
 149  *
 150  */
 151 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
 152
 153 /**
 154  * Returns the number of bytes (UTF-8 encoded) in an i3String.
 155  *
 156  */
 157 size_t i3string_get_num_bytes(i3String *str);
 158
 159 /**
 160  * Returns the number of glyphs in an i3String.
 161  *
 162  */
 163 size_t i3string_get_num_glyphs(i3String *str);
 164
 165 /**
 166  * Connects to the i3 IPC socket and returns the file descriptor for the
 167  * socket. die()s if anything goes wrong.
 168  *
 169  */
 170 int ipc_connect(const char *socket_path);
 171
 172 /**
 173  * Formats a message (payload) of the given size and type and sends it to i3 via
 174  * the given socket file descriptor.
 175  *
 176  * Returns -1 when write() fails, errno will remain.
 177  * Returns 0 on success.
 178  *
 179  */
 180 int ipc_send_message(int sockfd, uint32_t message_size,
 181                      uint32_t message_type, const uint8_t *payload);
 182
 183 /**
 184  * Reads a message from the given socket file descriptor and stores its length
 185  * (reply_length) as well as a pointer to its contents (reply).
 186  *
 187  * Returns -1 when read() fails, errno will remain.
 188  * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
 189  * message type, EOF instead of a message). Additionally, the error will be
 190  * printed to stderr.
 191  * Returns 0 on success.
 192  *
 193  */
 194 int ipc_recv_message(int sockfd, uint32_t message_type,
 195                      uint32_t *reply_length, uint8_t **reply);
 196
 197 /**
 198  * Generates a configure_notify event and sends it to the given window
 199  * Applications need this to think they’ve configured themselves correctly.
 200  * The truth is, however, that we will manage them.
 201  *
 202  */
 203 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
 204
 205 /**
 206  * Returns the colorpixel to use for the given hex color (think of HTML). Only
 207  * works for true-color (vast majority of cases) at the moment, avoiding a
 208  * roundtrip to X11.
 209  *
 210  * The hex_color has to start with #, for example #FF00FF.
 211  *
 212  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
 213  * This has to be done by the caller.
 214  *
 215  * NOTE that this function may in the future rely on a global xcb_connection_t
 216  * variable called 'conn' to be present.
 217  *
 218  */
 219 uint32_t get_colorpixel(const char *hex) __attribute__((const));
 220
 221 #if defined(__APPLE__)
 222
 223 /*
 224  * Taken from FreeBSD
 225  * Returns a pointer to a new string which is a duplicate of the
 226  * string, but only copies at most n characters.
 227  *
 228  */
 229 char *strndup(const char *str, size_t n);
 230
 231 #endif
 232
 233 /**
 234  * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
 235  * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
 236  *
 237  * This function initiates one round-trip. Use get_mod_mask_for() directly if
 238  * you already have the modifier mapping and key symbols.
 239  *
 240  */
 241 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
 242
 243 /**
 244  * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
 245  * example for XCB_NUM_LOCK (usually configured to mod2).
 246  *
 247  * This function does not initiate any round-trips.
 248  *
 249  */
 250 uint32_t get_mod_mask_for(uint32_t keysym,
 251                            xcb_key_symbols_t *symbols,
 252                            xcb_get_modifier_mapping_reply_t *modmap_reply);
 253
 254 /**
 255  * Loads a font for usage, also getting its height. If fallback is true,
 256  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
 257  *
 258  */
 259 i3Font load_font(const char *pattern, const bool fallback);
 260
 261 /**
 262  * Defines the font to be used for the forthcoming calls.
 263  *
 264  */
 265 void set_font(i3Font *font);
 266
 267 /**
 268  * Frees the resources taken by the current font.
 269  *
 270  */
 271 void free_font(void);
 272
 273 /**
 274  * Converts the given string to UTF-8 from UCS-2 big endian. The return value
 275  * must be freed after use.
 276  *
 277  */
 278 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
 279
 280 /**
 281  * Converts the given string to UCS-2 big endian for use with
 282  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 283  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 284  * returned. It has to be freed when done.
 285  *
 286  */
 287 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
 288
 289 /**
 290  * Defines the colors to be used for the forthcoming draw_text calls.
 291  *
 292  */
 293 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
 294
 295 /**
 296  * Draws text onto the specified X drawable (normally a pixmap) at the
 297  * specified coordinates (from the top left corner of the leftmost, uppermost
 298  * glyph) and using the provided gc.
 299  *
 300  * Text must be specified as an i3String.
 301  *
 302  */
 303 void draw_text(i3String *text, xcb_drawable_t drawable,
 304         xcb_gcontext_t gc, int x, int y, int max_width);
 305
 306 /**
 307  * ASCII version of draw_text to print static strings.
 308  *
 309  */
 310 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
 311         xcb_gcontext_t gc, int x, int y, int max_width);
 312
 313 /**
 314  * Predict the text width in pixels for the given text. Text must be
 315  * specified as an i3String.
 316  *
 317  */
 318 int predict_text_width(i3String *text);
 319
 320 /**
 321  * Returns the visual type associated with the given screen.
 322  *
 323  */
 324 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
 325
 326 /**
 327  * Returns true if this version of i3 is a debug build (anything which is not a
 328  * release version), based on the git version number.
 329  *
 330  */
 331 bool is_debug_build() __attribute__((const));
 332
 333 #endif