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 * XCB connection and root screen
33 extern xcb_connection_t *conn;
34 extern xcb_screen_t *root_screen;
37 * Opaque data structure for storing strings.
40 typedef struct _i3String i3String;
42 typedef struct Font i3Font;
45 * Data structure for cached font information:
46 * - font id in X11 (load it once)
47 * - font height (multiple calls needed to get it)
51 /** The type of font */
58 /** The height of the font, built from font_ascent + font_descent */
61 /** The pattern/name used to load the font. */
66 /** The xcb-id for the font */
69 /** Font information gathered from the server */
70 xcb_query_font_reply_t *info;
72 /** Font table for this font (may be NULL) */
73 xcb_charinfo_t *table;
77 /** The pango font description */
78 PangoFontDescription *pango_desc;
83 /* Since this file also gets included by utilities which don’t use the i3 log
84 * infrastructure, we define a fallback. */
86 void verboselog(char *fmt, ...)
87 __attribute__((format(printf, 1, 2)));
88 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
91 void errorlog(char *fmt, ...)
92 __attribute__((format(printf, 1, 2)));
93 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
96 void debuglog(char *fmt, ...)
97 __attribute__((format(printf, 1, 2)));
98 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
102 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
103 * the X11 root window and return NULL if it doesn’t work.
105 * If the provided XCB connection is NULL, a new connection will be
108 * The memory for the contents is dynamically allocated and has to be
109 * free()d by the caller.
112 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
115 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
116 * there is no more memory available)
119 void *smalloc(size_t size);
122 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
123 * there is no more memory available)
126 void *scalloc(size_t num, size_t size);
129 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
130 * that there is no more memory available).
133 void *srealloc(void *ptr, size_t size);
136 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
137 * there is no more memory available)
140 char *sstrdup(const char *str);
143 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
144 * there is no more memory available)
147 char *sstrndup(const char *str, size_t size);
150 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
151 * there is no more memory available)
154 int sasprintf(char **strp, const char *fmt, ...);
157 * Wrapper around correct write which returns -1 (meaning that
158 * write failed) or count (meaning that all bytes were written)
161 ssize_t writeall(int fd, const void *buf, size_t count);
164 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
168 ssize_t swrite(int fd, const void *buf, size_t count);
171 * Build an i3String from an UTF-8 encoded string.
172 * Returns the newly-allocated i3String.
175 i3String *i3string_from_utf8(const char *from_utf8);
178 * Build an i3String from an UTF-8 encoded string in Pango markup.
181 i3String *i3string_from_markup(const char *from_markup);
184 * Build an i3String from an UTF-8 encoded string with fixed length.
185 * To be used when no proper NUL-terminaison is available.
186 * Returns the newly-allocated i3String.
189 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
192 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
196 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
199 * Build an i3String from an UCS-2 encoded string.
200 * Returns the newly-allocated i3String.
203 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
206 * Copies the given i3string.
207 * Note that this will not free the source string.
209 i3String *i3string_copy(i3String *str);
215 void i3string_free(i3String *str);
218 * Securely i3string_free by setting the pointer to NULL
219 * to prevent accidentally using freed memory.
222 #define I3STRING_FREE(str) \
225 i3string_free(str); \
231 * Returns the UTF-8 encoded version of the i3String.
234 const char *i3string_as_utf8(i3String *str);
237 * Returns the UCS-2 encoded version of the i3String.
240 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
243 * Returns the number of bytes (UTF-8 encoded) in an i3String.
246 size_t i3string_get_num_bytes(i3String *str);
249 * Whether the given i3String is in Pango markup.
251 bool i3string_is_markup(i3String *str);
254 * Set whether the i3String should use Pango markup.
256 void i3string_set_markup(i3String *str, bool pango_markup);
259 * Escape pango markup characters in the given string.
261 i3String *i3string_escape_markup(i3String *str);
264 * Returns the number of glyphs in an i3String.
267 size_t i3string_get_num_glyphs(i3String *str);
270 * Connects to the i3 IPC socket and returns the file descriptor for the
271 * socket. die()s if anything goes wrong.
274 int ipc_connect(const char *socket_path);
277 * Formats a message (payload) of the given size and type and sends it to i3 via
278 * the given socket file descriptor.
280 * Returns -1 when write() fails, errno will remain.
281 * Returns 0 on success.
284 int ipc_send_message(int sockfd, const uint32_t message_size,
285 const uint32_t message_type, const uint8_t *payload);
288 * Reads a message from the given socket file descriptor and stores its length
289 * (reply_length) as well as a pointer to its contents (reply).
291 * Returns -1 when read() fails, errno will remain.
292 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
293 * message type, EOF instead of a message). Additionally, the error will be
295 * Returns 0 on success.
298 int ipc_recv_message(int sockfd, uint32_t *message_type,
299 uint32_t *reply_length, uint8_t **reply);
302 * Generates a configure_notify event and sends it to the given window
303 * Applications need this to think they’ve configured themselves correctly.
304 * The truth is, however, that we will manage them.
307 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
310 * Returns the colorpixel to use for the given hex color (think of HTML). Only
311 * works for true-color (vast majority of cases) at the moment, avoiding a
314 * The hex_color has to start with #, for example #FF00FF.
316 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
317 * This has to be done by the caller.
319 * NOTE that this function may in the future rely on a global xcb_connection_t
320 * variable called 'conn' to be present.
323 uint32_t get_colorpixel(const char *hex) __attribute__((const));
325 #if defined(__APPLE__)
329 * Returns a pointer to a new string which is a duplicate of the
330 * string, but only copies at most n characters.
333 char *strndup(const char *str, size_t n);
338 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
339 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
341 * This function initiates one round-trip. Use get_mod_mask_for() directly if
342 * you already have the modifier mapping and key symbols.
345 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
348 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
349 * example for XCB_NUM_LOCK (usually configured to mod2).
351 * This function does not initiate any round-trips.
354 uint32_t get_mod_mask_for(uint32_t keysym,
355 xcb_key_symbols_t *symbols,
356 xcb_get_modifier_mapping_reply_t *modmap_reply);
359 * Loads a font for usage, also getting its height. If fallback is true,
360 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
361 * font was previously loaded, it will be freed.
364 i3Font load_font(const char *pattern, const bool fallback);
367 * Defines the font to be used for the forthcoming calls.
370 void set_font(i3Font *font);
373 * Frees the resources taken by the current font. If no font was previously
374 * loaded, it simply returns.
377 void free_font(void);
380 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
381 * must be freed after use.
384 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
387 * Converts the given string to UCS-2 big endian for use with
388 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
389 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
390 * returned. It has to be freed when done.
393 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
396 * Defines the colors to be used for the forthcoming draw_text calls.
399 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
402 * Returns true if and only if the current font is a pango font.
405 bool font_is_pango(void);
408 * Draws text onto the specified X drawable (normally a pixmap) at the
409 * specified coordinates (from the top left corner of the leftmost, uppermost
410 * glyph) and using the provided gc.
412 * Text must be specified as an i3String.
415 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
416 xcb_visualtype_t *visual, int x, int y, int max_width);
419 * ASCII version of draw_text to print static strings.
422 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
423 xcb_gcontext_t gc, int x, int y, int max_width);
426 * Predict the text width in pixels for the given text. Text must be
427 * specified as an i3String.
430 int predict_text_width(i3String *text);
433 * Returns the visual type associated with the given screen.
436 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
439 * Returns true if this version of i3 is a debug build (anything which is not a
440 * release version), based on the git version number.
443 bool is_debug_build() __attribute__((const));
446 * Returns the name of a temporary file with the specified prefix.
449 char *get_process_filename(const char *prefix);
452 * This function returns the absolute path to the executable it is running in.
454 * The implementation follows http://stackoverflow.com/a/933996/712014
456 * Returned value must be freed by the caller.
458 char *get_exe_path(const char *argv0);
461 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
462 * screen) to a corresponding amount of physical pixels on a standard or retina
463 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
466 int logical_px(const int logical);
469 * This function resolves ~ in pathnames.
470 * It may resolve wildcards in the first part of the path, but if no match
471 * or multiple matches are found, it just returns a copy of path as given.
474 char *resolve_tilde(const char *path);
477 * Get the path of the first configuration file found. If override_configpath
478 * is specified, that path is returned and saved for further calls. Otherwise,
479 * checks the home directory first, then the system directory first, always
480 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
484 char *get_config_path(const char *override_configpath, bool use_system_paths);
488 * Emulates mkdir -p (creates any missing folders)
491 int mkdirp(const char *path, mode_t mode);
495 /* We need to flush cairo surfaces twice to avoid an assertion bug. See #1989
496 * and https://bugs.freedesktop.org/show_bug.cgi?id=92455. */
497 #define CAIRO_SURFACE_FLUSH(surface) \
499 cairo_surface_flush(surface); \
500 cairo_surface_flush(surface); \
504 /* Represents a color split by color channel. */
505 typedef struct color_t {
511 /* The colorpixel we use for direct XCB calls. */
515 #define COLOR_TRANSPARENT ((color_t){.red = 0.0, .green = 0.0, .blue = 0.0, .colorpixel = 0})
517 /* A wrapper grouping an XCB drawable and both a graphics context
518 * and the corresponding cairo objects representing it. */
519 typedef struct surface_t {
520 /* The drawable which is being represented. */
523 /* A classic XCB graphics context. */
526 xcb_visualtype_t *visual_type;
532 /* A cairo surface representing the drawable. */
533 cairo_surface_t *surface;
535 /* The cairo object representing the drawable. In general,
536 * this is what one should use for any drawing operation. */
542 * Initialize the surface to represent the given drawable.
545 void draw_util_surface_init(xcb_connection_t *conn, surface_t *surface, xcb_drawable_t drawable,
546 xcb_visualtype_t *visual, int width, int height);
549 * Resize the surface to the given size.
552 void draw_util_surface_set_size(surface_t *surface, int width, int height);
555 * Destroys the surface.
558 void draw_util_surface_free(xcb_connection_t *conn, surface_t *surface);
561 * Parses the given color in hex format to an internal color representation.
562 * Note that the input must begin with a hash sign, e.g., "#3fbc59".
565 color_t draw_util_hex_to_color(const char *color);
568 * Draw the given text using libi3.
569 * This function also marks the surface dirty which is needed if other means of
570 * drawing are used. This will be the case when using XCB to draw text.
573 void draw_util_text(i3String *text, surface_t *surface, color_t fg_color, color_t bg_color, int x, int y, int max_width);
576 * Draws a filled rectangle.
577 * This function is a convenience wrapper and takes care of flushing the
578 * surface as well as restoring the cairo state.
581 void draw_util_rectangle(xcb_connection_t *conn, surface_t *surface, color_t color, double x, double y, double w, double h);
584 * Clears a surface with the given color.
587 void draw_util_clear_surface(xcb_connection_t *conn, surface_t *surface, color_t color);
590 * Copies a surface onto another surface.
593 void draw_util_copy_surface(xcb_connection_t *conn, surface_t *src, surface_t *dest, double src_x, double src_y,
594 double dest_x, double dest_y, double width, double height);