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 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 strndup which exits if strndup returns NULL (meaning that
 132  * there is no more memory available)
 133  *
 134  */
 135 char *sstrndup(const char *str, size_t size);
 136
 137 /**
 138  * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
 139  * there is no more memory available)
 140  *
 141  */
 142 int sasprintf(char **strp, const char *fmt, ...);
 143
 144 /**
 145  * Wrapper around correct write which returns -1 (meaning that
 146  * write failed) or count (meaning that all bytes were written)
 147  *
 148  */
 149 ssize_t writeall(int fd, const void *buf, size_t count);
 150
 151 /**
 152  * Safe-wrapper around writeall which exits if it returns -1 (meaning that
 153  * write failed)
 154  *
 155  */
 156 ssize_t swrite(int fd, const void *buf, size_t count);
 157
 158 /**
 159  * Build an i3String from an UTF-8 encoded string.
 160  * Returns the newly-allocated i3String.
 161  *
 162  */
 163 i3String *i3string_from_utf8(const char *from_utf8);
 164
 165 /**
 166  * Build an i3String from an UTF-8 encoded string in Pango markup.
 167  *
 168  */
 169 i3String *i3string_from_markup(const char *from_markup);
 170
 171 /**
 172  * Build an i3String from an UTF-8 encoded string with fixed length.
 173  * To be used when no proper NUL-terminaison is available.
 174  * Returns the newly-allocated i3String.
 175  *
 176  */
 177 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
 178
 179 /**
 180  * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
 181  * length.
 182  *
 183  */
 184 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
 185
 186 /**
 187  * Build an i3String from an UCS-2 encoded string.
 188  * Returns the newly-allocated i3String.
 189  *
 190  */
 191 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
 192
 193 /**
 194  * Copies the given i3string.
 195  * Note that this will not free the source string.
 196  */
 197 i3String *i3string_copy(i3String *str);
 198
 199 /**
 200  * Free an i3String.
 201  *
 202  */
 203 void i3string_free(i3String *str);
 204
 205 /**
 206  * Securely i3string_free by setting the pointer to NULL
 207  * to prevent accidentally using freed memory.
 208  *
 209  */
 210 #define I3STRING_FREE(str)      \
 211     do {                        \
 212         if (str != NULL) {      \
 213             i3string_free(str); \
 214             str = NULL;         \
 215         }                       \
 216     } while (0)
 217
 218 /**
 219  * Returns the UTF-8 encoded version of the i3String.
 220  *
 221  */
 222 const char *i3string_as_utf8(i3String *str);
 223
 224 /**
 225  * Returns the UCS-2 encoded version of the i3String.
 226  *
 227  */
 228 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
 229
 230 /**
 231  * Returns the number of bytes (UTF-8 encoded) in an i3String.
 232  *
 233  */
 234 size_t i3string_get_num_bytes(i3String *str);
 235
 236 /**
 237  * Whether the given i3String is in Pango markup.
 238  */
 239 bool i3string_is_markup(i3String *str);
 240
 241 /**
 242  * Set whether the i3String should use Pango markup.
 243  */
 244 void i3string_set_markup(i3String *str, bool is_markup);
 245
 246 /**
 247  * Escape pango markup characters in the given string.
 248  */
 249 i3String *i3string_escape_markup(i3String *str);
 250
 251 /**
 252  * Returns the number of glyphs in an i3String.
 253  *
 254  */
 255 size_t i3string_get_num_glyphs(i3String *str);
 256
 257 /**
 258  * Connects to the i3 IPC socket and returns the file descriptor for the
 259  * socket. die()s if anything goes wrong.
 260  *
 261  */
 262 int ipc_connect(const char *socket_path);
 263
 264 /**
 265  * Formats a message (payload) of the given size and type and sends it to i3 via
 266  * the given socket file descriptor.
 267  *
 268  * Returns -1 when write() fails, errno will remain.
 269  * Returns 0 on success.
 270  *
 271  */
 272 int ipc_send_message(int sockfd, const uint32_t message_size,
 273                      const uint32_t message_type, const uint8_t *payload);
 274
 275 /**
 276  * Reads a message from the given socket file descriptor and stores its length
 277  * (reply_length) as well as a pointer to its contents (reply).
 278  *
 279  * Returns -1 when read() fails, errno will remain.
 280  * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
 281  * message type, EOF instead of a message). Additionally, the error will be
 282  * printed to stderr.
 283  * Returns 0 on success.
 284  *
 285  */
 286 int ipc_recv_message(int sockfd, uint32_t *message_type,
 287                      uint32_t *reply_length, uint8_t **reply);
 288
 289 /**
 290  * Generates a configure_notify event and sends it to the given window
 291  * Applications need this to think they’ve configured themselves correctly.
 292  * The truth is, however, that we will manage them.
 293  *
 294  */
 295 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
 296
 297 /**
 298  * Returns the colorpixel to use for the given hex color (think of HTML). Only
 299  * works for true-color (vast majority of cases) at the moment, avoiding a
 300  * roundtrip to X11.
 301  *
 302  * The hex_color has to start with #, for example #FF00FF.
 303  *
 304  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
 305  * This has to be done by the caller.
 306  *
 307  * NOTE that this function may in the future rely on a global xcb_connection_t
 308  * variable called 'conn' to be present.
 309  *
 310  */
 311 uint32_t get_colorpixel(const char *hex) __attribute__((const));
 312
 313 #if defined(__APPLE__)
 314
 315 /*
 316  * Taken from FreeBSD
 317  * Returns a pointer to a new string which is a duplicate of the
 318  * string, but only copies at most n characters.
 319  *
 320  */
 321 char *strndup(const char *str, size_t n);
 322
 323 #endif
 324
 325 /**
 326  * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
 327  * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
 328  *
 329  * This function initiates one round-trip. Use get_mod_mask_for() directly if
 330  * you already have the modifier mapping and key symbols.
 331  *
 332  */
 333 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
 334
 335 /**
 336  * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
 337  * example for XCB_NUM_LOCK (usually configured to mod2).
 338  *
 339  * This function does not initiate any round-trips.
 340  *
 341  */
 342 uint32_t get_mod_mask_for(uint32_t keysym,
 343                           xcb_key_symbols_t *symbols,
 344                           xcb_get_modifier_mapping_reply_t *modmap_reply);
 345
 346 /**
 347  * Loads a font for usage, also getting its height. If fallback is true,
 348  * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
 349  * font was previously loaded, it will be freed.
 350  *
 351  */
 352 i3Font load_font(const char *pattern, const bool fallback);
 353
 354 /**
 355  * Defines the font to be used for the forthcoming calls.
 356  *
 357  */
 358 void set_font(i3Font *font);
 359
 360 /**
 361  * Frees the resources taken by the current font. If no font was previously
 362  * loaded, it simply returns.
 363  *
 364  */
 365 void free_font(void);
 366
 367 /**
 368  * Converts the given string to UTF-8 from UCS-2 big endian. The return value
 369  * must be freed after use.
 370  *
 371  */
 372 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
 373
 374 /**
 375  * Converts the given string to UCS-2 big endian for use with
 376  * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
 377  * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
 378  * returned. It has to be freed when done.
 379  *
 380  */
 381 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
 382
 383 /**
 384  * Defines the colors to be used for the forthcoming draw_text calls.
 385  *
 386  */
 387 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
 388
 389 /**
 390  * Returns true if and only if the current font is a pango font.
 391  *
 392  */
 393 bool font_is_pango(void);
 394
 395 /**
 396  * Draws text onto the specified X drawable (normally a pixmap) at the
 397  * specified coordinates (from the top left corner of the leftmost, uppermost
 398  * glyph) and using the provided gc.
 399  *
 400  * Text must be specified as an i3String.
 401  *
 402  */
 403 void draw_text(i3String *text, xcb_drawable_t drawable,
 404                xcb_gcontext_t gc, int x, int y, int max_width);
 405
 406 /**
 407  * ASCII version of draw_text to print static strings.
 408  *
 409  */
 410 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
 411                      xcb_gcontext_t gc, int x, int y, int max_width);
 412
 413 /**
 414  * Predict the text width in pixels for the given text. Text must be
 415  * specified as an i3String.
 416  *
 417  */
 418 int predict_text_width(i3String *text);
 419
 420 /**
 421  * Returns the visual type associated with the given screen.
 422  *
 423  */
 424 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
 425
 426 /**
 427  * Returns true if this version of i3 is a debug build (anything which is not a
 428  * release version), based on the git version number.
 429  *
 430  */
 431 bool is_debug_build() __attribute__((const));
 432
 433 /**
 434  * Returns the name of a temporary file with the specified prefix.
 435  *
 436  */
 437 char *get_process_filename(const char *prefix);
 438
 439 /**
 440  * This function returns the absolute path to the executable it is running in.
 441  *
 442  * The implementation follows http://stackoverflow.com/a/933996/712014
 443  *
 444  * Returned value must be freed by the caller.
 445  */
 446 char *get_exe_path(const char *argv0);
 447
 448 /**
 449  * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
 450  * screen) to a corresponding amount of physical pixels on a standard or retina
 451  * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
 452  *
 453  */
 454 int logical_px(const int logical);
 455
 456 /**
 457  * This function resolves ~ in pathnames.
 458  * It may resolve wildcards in the first part of the path, but if no match
 459  * or multiple matches are found, it just returns a copy of path as given.
 460  *
 461  */
 462 char *resolve_tilde(const char *path);
 463
 464 /**
 465  * Get the path of the first configuration file found. If override_configpath
 466  * is specified, that path is returned and saved for further calls. Otherwise,
 467  * checks the home directory first, then the system directory first, always
 468  * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
 469  * $XDG_CONFIG_DIRS)
 470  *
 471  */
 472 char *get_config_path(const char *override_configpath, bool use_system_paths);
 473
 474 /**
 475  * Emulates mkdir -p (creates any missing folders)
 476  *
 477  */
 478 bool mkdirp(const char *path);