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