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 #define XCB_BUTTON_CLICK_LEFT XCB_BUTTON_INDEX_1
29 #define XCB_BUTTON_CLICK_MIDDLE XCB_BUTTON_INDEX_2
30 #define XCB_BUTTON_CLICK_RIGHT XCB_BUTTON_INDEX_3
31 #define XCB_BUTTON_SCROLL_UP XCB_BUTTON_INDEX_4
32 #define XCB_BUTTON_SCROLL_DOWN XCB_BUTTON_INDEX_5
33 /* xcb doesn't define constants for these. */
34 #define XCB_BUTTON_SCROLL_LEFT 6
35 #define XCB_BUTTON_SCROLL_RIGHT 7
38 * XCB connection and root screen
41 extern xcb_connection_t *conn;
42 extern xcb_screen_t *root_screen;
45 * Opaque data structure for storing strings.
48 typedef struct _i3String i3String;
50 typedef struct Font i3Font;
53 * Data structure for cached font information:
54 * - font id in X11 (load it once)
55 * - font height (multiple calls needed to get it)
59 /** The type of font */
66 /** The height of the font, built from font_ascent + font_descent */
69 /** The pattern/name used to load the font. */
74 /** The xcb-id for the font */
77 /** Font information gathered from the server */
78 xcb_query_font_reply_t *info;
80 /** Font table for this font (may be NULL) */
81 xcb_charinfo_t *table;
84 /** The pango font description */
85 PangoFontDescription *pango_desc;
89 /* Since this file also gets included by utilities which don’t use the i3 log
90 * infrastructure, we define a fallback. */
92 void verboselog(char *fmt, ...)
93 __attribute__((format(printf, 1, 2)));
94 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
97 void errorlog(char *fmt, ...)
98 __attribute__((format(printf, 1, 2)));
99 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
102 void debuglog(char *fmt, ...)
103 __attribute__((format(printf, 1, 2)));
104 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, STRIPPED__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
108 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
109 * the X11 root window and return NULL if it doesn’t work.
111 * If the provided XCB connection is NULL, a new connection will be
114 * The memory for the contents is dynamically allocated and has to be
115 * free()d by the caller.
118 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
121 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
122 * there is no more memory available)
125 void *smalloc(size_t size);
128 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
129 * there is no more memory available)
132 void *scalloc(size_t num, size_t size);
135 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
136 * that there is no more memory available).
139 void *srealloc(void *ptr, size_t size);
142 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
143 * there is no more memory available)
146 char *sstrdup(const char *str);
149 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
150 * there is no more memory available)
153 char *sstrndup(const char *str, size_t size);
156 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
157 * there is no more memory available)
160 int sasprintf(char **strp, const char *fmt, ...);
163 * Wrapper around correct write which returns -1 (meaning that
164 * write failed) or count (meaning that all bytes were written)
167 ssize_t writeall(int fd, const void *buf, size_t count);
170 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
174 ssize_t swrite(int fd, const void *buf, size_t count);
177 * Build an i3String from an UTF-8 encoded string.
178 * Returns the newly-allocated i3String.
181 i3String *i3string_from_utf8(const char *from_utf8);
184 * Build an i3String from an UTF-8 encoded string in Pango markup.
187 i3String *i3string_from_markup(const char *from_markup);
190 * Build an i3String from an UTF-8 encoded string with fixed length.
191 * To be used when no proper NUL-terminaison is available.
192 * Returns the newly-allocated i3String.
195 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
198 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
202 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
205 * Build an i3String from an UCS-2 encoded string.
206 * Returns the newly-allocated i3String.
209 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
212 * Copies the given i3string.
213 * Note that this will not free the source string.
215 i3String *i3string_copy(i3String *str);
221 void i3string_free(i3String *str);
224 * Securely i3string_free by setting the pointer to NULL
225 * to prevent accidentally using freed memory.
228 #define I3STRING_FREE(str) \
231 i3string_free(str); \
237 * Returns the UTF-8 encoded version of the i3String.
240 const char *i3string_as_utf8(i3String *str);
243 * Returns the UCS-2 encoded version of the i3String.
246 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
249 * Returns the number of bytes (UTF-8 encoded) in an i3String.
252 size_t i3string_get_num_bytes(i3String *str);
255 * Whether the given i3String is in Pango markup.
257 bool i3string_is_markup(i3String *str);
260 * Set whether the i3String should use Pango markup.
262 void i3string_set_markup(i3String *str, bool pango_markup);
265 * Escape pango markup characters in the given string.
267 i3String *i3string_escape_markup(i3String *str);
270 * Returns the number of glyphs in an i3String.
273 size_t i3string_get_num_glyphs(i3String *str);
276 * Connects to the i3 IPC socket and returns the file descriptor for the
277 * socket. die()s if anything goes wrong.
280 int ipc_connect(const char *socket_path);
283 * Formats a message (payload) of the given size and type and sends it to i3 via
284 * the given socket file descriptor.
286 * Returns -1 when write() fails, errno will remain.
287 * Returns 0 on success.
290 int ipc_send_message(int sockfd, const uint32_t message_size,
291 const uint32_t message_type, const uint8_t *payload);
294 * Reads a message from the given socket file descriptor and stores its length
295 * (reply_length) as well as a pointer to its contents (reply).
297 * Returns -1 when read() fails, errno will remain.
298 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
299 * message type, EOF instead of a message). Additionally, the error will be
301 * Returns 0 on success.
304 int ipc_recv_message(int sockfd, uint32_t *message_type,
305 uint32_t *reply_length, uint8_t **reply);
308 * Generates a configure_notify event and sends it to the given window
309 * Applications need this to think they’ve configured themselves correctly.
310 * The truth is, however, that we will manage them.
313 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
316 * Returns the colorpixel to use for the given hex color (think of HTML). Only
317 * works for true-color (vast majority of cases) at the moment, avoiding a
320 * The hex_color has to start with #, for example #FF00FF.
322 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
323 * This has to be done by the caller.
325 * NOTE that this function may in the future rely on a global xcb_connection_t
326 * variable called 'conn' to be present.
329 uint32_t get_colorpixel(const char *hex) __attribute__((const));
331 #if defined(__APPLE__)
335 * Returns a pointer to a new string which is a duplicate of the
336 * string, but only copies at most n characters.
339 char *strndup(const char *str, size_t n);
344 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
345 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
347 * This function initiates one round-trip. Use get_mod_mask_for() directly if
348 * you already have the modifier mapping and key symbols.
351 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
354 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
355 * example for XCB_NUM_LOCK (usually configured to mod2).
357 * This function does not initiate any round-trips.
360 uint32_t get_mod_mask_for(uint32_t keysym,
361 xcb_key_symbols_t *symbols,
362 xcb_get_modifier_mapping_reply_t *modmap_reply);
365 * Loads a font for usage, also getting its height. If fallback is true,
366 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
367 * font was previously loaded, it will be freed.
370 i3Font load_font(const char *pattern, const bool fallback);
373 * Defines the font to be used for the forthcoming calls.
376 void set_font(i3Font *font);
379 * Frees the resources taken by the current font. If no font was previously
380 * loaded, it simply returns.
383 void free_font(void);
386 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
387 * must be freed after use.
390 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
393 * Converts the given string to UCS-2 big endian for use with
394 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
395 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
396 * returned. It has to be freed when done.
399 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
401 /* Represents a color split by color channel. */
402 typedef struct color_t {
408 /* The colorpixel we use for direct XCB calls. */
412 #define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
415 * Defines the colors to be used for the forthcoming draw_text calls.
418 void set_font_colors(xcb_gcontext_t gc, color_t foreground, color_t background);
421 * Returns true if and only if the current font is a pango font.
424 bool font_is_pango(void);
427 * Draws text onto the specified X drawable (normally a pixmap) at the
428 * specified coordinates (from the top left corner of the leftmost, uppermost
429 * glyph) and using the provided gc.
431 * Text must be specified as an i3String.
434 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
435 xcb_visualtype_t *visual, int x, int y, int max_width);
438 * ASCII version of draw_text to print static strings.
441 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
442 xcb_gcontext_t gc, int x, int y, int max_width);
445 * Predict the text width in pixels for the given text. Text must be
446 * specified as an i3String.
449 int predict_text_width(i3String *text);
452 * Returns the visual type associated with the given screen.
455 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
458 * Returns true if this version of i3 is a debug build (anything which is not a
459 * release version), based on the git version number.
462 bool is_debug_build() __attribute__((const));
465 * Returns the name of a temporary file with the specified prefix.
468 char *get_process_filename(const char *prefix);
471 * This function returns the absolute path to the executable it is running in.
473 * The implementation follows https://stackoverflow.com/a/933996/712014
475 * Returned value must be freed by the caller.
477 char *get_exe_path(const char *argv0);
480 * Initialize the DPI setting.
481 * This will use the 'Xft.dpi' X resource if available and fall back to
482 * guessing the correct value otherwise.
487 * This function returns the value of the DPI setting.
490 long get_dpi_value(void);
493 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
494 * screen) to a corresponding amount of physical pixels on a standard or retina
495 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
498 int logical_px(const int logical);
501 * This function resolves ~ in pathnames.
502 * It may resolve wildcards in the first part of the path, but if no match
503 * or multiple matches are found, it just returns a copy of path as given.
506 char *resolve_tilde(const char *path);
509 * Get the path of the first configuration file found. If override_configpath
510 * is specified, that path is returned and saved for further calls. Otherwise,
511 * checks the home directory first, then the system directory first, always
512 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
516 char *get_config_path(const char *override_configpath, bool use_system_paths);
520 * Emulates mkdir -p (creates any missing folders)
523 int mkdirp(const char *path, mode_t mode);
526 /** Helper structure for usage in format_placeholders(). */
527 typedef struct placeholder_t {
528 /* The placeholder to be replaced, e.g., "%title". */
530 /* The value this placeholder should be replaced with. */
535 * Replaces occurrences of the defined placeholders in the format string.
538 char *format_placeholders(char *format, placeholder_t *placeholders, int num);
540 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
541 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
542 #define CAIRO_SURFACE_FLUSH(surface) \
544 cairo_surface_flush(surface); \
545 cairo_surface_flush(surface); \
548 /* A wrapper grouping an XCB drawable and both a graphics context
549 * and the corresponding cairo objects representing it. */
550 typedef struct surface_t {
551 /* The drawable which is being represented. */
554 /* A classic XCB graphics context. */
557 xcb_visualtype_t *visual_type;
562 /* A cairo surface representing the drawable. */
563 cairo_surface_t *surface;
565 /* The cairo object representing the drawable. In general,
566 * this is what one should use for any drawing operation. */
571 * Initialize the surface to represent the given drawable.
574 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
575 xcb_visualtype_t *visual, int width, int height);
578 * Resize the surface to the given size.
581 void draw_util_surface_set_size(surface_t *surface, int width, int height);
584 * Destroys the surface.
587 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
590 * Parses the given color in hex format to an internal color representation.
591 * Note that the input must begin with a hash sign, e.g., "#3fbc59".
594 color_t draw_util_hex_to_color(const char *color);
597 * Draw the given text using libi3.
598 * This function also marks the surface dirty which is needed if other means of
599 * drawing are used. This will be the case when using XCB to draw text.
602 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
605 * Draws a filled rectangle.
606 * This function is a convenience wrapper and takes care of flushing the
607 * surface as well as restoring the cairo state.
610 void draw_util_rectangle(surface_t *surface, color_t color, double x, double y, double w, double h);
613 * Clears a surface with the given color.
616 void draw_util_clear_surface(surface_t *surface, color_t color);
619 * Copies a surface onto another surface.
622 void draw_util_copy_surface(surface_t *src, surface_t *dest, double src_x, double src_y,
623 double dest_x, double dest_y, double width, double height);