2 * vim:ts=4:sw=4:expandtab
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, also getting its height. If fallback is true,
21 * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
25 i3Font load_font(const char *pattern, bool fallback) {
27 xcb_void_cookie_t font_cookie;
28 xcb_list_fonts_with_info_cookie_t info_cookie;
30 /* Send all our requests first */
31 new.id = xcb_generate_id(conn);
32 font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
33 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
35 /* Check for errors. If errors, fall back to default font. */
36 xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
38 /* If we fail to open font, fall back to 'fixed'. If opening 'fixed' fails fall back to '-misc-*' */
40 ELOG("Could not open font %s (X error %d). Reverting to backup font.\n", pattern, error->error_code);
42 font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
43 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
45 /* Check if we managed to open 'fixed' */
46 xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
48 /* Fall back to '-misc-*' if opening 'fixed' fails. */
50 ELOG("Could not open fallback font '%s', trying with '-misc-*'\n",pattern);
52 font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
53 info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
55 check_error(conn, font_cookie, "Could open neither requested font nor fallback (fixed or -misc-*");
59 /* Get information (height/name) for this font */
60 xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
61 exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
63 new.height = reply->font_ascent + reply->font_descent;
71 * Returns the colorpixel to use for the given hex color (think of HTML).
73 * The hex_color has to start with #, for example #FF00FF.
75 * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
76 * This has to be done by the caller.
79 uint32_t get_colorpixel(char *hex) {
80 char strgroups[3][3] = {{hex[1], hex[2], '\0'},
81 {hex[3], hex[4], '\0'},
82 {hex[5], hex[6], '\0'}};
83 uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
84 (strtol(strgroups[1], NULL, 16)),
85 (strtol(strgroups[2], NULL, 16))};
87 return (rgb16[0] << 16) + (rgb16[1] << 8) + rgb16[2];
91 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
95 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class,
96 enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
97 xcb_window_t result = 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 if (xcursor_supported) {
115 mask = XCB_CW_CURSOR;
116 values[0] = xcursor_get_cursor(cursor);
117 xcb_change_window_attributes(conn, result, mask, values);
119 xcb_cursor_t cursor_id = xcb_generate_id(conn);
120 i3Font cursor_font = load_font("cursor", false);
121 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
122 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
123 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
124 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
125 xcb_free_cursor(conn, cursor_id);
128 /* Map the window (= make it visible) */
130 xcb_map_window(conn, result);
136 * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
139 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value) {
140 xcb_change_gc(conn, gc, mask, &value);
144 * Draws a line from x,y to to_x,to_y using the given color
147 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
148 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
149 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
150 xcb_point_t points[] = {{x, y}, {to_x, to_y}};
151 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2, points);
155 * Draws a rectangle from x,y with width,height using the given color
158 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
159 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
160 xcb_change_gc_single(conn, gc, XCB_GC_FOREGROUND, colorpixel);
161 xcb_rectangle_t rect = {x, y, width, height};
162 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
166 * Generates a configure_notify_event with absolute coordinates (relative to the X root
167 * window, not to the client’s frame) for the given client.
170 void fake_absolute_configure_notify(Con *con) {
171 xcb_rectangle_t absolute;
172 if (con->window == NULL)
175 absolute.x = con->rect.x + con->window_rect.x;
176 absolute.y = con->rect.y + con->window_rect.y;
177 absolute.width = con->window_rect.width;
178 absolute.height = con->window_rect.height;
180 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
182 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
186 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
189 void send_take_focus(xcb_window_t window) {
190 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
191 * In order to properly initialize these bytes, we allocate 32 bytes even
192 * though we only need less for an xcb_configure_notify_event_t */
193 void *event = scalloc(32);
194 xcb_client_message_event_t *ev = event;
196 ev->response_type = XCB_CLIENT_MESSAGE;
198 ev->type = A_WM_PROTOCOLS;
200 ev->data.data32[0] = A_WM_TAKE_FOCUS;
201 ev->data.data32[1] = XCB_CURRENT_TIME;
203 DLOG("Sending WM_TAKE_FOCUS to the client\n");
204 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
209 * Finds out which modifier mask is the one for numlock, as the user may change this.
212 void xcb_get_numlock_mask(xcb_connection_t *conn) {
213 xcb_key_symbols_t *keysyms;
214 xcb_get_modifier_mapping_cookie_t cookie;
215 xcb_get_modifier_mapping_reply_t *reply;
216 xcb_keycode_t *modmap;
218 const int masks[8] = { XCB_MOD_MASK_SHIFT,
220 XCB_MOD_MASK_CONTROL,
227 /* Request the modifier map */
228 cookie = xcb_get_modifier_mapping(conn);
230 /* Get the keysymbols */
231 keysyms = xcb_key_symbols_alloc(conn);
233 if ((reply = xcb_get_modifier_mapping_reply(conn, cookie, NULL)) == NULL) {
234 xcb_key_symbols_free(keysyms);
238 modmap = xcb_get_modifier_mapping_keycodes(reply);
240 /* Get the keycode for numlock */
241 #ifdef OLD_XCB_KEYSYMS_API
242 xcb_keycode_t numlock = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
244 /* For now, we only use the first keysymbol. */
245 xcb_keycode_t *numlock_syms = xcb_key_symbols_get_keycode(keysyms, XCB_NUM_LOCK);
246 if (numlock_syms == NULL)
248 xcb_keycode_t numlock = *numlock_syms;
252 /* Check all modifiers (Mod1-Mod5, Shift, Control, Lock) */
253 for (mask = 0; mask < 8; mask++)
254 for (i = 0; i < reply->keycodes_per_modifier; i++)
255 if (modmap[(mask * reply->keycodes_per_modifier) + i] == numlock)
256 xcb_numlock_mask = masks[mask];
258 xcb_key_symbols_free(keysyms);
263 * Raises the given window (typically client->frame) above all other windows
266 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
267 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
268 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
272 * Query the width of the given text (16-bit characters, UCS) with given real
273 * length (amount of glyphs) using the given font.
276 int predict_text_width(char *text, int length) {
277 xcb_query_text_extents_cookie_t cookie;
278 xcb_query_text_extents_reply_t *reply;
279 xcb_generic_error_t *error;
282 cookie = xcb_query_text_extents(conn, config.font.id, length, (xcb_char2b_t*)text);
283 if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
284 ELOG("Could not get text extents (X error code %d)\n",
286 /* We return the rather safe guess of 7 pixels, because a
287 * rendering error is better than a crash. Plus, the user will
288 * see the error in his log. */
292 width = reply->overall_width;
298 * Configures the given window to have the size/position specified by given rect
301 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
302 xcb_void_cookie_t cookie;
303 cookie = xcb_configure_window(conn, window,
304 XCB_CONFIG_WINDOW_X |
305 XCB_CONFIG_WINDOW_Y |
306 XCB_CONFIG_WINDOW_WIDTH |
307 XCB_CONFIG_WINDOW_HEIGHT,
309 /* ignore events which are generated because we configured a window */
310 add_ignore_event(cookie.sequence, -1);
314 * Returns true if the given reply contains the given atom.
317 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
318 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
322 if ((atoms = xcb_get_property_value(prop)) == NULL)
325 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
326 if (atoms[i] == atom)
334 * Moves the mouse pointer into the middle of rect.
337 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
338 int mid_x = rect->x + (rect->width / 2);
339 int mid_y = rect->y + (rect->height / 2);
341 LOG("warp pointer to: %d %d\n", mid_x, mid_y);
342 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
346 * Set the cursor of the root window to the given cursor id.
347 * This function should only be used if xcursor_supported == false.
348 * Otherwise, use xcursor_set_root_cursor().
351 void xcb_set_root_cursor(int cursor) {
352 xcb_cursor_t cursor_id = xcb_generate_id(conn);
353 i3Font cursor_font = load_font("cursor", false);
354 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
355 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
356 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
357 xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
358 xcb_free_cursor(conn, cursor_id);