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