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 * restore_layout.c: Everything for restored containers that is not pure state
8 * parsing (which can be found in load_layout.c).
14 #ifdef I3_ASAN_ENABLED
15 #include <sanitizer/lsan_interface.h>
18 #define TEXT_PADDING logical_px(2)
20 typedef struct placeholder_state {
21 /** The X11 placeholder window. */
23 /** The container to which this placeholder window belongs. */
26 /** Current size of the placeholder window (to detect size changes). */
29 /** The drawable surface */
32 TAILQ_ENTRY(placeholder_state)
36 static TAILQ_HEAD(state_head, placeholder_state) state_head =
37 TAILQ_HEAD_INITIALIZER(state_head);
39 static xcb_connection_t *restore_conn;
41 static struct ev_io *xcb_watcher;
42 static struct ev_check *xcb_check;
43 static struct ev_prepare *xcb_prepare;
45 static void restore_handle_event(int type, xcb_generic_event_t *event);
47 /* Documentation for these functions can be found in src/main.c, starting at xcb_got_event */
48 static void restore_xcb_got_event(EV_P_ struct ev_io *w, int revents) {
51 static void restore_xcb_prepare_cb(EV_P_ ev_prepare *w, int revents) {
52 xcb_flush(restore_conn);
55 static void restore_xcb_check_cb(EV_P_ ev_check *w, int revents) {
56 xcb_generic_event_t *event;
58 if (xcb_connection_has_error(restore_conn)) {
59 DLOG("restore X11 connection has an error, reconnecting\n");
64 while ((event = xcb_poll_for_event(restore_conn)) != NULL) {
65 if (event->response_type == 0) {
66 xcb_generic_error_t *error = (xcb_generic_error_t *)event;
67 DLOG("X11 Error received (probably harmless)! sequence 0x%x, error_code = %d\n",
68 error->sequence, error->error_code);
73 /* Strip off the highest bit (set if the event is generated) */
74 int type = (event->response_type & 0x7F);
76 restore_handle_event(type, event);
83 * Opens a separate connection to X11 for placeholder windows when restoring
84 * layouts. This is done as a safety measure (users can xkill a placeholder
85 * window without killing their window manager) and for better isolation, both
86 * on the wire to X11 and thus also in the code.
89 void restore_connect(void) {
90 if (restore_conn != NULL) {
91 /* This is not the initial connect, but a reconnect, most likely
92 * because our X11 connection was killed (e.g. by a user with xkill. */
93 ev_io_stop(main_loop, xcb_watcher);
94 ev_check_stop(main_loop, xcb_check);
95 ev_prepare_stop(main_loop, xcb_prepare);
97 placeholder_state *state;
98 while (!TAILQ_EMPTY(&state_head)) {
99 state = TAILQ_FIRST(&state_head);
100 TAILQ_REMOVE(&state_head, state, state);
104 /* xcb_disconnect leaks memory in libxcb versions earlier than 1.11,
105 * but it’s the right function to call. See
106 * http://cgit.freedesktop.org/xcb/libxcb/commit/src/xcb_conn.c?id=4dcbfd77b
108 xcb_disconnect(restore_conn);
115 restore_conn = xcb_connect(NULL, &screen);
116 if (restore_conn == NULL || xcb_connection_has_error(restore_conn)) {
117 if (restore_conn != NULL) {
118 xcb_disconnect(restore_conn);
120 #ifdef I3_ASAN_ENABLED
121 __lsan_do_leak_check();
123 errx(EXIT_FAILURE, "Cannot open display\n");
126 xcb_watcher = scalloc(1, sizeof(struct ev_io));
127 xcb_check = scalloc(1, sizeof(struct ev_check));
128 xcb_prepare = scalloc(1, sizeof(struct ev_prepare));
130 ev_io_init(xcb_watcher, restore_xcb_got_event, xcb_get_file_descriptor(restore_conn), EV_READ);
131 ev_io_start(main_loop, xcb_watcher);
133 ev_check_init(xcb_check, restore_xcb_check_cb);
134 ev_check_start(main_loop, xcb_check);
136 ev_prepare_init(xcb_prepare, restore_xcb_prepare_cb);
137 ev_prepare_start(main_loop, xcb_prepare);
140 static void update_placeholder_contents(placeholder_state *state) {
141 const color_t foreground = config.client.placeholder.text;
142 const color_t background = config.client.placeholder.background;
144 draw_util_clear_surface(&(state->surface), background);
146 // TODO: make i3font functions per-connection, at least these two for now…?
147 xcb_flush(restore_conn);
148 xcb_aux_sync(restore_conn);
152 TAILQ_FOREACH(swallows, &(state->con->swallow_head), matches) {
153 char *serialized = NULL;
155 #define APPEND_REGEX(re_name) \
157 if (swallows->re_name != NULL) { \
158 sasprintf(&serialized, "%s%s" #re_name "=\"%s\"", (serialized ? serialized : "["), (serialized ? " " : ""), swallows->re_name->pattern); \
163 APPEND_REGEX(instance);
164 APPEND_REGEX(window_role);
167 if (serialized == NULL) {
168 DLOG("This swallows specification is not serializable?!\n");
172 sasprintf(&serialized, "%s]", serialized);
173 DLOG("con %p (placeholder 0x%08x) line %d: %s\n", state->con, state->window, n, serialized);
175 i3String *str = i3string_from_utf8(serialized);
176 draw_util_text(str, &(state->surface), foreground, background,
178 (n * (config.font.height + TEXT_PADDING)) + TEXT_PADDING,
179 state->rect.width - 2 * TEXT_PADDING);
185 // TODO: render the watch symbol in a bigger font
186 i3String *line = i3string_from_utf8("⌚");
187 int text_width = predict_text_width(line);
188 int x = (state->rect.width / 2) - (text_width / 2);
189 int y = (state->rect.height / 2) - (config.font.height / 2);
190 draw_util_text(line, &(state->surface), foreground, background, x, y, text_width);
196 static void open_placeholder_window(Con *con) {
197 if (con_is_leaf(con) &&
198 (con->window == NULL || con->window->id == XCB_NONE) &&
199 !TAILQ_EMPTY(&(con->swallow_head)) &&
200 con->type == CT_CON) {
201 xcb_window_t placeholder = create_window(
204 XCB_COPY_FROM_PARENT,
205 XCB_COPY_FROM_PARENT,
206 XCB_WINDOW_CLASS_INPUT_OUTPUT,
207 XCURSOR_CURSOR_POINTER,
209 XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
211 config.client.placeholder.background.colorpixel,
212 XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY,
214 /* Make i3 not focus this window. */
215 xcb_icccm_wm_hints_t hints;
216 xcb_icccm_wm_hints_set_none(&hints);
217 xcb_icccm_wm_hints_set_input(&hints, 0);
218 xcb_icccm_set_wm_hints(restore_conn, placeholder, &hints);
219 /* Set the same name as was stored in the layout file. While perhaps
220 * slightly confusing in the first instant, this brings additional
221 * clarity to which placeholder is waiting for which actual window. */
222 if (con->name != NULL)
223 xcb_change_property(restore_conn, XCB_PROP_MODE_REPLACE, placeholder,
224 A__NET_WM_NAME, A_UTF8_STRING, 8, strlen(con->name), con->name);
225 DLOG("Created placeholder window 0x%08x for leaf container %p / %s\n",
226 placeholder, con, con->name);
228 placeholder_state *state = scalloc(1, sizeof(placeholder_state));
229 state->window = placeholder;
231 state->rect = con->rect;
233 draw_util_surface_init(conn, &(state->surface), placeholder, get_visualtype(root_screen), state->rect.width, state->rect.height);
234 update_placeholder_contents(state);
235 TAILQ_INSERT_TAIL(&state_head, state, state);
237 /* create temporary id swallow to match the placeholder */
238 Match *temp_id = smalloc(sizeof(Match));
240 temp_id->dock = M_DONTCHECK;
241 temp_id->id = placeholder;
242 TAILQ_INSERT_HEAD(&(con->swallow_head), temp_id, matches);
246 TAILQ_FOREACH(child, &(con->nodes_head), nodes) {
247 open_placeholder_window(child);
249 TAILQ_FOREACH(child, &(con->floating_head), floating_windows) {
250 open_placeholder_window(child);
255 * Open placeholder windows for all children of parent. The placeholder window
256 * will vanish as soon as a real window is swallowed by the container. Until
257 * then, it exposes the criteria that must be fulfilled for a window to be
258 * swallowed by this container.
261 void restore_open_placeholder_windows(Con *parent) {
263 TAILQ_FOREACH(child, &(parent->nodes_head), nodes) {
264 open_placeholder_window(child);
266 TAILQ_FOREACH(child, &(parent->floating_head), floating_windows) {
267 open_placeholder_window(child);
270 xcb_flush(restore_conn);
274 * Kill the placeholder window, if placeholder refers to a placeholder window.
275 * This function is called when manage.c puts a window into an existing
276 * container. In order not to leak resources, we need to destroy the window and
277 * all associated X11 objects (pixmap/gc).
280 bool restore_kill_placeholder(xcb_window_t placeholder) {
281 placeholder_state *state;
282 TAILQ_FOREACH(state, &state_head, state) {
283 if (state->window != placeholder)
286 xcb_destroy_window(restore_conn, state->window);
287 draw_util_surface_free(restore_conn, &(state->surface));
288 TAILQ_REMOVE(&state_head, state, state);
290 DLOG("placeholder window 0x%08x destroyed.\n", placeholder);
294 DLOG("0x%08x is not a placeholder window, ignoring.\n", placeholder);
298 static void expose_event(xcb_expose_event_t *event) {
299 placeholder_state *state;
300 TAILQ_FOREACH(state, &state_head, state) {
301 if (state->window != event->window)
304 DLOG("refreshing window 0x%08x contents (con %p)\n", state->window, state->con);
306 update_placeholder_contents(state);
311 ELOG("Received ExposeEvent for unknown window 0x%08x\n", event->window);
315 * Window size has changed. Update the width/height, then recreate the back
316 * buffer pixmap and the accompanying graphics context and force an immediate
320 static void configure_notify(xcb_configure_notify_event_t *event) {
321 placeholder_state *state;
322 TAILQ_FOREACH(state, &state_head, state) {
323 if (state->window != event->window)
326 DLOG("ConfigureNotify: window 0x%08x has now width=%d, height=%d (con %p)\n",
327 state->window, event->width, event->height, state->con);
329 state->rect.width = event->width;
330 state->rect.height = event->height;
332 draw_util_surface_set_size(&(state->surface), state->rect.width, state->rect.height);
334 update_placeholder_contents(state);
339 ELOG("Received ConfigureNotify for unknown window 0x%08x\n", event->window);
342 static void restore_handle_event(int type, xcb_generic_event_t *event) {
345 if (((xcb_expose_event_t *)event)->count == 0) {
346 expose_event((xcb_expose_event_t *)event);
350 case XCB_CONFIGURE_NOTIFY:
351 configure_notify((xcb_configure_notify_event_t *)event);
354 DLOG("Received unhandled X11 event of type %d\n", type);