1 /* AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2003 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 /* deviceeventcontroller.c: implement the DeviceEventController interface */
30 #undef SPI_KEYEVENT_DEBUG
38 #include <X11/extensions/XTest.h>
39 #include <X11/XKBlib.h>
42 #include <X11/keysymdef.h>
45 #include <X11/Xproto.h>
47 #include <X11/extensions/Xevie.h>
48 #endif /* HAVE_XEVIE */
52 #include <dbus/dbus.h>
57 #include "de-marshaller.h"
60 #include "deviceeventcontroller.h"
61 #include "reentrant-list.h"
63 #include "introspection.h"
65 KeySym ucs2keysym (long ucs);
66 long keysym2ucs(KeySym keysym);
68 #define CHECK_RELEASE_DELAY 20
69 #define BIT(c, x) (c[x/8]&(1<<(x%8)))
70 static guint check_release_handler = 0;
71 static Accessibility_DeviceEvent pressed_event;
72 static SpiDEController *saved_controller;
73 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
75 /* Our parent Gtk object type */
76 #define PARENT_TYPE G_TYPE_OBJECT
78 /* A pointer to our parent object class */
79 static int spi_error_code = 0;
84 typedef struct _SpiPoint SpiPoint;
85 static SpiPoint last_mouse_pos_static = {0, 0};
86 static SpiPoint *last_mouse_pos = &last_mouse_pos_static;
87 static unsigned int mouse_mask_state = 0;
88 static unsigned int mouse_button_mask =
89 Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
90 static unsigned int key_modifier_mask =
91 Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
92 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
94 static GQuark spi_dec_private_quark = 0;
95 static XModifierKeymap* xmkeymap = NULL;
97 static gboolean have_mouse_listener = FALSE;
98 static gboolean have_mouse_event_listener = FALSE;
100 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
104 SPI_DEVICE_TYPE_MOUSE,
105 SPI_DEVICE_TYPE_LAST_DEFINED
106 } SpiDeviceTypeCategory;
109 guint ref_count : 30;
110 guint pending_add : 1;
111 guint pending_remove : 1;
113 Accessibility_ControllerEventMask mod_mask;
114 dbus_uint32_t key_val; /* KeyCode */
115 } DEControllerGrabMask;
120 SpiDeviceTypeCategory type;
122 } DEControllerListener;
125 DEControllerListener listener;
128 Accessibility_ControllerEventMask mask;
129 Accessibility_EventListenerMode *mode;
130 } DEControllerKeyListener;
133 unsigned int last_press_keycode;
134 unsigned int last_release_keycode;
135 struct timeval last_press_time;
136 struct timeval last_release_time;
138 int xkb_major_extension_opcode;
139 int xkb_base_event_code;
140 int xkb_base_error_code;
141 unsigned int xkb_latch_mask;
142 unsigned int pending_xkb_mod_relatch_mask;
144 KeyCode reserved_keycode;
145 KeySym reserved_keysym;
146 guint reserved_reset_timeout;
147 } DEControllerPrivateData;
149 static void spi_controller_register_with_devices (SpiDEController *controller);
150 static gboolean spi_controller_update_key_grabs (SpiDEController *controller,
151 Accessibility_DeviceEvent *recv);
152 static gboolean spi_controller_register_device_listener (SpiDEController *controller,
153 DEControllerListener *l);
154 static gboolean spi_device_event_controller_forward_key_event (SpiDEController *controller,
155 const XEvent *event);
156 static void spi_controller_deregister_device_listener (SpiDEController *controller,
157 DEControllerListener *listener);
158 static void spi_deregister_controller_key_listener (SpiDEController *controller,
159 DEControllerKeyListener *key_listener);
160 static gboolean spi_controller_notify_mouselisteners (SpiDEController *controller,
161 const Accessibility_DeviceEvent *event);
163 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
164 const Accessibility_DeviceEvent *event);
165 static gboolean spi_clear_error_state (void);
166 static gboolean spi_dec_poll_mouse_moved (gpointer data);
167 static gboolean spi_dec_poll_mouse_moving (gpointer data);
168 static gboolean spi_dec_poll_mouse_idle (gpointer data);
170 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
173 invalid_arguments_error (DBusMessage *message)
178 errmsg= g_strdup_printf (
179 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
180 dbus_message_get_member (message),
181 dbus_message_get_signature (message),
182 dbus_message_get_interface (message));
183 reply = dbus_message_new_error (message,
184 DBUS_ERROR_INVALID_ARGS,
190 /* Private methods */
192 spi_dbus_add_disconnect_match (DBusConnection *bus, const char *name)
194 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
198 dbus_error_init (&error);
199 dbus_bus_add_match (bus, match, &error);
201 return !dbus_error_is_set (&error);
207 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
209 char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
213 dbus_error_init (&error);
214 dbus_bus_remove_match (bus, match, &error);
216 return !dbus_error_is_set (&error);
222 keysym_mod_mask (KeySym keysym, KeyCode keycode)
224 /* we really should use XKB and look directly at the keymap */
225 /* this is very inelegant */
226 Display *display = spi_get_display ();
227 unsigned int mods_rtn = 0;
228 unsigned int retval = 0;
231 if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
232 (sym_rtn == keysym)) {
235 else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
236 (sym_rtn == keysym)) {
239 else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
240 (sym_rtn == keysym)) {
243 else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
244 (sym_rtn == keysym)) {
247 else if (XkbLookupKeySym (display, keycode,
248 ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
249 (sym_rtn == keysym)) {
250 retval = (Mod2Mask | ShiftMask);
252 else if (XkbLookupKeySym (display, keycode,
253 ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
254 (sym_rtn == keysym)) {
255 retval = (Mod3Mask | ShiftMask);
257 else if (XkbLookupKeySym (display, keycode,
258 ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
259 (sym_rtn == keysym)) {
260 retval = (Mod4Mask | ShiftMask);
268 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
271 Display *dpy = spi_get_display ();
273 if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
275 fprintf (stderr, "ERROR getting map\n");
279 if (desc && desc->map)
281 gint offset = desc->map->key_sym_map[keycode].offset;
282 desc->map->syms[offset] = keysym;
286 fprintf (stderr, "Error changing key map: empty server structure\n");
288 XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
290 * FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
291 * would be far preferable.
292 * HOWEVER it does not seem to work using XFree 4.3.
294 /* XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
297 XkbFreeKeyboard (desc, 0, TRUE);
306 spi_dec_reset_reserved (gpointer data)
308 DEControllerPrivateData *priv = data;
309 spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
310 priv->reserved_reset_timeout = 0;
315 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
318 keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
321 DEControllerPrivateData *priv = (DEControllerPrivateData *)
322 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
323 /* if there's no keycode available, fix it */
324 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
326 keycode = priv->reserved_keycode;
328 * queue a timer to restore the old keycode. Ugly, but required
329 * due to races / asynchronous X delivery.
330 * Long-term fix is to extend the X keymap here instead of replace entries.
332 priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
338 *modmask = keysym_mod_mask (keysym, keycode);
342 static DEControllerGrabMask *
343 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
345 DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
347 memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
349 clone->ref_count = 1;
350 clone->pending_add = TRUE;
351 clone->pending_remove = FALSE;
357 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
363 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
365 DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
366 DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
374 return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
379 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
381 DEControllerPrivateData *priv =
382 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
384 if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
385 priv->xkb_latch_mask);
387 priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
391 spi_dec_clear_unlatch_pending (SpiDEController *controller)
393 DEControllerPrivateData *priv =
394 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
395 priv->xkb_latch_mask = 0;
398 static void emit(SpiDEController *controller, const char *interface, const char *name, const char *minor, int a1, int a2)
400 DBusMessage *signal = NULL;
401 DBusMessageIter iter, iter_struct, iter_variant;
403 const char *path = SPI_DBUS_PATH_ROOT;
404 const char *bus_name = dbus_bus_get_unique_name (controller->bus);
406 signal = dbus_message_new_signal (path, interface, name);
408 dbus_message_iter_init_append (signal, &iter);
410 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
411 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a1);
412 dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a2);
413 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
414 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
415 dbus_message_iter_close_container (&iter, &iter_variant);
417 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
419 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
420 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
421 dbus_message_iter_close_container (&iter, &iter_struct);
423 dbus_connection_send (controller->bus, signal, NULL);
424 dbus_message_unref (signal);
428 spi_dec_button_update_and_emit (SpiDEController *controller,
431 Accessibility_DeviceEvent mouse_e;
432 gchar event_detail[3];
433 gboolean is_consumed = FALSE;
435 if ((mask_return & mouse_button_mask) !=
436 (mouse_mask_state & mouse_button_mask))
438 int button_number = 0;
439 gboolean is_down = False;
441 if (!(mask_return & Button1Mask) &&
442 (mouse_mask_state & Button1Mask))
444 mouse_mask_state &= ~Button1Mask;
447 else if ((mask_return & Button1Mask) &&
448 !(mouse_mask_state & Button1Mask))
450 mouse_mask_state |= Button1Mask;
454 else if (!(mask_return & Button2Mask) &&
455 (mouse_mask_state & Button2Mask))
457 mouse_mask_state &= ~Button2Mask;
460 else if ((mask_return & Button2Mask) &&
461 !(mouse_mask_state & Button2Mask))
463 mouse_mask_state |= Button2Mask;
467 else if (!(mask_return & Button3Mask) &&
468 (mouse_mask_state & Button3Mask))
470 mouse_mask_state &= ~Button3Mask;
473 else if ((mask_return & Button3Mask) &&
474 !(mouse_mask_state & Button3Mask))
476 mouse_mask_state |= Button3Mask;
480 else if (!(mask_return & Button4Mask) &&
481 (mouse_mask_state & Button4Mask))
483 mouse_mask_state &= ~Button4Mask;
486 else if ((mask_return & Button4Mask) &&
487 !(mouse_mask_state & Button4Mask))
489 mouse_mask_state |= Button4Mask;
493 else if (!(mask_return & Button5Mask) &&
494 (mouse_mask_state & Button5Mask))
496 mouse_mask_state &= ~Button5Mask;
499 else if ((mask_return & Button5Mask) &&
500 !(mouse_mask_state & Button5Mask))
502 mouse_mask_state |= Button5Mask;
508 fprintf (stderr, "Button %d %s\n",
509 button_number, (is_down) ? "Pressed" : "Released");
511 snprintf (event_detail, 3, "%d%c", button_number,
512 (is_down) ? 'p' : 'r');
513 /* TODO: FIXME distinguish between physical and
516 mouse_e.type = (is_down) ?
517 Accessibility_BUTTON_PRESSED_EVENT :
518 Accessibility_BUTTON_RELEASED_EVENT;
519 mouse_e.id = button_number;
520 mouse_e.hw_code = button_number;
521 mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
522 mouse_e.timestamp = 0;
523 mouse_e.event_string = "";
524 mouse_e.is_text = FALSE;
526 spi_controller_notify_mouselisteners (controller,
530 dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
531 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, x, y);
534 spi_dec_set_unlatch_pending (controller, mask_return);
546 spi_dec_mouse_check (SpiDEController *controller,
547 int *x, int *y, gboolean *moved)
549 int win_x_return,win_y_return;
550 unsigned int mask_return;
551 Window root_return, child_return;
552 Display *display = spi_get_display ();
555 XQueryPointer(display, DefaultRootWindow (display),
556 &root_return, &child_return,
558 &win_x_return, &win_y_return, &mask_return);
560 * Since many clients grab the pointer, and X goes an automatic
561 * pointer grab on mouse-down, we often must detect mouse button events
562 * by polling rather than via a button grab.
563 * The while loop (rather than if) is used since it's possible that
564 * multiple buttons have changed state since we last checked.
566 if (mask_return != mouse_mask_state)
568 while (spi_dec_button_update_and_emit (controller, mask_return));
571 if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
573 // TODO: combine these two signals?
574 dbus_uint32_t ix = *x, iy = *y;
575 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Abs", "", ix, iy);
576 ix -= last_mouse_pos->x;
577 iy -= last_mouse_pos->y;
578 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Rel", "", ix, iy);
579 last_mouse_pos->x = *x;
580 last_mouse_pos->y = *y;
592 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
595 dbus_uint32_t d1, d2;
598 fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
599 prev_mask, current_mask);
602 /* set bits for the virtual modifiers like NUMLOCK */
603 if (prev_mask & _numlock_physical_mask)
604 prev_mask |= SPI_KEYMASK_NUMLOCK;
605 if (current_mask & _numlock_physical_mask)
606 current_mask |= SPI_KEYMASK_NUMLOCK;
608 d1 = prev_mask & key_modifier_mask;
609 d2 = current_mask & key_modifier_mask;
610 emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "Modifiers", "", d1, d2);
614 spi_dec_poll_mouse_moved (gpointer data)
616 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
621 mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
623 if ((mask_return & key_modifier_mask) !=
624 (mouse_mask_state & key_modifier_mask))
626 spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
627 mouse_mask_state = mask_return;
634 spi_dec_poll_mouse_idle (gpointer data)
636 if (!have_mouse_event_listener && !have_mouse_listener)
638 else if (!spi_dec_poll_mouse_moved (data))
642 g_timeout_add (20, spi_dec_poll_mouse_moving, data);
648 spi_dec_poll_mouse_moving (gpointer data)
650 if (!have_mouse_event_listener && !have_mouse_listener)
652 else if (spi_dec_poll_mouse_moved (data))
656 g_timeout_add (100, spi_dec_poll_mouse_idle, data);
661 #ifdef WE_NEED_UGRAB_MOUSE
663 spi_dec_ungrab_mouse (gpointer data)
665 Display *display = spi_get_display ();
668 XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
669 XDefaultRootWindow (spi_get_display ()));
676 spi_dec_init_mouse_listener (SpiDEController *dec)
679 Display *display = spi_get_display ();
683 if (XGrabButton (display, AnyButton, AnyModifier,
684 spi_get_root_window (),
685 True, ButtonPressMask | ButtonReleaseMask,
686 GrabModeSync, GrabModeAsync, None, None) != Success) {
688 fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
692 XSync (display, False);
694 fprintf (stderr, "mouse buttons grabbed\n");
701 * Eventually we can use this to make the marshalling of mask types
702 * more sane, but for now we just use this to detect
703 * the use of 'virtual' masks such as numlock and convert them to
704 * system-specific mask values (i.e. ModMask).
707 static Accessibility_ControllerEventMask
708 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
710 Accessibility_ControllerEventMask tmp_mask;
711 gboolean has_numlock;
713 has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
717 tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
718 tmp_mask |= _numlock_physical_mask;
724 static DEControllerKeyListener *
725 spi_dec_key_listener_new (const char *bus_name,
728 const Accessibility_ControllerEventMask mask,
729 const dbus_uint32_t types,
730 const Accessibility_EventListenerMode *mode)
732 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
733 key_listener->listener.bus_name = g_strdup(bus_name);
734 key_listener->listener.path = g_strdup(path);
735 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
736 key_listener->keys = keys;
737 key_listener->mask = spi_dec_translate_mask (mask);
738 key_listener->listener.types = types;
741 key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
742 memcpy(key_listener->mode, mode, sizeof(*mode));
745 key_listener->mode = NULL;
748 g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
749 (unsigned int) key_listener->mask,
750 (int) (mode ? mode->global : 0),
751 (void *) key_listener->keys,
752 (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
758 static DEControllerListener *
759 spi_dec_listener_new (const char *bus_name,
763 DEControllerListener *listener = g_new0 (DEControllerListener, 1);
764 listener->bus_name = g_strdup(bus_name);
765 listener->path = g_strdup(path);
766 listener->type = SPI_DEVICE_TYPE_MOUSE;
767 listener->types = types;
771 static DEControllerListener *
772 spi_listener_clone (DEControllerListener *listener)
774 DEControllerListener *clone = g_new0 (DEControllerListener, 1);
775 clone->bus_name = g_strdup (listener->bus_name);
776 clone->path = g_strdup (listener->path);
777 clone->type = listener->type;
778 clone->types = listener->types;
782 static GSList *keylist_clone (GSList *s)
787 for (l = s; l; l = g_slist_next(l))
789 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
792 Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
793 kd->keycode = kds->keycode;
794 kd->keysym = kds->keysym;
795 kd->keystring = g_strdup(kds->keystring);
796 d = g_slist_append(d, kd);
802 static DEControllerKeyListener *
803 spi_key_listener_clone (DEControllerKeyListener *key_listener)
805 DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
806 clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
807 clone->listener.path = g_strdup (key_listener->listener.path);
808 clone->listener.type = SPI_DEVICE_TYPE_KBD;
809 clone->keys = keylist_clone (key_listener->keys);
810 clone->mask = key_listener->mask;
811 clone->listener.types = key_listener->listener.types;
812 if (key_listener->mode)
814 clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
815 if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
822 static void keylist_free(GSList *keys)
826 for (l = keys; l; l = g_slist_next(l))
828 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
829 g_free(kd->keystring);
836 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
838 keylist_free(key_listener->keys);
839 if (key_listener->mode) g_free(key_listener->mode);
840 g_free (key_listener->listener.bus_name);
841 g_free (key_listener->listener.path);
842 g_free (key_listener);
846 spi_key_listener_clone_free (DEControllerKeyListener *clone)
848 spi_key_listener_data_free (clone);
852 spi_listener_clone_free (DEControllerListener *clone)
854 g_free (clone->path);
855 g_free (clone->bus_name);
860 spi_dec_listener_free (DEControllerListener *listener)
862 g_free (listener->bus_name);
863 g_free (listener->path);
864 if (listener->type == SPI_DEVICE_TYPE_KBD)
865 spi_key_listener_data_free ((DEControllerKeyListener *) listener);
869 _register_keygrab (SpiDEController *controller,
870 DEControllerGrabMask *grab_mask)
874 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
875 spi_grab_mask_compare_values);
878 DEControllerGrabMask *cur_mask = l->data;
880 cur_mask->ref_count++;
881 if (cur_mask->pending_remove)
883 cur_mask->pending_remove = FALSE;
888 controller->keygrabs_list =
889 g_list_prepend (controller->keygrabs_list,
890 spi_grab_mask_clone (grab_mask));
895 _deregister_keygrab (SpiDEController *controller,
896 DEControllerGrabMask *grab_mask)
900 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
901 spi_grab_mask_compare_values);
905 DEControllerGrabMask *cur_mask = l->data;
907 cur_mask->ref_count--;
908 if (cur_mask->ref_count <= 0)
910 cur_mask->pending_remove = TRUE;
916 handle_keygrab (SpiDEController *controller,
917 DEControllerKeyListener *key_listener,
918 void (*process_cb) (SpiDEController *controller,
919 DEControllerGrabMask *grab_mask))
921 DEControllerGrabMask grab_mask = { 0 };
923 grab_mask.mod_mask = key_listener->mask;
924 if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
926 grab_mask.key_val = AnyKey;
928 fprintf (stderr, "AnyKey grab!");
930 process_cb (controller, &grab_mask);
936 for (l = key_listener->keys; l; l = g_slist_next(l))
938 Accessibility_KeyDefinition *keydef = l->data;
939 long int key_val = keydef->keysym;
940 /* X Grabs require keycodes, not keysyms */
941 if (keydef->keystring && keydef->keystring[0])
943 key_val = XStringToKeysym(keydef->keystring);
947 key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
951 key_val = keydef->keycode;
953 grab_mask.key_val = key_val;
954 process_cb (controller, &grab_mask);
960 spi_controller_register_global_keygrabs (SpiDEController *controller,
961 DEControllerKeyListener *key_listener)
963 handle_keygrab (controller, key_listener, _register_keygrab);
964 if (controller->xevie_display == NULL)
965 return spi_controller_update_key_grabs (controller, NULL);
971 spi_controller_deregister_global_keygrabs (SpiDEController *controller,
972 DEControllerKeyListener *key_listener)
974 handle_keygrab (controller, key_listener, _deregister_keygrab);
975 if (controller->xevie_display == NULL)
976 spi_controller_update_key_grabs (controller, NULL);
980 spi_controller_register_device_listener (SpiDEController *controller,
981 DEControllerListener *listener)
983 DEControllerKeyListener *key_listener;
985 switch (listener->type) {
986 case SPI_DEVICE_TYPE_KBD:
987 key_listener = (DEControllerKeyListener *) listener;
989 controller->key_listeners = g_list_prepend (controller->key_listeners,
991 spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
992 if (key_listener->mode->global)
994 return spi_controller_register_global_keygrabs (controller, key_listener);
999 case SPI_DEVICE_TYPE_MOUSE:
1000 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1001 if (!have_mouse_listener)
1003 have_mouse_listener = TRUE;
1004 if (!have_mouse_event_listener)
1005 g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1007 spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1016 set_reply (DBusPendingCall *pending, void *user_data)
1018 void **replyptr = (void **)user_data;
1020 *replyptr = dbus_pending_call_steal_reply (pending);
1023 static DBusMessage *
1024 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1026 DBusPendingCall *pending;
1027 DBusMessage *reply = NULL;
1029 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1033 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1036 if (!dbus_connection_read_write_dispatch (bus, timeout))
1039 dbus_pending_call_unref (pending);
1043 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1044 SpiRegistry *registry,
1045 DEControllerListener *listener,
1046 const Accessibility_DeviceEvent *key_event)
1048 DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1050 SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1053 dbus_bool_t consumed = FALSE;
1055 dbus_error_init(&error);
1056 if (spi_dbus_marshal_deviceEvent(message, key_event))
1058 DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 1000, &error);
1062 dbus_error_init(&error);
1063 dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1064 dbus_message_unref(reply);
1067 dbus_message_unref(message);
1072 spi_controller_notify_mouselisteners (SpiDEController *controller,
1073 const Accessibility_DeviceEvent *event)
1076 GSList *notify = NULL, *l2;
1077 GList **listeners = &controller->mouse_listeners;
1078 gboolean is_consumed;
1079 #ifdef SPI_KEYEVENT_DEBUG
1080 gboolean found = FALSE;
1087 for (l = *listeners; l; l = l->next)
1089 DEControllerListener *listener = l->data;
1091 if (spi_eventtype_seq_contains_event (listener->types, event))
1093 /* we clone (don't dup) the listener, to avoid refcount inc. */
1094 notify = g_slist_prepend (notify,
1095 spi_listener_clone (listener));
1096 #ifdef SPI_KEYEVENT_DEBUG
1102 #ifdef SPI_KEYEVENT_DEBUG
1105 g_print ("no match for event\n");
1109 is_consumed = FALSE;
1110 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1112 DEControllerListener *listener = l2->data;
1114 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1116 spi_listener_clone_free ((DEControllerListener *) l2->data);
1119 for (; l2; l2 = l2->next)
1121 DEControllerListener *listener = l2->data;
1122 spi_listener_clone_free (listener);
1123 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1126 g_slist_free (notify);
1129 if (is_consumed) g_message ("consumed\n");
1135 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1138 Accessibility_DeviceEvent mouse_e;
1139 gchar event_detail[3];
1140 gboolean is_consumed = FALSE;
1141 gboolean xkb_mod_unlatch_occurred;
1142 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1143 dbus_uint32_t ix, iy;
1145 int button = xbutton_event->button;
1147 unsigned int mouse_button_state = xbutton_event->state;
1152 mouse_button_state |= Button1Mask;
1155 mouse_button_state |= Button2Mask;
1158 mouse_button_state |= Button3Mask;
1161 mouse_button_state |= Button4Mask;
1164 mouse_button_state |= Button5Mask;
1168 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1169 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1172 fprintf (stderr, "mouse button %d %s (%x)\n",
1173 xbutton_event->button,
1174 (xevent->type == ButtonPress) ? "Press" : "Release",
1175 mouse_button_state);
1177 snprintf (event_detail, 3, "%d%c", button,
1178 (xevent->type == ButtonPress) ? 'p' : 'r');
1180 /* TODO: FIXME distinguish between physical and logical buttons */
1181 mouse_e.type = (xevent->type == ButtonPress) ?
1182 Accessibility_BUTTON_PRESSED_EVENT :
1183 Accessibility_BUTTON_RELEASED_EVENT;
1184 mouse_e.id = button;
1185 mouse_e.hw_code = button;
1186 mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1187 mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1188 mouse_e.event_string = "";
1189 mouse_e.is_text = FALSE;
1190 if ((mouse_button_state & mouse_button_mask) !=
1191 (mouse_mask_state & mouse_button_mask))
1193 if ((mouse_mask_state & key_modifier_mask) !=
1194 (mouse_button_state & key_modifier_mask))
1195 spi_dec_emit_modifier_event (controller,
1196 mouse_mask_state, mouse_button_state);
1197 mouse_mask_state = mouse_button_state;
1199 spi_controller_notify_mouselisteners (controller, &mouse_e);
1200 ix = last_mouse_pos->x;
1201 iy = last_mouse_pos->y;
1202 emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1205 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1206 xevent->type == ButtonRelease);
1208 /* if client wants to consume this event, and XKB latch state was
1209 * unset by this button event, we reset it
1211 if (is_consumed && xkb_mod_unlatch_occurred)
1212 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1214 XAllowEvents (spi_get_display (),
1215 (is_consumed) ? SyncPointer : ReplayPointer,
1220 global_filter_fn (XEvent *xevent, void *data)
1222 SpiDEController *controller;
1223 DEControllerPrivateData *priv;
1224 Display *display = spi_get_display ();
1225 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1226 priv = (DEControllerPrivateData *)
1227 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1229 if (xevent->type == MappingNotify)
1232 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1234 if (controller->xevie_display == NULL)
1236 gboolean is_consumed;
1239 spi_device_event_controller_forward_key_event (controller, xevent);
1246 n_events = XPending (display);
1248 #ifdef SPI_KEYEVENT_DEBUG
1249 g_print ("Number of events pending: %d\n", n_events);
1251 for (i = 0; i < n_events; i++)
1253 XNextEvent (display, &next_event);
1254 if (next_event.type != KeyPress &&
1255 next_event.type != KeyRelease)
1256 g_warning ("Unexpected event type %d in queue", next_event.type);
1259 XAllowEvents (display, AsyncKeyboard, CurrentTime);
1261 XUngrabKeyboard (display, CurrentTime);
1265 if (xevent->type == KeyPress)
1266 wait_for_release_event (xevent, controller);
1267 XAllowEvents (display, ReplayKeyboard, CurrentTime);
1273 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1275 spi_device_event_controller_forward_mouse_event (controller, xevent);
1277 if (xevent->type == priv->xkb_base_event_code)
1279 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1280 /* ugly but probably necessary...*/
1281 XSynchronize (display, TRUE);
1283 if (xkb_ev->xkb_type == XkbStateNotify)
1285 XkbStateNotifyEvent *xkb_snev =
1286 (XkbStateNotifyEvent *) xkb_ev;
1287 /* check the mouse, to catch mouse events grabbed by
1288 * another client; in case we should revert this XKB delatch
1290 if (!priv->pending_xkb_mod_relatch_mask)
1294 spi_dec_mouse_check (controller, &x, &y, &moved);
1296 /* we check again, since the previous call may have
1297 changed this flag */
1298 if (priv->pending_xkb_mod_relatch_mask)
1300 unsigned int feedback_mask;
1301 #ifdef SPI_XKB_DEBUG
1302 fprintf (stderr, "relatching %x\n",
1303 priv->pending_xkb_mod_relatch_mask);
1305 /* temporarily turn off the latch bell, if it's on */
1306 XkbGetControls (display,
1307 XkbAccessXFeedbackMask,
1309 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1310 if (feedback_mask & XkbAX_StickyKeysFBMask)
1312 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1314 priv->xkb_desc->ctrls->ax_options
1315 &= ~(XkbAX_StickyKeysFBMask);
1316 XkbChangeControls (display, priv->xkb_desc, &changes);
1318 /* TODO: account for lock as well as latch */
1319 XkbLatchModifiers (display,
1321 priv->pending_xkb_mod_relatch_mask,
1322 priv->pending_xkb_mod_relatch_mask);
1323 if (feedback_mask & XkbAX_StickyKeysFBMask)
1325 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1327 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1328 XkbChangeControls (display, priv->xkb_desc, &changes);
1330 #ifdef SPI_XKB_DEBUG
1331 fprintf (stderr, "relatched %x\n",
1332 priv->pending_xkb_mod_relatch_mask);
1334 priv->pending_xkb_mod_relatch_mask = 0;
1338 priv->xkb_latch_mask = xkb_snev->latched_mods;
1341 XSynchronize (display, FALSE);
1348 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1350 if (error->error_code == BadAccess)
1352 g_message ("Could not complete key grab: grab already in use.\n");
1353 spi_error_code = BadAccess;
1358 return (*x_default_error_handler) (display, error);
1363 spi_controller_register_with_devices (SpiDEController *controller)
1365 DEControllerPrivateData *priv;
1366 int event_base, error_base, major_version, minor_version;
1368 priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1369 if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1371 XTestGrabControl (spi_get_display (), True);
1374 /* calls to device-specific implementations and routines go here */
1375 /* register with: keyboard hardware code handler */
1376 /* register with: (translated) keystroke handler */
1378 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1379 &priv->xkb_major_extension_opcode,
1380 &priv->xkb_base_event_code,
1381 &priv->xkb_base_error_code, NULL, NULL);
1385 guint64 reserved = 0;
1386 priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1387 XkbSelectEvents (spi_get_display (),
1389 XkbStateNotifyMask, XkbStateNotifyMask);
1390 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1392 for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1394 if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1396 if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1398 /* don't use this one if there's a grab client! */
1400 /* Runtime errors are generated from these functions,
1401 * that are then quashed. Equivalent to:
1408 spi_x_error_trap ();
1409 XGrabKey (spi_get_display (), i, 0,
1410 spi_get_root_window (),
1412 GrabModeSync, GrabModeSync);
1413 XSync (spi_get_display (), TRUE);
1414 XUngrabKey (spi_get_display (), i, 0,
1415 spi_get_root_window ());
1416 if (!spi_x_error_release ())
1426 priv->reserved_keycode = reserved;
1427 priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1431 priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1432 priv->reserved_keysym = XK_numbersign;
1434 #ifdef SPI_RESERVED_DEBUG
1436 sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1437 fprintf (stderr, "%x\n", sym);
1438 fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1440 XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1445 spi_set_filter (global_filter_fn, controller);
1446 spi_set_events (KeyPressMask | KeyReleaseMask);
1448 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1452 spi_key_set_contains_key (GSList *key_set,
1453 const Accessibility_DeviceEvent *key_event)
1462 g_print ("null key set!\n");
1467 len = g_slist_length (key_set);
1469 if (len == 0) /* special case, means "all keys/any key" */
1472 g_print ("anykey\n");
1477 for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1479 Accessibility_KeyDefinition *kd = l->data;
1480 #ifdef SPI_KEYEVENT_DEBUG
1481 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1485 (int) key_event->id,
1486 (int) key_event->hw_code,
1487 key_event->event_string);
1489 if (kd->keysym == (dbus_uint32_t) key_event->id)
1493 if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1497 if (key_event->event_string && key_event->event_string[0] &&
1498 !strcmp (kd->keystring, key_event->event_string))
1508 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1509 const Accessibility_DeviceEvent *event)
1511 if (types == 0) /* special case, means "all events/any event" */
1516 return (types & (1 << event->type));
1520 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1521 DEControllerKeyListener *listener,
1522 dbus_bool_t is_system_global)
1524 if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1525 spi_key_set_contains_key (listener->keys, key_event) &&
1526 spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1527 (is_system_global == listener->mode->global))
1538 spi_controller_notify_keylisteners (SpiDEController *controller,
1539 Accessibility_DeviceEvent *key_event,
1540 dbus_bool_t is_system_global)
1543 GSList *notify = NULL, *l2;
1544 GList **key_listeners = &controller->key_listeners;
1545 gboolean is_consumed;
1552 /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1553 if (key_event->modifiers & _numlock_physical_mask)
1554 key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1556 for (l = *key_listeners; l; l = l->next)
1558 DEControllerKeyListener *key_listener = l->data;
1560 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1562 /* we clone (don't dup) the listener, to avoid refcount inc. */
1563 notify = g_slist_prepend (notify,
1564 spi_key_listener_clone (key_listener));
1568 #ifdef SPI_KEYEVENT_DEBUG
1571 g_print ("no match for event\n");
1575 is_consumed = FALSE;
1576 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1578 DEControllerKeyListener *key_listener = l2->data;
1580 is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1581 key_listener->mode->preemptive;
1583 spi_key_listener_clone_free (key_listener);
1586 for (; l2; l2 = l2->next)
1588 DEControllerKeyListener *key_listener = l2->data;
1589 spi_key_listener_clone_free (key_listener);
1590 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1593 g_slist_free (notify);
1596 if (is_consumed) g_message ("consumed\n");
1602 spi_clear_error_state (void)
1604 gboolean retval = spi_error_code != 0;
1609 static Accessibility_DeviceEvent
1610 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1612 Accessibility_DeviceEvent key_event;
1614 const int cbuf_bytes = 20;
1618 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1619 key_event.id = (dbus_int32_t)(keysym);
1620 key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1621 if (((XEvent *) x_key_event)->type == KeyPress)
1623 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1627 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1629 key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1630 key_event.is_text = FALSE;
1634 key_event.event_string = g_strdup ("space");
1637 key_event.event_string = g_strdup ("Tab");
1640 key_event.event_string = g_strdup ("Backspace");
1643 key_event.event_string = g_strdup ("Return");
1646 key_event.event_string = g_strdup ("Home");
1649 key_event.event_string = g_strdup ("Page_Down");
1652 key_event.event_string = g_strdup ("Page_Up");
1655 key_event.event_string = g_strdup ("F1");
1658 key_event.event_string = g_strdup ("F2");
1661 key_event.event_string = g_strdup ("F3");
1664 key_event.event_string = g_strdup ("F4");
1667 key_event.event_string = g_strdup ("F5");
1670 key_event.event_string = g_strdup ("F6");
1673 key_event.event_string = g_strdup ("F7");
1676 key_event.event_string = g_strdup ("F8");
1679 key_event.event_string = g_strdup ("F9");
1682 key_event.event_string = g_strdup ("F10");
1685 key_event.event_string = g_strdup ("F11");
1688 key_event.event_string = g_strdup ("F12");
1691 key_event.event_string = g_strdup ("End");
1694 key_event.event_string = g_strdup ("Escape");
1697 key_event.event_string = g_strdup ("Up");
1700 key_event.event_string = g_strdup ("Down");
1703 key_event.event_string = g_strdup ("Left");
1706 key_event.event_string = g_strdup ("Right");
1712 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1713 key_event.event_string = g_strdup (cbuf);
1714 c = keysym2ucs (keysym);
1715 if (c > 0 && !g_unichar_iscntrl (c))
1717 key_event.is_text = TRUE;
1718 /* incorrect for some composed chars? */
1723 key_event.event_string = g_strdup ("");
1727 key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1728 #ifdef SPI_KEYEVENT_DEBUG
1730 char *pressed_str = "pressed";
1731 char *released_str = "released";
1734 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1735 state_ptr = pressed_str;
1737 state_ptr = released_str;
1740 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1741 (unsigned long) keysym,
1743 keysym ? (int) keysym : '*',
1744 (int) x_key_event->state,
1745 key_event.event_string,
1746 key_event.event_string[0],
1747 (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1751 fprintf (stderr, "%s%c\n",
1752 (x_key_event->state & Mod1Mask)?"Alt-":"",
1753 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1754 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1755 fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1756 #endif /* SPI_DEBUG */
1761 spi_controller_update_key_grabs (SpiDEController *controller,
1762 Accessibility_DeviceEvent *recv)
1765 gboolean update_failed = FALSE;
1766 KeyCode keycode = 0;
1768 g_return_val_if_fail (controller != NULL, FALSE);
1771 * masks known to work with default RH 7.1+:
1772 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1773 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1774 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1775 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1777 * ControlMask grabs are broken, must be in use already
1780 keycode = keycode_for_keysym (controller, recv->id, NULL);
1781 for (l = controller->keygrabs_list; l; l = next)
1784 gboolean re_issue_grab;
1785 DEControllerGrabMask *grab_mask = l->data;
1789 re_issue_grab = recv &&
1790 (recv->modifiers & grab_mask->mod_mask) &&
1791 (grab_mask->key_val == keycode);
1794 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1795 (long int) grab_mask->key_val,
1796 (long int) grab_mask->mod_mask,
1797 grab_mask->pending_add ? '+' : '.',
1798 grab_mask->pending_remove ? '-' : '.',
1799 re_issue_grab ? "re-issue": "");
1804 if (grab_mask->pending_add && grab_mask->pending_remove)
1808 else if (grab_mask->pending_remove)
1811 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1813 XUngrabKey (spi_get_display (),
1815 grab_mask->mod_mask,
1816 spi_get_root_window ());
1820 else if (grab_mask->pending_add || re_issue_grab)
1824 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1826 XGrabKey (spi_get_display (),
1828 grab_mask->mod_mask,
1829 spi_get_root_window (),
1833 XSync (spi_get_display (), False);
1834 update_failed = spi_clear_error_state ();
1835 if (update_failed) {
1836 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1841 grab_mask->pending_add = FALSE;
1842 grab_mask->pending_remove = FALSE;
1846 g_assert (grab_mask->ref_count <= 0);
1848 controller->keygrabs_list = g_list_delete_link (
1849 controller->keygrabs_list, l);
1851 spi_grab_mask_free (grab_mask);
1856 return ! update_failed;
1860 * Implemented GObject::finalize
1863 spi_device_event_controller_object_finalize (GObject *object)
1865 SpiDEController *controller;
1866 DEControllerPrivateData *private;
1867 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1868 GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1870 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1872 /* disconnect any special listeners, get rid of outstanding keygrabs */
1873 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1876 if (controller->xevie_display != NULL)
1878 XevieEnd(controller->xevie_display);
1879 #ifdef SPI_KEYEVENT_DEBUG
1880 printf("XevieEnd(dpy) finished \n");
1885 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1886 if (private->xkb_desc)
1887 XkbFreeKeyboard (private->xkb_desc, 0, True);
1889 parent_class->finalize (object);
1893 * DBus Accessibility::DEController::RegisterKeystrokeListener
1894 * method implementation
1896 static DBusMessage *
1897 impl_register_keystroke_listener (DBusConnection *bus,
1898 DBusMessage *message,
1901 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1902 DEControllerKeyListener *dec_listener;
1903 DBusMessageIter iter, iter_array;
1905 GSList *keys = NULL;
1906 dbus_int32_t mask, type;
1907 Accessibility_EventListenerMode *mode;
1909 DBusMessage *reply = NULL;
1913 dbus_message_iter_init(message, &iter);
1914 // TODO: verify type signature
1915 dbus_message_iter_get_basic(&iter, &path);
1916 dbus_message_iter_next(&iter);
1917 dbus_message_iter_recurse(&iter, &iter_array);
1918 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1920 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
1921 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))
1925 kd->keystring = g_strdup (keystring);
1926 keys = g_slist_append(keys, kd);
1928 dbus_message_iter_next(&iter);
1929 dbus_message_iter_get_basic(&iter, &mask);
1930 dbus_message_iter_next(&iter);
1931 sig = dbus_message_iter_get_signature (&iter);
1932 if (sig && !strcmp (sig, "u"))
1933 dbus_message_iter_get_basic(&iter, &type);
1936 dbus_message_iter_recurse(&iter, &iter_array);
1937 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1940 dbus_message_iter_get_basic (&iter_array, &t);
1942 dbus_message_iter_next (&iter_array);
1944 dbus_message_iter_next (&iter_array);
1947 dbus_message_iter_next(&iter);
1948 mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
1951 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);
1954 fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
1955 dbus_message_get_sender(message), path, (unsigned long) mask);
1957 dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
1959 ret = spi_controller_register_device_listener (
1960 controller, (DEControllerListener *) dec_listener);
1961 reply = dbus_message_new_method_return (message);
1964 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1970 * DBus Accessibility::DEController::RegisterDeviceEventListener
1971 * method implementation
1973 static DBusMessage *
1974 impl_register_device_event_listener (DBusConnection *bus,
1975 DBusMessage *message,
1978 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1979 DEControllerListener *dec_listener;
1982 dbus_int32_t event_types;
1984 DBusMessage *reply = NULL;
1986 dbus_error_init(&error);
1987 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
1989 return invalid_arguments_error (message);
1991 dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
1992 ret = spi_controller_register_device_listener (
1993 controller, (DEControllerListener *) dec_listener);
1994 reply = dbus_message_new_method_return (message);
1997 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2003 DBusConnection *bus;
2004 DEControllerListener *listener;
2005 } RemoveListenerClosure;
2007 static SpiReEntrantContinue
2008 remove_listener_cb (GList * const *list,
2011 DEControllerListener *listener = (*list)->data;
2012 RemoveListenerClosure *ctx = user_data;
2014 if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2015 !strcmp(ctx->listener->path, listener->path))
2017 spi_re_entrant_list_delete_link (list);
2018 spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2019 spi_dec_listener_free (listener);
2022 return SPI_RE_ENTRANT_CONTINUE;
2025 static SpiReEntrantContinue
2026 copy_key_listener_cb (GList * const *list,
2029 DEControllerKeyListener *key_listener = (*list)->data;
2030 RemoveListenerClosure *ctx = user_data;
2032 if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2033 !strcmp(ctx->listener->path, key_listener->listener.path))
2035 /* TODO: FIXME aggregate keys in case the listener is registered twice */
2036 DEControllerKeyListener *ctx_key_listener =
2037 (DEControllerKeyListener *) ctx->listener;
2038 keylist_free (ctx_key_listener->keys);
2039 ctx_key_listener->keys = keylist_clone(key_listener->keys);
2042 return SPI_RE_ENTRANT_CONTINUE;
2046 spi_controller_deregister_device_listener (SpiDEController *controller,
2047 DEControllerListener *listener)
2049 RemoveListenerClosure ctx;
2051 ctx.bus = controller->bus;
2052 ctx.listener = listener;
2054 spi_re_entrant_list_foreach (&controller->mouse_listeners,
2055 remove_listener_cb, &ctx);
2056 if (!controller->mouse_listeners)
2057 have_mouse_listener = FALSE;
2061 spi_deregister_controller_key_listener (SpiDEController *controller,
2062 DEControllerKeyListener *key_listener)
2064 RemoveListenerClosure ctx;
2066 ctx.bus = controller->bus;
2067 ctx.listener = (DEControllerListener *) key_listener;
2069 /* special case, copy keyset from existing controller list entry */
2070 if (g_slist_length(key_listener->keys) == 0)
2072 spi_re_entrant_list_foreach (&controller->key_listeners,
2073 copy_key_listener_cb, &ctx);
2076 spi_controller_deregister_global_keygrabs (controller, key_listener);
2078 spi_re_entrant_list_foreach (&controller->key_listeners,
2079 remove_listener_cb, &ctx);
2084 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2088 for (l = controller->mouse_listeners; l; l = tmp)
2090 DEControllerListener *listener = l->data;
2092 if (!strcmp (listener->bus_name, bus_name))
2094 spi_controller_deregister_device_listener (controller, listener);
2097 for (l = controller->key_listeners; l; l = tmp)
2099 DEControllerKeyListener *key_listener = l->data;
2101 if (!strcmp (key_listener->listener.bus_name, bus_name))
2103 spi_deregister_controller_key_listener (controller, key_listener);
2109 * DBus Accessibility::DEController::DeregisterKeystrokeListener
2110 * method implementation
2112 static DBusMessage *
2113 impl_deregister_keystroke_listener (DBusConnection *bus,
2114 DBusMessage *message,
2117 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2118 DEControllerKeyListener *key_listener;
2119 DBusMessageIter iter, iter_array;
2121 GSList *keys = NULL;
2122 dbus_int32_t mask, type;
2123 DBusMessage *reply = NULL;
2125 dbus_message_iter_init(message, &iter);
2126 // TODO: verify type signature
2127 dbus_message_iter_get_basic(&iter, &path);
2128 dbus_message_iter_next(&iter);
2129 dbus_message_iter_recurse(&iter, &iter_array);
2130 while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2132 Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2135 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))
2139 kd->keystring = g_strdup (keystring);
2140 keys = g_slist_append(keys, kd);
2142 dbus_message_iter_next(&iter);
2143 dbus_message_iter_get_basic(&iter, &mask);
2144 dbus_message_iter_next(&iter);
2145 dbus_message_iter_get_basic(&iter, &type);
2146 dbus_message_iter_next(&iter);
2147 key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2148 #ifdef SPI_DEREGISTER_DEBUG
2149 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2150 (void *) l, (unsigned long) mask->value);
2153 spi_deregister_controller_key_listener (controller, key_listener);
2155 spi_dec_listener_free ((DEControllerListener *) key_listener);
2156 reply = dbus_message_new_method_return (message);
2161 * DBus Accessibility::DEController::DeregisterDeviceEventListener
2162 * method implementation
2164 static DBusMessage *
2165 impl_deregister_device_event_listener (DBusConnection *bus,
2166 DBusMessage *message,
2169 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2170 DEControllerListener *listener;
2173 dbus_int32_t event_types;
2174 DBusMessage *reply = NULL;
2176 dbus_error_init(&error);
2177 if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2179 return invalid_arguments_error (message);
2181 listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2182 spi_controller_deregister_device_listener (
2183 controller, listener);
2184 reply = dbus_message_new_method_return (message);
2188 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2190 unsigned int retval = 0;
2191 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2192 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2194 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2195 retval = XkbGetSlowKeysDelay (spi_get_display (),
2196 XkbUseCoreKbd, &bounce_delay);
2198 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2200 Status s = XkbGetControls (spi_get_display (),
2201 XkbAllControlsMask, priv->xkb_desc);
2204 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2205 retval = priv->xkb_desc->ctrls->slow_keys_delay;
2210 #ifdef SPI_XKB_DEBUG
2211 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2216 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2218 unsigned int retval = 0;
2219 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2220 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2222 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2223 retval = XkbGetBounceKeysDelay (spi_get_display (),
2224 XkbUseCoreKbd, &bounce_delay);
2226 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2228 Status s = XkbGetControls (spi_get_display (),
2229 XkbAllControlsMask, priv->xkb_desc);
2232 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2233 retval = priv->xkb_desc->ctrls->debounce_delay;
2238 #ifdef SPI_XKB_DEBUG
2239 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2245 dec_synth_keycode_press (SpiDEController *controller,
2246 unsigned int keycode)
2248 unsigned int time = CurrentTime;
2249 unsigned int bounce_delay;
2250 unsigned int elapsed_msec;
2252 DEControllerPrivateData *priv =
2253 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2254 spi_dec_private_quark);
2255 if (keycode == priv->last_release_keycode)
2257 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2260 gettimeofday (&tv, NULL);
2262 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2263 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2264 #ifdef SPI_XKB_DEBUG
2265 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2266 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2268 #ifdef THIS_IS_BROKEN
2269 if (elapsed_msec < bounce_delay)
2270 time = bounce_delay - elapsed_msec + 1;
2272 time = bounce_delay + 10;
2273 /* fudge for broken XTest */
2275 #ifdef SPI_XKB_DEBUG
2276 fprintf (stderr, "waiting %d ms\n", time);
2280 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2281 priv->last_press_keycode = keycode;
2282 XFlush (spi_get_display ());
2283 XSync (spi_get_display (), False);
2284 gettimeofday (&priv->last_press_time, NULL);
2289 dec_synth_keycode_release (SpiDEController *controller,
2290 unsigned int keycode)
2292 unsigned int time = CurrentTime;
2293 unsigned int slow_delay;
2294 unsigned int elapsed_msec;
2296 DEControllerPrivateData *priv =
2297 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2298 spi_dec_private_quark);
2299 if (keycode == priv->last_press_keycode)
2301 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2304 gettimeofday (&tv, NULL);
2306 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2307 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2308 #ifdef SPI_XKB_DEBUG
2309 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2310 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2312 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2313 if (elapsed_msec < slow_delay)
2314 time = slow_delay - elapsed_msec + 1;
2316 time = slow_delay + 10;
2317 /* our XTest seems broken, we have to add slop as above */
2319 #ifdef SPI_XKB_DEBUG
2320 fprintf (stderr, "waiting %d ms\n", time);
2324 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2325 priv->last_release_keycode = keycode;
2326 XSync (spi_get_display (), False);
2327 gettimeofday (&priv->last_release_time, NULL);
2332 dec_get_modifier_state (SpiDEController *controller)
2334 return mouse_mask_state;
2338 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2340 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2341 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2343 if (priv->have_xkb) {
2344 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2345 modifiers, modifiers);
2348 for (mod_index=0;mod_index<8;mod_index++)
2349 if (modifiers & (1<<mod_index))
2350 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2356 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2358 DEControllerPrivateData *priv = (DEControllerPrivateData *)
2359 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2361 if (priv->have_xkb) {
2362 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2366 for (mod_index=0;mod_index<8;mod_index++)
2367 if (modifiers & (1<<mod_index))
2368 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2374 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2376 return ucs2keysym ((long) unichar);
2380 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2382 KeyCode key_synth_code;
2383 unsigned int modifiers, synth_mods, lock_mods;
2385 key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2387 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2389 /* TODO: set the modifiers accordingly! */
2390 modifiers = dec_get_modifier_state (controller);
2391 /* side-effect; we may unset mousebutton modifiers here! */
2394 if (synth_mods != modifiers) {
2395 lock_mods = synth_mods & ~modifiers;
2396 dec_lock_modifiers (controller, lock_mods);
2398 dec_synth_keycode_press (controller, key_synth_code);
2399 dec_synth_keycode_release (controller, key_synth_code);
2401 if (synth_mods != modifiers)
2402 dec_unlock_modifiers (controller, lock_mods);
2408 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2410 /* probably we need to create and inject an XIM handler eventually. */
2411 /* for now, try to match the string to existing
2412 * keycode+modifier states.
2416 gunichar unichar = 0;
2418 gboolean retval = TRUE;
2421 maxlen = strlen (keystring) + 1;
2422 keysyms = g_new0 (KeySym, maxlen);
2423 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2428 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2430 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2435 mbytes = g_unichar_to_utf8 (unichar, bytes);
2436 bytes[mbytes] = '\0';
2438 fprintf (stderr, "[unichar %s]", bytes);
2440 keysym = dec_keysym_for_unichar (controller, unichar);
2441 if (keysym == NoSymbol) {
2443 fprintf (stderr, "no keysym for %s", bytes);
2448 keysyms[i++] = keysym;
2449 keystring = g_utf8_next_char (keystring);
2452 XSynchronize (spi_get_display (), TRUE);
2453 for (i = 0; keysyms[i]; ++i) {
2454 if (!dec_synth_keysym (controller, keysyms[i])) {
2456 fprintf (stderr, "could not synthesize %c\n",
2463 XSynchronize (spi_get_display (), FALSE);
2472 * DBus Accessibility::DEController::RegisterKeystrokeListener
2473 * method implementation
2475 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2477 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2479 dbus_int32_t keycode;
2481 dbus_uint32_t synth_type;
2484 DEControllerPrivateData *priv;
2485 DBusMessage *reply = NULL;
2487 dbus_error_init(&error);
2488 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2490 return invalid_arguments_error (message);
2494 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2495 (long) keycode, (int) synth_type);
2497 /* TODO: hide/wrap/remove X dependency */
2500 * TODO: when initializing, query for XTest extension before using,
2501 * and fall back to XSendEvent() if XTest is not available.
2504 spi_x_error_trap ();
2506 priv = (DEControllerPrivateData *)
2507 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2509 if (!priv->have_xkb && xmkeymap==NULL) {
2510 xmkeymap = XGetModifierMapping(spi_get_display ());
2515 case Accessibility_KEY_PRESS:
2516 dec_synth_keycode_press (controller, keycode);
2518 case Accessibility_KEY_PRESSRELEASE:
2519 dec_synth_keycode_press (controller, keycode);
2520 case Accessibility_KEY_RELEASE:
2521 dec_synth_keycode_release (controller, keycode);
2523 case Accessibility_KEY_SYM:
2524 #ifdef SPI_XKB_DEBUG
2525 fprintf (stderr, "KeySym synthesis\n");
2528 * note: we are using long for 'keycode'
2529 * in our arg list; it can contain either
2530 * a keycode or a keysym.
2532 dec_synth_keysym (controller, (KeySym) keycode);
2534 case Accessibility_KEY_STRING:
2535 if (!dec_synth_keystring (controller, keystring))
2536 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2540 if (synth_type == Accessibility_KEY_SYM) {
2544 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2546 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2548 spi_dec_clear_unlatch_pending (controller);
2550 reply = dbus_message_new_method_return (message);
2554 /* Accessibility::DEController::GenerateMouseEvent */
2555 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2561 DBusMessage *reply = NULL;
2563 gboolean err = FALSE;
2564 Display *display = spi_get_display ();
2566 dbus_error_init (&error);
2567 if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2569 return invalid_arguments_error (message);
2573 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2574 eventName, (long int) x, (long int) y);
2576 switch (eventName[0])
2579 switch (eventName[1])
2581 /* TODO: check number of buttons before parsing */
2602 if (x != -1 && y != -1)
2604 XTestFakeMotionEvent (display, DefaultScreen (display),
2607 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2608 if (eventName[2] == 'c')
2609 XTestFakeButtonEvent (display, button, FALSE, 1);
2610 else if (eventName[2] == 'd')
2612 XTestFakeButtonEvent (display, button, FALSE, 1);
2613 XTestFakeButtonEvent (display, button, TRUE, 2);
2614 XTestFakeButtonEvent (display, button, FALSE, 3);
2618 case 'r': /* relative motion */
2619 XTestFakeRelativeMotionEvent (display, x, y, 0);
2621 case 'a': /* absolute motion */
2622 XTestFakeMotionEvent (display, DefaultScreen (display),
2626 reply = dbus_message_new_method_return (message);
2630 /* Accessibility::DEController::NotifyListenersSync */
2631 static DBusMessage *
2632 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2634 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2635 Accessibility_DeviceEvent event;
2637 DBusMessage *reply = NULL;
2639 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2641 return invalid_arguments_error (message);
2644 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2645 controller, (int) event.id);
2647 ret = spi_controller_notify_keylisteners (controller,
2648 (Accessibility_DeviceEvent *)
2651 reply = dbus_message_new_method_return (message);
2654 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2659 static DBusMessage *
2660 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2662 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2663 Accessibility_DeviceEvent event;
2664 DBusMessage *reply = NULL;
2666 if (!spi_dbus_demarshal_deviceEvent(message, &event))
2668 return invalid_arguments_error (message);
2671 g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2672 controller, (int) event.id);
2674 spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2676 reply = dbus_message_new_method_return (message);
2681 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2683 GObjectClass * object_class = (GObjectClass *) klass;
2685 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2687 object_class->finalize = spi_device_event_controller_object_finalize;
2689 if (!spi_dec_private_quark)
2690 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2694 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2700 handle_io (GIOChannel *source,
2701 GIOCondition condition,
2704 SpiDEController *controller = (SpiDEController *) data;
2705 gboolean is_consumed = FALSE;
2708 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2710 if (ev.type == KeyPress || ev.type == KeyRelease)
2711 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2714 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2719 #endif /* HAVE_XEVIE */
2722 spi_device_event_controller_init (SpiDEController *device_event_controller)
2724 spi_events_init (spi_get_display());
2728 #endif /* HAVE_XEVIE */
2730 DEControllerPrivateData *private;
2731 device_event_controller->key_listeners = NULL;
2732 device_event_controller->mouse_listeners = NULL;
2733 device_event_controller->keygrabs_list = NULL;
2734 device_event_controller->xevie_display = NULL;
2737 device_event_controller->xevie_display = XOpenDisplay(NULL);
2739 if (XevieStart(device_event_controller->xevie_display) == TRUE)
2741 #ifdef SPI_KEYEVENT_DEBUG
2742 fprintf (stderr, "XevieStart() success \n");
2744 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2746 fd = ConnectionNumber(device_event_controller->xevie_display);
2747 ioc = g_io_channel_unix_new (fd);
2748 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2749 g_io_channel_unref (ioc);
2753 device_event_controller->xevie_display = NULL;
2754 #ifdef SPI_KEYEVENT_DEBUG
2755 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2758 #endif /* HAVE_XEVIE */
2760 private = g_new0 (DEControllerPrivateData, 1);
2761 gettimeofday (&private->last_press_time, NULL);
2762 gettimeofday (&private->last_release_time, NULL);
2763 g_object_set_qdata (G_OBJECT (device_event_controller),
2764 spi_dec_private_quark,
2766 spi_controller_register_with_devices (device_event_controller);
2767 device_event_controller->message_queue = g_queue_new ();
2768 saved_controller = device_event_controller;
2772 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2773 const XEvent *event)
2775 Accessibility_DeviceEvent key_event;
2778 g_assert (event->type == KeyPress || event->type == KeyRelease);
2780 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2782 if (controller->xevie_display == NULL)
2783 spi_controller_update_key_grabs (controller, &key_event);
2785 /* relay to listeners, and decide whether to consume it or not */
2786 ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2787 g_free(key_event.event_string);
2793 is_key_released (KeyCode code)
2798 XQueryKeymap (spi_get_display (), keys);
2799 down = BIT (keys, code);
2804 check_release (gpointer data)
2807 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2808 KeyCode code = event->hw_code;
2810 released = is_key_released (code);
2814 check_release_handler = 0;
2815 event->type = Accessibility_KEY_RELEASED_EVENT;
2816 spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2818 return (released == 0);
2821 static void wait_for_release_event (XEvent *event,
2822 SpiDEController *controller)
2824 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2825 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2828 /*---------------------------------------------------------------------------*/
2830 static const char *introspection_header =
2831 "<?xml version=\"1.0\"?>\n";
2833 static const char *introspection_node_element =
2834 "<node name=\"%s\">\n";
2836 static const char *introspection_footer =
2839 static DBusMessage *
2840 impl_Introspect (DBusConnection * bus,
2841 DBusMessage * message, void *user_data)
2847 const gchar *pathstr = SPI_DBUS_PATH_DEC;
2851 output = g_string_new(introspection_header);
2853 g_string_append_printf(output, introspection_node_element, pathstr);
2855 g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
2857 g_string_append(output, introspection_footer);
2858 final = g_string_free(output, FALSE);
2860 reply = dbus_message_new_method_return (message);
2861 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
2867 /*---------------------------------------------------------------------------*/
2870 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
2872 const gchar *iface = dbus_message_get_interface (message);
2873 const gchar *member = dbus_message_get_member (message);
2874 const gint type = dbus_message_get_type (message);
2875 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2876 DBusMessage *reply = NULL;
2878 if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
2880 result = DBUS_HANDLER_RESULT_HANDLED;
2881 if (!strcmp (member, "RegisterKeystrokeListener"))
2882 reply = impl_register_keystroke_listener (bus, message, user_data);
2883 else if (!strcmp (member, "RegisterDeviceEventListener"))
2884 reply = impl_register_device_event_listener (bus, message, user_data);
2885 else if (!strcmp (member, "DeregisterKeystrokeListener"))
2886 reply = impl_deregister_keystroke_listener (bus, message, user_data);
2887 else if (!strcmp (member, "DeregisterDeviceEventListener"))
2888 reply = impl_deregister_device_event_listener (bus, message, user_data);
2889 else if (!strcmp (member, "GenerateKeyboardEvent"))
2890 reply = impl_generate_keyboard_event (bus, message, user_data);
2891 else if (!strcmp (member, "GenerateMouseEvent"))
2892 reply = impl_generate_mouse_event (bus, message, user_data);
2893 else if (!strcmp (member, "NotifyListenersSync"))
2894 reply = impl_notify_listeners_sync (bus, message, user_data);
2895 else if (!strcmp (member, "NotifyListenersAsync"))
2896 reply = impl_notify_listeners_async (bus, message, user_data);
2898 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2901 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
2903 result = DBUS_HANDLER_RESULT_HANDLED;
2904 if (!strcmp (member, "Introspect"))
2905 reply = impl_Introspect (bus, message, user_data);
2907 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2910 if (result == DBUS_HANDLER_RESULT_HANDLED)
2914 reply = dbus_message_new_method_return (message);
2917 dbus_connection_send (bus, reply, NULL);
2918 dbus_message_unref (reply);
2923 message_queue_dispatch (gpointer data)
2925 saved_controller->message_queue_idle = 0;
2926 while (!g_queue_is_empty (saved_controller->message_queue))
2928 DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
2929 data = g_queue_pop_head (saved_controller->message_queue);
2930 handle_dec_method_from_idle (saved_controller->bus, message, data);
2931 dbus_message_unref (message);
2936 static DBusHandlerResult
2937 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
2939 const gchar *iface = dbus_message_get_interface (message);
2940 const gchar *member = dbus_message_get_member (message);
2941 const gint type = dbus_message_get_type (message);
2943 /* Check for basic reasons not to handle */
2944 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
2947 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2949 dbus_message_ref (message);
2950 g_queue_push_tail (saved_controller->message_queue, message);
2951 g_queue_push_tail (saved_controller->message_queue, user_data);
2952 if (!saved_controller->message_queue_idle)
2953 saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
2954 return DBUS_HANDLER_RESULT_HANDLED;
2957 static DBusObjectPathVTable dec_vtable =
2961 NULL, NULL, NULL, NULL
2965 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
2967 SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2969 dec->registry = g_object_ref (reg);
2970 reg->dec = g_object_ref (dec);
2973 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
2975 spi_dec_init_mouse_listener (dec);
2981 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
2983 if (!have_mouse_event_listener)
2985 have_mouse_event_listener = TRUE;
2986 if (!have_mouse_listener)
2987 g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
2992 spi_device_event_controller_stop_poll_mouse (void)
2994 have_mouse_event_listener = FALSE;