2009-06-08 Mark Doffman <mark.doffman@codethink.co.uk>
[platform/upstream/at-spi2-core.git] / registryd / deviceeventcontroller.c
1 /* AT-SPI - Assistive Technology Service Provider Interface
2  *
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2001, 2003 Sun Microsystems Inc.,
6  * Copyright 2001, 2002 Ximian, Inc.
7  *
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.
12  *
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.
17  *
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.
22  */
23
24 /* deviceeventcontroller.c: implement the DeviceEventController interface */
25
26 #include <config.h>
27
28 #undef  SPI_XKB_DEBUG
29 #undef  SPI_DEBUG
30 #undef  SPI_KEYEVENT_DEBUG
31
32 #include <string.h>
33 #include <ctype.h>
34 #include <stdio.h>
35 #include <sys/time.h>
36
37 #include <X11/Xlib.h>
38 #include <X11/extensions/XTest.h>
39 #include <X11/XKBlib.h>
40 #define XK_MISCELLANY
41 #define XK_LATIN1
42 #include <X11/keysymdef.h>
43
44 #ifdef HAVE_XEVIE
45 #include <X11/Xproto.h>
46 #include <X11/X.h>
47 #include <X11/extensions/Xevie.h>
48 #endif /* HAVE_XEVIE */
49
50 #include <glib.h>
51 #include <gdk/gdk.h>
52 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
53 #include <gdk/gdkkeysyms.h>
54
55 #include <droute/droute.h>
56
57 #include "paths.h"
58 #include "keymasks.h"
59 #include "de-types.h"
60 #include "de-marshaller.h"
61
62 #include "deviceeventcontroller.h"
63 #include "reentrant-list.h"
64
65 KeySym ucs2keysym (long ucs);
66 long keysym2ucs(KeySym keysym); 
67
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);
74
75 /* Our parent Gtk object type */
76 #define PARENT_TYPE G_TYPE_OBJECT
77
78 /* A pointer to our parent object class */
79 static int spi_error_code = 0;
80 static GdkPoint last_mouse_pos_static = {0, 0}; 
81 static GdkPoint *last_mouse_pos = &last_mouse_pos_static;
82 static unsigned int mouse_mask_state = 0;
83 static unsigned int mouse_button_mask =
84   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
85 static unsigned int key_modifier_mask =
86   Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
87 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
88
89 static GQuark spi_dec_private_quark = 0;
90 static XModifierKeymap* xmkeymap = NULL;
91
92 static gboolean have_mouse_listener = FALSE;
93 static gboolean have_mouse_event_listener = FALSE;
94
95 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
96
97 typedef enum {
98   SPI_DEVICE_TYPE_KBD,
99   SPI_DEVICE_TYPE_MOUSE,
100   SPI_DEVICE_TYPE_LAST_DEFINED
101 } SpiDeviceTypeCategory;
102
103 typedef struct {
104   guint                             ref_count : 30;
105   guint                             pending_add : 1;
106   guint                             pending_remove : 1;
107
108   Accessibility_ControllerEventMask mod_mask;
109   dbus_uint32_t               key_val;  /* KeyCode */
110 } DEControllerGrabMask;
111
112 typedef struct {
113   char *bus_name;
114   char *path;
115   SpiDeviceTypeCategory type;
116   gulong types;
117 } DEControllerListener;
118
119 typedef struct {
120   DEControllerListener listener;
121
122  GSList *keys;
123   Accessibility_ControllerEventMask mask;
124   Accessibility_EventListenerMode  *mode;       
125 } DEControllerKeyListener;
126
127 typedef struct {
128   unsigned int last_press_keycode;
129   unsigned int last_release_keycode;
130   struct timeval last_press_time;
131   struct timeval last_release_time;
132   int have_xkb;
133   int xkb_major_extension_opcode;
134   int xkb_base_event_code;
135   int xkb_base_error_code;
136   unsigned int xkb_latch_mask;
137   unsigned int pending_xkb_mod_relatch_mask;
138   XkbDescPtr xkb_desc;
139   KeyCode reserved_keycode;
140   KeySym reserved_keysym;
141   guint  reserved_reset_timeout;
142 } DEControllerPrivateData;
143
144 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
145 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
146                                                                Accessibility_DeviceEvent *recv);
147 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
148                                                                DEControllerListener      *l);
149 static gboolean spi_device_event_controller_forward_key_event (SpiDEController           *controller,
150                                                                const XEvent              *event);
151 static void     spi_controller_deregister_device_listener (SpiDEController            *controller,
152                                                            DEControllerListener *listener);
153 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
154                                                         DEControllerKeyListener *key_listener);
155 static gboolean spi_controller_notify_mouselisteners (SpiDEController                 *controller,
156                                                       const Accessibility_DeviceEvent *event);
157
158 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
159                                                   const Accessibility_DeviceEvent *event);
160 static gboolean spi_clear_error_state (void);
161 static gboolean spi_dec_poll_mouse_moved (gpointer data);
162 static gboolean spi_dec_poll_mouse_moving (gpointer data);
163 static gboolean spi_dec_poll_mouse_idle (gpointer data);
164
165 #define spi_get_display() GDK_DISPLAY()
166
167 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
168
169 /* Private methods */
170 static dbus_bool_t
171 spi_dbus_add_disconnect_match (DBusConnection *bus, const char *name)
172 {
173   char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
174   if (match)
175   {
176     DBusError error;
177     dbus_error_init (&error);
178     dbus_bus_add_match (bus, match, &error);
179     g_free (match);
180     return !dbus_error_is_set (&error);
181   }
182   else return FALSE;
183 }
184
185 static dbus_bool_t
186 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
187 {
188   char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
189   if (match)
190   {
191     DBusError error;
192     dbus_error_init (&error);
193     dbus_bus_remove_match (bus, match, &error);
194     g_free (match);
195     return !dbus_error_is_set (&error);
196   }
197   else return FALSE;
198 }
199
200 static unsigned int
201 keysym_mod_mask (KeySym keysym, KeyCode keycode)
202 {
203         /* we really should use XKB and look directly at the keymap */
204         /* this is very inelegant */
205         Display *display = spi_get_display ();
206         unsigned int mods_rtn = 0;
207         unsigned int retval = 0;
208         KeySym sym_rtn;
209
210         if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
211             (sym_rtn == keysym)) {
212                 retval = 0;
213         }
214         else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
215                  (sym_rtn == keysym)) {
216                 retval = ShiftMask;
217         }
218         else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
219                  (sym_rtn == keysym)) {
220                 retval = Mod2Mask;
221         }
222         else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
223                  (sym_rtn == keysym)) {
224                 retval = Mod3Mask;
225         }
226         else if (XkbLookupKeySym (display, keycode, 
227                                   ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
228                  (sym_rtn == keysym)) {
229                 retval = (Mod2Mask | ShiftMask);
230         }
231         else if (XkbLookupKeySym (display, keycode, 
232                                   ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
233                  (sym_rtn == keysym)) {
234                 retval = (Mod3Mask | ShiftMask);
235         }
236         else if (XkbLookupKeySym (display, keycode, 
237                                   ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
238                  (sym_rtn == keysym)) {
239                 retval = (Mod4Mask | ShiftMask);
240         }
241         else
242                 retval = 0xFFFF;
243         return retval;
244 }
245
246 static gboolean
247 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
248 {
249 #ifdef HAVE_XKB
250   Display *dpy = spi_get_display ();
251   XkbDescPtr desc;
252   if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
253     {
254       fprintf (stderr, "ERROR getting map\n");
255     }
256   XFlush (dpy);
257   XSync (dpy, False);
258   if (desc && desc->map)
259     {
260       gint offset = desc->map->key_sym_map[keycode].offset;
261       desc->map->syms[offset] = keysym; 
262     }
263   else
264     {
265       fprintf (stderr, "Error changing key map: empty server structure\n");
266     }           
267   XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
268   /**
269    *  FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure, 
270    * would be far preferable.
271    * HOWEVER it does not seem to work using XFree 4.3. 
272    **/
273   /*        XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
274   XFlush (dpy);
275   XSync (dpy, False);
276   XkbFreeKeyboard (desc, 0, TRUE);
277
278   return TRUE;
279 #else
280   return FALSE;
281 #endif
282 }
283
284 static gboolean
285 spi_dec_reset_reserved (gpointer data)
286 {
287   DEControllerPrivateData *priv = data;
288   spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
289   priv->reserved_reset_timeout = 0;
290   return FALSE;
291 }
292
293 static KeyCode
294 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
295 {
296         KeyCode keycode = 0;
297         keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
298         if (!keycode) 
299         {
300                 DEControllerPrivateData *priv = (DEControllerPrivateData *)
301                         g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
302                 /* if there's no keycode available, fix it */
303                 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
304                 {
305                         keycode = priv->reserved_keycode;
306                         /* 
307                          * queue a timer to restore the old keycode.  Ugly, but required 
308                          * due to races / asynchronous X delivery.   
309                          * Long-term fix is to extend the X keymap here instead of replace entries.
310                          */
311                         priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
312                 }               
313                 *modmask = 0;
314                 return keycode;
315         }
316         if (modmask) 
317                 *modmask = keysym_mod_mask (keysym, keycode);
318         return keycode;
319 }
320
321 static DEControllerGrabMask *
322 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
323 {
324   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
325
326   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
327
328   clone->ref_count = 1;
329   clone->pending_add = TRUE;
330   clone->pending_remove = FALSE;
331
332   return clone;
333 }
334
335 static void
336 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
337 {
338   g_free (grab_mask);
339 }
340
341 static gint
342 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
343 {
344   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
345   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
346
347   if (p1 == p2)
348     {
349       return 0;
350     }
351   else
352     { 
353       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
354     }
355 }
356
357 static void
358 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
359 {
360   DEControllerPrivateData *priv = 
361     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
362 #ifdef SPI_XKB_DEBUG
363   if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n", 
364                                      priv->xkb_latch_mask);
365 #endif
366   priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask; 
367 }
368  
369 static void
370 spi_dec_clear_unlatch_pending (SpiDEController *controller)
371 {
372   DEControllerPrivateData *priv = 
373     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
374   priv->xkb_latch_mask = 0;
375 }
376
377 static void emit(SpiDEController *controller, const char *interface, const char *name, int a1, int a2)
378 {
379   DBusMessage *signal = NULL;
380   DBusMessageIter iter, iter_variant;
381   int nil = 0;
382   const char *minor = "";
383   const char *path = SPI_DBUS_PATH_DESKTOP;
384
385   signal = dbus_message_new_signal (path, interface, name);
386
387   dbus_message_iter_init_append (signal, &iter);
388
389   dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
390   dbus_message_iter_append_basic (&iter, DBUS_TYPE_UINT32, &a1);
391   dbus_message_iter_append_basic (&iter, DBUS_TYPE_UINT32, &a2);
392   dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
393       dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
394   dbus_message_iter_close_container (&iter, &iter_variant);
395
396   dbus_connection_send (controller->bus, signal, NULL);
397 }
398
399 static gboolean
400 spi_dec_button_update_and_emit (SpiDEController *controller,
401                                 guint mask_return)
402 {
403   Accessibility_DeviceEvent mouse_e;
404   gchar event_detail[24];
405   gboolean is_consumed = FALSE;
406
407   if ((mask_return & mouse_button_mask) !=
408       (mouse_mask_state & mouse_button_mask)) 
409     {
410       int button_number = 0;
411       gboolean is_down = False;
412       
413       if (!(mask_return & Button1Mask) &&
414           (mouse_mask_state & Button1Mask)) 
415         {
416           mouse_mask_state &= ~Button1Mask;
417           button_number = 1;
418         } 
419       else if ((mask_return & Button1Mask) &&
420                !(mouse_mask_state & Button1Mask)) 
421         {
422           mouse_mask_state |= Button1Mask;
423           button_number = 1;
424           is_down = True;
425         } 
426       else if (!(mask_return & Button2Mask) &&
427                (mouse_mask_state & Button2Mask)) 
428         {
429           mouse_mask_state &= ~Button2Mask;
430           button_number = 2;
431         } 
432       else if ((mask_return & Button2Mask) &&
433                !(mouse_mask_state & Button2Mask)) 
434         {
435           mouse_mask_state |= Button2Mask;
436           button_number = 2;
437           is_down = True;
438         } 
439       else if (!(mask_return & Button3Mask) &&
440                (mouse_mask_state & Button3Mask)) 
441         {
442           mouse_mask_state &= ~Button3Mask;
443           button_number = 3;
444         } 
445       else if ((mask_return & Button3Mask) &&
446                !(mouse_mask_state & Button3Mask)) 
447         {
448           mouse_mask_state |= Button3Mask;
449           button_number = 3;
450           is_down = True;
451         } 
452       else if (!(mask_return & Button4Mask) &&
453                (mouse_mask_state & Button4Mask)) 
454         {
455           mouse_mask_state &= ~Button4Mask;
456           button_number = 4;
457         } 
458       else if ((mask_return & Button4Mask) &&
459                !(mouse_mask_state & Button4Mask)) 
460         {
461           mouse_mask_state |= Button4Mask;
462           button_number = 4;
463           is_down = True;
464         } 
465       else if (!(mask_return & Button5Mask) &&
466                (mouse_mask_state & Button5Mask)) 
467         {
468           mouse_mask_state &= ~Button5Mask;
469           button_number = 5;
470         }
471       else if ((mask_return & Button5Mask) &&
472                !(mouse_mask_state & Button5Mask)) 
473         {
474           mouse_mask_state |= Button5Mask;
475           button_number = 5;
476           is_down = True;
477         }
478       if (button_number) {
479 #ifdef SPI_DEBUG                  
480         fprintf (stderr, "Button %d %s\n",
481                  button_number, (is_down) ? "Pressed" : "Released");
482 #endif
483         snprintf (event_detail, 22, "%d%c", button_number,
484                   (is_down) ? 'p' : 'r');
485         /* TODO: FIXME distinguish between physical and 
486          * logical buttons 
487          */
488         mouse_e.type      = (is_down) ? 
489           Accessibility_BUTTON_PRESSED_EVENT :
490           Accessibility_BUTTON_RELEASED_EVENT;
491         mouse_e.id        = button_number;
492         mouse_e.hw_code   = button_number;
493         mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state; 
494         mouse_e.timestamp = 0;
495         mouse_e.event_string = "";
496         mouse_e.is_text   = FALSE;
497         is_consumed = 
498           spi_controller_notify_mouselisteners (controller, 
499                                                 &mouse_e);
500         if (!is_consumed)
501           {
502             dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
503             emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "button", x, y);
504           }
505         else
506           spi_dec_set_unlatch_pending (controller, mask_return);
507       }
508       return TRUE;
509     }
510   else
511     {
512       return FALSE;
513     }
514 }
515
516
517 static guint
518 spi_dec_mouse_check (SpiDEController *controller, 
519                      int *x, int *y, gboolean *moved)
520 {
521   int win_x_return,win_y_return;
522   unsigned int mask_return;
523   Window root_return, child_return;
524   Display *display = spi_get_display ();
525
526   if (display != NULL)
527     XQueryPointer(display, DefaultRootWindow (display),
528                   &root_return, &child_return,
529                   x, y,
530                   &win_x_return, &win_y_return, &mask_return);
531   /* 
532    * Since many clients grab the pointer, and X goes an automatic
533    * pointer grab on mouse-down, we often must detect mouse button events
534    * by polling rather than via a button grab. 
535    * The while loop (rather than if) is used since it's possible that 
536    * multiple buttons have changed state since we last checked.
537    */
538   if (mask_return != mouse_mask_state) 
539     {
540       while (spi_dec_button_update_and_emit (controller, mask_return));
541     }
542
543   if (*x != last_mouse_pos->x || *y != last_mouse_pos->y) 
544     {
545       // TODO: combine these two signals?
546       dbus_uint32_t ix = *x, iy = *y;
547       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "abs", ix, iy);
548       ix -= last_mouse_pos->x;
549       iy -= last_mouse_pos->y;
550       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "rel", ix, iy);
551       last_mouse_pos->x = *x;
552       last_mouse_pos->y = *y;
553       *moved = True;
554     }
555   else
556     {
557       *moved = False;
558     }
559
560   return mask_return;
561 }
562
563 static void
564 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask, 
565                              guint current_mask)
566 {
567   dbus_uint32_t d1, d2;
568
569 #ifdef SPI_XKB_DEBUG
570   fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n", 
571            prev_mask, current_mask);
572 #endif
573
574   /* set bits for the virtual modifiers like NUMLOCK */
575   if (prev_mask & _numlock_physical_mask) 
576     prev_mask |= SPI_KEYMASK_NUMLOCK;
577   if (current_mask & _numlock_physical_mask) 
578     current_mask |= SPI_KEYMASK_NUMLOCK;
579
580   d1 = prev_mask & key_modifier_mask;
581   d2 = current_mask & key_modifier_mask;
582       emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "modifiers", d1, d2);
583 }
584
585 static gboolean
586 spi_dec_poll_mouse_moved (gpointer data)
587 {
588   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
589   int x, y;
590   gboolean moved;
591   guint mask_return;
592
593   mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
594
595   if ((mask_return & key_modifier_mask) !=
596       (mouse_mask_state & key_modifier_mask)) 
597     {
598       spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
599       mouse_mask_state = mask_return;
600     }
601
602   return moved;
603 }
604
605 static gboolean
606 spi_dec_poll_mouse_idle (gpointer data)
607 {
608   if (!have_mouse_event_listener && !have_mouse_listener)
609     return FALSE;
610   else if (!spi_dec_poll_mouse_moved (data))
611     return TRUE;
612   else
613     {
614       g_timeout_add (20, spi_dec_poll_mouse_moving, data);          
615       return FALSE;         
616     }
617 }
618
619 static gboolean
620 spi_dec_poll_mouse_moving (gpointer data)
621 {
622   if (!have_mouse_event_listener && !have_mouse_listener)
623     return FALSE;
624   else if (spi_dec_poll_mouse_moved (data))
625     return TRUE;
626   else
627     {
628       g_timeout_add (100, spi_dec_poll_mouse_idle, data);           
629       return FALSE;
630     }
631 }
632
633 #ifdef WE_NEED_UGRAB_MOUSE
634 static int
635 spi_dec_ungrab_mouse (gpointer data)
636 {
637         Display *display = spi_get_display ();
638         if (display)
639           {
640             XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
641                            XDefaultRootWindow (spi_get_display ()));
642           }
643         return FALSE;
644 }
645 #endif
646
647 static void
648 spi_dec_init_mouse_listener (SpiDEController *dec)
649 {
650 #ifdef GRAB_BUTTON
651   Display *display = spi_get_display ();
652
653   if (display)
654     {
655       if (XGrabButton (display, AnyButton, AnyModifier,
656                        gdk_x11_get_default_root_xwindow (),
657                        True, ButtonPressMask | ButtonReleaseMask,
658                        GrabModeSync, GrabModeAsync, None, None) != Success) {
659 #ifdef SPI_DEBUG
660         fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
661 #endif
662         ;
663       }
664       XSync (display, False);
665 #ifdef SPI_DEBUG
666       fprintf (stderr, "mouse buttons grabbed\n");
667 #endif
668     }
669 #endif
670 }
671
672 /**
673  * Eventually we can use this to make the marshalling of mask types
674  * more sane, but for now we just use this to detect 
675  * the use of 'virtual' masks such as numlock and convert them to
676  * system-specific mask values (i.e. ModMask).
677  * 
678  **/
679 static Accessibility_ControllerEventMask
680 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
681 {
682   Accessibility_ControllerEventMask tmp_mask;
683   gboolean has_numlock;
684
685   has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
686   tmp_mask = mask;
687   if (has_numlock)
688     {
689       tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
690       tmp_mask |= _numlock_physical_mask;
691     }
692  
693   return tmp_mask;
694 }
695
696 static DEControllerKeyListener *
697 spi_dec_key_listener_new (const char *bus_name,
698                           const char *path,
699                           GSList *keys,
700                           const Accessibility_ControllerEventMask mask,
701                           const dbus_uint32_t types,
702                           const Accessibility_EventListenerMode  *mode)
703 {
704   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
705   key_listener->listener.bus_name = g_strdup(bus_name);
706   key_listener->listener.path = g_strdup(path);
707   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
708   key_listener->keys = keys;
709   key_listener->mask = spi_dec_translate_mask (mask);
710   key_listener->listener.types = types;
711   if (mode)
712   {
713     key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
714     memcpy(key_listener->mode, mode, sizeof(*mode));
715   }
716   else
717     key_listener->mode = NULL;
718
719 #ifdef SPI_DEBUG
720   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
721            (unsigned int) key_listener->mask,
722            (int) (mode ? mode->global : 0),
723            (void *) key_listener->keys,
724            (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
725 #endif
726
727   return key_listener;  
728 }
729
730 static DEControllerListener *
731 spi_dec_listener_new (const char *bus_name,
732                       const char *path,
733                       dbus_uint32_t types)
734 {
735   DEControllerListener *listener = g_new0 (DEControllerListener, 1);
736   listener->bus_name = g_strdup(bus_name);
737   listener->path = g_strdup(path);
738   listener->type = SPI_DEVICE_TYPE_MOUSE;
739   listener->types = types;
740   return listener;      
741 }
742
743 static DEControllerListener *
744 spi_listener_clone (DEControllerListener *listener)
745 {
746   DEControllerListener *clone = g_new0 (DEControllerListener, 1);
747   clone->bus_name = g_strdup (listener->bus_name);
748   clone->path = g_strdup (listener->path);
749   clone->type = listener->type;
750   clone->types = listener->types;
751   return clone;
752 }
753
754 static GSList *keylist_clone (GSList *s)
755 {
756   GSList *d = NULL;
757   GSList *l;
758
759   for (l = s; l; l = g_slist_next(l))
760   {
761     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
762     if (kd)
763     {
764       Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
765       kd->keycode = kds->keycode;
766       kd->keysym = kds->keysym;
767       kd->keystring = g_strdup(kds->keystring);
768       d = g_slist_append(d, kd);
769     }
770   }
771   return d;
772 }
773
774 static DEControllerKeyListener *
775 spi_key_listener_clone (DEControllerKeyListener *key_listener)
776 {
777   DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
778   clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
779   clone->listener.path = g_strdup (key_listener->listener.path);
780   clone->listener.type = SPI_DEVICE_TYPE_KBD;
781   clone->keys = keylist_clone (key_listener->keys);
782   clone->mask = key_listener->mask;
783   clone->listener.types = key_listener->listener.types;
784   if (key_listener->mode)
785   {
786     clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
787     if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
788   }
789   else
790     clone->mode = NULL;
791   return clone;
792 }
793
794 static void keylist_free(GSList *keys)
795 {
796   GSList *l;
797
798   for (l = keys; l; l = g_slist_next(l))
799   {
800     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
801     g_free(kd->keystring);
802     g_free(kd);
803   }
804   g_slist_free (keys);
805 }
806
807 static void
808 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
809 {
810   keylist_free(key_listener->keys);
811   if (key_listener->mode) g_free(key_listener->mode);
812   g_free (key_listener);
813 }
814
815 static void
816 spi_key_listener_clone_free (DEControllerKeyListener *clone)
817 {
818   spi_key_listener_data_free (clone);
819 }
820
821 static void
822 spi_listener_clone_free (DEControllerListener *clone)
823 {
824   g_free (clone->path);
825   g_free (clone->bus_name);
826   g_free (clone);
827 }
828
829 static void
830 spi_dec_listener_free (DEControllerListener    *listener)
831 {
832   g_free (listener->bus_name);
833   g_free (listener->path);
834   if (listener->type == SPI_DEVICE_TYPE_KBD) 
835     spi_key_listener_data_free ((DEControllerKeyListener *) listener);
836 }
837
838 static void
839 _register_keygrab (SpiDEController      *controller,
840                    DEControllerGrabMask *grab_mask)
841 {
842   GList *l;
843
844   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
845                           spi_grab_mask_compare_values);
846   if (l)
847     {
848       DEControllerGrabMask *cur_mask = l->data;
849
850       cur_mask->ref_count++;
851       if (cur_mask->pending_remove)
852         {
853           cur_mask->pending_remove = FALSE;
854         }
855     }
856   else
857     {
858       controller->keygrabs_list =
859         g_list_prepend (controller->keygrabs_list,
860                         spi_grab_mask_clone (grab_mask));
861     }
862 }
863
864 static void
865 _deregister_keygrab (SpiDEController      *controller,
866                      DEControllerGrabMask *grab_mask)
867 {
868   GList *l;
869
870   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
871                           spi_grab_mask_compare_values);
872
873   if (l)
874     {
875       DEControllerGrabMask *cur_mask = l->data;
876
877       cur_mask->ref_count--;
878       if (cur_mask->ref_count <= 0)
879         {
880           cur_mask->pending_remove = TRUE;
881         }
882     }
883 }
884
885 static void
886 handle_keygrab (SpiDEController         *controller,
887                 DEControllerKeyListener *key_listener,
888                 void                   (*process_cb) (SpiDEController *controller,
889                                                       DEControllerGrabMask *grab_mask))
890 {
891   DEControllerGrabMask grab_mask = { 0 };
892
893   grab_mask.mod_mask = key_listener->mask;
894   if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
895     {
896       grab_mask.key_val = AnyKey;
897 #ifdef SPI_DEBUG
898       fprintf (stderr, "AnyKey grab!");
899 #endif
900       process_cb (controller, &grab_mask);
901     }
902   else
903     {
904       GSList *l;
905
906       for (l = key_listener->keys; l; l = g_slist_next(l))
907         {
908           Accessibility_KeyDefinition *keydef = l->data;
909           long int key_val = keydef->keysym;
910           /* X Grabs require keycodes, not keysyms */
911           if (keydef->keystring && keydef->keystring[0])
912             {
913               key_val = XStringToKeysym(keydef->keystring);                 
914             }
915           if (key_val > 0)
916             {
917               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
918             }
919           else
920             {
921               key_val = keydef->keycode;
922             }
923           grab_mask.key_val = key_val;
924           process_cb (controller, &grab_mask);
925         }
926     }
927 }
928
929 static gboolean
930 spi_controller_register_global_keygrabs (SpiDEController         *controller,
931                                          DEControllerKeyListener *key_listener)
932 {
933   handle_keygrab (controller, key_listener, _register_keygrab);
934   if (controller->xevie_display == NULL)
935     return spi_controller_update_key_grabs (controller, NULL);
936   else
937     return TRUE;
938 }
939
940 static void
941 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
942                                            DEControllerKeyListener *key_listener)
943 {
944   handle_keygrab (controller, key_listener, _deregister_keygrab);
945   if (controller->xevie_display == NULL)
946     spi_controller_update_key_grabs (controller, NULL);
947 }
948
949 static gboolean
950 spi_controller_register_device_listener (SpiDEController      *controller,
951                                          DEControllerListener *listener)
952 {
953   DEControllerKeyListener *key_listener;
954   
955   switch (listener->type) {
956   case SPI_DEVICE_TYPE_KBD:
957       key_listener = (DEControllerKeyListener *) listener;
958
959       controller->key_listeners = g_list_prepend (controller->key_listeners,
960                                                   key_listener);
961       spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
962       if (key_listener->mode->global)
963         {
964           return spi_controller_register_global_keygrabs (controller, key_listener);    
965         }
966       else
967               return TRUE;
968       break;
969   case SPI_DEVICE_TYPE_MOUSE:
970       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
971       if (!have_mouse_listener)
972         {
973           have_mouse_listener = TRUE;
974           if (!have_mouse_event_listener)
975             g_timeout_add (100, spi_dec_poll_mouse_idle, controller->registry);
976         }
977       spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
978       break;
979   default:
980       break;
981   }
982   return FALSE;
983 }
984
985 static gboolean
986 Accessibility_DeviceEventListener_notifyEvent(SpiDEController *controller,
987                                               SpiRegistry *registry,
988                                               DEControllerListener *listener,
989                                               const Accessibility_DeviceEvent *key_event)
990 {
991   DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
992                                                       listener->path,
993                                                       SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
994                                                       "notifyEvent");
995   DBusError error;
996   dbus_bool_t consumed = FALSE;
997
998   dbus_error_init(&error);
999   if (spi_dbus_marshal_deviceEvent(message, key_event))
1000   {
1001     // TODO: Evaluate performance: perhaps rework this whole architecture
1002     // to avoid blocking calls
1003     DBusMessage *reply = dbus_connection_send_with_reply_and_block(controller->bus, message, 1000, &error);
1004     if (reply)
1005     {
1006       DBusError error;
1007       dbus_error_init(&error);
1008       dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1009       dbus_message_unref(reply);
1010     }
1011   }
1012   dbus_message_unref(message);
1013   return consumed;
1014 }
1015
1016 static gboolean
1017 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
1018                                       const Accessibility_DeviceEvent *event)
1019 {
1020   GList   *l;
1021   GSList  *notify = NULL, *l2;
1022   GList  **listeners = &controller->mouse_listeners;
1023   gboolean is_consumed;
1024 #ifdef SPI_KEYEVENT_DEBUG
1025   gboolean found = FALSE;
1026 #endif
1027   if (!listeners)
1028     {
1029       return FALSE;
1030     }
1031
1032   for (l = *listeners; l; l = l->next)
1033     {
1034        DEControllerListener *listener = l->data;
1035
1036        if (spi_eventtype_seq_contains_event (listener->types, event))
1037          {
1038            /* we clone (don't dup) the listener, to avoid refcount inc. */
1039            notify = g_slist_prepend (notify,
1040                                      spi_listener_clone (listener));
1041 #ifdef SPI_KEYEVENT_DEBUG
1042            found = TRUE;
1043 #endif
1044          }
1045     }
1046
1047 #ifdef SPI_KEYEVENT_DEBUG
1048   if (!found)
1049     {
1050       g_print ("no match for event\n");
1051     }
1052 #endif
1053
1054   is_consumed = FALSE;
1055   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1056     {
1057       DEControllerListener *listener = l2->data;
1058
1059       is_consumed = Accessibility_DeviceEventListener_notifyEvent (controller, controller->registry, listener, event);
1060
1061       spi_listener_clone_free ((DEControllerListener *) l2->data);
1062     }
1063
1064   for (; l2; l2 = l2->next)
1065     {
1066       DEControllerListener *listener = l2->data;
1067       spi_listener_clone_free (listener);
1068       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1069     }
1070
1071   g_slist_free (notify);
1072
1073 #ifdef SPI_DEBUG
1074   if (is_consumed) g_message ("consumed\n");
1075 #endif
1076   return is_consumed;
1077 }
1078
1079 static void
1080 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1081                                                  XEvent *xevent)
1082 {
1083   Accessibility_DeviceEvent mouse_e;
1084   gchar event_detail[24];
1085   gboolean is_consumed = FALSE;
1086   gboolean xkb_mod_unlatch_occurred;
1087   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1088   dbus_uint32_t ix, iy;
1089
1090   int button = xbutton_event->button;
1091   
1092   unsigned int mouse_button_state = xbutton_event->state;
1093
1094   switch (button)
1095     {
1096     case 1:
1097             mouse_button_state |= Button1Mask;
1098             break;
1099     case 2:
1100             mouse_button_state |= Button2Mask;
1101             break;
1102     case 3:
1103             mouse_button_state |= Button3Mask;
1104             break;
1105     case 4:
1106             mouse_button_state |= Button4Mask;
1107             break;
1108     case 5:
1109             mouse_button_state |= Button5Mask;
1110             break;
1111     }
1112
1113   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1114   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1115
1116 #ifdef SPI_DEBUG  
1117   fprintf (stderr, "mouse button %d %s (%x)\n",
1118            xbutton_event->button, 
1119            (xevent->type == ButtonPress) ? "Press" : "Release",
1120            mouse_button_state);
1121 #endif
1122   snprintf (event_detail, 22, "%d%c", button,
1123             (xevent->type == ButtonPress) ? 'p' : 'r');
1124
1125   /* TODO: FIXME distinguish between physical and logical buttons */
1126   mouse_e.type      = (xevent->type == ButtonPress) ? 
1127                       Accessibility_BUTTON_PRESSED_EVENT :
1128                       Accessibility_BUTTON_RELEASED_EVENT;
1129   mouse_e.id        = button;
1130   mouse_e.hw_code   = button;
1131   mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1132   mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1133   mouse_e.event_string = "";
1134   mouse_e.is_text   = FALSE;
1135   if ((mouse_button_state & mouse_button_mask) != 
1136        (mouse_mask_state & mouse_button_mask))
1137     { 
1138       if ((mouse_mask_state & key_modifier_mask) !=
1139           (mouse_button_state & key_modifier_mask))
1140         spi_dec_emit_modifier_event (controller, 
1141                                      mouse_mask_state, mouse_button_state);
1142       mouse_mask_state = mouse_button_state;
1143       is_consumed = 
1144         spi_controller_notify_mouselisteners (controller, &mouse_e);
1145       ix = last_mouse_pos->x;
1146       iy = last_mouse_pos->y;
1147       /* TODO - Work out which part of the spec this emit is fulfilling */
1148       //emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "button", event_detail, ix, iy);
1149     }
1150
1151   xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1152                               xevent->type == ButtonRelease);
1153   
1154   /* if client wants to consume this event, and XKB latch state was
1155    *   unset by this button event, we reset it
1156    */
1157   if (is_consumed && xkb_mod_unlatch_occurred)
1158     spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1159   
1160   XAllowEvents (spi_get_display (),
1161                 (is_consumed) ? SyncPointer : ReplayPointer,
1162                 CurrentTime);
1163 }
1164
1165 static GdkFilterReturn
1166 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
1167 {
1168   XEvent *xevent = gdk_xevent;
1169   SpiDEController *controller;
1170   DEControllerPrivateData *priv;
1171   Display *display = spi_get_display ();
1172   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1173   priv = (DEControllerPrivateData *)
1174           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);  
1175
1176   if (xevent->type == MappingNotify)
1177     xmkeymap = NULL;
1178
1179   if (xevent->type == KeyPress || xevent->type == KeyRelease)
1180     {
1181       if (controller->xevie_display == NULL)
1182         {
1183           gboolean is_consumed;
1184
1185           is_consumed =
1186             spi_device_event_controller_forward_key_event (controller, xevent);
1187
1188           if (is_consumed)
1189             {
1190               int n_events;
1191               int i;
1192               XEvent next_event;
1193               n_events = XPending (display);
1194
1195 #ifdef SPI_KEYEVENT_DEBUG
1196               g_print ("Number of events pending: %d\n", n_events);
1197 #endif
1198               for (i = 0; i < n_events; i++)
1199                 {
1200                   XNextEvent (display, &next_event);
1201                   if (next_event.type != KeyPress &&
1202                       next_event.type != KeyRelease)
1203                         g_warning ("Unexpected event type %d in queue", next_event.type);
1204                  }
1205
1206               XAllowEvents (display, AsyncKeyboard, CurrentTime);
1207               if (n_events)
1208                 XUngrabKeyboard (display, CurrentTime);
1209             }
1210           else
1211             {
1212               if (xevent->type == KeyPress)
1213                 wait_for_release_event (xevent, controller);
1214               XAllowEvents (display, ReplayKeyboard, CurrentTime);
1215             }
1216         }
1217
1218       return GDK_FILTER_CONTINUE;
1219     }
1220   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1221     {
1222       spi_device_event_controller_forward_mouse_event (controller, xevent);
1223     }
1224   if (xevent->type == priv->xkb_base_event_code)
1225     {
1226       XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1227       /* ugly but probably necessary...*/
1228       XSynchronize (display, TRUE);
1229
1230       if (xkb_ev->xkb_type == XkbStateNotify)
1231         {
1232           XkbStateNotifyEvent *xkb_snev =
1233                   (XkbStateNotifyEvent *) xkb_ev;
1234           /* check the mouse, to catch mouse events grabbed by
1235            * another client; in case we should revert this XKB delatch 
1236            */
1237           if (!priv->pending_xkb_mod_relatch_mask)
1238             {
1239               int x, y;
1240               gboolean moved;
1241               spi_dec_mouse_check (controller, &x, &y, &moved);
1242             }
1243           /* we check again, since the previous call may have 
1244              changed this flag */
1245           if (priv->pending_xkb_mod_relatch_mask)
1246             {
1247               unsigned int feedback_mask;
1248 #ifdef SPI_XKB_DEBUG
1249               fprintf (stderr, "relatching %x\n",
1250                        priv->pending_xkb_mod_relatch_mask);
1251 #endif
1252               /* temporarily turn off the latch bell, if it's on */
1253               XkbGetControls (display,
1254                               XkbAccessXFeedbackMask,
1255                               priv->xkb_desc);
1256               feedback_mask = priv->xkb_desc->ctrls->ax_options;
1257               if (feedback_mask & XkbAX_StickyKeysFBMask)
1258               {
1259                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1260                                                  0, False};      
1261                 priv->xkb_desc->ctrls->ax_options
1262                               &= ~(XkbAX_StickyKeysFBMask);
1263                 XkbChangeControls (display, priv->xkb_desc, &changes);
1264               }
1265               /* TODO: account for lock as well as latch */
1266               XkbLatchModifiers (display,
1267                                  XkbUseCoreKbd,
1268                                  priv->pending_xkb_mod_relatch_mask,
1269                                  priv->pending_xkb_mod_relatch_mask);
1270               if (feedback_mask & XkbAX_StickyKeysFBMask)
1271               { 
1272                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1273                                                  0, False};      
1274                 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1275                 XkbChangeControls (display, priv->xkb_desc, &changes);
1276               }
1277 #ifdef SPI_XKB_DEBUG
1278               fprintf (stderr, "relatched %x\n",
1279                        priv->pending_xkb_mod_relatch_mask);
1280 #endif
1281               priv->pending_xkb_mod_relatch_mask = 0;
1282             }
1283           else
1284             {
1285               priv->xkb_latch_mask = xkb_snev->latched_mods;
1286             }
1287         }
1288       XSynchronize (display, FALSE);
1289     }
1290   
1291   return GDK_FILTER_CONTINUE;
1292 }
1293
1294 static int
1295 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1296 {
1297   if (error->error_code == BadAccess) 
1298     {  
1299       g_message ("Could not complete key grab: grab already in use.\n");
1300       spi_error_code = BadAccess;
1301       return 0;
1302     }
1303   else 
1304     {
1305       return (*x_default_error_handler) (display, error);
1306     }
1307 }
1308
1309 static void
1310 spi_controller_register_with_devices (SpiDEController *controller)
1311 {
1312   DEControllerPrivateData *priv;
1313   int event_base, error_base, major_version, minor_version;
1314
1315   priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1316   if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1317     {
1318       XTestGrabControl (spi_get_display (), True);
1319     }
1320
1321   /* calls to device-specific implementations and routines go here */
1322   /* register with: keyboard hardware code handler */
1323   /* register with: (translated) keystroke handler */
1324
1325   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1326                                       &priv->xkb_major_extension_opcode,
1327                                       &priv->xkb_base_event_code,
1328                                       &priv->xkb_base_error_code, NULL, NULL);
1329   if (priv->have_xkb)
1330     {
1331       gint i;
1332       guint64 reserved = 0;
1333       priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1334       XkbSelectEvents (spi_get_display (),
1335                        XkbUseCoreKbd,
1336                        XkbStateNotifyMask, XkbStateNotifyMask);     
1337       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (), 
1338                                                      XK_Num_Lock);
1339       for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1340       {
1341           if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1342           { 
1343               if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1344               {
1345                   /* don't use this one if there's a grab client! */
1346                   gdk_error_trap_push ();
1347                   XGrabKey (spi_get_display (), i, 0, 
1348                             gdk_x11_get_default_root_xwindow (),
1349                             TRUE,
1350                             GrabModeSync, GrabModeSync);
1351                   XSync (spi_get_display (), TRUE);
1352                   XUngrabKey (spi_get_display (), i, 0, 
1353                               gdk_x11_get_default_root_xwindow ());
1354                   if (!gdk_error_trap_pop ())
1355                   {
1356                       reserved = i;
1357                       break;
1358                   }
1359               }
1360           }
1361       }
1362       if (reserved) 
1363       {
1364           priv->reserved_keycode = reserved;
1365           priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1366       }
1367       else
1368       { 
1369           priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1370           priv->reserved_keysym = XK_numbersign;
1371       }
1372 #ifdef SPI_RESERVED_DEBUG
1373       unsigned sym = 0;
1374       sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1375       fprintf (stderr, "%x\n", sym);
1376       fprintf (stderr, "setting the reserved keycode to %d (%s)\n", 
1377                reserved, 
1378                XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1379                                                             reserved, 0)));
1380 #endif
1381     }   
1382
1383   gdk_window_add_filter (NULL, global_filter_fn, controller);
1384
1385   gdk_window_set_events (gdk_get_default_root_window (),
1386                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
1387
1388   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1389 }
1390
1391 static gboolean
1392 spi_key_set_contains_key (GSList                          *key_set,
1393                           const Accessibility_DeviceEvent *key_event)
1394 {
1395   gint i;
1396   gint len;
1397   GSList *l;
1398
1399   if (!key_set)
1400     {
1401 #ifdef SPI_DEBUG
1402       g_print ("null key set!\n");
1403 #endif
1404       return TRUE;
1405     }
1406
1407   len = g_slist_length (key_set);
1408   
1409   if (len == 0) /* special case, means "all keys/any key" */
1410     {
1411 #ifdef SPI_DEBUG
1412       g_print ("anykey\n");         
1413 #endif
1414       return TRUE;
1415     }
1416
1417   for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1418     {
1419       Accessibility_KeyDefinition *kd = l->data;
1420 #ifdef SPI_KEYEVENT_DEBUG           
1421       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1422                 i,
1423                 (int) kd->keysym,
1424                 (int) kd->keycode,
1425                 (int) key_event->id,
1426                 (int) key_event->hw_code,
1427                 key_event->event_string); 
1428 #endif
1429       if (kd->keysym == (dbus_uint32_t) key_event->id)
1430         {
1431           return TRUE;
1432         }
1433       if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1434         {
1435           return TRUE;
1436         }
1437       if (key_event->event_string && key_event->event_string[0] &&
1438           !strcmp (kd->keystring, key_event->event_string))
1439         {
1440           return TRUE;
1441         }
1442     }
1443
1444   return FALSE;
1445 }
1446
1447 static gboolean
1448 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1449                                   const Accessibility_DeviceEvent *event)
1450 {
1451   if (types == 0) /* special case, means "all events/any event" */
1452     {
1453       return TRUE;
1454     }
1455
1456   return (types & (1 << event->type));
1457 }
1458
1459 static gboolean
1460 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1461                                 DEControllerKeyListener         *listener,
1462                                 dbus_bool_t                    is_system_global)
1463 {
1464   if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1465        spi_key_set_contains_key (listener->keys, key_event) &&
1466        spi_eventtype_seq_contains_event (listener->listener.types, key_event) && 
1467       (is_system_global == listener->mode->global))
1468     {
1469       return TRUE;
1470     }
1471   else
1472     {
1473       return FALSE;
1474     }
1475 }
1476
1477 static gboolean
1478 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1479                                     Accessibility_DeviceEvent       *key_event,
1480                                     dbus_bool_t                    is_system_global)
1481 {
1482   GList   *l;
1483   GSList  *notify = NULL, *l2;
1484   GList  **key_listeners = &controller->key_listeners;
1485   gboolean is_consumed;
1486
1487   if (!key_listeners)
1488     {
1489       return FALSE;
1490     }
1491
1492   /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1493   if (key_event->modifiers & _numlock_physical_mask)
1494       key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1495
1496   for (l = *key_listeners; l; l = l->next)
1497     {
1498        DEControllerKeyListener *key_listener = l->data;
1499
1500        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1501          {
1502            /* we clone (don't dup) the listener, to avoid refcount inc. */
1503            notify = g_slist_prepend (notify,
1504                                      spi_key_listener_clone (key_listener));
1505          }
1506     }
1507
1508 #ifdef SPI_KEYEVENT_DEBUG
1509   if (!notify)
1510     {
1511       g_print ("no match for event\n");
1512     }
1513 #endif
1514
1515   is_consumed = FALSE;
1516   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1517     {
1518       DEControllerKeyListener *key_listener = l2->data;     
1519
1520       is_consumed = Accessibility_DeviceEventListener_notifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1521                     key_listener->mode->preemptive;
1522
1523       spi_key_listener_clone_free (key_listener);
1524     }
1525
1526   for (; l2; l2 = l2->next)
1527     {
1528       DEControllerKeyListener *key_listener = l2->data;     
1529       spi_key_listener_clone_free (key_listener);
1530       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1531     }
1532
1533   g_slist_free (notify);
1534
1535 #ifdef SPI_DEBUG
1536   if (is_consumed) g_message ("consumed\n");
1537 #endif
1538   return is_consumed;
1539 }
1540
1541 static gboolean
1542 spi_clear_error_state (void)
1543 {
1544         gboolean retval = spi_error_code != 0;
1545         spi_error_code = 0;
1546         return retval;
1547 }
1548
1549 static Accessibility_DeviceEvent
1550 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1551 {
1552   Accessibility_DeviceEvent key_event;
1553   KeySym keysym;
1554   const int cbuf_bytes = 20;
1555   char cbuf [21];
1556   int nbytes;
1557
1558   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);  
1559   key_event.id = (dbus_int32_t)(keysym);
1560   key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1561   if (((XEvent *) x_key_event)->type == KeyPress)
1562     {
1563       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1564     }
1565   else
1566     {
1567       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1568     } 
1569   key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1570   key_event.is_text = FALSE;
1571   switch (keysym)
1572     {
1573       case ' ':
1574         key_event.event_string = g_strdup ("space");
1575         break;
1576       case XK_Tab:
1577         key_event.event_string = g_strdup ("Tab");
1578         break;
1579       case XK_BackSpace:
1580         key_event.event_string = g_strdup ("Backspace");
1581         break;
1582       case XK_Return:
1583         key_event.event_string = g_strdup ("Return");
1584         break;
1585       case XK_Home:
1586         key_event.event_string = g_strdup ("Home");
1587         break;
1588       case XK_Page_Down:
1589         key_event.event_string = g_strdup ("Page_Down");
1590         break;
1591       case XK_Page_Up:
1592         key_event.event_string = g_strdup ("Page_Up");
1593         break;
1594       case XK_F1:
1595         key_event.event_string = g_strdup ("F1");
1596         break;
1597       case XK_F2:
1598         key_event.event_string = g_strdup ("F2");
1599         break;
1600       case XK_F3:
1601         key_event.event_string = g_strdup ("F3");
1602         break;
1603       case XK_F4:
1604         key_event.event_string = g_strdup ("F4");
1605         break;
1606       case XK_F5:
1607         key_event.event_string = g_strdup ("F5");
1608         break;
1609       case XK_F6:
1610         key_event.event_string = g_strdup ("F6");
1611         break;
1612       case XK_F7:
1613         key_event.event_string = g_strdup ("F7");
1614         break;
1615       case XK_F8:
1616         key_event.event_string = g_strdup ("F8");
1617         break;
1618       case XK_F9:
1619         key_event.event_string = g_strdup ("F9");
1620         break;
1621       case XK_F10:
1622         key_event.event_string = g_strdup ("F10");
1623         break;
1624       case XK_F11:
1625         key_event.event_string = g_strdup ("F11");
1626         break;
1627       case XK_F12:
1628         key_event.event_string = g_strdup ("F12");
1629         break;
1630       case XK_End:
1631         key_event.event_string = g_strdup ("End");
1632         break;
1633       case XK_Escape:
1634         key_event.event_string = g_strdup ("Escape");
1635         break;
1636       case XK_Up:
1637         key_event.event_string = g_strdup ("Up");
1638         break;
1639       case XK_Down:
1640         key_event.event_string = g_strdup ("Down");
1641         break;
1642       case XK_Left:
1643         key_event.event_string = g_strdup ("Left");
1644         break;
1645       case XK_Right:
1646         key_event.event_string = g_strdup ("Right");
1647         break;
1648       default:
1649         if (nbytes > 0)
1650           {
1651             gunichar c;
1652             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1653             key_event.event_string = g_strdup (cbuf);
1654             c = keysym2ucs (keysym);
1655             if (c > 0 && !g_unichar_iscntrl (c))
1656               {
1657                 key_event.is_text = TRUE; 
1658                 /* incorrect for some composed chars? */
1659               }
1660           }
1661         else
1662           {
1663             key_event.event_string = g_strdup ("");
1664           }
1665     }
1666
1667   key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1668 #ifdef SPI_KEYEVENT_DEBUG
1669   {
1670     char *pressed_str  = "pressed";
1671     char *released_str = "released";
1672     char *state_ptr;
1673
1674     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1675       state_ptr = pressed_str;
1676     else
1677       state_ptr = released_str;
1678  
1679     fprintf (stderr,
1680              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1681              (unsigned long) keysym,
1682              state_ptr,
1683              keysym ? (int) keysym : '*',
1684              (int) x_key_event->state,
1685              key_event.event_string,
1686              key_event.event_string[0],
1687              (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1688   }
1689 #endif
1690 #ifdef SPI_DEBUG
1691   fprintf (stderr, "%s%c\n",
1692      (x_key_event->state & Mod1Mask)?"Alt-":"",
1693      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1694      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1695   fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1696 #endif /* SPI_DEBUG */
1697   return key_event;     
1698 }
1699
1700 static gboolean
1701 spi_controller_update_key_grabs (SpiDEController           *controller,
1702                                  Accessibility_DeviceEvent *recv)
1703 {
1704   GList *l, *next;
1705   gboolean   update_failed = FALSE;
1706   KeyCode keycode = 0;
1707   
1708   g_return_val_if_fail (controller != NULL, FALSE);
1709
1710   /*
1711    * masks known to work with default RH 7.1+:
1712    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1713    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1714    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1715    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1716    *
1717    * ControlMask grabs are broken, must be in use already
1718    */
1719   if (recv)
1720     keycode = keycode_for_keysym (controller, recv->id, NULL);
1721   for (l = controller->keygrabs_list; l; l = next)
1722     {
1723       gboolean do_remove;
1724       gboolean re_issue_grab;
1725       DEControllerGrabMask *grab_mask = l->data;
1726
1727       next = l->next;
1728
1729       re_issue_grab = recv &&
1730               (recv->modifiers & grab_mask->mod_mask) &&
1731               (grab_mask->key_val == keycode);
1732
1733 #ifdef SPI_DEBUG
1734       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1735                (long int) grab_mask->key_val,
1736                (long int) grab_mask->mod_mask,
1737                grab_mask->pending_add ? '+' : '.',
1738                grab_mask->pending_remove ? '-' : '.',
1739                re_issue_grab ? "re-issue": "");
1740 #endif
1741
1742       do_remove = FALSE;
1743
1744       if (grab_mask->pending_add && grab_mask->pending_remove)
1745         {
1746           do_remove = TRUE;
1747         }
1748       else if (grab_mask->pending_remove)
1749         {
1750 #ifdef SPI_DEBUG
1751       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1752 #endif
1753           XUngrabKey (spi_get_display (),
1754                       grab_mask->key_val,
1755                       grab_mask->mod_mask,
1756                       gdk_x11_get_default_root_xwindow ());
1757
1758           do_remove = TRUE;
1759         }
1760       else if (grab_mask->pending_add || re_issue_grab)
1761         {
1762
1763 #ifdef SPI_DEBUG
1764           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1765 #endif
1766           XGrabKey (spi_get_display (),
1767                     grab_mask->key_val,
1768                     grab_mask->mod_mask,
1769                     gdk_x11_get_default_root_xwindow (),
1770                     True,
1771                     GrabModeSync,
1772                     GrabModeSync);
1773           XSync (spi_get_display (), False);
1774           update_failed = spi_clear_error_state ();
1775           if (update_failed) {
1776                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1777                   do_remove = TRUE;
1778           }
1779         }
1780
1781       grab_mask->pending_add = FALSE;
1782       grab_mask->pending_remove = FALSE;
1783
1784       if (do_remove)
1785         {
1786           g_assert (grab_mask->ref_count <= 0);
1787
1788           controller->keygrabs_list = g_list_delete_link (
1789             controller->keygrabs_list, l);
1790
1791           spi_grab_mask_free (grab_mask);
1792         }
1793
1794     } 
1795
1796   return ! update_failed;
1797 }
1798
1799 /*
1800  * Implemented GObject::finalize
1801  */
1802 static void
1803 spi_device_event_controller_object_finalize (GObject *object)
1804 {
1805   SpiDEController *controller;
1806   DEControllerPrivateData *private;
1807   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1808   GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1809 #ifdef SPI_DEBUG
1810   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1811 #endif
1812   /* disconnect any special listeners, get rid of outstanding keygrabs */
1813   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1814
1815 #ifdef HAVE_XEVIE
1816   if (controller->xevie_display != NULL)
1817     {
1818       XevieEnd(controller->xevie_display);
1819 #ifdef SPI_KEYEVENT_DEBUG
1820       printf("XevieEnd(dpy) finished \n");
1821 #endif
1822     }
1823 #endif
1824
1825   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1826   if (private->xkb_desc)
1827           XkbFreeKeyboard (private->xkb_desc, 0, True);
1828   g_free (private);
1829   parent_class->finalize (object);
1830 }
1831
1832 /*
1833  * DBus Accessibility::DEController::registerKeystrokeListener
1834  *     method implementation
1835  */
1836 static DBusMessage *
1837 impl_register_keystroke_listener (DBusConnection *bus,
1838                                   DBusMessage *message,
1839                                   void *user_data)
1840 {
1841   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1842   DEControllerKeyListener *dec_listener;
1843   DBusMessageIter iter, iter_array;
1844   const char *path;
1845   GSList *keys = NULL;
1846   dbus_int32_t mask, type;
1847   Accessibility_EventListenerMode *mode;
1848   dbus_bool_t ret;
1849   DBusMessage *reply = NULL;
1850   char *keystring;
1851
1852   dbus_message_iter_init(message, &iter);
1853   // TODO: verify type signature
1854   dbus_message_iter_get_basic(&iter, &path);
1855   dbus_message_iter_next(&iter);
1856   dbus_message_iter_recurse(&iter, &iter_array);
1857   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1858   {
1859     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
1860     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))
1861     {
1862       break;
1863     }
1864     kd->keystring = g_strdup (keystring);
1865     keys = g_slist_append(keys, kd);
1866   }
1867   dbus_message_iter_next(&iter);
1868   dbus_message_iter_get_basic(&iter, &mask);
1869   dbus_message_iter_next(&iter);
1870   if (!strcmp (dbus_message_iter_get_signature (&iter), "u"))
1871     dbus_message_iter_get_basic(&iter, &type);
1872   else
1873   {
1874     dbus_message_iter_recurse(&iter, &iter_array);
1875     while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1876     {
1877       dbus_uint32_t t;
1878       dbus_message_iter_get_basic (&iter_array, &t);
1879       type |= (1 << t);
1880       dbus_message_iter_next (&iter_array);
1881     }
1882     dbus_message_iter_next (&iter_array);
1883   }
1884   dbus_message_iter_next(&iter);
1885   mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
1886   if (mode)
1887   {
1888     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);
1889   }
1890 #ifdef SPI_DEBUG
1891   fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
1892            dbus_message_get_sender(message), path, (unsigned long) mask);
1893 #endif
1894   dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
1895   ret = spi_controller_register_device_listener (
1896           controller, (DEControllerListener *) dec_listener);
1897   reply = dbus_message_new_method_return (message);
1898   if (reply)
1899   {
1900     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1901   }
1902   return reply;
1903 }
1904
1905 /*
1906  * DBus Accessibility::DEController::registerDeviceEventListener
1907  *     method implementation
1908  */
1909 static DBusMessage *
1910 impl_register_device_event_listener (DBusConnection *bus,
1911                                   DBusMessage *message,
1912                                   void *user_data)
1913 {
1914   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1915   DEControllerListener *dec_listener;
1916   DBusError error;
1917   const char *path;
1918   dbus_int32_t event_types;
1919   dbus_bool_t ret;
1920   DBusMessage *reply = NULL;
1921
1922   dbus_error_init(&error);
1923   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
1924   {
1925     return droute_invalid_arguments_error (message);
1926   }
1927   dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
1928   ret =  spi_controller_register_device_listener (
1929           controller, (DEControllerListener *) dec_listener);
1930   reply = dbus_message_new_method_return (message);
1931   if (reply)
1932   {
1933     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1934   }
1935   return reply;
1936 }
1937
1938 typedef struct {
1939         DBusConnection *bus;
1940         DEControllerListener    *listener;
1941 } RemoveListenerClosure;
1942
1943 static SpiReEntrantContinue
1944 remove_listener_cb (GList * const *list,
1945                     gpointer       user_data)
1946 {
1947   DEControllerListener  *listener = (*list)->data;
1948   RemoveListenerClosure *ctx = user_data;
1949
1950   if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
1951       !strcmp(ctx->listener->path, listener->path))
1952     {
1953       spi_re_entrant_list_delete_link (list);
1954       spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
1955       spi_dec_listener_free (listener);
1956     }
1957
1958   return SPI_RE_ENTRANT_CONTINUE;
1959 }
1960
1961 static SpiReEntrantContinue
1962 copy_key_listener_cb (GList * const *list,
1963                       gpointer       user_data)
1964 {
1965   DEControllerKeyListener  *key_listener = (*list)->data;
1966   RemoveListenerClosure    *ctx = user_data;
1967
1968   if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
1969       !strcmp(ctx->listener->path, key_listener->listener.path))
1970     {
1971       /* TODO: FIXME aggregate keys in case the listener is registered twice */
1972       DEControllerKeyListener *ctx_key_listener = 
1973         (DEControllerKeyListener *) ctx->listener; 
1974       keylist_free (ctx_key_listener->keys);        
1975       ctx_key_listener->keys = keylist_clone(key_listener->keys);
1976     }
1977
1978   return SPI_RE_ENTRANT_CONTINUE;
1979 }
1980
1981 static void
1982 spi_controller_deregister_device_listener (SpiDEController            *controller,
1983                                            DEControllerListener *listener)
1984 {
1985   RemoveListenerClosure  ctx;
1986
1987   ctx.bus = controller->bus;
1988   ctx.listener = listener;
1989
1990   spi_re_entrant_list_foreach (&controller->mouse_listeners,
1991                                remove_listener_cb, &ctx);
1992   if (!controller->mouse_listeners)
1993     have_mouse_listener = FALSE;
1994 }
1995
1996 static void
1997 spi_deregister_controller_key_listener (SpiDEController            *controller,
1998                                         DEControllerKeyListener    *key_listener)
1999 {
2000   RemoveListenerClosure  ctx;
2001
2002   ctx.bus = controller->bus;
2003   ctx.listener = (DEControllerListener *) key_listener;
2004
2005   /* special case, copy keyset from existing controller list entry */
2006   if (g_slist_length(key_listener->keys) == 0)
2007     {
2008       spi_re_entrant_list_foreach (&controller->key_listeners,
2009                                   copy_key_listener_cb, &ctx);
2010     }
2011
2012   spi_controller_deregister_global_keygrabs (controller, key_listener);
2013
2014   spi_re_entrant_list_foreach (&controller->key_listeners,
2015                                 remove_listener_cb, &ctx);
2016
2017 }
2018
2019 void
2020 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2021 {
2022   GList *l, *tmp;
2023
2024   for (l = controller->mouse_listeners; l; l = tmp)
2025   {
2026     DEControllerListener *listener = l->data;
2027     tmp = l->next;
2028     if (!strcmp (listener->bus_name, bus_name))
2029     {
2030       spi_controller_deregister_device_listener (controller, listener);
2031     }
2032   }
2033   for (l = controller->key_listeners; l; l = tmp)
2034   {
2035     DEControllerKeyListener *key_listener = l->data;
2036     tmp = l->next;
2037     if (!strcmp (key_listener->listener.bus_name, bus_name))
2038     {
2039       spi_deregister_controller_key_listener (controller, key_listener);
2040     }
2041   }
2042 }
2043
2044 /*
2045  * DBus Accessibility::DEController::deregisterKeystrokeListener
2046  *     method implementation
2047  */
2048 static DBusMessage *
2049 impl_deregister_keystroke_listener (DBusConnection *bus,
2050                                   DBusMessage *message,
2051                                   void *user_data)
2052 {
2053   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2054   DEControllerKeyListener *key_listener;
2055   DBusMessageIter iter, iter_array;
2056   const char *path;
2057   GSList *keys = NULL;
2058   dbus_int32_t mask, type;
2059   DBusMessage *reply = NULL;
2060
2061   dbus_message_iter_init(message, &iter);
2062   // TODO: verify type signature
2063   dbus_message_iter_get_basic(&iter, &path);
2064   dbus_message_iter_next(&iter);
2065   dbus_message_iter_recurse(&iter, &iter_array);
2066   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2067   {
2068     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2069   char *keystring;
2070
2071     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))
2072     {
2073       break;
2074     }
2075     kd->keystring = g_strdup (keystring);
2076     keys = g_slist_append(keys, kd);
2077   }
2078   dbus_message_iter_next(&iter);
2079   dbus_message_iter_get_basic(&iter, &mask);
2080   dbus_message_iter_next(&iter);
2081   dbus_message_iter_get_basic(&iter, &type);
2082   dbus_message_iter_next(&iter);
2083   key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2084 #ifdef SPI_DEREGISTER_DEBUG
2085   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2086            (void *) l, (unsigned long) mask->value);
2087 #endif
2088
2089   spi_deregister_controller_key_listener (controller, key_listener);
2090
2091   spi_dec_listener_free ((DEControllerListener *) key_listener);
2092   reply = dbus_message_new_method_return (message);
2093   return reply;
2094 }
2095
2096 /*
2097  * DBus Accessibility::DEController::deregisterDeviceEventListener
2098  *     method implementation
2099  */
2100 static DBusMessage *
2101 impl_deregister_device_event_listener (DBusConnection *bus,
2102                                   DBusMessage *message,
2103                                   void *user_data)
2104 {
2105   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2106   DEControllerListener *listener;
2107   DBusError error;
2108   const char *path;
2109   dbus_int32_t event_types;
2110   DBusMessage *reply = NULL;
2111
2112   dbus_error_init(&error);
2113   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2114   {
2115     return droute_invalid_arguments_error (message);
2116   }
2117   listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2118   spi_controller_deregister_device_listener (
2119           controller, listener);
2120   reply = dbus_message_new_method_return (message);
2121   return reply;
2122 }
2123
2124 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2125 {
2126   unsigned int retval = 0;
2127   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2128           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2129 #ifdef HAVE_XKB
2130 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY      
2131   retval = XkbGetSlowKeysDelay (spi_get_display (),
2132                                 XkbUseCoreKbd, &bounce_delay);
2133 #else
2134   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2135     {
2136       Status s = XkbGetControls (spi_get_display (),
2137                                  XkbAllControlsMask, priv->xkb_desc);
2138       if (s == Success)
2139         {
2140          if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2141                  retval = priv->xkb_desc->ctrls->slow_keys_delay;
2142         }
2143     }
2144 #endif
2145 #endif
2146 #ifdef SPI_XKB_DEBUG
2147         fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2148 #endif
2149         return retval;
2150 }
2151
2152 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2153 {
2154   unsigned int retval = 0;
2155   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2156           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2157 #ifdef HAVE_XKB
2158 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY    
2159   retval = XkbGetBounceKeysDelay (spi_get_display (),
2160                                   XkbUseCoreKbd, &bounce_delay);
2161 #else
2162   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2163     {
2164       Status s = XkbGetControls (spi_get_display (),
2165                                  XkbAllControlsMask, priv->xkb_desc);
2166       if (s == Success)
2167         {
2168           if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2169                   retval = priv->xkb_desc->ctrls->debounce_delay;
2170         }
2171     }
2172 #endif
2173 #endif
2174 #ifdef SPI_XKB_DEBUG
2175   fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2176 #endif
2177   return retval;
2178 }
2179
2180 static gboolean
2181 dec_synth_keycode_press (SpiDEController *controller,
2182                          unsigned int keycode)
2183 {
2184         unsigned int time = CurrentTime;
2185         unsigned int bounce_delay;
2186         unsigned int elapsed_msec;
2187         struct timeval tv;
2188         DEControllerPrivateData *priv =
2189                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2190                                                                 spi_dec_private_quark);
2191         if (keycode == priv->last_release_keycode)
2192         {
2193                 bounce_delay = dec_xkb_get_bouncekeys_delay (controller); 
2194                 if (bounce_delay)
2195                 {
2196                         gettimeofday (&tv, NULL);
2197                         elapsed_msec =
2198                                 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2199                                 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2200 #ifdef SPI_XKB_DEBUG                    
2201                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2202                                  (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2203 #endif
2204 #ifdef THIS_IS_BROKEN
2205                         if (elapsed_msec < bounce_delay)
2206                                 time = bounce_delay - elapsed_msec + 1;
2207 #else
2208                         time = bounce_delay + 10;
2209                         /* fudge for broken XTest */
2210 #endif
2211 #ifdef SPI_XKB_DEBUG                    
2212                         fprintf (stderr, "waiting %d ms\n", time);
2213 #endif
2214                 }
2215         }
2216         XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2217         priv->last_press_keycode = keycode;
2218         XFlush (spi_get_display ());
2219         XSync (spi_get_display (), False);
2220         gettimeofday (&priv->last_press_time, NULL);
2221         return TRUE;
2222 }
2223
2224 static gboolean
2225 dec_synth_keycode_release (SpiDEController *controller,
2226                            unsigned int keycode)
2227 {
2228         unsigned int time = CurrentTime;
2229         unsigned int slow_delay;
2230         unsigned int elapsed_msec;
2231         struct timeval tv;
2232         DEControllerPrivateData *priv =
2233                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2234                                                                 spi_dec_private_quark);
2235         if (keycode == priv->last_press_keycode)
2236         {
2237                 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2238                 if (slow_delay)
2239                 {
2240                         gettimeofday (&tv, NULL);
2241                         elapsed_msec =
2242                                 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2243                                 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2244 #ifdef SPI_XKB_DEBUG                    
2245                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2246                                  (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2247 #endif
2248 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2249                         if (elapsed_msec < slow_delay)
2250                                 time = slow_delay - elapsed_msec + 1;
2251 #else
2252                         time = slow_delay + 10;
2253                         /* our XTest seems broken, we have to add slop as above */
2254 #endif
2255 #ifdef SPI_XKB_DEBUG                    
2256                         fprintf (stderr, "waiting %d ms\n", time);
2257 #endif
2258                 }
2259         }
2260         XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2261         priv->last_release_keycode = keycode;
2262         XSync (spi_get_display (), False);
2263         gettimeofday (&priv->last_release_time, NULL);
2264         return TRUE;
2265 }
2266
2267 static unsigned
2268 dec_get_modifier_state (SpiDEController *controller)
2269 {
2270         return mouse_mask_state;
2271 }
2272
2273 static gboolean
2274 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2275 {
2276     DEControllerPrivateData *priv = (DEControllerPrivateData *) 
2277     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);   
2278     
2279     if (priv->have_xkb) {
2280         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd, 
2281                                   modifiers, modifiers);
2282     } else {
2283         int mod_index;
2284         for (mod_index=0;mod_index<8;mod_index++)
2285             if (modifiers & (1<<mod_index))
2286                 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2287         return TRUE;
2288     }
2289 }
2290
2291 static gboolean
2292 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2293 {
2294     DEControllerPrivateData *priv = (DEControllerPrivateData *) 
2295     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);   
2296     
2297     if (priv->have_xkb) {
2298         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd, 
2299                                   modifiers, 0);
2300     } else {
2301         int mod_index;
2302         for (mod_index=0;mod_index<8;mod_index++)
2303             if (modifiers & (1<<mod_index))
2304                 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2305         return TRUE;
2306     }
2307 }
2308
2309 static KeySym
2310 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2311 {
2312         return ucs2keysym ((long) unichar);
2313 }
2314
2315 static gboolean
2316 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2317 {
2318         KeyCode key_synth_code;
2319         unsigned int modifiers, synth_mods, lock_mods;
2320
2321         key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2322
2323         if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2324
2325         /* TODO: set the modifiers accordingly! */
2326         modifiers = dec_get_modifier_state (controller);
2327         /* side-effect; we may unset mousebutton modifiers here! */
2328
2329         lock_mods = 0;
2330         if (synth_mods != modifiers) {
2331                 lock_mods = synth_mods & ~modifiers;
2332                 dec_lock_modifiers (controller, lock_mods);
2333         }
2334         dec_synth_keycode_press (controller, key_synth_code);
2335         dec_synth_keycode_release (controller, key_synth_code);
2336
2337         if (synth_mods != modifiers) 
2338                 dec_unlock_modifiers (controller, lock_mods);
2339         return TRUE;
2340 }
2341
2342
2343 static gboolean
2344 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2345 {
2346         /* probably we need to create and inject an XIM handler eventually. */
2347         /* for now, try to match the string to existing 
2348          * keycode+modifier states. 
2349          */
2350         KeySym *keysyms;
2351         gint maxlen = 0;
2352         gunichar unichar = 0;
2353         gint i = 0;
2354         gboolean retval = TRUE;
2355         const gchar *c;
2356
2357         maxlen = strlen (keystring) + 1;
2358         keysyms = g_new0 (KeySym, maxlen);
2359         if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) { 
2360                 retval = FALSE;
2361         } 
2362         else {
2363 #ifdef SPI_DEBUG
2364                 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2365 #endif
2366                 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2367                         KeySym keysym;
2368                         char bytes[6];
2369                         gint mbytes;
2370                         
2371                         mbytes = g_unichar_to_utf8 (unichar, bytes);
2372                         bytes[mbytes] = '\0';
2373 #ifdef SPI_DEBUG
2374                         fprintf (stderr, "[unichar %s]", bytes);
2375 #endif
2376                         keysym = dec_keysym_for_unichar (controller, unichar);
2377                         if (keysym == NoSymbol) {
2378 #ifdef SPI_DEBUG
2379                                 fprintf (stderr, "no keysym for %s", bytes);
2380 #endif
2381                                 retval = FALSE;
2382                                 break;
2383                         }
2384                         keysyms[i++] = keysym;
2385                         keystring = g_utf8_next_char (keystring); 
2386                 }
2387                 keysyms[i++] = 0;
2388                 XSynchronize (spi_get_display (), TRUE);
2389                 for (i = 0; keysyms[i]; ++i) {
2390                         if (!dec_synth_keysym (controller, keysyms[i])) {
2391 #ifdef SPI_DEBUG
2392                                 fprintf (stderr, "could not synthesize %c\n",
2393                                          (int) keysyms[i]);
2394 #endif
2395                                 retval = FALSE;
2396                                 break;
2397                         }
2398                 }
2399                 XSynchronize (spi_get_display (), FALSE);
2400         }
2401         g_free (keysyms);
2402
2403         return retval;
2404 }
2405
2406
2407 /*
2408  * DBus Accessibility::DEController::registerKeystrokeListener
2409  *     method implementation
2410  */
2411 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2412 {
2413   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2414   DBusError error;
2415   dbus_int32_t keycode;
2416   char *keystring;
2417   dbus_uint32_t synth_type;
2418   gint err;
2419   KeySym keysym;
2420   DEControllerPrivateData *priv;
2421   DBusMessage *reply = NULL;
2422
2423   dbus_error_init(&error);
2424   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2425   {
2426     return droute_invalid_arguments_error (message);
2427   }
2428
2429 #ifdef SPI_DEBUG
2430         fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2431                  (long) keycode, (int) synth_type);
2432 #endif
2433   /* TODO: hide/wrap/remove X dependency */
2434
2435   /*
2436    * TODO: when initializing, query for XTest extension before using,
2437    * and fall back to XSendEvent() if XTest is not available.
2438    */
2439   
2440   gdk_error_trap_push ();
2441
2442   priv = (DEControllerPrivateData *) 
2443       g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2444
2445   if (!priv->have_xkb && xmkeymap==NULL) {
2446     xmkeymap = XGetModifierMapping(spi_get_display ());
2447   }
2448
2449   switch (synth_type)
2450     {
2451       case Accessibility_KEY_PRESS:
2452               dec_synth_keycode_press (controller, keycode);
2453               break;
2454       case Accessibility_KEY_PRESSRELEASE:
2455               dec_synth_keycode_press (controller, keycode);
2456       case Accessibility_KEY_RELEASE:
2457               dec_synth_keycode_release (controller, keycode);
2458               break;
2459       case Accessibility_KEY_SYM:
2460 #ifdef SPI_XKB_DEBUG          
2461               fprintf (stderr, "KeySym synthesis\n");
2462 #endif
2463               /* 
2464                * note: we are using long for 'keycode'
2465                * in our arg list; it can contain either
2466                * a keycode or a keysym.
2467                */
2468               dec_synth_keysym (controller, (KeySym) keycode);
2469               break;
2470       case Accessibility_KEY_STRING:
2471               if (!dec_synth_keystring (controller, keystring))
2472                       fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2473                                keystring);
2474               break;
2475     }
2476   if (synth_type == Accessibility_KEY_SYM) {
2477     keysym = keycode;
2478   }
2479   else {
2480     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2481   }
2482   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0) 
2483     {
2484       spi_dec_clear_unlatch_pending (controller);
2485     }
2486   reply = dbus_message_new_method_return (message);
2487   return reply;
2488 }
2489
2490 /* Accessibility::DEController::generateMouseEvent */
2491 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2492 {
2493   DBusError error;
2494   dbus_int32_t       x;
2495   dbus_int32_t       y;
2496   char *eventName;
2497   DBusMessage *reply = NULL;
2498   int button = 0;
2499   gboolean err = FALSE;
2500   Display *display = spi_get_display ();
2501
2502   dbus_error_init (&error);
2503   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2504   {
2505     return droute_invalid_arguments_error (message);
2506   }
2507
2508 #ifdef SPI_DEBUG
2509   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2510            eventName, (long int) x, (long int) y);
2511 #endif
2512   switch (eventName[0])
2513     {
2514       case 'b':
2515         switch (eventName[1])
2516           {
2517           /* TODO: check number of buttons before parsing */
2518           case '1':
2519                     button = 1;
2520                     break;
2521           case '2':
2522                   button = 2;
2523                   break;
2524           case '3':
2525                   button = 3;
2526                   break;
2527           case '4':
2528                   button = 4;
2529                   break;
2530           case '5':
2531                   button = 5;
2532                   break;
2533           default:
2534                   err = TRUE;
2535           }
2536         if (!err)
2537           {
2538             if (x != -1 && y != -1)
2539               {
2540                 XTestFakeMotionEvent (display, DefaultScreen (display),
2541                                       x, y, 0);
2542               }
2543             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2544             if (eventName[2] == 'c')
2545               XTestFakeButtonEvent (display, button, FALSE, 1);
2546             else if (eventName[2] == 'd')
2547               {
2548               XTestFakeButtonEvent (display, button, FALSE, 1);
2549               XTestFakeButtonEvent (display, button, TRUE, 2);
2550               XTestFakeButtonEvent (display, button, FALSE, 3);
2551               }
2552           }
2553         break;
2554       case 'r': /* relative motion */ 
2555         XTestFakeRelativeMotionEvent (display, x, y, 0);
2556         break;
2557       case 'a': /* absolute motion */
2558         XTestFakeMotionEvent (display, DefaultScreen (display),
2559                               x, y, 0);
2560         break;
2561     }
2562   reply = dbus_message_new_method_return (message);
2563   return reply;
2564 }
2565
2566 /* Accessibility::DEController::notifyListenersSync */
2567 static DBusMessage *
2568 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2569 {
2570   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2571   Accessibility_DeviceEvent event;
2572   dbus_bool_t ret;
2573   DBusMessage *reply = NULL;
2574
2575   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2576   {
2577     return droute_invalid_arguments_error (message);
2578   }
2579 #ifdef SPI_DEBUG
2580   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2581            controller, (int) event.id);
2582 #endif
2583   ret = spi_controller_notify_keylisteners (controller,
2584                                              (Accessibility_DeviceEvent *) 
2585                                              &event, FALSE) ?
2586           TRUE : FALSE; 
2587   reply = dbus_message_new_method_return (message);
2588   if (reply)
2589   {
2590     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2591   }
2592   return reply;
2593 }
2594
2595 static DBusMessage *
2596 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2597 {
2598   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2599   Accessibility_DeviceEvent event;
2600   DBusMessage *reply = NULL;
2601
2602   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2603   {
2604     return droute_invalid_arguments_error (message);
2605   }
2606 #ifdef SPI_DEBUG
2607   g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2608            controller, (int) event.id);
2609 #endif
2610   spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2611                                       &event, FALSE); 
2612   reply = dbus_message_new_method_return (message);
2613   return reply;
2614 }
2615
2616 static void
2617 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2618 {
2619   GObjectClass * object_class = (GObjectClass *) klass;
2620
2621   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2622
2623   object_class->finalize = spi_device_event_controller_object_finalize;
2624
2625   if (!spi_dec_private_quark)
2626           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2627 }
2628
2629 #ifdef HAVE_XEVIE
2630 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2631 {
2632    return TRUE;
2633 }
2634
2635 static gboolean
2636 handle_io (GIOChannel *source,
2637            GIOCondition condition,
2638            gpointer data) 
2639 {
2640   SpiDEController *controller = (SpiDEController *) data;
2641   gboolean is_consumed = FALSE;
2642   XEvent ev;
2643
2644   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2645     {
2646       if (ev.type == KeyPress || ev.type == KeyRelease)
2647         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2648
2649       if (! is_consumed)
2650         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2651     }
2652
2653   return TRUE;
2654 }
2655 #endif /* HAVE_XEVIE */
2656
2657 static void
2658 spi_device_event_controller_init (SpiDEController *device_event_controller)
2659 {
2660 #ifdef HAVE_XEVIE
2661   GIOChannel *ioc;
2662   int fd;
2663 #endif /* HAVE_XEVIE */
2664
2665   DEControllerPrivateData *private;     
2666   device_event_controller->key_listeners   = NULL;
2667   device_event_controller->mouse_listeners = NULL;
2668   device_event_controller->keygrabs_list   = NULL;
2669   device_event_controller->xevie_display   = NULL;
2670
2671 #ifdef HAVE_XEVIE
2672   device_event_controller->xevie_display = XOpenDisplay(NULL);
2673
2674   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2675     {
2676 #ifdef SPI_KEYEVENT_DEBUG
2677       fprintf (stderr, "XevieStart() success \n");
2678 #endif
2679       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2680
2681       fd = ConnectionNumber(device_event_controller->xevie_display);
2682       ioc = g_io_channel_unix_new (fd);
2683       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2684       g_io_channel_unref (ioc);
2685     }
2686   else
2687     {
2688       device_event_controller->xevie_display = NULL;
2689 #ifdef SPI_KEYEVENT_DEBUG
2690       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2691 #endif
2692     }
2693 #endif /* HAVE_XEVIE */
2694
2695   private = g_new0 (DEControllerPrivateData, 1);
2696   gettimeofday (&private->last_press_time, NULL);
2697   gettimeofday (&private->last_release_time, NULL);
2698   g_object_set_qdata (G_OBJECT (device_event_controller),
2699                       spi_dec_private_quark,
2700                       private);
2701   spi_controller_register_with_devices (device_event_controller);
2702 }
2703
2704 static gboolean
2705 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2706                                                const XEvent    *event)
2707 {
2708   Accessibility_DeviceEvent key_event;
2709   gboolean ret;
2710
2711   g_assert (event->type == KeyPress || event->type == KeyRelease);
2712
2713   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2714
2715   if (controller->xevie_display == NULL)
2716     spi_controller_update_key_grabs (controller, &key_event);
2717
2718   /* relay to listeners, and decide whether to consume it or not */
2719   ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2720   g_free(key_event.event_string);
2721   return ret;
2722 }
2723
2724
2725 static gboolean
2726 is_key_released (KeyCode code)
2727 {
2728   char keys[32];
2729   int down;
2730
2731   XQueryKeymap (spi_get_display (), keys);
2732   down = BIT (keys, code);
2733   return (down == 0);
2734 }
2735
2736 static gboolean
2737 check_release (gpointer data)
2738 {
2739   gboolean released;
2740   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2741   KeyCode code = event->hw_code;
2742
2743   released = is_key_released (code);
2744
2745   if (released)
2746     {
2747       check_release_handler = 0;
2748       event->type = Accessibility_KEY_RELEASED_EVENT;
2749       spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2750     }
2751   return (released == 0);
2752 }
2753
2754 static void wait_for_release_event (XEvent          *event,
2755                                     SpiDEController *controller)
2756 {
2757   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2758   saved_controller = controller;
2759   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2760 }
2761
2762 static DRouteMethod dev_methods[] =
2763 {
2764   { impl_register_keystroke_listener, "registerKeystrokeListener" },
2765   { impl_register_device_event_listener, "registerDeviceEventListener" },
2766   { impl_deregister_keystroke_listener, "deregisterKeystrokeListener" },
2767   { impl_deregister_device_event_listener, "deregisterDeviceEventListener" },
2768   { impl_generate_keyboard_event, "generateKeyboardEvent" },
2769   { impl_generate_mouse_event, "generateMouseEvent" },
2770   { impl_notify_listeners_sync, "notifyListenersSync" },
2771   { impl_notify_listeners_async, "notifyListenersAsync" },
2772   { NULL, NULL }
2773 };
2774
2775 SpiDEController *
2776 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus, DRouteContext *droute)
2777 {
2778   SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2779   DRoutePath *path;
2780
2781   dec->registry = g_object_ref (reg);
2782   dec->bus = bus;
2783
2784   path = droute_add_one (droute,
2785                          SPI_DBUS_PATH_DEC,
2786                          dec);
2787
2788   droute_path_add_interface (path,
2789                              SPI_DBUS_INTERFACE_DEC,
2790                              dev_methods,
2791                              NULL);
2792
2793   spi_dec_init_mouse_listener (dec);
2794   /* TODO: kill mouse listener on finalize */
2795
2796   return dec;
2797 }
2798
2799 void
2800 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
2801 {
2802   if (!have_mouse_event_listener)
2803     {
2804       have_mouse_event_listener = TRUE;
2805       if (!have_mouse_listener)
2806       g_timeout_add (100, spi_dec_poll_mouse_idle, registry);
2807     }
2808 }
2809
2810 void
2811 spi_device_event_controller_stop_poll_mouse (void)
2812 {
2813   have_mouse_event_listener = FALSE;
2814 }