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 return !dbus_error_is_set (&error);
209 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
211 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
215 dbus_error_init (&error);
216 dbus_bus_remove_match (bus, match, &error);
218 return !dbus_error_is_set (&error);
224 keysym_mod_mask (KeySym keysym, KeyCode keycode)
226 /* we really should use XKB and look directly at the keymap */
227 /* this is very inelegant */
228 Display *display = spi_get_display ();
229 unsigned int mods_rtn = 0;
230 unsigned int retval = 0;
233 if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
234 (sym_rtn == keysym)) {
237 else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
238 (sym_rtn == keysym)) {
241 else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
242 (sym_rtn == keysym)) {
245 else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
246 (sym_rtn == keysym)) {
249 else if (XkbLookupKeySym (display, keycode,
250 ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
251 (sym_rtn == keysym)) {
252 retval = (Mod2Mask | ShiftMask);
254 else if (XkbLookupKeySym (display, keycode,
255 ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
256 (sym_rtn == keysym)) {
257 retval = (Mod3Mask | ShiftMask);
259 else if (XkbLookupKeySym (display, keycode,
260 ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
261 (sym_rtn == keysym)) {
262 retval = (Mod4Mask | ShiftMask);
270 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
273 Display *dpy = spi_get_display ();
275 if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
277 fprintf (stderr, "ERROR getting map\n");
281 if (desc && desc->map)
283 gint offset = desc->map->key_sym_map[keycode].offset;
284 desc->map->syms[offset] = keysym;
288 fprintf (stderr, "Error changing key map: empty server structure\n");
290 XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
292 * FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
293 * would be far preferable.
294 * HOWEVER it does not seem to work using XFree 4.3.
296 /* XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
299 XkbFreeKeyboard (desc, 0, TRUE);
308 spi_dec_reset_reserved (gpointer data)
310 DEControllerPrivateData *priv = data;
311 spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
312 priv->reserved_reset_timeout = 0;
317 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
320 keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
323 DEControllerPrivateData *priv = (DEControllerPrivateData *)
324 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
325 /* if there's no keycode available, fix it */
326 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
328 keycode = priv->reserved_keycode;
330 * queue a timer to restore the old keycode. Ugly, but required
331 * due to races / asynchronous X delivery.
332 * Long-term fix is to extend the X keymap here instead of replace entries.
334 priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
340 *modmask = keysym_mod_mask (keysym, keycode);
344 static DEControllerGrabMask *
345 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
347 DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
349 memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
351 clone->ref_count = 1;
352 clone->pending_add = TRUE;
353 clone->pending_remove = FALSE;
359 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
365 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
367 DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
368 DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
376 return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
381 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
383 DEControllerPrivateData *priv =
384 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
386 if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
387 priv->xkb_latch_mask);
389 priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
393 spi_dec_clear_unlatch_pending (SpiDEController *controller)
395 DEControllerPrivateData *priv =
396 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
397 priv->xkb_latch_mask = 0;
400 static void emit(SpiDEController *controller, const char *interface, const char *name, const char *minor, int a1, int a2)
402 DBusMessage *signal = NULL;
403 DBusMessageIter iter, iter_struct, iter_variant;
405 const char *path = SPI_DBUS_PATH_ROOT;
406 const char *bus_name = dbus_bus_get_unique_name (controller->bus);
408 signal = dbus_message_new_signal (path, interface, name);
410 dbus_message_iter_init_append (signal, &iter);
412 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
413 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a1);
414 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a2);
415 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
416 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
417 dbus_message_iter_close_container (&iter, &iter_variant);
419 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
421 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
422 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
423 dbus_message_iter_close_container (&iter, &iter_struct);
425 dbus_connection_send (controller->bus, signal, NULL);
426 dbus_message_unref (signal);
430 spi_dec_button_update_and_emit (SpiDEController *controller,
433 Accessibility_DeviceEvent mouse_e;
434 gchar event_detail[3];
435 gboolean is_consumed = FALSE;
437 if ((mask_return & mouse_button_mask) !=
438 (mouse_mask_state & mouse_button_mask))
440 int button_number = 0;
441 gboolean is_down = False;
443 if (!(mask_return & Button1Mask) &&
444 (mouse_mask_state & Button1Mask))
446 mouse_mask_state &= ~Button1Mask;
449 else if ((mask_return & Button1Mask) &&
450 !(mouse_mask_state & Button1Mask))
452 mouse_mask_state |= Button1Mask;
456 else if (!(mask_return & Button2Mask) &&
457 (mouse_mask_state & Button2Mask))
459 mouse_mask_state &= ~Button2Mask;
462 else if ((mask_return & Button2Mask) &&
463 !(mouse_mask_state & Button2Mask))
465 mouse_mask_state |= Button2Mask;
469 else if (!(mask_return & Button3Mask) &&
470 (mouse_mask_state & Button3Mask))
472 mouse_mask_state &= ~Button3Mask;
475 else if ((mask_return & Button3Mask) &&
476 !(mouse_mask_state & Button3Mask))
478 mouse_mask_state |= Button3Mask;
482 else if (!(mask_return & Button4Mask) &&
483 (mouse_mask_state & Button4Mask))
485 mouse_mask_state &= ~Button4Mask;
488 else if ((mask_return & Button4Mask) &&
489 !(mouse_mask_state & Button4Mask))
491 mouse_mask_state |= Button4Mask;
495 else if (!(mask_return & Button5Mask) &&
496 (mouse_mask_state & Button5Mask))
498 mouse_mask_state &= ~Button5Mask;
501 else if ((mask_return & Button5Mask) &&
502 !(mouse_mask_state & Button5Mask))
504 mouse_mask_state |= Button5Mask;
510 fprintf (stderr, "Button %d %s\n",
511 button_number, (is_down) ? "Pressed" : "Released");
513 snprintf (event_detail, 3, "%d%c", button_number,
514 (is_down) ? 'p' : 'r');
515 /* TODO: FIXME distinguish between physical and
518 mouse_e.type = (is_down) ?
519 Accessibility_BUTTON_PRESSED_EVENT :
520 Accessibility_BUTTON_RELEASED_EVENT;
521 mouse_e.id = button_number;
522 mouse_e.hw_code = button_number;
523 mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
524 mouse_e.timestamp = 0;
525 mouse_e.event_string = "";
526 mouse_e.is_text = FALSE;
528 spi_controller_notify_mouselisteners (controller,
532 dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
533 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, x, y);
536 spi_dec_set_unlatch_pending (controller, mask_return);
548 spi_dec_mouse_check (SpiDEController *controller,
549 int *x, int *y, gboolean *moved)
551 int win_x_return,win_y_return;
552 unsigned int mask_return;
553 Window root_return, child_return;
554 Display *display = spi_get_display ();
557 XQueryPointer(display, DefaultRootWindow (display),
558 &root_return, &child_return,
560 &win_x_return, &win_y_return, &mask_return);
562 * Since many clients grab the pointer, and X goes an automatic
563 * pointer grab on mouse-down, we often must detect mouse button events
564 * by polling rather than via a button grab.
565 * The while loop (rather than if) is used since it's possible that
566 * multiple buttons have changed state since we last checked.
568 if (mask_return != mouse_mask_state)
570 while (spi_dec_button_update_and_emit (controller, mask_return));
573 if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
575 // TODO: combine these two signals?
576 dbus_uint32_t ix = *x, iy = *y;
577 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Abs", "", ix, iy);
578 ix -= last_mouse_pos->x;
579 iy -= last_mouse_pos->y;
580 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Rel", "", ix, iy);
581 last_mouse_pos->x = *x;
582 last_mouse_pos->y = *y;
594 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
597 dbus_uint32_t d1, d2;
600 fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
601 prev_mask, current_mask);
604 /* set bits for the virtual modifiers like NUMLOCK */
605 if (prev_mask & _numlock_physical_mask)
606 prev_mask |= SPI_KEYMASK_NUMLOCK;
607 if (current_mask & _numlock_physical_mask)
608 current_mask |= SPI_KEYMASK_NUMLOCK;
610 d1 = prev_mask & key_modifier_mask;
611 d2 = current_mask & key_modifier_mask;
612 emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "Modifiers", "", d1, d2);
616 spi_dec_poll_mouse_moved (gpointer data)
618 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
623 mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
625 if ((mask_return & key_modifier_mask) !=
626 (mouse_mask_state & key_modifier_mask))
628 spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
629 mouse_mask_state = mask_return;
636 spi_dec_poll_mouse_idle (gpointer data)
638 if (!have_mouse_event_listener && !have_mouse_listener)
640 else if (!spi_dec_poll_mouse_moved (data))
644 g_timeout_add (20, spi_dec_poll_mouse_moving, data);
650 spi_dec_poll_mouse_moving (gpointer data)
652 if (!have_mouse_event_listener && !have_mouse_listener)
654 else if (spi_dec_poll_mouse_moved (data))
658 g_timeout_add (100, spi_dec_poll_mouse_idle, data);
663 #ifdef WE_NEED_UGRAB_MOUSE
665 spi_dec_ungrab_mouse (gpointer data)
667 Display *display = spi_get_display ();
670 XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
671 XDefaultRootWindow (spi_get_display ()));
678 spi_dec_init_mouse_listener (SpiDEController *dec)
681 Display *display = spi_get_display ();
685 if (XGrabButton (display, AnyButton, AnyModifier,
686 spi_get_root_window (),
687 True, ButtonPressMask | ButtonReleaseMask,
688 GrabModeSync, GrabModeAsync, None, None) != Success) {
690 fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
694 XSync (display, False);
696 fprintf (stderr, "mouse buttons grabbed\n");
703 * Eventually we can use this to make the marshalling of mask types
704 * more sane, but for now we just use this to detect
705 * the use of 'virtual' masks such as numlock and convert them to
706 * system-specific mask values (i.e. ModMask).
709 static Accessibility_ControllerEventMask
710 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
712 Accessibility_ControllerEventMask tmp_mask;
713 gboolean has_numlock;
715 has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
719 tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
720 tmp_mask |= _numlock_physical_mask;
726 static DEControllerKeyListener *
727 spi_dec_key_listener_new (const char *bus_name,
730 const Accessibility_ControllerEventMask mask,
731 const dbus_uint32_t types,
732 const Accessibility_EventListenerMode *mode)
734 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
735 key_listener->listener.bus_name = g_strdup(bus_name);
736 key_listener->listener.path = g_strdup(path);
737 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
738 key_listener->keys = keys;
739 key_listener->mask = spi_dec_translate_mask (mask);
740 key_listener->listener.types = types;
743 key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
744 memcpy(key_listener->mode, mode, sizeof(*mode));
747 key_listener->mode = NULL;
750 g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
751 (unsigned int) key_listener->mask,
752 (int) (mode ? mode->global : 0),
753 (void *) key_listener->keys,
754 (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
760 static DEControllerListener *
761 spi_dec_listener_new (const char *bus_name,
765 DEControllerListener *listener = g_new0 (DEControllerListener, 1);
766 listener->bus_name = g_strdup(bus_name);
767 listener->path = g_strdup(path);
768 listener->type = SPI_DEVICE_TYPE_MOUSE;
769 listener->types = types;
773 static DEControllerListener *
774 spi_listener_clone (DEControllerListener *listener)
776 DEControllerListener *clone = g_new0 (DEControllerListener, 1);
777 clone->bus_name = g_strdup (listener->bus_name);
778 clone->path = g_strdup (listener->path);
779 clone->type = listener->type;
780 clone->types = listener->types;
784 static GSList *keylist_clone (GSList *s)
789 for (l = s; l; l = g_slist_next(l))
791 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
794 Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
795 kd->keycode = kds->keycode;
796 kd->keysym = kds->keysym;
797 kd->keystring = g_strdup(kds->keystring);
798 d = g_slist_append(d, kd);
804 static DEControllerKeyListener *
805 spi_key_listener_clone (DEControllerKeyListener *key_listener)
807 DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
808 clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
809 clone->listener.path = g_strdup (key_listener->listener.path);
810 clone->listener.type = SPI_DEVICE_TYPE_KBD;
811 clone->keys = keylist_clone (key_listener->keys);
812 clone->mask = key_listener->mask;
813 clone->listener.types = key_listener->listener.types;
814 if (key_listener->mode)
816 clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
817 if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
824 static void keylist_free(GSList *keys)
828 for (l = keys; l; l = g_slist_next(l))
830 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
831 g_free(kd->keystring);
838 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
840 keylist_free(key_listener->keys);
841 if (key_listener->mode) g_free(key_listener->mode);
842 g_free (key_listener->listener.bus_name);
843 g_free (key_listener->listener.path);
844 g_free (key_listener);
848 spi_key_listener_clone_free (DEControllerKeyListener *clone)
850 spi_key_listener_data_free (clone);
854 spi_listener_clone_free (DEControllerListener *clone)
856 g_free (clone->path);
857 g_free (clone->bus_name);
862 spi_dec_listener_free (DEControllerListener *listener)
864 if (listener->type == SPI_DEVICE_TYPE_KBD)
865 spi_key_listener_data_free ((DEControllerKeyListener *) listener);
868 g_free (listener->bus_name);
869 g_free (listener->path);
874 _register_keygrab (SpiDEController *controller,
875 DEControllerGrabMask *grab_mask)
879 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
880 spi_grab_mask_compare_values);
883 DEControllerGrabMask *cur_mask = l->data;
885 cur_mask->ref_count++;
886 if (cur_mask->pending_remove)
888 cur_mask->pending_remove = FALSE;
893 controller->keygrabs_list =
894 g_list_prepend (controller->keygrabs_list,
895 spi_grab_mask_clone (grab_mask));
900 _deregister_keygrab (SpiDEController *controller,
901 DEControllerGrabMask *grab_mask)
905 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
906 spi_grab_mask_compare_values);
910 DEControllerGrabMask *cur_mask = l->data;
912 cur_mask->ref_count--;
913 if (cur_mask->ref_count <= 0)
915 cur_mask->pending_remove = TRUE;
921 handle_keygrab (SpiDEController *controller,
922 DEControllerKeyListener *key_listener,
923 void (*process_cb) (SpiDEController *controller,
924 DEControllerGrabMask *grab_mask))
926 DEControllerGrabMask grab_mask = { 0 };
928 grab_mask.mod_mask = key_listener->mask;
929 if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
931 grab_mask.key_val = AnyKey;
933 fprintf (stderr, "AnyKey grab!");
935 process_cb (controller, &grab_mask);
941 for (l = key_listener->keys; l; l = g_slist_next(l))
943 Accessibility_KeyDefinition *keydef = l->data;
944 long int key_val = keydef->keysym;
945 /* X Grabs require keycodes, not keysyms */
946 if (keydef->keystring && keydef->keystring[0])
948 key_val = XStringToKeysym(keydef->keystring);
952 key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
956 key_val = keydef->keycode;
958 grab_mask.key_val = key_val;
959 process_cb (controller, &grab_mask);
965 spi_controller_register_global_keygrabs (SpiDEController *controller,
966 DEControllerKeyListener *key_listener)
968 handle_keygrab (controller, key_listener, _register_keygrab);
969 if (controller->xevie_display == NULL)
970 return spi_controller_update_key_grabs (controller, NULL);
976 spi_controller_deregister_global_keygrabs (SpiDEController *controller,
977 DEControllerKeyListener *key_listener)
979 handle_keygrab (controller, key_listener, _deregister_keygrab);
980 if (controller->xevie_display == NULL)
981 spi_controller_update_key_grabs (controller, NULL);
985 append_keystroke_listener (DBusMessageIter *iter, DEControllerKeyListener *listener)
987 dbus_uint32_t d_uint;
988 DBusMessageIter iter_struct, iter_subarray, iter_substruct;
992 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
996 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
997 &listener->listener.bus_name);
998 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
999 &listener->listener.path);
1000 d_uint = listener->listener.type;
1001 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1002 d_uint = listener->listener.types;
1003 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1004 if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY,
1005 "(iisi)", &iter_subarray))
1007 dbus_message_iter_close_container (iter, &iter_struct);
1010 for (kl = listener->keys; kl; kl = kl->next)
1012 Accessibility_KeyDefinition *kd = kl->data;
1013 if (!dbus_message_iter_open_container (&iter_subarray, DBUS_TYPE_STRUCT,
1014 NULL, &iter_substruct))
1016 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keycode);
1017 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keysym);
1018 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_STRING, &kd->keystring);
1019 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->unused);
1020 dbus_message_iter_close_container (&iter_subarray, &iter_substruct);
1022 dbus_message_iter_close_container (&iter_struct, &iter_subarray);
1023 d_uint = listener->mask;
1024 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1025 if (dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT,
1026 NULL, &iter_substruct))
1028 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1029 &listener->mode->synchronous);
1030 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1031 &listener->mode->preemptive);
1032 dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1033 &listener->mode->global);
1034 dbus_message_iter_close_container (&iter_struct, &iter_substruct);
1036 dbus_message_iter_close_container (iter, &iter_struct);
1040 notify_keystroke_listener (SpiDEController *controller,
1041 DEControllerKeyListener *listener,
1044 const char *path = SPI_DBUS_PATH_DEC;
1045 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1046 const char *name = (enable
1047 ? "KeystrokeListenerRegistered"
1048 : "KeystrokeListenerDeregistered");
1049 DBusMessage *signal;
1050 DBusMessageIter iter;
1052 signal = dbus_message_new_signal (path, interface, name);
1055 dbus_message_iter_init_append (signal, &iter);
1056 append_keystroke_listener (&iter, listener);
1057 dbus_connection_send (controller->bus, signal, NULL);
1058 dbus_message_unref (signal);
1062 append_mouse_listener (DBusMessageIter *iter, DEControllerListener *listener)
1064 DBusMessageIter iter_struct;
1065 dbus_uint32_t d_uint;
1067 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1070 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1071 &listener->bus_name);
1072 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1074 d_uint = listener->types;
1075 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1076 dbus_message_iter_close_container (iter, &iter_struct);
1080 notify_mouse_listener (SpiDEController *controller,
1081 DEControllerListener *listener,
1084 const char *path = SPI_DBUS_PATH_DEC;
1085 const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1086 const char *name = (enable
1087 ? "DeviceListenerRegistered"
1088 : "DeviceListenerDeregistered");
1089 DBusMessage *signal;
1090 DBusMessageIter iter;
1092 signal = dbus_message_new_signal (path, interface, name);
1095 dbus_message_iter_init_append (signal, &iter);
1096 append_mouse_listener (&iter, listener);
1097 dbus_connection_send (controller->bus, signal, NULL);
1098 dbus_message_unref (signal);
1102 spi_controller_register_device_listener (SpiDEController *controller,
1103 DEControllerListener *listener)
1105 DEControllerKeyListener *key_listener;
1108 switch (listener->type) {
1109 case SPI_DEVICE_TYPE_KBD:
1110 key_listener = (DEControllerKeyListener *) listener;
1112 controller->key_listeners = g_list_prepend (controller->key_listeners,
1114 spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
1115 if (key_listener->mode->global)
1117 retval = spi_controller_register_global_keygrabs (controller, key_listener);
1122 notify_keystroke_listener (controller, key_listener, TRUE);
1124 case SPI_DEVICE_TYPE_MOUSE:
1125 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1126 if (!have_mouse_listener)
1128 have_mouse_listener = TRUE;
1129 if (!have_mouse_event_listener)
1130 g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1132 spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1133 notify_mouse_listener (controller, listener, TRUE);
1142 set_reply (DBusPendingCall *pending, void *user_data)
1144 void **replyptr = (void **)user_data;
1146 *replyptr = dbus_pending_call_steal_reply (pending);
1149 static GSList *hung_processes = NULL;
1152 reset_hung_process (DBusPendingCall *pending, void *data)
1154 DBusMessage *message = data;
1155 const char *dest = dbus_message_get_destination (message);
1158 /* At this point we don't care about the result */
1159 dbus_pending_call_unref (pending);
1161 for (l = hung_processes; l; l = l->next)
1163 if (!strcmp (l->data, dest))
1166 hung_processes = g_slist_remove (hung_processes, data);
1173 time_elapsed (struct timeval *origin)
1177 gettimeofday (&tv, NULL);
1178 return (tv.tv_sec - origin->tv_sec) * 1000 + (tv.tv_usec - origin->tv_usec) / 1000;
1181 static DBusMessage *
1182 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1184 DBusPendingCall *pending;
1185 DBusMessage *reply = NULL;
1188 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1192 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1193 gettimeofday (&tv, NULL);
1196 if (!dbus_connection_read_write_dispatch (bus, timeout) ||
1197 time_elapsed (&tv) > timeout)
1199 const char *dest = dbus_message_get_destination (message);
1201 dbus_message_ref (message);
1202 dbus_pending_call_set_notify (pending, reset_hung_process, message,
1203 (DBusFreeFunction) dbus_message_unref);
1204 for (l = hung_processes; l; l = l->next)
1205 if (!strcmp (l->data, dest))
1207 hung_processes = g_slist_prepend (hung_processes, g_strdup (dest));
1211 dbus_pending_call_unref (pending);
1215 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1216 SpiRegistry *registry,
1217 DEControllerListener *listener,
1218 const Accessibility_DeviceEvent *key_event)
1220 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1222 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1225 dbus_bool_t consumed = FALSE;
1228 for (l = hung_processes; l; l = l->next)
1230 if (!strcmp (l->data, listener->bus_name))
1232 dbus_message_unref (message);
1237 dbus_error_init(&error);
1238 if (spi_dbus_marshal_deviceEvent(message, key_event))
1240 DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 1000, &error);
1244 dbus_error_init(&error);
1245 dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1246 dbus_message_unref(reply);
1249 dbus_message_unref(message);
1254 spi_controller_notify_mouselisteners (SpiDEController *controller,
1255 const Accessibility_DeviceEvent *event)
1258 GSList *notify = NULL, *l2;
1259 GList **listeners = &controller->mouse_listeners;
1260 gboolean is_consumed;
1261 #ifdef SPI_KEYEVENT_DEBUG
1262 gboolean found = FALSE;
1269 for (l = *listeners; l; l = l->next)
1271 DEControllerListener *listener = l->data;
1273 if (spi_eventtype_seq_contains_event (listener->types, event))
1275 /* we clone (don't dup) the listener, to avoid refcount inc. */
1276 notify = g_slist_prepend (notify,
1277 spi_listener_clone (listener));
1278 #ifdef SPI_KEYEVENT_DEBUG
1284 #ifdef SPI_KEYEVENT_DEBUG
1287 g_print ("no match for event\n");
1291 is_consumed = FALSE;
1292 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1294 DEControllerListener *listener = l2->data;
1296 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1298 spi_listener_clone_free ((DEControllerListener *) l2->data);
1301 for (; l2; l2 = l2->next)
1303 DEControllerListener *listener = l2->data;
1304 spi_listener_clone_free (listener);
1305 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1308 g_slist_free (notify);
1311 if (is_consumed) g_message ("consumed\n");
1317 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1320 Accessibility_DeviceEvent mouse_e;
1321 gchar event_detail[3];
1322 gboolean is_consumed = FALSE;
1323 gboolean xkb_mod_unlatch_occurred;
1324 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1325 dbus_uint32_t ix, iy;
1327 int button = xbutton_event->button;
1329 unsigned int mouse_button_state = xbutton_event->state;
1334 mouse_button_state |= Button1Mask;
1337 mouse_button_state |= Button2Mask;
1340 mouse_button_state |= Button3Mask;
1343 mouse_button_state |= Button4Mask;
1346 mouse_button_state |= Button5Mask;
1350 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1351 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1354 fprintf (stderr, "mouse button %d %s (%x)\n",
1355 xbutton_event->button,
1356 (xevent->type == ButtonPress) ? "Press" : "Release",
1357 mouse_button_state);
1359 snprintf (event_detail, 3, "%d%c", button,
1360 (xevent->type == ButtonPress) ? 'p' : 'r');
1362 /* TODO: FIXME distinguish between physical and logical buttons */
1363 mouse_e.type = (xevent->type == ButtonPress) ?
1364 Accessibility_BUTTON_PRESSED_EVENT :
1365 Accessibility_BUTTON_RELEASED_EVENT;
1366 mouse_e.id = button;
1367 mouse_e.hw_code = button;
1368 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1369 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1370 mouse_e.event_string = "";
1371 mouse_e.is_text = FALSE;
1372 if ((mouse_button_state & mouse_button_mask) !=
1373 (mouse_mask_state & mouse_button_mask))
1375 if ((mouse_mask_state & key_modifier_mask) !=
1376 (mouse_button_state & key_modifier_mask))
1377 spi_dec_emit_modifier_event (controller,
1378 mouse_mask_state, mouse_button_state);
1379 mouse_mask_state = mouse_button_state;
1381 spi_controller_notify_mouselisteners (controller, &mouse_e);
1382 ix = last_mouse_pos->x;
1383 iy = last_mouse_pos->y;
1384 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1387 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1388 xevent->type == ButtonRelease);
1390 /* if client wants to consume this event, and XKB latch state was
1391 * unset by this button event, we reset it
1393 if (is_consumed && xkb_mod_unlatch_occurred)
1394 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1396 XAllowEvents (spi_get_display (),
1397 (is_consumed) ? SyncPointer : ReplayPointer,
1402 global_filter_fn (XEvent *xevent, void *data)
1404 SpiDEController *controller;
1405 DEControllerPrivateData *priv;
1406 Display *display = spi_get_display ();
1407 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1408 priv = (DEControllerPrivateData *)
1409 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1411 if (xevent->type == MappingNotify)
1414 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1416 if (controller->xevie_display == NULL)
1418 gboolean is_consumed;
1421 spi_device_event_controller_forward_key_event (controller, xevent);
1428 n_events = XPending (display);
1430 #ifdef SPI_KEYEVENT_DEBUG
1431 g_print ("Number of events pending: %d\n", n_events);
1433 for (i = 0; i < n_events; i++)
1435 XNextEvent (display, &next_event);
1436 if (next_event.type != KeyPress &&
1437 next_event.type != KeyRelease)
1438 g_warning ("Unexpected event type %d in queue", next_event.type);
1441 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1443 XUngrabKeyboard (display, CurrentTime);
1447 if (xevent->type == KeyPress)
1448 wait_for_release_event (xevent, controller);
1449 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1455 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1457 spi_device_event_controller_forward_mouse_event (controller, xevent);
1459 if (xevent->type == priv->xkb_base_event_code)
1461 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1462 /* ugly but probably necessary...*/
1463 XSynchronize (display, TRUE);
1465 if (xkb_ev->xkb_type == XkbStateNotify)
1467 XkbStateNotifyEvent *xkb_snev =
1468 (XkbStateNotifyEvent *) xkb_ev;
1469 /* check the mouse, to catch mouse events grabbed by
1470 * another client; in case we should revert this XKB delatch
1472 if (!priv->pending_xkb_mod_relatch_mask)
1476 spi_dec_mouse_check (controller, &x, &y, &moved);
1478 /* we check again, since the previous call may have
1479 changed this flag */
1480 if (priv->pending_xkb_mod_relatch_mask)
1482 unsigned int feedback_mask;
1483 #ifdef SPI_XKB_DEBUG
1484 fprintf (stderr, "relatching %x\n",
1485 priv->pending_xkb_mod_relatch_mask);
1487 /* temporarily turn off the latch bell, if it's on */
1488 XkbGetControls (display,
1489 XkbAccessXFeedbackMask,
1491 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1492 if (feedback_mask & XkbAX_StickyKeysFBMask)
1494 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1496 priv->xkb_desc->ctrls->ax_options
1497 &= ~(XkbAX_StickyKeysFBMask);
1498 XkbChangeControls (display, priv->xkb_desc, &changes);
1500 /* TODO: account for lock as well as latch */
1501 XkbLatchModifiers (display,
1503 priv->pending_xkb_mod_relatch_mask,
1504 priv->pending_xkb_mod_relatch_mask);
1505 if (feedback_mask & XkbAX_StickyKeysFBMask)
1507 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1509 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1510 XkbChangeControls (display, priv->xkb_desc, &changes);
1512 #ifdef SPI_XKB_DEBUG
1513 fprintf (stderr, "relatched %x\n",
1514 priv->pending_xkb_mod_relatch_mask);
1516 priv->pending_xkb_mod_relatch_mask = 0;
1520 priv->xkb_latch_mask = xkb_snev->latched_mods;
1523 XSynchronize (display, FALSE);
1530 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1532 if (error->error_code == BadAccess)
1534 g_message ("Could not complete key grab: grab already in use.\n");
1535 spi_error_code = BadAccess;
1540 return (*x_default_error_handler) (display, error);
1545 spi_controller_register_with_devices (SpiDEController *controller)
1547 DEControllerPrivateData *priv;
1548 int event_base, error_base, major_version, minor_version;
1550 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1551 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1553 XTestGrabControl (spi_get_display (), True);
1556 /* calls to device-specific implementations and routines go here */
1557 /* register with: keyboard hardware code handler */
1558 /* register with: (translated) keystroke handler */
1560 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1561 &priv->xkb_major_extension_opcode,
1562 &priv->xkb_base_event_code,
1563 &priv->xkb_base_error_code, NULL, NULL);
1567 guint64 reserved = 0;
1568 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1569 XkbSelectEvents (spi_get_display (),
1571 XkbStateNotifyMask, XkbStateNotifyMask);
1572 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1574 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1576 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1578 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1580 /* don't use this one if there's a grab client! */
1582 /* Runtime errors are generated from these functions,
1583 * that are then quashed. Equivalent to:
1590 spi_x_error_trap ();
1591 XGrabKey (spi_get_display (), i, 0,
1592 spi_get_root_window (),
1594 GrabModeSync, GrabModeSync);
1595 XSync (spi_get_display (), TRUE);
1596 XUngrabKey (spi_get_display (), i, 0,
1597 spi_get_root_window ());
1598 if (!spi_x_error_release ())
1608 priv->reserved_keycode = reserved;
1609 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1613 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1614 priv->reserved_keysym = XK_numbersign;
1616 #ifdef SPI_RESERVED_DEBUG
1618 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1619 fprintf (stderr, "%x\n", sym);
1620 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1622 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1627 spi_set_filter (global_filter_fn, controller);
1628 spi_set_events (KeyPressMask | KeyReleaseMask);
1630 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1634 spi_key_set_contains_key (GSList *key_set,
1635 const Accessibility_DeviceEvent *key_event)
1644 g_print ("null key set!\n");
1649 len = g_slist_length (key_set);
1651 if (len == 0) /* special case, means "all keys/any key" */
1654 g_print ("anykey\n");
1659 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1661 Accessibility_KeyDefinition *kd = l->data;
1662 #ifdef SPI_KEYEVENT_DEBUG
1663 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1667 (int) key_event->id,
1668 (int) key_event->hw_code,
1669 key_event->event_string);
1671 if (kd->keysym == (dbus_uint32_t) key_event->id)
1675 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1679 if (key_event->event_string && key_event->event_string[0] &&
1680 !strcmp (kd->keystring, key_event->event_string))
1690 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1691 const Accessibility_DeviceEvent *event)
1693 if (types == 0) /* special case, means "all events/any event" */
1698 return (types & (1 << event->type));
1702 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1703 DEControllerKeyListener *listener,
1704 dbus_bool_t is_system_global)
1706 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1707 spi_key_set_contains_key (listener->keys, key_event) &&
1708 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1709 (is_system_global == listener->mode->global))
1720 spi_controller_notify_keylisteners (SpiDEController *controller,
1721 Accessibility_DeviceEvent *key_event,
1722 dbus_bool_t is_system_global)
1725 GSList *notify = NULL, *l2;
1726 GList **key_listeners = &controller->key_listeners;
1727 gboolean is_consumed;
1734 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1735 if (key_event->modifiers & _numlock_physical_mask)
1736 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1738 for (l = *key_listeners; l; l = l->next)
1740 DEControllerKeyListener *key_listener = l->data;
1742 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1744 /* we clone (don't dup) the listener, to avoid refcount inc. */
1745 notify = g_slist_prepend (notify,
1746 spi_key_listener_clone (key_listener));
1750 #ifdef SPI_KEYEVENT_DEBUG
1753 g_print ("no match for event\n");
1757 is_consumed = FALSE;
1758 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1760 DEControllerKeyListener *key_listener = l2->data;
1762 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1763 key_listener->mode->preemptive;
1765 spi_key_listener_clone_free (key_listener);
1768 for (; l2; l2 = l2->next)
1770 DEControllerKeyListener *key_listener = l2->data;
1771 spi_key_listener_clone_free (key_listener);
1772 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1775 g_slist_free (notify);
1778 if (is_consumed) g_message ("consumed\n");
1784 spi_clear_error_state (void)
1786 gboolean retval = spi_error_code != 0;
1791 static Accessibility_DeviceEvent
1792 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1794 Accessibility_DeviceEvent key_event;
1796 const int cbuf_bytes = 20;
1800 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1801 key_event.id = (dbus_int32_t)(keysym);
1802 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1803 if (((XEvent *) x_key_event)->type == KeyPress)
1805 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1809 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1811 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1812 key_event.is_text = FALSE;
1816 key_event.event_string = g_strdup ("space");
1819 key_event.event_string = g_strdup ("Tab");
1822 key_event.event_string = g_strdup ("Backspace");
1825 key_event.event_string = g_strdup ("Return");
1828 key_event.event_string = g_strdup ("Home");
1831 key_event.event_string = g_strdup ("Page_Down");
1834 key_event.event_string = g_strdup ("Page_Up");
1837 key_event.event_string = g_strdup ("F1");
1840 key_event.event_string = g_strdup ("F2");
1843 key_event.event_string = g_strdup ("F3");
1846 key_event.event_string = g_strdup ("F4");
1849 key_event.event_string = g_strdup ("F5");
1852 key_event.event_string = g_strdup ("F6");
1855 key_event.event_string = g_strdup ("F7");
1858 key_event.event_string = g_strdup ("F8");
1861 key_event.event_string = g_strdup ("F9");
1864 key_event.event_string = g_strdup ("F10");
1867 key_event.event_string = g_strdup ("F11");
1870 key_event.event_string = g_strdup ("F12");
1873 key_event.event_string = g_strdup ("End");
1876 key_event.event_string = g_strdup ("Escape");
1879 key_event.event_string = g_strdup ("Up");
1882 key_event.event_string = g_strdup ("Down");
1885 key_event.event_string = g_strdup ("Left");
1888 key_event.event_string = g_strdup ("Right");
1894 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1895 key_event.event_string = g_strdup (cbuf);
1896 c = keysym2ucs (keysym);
1897 if (c > 0 && !g_unichar_iscntrl (c))
1899 key_event.is_text = TRUE;
1900 /* incorrect for some composed chars? */
1905 key_event.event_string = g_strdup ("");
1909 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1910 #ifdef SPI_KEYEVENT_DEBUG
1912 char *pressed_str = "pressed";
1913 char *released_str = "released";
1916 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1917 state_ptr = pressed_str;
1919 state_ptr = released_str;
1922 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1923 (unsigned long) keysym,
1925 keysym ? (int) keysym : '*',
1926 (int) x_key_event->state,
1927 key_event.event_string,
1928 key_event.event_string[0],
1929 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1933 fprintf (stderr, "%s%c\n",
1934 (x_key_event->state & Mod1Mask)?"Alt-":"",
1935 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1936 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1937 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1938 #endif /* SPI_DEBUG */
1943 spi_controller_update_key_grabs (SpiDEController *controller,
1944 Accessibility_DeviceEvent *recv)
1947 gboolean update_failed = FALSE;
1948 KeyCode keycode = 0;
1950 g_return_val_if_fail (controller != NULL, FALSE);
1953 * masks known to work with default RH 7.1+:
1954 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1955 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1956 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1957 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1959 * ControlMask grabs are broken, must be in use already
1962 keycode = keycode_for_keysym (controller, recv->id, NULL);
1963 for (l = controller->keygrabs_list; l; l = next)
1966 gboolean re_issue_grab;
1967 DEControllerGrabMask *grab_mask = l->data;
1971 re_issue_grab = recv &&
1972 (recv->modifiers & grab_mask->mod_mask) &&
1973 (grab_mask->key_val == keycode);
1976 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1977 (long int) grab_mask->key_val,
1978 (long int) grab_mask->mod_mask,
1979 grab_mask->pending_add ? '+' : '.',
1980 grab_mask->pending_remove ? '-' : '.',
1981 re_issue_grab ? "re-issue": "");
1986 if (grab_mask->pending_add && grab_mask->pending_remove)
1990 else if (grab_mask->pending_remove)
1993 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1995 XUngrabKey (spi_get_display (),
1997 grab_mask->mod_mask,
1998 spi_get_root_window ());
2002 else if (grab_mask->pending_add || re_issue_grab)
2006 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
2008 XGrabKey (spi_get_display (),
2010 grab_mask->mod_mask,
2011 spi_get_root_window (),
2015 XSync (spi_get_display (), False);
2016 update_failed = spi_clear_error_state ();
2017 if (update_failed) {
2018 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
2023 grab_mask->pending_add = FALSE;
2024 grab_mask->pending_remove = FALSE;
2028 g_assert (grab_mask->ref_count <= 0);
2030 controller->keygrabs_list = g_list_delete_link (
2031 controller->keygrabs_list, l);
2033 spi_grab_mask_free (grab_mask);
2038 return ! update_failed;
2042 * Implemented GObject::finalize
2045 spi_device_event_controller_object_finalize (GObject *object)
2047 SpiDEController *controller;
2048 DEControllerPrivateData *private;
2049 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
2050 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
2052 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
2054 /* disconnect any special listeners, get rid of outstanding keygrabs */
2055 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
2058 if (controller->xevie_display != NULL)
2060 XevieEnd(controller->xevie_display);
2061 #ifdef SPI_KEYEVENT_DEBUG
2062 printf("XevieEnd(dpy) finished \n");
2067 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
2068 if (private->xkb_desc)
2069 XkbFreeKeyboard (private->xkb_desc, 0, True);
2071 parent_class->finalize (object);
2075 * DBus Accessibility::DEController::RegisterKeystrokeListener
2076 * method implementation
2078 static DBusMessage *
2079 impl_register_keystroke_listener (DBusConnection *bus,
2080 DBusMessage *message,
2083 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2084 DEControllerKeyListener *dec_listener;
2085 DBusMessageIter iter, iter_array;
2087 GSList *keys = NULL;
2088 dbus_int32_t mask, type;
2089 Accessibility_EventListenerMode *mode;
2091 DBusMessage *reply = NULL;
2094 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu(bbb)") != 0)
2095 return invalid_arguments_error (message);
2097 dbus_message_iter_init(message, &iter);
2098 dbus_message_iter_get_basic(&iter, &path);
2099 dbus_message_iter_next(&iter);
2100 dbus_message_iter_recurse(&iter, &iter_array);
2101 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2103 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2104 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))
2108 kd->keystring = g_strdup (keystring);
2109 keys = g_slist_append(keys, kd);
2111 dbus_message_iter_next(&iter);
2112 dbus_message_iter_get_basic(&iter, &mask);
2113 dbus_message_iter_next(&iter);
2114 dbus_message_iter_get_basic(&iter, &type);
2115 dbus_message_iter_next(&iter);
2116 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
2119 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);
2122 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
2123 dbus_message_get_sender(message), path, (unsigned long) mask);
2125 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
2127 ret = spi_controller_register_device_listener (
2128 controller, (DEControllerListener *) dec_listener);
2129 reply = dbus_message_new_method_return (message);
2132 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2138 * DBus Accessibility::DEController::RegisterDeviceEventListener
2139 * method implementation
2141 static DBusMessage *
2142 impl_register_device_event_listener (DBusConnection *bus,
2143 DBusMessage *message,
2146 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2147 DEControllerListener *dec_listener;
2150 dbus_int32_t event_types;
2152 DBusMessage *reply = NULL;
2154 dbus_error_init(&error);
2155 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2157 return invalid_arguments_error (message);
2159 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2160 ret = spi_controller_register_device_listener (
2161 controller, (DEControllerListener *) dec_listener);
2162 reply = dbus_message_new_method_return (message);
2165 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2171 DBusConnection *bus;
2172 DEControllerListener *listener;
2173 } RemoveListenerClosure;
2175 static SpiReEntrantContinue
2176 remove_listener_cb (GList * const *list,
2179 DEControllerListener *listener = (*list)->data;
2180 RemoveListenerClosure *ctx = user_data;
2182 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2183 !strcmp(ctx->listener->path, listener->path))
2185 spi_re_entrant_list_delete_link (list);
2186 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2187 spi_dec_listener_free (listener);
2190 return SPI_RE_ENTRANT_CONTINUE;
2193 static SpiReEntrantContinue
2194 copy_key_listener_cb (GList * const *list,
2197 DEControllerKeyListener *key_listener = (*list)->data;
2198 RemoveListenerClosure *ctx = user_data;
2200 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2201 !strcmp(ctx->listener->path, key_listener->listener.path))
2203 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2204 DEControllerKeyListener *ctx_key_listener =
2205 (DEControllerKeyListener *) ctx->listener;
2206 keylist_free (ctx_key_listener->keys);
2207 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2210 return SPI_RE_ENTRANT_CONTINUE;
2214 spi_controller_deregister_device_listener (SpiDEController *controller,
2215 DEControllerListener *listener)
2217 RemoveListenerClosure ctx;
2219 ctx.bus = controller->bus;
2220 ctx.listener = listener;
2222 notify_mouse_listener (controller, listener, FALSE);
2224 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2225 remove_listener_cb, &ctx);
2226 if (!controller->mouse_listeners)
2227 have_mouse_listener = FALSE;
2231 spi_deregister_controller_key_listener (SpiDEController *controller,
2232 DEControllerKeyListener *key_listener)
2234 RemoveListenerClosure ctx;
2236 ctx.bus = controller->bus;
2237 ctx.listener = (DEControllerListener *) spi_key_listener_clone (key_listener);
2239 notify_keystroke_listener (controller, key_listener, FALSE);
2241 /* special case, copy keyset from existing controller list entry */
2242 if (g_slist_length(key_listener->keys) == 0)
2244 spi_re_entrant_list_foreach (&controller->key_listeners,
2245 copy_key_listener_cb, &ctx);
2248 spi_controller_deregister_global_keygrabs (controller, key_listener);
2250 spi_re_entrant_list_foreach (&controller->key_listeners,
2251 remove_listener_cb, &ctx);
2253 spi_key_listener_clone_free ((DEControllerKeyListener *) ctx.listener);
2257 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2261 for (l = controller->mouse_listeners; l; l = tmp)
2263 DEControllerListener *listener = l->data;
2265 if (!strcmp (listener->bus_name, bus_name))
2267 spi_controller_deregister_device_listener (controller, listener);
2268 tmp = controller->mouse_listeners;
2271 for (l = controller->key_listeners; l; l = tmp)
2273 DEControllerKeyListener *key_listener = l->data;
2275 if (!strcmp (key_listener->listener.bus_name, bus_name))
2277 /* TODO: untangle the below line(s) */
2278 spi_deregister_controller_key_listener (controller, key_listener);
2279 tmp = controller->key_listeners;
2285 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2286 * method implementation
2288 static DBusMessage *
2289 impl_deregister_keystroke_listener (DBusConnection *bus,
2290 DBusMessage *message,
2293 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2294 DEControllerKeyListener *key_listener;
2295 DBusMessageIter iter, iter_array;
2297 GSList *keys = NULL;
2298 dbus_int32_t mask, type;
2299 DBusMessage *reply = NULL;
2301 dbus_message_iter_init(message, &iter);
2302 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu") != 0)
2303 dbus_message_iter_get_basic(&iter, &path);
2304 dbus_message_iter_next(&iter);
2305 dbus_message_iter_recurse(&iter, &iter_array);
2306 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2308 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2311 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))
2315 kd->keystring = g_strdup (keystring);
2316 keys = g_slist_append(keys, kd);
2318 dbus_message_iter_next(&iter);
2319 dbus_message_iter_get_basic(&iter, &mask);
2320 dbus_message_iter_next(&iter);
2321 dbus_message_iter_get_basic(&iter, &type);
2322 dbus_message_iter_next(&iter);
2323 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2324 #ifdef SPI_DEREGISTER_DEBUG
2325 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2326 (void *) l, (unsigned long) mask->value);
2329 spi_deregister_controller_key_listener (controller, key_listener);
2331 spi_dec_listener_free ((DEControllerListener *) key_listener);
2332 reply = dbus_message_new_method_return (message);
2337 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2338 * method implementation
2340 static DBusMessage *
2341 impl_deregister_device_event_listener (DBusConnection *bus,
2342 DBusMessage *message,
2345 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2346 DEControllerListener *listener;
2349 dbus_int32_t event_types;
2350 DBusMessage *reply = NULL;
2352 dbus_error_init(&error);
2353 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2355 return invalid_arguments_error (message);
2357 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2358 spi_controller_deregister_device_listener (
2359 controller, listener);
2360 reply = dbus_message_new_method_return (message);
2364 static DBusMessage *
2365 impl_get_keystroke_listeners (DBusConnection *bus,
2366 DBusMessage *message,
2369 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2370 DEControllerKeyListener *dec_listener;
2371 DBusMessageIter iter, iter_array;
2372 DBusMessage *reply = dbus_message_new_method_return (message);
2378 dbus_message_iter_init_append (reply, &iter);
2379 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2380 "(souua(iisi)u(bbb))", &iter_array);
2381 for (l = controller->key_listeners; l; l = l->next)
2383 append_keystroke_listener (&iter_array, l->data);
2385 dbus_message_iter_close_container (&iter, &iter_array);
2389 static DBusMessage *
2390 impl_get_device_event_listeners (DBusConnection *bus,
2391 DBusMessage *message,
2394 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2395 DEControllerKeyListener *dec_listener;
2396 DBusMessageIter iter, iter_array;
2398 DBusMessage *reply = dbus_message_new_method_return (message);
2403 dbus_message_iter_init_append (reply, &iter);
2404 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2405 "(sou)", &iter_array);
2406 for (l = controller->key_listeners; l; l = l->next)
2408 append_mouse_listener (&iter_array, l->data);
2410 dbus_message_iter_close_container (&iter, &iter_array);
2414 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2416 unsigned int retval = 0;
2417 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2418 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2420 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2421 retval = XkbGetSlowKeysDelay (spi_get_display (),
2422 XkbUseCoreKbd, &bounce_delay);
2424 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2426 Status s = XkbGetControls (spi_get_display (),
2427 XkbAllControlsMask, priv->xkb_desc);
2430 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2431 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2436 #ifdef SPI_XKB_DEBUG
2437 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2442 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2444 unsigned int retval = 0;
2445 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2446 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2448 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2449 retval = XkbGetBounceKeysDelay (spi_get_display (),
2450 XkbUseCoreKbd, &bounce_delay);
2452 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2454 Status s = XkbGetControls (spi_get_display (),
2455 XkbAllControlsMask, priv->xkb_desc);
2458 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2459 retval = priv->xkb_desc->ctrls->debounce_delay;
2464 #ifdef SPI_XKB_DEBUG
2465 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2471 dec_synth_keycode_press (SpiDEController *controller,
2472 unsigned int keycode)
2474 unsigned int time = CurrentTime;
2475 unsigned int bounce_delay;
2476 unsigned int elapsed_msec;
2478 DEControllerPrivateData *priv =
2479 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2480 spi_dec_private_quark);
2481 if (keycode == priv->last_release_keycode)
2483 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2486 gettimeofday (&tv, NULL);
2488 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2489 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2490 #ifdef SPI_XKB_DEBUG
2491 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2492 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2494 #ifdef THIS_IS_BROKEN
2495 if (elapsed_msec < bounce_delay)
2496 time = bounce_delay - elapsed_msec + 1;
2498 time = bounce_delay + 10;
2499 /* fudge for broken XTest */
2501 #ifdef SPI_XKB_DEBUG
2502 fprintf (stderr, "waiting %d ms\n", time);
2506 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2507 priv->last_press_keycode = keycode;
2508 XFlush (spi_get_display ());
2509 XSync (spi_get_display (), False);
2510 gettimeofday (&priv->last_press_time, NULL);
2515 dec_synth_keycode_release (SpiDEController *controller,
2516 unsigned int keycode)
2518 unsigned int time = CurrentTime;
2519 unsigned int slow_delay;
2520 unsigned int elapsed_msec;
2522 DEControllerPrivateData *priv =
2523 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2524 spi_dec_private_quark);
2525 if (keycode == priv->last_press_keycode)
2527 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2530 gettimeofday (&tv, NULL);
2532 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2533 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2534 #ifdef SPI_XKB_DEBUG
2535 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2536 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2538 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2539 if (elapsed_msec < slow_delay)
2540 time = slow_delay - elapsed_msec + 1;
2542 time = slow_delay + 10;
2543 /* our XTest seems broken, we have to add slop as above */
2545 #ifdef SPI_XKB_DEBUG
2546 fprintf (stderr, "waiting %d ms\n", time);
2550 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2551 priv->last_release_keycode = keycode;
2552 XSync (spi_get_display (), False);
2553 gettimeofday (&priv->last_release_time, NULL);
2558 dec_get_modifier_state (SpiDEController *controller)
2560 return mouse_mask_state;
2564 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2566 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2567 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2569 if (priv->have_xkb) {
2570 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2571 modifiers, modifiers);
2574 for (mod_index=0;mod_index<8;mod_index++)
2575 if (modifiers & (1<<mod_index))
2576 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2582 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2584 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2585 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2587 if (priv->have_xkb) {
2588 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2592 for (mod_index=0;mod_index<8;mod_index++)
2593 if (modifiers & (1<<mod_index))
2594 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2600 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2602 return ucs2keysym ((long) unichar);
2606 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2608 KeyCode key_synth_code;
2609 unsigned int modifiers, synth_mods, lock_mods;
2611 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2613 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2615 /* TODO: set the modifiers accordingly! */
2616 modifiers = dec_get_modifier_state (controller);
2617 /* side-effect; we may unset mousebutton modifiers here! */
2620 if (synth_mods != modifiers) {
2621 lock_mods = synth_mods & ~modifiers;
2622 dec_lock_modifiers (controller, lock_mods);
2624 dec_synth_keycode_press (controller, key_synth_code);
2625 dec_synth_keycode_release (controller, key_synth_code);
2627 if (synth_mods != modifiers)
2628 dec_unlock_modifiers (controller, lock_mods);
2634 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2636 /* probably we need to create and inject an XIM handler eventually. */
2637 /* for now, try to match the string to existing
2638 * keycode+modifier states.
2642 gunichar unichar = 0;
2644 gboolean retval = TRUE;
2647 maxlen = strlen (keystring) + 1;
2648 keysyms = g_new0 (KeySym, maxlen);
2649 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2654 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2656 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2661 mbytes = g_unichar_to_utf8 (unichar, bytes);
2662 bytes[mbytes] = '\0';
2664 fprintf (stderr, "[unichar %s]", bytes);
2666 keysym = dec_keysym_for_unichar (controller, unichar);
2667 if (keysym == NoSymbol) {
2669 fprintf (stderr, "no keysym for %s", bytes);
2674 keysyms[i++] = keysym;
2675 keystring = g_utf8_next_char (keystring);
2678 XSynchronize (spi_get_display (), TRUE);
2679 for (i = 0; keysyms[i]; ++i) {
2680 if (!dec_synth_keysym (controller, keysyms[i])) {
2682 fprintf (stderr, "could not synthesize %c\n",
2689 XSynchronize (spi_get_display (), FALSE);
2698 * DBus Accessibility::DEController::RegisterKeystrokeListener
2699 * method implementation
2701 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2703 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2705 dbus_int32_t keycode;
2707 dbus_uint32_t synth_type;
2710 DEControllerPrivateData *priv;
2711 DBusMessage *reply = NULL;
2713 dbus_error_init(&error);
2714 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2716 return invalid_arguments_error (message);
2720 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2721 (long) keycode, (int) synth_type);
2723 /* TODO: hide/wrap/remove X dependency */
2726 * TODO: when initializing, query for XTest extension before using,
2727 * and fall back to XSendEvent() if XTest is not available.
2730 spi_x_error_trap ();
2732 priv = (DEControllerPrivateData *)
2733 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2735 if (!priv->have_xkb && xmkeymap==NULL) {
2736 xmkeymap = XGetModifierMapping(spi_get_display ());
2741 case Accessibility_KEY_PRESS:
2742 dec_synth_keycode_press (controller, keycode);
2744 case Accessibility_KEY_PRESSRELEASE:
2745 dec_synth_keycode_press (controller, keycode);
2746 case Accessibility_KEY_RELEASE:
2747 dec_synth_keycode_release (controller, keycode);
2749 case Accessibility_KEY_SYM:
2750 #ifdef SPI_XKB_DEBUG
2751 fprintf (stderr, "KeySym synthesis\n");
2754 * note: we are using long for 'keycode'
2755 * in our arg list; it can contain either
2756 * a keycode or a keysym.
2758 dec_synth_keysym (controller, (KeySym) keycode);
2760 case Accessibility_KEY_STRING:
2761 if (!dec_synth_keystring (controller, keystring))
2762 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2766 if (synth_type == Accessibility_KEY_SYM) {
2770 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2772 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2774 spi_dec_clear_unlatch_pending (controller);
2776 reply = dbus_message_new_method_return (message);
2780 /* Accessibility::DEController::GenerateMouseEvent */
2781 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2787 DBusMessage *reply = NULL;
2789 gboolean err = FALSE;
2790 Display *display = spi_get_display ();
2792 dbus_error_init (&error);
2793 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2795 return invalid_arguments_error (message);
2799 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2800 eventName, (long int) x, (long int) y);
2802 switch (eventName[0])
2805 switch (eventName[1])
2807 /* TODO: check number of buttons before parsing */
2828 if (x != -1 && y != -1)
2830 XTestFakeMotionEvent (display, DefaultScreen (display),
2833 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2834 if (eventName[2] == 'c')
2835 XTestFakeButtonEvent (display, button, FALSE, 1);
2836 else if (eventName[2] == 'd')
2838 XTestFakeButtonEvent (display, button, FALSE, 1);
2839 XTestFakeButtonEvent (display, button, TRUE, 2);
2840 XTestFakeButtonEvent (display, button, FALSE, 3);
2844 case 'r': /* relative motion */
2845 XTestFakeRelativeMotionEvent (display, x, y, 0);
2847 case 'a': /* absolute motion */
2848 XTestFakeMotionEvent (display, DefaultScreen (display),
2852 reply = dbus_message_new_method_return (message);
2856 /* Accessibility::DEController::NotifyListenersSync */
2857 static DBusMessage *
2858 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2860 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2861 Accessibility_DeviceEvent event;
2863 DBusMessage *reply = NULL;
2865 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2867 return invalid_arguments_error (message);
2870 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2871 controller, (int) event.id);
2873 ret = spi_controller_notify_keylisteners (controller,
2874 (Accessibility_DeviceEvent *)
2877 reply = dbus_message_new_method_return (message);
2880 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2885 static DBusMessage *
2886 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2888 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2889 Accessibility_DeviceEvent event;
2890 DBusMessage *reply = NULL;
2892 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2894 return invalid_arguments_error (message);
2897 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2898 controller, (int) event.id);
2900 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2902 reply = dbus_message_new_method_return (message);
2907 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2909 GObjectClass * object_class = (GObjectClass *) klass;
2911 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2913 object_class->finalize = spi_device_event_controller_object_finalize;
2915 if (!spi_dec_private_quark)
2916 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2920 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2926 handle_io (GIOChannel *source,
2927 GIOCondition condition,
2930 SpiDEController *controller = (SpiDEController *) data;
2931 gboolean is_consumed = FALSE;
2934 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2936 if (ev.type == KeyPress || ev.type == KeyRelease)
2937 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2940 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2945 #endif /* HAVE_XEVIE */
2948 spi_device_event_controller_init (SpiDEController *device_event_controller)
2950 spi_events_init (spi_get_display());
2954 #endif /* HAVE_XEVIE */
2956 DEControllerPrivateData *private;
2957 device_event_controller->key_listeners = NULL;
2958 device_event_controller->mouse_listeners = NULL;
2959 device_event_controller->keygrabs_list = NULL;
2960 device_event_controller->xevie_display = NULL;
2963 device_event_controller->xevie_display = XOpenDisplay(NULL);
2965 if (XevieStart(device_event_controller->xevie_display) == TRUE)
2967 #ifdef SPI_KEYEVENT_DEBUG
2968 fprintf (stderr, "XevieStart() success \n");
2970 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2972 fd = ConnectionNumber(device_event_controller->xevie_display);
2973 ioc = g_io_channel_unix_new (fd);
2974 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2975 g_io_channel_unref (ioc);
2979 device_event_controller->xevie_display = NULL;
2980 #ifdef SPI_KEYEVENT_DEBUG
2981 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2984 #endif /* HAVE_XEVIE */
2986 private = g_new0 (DEControllerPrivateData, 1);
2987 gettimeofday (&private->last_press_time, NULL);
2988 gettimeofday (&private->last_release_time, NULL);
2989 g_object_set_qdata (G_OBJECT (device_event_controller),
2990 spi_dec_private_quark,
2992 spi_controller_register_with_devices (device_event_controller);
2993 device_event_controller->message_queue = g_queue_new ();
2994 saved_controller = device_event_controller;
2998 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2999 const XEvent *event)
3001 Accessibility_DeviceEvent key_event;
3004 g_assert (event->type == KeyPress || event->type == KeyRelease);
3006 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3008 if (controller->xevie_display == NULL)
3009 spi_controller_update_key_grabs (controller, &key_event);
3011 /* relay to listeners, and decide whether to consume it or not */
3012 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
3013 g_free(key_event.event_string);
3019 is_key_released (KeyCode code)
3024 XQueryKeymap (spi_get_display (), keys);
3025 down = BIT (keys, code);
3030 check_release (gpointer data)
3033 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
3034 KeyCode code = event->hw_code;
3036 released = is_key_released (code);
3040 check_release_handler = 0;
3041 event->type = Accessibility_KEY_RELEASED_EVENT;
3042 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
3044 return (released == 0);
3047 static void wait_for_release_event (XEvent *event,
3048 SpiDEController *controller)
3050 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3051 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
3054 /*---------------------------------------------------------------------------*/
3056 static const char *introspection_header =
3057 "<?xml version=\"1.0\"?>\n";
3059 static const char *introspection_node_element =
3060 "<node name=\"%s\">\n";
3062 static const char *introspection_footer =
3065 static DBusMessage *
3066 impl_Introspect (DBusConnection * bus,
3067 DBusMessage * message, void *user_data)
3073 const gchar *pathstr = SPI_DBUS_PATH_DEC;
3077 output = g_string_new(introspection_header);
3079 g_string_append_printf(output, introspection_node_element, pathstr);
3081 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
3083 g_string_append(output, introspection_footer);
3084 final = g_string_free(output, FALSE);
3086 reply = dbus_message_new_method_return (message);
3087 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
3093 /*---------------------------------------------------------------------------*/
3096 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
3098 const gchar *iface = dbus_message_get_interface (message);
3099 const gchar *member = dbus_message_get_member (message);
3100 const gint type = dbus_message_get_type (message);
3101 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3102 DBusMessage *reply = NULL;
3104 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
3106 result = DBUS_HANDLER_RESULT_HANDLED;
3107 if (!strcmp (member, "RegisterKeystrokeListener"))
3108 reply = impl_register_keystroke_listener (bus, message, user_data);
3109 else if (!strcmp (member, "RegisterDeviceEventListener"))
3110 reply = impl_register_device_event_listener (bus, message, user_data);
3111 else if (!strcmp (member, "DeregisterKeystrokeListener"))
3112 reply = impl_deregister_keystroke_listener (bus, message, user_data);
3113 else if (!strcmp (member, "DeregisterDeviceEventListener"))
3114 reply = impl_deregister_device_event_listener (bus, message, user_data);
3115 else if (!strcmp (member, "GetKeystrokeListeners"))
3116 reply = impl_get_keystroke_listeners (bus, message, user_data);
3117 else if (!strcmp (member, "GetDeviceEventListeners"))
3118 reply = impl_get_device_event_listeners (bus, message, user_data);
3119 else if (!strcmp (member, "GenerateKeyboardEvent"))
3120 reply = impl_generate_keyboard_event (bus, message, user_data);
3121 else if (!strcmp (member, "GenerateMouseEvent"))
3122 reply = impl_generate_mouse_event (bus, message, user_data);
3123 else if (!strcmp (member, "NotifyListenersSync"))
3124 reply = impl_notify_listeners_sync (bus, message, user_data);
3125 else if (!strcmp (member, "NotifyListenersAsync"))
3126 reply = impl_notify_listeners_async (bus, message, user_data);
3128 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3131 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
3133 result = DBUS_HANDLER_RESULT_HANDLED;
3134 if (!strcmp (member, "Introspect"))
3135 reply = impl_Introspect (bus, message, user_data);
3137 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3140 if (result == DBUS_HANDLER_RESULT_HANDLED)
3144 reply = dbus_message_new_method_return (message);
3147 dbus_connection_send (bus, reply, NULL);
3148 dbus_message_unref (reply);
3153 message_queue_dispatch (gpointer data)
3155 saved_controller->message_queue_idle = 0;
3156 while (!g_queue_is_empty (saved_controller->message_queue))
3158 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
3159 data = g_queue_pop_head (saved_controller->message_queue);
3160 handle_dec_method_from_idle (saved_controller->bus, message, data);
3161 dbus_message_unref (message);
3166 static DBusHandlerResult
3167 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
3169 const gchar *iface = dbus_message_get_interface (message);
3170 const gchar *member = dbus_message_get_member (message);
3171 const gint type = dbus_message_get_type (message);
3173 /* Check for basic reasons not to handle */
3174 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3177 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3179 dbus_message_ref (message);
3180 g_queue_push_tail (saved_controller->message_queue, message);
3181 g_queue_push_tail (saved_controller->message_queue, user_data);
3182 if (!saved_controller->message_queue_idle)
3183 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
3184 return DBUS_HANDLER_RESULT_HANDLED;
3187 static DBusObjectPathVTable dec_vtable =
3191 NULL, NULL, NULL, NULL
3195 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
3197 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
3199 dec->registry = g_object_ref (reg);
3200 reg->dec = g_object_ref (dec);
3203 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
3205 spi_dec_init_mouse_listener (dec);
3211 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
3213 if (!have_mouse_event_listener)
3215 have_mouse_event_listener = TRUE;
3216 if (!have_mouse_listener)
3217 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
3222 spi_device_event_controller_stop_poll_mouse (void)
3224 have_mouse_event_listener = FALSE;