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 * Opaque data structure for storing strings.
25 typedef struct _i3String i3String;
27 typedef struct Font i3Font;
30 * Data structure for cached font information:
31 * - font id in X11 (load it once)
32 * - font height (multiple calls needed to get it)
36 /** The xcb-id for the font */
39 /** Font information gathered from the server */
40 xcb_query_font_reply_t *info;
42 /** Font table for this font (may be NULL) */
43 xcb_charinfo_t *table;
45 /** The height of the font, built from font_ascent + font_descent */
49 /* Since this file also gets included by utilities which don’t use the i3 log
50 * infrastructure, we define a fallback. */
52 #define ELOG(fmt, ...) fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__)
56 * Try to get the contents of the given atom (for example I3_SOCKET_PATH) from
57 * the X11 root window and return NULL if it doesn’t work.
59 * The memory for the contents is dynamically allocated and has to be
60 * free()d by the caller.
63 char *root_atom_contents(const char *atomname);
66 * Safe-wrapper around malloc which exits if malloc returns NULL (meaning that
67 * there is no more memory available)
70 void *smalloc(size_t size);
73 * Safe-wrapper around calloc which exits if malloc returns NULL (meaning that
74 * there is no more memory available)
77 void *scalloc(size_t size);
80 * Safe-wrapper around realloc which exits if realloc returns NULL (meaning
81 * that there is no more memory available).
84 void *srealloc(void *ptr, size_t size);
87 * Safe-wrapper around strdup which exits if malloc returns NULL (meaning that
88 * there is no more memory available)
91 char *sstrdup(const char *str);
94 * Safe-wrapper around asprintf which exits if it returns -1 (meaning that
95 * there is no more memory available)
98 int sasprintf(char **strp, const char *fmt, ...);
101 * Build an i3String from an UTF-8 encoded string.
102 * Returns the newly-allocated i3String.
105 i3String *i3string_from_utf8(const char *from_utf8);
108 * Build an i3String from an UTF-8 encoded string with fixed length.
109 * To be used when no proper NUL-terminaison is available.
110 * Returns the newly-allocated i3String.
113 i3String *i3string_from_utf8_with_length(const char *from_utf8, size_t num_bytes);
116 * Build an i3String from an UCS-2 encoded string.
117 * Returns the newly-allocated i3String.
120 i3String *i3string_from_ucs2(const xcb_char2b_t *from_ucs2, size_t num_glyphs);
126 void i3string_free(i3String *str);
129 * Securely i3string_free by setting the pointer to NULL
130 * to prevent accidentally using freed memory.
133 #define I3STRING_FREE(str) \
136 i3string_free(str); \
142 * Returns the UTF-8 encoded version of the i3String.
145 const char *i3string_as_utf8(i3String *str);
148 * Returns the UCS-2 encoded version of the i3String.
151 const xcb_char2b_t *i3string_as_ucs2(i3String *str);
154 * Returns the number of bytes (UTF-8 encoded) in an i3String.
157 size_t i3string_get_num_bytes(i3String *str);
160 * Returns the number of glyphs in an i3String.
163 size_t i3string_get_num_glyphs(i3String *str);
166 * Connects to the i3 IPC socket and returns the file descriptor for the
167 * socket. die()s if anything goes wrong.
170 int ipc_connect(const char *socket_path);
173 * Formats a message (payload) of the given size and type and sends it to i3 via
174 * the given socket file descriptor.
176 * Returns -1 when write() fails, errno will remain.
177 * Returns 0 on success.
180 int ipc_send_message(int sockfd, uint32_t message_size,
181 uint32_t message_type, const uint8_t *payload);
184 * Reads a message from the given socket file descriptor and stores its length
185 * (reply_length) as well as a pointer to its contents (reply).
187 * Returns -1 when read() fails, errno will remain.
188 * Returns -2 when the IPC protocol is violated (invalid magic, unexpected
189 * message type, EOF instead of a message). Additionally, the error will be
191 * Returns 0 on success.
194 int ipc_recv_message(int sockfd, uint32_t message_type,
195 uint32_t *reply_length, uint8_t **reply);
198 * Generates a configure_notify event and sends it to the given window
199 * Applications need this to think they’ve configured themselves correctly.
200 * The truth is, however, that we will manage them.
203 void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width);
206 * Returns the colorpixel to use for the given hex color (think of HTML). Only
207 * works for true-color (vast majority of cases) at the moment, avoiding a
210 * The hex_color has to start with #, for example #FF00FF.
212 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
213 * This has to be done by the caller.
215 * NOTE that this function may in the future rely on a global xcb_connection_t
216 * variable called 'conn' to be present.
219 uint32_t get_colorpixel(const char *hex) __attribute__((const));
221 #if defined(__APPLE__)
225 * Returns a pointer to a new string which is a duplicate of the
226 * string, but only copies at most n characters.
229 char *strndup(const char *str, size_t n);
234 * All-in-one function which returns the modifier mask (XCB_MOD_MASK_*) for the
235 * given keysymbol, for example for XCB_NUM_LOCK (usually configured to mod2).
237 * This function initiates one round-trip. Use get_mod_mask_for() directly if
238 * you already have the modifier mapping and key symbols.
241 uint32_t aio_get_mod_mask_for(uint32_t keysym, xcb_key_symbols_t *symbols);
244 * Returns the modifier mask (XCB_MOD_MASK_*) for the given keysymbol, for
245 * example for XCB_NUM_LOCK (usually configured to mod2).
247 * This function does not initiate any round-trips.
250 uint32_t get_mod_mask_for(uint32_t keysym,
251 xcb_key_symbols_t *symbols,
252 xcb_get_modifier_mapping_reply_t *modmap_reply);
255 * Loads a font for usage, also getting its height. If fallback is true,
256 * the fonts 'fixed' or '-misc-*' will be loaded instead of exiting.
259 i3Font load_font(const char *pattern, const bool fallback);
262 * Defines the font to be used for the forthcoming calls.
265 void set_font(i3Font *font);
268 * Frees the resources taken by the current font.
271 void free_font(void);
274 * Converts the given string to UTF-8 from UCS-2 big endian. The return value
275 * must be freed after use.
278 char *convert_ucs2_to_utf8(xcb_char2b_t *text, size_t num_glyphs);
281 * Converts the given string to UCS-2 big endian for use with
282 * xcb_image_text_16(). The amount of real glyphs is stored in real_strlen,
283 * a buffer containing the UCS-2 encoded string (16 bit per glyph) is
284 * returned. It has to be freed when done.
287 xcb_char2b_t *convert_utf8_to_ucs2(char *input, size_t *real_strlen);
290 * Defines the colors to be used for the forthcoming draw_text calls.
293 void set_font_colors(xcb_gcontext_t gc, uint32_t foreground, uint32_t background);
296 * Draws text onto the specified X drawable (normally a pixmap) at the
297 * specified coordinates (from the top left corner of the leftmost, uppermost
298 * glyph) and using the provided gc.
300 * Text must be specified as an i3String.
303 void draw_text(i3String *text, xcb_drawable_t drawable,
304 xcb_gcontext_t gc, int x, int y, int max_width);
307 * ASCII version of draw_text to print static strings.
310 void draw_text_ascii(const char *text, xcb_drawable_t drawable,
311 xcb_gcontext_t gc, int x, int y, int max_width);
314 * Predict the text width in pixels for the given text. Text must be
315 * specified as an i3String.
318 int predict_text_width(i3String *text);
321 * Returns the visual type associated with the given screen.
324 xcb_visualtype_t *get_visualtype(xcb_screen_t *screen);
327 * Returns true if this version of i3 is a debug build (anything which is not a
328 * release version), based on the git version number.
331 bool is_debug_build() __attribute__((const));