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