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