1 /* AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2003 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 /* deviceeventcontroller.c: implement the DeviceEventController interface */
30 #undef SPI_KEYEVENT_DEBUG
38 #include <X11/Xutil.h>
39 #include <X11/extensions/XTest.h>
40 #include <X11/XKBlib.h>
43 #include <X11/keysymdef.h>
46 #include <X11/Xproto.h>
48 #include <X11/extensions/Xevie.h>
49 #endif /* HAVE_XEVIE */
53 #include <dbus/dbus.h>
58 #include "de-marshaller.h"
60 #include "event-source.h"
62 #include "deviceeventcontroller.h"
63 #include "reentrant-list.h"
65 #include "introspection.h"
67 KeySym ucs2keysym (long ucs);
68 long keysym2ucs(KeySym keysym);
70 #define CHECK_RELEASE_DELAY 20
71 #define BIT(c, x) (c[x/8]&(1<<(x%8)))
72 static guint check_release_handler = 0;
73 static Accessibility_DeviceEvent pressed_event;
74 static SpiDEController *saved_controller;
75 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
77 /* Our parent Gtk object type */
78 #define PARENT_TYPE G_TYPE_OBJECT
80 /* A pointer to our parent object class */
81 static int spi_error_code = 0;
86 typedef struct _SpiPoint SpiPoint;
87 static SpiPoint last_mouse_pos_static = {0, 0};
88 static SpiPoint *last_mouse_pos = &last_mouse_pos_static;
89 static unsigned int mouse_mask_state = 0;
90 static unsigned int mouse_button_mask =
91 Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
92 static unsigned int key_modifier_mask =
93 Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
94 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
96 static GQuark spi_dec_private_quark = 0;
97 static XModifierKeymap* xmkeymap = NULL;
99 static gboolean have_mouse_listener = FALSE;
100 static gboolean have_mouse_event_listener = FALSE;
102 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
106 SPI_DEVICE_TYPE_MOUSE,
107 SPI_DEVICE_TYPE_LAST_DEFINED
108 } SpiDeviceTypeCategory;
111 guint ref_count : 30;
112 guint pending_add : 1;
113 guint pending_remove : 1;
115 Accessibility_ControllerEventMask mod_mask;
116 dbus_uint32_t key_val; /* KeyCode */
117 } DEControllerGrabMask;
122 SpiDeviceTypeCategory type;
124 } DEControllerListener;
127 DEControllerListener listener;
130 Accessibility_ControllerEventMask mask;
131 Accessibility_EventListenerMode *mode;
132 } DEControllerKeyListener;
135 unsigned int last_press_keycode;
136 unsigned int last_release_keycode;
137 struct timeval last_press_time;
138 struct timeval last_release_time;
140 int xkb_major_extension_opcode;
141 int xkb_base_event_code;
142 int xkb_base_error_code;
143 unsigned int xkb_latch_mask;
144 unsigned int pending_xkb_mod_relatch_mask;
146 KeyCode reserved_keycode;
147 KeySym reserved_keysym;
148 guint reserved_reset_timeout;
149 } DEControllerPrivateData;
151 static void spi_controller_register_with_devices (SpiDEController *controller);
152 static gboolean spi_controller_update_key_grabs (SpiDEController *controller,
153 Accessibility_DeviceEvent *recv);
154 static gboolean spi_controller_register_device_listener (SpiDEController *controller,
155 DEControllerListener *l);
156 static gboolean spi_device_event_controller_forward_key_event (SpiDEController *controller,
157 const XEvent *event);
158 static void spi_controller_deregister_device_listener (SpiDEController *controller,
159 DEControllerListener *listener);
160 static void spi_deregister_controller_key_listener (SpiDEController *controller,
161 DEControllerKeyListener *key_listener);
162 static gboolean spi_controller_notify_mouselisteners (SpiDEController *controller,
163 const Accessibility_DeviceEvent *event);
165 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
166 const Accessibility_DeviceEvent *event);
167 static gboolean spi_clear_error_state (void);
168 static gboolean spi_dec_poll_mouse_moved (gpointer data);
169 static gboolean spi_dec_poll_mouse_moving (gpointer data);
170 static gboolean spi_dec_poll_mouse_idle (gpointer data);
172 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
175 invalid_arguments_error (DBusMessage *message)
180 errmsg= g_strdup_printf (
181 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
182 dbus_message_get_member (message),
183 dbus_message_get_signature (message),
184 dbus_message_get_interface (message));
185 reply = dbus_message_new_error (message,
186 DBUS_ERROR_INVALID_ARGS,
192 /* Private methods */
194 spi_dbus_add_disconnect_match (DBusConnection *bus, const char *name)
196 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
200 dbus_error_init (&error);
201 dbus_bus_add_match (bus, match, &error);
203 if (dbus_error_is_set (&error))
205 dbus_error_free (&error);
217 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
219 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
223 dbus_error_init (&error);
224 dbus_bus_remove_match (bus, match, &error);
226 if (dbus_error_is_set (&error))
228 dbus_error_free (&error);
240 keysym_mod_mask (KeySym keysym, KeyCode keycode)
242 /* we really should use XKB and look directly at the keymap */
243 /* this is very inelegant */
244 Display *display = spi_get_display ();
245 unsigned int mods_rtn = 0;
246 unsigned int retval = 0;
249 if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
250 (sym_rtn == keysym)) {
253 else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
254 (sym_rtn == keysym)) {
257 else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
258 (sym_rtn == keysym)) {
261 else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
262 (sym_rtn == keysym)) {
265 else if (XkbLookupKeySym (display, keycode,
266 ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
267 (sym_rtn == keysym)) {
268 retval = (Mod2Mask | ShiftMask);
270 else if (XkbLookupKeySym (display, keycode,
271 ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
272 (sym_rtn == keysym)) {
273 retval = (Mod3Mask | ShiftMask);
275 else if (XkbLookupKeySym (display, keycode,
276 ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
277 (sym_rtn == keysym)) {
278 retval = (Mod4Mask | ShiftMask);
286 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
289 Display *dpy = spi_get_display ();
291 if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
293 fprintf (stderr, "ERROR getting map\n");
297 if (desc && desc->map)
299 gint offset = desc->map->key_sym_map[keycode].offset;
300 desc->map->syms[offset] = keysym;
304 fprintf (stderr, "Error changing key map: empty server structure\n");
306 XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
308 * FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
309 * would be far preferable.
310 * HOWEVER it does not seem to work using XFree 4.3.
312 /* XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
315 XkbFreeKeyboard (desc, 0, TRUE);
324 spi_dec_reset_reserved (gpointer data)
326 DEControllerPrivateData *priv = data;
327 spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
328 priv->reserved_reset_timeout = 0;
333 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
336 keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
339 DEControllerPrivateData *priv = (DEControllerPrivateData *)
340 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
341 /* if there's no keycode available, fix it */
342 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
344 keycode = priv->reserved_keycode;
346 * queue a timer to restore the old keycode. Ugly, but required
347 * due to races / asynchronous X delivery.
348 * Long-term fix is to extend the X keymap here instead of replace entries.
350 priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
356 *modmask = keysym_mod_mask (keysym, keycode);
360 static DEControllerGrabMask *
361 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
363 DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
365 memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
367 clone->ref_count = 1;
368 clone->pending_add = TRUE;
369 clone->pending_remove = FALSE;
375 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
381 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
383 DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
384 DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
392 return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
397 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
399 DEControllerPrivateData *priv =
400 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
402 if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
403 priv->xkb_latch_mask);
405 priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
409 spi_dec_clear_unlatch_pending (SpiDEController *controller)
411 DEControllerPrivateData *priv =
412 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
413 priv->xkb_latch_mask = 0;
416 static void emit(SpiDEController *controller, const char *interface, const char *name, const char *minor, int a1, int a2)
418 DBusMessage *signal = NULL;
419 DBusMessageIter iter, iter_struct, iter_variant;
421 const char *path = SPI_DBUS_PATH_ROOT;
422 const char *bus_name = dbus_bus_get_unique_name (controller->bus);
424 signal = dbus_message_new_signal (path, interface, name);
426 dbus_message_iter_init_append (signal, &iter);
428 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
429 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a1);
430 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a2);
431 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
432 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
433 dbus_message_iter_close_container (&iter, &iter_variant);
435 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
437 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
438 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
439 dbus_message_iter_close_container (&iter, &iter_struct);
441 dbus_connection_send (controller->bus, signal, NULL);
442 dbus_message_unref (signal);
446 spi_dec_button_update_and_emit (SpiDEController *controller,
449 Accessibility_DeviceEvent mouse_e;
450 gchar event_detail[3];
451 gboolean is_consumed = FALSE;
453 if ((mask_return & mouse_button_mask) !=
454 (mouse_mask_state & mouse_button_mask))
456 int button_number = 0;
457 gboolean is_down = False;
459 if (!(mask_return & Button1Mask) &&
460 (mouse_mask_state & Button1Mask))
462 mouse_mask_state &= ~Button1Mask;
465 else if ((mask_return & Button1Mask) &&
466 !(mouse_mask_state & Button1Mask))
468 mouse_mask_state |= Button1Mask;
472 else if (!(mask_return & Button2Mask) &&
473 (mouse_mask_state & Button2Mask))
475 mouse_mask_state &= ~Button2Mask;
478 else if ((mask_return & Button2Mask) &&
479 !(mouse_mask_state & Button2Mask))
481 mouse_mask_state |= Button2Mask;
485 else if (!(mask_return & Button3Mask) &&
486 (mouse_mask_state & Button3Mask))
488 mouse_mask_state &= ~Button3Mask;
491 else if ((mask_return & Button3Mask) &&
492 !(mouse_mask_state & Button3Mask))
494 mouse_mask_state |= Button3Mask;
498 else if (!(mask_return & Button4Mask) &&
499 (mouse_mask_state & Button4Mask))
501 mouse_mask_state &= ~Button4Mask;
504 else if ((mask_return & Button4Mask) &&
505 !(mouse_mask_state & Button4Mask))
507 mouse_mask_state |= Button4Mask;
511 else if (!(mask_return & Button5Mask) &&
512 (mouse_mask_state & Button5Mask))
514 mouse_mask_state &= ~Button5Mask;
517 else if ((mask_return & Button5Mask) &&
518 !(mouse_mask_state & Button5Mask))
520 mouse_mask_state |= Button5Mask;
526 fprintf (stderr, "Button %d %s\n",
527 button_number, (is_down) ? "Pressed" : "Released");
529 snprintf (event_detail, 3, "%d%c", button_number,
530 (is_down) ? 'p' : 'r');
531 /* TODO: FIXME distinguish between physical and
534 mouse_e.type = (is_down) ?
535 Accessibility_BUTTON_PRESSED_EVENT :
536 Accessibility_BUTTON_RELEASED_EVENT;
537 mouse_e.id = button_number;
538 mouse_e.hw_code = button_number;
539 mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
540 mouse_e.timestamp = 0;
541 mouse_e.event_string = "";
542 mouse_e.is_text = FALSE;
544 spi_controller_notify_mouselisteners (controller,
548 dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
549 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, x, y);
552 spi_dec_set_unlatch_pending (controller, mask_return);
564 spi_dec_mouse_check (SpiDEController *controller,
565 int *x, int *y, gboolean *moved)
567 int win_x_return,win_y_return;
568 unsigned int mask_return;
569 Window root_return, child_return;
570 Display *display = spi_get_display ();
573 XQueryPointer(display, DefaultRootWindow (display),
574 &root_return, &child_return,
576 &win_x_return, &win_y_return, &mask_return);
578 * Since many clients grab the pointer, and X goes an automatic
579 * pointer grab on mouse-down, we often must detect mouse button events
580 * by polling rather than via a button grab.
581 * The while loop (rather than if) is used since it's possible that
582 * multiple buttons have changed state since we last checked.
584 if (mask_return != mouse_mask_state)
586 while (spi_dec_button_update_and_emit (controller, mask_return));
589 if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
591 // TODO: combine these two signals?
592 dbus_uint32_t ix = *x, iy = *y;
593 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Abs", "", ix, iy);
594 ix -= last_mouse_pos->x;
595 iy -= last_mouse_pos->y;
596 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Rel", "", ix, iy);
597 last_mouse_pos->x = *x;
598 last_mouse_pos->y = *y;
610 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
613 dbus_uint32_t d1, d2;
616 fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
617 prev_mask, current_mask);
620 /* set bits for the virtual modifiers like NUMLOCK */
621 if (prev_mask & _numlock_physical_mask)
622 prev_mask |= SPI_KEYMASK_NUMLOCK;
623 if (current_mask & _numlock_physical_mask)
624 current_mask |= SPI_KEYMASK_NUMLOCK;
626 d1 = prev_mask & key_modifier_mask;
627 d2 = current_mask & key_modifier_mask;
628 emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "Modifiers", "", d1, d2);
632 spi_dec_poll_mouse_moved (gpointer data)
634 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
639 mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
641 if ((mask_return & key_modifier_mask) !=
642 (mouse_mask_state & key_modifier_mask))
644 spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
645 mouse_mask_state = mask_return;
652 spi_dec_poll_mouse_idle (gpointer data)
654 if (!have_mouse_event_listener && !have_mouse_listener)
656 else if (!spi_dec_poll_mouse_moved (data))
660 g_timeout_add (20, spi_dec_poll_mouse_moving, data);
666 spi_dec_poll_mouse_moving (gpointer data)
668 if (!have_mouse_event_listener && !have_mouse_listener)
670 else if (spi_dec_poll_mouse_moved (data))
674 g_timeout_add (100, spi_dec_poll_mouse_idle, data);
679 #ifdef WE_NEED_UGRAB_MOUSE
681 spi_dec_ungrab_mouse (gpointer data)
683 Display *display = spi_get_display ();
686 XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
687 XDefaultRootWindow (spi_get_display ()));
694 spi_dec_init_mouse_listener (SpiDEController *dec)
697 Display *display = spi_get_display ();
701 if (XGrabButton (display, AnyButton, AnyModifier,
702 spi_get_root_window (),
703 True, ButtonPressMask | ButtonReleaseMask,
704 GrabModeSync, GrabModeAsync, None, None) != Success) {
706 fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
710 XSync (display, False);
712 fprintf (stderr, "mouse buttons grabbed\n");
719 * Eventually we can use this to make the marshalling of mask types
720 * more sane, but for now we just use this to detect
721 * the use of 'virtual' masks such as numlock and convert them to
722 * system-specific mask values (i.e. ModMask).
725 static Accessibility_ControllerEventMask
726 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
728 Accessibility_ControllerEventMask tmp_mask;
729 gboolean has_numlock;
731 has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
735 tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
736 tmp_mask |= _numlock_physical_mask;
742 static DEControllerKeyListener *
743 spi_dec_key_listener_new (const char *bus_name,
746 const Accessibility_ControllerEventMask mask,
747 const dbus_uint32_t types,
748 const Accessibility_EventListenerMode *mode)
750 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
751 key_listener->listener.bus_name = g_strdup(bus_name);
752 key_listener->listener.path = g_strdup(path);
753 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
754 key_listener->keys = keys;
755 key_listener->mask = spi_dec_translate_mask (mask);
756 key_listener->listener.types = types;
759 key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
760 memcpy(key_listener->mode, mode, sizeof(*mode));
763 key_listener->mode = NULL;
766 g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
767 (unsigned int) key_listener->mask,
768 (int) (mode ? mode->global : 0),
769 (void *) key_listener->keys,
770 (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
776 static DEControllerListener *
777 spi_dec_listener_new (const char *bus_name,
781 DEControllerListener *listener = g_new0 (DEControllerListener, 1);
782 listener->bus_name = g_strdup(bus_name);
783 listener->path = g_strdup(path);
784 listener->type = SPI_DEVICE_TYPE_MOUSE;
785 listener->types = types;
789 static DEControllerListener *
790 spi_listener_clone (DEControllerListener *listener)
792 DEControllerListener *clone = g_new0 (DEControllerListener, 1);
793 clone->bus_name = g_strdup (listener->bus_name);
794 clone->path = g_strdup (listener->path);
795 clone->type = listener->type;
796 clone->types = listener->types;
800 static GSList *keylist_clone (GSList *s)
805 for (l = s; l; l = g_slist_next(l))
807 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
810 Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
811 kd->keycode = kds->keycode;
812 kd->keysym = kds->keysym;
813 kd->keystring = g_strdup(kds->keystring);
814 d = g_slist_append(d, kd);
820 static DEControllerKeyListener *
821 spi_key_listener_clone (DEControllerKeyListener *key_listener)
823 DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
824 clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
825 clone->listener.path = g_strdup (key_listener->listener.path);
826 clone->listener.type = SPI_DEVICE_TYPE_KBD;
827 clone->keys = keylist_clone (key_listener->keys);
828 clone->mask = key_listener->mask;
829 clone->listener.types = key_listener->listener.types;
830 if (key_listener->mode)
832 clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
833 if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
840 static void keylist_free(GSList *keys)
844 for (l = keys; l; l = g_slist_next(l))
846 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
847 g_free(kd->keystring);
854 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
856 keylist_free(key_listener->keys);
857 if (key_listener->mode) g_free(key_listener->mode);
858 g_free (key_listener->listener.bus_name);
859 g_free (key_listener->listener.path);
860 g_free (key_listener);
864 spi_key_listener_clone_free (DEControllerKeyListener *clone)
866 spi_key_listener_data_free (clone);
870 spi_listener_clone_free (DEControllerListener *clone)
872 g_free (clone->path);
873 g_free (clone->bus_name);
878 spi_dec_listener_free (DEControllerListener *listener)
880 if (listener->type == SPI_DEVICE_TYPE_KBD)
881 spi_key_listener_data_free ((DEControllerKeyListener *) listener);
884 g_free (listener->bus_name);
885 g_free (listener->path);
890 _register_keygrab (SpiDEController *controller,
891 DEControllerGrabMask *grab_mask)
895 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
896 spi_grab_mask_compare_values);
899 DEControllerGrabMask *cur_mask = l->data;
901 cur_mask->ref_count++;
902 if (cur_mask->pending_remove)
904 cur_mask->pending_remove = FALSE;
909 controller->keygrabs_list =
910 g_list_prepend (controller->keygrabs_list,
911 spi_grab_mask_clone (grab_mask));
916 _deregister_keygrab (SpiDEController *controller,
917 DEControllerGrabMask *grab_mask)
921 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
922 spi_grab_mask_compare_values);
926 DEControllerGrabMask *cur_mask = l->data;
928 cur_mask->ref_count--;
929 if (cur_mask->ref_count <= 0)
931 cur_mask->pending_remove = TRUE;
937 handle_keygrab (SpiDEController *controller,
938 DEControllerKeyListener *key_listener,
939 void (*process_cb) (SpiDEController *controller,
940 DEControllerGrabMask *grab_mask))
942 DEControllerGrabMask grab_mask = { 0 };
944 grab_mask.mod_mask = key_listener->mask;
945 if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
947 grab_mask.key_val = AnyKey;
949 fprintf (stderr, "AnyKey grab!");
951 process_cb (controller, &grab_mask);
957 for (l = key_listener->keys; l; l = g_slist_next(l))
959 Accessibility_KeyDefinition *keydef = l->data;
960 long int key_val = keydef->keysym;
961 /* X Grabs require keycodes, not keysyms */
962 if (keydef->keystring && keydef->keystring[0])
964 key_val = XStringToKeysym(keydef->keystring);
968 key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
972 key_val = keydef->keycode;
974 grab_mask.key_val = key_val;
975 process_cb (controller, &grab_mask);
981 spi_controller_register_global_keygrabs (SpiDEController *controller,
982 DEControllerKeyListener *key_listener)
984 handle_keygrab (controller, key_listener, _register_keygrab);
985 if (controller->xevie_display == NULL)
986 return spi_controller_update_key_grabs (controller, NULL);
992 spi_controller_deregister_global_keygrabs (SpiDEController *controller,
993 DEControllerKeyListener *key_listener)
995 handle_keygrab (controller, key_listener, _deregister_keygrab);
996 if (controller->xevie_display == NULL)
997 spi_controller_update_key_grabs (controller, NULL);
1001 append_keystroke_listener (DBusMessageIter *iter, DEControllerKeyListener *listener)
1003 dbus_uint32_t d_uint;
1004 DBusMessageIter iter_struct, iter_subarray, iter_substruct;
1007 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1011 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1012 &listener->listener.bus_name);
1013 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1014 &listener->listener.path);
1015 d_uint = listener->listener.type;
1016 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1017 d_uint = listener->listener.types;
1018 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1019 if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY,
1020 "(iisi)", &iter_subarray))
1022 dbus_message_iter_close_container (iter, &iter_struct);
1025 for (kl = listener->keys; kl; kl = kl->next)
1027 Accessibility_KeyDefinition *kd = kl->data;
1028 if (!dbus_message_iter_open_container (&iter_subarray, DBUS_TYPE_STRUCT,
1029 NULL, &iter_substruct))
1031 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keycode);
1032 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keysym);
1033 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_STRING, &kd->keystring);
1034 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->unused);
1035 dbus_message_iter_close_container (&iter_subarray, &iter_substruct);
1037 dbus_message_iter_close_container (&iter_struct, &iter_subarray);
1038 d_uint = listener->mask;
1039 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1040 if (dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT,
1041 NULL, &iter_substruct))
1045 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1046 &listener->mode->synchronous);
1047 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1048 &listener->mode->preemptive);
1049 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1050 &listener->mode->global);
1054 dbus_bool_t dummy_val = FALSE;
1055 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1057 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1059 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1062 dbus_message_iter_close_container (&iter_struct, &iter_substruct);
1064 dbus_message_iter_close_container (iter, &iter_struct);
1068 notify_keystroke_listener (SpiDEController *controller,
1069 DEControllerKeyListener *listener,
1072 const char *path = SPI_DBUS_PATH_DEC;
1073 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1074 const char *name = (enable
1075 ? "KeystrokeListenerRegistered"
1076 : "KeystrokeListenerDeregistered");
1077 DBusMessage *signal;
1078 DBusMessageIter iter;
1080 signal = dbus_message_new_signal (path, interface, name);
1083 dbus_message_iter_init_append (signal, &iter);
1084 append_keystroke_listener (&iter, listener);
1085 dbus_connection_send (controller->bus, signal, NULL);
1086 dbus_message_unref (signal);
1090 append_mouse_listener (DBusMessageIter *iter, DEControllerListener *listener)
1092 DBusMessageIter iter_struct;
1093 dbus_uint32_t d_uint;
1095 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1098 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1099 &listener->bus_name);
1100 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1102 d_uint = listener->types;
1103 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1104 dbus_message_iter_close_container (iter, &iter_struct);
1108 notify_mouse_listener (SpiDEController *controller,
1109 DEControllerListener *listener,
1112 const char *path = SPI_DBUS_PATH_DEC;
1113 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1114 const char *name = (enable
1115 ? "DeviceListenerRegistered"
1116 : "DeviceListenerDeregistered");
1117 DBusMessage *signal;
1118 DBusMessageIter iter;
1120 signal = dbus_message_new_signal (path, interface, name);
1123 dbus_message_iter_init_append (signal, &iter);
1124 append_mouse_listener (&iter, listener);
1125 dbus_connection_send (controller->bus, signal, NULL);
1126 dbus_message_unref (signal);
1130 spi_controller_register_device_listener (SpiDEController *controller,
1131 DEControllerListener *listener)
1133 DEControllerKeyListener *key_listener;
1136 switch (listener->type) {
1137 case SPI_DEVICE_TYPE_KBD:
1138 key_listener = (DEControllerKeyListener *) listener;
1140 controller->key_listeners = g_list_prepend (controller->key_listeners,
1142 spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
1143 if (key_listener->mode->global)
1145 retval = spi_controller_register_global_keygrabs (controller, key_listener);
1150 notify_keystroke_listener (controller, key_listener, TRUE);
1152 case SPI_DEVICE_TYPE_MOUSE:
1153 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1154 if (!have_mouse_listener)
1156 have_mouse_listener = TRUE;
1157 if (!have_mouse_event_listener)
1158 g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1160 spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1161 notify_mouse_listener (controller, listener, TRUE);
1170 set_reply (DBusPendingCall *pending, void *user_data)
1172 void **replyptr = (void **)user_data;
1174 *replyptr = dbus_pending_call_steal_reply (pending);
1177 static GSList *hung_processes = NULL;
1180 reset_hung_process (DBusPendingCall *pending, void *data)
1182 DBusMessage *message = data;
1183 const char *dest = dbus_message_get_destination (message);
1186 /* At this point we don't care about the result */
1187 dbus_pending_call_unref (pending);
1189 for (l = hung_processes; l; l = l->next)
1191 if (!strcmp (l->data, dest))
1194 hung_processes = g_slist_remove (hung_processes, l->data);
1201 time_elapsed (struct timeval *origin)
1205 gettimeofday (&tv, NULL);
1206 return (tv.tv_sec - origin->tv_sec) * 1000 + (tv.tv_usec - origin->tv_usec) / 1000;
1210 reset_hung_process_from_ping (DBusPendingCall *pending, void *data)
1214 for (l = hung_processes; l; l = l->next)
1216 if (!strcmp (l->data, data))
1219 hung_processes = g_slist_remove (hung_processes, l->data);
1224 dbus_pending_call_unref (pending);
1227 static DBusMessage *
1228 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1230 DBusPendingCall *pending;
1231 DBusMessage *reply = NULL;
1234 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1238 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1239 gettimeofday (&tv, NULL);
1242 if (!dbus_connection_read_write_dispatch (bus, timeout) ||
1243 time_elapsed (&tv) > timeout)
1245 const char *dest = dbus_message_get_destination (message);
1247 gchar *bus_name_dup;
1248 dbus_message_ref (message);
1249 dbus_pending_call_set_notify (pending, reset_hung_process, message,
1250 (DBusFreeFunction) dbus_message_unref);
1251 message = dbus_message_new_method_call (dest, "/",
1252 "org.freedesktop.DBus.Peer",
1256 dbus_connection_send_with_reply (bus, message, &pending, -1);
1257 dbus_message_unref (message);
1260 bus_name_dup = g_strdup (dest);
1261 dbus_pending_call_set_notify (pending, reset_hung_process_from_ping,
1262 bus_name_dup, NULL);
1263 for (l = hung_processes; l; l = l->next)
1264 if (!strcmp (l->data, dest))
1266 hung_processes = g_slist_prepend (hung_processes, g_strdup (dest));
1270 dbus_pending_call_unref (pending);
1274 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1275 SpiRegistry *registry,
1276 DEControllerListener *listener,
1277 const Accessibility_DeviceEvent *key_event)
1279 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1281 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1283 dbus_bool_t consumed = FALSE;
1285 gboolean hung = FALSE;
1287 for (l = hung_processes; l; l = l->next)
1289 if (!strcmp (l->data, listener->bus_name))
1291 dbus_message_set_no_reply (message, TRUE);
1297 if (spi_dbus_marshal_deviceEvent(message, key_event))
1303 dbus_connection_send (controller->bus, message, NULL);
1304 dbus_message_unref (message);
1308 reply = send_and_allow_reentry (controller->bus, message, 3000, NULL);
1311 dbus_message_get_args(reply, NULL, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1312 dbus_message_unref(reply);
1315 dbus_message_unref(message);
1320 spi_controller_notify_mouselisteners (SpiDEController *controller,
1321 const Accessibility_DeviceEvent *event)
1324 GSList *notify = NULL, *l2;
1325 GList **listeners = &controller->mouse_listeners;
1326 gboolean is_consumed;
1327 #ifdef SPI_KEYEVENT_DEBUG
1328 gboolean found = FALSE;
1335 for (l = *listeners; l; l = l->next)
1337 DEControllerListener *listener = l->data;
1339 if (spi_eventtype_seq_contains_event (listener->types, event))
1341 /* we clone (don't dup) the listener, to avoid refcount inc. */
1342 notify = g_slist_prepend (notify,
1343 spi_listener_clone (listener));
1344 #ifdef SPI_KEYEVENT_DEBUG
1350 #ifdef SPI_KEYEVENT_DEBUG
1353 g_print ("no match for event\n");
1357 is_consumed = FALSE;
1358 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1360 DEControllerListener *listener = l2->data;
1362 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1364 spi_listener_clone_free ((DEControllerListener *) l2->data);
1367 for (; l2; l2 = l2->next)
1369 DEControllerListener *listener = l2->data;
1370 spi_listener_clone_free (listener);
1371 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1374 g_slist_free (notify);
1377 if (is_consumed) g_message ("consumed\n");
1383 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1386 Accessibility_DeviceEvent mouse_e;
1387 gchar event_detail[3];
1388 gboolean is_consumed = FALSE;
1389 gboolean xkb_mod_unlatch_occurred;
1390 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1391 dbus_uint32_t ix, iy;
1393 int button = xbutton_event->button;
1395 unsigned int mouse_button_state = xbutton_event->state;
1400 mouse_button_state |= Button1Mask;
1403 mouse_button_state |= Button2Mask;
1406 mouse_button_state |= Button3Mask;
1409 mouse_button_state |= Button4Mask;
1412 mouse_button_state |= Button5Mask;
1416 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1417 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1420 fprintf (stderr, "mouse button %d %s (%x)\n",
1421 xbutton_event->button,
1422 (xevent->type == ButtonPress) ? "Press" : "Release",
1423 mouse_button_state);
1425 snprintf (event_detail, 3, "%d%c", button,
1426 (xevent->type == ButtonPress) ? 'p' : 'r');
1428 /* TODO: FIXME distinguish between physical and logical buttons */
1429 mouse_e.type = (xevent->type == ButtonPress) ?
1430 Accessibility_BUTTON_PRESSED_EVENT :
1431 Accessibility_BUTTON_RELEASED_EVENT;
1432 mouse_e.id = button;
1433 mouse_e.hw_code = button;
1434 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1435 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1436 mouse_e.event_string = "";
1437 mouse_e.is_text = FALSE;
1438 if ((mouse_button_state & mouse_button_mask) !=
1439 (mouse_mask_state & mouse_button_mask))
1441 if ((mouse_mask_state & key_modifier_mask) !=
1442 (mouse_button_state & key_modifier_mask))
1443 spi_dec_emit_modifier_event (controller,
1444 mouse_mask_state, mouse_button_state);
1445 mouse_mask_state = mouse_button_state;
1447 spi_controller_notify_mouselisteners (controller, &mouse_e);
1448 ix = last_mouse_pos->x;
1449 iy = last_mouse_pos->y;
1450 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1453 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1454 xevent->type == ButtonRelease);
1456 /* if client wants to consume this event, and XKB latch state was
1457 * unset by this button event, we reset it
1459 if (is_consumed && xkb_mod_unlatch_occurred)
1460 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1462 XAllowEvents (spi_get_display (),
1463 (is_consumed) ? SyncPointer : ReplayPointer,
1468 global_filter_fn (XEvent *xevent, void *data)
1470 SpiDEController *controller;
1471 DEControllerPrivateData *priv;
1472 Display *display = spi_get_display ();
1473 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1474 priv = (DEControllerPrivateData *)
1475 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1477 if (xevent->type == MappingNotify)
1480 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1482 if (controller->xevie_display == NULL)
1484 gboolean is_consumed;
1487 spi_device_event_controller_forward_key_event (controller, xevent);
1494 n_events = XPending (display);
1496 #ifdef SPI_KEYEVENT_DEBUG
1497 g_print ("Number of events pending: %d\n", n_events);
1499 for (i = 0; i < n_events; i++)
1501 XNextEvent (display, &next_event);
1502 if (next_event.type != KeyPress &&
1503 next_event.type != KeyRelease)
1504 g_warning ("Unexpected event type %d in queue", next_event.type);
1507 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1509 XUngrabKeyboard (display, CurrentTime);
1513 if (xevent->type == KeyPress)
1514 wait_for_release_event (xevent, controller);
1515 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1521 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1523 spi_device_event_controller_forward_mouse_event (controller, xevent);
1525 if (xevent->type == priv->xkb_base_event_code)
1527 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1528 /* ugly but probably necessary...*/
1529 XSynchronize (display, TRUE);
1531 if (xkb_ev->xkb_type == XkbStateNotify)
1533 XkbStateNotifyEvent *xkb_snev =
1534 (XkbStateNotifyEvent *) xkb_ev;
1535 /* check the mouse, to catch mouse events grabbed by
1536 * another client; in case we should revert this XKB delatch
1538 if (!priv->pending_xkb_mod_relatch_mask)
1542 spi_dec_mouse_check (controller, &x, &y, &moved);
1544 /* we check again, since the previous call may have
1545 changed this flag */
1546 if (priv->pending_xkb_mod_relatch_mask)
1548 unsigned int feedback_mask;
1549 #ifdef SPI_XKB_DEBUG
1550 fprintf (stderr, "relatching %x\n",
1551 priv->pending_xkb_mod_relatch_mask);
1553 /* temporarily turn off the latch bell, if it's on */
1554 XkbGetControls (display,
1555 XkbAccessXFeedbackMask,
1557 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1558 if (feedback_mask & XkbAX_StickyKeysFBMask)
1560 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1562 priv->xkb_desc->ctrls->ax_options
1563 &= ~(XkbAX_StickyKeysFBMask);
1564 XkbChangeControls (display, priv->xkb_desc, &changes);
1566 /* TODO: account for lock as well as latch */
1567 XkbLatchModifiers (display,
1569 priv->pending_xkb_mod_relatch_mask,
1570 priv->pending_xkb_mod_relatch_mask);
1571 if (feedback_mask & XkbAX_StickyKeysFBMask)
1573 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1575 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1576 XkbChangeControls (display, priv->xkb_desc, &changes);
1578 #ifdef SPI_XKB_DEBUG
1579 fprintf (stderr, "relatched %x\n",
1580 priv->pending_xkb_mod_relatch_mask);
1582 priv->pending_xkb_mod_relatch_mask = 0;
1586 priv->xkb_latch_mask = xkb_snev->latched_mods;
1589 XSynchronize (display, FALSE);
1596 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1598 if (error->error_code == BadAccess)
1600 g_message ("Could not complete key grab: grab already in use.\n");
1601 spi_error_code = BadAccess;
1606 return (*x_default_error_handler) (display, error);
1611 spi_controller_register_with_devices (SpiDEController *controller)
1613 DEControllerPrivateData *priv;
1614 int event_base, error_base, major_version, minor_version;
1616 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1617 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1619 XTestGrabControl (spi_get_display (), True);
1622 /* calls to device-specific implementations and routines go here */
1623 /* register with: keyboard hardware code handler */
1624 /* register with: (translated) keystroke handler */
1626 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1627 &priv->xkb_major_extension_opcode,
1628 &priv->xkb_base_event_code,
1629 &priv->xkb_base_error_code, NULL, NULL);
1633 guint64 reserved = 0;
1634 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1635 XkbSelectEvents (spi_get_display (),
1637 XkbStateNotifyMask, XkbStateNotifyMask);
1638 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1640 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1642 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1644 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1646 /* don't use this one if there's a grab client! */
1648 /* Runtime errors are generated from these functions,
1649 * that are then quashed. Equivalent to:
1656 spi_x_error_trap ();
1657 XGrabKey (spi_get_display (), i, 0,
1658 spi_get_root_window (),
1660 GrabModeSync, GrabModeSync);
1661 XSync (spi_get_display (), TRUE);
1662 XUngrabKey (spi_get_display (), i, 0,
1663 spi_get_root_window ());
1664 if (!spi_x_error_release ())
1674 priv->reserved_keycode = reserved;
1675 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1679 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1680 priv->reserved_keysym = XK_numbersign;
1682 #ifdef SPI_RESERVED_DEBUG
1684 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1685 fprintf (stderr, "%x\n", sym);
1686 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1688 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1693 spi_set_filter (global_filter_fn, controller);
1694 spi_set_events (KeyPressMask | KeyReleaseMask);
1696 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1700 spi_key_set_contains_key (GSList *key_set,
1701 const Accessibility_DeviceEvent *key_event)
1710 g_print ("null key set!\n");
1715 len = g_slist_length (key_set);
1717 if (len == 0) /* special case, means "all keys/any key" */
1720 g_print ("anykey\n");
1725 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1727 Accessibility_KeyDefinition *kd = l->data;
1728 #ifdef SPI_KEYEVENT_DEBUG
1729 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1733 (int) key_event->id,
1734 (int) key_event->hw_code,
1735 key_event->event_string);
1737 if (kd->keysym == (dbus_uint32_t) key_event->id)
1741 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1745 if (key_event->event_string && key_event->event_string[0] &&
1746 !strcmp (kd->keystring, key_event->event_string))
1756 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1757 const Accessibility_DeviceEvent *event)
1759 if (types == 0) /* special case, means "all events/any event" */
1764 return (types & (1 << event->type));
1768 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1769 DEControllerKeyListener *listener,
1770 dbus_bool_t is_system_global)
1772 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1773 spi_key_set_contains_key (listener->keys, key_event) &&
1774 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1775 (is_system_global == listener->mode->global))
1786 spi_controller_notify_keylisteners (SpiDEController *controller,
1787 Accessibility_DeviceEvent *key_event,
1788 dbus_bool_t is_system_global)
1791 GSList *notify = NULL, *l2;
1792 GList **key_listeners = &controller->key_listeners;
1793 gboolean is_consumed;
1800 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1801 if (key_event->modifiers & _numlock_physical_mask)
1802 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1804 for (l = *key_listeners; l; l = l->next)
1806 DEControllerKeyListener *key_listener = l->data;
1808 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1810 /* we clone (don't dup) the listener, to avoid refcount inc. */
1811 notify = g_slist_prepend (notify,
1812 spi_key_listener_clone (key_listener));
1816 #ifdef SPI_KEYEVENT_DEBUG
1819 g_print ("no match for event\n");
1823 is_consumed = FALSE;
1824 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1826 DEControllerKeyListener *key_listener = l2->data;
1828 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1829 key_listener->mode->preemptive;
1831 spi_key_listener_clone_free (key_listener);
1834 for (; l2; l2 = l2->next)
1836 DEControllerKeyListener *key_listener = l2->data;
1837 spi_key_listener_clone_free (key_listener);
1838 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1841 g_slist_free (notify);
1844 if (is_consumed) g_message ("consumed\n");
1850 spi_clear_error_state (void)
1852 gboolean retval = spi_error_code != 0;
1857 static Accessibility_DeviceEvent
1858 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1860 Accessibility_DeviceEvent key_event;
1862 const int cbuf_bytes = 20;
1866 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1867 key_event.id = (dbus_int32_t)(keysym);
1868 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1869 if (((XEvent *) x_key_event)->type == KeyPress)
1871 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1875 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1877 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1878 key_event.is_text = FALSE;
1882 key_event.event_string = g_strdup ("space");
1885 key_event.event_string = g_strdup ("Tab");
1888 key_event.event_string = g_strdup ("Backspace");
1891 key_event.event_string = g_strdup ("Return");
1894 key_event.event_string = g_strdup ("Home");
1897 key_event.event_string = g_strdup ("Page_Down");
1900 key_event.event_string = g_strdup ("Page_Up");
1903 key_event.event_string = g_strdup ("F1");
1906 key_event.event_string = g_strdup ("F2");
1909 key_event.event_string = g_strdup ("F3");
1912 key_event.event_string = g_strdup ("F4");
1915 key_event.event_string = g_strdup ("F5");
1918 key_event.event_string = g_strdup ("F6");
1921 key_event.event_string = g_strdup ("F7");
1924 key_event.event_string = g_strdup ("F8");
1927 key_event.event_string = g_strdup ("F9");
1930 key_event.event_string = g_strdup ("F10");
1933 key_event.event_string = g_strdup ("F11");
1936 key_event.event_string = g_strdup ("F12");
1939 key_event.event_string = g_strdup ("End");
1942 key_event.event_string = g_strdup ("Escape");
1945 key_event.event_string = g_strdup ("Up");
1948 key_event.event_string = g_strdup ("Down");
1951 key_event.event_string = g_strdup ("Left");
1954 key_event.event_string = g_strdup ("Right");
1960 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1961 key_event.event_string = g_strdup (cbuf);
1962 c = keysym2ucs (keysym);
1963 if (c > 0 && !g_unichar_iscntrl (c))
1965 key_event.is_text = TRUE;
1966 /* incorrect for some composed chars? */
1971 key_event.event_string = g_strdup ("");
1975 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1976 #ifdef SPI_KEYEVENT_DEBUG
1978 char *pressed_str = "pressed";
1979 char *released_str = "released";
1982 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1983 state_ptr = pressed_str;
1985 state_ptr = released_str;
1988 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1989 (unsigned long) keysym,
1991 keysym ? (int) keysym : '*',
1992 (int) x_key_event->state,
1993 key_event.event_string,
1994 key_event.event_string[0],
1995 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1999 fprintf (stderr, "%s%c\n",
2000 (x_key_event->state & Mod1Mask)?"Alt-":"",
2001 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
2002 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
2003 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
2004 #endif /* SPI_DEBUG */
2009 spi_controller_update_key_grabs (SpiDEController *controller,
2010 Accessibility_DeviceEvent *recv)
2013 gboolean update_failed = FALSE;
2014 KeyCode keycode = 0;
2016 g_return_val_if_fail (controller != NULL, FALSE);
2019 * masks known to work with default RH 7.1+:
2020 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
2021 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
2022 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
2023 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
2025 * ControlMask grabs are broken, must be in use already
2028 keycode = keycode_for_keysym (controller, recv->id, NULL);
2029 for (l = controller->keygrabs_list; l; l = next)
2032 gboolean re_issue_grab;
2033 DEControllerGrabMask *grab_mask = l->data;
2037 re_issue_grab = recv &&
2038 (recv->modifiers & grab_mask->mod_mask) &&
2039 (grab_mask->key_val == keycode);
2042 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
2043 (long int) grab_mask->key_val,
2044 (long int) grab_mask->mod_mask,
2045 grab_mask->pending_add ? '+' : '.',
2046 grab_mask->pending_remove ? '-' : '.',
2047 re_issue_grab ? "re-issue": "");
2052 if (grab_mask->pending_add && grab_mask->pending_remove)
2056 else if (grab_mask->pending_remove)
2059 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
2061 XUngrabKey (spi_get_display (),
2063 grab_mask->mod_mask,
2064 spi_get_root_window ());
2068 else if (grab_mask->pending_add || re_issue_grab)
2072 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
2074 XGrabKey (spi_get_display (),
2076 grab_mask->mod_mask,
2077 spi_get_root_window (),
2081 XSync (spi_get_display (), False);
2082 update_failed = spi_clear_error_state ();
2083 if (update_failed) {
2084 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
2089 grab_mask->pending_add = FALSE;
2090 grab_mask->pending_remove = FALSE;
2094 g_assert (grab_mask->ref_count <= 0);
2096 controller->keygrabs_list = g_list_delete_link (
2097 controller->keygrabs_list, l);
2099 spi_grab_mask_free (grab_mask);
2104 return ! update_failed;
2108 * Implemented GObject::finalize
2111 spi_device_event_controller_object_finalize (GObject *object)
2113 SpiDEController *controller;
2114 DEControllerPrivateData *private;
2115 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
2116 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
2118 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
2120 /* disconnect any special listeners, get rid of outstanding keygrabs */
2121 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
2124 if (controller->xevie_display != NULL)
2126 XevieEnd(controller->xevie_display);
2127 #ifdef SPI_KEYEVENT_DEBUG
2128 printf("XevieEnd(dpy) finished \n");
2133 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
2134 if (private->xkb_desc)
2135 XkbFreeKeyboard (private->xkb_desc, 0, True);
2137 parent_class->finalize (object);
2141 * DBus Accessibility::DEController::RegisterKeystrokeListener
2142 * method implementation
2144 static DBusMessage *
2145 impl_register_keystroke_listener (DBusConnection *bus,
2146 DBusMessage *message,
2149 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2150 DEControllerKeyListener *dec_listener;
2151 DBusMessageIter iter, iter_array;
2153 GSList *keys = NULL;
2154 dbus_int32_t mask, type;
2155 Accessibility_EventListenerMode *mode;
2157 DBusMessage *reply = NULL;
2160 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu(bbb)") != 0)
2161 return invalid_arguments_error (message);
2163 dbus_message_iter_init(message, &iter);
2164 dbus_message_iter_get_basic(&iter, &path);
2165 dbus_message_iter_next(&iter);
2166 dbus_message_iter_recurse(&iter, &iter_array);
2167 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2169 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2170 if (!spi_dbus_message_iter_get_struct(&iter_array, DBUS_TYPE_INT32, &kd->keycode, DBUS_TYPE_INT32, &kd->keysym, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_INVALID))
2174 kd->keystring = g_strdup (keystring);
2175 keys = g_slist_append(keys, kd);
2177 dbus_message_iter_next(&iter);
2178 dbus_message_iter_get_basic(&iter, &mask);
2179 dbus_message_iter_next(&iter);
2180 dbus_message_iter_get_basic(&iter, &type);
2181 dbus_message_iter_next(&iter);
2182 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
2185 spi_dbus_message_iter_get_struct(&iter, DBUS_TYPE_BOOLEAN, &mode->synchronous, DBUS_TYPE_BOOLEAN, &mode->preemptive, DBUS_TYPE_BOOLEAN, &mode->global, DBUS_TYPE_INVALID);
2188 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
2189 dbus_message_get_sender(message), path, (unsigned long) mask);
2191 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
2193 ret = spi_controller_register_device_listener (
2194 controller, (DEControllerListener *) dec_listener);
2195 reply = dbus_message_new_method_return (message);
2198 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2204 * DBus Accessibility::DEController::RegisterDeviceEventListener
2205 * method implementation
2207 static DBusMessage *
2208 impl_register_device_event_listener (DBusConnection *bus,
2209 DBusMessage *message,
2212 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2213 DEControllerListener *dec_listener;
2215 dbus_int32_t event_types;
2217 DBusMessage *reply = NULL;
2219 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2221 return invalid_arguments_error (message);
2223 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2224 ret = spi_controller_register_device_listener (
2225 controller, (DEControllerListener *) dec_listener);
2226 reply = dbus_message_new_method_return (message);
2229 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2235 DBusConnection *bus;
2236 DEControllerListener *listener;
2237 } RemoveListenerClosure;
2239 static SpiReEntrantContinue
2240 remove_listener_cb (GList * const *list,
2243 DEControllerListener *listener = (*list)->data;
2244 RemoveListenerClosure *ctx = user_data;
2246 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2247 !strcmp(ctx->listener->path, listener->path))
2249 spi_re_entrant_list_delete_link (list);
2250 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2251 spi_dec_listener_free (listener);
2254 return SPI_RE_ENTRANT_CONTINUE;
2257 static SpiReEntrantContinue
2258 copy_key_listener_cb (GList * const *list,
2261 DEControllerKeyListener *key_listener = (*list)->data;
2262 RemoveListenerClosure *ctx = user_data;
2264 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2265 !strcmp(ctx->listener->path, key_listener->listener.path))
2267 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2268 DEControllerKeyListener *ctx_key_listener =
2269 (DEControllerKeyListener *) ctx->listener;
2270 keylist_free (ctx_key_listener->keys);
2271 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2274 return SPI_RE_ENTRANT_CONTINUE;
2278 spi_controller_deregister_device_listener (SpiDEController *controller,
2279 DEControllerListener *listener)
2281 RemoveListenerClosure ctx;
2283 ctx.bus = controller->bus;
2284 ctx.listener = listener;
2286 notify_mouse_listener (controller, listener, FALSE);
2288 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2289 remove_listener_cb, &ctx);
2290 if (!controller->mouse_listeners)
2291 have_mouse_listener = FALSE;
2295 spi_deregister_controller_key_listener (SpiDEController *controller,
2296 DEControllerKeyListener *key_listener)
2298 RemoveListenerClosure ctx;
2300 ctx.bus = controller->bus;
2301 ctx.listener = (DEControllerListener *) spi_key_listener_clone (key_listener);
2303 notify_keystroke_listener (controller, key_listener, FALSE);
2305 /* special case, copy keyset from existing controller list entry */
2306 if (g_slist_length(key_listener->keys) == 0)
2308 spi_re_entrant_list_foreach (&controller->key_listeners,
2309 copy_key_listener_cb, &ctx);
2312 spi_controller_deregister_global_keygrabs (controller, key_listener);
2314 spi_re_entrant_list_foreach (&controller->key_listeners,
2315 remove_listener_cb, &ctx);
2317 spi_key_listener_clone_free ((DEControllerKeyListener *) ctx.listener);
2321 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2325 for (l = controller->mouse_listeners; l; l = tmp)
2327 DEControllerListener *listener = l->data;
2329 if (!strcmp (listener->bus_name, bus_name))
2331 spi_controller_deregister_device_listener (controller, listener);
2332 tmp = controller->mouse_listeners;
2335 for (l = controller->key_listeners; l; l = tmp)
2337 DEControllerKeyListener *key_listener = l->data;
2339 if (!strcmp (key_listener->listener.bus_name, bus_name))
2341 /* TODO: untangle the below line(s) */
2342 spi_deregister_controller_key_listener (controller, key_listener);
2343 tmp = controller->key_listeners;
2349 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2350 * method implementation
2352 static DBusMessage *
2353 impl_deregister_keystroke_listener (DBusConnection *bus,
2354 DBusMessage *message,
2357 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2358 DEControllerKeyListener *key_listener;
2359 DBusMessageIter iter, iter_array;
2361 GSList *keys = NULL;
2362 dbus_int32_t mask, type;
2363 DBusMessage *reply = NULL;
2365 dbus_message_iter_init(message, &iter);
2366 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu") != 0)
2368 g_warning ("Received DeregisterKeystrokeListener with strange signature '%s'", dbus_message_get_signature (message));
2369 return invalid_arguments_error (message);
2372 dbus_message_iter_get_basic(&iter, &path);
2373 dbus_message_iter_next(&iter);
2374 dbus_message_iter_recurse(&iter, &iter_array);
2375 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2377 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2380 if (!spi_dbus_message_iter_get_struct(&iter_array, DBUS_TYPE_INT32, &kd->keycode, DBUS_TYPE_INT32, &kd->keysym, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_INVALID))
2384 kd->keystring = g_strdup (keystring);
2385 keys = g_slist_append(keys, kd);
2387 dbus_message_iter_next(&iter);
2388 dbus_message_iter_get_basic(&iter, &mask);
2389 dbus_message_iter_next(&iter);
2390 dbus_message_iter_get_basic(&iter, &type);
2391 dbus_message_iter_next(&iter);
2392 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2393 #ifdef SPI_DEREGISTER_DEBUG
2394 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2395 (void *) l, (unsigned long) mask->value);
2398 spi_deregister_controller_key_listener (controller, key_listener);
2400 spi_dec_listener_free ((DEControllerListener *) key_listener);
2401 reply = dbus_message_new_method_return (message);
2406 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2407 * method implementation
2409 static DBusMessage *
2410 impl_deregister_device_event_listener (DBusConnection *bus,
2411 DBusMessage *message,
2414 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2415 DEControllerListener *listener;
2417 dbus_int32_t event_types;
2418 DBusMessage *reply = NULL;
2420 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2422 return invalid_arguments_error (message);
2424 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2425 spi_controller_deregister_device_listener (
2426 controller, listener);
2427 reply = dbus_message_new_method_return (message);
2431 static DBusMessage *
2432 impl_get_keystroke_listeners (DBusConnection *bus,
2433 DBusMessage *message,
2436 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2437 DBusMessageIter iter, iter_array;
2438 DBusMessage *reply = dbus_message_new_method_return (message);
2444 dbus_message_iter_init_append (reply, &iter);
2445 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2446 "(souua(iisi)u(bbb))", &iter_array);
2447 for (l = controller->key_listeners; l; l = l->next)
2449 append_keystroke_listener (&iter_array, l->data);
2451 dbus_message_iter_close_container (&iter, &iter_array);
2455 static DBusMessage *
2456 impl_get_device_event_listeners (DBusConnection *bus,
2457 DBusMessage *message,
2460 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2461 DBusMessageIter iter, iter_array;
2463 DBusMessage *reply = dbus_message_new_method_return (message);
2468 dbus_message_iter_init_append (reply, &iter);
2469 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2470 "(sou)", &iter_array);
2471 for (l = controller->key_listeners; l; l = l->next)
2473 append_mouse_listener (&iter_array, l->data);
2475 dbus_message_iter_close_container (&iter, &iter_array);
2479 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2481 unsigned int retval = 0;
2482 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2483 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2485 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2486 retval = XkbGetSlowKeysDelay (spi_get_display (),
2487 XkbUseCoreKbd, &bounce_delay);
2489 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2491 Status s = XkbGetControls (spi_get_display (),
2492 XkbAllControlsMask, priv->xkb_desc);
2495 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2496 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2501 #ifdef SPI_XKB_DEBUG
2502 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2507 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2509 unsigned int retval = 0;
2510 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2511 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2513 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2514 retval = XkbGetBounceKeysDelay (spi_get_display (),
2515 XkbUseCoreKbd, &bounce_delay);
2517 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2519 Status s = XkbGetControls (spi_get_display (),
2520 XkbAllControlsMask, priv->xkb_desc);
2523 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2524 retval = priv->xkb_desc->ctrls->debounce_delay;
2529 #ifdef SPI_XKB_DEBUG
2530 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2536 dec_synth_keycode_press (SpiDEController *controller,
2537 unsigned int keycode)
2539 unsigned int time = CurrentTime;
2540 unsigned int bounce_delay;
2541 unsigned int elapsed_msec;
2543 DEControllerPrivateData *priv =
2544 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2545 spi_dec_private_quark);
2546 if (keycode == priv->last_release_keycode)
2548 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2551 gettimeofday (&tv, NULL);
2553 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2554 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2555 #ifdef SPI_XKB_DEBUG
2556 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2557 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2559 #ifdef THIS_IS_BROKEN
2560 if (elapsed_msec < bounce_delay)
2561 time = bounce_delay - elapsed_msec + 1;
2563 time = bounce_delay + 10;
2564 /* fudge for broken XTest */
2566 #ifdef SPI_XKB_DEBUG
2567 fprintf (stderr, "waiting %d ms\n", time);
2571 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2572 priv->last_press_keycode = keycode;
2573 XFlush (spi_get_display ());
2574 XSync (spi_get_display (), False);
2575 gettimeofday (&priv->last_press_time, NULL);
2580 dec_synth_keycode_release (SpiDEController *controller,
2581 unsigned int keycode)
2583 unsigned int time = CurrentTime;
2584 unsigned int slow_delay;
2585 unsigned int elapsed_msec;
2587 DEControllerPrivateData *priv =
2588 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2589 spi_dec_private_quark);
2590 if (keycode == priv->last_press_keycode)
2592 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2595 gettimeofday (&tv, NULL);
2597 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2598 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2599 #ifdef SPI_XKB_DEBUG
2600 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2601 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2603 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2604 if (elapsed_msec < slow_delay)
2605 time = slow_delay - elapsed_msec + 1;
2607 time = slow_delay + 10;
2608 /* our XTest seems broken, we have to add slop as above */
2610 #ifdef SPI_XKB_DEBUG
2611 fprintf (stderr, "waiting %d ms\n", time);
2615 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2616 priv->last_release_keycode = keycode;
2617 XSync (spi_get_display (), False);
2618 gettimeofday (&priv->last_release_time, NULL);
2623 dec_get_modifier_state (SpiDEController *controller)
2625 return mouse_mask_state;
2629 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2631 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2632 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2634 if (priv->have_xkb) {
2635 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2636 modifiers, modifiers);
2639 for (mod_index=0;mod_index<8;mod_index++)
2640 if (modifiers & (1<<mod_index))
2641 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2647 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2649 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2650 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2652 if (priv->have_xkb) {
2653 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2657 for (mod_index=0;mod_index<8;mod_index++)
2658 if (modifiers & (1<<mod_index))
2659 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2665 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2667 return ucs2keysym ((long) unichar);
2671 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2673 KeyCode key_synth_code;
2674 unsigned int modifiers, synth_mods, lock_mods;
2676 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2678 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2680 /* TODO: set the modifiers accordingly! */
2681 modifiers = dec_get_modifier_state (controller);
2682 /* side-effect; we may unset mousebutton modifiers here! */
2685 if (synth_mods != modifiers) {
2686 lock_mods = synth_mods & ~modifiers;
2687 dec_lock_modifiers (controller, lock_mods);
2689 dec_synth_keycode_press (controller, key_synth_code);
2690 dec_synth_keycode_release (controller, key_synth_code);
2692 if (synth_mods != modifiers)
2693 dec_unlock_modifiers (controller, lock_mods);
2699 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2701 /* probably we need to create and inject an XIM handler eventually. */
2702 /* for now, try to match the string to existing
2703 * keycode+modifier states.
2707 gunichar unichar = 0;
2709 gboolean retval = TRUE;
2712 maxlen = strlen (keystring) + 1;
2713 keysyms = g_new0 (KeySym, maxlen);
2714 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2719 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2721 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2726 mbytes = g_unichar_to_utf8 (unichar, bytes);
2727 bytes[mbytes] = '\0';
2729 fprintf (stderr, "[unichar %s]", bytes);
2731 keysym = dec_keysym_for_unichar (controller, unichar);
2732 if (keysym == NoSymbol) {
2734 fprintf (stderr, "no keysym for %s", bytes);
2739 keysyms[i++] = keysym;
2740 keystring = g_utf8_next_char (keystring);
2743 XSynchronize (spi_get_display (), TRUE);
2744 for (i = 0; keysyms[i]; ++i) {
2745 if (!dec_synth_keysym (controller, keysyms[i])) {
2747 fprintf (stderr, "could not synthesize %c\n",
2754 XSynchronize (spi_get_display (), FALSE);
2763 * DBus Accessibility::DEController::RegisterKeystrokeListener
2764 * method implementation
2766 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2768 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2769 dbus_int32_t keycode;
2771 dbus_uint32_t synth_type;
2773 DEControllerPrivateData *priv;
2774 DBusMessage *reply = NULL;
2776 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2778 return invalid_arguments_error (message);
2782 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2783 (long) keycode, (int) synth_type);
2785 /* TODO: hide/wrap/remove X dependency */
2788 * TODO: when initializing, query for XTest extension before using,
2789 * and fall back to XSendEvent() if XTest is not available.
2792 spi_x_error_trap ();
2794 priv = (DEControllerPrivateData *)
2795 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2797 if (!priv->have_xkb && xmkeymap==NULL) {
2798 xmkeymap = XGetModifierMapping(spi_get_display ());
2803 case Accessibility_KEY_PRESS:
2804 dec_synth_keycode_press (controller, keycode);
2806 case Accessibility_KEY_PRESSRELEASE:
2807 dec_synth_keycode_press (controller, keycode);
2808 case Accessibility_KEY_RELEASE:
2809 dec_synth_keycode_release (controller, keycode);
2811 case Accessibility_KEY_SYM:
2812 #ifdef SPI_XKB_DEBUG
2813 fprintf (stderr, "KeySym synthesis\n");
2816 * note: we are using long for 'keycode'
2817 * in our arg list; it can contain either
2818 * a keycode or a keysym.
2820 dec_synth_keysym (controller, (KeySym) keycode);
2822 case Accessibility_KEY_STRING:
2823 if (!dec_synth_keystring (controller, keystring))
2824 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2828 if (synth_type == Accessibility_KEY_SYM) {
2832 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2834 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2836 spi_dec_clear_unlatch_pending (controller);
2838 reply = dbus_message_new_method_return (message);
2842 /* Accessibility::DEController::GenerateMouseEvent */
2843 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2848 DBusMessage *reply = NULL;
2850 gboolean err = FALSE;
2851 Display *display = spi_get_display ();
2853 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2855 return invalid_arguments_error (message);
2859 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2860 eventName, (long int) x, (long int) y);
2862 switch (eventName[0])
2865 switch (eventName[1])
2867 /* TODO: check number of buttons before parsing */
2888 if (x != -1 && y != -1)
2890 XTestFakeMotionEvent (display, DefaultScreen (display),
2893 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2894 if (eventName[2] == 'c')
2895 XTestFakeButtonEvent (display, button, FALSE, 1);
2896 else if (eventName[2] == 'd')
2898 XTestFakeButtonEvent (display, button, FALSE, 1);
2899 XTestFakeButtonEvent (display, button, TRUE, 2);
2900 XTestFakeButtonEvent (display, button, FALSE, 3);
2904 case 'r': /* relative motion */
2905 XTestFakeRelativeMotionEvent (display, x, y, 0);
2907 case 'a': /* absolute motion */
2908 XTestFakeMotionEvent (display, DefaultScreen (display),
2912 reply = dbus_message_new_method_return (message);
2916 /* Accessibility::DEController::NotifyListenersSync */
2917 static DBusMessage *
2918 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2920 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2921 Accessibility_DeviceEvent event;
2923 DBusMessage *reply = NULL;
2925 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2927 return invalid_arguments_error (message);
2930 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2931 controller, (int) event.id);
2933 ret = spi_controller_notify_keylisteners (controller,
2934 (Accessibility_DeviceEvent *)
2937 reply = dbus_message_new_method_return (message);
2940 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2945 static DBusMessage *
2946 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2948 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2949 Accessibility_DeviceEvent event;
2950 DBusMessage *reply = NULL;
2952 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2954 return invalid_arguments_error (message);
2957 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2958 controller, (int) event.id);
2960 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2962 reply = dbus_message_new_method_return (message);
2967 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2969 GObjectClass * object_class = (GObjectClass *) klass;
2971 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2973 object_class->finalize = spi_device_event_controller_object_finalize;
2975 if (!spi_dec_private_quark)
2976 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2980 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2986 handle_io (GIOChannel *source,
2987 GIOCondition condition,
2990 SpiDEController *controller = (SpiDEController *) data;
2991 gboolean is_consumed = FALSE;
2994 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2996 if (ev.type == KeyPress || ev.type == KeyRelease)
2997 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
3000 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
3005 #endif /* HAVE_XEVIE */
3008 spi_device_event_controller_init (SpiDEController *device_event_controller)
3010 spi_events_init (spi_get_display());
3014 #endif /* HAVE_XEVIE */
3016 DEControllerPrivateData *private;
3017 device_event_controller->key_listeners = NULL;
3018 device_event_controller->mouse_listeners = NULL;
3019 device_event_controller->keygrabs_list = NULL;
3020 device_event_controller->xevie_display = NULL;
3023 device_event_controller->xevie_display = XOpenDisplay(NULL);
3025 if (XevieStart(device_event_controller->xevie_display) == TRUE)
3027 #ifdef SPI_KEYEVENT_DEBUG
3028 fprintf (stderr, "XevieStart() success \n");
3030 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
3032 fd = ConnectionNumber(device_event_controller->xevie_display);
3033 ioc = g_io_channel_unix_new (fd);
3034 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
3035 g_io_channel_unref (ioc);
3039 device_event_controller->xevie_display = NULL;
3040 #ifdef SPI_KEYEVENT_DEBUG
3041 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
3044 #endif /* HAVE_XEVIE */
3046 private = g_new0 (DEControllerPrivateData, 1);
3047 gettimeofday (&private->last_press_time, NULL);
3048 gettimeofday (&private->last_release_time, NULL);
3049 g_object_set_qdata (G_OBJECT (device_event_controller),
3050 spi_dec_private_quark,
3052 spi_controller_register_with_devices (device_event_controller);
3053 device_event_controller->message_queue = g_queue_new ();
3054 saved_controller = device_event_controller;
3058 spi_device_event_controller_forward_key_event (SpiDEController *controller,
3059 const XEvent *event)
3061 Accessibility_DeviceEvent key_event;
3064 g_assert (event->type == KeyPress || event->type == KeyRelease);
3066 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3068 if (controller->xevie_display == NULL)
3069 spi_controller_update_key_grabs (controller, &key_event);
3071 /* relay to listeners, and decide whether to consume it or not */
3072 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
3073 g_free(key_event.event_string);
3079 is_key_released (KeyCode code)
3084 XQueryKeymap (spi_get_display (), keys);
3085 down = BIT (keys, code);
3090 check_release (gpointer data)
3093 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
3094 KeyCode code = event->hw_code;
3096 released = is_key_released (code);
3100 check_release_handler = 0;
3101 event->type = Accessibility_KEY_RELEASED_EVENT;
3102 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
3104 return (released == 0);
3107 static void wait_for_release_event (XEvent *event,
3108 SpiDEController *controller)
3110 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3111 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
3114 /*---------------------------------------------------------------------------*/
3116 static const char *introspection_header =
3117 "<?xml version=\"1.0\"?>\n";
3119 static const char *introspection_node_element =
3120 "<node name=\"%s\">\n";
3122 static const char *introspection_footer =
3125 static DBusMessage *
3126 impl_Introspect (DBusConnection * bus,
3127 DBusMessage * message, void *user_data)
3132 const gchar *pathstr = SPI_DBUS_PATH_DEC;
3136 output = g_string_new(introspection_header);
3138 g_string_append_printf(output, introspection_node_element, pathstr);
3140 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
3142 g_string_append(output, introspection_footer);
3143 final = g_string_free(output, FALSE);
3145 reply = dbus_message_new_method_return (message);
3146 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
3152 /*---------------------------------------------------------------------------*/
3155 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
3157 const gchar *iface = dbus_message_get_interface (message);
3158 const gchar *member = dbus_message_get_member (message);
3159 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3160 DBusMessage *reply = NULL;
3162 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
3164 result = DBUS_HANDLER_RESULT_HANDLED;
3165 if (!strcmp (member, "RegisterKeystrokeListener"))
3166 reply = impl_register_keystroke_listener (bus, message, user_data);
3167 else if (!strcmp (member, "RegisterDeviceEventListener"))
3168 reply = impl_register_device_event_listener (bus, message, user_data);
3169 else if (!strcmp (member, "DeregisterKeystrokeListener"))
3170 reply = impl_deregister_keystroke_listener (bus, message, user_data);
3171 else if (!strcmp (member, "DeregisterDeviceEventListener"))
3172 reply = impl_deregister_device_event_listener (bus, message, user_data);
3173 else if (!strcmp (member, "GetKeystrokeListeners"))
3174 reply = impl_get_keystroke_listeners (bus, message, user_data);
3175 else if (!strcmp (member, "GetDeviceEventListeners"))
3176 reply = impl_get_device_event_listeners (bus, message, user_data);
3177 else if (!strcmp (member, "GenerateKeyboardEvent"))
3178 reply = impl_generate_keyboard_event (bus, message, user_data);
3179 else if (!strcmp (member, "GenerateMouseEvent"))
3180 reply = impl_generate_mouse_event (bus, message, user_data);
3181 else if (!strcmp (member, "NotifyListenersSync"))
3182 reply = impl_notify_listeners_sync (bus, message, user_data);
3183 else if (!strcmp (member, "NotifyListenersAsync"))
3184 reply = impl_notify_listeners_async (bus, message, user_data);
3186 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3189 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
3191 result = DBUS_HANDLER_RESULT_HANDLED;
3192 if (!strcmp (member, "Introspect"))
3193 reply = impl_Introspect (bus, message, user_data);
3195 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3198 if (result == DBUS_HANDLER_RESULT_HANDLED)
3202 reply = dbus_message_new_method_return (message);
3205 dbus_connection_send (bus, reply, NULL);
3206 dbus_message_unref (reply);
3211 message_queue_dispatch (gpointer data)
3213 saved_controller->message_queue_idle = 0;
3214 while (!g_queue_is_empty (saved_controller->message_queue))
3216 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
3217 data = g_queue_pop_head (saved_controller->message_queue);
3218 handle_dec_method_from_idle (saved_controller->bus, message, data);
3219 dbus_message_unref (message);
3224 static DBusHandlerResult
3225 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
3227 const gchar *iface = dbus_message_get_interface (message);
3228 const gchar *member = dbus_message_get_member (message);
3229 const gint type = dbus_message_get_type (message);
3231 /* Check for basic reasons not to handle */
3232 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3235 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3237 dbus_message_ref (message);
3238 g_queue_push_tail (saved_controller->message_queue, message);
3239 g_queue_push_tail (saved_controller->message_queue, user_data);
3240 if (!saved_controller->message_queue_idle)
3241 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
3242 return DBUS_HANDLER_RESULT_HANDLED;
3245 static DBusObjectPathVTable dec_vtable =
3249 NULL, NULL, NULL, NULL
3253 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
3255 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
3257 dec->registry = g_object_ref (reg);
3258 reg->dec = g_object_ref (dec);
3261 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
3263 spi_dec_init_mouse_listener (dec);
3269 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
3271 if (!have_mouse_event_listener)
3273 have_mouse_event_listener = TRUE;
3274 if (!have_mouse_listener)
3275 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
3280 spi_device_event_controller_stop_poll_mouse (void)
3282 have_mouse_event_listener = FALSE;