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 typedef struct Font i3Font;
  22
  23 /**
  24  * Data structure for cached font information:
  25  * - font id in X11 (load it once)
  26  * - font height (multiple calls needed to get it)
  27  *
  28  */
  29 struct Font {
  30     /** The xcb-id for the font */
  31     xcb_font_t id;
  32
  33     /** Font information gathered from the server */
  34     xcb_query_font_reply_t *info;
  35
  36     /** Font table for this font (may be NULL) */
  37     xcb_charinfo_t *table;
  38
  39     /** The height of the font, built from font_ascent + font_descent */
  40     int height;
  41 };
  42
  43 /* Since this file also gets included by utilities which don’t use the i3 log
  44  * infrastructure, we define a fallback. */
  45 #if !defined(ELOG)
  46 #define ELOG(fmt, ...) fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__)
  47 #endif
  48
  49 /**
  50  * Try to get the socket path from X11 and return NULL if it doesn’t work.
  51  *
  52  * The memory for the socket path is dynamically allocated and has to be
  53  * free()d by the caller.
  54  *
  55  */
  56 char *socket_path_from_x11();
  57
  58 /**
  59  * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
  60  * there is no more memory available)
  61  *
  62  */
  63 void *smalloc(size_t size);
  64
  65 /**
  66  * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
  67  * there is no more memory available)
  68  *
  69  */
  70 void *scalloc(size_t size);
  71
  72 /**
  73  * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
  74  * that there is no more memory available).
  75  *
  76  */
  77 void *srealloc(void *ptr, size_t size);
  78
  79 /**
  80  * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
  81  * there is no more memory available)
  82  *
  83  */
  84 char *sstrdup(const char *str);
  85
  86 /**
  87  * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
  88  * there is no more memory available)
  89  *
  90  */
  91 int sasprintf(char **strp, const char *fmt, ...);
  92
  93 /**
  94  * Connects to the i3 IPC socket and returns the file descriptor for the
  95  * socket. die()s if anything goes wrong.
  96  *
  97  */
  98 int ipc_connect(const char *socket_path);
  99
 100 /**
 101  * Formats a message (payload) of the given size and type and sends it to i3 via
 102  * the given socket file descriptor.
 103  *
 104  * Returns -1 when write() fails, errno will remain.
 105  * Returns 0 on success.
 106  *
 107  */
 108 int ipc_send_message(int sockfd, uint32_t message_size,
 109                      uint32_t message_type, const uint8_t *payload);
 110
 111 /**
 112  * Reads a message from the given socket file descriptor and stores its length
 113  * (reply_length) as well as a pointer to its contents (reply).
 114  *
 115  * Returns -1 when read() fails, errno will remain.
 116  * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
 117  * message type, EOF instead of a message). Additionally, the error will be
 118  * printed to stderr.
 119  * Returns 0 on success.
 120  *
 121  */
 122 int ipc_recv_message(int sockfd, uint32_t message_type,
 123                      uint32_t *reply_length, uint8_t **reply);
 124
 125 /**
 126  * Generates a configure_notify event and sends it to the given window
 127  * Applications need this to think they’ve configured themselves correctly.
 128  * The truth is, however, that we will manage them.
 129  *
 130  */
 131 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
 132
 133 /**
 134  * Returns the colorpixel to use for the given hex color (think of HTML). Only
 135  * works for true-color (vast majority of cases) at the moment, avoiding a
 136  * roundtrip to X11.
 137  *
 138  * The hex_color has to start with #, for example #FF00FF.
 139  *
 140  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
 141  * This has to be done by the caller.
 142  *
 143  * NOTE that this function may in the future rely on a global xcb_connection_t
 144  * variable called 'conn' to be present.
 145  *
 146  */
 147 uint32_t get_colorpixel(const char *hex) __attribute__((const));
 148
 149 #if defined(__APPLE__)
 150
 151 /*
 152  * Taken from FreeBSD
 153  * Returns a pointer to a new string which is a duplicate of the
 154  * string, but only copies at most n characters.
 155  *
 156  */
 157 char *strndup(const char *str, size_t n);
 158
 159 #endif
 160
 161 /**
 162  * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
 163  * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
 164  *
 165  * This function initiates one round-trip. Use get_mod_mask_for() directly if
 166  * you already have the modifier mapping and key symbols.
 167  *
 168  */
 169 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
 170
 171 /**
 172  * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
 173  * example for XCB_NUM_LOCK (usually configured to mod2).
 174  *
 175  * This function does not initiate any round-trips.
 176  *
 177  */
 178 uint32_t get_mod_mask_for(uint32_t keysym,
 179                            xcb_key_symbols_t *symbols,
 180                            xcb_get_modifier_mapping_reply_t *modmap_reply);
 181
 182 /**
 183  * Loads a font for usage, also getting its height. If fallback is true,
 184  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
 185  *
 186  */
 187 i3Font load_font(const char *pattern, const bool fallback);
 188
 189 /**
 190  * Defines the font to be used for the forthcoming calls.
 191  *
 192  */
 193 void set_font(i3Font *font);
 194
 195 /**
 196  * Frees the resources taken by the current font.
 197  *
 198  */
 199 void free_font();
 200
 201 /**
 202  * Converts the given string to UTF-8 from UCS-2 big endian. The return value
 203  * must be freed after use.
 204  *
 205  */
 206 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
 207
 208 /**
 209  * Converts the given string to UCS-2 big endian for use with
 210  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 211  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 212  * returned. It has to be freed when done.
 213  *
 214  */
 215 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
 216
 217 /**
 218  * Defines the colors to be used for the forthcoming draw_text calls.
 219  *
 220  */
 221 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
 222
 223 /**
 224  * Draws text onto the specified X drawable (normally a pixmap) at the
 225  * specified coordinates (from the top left corner of the leftmost, uppermost
 226  * glyph) and using the provided gc. Text can be specified as UCS-2 or UTF-8.
 227  *
 228  */
 229 void draw_text(char *text, size_t text_len, bool is_ucs2, xcb_drawable_t drawable,
 230         xcb_gcontext_t gc, int x, int y, int max_width);
 231
 232 /**
 233  * Predict the text width in pixels for the given text. Text can be specified
 234  * as UCS-2 or UTF-8.
 235  *
 236  */
 237 int predict_text_width(char *text, size_t text_len, bool is_ucs2);
 238
 239 #endif