2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 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,
20 uint16_t depth, xcb_visualid_t visual, uint16_t window_class,
21 enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
22 xcb_window_t result = xcb_generate_id(conn);
24 /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, we copy depth and
25 * visual id from the parent window. */
26 if (window_class == XCB_WINDOW_CLASS_INPUT_ONLY) {
27 depth = XCB_COPY_FROM_PARENT;
28 visual = XCB_COPY_FROM_PARENT;
31 xcb_void_cookie_t gc_cookie = xcb_create_window(conn,
33 result, /* the window id */
34 root, /* parent == root */
35 dims.x, dims.y, dims.width, dims.height, /* dimensions */
36 0, /* border = 0, we draw our own */
42 xcb_generic_error_t *error = xcb_request_check(conn, gc_cookie);
44 ELOG("Could not create window. Error code: %d.\n", error->error_code);
48 if (xcursor_supported) {
50 values[0] = xcursor_get_cursor(cursor);
51 xcb_change_window_attributes(conn, result, mask, values);
53 xcb_cursor_t cursor_id = xcb_generate_id(conn);
54 i3Font cursor_font = load_font("cursor", false);
55 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
56 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
57 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
59 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
60 xcb_free_cursor(conn, cursor_id);
63 /* Map the window (= make it visible) */
65 xcb_map_window(conn, result);
71 * Generates a configure_notify_event with absolute coordinates (relative to the X root
72 * window, not to the client’s frame) for the given client.
75 void fake_absolute_configure_notify(Con *con) {
76 xcb_rectangle_t absolute;
77 if (con->window == NULL)
80 absolute.x = con->rect.x + con->window_rect.x;
81 absolute.y = con->rect.y + con->window_rect.y;
82 absolute.width = con->window_rect.width;
83 absolute.height = con->window_rect.height;
85 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
87 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
91 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
94 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
95 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
96 * In order to properly initialize these bytes, we allocate 32 bytes even
97 * though we only need less for an xcb_configure_notify_event_t */
98 void *event = scalloc(32, 1);
99 xcb_client_message_event_t *ev = event;
101 ev->response_type = XCB_CLIENT_MESSAGE;
103 ev->type = A_WM_PROTOCOLS;
105 ev->data.data32[0] = A_WM_TAKE_FOCUS;
106 ev->data.data32[1] = timestamp;
108 DLOG("Sending WM_TAKE_FOCUS to the client\n");
109 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
114 * Configures the given window to have the size/position specified by given rect
117 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
118 xcb_void_cookie_t cookie;
119 cookie = xcb_configure_window(conn, window,
120 XCB_CONFIG_WINDOW_X |
121 XCB_CONFIG_WINDOW_Y |
122 XCB_CONFIG_WINDOW_WIDTH |
123 XCB_CONFIG_WINDOW_HEIGHT,
125 /* ignore events which are generated because we configured a window */
126 add_ignore_event(cookie.sequence, -1);
130 * Returns the first supported _NET_WM_WINDOW_TYPE atom.
133 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
134 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
138 if ((atoms = xcb_get_property_value(reply)) == NULL)
141 for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
142 if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
143 atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
144 atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
145 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
146 atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
147 atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
148 atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
149 atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
150 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
151 atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
160 * Returns true if the given reply contains the given atom.
163 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
164 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
168 if ((atoms = xcb_get_property_value(prop)) == NULL)
171 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
172 if (atoms[i] == atom)
179 * Set the cursor of the root window to the given cursor id.
180 * This function should only be used if xcursor_supported == false.
181 * Otherwise, use xcursor_set_root_cursor().
184 void xcb_set_root_cursor(int cursor) {
185 xcb_cursor_t cursor_id = xcb_generate_id(conn);
186 i3Font cursor_font = load_font("cursor", false);
187 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
188 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
189 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
190 65535, 65535, 65535);
191 xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
192 xcb_free_cursor(conn, cursor_id);
197 * Get depth of visual specified by visualid
200 uint16_t get_visual_depth(xcb_visualid_t visual_id) {
201 xcb_depth_iterator_t depth_iter;
203 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
204 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
205 xcb_visualtype_iterator_t visual_iter;
207 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
208 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
209 if (visual_id == visual_iter.data->visual_id) {
210 return depth_iter.data->depth;
218 * Get visual type specified by visualid
221 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
222 xcb_depth_iterator_t depth_iter;
224 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
225 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
226 xcb_visualtype_iterator_t visual_iter;
228 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
229 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
230 if (visual_id == visual_iter.data->visual_id) {
231 return visual_iter.data;
239 * Get visualid with specified depth
242 xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
243 xcb_depth_iterator_t depth_iter;
245 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
246 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
247 if (depth_iter.data->depth != depth)
250 xcb_visualtype_iterator_t visual_iter;
252 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
253 if (!visual_iter.rem)
255 return visual_iter.data->visual_id;
261 * Add an atom to a list of atoms the given property defines.
262 * This is useful, for example, for manipulating _NET_WM_STATE.
265 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
266 xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
270 * Remove an atom from a list of atoms the given property defines without
271 * removing any other potentially set atoms. This is useful, for example, for
272 * manipulating _NET_WM_STATE.
275 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
276 xcb_grab_server(conn);
278 xcb_get_property_reply_t *reply =
279 xcb_get_property_reply(conn,
280 xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
281 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
283 xcb_atom_t *atoms = xcb_get_property_value(reply);
290 const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
291 xcb_atom_t values[current_size];
292 for (int i = 0; i < current_size; i++) {
293 if (atoms[i] != atom)
294 values[num++] = atoms[i];
297 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
302 xcb_ungrab_server(conn);
306 * Grab the specified buttons on a window when managing it.
309 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
311 while (buttons[i] > 0) {
312 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
313 XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);