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;
1008 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1012 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1013 &listener->listener.bus_name);
1014 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1015 &listener->listener.path);
1016 d_uint = listener->listener.type;
1017 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1018 d_uint = listener->listener.types;
1019 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1020 if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY,
1021 "(iisi)", &iter_subarray))
1023 dbus_message_iter_close_container (iter, &iter_struct);
1026 for (kl = listener->keys; kl; kl = kl->next)
1028 Accessibility_KeyDefinition *kd = kl->data;
1029 if (!dbus_message_iter_open_container (&iter_subarray, DBUS_TYPE_STRUCT,
1030 NULL, &iter_substruct))
1032 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keycode);
1033 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keysym);
1034 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_STRING, &kd->keystring);
1035 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->unused);
1036 dbus_message_iter_close_container (&iter_subarray, &iter_substruct);
1038 dbus_message_iter_close_container (&iter_struct, &iter_subarray);
1039 d_uint = listener->mask;
1040 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1041 if (dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT,
1042 NULL, &iter_substruct))
1046 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1047 &listener->mode->synchronous);
1048 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1049 &listener->mode->preemptive);
1050 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1051 &listener->mode->global);
1055 dbus_bool_t dummy_val = FALSE;
1056 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1058 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1060 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1063 dbus_message_iter_close_container (&iter_struct, &iter_substruct);
1065 dbus_message_iter_close_container (iter, &iter_struct);
1069 notify_keystroke_listener (SpiDEController *controller,
1070 DEControllerKeyListener *listener,
1073 const char *path = SPI_DBUS_PATH_DEC;
1074 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1075 const char *name = (enable
1076 ? "KeystrokeListenerRegistered"
1077 : "KeystrokeListenerDeregistered");
1078 DBusMessage *signal;
1079 DBusMessageIter iter;
1081 signal = dbus_message_new_signal (path, interface, name);
1084 dbus_message_iter_init_append (signal, &iter);
1085 append_keystroke_listener (&iter, listener);
1086 dbus_connection_send (controller->bus, signal, NULL);
1087 dbus_message_unref (signal);
1091 append_mouse_listener (DBusMessageIter *iter, DEControllerListener *listener)
1093 DBusMessageIter iter_struct;
1094 dbus_uint32_t d_uint;
1096 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1099 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1100 &listener->bus_name);
1101 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1103 d_uint = listener->types;
1104 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1105 dbus_message_iter_close_container (iter, &iter_struct);
1109 notify_mouse_listener (SpiDEController *controller,
1110 DEControllerListener *listener,
1113 const char *path = SPI_DBUS_PATH_DEC;
1114 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1115 const char *name = (enable
1116 ? "DeviceListenerRegistered"
1117 : "DeviceListenerDeregistered");
1118 DBusMessage *signal;
1119 DBusMessageIter iter;
1121 signal = dbus_message_new_signal (path, interface, name);
1124 dbus_message_iter_init_append (signal, &iter);
1125 append_mouse_listener (&iter, listener);
1126 dbus_connection_send (controller->bus, signal, NULL);
1127 dbus_message_unref (signal);
1131 spi_controller_register_device_listener (SpiDEController *controller,
1132 DEControllerListener *listener)
1134 DEControllerKeyListener *key_listener;
1137 switch (listener->type) {
1138 case SPI_DEVICE_TYPE_KBD:
1139 key_listener = (DEControllerKeyListener *) listener;
1141 controller->key_listeners = g_list_prepend (controller->key_listeners,
1143 spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
1144 if (key_listener->mode->global)
1146 retval = spi_controller_register_global_keygrabs (controller, key_listener);
1151 notify_keystroke_listener (controller, key_listener, TRUE);
1153 case SPI_DEVICE_TYPE_MOUSE:
1154 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1155 if (!have_mouse_listener)
1157 have_mouse_listener = TRUE;
1158 if (!have_mouse_event_listener)
1159 g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1161 spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1162 notify_mouse_listener (controller, listener, TRUE);
1171 set_reply (DBusPendingCall *pending, void *user_data)
1173 void **replyptr = (void **)user_data;
1175 *replyptr = dbus_pending_call_steal_reply (pending);
1178 static GSList *hung_processes = NULL;
1181 reset_hung_process (DBusPendingCall *pending, void *data)
1183 DBusMessage *message = data;
1184 const char *dest = dbus_message_get_destination (message);
1187 /* At this point we don't care about the result */
1188 dbus_pending_call_unref (pending);
1190 for (l = hung_processes; l; l = l->next)
1192 if (!strcmp (l->data, dest))
1195 hung_processes = g_slist_remove (hung_processes, l->data);
1202 time_elapsed (struct timeval *origin)
1206 gettimeofday (&tv, NULL);
1207 return (tv.tv_sec - origin->tv_sec) * 1000 + (tv.tv_usec - origin->tv_usec) / 1000;
1211 reset_hung_process_from_ping (DBusPendingCall *pending, void *data)
1213 gchar *bus_name = data;
1216 for (l = hung_processes; l; l = l->next)
1218 if (!strcmp (l->data, data))
1221 hung_processes = g_slist_remove (hung_processes, l->data);
1226 dbus_pending_call_unref (pending);
1229 static DBusMessage *
1230 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1232 DBusPendingCall *pending;
1233 DBusMessage *reply = NULL;
1236 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1240 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1241 gettimeofday (&tv, NULL);
1244 if (!dbus_connection_read_write_dispatch (bus, timeout) ||
1245 time_elapsed (&tv) > timeout)
1247 const char *dest = dbus_message_get_destination (message);
1249 gchar *bus_name_dup;
1250 dbus_message_ref (message);
1251 dbus_pending_call_set_notify (pending, reset_hung_process, message,
1252 (DBusFreeFunction) dbus_message_unref);
1253 message = dbus_message_new_method_call (dest, "/",
1254 "org.freedesktop.DBus.Peer",
1258 dbus_connection_send_with_reply (bus, message, &pending, -1);
1259 dbus_message_unref (message);
1262 bus_name_dup = g_strdup (dest);
1263 dbus_pending_call_set_notify (pending, reset_hung_process_from_ping,
1264 bus_name_dup, NULL);
1265 for (l = hung_processes; l; l = l->next)
1266 if (!strcmp (l->data, dest))
1268 hung_processes = g_slist_prepend (hung_processes, g_strdup (dest));
1272 dbus_pending_call_unref (pending);
1276 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1277 SpiRegistry *registry,
1278 DEControllerListener *listener,
1279 const Accessibility_DeviceEvent *key_event)
1281 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1283 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1285 dbus_bool_t consumed = FALSE;
1287 gboolean hung = FALSE;
1289 for (l = hung_processes; l; l = l->next)
1291 if (!strcmp (l->data, listener->bus_name))
1293 dbus_message_set_no_reply (message, TRUE);
1299 if (spi_dbus_marshal_deviceEvent(message, key_event))
1305 dbus_connection_send (controller->bus, message, NULL);
1306 dbus_message_unref (message);
1310 reply = send_and_allow_reentry (controller->bus, message, 3000, NULL);
1313 dbus_message_get_args(reply, NULL, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1314 dbus_message_unref(reply);
1317 dbus_message_unref(message);
1322 spi_controller_notify_mouselisteners (SpiDEController *controller,
1323 const Accessibility_DeviceEvent *event)
1326 GSList *notify = NULL, *l2;
1327 GList **listeners = &controller->mouse_listeners;
1328 gboolean is_consumed;
1329 #ifdef SPI_KEYEVENT_DEBUG
1330 gboolean found = FALSE;
1337 for (l = *listeners; l; l = l->next)
1339 DEControllerListener *listener = l->data;
1341 if (spi_eventtype_seq_contains_event (listener->types, event))
1343 /* we clone (don't dup) the listener, to avoid refcount inc. */
1344 notify = g_slist_prepend (notify,
1345 spi_listener_clone (listener));
1346 #ifdef SPI_KEYEVENT_DEBUG
1352 #ifdef SPI_KEYEVENT_DEBUG
1355 g_print ("no match for event\n");
1359 is_consumed = FALSE;
1360 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1362 DEControllerListener *listener = l2->data;
1364 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1366 spi_listener_clone_free ((DEControllerListener *) l2->data);
1369 for (; l2; l2 = l2->next)
1371 DEControllerListener *listener = l2->data;
1372 spi_listener_clone_free (listener);
1373 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1376 g_slist_free (notify);
1379 if (is_consumed) g_message ("consumed\n");
1385 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1388 Accessibility_DeviceEvent mouse_e;
1389 gchar event_detail[3];
1390 gboolean is_consumed = FALSE;
1391 gboolean xkb_mod_unlatch_occurred;
1392 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1393 dbus_uint32_t ix, iy;
1395 int button = xbutton_event->button;
1397 unsigned int mouse_button_state = xbutton_event->state;
1402 mouse_button_state |= Button1Mask;
1405 mouse_button_state |= Button2Mask;
1408 mouse_button_state |= Button3Mask;
1411 mouse_button_state |= Button4Mask;
1414 mouse_button_state |= Button5Mask;
1418 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1419 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1422 fprintf (stderr, "mouse button %d %s (%x)\n",
1423 xbutton_event->button,
1424 (xevent->type == ButtonPress) ? "Press" : "Release",
1425 mouse_button_state);
1427 snprintf (event_detail, 3, "%d%c", button,
1428 (xevent->type == ButtonPress) ? 'p' : 'r');
1430 /* TODO: FIXME distinguish between physical and logical buttons */
1431 mouse_e.type = (xevent->type == ButtonPress) ?
1432 Accessibility_BUTTON_PRESSED_EVENT :
1433 Accessibility_BUTTON_RELEASED_EVENT;
1434 mouse_e.id = button;
1435 mouse_e.hw_code = button;
1436 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1437 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1438 mouse_e.event_string = "";
1439 mouse_e.is_text = FALSE;
1440 if ((mouse_button_state & mouse_button_mask) !=
1441 (mouse_mask_state & mouse_button_mask))
1443 if ((mouse_mask_state & key_modifier_mask) !=
1444 (mouse_button_state & key_modifier_mask))
1445 spi_dec_emit_modifier_event (controller,
1446 mouse_mask_state, mouse_button_state);
1447 mouse_mask_state = mouse_button_state;
1449 spi_controller_notify_mouselisteners (controller, &mouse_e);
1450 ix = last_mouse_pos->x;
1451 iy = last_mouse_pos->y;
1452 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1455 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1456 xevent->type == ButtonRelease);
1458 /* if client wants to consume this event, and XKB latch state was
1459 * unset by this button event, we reset it
1461 if (is_consumed && xkb_mod_unlatch_occurred)
1462 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1464 XAllowEvents (spi_get_display (),
1465 (is_consumed) ? SyncPointer : ReplayPointer,
1470 global_filter_fn (XEvent *xevent, void *data)
1472 SpiDEController *controller;
1473 DEControllerPrivateData *priv;
1474 Display *display = spi_get_display ();
1475 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1476 priv = (DEControllerPrivateData *)
1477 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1479 if (xevent->type == MappingNotify)
1482 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1484 if (controller->xevie_display == NULL)
1486 gboolean is_consumed;
1489 spi_device_event_controller_forward_key_event (controller, xevent);
1496 n_events = XPending (display);
1498 #ifdef SPI_KEYEVENT_DEBUG
1499 g_print ("Number of events pending: %d\n", n_events);
1501 for (i = 0; i < n_events; i++)
1503 XNextEvent (display, &next_event);
1504 if (next_event.type != KeyPress &&
1505 next_event.type != KeyRelease)
1506 g_warning ("Unexpected event type %d in queue", next_event.type);
1509 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1511 XUngrabKeyboard (display, CurrentTime);
1515 if (xevent->type == KeyPress)
1516 wait_for_release_event (xevent, controller);
1517 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1523 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1525 spi_device_event_controller_forward_mouse_event (controller, xevent);
1527 if (xevent->type == priv->xkb_base_event_code)
1529 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1530 /* ugly but probably necessary...*/
1531 XSynchronize (display, TRUE);
1533 if (xkb_ev->xkb_type == XkbStateNotify)
1535 XkbStateNotifyEvent *xkb_snev =
1536 (XkbStateNotifyEvent *) xkb_ev;
1537 /* check the mouse, to catch mouse events grabbed by
1538 * another client; in case we should revert this XKB delatch
1540 if (!priv->pending_xkb_mod_relatch_mask)
1544 spi_dec_mouse_check (controller, &x, &y, &moved);
1546 /* we check again, since the previous call may have
1547 changed this flag */
1548 if (priv->pending_xkb_mod_relatch_mask)
1550 unsigned int feedback_mask;
1551 #ifdef SPI_XKB_DEBUG
1552 fprintf (stderr, "relatching %x\n",
1553 priv->pending_xkb_mod_relatch_mask);
1555 /* temporarily turn off the latch bell, if it's on */
1556 XkbGetControls (display,
1557 XkbAccessXFeedbackMask,
1559 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1560 if (feedback_mask & XkbAX_StickyKeysFBMask)
1562 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1564 priv->xkb_desc->ctrls->ax_options
1565 &= ~(XkbAX_StickyKeysFBMask);
1566 XkbChangeControls (display, priv->xkb_desc, &changes);
1568 /* TODO: account for lock as well as latch */
1569 XkbLatchModifiers (display,
1571 priv->pending_xkb_mod_relatch_mask,
1572 priv->pending_xkb_mod_relatch_mask);
1573 if (feedback_mask & XkbAX_StickyKeysFBMask)
1575 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1577 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1578 XkbChangeControls (display, priv->xkb_desc, &changes);
1580 #ifdef SPI_XKB_DEBUG
1581 fprintf (stderr, "relatched %x\n",
1582 priv->pending_xkb_mod_relatch_mask);
1584 priv->pending_xkb_mod_relatch_mask = 0;
1588 priv->xkb_latch_mask = xkb_snev->latched_mods;
1591 XSynchronize (display, FALSE);
1598 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1600 if (error->error_code == BadAccess)
1602 g_message ("Could not complete key grab: grab already in use.\n");
1603 spi_error_code = BadAccess;
1608 return (*x_default_error_handler) (display, error);
1613 spi_controller_register_with_devices (SpiDEController *controller)
1615 DEControllerPrivateData *priv;
1616 int event_base, error_base, major_version, minor_version;
1618 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1619 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1621 XTestGrabControl (spi_get_display (), True);
1624 /* calls to device-specific implementations and routines go here */
1625 /* register with: keyboard hardware code handler */
1626 /* register with: (translated) keystroke handler */
1628 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1629 &priv->xkb_major_extension_opcode,
1630 &priv->xkb_base_event_code,
1631 &priv->xkb_base_error_code, NULL, NULL);
1635 guint64 reserved = 0;
1636 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1637 XkbSelectEvents (spi_get_display (),
1639 XkbStateNotifyMask, XkbStateNotifyMask);
1640 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1642 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1644 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1646 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1648 /* don't use this one if there's a grab client! */
1650 /* Runtime errors are generated from these functions,
1651 * that are then quashed. Equivalent to:
1658 spi_x_error_trap ();
1659 XGrabKey (spi_get_display (), i, 0,
1660 spi_get_root_window (),
1662 GrabModeSync, GrabModeSync);
1663 XSync (spi_get_display (), TRUE);
1664 XUngrabKey (spi_get_display (), i, 0,
1665 spi_get_root_window ());
1666 if (!spi_x_error_release ())
1676 priv->reserved_keycode = reserved;
1677 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1681 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1682 priv->reserved_keysym = XK_numbersign;
1684 #ifdef SPI_RESERVED_DEBUG
1686 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1687 fprintf (stderr, "%x\n", sym);
1688 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1690 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1695 spi_set_filter (global_filter_fn, controller);
1696 spi_set_events (KeyPressMask | KeyReleaseMask);
1698 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1702 spi_key_set_contains_key (GSList *key_set,
1703 const Accessibility_DeviceEvent *key_event)
1712 g_print ("null key set!\n");
1717 len = g_slist_length (key_set);
1719 if (len == 0) /* special case, means "all keys/any key" */
1722 g_print ("anykey\n");
1727 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1729 Accessibility_KeyDefinition *kd = l->data;
1730 #ifdef SPI_KEYEVENT_DEBUG
1731 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1735 (int) key_event->id,
1736 (int) key_event->hw_code,
1737 key_event->event_string);
1739 if (kd->keysym == (dbus_uint32_t) key_event->id)
1743 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1747 if (key_event->event_string && key_event->event_string[0] &&
1748 !strcmp (kd->keystring, key_event->event_string))
1758 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1759 const Accessibility_DeviceEvent *event)
1761 if (types == 0) /* special case, means "all events/any event" */
1766 return (types & (1 << event->type));
1770 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1771 DEControllerKeyListener *listener,
1772 dbus_bool_t is_system_global)
1774 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1775 spi_key_set_contains_key (listener->keys, key_event) &&
1776 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1777 (is_system_global == listener->mode->global))
1788 spi_controller_notify_keylisteners (SpiDEController *controller,
1789 Accessibility_DeviceEvent *key_event,
1790 dbus_bool_t is_system_global)
1793 GSList *notify = NULL, *l2;
1794 GList **key_listeners = &controller->key_listeners;
1795 gboolean is_consumed;
1802 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1803 if (key_event->modifiers & _numlock_physical_mask)
1804 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1806 for (l = *key_listeners; l; l = l->next)
1808 DEControllerKeyListener *key_listener = l->data;
1810 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1812 /* we clone (don't dup) the listener, to avoid refcount inc. */
1813 notify = g_slist_prepend (notify,
1814 spi_key_listener_clone (key_listener));
1818 #ifdef SPI_KEYEVENT_DEBUG
1821 g_print ("no match for event\n");
1825 is_consumed = FALSE;
1826 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1828 DEControllerKeyListener *key_listener = l2->data;
1830 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1831 key_listener->mode->preemptive;
1833 spi_key_listener_clone_free (key_listener);
1836 for (; l2; l2 = l2->next)
1838 DEControllerKeyListener *key_listener = l2->data;
1839 spi_key_listener_clone_free (key_listener);
1840 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1843 g_slist_free (notify);
1846 if (is_consumed) g_message ("consumed\n");
1852 spi_clear_error_state (void)
1854 gboolean retval = spi_error_code != 0;
1859 static Accessibility_DeviceEvent
1860 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1862 Accessibility_DeviceEvent key_event;
1864 const int cbuf_bytes = 20;
1868 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1869 key_event.id = (dbus_int32_t)(keysym);
1870 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1871 if (((XEvent *) x_key_event)->type == KeyPress)
1873 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1877 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1879 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1880 key_event.is_text = FALSE;
1884 key_event.event_string = g_strdup ("space");
1887 key_event.event_string = g_strdup ("Tab");
1890 key_event.event_string = g_strdup ("Backspace");
1893 key_event.event_string = g_strdup ("Return");
1896 key_event.event_string = g_strdup ("Home");
1899 key_event.event_string = g_strdup ("Page_Down");
1902 key_event.event_string = g_strdup ("Page_Up");
1905 key_event.event_string = g_strdup ("F1");
1908 key_event.event_string = g_strdup ("F2");
1911 key_event.event_string = g_strdup ("F3");
1914 key_event.event_string = g_strdup ("F4");
1917 key_event.event_string = g_strdup ("F5");
1920 key_event.event_string = g_strdup ("F6");
1923 key_event.event_string = g_strdup ("F7");
1926 key_event.event_string = g_strdup ("F8");
1929 key_event.event_string = g_strdup ("F9");
1932 key_event.event_string = g_strdup ("F10");
1935 key_event.event_string = g_strdup ("F11");
1938 key_event.event_string = g_strdup ("F12");
1941 key_event.event_string = g_strdup ("End");
1944 key_event.event_string = g_strdup ("Escape");
1947 key_event.event_string = g_strdup ("Up");
1950 key_event.event_string = g_strdup ("Down");
1953 key_event.event_string = g_strdup ("Left");
1956 key_event.event_string = g_strdup ("Right");
1962 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1963 key_event.event_string = g_strdup (cbuf);
1964 c = keysym2ucs (keysym);
1965 if (c > 0 && !g_unichar_iscntrl (c))
1967 key_event.is_text = TRUE;
1968 /* incorrect for some composed chars? */
1973 key_event.event_string = g_strdup ("");
1977 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1978 #ifdef SPI_KEYEVENT_DEBUG
1980 char *pressed_str = "pressed";
1981 char *released_str = "released";
1984 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1985 state_ptr = pressed_str;
1987 state_ptr = released_str;
1990 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1991 (unsigned long) keysym,
1993 keysym ? (int) keysym : '*',
1994 (int) x_key_event->state,
1995 key_event.event_string,
1996 key_event.event_string[0],
1997 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
2001 fprintf (stderr, "%s%c\n",
2002 (x_key_event->state & Mod1Mask)?"Alt-":"",
2003 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
2004 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
2005 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
2006 #endif /* SPI_DEBUG */
2011 spi_controller_update_key_grabs (SpiDEController *controller,
2012 Accessibility_DeviceEvent *recv)
2015 gboolean update_failed = FALSE;
2016 KeyCode keycode = 0;
2018 g_return_val_if_fail (controller != NULL, FALSE);
2021 * masks known to work with default RH 7.1+:
2022 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
2023 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
2024 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
2025 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
2027 * ControlMask grabs are broken, must be in use already
2030 keycode = keycode_for_keysym (controller, recv->id, NULL);
2031 for (l = controller->keygrabs_list; l; l = next)
2034 gboolean re_issue_grab;
2035 DEControllerGrabMask *grab_mask = l->data;
2039 re_issue_grab = recv &&
2040 (recv->modifiers & grab_mask->mod_mask) &&
2041 (grab_mask->key_val == keycode);
2044 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
2045 (long int) grab_mask->key_val,
2046 (long int) grab_mask->mod_mask,
2047 grab_mask->pending_add ? '+' : '.',
2048 grab_mask->pending_remove ? '-' : '.',
2049 re_issue_grab ? "re-issue": "");
2054 if (grab_mask->pending_add && grab_mask->pending_remove)
2058 else if (grab_mask->pending_remove)
2061 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
2063 XUngrabKey (spi_get_display (),
2065 grab_mask->mod_mask,
2066 spi_get_root_window ());
2070 else if (grab_mask->pending_add || re_issue_grab)
2074 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
2076 XGrabKey (spi_get_display (),
2078 grab_mask->mod_mask,
2079 spi_get_root_window (),
2083 XSync (spi_get_display (), False);
2084 update_failed = spi_clear_error_state ();
2085 if (update_failed) {
2086 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
2091 grab_mask->pending_add = FALSE;
2092 grab_mask->pending_remove = FALSE;
2096 g_assert (grab_mask->ref_count <= 0);
2098 controller->keygrabs_list = g_list_delete_link (
2099 controller->keygrabs_list, l);
2101 spi_grab_mask_free (grab_mask);
2106 return ! update_failed;
2110 * Implemented GObject::finalize
2113 spi_device_event_controller_object_finalize (GObject *object)
2115 SpiDEController *controller;
2116 DEControllerPrivateData *private;
2117 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
2118 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
2120 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
2122 /* disconnect any special listeners, get rid of outstanding keygrabs */
2123 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
2126 if (controller->xevie_display != NULL)
2128 XevieEnd(controller->xevie_display);
2129 #ifdef SPI_KEYEVENT_DEBUG
2130 printf("XevieEnd(dpy) finished \n");
2135 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
2136 if (private->xkb_desc)
2137 XkbFreeKeyboard (private->xkb_desc, 0, True);
2139 parent_class->finalize (object);
2143 * DBus Accessibility::DEController::RegisterKeystrokeListener
2144 * method implementation
2146 static DBusMessage *
2147 impl_register_keystroke_listener (DBusConnection *bus,
2148 DBusMessage *message,
2151 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2152 DEControllerKeyListener *dec_listener;
2153 DBusMessageIter iter, iter_array;
2155 GSList *keys = NULL;
2156 dbus_int32_t mask, type;
2157 Accessibility_EventListenerMode *mode;
2159 DBusMessage *reply = NULL;
2162 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu(bbb)") != 0)
2163 return invalid_arguments_error (message);
2165 dbus_message_iter_init(message, &iter);
2166 dbus_message_iter_get_basic(&iter, &path);
2167 dbus_message_iter_next(&iter);
2168 dbus_message_iter_recurse(&iter, &iter_array);
2169 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2171 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2172 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))
2176 kd->keystring = g_strdup (keystring);
2177 keys = g_slist_append(keys, kd);
2179 dbus_message_iter_next(&iter);
2180 dbus_message_iter_get_basic(&iter, &mask);
2181 dbus_message_iter_next(&iter);
2182 dbus_message_iter_get_basic(&iter, &type);
2183 dbus_message_iter_next(&iter);
2184 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
2187 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);
2190 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
2191 dbus_message_get_sender(message), path, (unsigned long) mask);
2193 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
2195 ret = spi_controller_register_device_listener (
2196 controller, (DEControllerListener *) dec_listener);
2197 reply = dbus_message_new_method_return (message);
2200 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2206 * DBus Accessibility::DEController::RegisterDeviceEventListener
2207 * method implementation
2209 static DBusMessage *
2210 impl_register_device_event_listener (DBusConnection *bus,
2211 DBusMessage *message,
2214 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2215 DEControllerListener *dec_listener;
2217 dbus_int32_t event_types;
2219 DBusMessage *reply = NULL;
2221 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2223 return invalid_arguments_error (message);
2225 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2226 ret = spi_controller_register_device_listener (
2227 controller, (DEControllerListener *) dec_listener);
2228 reply = dbus_message_new_method_return (message);
2231 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2237 DBusConnection *bus;
2238 DEControllerListener *listener;
2239 } RemoveListenerClosure;
2241 static SpiReEntrantContinue
2242 remove_listener_cb (GList * const *list,
2245 DEControllerListener *listener = (*list)->data;
2246 RemoveListenerClosure *ctx = user_data;
2248 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2249 !strcmp(ctx->listener->path, listener->path))
2251 spi_re_entrant_list_delete_link (list);
2252 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2253 spi_dec_listener_free (listener);
2256 return SPI_RE_ENTRANT_CONTINUE;
2259 static SpiReEntrantContinue
2260 copy_key_listener_cb (GList * const *list,
2263 DEControllerKeyListener *key_listener = (*list)->data;
2264 RemoveListenerClosure *ctx = user_data;
2266 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2267 !strcmp(ctx->listener->path, key_listener->listener.path))
2269 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2270 DEControllerKeyListener *ctx_key_listener =
2271 (DEControllerKeyListener *) ctx->listener;
2272 keylist_free (ctx_key_listener->keys);
2273 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2276 return SPI_RE_ENTRANT_CONTINUE;
2280 spi_controller_deregister_device_listener (SpiDEController *controller,
2281 DEControllerListener *listener)
2283 RemoveListenerClosure ctx;
2285 ctx.bus = controller->bus;
2286 ctx.listener = listener;
2288 notify_mouse_listener (controller, listener, FALSE);
2290 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2291 remove_listener_cb, &ctx);
2292 if (!controller->mouse_listeners)
2293 have_mouse_listener = FALSE;
2297 spi_deregister_controller_key_listener (SpiDEController *controller,
2298 DEControllerKeyListener *key_listener)
2300 RemoveListenerClosure ctx;
2302 ctx.bus = controller->bus;
2303 ctx.listener = (DEControllerListener *) spi_key_listener_clone (key_listener);
2305 notify_keystroke_listener (controller, key_listener, FALSE);
2307 /* special case, copy keyset from existing controller list entry */
2308 if (g_slist_length(key_listener->keys) == 0)
2310 spi_re_entrant_list_foreach (&controller->key_listeners,
2311 copy_key_listener_cb, &ctx);
2314 spi_controller_deregister_global_keygrabs (controller, key_listener);
2316 spi_re_entrant_list_foreach (&controller->key_listeners,
2317 remove_listener_cb, &ctx);
2319 spi_key_listener_clone_free ((DEControllerKeyListener *) ctx.listener);
2323 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2327 for (l = controller->mouse_listeners; l; l = tmp)
2329 DEControllerListener *listener = l->data;
2331 if (!strcmp (listener->bus_name, bus_name))
2333 spi_controller_deregister_device_listener (controller, listener);
2334 tmp = controller->mouse_listeners;
2337 for (l = controller->key_listeners; l; l = tmp)
2339 DEControllerKeyListener *key_listener = l->data;
2341 if (!strcmp (key_listener->listener.bus_name, bus_name))
2343 /* TODO: untangle the below line(s) */
2344 spi_deregister_controller_key_listener (controller, key_listener);
2345 tmp = controller->key_listeners;
2351 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2352 * method implementation
2354 static DBusMessage *
2355 impl_deregister_keystroke_listener (DBusConnection *bus,
2356 DBusMessage *message,
2359 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2360 DEControllerKeyListener *key_listener;
2361 DBusMessageIter iter, iter_array;
2363 GSList *keys = NULL;
2364 dbus_int32_t mask, type;
2365 DBusMessage *reply = NULL;
2367 dbus_message_iter_init(message, &iter);
2368 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu") != 0)
2370 g_warning ("Received DeregisterKeystrokeListener with strange signature '%s'", dbus_message_get_signature (message));
2371 return invalid_arguments_error (message);
2374 dbus_message_iter_get_basic(&iter, &path);
2375 dbus_message_iter_next(&iter);
2376 dbus_message_iter_recurse(&iter, &iter_array);
2377 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2379 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2382 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))
2386 kd->keystring = g_strdup (keystring);
2387 keys = g_slist_append(keys, kd);
2389 dbus_message_iter_next(&iter);
2390 dbus_message_iter_get_basic(&iter, &mask);
2391 dbus_message_iter_next(&iter);
2392 dbus_message_iter_get_basic(&iter, &type);
2393 dbus_message_iter_next(&iter);
2394 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2395 #ifdef SPI_DEREGISTER_DEBUG
2396 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2397 (void *) l, (unsigned long) mask->value);
2400 spi_deregister_controller_key_listener (controller, key_listener);
2402 spi_dec_listener_free ((DEControllerListener *) key_listener);
2403 reply = dbus_message_new_method_return (message);
2408 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2409 * method implementation
2411 static DBusMessage *
2412 impl_deregister_device_event_listener (DBusConnection *bus,
2413 DBusMessage *message,
2416 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2417 DEControllerListener *listener;
2419 dbus_int32_t event_types;
2420 DBusMessage *reply = NULL;
2422 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2424 return invalid_arguments_error (message);
2426 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2427 spi_controller_deregister_device_listener (
2428 controller, listener);
2429 reply = dbus_message_new_method_return (message);
2433 static DBusMessage *
2434 impl_get_keystroke_listeners (DBusConnection *bus,
2435 DBusMessage *message,
2438 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2439 DEControllerKeyListener *dec_listener;
2440 DBusMessageIter iter, iter_array;
2441 DBusMessage *reply = dbus_message_new_method_return (message);
2447 dbus_message_iter_init_append (reply, &iter);
2448 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2449 "(souua(iisi)u(bbb))", &iter_array);
2450 for (l = controller->key_listeners; l; l = l->next)
2452 append_keystroke_listener (&iter_array, l->data);
2454 dbus_message_iter_close_container (&iter, &iter_array);
2458 static DBusMessage *
2459 impl_get_device_event_listeners (DBusConnection *bus,
2460 DBusMessage *message,
2463 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2464 DEControllerKeyListener *dec_listener;
2465 DBusMessageIter iter, iter_array;
2467 DBusMessage *reply = dbus_message_new_method_return (message);
2472 dbus_message_iter_init_append (reply, &iter);
2473 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2474 "(sou)", &iter_array);
2475 for (l = controller->key_listeners; l; l = l->next)
2477 append_mouse_listener (&iter_array, l->data);
2479 dbus_message_iter_close_container (&iter, &iter_array);
2483 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2485 unsigned int retval = 0;
2486 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2487 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2489 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2490 retval = XkbGetSlowKeysDelay (spi_get_display (),
2491 XkbUseCoreKbd, &bounce_delay);
2493 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2495 Status s = XkbGetControls (spi_get_display (),
2496 XkbAllControlsMask, priv->xkb_desc);
2499 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2500 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2505 #ifdef SPI_XKB_DEBUG
2506 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2511 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2513 unsigned int retval = 0;
2514 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2515 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2517 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2518 retval = XkbGetBounceKeysDelay (spi_get_display (),
2519 XkbUseCoreKbd, &bounce_delay);
2521 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2523 Status s = XkbGetControls (spi_get_display (),
2524 XkbAllControlsMask, priv->xkb_desc);
2527 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2528 retval = priv->xkb_desc->ctrls->debounce_delay;
2533 #ifdef SPI_XKB_DEBUG
2534 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2540 dec_synth_keycode_press (SpiDEController *controller,
2541 unsigned int keycode)
2543 unsigned int time = CurrentTime;
2544 unsigned int bounce_delay;
2545 unsigned int elapsed_msec;
2547 DEControllerPrivateData *priv =
2548 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2549 spi_dec_private_quark);
2550 if (keycode == priv->last_release_keycode)
2552 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2555 gettimeofday (&tv, NULL);
2557 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2558 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2559 #ifdef SPI_XKB_DEBUG
2560 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2561 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2563 #ifdef THIS_IS_BROKEN
2564 if (elapsed_msec < bounce_delay)
2565 time = bounce_delay - elapsed_msec + 1;
2567 time = bounce_delay + 10;
2568 /* fudge for broken XTest */
2570 #ifdef SPI_XKB_DEBUG
2571 fprintf (stderr, "waiting %d ms\n", time);
2575 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2576 priv->last_press_keycode = keycode;
2577 XFlush (spi_get_display ());
2578 XSync (spi_get_display (), False);
2579 gettimeofday (&priv->last_press_time, NULL);
2584 dec_synth_keycode_release (SpiDEController *controller,
2585 unsigned int keycode)
2587 unsigned int time = CurrentTime;
2588 unsigned int slow_delay;
2589 unsigned int elapsed_msec;
2591 DEControllerPrivateData *priv =
2592 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2593 spi_dec_private_quark);
2594 if (keycode == priv->last_press_keycode)
2596 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2599 gettimeofday (&tv, NULL);
2601 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2602 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2603 #ifdef SPI_XKB_DEBUG
2604 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2605 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2607 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2608 if (elapsed_msec < slow_delay)
2609 time = slow_delay - elapsed_msec + 1;
2611 time = slow_delay + 10;
2612 /* our XTest seems broken, we have to add slop as above */
2614 #ifdef SPI_XKB_DEBUG
2615 fprintf (stderr, "waiting %d ms\n", time);
2619 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2620 priv->last_release_keycode = keycode;
2621 XSync (spi_get_display (), False);
2622 gettimeofday (&priv->last_release_time, NULL);
2627 dec_get_modifier_state (SpiDEController *controller)
2629 return mouse_mask_state;
2633 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2635 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2636 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2638 if (priv->have_xkb) {
2639 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2640 modifiers, modifiers);
2643 for (mod_index=0;mod_index<8;mod_index++)
2644 if (modifiers & (1<<mod_index))
2645 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2651 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2653 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2654 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2656 if (priv->have_xkb) {
2657 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2661 for (mod_index=0;mod_index<8;mod_index++)
2662 if (modifiers & (1<<mod_index))
2663 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2669 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2671 return ucs2keysym ((long) unichar);
2675 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2677 KeyCode key_synth_code;
2678 unsigned int modifiers, synth_mods, lock_mods;
2680 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2682 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2684 /* TODO: set the modifiers accordingly! */
2685 modifiers = dec_get_modifier_state (controller);
2686 /* side-effect; we may unset mousebutton modifiers here! */
2689 if (synth_mods != modifiers) {
2690 lock_mods = synth_mods & ~modifiers;
2691 dec_lock_modifiers (controller, lock_mods);
2693 dec_synth_keycode_press (controller, key_synth_code);
2694 dec_synth_keycode_release (controller, key_synth_code);
2696 if (synth_mods != modifiers)
2697 dec_unlock_modifiers (controller, lock_mods);
2703 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2705 /* probably we need to create and inject an XIM handler eventually. */
2706 /* for now, try to match the string to existing
2707 * keycode+modifier states.
2711 gunichar unichar = 0;
2713 gboolean retval = TRUE;
2716 maxlen = strlen (keystring) + 1;
2717 keysyms = g_new0 (KeySym, maxlen);
2718 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2723 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2725 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2730 mbytes = g_unichar_to_utf8 (unichar, bytes);
2731 bytes[mbytes] = '\0';
2733 fprintf (stderr, "[unichar %s]", bytes);
2735 keysym = dec_keysym_for_unichar (controller, unichar);
2736 if (keysym == NoSymbol) {
2738 fprintf (stderr, "no keysym for %s", bytes);
2743 keysyms[i++] = keysym;
2744 keystring = g_utf8_next_char (keystring);
2747 XSynchronize (spi_get_display (), TRUE);
2748 for (i = 0; keysyms[i]; ++i) {
2749 if (!dec_synth_keysym (controller, keysyms[i])) {
2751 fprintf (stderr, "could not synthesize %c\n",
2758 XSynchronize (spi_get_display (), FALSE);
2767 * DBus Accessibility::DEController::RegisterKeystrokeListener
2768 * method implementation
2770 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2772 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2773 dbus_int32_t keycode;
2775 dbus_uint32_t synth_type;
2778 DEControllerPrivateData *priv;
2779 DBusMessage *reply = NULL;
2781 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2783 return invalid_arguments_error (message);
2787 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2788 (long) keycode, (int) synth_type);
2790 /* TODO: hide/wrap/remove X dependency */
2793 * TODO: when initializing, query for XTest extension before using,
2794 * and fall back to XSendEvent() if XTest is not available.
2797 spi_x_error_trap ();
2799 priv = (DEControllerPrivateData *)
2800 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2802 if (!priv->have_xkb && xmkeymap==NULL) {
2803 xmkeymap = XGetModifierMapping(spi_get_display ());
2808 case Accessibility_KEY_PRESS:
2809 dec_synth_keycode_press (controller, keycode);
2811 case Accessibility_KEY_PRESSRELEASE:
2812 dec_synth_keycode_press (controller, keycode);
2813 case Accessibility_KEY_RELEASE:
2814 dec_synth_keycode_release (controller, keycode);
2816 case Accessibility_KEY_SYM:
2817 #ifdef SPI_XKB_DEBUG
2818 fprintf (stderr, "KeySym synthesis\n");
2821 * note: we are using long for 'keycode'
2822 * in our arg list; it can contain either
2823 * a keycode or a keysym.
2825 dec_synth_keysym (controller, (KeySym) keycode);
2827 case Accessibility_KEY_STRING:
2828 if (!dec_synth_keystring (controller, keystring))
2829 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2833 if (synth_type == Accessibility_KEY_SYM) {
2837 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2839 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2841 spi_dec_clear_unlatch_pending (controller);
2843 reply = dbus_message_new_method_return (message);
2847 /* Accessibility::DEController::GenerateMouseEvent */
2848 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2853 DBusMessage *reply = NULL;
2855 gboolean err = FALSE;
2856 Display *display = spi_get_display ();
2858 if (!dbus_message_get_args(message, NULL, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2860 return invalid_arguments_error (message);
2864 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2865 eventName, (long int) x, (long int) y);
2867 switch (eventName[0])
2870 switch (eventName[1])
2872 /* TODO: check number of buttons before parsing */
2893 if (x != -1 && y != -1)
2895 XTestFakeMotionEvent (display, DefaultScreen (display),
2898 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2899 if (eventName[2] == 'c')
2900 XTestFakeButtonEvent (display, button, FALSE, 1);
2901 else if (eventName[2] == 'd')
2903 XTestFakeButtonEvent (display, button, FALSE, 1);
2904 XTestFakeButtonEvent (display, button, TRUE, 2);
2905 XTestFakeButtonEvent (display, button, FALSE, 3);
2909 case 'r': /* relative motion */
2910 XTestFakeRelativeMotionEvent (display, x, y, 0);
2912 case 'a': /* absolute motion */
2913 XTestFakeMotionEvent (display, DefaultScreen (display),
2917 reply = dbus_message_new_method_return (message);
2921 /* Accessibility::DEController::NotifyListenersSync */
2922 static DBusMessage *
2923 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2925 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2926 Accessibility_DeviceEvent event;
2928 DBusMessage *reply = NULL;
2930 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2932 return invalid_arguments_error (message);
2935 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2936 controller, (int) event.id);
2938 ret = spi_controller_notify_keylisteners (controller,
2939 (Accessibility_DeviceEvent *)
2942 reply = dbus_message_new_method_return (message);
2945 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2950 static DBusMessage *
2951 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2953 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2954 Accessibility_DeviceEvent event;
2955 DBusMessage *reply = NULL;
2957 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2959 return invalid_arguments_error (message);
2962 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2963 controller, (int) event.id);
2965 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2967 reply = dbus_message_new_method_return (message);
2972 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2974 GObjectClass * object_class = (GObjectClass *) klass;
2976 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2978 object_class->finalize = spi_device_event_controller_object_finalize;
2980 if (!spi_dec_private_quark)
2981 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2985 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2991 handle_io (GIOChannel *source,
2992 GIOCondition condition,
2995 SpiDEController *controller = (SpiDEController *) data;
2996 gboolean is_consumed = FALSE;
2999 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
3001 if (ev.type == KeyPress || ev.type == KeyRelease)
3002 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
3005 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
3010 #endif /* HAVE_XEVIE */
3013 spi_device_event_controller_init (SpiDEController *device_event_controller)
3015 spi_events_init (spi_get_display());
3019 #endif /* HAVE_XEVIE */
3021 DEControllerPrivateData *private;
3022 device_event_controller->key_listeners = NULL;
3023 device_event_controller->mouse_listeners = NULL;
3024 device_event_controller->keygrabs_list = NULL;
3025 device_event_controller->xevie_display = NULL;
3028 device_event_controller->xevie_display = XOpenDisplay(NULL);
3030 if (XevieStart(device_event_controller->xevie_display) == TRUE)
3032 #ifdef SPI_KEYEVENT_DEBUG
3033 fprintf (stderr, "XevieStart() success \n");
3035 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
3037 fd = ConnectionNumber(device_event_controller->xevie_display);
3038 ioc = g_io_channel_unix_new (fd);
3039 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
3040 g_io_channel_unref (ioc);
3044 device_event_controller->xevie_display = NULL;
3045 #ifdef SPI_KEYEVENT_DEBUG
3046 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
3049 #endif /* HAVE_XEVIE */
3051 private = g_new0 (DEControllerPrivateData, 1);
3052 gettimeofday (&private->last_press_time, NULL);
3053 gettimeofday (&private->last_release_time, NULL);
3054 g_object_set_qdata (G_OBJECT (device_event_controller),
3055 spi_dec_private_quark,
3057 spi_controller_register_with_devices (device_event_controller);
3058 device_event_controller->message_queue = g_queue_new ();
3059 saved_controller = device_event_controller;
3063 spi_device_event_controller_forward_key_event (SpiDEController *controller,
3064 const XEvent *event)
3066 Accessibility_DeviceEvent key_event;
3069 g_assert (event->type == KeyPress || event->type == KeyRelease);
3071 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3073 if (controller->xevie_display == NULL)
3074 spi_controller_update_key_grabs (controller, &key_event);
3076 /* relay to listeners, and decide whether to consume it or not */
3077 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
3078 g_free(key_event.event_string);
3084 is_key_released (KeyCode code)
3089 XQueryKeymap (spi_get_display (), keys);
3090 down = BIT (keys, code);
3095 check_release (gpointer data)
3098 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
3099 KeyCode code = event->hw_code;
3101 released = is_key_released (code);
3105 check_release_handler = 0;
3106 event->type = Accessibility_KEY_RELEASED_EVENT;
3107 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
3109 return (released == 0);
3112 static void wait_for_release_event (XEvent *event,
3113 SpiDEController *controller)
3115 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3116 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
3119 /*---------------------------------------------------------------------------*/
3121 static const char *introspection_header =
3122 "<?xml version=\"1.0\"?>\n";
3124 static const char *introspection_node_element =
3125 "<node name=\"%s\">\n";
3127 static const char *introspection_footer =
3130 static DBusMessage *
3131 impl_Introspect (DBusConnection * bus,
3132 DBusMessage * message, void *user_data)
3138 const gchar *pathstr = SPI_DBUS_PATH_DEC;
3142 output = g_string_new(introspection_header);
3144 g_string_append_printf(output, introspection_node_element, pathstr);
3146 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
3148 g_string_append(output, introspection_footer);
3149 final = g_string_free(output, FALSE);
3151 reply = dbus_message_new_method_return (message);
3152 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
3158 /*---------------------------------------------------------------------------*/
3161 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
3163 const gchar *iface = dbus_message_get_interface (message);
3164 const gchar *member = dbus_message_get_member (message);
3165 const gint type = dbus_message_get_type (message);
3166 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3167 DBusMessage *reply = NULL;
3169 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
3171 result = DBUS_HANDLER_RESULT_HANDLED;
3172 if (!strcmp (member, "RegisterKeystrokeListener"))
3173 reply = impl_register_keystroke_listener (bus, message, user_data);
3174 else if (!strcmp (member, "RegisterDeviceEventListener"))
3175 reply = impl_register_device_event_listener (bus, message, user_data);
3176 else if (!strcmp (member, "DeregisterKeystrokeListener"))
3177 reply = impl_deregister_keystroke_listener (bus, message, user_data);
3178 else if (!strcmp (member, "DeregisterDeviceEventListener"))
3179 reply = impl_deregister_device_event_listener (bus, message, user_data);
3180 else if (!strcmp (member, "GetKeystrokeListeners"))
3181 reply = impl_get_keystroke_listeners (bus, message, user_data);
3182 else if (!strcmp (member, "GetDeviceEventListeners"))
3183 reply = impl_get_device_event_listeners (bus, message, user_data);
3184 else if (!strcmp (member, "GenerateKeyboardEvent"))
3185 reply = impl_generate_keyboard_event (bus, message, user_data);
3186 else if (!strcmp (member, "GenerateMouseEvent"))
3187 reply = impl_generate_mouse_event (bus, message, user_data);
3188 else if (!strcmp (member, "NotifyListenersSync"))
3189 reply = impl_notify_listeners_sync (bus, message, user_data);
3190 else if (!strcmp (member, "NotifyListenersAsync"))
3191 reply = impl_notify_listeners_async (bus, message, user_data);
3193 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3196 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
3198 result = DBUS_HANDLER_RESULT_HANDLED;
3199 if (!strcmp (member, "Introspect"))
3200 reply = impl_Introspect (bus, message, user_data);
3202 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3205 if (result == DBUS_HANDLER_RESULT_HANDLED)
3209 reply = dbus_message_new_method_return (message);
3212 dbus_connection_send (bus, reply, NULL);
3213 dbus_message_unref (reply);
3218 message_queue_dispatch (gpointer data)
3220 saved_controller->message_queue_idle = 0;
3221 while (!g_queue_is_empty (saved_controller->message_queue))
3223 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
3224 data = g_queue_pop_head (saved_controller->message_queue);
3225 handle_dec_method_from_idle (saved_controller->bus, message, data);
3226 dbus_message_unref (message);
3231 static DBusHandlerResult
3232 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
3234 const gchar *iface = dbus_message_get_interface (message);
3235 const gchar *member = dbus_message_get_member (message);
3236 const gint type = dbus_message_get_type (message);
3238 /* Check for basic reasons not to handle */
3239 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3242 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3244 dbus_message_ref (message);
3245 g_queue_push_tail (saved_controller->message_queue, message);
3246 g_queue_push_tail (saved_controller->message_queue, user_data);
3247 if (!saved_controller->message_queue_idle)
3248 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
3249 return DBUS_HANDLER_RESULT_HANDLED;
3252 static DBusObjectPathVTable dec_vtable =
3256 NULL, NULL, NULL, NULL
3260 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
3262 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
3264 dec->registry = g_object_ref (reg);
3265 reg->dec = g_object_ref (dec);
3268 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
3270 spi_dec_init_mouse_listener (dec);
3276 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
3278 if (!have_mouse_event_listener)
3280 have_mouse_event_listener = TRUE;
3281 if (!have_mouse_listener)
3282 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
3287 spi_device_event_controller_stop_poll_mouse (void)
3289 have_mouse_event_listener = FALSE;