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