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 #define DEFAULT_DIR_MODE (S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
27 * Opaque data structure for storing strings.
30 typedef struct _i3String i3String;
32 typedef struct Font i3Font;
35 * Data structure for cached font information:
36 * - font id in X11 (load it once)
37 * - font height (multiple calls needed to get it)
41 /** The type of font */
48 /** The height of the font, built from font_ascent + font_descent */
51 /** The pattern/name used to load the font. */
56 /** The xcb-id for the font */
59 /** Font information gathered from the server */
60 xcb_query_font_reply_t *info;
62 /** Font table for this font (may be NULL) */
63 xcb_charinfo_t *table;
67 /** The pango font description */
68 PangoFontDescription *pango_desc;
73 /* Since this file also gets included by utilities which don’t use the i3 log
74 * infrastructure, we define a fallback. */
76 void verboselog(char *fmt, ...)
77 __attribute__((format(printf, 1, 2)));
78 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
81 void errorlog(char *fmt, ...)
82 __attribute__((format(printf, 1, 2)));
83 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
86 void debuglog(char *fmt, ...)
87 __attribute__((format(printf, 1, 2)));
88 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
92 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
93 * the X11 root window and return NULL if it doesn’t work.
95 * If the provided XCB connection is NULL, a new connection will be
98 * The memory for the contents is dynamically allocated and has to be
99 * free()d by the caller.
102 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
105 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
106 * there is no more memory available)
109 void *smalloc(size_t size);
112 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
113 * there is no more memory available)
116 void *scalloc(size_t num, size_t size);
119 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
120 * that there is no more memory available).
123 void *srealloc(void *ptr, size_t size);
126 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
127 * there is no more memory available)
130 char *sstrdup(const char *str);
133 * Safe-wrapper around strndup which exits if strndup returns NULL (meaning that
134 * there is no more memory available)
137 char *sstrndup(const char *str, size_t size);
140 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
141 * there is no more memory available)
144 int sasprintf(char **strp, const char *fmt, ...);
147 * Wrapper around correct write which returns -1 (meaning that
148 * write failed) or count (meaning that all bytes were written)
151 ssize_t writeall(int fd, const void *buf, size_t count);
154 * Safe-wrapper around writeall which exits if it returns -1 (meaning that
158 ssize_t swrite(int fd, const void *buf, size_t count);
161 * Build an i3String from an UTF-8 encoded string.
162 * Returns the newly-allocated i3String.
165 i3String *i3string_from_utf8(const char *from_utf8);
168 * Build an i3String from an UTF-8 encoded string in Pango markup.
171 i3String *i3string_from_markup(const char *from_markup);
174 * Build an i3String from an UTF-8 encoded string with fixed length.
175 * To be used when no proper NUL-terminaison is available.
176 * Returns the newly-allocated i3String.
179 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
182 * Build an i3String from an UTF-8 encoded string in Pango markup with fixed
186 i3String *i3string_from_markup_with_length(const char *from_markup, size_t num_bytes);
189 * Build an i3String from an UCS-2 encoded string.
190 * Returns the newly-allocated i3String.
193 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
196 * Copies the given i3string.
197 * Note that this will not free the source string.
199 i3String *i3string_copy(i3String *str);
205 void i3string_free(i3String *str);
208 * Securely i3string_free by setting the pointer to NULL
209 * to prevent accidentally using freed memory.
212 #define I3STRING_FREE(str) \
215 i3string_free(str); \
221 * Returns the UTF-8 encoded version of the i3String.
224 const char *i3string_as_utf8(i3String *str);
227 * Returns the UCS-2 encoded version of the i3String.
230 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
233 * Returns the number of bytes (UTF-8 encoded) in an i3String.
236 size_t i3string_get_num_bytes(i3String *str);
239 * Whether the given i3String is in Pango markup.
241 bool i3string_is_markup(i3String *str);
244 * Set whether the i3String should use Pango markup.
246 void i3string_set_markup(i3String *str, bool pango_markup);
249 * Escape pango markup characters in the given string.
251 i3String *i3string_escape_markup(i3String *str);
254 * Returns the number of glyphs in an i3String.
257 size_t i3string_get_num_glyphs(i3String *str);
260 * Connects to the i3 IPC socket and returns the file descriptor for the
261 * socket. die()s if anything goes wrong.
264 int ipc_connect(const char *socket_path);
267 * Formats a message (payload) of the given size and type and sends it to i3 via
268 * the given socket file descriptor.
270 * Returns -1 when write() fails, errno will remain.
271 * Returns 0 on success.
274 int ipc_send_message(int sockfd, const uint32_t message_size,
275 const uint32_t message_type, const uint8_t *payload);
278 * Reads a message from the given socket file descriptor and stores its length
279 * (reply_length) as well as a pointer to its contents (reply).
281 * Returns -1 when read() fails, errno will remain.
282 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
283 * message type, EOF instead of a message). Additionally, the error will be
285 * Returns 0 on success.
288 int ipc_recv_message(int sockfd, uint32_t *message_type,
289 uint32_t *reply_length, uint8_t **reply);
292 * Generates a configure_notify event and sends it to the given window
293 * Applications need this to think they’ve configured themselves correctly.
294 * The truth is, however, that we will manage them.
297 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
300 * Returns the colorpixel to use for the given hex color (think of HTML). Only
301 * works for true-color (vast majority of cases) at the moment, avoiding a
304 * The hex_color has to start with #, for example #FF00FF.
306 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
307 * This has to be done by the caller.
309 * NOTE that this function may in the future rely on a global xcb_connection_t
310 * variable called 'conn' to be present.
313 uint32_t get_colorpixel(const char *hex) __attribute__((const));
315 #if defined(__APPLE__)
319 * Returns a pointer to a new string which is a duplicate of the
320 * string, but only copies at most n characters.
323 char *strndup(const char *str, size_t n);
328 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
329 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
331 * This function initiates one round-trip. Use get_mod_mask_for() directly if
332 * you already have the modifier mapping and key symbols.
335 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
338 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
339 * example for XCB_NUM_LOCK (usually configured to mod2).
341 * This function does not initiate any round-trips.
344 uint32_t get_mod_mask_for(uint32_t keysym,
345 xcb_key_symbols_t *symbols,
346 xcb_get_modifier_mapping_reply_t *modmap_reply);
349 * Loads a font for usage, also getting its height. If fallback is true,
350 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting. If any
351 * font was previously loaded, it will be freed.
354 i3Font load_font(const char *pattern, const bool fallback);
357 * Defines the font to be used for the forthcoming calls.
360 void set_font(i3Font *font);
363 * Frees the resources taken by the current font. If no font was previously
364 * loaded, it simply returns.
367 void free_font(void);
370 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
371 * must be freed after use.
374 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
377 * Converts the given string to UCS-2 big endian for use with
378 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
379 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
380 * returned. It has to be freed when done.
383 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
386 * Defines the colors to be used for the forthcoming draw_text calls.
389 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
392 * Returns true if and only if the current font is a pango font.
395 bool font_is_pango(void);
398 * Draws text onto the specified X drawable (normally a pixmap) at the
399 * specified coordinates (from the top left corner of the leftmost, uppermost
400 * glyph) and using the provided gc.
402 * Text must be specified as an i3String.
405 void draw_text(i3String *text, xcb_drawable_t drawable, xcb_gcontext_t gc,
406 xcb_visualtype_t *visual, int x, int y, int max_width);
409 * ASCII version of draw_text to print static strings.
412 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
413 xcb_gcontext_t gc, int x, int y, int max_width);
416 * Predict the text width in pixels for the given text. Text must be
417 * specified as an i3String.
420 int predict_text_width(i3String *text);
423 * Returns the visual type associated with the given screen.
426 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
429 * Returns true if this version of i3 is a debug build (anything which is not a
430 * release version), based on the git version number.
433 bool is_debug_build() __attribute__((const));
436 * Returns the name of a temporary file with the specified prefix.
439 char *get_process_filename(const char *prefix);
442 * This function returns the absolute path to the executable it is running in.
444 * The implementation follows http://stackoverflow.com/a/933996/712014
446 * Returned value must be freed by the caller.
448 char *get_exe_path(const char *argv0);
451 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
452 * screen) to a corresponding amount of physical pixels on a standard or retina
453 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
456 int logical_px(const int logical);
459 * This function resolves ~ in pathnames.
460 * It may resolve wildcards in the first part of the path, but if no match
461 * or multiple matches are found, it just returns a copy of path as given.
464 char *resolve_tilde(const char *path);
467 * Get the path of the first configuration file found. If override_configpath
468 * is specified, that path is returned and saved for further calls. Otherwise,
469 * checks the home directory first, then the system directory first, always
470 * taking into account the XDG Base Directory Specification ($XDG_CONFIG_HOME,
474 char *get_config_path(const char *override_configpath, bool use_system_paths);
478 * Emulates mkdir -p (creates any missing folders)
481 int mkdirp(const char *path, mode_t mode);