4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
10 * xcb.c: Helper functions for easier usage of XCB
16 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
17 unsigned int xcb_numlock_mask;
20 * Loads a font for usage, getting its height. This function is used very often, so it
24 i3Font *load_font(xcb_connection_t *conn, const char *pattern) {
25 /* Check if we got the font cached */
27 TAILQ_FOREACH(font, &cached_fonts, fonts)
28 if (strcmp(font->pattern, pattern) == 0)
31 i3Font *new = smalloc(sizeof(i3Font));
32 xcb_void_cookie_t font_cookie;
33 xcb_list_fonts_with_info_cookie_t info_cookie;
35 /* Send all our requests first */
36 new->id = xcb_generate_id(conn);
37 font_cookie = xcb_open_font_checked(conn, new->id, strlen(pattern), pattern);
38 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
40 check_error(conn, font_cookie, "Could not open font");
42 /* Get information (height/name) for this font */
43 xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
44 exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
46 if (asprintf(&(new->name), "%.*s", xcb_list_fonts_with_info_name_length(reply),
47 xcb_list_fonts_with_info_name(reply)) == -1)
48 die("asprintf() failed\n");
49 new->pattern = sstrdup(pattern);
50 new->height = reply->font_ascent + reply->font_descent;
52 /* Insert into cache */
53 TAILQ_INSERT_TAIL(&cached_fonts, new, fonts);
59 * Returns the colorpixel to use for the given hex color (think of HTML).
61 * The hex_color has to start with #, for example #FF00FF.
63 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
64 * This has to be done by the caller.
67 uint32_t get_colorpixel(char *hex) {
68 char strgroups[3][3] = {{hex[1], hex[2], '\0'},
69 {hex[3], hex[4], '\0'},
70 {hex[5], hex[6], '\0'}};
71 uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
72 (strtol(strgroups[1], NULL, 16)),
73 (strtol(strgroups[2], NULL, 16))};
75 return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
79 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
83 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class,
84 enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
85 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
86 xcb_window_t result = xcb_generate_id(conn);
87 xcb_cursor_t cursor_id = xcb_generate_id(conn);
89 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
90 uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
92 xcb_create_window(conn,
94 result, /* the window id */
95 root, /* parent == root */
96 dims.x, dims.y, dims.width, dims.height, /* dimensions */
97 0, /* border = 0, we draw our own */
99 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
104 if (xcursor_supported) {
105 mask = XCB_CW_CURSOR;
106 values[0] = xcursor_get_cursor(cursor);
107 xcb_change_window_attributes(conn, result, mask, values);
109 i3Font *cursor_font = load_font(conn, "cursor");
110 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
111 xcb_create_glyph_cursor(conn, cursor_id, cursor_font->id, cursor_font->id,
112 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
113 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
114 xcb_free_cursor(conn, cursor_id);
117 /* Map the window (= make it visible) */
119 xcb_map_window(conn, result);
125 * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
128 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
129 xcb_change_gc(conn, gc, mask, &value);
133 * Draws a line from x,y to to_x,to_y using the given color
136 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
137 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
138 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
139 xcb_point_t points[] = {{x, y}, {to_x, to_y}};
140 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
144 * Draws a rectangle from x,y with width,height using the given color
147 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
148 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
149 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
150 xcb_rectangle_t rect = {x, y, width, height};
151 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
155 * Generates a configure_notify event and sends it to the given window
156 * Applications need this to think they’ve configured themselves correctly.
157 * The truth is, however, that we will manage them.
160 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
161 xcb_configure_notify_event_t generated_event;
163 generated_event.event = window;
164 generated_event.window = window;
165 generated_event.response_type = XCB_CONFIGURE_NOTIFY;
167 generated_event.x = r.x;
168 generated_event.y = r.y;
169 generated_event.width = r.width;
170 generated_event.height = r.height;
172 generated_event.border_width = 0;
173 generated_event.above_sibling = XCB_NONE;
174 generated_event.override_redirect = false;
176 xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)&generated_event);
181 * Generates a configure_notify_event with absolute coordinates (relative to the X root
182 * window, not to the client’s frame) for the given client.
185 void fake_absolute_configure_notify(Con *con) {
187 if (con->window == NULL)
190 absolute.x = con->rect.x + con->window_rect.x;
191 absolute.y = con->rect.y + con->window_rect.y;
192 absolute.width = con->window_rect.width;
193 absolute.height = con->window_rect.height;
195 fake_configure_notify(conn, absolute, con->window->id);
199 * Finds out which modifier mask is the one for numlock, as the user may change this.
202 void xcb_get_numlock_mask(xcb_connection_t *conn) {
203 xcb_key_symbols_t *keysyms;
204 xcb_get_modifier_mapping_cookie_t cookie;
205 xcb_get_modifier_mapping_reply_t *reply;
206 xcb_keycode_t *modmap;
208 const int masks[8] = { XCB_MOD_MASK_SHIFT,
210 XCB_MOD_MASK_CONTROL,
217 /* Request the modifier map */
218 cookie = xcb_get_modifier_mapping_unchecked(conn);
220 /* Get the keysymbols */
221 keysyms = xcb_key_symbols_alloc(conn);
223 if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
224 xcb_key_symbols_free(keysyms);
228 modmap = xcb_get_modifier_mapping_keycodes(reply);
230 /* Get the keycode for numlock */
231 #ifdef OLD_XCB_KEYSYMS_API
232 xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
234 /* For now, we only use the first keysymbol. */
235 xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
236 if (numlock_syms == NULL)
238 xcb_keycode_t numlock = *numlock_syms;
242 /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
243 for (mask = 0; mask < 8; mask++)
244 for (i = 0; i < reply->keycodes_per_modifier; i++)
245 if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
246 xcb_numlock_mask = masks[mask];
248 xcb_key_symbols_free(keysyms);
253 * Raises the given window (typically client->frame) above all other windows
256 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
257 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
258 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
263 * Prepares the given Cached_Pixmap for usage (checks whether the size of the
264 * object this pixmap is related to (e.g. a window) has changed and re-creates
268 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap) {
269 DLOG("preparing pixmap\n");
271 /* If the Rect did not change, the pixmap does not need to be recreated */
272 if (memcmp(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect)) == 0)
275 memcpy(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect));
277 if (pixmap->id == 0 || pixmap->gc == 0) {
278 DLOG("Creating new pixmap...\n");
279 pixmap->id = xcb_generate_id(conn);
280 pixmap->gc = xcb_generate_id(conn);
282 DLOG("Re-creating this pixmap...\n");
283 xcb_free_gc(conn, pixmap->gc);
284 xcb_free_pixmap(conn, pixmap->id);
287 xcb_create_pixmap(conn, root_depth, pixmap->id,
288 pixmap->referred_drawable, pixmap->rect.width, pixmap->rect.height);
290 xcb_create_gc(conn, pixmap->gc, pixmap->id, 0, 0);
294 * Query the width of the given text (16-bit characters, UCS) with given real
295 * length (amount of glyphs) using the given font.
298 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text, int length) {
299 i3Font *font = load_font(conn, font_pattern);
301 xcb_query_text_extents_cookie_t cookie;
302 xcb_query_text_extents_reply_t *reply;
303 xcb_generic_error_t *error;
306 cookie = xcb_query_text_extents(conn, font->id, length, (xcb_char2b_t*)text);
307 if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
308 ELOG("Could not get text extents (X error code %d)\n",
310 /* We return the rather safe guess of 7 pixels, because a
311 * rendering error is better than a crash. Plus, the user will
312 * see the error in his log. */
316 width = reply->overall_width;
322 * Configures the given window to have the size/position specified by given rect
325 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
326 xcb_void_cookie_t cookie;
327 cookie = xcb_configure_window(conn, window,
328 XCB_CONFIG_WINDOW_X |
329 XCB_CONFIG_WINDOW_Y |
330 XCB_CONFIG_WINDOW_WIDTH |
331 XCB_CONFIG_WINDOW_HEIGHT,
333 /* ignore events which are generated because we configured a window */
334 add_ignore_event(cookie.sequence);
338 * Returns true if the given reply contains the given atom.
341 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
342 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
346 if ((atoms = xcb_get_property_value(prop)) == NULL)
349 for (int i = 0; i < xcb_get_property_value_length(prop); i++)
350 if (atoms[i] == atom)