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 * xcb.c: Helper functions for easier usage of XCB
12 unsigned int xcb_numlock_mask;
15 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
19 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class,
20 enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
21 xcb_window_t result = xcb_generate_id(conn);
23 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
24 uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
26 xcb_create_window(conn,
28 result, /* the window id */
29 root, /* parent == root */
30 dims.x, dims.y, dims.width, dims.height, /* dimensions */
31 0, /* border = 0, we draw our own */
33 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
38 if (xcursor_supported) {
40 values[0] = xcursor_get_cursor(cursor);
41 xcb_change_window_attributes(conn, result, mask, values);
43 xcb_cursor_t cursor_id = xcb_generate_id(conn);
44 i3Font cursor_font = load_font("cursor", false);
45 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
46 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
47 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
48 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
49 xcb_free_cursor(conn, cursor_id);
52 /* Map the window (= make it visible) */
54 xcb_map_window(conn, result);
60 * Draws a line from x,y to to_x,to_y using the given color
63 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
64 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
65 xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){ colorpixel });
66 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2,
67 (xcb_point_t[]) { {x, y}, {to_x, to_y} });
71 * Draws a rectangle from x,y with width,height using the given color
74 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
75 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
76 xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){ colorpixel });
77 xcb_rectangle_t rect = {x, y, width, height};
78 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
82 * Generates a configure_notify_event with absolute coordinates (relative to the X root
83 * window, not to the client’s frame) for the given client.
86 void fake_absolute_configure_notify(Con *con) {
87 xcb_rectangle_t absolute;
88 if (con->window == NULL)
91 absolute.x = con->rect.x + con->window_rect.x;
92 absolute.y = con->rect.y + con->window_rect.y;
93 absolute.width = con->window_rect.width;
94 absolute.height = con->window_rect.height;
96 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
98 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
102 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
105 void send_take_focus(xcb_window_t window) {
106 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
107 * In order to properly initialize these bytes, we allocate 32 bytes even
108 * though we only need less for an xcb_configure_notify_event_t */
109 void *event = scalloc(32);
110 xcb_client_message_event_t *ev = event;
112 ev->response_type = XCB_CLIENT_MESSAGE;
114 ev->type = A_WM_PROTOCOLS;
116 ev->data.data32[0] = A_WM_TAKE_FOCUS;
117 ev->data.data32[1] = XCB_CURRENT_TIME;
119 DLOG("Sending WM_TAKE_FOCUS to the client\n");
120 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
125 * Raises the given window (typically client->frame) above all other windows
128 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
129 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
130 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
134 * Query the width of the given text (16-bit characters, UCS) with given real
135 * length (amount of glyphs) using the given font.
138 int predict_text_width(const xcb_char2b_t *text, int length) {
139 xcb_query_text_extents_cookie_t cookie;
140 xcb_query_text_extents_reply_t *reply;
141 xcb_generic_error_t *error;
144 cookie = xcb_query_text_extents(conn, config.font.id, length, text);
145 if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
146 ELOG("Could not get text extents (X error code %d)\n",
148 /* We return the rather safe guess of 7 pixels, because a
149 * rendering error is better than a crash. Plus, the user will
150 * see the error in his log. */
154 width = reply->overall_width;
160 * Configures the given window to have the size/position specified by given rect
163 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
164 xcb_void_cookie_t cookie;
165 cookie = xcb_configure_window(conn, window,
166 XCB_CONFIG_WINDOW_X |
167 XCB_CONFIG_WINDOW_Y |
168 XCB_CONFIG_WINDOW_WIDTH |
169 XCB_CONFIG_WINDOW_HEIGHT,
171 /* ignore events which are generated because we configured a window */
172 add_ignore_event(cookie.sequence, -1);
176 * Returns true if the given reply contains the given atom.
179 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
180 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
184 if ((atoms = xcb_get_property_value(prop)) == NULL)
187 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
188 if (atoms[i] == atom)
196 * Moves the mouse pointer into the middle of rect.
199 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
200 int mid_x = rect->x + (rect->width / 2);
201 int mid_y = rect->y + (rect->height / 2);
203 LOG("warp pointer to: %d %d\n", mid_x, mid_y);
204 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
208 * Set the cursor of the root window to the given cursor id.
209 * This function should only be used if xcursor_supported == false.
210 * Otherwise, use xcursor_set_root_cursor().
213 void xcb_set_root_cursor(int cursor) {
214 xcb_cursor_t cursor_id = xcb_generate_id(conn);
215 i3Font cursor_font = load_font("cursor", false);
216 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
217 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
218 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
219 xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
220 xcb_free_cursor(conn, cursor_id);