i3
xcb.c
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved dynamic 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 return result;
56}
57
58/*
59 * Generates a configure_notify_event with absolute coordinates (relative to the X root
60 * window, not to the client’s frame) for the given client.
61 *
62 */
64 xcb_rectangle_t absolute;
65 if (con->window == NULL)
66 return;
67
68 absolute.x = con->rect.x + con->window_rect.x;
69 absolute.y = con->rect.y + con->window_rect.y;
70 absolute.width = con->window_rect.width;
71 absolute.height = con->window_rect.height;
72
73 DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
74
75 fake_configure_notify(conn, absolute, con->window->id, con->border_width);
76}
77
78/*
79 * Sends the WM_TAKE_FOCUS ClientMessage to the given window
80 *
81 */
82void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
83 /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
84 * In order to properly initialize these bytes, we allocate 32 bytes even
85 * though we only need less for an xcb_configure_notify_event_t */
86 void *event = scalloc(32, 1);
87 xcb_client_message_event_t *ev = event;
88
89 ev->response_type = XCB_CLIENT_MESSAGE;
90 ev->window = window;
91 ev->type = A_WM_PROTOCOLS;
92 ev->format = 32;
93 ev->data.data32[0] = A_WM_TAKE_FOCUS;
94 ev->data.data32[1] = timestamp;
95
96 DLOG("Sending WM_TAKE_FOCUS to the client\n");
97 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
98 free(event);
99}
100
101/*
102 * Configures the given window to have the size/position specified by given rect
103 *
104 */
105void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
106 xcb_void_cookie_t cookie;
107 cookie = xcb_configure_window(conn, window,
108 XCB_CONFIG_WINDOW_X |
109 XCB_CONFIG_WINDOW_Y |
110 XCB_CONFIG_WINDOW_WIDTH |
111 XCB_CONFIG_WINDOW_HEIGHT,
112 &(r.x));
113 /* ignore events which are generated because we configured a window */
114 add_ignore_event(cookie.sequence, -1);
115}
116
117/*
118 * Returns the first supported _NET_WM_WINDOW_TYPE atom.
119 *
120 */
121xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
122 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
123 return XCB_NONE;
124
125 xcb_atom_t *atoms;
126 if ((atoms = xcb_get_property_value(reply)) == NULL)
127 return XCB_NONE;
128
129 for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
130 if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
131 atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
132 atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
133 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
134 atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
135 atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
136 atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
137 atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
138 atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
139 atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
140 return atoms[i];
141 }
142 }
143
144 return XCB_NONE;
145}
146
147/*
148 * Returns true if the given reply contains the given atom.
149 *
150 */
151bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
152 if (prop == NULL || xcb_get_property_value_length(prop) == 0)
153 return false;
154
155 xcb_atom_t *atoms;
156 if ((atoms = xcb_get_property_value(prop)) == NULL)
157 return false;
158
159 for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
160 if (atoms[i] == atom)
161 return true;
162
163 return false;
164}
165
166/*
167 * Get visual type specified by visualid
168 *
169 */
170xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
171 xcb_depth_iterator_t depth_iter;
172
173 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
174 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
175 xcb_visualtype_iterator_t visual_iter;
176
177 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
178 for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
179 if (visual_id == visual_iter.data->visual_id) {
180 return visual_iter.data;
181 }
182 }
183 }
184 return 0;
185}
186
187/*
188 * Get visualid with specified depth
189 *
190 */
191xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
192 xcb_depth_iterator_t depth_iter;
193
194 depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
195 for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
196 if (depth_iter.data->depth != depth)
197 continue;
198
199 xcb_visualtype_iterator_t visual_iter;
200
201 visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
202 if (!visual_iter.rem)
203 continue;
204 return visual_iter.data->visual_id;
205 }
206 return 0;
207}
208
209/*
210 * Add an atom to a list of atoms the given property defines.
211 * This is useful, for example, for manipulating _NET_WM_STATE.
212 *
213 */
214void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
215 xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
216}
217
218/*
219 * Remove an atom from a list of atoms the given property defines without
220 * removing any other potentially set atoms. This is useful, for example, for
221 * manipulating _NET_WM_STATE.
222 *
223 */
224void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
225 xcb_grab_server(conn);
226
227 xcb_get_property_reply_t *reply =
228 xcb_get_property_reply(conn,
229 xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
230 if (reply == NULL || xcb_get_property_value_length(reply) == 0)
231 goto release_grab;
232 xcb_atom_t *atoms = xcb_get_property_value(reply);
233 if (atoms == NULL) {
234 goto release_grab;
235 }
236
237 {
238 int num = 0;
239 const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
240 xcb_atom_t values[current_size];
241 for (int i = 0; i < current_size; i++) {
242 if (atoms[i] != atom)
243 values[num++] = atoms[i];
244 }
245
246 xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
247 }
248
249release_grab:
250 FREE(reply);
251 xcb_ungrab_server(conn);
252}
253
254/*
255 * Grab the specified buttons on a window when managing it.
256 *
257 */
258void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
259 int i = 0;
260 while (buttons[i] > 0) {
261 xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
262 XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);
263
264 i++;
265 }
266}
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
xcb_cursor_t xcursor_get_cursor(enum xcursor_cursor_t c)
Definition xcursor.c:54
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:191
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:121
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:105
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:82
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:214
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:224
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:63
xcb_visualtype_t * get_visualtype_by_id(xcb_visualid_t visual_id)
Get visual type specified by visualid.
Definition xcb.c:170
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:151
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:258
xcursor_cursor_t
Definition xcursor.h:16
#define FREE(pointer)
Definition util.h:47
#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...
xcb_visualid_t visual_id
void add_ignore_event(const int sequence, const int response_type)
Adds the given sequence to the list of events which are ignored.
Stores a rectangle, for example the size of a window, the child window etc.
Definition data.h:189
uint32_t height
Definition data.h:193
uint32_t x
Definition data.h:190
uint32_t y
Definition data.h:191
uint32_t width
Definition data.h:192
xcb_window_t id
Definition data.h:429
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:647
int border_width
Definition data.h:719
struct Rect rect
Definition data.h:686
struct Rect window_rect
Definition data.h:689
struct Window * window
Definition data.h:722