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/extensions/XTest.h>
39 #include <X11/XKBlib.h>
42 #include <X11/keysymdef.h>
45 #include <X11/Xproto.h>
47 #include <X11/extensions/Xevie.h>
48 #endif /* HAVE_XEVIE */
52 #include <dbus/dbus.h>
57 #include "de-marshaller.h"
60 #include "deviceeventcontroller.h"
61 #include "reentrant-list.h"
63 #include "introspection.h"
65 KeySym ucs2keysym (long ucs);
66 long keysym2ucs(KeySym keysym);
68 #define CHECK_RELEASE_DELAY 20
69 #define BIT(c, x) (c[x/8]&(1<<(x%8)))
70 static guint check_release_handler = 0;
71 static Accessibility_DeviceEvent pressed_event;
72 static SpiDEController *saved_controller;
73 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
75 /* Our parent Gtk object type */
76 #define PARENT_TYPE G_TYPE_OBJECT
78 /* A pointer to our parent object class */
79 static int spi_error_code = 0;
84 typedef struct _SpiPoint SpiPoint;
85 static SpiPoint last_mouse_pos_static = {0, 0};
86 static SpiPoint *last_mouse_pos = &last_mouse_pos_static;
87 static unsigned int mouse_mask_state = 0;
88 static unsigned int mouse_button_mask =
89 Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
90 static unsigned int key_modifier_mask =
91 Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
92 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
94 static GQuark spi_dec_private_quark = 0;
95 static XModifierKeymap* xmkeymap = NULL;
97 static gboolean have_mouse_listener = FALSE;
98 static gboolean have_mouse_event_listener = FALSE;
100 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
104 SPI_DEVICE_TYPE_MOUSE,
105 SPI_DEVICE_TYPE_LAST_DEFINED
106 } SpiDeviceTypeCategory;
109 guint ref_count : 30;
110 guint pending_add : 1;
111 guint pending_remove : 1;
113 Accessibility_ControllerEventMask mod_mask;
114 dbus_uint32_t key_val; /* KeyCode */
115 } DEControllerGrabMask;
120 SpiDeviceTypeCategory type;
122 } DEControllerListener;
125 DEControllerListener listener;
128 Accessibility_ControllerEventMask mask;
129 Accessibility_EventListenerMode *mode;
130 } DEControllerKeyListener;
133 unsigned int last_press_keycode;
134 unsigned int last_release_keycode;
135 struct timeval last_press_time;
136 struct timeval last_release_time;
138 int xkb_major_extension_opcode;
139 int xkb_base_event_code;
140 int xkb_base_error_code;
141 unsigned int xkb_latch_mask;
142 unsigned int pending_xkb_mod_relatch_mask;
144 KeyCode reserved_keycode;
145 KeySym reserved_keysym;
146 guint reserved_reset_timeout;
147 } DEControllerPrivateData;
149 static void spi_controller_register_with_devices (SpiDEController *controller);
150 static gboolean spi_controller_update_key_grabs (SpiDEController *controller,
151 Accessibility_DeviceEvent *recv);
152 static gboolean spi_controller_register_device_listener (SpiDEController *controller,
153 DEControllerListener *l);
154 static gboolean spi_device_event_controller_forward_key_event (SpiDEController *controller,
155 const XEvent *event);
156 static void spi_controller_deregister_device_listener (SpiDEController *controller,
157 DEControllerListener *listener);
158 static void spi_deregister_controller_key_listener (SpiDEController *controller,
159 DEControllerKeyListener *key_listener);
160 static gboolean spi_controller_notify_mouselisteners (SpiDEController *controller,
161 const Accessibility_DeviceEvent *event);
163 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
164 const Accessibility_DeviceEvent *event);
165 static gboolean spi_clear_error_state (void);
166 static gboolean spi_dec_poll_mouse_moved (gpointer data);
167 static gboolean spi_dec_poll_mouse_moving (gpointer data);
168 static gboolean spi_dec_poll_mouse_idle (gpointer data);
170 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
173 invalid_arguments_error (DBusMessage *message)
178 errmsg= g_strdup_printf (
179 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
180 dbus_message_get_member (message),
181 dbus_message_get_signature (message),
182 dbus_message_get_interface (message));
183 reply = dbus_message_new_error (message,
184 DBUS_ERROR_INVALID_ARGS,
190 /* Private methods */
192 spi_dbus_add_disconnect_match (DBusConnection *bus, const char *name)
194 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
198 dbus_error_init (&error);
199 dbus_bus_add_match (bus, match, &error);
201 return !dbus_error_is_set (&error);
207 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
209 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
213 dbus_error_init (&error);
214 dbus_bus_remove_match (bus, match, &error);
216 return !dbus_error_is_set (&error);
222 keysym_mod_mask (KeySym keysym, KeyCode keycode)
224 /* we really should use XKB and look directly at the keymap */
225 /* this is very inelegant */
226 Display *display = spi_get_display ();
227 unsigned int mods_rtn = 0;
228 unsigned int retval = 0;
231 if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
232 (sym_rtn == keysym)) {
235 else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
236 (sym_rtn == keysym)) {
239 else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
240 (sym_rtn == keysym)) {
243 else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
244 (sym_rtn == keysym)) {
247 else if (XkbLookupKeySym (display, keycode,
248 ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
249 (sym_rtn == keysym)) {
250 retval = (Mod2Mask | ShiftMask);
252 else if (XkbLookupKeySym (display, keycode,
253 ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
254 (sym_rtn == keysym)) {
255 retval = (Mod3Mask | ShiftMask);
257 else if (XkbLookupKeySym (display, keycode,
258 ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
259 (sym_rtn == keysym)) {
260 retval = (Mod4Mask | ShiftMask);
268 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
271 Display *dpy = spi_get_display ();
273 if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
275 fprintf (stderr, "ERROR getting map\n");
279 if (desc && desc->map)
281 gint offset = desc->map->key_sym_map[keycode].offset;
282 desc->map->syms[offset] = keysym;
286 fprintf (stderr, "Error changing key map: empty server structure\n");
288 XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
290 * FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
291 * would be far preferable.
292 * HOWEVER it does not seem to work using XFree 4.3.
294 /* XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
297 XkbFreeKeyboard (desc, 0, TRUE);
306 spi_dec_reset_reserved (gpointer data)
308 DEControllerPrivateData *priv = data;
309 spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
310 priv->reserved_reset_timeout = 0;
315 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
318 keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
321 DEControllerPrivateData *priv = (DEControllerPrivateData *)
322 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
323 /* if there's no keycode available, fix it */
324 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
326 keycode = priv->reserved_keycode;
328 * queue a timer to restore the old keycode. Ugly, but required
329 * due to races / asynchronous X delivery.
330 * Long-term fix is to extend the X keymap here instead of replace entries.
332 priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
338 *modmask = keysym_mod_mask (keysym, keycode);
342 static DEControllerGrabMask *
343 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
345 DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
347 memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
349 clone->ref_count = 1;
350 clone->pending_add = TRUE;
351 clone->pending_remove = FALSE;
357 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
363 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
365 DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
366 DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
374 return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
379 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
381 DEControllerPrivateData *priv =
382 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
384 if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
385 priv->xkb_latch_mask);
387 priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
391 spi_dec_clear_unlatch_pending (SpiDEController *controller)
393 DEControllerPrivateData *priv =
394 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
395 priv->xkb_latch_mask = 0;
398 static void emit(SpiDEController *controller, const char *interface, const char *name, const char *minor, int a1, int a2)
400 DBusMessage *signal = NULL;
401 DBusMessageIter iter, iter_struct, iter_variant;
403 const char *path = SPI_DBUS_PATH_ROOT;
404 const char *bus_name = dbus_bus_get_unique_name (controller->bus);
406 signal = dbus_message_new_signal (path, interface, name);
408 dbus_message_iter_init_append (signal, &iter);
410 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
411 dbus_message_iter_append_basic (&iter, DBUS_TYPE_UINT32, &a1);
412 dbus_message_iter_append_basic (&iter, DBUS_TYPE_UINT32, &a2);
413 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
414 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
415 dbus_message_iter_close_container (&iter, &iter_variant);
417 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
419 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
420 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
421 dbus_message_iter_close_container (&iter, &iter_struct);
423 dbus_connection_send (controller->bus, signal, NULL);
427 spi_dec_button_update_and_emit (SpiDEController *controller,
430 Accessibility_DeviceEvent mouse_e;
431 gchar event_detail[3];
432 gboolean is_consumed = FALSE;
434 if ((mask_return & mouse_button_mask) !=
435 (mouse_mask_state & mouse_button_mask))
437 int button_number = 0;
438 gboolean is_down = False;
440 if (!(mask_return & Button1Mask) &&
441 (mouse_mask_state & Button1Mask))
443 mouse_mask_state &= ~Button1Mask;
446 else if ((mask_return & Button1Mask) &&
447 !(mouse_mask_state & Button1Mask))
449 mouse_mask_state |= Button1Mask;
453 else if (!(mask_return & Button2Mask) &&
454 (mouse_mask_state & Button2Mask))
456 mouse_mask_state &= ~Button2Mask;
459 else if ((mask_return & Button2Mask) &&
460 !(mouse_mask_state & Button2Mask))
462 mouse_mask_state |= Button2Mask;
466 else if (!(mask_return & Button3Mask) &&
467 (mouse_mask_state & Button3Mask))
469 mouse_mask_state &= ~Button3Mask;
472 else if ((mask_return & Button3Mask) &&
473 !(mouse_mask_state & Button3Mask))
475 mouse_mask_state |= Button3Mask;
479 else if (!(mask_return & Button4Mask) &&
480 (mouse_mask_state & Button4Mask))
482 mouse_mask_state &= ~Button4Mask;
485 else if ((mask_return & Button4Mask) &&
486 !(mouse_mask_state & Button4Mask))
488 mouse_mask_state |= Button4Mask;
492 else if (!(mask_return & Button5Mask) &&
493 (mouse_mask_state & Button5Mask))
495 mouse_mask_state &= ~Button5Mask;
498 else if ((mask_return & Button5Mask) &&
499 !(mouse_mask_state & Button5Mask))
501 mouse_mask_state |= Button5Mask;
507 fprintf (stderr, "Button %d %s\n",
508 button_number, (is_down) ? "Pressed" : "Released");
510 snprintf (event_detail, 3, "%d%c", button_number,
511 (is_down) ? 'p' : 'r');
512 /* TODO: FIXME distinguish between physical and
515 mouse_e.type = (is_down) ?
516 Accessibility_BUTTON_PRESSED_EVENT :
517 Accessibility_BUTTON_RELEASED_EVENT;
518 mouse_e.id = button_number;
519 mouse_e.hw_code = button_number;
520 mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
521 mouse_e.timestamp = 0;
522 mouse_e.event_string = "";
523 mouse_e.is_text = FALSE;
525 spi_controller_notify_mouselisteners (controller,
529 dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
530 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, x, y);
533 spi_dec_set_unlatch_pending (controller, mask_return);
545 spi_dec_mouse_check (SpiDEController *controller,
546 int *x, int *y, gboolean *moved)
548 int win_x_return,win_y_return;
549 unsigned int mask_return;
550 Window root_return, child_return;
551 Display *display = spi_get_display ();
554 XQueryPointer(display, DefaultRootWindow (display),
555 &root_return, &child_return,
557 &win_x_return, &win_y_return, &mask_return);
559 * Since many clients grab the pointer, and X goes an automatic
560 * pointer grab on mouse-down, we often must detect mouse button events
561 * by polling rather than via a button grab.
562 * The while loop (rather than if) is used since it's possible that
563 * multiple buttons have changed state since we last checked.
565 if (mask_return != mouse_mask_state)
567 while (spi_dec_button_update_and_emit (controller, mask_return));
570 if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
572 // TODO: combine these two signals?
573 dbus_uint32_t ix = *x, iy = *y;
574 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Abs", "", ix, iy);
575 ix -= last_mouse_pos->x;
576 iy -= last_mouse_pos->y;
577 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Rel", "", ix, iy);
578 last_mouse_pos->x = *x;
579 last_mouse_pos->y = *y;
591 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
594 dbus_uint32_t d1, d2;
597 fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
598 prev_mask, current_mask);
601 /* set bits for the virtual modifiers like NUMLOCK */
602 if (prev_mask & _numlock_physical_mask)
603 prev_mask |= SPI_KEYMASK_NUMLOCK;
604 if (current_mask & _numlock_physical_mask)
605 current_mask |= SPI_KEYMASK_NUMLOCK;
607 d1 = prev_mask & key_modifier_mask;
608 d2 = current_mask & key_modifier_mask;
609 emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "Modifiers", "", d1, d2);
613 spi_dec_poll_mouse_moved (gpointer data)
615 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
620 mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
622 if ((mask_return & key_modifier_mask) !=
623 (mouse_mask_state & key_modifier_mask))
625 spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
626 mouse_mask_state = mask_return;
633 spi_dec_poll_mouse_idle (gpointer data)
635 if (!have_mouse_event_listener && !have_mouse_listener)
637 else if (!spi_dec_poll_mouse_moved (data))
641 g_timeout_add (20, spi_dec_poll_mouse_moving, data);
647 spi_dec_poll_mouse_moving (gpointer data)
649 if (!have_mouse_event_listener && !have_mouse_listener)
651 else if (spi_dec_poll_mouse_moved (data))
655 g_timeout_add (100, spi_dec_poll_mouse_idle, data);
660 #ifdef WE_NEED_UGRAB_MOUSE
662 spi_dec_ungrab_mouse (gpointer data)
664 Display *display = spi_get_display ();
667 XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
668 XDefaultRootWindow (spi_get_display ()));
675 spi_dec_init_mouse_listener (SpiDEController *dec)
678 Display *display = spi_get_display ();
682 if (XGrabButton (display, AnyButton, AnyModifier,
683 spi_get_root_window (),
684 True, ButtonPressMask | ButtonReleaseMask,
685 GrabModeSync, GrabModeAsync, None, None) != Success) {
687 fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
691 XSync (display, False);
693 fprintf (stderr, "mouse buttons grabbed\n");
700 * Eventually we can use this to make the marshalling of mask types
701 * more sane, but for now we just use this to detect
702 * the use of 'virtual' masks such as numlock and convert them to
703 * system-specific mask values (i.e. ModMask).
706 static Accessibility_ControllerEventMask
707 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
709 Accessibility_ControllerEventMask tmp_mask;
710 gboolean has_numlock;
712 has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
716 tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
717 tmp_mask |= _numlock_physical_mask;
723 static DEControllerKeyListener *
724 spi_dec_key_listener_new (const char *bus_name,
727 const Accessibility_ControllerEventMask mask,
728 const dbus_uint32_t types,
729 const Accessibility_EventListenerMode *mode)
731 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
732 key_listener->listener.bus_name = g_strdup(bus_name);
733 key_listener->listener.path = g_strdup(path);
734 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
735 key_listener->keys = keys;
736 key_listener->mask = spi_dec_translate_mask (mask);
737 key_listener->listener.types = types;
740 key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
741 memcpy(key_listener->mode, mode, sizeof(*mode));
744 key_listener->mode = NULL;
747 g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
748 (unsigned int) key_listener->mask,
749 (int) (mode ? mode->global : 0),
750 (void *) key_listener->keys,
751 (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
757 static DEControllerListener *
758 spi_dec_listener_new (const char *bus_name,
762 DEControllerListener *listener = g_new0 (DEControllerListener, 1);
763 listener->bus_name = g_strdup(bus_name);
764 listener->path = g_strdup(path);
765 listener->type = SPI_DEVICE_TYPE_MOUSE;
766 listener->types = types;
770 static DEControllerListener *
771 spi_listener_clone (DEControllerListener *listener)
773 DEControllerListener *clone = g_new0 (DEControllerListener, 1);
774 clone->bus_name = g_strdup (listener->bus_name);
775 clone->path = g_strdup (listener->path);
776 clone->type = listener->type;
777 clone->types = listener->types;
781 static GSList *keylist_clone (GSList *s)
786 for (l = s; l; l = g_slist_next(l))
788 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
791 Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
792 kd->keycode = kds->keycode;
793 kd->keysym = kds->keysym;
794 kd->keystring = g_strdup(kds->keystring);
795 d = g_slist_append(d, kd);
801 static DEControllerKeyListener *
802 spi_key_listener_clone (DEControllerKeyListener *key_listener)
804 DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
805 clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
806 clone->listener.path = g_strdup (key_listener->listener.path);
807 clone->listener.type = SPI_DEVICE_TYPE_KBD;
808 clone->keys = keylist_clone (key_listener->keys);
809 clone->mask = key_listener->mask;
810 clone->listener.types = key_listener->listener.types;
811 if (key_listener->mode)
813 clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
814 if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
821 static void keylist_free(GSList *keys)
825 for (l = keys; l; l = g_slist_next(l))
827 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
828 g_free(kd->keystring);
835 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
837 keylist_free(key_listener->keys);
838 if (key_listener->mode) g_free(key_listener->mode);
839 g_free (key_listener);
843 spi_key_listener_clone_free (DEControllerKeyListener *clone)
845 spi_key_listener_data_free (clone);
849 spi_listener_clone_free (DEControllerListener *clone)
851 g_free (clone->path);
852 g_free (clone->bus_name);
857 spi_dec_listener_free (DEControllerListener *listener)
859 g_free (listener->bus_name);
860 g_free (listener->path);
861 if (listener->type == SPI_DEVICE_TYPE_KBD)
862 spi_key_listener_data_free ((DEControllerKeyListener *) listener);
866 _register_keygrab (SpiDEController *controller,
867 DEControllerGrabMask *grab_mask)
871 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
872 spi_grab_mask_compare_values);
875 DEControllerGrabMask *cur_mask = l->data;
877 cur_mask->ref_count++;
878 if (cur_mask->pending_remove)
880 cur_mask->pending_remove = FALSE;
885 controller->keygrabs_list =
886 g_list_prepend (controller->keygrabs_list,
887 spi_grab_mask_clone (grab_mask));
892 _deregister_keygrab (SpiDEController *controller,
893 DEControllerGrabMask *grab_mask)
897 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
898 spi_grab_mask_compare_values);
902 DEControllerGrabMask *cur_mask = l->data;
904 cur_mask->ref_count--;
905 if (cur_mask->ref_count <= 0)
907 cur_mask->pending_remove = TRUE;
913 handle_keygrab (SpiDEController *controller,
914 DEControllerKeyListener *key_listener,
915 void (*process_cb) (SpiDEController *controller,
916 DEControllerGrabMask *grab_mask))
918 DEControllerGrabMask grab_mask = { 0 };
920 grab_mask.mod_mask = key_listener->mask;
921 if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
923 grab_mask.key_val = AnyKey;
925 fprintf (stderr, "AnyKey grab!");
927 process_cb (controller, &grab_mask);
933 for (l = key_listener->keys; l; l = g_slist_next(l))
935 Accessibility_KeyDefinition *keydef = l->data;
936 long int key_val = keydef->keysym;
937 /* X Grabs require keycodes, not keysyms */
938 if (keydef->keystring && keydef->keystring[0])
940 key_val = XStringToKeysym(keydef->keystring);
944 key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
948 key_val = keydef->keycode;
950 grab_mask.key_val = key_val;
951 process_cb (controller, &grab_mask);
957 spi_controller_register_global_keygrabs (SpiDEController *controller,
958 DEControllerKeyListener *key_listener)
960 handle_keygrab (controller, key_listener, _register_keygrab);
961 if (controller->xevie_display == NULL)
962 return spi_controller_update_key_grabs (controller, NULL);
968 spi_controller_deregister_global_keygrabs (SpiDEController *controller,
969 DEControllerKeyListener *key_listener)
971 handle_keygrab (controller, key_listener, _deregister_keygrab);
972 if (controller->xevie_display == NULL)
973 spi_controller_update_key_grabs (controller, NULL);
977 spi_controller_register_device_listener (SpiDEController *controller,
978 DEControllerListener *listener)
980 DEControllerKeyListener *key_listener;
982 switch (listener->type) {
983 case SPI_DEVICE_TYPE_KBD:
984 key_listener = (DEControllerKeyListener *) listener;
986 controller->key_listeners = g_list_prepend (controller->key_listeners,
988 spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
989 if (key_listener->mode->global)
991 return spi_controller_register_global_keygrabs (controller, key_listener);
996 case SPI_DEVICE_TYPE_MOUSE:
997 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
998 if (!have_mouse_listener)
1000 have_mouse_listener = TRUE;
1001 if (!have_mouse_event_listener)
1002 g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1004 spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1013 set_reply (DBusPendingCall *pending, void *user_data)
1015 void **replyptr = (void **)user_data;
1017 *replyptr = dbus_pending_call_steal_reply (pending);
1020 static DBusMessage *
1021 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1023 DBusPendingCall *pending;
1024 DBusMessage *reply = NULL;
1026 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1030 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1033 if (!dbus_connection_read_write_dispatch (bus, timeout))
1039 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1040 SpiRegistry *registry,
1041 DEControllerListener *listener,
1042 const Accessibility_DeviceEvent *key_event)
1044 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1046 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1049 dbus_bool_t consumed = FALSE;
1051 dbus_error_init(&error);
1052 if (spi_dbus_marshal_deviceEvent(message, key_event))
1054 DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 1000, &error);
1058 dbus_error_init(&error);
1059 dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1060 dbus_message_unref(reply);
1063 dbus_message_unref(message);
1068 spi_controller_notify_mouselisteners (SpiDEController *controller,
1069 const Accessibility_DeviceEvent *event)
1072 GSList *notify = NULL, *l2;
1073 GList **listeners = &controller->mouse_listeners;
1074 gboolean is_consumed;
1075 #ifdef SPI_KEYEVENT_DEBUG
1076 gboolean found = FALSE;
1083 for (l = *listeners; l; l = l->next)
1085 DEControllerListener *listener = l->data;
1087 if (spi_eventtype_seq_contains_event (listener->types, event))
1089 /* we clone (don't dup) the listener, to avoid refcount inc. */
1090 notify = g_slist_prepend (notify,
1091 spi_listener_clone (listener));
1092 #ifdef SPI_KEYEVENT_DEBUG
1098 #ifdef SPI_KEYEVENT_DEBUG
1101 g_print ("no match for event\n");
1105 is_consumed = FALSE;
1106 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1108 DEControllerListener *listener = l2->data;
1110 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1112 spi_listener_clone_free ((DEControllerListener *) l2->data);
1115 for (; l2; l2 = l2->next)
1117 DEControllerListener *listener = l2->data;
1118 spi_listener_clone_free (listener);
1119 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1122 g_slist_free (notify);
1125 if (is_consumed) g_message ("consumed\n");
1131 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1134 Accessibility_DeviceEvent mouse_e;
1135 gchar event_detail[3];
1136 gboolean is_consumed = FALSE;
1137 gboolean xkb_mod_unlatch_occurred;
1138 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1139 dbus_uint32_t ix, iy;
1141 int button = xbutton_event->button;
1143 unsigned int mouse_button_state = xbutton_event->state;
1148 mouse_button_state |= Button1Mask;
1151 mouse_button_state |= Button2Mask;
1154 mouse_button_state |= Button3Mask;
1157 mouse_button_state |= Button4Mask;
1160 mouse_button_state |= Button5Mask;
1164 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1165 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1168 fprintf (stderr, "mouse button %d %s (%x)\n",
1169 xbutton_event->button,
1170 (xevent->type == ButtonPress) ? "Press" : "Release",
1171 mouse_button_state);
1173 snprintf (event_detail, 3, "%d%c", button,
1174 (xevent->type == ButtonPress) ? 'p' : 'r');
1176 /* TODO: FIXME distinguish between physical and logical buttons */
1177 mouse_e.type = (xevent->type == ButtonPress) ?
1178 Accessibility_BUTTON_PRESSED_EVENT :
1179 Accessibility_BUTTON_RELEASED_EVENT;
1180 mouse_e.id = button;
1181 mouse_e.hw_code = button;
1182 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1183 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1184 mouse_e.event_string = "";
1185 mouse_e.is_text = FALSE;
1186 if ((mouse_button_state & mouse_button_mask) !=
1187 (mouse_mask_state & mouse_button_mask))
1189 if ((mouse_mask_state & key_modifier_mask) !=
1190 (mouse_button_state & key_modifier_mask))
1191 spi_dec_emit_modifier_event (controller,
1192 mouse_mask_state, mouse_button_state);
1193 mouse_mask_state = mouse_button_state;
1195 spi_controller_notify_mouselisteners (controller, &mouse_e);
1196 ix = last_mouse_pos->x;
1197 iy = last_mouse_pos->y;
1198 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1201 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1202 xevent->type == ButtonRelease);
1204 /* if client wants to consume this event, and XKB latch state was
1205 * unset by this button event, we reset it
1207 if (is_consumed && xkb_mod_unlatch_occurred)
1208 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1210 XAllowEvents (spi_get_display (),
1211 (is_consumed) ? SyncPointer : ReplayPointer,
1216 global_filter_fn (XEvent *xevent, void *data)
1218 SpiDEController *controller;
1219 DEControllerPrivateData *priv;
1220 Display *display = spi_get_display ();
1221 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1222 priv = (DEControllerPrivateData *)
1223 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1225 if (xevent->type == MappingNotify)
1228 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1230 if (controller->xevie_display == NULL)
1232 gboolean is_consumed;
1235 spi_device_event_controller_forward_key_event (controller, xevent);
1242 n_events = XPending (display);
1244 #ifdef SPI_KEYEVENT_DEBUG
1245 g_print ("Number of events pending: %d\n", n_events);
1247 for (i = 0; i < n_events; i++)
1249 XNextEvent (display, &next_event);
1250 if (next_event.type != KeyPress &&
1251 next_event.type != KeyRelease)
1252 g_warning ("Unexpected event type %d in queue", next_event.type);
1255 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1257 XUngrabKeyboard (display, CurrentTime);
1261 if (xevent->type == KeyPress)
1262 wait_for_release_event (xevent, controller);
1263 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1269 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1271 spi_device_event_controller_forward_mouse_event (controller, xevent);
1273 if (xevent->type == priv->xkb_base_event_code)
1275 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1276 /* ugly but probably necessary...*/
1277 XSynchronize (display, TRUE);
1279 if (xkb_ev->xkb_type == XkbStateNotify)
1281 XkbStateNotifyEvent *xkb_snev =
1282 (XkbStateNotifyEvent *) xkb_ev;
1283 /* check the mouse, to catch mouse events grabbed by
1284 * another client; in case we should revert this XKB delatch
1286 if (!priv->pending_xkb_mod_relatch_mask)
1290 spi_dec_mouse_check (controller, &x, &y, &moved);
1292 /* we check again, since the previous call may have
1293 changed this flag */
1294 if (priv->pending_xkb_mod_relatch_mask)
1296 unsigned int feedback_mask;
1297 #ifdef SPI_XKB_DEBUG
1298 fprintf (stderr, "relatching %x\n",
1299 priv->pending_xkb_mod_relatch_mask);
1301 /* temporarily turn off the latch bell, if it's on */
1302 XkbGetControls (display,
1303 XkbAccessXFeedbackMask,
1305 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1306 if (feedback_mask & XkbAX_StickyKeysFBMask)
1308 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1310 priv->xkb_desc->ctrls->ax_options
1311 &= ~(XkbAX_StickyKeysFBMask);
1312 XkbChangeControls (display, priv->xkb_desc, &changes);
1314 /* TODO: account for lock as well as latch */
1315 XkbLatchModifiers (display,
1317 priv->pending_xkb_mod_relatch_mask,
1318 priv->pending_xkb_mod_relatch_mask);
1319 if (feedback_mask & XkbAX_StickyKeysFBMask)
1321 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1323 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1324 XkbChangeControls (display, priv->xkb_desc, &changes);
1326 #ifdef SPI_XKB_DEBUG
1327 fprintf (stderr, "relatched %x\n",
1328 priv->pending_xkb_mod_relatch_mask);
1330 priv->pending_xkb_mod_relatch_mask = 0;
1334 priv->xkb_latch_mask = xkb_snev->latched_mods;
1337 XSynchronize (display, FALSE);
1344 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1346 if (error->error_code == BadAccess)
1348 g_message ("Could not complete key grab: grab already in use.\n");
1349 spi_error_code = BadAccess;
1354 return (*x_default_error_handler) (display, error);
1359 spi_controller_register_with_devices (SpiDEController *controller)
1361 DEControllerPrivateData *priv;
1362 int event_base, error_base, major_version, minor_version;
1364 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1365 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1367 XTestGrabControl (spi_get_display (), True);
1370 /* calls to device-specific implementations and routines go here */
1371 /* register with: keyboard hardware code handler */
1372 /* register with: (translated) keystroke handler */
1374 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1375 &priv->xkb_major_extension_opcode,
1376 &priv->xkb_base_event_code,
1377 &priv->xkb_base_error_code, NULL, NULL);
1381 guint64 reserved = 0;
1382 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1383 XkbSelectEvents (spi_get_display (),
1385 XkbStateNotifyMask, XkbStateNotifyMask);
1386 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1388 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1390 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1392 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1394 /* don't use this one if there's a grab client! */
1396 /* Runtime errors are generated from these functions,
1397 * that are then quashed. Equivalent to:
1404 spi_x_error_trap ();
1405 XGrabKey (spi_get_display (), i, 0,
1406 spi_get_root_window (),
1408 GrabModeSync, GrabModeSync);
1409 XSync (spi_get_display (), TRUE);
1410 XUngrabKey (spi_get_display (), i, 0,
1411 spi_get_root_window ());
1412 if (!spi_x_error_release ())
1422 priv->reserved_keycode = reserved;
1423 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1427 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1428 priv->reserved_keysym = XK_numbersign;
1430 #ifdef SPI_RESERVED_DEBUG
1432 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1433 fprintf (stderr, "%x\n", sym);
1434 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1436 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1441 spi_set_filter (global_filter_fn, controller);
1442 spi_set_events (KeyPressMask | KeyReleaseMask);
1444 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1448 spi_key_set_contains_key (GSList *key_set,
1449 const Accessibility_DeviceEvent *key_event)
1458 g_print ("null key set!\n");
1463 len = g_slist_length (key_set);
1465 if (len == 0) /* special case, means "all keys/any key" */
1468 g_print ("anykey\n");
1473 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1475 Accessibility_KeyDefinition *kd = l->data;
1476 #ifdef SPI_KEYEVENT_DEBUG
1477 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1481 (int) key_event->id,
1482 (int) key_event->hw_code,
1483 key_event->event_string);
1485 if (kd->keysym == (dbus_uint32_t) key_event->id)
1489 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1493 if (key_event->event_string && key_event->event_string[0] &&
1494 !strcmp (kd->keystring, key_event->event_string))
1504 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1505 const Accessibility_DeviceEvent *event)
1507 if (types == 0) /* special case, means "all events/any event" */
1512 return (types & (1 << event->type));
1516 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1517 DEControllerKeyListener *listener,
1518 dbus_bool_t is_system_global)
1520 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1521 spi_key_set_contains_key (listener->keys, key_event) &&
1522 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1523 (is_system_global == listener->mode->global))
1534 spi_controller_notify_keylisteners (SpiDEController *controller,
1535 Accessibility_DeviceEvent *key_event,
1536 dbus_bool_t is_system_global)
1539 GSList *notify = NULL, *l2;
1540 GList **key_listeners = &controller->key_listeners;
1541 gboolean is_consumed;
1548 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1549 if (key_event->modifiers & _numlock_physical_mask)
1550 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1552 for (l = *key_listeners; l; l = l->next)
1554 DEControllerKeyListener *key_listener = l->data;
1556 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1558 /* we clone (don't dup) the listener, to avoid refcount inc. */
1559 notify = g_slist_prepend (notify,
1560 spi_key_listener_clone (key_listener));
1564 #ifdef SPI_KEYEVENT_DEBUG
1567 g_print ("no match for event\n");
1571 is_consumed = FALSE;
1572 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1574 DEControllerKeyListener *key_listener = l2->data;
1576 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1577 key_listener->mode->preemptive;
1579 spi_key_listener_clone_free (key_listener);
1582 for (; l2; l2 = l2->next)
1584 DEControllerKeyListener *key_listener = l2->data;
1585 spi_key_listener_clone_free (key_listener);
1586 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1589 g_slist_free (notify);
1592 if (is_consumed) g_message ("consumed\n");
1598 spi_clear_error_state (void)
1600 gboolean retval = spi_error_code != 0;
1605 static Accessibility_DeviceEvent
1606 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1608 Accessibility_DeviceEvent key_event;
1610 const int cbuf_bytes = 20;
1614 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1615 key_event.id = (dbus_int32_t)(keysym);
1616 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1617 if (((XEvent *) x_key_event)->type == KeyPress)
1619 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1623 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1625 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1626 key_event.is_text = FALSE;
1630 key_event.event_string = g_strdup ("space");
1633 key_event.event_string = g_strdup ("Tab");
1636 key_event.event_string = g_strdup ("Backspace");
1639 key_event.event_string = g_strdup ("Return");
1642 key_event.event_string = g_strdup ("Home");
1645 key_event.event_string = g_strdup ("Page_Down");
1648 key_event.event_string = g_strdup ("Page_Up");
1651 key_event.event_string = g_strdup ("F1");
1654 key_event.event_string = g_strdup ("F2");
1657 key_event.event_string = g_strdup ("F3");
1660 key_event.event_string = g_strdup ("F4");
1663 key_event.event_string = g_strdup ("F5");
1666 key_event.event_string = g_strdup ("F6");
1669 key_event.event_string = g_strdup ("F7");
1672 key_event.event_string = g_strdup ("F8");
1675 key_event.event_string = g_strdup ("F9");
1678 key_event.event_string = g_strdup ("F10");
1681 key_event.event_string = g_strdup ("F11");
1684 key_event.event_string = g_strdup ("F12");
1687 key_event.event_string = g_strdup ("End");
1690 key_event.event_string = g_strdup ("Escape");
1693 key_event.event_string = g_strdup ("Up");
1696 key_event.event_string = g_strdup ("Down");
1699 key_event.event_string = g_strdup ("Left");
1702 key_event.event_string = g_strdup ("Right");
1708 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1709 key_event.event_string = g_strdup (cbuf);
1710 c = keysym2ucs (keysym);
1711 if (c > 0 && !g_unichar_iscntrl (c))
1713 key_event.is_text = TRUE;
1714 /* incorrect for some composed chars? */
1719 key_event.event_string = g_strdup ("");
1723 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1724 #ifdef SPI_KEYEVENT_DEBUG
1726 char *pressed_str = "pressed";
1727 char *released_str = "released";
1730 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1731 state_ptr = pressed_str;
1733 state_ptr = released_str;
1736 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1737 (unsigned long) keysym,
1739 keysym ? (int) keysym : '*',
1740 (int) x_key_event->state,
1741 key_event.event_string,
1742 key_event.event_string[0],
1743 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1747 fprintf (stderr, "%s%c\n",
1748 (x_key_event->state & Mod1Mask)?"Alt-":"",
1749 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1750 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1751 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1752 #endif /* SPI_DEBUG */
1757 spi_controller_update_key_grabs (SpiDEController *controller,
1758 Accessibility_DeviceEvent *recv)
1761 gboolean update_failed = FALSE;
1762 KeyCode keycode = 0;
1764 g_return_val_if_fail (controller != NULL, FALSE);
1767 * masks known to work with default RH 7.1+:
1768 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1769 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1770 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1771 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1773 * ControlMask grabs are broken, must be in use already
1776 keycode = keycode_for_keysym (controller, recv->id, NULL);
1777 for (l = controller->keygrabs_list; l; l = next)
1780 gboolean re_issue_grab;
1781 DEControllerGrabMask *grab_mask = l->data;
1785 re_issue_grab = recv &&
1786 (recv->modifiers & grab_mask->mod_mask) &&
1787 (grab_mask->key_val == keycode);
1790 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1791 (long int) grab_mask->key_val,
1792 (long int) grab_mask->mod_mask,
1793 grab_mask->pending_add ? '+' : '.',
1794 grab_mask->pending_remove ? '-' : '.',
1795 re_issue_grab ? "re-issue": "");
1800 if (grab_mask->pending_add && grab_mask->pending_remove)
1804 else if (grab_mask->pending_remove)
1807 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1809 XUngrabKey (spi_get_display (),
1811 grab_mask->mod_mask,
1812 spi_get_root_window ());
1816 else if (grab_mask->pending_add || re_issue_grab)
1820 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1822 XGrabKey (spi_get_display (),
1824 grab_mask->mod_mask,
1825 spi_get_root_window (),
1829 XSync (spi_get_display (), False);
1830 update_failed = spi_clear_error_state ();
1831 if (update_failed) {
1832 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1837 grab_mask->pending_add = FALSE;
1838 grab_mask->pending_remove = FALSE;
1842 g_assert (grab_mask->ref_count <= 0);
1844 controller->keygrabs_list = g_list_delete_link (
1845 controller->keygrabs_list, l);
1847 spi_grab_mask_free (grab_mask);
1852 return ! update_failed;
1856 * Implemented GObject::finalize
1859 spi_device_event_controller_object_finalize (GObject *object)
1861 SpiDEController *controller;
1862 DEControllerPrivateData *private;
1863 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1864 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1866 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1868 /* disconnect any special listeners, get rid of outstanding keygrabs */
1869 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1872 if (controller->xevie_display != NULL)
1874 XevieEnd(controller->xevie_display);
1875 #ifdef SPI_KEYEVENT_DEBUG
1876 printf("XevieEnd(dpy) finished \n");
1881 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1882 if (private->xkb_desc)
1883 XkbFreeKeyboard (private->xkb_desc, 0, True);
1885 parent_class->finalize (object);
1889 * DBus Accessibility::DEController::RegisterKeystrokeListener
1890 * method implementation
1892 static DBusMessage *
1893 impl_register_keystroke_listener (DBusConnection *bus,
1894 DBusMessage *message,
1897 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1898 DEControllerKeyListener *dec_listener;
1899 DBusMessageIter iter, iter_array;
1901 GSList *keys = NULL;
1902 dbus_int32_t mask, type;
1903 Accessibility_EventListenerMode *mode;
1905 DBusMessage *reply = NULL;
1908 dbus_message_iter_init(message, &iter);
1909 // TODO: verify type signature
1910 dbus_message_iter_get_basic(&iter, &path);
1911 dbus_message_iter_next(&iter);
1912 dbus_message_iter_recurse(&iter, &iter_array);
1913 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1915 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
1916 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))
1920 kd->keystring = g_strdup (keystring);
1921 keys = g_slist_append(keys, kd);
1923 dbus_message_iter_next(&iter);
1924 dbus_message_iter_get_basic(&iter, &mask);
1925 dbus_message_iter_next(&iter);
1926 if (!strcmp (dbus_message_iter_get_signature (&iter), "u"))
1927 dbus_message_iter_get_basic(&iter, &type);
1930 dbus_message_iter_recurse(&iter, &iter_array);
1931 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1934 dbus_message_iter_get_basic (&iter_array, &t);
1936 dbus_message_iter_next (&iter_array);
1938 dbus_message_iter_next (&iter_array);
1940 dbus_message_iter_next(&iter);
1941 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
1944 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);
1947 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
1948 dbus_message_get_sender(message), path, (unsigned long) mask);
1950 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
1951 ret = spi_controller_register_device_listener (
1952 controller, (DEControllerListener *) dec_listener);
1953 reply = dbus_message_new_method_return (message);
1956 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1962 * DBus Accessibility::DEController::RegisterDeviceEventListener
1963 * method implementation
1965 static DBusMessage *
1966 impl_register_device_event_listener (DBusConnection *bus,
1967 DBusMessage *message,
1970 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1971 DEControllerListener *dec_listener;
1974 dbus_int32_t event_types;
1976 DBusMessage *reply = NULL;
1978 dbus_error_init(&error);
1979 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
1981 return invalid_arguments_error (message);
1983 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
1984 ret = spi_controller_register_device_listener (
1985 controller, (DEControllerListener *) dec_listener);
1986 reply = dbus_message_new_method_return (message);
1989 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1995 DBusConnection *bus;
1996 DEControllerListener *listener;
1997 } RemoveListenerClosure;
1999 static SpiReEntrantContinue
2000 remove_listener_cb (GList * const *list,
2003 DEControllerListener *listener = (*list)->data;
2004 RemoveListenerClosure *ctx = user_data;
2006 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2007 !strcmp(ctx->listener->path, listener->path))
2009 spi_re_entrant_list_delete_link (list);
2010 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2011 spi_dec_listener_free (listener);
2014 return SPI_RE_ENTRANT_CONTINUE;
2017 static SpiReEntrantContinue
2018 copy_key_listener_cb (GList * const *list,
2021 DEControllerKeyListener *key_listener = (*list)->data;
2022 RemoveListenerClosure *ctx = user_data;
2024 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2025 !strcmp(ctx->listener->path, key_listener->listener.path))
2027 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2028 DEControllerKeyListener *ctx_key_listener =
2029 (DEControllerKeyListener *) ctx->listener;
2030 keylist_free (ctx_key_listener->keys);
2031 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2034 return SPI_RE_ENTRANT_CONTINUE;
2038 spi_controller_deregister_device_listener (SpiDEController *controller,
2039 DEControllerListener *listener)
2041 RemoveListenerClosure ctx;
2043 ctx.bus = controller->bus;
2044 ctx.listener = listener;
2046 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2047 remove_listener_cb, &ctx);
2048 if (!controller->mouse_listeners)
2049 have_mouse_listener = FALSE;
2053 spi_deregister_controller_key_listener (SpiDEController *controller,
2054 DEControllerKeyListener *key_listener)
2056 RemoveListenerClosure ctx;
2058 ctx.bus = controller->bus;
2059 ctx.listener = (DEControllerListener *) key_listener;
2061 /* special case, copy keyset from existing controller list entry */
2062 if (g_slist_length(key_listener->keys) == 0)
2064 spi_re_entrant_list_foreach (&controller->key_listeners,
2065 copy_key_listener_cb, &ctx);
2068 spi_controller_deregister_global_keygrabs (controller, key_listener);
2070 spi_re_entrant_list_foreach (&controller->key_listeners,
2071 remove_listener_cb, &ctx);
2076 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2080 for (l = controller->mouse_listeners; l; l = tmp)
2082 DEControllerListener *listener = l->data;
2084 if (!strcmp (listener->bus_name, bus_name))
2086 spi_controller_deregister_device_listener (controller, listener);
2089 for (l = controller->key_listeners; l; l = tmp)
2091 DEControllerKeyListener *key_listener = l->data;
2093 if (!strcmp (key_listener->listener.bus_name, bus_name))
2095 spi_deregister_controller_key_listener (controller, key_listener);
2101 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2102 * method implementation
2104 static DBusMessage *
2105 impl_deregister_keystroke_listener (DBusConnection *bus,
2106 DBusMessage *message,
2109 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2110 DEControllerKeyListener *key_listener;
2111 DBusMessageIter iter, iter_array;
2113 GSList *keys = NULL;
2114 dbus_int32_t mask, type;
2115 DBusMessage *reply = NULL;
2117 dbus_message_iter_init(message, &iter);
2118 // TODO: verify type signature
2119 dbus_message_iter_get_basic(&iter, &path);
2120 dbus_message_iter_next(&iter);
2121 dbus_message_iter_recurse(&iter, &iter_array);
2122 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2124 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2127 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))
2131 kd->keystring = g_strdup (keystring);
2132 keys = g_slist_append(keys, kd);
2134 dbus_message_iter_next(&iter);
2135 dbus_message_iter_get_basic(&iter, &mask);
2136 dbus_message_iter_next(&iter);
2137 dbus_message_iter_get_basic(&iter, &type);
2138 dbus_message_iter_next(&iter);
2139 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2140 #ifdef SPI_DEREGISTER_DEBUG
2141 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2142 (void *) l, (unsigned long) mask->value);
2145 spi_deregister_controller_key_listener (controller, key_listener);
2147 spi_dec_listener_free ((DEControllerListener *) key_listener);
2148 reply = dbus_message_new_method_return (message);
2153 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2154 * method implementation
2156 static DBusMessage *
2157 impl_deregister_device_event_listener (DBusConnection *bus,
2158 DBusMessage *message,
2161 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2162 DEControllerListener *listener;
2165 dbus_int32_t event_types;
2166 DBusMessage *reply = NULL;
2168 dbus_error_init(&error);
2169 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2171 return invalid_arguments_error (message);
2173 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2174 spi_controller_deregister_device_listener (
2175 controller, listener);
2176 reply = dbus_message_new_method_return (message);
2180 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2182 unsigned int retval = 0;
2183 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2184 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2186 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2187 retval = XkbGetSlowKeysDelay (spi_get_display (),
2188 XkbUseCoreKbd, &bounce_delay);
2190 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2192 Status s = XkbGetControls (spi_get_display (),
2193 XkbAllControlsMask, priv->xkb_desc);
2196 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2197 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2202 #ifdef SPI_XKB_DEBUG
2203 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2208 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2210 unsigned int retval = 0;
2211 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2212 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2214 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2215 retval = XkbGetBounceKeysDelay (spi_get_display (),
2216 XkbUseCoreKbd, &bounce_delay);
2218 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2220 Status s = XkbGetControls (spi_get_display (),
2221 XkbAllControlsMask, priv->xkb_desc);
2224 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2225 retval = priv->xkb_desc->ctrls->debounce_delay;
2230 #ifdef SPI_XKB_DEBUG
2231 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2237 dec_synth_keycode_press (SpiDEController *controller,
2238 unsigned int keycode)
2240 unsigned int time = CurrentTime;
2241 unsigned int bounce_delay;
2242 unsigned int elapsed_msec;
2244 DEControllerPrivateData *priv =
2245 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2246 spi_dec_private_quark);
2247 if (keycode == priv->last_release_keycode)
2249 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2252 gettimeofday (&tv, NULL);
2254 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2255 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2256 #ifdef SPI_XKB_DEBUG
2257 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2258 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2260 #ifdef THIS_IS_BROKEN
2261 if (elapsed_msec < bounce_delay)
2262 time = bounce_delay - elapsed_msec + 1;
2264 time = bounce_delay + 10;
2265 /* fudge for broken XTest */
2267 #ifdef SPI_XKB_DEBUG
2268 fprintf (stderr, "waiting %d ms\n", time);
2272 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2273 priv->last_press_keycode = keycode;
2274 XFlush (spi_get_display ());
2275 XSync (spi_get_display (), False);
2276 gettimeofday (&priv->last_press_time, NULL);
2281 dec_synth_keycode_release (SpiDEController *controller,
2282 unsigned int keycode)
2284 unsigned int time = CurrentTime;
2285 unsigned int slow_delay;
2286 unsigned int elapsed_msec;
2288 DEControllerPrivateData *priv =
2289 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2290 spi_dec_private_quark);
2291 if (keycode == priv->last_press_keycode)
2293 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2296 gettimeofday (&tv, NULL);
2298 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2299 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2300 #ifdef SPI_XKB_DEBUG
2301 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2302 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2304 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2305 if (elapsed_msec < slow_delay)
2306 time = slow_delay - elapsed_msec + 1;
2308 time = slow_delay + 10;
2309 /* our XTest seems broken, we have to add slop as above */
2311 #ifdef SPI_XKB_DEBUG
2312 fprintf (stderr, "waiting %d ms\n", time);
2316 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2317 priv->last_release_keycode = keycode;
2318 XSync (spi_get_display (), False);
2319 gettimeofday (&priv->last_release_time, NULL);
2324 dec_get_modifier_state (SpiDEController *controller)
2326 return mouse_mask_state;
2330 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2332 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2333 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2335 if (priv->have_xkb) {
2336 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2337 modifiers, modifiers);
2340 for (mod_index=0;mod_index<8;mod_index++)
2341 if (modifiers & (1<<mod_index))
2342 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2348 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2350 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2351 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2353 if (priv->have_xkb) {
2354 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2358 for (mod_index=0;mod_index<8;mod_index++)
2359 if (modifiers & (1<<mod_index))
2360 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2366 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2368 return ucs2keysym ((long) unichar);
2372 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2374 KeyCode key_synth_code;
2375 unsigned int modifiers, synth_mods, lock_mods;
2377 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2379 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2381 /* TODO: set the modifiers accordingly! */
2382 modifiers = dec_get_modifier_state (controller);
2383 /* side-effect; we may unset mousebutton modifiers here! */
2386 if (synth_mods != modifiers) {
2387 lock_mods = synth_mods & ~modifiers;
2388 dec_lock_modifiers (controller, lock_mods);
2390 dec_synth_keycode_press (controller, key_synth_code);
2391 dec_synth_keycode_release (controller, key_synth_code);
2393 if (synth_mods != modifiers)
2394 dec_unlock_modifiers (controller, lock_mods);
2400 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2402 /* probably we need to create and inject an XIM handler eventually. */
2403 /* for now, try to match the string to existing
2404 * keycode+modifier states.
2408 gunichar unichar = 0;
2410 gboolean retval = TRUE;
2413 maxlen = strlen (keystring) + 1;
2414 keysyms = g_new0 (KeySym, maxlen);
2415 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2420 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2422 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2427 mbytes = g_unichar_to_utf8 (unichar, bytes);
2428 bytes[mbytes] = '\0';
2430 fprintf (stderr, "[unichar %s]", bytes);
2432 keysym = dec_keysym_for_unichar (controller, unichar);
2433 if (keysym == NoSymbol) {
2435 fprintf (stderr, "no keysym for %s", bytes);
2440 keysyms[i++] = keysym;
2441 keystring = g_utf8_next_char (keystring);
2444 XSynchronize (spi_get_display (), TRUE);
2445 for (i = 0; keysyms[i]; ++i) {
2446 if (!dec_synth_keysym (controller, keysyms[i])) {
2448 fprintf (stderr, "could not synthesize %c\n",
2455 XSynchronize (spi_get_display (), FALSE);
2464 * DBus Accessibility::DEController::RegisterKeystrokeListener
2465 * method implementation
2467 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2469 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2471 dbus_int32_t keycode;
2473 dbus_uint32_t synth_type;
2476 DEControllerPrivateData *priv;
2477 DBusMessage *reply = NULL;
2479 dbus_error_init(&error);
2480 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2482 return invalid_arguments_error (message);
2486 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2487 (long) keycode, (int) synth_type);
2489 /* TODO: hide/wrap/remove X dependency */
2492 * TODO: when initializing, query for XTest extension before using,
2493 * and fall back to XSendEvent() if XTest is not available.
2496 spi_x_error_trap ();
2498 priv = (DEControllerPrivateData *)
2499 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2501 if (!priv->have_xkb && xmkeymap==NULL) {
2502 xmkeymap = XGetModifierMapping(spi_get_display ());
2507 case Accessibility_KEY_PRESS:
2508 dec_synth_keycode_press (controller, keycode);
2510 case Accessibility_KEY_PRESSRELEASE:
2511 dec_synth_keycode_press (controller, keycode);
2512 case Accessibility_KEY_RELEASE:
2513 dec_synth_keycode_release (controller, keycode);
2515 case Accessibility_KEY_SYM:
2516 #ifdef SPI_XKB_DEBUG
2517 fprintf (stderr, "KeySym synthesis\n");
2520 * note: we are using long for 'keycode'
2521 * in our arg list; it can contain either
2522 * a keycode or a keysym.
2524 dec_synth_keysym (controller, (KeySym) keycode);
2526 case Accessibility_KEY_STRING:
2527 if (!dec_synth_keystring (controller, keystring))
2528 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2532 if (synth_type == Accessibility_KEY_SYM) {
2536 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2538 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2540 spi_dec_clear_unlatch_pending (controller);
2542 reply = dbus_message_new_method_return (message);
2546 /* Accessibility::DEController::GenerateMouseEvent */
2547 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2553 DBusMessage *reply = NULL;
2555 gboolean err = FALSE;
2556 Display *display = spi_get_display ();
2558 dbus_error_init (&error);
2559 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2561 return invalid_arguments_error (message);
2565 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2566 eventName, (long int) x, (long int) y);
2568 switch (eventName[0])
2571 switch (eventName[1])
2573 /* TODO: check number of buttons before parsing */
2594 if (x != -1 && y != -1)
2596 XTestFakeMotionEvent (display, DefaultScreen (display),
2599 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2600 if (eventName[2] == 'c')
2601 XTestFakeButtonEvent (display, button, FALSE, 1);
2602 else if (eventName[2] == 'd')
2604 XTestFakeButtonEvent (display, button, FALSE, 1);
2605 XTestFakeButtonEvent (display, button, TRUE, 2);
2606 XTestFakeButtonEvent (display, button, FALSE, 3);
2610 case 'r': /* relative motion */
2611 XTestFakeRelativeMotionEvent (display, x, y, 0);
2613 case 'a': /* absolute motion */
2614 XTestFakeMotionEvent (display, DefaultScreen (display),
2618 reply = dbus_message_new_method_return (message);
2622 /* Accessibility::DEController::NotifyListenersSync */
2623 static DBusMessage *
2624 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2626 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2627 Accessibility_DeviceEvent event;
2629 DBusMessage *reply = NULL;
2631 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2633 return invalid_arguments_error (message);
2636 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2637 controller, (int) event.id);
2639 ret = spi_controller_notify_keylisteners (controller,
2640 (Accessibility_DeviceEvent *)
2643 reply = dbus_message_new_method_return (message);
2646 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2651 static DBusMessage *
2652 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2654 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2655 Accessibility_DeviceEvent event;
2656 DBusMessage *reply = NULL;
2658 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2660 return invalid_arguments_error (message);
2663 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2664 controller, (int) event.id);
2666 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2668 reply = dbus_message_new_method_return (message);
2673 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2675 GObjectClass * object_class = (GObjectClass *) klass;
2677 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2679 object_class->finalize = spi_device_event_controller_object_finalize;
2681 if (!spi_dec_private_quark)
2682 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2686 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2692 handle_io (GIOChannel *source,
2693 GIOCondition condition,
2696 SpiDEController *controller = (SpiDEController *) data;
2697 gboolean is_consumed = FALSE;
2700 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2702 if (ev.type == KeyPress || ev.type == KeyRelease)
2703 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2706 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2711 #endif /* HAVE_XEVIE */
2714 spi_device_event_controller_init (SpiDEController *device_event_controller)
2716 spi_events_init (spi_get_display());
2720 #endif /* HAVE_XEVIE */
2722 DEControllerPrivateData *private;
2723 device_event_controller->key_listeners = NULL;
2724 device_event_controller->mouse_listeners = NULL;
2725 device_event_controller->keygrabs_list = NULL;
2726 device_event_controller->xevie_display = NULL;
2729 device_event_controller->xevie_display = XOpenDisplay(NULL);
2731 if (XevieStart(device_event_controller->xevie_display) == TRUE)
2733 #ifdef SPI_KEYEVENT_DEBUG
2734 fprintf (stderr, "XevieStart() success \n");
2736 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2738 fd = ConnectionNumber(device_event_controller->xevie_display);
2739 ioc = g_io_channel_unix_new (fd);
2740 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2741 g_io_channel_unref (ioc);
2745 device_event_controller->xevie_display = NULL;
2746 #ifdef SPI_KEYEVENT_DEBUG
2747 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2750 #endif /* HAVE_XEVIE */
2752 private = g_new0 (DEControllerPrivateData, 1);
2753 gettimeofday (&private->last_press_time, NULL);
2754 gettimeofday (&private->last_release_time, NULL);
2755 g_object_set_qdata (G_OBJECT (device_event_controller),
2756 spi_dec_private_quark,
2758 spi_controller_register_with_devices (device_event_controller);
2759 device_event_controller->message_queue = g_queue_new ();
2760 saved_controller = device_event_controller;
2764 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2765 const XEvent *event)
2767 Accessibility_DeviceEvent key_event;
2770 g_assert (event->type == KeyPress || event->type == KeyRelease);
2772 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2774 if (controller->xevie_display == NULL)
2775 spi_controller_update_key_grabs (controller, &key_event);
2777 /* relay to listeners, and decide whether to consume it or not */
2778 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2779 g_free(key_event.event_string);
2785 is_key_released (KeyCode code)
2790 XQueryKeymap (spi_get_display (), keys);
2791 down = BIT (keys, code);
2796 check_release (gpointer data)
2799 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2800 KeyCode code = event->hw_code;
2802 released = is_key_released (code);
2806 check_release_handler = 0;
2807 event->type = Accessibility_KEY_RELEASED_EVENT;
2808 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2810 return (released == 0);
2813 static void wait_for_release_event (XEvent *event,
2814 SpiDEController *controller)
2816 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2817 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2820 /*---------------------------------------------------------------------------*/
2822 static const char *introspection_header =
2823 "<?xml version=\"1.0\"?>\n";
2825 static const char *introspection_node_element =
2826 "<node name=\"%s\">\n";
2828 static const char *introspection_footer =
2831 static DBusMessage *
2832 impl_Introspect (DBusConnection * bus,
2833 DBusMessage * message, void *user_data)
2839 const gchar *pathstr = SPI_DBUS_PATH_DEC;
2843 output = g_string_new(introspection_header);
2845 g_string_append_printf(output, introspection_node_element, pathstr);
2847 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
2849 g_string_append(output, introspection_footer);
2850 final = g_string_free(output, FALSE);
2852 reply = dbus_message_new_method_return (message);
2853 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
2859 /*---------------------------------------------------------------------------*/
2862 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
2864 const gchar *iface = dbus_message_get_interface (message);
2865 const gchar *member = dbus_message_get_member (message);
2866 const gint type = dbus_message_get_type (message);
2867 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2868 DBusMessage *reply = NULL;
2870 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
2872 result = DBUS_HANDLER_RESULT_HANDLED;
2873 if (!strcmp (member, "RegisterKeystrokeListener"))
2874 reply = impl_register_keystroke_listener (bus, message, user_data);
2875 else if (!strcmp (member, "RegisterDeviceEventListener"))
2876 reply = impl_register_device_event_listener (bus, message, user_data);
2877 else if (!strcmp (member, "DeregisterKeystrokeListener"))
2878 reply = impl_deregister_keystroke_listener (bus, message, user_data);
2879 else if (!strcmp (member, "DeregisterDeviceEventListener"))
2880 reply = impl_deregister_device_event_listener (bus, message, user_data);
2881 else if (!strcmp (member, "GenerateKeyboardEvent"))
2882 reply = impl_generate_keyboard_event (bus, message, user_data);
2883 else if (!strcmp (member, "GenerateMouseEvent"))
2884 reply = impl_generate_mouse_event (bus, message, user_data);
2885 else if (!strcmp (member, "NotifyListenersSync"))
2886 reply = impl_notify_listeners_sync (bus, message, user_data);
2887 else if (!strcmp (member, "NotifyListenersAsync"))
2888 reply = impl_notify_listeners_async (bus, message, user_data);
2890 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2893 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
2895 result = DBUS_HANDLER_RESULT_HANDLED;
2896 if (!strcmp (member, "Introspect"))
2897 reply = impl_Introspect (bus, message, user_data);
2899 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2902 if (result == DBUS_HANDLER_RESULT_HANDLED)
2906 reply = dbus_message_new_method_return (message);
2909 dbus_connection_send (bus, reply, NULL);
2910 dbus_message_unref (reply);
2915 message_queue_dispatch (gpointer data)
2917 saved_controller->message_queue_idle = 0;
2918 while (!g_queue_is_empty (saved_controller->message_queue))
2920 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
2921 data = g_queue_pop_head (saved_controller->message_queue);
2922 handle_dec_method_from_idle (saved_controller->bus, message, data);
2923 dbus_message_unref (message);
2928 static DBusHandlerResult
2929 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
2931 const gchar *iface = dbus_message_get_interface (message);
2932 const gchar *member = dbus_message_get_member (message);
2933 const gint type = dbus_message_get_type (message);
2935 /* Check for basic reasons not to handle */
2936 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
2939 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2941 dbus_message_ref (message);
2942 g_queue_push_tail (saved_controller->message_queue, message);
2943 g_queue_push_tail (saved_controller->message_queue, user_data);
2944 if (!saved_controller->message_queue_idle)
2945 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
2946 return DBUS_HANDLER_RESULT_HANDLED;
2949 static DBusObjectPathVTable dec_vtable =
2953 NULL, NULL, NULL, NULL
2957 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
2959 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2961 dec->registry = g_object_ref (reg);
2962 reg->dec = g_object_ref (dec);
2965 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
2967 spi_dec_init_mouse_listener (dec);
2973 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
2975 if (!have_mouse_event_listener)
2977 have_mouse_event_listener = TRUE;
2978 if (!have_mouse_listener)
2979 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
2984 spi_device_event_controller_stop_poll_mouse (void)
2986 have_mouse_event_listener = FALSE;