i3
xcb.c
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6 *
7 * xcb.c: Helper functions for easier usage of XCB
8 *
9 */
10#include "all.h"
11
12unsigned int xcb_numlock_mask;
13
14/*
15 * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
16 * for errors.
17 *
18 */
19xcb_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);
23
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;
29 }
30
31 xcb_void_cookie_t gc_cookie = xcb_create_window(conn,
32 depth,
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 */
37 window_class,
38 visual,
39 mask,
40 values);
41
42 xcb_generic_error_t *error = xcb_request_check(conn, gc_cookie);
43 if (error != NULL) {
44 ELOG("Could not create window. Error code: %d.\n", error->error_code);
45 }
46
47 /* Set the cursor */
48 uint32_t cursor_values[] = {xcursor_get_cursor(cursor)};
49 xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, cursor_values);
50
51 /* Map the window (= make it visible) */
52 if (map) {
53 xcb_map_window(conn, result);
54 }
55
56 return result;
57}
58
59/*
60 * Generates a configure_notify_event with absolute coordinates (relative to the X root
61 * window, not to the client’s frame) for the given client.
62 *
63 */
65 xcb_rectangle_t absolute;
66 if (con->window == NULL) {
67 return;
68 }
69
70 absolute.x = con->rect.x + con->window_rect.x;
71 absolute.y = con->rect.y + con->window_rect.y;
72 absolute.width = con->window_rect.width;
73 absolute.height = con->window_rect.height;
74
75 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
76
77 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
78}
79
80/*
81 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
82 *
83 */
84void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
85 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
86 * In order to properly initialize these bytes, we allocate 32 bytes even
87 * though we only need less for an xcb_configure_notify_event_t */
88 void *event = scalloc(32, 1);
89 xcb_client_message_event_t *ev = event;
90
91 ev->response_type = XCB_CLIENT_MESSAGE;
92 ev->window = window;
93 ev->type = A_WM_PROTOCOLS;
94 ev->format = 32;
95 ev->data.data32[0] = A_WM_TAKE_FOCUS;
96 ev->data.data32[1] = timestamp;
97
98 DLOG("Sending WM_TAKE_FOCUS to the client\n");
99 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
100 free(event);
101}
102
103/*
104 * Configures the given window to have the size/position specified by given rect
105 *
106 */
107void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
108 xcb_void_cookie_t cookie;
109 cookie = xcb_configure_window(conn, window,
110 XCB_CONFIG_WINDOW_X |
111 XCB_CONFIG_WINDOW_Y |
112 XCB_CONFIG_WINDOW_WIDTH |
113 XCB_CONFIG_WINDOW_HEIGHT,
114 &(r.x));
115 /* ignore events which are generated because we configured a window */
116 add_ignore_event(cookie.sequence, -1);
117}
118
119/*
120 * Returns the first supported _NET_WM_WINDOW_TYPE atom.
121 *
122 */
123xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
124 if (reply == NULL || xcb_get_property_value_length(reply) == 0) {
125 return XCB_NONE;
126 }
127
128 xcb_atom_t *atoms;
129 if ((atoms = xcb_get_property_value(reply)) == NULL) {
130 return XCB_NONE;
131 }
132
133 for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
134 if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
135 atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
136 atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
137 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
138 atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
139 atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
140 atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
141 atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
142 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
143 atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
144 return atoms[i];
145 }
146 }
147
148 return XCB_NONE;
149}
150
151/*
152 * Returns true if the given reply contains the given atom.
153 *
154 */
155bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
156 if (prop == NULL || xcb_get_property_value_length(prop) == 0) {
157 return false;
158 }
159
160 xcb_atom_t *atoms;
161 if ((atoms = xcb_get_property_value(prop)) == NULL) {
162 return false;
163 }
164
165 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++) {
166 if (atoms[i] == atom) {
167 return true;
168 }
169 }
170
171 return false;
172}
173
174/*
175 * Get visual type specified by visualid
176 *
177 */
178xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
179 xcb_depth_iterator_t depth_iter;
180
181 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
182 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
183 xcb_visualtype_iterator_t visual_iter;
184
185 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
186 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
187 if (visual_id == visual_iter.data->visual_id) {
188 return visual_iter.data;
189 }
190 }
191 }
192 return 0;
193}
194
195/*
196 * Get visualid with specified depth
197 *
198 */
199xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
200 xcb_depth_iterator_t depth_iter;
201
202 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
203 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
204 if (depth_iter.data->depth != depth) {
205 continue;
206 }
207
208 xcb_visualtype_iterator_t visual_iter;
209
210 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
211 if (!visual_iter.rem) {
212 continue;
213 }
214 return visual_iter.data->visual_id;
215 }
216 return 0;
217}
218
219/*
220 * Add an atom to a list of atoms the given property defines.
221 * This is useful, for example, for manipulating _NET_WM_STATE.
222 *
223 */
224void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
225 xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
226}
227
228/*
229 * Remove an atom from a list of atoms the given property defines without
230 * removing any other potentially set atoms. This is useful, for example, for
231 * manipulating _NET_WM_STATE.
232 *
233 */
234void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
235 xcb_grab_server(conn);
236
237 xcb_get_property_reply_t *reply =
238 xcb_get_property_reply(conn,
239 xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
240 if (reply == NULL || xcb_get_property_value_length(reply) == 0) {
241 goto release_grab;
242 }
243 xcb_atom_t *atoms = xcb_get_property_value(reply);
244 if (atoms == NULL) {
245 goto release_grab;
246 }
247
248 {
249 int num = 0;
250 const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
251 xcb_atom_t values[current_size];
252 for (int i = 0; i < current_size; i++) {
253 if (atoms[i] != atom) {
254 values[num++] = atoms[i];
255 }
256 }
257
258 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
259 }
260
261release_grab:
262 FREE(reply);
263 xcb_ungrab_server(conn);
264}
265
266/*
267 * Grab the specified buttons on a window when managing it.
268 *
269 */
270void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
271 int i = 0;
272 while (buttons[i] > 0) {
273 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
274 XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);
275
276 i++;
277 }
278}
xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t depth, xcb_visualid_t visual, uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values)
Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking...
Definition xcb.c:19
xcb_visualid_t get_visualid_by_depth(uint16_t depth)
Get visualid with specified depth.
Definition xcb.c:199
xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply)
Returns the first supported _NET_WM_WINDOW_TYPE atom.
Definition xcb.c:123
void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r)
Configures the given window to have the size/position specified by given rect.
Definition xcb.c:107
void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp)
Sends the WM_TAKE_FOCUS ClientMessage to the given window.
Definition xcb.c:84
void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Add an atom to a list of atoms the given property defines.
Definition xcb.c:224
void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Remove an atom from a list of atoms the given property defines without removing any other potentially...
Definition xcb.c:234
unsigned int xcb_numlock_mask
Definition xcb.c:12
void fake_absolute_configure_notify(Con *con)
Generates a configure_notify_event with absolute coordinates (relative to the X root window,...
Definition xcb.c:64
xcb_visualtype_t * get_visualtype_by_id(xcb_visualid_t visual_id)
Get visual type specified by visualid.
Definition xcb.c:178
bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom)
Returns true if the given reply contains the given data.
Definition xcb.c:155
void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons)
Grab the specified buttons on a window when managing it.
Definition xcb.c:270
xcb_cursor_t xcursor_get_cursor(enum xcursor_cursor_t c)
Definition xcursor.c:54
xcb_connection_t * conn
XCB connection and root screen.
Definition main.c:54
xcb_window_t root
Definition main.c:67
xcb_screen_t * root_screen
Definition main.c:66
void add_ignore_event(const int sequence, const int response_type)
Adds the given sequence to the list of events which are ignored.
xcb_visualid_t visual_id
#define DLOG(fmt,...)
Definition libi3.h:105
void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width)
Generates a configure_notify event and sends it to the given window Applications need this to think t...
#define ELOG(fmt,...)
Definition libi3.h:100
void * scalloc(size_t num, size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
#define FREE(pointer)
Definition util.h:47
xcursor_cursor_t
Definition xcursor.h:16
Stores a rectangle, for example the size of a window, the child window etc.
Definition data.h:185
uint32_t height
Definition data.h:189
uint32_t x
Definition data.h:186
uint32_t y
Definition data.h:187
uint32_t width
Definition data.h:188
xcb_window_t id
Definition data.h:425
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:643
int border_width
Definition data.h:715
struct Rect rect
Definition data.h:682
struct Rect window_rect
Definition data.h:685
struct Window * window
Definition data.h:718