4 * i3 - an improved dynamic tiling window manager
6 * © 2009 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * xcb.c: Helper functions for easier usage of XCB
19 #include <xcb/xcb_keysyms.h>
25 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
26 unsigned int xcb_numlock_mask;
29 * Loads a font for usage, getting its height. This function is used very often, so it
33 i3Font *load_font(xcb_connection_t *conn, const char *pattern) {
34 /* Check if we got the font cached */
36 TAILQ_FOREACH(font, &cached_fonts, fonts)
37 if (strcmp(font->pattern, pattern) == 0)
40 i3Font *new = smalloc(sizeof(i3Font));
41 xcb_void_cookie_t font_cookie;
42 xcb_list_fonts_with_info_cookie_t info_cookie;
44 /* Send all our requests first */
45 new->id = xcb_generate_id(conn);
46 font_cookie = xcb_open_font_checked(conn, new->id, strlen(pattern), pattern);
47 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
49 check_error(conn, font_cookie, "Could not open font");
51 /* Get information (height/name) for this font */
52 xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
53 exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
55 if (asprintf(&(new->name), "%.*s", xcb_list_fonts_with_info_name_length(reply),
56 xcb_list_fonts_with_info_name(reply)) == -1)
57 die("asprintf() failed\n");
58 new->pattern = sstrdup(pattern);
59 new->height = reply->font_ascent + reply->font_descent;
61 /* Insert into cache */
62 TAILQ_INSERT_TAIL(&cached_fonts, new, fonts);
68 * Returns the colorpixel to use for the given hex color (think of HTML).
70 * The hex_color has to start with #, for example #FF00FF.
72 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
73 * This has to be done by the caller.
76 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex) {
77 char strgroups[3][3] = {{hex[1], hex[2], '\0'},
78 {hex[3], hex[4], '\0'},
79 {hex[5], hex[6], '\0'}};
80 uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
81 (strtol(strgroups[1], NULL, 16)),
82 (strtol(strgroups[2], NULL, 16))};
84 return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
88 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
92 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class, int cursor,
93 bool map, uint32_t mask, uint32_t *values) {
94 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
95 xcb_window_t result = xcb_generate_id(conn);
96 xcb_cursor_t cursor_id = xcb_generate_id(conn);
98 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
99 uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
101 /* Use the default cursor (left pointer) */
103 i3Font *cursor_font = load_font(conn, "cursor");
104 xcb_create_glyph_cursor(conn, cursor_id, cursor_font->id, cursor_font->id,
105 XCB_CURSOR_LEFT_PTR, XCB_CURSOR_LEFT_PTR + 1,
106 0, 0, 0, 65535, 65535, 65535);
109 xcb_create_window(conn,
111 result, /* the window id */
112 root, /* parent == root */
113 dims.x, dims.y, dims.width, dims.height, /* dimensions */
114 0, /* border = 0, we draw our own */
116 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
121 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
123 /* Map the window (= make it visible) */
125 xcb_map_window(conn, result);
131 * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
134 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
135 xcb_change_gc(conn, gc, mask, &value);
139 * Draws a line from x,y to to_x,to_y using the given color
142 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
143 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
144 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
145 xcb_point_t points[] = {{x, y}, {to_x, to_y}};
146 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
150 * Draws a rectangle from x,y with width,height using the given color
153 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
154 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
155 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
156 xcb_rectangle_t rect = {x, y, width, height};
157 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
161 * Generates a configure_notify event and sends it to the given window
162 * Applications need this to think they’ve configured themselves correctly.
163 * The truth is, however, that we will manage them.
166 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
167 xcb_configure_notify_event_t generated_event;
169 generated_event.event = window;
170 generated_event.window = window;
171 generated_event.response_type = XCB_CONFIGURE_NOTIFY;
173 generated_event.x = r.x;
174 generated_event.y = r.y;
175 generated_event.width = r.width;
176 generated_event.height = r.height;
178 generated_event.border_width = 0;
179 generated_event.above_sibling = XCB_NONE;
180 generated_event.override_redirect = false;
182 xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)&generated_event);
187 * Generates a configure_notify_event with absolute coordinates (relative to the X root
188 * window, not to the client’s frame) for the given client.
191 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client) {
194 absolute.x = client->rect.x + client->child_rect.x;
195 absolute.y = client->rect.y + client->child_rect.y;
196 absolute.width = client->child_rect.width;
197 absolute.height = client->child_rect.height;
199 fake_configure_notify(conn, absolute, client->child);
203 * Finds out which modifier mask is the one for numlock, as the user may change this.
206 void xcb_get_numlock_mask(xcb_connection_t *conn) {
207 xcb_key_symbols_t *keysyms;
208 xcb_get_modifier_mapping_cookie_t cookie;
209 xcb_get_modifier_mapping_reply_t *reply;
210 xcb_keycode_t *modmap;
212 const int masks[8] = { XCB_MOD_MASK_SHIFT,
214 XCB_MOD_MASK_CONTROL,
221 /* Request the modifier map */
222 cookie = xcb_get_modifier_mapping_unchecked(conn);
224 /* Get the keysymbols */
225 keysyms = xcb_key_symbols_alloc(conn);
227 if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
228 xcb_key_symbols_free(keysyms);
232 modmap = xcb_get_modifier_mapping_keycodes(reply);
234 /* Get the keycode for numlock */
235 #ifdef OLD_XCB_KEYSYMS_API
236 xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
238 /* For now, we only use the first keysymbol. */
239 xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
240 if (numlock_syms == NULL)
242 xcb_keycode_t numlock = *numlock_syms;
246 /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
247 for (mask = 0; mask < 8; mask++)
248 for (i = 0; i < reply->keycodes_per_modifier; i++)
249 if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
250 xcb_numlock_mask = masks[mask];
252 xcb_key_symbols_free(keysyms);
257 * Raises the given window (typically client->frame) above all other windows
260 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
261 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
262 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
267 * Prepares the given Cached_Pixmap for usage (checks whether the size of the
268 * object this pixmap is related to (e.g. a window) has changed and re-creates
272 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap) {
273 LOG("preparing pixmap\n");
275 /* If the Rect did not change, the pixmap does not need to be recreated */
276 if (memcmp(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect)) == 0)
279 memcpy(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect));
281 if (pixmap->id == 0 || pixmap->gc == 0) {
282 LOG("Creating new pixmap...\n");
283 pixmap->id = xcb_generate_id(conn);
284 pixmap->gc = xcb_generate_id(conn);
286 LOG("Re-creating this pixmap...\n");
287 xcb_free_gc(conn, pixmap->gc);
288 xcb_free_pixmap(conn, pixmap->id);
291 xcb_create_pixmap(conn, root_depth, pixmap->id,
292 pixmap->referred_drawable, pixmap->rect.width, pixmap->rect.height);
294 xcb_create_gc(conn, pixmap->gc, pixmap->id, 0, 0);
298 * Query the width of the given text (16-bit characters, UCS) with given real
299 * length (amount of glyphs) using the given font.
302 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text, int length) {
303 i3Font *font = load_font(conn, font_pattern);
305 xcb_query_text_extents_cookie_t cookie;
306 xcb_query_text_extents_reply_t *reply;
307 xcb_generic_error_t *error;
310 cookie = xcb_query_text_extents(conn, font->id, length, (xcb_char2b_t*)text);
311 if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
312 ELOG("Could not get text extents (X error code %d)\n",
314 /* We return the rather safe guess of 7 pixels, because a
315 * rendering error is better than a crash. Plus, the user will
316 * see the error in his log. */
320 width = reply->overall_width;