i3
handlers.c
Go to the documentation of this file.
1 #undef I3__FILE__
2 #define I3__FILE__ "handlers.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * handlers.c: Small handlers for various events (keypresses, focus changes,
10  * …).
11  *
12  */
13 #include "all.h"
14 
15 #include <time.h>
16 #include <float.h>
17 #include <sys/time.h>
18 #include <xcb/randr.h>
19 #include <X11/XKBlib.h>
20 #define SN_API_NOT_YET_FROZEN 1
21 #include <libsn/sn-monitor.h>
22 
23 int randr_base = -1;
24 
25 /* After mapping/unmapping windows, a notify event is generated. However, we don’t want it,
26  since it’d trigger an infinite loop of switching between the different windows when
27  changing workspaces */
28 static SLIST_HEAD(ignore_head, Ignore_Event) ignore_events;
29 
30 /*
31  * Adds the given sequence to the list of events which are ignored.
32  * If this ignore should only affect a specific response_type, pass
33  * response_type, otherwise, pass -1.
34  *
35  * Every ignored sequence number gets garbage collected after 5 seconds.
36  *
37  */
38 void add_ignore_event(const int sequence, const int response_type) {
39  struct Ignore_Event *event = smalloc(sizeof(struct Ignore_Event));
40 
41  event->sequence = sequence;
42  event->response_type = response_type;
43  event->added = time(NULL);
44 
45  SLIST_INSERT_HEAD(&ignore_events, event, ignore_events);
46 }
47 
48 /*
49  * Checks if the given sequence is ignored and returns true if so.
50  *
51  */
52 bool event_is_ignored(const int sequence, const int response_type) {
53  struct Ignore_Event *event;
54  time_t now = time(NULL);
55  for (event = SLIST_FIRST(&ignore_events); event != SLIST_END(&ignore_events);) {
56  if ((now - event->added) > 5) {
57  struct Ignore_Event *save = event;
58  event = SLIST_NEXT(event, ignore_events);
59  SLIST_REMOVE(&ignore_events, save, Ignore_Event, ignore_events);
60  free(save);
61  } else event = SLIST_NEXT(event, ignore_events);
62  }
63 
64  SLIST_FOREACH(event, &ignore_events, ignore_events) {
65  if (event->sequence != sequence)
66  continue;
67 
68  if (event->response_type != -1 &&
69  event->response_type != response_type)
70  continue;
71 
72  /* instead of removing a sequence number we better wait until it gets
73  * garbage collected. it may generate multiple events (there are multiple
74  * enter_notifies for one configure_request, for example). */
75  //SLIST_REMOVE(&ignore_events, event, Ignore_Event, ignore_events);
76  //free(event);
77  return true;
78  }
79 
80  return false;
81 }
82 
83 /*
84  * Called with coordinates of an enter_notify event or motion_notify event
85  * to check if the user crossed virtual screen boundaries and adjust the
86  * current workspace, if so.
87  *
88  */
89 static void check_crossing_screen_boundary(uint32_t x, uint32_t y) {
90  Output *output;
91 
92  /* If the user disable focus follows mouse, we have nothing to do here */
94  return;
95 
96  if ((output = get_output_containing(x, y)) == NULL) {
97  ELOG("ERROR: No such screen\n");
98  return;
99  }
100 
101  if (output->con == NULL) {
102  ELOG("ERROR: The screen is not recognized by i3 (no container associated)\n");
103  return;
104  }
105 
106  /* Focus the output on which the user moved his cursor */
107  Con *old_focused = focused;
108  Con *next = con_descend_focused(output_get_content(output->con));
109  /* Since we are switching outputs, this *must* be a different workspace, so
110  * call workspace_show() */
112  con_focus(next);
113 
114  /* If the focus changed, we re-render to get updated decorations */
115  if (old_focused != focused)
116  tree_render();
117 }
118 
119 /*
120  * When the user moves the mouse pointer onto a window, this callback gets called.
121  *
122  */
123 static void handle_enter_notify(xcb_enter_notify_event_t *event) {
124  Con *con;
125 
126  last_timestamp = event->time;
127 
128  DLOG("enter_notify for %08x, mode = %d, detail %d, serial %d\n",
129  event->event, event->mode, event->detail, event->sequence);
130  DLOG("coordinates %d, %d\n", event->event_x, event->event_y);
131  if (event->mode != XCB_NOTIFY_MODE_NORMAL) {
132  DLOG("This was not a normal notify, ignoring\n");
133  return;
134  }
135  /* Some events are not interesting, because they were not generated
136  * actively by the user, but by reconfiguration of windows */
137  if (event_is_ignored(event->sequence, XCB_ENTER_NOTIFY)) {
138  DLOG("Event ignored\n");
139  return;
140  }
141 
142  bool enter_child = false;
143  /* Get container by frame or by child window */
144  if ((con = con_by_frame_id(event->event)) == NULL) {
145  con = con_by_window_id(event->event);
146  enter_child = true;
147  }
148 
149  /* If not, then the user moved his cursor to the root window. In that case, we adjust c_ws */
150  if (con == NULL) {
151  DLOG("Getting screen at %d x %d\n", event->root_x, event->root_y);
152  check_crossing_screen_boundary(event->root_x, event->root_y);
153  return;
154  }
155 
156  if (con->parent->type == CT_DOCKAREA) {
157  DLOG("Ignoring, this is a dock client\n");
158  return;
159  }
160 
161  /* see if the user entered the window on a certain window decoration */
162  layout_t layout = (enter_child ? con->parent->layout : con->layout);
163  if (layout == L_DEFAULT) {
164  Con *child;
165  TAILQ_FOREACH(child, &(con->nodes_head), nodes)
166  if (rect_contains(child->deco_rect, event->event_x, event->event_y)) {
167  LOG("using child %p / %s instead!\n", child, child->name);
168  con = child;
169  break;
170  }
171  }
172 
173 #if 0
174  if (client->workspace != c_ws && client->workspace->output == c_ws->output) {
175  /* This can happen when a client gets assigned to a different workspace than
176  * the current one (see src/mainx.c:reparent_window). Shortly after it was created,
177  * an enter_notify will follow. */
178  DLOG("enter_notify for a client on a different workspace but the same screen, ignoring\n");
179  return 1;
180  }
181 #endif
182 
184  return;
185 
186  /* Get the currently focused workspace to check if the focus change also
187  * involves changing workspaces. If so, we need to call workspace_show() to
188  * correctly update state and send the IPC event. */
189  Con *ws = con_get_workspace(con);
190  if (ws != con_get_workspace(focused))
191  workspace_show(ws);
192 
193  focused_id = XCB_NONE;
195  tree_render();
196 
197  return;
198 }
199 
200 /*
201  * When the user moves the mouse but does not change the active window
202  * (e.g. when having no windows opened but moving mouse on the root screen
203  * and crossing virtual screen boundaries), this callback gets called.
204  *
205  */
206 static void handle_motion_notify(xcb_motion_notify_event_t *event) {
207 
208  last_timestamp = event->time;
209 
210  /* Skip events where the pointer was over a child window, we are only
211  * interested in events on the root window. */
212  if (event->child != 0)
213  return;
214 
215  Con *con;
216  if ((con = con_by_frame_id(event->event)) == NULL) {
217  DLOG("MotionNotify for an unknown container, checking if it crosses screen boundaries.\n");
218  check_crossing_screen_boundary(event->root_x, event->root_y);
219  return;
220  }
221 
223  return;
224 
225  if (con->layout != L_DEFAULT)
226  return;
227 
228  /* see over which rect the user is */
229  Con *current;
230  TAILQ_FOREACH(current, &(con->nodes_head), nodes) {
231  if (!rect_contains(current->deco_rect, event->event_x, event->event_y))
232  continue;
233 
234  /* We found the rect, let’s see if this window is focused */
235  if (TAILQ_FIRST(&(con->focus_head)) == current)
236  return;
237 
238  con_focus(current);
240  return;
241  }
242 
243  return;
244 }
245 
246 /*
247  * Called when the keyboard mapping changes (for example by using Xmodmap),
248  * we need to update our key bindings then (re-translate symbols).
249  *
250  */
251 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
252  if (event->request != XCB_MAPPING_KEYBOARD &&
253  event->request != XCB_MAPPING_MODIFIER)
254  return;
255 
256  DLOG("Received mapping_notify for keyboard or modifier mapping, re-grabbing keys\n");
257  xcb_refresh_keyboard_mapping(keysyms, event);
258 
260 
263  grab_all_keys(conn, false);
264 
265  return;
266 }
267 
268 /*
269  * A new window appeared on the screen (=was mapped), so let’s manage it.
270  *
271  */
272 static void handle_map_request(xcb_map_request_event_t *event) {
273  xcb_get_window_attributes_cookie_t cookie;
274 
275  cookie = xcb_get_window_attributes_unchecked(conn, event->window);
276 
277  DLOG("window = 0x%08x, serial is %d.\n", event->window, event->sequence);
278  add_ignore_event(event->sequence, -1);
279 
280  manage_window(event->window, cookie, false);
282  return;
283 }
284 
285 /*
286  * Configure requests are received when the application wants to resize windows
287  * on their own.
288  *
289  * We generate a synthethic configure notify event to signalize the client its
290  * "new" position.
291  *
292  */
293 static void handle_configure_request(xcb_configure_request_event_t *event) {
294  Con *con;
295 
296  DLOG("window 0x%08x wants to be at %dx%d with %dx%d\n",
297  event->window, event->x, event->y, event->width, event->height);
298 
299  /* For unmanaged windows, we just execute the configure request. As soon as
300  * it gets mapped, we will take over anyways. */
301  if ((con = con_by_window_id(event->window)) == NULL) {
302  DLOG("Configure request for unmanaged window, can do that.\n");
303 
304  uint32_t mask = 0;
305  uint32_t values[7];
306  int c = 0;
307 #define COPY_MASK_MEMBER(mask_member, event_member) do { \
308  if (event->value_mask & mask_member) { \
309  mask |= mask_member; \
310  values[c++] = event->event_member; \
311  } \
312 } while (0)
313 
314  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_X, x);
315  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_Y, y);
316  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_WIDTH, width);
317  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_HEIGHT, height);
318  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_BORDER_WIDTH, border_width);
319  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_SIBLING, sibling);
320  COPY_MASK_MEMBER(XCB_CONFIG_WINDOW_STACK_MODE, stack_mode);
321 
322  xcb_configure_window(conn, event->window, mask, values);
323  xcb_flush(conn);
324 
325  return;
326  }
327 
328  DLOG("Configure request!\n");
329 
330  Con *workspace = con_get_workspace(con),
331  *fullscreen = NULL;
332 
333  /* There might not be a corresponding workspace for dock cons, therefore we
334  * have to be careful here. */
335  if (workspace) {
336  fullscreen = con_get_fullscreen_con(workspace, CF_OUTPUT);
337  if (!fullscreen)
338  fullscreen = con_get_fullscreen_con(workspace, CF_GLOBAL);
339  }
340 
341  if (fullscreen != con && con_is_floating(con) && con_is_leaf(con)) {
342  /* find the height for the decorations */
343  int deco_height = con->deco_rect.height;
344  /* we actually need to apply the size/position changes to the *parent*
345  * container */
346  Rect bsr = con_border_style_rect(con);
347  if (con->border_style == BS_NORMAL) {
348  bsr.y += deco_height;
349  bsr.height -= deco_height;
350  }
351  Con *floatingcon = con->parent;
352 
353  if (strcmp(con_get_workspace(floatingcon)->name, "__i3_scratch") == 0) {
354  DLOG("This is a scratchpad container, ignoring ConfigureRequest\n");
355  return;
356  }
357 
358  Rect newrect = floatingcon->rect;
359 
360  if (event->value_mask & XCB_CONFIG_WINDOW_X) {
361  newrect.x = event->x + (-1) * bsr.x;
362  DLOG("proposed x = %d, new x is %d\n", event->x, newrect.x);
363  }
364  if (event->value_mask & XCB_CONFIG_WINDOW_Y) {
365  newrect.y = event->y + (-1) * bsr.y;
366  DLOG("proposed y = %d, new y is %d\n", event->y, newrect.y);
367  }
368  if (event->value_mask & XCB_CONFIG_WINDOW_WIDTH) {
369  newrect.width = event->width + (-1) * bsr.width;
370  newrect.width += con->border_width * 2;
371  DLOG("proposed width = %d, new width is %d (x11 border %d)\n",
372  event->width, newrect.width, con->border_width);
373  }
374  if (event->value_mask & XCB_CONFIG_WINDOW_HEIGHT) {
375  newrect.height = event->height + (-1) * bsr.height;
376  newrect.height += con->border_width * 2;
377  DLOG("proposed height = %d, new height is %d (x11 border %d)\n",
378  event->height, newrect.height, con->border_width);
379  }
380 
381  DLOG("Container is a floating leaf node, will do that.\n");
382  floating_reposition(floatingcon, newrect);
383  return;
384  }
385 
386  /* Dock windows can be reconfigured in their height */
387  if (con->parent && con->parent->type == CT_DOCKAREA) {
388  DLOG("Dock window, only height reconfiguration allowed\n");
389  if (event->value_mask & XCB_CONFIG_WINDOW_HEIGHT) {
390  DLOG("Height given, changing\n");
391 
392  con->geometry.height = event->height;
393  tree_render();
394  }
395  }
396 
398 
399  return;
400 }
401 #if 0
402 
403 /*
404  * Configuration notifies are only handled because we need to set up ignore for
405  * the following enter notify events.
406  *
407  */
408 int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event) {
409  DLOG("configure_event, sequence %d\n", event->sequence);
410  /* We ignore this sequence twice because events for child and frame should be ignored */
411  add_ignore_event(event->sequence);
412  add_ignore_event(event->sequence);
413 
414  return 1;
415 }
416 #endif
417 
418 /*
419  * Gets triggered upon a RandR screen change event, that is when the user
420  * changes the screen configuration in any way (mode, position, …)
421  *
422  */
423 static void handle_screen_change(xcb_generic_event_t *e) {
424  DLOG("RandR screen change\n");
425 
426  /* The geometry of the root window is used for “fullscreen global” and
427  * changes when new outputs are added. */
428  xcb_get_geometry_cookie_t cookie = xcb_get_geometry(conn, root);
429  xcb_get_geometry_reply_t *reply = xcb_get_geometry_reply(conn, cookie, NULL);
430  if (reply == NULL) {
431  ELOG("Could not get geometry of the root window, exiting\n");
432  exit(1);
433  }
434  DLOG("root geometry reply: (%d, %d) %d x %d\n", reply->x, reply->y, reply->width, reply->height);
435 
436  croot->rect.width = reply->width;
437  croot->rect.height = reply->height;
438 
440 
442 
443  ipc_send_event("output", I3_IPC_EVENT_OUTPUT, "{\"change\":\"unspecified\"}");
444 
445  return;
446 }
447 
448 /*
449  * Our window decorations were unmapped. That means, the window will be killed
450  * now, so we better clean up before.
451  *
452  */
453 static void handle_unmap_notify_event(xcb_unmap_notify_event_t *event) {
454  DLOG("UnmapNotify for 0x%08x (received from 0x%08x), serial %d\n", event->window, event->event, event->sequence);
455  xcb_get_input_focus_cookie_t cookie;
456  Con *con = con_by_window_id(event->window);
457  if (con == NULL) {
458  /* This could also be an UnmapNotify for the frame. We need to
459  * decrement the ignore_unmap counter. */
460  con = con_by_frame_id(event->window);
461  if (con == NULL) {
462  LOG("Not a managed window, ignoring UnmapNotify event\n");
463  return;
464  }
465 
466  if (con->ignore_unmap > 0)
467  con->ignore_unmap--;
468  /* See the end of this function. */
469  cookie = xcb_get_input_focus(conn);
470  DLOG("ignore_unmap = %d for frame of container %p\n", con->ignore_unmap, con);
471  goto ignore_end;
472  }
473 
474  /* See the end of this function. */
475  cookie = xcb_get_input_focus(conn);
476 
477  if (con->ignore_unmap > 0) {
478  DLOG("ignore_unmap = %d, dec\n", con->ignore_unmap);
479  con->ignore_unmap--;
480  goto ignore_end;
481  }
482 
483  tree_close(con, DONT_KILL_WINDOW, false, false);
484  tree_render();
486 
487 ignore_end:
488  /* If the client (as opposed to i3) destroyed or unmapped a window, an
489  * EnterNotify event will follow (indistinguishable from an EnterNotify
490  * event caused by moving your mouse), causing i3 to set focus to whichever
491  * window is now visible.
492  *
493  * In a complex stacked or tabbed layout (take two v-split containers in a
494  * tabbed container), when the bottom window in tab2 is closed, the bottom
495  * window of tab1 is visible instead. X11 will thus send an EnterNotify
496  * event for the bottom window of tab1, while the focus should be set to
497  * the remaining window of tab2.
498  *
499  * Therefore, we ignore all EnterNotify events which have the same sequence
500  * as an UnmapNotify event. */
501  add_ignore_event(event->sequence, XCB_ENTER_NOTIFY);
502 
503  /* Since we just ignored the sequence of this UnmapNotify, we want to make
504  * sure that following events use a different sequence. When putting xterm
505  * into fullscreen and moving the pointer to a different window, without
506  * using GetInputFocus, subsequent (legitimate) EnterNotify events arrived
507  * with the same sequence and thus were ignored (see ticket #609). */
508  free(xcb_get_input_focus_reply(conn, cookie, NULL));
509 }
510 
511 /*
512  * A destroy notify event is sent when the window is not unmapped, but
513  * immediately destroyed (for example when starting a window and immediately
514  * killing the program which started it).
515  *
516  * We just pass on the event to the unmap notify handler (by copying the
517  * important fields in the event data structure).
518  *
519  */
520 static void handle_destroy_notify_event(xcb_destroy_notify_event_t *event) {
521  DLOG("destroy notify for 0x%08x, 0x%08x\n", event->event, event->window);
522 
523  xcb_unmap_notify_event_t unmap;
524  unmap.sequence = event->sequence;
525  unmap.event = event->event;
526  unmap.window = event->window;
527 
529 }
530 
531 /*
532  * Called when a window changes its title
533  *
534  */
535 static bool handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
536  xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
537  Con *con;
538  if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
539  return false;
540 
541  window_update_name(con->window, prop, false);
542 
544 
545  return true;
546 }
547 
548 /*
549  * Handles legacy window name updates (WM_NAME), see also src/window.c,
550  * window_update_name_legacy().
551  *
552  */
553 static bool handle_windowname_change_legacy(void *data, xcb_connection_t *conn, uint8_t state,
554  xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
555  Con *con;
556  if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
557  return false;
558 
559  window_update_name_legacy(con->window, prop, false);
560 
562 
563  return true;
564 }
565 
566 /*
567  * Called when a window changes its WM_WINDOW_ROLE.
568  *
569  */
570 static bool handle_windowrole_change(void *data, xcb_connection_t *conn, uint8_t state,
571  xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
572  Con *con;
573  if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
574  return false;
575 
576  window_update_role(con->window, prop, false);
577 
578  return true;
579 }
580 
581 #if 0
582 /*
583  * Updates the client’s WM_CLASS property
584  *
585  */
586 static int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
587  xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop) {
588  Con *con;
589  if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
590  return 1;
591 
592  window_update_class(con->window, prop, false);
593 
594  return 0;
595 }
596 #endif
597 
598 /*
599  * Expose event means we should redraw our windows (= title bar)
600  *
601  */
602 static void handle_expose_event(xcb_expose_event_t *event) {
603  Con *parent;
604 
605  DLOG("window = %08x\n", event->window);
606 
607  if ((parent = con_by_frame_id(event->window)) == NULL) {
608  LOG("expose event for unknown window, ignoring\n");
609  return;
610  }
611 
612  /* Since we render to our pixmap on every change anyways, expose events
613  * only tell us that the X server lost (parts of) the window contents. We
614  * can handle that by copying the appropriate part from our pixmap to the
615  * window. */
616  xcb_copy_area(conn, parent->pixmap, parent->frame, parent->pm_gc,
617  event->x, event->y, event->x, event->y,
618  event->width, event->height);
619  xcb_flush(conn);
620 
621  return;
622 }
623 
624 /*
625  * Handle client messages (EWMH)
626  *
627  */
628 static void handle_client_message(xcb_client_message_event_t *event) {
629  /* If this is a startup notification ClientMessage, the library will handle
630  * it and call our monitor_event() callback. */
631  if (sn_xcb_display_process_event(sndisplay, (xcb_generic_event_t*)event))
632  return;
633 
634  LOG("ClientMessage for window 0x%08x\n", event->window);
635  if (event->type == A__NET_WM_STATE) {
636  if (event->format != 32 ||
637  (event->data.data32[1] != A__NET_WM_STATE_FULLSCREEN &&
638  event->data.data32[1] != A__NET_WM_STATE_DEMANDS_ATTENTION)) {
639  DLOG("Unknown atom in clientmessage of type %d\n", event->data.data32[1]);
640  return;
641  }
642 
643  Con *con = con_by_window_id(event->window);
644  if (con == NULL) {
645  DLOG("Could not get window for client message\n");
646  return;
647  }
648 
649  if (event->data.data32[1] == A__NET_WM_STATE_FULLSCREEN) {
650  /* Check if the fullscreen state should be toggled */
651  if ((con->fullscreen_mode != CF_NONE &&
652  (event->data.data32[0] == _NET_WM_STATE_REMOVE ||
653  event->data.data32[0] == _NET_WM_STATE_TOGGLE)) ||
654  (con->fullscreen_mode == CF_NONE &&
655  (event->data.data32[0] == _NET_WM_STATE_ADD ||
656  event->data.data32[0] == _NET_WM_STATE_TOGGLE))) {
657  DLOG("toggling fullscreen\n");
658  con_toggle_fullscreen(con, CF_OUTPUT);
659  }
660  } else if (event->data.data32[1] == A__NET_WM_STATE_DEMANDS_ATTENTION) {
661  /* Check if the urgent flag must be set or not */
662  if (event->data.data32[0] == _NET_WM_STATE_ADD)
663  con_set_urgency(con, true);
664  else if (event->data.data32[0] == _NET_WM_STATE_REMOVE)
665  con_set_urgency(con, false);
666  else if (event->data.data32[0] == _NET_WM_STATE_TOGGLE)
667  con_set_urgency(con, !con->urgent);
668  }
669 
670  tree_render();
671  } else if (event->type == A__NET_ACTIVE_WINDOW) {
672  DLOG("_NET_ACTIVE_WINDOW: Window 0x%08x should be activated\n", event->window);
673  Con *con = con_by_window_id(event->window);
674  if (con == NULL) {
675  DLOG("Could not get window for client message\n");
676  return;
677  }
678 
679  Con *ws = con_get_workspace(con);
680  if (!workspace_is_visible(ws)) {
681  DLOG("Workspace not visible, ignoring _NET_ACTIVE_WINDOW\n");
682  return;
683  }
684 
685  if (con_is_internal(ws)) {
686  DLOG("Workspace is internal, ignoring _NET_ACTIVE_WINDOW\n");
687  return;
688  }
689 
690  if (ws != con_get_workspace(focused))
691  workspace_show(ws);
692 
693  con_focus(con);
694  tree_render();
695  } else if (event->type == A_I3_SYNC) {
696  xcb_window_t window = event->data.data32[0];
697  uint32_t rnd = event->data.data32[1];
698  DLOG("[i3 sync protocol] Sending random value %d back to X11 window 0x%08x\n", rnd, window);
699 
700  void *reply = scalloc(32);
701  xcb_client_message_event_t *ev = reply;
702 
703  ev->response_type = XCB_CLIENT_MESSAGE;
704  ev->window = window;
705  ev->type = A_I3_SYNC;
706  ev->format = 32;
707  ev->data.data32[0] = window;
708  ev->data.data32[1] = rnd;
709 
710  xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char*)ev);
711  xcb_flush(conn);
712  free(reply);
713  } else if (event->type == A__NET_REQUEST_FRAME_EXTENTS) {
714  /*
715  * A client can request an estimate for the frame size which the window
716  * manager will put around it before actually mapping its window. Java
717  * does this (as of openjdk-7).
718  *
719  * Note that the calculation below is not entirely accurate — once you
720  * set a different border type, it’s off. We _could_ request all the
721  * window properties (which have to be set up at this point according
722  * to EWMH), but that seems rather elaborate. The standard explicitly
723  * says the application must cope with an estimate that is not entirely
724  * accurate.
725  */
726  DLOG("_NET_REQUEST_FRAME_EXTENTS for window 0x%08x\n", event->window);
727 
728  /* The reply data: approximate frame size */
729  Rect r = {
730  config.default_border_width, /* left */
731  config.default_border_width, /* right */
732  config.font.height + 5, /* top */
733  config.default_border_width /* bottom */
734  };
735  xcb_change_property(
736  conn,
737  XCB_PROP_MODE_REPLACE,
738  event->window,
739  A__NET_FRAME_EXTENTS,
740  XCB_ATOM_CARDINAL, 32, 4,
741  &r);
742  xcb_flush(conn);
743  } else {
744  DLOG("unhandled clientmessage\n");
745  return;
746  }
747 }
748 
749 #if 0
750 int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
751  xcb_atom_t atom, xcb_get_property_reply_t *property) {
752  /* TODO: Implement this one. To do this, implement a little test program which sleep(1)s
753  before changing this property. */
754  ELOG("_NET_WM_WINDOW_TYPE changed, this is not yet implemented.\n");
755  return 0;
756 }
757 #endif
758 
759 /*
760  * Handles the size hints set by a window, but currently only the part necessary for displaying
761  * clients proportionally inside their frames (mplayer for example)
762  *
763  * See ICCCM 4.1.2.3 for more details
764  *
765  */
766 static bool handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
767  xcb_atom_t name, xcb_get_property_reply_t *reply) {
768  Con *con = con_by_window_id(window);
769  if (con == NULL) {
770  DLOG("Received WM_NORMAL_HINTS for unknown client\n");
771  return false;
772  }
773 
774  xcb_size_hints_t size_hints;
775 
776  //CLIENT_LOG(client);
777 
778  /* If the hints were already in this event, use them, if not, request them */
779  if (reply != NULL)
780  xcb_icccm_get_wm_size_hints_from_reply(&size_hints, reply);
781  else
783 
784  if ((size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE)) {
785  // TODO: Minimum size is not yet implemented
786  DLOG("Minimum size: %d (width) x %d (height)\n", size_hints.min_width, size_hints.min_height);
787  }
788 
789  bool changed = false;
790  if ((size_hints.flags & XCB_ICCCM_SIZE_HINT_P_RESIZE_INC)) {
791  if (size_hints.width_inc > 0 && size_hints.width_inc < 0xFFFF)
792  if (con->width_increment != size_hints.width_inc) {
793  con->width_increment = size_hints.width_inc;
794  changed = true;
795  }
796  if (size_hints.height_inc > 0 && size_hints.height_inc < 0xFFFF)
797  if (con->height_increment != size_hints.height_inc) {
798  con->height_increment = size_hints.height_inc;
799  changed = true;
800  }
801 
802  if (changed)
803  DLOG("resize increments changed\n");
804  }
805 
806  int base_width = 0, base_height = 0;
807 
808  /* base_width/height are the desired size of the window.
809  We check if either the program-specified size or the program-specified
810  min-size is available */
811  if (size_hints.flags & XCB_ICCCM_SIZE_HINT_BASE_SIZE) {
812  base_width = size_hints.base_width;
813  base_height = size_hints.base_height;
814  } else if (size_hints.flags & XCB_ICCCM_SIZE_HINT_P_MIN_SIZE) {
815  /* TODO: is this right? icccm says not */
816  base_width = size_hints.min_width;
817  base_height = size_hints.min_height;
818  }
819 
820  if (base_width != con->base_width ||
821  base_height != con->base_height) {
822  con->base_width = base_width;
823  con->base_height = base_height;
824  DLOG("client's base_height changed to %d\n", base_height);
825  DLOG("client's base_width changed to %d\n", base_width);
826  changed = true;
827  }
828 
829  /* If no aspect ratio was set or if it was invalid, we ignore the hints */
830  if (!(size_hints.flags & XCB_ICCCM_SIZE_HINT_P_ASPECT) ||
831  (size_hints.min_aspect_num <= 0) ||
832  (size_hints.min_aspect_den <= 0)) {
833  goto render_and_return;
834  }
835 
836  /* XXX: do we really use rect here, not window_rect? */
837  double width = con->rect.width - base_width;
838  double height = con->rect.height - base_height;
839  /* Convert numerator/denominator to a double */
840  double min_aspect = (double)size_hints.min_aspect_num / size_hints.min_aspect_den;
841  double max_aspect = (double)size_hints.max_aspect_num / size_hints.min_aspect_den;
842 
843  DLOG("Aspect ratio set: minimum %f, maximum %f\n", min_aspect, max_aspect);
844  DLOG("width = %f, height = %f\n", width, height);
845 
846  /* Sanity checks, this is user-input, in a way */
847  if (max_aspect <= 0 || min_aspect <= 0 || height == 0 || (width / height) <= 0)
848  goto render_and_return;
849 
850  /* Check if we need to set proportional_* variables using the correct ratio */
851  double aspect_ratio = 0.0;
852  if ((width / height) < min_aspect) {
853  aspect_ratio = min_aspect;
854  } else if ((width / height) > max_aspect) {
855  aspect_ratio = max_aspect;
856  } else goto render_and_return;
857 
858  if (fabs(con->aspect_ratio - aspect_ratio) > DBL_EPSILON) {
859  con->aspect_ratio = aspect_ratio;
860  changed = true;
861  }
862 
863 render_and_return:
864  if (changed)
865  tree_render();
866  FREE(reply);
867  return true;
868 }
869 
870 /*
871  * Handles the WM_HINTS property for extracting the urgency state of the window.
872  *
873  */
874 static bool handle_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
875  xcb_atom_t name, xcb_get_property_reply_t *reply) {
876  Con *con = con_by_window_id(window);
877  if (con == NULL) {
878  DLOG("Received WM_HINTS for unknown client\n");
879  return false;
880  }
881 
882  bool urgency_hint;
883  if (reply == NULL)
884  reply = xcb_get_property_reply(conn, xcb_icccm_get_wm_hints(conn, window), NULL);
885  window_update_hints(con->window, reply, &urgency_hint);
886  con_set_urgency(con, urgency_hint);
887  tree_render();
888 
889  return true;
890 }
891 
892 /*
893  * Handles the transient for hints set by a window, signalizing that this window is a popup window
894  * for some other window.
895  *
896  * See ICCCM 4.1.2.6 for more details
897  *
898  */
899 static bool handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
900  xcb_atom_t name, xcb_get_property_reply_t *prop) {
901  Con *con;
902 
903  if ((con = con_by_window_id(window)) == NULL || con->window == NULL) {
904  DLOG("No such window\n");
905  return false;
906  }
907 
908  if (prop == NULL) {
909  prop = xcb_get_property_reply(conn, xcb_get_property_unchecked(conn,
910  false, window, XCB_ATOM_WM_TRANSIENT_FOR, XCB_ATOM_WINDOW, 0, 32), NULL);
911  if (prop == NULL)
912  return false;
913  }
914 
916 
917  return true;
918 }
919 
920 /*
921  * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
922  * toolwindow (or similar) and to which window it belongs (logical parent).
923  *
924  */
925 static bool handle_clientleader_change(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
926  xcb_atom_t name, xcb_get_property_reply_t *prop) {
927  Con *con;
928  if ((con = con_by_window_id(window)) == NULL || con->window == NULL)
929  return false;
930 
931  if (prop == NULL) {
932  prop = xcb_get_property_reply(conn, xcb_get_property_unchecked(conn,
933  false, window, A_WM_CLIENT_LEADER, XCB_ATOM_WINDOW, 0, 32), NULL);
934  if (prop == NULL)
935  return false;
936  }
937 
938  window_update_leader(con->window, prop);
939 
940  return true;
941 }
942 
943 /*
944  * Handles FocusIn events which are generated by clients (i3’s focus changes
945  * don’t generate FocusIn events due to a different EventMask) and updates the
946  * decorations accordingly.
947  *
948  */
949 static void handle_focus_in(xcb_focus_in_event_t *event) {
950  DLOG("focus change in, for window 0x%08x\n", event->event);
951  Con *con;
952  if ((con = con_by_window_id(event->event)) == NULL || con->window == NULL)
953  return;
954  DLOG("That is con %p / %s\n", con, con->name);
955 
956  if (event->mode == XCB_NOTIFY_MODE_GRAB ||
957  event->mode == XCB_NOTIFY_MODE_UNGRAB) {
958  DLOG("FocusIn event for grab/ungrab, ignoring\n");
959  return;
960  }
961 
962  if (event->detail == XCB_NOTIFY_DETAIL_POINTER) {
963  DLOG("notify detail is pointer, ignoring this event\n");
964  return;
965  }
966 
967  if (focused_id == event->event) {
968  DLOG("focus matches the currently focused window, not doing anything\n");
969  return;
970  }
971 
972  /* Skip dock clients, they cannot get the i3 focus. */
973  if (con->parent->type == CT_DOCKAREA) {
974  DLOG("This is a dock client, not focusing.\n");
975  return;
976  }
977 
978  DLOG("focus is different, updating decorations\n");
979 
980  /* Get the currently focused workspace to check if the focus change also
981  * involves changing workspaces. If so, we need to call workspace_show() to
982  * correctly update state and send the IPC event. */
983  Con *ws = con_get_workspace(con);
984  if (ws != con_get_workspace(focused))
985  workspace_show(ws);
986 
987  con_focus(con);
988  /* We update focused_id because we don’t need to set focus again */
989  focused_id = event->event;
991  return;
992 }
993 
994 /* Returns false if the event could not be processed (e.g. the window could not
995  * be found), true otherwise */
996 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);
997 
999  xcb_atom_t atom;
1000  uint32_t long_len;
1002 };
1003 
1005  { 0, 128, handle_windowname_change },
1006  { 0, UINT_MAX, handle_hints },
1007  { 0, 128, handle_windowname_change_legacy },
1008  { 0, UINT_MAX, handle_normal_hints },
1009  { 0, UINT_MAX, handle_clientleader_change },
1010  { 0, UINT_MAX, handle_transient_for },
1011  { 0, 128, handle_windowrole_change }
1012 };
1013 #define NUM_HANDLERS (sizeof(property_handlers) / sizeof(struct property_handler_t))
1014 
1015 /*
1016  * Sets the appropriate atoms for the property handlers after the atoms were
1017  * received from X11
1018  *
1019  */
1021 
1022  sn_monitor_context_new(sndisplay, conn_screen, startup_monitor_event, NULL, NULL);
1023 
1024  property_handlers[0].atom = A__NET_WM_NAME;
1025  property_handlers[1].atom = XCB_ATOM_WM_HINTS;
1026  property_handlers[2].atom = XCB_ATOM_WM_NAME;
1027  property_handlers[3].atom = XCB_ATOM_WM_NORMAL_HINTS;
1028  property_handlers[4].atom = A_WM_CLIENT_LEADER;
1029  property_handlers[5].atom = XCB_ATOM_WM_TRANSIENT_FOR;
1030  property_handlers[6].atom = A_WM_WINDOW_ROLE;
1031 }
1032 
1033 static void property_notify(uint8_t state, xcb_window_t window, xcb_atom_t atom) {
1034  struct property_handler_t *handler = NULL;
1035  xcb_get_property_reply_t *propr = NULL;
1036 
1037  for (int c = 0; c < sizeof(property_handlers) / sizeof(struct property_handler_t); c++) {
1038  if (property_handlers[c].atom != atom)
1039  continue;
1040 
1041  handler = &property_handlers[c];
1042  break;
1043  }
1044 
1045  if (handler == NULL) {
1046  //DLOG("Unhandled property notify for atom %d (0x%08x)\n", atom, atom);
1047  return;
1048  }
1049 
1050  if (state != XCB_PROPERTY_DELETE) {
1051  xcb_get_property_cookie_t cookie = xcb_get_property(conn, 0, window, atom, XCB_GET_PROPERTY_TYPE_ANY, 0, handler->long_len);
1052  propr = xcb_get_property_reply(conn, cookie, 0);
1053  }
1054 
1055  /* the handler will free() the reply unless it returns false */
1056  if (!handler->cb(NULL, conn, state, window, atom, propr))
1057  FREE(propr);
1058 }
1059 
1060 /*
1061  * Takes an xcb_generic_event_t and calls the appropriate handler, based on the
1062  * event type.
1063  *
1064  */
1065 void handle_event(int type, xcb_generic_event_t *event) {
1066  if (randr_base > -1 &&
1067  type == randr_base + XCB_RANDR_SCREEN_CHANGE_NOTIFY) {
1068  handle_screen_change(event);
1069  return;
1070  }
1071 
1072  switch (type) {
1073  case XCB_KEY_PRESS:
1074  case XCB_KEY_RELEASE:
1075  handle_key_press((xcb_key_press_event_t*)event);
1076  break;
1077 
1078  case XCB_BUTTON_PRESS:
1079  handle_button_press((xcb_button_press_event_t*)event);
1080  break;
1081 
1082  case XCB_MAP_REQUEST:
1083  handle_map_request((xcb_map_request_event_t*)event);
1084  break;
1085 
1086  case XCB_UNMAP_NOTIFY:
1087  handle_unmap_notify_event((xcb_unmap_notify_event_t*)event);
1088  break;
1089 
1090  case XCB_DESTROY_NOTIFY:
1091  handle_destroy_notify_event((xcb_destroy_notify_event_t*)event);
1092  break;
1093 
1094  case XCB_EXPOSE:
1095  handle_expose_event((xcb_expose_event_t*)event);
1096  break;
1097 
1098  case XCB_MOTION_NOTIFY:
1099  handle_motion_notify((xcb_motion_notify_event_t*)event);
1100  break;
1101 
1102  /* Enter window = user moved his mouse over the window */
1103  case XCB_ENTER_NOTIFY:
1104  handle_enter_notify((xcb_enter_notify_event_t*)event);
1105  break;
1106 
1107  /* Client message are sent to the root window. The only interesting
1108  * client message for us is _NET_WM_STATE, we honour
1109  * _NET_WM_STATE_FULLSCREEN and _NET_WM_STATE_DEMANDS_ATTENTION */
1110  case XCB_CLIENT_MESSAGE:
1111  handle_client_message((xcb_client_message_event_t*)event);
1112  break;
1113 
1114  /* Configure request = window tried to change size on its own */
1115  case XCB_CONFIGURE_REQUEST:
1116  handle_configure_request((xcb_configure_request_event_t*)event);
1117  break;
1118 
1119  /* Mapping notify = keyboard mapping changed (Xmodmap), re-grab bindings */
1120  case XCB_MAPPING_NOTIFY:
1121  handle_mapping_notify((xcb_mapping_notify_event_t*)event);
1122  break;
1123 
1124  case XCB_FOCUS_IN:
1125  handle_focus_in((xcb_focus_in_event_t*)event);
1126  break;
1127 
1128  case XCB_PROPERTY_NOTIFY: {
1129  xcb_property_notify_event_t *e = (xcb_property_notify_event_t*)event;
1130  last_timestamp = e->time;
1131  property_notify(e->state, e->window, e->atom);
1132  break;
1133  }
1134 
1135  default:
1136  //DLOG("Unhandled event of type %d\n", type);
1137  break;
1138  }
1139 }