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_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 */
43 if (xcursor_supported) {
45 values[0] = xcursor_get_cursor(cursor);
46 xcb_change_window_attributes(conn, result, mask, values);
48 xcb_cursor_t cursor_id = xcb_generate_id(conn);
49 i3Font cursor_font = load_font("cursor", false);
50 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
51 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
52 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
54 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
55 xcb_free_cursor(conn, cursor_id);
58 /* Map the window (= make it visible) */
60 xcb_map_window(conn, result);
66 * Generates a configure_notify_event with absolute coordinates (relative to the X root
67 * window, not to the client’s frame) for the given client.
70 void fake_absolute_configure_notify(Con *con) {
71 xcb_rectangle_t absolute;
72 if (con->window == NULL)
75 absolute.x = con->rect.x + con->window_rect.x;
76 absolute.y = con->rect.y + con->window_rect.y;
77 absolute.width = con->window_rect.width;
78 absolute.height = con->window_rect.height;
80 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
82 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
86 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
89 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
90 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
91 * In order to properly initialize these bytes, we allocate 32 bytes even
92 * though we only need less for an xcb_configure_notify_event_t */
93 void *event = scalloc(32, 1);
94 xcb_client_message_event_t *ev = event;
96 ev->response_type = XCB_CLIENT_MESSAGE;
98 ev->type = A_WM_PROTOCOLS;
100 ev->data.data32[0] = A_WM_TAKE_FOCUS;
101 ev->data.data32[1] = timestamp;
103 DLOG("Sending WM_TAKE_FOCUS to the client\n");
104 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
109 * Configures the given window to have the size/position specified by given rect
112 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
113 xcb_void_cookie_t cookie;
114 cookie = xcb_configure_window(conn, window,
115 XCB_CONFIG_WINDOW_X |
116 XCB_CONFIG_WINDOW_Y |
117 XCB_CONFIG_WINDOW_WIDTH |
118 XCB_CONFIG_WINDOW_HEIGHT,
120 /* ignore events which are generated because we configured a window */
121 add_ignore_event(cookie.sequence, -1);
125 * Returns the first supported _NET_WM_WINDOW_TYPE atom.
128 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
129 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
133 if ((atoms = xcb_get_property_value(reply)) == NULL)
136 for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
137 if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
138 atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
139 atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
140 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
141 atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
142 atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
143 atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
144 atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
145 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
146 atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
155 * Returns true if the given reply contains the given atom.
158 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
159 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
163 if ((atoms = xcb_get_property_value(prop)) == NULL)
166 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
167 if (atoms[i] == atom)
174 * Set the cursor of the root window to the given cursor id.
175 * This function should only be used if xcursor_supported == false.
176 * Otherwise, use xcursor_set_root_cursor().
179 void xcb_set_root_cursor(int cursor) {
180 xcb_cursor_t cursor_id = xcb_generate_id(conn);
181 i3Font cursor_font = load_font("cursor", false);
182 int xcb_cursor = xcursor_get_xcb_cursor(cursor);
183 xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
184 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
185 65535, 65535, 65535);
186 xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
187 xcb_free_cursor(conn, cursor_id);
192 * Get depth of visual specified by visualid
195 uint16_t get_visual_depth(xcb_visualid_t visual_id) {
196 xcb_depth_iterator_t depth_iter;
198 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
199 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
200 xcb_visualtype_iterator_t visual_iter;
202 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
203 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
204 if (visual_id == visual_iter.data->visual_id) {
205 return depth_iter.data->depth;
213 * Get visual type specified by visualid
216 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
217 xcb_depth_iterator_t depth_iter;
219 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
220 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
221 xcb_visualtype_iterator_t visual_iter;
223 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
224 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
225 if (visual_id == visual_iter.data->visual_id) {
226 return visual_iter.data;
234 * Get visualid with specified depth
237 xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
238 xcb_depth_iterator_t depth_iter;
240 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
241 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
242 if (depth_iter.data->depth != depth)
245 xcb_visualtype_iterator_t visual_iter;
247 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
248 if (!visual_iter.rem)
250 return visual_iter.data->visual_id;
256 * Add an atom to a list of atoms the given property defines.
257 * This is useful, for example, for manipulating _NET_WM_STATE.
260 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
261 xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
265 * Remove an atom from a list of atoms the given property defines without
266 * removing any other potentially set atoms. This is useful, for example, for
267 * manipulating _NET_WM_STATE.
270 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
271 xcb_grab_server(conn);
273 xcb_get_property_reply_t *reply =
274 xcb_get_property_reply(conn,
275 xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
276 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
278 xcb_atom_t *atoms = xcb_get_property_value(reply);
285 const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
286 xcb_atom_t values[current_size];
287 for (int i = 0; i < current_size; i++) {
288 if (atoms[i] != atom)
289 values[num++] = atoms[i];
292 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
297 xcb_ungrab_server(conn);
301 * Grab the specified buttons on a window when managing it.
304 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
306 while (buttons[i] > 0) {
307 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
308 XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);