]> git.sur5r.net Git - i3/i3/blob - src/xcb.c
Move get_mod_mask to libi3, use it in i3 and i3-config-wizard
[i3/i3] / src / xcb.c
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2011 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
12 TAILQ_HEAD(cached_fonts_head, Font) cached_fonts = TAILQ_HEAD_INITIALIZER(cached_fonts);
13 unsigned int xcb_numlock_mask;
14
15 /*
16  * Loads a font for usage, also getting its height. If fallback is true,
17  * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
18  * exiting.
19  *
20  */
21 i3Font load_font(const char *pattern, bool fallback) {
22     i3Font new;
23     xcb_void_cookie_t font_cookie;
24     xcb_list_fonts_with_info_cookie_t info_cookie;
25
26     /* Send all our requests first */
27     new.id = xcb_generate_id(conn);
28     font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
29     info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
30
31     /* Check for errors. If errors, fall back to default font. */
32     xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
33
34     /* If we fail to open font, fall back to 'fixed'. If opening 'fixed' fails fall back to '-misc-*' */
35     if (error != NULL) {
36         ELOG("Could not open font %s (X error %d). Reverting to backup font.\n", pattern, error->error_code);
37         pattern = "fixed";
38         font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
39         info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
40
41         /* Check if we managed to open 'fixed' */
42         xcb_generic_error_t *error = xcb_request_check(conn, font_cookie);
43
44         /* Fall back to '-misc-*' if opening 'fixed' fails. */
45         if (error != NULL) {
46             ELOG("Could not open fallback font '%s', trying with '-misc-*'\n",pattern);
47             pattern = "-misc-*";
48             font_cookie = xcb_open_font_checked(conn, new.id, strlen(pattern), pattern);
49             info_cookie = xcb_list_fonts_with_info(conn, 1, strlen(pattern), pattern);
50
51             check_error(conn, font_cookie, "Could open neither requested font nor fallback (fixed or -misc-*");
52         }
53     }
54
55     /* Get information (height/name) for this font */
56     xcb_list_fonts_with_info_reply_t *reply = xcb_list_fonts_with_info_reply(conn, info_cookie, NULL);
57     exit_if_null(reply, "Could not load font \"%s\"\n", pattern);
58
59     new.height = reply->font_ascent + reply->font_descent;
60
61     free(reply);
62
63     return new;
64 }
65
66 /*
67  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
68  * for errors.
69  *
70  */
71 xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t window_class,
72         enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
73     xcb_window_t result = xcb_generate_id(conn);
74
75     /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, depth has to be 0 */
76     uint16_t depth = (window_class == XCB_WINDOW_CLASS_INPUT_ONLY ? 0 : XCB_COPY_FROM_PARENT);
77
78     xcb_create_window(conn,
79             depth,
80             result, /* the window id */
81             root, /* parent == root */
82             dims.x, dims.y, dims.width, dims.height, /* dimensions */
83             0, /* border = 0, we draw our own */
84             window_class,
85             XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
86             mask,
87             values);
88
89     /* Set the cursor */
90     if (xcursor_supported) {
91         mask = XCB_CW_CURSOR;
92         values[0] = xcursor_get_cursor(cursor);
93         xcb_change_window_attributes(conn, result, mask, values);
94     } else {
95         xcb_cursor_t cursor_id = xcb_generate_id(conn);
96         i3Font cursor_font = load_font("cursor", false);
97         int xcb_cursor = xcursor_get_xcb_cursor(cursor);
98         xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
99                 xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
100         xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
101         xcb_free_cursor(conn, cursor_id);
102     }
103
104     /* Map the window (= make it visible) */
105     if (map)
106         xcb_map_window(conn, result);
107
108     return result;
109 }
110
111 /*
112  * Draws a line from x,y to to_x,to_y using the given color
113  *
114  */
115 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
116                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
117     xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){ colorpixel });
118     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2,
119                   (xcb_point_t[]) { {x, y}, {to_x, to_y} });
120 }
121
122 /*
123  * Draws a rectangle from x,y with width,height using the given color
124  *
125  */
126 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
127                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
128     xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){ colorpixel });
129     xcb_rectangle_t rect = {x, y, width, height};
130     xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
131 }
132
133 /*
134  * Generates a configure_notify_event with absolute coordinates (relative to the X root
135  * window, not to the client’s frame) for the given client.
136  *
137  */
138 void fake_absolute_configure_notify(Con *con) {
139     xcb_rectangle_t absolute;
140     if (con->window == NULL)
141         return;
142
143     absolute.x = con->rect.x + con->window_rect.x;
144     absolute.y = con->rect.y + con->window_rect.y;
145     absolute.width = con->window_rect.width;
146     absolute.height = con->window_rect.height;
147
148     DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
149
150     fake_configure_notify(conn, absolute, con->window->id, con->border_width);
151 }
152
153 /*
154  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
155  *
156  */
157 void send_take_focus(xcb_window_t window) {
158     /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
159      * In order to properly initialize these bytes, we allocate 32 bytes even
160      * though we only need less for an xcb_configure_notify_event_t */
161     void *event = scalloc(32);
162     xcb_client_message_event_t *ev = event;
163
164     ev->response_type = XCB_CLIENT_MESSAGE;
165     ev->window = window;
166     ev->type = A_WM_PROTOCOLS;
167     ev->format = 32;
168     ev->data.data32[0] = A_WM_TAKE_FOCUS;
169     ev->data.data32[1] = XCB_CURRENT_TIME;
170
171     DLOG("Sending WM_TAKE_FOCUS to the client\n");
172     xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
173     free(event);
174 }
175
176 /*
177  * Raises the given window (typically client->frame) above all other windows
178  *
179  */
180 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
181     uint32_t values[] = { XCB_STACK_MODE_ABOVE };
182     xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
183 }
184
185 /*
186  * Query the width of the given text (16-bit characters, UCS) with given real
187  * length (amount of glyphs) using the given font.
188  *
189  */
190 int predict_text_width(char *text, int length) {
191     xcb_query_text_extents_cookie_t cookie;
192     xcb_query_text_extents_reply_t *reply;
193     xcb_generic_error_t *error;
194     int width;
195
196     cookie = xcb_query_text_extents(conn, config.font.id, length, (xcb_char2b_t*)text);
197     if ((reply = xcb_query_text_extents_reply(conn, cookie, &error)) == NULL) {
198         ELOG("Could not get text extents (X error code %d)\n",
199              error->error_code);
200         /* We return the rather safe guess of 7 pixels, because a
201          * rendering error is better than a crash. Plus, the user will
202          * see the error in his log. */
203         return 7;
204     }
205
206     width = reply->overall_width;
207     free(reply);
208     return width;
209 }
210
211 /*
212  * Configures the given window to have the size/position specified by given rect
213  *
214  */
215 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
216     xcb_void_cookie_t cookie;
217     cookie = xcb_configure_window(conn, window,
218                          XCB_CONFIG_WINDOW_X |
219                          XCB_CONFIG_WINDOW_Y |
220                          XCB_CONFIG_WINDOW_WIDTH |
221                          XCB_CONFIG_WINDOW_HEIGHT,
222                          &(r.x));
223     /* ignore events which are generated because we configured a window */
224     add_ignore_event(cookie.sequence, -1);
225 }
226
227 /*
228  * Returns true if the given reply contains the given atom.
229  *
230  */
231 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
232     if (prop == NULL || xcb_get_property_value_length(prop) == 0)
233         return false;
234
235     xcb_atom_t *atoms;
236     if ((atoms = xcb_get_property_value(prop)) == NULL)
237         return false;
238
239     for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
240         if (atoms[i] == atom)
241             return true;
242
243     return false;
244
245 }
246
247 /**
248  * Moves the mouse pointer into the middle of rect.
249  *
250  */
251 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
252     int mid_x = rect->x + (rect->width / 2);
253     int mid_y = rect->y + (rect->height / 2);
254
255     LOG("warp pointer to: %d %d\n", mid_x, mid_y);
256     xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
257 }
258
259 /*
260  * Set the cursor of the root window to the given cursor id.
261  * This function should only be used if xcursor_supported == false.
262  * Otherwise, use xcursor_set_root_cursor().
263  *
264  */
265 void xcb_set_root_cursor(int cursor) {
266     xcb_cursor_t cursor_id = xcb_generate_id(conn);
267     i3Font cursor_font = load_font("cursor", false);
268     int xcb_cursor = xcursor_get_xcb_cursor(cursor);
269     xcb_create_glyph_cursor(conn, cursor_id, cursor_font.id, cursor_font.id,
270             xcb_cursor, xcb_cursor + 1, 0, 0, 0, 65535, 65535, 65535);
271     xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
272     xcb_free_cursor(conn, cursor_id);
273     xcb_flush(conn);
274 }