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