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