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