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>
20 #include <pango/pango.h>
21 #include <cairo/cairo-xcb.h>
23 #define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
26 * XCB connection and root screen
29 extern xcb_connection_t *conn;
30 extern xcb_screen_t *root_screen;
33 * Opaque data structure for storing strings.
36 typedef struct _i3String i3String;
38 typedef struct Font i3Font;
41 * Data structure for cached font information:
42 * - font id in X11 (load it once)
43 * - font height (multiple calls needed to get it)
47 /** The type of font */
54 /** The height of the font, built from font_ascent + font_descent */
57 /** The pattern/name used to load the font. */
62 /** The xcb-id for the font */
65 /** Font information gathered from the server */
66 xcb_query_font_reply_t *info;
68 /** Font table for this font (may be NULL) */
69 xcb_charinfo_t *table;
72 /** The pango font description */
73 PangoFontDescription *pango_desc;
77 /* Since this file also gets included by utilities which don’t use the i3 log
78 * infrastructure, we define a fallback. */
80 void verboselog(char *fmt, ...)
81 __attribute__((format(printf, 1, 2)));
82 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
85 void errorlog(char *fmt, ...)
86 __attribute__((format(printf, 1, 2)));
87 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
90 void debuglog(char *fmt, ...)
91 __attribute__((format(printf, 1, 2)));
92 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
96 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
97 * the X11 root window and return NULL if it doesn’t work.
99 * If the provided XCB connection is NULL, a new connection will be
102 * The memory for the contents is dynamically allocated and has to be
103 * free()d by the caller.
106 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
109 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
110 * there is no more memory available)
113 void *smalloc(size_t size);
116 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
117 * there is no more memory available)
120 void *scalloc(size_t num, size_t size);
123 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
124 * that there is no more memory available).
127 void *srealloc(void *ptr, size_t size);
130 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
131 * there is no more memory available)
134 char *sstrdup(const char *str);
137 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
138 * there is no more memory available)
141 char *sstrndup(const char *str, size_t size);
144 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
145 * there is no more memory available)
148 int sasprintf(char **strp, const char *fmt, ...);
151 * Wrapper around correct write which returns -1 (meaning that
152 * write failed) or count (meaning that all bytes were written)
155 ssize_t writeall(int fd, const void *buf, size_t count);
158 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
162 ssize_t swrite(int fd, const void *buf, size_t count);
165 * Build an i3String from an UTF-8 encoded string.
166 * Returns the newly-allocated i3String.
169 i3String *i3string_from_utf8(const char *from_utf8);
172 * Build an i3String from an UTF-8 encoded string in Pango markup.
175 i3String *i3string_from_markup(const char *from_markup);
178 * Build an i3String from an UTF-8 encoded string with fixed length.
179 * To be used when no proper NUL-terminaison is available.
180 * Returns the newly-allocated i3String.
183 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
186 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
190 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
193 * Build an i3String from an UCS-2 encoded string.
194 * Returns the newly-allocated i3String.
197 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
200 * Copies the given i3string.
201 * Note that this will not free the source string.
203 i3String *i3string_copy(i3String *str);
209 void i3string_free(i3String *str);
212 * Securely i3string_free by setting the pointer to NULL
213 * to prevent accidentally using freed memory.
216 #define I3STRING_FREE(str) \
219 i3string_free(str); \
225 * Returns the UTF-8 encoded version of the i3String.
228 const char *i3string_as_utf8(i3String *str);
231 * Returns the UCS-2 encoded version of the i3String.
234 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
237 * Returns the number of bytes (UTF-8 encoded) in an i3String.
240 size_t i3string_get_num_bytes(i3String *str);
243 * Whether the given i3String is in Pango markup.
245 bool i3string_is_markup(i3String *str);
248 * Set whether the i3String should use Pango markup.
250 void i3string_set_markup(i3String *str, bool pango_markup);
253 * Escape pango markup characters in the given string.
255 i3String *i3string_escape_markup(i3String *str);
258 * Returns the number of glyphs in an i3String.
261 size_t i3string_get_num_glyphs(i3String *str);
264 * Connects to the i3 IPC socket and returns the file descriptor for the
265 * socket. die()s if anything goes wrong.
268 int ipc_connect(const char *socket_path);
271 * Formats a message (payload) of the given size and type and sends it to i3 via
272 * the given socket file descriptor.
274 * Returns -1 when write() fails, errno will remain.
275 * Returns 0 on success.
278 int ipc_send_message(int sockfd, const uint32_t message_size,
279 const uint32_t message_type, const uint8_t *payload);
282 * Reads a message from the given socket file descriptor and stores its length
283 * (reply_length) as well as a pointer to its contents (reply).
285 * Returns -1 when read() fails, errno will remain.
286 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
287 * message type, EOF instead of a message). Additionally, the error will be
289 * Returns 0 on success.
292 int ipc_recv_message(int sockfd, uint32_t *message_type,
293 uint32_t *reply_length, uint8_t **reply);
296 * Generates a configure_notify event and sends it to the given window
297 * Applications need this to think they’ve configured themselves correctly.
298 * The truth is, however, that we will manage them.
301 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
304 * Returns the colorpixel to use for the given hex color (think of HTML). Only
305 * works for true-color (vast majority of cases) at the moment, avoiding a
308 * The hex_color has to start with #, for example #FF00FF.
310 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
311 * This has to be done by the caller.
313 * NOTE that this function may in the future rely on a global xcb_connection_t
314 * variable called 'conn' to be present.
317 uint32_t get_colorpixel(const char *hex) __attribute__((const));
319 #if defined(__APPLE__)
323 * Returns a pointer to a new string which is a duplicate of the
324 * string, but only copies at most n characters.
327 char *strndup(const char *str, size_t n);
332 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
333 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
335 * This function initiates one round-trip. Use get_mod_mask_for() directly if
336 * you already have the modifier mapping and key symbols.
339 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
342 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
343 * example for XCB_NUM_LOCK (usually configured to mod2).
345 * This function does not initiate any round-trips.
348 uint32_t get_mod_mask_for(uint32_t keysym,
349 xcb_key_symbols_t *symbols,
350 xcb_get_modifier_mapping_reply_t *modmap_reply);
353 * Loads a font for usage, also getting its height. If fallback is true,
354 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
355 * font was previously loaded, it will be freed.
358 i3Font load_font(const char *pattern, const bool fallback);
361 * Defines the font to be used for the forthcoming calls.
364 void set_font(i3Font *font);
367 * Frees the resources taken by the current font. If no font was previously
368 * loaded, it simply returns.
371 void free_font(void);
374 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
375 * must be freed after use.
378 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
381 * Converts the given string to UCS-2 big endian for use with
382 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
383 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
384 * returned. It has to be freed when done.
387 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
389 /* Represents a color split by color channel. */
390 typedef struct color_t {
396 /* The colorpixel we use for direct XCB calls. */
400 #define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
403 * Defines the colors to be used for the forthcoming draw_text calls.
406 void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
409 * Returns true if and only if the current font is a pango font.
412 bool font_is_pango(void);
415 * Draws text onto the specified X drawable (normally a pixmap) at the
416 * specified coordinates (from the top left corner of the leftmost, uppermost
417 * glyph) and using the provided gc.
419 * Text must be specified as an i3String.
422 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
423 xcb_visualtype_t *visual, int x, int y, int max_width);
426 * ASCII version of draw_text to print static strings.
429 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
430 xcb_gcontext_t gc, int x, int y, int max_width);
433 * Predict the text width in pixels for the given text. Text must be
434 * specified as an i3String.
437 int predict_text_width(i3String *text);
440 * Returns the visual type associated with the given screen.
443 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
446 * Returns true if this version of i3 is a debug build (anything which is not a
447 * release version), based on the git version number.
450 bool is_debug_build() __attribute__((const));
453 * Returns the name of a temporary file with the specified prefix.
456 char *get_process_filename(const char *prefix);
459 * This function returns the absolute path to the executable it is running in.
461 * The implementation follows http://stackoverflow.com/a/933996/712014
463 * Returned value must be freed by the caller.
465 char *get_exe_path(const char *argv0);
468 * Initialize the DPI setting.
469 * This will use the 'Xft.dpi' X resource if available and fall back to
470 * guessing the correct value otherwise.
475 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
476 * screen) to a corresponding amount of physical pixels on a standard or retina
477 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
480 int logical_px(const int logical);
483 * This function resolves ~ in pathnames.
484 * It may resolve wildcards in the first part of the path, but if no match
485 * or multiple matches are found, it just returns a copy of path as given.
488 char *resolve_tilde(const char *path);
491 * Get the path of the first configuration file found. If override_configpath
492 * is specified, that path is returned and saved for further calls. Otherwise,
493 * checks the home directory first, then the system directory first, always
494 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
498 char *get_config_path(const char *override_configpath, bool use_system_paths);
502 * Emulates mkdir -p (creates any missing folders)
505 int mkdirp(const char *path, mode_t mode);
508 /** Helper structure for usage in format_placeholders(). */
509 typedef struct placeholder_t {
510 /* The placeholder to be replaced, e.g., "%title". */
512 /* The value this placeholder should be replaced with. */
517 * Replaces occurrences of the defined placeholders in the format string.
520 char *format_placeholders(char *format, placeholder_t *placeholders, int num);
522 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
523 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
524 #define CAIRO_SURFACE_FLUSH(surface) \
526 cairo_surface_flush(surface); \
527 cairo_surface_flush(surface); \
530 /* A wrapper grouping an XCB drawable and both a graphics context
531 * and the corresponding cairo objects representing it. */
532 typedef struct surface_t {
533 /* The drawable which is being represented. */
536 /* A classic XCB graphics context. */
539 xcb_visualtype_t *visual_type;
544 /* A cairo surface representing the drawable. */
545 cairo_surface_t *surface;
547 /* The cairo object representing the drawable. In general,
548 * this is what one should use for any drawing operation. */
553 * Initialize the surface to represent the given drawable.
556 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
557 xcb_visualtype_t *visual, int width, int height);
560 * Resize the surface to the given size.
563 void draw_util_surface_set_size(surface_t *surface, int width, int height);
566 * Destroys the surface.
569 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
572 * Parses the given color in hex format to an internal color representation.
573 * Note that the input must begin with a hash sign, e.g., "#3fbc59".
576 color_t draw_util_hex_to_color(const char *color);
579 * Draw the given text using libi3.
580 * This function also marks the surface dirty which is needed if other means of
581 * drawing are used. This will be the case when using XCB to draw text.
584 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
587 * Draws a filled rectangle.
588 * This function is a convenience wrapper and takes care of flushing the
589 * surface as well as restoring the cairo state.
592 void draw_util_rectangle(xcb_connection_t *conn, surface_t *surface, color_t color, double x, double y, double w, double h);
595 * Clears a surface with the given color.
598 void draw_util_clear_surface(xcb_connection_t *conn, surface_t *surface, color_t color);
601 * Copies a surface onto another surface.
604 void draw_util_copy_surface(xcb_connection_t *conn, surface_t *src, surface_t *dest, double src_x, double src_y,
605 double dest_x, double dest_y, double width, double height);