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, …
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 */
50 /** The pattern/name used to load the font. */
55 /** The xcb-id for the font */
58 /** Font information gathered from the server */
59 xcb_query_font_reply_t *info;
61 /** Font table for this font (may be NULL) */
62 xcb_charinfo_t *table;
66 /** The pango font description */
67 PangoFontDescription *pango_desc;
72 /* Since this file also gets included by utilities which don’t use the i3 log
73 * infrastructure, we define a fallback. */
75 void verboselog(char *fmt, ...);
76 #define LOG(fmt, ...) verboselog("[libi3] " __FILE__ " " fmt, ##__VA_ARGS__)
79 void errorlog(char *fmt, ...);
80 #define ELOG(fmt, ...) errorlog("[libi3] ERROR: " fmt, ##__VA_ARGS__)
84 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
85 * the X11 root window and return NULL if it doesn’t work.
87 * The memory for the contents is dynamically allocated and has to be
88 * free()d by the caller.
91 char *root_atom_contents(const char *atomname);
94 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
95 * there is no more memory available)
98 void *smalloc(size_t size);
101 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
102 * there is no more memory available)
105 void *scalloc(size_t size);
108 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
109 * that there is no more memory available).
112 void *srealloc(void *ptr, size_t size);
115 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
116 * there is no more memory available)
119 char *sstrdup(const char *str);
122 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
123 * there is no more memory available)
126 int sasprintf(char **strp, const char *fmt, ...);
129 * Build an i3String from an UTF-8 encoded string.
130 * Returns the newly-allocated i3String.
133 i3String *i3string_from_utf8(const char *from_utf8);
136 * Build an i3String from an UTF-8 encoded string with fixed length.
137 * To be used when no proper NUL-terminaison is available.
138 * Returns the newly-allocated i3String.
141 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
144 * Build an i3String from an UCS-2 encoded string.
145 * Returns the newly-allocated i3String.
148 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
154 void i3string_free(i3String *str);
157 * Securely i3string_free by setting the pointer to NULL
158 * to prevent accidentally using freed memory.
161 #define I3STRING_FREE(str) \
164 i3string_free(str); \
170 * Returns the UTF-8 encoded version of the i3String.
173 const char *i3string_as_utf8(i3String *str);
176 * Returns the UCS-2 encoded version of the i3String.
179 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
182 * Returns the number of bytes (UTF-8 encoded) in an i3String.
185 size_t i3string_get_num_bytes(i3String *str);
188 * Returns the number of glyphs in an i3String.
191 size_t i3string_get_num_glyphs(i3String *str);
194 * Connects to the i3 IPC socket and returns the file descriptor for the
195 * socket. die()s if anything goes wrong.
198 int ipc_connect(const char *socket_path);
201 * Formats a message (payload) of the given size and type and sends it to i3 via
202 * the given socket file descriptor.
204 * Returns -1 when write() fails, errno will remain.
205 * Returns 0 on success.
208 int ipc_send_message(int sockfd, const uint32_t message_size,
209 const uint32_t message_type, const uint8_t *payload);
212 * Reads a message from the given socket file descriptor and stores its length
213 * (reply_length) as well as a pointer to its contents (reply).
215 * Returns -1 when read() fails, errno will remain.
216 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
217 * message type, EOF instead of a message). Additionally, the error will be
219 * Returns 0 on success.
222 int ipc_recv_message(int sockfd, uint32_t *message_type,
223 uint32_t *reply_length, uint8_t **reply);
226 * Generates a configure_notify event and sends it to the given window
227 * Applications need this to think they’ve configured themselves correctly.
228 * The truth is, however, that we will manage them.
231 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
234 * Returns the colorpixel to use for the given hex color (think of HTML). Only
235 * works for true-color (vast majority of cases) at the moment, avoiding a
238 * The hex_color has to start with #, for example #FF00FF.
240 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
241 * This has to be done by the caller.
243 * NOTE that this function may in the future rely on a global xcb_connection_t
244 * variable called 'conn' to be present.
247 uint32_t get_colorpixel(const char *hex) __attribute__((const));
249 #if defined(__APPLE__)
253 * Returns a pointer to a new string which is a duplicate of the
254 * string, but only copies at most n characters.
257 char *strndup(const char *str, size_t n);
262 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
263 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
265 * This function initiates one round-trip. Use get_mod_mask_for() directly if
266 * you already have the modifier mapping and key symbols.
269 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
272 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
273 * example for XCB_NUM_LOCK (usually configured to mod2).
275 * This function does not initiate any round-trips.
278 uint32_t get_mod_mask_for(uint32_t keysym,
279 xcb_key_symbols_t *symbols,
280 xcb_get_modifier_mapping_reply_t *modmap_reply);
283 * Loads a font for usage, also getting its height. If fallback is true,
284 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
287 i3Font load_font(const char *pattern, const bool fallback);
290 * Defines the font to be used for the forthcoming calls.
293 void set_font(i3Font *font);
296 * Frees the resources taken by the current font.
299 void free_font(void);
302 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
303 * must be freed after use.
306 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
309 * Converts the given string to UCS-2 big endian for use with
310 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
311 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
312 * returned. It has to be freed when done.
315 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
318 * Defines the colors to be used for the forthcoming draw_text calls.
321 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
324 * Draws text onto the specified X drawable (normally a pixmap) at the
325 * specified coordinates (from the top left corner of the leftmost, uppermost
326 * glyph) and using the provided gc.
328 * Text must be specified as an i3String.
331 void draw_text(i3String *text, xcb_drawable_t drawable,
332 xcb_gcontext_t gc, int x, int y, int max_width);
335 * ASCII version of draw_text to print static strings.
338 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
339 xcb_gcontext_t gc, int x, int y, int max_width);
342 * Predict the text width in pixels for the given text. Text must be
343 * specified as an i3String.
346 int predict_text_width(i3String *text);
349 * Returns the visual type associated with the given screen.
352 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
355 * Returns true if this version of i3 is a debug build (anything which is not a
356 * release version), based on the git version number.
359 bool is_debug_build() __attribute__((const));
362 * Returns the name of a temporary file with the specified prefix.
365 char *get_process_filename(const char *prefix);