2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2013 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>
25 * Opaque data structure for storing strings.
28 typedef struct _i3String i3String;
30 typedef struct Font i3Font;
33 * Data structure for cached font information:
34 * - font id in X11 (load it once)
35 * - font height (multiple calls needed to get it)
39 /** The type of font */
46 /** The height of the font, built from font_ascent + font_descent */
49 /** The pattern/name used to load the font. */
54 /** The xcb-id for the font */
57 /** Font information gathered from the server */
58 xcb_query_font_reply_t *info;
60 /** Font table for this font (may be NULL) */
61 xcb_charinfo_t *table;
65 /** The pango font description */
66 PangoFontDescription *pango_desc;
71 /* Since this file also gets included by utilities which don’t use the i3 log
72 * infrastructure, we define a fallback. */
74 void verboselog(char *fmt, ...)
75 __attribute__((format(printf, 1, 2)));
76 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
79 void errorlog(char *fmt, ...)
80 __attribute__((format(printf, 1, 2)));
81 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
84 void debuglog(char *fmt, ...)
85 __attribute__((format(printf, 1, 2)));
86 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
90 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
91 * the X11 root window and return NULL if it doesn’t work.
93 * If the provided XCB connection is NULL, a new connection will be
96 * The memory for the contents is dynamically allocated and has to be
97 * free()d by the caller.
100 char *root_atom_contents(const char *atomname, xcb_connection_t *provided_conn, int screen);
103 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
104 * there is no more memory available)
107 void *smalloc(size_t size);
110 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
111 * there is no more memory available)
114 void *scalloc(size_t size);
117 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
118 * that there is no more memory available).
121 void *srealloc(void *ptr, size_t size);
124 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
125 * there is no more memory available)
128 char *sstrdup(const char *str);
131 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
132 * there is no more memory available)
135 int sasprintf(char **strp, const char *fmt, ...);
138 * Build an i3String from an UTF-8 encoded string.
139 * Returns the newly-allocated i3String.
142 i3String *i3string_from_utf8(const char *from_utf8);
145 * Build an i3String from an UTF-8 encoded string with fixed length.
146 * To be used when no proper NUL-terminaison is available.
147 * Returns the newly-allocated i3String.
150 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
153 * Build an i3String from an UCS-2 encoded string.
154 * Returns the newly-allocated i3String.
157 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
163 void i3string_free(i3String *str);
166 * Securely i3string_free by setting the pointer to NULL
167 * to prevent accidentally using freed memory.
170 #define I3STRING_FREE(str) \
173 i3string_free(str); \
179 * Returns the UTF-8 encoded version of the i3String.
182 const char *i3string_as_utf8(i3String *str);
185 * Returns the UCS-2 encoded version of the i3String.
188 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
191 * Returns the number of bytes (UTF-8 encoded) in an i3String.
194 size_t i3string_get_num_bytes(i3String *str);
197 * Returns the number of glyphs in an i3String.
200 size_t i3string_get_num_glyphs(i3String *str);
203 * Connects to the i3 IPC socket and returns the file descriptor for the
204 * socket. die()s if anything goes wrong.
207 int ipc_connect(const char *socket_path);
210 * Formats a message (payload) of the given size and type and sends it to i3 via
211 * the given socket file descriptor.
213 * Returns -1 when write() fails, errno will remain.
214 * Returns 0 on success.
217 int ipc_send_message(int sockfd, const uint32_t message_size,
218 const uint32_t message_type, const uint8_t *payload);
221 * Reads a message from the given socket file descriptor and stores its length
222 * (reply_length) as well as a pointer to its contents (reply).
224 * Returns -1 when read() fails, errno will remain.
225 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
226 * message type, EOF instead of a message). Additionally, the error will be
228 * Returns 0 on success.
231 int ipc_recv_message(int sockfd, uint32_t *message_type,
232 uint32_t *reply_length, uint8_t **reply);
235 * Generates a configure_notify event and sends it to the given window
236 * Applications need this to think they’ve configured themselves correctly.
237 * The truth is, however, that we will manage them.
240 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
243 * Returns the colorpixel to use for the given hex color (think of HTML). Only
244 * works for true-color (vast majority of cases) at the moment, avoiding a
247 * The hex_color has to start with #, for example #FF00FF.
249 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
250 * This has to be done by the caller.
252 * NOTE that this function may in the future rely on a global xcb_connection_t
253 * variable called 'conn' to be present.
256 uint32_t get_colorpixel(const char *hex) __attribute__((const));
258 #if defined(__APPLE__)
262 * Returns a pointer to a new string which is a duplicate of the
263 * string, but only copies at most n characters.
266 char *strndup(const char *str, size_t n);
271 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
272 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
274 * This function initiates one round-trip. Use get_mod_mask_for() directly if
275 * you already have the modifier mapping and key symbols.
278 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
281 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
282 * example for XCB_NUM_LOCK (usually configured to mod2).
284 * This function does not initiate any round-trips.
287 uint32_t get_mod_mask_for(uint32_t keysym,
288 xcb_key_symbols_t *symbols,
289 xcb_get_modifier_mapping_reply_t *modmap_reply);
292 * Loads a font for usage, also getting its height. If fallback is true,
293 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
296 i3Font load_font(const char *pattern, const bool fallback);
299 * Defines the font to be used for the forthcoming calls.
302 void set_font(i3Font *font);
305 * Frees the resources taken by the current font.
308 void free_font(void);
311 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
312 * must be freed after use.
315 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
318 * Converts the given string to UCS-2 big endian for use with
319 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
320 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
321 * returned. It has to be freed when done.
324 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
327 * Defines the colors to be used for the forthcoming draw_text calls.
330 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
333 * Draws text onto the specified X drawable (normally a pixmap) at the
334 * specified coordinates (from the top left corner of the leftmost, uppermost
335 * glyph) and using the provided gc.
337 * Text must be specified as an i3String.
340 void draw_text(i3String *text, xcb_drawable_t drawable,
341 xcb_gcontext_t gc, int x, int y, int max_width);
344 * ASCII version of draw_text to print static strings.
347 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
348 xcb_gcontext_t gc, int x, int y, int max_width);
351 * Predict the text width in pixels for the given text. Text must be
352 * specified as an i3String.
355 int predict_text_width(i3String *text);
358 * Returns the visual type associated with the given screen.
361 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
364 * Returns true if this version of i3 is a debug build (anything which is not a
365 * release version), based on the git version number.
368 bool is_debug_build() __attribute__((const));
371 * Returns the name of a temporary file with the specified prefix.
374 char *get_process_filename(const char *prefix);
377 * This function returns the absolute path to the executable it is running in.
379 * The implementation follows http://stackoverflow.com/a/933996/712014
381 * Returned value must be freed by the caller.
383 char *get_exe_path(const char *argv0);
386 * Convert a logical amount of pixels (e.g. 2 pixels on a “standard” 96 DPI
387 * screen) to a corresponding amount of physical pixels on a standard or retina
388 * screen, e.g. 5 pixels on a 227 DPI MacBook Pro 13" Retina screen.
391 int logical_px(const int logical);