2 #define I3__FILE__ "xcb.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
9 * xcb.c: Helper functions for easier usage of XCB
14 unsigned int xcb_numlock_mask;
17 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
21 xcb_window_t create_window(xcb_connection_t *conn, Rect dims,
22 uint16_t depth, xcb_visualid_t visual, uint16_t window_class,
23 enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
24 xcb_window_t result = xcb_generate_id(conn);
26 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, we copy depth and
27 * visual id from the parent window. */
28 if (window_class == XCB_WINDOW_CLASS_INPUT_ONLY) {
29 depth = XCB_COPY_FROM_PARENT;
30 visual = XCB_COPY_FROM_PARENT;
33 xcb_create_window(conn,
35 result, /* the window id */
36 root, /* parent == root */
37 dims.x, dims.y, dims.width, dims.height, /* dimensions */
38 0, /* border = 0, we draw our own */
45 if (xcursor_supported) {
47 values[0] = xcursor_get_cursor(cursor);
48 xcb_change_window_attributes(conn, result, mask, values);
50 xcb_cursor_t cursor_id = xcb_generate_id(conn);
51 i3Font cursor_font = load_font("cursor", false);
52 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
53 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
54 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
56 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
57 xcb_free_cursor(conn, cursor_id);
60 /* Map the window (= make it visible) */
62 xcb_map_window(conn, result);
68 * Draws a line from x,y to to_x,to_y using the given color
71 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
72 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
73 xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){colorpixel});
74 xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2,
75 (xcb_point_t[]){{x, y}, {to_x, to_y}});
79 * Draws a rectangle from x,y with width,height using the given color
82 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
83 uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
84 xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){colorpixel});
85 xcb_rectangle_t rect = {x, y, width, height};
86 xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
90 * Generates a configure_notify_event with absolute coordinates (relative to the X root
91 * window, not to the client’s frame) for the given client.
94 void fake_absolute_configure_notify(Con *con) {
95 xcb_rectangle_t absolute;
96 if (con->window == NULL)
99 absolute.x = con->rect.x + con->window_rect.x;
100 absolute.y = con->rect.y + con->window_rect.y;
101 absolute.width = con->window_rect.width;
102 absolute.height = con->window_rect.height;
104 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
106 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
110 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
113 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
114 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
115 * In order to properly initialize these bytes, we allocate 32 bytes even
116 * though we only need less for an xcb_configure_notify_event_t */
117 void *event = scalloc(32, 1);
118 xcb_client_message_event_t *ev = event;
120 ev->response_type = XCB_CLIENT_MESSAGE;
122 ev->type = A_WM_PROTOCOLS;
124 ev->data.data32[0] = A_WM_TAKE_FOCUS;
125 ev->data.data32[1] = timestamp;
127 DLOG("Sending WM_TAKE_FOCUS to the client\n");
128 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
133 * Raises the given window (typically client->frame) above all other windows
136 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
137 uint32_t values[] = {XCB_STACK_MODE_ABOVE};
138 xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
142 * Configures the given window to have the size/position specified by given rect
145 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
146 xcb_void_cookie_t cookie;
147 cookie = xcb_configure_window(conn, window,
148 XCB_CONFIG_WINDOW_X |
149 XCB_CONFIG_WINDOW_Y |
150 XCB_CONFIG_WINDOW_WIDTH |
151 XCB_CONFIG_WINDOW_HEIGHT,
153 /* ignore events which are generated because we configured a window */
154 add_ignore_event(cookie.sequence, -1);
158 * Returns the first supported _NET_WM_WINDOW_TYPE atom.
161 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
162 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
166 if ((atoms = xcb_get_property_value(reply)) == NULL)
169 for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
170 if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
171 atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
172 atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
173 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
174 atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
175 atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
176 atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
177 atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
178 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
179 atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
188 * Returns true if the given reply contains the given atom.
191 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
192 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
196 if ((atoms = xcb_get_property_value(prop)) == NULL)
199 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
200 if (atoms[i] == atom)
207 * Moves the mouse pointer into the middle of rect.
210 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
211 int mid_x = rect->x + (rect->width / 2);
212 int mid_y = rect->y + (rect->height / 2);
214 LOG("warp pointer to: %d %d\n", mid_x, mid_y);
215 xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
219 * Set the cursor of the root window to the given cursor id.
220 * This function should only be used if xcursor_supported == false.
221 * Otherwise, use xcursor_set_root_cursor().
224 void xcb_set_root_cursor(int cursor) {
225 xcb_cursor_t cursor_id = xcb_generate_id(conn);
226 i3Font cursor_font = load_font("cursor", false);
227 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
228 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
229 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
230 65535, 65535, 65535);
231 xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
232 xcb_free_cursor(conn, cursor_id);
237 * Get depth of visual specified by visualid
240 uint16_t get_visual_depth(xcb_visualid_t visual_id) {
241 xcb_depth_iterator_t depth_iter;
243 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
244 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
245 xcb_visualtype_iterator_t visual_iter;
247 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
248 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
249 if (visual_id == visual_iter.data->visual_id) {
250 return depth_iter.data->depth;
258 * Get visual type specified by visualid
261 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
262 xcb_depth_iterator_t depth_iter;
264 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
265 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
266 xcb_visualtype_iterator_t visual_iter;
268 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
269 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
270 if (visual_id == visual_iter.data->visual_id) {
271 return visual_iter.data;
279 * Get visualid with specified depth
282 xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
283 xcb_depth_iterator_t depth_iter;
285 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
286 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
287 if (depth_iter.data->depth != depth)
290 xcb_visualtype_iterator_t visual_iter;
292 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
293 if (!visual_iter.rem)
295 return visual_iter.data->visual_id;
301 * Add an atom to a list of atoms the given property defines.
302 * This is useful, for example, for manipulating _NET_WM_STATE.
305 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
306 xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
310 * Remove an atom from a list of atoms the given property defines without
311 * removing any other potentially set atoms. This is useful, for example, for
312 * manipulating _NET_WM_STATE.
315 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
316 xcb_grab_server(conn);
318 xcb_get_property_reply_t *reply =
319 xcb_get_property_reply(conn,
320 xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
321 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
323 xcb_atom_t *atoms = xcb_get_property_value(reply);
330 const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
331 xcb_atom_t values[current_size];
332 for (int i = 0; i < current_size; i++) {
333 if (atoms[i] != atom)
334 values[num++] = atoms[i];
337 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
342 xcb_ungrab_server(conn);
346 * Grab the specified buttons on a window when managing it.
349 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
351 while (buttons[i] > 0) {
352 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
353 XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);