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