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, …
17 #include <xcb/xproto.h>
18 #include <xcb/xcb_keysyms.h>
21 #include <pango/pango.h>
24 #include <cairo/cairo-xcb.h>
27 #define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
30 * Opaque data structure for storing strings.
33 typedef struct _i3String i3String;
35 typedef struct Font i3Font;
38 * Data structure for cached font information:
39 * - font id in X11 (load it once)
40 * - font height (multiple calls needed to get it)
44 /** The type of font */
51 /** The height of the font, built from font_ascent + font_descent */
54 /** The pattern/name used to load the font. */
59 /** The xcb-id for the font */
62 /** Font information gathered from the server */
63 xcb_query_font_reply_t *info;
65 /** Font table for this font (may be NULL) */
66 xcb_charinfo_t *table;
70 /** The pango font description */
71 PangoFontDescription *pango_desc;
76 /* Since this file also gets included by utilities which don’t use the i3 log
77 * infrastructure, we define a fallback. */
79 void verboselog(char *fmt, ...)
80 __attribute__((format(printf, 1, 2)));
81 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
84 void errorlog(char *fmt, ...)
85 __attribute__((format(printf, 1, 2)));
86 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
89 void debuglog(char *fmt, ...)
90 __attribute__((format(printf, 1, 2)));
91 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
95 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
96 * the X11 root window and return NULL if it doesn’t work.
98 * If the provided XCB connection is NULL, a new connection will be
101 * The memory for the contents is dynamically allocated and has to be
102 * free()d by the caller.
105 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
108 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
109 * there is no more memory available)
112 void *smalloc(size_t size);
115 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
116 * there is no more memory available)
119 void *scalloc(size_t num, size_t size);
122 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
123 * that there is no more memory available).
126 void *srealloc(void *ptr, size_t size);
129 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
130 * there is no more memory available)
133 char *sstrdup(const char *str);
136 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
137 * there is no more memory available)
140 char *sstrndup(const char *str, size_t size);
143 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
144 * there is no more memory available)
147 int sasprintf(char **strp, const char *fmt, ...);
150 * Wrapper around correct write which returns -1 (meaning that
151 * write failed) or count (meaning that all bytes were written)
154 ssize_t writeall(int fd, const void *buf, size_t count);
157 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
161 ssize_t swrite(int fd, const void *buf, size_t count);
164 * Build an i3String from an UTF-8 encoded string.
165 * Returns the newly-allocated i3String.
168 i3String *i3string_from_utf8(const char *from_utf8);
171 * Build an i3String from an UTF-8 encoded string in Pango markup.
174 i3String *i3string_from_markup(const char *from_markup);
177 * Build an i3String from an UTF-8 encoded string with fixed length.
178 * To be used when no proper NUL-terminaison is available.
179 * Returns the newly-allocated i3String.
182 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
185 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
189 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
192 * Build an i3String from an UCS-2 encoded string.
193 * Returns the newly-allocated i3String.
196 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
199 * Copies the given i3string.
200 * Note that this will not free the source string.
202 i3String *i3string_copy(i3String *str);
208 void i3string_free(i3String *str);
211 * Securely i3string_free by setting the pointer to NULL
212 * to prevent accidentally using freed memory.
215 #define I3STRING_FREE(str) \
218 i3string_free(str); \
224 * Returns the UTF-8 encoded version of the i3String.
227 const char *i3string_as_utf8(i3String *str);
230 * Returns the UCS-2 encoded version of the i3String.
233 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
236 * Returns the number of bytes (UTF-8 encoded) in an i3String.
239 size_t i3string_get_num_bytes(i3String *str);
242 * Whether the given i3String is in Pango markup.
244 bool i3string_is_markup(i3String *str);
247 * Set whether the i3String should use Pango markup.
249 void i3string_set_markup(i3String *str, bool pango_markup);
252 * Escape pango markup characters in the given string.
254 i3String *i3string_escape_markup(i3String *str);
257 * Returns the number of glyphs in an i3String.
260 size_t i3string_get_num_glyphs(i3String *str);
263 * Connects to the i3 IPC socket and returns the file descriptor for the
264 * socket. die()s if anything goes wrong.
267 int ipc_connect(const char *socket_path);
270 * Formats a message (payload) of the given size and type and sends it to i3 via
271 * the given socket file descriptor.
273 * Returns -1 when write() fails, errno will remain.
274 * Returns 0 on success.
277 int ipc_send_message(int sockfd, const uint32_t message_size,
278 const uint32_t message_type, const uint8_t *payload);
281 * Reads a message from the given socket file descriptor and stores its length
282 * (reply_length) as well as a pointer to its contents (reply).
284 * Returns -1 when read() fails, errno will remain.
285 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
286 * message type, EOF instead of a message). Additionally, the error will be
288 * Returns 0 on success.
291 int ipc_recv_message(int sockfd, uint32_t *message_type,
292 uint32_t *reply_length, uint8_t **reply);
295 * Generates a configure_notify event and sends it to the given window
296 * Applications need this to think they’ve configured themselves correctly.
297 * The truth is, however, that we will manage them.
300 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
303 * Returns the colorpixel to use for the given hex color (think of HTML). Only
304 * works for true-color (vast majority of cases) at the moment, avoiding a
307 * The hex_color has to start with #, for example #FF00FF.
309 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
310 * This has to be done by the caller.
312 * NOTE that this function may in the future rely on a global xcb_connection_t
313 * variable called 'conn' to be present.
316 uint32_t get_colorpixel(const char *hex) __attribute__((const));
318 #if defined(__APPLE__)
322 * Returns a pointer to a new string which is a duplicate of the
323 * string, but only copies at most n characters.
326 char *strndup(const char *str, size_t n);
331 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
332 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
334 * This function initiates one round-trip. Use get_mod_mask_for() directly if
335 * you already have the modifier mapping and key symbols.
338 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
341 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
342 * example for XCB_NUM_LOCK (usually configured to mod2).
344 * This function does not initiate any round-trips.
347 uint32_t get_mod_mask_for(uint32_t keysym,
348 xcb_key_symbols_t *symbols,
349 xcb_get_modifier_mapping_reply_t *modmap_reply);
352 * Loads a font for usage, also getting its height. If fallback is true,
353 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
354 * font was previously loaded, it will be freed.
357 i3Font load_font(const char *pattern, const bool fallback);
360 * Defines the font to be used for the forthcoming calls.
363 void set_font(i3Font *font);
366 * Frees the resources taken by the current font. If no font was previously
367 * loaded, it simply returns.
370 void free_font(void);
373 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
374 * must be freed after use.
377 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
380 * Converts the given string to UCS-2 big endian for use with
381 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
382 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
383 * returned. It has to be freed when done.
386 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
389 * Defines the colors to be used for the forthcoming draw_text calls.
392 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
395 * Returns true if and only if the current font is a pango font.
398 bool font_is_pango(void);
401 * Draws text onto the specified X drawable (normally a pixmap) at the
402 * specified coordinates (from the top left corner of the leftmost, uppermost
403 * glyph) and using the provided gc.
405 * Text must be specified as an i3String.
408 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
409 xcb_visualtype_t *visual, int x, int y, int max_width);
412 * ASCII version of draw_text to print static strings.
415 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
416 xcb_gcontext_t gc, int x, int y, int max_width);
419 * Predict the text width in pixels for the given text. Text must be
420 * specified as an i3String.
423 int predict_text_width(i3String *text);
426 * Returns the visual type associated with the given screen.
429 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
432 * Returns true if this version of i3 is a debug build (anything which is not a
433 * release version), based on the git version number.
436 bool is_debug_build() __attribute__((const));
439 * Returns the name of a temporary file with the specified prefix.
442 char *get_process_filename(const char *prefix);
445 * This function returns the absolute path to the executable it is running in.
447 * The implementation follows http://stackoverflow.com/a/933996/712014
449 * Returned value must be freed by the caller.
451 char *get_exe_path(const char *argv0);
454 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
455 * screen) to a corresponding amount of physical pixels on a standard or retina
456 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
459 int logical_px(const int logical);
462 * This function resolves ~ in pathnames.
463 * It may resolve wildcards in the first part of the path, but if no match
464 * or multiple matches are found, it just returns a copy of path as given.
467 char *resolve_tilde(const char *path);
470 * Get the path of the first configuration file found. If override_configpath
471 * is specified, that path is returned and saved for further calls. Otherwise,
472 * checks the home directory first, then the system directory first, always
473 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
477 char *get_config_path(const char *override_configpath, bool use_system_paths);
481 * Emulates mkdir -p (creates any missing folders)
484 int mkdirp(const char *path, mode_t mode);
488 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
489 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
490 #define CAIRO_SURFACE_FLUSH(surface) \
492 cairo_surface_flush(surface); \
493 cairo_surface_flush(surface); \
497 /* Represents a color split by color channel. */
498 typedef struct color_t {
503 /* The colorpixel we use for direct XCB calls. */
507 /* A wrapper grouping an XCB drawable and both a graphics context
508 * and the corresponding cairo objects representing it. */
509 typedef struct surface_t {
510 /* The drawable which is being represented. */
513 /* A classic XCB graphics context. */
516 xcb_visualtype_t *visual_type;
522 /* A cairo surface representing the drawable. */
523 cairo_surface_t *surface;
525 /* The cairo object representing the drawable. In general,
526 * this is what one should use for any drawing operation. */
532 * Initialize the surface to represent the given drawable.
535 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
536 xcb_visualtype_t *visual, int width, int height);
539 * Resize the surface to the given size.
542 void draw_util_surface_set_size(surface_t *surface, int width, int height);
545 * Destroys the surface.
548 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
551 * Parses the given color in hex format to an internal color representation.
552 * Note that the input must begin with a hash sign, e.g., "#3fbc59".
555 color_t draw_util_hex_to_color(const char *color);
557 color_t draw_util_colorpixel_to_color(uint32_t colorpixel);
560 * Draw the given text using libi3.
561 * This function also marks the surface dirty which is needed if other means of
562 * drawing are used. This will be the case when using XCB to draw text.
565 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
568 * Draws a filled rectangle.
569 * This function is a convenience wrapper and takes care of flushing the
570 * surface as well as restoring the cairo state.
573 void draw_util_rectangle(xcb_connection_t *conn, surface_t *surface, color_t color, double x, double y, double w, double h);
576 * Clears a surface with the given color.
579 void draw_util_clear_surface(xcb_connection_t *conn, surface_t *surface, color_t color);
582 * Copies a surface onto another surface.
585 void draw_util_copy_surface(xcb_connection_t *conn, surface_t *src, surface_t *dest, double src_x, double src_y,
586 double dest_x, double dest_y, double width, double height);