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