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