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;
1182 reset_hung_process_from_ping (DBusPendingCall *pending, void *data)
1184 gchar *bus_name = data;
1187 for (l = hung_processes; l; l = l->next)
1189 if (!strcmp (l->data, data))
1192 hung_processes = g_slist_remove (hung_processes, data);
1197 dbus_pending_call_unref (pending);
1200 static DBusMessage *
1201 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1203 DBusPendingCall *pending;
1204 DBusMessage *reply = NULL;
1207 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1211 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1212 gettimeofday (&tv, NULL);
1215 if (!dbus_connection_read_write_dispatch (bus, timeout) ||
1216 time_elapsed (&tv) > timeout)
1218 const char *dest = dbus_message_get_destination (message);
1220 gchar *bus_name_dup;
1221 dbus_message_ref (message);
1222 dbus_pending_call_set_notify (pending, reset_hung_process, message,
1223 (DBusFreeFunction) dbus_message_unref);
1224 message = dbus_message_new_method_call (dest, "/",
1225 "org.freedesktop.DBus.Peer",
1229 dbus_connection_send_with_reply (bus, message, &pending, -1);
1230 dbus_message_unref (message);
1233 bus_name_dup = g_strdup (dest);
1234 dbus_pending_call_set_notify (pending, reset_hung_process_from_ping,
1235 bus_name_dup, NULL);
1236 for (l = hung_processes; l; l = l->next)
1237 if (!strcmp (l->data, dest))
1239 hung_processes = g_slist_prepend (hung_processes, g_strdup (dest));
1243 dbus_pending_call_unref (pending);
1247 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1248 SpiRegistry *registry,
1249 DEControllerListener *listener,
1250 const Accessibility_DeviceEvent *key_event)
1252 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1254 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1257 dbus_bool_t consumed = FALSE;
1259 gboolean hung = FALSE;
1261 for (l = hung_processes; l; l = l->next)
1263 if (!strcmp (l->data, listener->bus_name))
1265 dbus_message_set_no_reply (message, TRUE);
1271 dbus_error_init(&error);
1272 if (spi_dbus_marshal_deviceEvent(message, key_event))
1276 dbus_connection_send (controller->bus, message, NULL);
1277 dbus_message_unref (message);
1280 DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 3000, &error);
1284 dbus_error_init(&error);
1285 dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1286 dbus_message_unref(reply);
1289 dbus_message_unref(message);
1294 spi_controller_notify_mouselisteners (SpiDEController *controller,
1295 const Accessibility_DeviceEvent *event)
1298 GSList *notify = NULL, *l2;
1299 GList **listeners = &controller->mouse_listeners;
1300 gboolean is_consumed;
1301 #ifdef SPI_KEYEVENT_DEBUG
1302 gboolean found = FALSE;
1309 for (l = *listeners; l; l = l->next)
1311 DEControllerListener *listener = l->data;
1313 if (spi_eventtype_seq_contains_event (listener->types, event))
1315 /* we clone (don't dup) the listener, to avoid refcount inc. */
1316 notify = g_slist_prepend (notify,
1317 spi_listener_clone (listener));
1318 #ifdef SPI_KEYEVENT_DEBUG
1324 #ifdef SPI_KEYEVENT_DEBUG
1327 g_print ("no match for event\n");
1331 is_consumed = FALSE;
1332 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1334 DEControllerListener *listener = l2->data;
1336 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1338 spi_listener_clone_free ((DEControllerListener *) l2->data);
1341 for (; l2; l2 = l2->next)
1343 DEControllerListener *listener = l2->data;
1344 spi_listener_clone_free (listener);
1345 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1348 g_slist_free (notify);
1351 if (is_consumed) g_message ("consumed\n");
1357 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1360 Accessibility_DeviceEvent mouse_e;
1361 gchar event_detail[3];
1362 gboolean is_consumed = FALSE;
1363 gboolean xkb_mod_unlatch_occurred;
1364 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1365 dbus_uint32_t ix, iy;
1367 int button = xbutton_event->button;
1369 unsigned int mouse_button_state = xbutton_event->state;
1374 mouse_button_state |= Button1Mask;
1377 mouse_button_state |= Button2Mask;
1380 mouse_button_state |= Button3Mask;
1383 mouse_button_state |= Button4Mask;
1386 mouse_button_state |= Button5Mask;
1390 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1391 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1394 fprintf (stderr, "mouse button %d %s (%x)\n",
1395 xbutton_event->button,
1396 (xevent->type == ButtonPress) ? "Press" : "Release",
1397 mouse_button_state);
1399 snprintf (event_detail, 3, "%d%c", button,
1400 (xevent->type == ButtonPress) ? 'p' : 'r');
1402 /* TODO: FIXME distinguish between physical and logical buttons */
1403 mouse_e.type = (xevent->type == ButtonPress) ?
1404 Accessibility_BUTTON_PRESSED_EVENT :
1405 Accessibility_BUTTON_RELEASED_EVENT;
1406 mouse_e.id = button;
1407 mouse_e.hw_code = button;
1408 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1409 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1410 mouse_e.event_string = "";
1411 mouse_e.is_text = FALSE;
1412 if ((mouse_button_state & mouse_button_mask) !=
1413 (mouse_mask_state & mouse_button_mask))
1415 if ((mouse_mask_state & key_modifier_mask) !=
1416 (mouse_button_state & key_modifier_mask))
1417 spi_dec_emit_modifier_event (controller,
1418 mouse_mask_state, mouse_button_state);
1419 mouse_mask_state = mouse_button_state;
1421 spi_controller_notify_mouselisteners (controller, &mouse_e);
1422 ix = last_mouse_pos->x;
1423 iy = last_mouse_pos->y;
1424 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1427 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1428 xevent->type == ButtonRelease);
1430 /* if client wants to consume this event, and XKB latch state was
1431 * unset by this button event, we reset it
1433 if (is_consumed && xkb_mod_unlatch_occurred)
1434 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1436 XAllowEvents (spi_get_display (),
1437 (is_consumed) ? SyncPointer : ReplayPointer,
1442 global_filter_fn (XEvent *xevent, void *data)
1444 SpiDEController *controller;
1445 DEControllerPrivateData *priv;
1446 Display *display = spi_get_display ();
1447 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1448 priv = (DEControllerPrivateData *)
1449 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1451 if (xevent->type == MappingNotify)
1454 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1456 if (controller->xevie_display == NULL)
1458 gboolean is_consumed;
1461 spi_device_event_controller_forward_key_event (controller, xevent);
1468 n_events = XPending (display);
1470 #ifdef SPI_KEYEVENT_DEBUG
1471 g_print ("Number of events pending: %d\n", n_events);
1473 for (i = 0; i < n_events; i++)
1475 XNextEvent (display, &next_event);
1476 if (next_event.type != KeyPress &&
1477 next_event.type != KeyRelease)
1478 g_warning ("Unexpected event type %d in queue", next_event.type);
1481 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1483 XUngrabKeyboard (display, CurrentTime);
1487 if (xevent->type == KeyPress)
1488 wait_for_release_event (xevent, controller);
1489 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1495 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1497 spi_device_event_controller_forward_mouse_event (controller, xevent);
1499 if (xevent->type == priv->xkb_base_event_code)
1501 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1502 /* ugly but probably necessary...*/
1503 XSynchronize (display, TRUE);
1505 if (xkb_ev->xkb_type == XkbStateNotify)
1507 XkbStateNotifyEvent *xkb_snev =
1508 (XkbStateNotifyEvent *) xkb_ev;
1509 /* check the mouse, to catch mouse events grabbed by
1510 * another client; in case we should revert this XKB delatch
1512 if (!priv->pending_xkb_mod_relatch_mask)
1516 spi_dec_mouse_check (controller, &x, &y, &moved);
1518 /* we check again, since the previous call may have
1519 changed this flag */
1520 if (priv->pending_xkb_mod_relatch_mask)
1522 unsigned int feedback_mask;
1523 #ifdef SPI_XKB_DEBUG
1524 fprintf (stderr, "relatching %x\n",
1525 priv->pending_xkb_mod_relatch_mask);
1527 /* temporarily turn off the latch bell, if it's on */
1528 XkbGetControls (display,
1529 XkbAccessXFeedbackMask,
1531 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1532 if (feedback_mask & XkbAX_StickyKeysFBMask)
1534 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1536 priv->xkb_desc->ctrls->ax_options
1537 &= ~(XkbAX_StickyKeysFBMask);
1538 XkbChangeControls (display, priv->xkb_desc, &changes);
1540 /* TODO: account for lock as well as latch */
1541 XkbLatchModifiers (display,
1543 priv->pending_xkb_mod_relatch_mask,
1544 priv->pending_xkb_mod_relatch_mask);
1545 if (feedback_mask & XkbAX_StickyKeysFBMask)
1547 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1549 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1550 XkbChangeControls (display, priv->xkb_desc, &changes);
1552 #ifdef SPI_XKB_DEBUG
1553 fprintf (stderr, "relatched %x\n",
1554 priv->pending_xkb_mod_relatch_mask);
1556 priv->pending_xkb_mod_relatch_mask = 0;
1560 priv->xkb_latch_mask = xkb_snev->latched_mods;
1563 XSynchronize (display, FALSE);
1570 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1572 if (error->error_code == BadAccess)
1574 g_message ("Could not complete key grab: grab already in use.\n");
1575 spi_error_code = BadAccess;
1580 return (*x_default_error_handler) (display, error);
1585 spi_controller_register_with_devices (SpiDEController *controller)
1587 DEControllerPrivateData *priv;
1588 int event_base, error_base, major_version, minor_version;
1590 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1591 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1593 XTestGrabControl (spi_get_display (), True);
1596 /* calls to device-specific implementations and routines go here */
1597 /* register with: keyboard hardware code handler */
1598 /* register with: (translated) keystroke handler */
1600 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1601 &priv->xkb_major_extension_opcode,
1602 &priv->xkb_base_event_code,
1603 &priv->xkb_base_error_code, NULL, NULL);
1607 guint64 reserved = 0;
1608 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1609 XkbSelectEvents (spi_get_display (),
1611 XkbStateNotifyMask, XkbStateNotifyMask);
1612 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1614 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1616 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1618 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1620 /* don't use this one if there's a grab client! */
1622 /* Runtime errors are generated from these functions,
1623 * that are then quashed. Equivalent to:
1630 spi_x_error_trap ();
1631 XGrabKey (spi_get_display (), i, 0,
1632 spi_get_root_window (),
1634 GrabModeSync, GrabModeSync);
1635 XSync (spi_get_display (), TRUE);
1636 XUngrabKey (spi_get_display (), i, 0,
1637 spi_get_root_window ());
1638 if (!spi_x_error_release ())
1648 priv->reserved_keycode = reserved;
1649 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1653 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1654 priv->reserved_keysym = XK_numbersign;
1656 #ifdef SPI_RESERVED_DEBUG
1658 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1659 fprintf (stderr, "%x\n", sym);
1660 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1662 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1667 spi_set_filter (global_filter_fn, controller);
1668 spi_set_events (KeyPressMask | KeyReleaseMask);
1670 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1674 spi_key_set_contains_key (GSList *key_set,
1675 const Accessibility_DeviceEvent *key_event)
1684 g_print ("null key set!\n");
1689 len = g_slist_length (key_set);
1691 if (len == 0) /* special case, means "all keys/any key" */
1694 g_print ("anykey\n");
1699 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1701 Accessibility_KeyDefinition *kd = l->data;
1702 #ifdef SPI_KEYEVENT_DEBUG
1703 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1707 (int) key_event->id,
1708 (int) key_event->hw_code,
1709 key_event->event_string);
1711 if (kd->keysym == (dbus_uint32_t) key_event->id)
1715 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1719 if (key_event->event_string && key_event->event_string[0] &&
1720 !strcmp (kd->keystring, key_event->event_string))
1730 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1731 const Accessibility_DeviceEvent *event)
1733 if (types == 0) /* special case, means "all events/any event" */
1738 return (types & (1 << event->type));
1742 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1743 DEControllerKeyListener *listener,
1744 dbus_bool_t is_system_global)
1746 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1747 spi_key_set_contains_key (listener->keys, key_event) &&
1748 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1749 (is_system_global == listener->mode->global))
1760 spi_controller_notify_keylisteners (SpiDEController *controller,
1761 Accessibility_DeviceEvent *key_event,
1762 dbus_bool_t is_system_global)
1765 GSList *notify = NULL, *l2;
1766 GList **key_listeners = &controller->key_listeners;
1767 gboolean is_consumed;
1774 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1775 if (key_event->modifiers & _numlock_physical_mask)
1776 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1778 for (l = *key_listeners; l; l = l->next)
1780 DEControllerKeyListener *key_listener = l->data;
1782 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1784 /* we clone (don't dup) the listener, to avoid refcount inc. */
1785 notify = g_slist_prepend (notify,
1786 spi_key_listener_clone (key_listener));
1790 #ifdef SPI_KEYEVENT_DEBUG
1793 g_print ("no match for event\n");
1797 is_consumed = FALSE;
1798 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1800 DEControllerKeyListener *key_listener = l2->data;
1802 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1803 key_listener->mode->preemptive;
1805 spi_key_listener_clone_free (key_listener);
1808 for (; l2; l2 = l2->next)
1810 DEControllerKeyListener *key_listener = l2->data;
1811 spi_key_listener_clone_free (key_listener);
1812 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1815 g_slist_free (notify);
1818 if (is_consumed) g_message ("consumed\n");
1824 spi_clear_error_state (void)
1826 gboolean retval = spi_error_code != 0;
1831 static Accessibility_DeviceEvent
1832 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1834 Accessibility_DeviceEvent key_event;
1836 const int cbuf_bytes = 20;
1840 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1841 key_event.id = (dbus_int32_t)(keysym);
1842 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1843 if (((XEvent *) x_key_event)->type == KeyPress)
1845 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1849 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1851 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1852 key_event.is_text = FALSE;
1856 key_event.event_string = g_strdup ("space");
1859 key_event.event_string = g_strdup ("Tab");
1862 key_event.event_string = g_strdup ("Backspace");
1865 key_event.event_string = g_strdup ("Return");
1868 key_event.event_string = g_strdup ("Home");
1871 key_event.event_string = g_strdup ("Page_Down");
1874 key_event.event_string = g_strdup ("Page_Up");
1877 key_event.event_string = g_strdup ("F1");
1880 key_event.event_string = g_strdup ("F2");
1883 key_event.event_string = g_strdup ("F3");
1886 key_event.event_string = g_strdup ("F4");
1889 key_event.event_string = g_strdup ("F5");
1892 key_event.event_string = g_strdup ("F6");
1895 key_event.event_string = g_strdup ("F7");
1898 key_event.event_string = g_strdup ("F8");
1901 key_event.event_string = g_strdup ("F9");
1904 key_event.event_string = g_strdup ("F10");
1907 key_event.event_string = g_strdup ("F11");
1910 key_event.event_string = g_strdup ("F12");
1913 key_event.event_string = g_strdup ("End");
1916 key_event.event_string = g_strdup ("Escape");
1919 key_event.event_string = g_strdup ("Up");
1922 key_event.event_string = g_strdup ("Down");
1925 key_event.event_string = g_strdup ("Left");
1928 key_event.event_string = g_strdup ("Right");
1934 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1935 key_event.event_string = g_strdup (cbuf);
1936 c = keysym2ucs (keysym);
1937 if (c > 0 && !g_unichar_iscntrl (c))
1939 key_event.is_text = TRUE;
1940 /* incorrect for some composed chars? */
1945 key_event.event_string = g_strdup ("");
1949 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1950 #ifdef SPI_KEYEVENT_DEBUG
1952 char *pressed_str = "pressed";
1953 char *released_str = "released";
1956 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1957 state_ptr = pressed_str;
1959 state_ptr = released_str;
1962 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1963 (unsigned long) keysym,
1965 keysym ? (int) keysym : '*',
1966 (int) x_key_event->state,
1967 key_event.event_string,
1968 key_event.event_string[0],
1969 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1973 fprintf (stderr, "%s%c\n",
1974 (x_key_event->state & Mod1Mask)?"Alt-":"",
1975 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1976 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1977 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1978 #endif /* SPI_DEBUG */
1983 spi_controller_update_key_grabs (SpiDEController *controller,
1984 Accessibility_DeviceEvent *recv)
1987 gboolean update_failed = FALSE;
1988 KeyCode keycode = 0;
1990 g_return_val_if_fail (controller != NULL, FALSE);
1993 * masks known to work with default RH 7.1+:
1994 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1995 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1996 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1997 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1999 * ControlMask grabs are broken, must be in use already
2002 keycode = keycode_for_keysym (controller, recv->id, NULL);
2003 for (l = controller->keygrabs_list; l; l = next)
2006 gboolean re_issue_grab;
2007 DEControllerGrabMask *grab_mask = l->data;
2011 re_issue_grab = recv &&
2012 (recv->modifiers & grab_mask->mod_mask) &&
2013 (grab_mask->key_val == keycode);
2016 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
2017 (long int) grab_mask->key_val,
2018 (long int) grab_mask->mod_mask,
2019 grab_mask->pending_add ? '+' : '.',
2020 grab_mask->pending_remove ? '-' : '.',
2021 re_issue_grab ? "re-issue": "");
2026 if (grab_mask->pending_add && grab_mask->pending_remove)
2030 else if (grab_mask->pending_remove)
2033 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
2035 XUngrabKey (spi_get_display (),
2037 grab_mask->mod_mask,
2038 spi_get_root_window ());
2042 else if (grab_mask->pending_add || re_issue_grab)
2046 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
2048 XGrabKey (spi_get_display (),
2050 grab_mask->mod_mask,
2051 spi_get_root_window (),
2055 XSync (spi_get_display (), False);
2056 update_failed = spi_clear_error_state ();
2057 if (update_failed) {
2058 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
2063 grab_mask->pending_add = FALSE;
2064 grab_mask->pending_remove = FALSE;
2068 g_assert (grab_mask->ref_count <= 0);
2070 controller->keygrabs_list = g_list_delete_link (
2071 controller->keygrabs_list, l);
2073 spi_grab_mask_free (grab_mask);
2078 return ! update_failed;
2082 * Implemented GObject::finalize
2085 spi_device_event_controller_object_finalize (GObject *object)
2087 SpiDEController *controller;
2088 DEControllerPrivateData *private;
2089 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
2090 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
2092 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
2094 /* disconnect any special listeners, get rid of outstanding keygrabs */
2095 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
2098 if (controller->xevie_display != NULL)
2100 XevieEnd(controller->xevie_display);
2101 #ifdef SPI_KEYEVENT_DEBUG
2102 printf("XevieEnd(dpy) finished \n");
2107 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
2108 if (private->xkb_desc)
2109 XkbFreeKeyboard (private->xkb_desc, 0, True);
2111 parent_class->finalize (object);
2115 * DBus Accessibility::DEController::RegisterKeystrokeListener
2116 * method implementation
2118 static DBusMessage *
2119 impl_register_keystroke_listener (DBusConnection *bus,
2120 DBusMessage *message,
2123 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2124 DEControllerKeyListener *dec_listener;
2125 DBusMessageIter iter, iter_array;
2127 GSList *keys = NULL;
2128 dbus_int32_t mask, type;
2129 Accessibility_EventListenerMode *mode;
2131 DBusMessage *reply = NULL;
2134 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu(bbb)") != 0)
2135 return invalid_arguments_error (message);
2137 dbus_message_iter_init(message, &iter);
2138 dbus_message_iter_get_basic(&iter, &path);
2139 dbus_message_iter_next(&iter);
2140 dbus_message_iter_recurse(&iter, &iter_array);
2141 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2143 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2144 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))
2148 kd->keystring = g_strdup (keystring);
2149 keys = g_slist_append(keys, kd);
2151 dbus_message_iter_next(&iter);
2152 dbus_message_iter_get_basic(&iter, &mask);
2153 dbus_message_iter_next(&iter);
2154 dbus_message_iter_get_basic(&iter, &type);
2155 dbus_message_iter_next(&iter);
2156 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
2159 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);
2162 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
2163 dbus_message_get_sender(message), path, (unsigned long) mask);
2165 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
2167 ret = spi_controller_register_device_listener (
2168 controller, (DEControllerListener *) dec_listener);
2169 reply = dbus_message_new_method_return (message);
2172 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2178 * DBus Accessibility::DEController::RegisterDeviceEventListener
2179 * method implementation
2181 static DBusMessage *
2182 impl_register_device_event_listener (DBusConnection *bus,
2183 DBusMessage *message,
2186 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2187 DEControllerListener *dec_listener;
2190 dbus_int32_t event_types;
2192 DBusMessage *reply = NULL;
2194 dbus_error_init(&error);
2195 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2197 return invalid_arguments_error (message);
2199 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2200 ret = spi_controller_register_device_listener (
2201 controller, (DEControllerListener *) dec_listener);
2202 reply = dbus_message_new_method_return (message);
2205 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2211 DBusConnection *bus;
2212 DEControllerListener *listener;
2213 } RemoveListenerClosure;
2215 static SpiReEntrantContinue
2216 remove_listener_cb (GList * const *list,
2219 DEControllerListener *listener = (*list)->data;
2220 RemoveListenerClosure *ctx = user_data;
2222 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2223 !strcmp(ctx->listener->path, listener->path))
2225 spi_re_entrant_list_delete_link (list);
2226 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2227 spi_dec_listener_free (listener);
2230 return SPI_RE_ENTRANT_CONTINUE;
2233 static SpiReEntrantContinue
2234 copy_key_listener_cb (GList * const *list,
2237 DEControllerKeyListener *key_listener = (*list)->data;
2238 RemoveListenerClosure *ctx = user_data;
2240 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2241 !strcmp(ctx->listener->path, key_listener->listener.path))
2243 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2244 DEControllerKeyListener *ctx_key_listener =
2245 (DEControllerKeyListener *) ctx->listener;
2246 keylist_free (ctx_key_listener->keys);
2247 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2250 return SPI_RE_ENTRANT_CONTINUE;
2254 spi_controller_deregister_device_listener (SpiDEController *controller,
2255 DEControllerListener *listener)
2257 RemoveListenerClosure ctx;
2259 ctx.bus = controller->bus;
2260 ctx.listener = listener;
2262 notify_mouse_listener (controller, listener, FALSE);
2264 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2265 remove_listener_cb, &ctx);
2266 if (!controller->mouse_listeners)
2267 have_mouse_listener = FALSE;
2271 spi_deregister_controller_key_listener (SpiDEController *controller,
2272 DEControllerKeyListener *key_listener)
2274 RemoveListenerClosure ctx;
2276 ctx.bus = controller->bus;
2277 ctx.listener = (DEControllerListener *) spi_key_listener_clone (key_listener);
2279 notify_keystroke_listener (controller, key_listener, FALSE);
2281 /* special case, copy keyset from existing controller list entry */
2282 if (g_slist_length(key_listener->keys) == 0)
2284 spi_re_entrant_list_foreach (&controller->key_listeners,
2285 copy_key_listener_cb, &ctx);
2288 spi_controller_deregister_global_keygrabs (controller, key_listener);
2290 spi_re_entrant_list_foreach (&controller->key_listeners,
2291 remove_listener_cb, &ctx);
2293 spi_key_listener_clone_free ((DEControllerKeyListener *) ctx.listener);
2297 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2301 for (l = controller->mouse_listeners; l; l = tmp)
2303 DEControllerListener *listener = l->data;
2305 if (!strcmp (listener->bus_name, bus_name))
2307 spi_controller_deregister_device_listener (controller, listener);
2308 tmp = controller->mouse_listeners;
2311 for (l = controller->key_listeners; l; l = tmp)
2313 DEControllerKeyListener *key_listener = l->data;
2315 if (!strcmp (key_listener->listener.bus_name, bus_name))
2317 /* TODO: untangle the below line(s) */
2318 spi_deregister_controller_key_listener (controller, key_listener);
2319 tmp = controller->key_listeners;
2325 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2326 * method implementation
2328 static DBusMessage *
2329 impl_deregister_keystroke_listener (DBusConnection *bus,
2330 DBusMessage *message,
2333 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2334 DEControllerKeyListener *key_listener;
2335 DBusMessageIter iter, iter_array;
2337 GSList *keys = NULL;
2338 dbus_int32_t mask, type;
2339 DBusMessage *reply = NULL;
2341 dbus_message_iter_init(message, &iter);
2342 if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu") != 0)
2343 dbus_message_iter_get_basic(&iter, &path);
2344 dbus_message_iter_next(&iter);
2345 dbus_message_iter_recurse(&iter, &iter_array);
2346 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2348 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2351 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))
2355 kd->keystring = g_strdup (keystring);
2356 keys = g_slist_append(keys, kd);
2358 dbus_message_iter_next(&iter);
2359 dbus_message_iter_get_basic(&iter, &mask);
2360 dbus_message_iter_next(&iter);
2361 dbus_message_iter_get_basic(&iter, &type);
2362 dbus_message_iter_next(&iter);
2363 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2364 #ifdef SPI_DEREGISTER_DEBUG
2365 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2366 (void *) l, (unsigned long) mask->value);
2369 spi_deregister_controller_key_listener (controller, key_listener);
2371 spi_dec_listener_free ((DEControllerListener *) key_listener);
2372 reply = dbus_message_new_method_return (message);
2377 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2378 * method implementation
2380 static DBusMessage *
2381 impl_deregister_device_event_listener (DBusConnection *bus,
2382 DBusMessage *message,
2385 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2386 DEControllerListener *listener;
2389 dbus_int32_t event_types;
2390 DBusMessage *reply = NULL;
2392 dbus_error_init(&error);
2393 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2395 return invalid_arguments_error (message);
2397 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2398 spi_controller_deregister_device_listener (
2399 controller, listener);
2400 reply = dbus_message_new_method_return (message);
2404 static DBusMessage *
2405 impl_get_keystroke_listeners (DBusConnection *bus,
2406 DBusMessage *message,
2409 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2410 DEControllerKeyListener *dec_listener;
2411 DBusMessageIter iter, iter_array;
2412 DBusMessage *reply = dbus_message_new_method_return (message);
2418 dbus_message_iter_init_append (reply, &iter);
2419 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2420 "(souua(iisi)u(bbb))", &iter_array);
2421 for (l = controller->key_listeners; l; l = l->next)
2423 append_keystroke_listener (&iter_array, l->data);
2425 dbus_message_iter_close_container (&iter, &iter_array);
2429 static DBusMessage *
2430 impl_get_device_event_listeners (DBusConnection *bus,
2431 DBusMessage *message,
2434 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2435 DEControllerKeyListener *dec_listener;
2436 DBusMessageIter iter, iter_array;
2438 DBusMessage *reply = dbus_message_new_method_return (message);
2443 dbus_message_iter_init_append (reply, &iter);
2444 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2445 "(sou)", &iter_array);
2446 for (l = controller->key_listeners; l; l = l->next)
2448 append_mouse_listener (&iter_array, l->data);
2450 dbus_message_iter_close_container (&iter, &iter_array);
2454 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2456 unsigned int retval = 0;
2457 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2458 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2460 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2461 retval = XkbGetSlowKeysDelay (spi_get_display (),
2462 XkbUseCoreKbd, &bounce_delay);
2464 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2466 Status s = XkbGetControls (spi_get_display (),
2467 XkbAllControlsMask, priv->xkb_desc);
2470 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2471 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2476 #ifdef SPI_XKB_DEBUG
2477 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2482 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2484 unsigned int retval = 0;
2485 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2486 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2488 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2489 retval = XkbGetBounceKeysDelay (spi_get_display (),
2490 XkbUseCoreKbd, &bounce_delay);
2492 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2494 Status s = XkbGetControls (spi_get_display (),
2495 XkbAllControlsMask, priv->xkb_desc);
2498 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2499 retval = priv->xkb_desc->ctrls->debounce_delay;
2504 #ifdef SPI_XKB_DEBUG
2505 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2511 dec_synth_keycode_press (SpiDEController *controller,
2512 unsigned int keycode)
2514 unsigned int time = CurrentTime;
2515 unsigned int bounce_delay;
2516 unsigned int elapsed_msec;
2518 DEControllerPrivateData *priv =
2519 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2520 spi_dec_private_quark);
2521 if (keycode == priv->last_release_keycode)
2523 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2526 gettimeofday (&tv, NULL);
2528 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2529 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2530 #ifdef SPI_XKB_DEBUG
2531 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2532 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2534 #ifdef THIS_IS_BROKEN
2535 if (elapsed_msec < bounce_delay)
2536 time = bounce_delay - elapsed_msec + 1;
2538 time = bounce_delay + 10;
2539 /* fudge for broken XTest */
2541 #ifdef SPI_XKB_DEBUG
2542 fprintf (stderr, "waiting %d ms\n", time);
2546 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2547 priv->last_press_keycode = keycode;
2548 XFlush (spi_get_display ());
2549 XSync (spi_get_display (), False);
2550 gettimeofday (&priv->last_press_time, NULL);
2555 dec_synth_keycode_release (SpiDEController *controller,
2556 unsigned int keycode)
2558 unsigned int time = CurrentTime;
2559 unsigned int slow_delay;
2560 unsigned int elapsed_msec;
2562 DEControllerPrivateData *priv =
2563 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2564 spi_dec_private_quark);
2565 if (keycode == priv->last_press_keycode)
2567 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2570 gettimeofday (&tv, NULL);
2572 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2573 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2574 #ifdef SPI_XKB_DEBUG
2575 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2576 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2578 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2579 if (elapsed_msec < slow_delay)
2580 time = slow_delay - elapsed_msec + 1;
2582 time = slow_delay + 10;
2583 /* our XTest seems broken, we have to add slop as above */
2585 #ifdef SPI_XKB_DEBUG
2586 fprintf (stderr, "waiting %d ms\n", time);
2590 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2591 priv->last_release_keycode = keycode;
2592 XSync (spi_get_display (), False);
2593 gettimeofday (&priv->last_release_time, NULL);
2598 dec_get_modifier_state (SpiDEController *controller)
2600 return mouse_mask_state;
2604 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2606 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2607 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2609 if (priv->have_xkb) {
2610 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2611 modifiers, modifiers);
2614 for (mod_index=0;mod_index<8;mod_index++)
2615 if (modifiers & (1<<mod_index))
2616 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2622 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2624 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2625 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2627 if (priv->have_xkb) {
2628 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2632 for (mod_index=0;mod_index<8;mod_index++)
2633 if (modifiers & (1<<mod_index))
2634 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2640 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2642 return ucs2keysym ((long) unichar);
2646 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2648 KeyCode key_synth_code;
2649 unsigned int modifiers, synth_mods, lock_mods;
2651 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2653 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2655 /* TODO: set the modifiers accordingly! */
2656 modifiers = dec_get_modifier_state (controller);
2657 /* side-effect; we may unset mousebutton modifiers here! */
2660 if (synth_mods != modifiers) {
2661 lock_mods = synth_mods & ~modifiers;
2662 dec_lock_modifiers (controller, lock_mods);
2664 dec_synth_keycode_press (controller, key_synth_code);
2665 dec_synth_keycode_release (controller, key_synth_code);
2667 if (synth_mods != modifiers)
2668 dec_unlock_modifiers (controller, lock_mods);
2674 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2676 /* probably we need to create and inject an XIM handler eventually. */
2677 /* for now, try to match the string to existing
2678 * keycode+modifier states.
2682 gunichar unichar = 0;
2684 gboolean retval = TRUE;
2687 maxlen = strlen (keystring) + 1;
2688 keysyms = g_new0 (KeySym, maxlen);
2689 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2694 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2696 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2701 mbytes = g_unichar_to_utf8 (unichar, bytes);
2702 bytes[mbytes] = '\0';
2704 fprintf (stderr, "[unichar %s]", bytes);
2706 keysym = dec_keysym_for_unichar (controller, unichar);
2707 if (keysym == NoSymbol) {
2709 fprintf (stderr, "no keysym for %s", bytes);
2714 keysyms[i++] = keysym;
2715 keystring = g_utf8_next_char (keystring);
2718 XSynchronize (spi_get_display (), TRUE);
2719 for (i = 0; keysyms[i]; ++i) {
2720 if (!dec_synth_keysym (controller, keysyms[i])) {
2722 fprintf (stderr, "could not synthesize %c\n",
2729 XSynchronize (spi_get_display (), FALSE);
2738 * DBus Accessibility::DEController::RegisterKeystrokeListener
2739 * method implementation
2741 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2743 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2745 dbus_int32_t keycode;
2747 dbus_uint32_t synth_type;
2750 DEControllerPrivateData *priv;
2751 DBusMessage *reply = NULL;
2753 dbus_error_init(&error);
2754 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2756 return invalid_arguments_error (message);
2760 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2761 (long) keycode, (int) synth_type);
2763 /* TODO: hide/wrap/remove X dependency */
2766 * TODO: when initializing, query for XTest extension before using,
2767 * and fall back to XSendEvent() if XTest is not available.
2770 spi_x_error_trap ();
2772 priv = (DEControllerPrivateData *)
2773 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2775 if (!priv->have_xkb && xmkeymap==NULL) {
2776 xmkeymap = XGetModifierMapping(spi_get_display ());
2781 case Accessibility_KEY_PRESS:
2782 dec_synth_keycode_press (controller, keycode);
2784 case Accessibility_KEY_PRESSRELEASE:
2785 dec_synth_keycode_press (controller, keycode);
2786 case Accessibility_KEY_RELEASE:
2787 dec_synth_keycode_release (controller, keycode);
2789 case Accessibility_KEY_SYM:
2790 #ifdef SPI_XKB_DEBUG
2791 fprintf (stderr, "KeySym synthesis\n");
2794 * note: we are using long for 'keycode'
2795 * in our arg list; it can contain either
2796 * a keycode or a keysym.
2798 dec_synth_keysym (controller, (KeySym) keycode);
2800 case Accessibility_KEY_STRING:
2801 if (!dec_synth_keystring (controller, keystring))
2802 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2806 if (synth_type == Accessibility_KEY_SYM) {
2810 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2812 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2814 spi_dec_clear_unlatch_pending (controller);
2816 reply = dbus_message_new_method_return (message);
2820 /* Accessibility::DEController::GenerateMouseEvent */
2821 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2827 DBusMessage *reply = NULL;
2829 gboolean err = FALSE;
2830 Display *display = spi_get_display ();
2832 dbus_error_init (&error);
2833 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2835 return invalid_arguments_error (message);
2839 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2840 eventName, (long int) x, (long int) y);
2842 switch (eventName[0])
2845 switch (eventName[1])
2847 /* TODO: check number of buttons before parsing */
2868 if (x != -1 && y != -1)
2870 XTestFakeMotionEvent (display, DefaultScreen (display),
2873 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2874 if (eventName[2] == 'c')
2875 XTestFakeButtonEvent (display, button, FALSE, 1);
2876 else if (eventName[2] == 'd')
2878 XTestFakeButtonEvent (display, button, FALSE, 1);
2879 XTestFakeButtonEvent (display, button, TRUE, 2);
2880 XTestFakeButtonEvent (display, button, FALSE, 3);
2884 case 'r': /* relative motion */
2885 XTestFakeRelativeMotionEvent (display, x, y, 0);
2887 case 'a': /* absolute motion */
2888 XTestFakeMotionEvent (display, DefaultScreen (display),
2892 reply = dbus_message_new_method_return (message);
2896 /* Accessibility::DEController::NotifyListenersSync */
2897 static DBusMessage *
2898 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2900 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2901 Accessibility_DeviceEvent event;
2903 DBusMessage *reply = NULL;
2905 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2907 return invalid_arguments_error (message);
2910 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2911 controller, (int) event.id);
2913 ret = spi_controller_notify_keylisteners (controller,
2914 (Accessibility_DeviceEvent *)
2917 reply = dbus_message_new_method_return (message);
2920 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2925 static DBusMessage *
2926 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2928 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2929 Accessibility_DeviceEvent event;
2930 DBusMessage *reply = NULL;
2932 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2934 return invalid_arguments_error (message);
2937 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2938 controller, (int) event.id);
2940 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2942 reply = dbus_message_new_method_return (message);
2947 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2949 GObjectClass * object_class = (GObjectClass *) klass;
2951 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2953 object_class->finalize = spi_device_event_controller_object_finalize;
2955 if (!spi_dec_private_quark)
2956 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2960 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2966 handle_io (GIOChannel *source,
2967 GIOCondition condition,
2970 SpiDEController *controller = (SpiDEController *) data;
2971 gboolean is_consumed = FALSE;
2974 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2976 if (ev.type == KeyPress || ev.type == KeyRelease)
2977 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2980 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2985 #endif /* HAVE_XEVIE */
2988 spi_device_event_controller_init (SpiDEController *device_event_controller)
2990 spi_events_init (spi_get_display());
2994 #endif /* HAVE_XEVIE */
2996 DEControllerPrivateData *private;
2997 device_event_controller->key_listeners = NULL;
2998 device_event_controller->mouse_listeners = NULL;
2999 device_event_controller->keygrabs_list = NULL;
3000 device_event_controller->xevie_display = NULL;
3003 device_event_controller->xevie_display = XOpenDisplay(NULL);
3005 if (XevieStart(device_event_controller->xevie_display) == TRUE)
3007 #ifdef SPI_KEYEVENT_DEBUG
3008 fprintf (stderr, "XevieStart() success \n");
3010 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
3012 fd = ConnectionNumber(device_event_controller->xevie_display);
3013 ioc = g_io_channel_unix_new (fd);
3014 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
3015 g_io_channel_unref (ioc);
3019 device_event_controller->xevie_display = NULL;
3020 #ifdef SPI_KEYEVENT_DEBUG
3021 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
3024 #endif /* HAVE_XEVIE */
3026 private = g_new0 (DEControllerPrivateData, 1);
3027 gettimeofday (&private->last_press_time, NULL);
3028 gettimeofday (&private->last_release_time, NULL);
3029 g_object_set_qdata (G_OBJECT (device_event_controller),
3030 spi_dec_private_quark,
3032 spi_controller_register_with_devices (device_event_controller);
3033 device_event_controller->message_queue = g_queue_new ();
3034 saved_controller = device_event_controller;
3038 spi_device_event_controller_forward_key_event (SpiDEController *controller,
3039 const XEvent *event)
3041 Accessibility_DeviceEvent key_event;
3044 g_assert (event->type == KeyPress || event->type == KeyRelease);
3046 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3048 if (controller->xevie_display == NULL)
3049 spi_controller_update_key_grabs (controller, &key_event);
3051 /* relay to listeners, and decide whether to consume it or not */
3052 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
3053 g_free(key_event.event_string);
3059 is_key_released (KeyCode code)
3064 XQueryKeymap (spi_get_display (), keys);
3065 down = BIT (keys, code);
3070 check_release (gpointer data)
3073 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
3074 KeyCode code = event->hw_code;
3076 released = is_key_released (code);
3080 check_release_handler = 0;
3081 event->type = Accessibility_KEY_RELEASED_EVENT;
3082 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
3084 return (released == 0);
3087 static void wait_for_release_event (XEvent *event,
3088 SpiDEController *controller)
3090 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
3091 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
3094 /*---------------------------------------------------------------------------*/
3096 static const char *introspection_header =
3097 "<?xml version=\"1.0\"?>\n";
3099 static const char *introspection_node_element =
3100 "<node name=\"%s\">\n";
3102 static const char *introspection_footer =
3105 static DBusMessage *
3106 impl_Introspect (DBusConnection * bus,
3107 DBusMessage * message, void *user_data)
3113 const gchar *pathstr = SPI_DBUS_PATH_DEC;
3117 output = g_string_new(introspection_header);
3119 g_string_append_printf(output, introspection_node_element, pathstr);
3121 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
3123 g_string_append(output, introspection_footer);
3124 final = g_string_free(output, FALSE);
3126 reply = dbus_message_new_method_return (message);
3127 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
3133 /*---------------------------------------------------------------------------*/
3136 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
3138 const gchar *iface = dbus_message_get_interface (message);
3139 const gchar *member = dbus_message_get_member (message);
3140 const gint type = dbus_message_get_type (message);
3141 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3142 DBusMessage *reply = NULL;
3144 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
3146 result = DBUS_HANDLER_RESULT_HANDLED;
3147 if (!strcmp (member, "RegisterKeystrokeListener"))
3148 reply = impl_register_keystroke_listener (bus, message, user_data);
3149 else if (!strcmp (member, "RegisterDeviceEventListener"))
3150 reply = impl_register_device_event_listener (bus, message, user_data);
3151 else if (!strcmp (member, "DeregisterKeystrokeListener"))
3152 reply = impl_deregister_keystroke_listener (bus, message, user_data);
3153 else if (!strcmp (member, "DeregisterDeviceEventListener"))
3154 reply = impl_deregister_device_event_listener (bus, message, user_data);
3155 else if (!strcmp (member, "GetKeystrokeListeners"))
3156 reply = impl_get_keystroke_listeners (bus, message, user_data);
3157 else if (!strcmp (member, "GetDeviceEventListeners"))
3158 reply = impl_get_device_event_listeners (bus, message, user_data);
3159 else if (!strcmp (member, "GenerateKeyboardEvent"))
3160 reply = impl_generate_keyboard_event (bus, message, user_data);
3161 else if (!strcmp (member, "GenerateMouseEvent"))
3162 reply = impl_generate_mouse_event (bus, message, user_data);
3163 else if (!strcmp (member, "NotifyListenersSync"))
3164 reply = impl_notify_listeners_sync (bus, message, user_data);
3165 else if (!strcmp (member, "NotifyListenersAsync"))
3166 reply = impl_notify_listeners_async (bus, message, user_data);
3168 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3171 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
3173 result = DBUS_HANDLER_RESULT_HANDLED;
3174 if (!strcmp (member, "Introspect"))
3175 reply = impl_Introspect (bus, message, user_data);
3177 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3180 if (result == DBUS_HANDLER_RESULT_HANDLED)
3184 reply = dbus_message_new_method_return (message);
3187 dbus_connection_send (bus, reply, NULL);
3188 dbus_message_unref (reply);
3193 message_queue_dispatch (gpointer data)
3195 saved_controller->message_queue_idle = 0;
3196 while (!g_queue_is_empty (saved_controller->message_queue))
3198 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
3199 data = g_queue_pop_head (saved_controller->message_queue);
3200 handle_dec_method_from_idle (saved_controller->bus, message, data);
3201 dbus_message_unref (message);
3206 static DBusHandlerResult
3207 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
3209 const gchar *iface = dbus_message_get_interface (message);
3210 const gchar *member = dbus_message_get_member (message);
3211 const gint type = dbus_message_get_type (message);
3213 /* Check for basic reasons not to handle */
3214 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3217 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3219 dbus_message_ref (message);
3220 g_queue_push_tail (saved_controller->message_queue, message);
3221 g_queue_push_tail (saved_controller->message_queue, user_data);
3222 if (!saved_controller->message_queue_idle)
3223 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
3224 return DBUS_HANDLER_RESULT_HANDLED;
3227 static DBusObjectPathVTable dec_vtable =
3231 NULL, NULL, NULL, NULL
3235 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
3237 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
3239 dec->registry = g_object_ref (reg);
3240 reg->dec = g_object_ref (dec);
3243 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
3245 spi_dec_init_mouse_listener (dec);
3251 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
3253 if (!have_mouse_event_listener)
3255 have_mouse_event_listener = TRUE;
3256 if (!have_mouse_listener)
3257 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
3262 spi_device_event_controller_stop_poll_mouse (void)
3264 have_mouse_event_listener = FALSE;