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