2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * libi3: contains functions which are used by i3 *and* accompanying tools such
8 * as i3-msg, i3-config-wizard, …
19 #include <xcb/xproto.h>
20 #include <xcb/xcb_keysyms.h>
22 #include <pango/pango.h>
23 #include <cairo/cairo-xcb.h>
25 #define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
28 * XCB connection and root screen
31 extern xcb_connection_t *conn;
32 extern xcb_screen_t *root_screen;
35 * Opaque data structure for storing strings.
38 typedef struct _i3String i3String;
40 typedef struct Font i3Font;
43 * Data structure for cached font information:
44 * - font id in X11 (load it once)
45 * - font height (multiple calls needed to get it)
49 /** The type of font */
56 /** The height of the font, built from font_ascent + font_descent */
59 /** The pattern/name used to load the font. */
64 /** The xcb-id for the font */
67 /** Font information gathered from the server */
68 xcb_query_font_reply_t *info;
70 /** Font table for this font (may be NULL) */
71 xcb_charinfo_t *table;
74 /** The pango font description */
75 PangoFontDescription *pango_desc;
79 /* Since this file also gets included by utilities which don’t use the i3 log
80 * infrastructure, we define a fallback. */
82 void verboselog(char *fmt, ...)
83 __attribute__((format(printf, 1, 2)));
84 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
87 void errorlog(char *fmt, ...)
88 __attribute__((format(printf, 1, 2)));
89 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
92 void debuglog(char *fmt, ...)
93 __attribute__((format(printf, 1, 2)));
94 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, STRIPPED__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
98 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
99 * the X11 root window and return NULL if it doesn’t work.
101 * If the provided XCB connection is NULL, a new connection will be
104 * The memory for the contents is dynamically allocated and has to be
105 * free()d by the caller.
108 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
111 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
112 * there is no more memory available)
115 void *smalloc(size_t size);
118 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
119 * there is no more memory available)
122 void *scalloc(size_t num, size_t size);
125 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
126 * that there is no more memory available).
129 void *srealloc(void *ptr, size_t size);
132 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
133 * there is no more memory available)
136 char *sstrdup(const char *str);
139 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
140 * there is no more memory available)
143 char *sstrndup(const char *str, size_t size);
146 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
147 * there is no more memory available)
150 int sasprintf(char **strp, const char *fmt, ...);
153 * Wrapper around correct write which returns -1 (meaning that
154 * write failed) or count (meaning that all bytes were written)
157 ssize_t writeall(int fd, const void *buf, size_t count);
160 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
164 ssize_t swrite(int fd, const void *buf, size_t count);
167 * Build an i3String from an UTF-8 encoded string.
168 * Returns the newly-allocated i3String.
171 i3String *i3string_from_utf8(const char *from_utf8);
174 * Build an i3String from an UTF-8 encoded string in Pango markup.
177 i3String *i3string_from_markup(const char *from_markup);
180 * Build an i3String from an UTF-8 encoded string with fixed length.
181 * To be used when no proper NUL-terminaison is available.
182 * Returns the newly-allocated i3String.
185 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
188 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
192 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
195 * Build an i3String from an UCS-2 encoded string.
196 * Returns the newly-allocated i3String.
199 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
202 * Copies the given i3string.
203 * Note that this will not free the source string.
205 i3String *i3string_copy(i3String *str);
211 void i3string_free(i3String *str);
214 * Securely i3string_free by setting the pointer to NULL
215 * to prevent accidentally using freed memory.
218 #define I3STRING_FREE(str) \
221 i3string_free(str); \
227 * Returns the UTF-8 encoded version of the i3String.
230 const char *i3string_as_utf8(i3String *str);
233 * Returns the UCS-2 encoded version of the i3String.
236 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
239 * Returns the number of bytes (UTF-8 encoded) in an i3String.
242 size_t i3string_get_num_bytes(i3String *str);
245 * Whether the given i3String is in Pango markup.
247 bool i3string_is_markup(i3String *str);
250 * Set whether the i3String should use Pango markup.
252 void i3string_set_markup(i3String *str, bool pango_markup);
255 * Escape pango markup characters in the given string.
257 i3String *i3string_escape_markup(i3String *str);
260 * Returns the number of glyphs in an i3String.
263 size_t i3string_get_num_glyphs(i3String *str);
266 * Connects to the i3 IPC socket and returns the file descriptor for the
267 * socket. die()s if anything goes wrong.
270 int ipc_connect(const char *socket_path);
273 * Formats a message (payload) of the given size and type and sends it to i3 via
274 * the given socket file descriptor.
276 * Returns -1 when write() fails, errno will remain.
277 * Returns 0 on success.
280 int ipc_send_message(int sockfd, const uint32_t message_size,
281 const uint32_t message_type, const uint8_t *payload);
284 * Reads a message from the given socket file descriptor and stores its length
285 * (reply_length) as well as a pointer to its contents (reply).
287 * Returns -1 when read() fails, errno will remain.
288 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
289 * message type, EOF instead of a message). Additionally, the error will be
291 * Returns 0 on success.
294 int ipc_recv_message(int sockfd, uint32_t *message_type,
295 uint32_t *reply_length, uint8_t **reply);
298 * Generates a configure_notify event and sends it to the given window
299 * Applications need this to think they’ve configured themselves correctly.
300 * The truth is, however, that we will manage them.
303 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
306 * Returns the colorpixel to use for the given hex color (think of HTML). Only
307 * works for true-color (vast majority of cases) at the moment, avoiding a
310 * The hex_color has to start with #, for example #FF00FF.
312 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
313 * This has to be done by the caller.
315 * NOTE that this function may in the future rely on a global xcb_connection_t
316 * variable called 'conn' to be present.
319 uint32_t get_colorpixel(const char *hex) __attribute__((const));
321 #if defined(__APPLE__)
325 * Returns a pointer to a new string which is a duplicate of the
326 * string, but only copies at most n characters.
329 char *strndup(const char *str, size_t n);
334 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
335 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
337 * This function initiates one round-trip. Use get_mod_mask_for() directly if
338 * you already have the modifier mapping and key symbols.
341 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
344 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
345 * example for XCB_NUM_LOCK (usually configured to mod2).
347 * This function does not initiate any round-trips.
350 uint32_t get_mod_mask_for(uint32_t keysym,
351 xcb_key_symbols_t *symbols,
352 xcb_get_modifier_mapping_reply_t *modmap_reply);
355 * Loads a font for usage, also getting its height. If fallback is true,
356 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
357 * font was previously loaded, it will be freed.
360 i3Font load_font(const char *pattern, const bool fallback);
363 * Defines the font to be used for the forthcoming calls.
366 void set_font(i3Font *font);
369 * Frees the resources taken by the current font. If no font was previously
370 * loaded, it simply returns.
373 void free_font(void);
376 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
377 * must be freed after use.
380 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
383 * Converts the given string to UCS-2 big endian for use with
384 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
385 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
386 * returned. It has to be freed when done.
389 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
391 /* Represents a color split by color channel. */
392 typedef struct color_t {
398 /* The colorpixel we use for direct XCB calls. */
402 #define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
405 * Defines the colors to be used for the forthcoming draw_text calls.
408 void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
411 * Returns true if and only if the current font is a pango font.
414 bool font_is_pango(void);
417 * Draws text onto the specified X drawable (normally a pixmap) at the
418 * specified coordinates (from the top left corner of the leftmost, uppermost
419 * glyph) and using the provided gc.
421 * Text must be specified as an i3String.
424 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
425 xcb_visualtype_t *visual, int x, int y, int max_width);
428 * ASCII version of draw_text to print static strings.
431 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
432 xcb_gcontext_t gc, int x, int y, int max_width);
435 * Predict the text width in pixels for the given text. Text must be
436 * specified as an i3String.
439 int predict_text_width(i3String *text);
442 * Returns the visual type associated with the given screen.
445 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
448 * Returns true if this version of i3 is a debug build (anything which is not a
449 * release version), based on the git version number.
452 bool is_debug_build() __attribute__((const));
455 * Returns the name of a temporary file with the specified prefix.
458 char *get_process_filename(const char *prefix);
461 * This function returns the absolute path to the executable it is running in.
463 * The implementation follows http://stackoverflow.com/a/933996/712014
465 * Returned value must be freed by the caller.
467 char *get_exe_path(const char *argv0);
470 * Initialize the DPI setting.
471 * This will use the 'Xft.dpi' X resource if available and fall back to
472 * guessing the correct value otherwise.
477 * This function returns the value of the DPI setting.
480 long get_dpi_value(void);
483 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
484 * screen) to a corresponding amount of physical pixels on a standard or retina
485 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
488 int logical_px(const int logical);
491 * This function resolves ~ in pathnames.
492 * It may resolve wildcards in the first part of the path, but if no match
493 * or multiple matches are found, it just returns a copy of path as given.
496 char *resolve_tilde(const char *path);
499 * Get the path of the first configuration file found. If override_configpath
500 * is specified, that path is returned and saved for further calls. Otherwise,
501 * checks the home directory first, then the system directory first, always
502 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
506 char *get_config_path(const char *override_configpath, bool use_system_paths);
510 * Emulates mkdir -p (creates any missing folders)
513 int mkdirp(const char *path, mode_t mode);
516 /** Helper structure for usage in format_placeholders(). */
517 typedef struct placeholder_t {
518 /* The placeholder to be replaced, e.g., "%title". */
520 /* The value this placeholder should be replaced with. */
525 * Replaces occurrences of the defined placeholders in the format string.
528 char *format_placeholders(char *format, placeholder_t *placeholders, int num);
530 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
531 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
532 #define CAIRO_SURFACE_FLUSH(surface) \
534 cairo_surface_flush(surface); \
535 cairo_surface_flush(surface); \
538 /* A wrapper grouping an XCB drawable and both a graphics context
539 * and the corresponding cairo objects representing it. */
540 typedef struct surface_t {
541 /* The drawable which is being represented. */
544 /* A classic XCB graphics context. */
547 xcb_visualtype_t *visual_type;
552 /* A cairo surface representing the drawable. */
553 cairo_surface_t *surface;
555 /* The cairo object representing the drawable. In general,
556 * this is what one should use for any drawing operation. */
561 * Initialize the surface to represent the given drawable.
564 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
565 xcb_visualtype_t *visual, int width, int height);
568 * Resize the surface to the given size.
571 void draw_util_surface_set_size(surface_t *surface, int width, int height);
574 * Destroys the surface.
577 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
580 * Parses the given color in hex format to an internal color representation.
581 * Note that the input must begin with a hash sign, e.g., "#3fbc59".
584 color_t draw_util_hex_to_color(const char *color);
587 * Draw the given text using libi3.
588 * This function also marks the surface dirty which is needed if other means of
589 * drawing are used. This will be the case when using XCB to draw text.
592 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
595 * Draws a filled rectangle.
596 * This function is a convenience wrapper and takes care of flushing the
597 * surface as well as restoring the cairo state.
600 void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
603 * Clears a surface with the given color.
606 void draw_util_clear_surface(surface_t *surface, color_t color);
609 * Copies a surface onto another surface.
612 void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
613 double dest_x, double dest_y, double width, double height);