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
19 #include <xcb/xcb_keysyms.h>
26 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
27 unsigned int xcb_numlock_mask;
30 * Loads a font for usage, getting its height. This function is used very often, so it
34 i3Font *load_font(xcb_connection_t *conn, const char *pattern) {
35 /* Check if we got the font cached */
37 TAILQ_FOREACH(font, &cached_fonts, fonts)
38 if (strcmp(font->pattern, pattern) == 0)
41 i3Font *new = smalloc(sizeof(i3Font));
42 xcb_void_cookie_t font_cookie;
43 xcb_list_fonts_with_info_cookie_t info_cookie;
45 /* Send all our requests first */
46 new->id = xcb_generate_id(conn);
47 font_cookie = xcb_open_font_checked(conn, new->id, strlen(pattern), pattern);
48 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
50 check_error(conn, font_cookie, "Could not open font");
52 /* Get information (height/name) for this font */
53 xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
54 exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
56 if (asprintf(&(new->name), "%.*s", xcb_list_fonts_with_info_name_length(reply),
57 xcb_list_fonts_with_info_name(reply)) == -1)
58 die("asprintf() failed\n");
59 new->pattern = sstrdup(pattern);
60 new->height = reply->font_ascent + reply->font_descent;
62 /* Insert into cache */
63 TAILQ_INSERT_TAIL(&cached_fonts, new, fonts);
69 * Returns the colorpixel to use for the given hex color (think of HTML).
71 * The hex_color has to start with #, for example #FF00FF.
73 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
74 * This has to be done by the caller.
77 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex) {
78 char strgroups[3][3] = {{hex[1], hex[2], '\0'},
79 {hex[3], hex[4], '\0'},
80 {hex[5], hex[6], '\0'}};
81 uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
82 (strtol(strgroups[1], NULL, 16)),
83 (strtol(strgroups[2], NULL, 16))};
85 return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
89 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
93 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class, int cursor,
94 bool map, uint32_t mask, uint32_t *values) {
95 xcb_window_t root = xcb_setup_roots_iterator(xcb_get_setup(conn)).data->root;
96 xcb_window_t result = xcb_generate_id(conn);
97 xcb_cursor_t cursor_id = xcb_generate_id(conn);
99 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
100 uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
102 xcb_create_window(conn,
104 result, /* the window id */
105 root, /* parent == root */
106 dims.x, dims.y, dims.width, dims.height, /* dimensions */
107 0, /* border = 0, we draw our own */
109 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
114 i3Font *cursor_font = load_font(conn, "cursor");
115 xcb_create_glyph_cursor(conn, cursor_id, cursor_font->id, cursor_font->id,
116 (cursor == -1 ? XCB_CURSOR_LEFT_PTR : cursor),
117 (cursor == -1 ? XCB_CURSOR_LEFT_PTR : cursor) + 1,
118 0, 0, 0, 65535, 65535, 65535);
119 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
120 xcb_free_cursor(conn, cursor_id);
122 /* Map the window (= make it visible) */
124 xcb_map_window(conn, result);
130 * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
133 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
134 xcb_change_gc(conn, gc, mask, &value);
138 * Draws a line from x,y to to_x,to_y using the given color
141 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
142 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
143 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
144 xcb_point_t points[] = {{x, y}, {to_x, to_y}};
145 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
149 * Draws a rectangle from x,y with width,height using the given color
152 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
153 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
154 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
155 xcb_rectangle_t rect = {x, y, width, height};
156 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
160 * Generates a configure_notify event and sends it to the given window
161 * Applications need this to think they’ve configured themselves correctly.
162 * The truth is, however, that we will manage them.
165 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window) {
166 xcb_configure_notify_event_t generated_event;
168 generated_event.event = window;
169 generated_event.window = window;
170 generated_event.response_type = XCB_CONFIGURE_NOTIFY;
172 generated_event.x = r.x;
173 generated_event.y = r.y;
174 generated_event.width = r.width;
175 generated_event.height = r.height;
177 generated_event.border_width = 0;
178 generated_event.above_sibling = XCB_NONE;
179 generated_event.override_redirect = false;
181 xcb_send_event(conn, false, window, XCB_EVENT_MASK_STRUCTURE_NOTIFY, (char*)&generated_event);
186 * Generates a configure_notify_event with absolute coordinates (relative to the X root
187 * window, not to the client’s frame) for the given client.
190 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client) {
193 absolute.x = client->rect.x + client->child_rect.x;
194 absolute.y = client->rect.y + client->child_rect.y;
195 absolute.width = client->child_rect.width;
196 absolute.height = client->child_rect.height;
198 fake_configure_notify(conn, absolute, client->child);
202 * Finds out which modifier mask is the one for numlock, as the user may change this.
205 void xcb_get_numlock_mask(xcb_connection_t *conn) {
206 xcb_key_symbols_t *keysyms;
207 xcb_get_modifier_mapping_cookie_t cookie;
208 xcb_get_modifier_mapping_reply_t *reply;
209 xcb_keycode_t *modmap;
211 const int masks[8] = { XCB_MOD_MASK_SHIFT,
213 XCB_MOD_MASK_CONTROL,
220 /* Request the modifier map */
221 cookie = xcb_get_modifier_mapping_unchecked(conn);
223 /* Get the keysymbols */
224 keysyms = xcb_key_symbols_alloc(conn);
226 if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
227 xcb_key_symbols_free(keysyms);
231 modmap = xcb_get_modifier_mapping_keycodes(reply);
233 /* Get the keycode for numlock */
234 #ifdef OLD_XCB_KEYSYMS_API
235 xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
237 /* For now, we only use the first keysymbol. */
238 xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
239 if (numlock_syms == NULL)
241 xcb_keycode_t numlock = *numlock_syms;
245 /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
246 for (mask = 0; mask < 8; mask++)
247 for (i = 0; i < reply->keycodes_per_modifier; i++)
248 if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
249 xcb_numlock_mask = masks[mask];
251 xcb_key_symbols_free(keysyms);
256 * Raises the given window (typically client->frame) above all other windows
259 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
260 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
261 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
266 * Prepares the given Cached_Pixmap for usage (checks whether the size of the
267 * object this pixmap is related to (e.g. a window) has changed and re-creates
271 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap) {
272 DLOG("preparing pixmap\n");
274 /* If the Rect did not change, the pixmap does not need to be recreated */
275 if (memcmp(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect)) == 0)
278 memcpy(&(pixmap->rect), pixmap->referred_rect, sizeof(Rect));
280 if (pixmap->id == 0 || pixmap->gc == 0) {
281 DLOG("Creating new pixmap...\n");
282 pixmap->id = xcb_generate_id(conn);
283 pixmap->gc = xcb_generate_id(conn);
285 DLOG("Re-creating this pixmap...\n");
286 xcb_free_gc(conn, pixmap->gc);
287 xcb_free_pixmap(conn, pixmap->id);
290 xcb_create_pixmap(conn, root_depth, pixmap->id,
291 pixmap->referred_drawable, pixmap->rect.width, pixmap->rect.height);
293 xcb_create_gc(conn, pixmap->gc, pixmap->id, 0, 0);
297 * Query the width of the given text (16-bit characters, UCS) with given real
298 * length (amount of glyphs) using the given font.
301 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text, int length) {
302 i3Font *font = load_font(conn, font_pattern);
304 xcb_query_text_extents_cookie_t cookie;
305 xcb_query_text_extents_reply_t *reply;
306 xcb_generic_error_t *error;
309 cookie = xcb_query_text_extents(conn, font->id, length, (xcb_char2b_t*)text);
310 if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
311 ELOG("Could not get text extents (X error code %d)\n",
313 /* We return the rather safe guess of 7 pixels, because a
314 * rendering error is better than a crash. Plus, the user will
315 * see the error in his log. */
319 width = reply->overall_width;
325 * Configures the given window to have the size/position specified by given rect
328 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
329 xcb_configure_window(conn, window,
330 XCB_CONFIG_WINDOW_X |
331 XCB_CONFIG_WINDOW_Y |
332 XCB_CONFIG_WINDOW_WIDTH |
333 XCB_CONFIG_WINDOW_HEIGHT,