2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 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, …
18 #include <xcb/xproto.h>
19 #include <xcb/xcb_keysyms.h>
22 #include <pango/pango.h>
26 * Opaque data structure for storing strings.
29 typedef struct _i3String i3String;
31 typedef struct Font i3Font;
34 * Data structure for cached font information:
35 * - font id in X11 (load it once)
36 * - font height (multiple calls needed to get it)
40 /** The type of font */
47 /** The height of the font, built from font_ascent + font_descent */
52 /** The xcb-id for the font */
55 /** Font information gathered from the server */
56 xcb_query_font_reply_t *info;
58 /** Font table for this font (may be NULL) */
59 xcb_charinfo_t *table;
63 /** The pango font description */
64 PangoFontDescription *pango_desc;
69 /* Since this file also gets included by utilities which don’t use the i3 log
70 * infrastructure, we define a fallback. */
72 void verboselog(char *fmt, ...);
73 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
76 void errorlog(char *fmt, ...);
77 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
81 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
82 * the X11 root window and return NULL if it doesn’t work.
84 * The memory for the contents is dynamically allocated and has to be
85 * free()d by the caller.
88 char *root_atom_contents(const char *atomname);
91 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
92 * there is no more memory available)
95 void *smalloc(size_t size);
98 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
99 * there is no more memory available)
102 void *scalloc(size_t size);
105 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
106 * that there is no more memory available).
109 void *srealloc(void *ptr, size_t size);
112 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
113 * there is no more memory available)
116 char *sstrdup(const char *str);
119 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
120 * there is no more memory available)
123 int sasprintf(char **strp, const char *fmt, ...);
126 * Build an i3String from an UTF-8 encoded string.
127 * Returns the newly-allocated i3String.
130 i3String *i3string_from_utf8(const char *from_utf8);
133 * Build an i3String from an UTF-8 encoded string with fixed length.
134 * To be used when no proper NUL-terminaison is available.
135 * Returns the newly-allocated i3String.
138 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
141 * Build an i3String from an UCS-2 encoded string.
142 * Returns the newly-allocated i3String.
145 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
151 void i3string_free(i3String *str);
154 * Securely i3string_free by setting the pointer to NULL
155 * to prevent accidentally using freed memory.
158 #define I3STRING_FREE(str) \
161 i3string_free(str); \
167 * Returns the UTF-8 encoded version of the i3String.
170 const char *i3string_as_utf8(i3String *str);
173 * Returns the UCS-2 encoded version of the i3String.
176 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
179 * Returns the number of bytes (UTF-8 encoded) in an i3String.
182 size_t i3string_get_num_bytes(i3String *str);
185 * Returns the number of glyphs in an i3String.
188 size_t i3string_get_num_glyphs(i3String *str);
191 * Connects to the i3 IPC socket and returns the file descriptor for the
192 * socket. die()s if anything goes wrong.
195 int ipc_connect(const char *socket_path);
198 * Formats a message (payload) of the given size and type and sends it to i3 via
199 * the given socket file descriptor.
201 * Returns -1 when write() fails, errno will remain.
202 * Returns 0 on success.
205 int ipc_send_message(int sockfd, const uint32_t message_size,
206 const uint32_t message_type, const uint8_t *payload);
209 * Reads a message from the given socket file descriptor and stores its length
210 * (reply_length) as well as a pointer to its contents (reply).
212 * Returns -1 when read() fails, errno will remain.
213 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
214 * message type, EOF instead of a message). Additionally, the error will be
216 * Returns 0 on success.
219 int ipc_recv_message(int sockfd, uint32_t message_type,
220 uint32_t *reply_length, uint8_t **reply);
223 * Generates a configure_notify event and sends it to the given window
224 * Applications need this to think they’ve configured themselves correctly.
225 * The truth is, however, that we will manage them.
228 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
231 * Returns the colorpixel to use for the given hex color (think of HTML). Only
232 * works for true-color (vast majority of cases) at the moment, avoiding a
235 * The hex_color has to start with #, for example #FF00FF.
237 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
238 * This has to be done by the caller.
240 * NOTE that this function may in the future rely on a global xcb_connection_t
241 * variable called 'conn' to be present.
244 uint32_t get_colorpixel(const char *hex) __attribute__((const));
246 #if defined(__APPLE__)
250 * Returns a pointer to a new string which is a duplicate of the
251 * string, but only copies at most n characters.
254 char *strndup(const char *str, size_t n);
259 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
260 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
262 * This function initiates one round-trip. Use get_mod_mask_for() directly if
263 * you already have the modifier mapping and key symbols.
266 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
269 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
270 * example for XCB_NUM_LOCK (usually configured to mod2).
272 * This function does not initiate any round-trips.
275 uint32_t get_mod_mask_for(uint32_t keysym,
276 xcb_key_symbols_t *symbols,
277 xcb_get_modifier_mapping_reply_t *modmap_reply);
280 * Loads a font for usage, also getting its height. If fallback is true,
281 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
284 i3Font load_font(const char *pattern, const bool fallback);
287 * Defines the font to be used for the forthcoming calls.
290 void set_font(i3Font *font);
293 * Frees the resources taken by the current font.
296 void free_font(void);
299 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
300 * must be freed after use.
303 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
306 * Converts the given string to UCS-2 big endian for use with
307 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
308 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
309 * returned. It has to be freed when done.
312 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
315 * Defines the colors to be used for the forthcoming draw_text calls.
318 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
321 * Draws text onto the specified X drawable (normally a pixmap) at the
322 * specified coordinates (from the top left corner of the leftmost, uppermost
323 * glyph) and using the provided gc.
325 * Text must be specified as an i3String.
328 void draw_text(i3String *text, xcb_drawable_t drawable,
329 xcb_gcontext_t gc, int x, int y, int max_width);
332 * ASCII version of draw_text to print static strings.
335 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
336 xcb_gcontext_t gc, int x, int y, int max_width);
339 * Predict the text width in pixels for the given text. Text must be
340 * specified as an i3String.
343 int predict_text_width(i3String *text);
346 * Returns the visual type associated with the given screen.
349 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
352 * Returns true if this version of i3 is a debug build (anything which is not a
353 * release version), based on the git version number.
356 bool is_debug_build() __attribute__((const));
359 * Returns the name of a temporary file with the specified prefix.
362 char *get_process_filename(const char *prefix);