2 #define I3__FILE__ "handlers.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
9 * handlers.c: Small handlers for various events (keypresses, focus changes,
18 #include <xcb/randr.h>
19 #include <X11/XKBlib.h>
20 #define SN_API_NOT_YET_FROZEN 1
21 #include <libsn/sn-monitor.h>
25 int xkb_current_group;
27 /* After mapping/unmapping windows, a notify event is generated. However, we don’t want it,
28 since it’d trigger an infinite loop of switching between the different windows when
29 changing workspaces */
30 static SLIST_HEAD(ignore_head, Ignore_Event) ignore_events;
33 * Adds the given sequence to the list of events which are ignored.
34 * If this ignore should only affect a specific response_type, pass
35 * response_type, otherwise, pass -1.
37 * Every ignored sequence number gets garbage collected after 5 seconds.
40 void add_ignore_event(const int sequence, const int response_type) {
41 struct Ignore_Event *event = smalloc(sizeof(struct Ignore_Event));
43 event->sequence = sequence;
44 event->response_type = response_type;
45 event->added = time(NULL);
47 SLIST_INSERT_HEAD(&ignore_events, event, ignore_events);
51 * Checks if the given sequence is ignored and returns true if so.
54 bool event_is_ignored(const int sequence, const int response_type) {
55 struct Ignore_Event *event;
56 time_t now = time(NULL);
57 for (event = SLIST_FIRST(&ignore_events); event != SLIST_END(&ignore_events);) {
58 if ((now - event->added) > 5) {
59 struct Ignore_Event *save = event;
60 event = SLIST_NEXT(event, ignore_events);
61 SLIST_REMOVE(&ignore_events, save, Ignore_Event, ignore_events);
64 event = SLIST_NEXT(event, ignore_events);
67 SLIST_FOREACH(event, &ignore_events, ignore_events) {
68 if (event->sequence != sequence)
71 if (event->response_type != -1 &&
72 event->response_type != response_type)
75 /* instead of removing a sequence number we better wait until it gets
76 * garbage collected. it may generate multiple events (there are multiple
77 * enter_notifies for one configure_request, for example). */
78 //SLIST_REMOVE(&ignore_events, event, Ignore_Event, ignore_events);
87 * Called with coordinates of an enter_notify event or motion_notify event
88 * to check if the user crossed virtual screen boundaries and adjust the
89 * current workspace, if so.
92 static void check_crossing_screen_boundary(uint32_t x, uint32_t y) {
95 /* If the user disable focus follows mouse, we have nothing to do here */
96 if (config.disable_focus_follows_mouse)
99 if ((output = get_output_containing(x, y)) == NULL) {
100 ELOG("ERROR: No such screen\n");
104 if (output->con == NULL) {
105 ELOG("ERROR: The screen is not recognized by i3 (no container associated)\n");
109 /* Focus the output on which the user moved their cursor */
110 Con *old_focused = focused;
111 Con *next = con_descend_focused(output_get_content(output->con));
112 /* Since we are switching outputs, this *must* be a different workspace, so
113 * call workspace_show() */
114 workspace_show(con_get_workspace(next));
117 /* If the focus changed, we re-render to get updated decorations */
118 if (old_focused != focused)
123 * When the user moves the mouse pointer onto a window, this callback gets called.
126 static void handle_enter_notify(xcb_enter_notify_event_t *event) {
129 last_timestamp = event->time;
131 DLOG("enter_notify for %08x, mode = %d, detail %d, serial %d\n",
132 event->event, event->mode, event->detail, event->sequence);
133 DLOG("coordinates %d, %d\n", event->event_x, event->event_y);
134 if (event->mode != XCB_NOTIFY_MODE_NORMAL) {
135 DLOG("This was not a normal notify, ignoring\n");
138 /* Some events are not interesting, because they were not generated
139 * actively by the user, but by reconfiguration of windows */
140 if (event_is_ignored(event->sequence, XCB_ENTER_NOTIFY)) {
141 DLOG("Event ignored\n");
145 bool enter_child = false;
146 /* Get container by frame or by child window */
147 if ((con = con_by_frame_id(event->event)) == NULL) {
148 con = con_by_window_id(event->event);
152 /* If not, then the user moved their cursor to the root window. In that case, we adjust c_ws */
154 DLOG("Getting screen at %d x %d\n", event->root_x, event->root_y);
155 check_crossing_screen_boundary(event->root_x, event->root_y);
159 if (con->parent->type == CT_DOCKAREA) {
160 DLOG("Ignoring, this is a dock client\n");
164 /* see if the user entered the window on a certain window decoration */
165 layout_t layout = (enter_child ? con->parent->layout : con->layout);
166 if (layout == L_DEFAULT) {
168 TAILQ_FOREACH(child, &(con->nodes_head), nodes)
169 if (rect_contains(child->deco_rect, event->event_x, event->event_y)) {
170 LOG("using child %p / %s instead!\n", child, child->name);
177 if (client->workspace != c_ws && client->workspace->output == c_ws->output) {
178 /* This can happen when a client gets assigned to a different workspace than
179 * the current one (see src/mainx.c:reparent_window). Shortly after it was created,
180 * an enter_notify will follow. */
181 DLOG("enter_notify for a client on a different workspace but the same screen, ignoring\n");
186 if (config.disable_focus_follows_mouse)
189 /* if this container is already focused, there is nothing to do. */
193 /* Get the currently focused workspace to check if the focus change also
194 * involves changing workspaces. If so, we need to call workspace_show() to
195 * correctly update state and send the IPC event. */
196 Con *ws = con_get_workspace(con);
197 if (ws != con_get_workspace(focused))
200 focused_id = XCB_NONE;
201 con_focus(con_descend_focused(con));
208 * When the user moves the mouse but does not change the active window
209 * (e.g. when having no windows opened but moving mouse on the root screen
210 * and crossing virtual screen boundaries), this callback gets called.
213 static void handle_motion_notify(xcb_motion_notify_event_t *event) {
214 last_timestamp = event->time;
216 /* Skip events where the pointer was over a child window, we are only
217 * interested in events on the root window. */
218 if (event->child != 0)
222 if ((con = con_by_frame_id(event->event)) == NULL) {
223 DLOG("MotionNotify for an unknown container, checking if it crosses screen boundaries.\n");
224 check_crossing_screen_boundary(event->root_x, event->root_y);
228 if (config.disable_focus_follows_mouse)
231 if (con->layout != L_DEFAULT)
234 /* see over which rect the user is */
236 TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
237 if (!rect_contains(current->deco_rect, event->event_x, event->event_y))
240 /* We found the rect, let’s see if this window is focused */
241 if (TAILQ_FIRST(&(con->focus_head)) == current)
245 x_push_changes(croot);
253 * Called when the keyboard mapping changes (for example by using Xmodmap),
254 * we need to update our key bindings then (re-translate symbols).
257 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
258 if (event->request != XCB_MAPPING_KEYBOARD &&
259 event->request != XCB_MAPPING_MODIFIER)
262 DLOG("Received mapping_notify for keyboard or modifier mapping, re-grabbing keys\n");
263 xcb_refresh_keyboard_mapping(keysyms, event);
265 xcb_numlock_mask = aio_get_mod_mask_for(XCB_NUM_LOCK, keysyms);
267 ungrab_all_keys(conn);
269 grab_all_keys(conn, false);
275 * A new window appeared on the screen (=was mapped), so let’s manage it.
278 static void handle_map_request(xcb_map_request_event_t *event) {
279 xcb_get_window_attributes_cookie_t cookie;
281 cookie = xcb_get_window_attributes_unchecked(conn, event->window);
283 DLOG("window = 0x%08x, serial is %d.\n", event->window, event->sequence);
284 add_ignore_event(event->sequence, -1);
286 manage_window(event->window, cookie, false);
291 * Configure requests are received when the application wants to resize windows
294 * We generate a synthethic configure notify event to signalize the client its
298 static void handle_configure_request(xcb_configure_request_event_t *event) {
301 DLOG("window 0x%08x wants to be at %dx%d with %dx%d\n",
302 event->window, event->x, event->y, event->width, event->height);
304 /* For unmanaged windows, we just execute the configure request. As soon as
305 * it gets mapped, we will take over anyways. */
306 if ((con = con_by_window_id(event->window)) == NULL) {
307 DLOG("Configure request for unmanaged window, can do that.\n");
312 #define COPY_MASK_MEMBER(mask_member, event_member) \
314 if (event->value_mask & mask_member) { \
315 mask |= mask_member; \
316 values[c++] = event->event_member; \
320 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_X, x);
321 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_Y, y);
322 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_WIDTH, width);
323 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_HEIGHT, height);
324 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_BORDER_WIDTH, border_width);
325 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_SIBLING, sibling);
326 COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_STACK_MODE, stack_mode);
328 xcb_configure_window(conn, event->window, mask, values);
334 DLOG("Configure request!\n");
336 Con *workspace = con_get_workspace(con),
339 /* There might not be a corresponding workspace for dock cons, therefore we
340 * have to be careful here. */
342 fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
344 fullscreen = con_get_fullscreen_con(workspace, CF_GLOBAL);
347 if (fullscreen != con && con_is_floating(con) && con_is_leaf(con)) {
348 /* find the height for the decorations */
349 int deco_height = con->deco_rect.height;
350 /* we actually need to apply the size/position changes to the *parent*
352 Rect bsr = con_border_style_rect(con);
353 if (con->border_style == BS_NORMAL) {
354 bsr.y += deco_height;
355 bsr.height -= deco_height;
357 Con *floatingcon = con->parent;
359 if (strcmp(con_get_workspace(floatingcon)->name, "__i3_scratch") == 0) {
360 DLOG("This is a scratchpad container, ignoring ConfigureRequest\n");
364 Rect newrect = floatingcon->rect;
366 if (event->value_mask & XCB_CONFIG_WINDOW_X) {
367 newrect.x = event->x + (-1) * bsr.x;
368 DLOG("proposed x = %d, new x is %d\n", event->x, newrect.x);
370 if (event->value_mask & XCB_CONFIG_WINDOW_Y) {
371 newrect.y = event->y + (-1) * bsr.y;
372 DLOG("proposed y = %d, new y is %d\n", event->y, newrect.y);
374 if (event->value_mask & XCB_CONFIG_WINDOW_WIDTH) {
375 newrect.width = event->width + (-1) * bsr.width;
376 newrect.width += con->border_width * 2;
377 DLOG("proposed width = %d, new width is %d (x11 border %d)\n",
378 event->width, newrect.width, con->border_width);
380 if (event->value_mask & XCB_CONFIG_WINDOW_HEIGHT) {
381 newrect.height = event->height + (-1) * bsr.height;
382 newrect.height += con->border_width * 2;
383 DLOG("proposed height = %d, new height is %d (x11 border %d)\n",
384 event->height, newrect.height, con->border_width);
387 DLOG("Container is a floating leaf node, will do that.\n");
388 floating_reposition(floatingcon, newrect);
392 /* Dock windows can be reconfigured in their height */
393 if (con->parent && con->parent->type == CT_DOCKAREA) {
394 DLOG("Dock window, only height reconfiguration allowed\n");
395 if (event->value_mask & XCB_CONFIG_WINDOW_HEIGHT) {
396 DLOG("Height given, changing\n");
398 con->geometry.height = event->height;
403 fake_absolute_configure_notify(con);
410 * Configuration notifies are only handled because we need to set up ignore for
411 * the following enter notify events.
414 int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event) {
415 DLOG("configure_event, sequence %d\n", event->sequence);
416 /* We ignore this sequence twice because events for child and frame should be ignored */
417 add_ignore_event(event->sequence);
418 add_ignore_event(event->sequence);
425 * Gets triggered upon a RandR screen change event, that is when the user
426 * changes the screen configuration in any way (mode, position, …)
429 static void handle_screen_change(xcb_generic_event_t *e) {
430 DLOG("RandR screen change\n");
432 /* The geometry of the root window is used for “fullscreen global” and
433 * changes when new outputs are added. */
434 xcb_get_geometry_cookie_t cookie = xcb_get_geometry(conn, root);
435 xcb_get_geometry_reply_t *reply = xcb_get_geometry_reply(conn, cookie, NULL);
437 ELOG("Could not get geometry of the root window, exiting\n");
440 DLOG("root geometry reply: (%d, %d) %d x %d\n", reply->x, reply->y, reply->width, reply->height);
442 croot->rect.width = reply->width;
443 croot->rect.height = reply->height;
445 randr_query_outputs();
447 scratchpad_fix_resolution();
449 ipc_send_event("output", I3_IPC_EVENT_OUTPUT, "{\"change\":\"unspecified\"}");
455 * Our window decorations were unmapped. That means, the window will be killed
456 * now, so we better clean up before.
459 static void handle_unmap_notify_event(xcb_unmap_notify_event_t *event) {
460 DLOG("UnmapNotify for 0x%08x (received from 0x%08x), serial %d\n", event->window, event->event, event->sequence);
461 xcb_get_input_focus_cookie_t cookie;
462 Con *con = con_by_window_id(event->window);
464 /* This could also be an UnmapNotify for the frame. We need to
465 * decrement the ignore_unmap counter. */
466 con = con_by_frame_id(event->window);
468 LOG("Not a managed window, ignoring UnmapNotify event\n");
472 if (con->ignore_unmap > 0)
474 /* See the end of this function. */
475 cookie = xcb_get_input_focus(conn);
476 DLOG("ignore_unmap = %d for frame of container %p\n", con->ignore_unmap, con);
480 /* See the end of this function. */
481 cookie = xcb_get_input_focus(conn);
483 if (con->ignore_unmap > 0) {
484 DLOG("ignore_unmap = %d, dec\n", con->ignore_unmap);
489 tree_close(con, DONT_KILL_WINDOW, false, false);
493 /* If the client (as opposed to i3) destroyed or unmapped a window, an
494 * EnterNotify event will follow (indistinguishable from an EnterNotify
495 * event caused by moving your mouse), causing i3 to set focus to whichever
496 * window is now visible.
498 * In a complex stacked or tabbed layout (take two v-split containers in a
499 * tabbed container), when the bottom window in tab2 is closed, the bottom
500 * window of tab1 is visible instead. X11 will thus send an EnterNotify
501 * event for the bottom window of tab1, while the focus should be set to
502 * the remaining window of tab2.
504 * Therefore, we ignore all EnterNotify events which have the same sequence
505 * as an UnmapNotify event. */
506 add_ignore_event(event->sequence, XCB_ENTER_NOTIFY);
508 /* Since we just ignored the sequence of this UnmapNotify, we want to make
509 * sure that following events use a different sequence. When putting xterm
510 * into fullscreen and moving the pointer to a different window, without
511 * using GetInputFocus, subsequent (legitimate) EnterNotify events arrived
512 * with the same sequence and thus were ignored (see ticket #609). */
513 free(xcb_get_input_focus_reply(conn, cookie, NULL));
517 * A destroy notify event is sent when the window is not unmapped, but
518 * immediately destroyed (for example when starting a window and immediately
519 * killing the program which started it).
521 * We just pass on the event to the unmap notify handler (by copying the
522 * important fields in the event data structure).
525 static void handle_destroy_notify_event(xcb_destroy_notify_event_t *event) {
526 DLOG("destroy notify for 0x%08x, 0x%08x\n", event->event, event->window);
528 xcb_unmap_notify_event_t unmap;
529 unmap.sequence = event->sequence;
530 unmap.event = event->event;
531 unmap.window = event->window;
533 handle_unmap_notify_event(&unmap);
536 static bool window_name_changed(i3Window *window, char *old_name) {
537 if ((old_name == NULL) && (window->name == NULL))
540 /* Either the old or the new one is NULL, but not both. */
541 if ((old_name == NULL) ^ (window->name == NULL))
544 return (strcmp(old_name, i3string_as_utf8(window->name)) != 0);
548 * Called when a window changes its title
551 static bool handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
552 xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
554 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
557 char *old_name = (con->window->name != NULL ? sstrdup(i3string_as_utf8(con->window->name)) : NULL);
559 window_update_name(con->window, prop, false);
561 x_push_changes(croot);
563 if (window_name_changed(con->window, old_name))
564 ipc_send_window_event("title", con);
572 * Handles legacy window name updates (WM_NAME), see also src/window.c,
573 * window_update_name_legacy().
576 static bool handle_windowname_change_legacy(void *data, xcb_connection_t *conn, uint8_t state,
577 xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
579 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
582 char *old_name = (con->window->name != NULL ? sstrdup(i3string_as_utf8(con->window->name)) : NULL);
584 window_update_name_legacy(con->window, prop, false);
586 x_push_changes(croot);
588 if (window_name_changed(con->window, old_name))
589 ipc_send_window_event("title", con);
597 * Called when a window changes its WM_WINDOW_ROLE.
600 static bool handle_windowrole_change(void *data, xcb_connection_t *conn, uint8_t state,
601 xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
603 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
606 window_update_role(con->window, prop, false);
613 * Updates the client’s WM_CLASS property
616 static int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
617 xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
619 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
622 window_update_class(con->window, prop, false);
629 * Expose event means we should redraw our windows (= title bar)
632 static void handle_expose_event(xcb_expose_event_t *event) {
635 DLOG("window = %08x\n", event->window);
637 if ((parent = con_by_frame_id(event->window)) == NULL) {
638 LOG("expose event for unknown window, ignoring\n");
642 /* Since we render to our pixmap on every change anyways, expose events
643 * only tell us that the X server lost (parts of) the window contents. We
644 * can handle that by copying the appropriate part from our pixmap to the
646 xcb_copy_area(conn, parent->pixmap, parent->frame, parent->pm_gc,
647 event->x, event->y, event->x, event->y,
648 event->width, event->height);
654 #define _NET_WM_MOVERESIZE_SIZE_TOPLEFT 0
655 #define _NET_WM_MOVERESIZE_SIZE_TOP 1
656 #define _NET_WM_MOVERESIZE_SIZE_TOPRIGHT 2
657 #define _NET_WM_MOVERESIZE_SIZE_RIGHT 3
658 #define _NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT 4
659 #define _NET_WM_MOVERESIZE_SIZE_BOTTOM 5
660 #define _NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT 6
661 #define _NET_WM_MOVERESIZE_SIZE_LEFT 7
662 #define _NET_WM_MOVERESIZE_MOVE 8 /* movement only */
663 #define _NET_WM_MOVERESIZE_SIZE_KEYBOARD 9 /* size via keyboard */
664 #define _NET_WM_MOVERESIZE_MOVE_KEYBOARD 10 /* move via keyboard */
665 #define _NET_WM_MOVERESIZE_CANCEL 11 /* cancel operation */
668 * Handle client messages (EWMH)
671 static void handle_client_message(xcb_client_message_event_t *event) {
672 /* If this is a startup notification ClientMessage, the library will handle
673 * it and call our monitor_event() callback. */
674 if (sn_xcb_display_process_event(sndisplay, (xcb_generic_event_t *)event))
677 LOG("ClientMessage for window 0x%08x\n", event->window);
678 if (event->type == A__NET_WM_STATE) {
679 if (event->format != 32 ||
680 (event->data.data32[1] != A__NET_WM_STATE_FULLSCREEN &&
681 event->data.data32[1] != A__NET_WM_STATE_DEMANDS_ATTENTION)) {
682 DLOG("Unknown atom in clientmessage of type %d\n", event->data.data32[1]);
686 Con *con = con_by_window_id(event->window);
688 DLOG("Could not get window for client message\n");
692 if (event->data.data32[1] == A__NET_WM_STATE_FULLSCREEN) {
693 /* Check if the fullscreen state should be toggled */
694 if ((con->fullscreen_mode != CF_NONE &&
695 (event->data.data32[0] == _NET_WM_STATE_REMOVE ||
696 event->data.data32[0] == _NET_WM_STATE_TOGGLE)) ||
697 (con->fullscreen_mode == CF_NONE &&
698 (event->data.data32[0] == _NET_WM_STATE_ADD ||
699 event->data.data32[0] == _NET_WM_STATE_TOGGLE))) {
700 DLOG("toggling fullscreen\n");
701 con_toggle_fullscreen(con, CF_OUTPUT);
703 } else if (event->data.data32[1] == A__NET_WM_STATE_DEMANDS_ATTENTION) {
704 /* Check if the urgent flag must be set or not */
705 if (event->data.data32[0] == _NET_WM_STATE_ADD)
706 con_set_urgency(con, true);
707 else if (event->data.data32[0] == _NET_WM_STATE_REMOVE)
708 con_set_urgency(con, false);
709 else if (event->data.data32[0] == _NET_WM_STATE_TOGGLE)
710 con_set_urgency(con, !con->urgent);
714 } else if (event->type == A__NET_ACTIVE_WINDOW) {
715 if (event->format != 32)
718 DLOG("_NET_ACTIVE_WINDOW: Window 0x%08x should be activated\n", event->window);
720 Con *con = con_by_window_id(event->window);
722 DLOG("Could not get window for client message\n");
726 Con *ws = con_get_workspace(con);
729 DLOG("Window is not being managed, ignoring _NET_ACTIVE_WINDOW\n");
733 if (con_is_internal(ws)) {
734 DLOG("Workspace is internal, ignoring _NET_ACTIVE_WINDOW\n");
738 /* data32[0] indicates the source of the request (application or pager) */
739 if (event->data.data32[0] == 2) {
740 /* Always focus the con if it is from a pager, because this is most
741 * likely from some user action */
742 DLOG("This request came from a pager. Focusing con = %p\n", con);
746 /* Request is from an application. */
748 if (config.focus_on_window_activation == FOWA_FOCUS || (config.focus_on_window_activation == FOWA_SMART && workspace_is_visible(ws))) {
749 DLOG("Focusing con = %p\n", con);
752 } else if (config.focus_on_window_activation == FOWA_URGENT || (config.focus_on_window_activation == FOWA_SMART && !workspace_is_visible(ws))) {
753 DLOG("Marking con = %p urgent\n", con);
754 con_set_urgency(con, true);
756 DLOG("Ignoring request for con = %p", con);
760 } else if (event->type == A_I3_SYNC) {
761 xcb_window_t window = event->data.data32[0];
762 uint32_t rnd = event->data.data32[1];
763 DLOG("[i3 sync protocol] Sending random value %d back to X11 window 0x%08x\n", rnd, window);
765 void *reply = scalloc(32);
766 xcb_client_message_event_t *ev = reply;
768 ev->response_type = XCB_CLIENT_MESSAGE;
770 ev->type = A_I3_SYNC;
772 ev->data.data32[0] = window;
773 ev->data.data32[1] = rnd;
775 xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
778 } else if (event->type == A__NET_REQUEST_FRAME_EXTENTS) {
780 * A client can request an estimate for the frame size which the window
781 * manager will put around it before actually mapping its window. Java
782 * does this (as of openjdk-7).
784 * Note that the calculation below is not entirely accurate — once you
785 * set a different border type, it’s off. We _could_ request all the
786 * window properties (which have to be set up at this point according
787 * to EWMH), but that seems rather elaborate. The standard explicitly
788 * says the application must cope with an estimate that is not entirely
791 DLOG("_NET_REQUEST_FRAME_EXTENTS for window 0x%08x\n", event->window);
793 /* The reply data: approximate frame size */
795 config.default_border_width, /* left */
796 config.default_border_width, /* right */
797 config.font.height + 5, /* top */
798 config.default_border_width /* bottom */
802 XCB_PROP_MODE_REPLACE,
804 A__NET_FRAME_EXTENTS,
805 XCB_ATOM_CARDINAL, 32, 4,
808 } else if (event->type == A__NET_CURRENT_DESKTOP) {
809 /* This request is used by pagers and bars to change the current
810 * desktop likely as a result of some user action. We interpret this as
811 * a request to focus the given workspace. See
812 * http://standards.freedesktop.org/wm-spec/latest/ar01s03.html#idm140251368135008
816 DLOG("Request to change current desktop to index %d\n", event->data.data32[0]);
818 TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
820 TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
821 if (STARTS_WITH(ws->name, "__"))
824 if (idx == event->data.data32[0]) {
825 /* data32[1] is a timestamp used to prevent focus race conditions */
826 if (event->data.data32[1])
827 last_timestamp = event->data.data32[1];
829 DLOG("Handling request to focus workspace %s\n", ws->name);
840 } else if (event->type == A__NET_CLOSE_WINDOW) {
842 * Pagers wanting to close a window MUST send a _NET_CLOSE_WINDOW
843 * client message request to the root window.
844 * http://standards.freedesktop.org/wm-spec/wm-spec-latest.html#idm140200472668896
846 Con *con = con_by_window_id(event->window);
848 DLOG("Handling _NET_CLOSE_WINDOW request (con = %p)\n", con);
850 if (event->data.data32[0])
851 last_timestamp = event->data.data32[0];
853 tree_close(con, KILL_WINDOW, false, false);
856 DLOG("Couldn't find con for _NET_CLOSE_WINDOW request. (window = %d)\n", event->window);
858 } else if (event->type == A__NET_WM_MOVERESIZE) {
860 * Client-side decorated Gtk3 windows emit this signal when being
861 * dragged by their GtkHeaderBar
863 Con *con = con_by_window_id(event->window);
864 if (!con || !con_is_floating(con)) {
865 DLOG("Couldn't find con for _NET_WM_MOVERESIZE request, or con not floating (window = %d)\n", event->window);
868 DLOG("Handling _NET_WM_MOVERESIZE request (con = %p)\n", con);
869 uint32_t direction = event->data.data32[2];
870 uint32_t x_root = event->data.data32[0];
871 uint32_t y_root = event->data.data32[1];
872 /* construct fake xcb_button_press_event_t */
873 xcb_button_press_event_t fake = {
876 .event_x = x_root - (con->rect.x),
877 .event_y = y_root - (con->rect.y)};
879 case _NET_WM_MOVERESIZE_MOVE:
880 floating_drag_window(con->parent, &fake);
882 case _NET_WM_MOVERESIZE_SIZE_TOPLEFT... _NET_WM_MOVERESIZE_SIZE_LEFT:
883 floating_resize_window(con->parent, false, &fake);
886 DLOG("_NET_WM_MOVERESIZE direction %d not implemented\n", direction);
890 DLOG("unhandled clientmessage\n");
895 bool handle_window_type(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
896 xcb_atom_t atom, xcb_get_property_reply_t *reply) {
898 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
901 window_update_type(con->window, reply);
906 * Handles the size hints set by a window, but currently only the part necessary for displaying
907 * clients proportionally inside their frames (mplayer for example)
909 * See ICCCM 4.1.2.3 for more details
912 static bool handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
913 xcb_atom_t name, xcb_get_property_reply_t *reply) {
914 Con *con = con_by_window_id(window);
916 DLOG("Received WM_NORMAL_HINTS for unknown client\n");
920 xcb_size_hints_t size_hints;
922 //CLIENT_LOG(client);
924 /* If the hints were already in this event, use them, if not, request them */
926 xcb_icccm_get_wm_size_hints_from_reply(&size_hints, reply);
928 xcb_icccm_get_wm_normal_hints_reply(conn, xcb_icccm_get_wm_normal_hints_unchecked(conn, con->window->id), &size_hints, NULL);
930 if ((size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE)) {
931 // TODO: Minimum size is not yet implemented
932 DLOG("Minimum size: %d (width) x %d (height)\n", size_hints.min_width, size_hints.min_height);
935 bool changed = false;
936 if ((size_hints.flags & XCB_ICCCM_SIZE_HINT_P_RESIZE_INC)) {
937 if (size_hints.width_inc > 0 && size_hints.width_inc < 0xFFFF)
938 if (con->width_increment != size_hints.width_inc) {
939 con->width_increment = size_hints.width_inc;
942 if (size_hints.height_inc > 0 && size_hints.height_inc < 0xFFFF)
943 if (con->height_increment != size_hints.height_inc) {
944 con->height_increment = size_hints.height_inc;
949 DLOG("resize increments changed\n");
952 int base_width = 0, base_height = 0;
954 /* base_width/height are the desired size of the window.
955 We check if either the program-specified size or the program-specified
956 min-size is available */
957 if (size_hints.flags & XCB_ICCCM_SIZE_HINT_BASE_SIZE) {
958 base_width = size_hints.base_width;
959 base_height = size_hints.base_height;
960 } else if (size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE) {
961 /* TODO: is this right? icccm says not */
962 base_width = size_hints.min_width;
963 base_height = size_hints.min_height;
966 if (base_width != con->base_width ||
967 base_height != con->base_height) {
968 con->base_width = base_width;
969 con->base_height = base_height;
970 DLOG("client's base_height changed to %d\n", base_height);
971 DLOG("client's base_width changed to %d\n", base_width);
975 /* If no aspect ratio was set or if it was invalid, we ignore the hints */
976 if (!(size_hints.flags & XCB_ICCCM_SIZE_HINT_P_ASPECT) ||
977 (size_hints.min_aspect_num <= 0) ||
978 (size_hints.min_aspect_den <= 0)) {
979 goto render_and_return;
982 /* XXX: do we really use rect here, not window_rect? */
983 double width = con->rect.width - base_width;
984 double height = con->rect.height - base_height;
985 /* Convert numerator/denominator to a double */
986 double min_aspect = (double)size_hints.min_aspect_num / size_hints.min_aspect_den;
987 double max_aspect = (double)size_hints.max_aspect_num / size_hints.min_aspect_den;
989 DLOG("Aspect ratio set: minimum %f, maximum %f\n", min_aspect, max_aspect);
990 DLOG("width = %f, height = %f\n", width, height);
992 /* Sanity checks, this is user-input, in a way */
993 if (max_aspect <= 0 || min_aspect <= 0 || height == 0 || (width / height) <= 0)
994 goto render_and_return;
996 /* Check if we need to set proportional_* variables using the correct ratio */
997 double aspect_ratio = 0.0;
998 if ((width / height) < min_aspect) {
999 aspect_ratio = min_aspect;
1000 } else if ((width / height) > max_aspect) {
1001 aspect_ratio = max_aspect;
1003 goto render_and_return;
1005 if (fabs(con->aspect_ratio - aspect_ratio) > DBL_EPSILON) {
1006 con->aspect_ratio = aspect_ratio;
1018 * Handles the WM_HINTS property for extracting the urgency state of the window.
1021 static bool handle_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
1022 xcb_atom_t name, xcb_get_property_reply_t *reply) {
1023 Con *con = con_by_window_id(window);
1025 DLOG("Received WM_HINTS for unknown client\n");
1031 reply = xcb_get_property_reply(conn, xcb_icccm_get_wm_hints(conn, window), NULL);
1032 window_update_hints(con->window, reply, &urgency_hint);
1033 con_set_urgency(con, urgency_hint);
1040 * Handles the transient for hints set by a window, signalizing that this window is a popup window
1041 * for some other window.
1043 * See ICCCM 4.1.2.6 for more details
1046 static bool handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
1047 xcb_atom_t name, xcb_get_property_reply_t *prop) {
1050 if ((con = con_by_window_id(window)) == NULL || con->window == NULL) {
1051 DLOG("No such window\n");
1056 prop = xcb_get_property_reply(conn, xcb_get_property_unchecked(conn,
1057 false, window, XCB_ATOM_WM_TRANSIENT_FOR, XCB_ATOM_WINDOW, 0, 32),
1063 window_update_transient_for(con->window, prop);
1069 * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
1070 * toolwindow (or similar) and to which window it belongs (logical parent).
1073 static bool handle_clientleader_change(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
1074 xcb_atom_t name, xcb_get_property_reply_t *prop) {
1076 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
1080 prop = xcb_get_property_reply(conn, xcb_get_property_unchecked(conn,
1081 false, window, A_WM_CLIENT_LEADER, XCB_ATOM_WINDOW, 0, 32),
1087 window_update_leader(con->window, prop);
1093 * Handles FocusIn events which are generated by clients (i3’s focus changes
1094 * don’t generate FocusIn events due to a different EventMask) and updates the
1095 * decorations accordingly.
1098 static void handle_focus_in(xcb_focus_in_event_t *event) {
1099 DLOG("focus change in, for window 0x%08x\n", event->event);
1101 if ((con = con_by_window_id(event->event)) == NULL || con->window == NULL)
1103 DLOG("That is con %p / %s\n", con, con->name);
1105 if (event->mode == XCB_NOTIFY_MODE_GRAB ||
1106 event->mode == XCB_NOTIFY_MODE_UNGRAB) {
1107 DLOG("FocusIn event for grab/ungrab, ignoring\n");
1111 if (event->detail == XCB_NOTIFY_DETAIL_POINTER) {
1112 DLOG("notify detail is pointer, ignoring this event\n");
1116 if (focused_id == event->event) {
1117 DLOG("focus matches the currently focused window, not doing anything\n");
1121 /* Skip dock clients, they cannot get the i3 focus. */
1122 if (con->parent->type == CT_DOCKAREA) {
1123 DLOG("This is a dock client, not focusing.\n");
1127 DLOG("focus is different, updating decorations\n");
1129 /* Get the currently focused workspace to check if the focus change also
1130 * involves changing workspaces. If so, we need to call workspace_show() to
1131 * correctly update state and send the IPC event. */
1132 Con *ws = con_get_workspace(con);
1133 if (ws != con_get_workspace(focused))
1137 /* We update focused_id because we don’t need to set focus again */
1138 focused_id = event->event;
1139 x_push_changes(croot);
1144 * Handles the WM_CLASS property for assignments and criteria selection.
1147 static bool handle_class_change(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
1148 xcb_atom_t name, xcb_get_property_reply_t *prop) {
1150 if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
1154 prop = xcb_get_property_reply(conn, xcb_get_property_unchecked(conn,
1155 false, window, XCB_ATOM_WM_CLASS, XCB_ATOM_STRING, 0, 32),
1162 window_update_class(con->window, prop, false);
1168 * Handles the _NET_WM_STRUT_PARTIAL property for allocating space for dock clients.
1171 static bool handle_strut_partial_change(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
1172 xcb_atom_t name, xcb_get_property_reply_t *prop) {
1173 DLOG("strut partial change for window 0x%08x\n", window);
1176 if ((con = con_by_window_id(window)) == NULL || con->window == NULL) {
1181 xcb_generic_error_t *err = NULL;
1182 xcb_get_property_cookie_t strut_cookie = xcb_get_property(conn, false, window, A__NET_WM_STRUT_PARTIAL,
1183 XCB_GET_PROPERTY_TYPE_ANY, 0, UINT32_MAX);
1184 prop = xcb_get_property_reply(conn, strut_cookie, &err);
1187 DLOG("got error when getting strut partial property: %d\n", err->error_code);
1197 DLOG("That is con %p / %s\n", con, con->name);
1199 window_update_strut_partial(con->window, prop);
1201 /* we only handle this change for dock clients */
1202 if (con->parent == NULL || con->parent->type != CT_DOCKAREA) {
1206 Con *search_at = croot;
1207 Con *output = con_get_output(con);
1208 if (output != NULL) {
1209 DLOG("Starting search at output %s\n", output->name);
1213 /* find out the desired position of this dock window */
1214 if (con->window->reserved.top > 0 && con->window->reserved.bottom == 0) {
1215 DLOG("Top dock client\n");
1216 con->window->dock = W_DOCK_TOP;
1217 } else if (con->window->reserved.top == 0 && con->window->reserved.bottom > 0) {
1218 DLOG("Bottom dock client\n");
1219 con->window->dock = W_DOCK_BOTTOM;
1221 DLOG("Ignoring invalid reserved edges (_NET_WM_STRUT_PARTIAL), using position as fallback:\n");
1222 if (con->geometry.y < (search_at->rect.height / 2)) {
1223 DLOG("geom->y = %d < rect.height / 2 = %d, it is a top dock client\n",
1224 con->geometry.y, (search_at->rect.height / 2));
1225 con->window->dock = W_DOCK_TOP;
1227 DLOG("geom->y = %d >= rect.height / 2 = %d, it is a bottom dock client\n",
1228 con->geometry.y, (search_at->rect.height / 2));
1229 con->window->dock = W_DOCK_BOTTOM;
1233 /* find the dockarea */
1234 Con *dockarea = con_for_window(search_at, con->window, NULL);
1235 assert(dockarea != NULL);
1237 /* attach the dock to the dock area */
1239 con->parent = dockarea;
1240 TAILQ_INSERT_HEAD(&(dockarea->focus_head), con, focused);
1241 TAILQ_INSERT_HEAD(&(dockarea->nodes_head), con, nodes);
1248 /* Returns false if the event could not be processed (e.g. the window could not
1249 * be found), true otherwise */
1250 typedef bool (*cb_property_handler_t)(void *data, xcb_connection_t *c, uint8_t state, xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *property);
1252 struct property_handler_t {
1255 cb_property_handler_t cb;
1258 static struct property_handler_t property_handlers[] = {
1259 {0, 128, handle_windowname_change},
1260 {0, UINT_MAX, handle_hints},
1261 {0, 128, handle_windowname_change_legacy},
1262 {0, UINT_MAX, handle_normal_hints},
1263 {0, UINT_MAX, handle_clientleader_change},
1264 {0, UINT_MAX, handle_transient_for},
1265 {0, 128, handle_windowrole_change},
1266 {0, 128, handle_class_change},
1267 {0, UINT_MAX, handle_strut_partial_change},
1268 {0, UINT_MAX, handle_window_type}};
1269 #define NUM_HANDLERS (sizeof(property_handlers) / sizeof(struct property_handler_t))
1272 * Sets the appropriate atoms for the property handlers after the atoms were
1276 void property_handlers_init(void) {
1277 sn_monitor_context_new(sndisplay, conn_screen, startup_monitor_event, NULL, NULL);
1279 property_handlers[0].atom = A__NET_WM_NAME;
1280 property_handlers[1].atom = XCB_ATOM_WM_HINTS;
1281 property_handlers[2].atom = XCB_ATOM_WM_NAME;
1282 property_handlers[3].atom = XCB_ATOM_WM_NORMAL_HINTS;
1283 property_handlers[4].atom = A_WM_CLIENT_LEADER;
1284 property_handlers[5].atom = XCB_ATOM_WM_TRANSIENT_FOR;
1285 property_handlers[6].atom = A_WM_WINDOW_ROLE;
1286 property_handlers[7].atom = XCB_ATOM_WM_CLASS;
1287 property_handlers[8].atom = A__NET_WM_STRUT_PARTIAL;
1288 property_handlers[9].atom = A__NET_WM_WINDOW_TYPE;
1291 static void property_notify(uint8_t state, xcb_window_t window, xcb_atom_t atom) {
1292 struct property_handler_t *handler = NULL;
1293 xcb_get_property_reply_t *propr = NULL;
1295 for (size_t c = 0; c < sizeof(property_handlers) / sizeof(struct property_handler_t); c++) {
1296 if (property_handlers[c].atom != atom)
1299 handler = &property_handlers[c];
1303 if (handler == NULL) {
1304 //DLOG("Unhandled property notify for atom %d (0x%08x)\n", atom, atom);
1308 if (state != XCB_PROPERTY_DELETE) {
1309 xcb_get_property_cookie_t cookie = xcb_get_property(conn, 0, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, handler->long_len);
1310 propr = xcb_get_property_reply(conn, cookie, 0);
1313 /* the handler will free() the reply unless it returns false */
1314 if (!handler->cb(NULL, conn, state, window, atom, propr))
1319 * Takes an xcb_generic_event_t and calls the appropriate handler, based on the
1323 void handle_event(int type, xcb_generic_event_t *event) {
1324 DLOG("event type %d, xkb_base %d\n", type, xkb_base);
1325 if (randr_base > -1 &&
1326 type == randr_base + XCB_RANDR_SCREEN_CHANGE_NOTIFY) {
1327 handle_screen_change(event);
1331 if (xkb_base > -1 && type == xkb_base) {
1332 DLOG("xkb event, need to handle it.\n");
1334 xcb_xkb_state_notify_event_t *state = (xcb_xkb_state_notify_event_t *)event;
1335 if (state->xkbType == XCB_XKB_NEW_KEYBOARD_NOTIFY) {
1336 DLOG("xkb new keyboard notify, sequence %d, time %d\n", state->sequence, state->time);
1337 xcb_key_symbols_free(keysyms);
1338 keysyms = xcb_key_symbols_alloc(conn);
1339 ungrab_all_keys(conn);
1340 translate_keysyms();
1341 grab_all_keys(conn, false);
1342 } else if (state->xkbType == XCB_XKB_MAP_NOTIFY) {
1343 if (event_is_ignored(event->sequence, type)) {
1344 DLOG("Ignoring map notify event for sequence %d.\n", state->sequence);
1346 DLOG("xkb map notify, sequence %d, time %d\n", state->sequence, state->time);
1347 add_ignore_event(event->sequence, type);
1348 xcb_key_symbols_free(keysyms);
1349 keysyms = xcb_key_symbols_alloc(conn);
1350 ungrab_all_keys(conn);
1351 translate_keysyms();
1352 grab_all_keys(conn, false);
1354 } else if (state->xkbType == XCB_XKB_STATE_NOTIFY) {
1355 DLOG("xkb state group = %d\n", state->group);
1357 /* See The XKB Extension: Library Specification, section 14.1 */
1358 /* We check if the current group (each group contains
1359 * two levels) has been changed. Mode_switch activates
1360 * group XCB_XKB_GROUP_2 */
1361 if (xkb_current_group == state->group)
1363 xkb_current_group = state->group;
1364 if (state->group == XCB_XKB_GROUP_1) {
1365 DLOG("Mode_switch disabled\n");
1366 ungrab_all_keys(conn);
1367 grab_all_keys(conn, false);
1369 DLOG("Mode_switch enabled\n");
1370 grab_all_keys(conn, true);
1379 case XCB_KEY_RELEASE:
1380 handle_key_press((xcb_key_press_event_t *)event);
1383 case XCB_BUTTON_PRESS:
1384 case XCB_BUTTON_RELEASE:
1385 handle_button_press((xcb_button_press_event_t *)event);
1388 case XCB_MAP_REQUEST:
1389 handle_map_request((xcb_map_request_event_t *)event);
1392 case XCB_UNMAP_NOTIFY:
1393 handle_unmap_notify_event((xcb_unmap_notify_event_t *)event);
1396 case XCB_DESTROY_NOTIFY:
1397 handle_destroy_notify_event((xcb_destroy_notify_event_t *)event);
1401 handle_expose_event((xcb_expose_event_t *)event);
1404 case XCB_MOTION_NOTIFY:
1405 handle_motion_notify((xcb_motion_notify_event_t *)event);
1408 /* Enter window = user moved their mouse over the window */
1409 case XCB_ENTER_NOTIFY:
1410 handle_enter_notify((xcb_enter_notify_event_t *)event);
1413 /* Client message are sent to the root window. The only interesting
1414 * client message for us is _NET_WM_STATE, we honour
1415 * _NET_WM_STATE_FULLSCREEN and _NET_WM_STATE_DEMANDS_ATTENTION */
1416 case XCB_CLIENT_MESSAGE:
1417 handle_client_message((xcb_client_message_event_t *)event);
1420 /* Configure request = window tried to change size on its own */
1421 case XCB_CONFIGURE_REQUEST:
1422 handle_configure_request((xcb_configure_request_event_t *)event);
1425 /* Mapping notify = keyboard mapping changed (Xmodmap), re-grab bindings */
1426 case XCB_MAPPING_NOTIFY:
1427 handle_mapping_notify((xcb_mapping_notify_event_t *)event);
1431 handle_focus_in((xcb_focus_in_event_t *)event);
1434 case XCB_PROPERTY_NOTIFY: {
1435 xcb_property_notify_event_t *e = (xcb_property_notify_event_t *)event;
1436 last_timestamp = e->time;
1437 property_notify(e->state, e->window, e->atom);
1442 //DLOG("Unhandled event of type %d\n", type);