Added notification of mouse button events, for instance
[platform/core/uifw/at-spi2-atk.git] / registryd / deviceeventcontroller.c
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2001 Sun Microsystems Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /* deviceeventcontroller.c: implement the DeviceEventController interface */
24
25 #include <config.h>
26
27 #undef  SPI_DEBUG
28 #undef  SPI_KEYEVENT_DEBUG
29
30 #include <string.h>
31 #include <ctype.h>
32 #include <stdio.h>
33 #include <bonobo/bonobo-exception.h>
34
35 #include <X11/Xlib.h>
36 #include <X11/extensions/XTest.h>
37 #define XK_MISCELLANY
38 #include <X11/keysymdef.h>
39 #include <gdk/gdk.h>
40 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
41 #include <gdk/gdkkeysyms.h>
42 #include <gdk/gdkwindow.h>
43
44 #include "../libspi/spi-private.h"
45 #include "deviceeventcontroller.h"
46
47 /* Our parent Gtk object type */
48 #define PARENT_TYPE BONOBO_TYPE_OBJECT
49
50 /* A pointer to our parent object class */
51 static GObjectClass *spi_device_event_controller_parent_class;
52 static int spi_error_code = 0;
53 static GdkPoint *last_mouse_pos = NULL; 
54 static unsigned int mouse_button_state = 0;
55 static unsigned int mouse_button_mask =
56   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
57
58 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
59
60 typedef enum {
61   SPI_DEVICE_TYPE_KBD,
62   SPI_DEVICE_TYPE_MOUSE,
63   SPI_DEVICE_TYPE_LAST_DEFINED
64 } SpiDeviceTypeCategory;
65
66 typedef struct {
67   guint                             ref_count : 30;
68   guint                             pending_add : 1;
69   guint                             pending_remove : 1;
70
71   Accessibility_ControllerEventMask mod_mask;
72   CORBA_unsigned_long               key_val;  /* KeyCode */
73 } DEControllerGrabMask;
74
75 typedef struct {
76   CORBA_Object          object;
77   SpiDeviceTypeCategory type;
78 } DEControllerListener;
79
80 typedef struct {
81   DEControllerListener listener;
82
83   Accessibility_KeySet             *keys;
84   Accessibility_ControllerEventMask mask;
85   Accessibility_KeyEventTypeSeq    *typeseq;
86   Accessibility_EventListenerMode  *mode;       
87 } DEControllerKeyListener;
88
89 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
90 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
91                                                                Accessibility_DeviceEvent *recv);
92 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
93                                                                DEControllerListener      *l,
94                                                                CORBA_Environment         *ev);
95 static void     spi_device_event_controller_forward_key_event (SpiDEController           *controller,
96                                                                const XEvent              *event);
97 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
98                                                         DEControllerKeyListener *key_listener,
99                                                         CORBA_Environment       *ev);
100
101 static gboolean spi_clear_error_state (void);
102 static gboolean spi_dec_poll_mouse_moved (gpointer data);
103 static gboolean spi_dec_poll_mouse_moving (gpointer data);
104 static gboolean spi_dec_poll_mouse_idle (gpointer data);
105
106 #define spi_get_display() GDK_DISPLAY()
107
108 /* Private methods */
109
110 static KeyCode
111 keycode_for_keysym (long keysym)
112 {
113   return XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
114 }
115
116 static DEControllerGrabMask *
117 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
118 {
119   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
120
121   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
122
123   clone->ref_count = 1;
124   clone->pending_add = TRUE;
125   clone->pending_remove = FALSE;
126
127   return clone;
128 }
129
130 static void
131 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
132 {
133   g_free (grab_mask);
134 }
135
136 static gint
137 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
138 {
139   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
140   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
141
142   if (p1 == p2)
143     {
144       return 0;
145     }
146   else
147     { 
148       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
149     }
150 }
151
152 static gboolean
153 spi_dec_poll_mouse_moved (gpointer data)
154 {
155   SpiRegistry *registry = SPI_REGISTRY (data);
156   CORBA_Environment ev;
157   Accessibility_Event e;
158   Window root_return, child_return;
159   int win_x_return,win_y_return;
160   int x, y;
161   unsigned int mask_return;
162   gchar event_name[24];
163   Display *display = spi_get_display ();
164   if (last_mouse_pos == NULL) {
165           last_mouse_pos = g_new0 (GdkPoint, 1);
166           last_mouse_pos->x = 0;
167           last_mouse_pos->y = 0;
168           e.type = g_strdup ("mouse:abs");
169   } else {
170           e.type = g_strdup ("mouse:rel");
171   }
172   if (display != NULL)
173           XQueryPointer(display, DefaultRootWindow (display),
174                 &root_return, &child_return,
175                 &x, &y,
176                 &win_x_return, &win_y_return, &mask_return);
177   if ((mask_return & mouse_button_mask) != mouse_button_state) {
178           int button_number = 0;
179           if (!(mask_return & Button1Mask) &&
180               (mouse_button_state & Button1Mask)) {
181                   button_number = 1;
182           } else if (!(mask_return & Button2Mask) &&
183                      (mouse_button_state & Button2Mask)) {
184                   button_number = 2;
185           } else if (!(mask_return & Button3Mask) &&
186                      (mouse_button_state & Button3Mask)) {
187                   button_number = 3;
188           } else if (!(mask_return & Button4Mask) &&
189                      (mouse_button_state & Button1Mask)) {
190                   button_number = 4;
191           } else if (!(mask_return & Button5Mask) &&
192                      (mouse_button_state & Button5Mask)) {
193                   button_number = 5;
194           }
195           if (button_number) {
196 #ifdef SPI_DEBUG                  
197                   fprintf (stderr, "Button %d Released\n",
198                            button_number);
199 #endif
200                   snprintf (event_name, 22, "mouse:button:%dr", button_number);
201                   e.type = CORBA_string_dup (event_name);
202                   e.source = BONOBO_OBJREF (registry->desktop);
203                   e.detail1 = last_mouse_pos->x;
204                   e.detail2 = last_mouse_pos->y;
205                   CORBA_exception_init (&ev);
206                   Accessibility_Registry_notifyEvent (BONOBO_OBJREF (registry),
207                                                       &e,
208                                                       &ev);
209           }
210           mouse_button_state = mask_return & mouse_button_mask;
211   }
212   if (x != last_mouse_pos->x || y != last_mouse_pos->y) {
213           e.source = BONOBO_OBJREF (registry->desktop);
214           e.detail1 = x - last_mouse_pos->x;
215           e.detail2 = y - last_mouse_pos->y;
216           CORBA_exception_init (&ev);
217           if (last_mouse_pos == NULL)
218                   last_mouse_pos = g_new0 (GdkPoint, 1);
219           last_mouse_pos->x = x;
220           last_mouse_pos->y = y;
221           Accessibility_Registry_notifyEvent (BONOBO_OBJREF (registry),
222                                               &e,
223                                               &ev);
224           return TRUE;
225   }
226   return FALSE;
227 }
228
229 static gboolean
230 spi_dec_poll_mouse_idle (gpointer data)
231 {
232   if (! spi_dec_poll_mouse_moved (data)) 
233     return TRUE;
234   else
235     {
236       g_timeout_add (20, spi_dec_poll_mouse_moving, data);          
237       return FALSE;         
238     }
239 }
240
241 static gboolean
242 spi_dec_poll_mouse_moving (gpointer data)
243 {
244   if (spi_dec_poll_mouse_moved (data))
245     return TRUE;
246   else
247     {
248       g_timeout_add (100, spi_dec_poll_mouse_idle, data);           
249       return FALSE;
250     }
251 }
252
253 static int
254 spi_dec_ungrab_mouse (gpointer data)
255 {
256         Display *display = spi_get_display ();
257         fprintf (stderr, "mouse ungrab : display = %p\n", display);
258         if (display)
259           {
260             XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
261                            XDefaultRootWindow (spi_get_display ()));
262             fprintf (stderr, "mouse grab released\n");
263           }
264         return FALSE;
265 }
266
267 static void
268 spi_dec_init_mouse_listener (SpiRegistry *registry)
269 {
270   Display *display = spi_get_display ();
271   g_timeout_add (100, spi_dec_poll_mouse_idle, registry);
272
273   if (display)
274     {
275       XGrabButton (display, AnyButton, 0,
276                    gdk_x11_get_default_root_xwindow (),
277                    True, ButtonPressMask | ButtonReleaseMask,
278                    GrabModeSync, GrabModeAsync, None, None);
279       XSync (display, False);
280       fprintf (stderr, "mouse buttons grabbed\n");
281     }
282 }
283
284 static DEControllerKeyListener *
285 spi_dec_key_listener_new (CORBA_Object                            l,
286                           const Accessibility_KeySet             *keys,
287                           const Accessibility_ControllerEventMask mask,
288                           const Accessibility_KeyEventTypeSeq    *typeseq,
289                           const Accessibility_EventListenerMode  *mode,
290                           CORBA_Environment                      *ev)
291 {
292   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
293   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
294   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
295   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
296   key_listener->mask = mask;
297   key_listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_KeyEventTypeSeq);
298   if (mode)
299     key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
300   else
301     key_listener->mode = NULL;
302
303 #ifdef SPI_DEBUG
304   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
305            (unsigned int) key_listener->mask,
306            (int) (mode ? mode->global : 0),
307            (void *) key_listener->keys,
308            (int) (key_listener->keys ? key_listener->keys->_length : 0));
309 #endif
310
311   return key_listener;  
312 }
313
314 static DEControllerKeyListener *
315 spi_key_listener_clone (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
316 {
317   DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
318   clone->listener.object =
319           CORBA_Object_duplicate (key_listener->listener.object, ev);
320   clone->listener.type = SPI_DEVICE_TYPE_KBD;
321   clone->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
322   clone->mask = key_listener->mask;
323   clone->typeseq = ORBit_copy_value (key_listener->typeseq, TC_Accessibility_KeyEventTypeSeq);
324   if (key_listener->mode)
325     clone->mode = ORBit_copy_value (key_listener->mode, TC_Accessibility_EventListenerMode);
326   else
327     clone->mode = NULL;
328   return clone;
329 }
330
331 static void
332 spi_key_listener_data_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
333 {
334   CORBA_free (key_listener->typeseq);
335   CORBA_free (key_listener->keys);
336   g_free (key_listener);
337 }
338
339 static void
340 spi_key_listener_clone_free (DEControllerKeyListener *clone, CORBA_Environment *ev)
341 {
342   CORBA_Object_release (clone->listener.object, ev);
343   spi_key_listener_data_free (clone, ev);
344 }
345
346 static void
347 spi_dec_key_listener_free (DEControllerKeyListener *key_listener,
348                            CORBA_Environment       *ev)
349 {
350   bonobo_object_release_unref (key_listener->listener.object, ev);
351   spi_key_listener_data_free (key_listener, ev);
352 }
353
354 static void
355 _register_keygrab (SpiDEController      *controller,
356                    DEControllerGrabMask *grab_mask)
357 {
358   GList *l;
359
360   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
361                           spi_grab_mask_compare_values);
362   if (l)
363     {
364       DEControllerGrabMask *cur_mask = l->data;
365
366       cur_mask->ref_count++;
367       if (cur_mask->pending_remove)
368         {
369           cur_mask->pending_remove = FALSE;
370         }
371     }
372   else
373     {
374       controller->keygrabs_list =
375         g_list_prepend (controller->keygrabs_list,
376                         spi_grab_mask_clone (grab_mask));
377     }
378 }
379
380 static void
381 _deregister_keygrab (SpiDEController      *controller,
382                      DEControllerGrabMask *grab_mask)
383 {
384   GList *l;
385
386   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
387                           spi_grab_mask_compare_values);
388
389   if (l)
390     {
391       DEControllerGrabMask *cur_mask = l->data;
392
393       cur_mask->ref_count--;
394       if (cur_mask->ref_count <= 0)
395         {
396           cur_mask->pending_remove = TRUE;
397         }
398     }
399   else
400     {
401       g_warning ("De-registering non-existant grab");
402     }
403 }
404
405 static void
406 handle_keygrab (SpiDEController         *controller,
407                 DEControllerKeyListener *key_listener,
408                 void                   (*process_cb) (SpiDEController *controller,
409                                                       DEControllerGrabMask *grab_mask))
410 {
411   DEControllerGrabMask grab_mask = { 0 };
412
413   grab_mask.mod_mask = key_listener->mask;
414   if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
415     {
416       grab_mask.key_val = AnyKey;
417 #ifdef SPI_DEBUG
418       fprintf (stderr, "AnyKey grab!"); */
419 #endif
420       process_cb (controller, &grab_mask);
421     }
422   else
423     {
424       int i;
425
426       for (i = 0; i < key_listener->keys->_length; ++i)
427         {
428           Accessibility_KeyDefinition keydef = key_listener->keys->_buffer[i];  
429           long int key_val = keydef.keysym;
430           /* X Grabs require keycodes, not keysyms */
431           if (keydef.keystring && keydef.keystring[0])
432             {
433               key_val = XStringToKeysym(keydef.keystring);                  
434             }
435           if (key_val > 0)
436             {
437               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
438             }
439           else
440             {
441               key_val = keydef.keycode;
442             }
443           grab_mask.key_val = key_val;
444           process_cb (controller, &grab_mask);
445         }
446     }
447 }
448
449 static gboolean
450 spi_controller_register_global_keygrabs (SpiDEController         *controller,
451                                          DEControllerKeyListener *key_listener)
452 {
453   handle_keygrab (controller, key_listener, _register_keygrab);
454   return spi_controller_update_key_grabs (controller, NULL);
455 }
456
457 static void
458 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
459                                            DEControllerKeyListener *key_listener)
460 {
461   handle_keygrab (controller, key_listener, _deregister_keygrab);
462   spi_controller_update_key_grabs (controller, NULL);
463 }
464
465 static gboolean
466 spi_controller_register_device_listener (SpiDEController      *controller,
467                                          DEControllerListener *listener,
468                                          CORBA_Environment    *ev)
469 {
470   DEControllerKeyListener *key_listener;
471   
472   switch (listener->type) {
473   case SPI_DEVICE_TYPE_KBD:
474       key_listener = (DEControllerKeyListener *) listener;
475
476       controller->key_listeners = g_list_prepend (controller->key_listeners,
477                                                   key_listener);
478       if (key_listener->mode->global)
479         {
480           return spi_controller_register_global_keygrabs (controller, key_listener);    
481         }
482       else
483               return TRUE;
484       break;
485     default:
486       break;
487   }
488   return FALSE; 
489 }
490
491 static void
492 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
493                                                  XEvent *xevent)
494 {
495   Accessibility_Event e;
496   CORBA_Environment ev;
497   gchar event_name[24];
498   int button = ((XButtonEvent *) xevent)->button;
499   
500   mouse_button_state = ((XButtonEvent *) xevent)->state;
501
502   switch (button)
503     {
504     case 1:
505             mouse_button_state |= Button1Mask;
506             break;
507     case 2:
508             mouse_button_state |= Button2Mask;
509             break;
510     case 3:
511             mouse_button_state |= Button3Mask;
512             break;
513     case 4:
514             mouse_button_state |= Button4Mask;
515             break;
516     case 5:
517             mouse_button_state |= Button5Mask;
518             break;
519     }
520   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
521   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
522
523 #ifdef SPI_DEBUG  
524   fprintf (stderr, "mouse button %d %s (%x)\n",
525            ((XButtonEvent *) xevent)->button, 
526            (xevent->type == ButtonPress) ? "Press" : "Release",
527            mouse_button_state);
528 #endif
529   snprintf (event_name, 22, "mouse:button:%d%c", button,
530             (xevent->type == ButtonPress) ? 'p' : 'r');
531
532   e.type = CORBA_string_dup (event_name);
533   e.source = BONOBO_OBJREF (controller->registry->desktop);
534   e.detail1 = last_mouse_pos->x;
535   e.detail2 = last_mouse_pos->y;
536   CORBA_exception_init (&ev);
537   Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
538                                       &e,
539                                       &ev);
540   
541   XAllowEvents (spi_get_display (), ReplayPointer, CurrentTime);
542 }
543
544 static GdkFilterReturn
545 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
546 {
547   XEvent *xevent = gdk_xevent;
548   SpiDEController *controller;
549
550   if (xevent->type == KeyPress && xevent->type == KeyRelease)
551     {
552       controller = SPI_DEVICE_EVENT_CONTROLLER (data);
553       spi_device_event_controller_forward_key_event (controller, xevent);
554       /* FIXME: is this right ? */
555       return GDK_FILTER_CONTINUE;
556     }
557   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
558     {
559       controller = SPI_DEVICE_EVENT_CONTROLLER (data);
560       spi_device_event_controller_forward_mouse_event (controller, xevent);
561     }
562   
563   return GDK_FILTER_CONTINUE;
564 }
565
566 int
567 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
568 {
569   if (error->error_code == BadAccess) 
570     {  
571       g_message ("Could not complete key grab: grab already in use.\n");
572       spi_error_code = BadAccess;
573       return 0;
574     }
575   else 
576     {
577       return (*x_default_error_handler) (display, error);
578     }
579 }
580
581 static void
582 spi_controller_register_with_devices (SpiDEController *controller)
583 {
584   /* calls to device-specific implementations and routines go here */
585   /* register with: keyboard hardware code handler */
586   /* register with: (translated) keystroke handler */
587
588   gdk_window_add_filter (NULL, global_filter_fn, controller);
589
590   gdk_window_set_events (gdk_get_default_root_window (),
591                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
592
593   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
594 }
595
596 #define SPI_KEYEVENT_DEBUG
597 static gboolean
598 spi_key_set_contains_key (Accessibility_KeySet            *key_set,
599                           const Accessibility_DeviceEvent *key_event)
600 {
601   gint i;
602   gint len;
603
604   if (!key_set)
605     {
606       g_print ("null key set!");
607       return TRUE;
608     }
609
610   len = key_set->_length;
611   
612   if (len == 0) /* special case, means "all keys/any key" */
613     {
614       g_print ("anykey\n");         
615       return TRUE;
616     }
617
618   for (i = 0; i < len; ++i)
619     {
620 #ifdef SPI_KEYEVENT_DEBUG           
621       g_print ("key_set[%d] = %d; key_event %d, code %d, string %s\n",
622                 i, (int) key_set->_buffer[i].keycode,
623                (int) key_event->id, (int) key_event->hw_code,
624                key_event->event_string); 
625 #endif
626       if (key_set->_buffer[i].keysym == (CORBA_long) key_event->id)
627         {
628           return TRUE;
629         }
630       if (key_set->_buffer[i].keycode == (CORBA_long) key_event->hw_code)
631         {
632           return TRUE;
633         }
634       if (key_event->event_string && key_event->event_string[0] &&
635           !strcmp (key_set->_buffer[i].keystring, key_event->event_string))
636         {
637           return TRUE;
638         }
639     }
640   
641   return FALSE;
642 }
643
644 static gboolean
645 spi_key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq   *type_seq,
646                                       const Accessibility_DeviceEvent *key_event)
647 {
648   gint i;
649   gint len;
650
651
652   if (!type_seq)
653     {
654       g_print ("null type seq!");
655       return TRUE;
656     }
657
658   len = type_seq->_length;
659   
660   if (len == 0) /* special case, means "all events/any event" */
661     {
662       return TRUE;
663     }
664
665   for (i = 0; i < len; ++i)
666     {
667 #ifdef SPI_DEBUG            
668       g_print ("type_seq[%d] = %d; key event type = %d\n", i,
669                (int) type_seq->_buffer[i], (int) key_event->type);
670 #endif      
671       if (type_seq->_buffer[i] == (CORBA_long) key_event->type)
672         {
673           return TRUE;
674         }
675     }
676   
677   return FALSE;
678 }
679
680 static gboolean
681 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
682                                 DEControllerKeyListener         *listener,
683                                 CORBA_boolean                    is_system_global)
684 {
685   if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFFFF)) &&
686        spi_key_set_contains_key (listener->keys, key_event) &&
687        spi_key_eventtype_seq_contains_event (listener->typeseq, key_event) && 
688       (is_system_global == listener->mode->global))
689     {
690       return TRUE;
691     }
692   else
693     {
694       return FALSE;
695     }
696 }
697
698 static gboolean
699 spi_controller_notify_keylisteners (SpiDEController                 *controller,
700                                     const Accessibility_DeviceEvent *key_event,
701                                     CORBA_boolean                    is_system_global,
702                                     CORBA_Environment               *ev)
703 {
704   GList   *l;
705   GSList  *notify = NULL, *l2;
706   GList  **key_listeners = &controller->key_listeners;
707   gboolean is_consumed;
708
709   if (!key_listeners)
710     {
711       return FALSE;
712     }
713
714   for (l = *key_listeners; l; l = l->next)
715     {
716        DEControllerKeyListener *key_listener = l->data;
717
718        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
719          {
720            Accessibility_DeviceEventListener ls = key_listener->listener.object;
721
722            if (ls != CORBA_OBJECT_NIL)
723              {
724                /* we clone (don't dup) the listener, to avoid refcount inc. */
725                notify = g_slist_prepend (notify,
726                                          spi_key_listener_clone (key_listener, ev));
727              }
728          }
729     }
730
731 #ifdef SPI_KEYEVENT_DEBUG
732   if (!notify)
733     {
734       g_print ("no match for event\n");
735     }
736 #endif
737
738   is_consumed = FALSE;
739   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
740     {
741       DEControllerKeyListener *key_listener = l2->data;     
742       Accessibility_DeviceEventListener ls = key_listener->listener.object;
743
744       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
745
746       if (BONOBO_EX (ev))
747         {
748           is_consumed = FALSE;
749           spi_deregister_controller_key_listener (controller, key_listener,
750                                                   ev);
751           CORBA_exception_free (ev);
752         }
753
754       CORBA_Object_release (ls, ev);
755     }
756
757   for (; l2; l2 = l2->next)
758     {
759       DEControllerKeyListener *key_listener = l2->data;     
760       spi_key_listener_clone_free (key_listener, ev);
761       /* clone doesn't have its own ref, so don't use spi_key_listener_free */
762     }
763
764   g_slist_free (notify);
765
766 #ifdef SPI_DEBUG
767   if (is_consumed) g_message ("consumed\n");
768 #endif
769   return is_consumed;
770 }
771
772 static gboolean
773 spi_clear_error_state ()
774 {
775         gboolean retval = spi_error_code != 0;
776         spi_error_code = 0;
777         return retval;
778 }
779
780 static Accessibility_DeviceEvent
781 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
782 {
783   Accessibility_DeviceEvent key_event;
784   KeySym keysym;
785   const int cbuf_bytes = 20;
786   char cbuf [cbuf_bytes];
787   
788   keysym = XLookupKeysym (x_key_event, 0);
789   key_event.id = (CORBA_long)(keysym);
790   key_event.hw_code = (CORBA_short) x_key_event->keycode;
791   if (((XEvent *) x_key_event)->type == KeyPress)
792     {
793       key_event.type = Accessibility_KEY_PRESSED;
794     }
795   else
796     {
797       key_event.type = Accessibility_KEY_RELEASED;
798     } 
799   key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
800   key_event.is_text = CORBA_FALSE;
801   switch (keysym)
802     {
803       case ' ':
804         key_event.event_string = CORBA_string_dup ("space");
805         break;
806       case XK_Tab:
807 #ifdef SPI_KEYEVENT_DEBUG
808         fprintf(stderr, "Tab\n");
809 #endif
810         key_event.event_string = CORBA_string_dup ("Tab");
811         break;
812       case XK_BackSpace:
813         key_event.event_string = CORBA_string_dup ("Backspace");
814         break;
815       case XK_Return:
816         key_event.event_string = CORBA_string_dup ("Return");
817         break;
818       case XK_Home:
819         key_event.event_string = CORBA_string_dup ("Home");
820         break;
821       case XK_Page_Down:
822         key_event.event_string = CORBA_string_dup ("Page_Down");
823         break;
824       case XK_Page_Up:
825         key_event.event_string = CORBA_string_dup ("Page_Up");
826         break;
827       case XK_F1:
828         key_event.event_string = CORBA_string_dup ("F1");
829         break;
830       case XK_F2:
831         key_event.event_string = CORBA_string_dup ("F2");
832         break;
833       case XK_F3:
834         key_event.event_string = CORBA_string_dup ("F3");
835         break;
836       case XK_F4:
837         key_event.event_string = CORBA_string_dup ("F4");
838         break;
839       case XK_F5:
840         key_event.event_string = CORBA_string_dup ("F5");
841         break;
842       case XK_F6:
843         key_event.event_string = CORBA_string_dup ("F6");
844         break;
845       case XK_F7:
846         key_event.event_string = CORBA_string_dup ("F7");
847         break;
848       case XK_F8:
849         key_event.event_string = CORBA_string_dup ("F8");
850         break;
851       case XK_F9:
852         key_event.event_string = CORBA_string_dup ("F9");
853         break;
854       case XK_F10:
855         key_event.event_string = CORBA_string_dup ("F10");
856         break;
857       case XK_F11:
858         key_event.event_string = CORBA_string_dup ("F11");
859         break;
860       case XK_F12:
861         key_event.event_string = CORBA_string_dup ("F12");
862         break;
863       case XK_End:
864         key_event.event_string = CORBA_string_dup ("End");
865         break;
866       case XK_Escape:
867         key_event.event_string = CORBA_string_dup ("Escape");
868         break;
869       case XK_Up:
870         key_event.event_string = CORBA_string_dup ("Up");
871         break;
872       case XK_Down:
873         key_event.event_string = CORBA_string_dup ("Down");
874         break;
875       case XK_Left:
876         key_event.event_string = CORBA_string_dup ("Left");
877         break;
878       case XK_Right:
879         key_event.event_string = CORBA_string_dup ("Right");
880         break;
881       default:
882         if (XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL) > 0)
883           {
884             key_event.event_string = CORBA_string_dup (cbuf);
885             if (isgraph (keysym))
886               {
887                 key_event.is_text = CORBA_TRUE; /* FIXME: incorrect for some composed chars? */
888               }
889           }
890         else
891           {
892             key_event.event_string = CORBA_string_dup ("");
893           }
894     }
895
896   key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
897 #ifdef SPI_KEYEVENT_DEBUG
898   fprintf (stderr,
899      "Key %lu pressed (%c), modifiers %d\n",
900      (unsigned long) keysym,
901      keysym ? (int) keysym : '*',
902      (int) x_key_event->state);
903 #endif
904 #ifdef SPI_DEBUG
905   fprintf (stderr, "%s%c",
906      (x_key_event->state & Mod1Mask)?"Alt-":"",
907      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
908      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
909 #endif /* SPI_DEBUG */
910   return key_event;     
911 }
912
913 static gboolean
914 spi_controller_update_key_grabs (SpiDEController           *controller,
915                                  Accessibility_DeviceEvent *recv)
916 {
917   GList *l, *next;
918   gboolean   update_failed = FALSE;
919   
920   g_return_val_if_fail (controller != NULL, FALSE);
921
922   /*
923    * masks known to work with default RH 7.1+:
924    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
925    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
926    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
927    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
928    *
929    * ControlMask grabs are broken, must be in use already
930    */
931   for (l = controller->keygrabs_list; l; l = next)
932     {
933       gboolean do_remove;
934       gboolean re_issue_grab;
935       DEControllerGrabMask *grab_mask = l->data;
936
937       next = l->next;
938
939       re_issue_grab = recv &&
940 /*            (recv->type == Accessibility_KEY_RELEASED) && - (?) */
941               (recv->modifiers & grab_mask->mod_mask) &&
942               (grab_mask->key_val == keycode_for_keysym (recv->id));
943
944 #ifdef SPI_DEBUG
945       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
946                (long int) grab_mask->key_val,
947                (long int) grab_mask->mod_mask,
948                grab_mask->pending_add ? '+' : '.',
949                grab_mask->pending_remove ? '-' : '.',
950                re_issue_grab ? "re-issue": "");
951 #endif
952
953       do_remove = FALSE;
954
955       if (grab_mask->pending_add && grab_mask->pending_remove)
956         {
957           do_remove = TRUE;
958         }
959       else if (grab_mask->pending_remove)
960         {
961 #ifdef SPI_DEBUG
962       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
963 #endif
964           XUngrabKey (spi_get_display (),
965                       grab_mask->key_val,
966                       grab_mask->mod_mask,
967                       gdk_x11_get_default_root_xwindow ());
968
969           do_remove = TRUE;
970         }
971       else if (grab_mask->pending_add || re_issue_grab)
972         {
973
974 #ifdef SPI_DEBUG
975           fprintf (stderr, "grab with mask %x\n", grab_mask->mod_mask);
976 #endif
977           XGrabKey (spi_get_display (),
978                     grab_mask->key_val,
979                     grab_mask->mod_mask,
980                     gdk_x11_get_default_root_xwindow (),
981                     True,
982                     GrabModeAsync,
983                     GrabModeAsync);
984           XSync (spi_get_display (), False);
985           update_failed = spi_clear_error_state ();
986           if (update_failed) {
987                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
988                   do_remove = TRUE;
989           }
990         }
991
992       grab_mask->pending_add = FALSE;
993       grab_mask->pending_remove = FALSE;
994
995       if (do_remove)
996         {
997           g_assert (grab_mask->ref_count <= 0);
998
999           controller->keygrabs_list = g_list_delete_link (
1000             controller->keygrabs_list, l);
1001
1002           spi_grab_mask_free (grab_mask);
1003         }
1004
1005     } 
1006
1007   return ! update_failed;
1008 }
1009
1010 /*
1011  * Implemented GObject::finalize
1012  */
1013 static void
1014 spi_device_event_controller_object_finalize (GObject *object)
1015 {
1016   SpiDEController *controller;
1017
1018   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1019
1020 #ifdef SPI_DEBUG
1021   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1022 #endif
1023   /* disconnect any special listeners, get rid of outstanding keygrabs */
1024   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1025         
1026   spi_device_event_controller_parent_class->finalize (object);
1027 }
1028
1029 /*
1030  * CORBA Accessibility::DEController::registerKeystrokeListener
1031  *     method implementation
1032  */
1033 static CORBA_boolean
1034 impl_register_keystroke_listener (PortableServer_Servant                  servant,
1035                                   const Accessibility_DeviceEventListener l,
1036                                   const Accessibility_KeySet             *keys,
1037                                   const Accessibility_ControllerEventMask mask,
1038                                   const Accessibility_KeyEventTypeSeq    *type,
1039                                   const Accessibility_EventListenerMode  *mode,
1040                                   CORBA_Environment                      *ev)
1041 {
1042   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1043           bonobo_object_from_servant (servant));
1044   DEControllerKeyListener *dec_listener;
1045 #ifdef SPI_DEBUG
1046   fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
1047            (void *) l, (unsigned long) mask);
1048 #endif
1049   dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
1050   return spi_controller_register_device_listener (
1051           controller, (DEControllerListener *) dec_listener, ev);
1052 }
1053
1054
1055 typedef struct {
1056         CORBA_Environment       *ev;
1057         DEControllerKeyListener *key_listener;
1058 } RemoveKeyListenerClosure;
1059
1060 static SpiReEntrantContinue
1061 remove_key_listener_cb (GList * const *list,
1062                         gpointer       user_data)
1063 {
1064   DEControllerKeyListener  *key_listener = (*list)->data;
1065   RemoveKeyListenerClosure *ctx = user_data;
1066
1067   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
1068                                   key_listener->listener.object, ctx->ev))
1069     {
1070       spi_re_entrant_list_delete_link (list);
1071       spi_dec_key_listener_free (key_listener, ctx->ev);
1072     }
1073
1074   return SPI_RE_ENTRANT_CONTINUE;
1075 }
1076
1077 static SpiReEntrantContinue
1078 copy_key_listener_cb (GList * const *list,
1079                       gpointer       user_data)
1080 {
1081   DEControllerKeyListener  *key_listener = (*list)->data;
1082   RemoveKeyListenerClosure *ctx = user_data;
1083
1084   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
1085                                   key_listener->listener.object, ctx->ev))
1086     {
1087       /* TODO: FIXME aggregate keys in case the listener is registered twice */
1088       CORBA_free (ctx->key_listener->keys);         
1089       ctx->key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
1090     }
1091
1092   return SPI_RE_ENTRANT_CONTINUE;
1093 }
1094
1095
1096 static void
1097 spi_deregister_controller_key_listener (SpiDEController            *controller,
1098                                         DEControllerKeyListener    *key_listener,
1099                                         CORBA_Environment          *ev)
1100 {
1101   RemoveKeyListenerClosure  ctx;
1102
1103   ctx.ev = ev;
1104   ctx.key_listener = key_listener;
1105
1106   /* special case, copy keyset from existing controller list entry */
1107   if (key_listener->keys->_length == 0) 
1108     {
1109       spi_re_entrant_list_foreach (&controller->key_listeners,
1110                                   copy_key_listener_cb, &ctx);
1111     }
1112   
1113   spi_controller_deregister_global_keygrabs (controller, key_listener);
1114
1115   spi_re_entrant_list_foreach (&controller->key_listeners,
1116                                 remove_key_listener_cb, &ctx);
1117
1118 }
1119
1120 /*
1121  * CORBA Accessibility::DEController::deregisterKeystrokeListener
1122  *     method implementation
1123  */
1124 static void
1125 impl_deregister_keystroke_listener (PortableServer_Servant                  servant,
1126                                     const Accessibility_DeviceEventListener l,
1127                                     const Accessibility_KeySet             *keys,
1128                                     const Accessibility_ControllerEventMask mask,
1129                                     const Accessibility_KeyEventTypeSeq    *type,
1130                                     CORBA_Environment                      *ev)
1131 {
1132   DEControllerKeyListener  *key_listener;
1133   SpiDEController *controller;
1134
1135   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1136
1137   key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
1138
1139 #ifdef SPI_DEREGISTER_DEBUG
1140   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
1141            (void *) l, (unsigned long) mask->value);
1142 #endif
1143
1144   spi_deregister_controller_key_listener (controller, key_listener, ev);
1145
1146   spi_dec_key_listener_free (key_listener, ev);
1147 }
1148
1149 /*
1150  * CORBA Accessibility::DEController::registerKeystrokeListener
1151  *     method implementation
1152  */
1153 static void
1154 impl_generate_keyboard_event (PortableServer_Servant           servant,
1155                               const CORBA_long                 keycode,
1156                               const CORBA_char                *keystring,
1157                               const Accessibility_KeySynthType synth_type,
1158                               CORBA_Environment               *ev)
1159 {
1160   long key_synth_code;
1161
1162 #ifdef SPI_DEBUG
1163   fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
1164            (long) keycode, (int) synth_type);
1165 #endif
1166   /* TODO: hide/wrap/remove X dependency */
1167
1168   /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
1169         
1170   /*
1171    * TODO: when initializing, query for XTest extension before using,
1172    * and fall back to XSendEvent() if XTest is not available.
1173    */
1174   
1175   /* TODO: implement keystring mode also */
1176   gdk_error_trap_push ();
1177
1178   switch (synth_type)
1179     {
1180       case Accessibility_KEY_PRESS:
1181         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
1182         break;
1183       case Accessibility_KEY_PRESSRELEASE:
1184         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
1185       case Accessibility_KEY_RELEASE:
1186         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, False, CurrentTime);
1187         break;
1188       case Accessibility_KEY_SYM:
1189         key_synth_code = keycode_for_keysym (keycode);
1190         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, True, CurrentTime);
1191         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, False, CurrentTime);
1192         break;
1193       case Accessibility_KEY_STRING:
1194         fprintf (stderr, "Not yet implemented\n");
1195         break;
1196     }
1197   if (gdk_error_trap_pop ())
1198     {
1199       g_warning ("Error emitting keystroke");
1200     }
1201 }
1202
1203 /* Accessibility::DEController::generateMouseEvent */
1204 static void
1205 impl_generate_mouse_event (PortableServer_Servant servant,
1206                            const CORBA_long       x,
1207                            const CORBA_long       y,
1208                            const CORBA_char      *eventName,
1209                            CORBA_Environment     *ev)
1210 {
1211   int button;
1212   gboolean error = FALSE;
1213   Display *display = spi_get_display ();
1214 #ifdef SPI_DEBUG
1215   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
1216            eventName, (long int) x, (long int) y);
1217 #endif
1218   g_message ("mouse event synthesis\n");
1219   switch (eventName[0])
1220     {
1221       case 'b':
1222         switch (eventName[1])
1223           {
1224           /* TODO: check number of buttons before parsing */
1225           case '1':
1226                     button = 1;
1227                     break;
1228           case '2':
1229                   button = 2;
1230                   break;
1231           case '3':
1232                   button = 3;
1233                   break;
1234           default:
1235                   error = TRUE;
1236           }
1237         if (!error)
1238           {
1239             if (x != -1 && y != -1)
1240               {
1241                 XTestFakeMotionEvent (display, DefaultScreen (display),
1242                                       x, y, 0);
1243               }
1244             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
1245             if (eventName[2] == 'c')
1246               XTestFakeButtonEvent (display, button, FALSE, 1);
1247             else if (eventName[2] == 'd')
1248               {
1249               XTestFakeButtonEvent (display, button, FALSE, 1);
1250               XTestFakeButtonEvent (display, button, TRUE, 2);
1251               XTestFakeButtonEvent (display, button, FALSE, 3);
1252               }
1253           }
1254         break;
1255       case 'r': /* relative motion */ 
1256         XTestFakeRelativeMotionEvent (display, x, y, 0);
1257         break;
1258       case 'a': /* absolute motion */
1259         XTestFakeMotionEvent (display, DefaultScreen (display),
1260                               x, y, 0);
1261         break;
1262     }
1263 }
1264
1265 /* Accessibility::DEController::notifyListenersSync */
1266 static CORBA_boolean
1267 impl_notify_listeners_sync (PortableServer_Servant           servant,
1268                             const Accessibility_DeviceEvent *event,
1269                             CORBA_Environment               *ev)
1270 {
1271   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1272     bonobo_object_from_servant (servant));
1273 #ifdef SPI_DEBUG
1274   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
1275            controller, (int) event->id);
1276 #endif
1277   return spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev) ?
1278           CORBA_TRUE : CORBA_FALSE; 
1279 }
1280
1281 /* Accessibility::DEController::notifyListenersAsync */
1282 static void
1283 impl_notify_listeners_async (PortableServer_Servant           servant,
1284                              const Accessibility_DeviceEvent *event,
1285                              CORBA_Environment               *ev)
1286 {
1287   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1288     bonobo_object_from_servant (servant));
1289 #ifdef SPI_DEBUG
1290   fprintf (stderr, "notifying listeners asynchronously\n");
1291 #endif
1292   spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev); 
1293 }
1294
1295 static void
1296 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
1297 {
1298   GObjectClass * object_class = (GObjectClass *) klass;
1299   POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
1300
1301   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
1302   
1303   object_class->finalize = spi_device_event_controller_object_finalize;
1304         
1305   epv->registerKeystrokeListener   = impl_register_keystroke_listener;
1306   epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
1307   epv->generateKeyboardEvent       = impl_generate_keyboard_event;
1308   epv->generateMouseEvent          = impl_generate_mouse_event;
1309   epv->notifyListenersSync         = impl_notify_listeners_sync;
1310   epv->notifyListenersAsync        = impl_notify_listeners_async;
1311 }
1312
1313 static void
1314 spi_device_event_controller_init (SpiDEController *device_event_controller)
1315 {
1316   device_event_controller->key_listeners   = NULL;
1317   device_event_controller->mouse_listeners = NULL;
1318   device_event_controller->keygrabs_list   = NULL;
1319
1320   /*
1321    * TODO: fixme, this module makes the foolish assumptions that
1322    * registryd uses the same display as the apps, and that the
1323    * DISPLAY environment variable is set.
1324    */
1325   gdk_init (NULL, NULL);
1326   
1327   spi_controller_register_with_devices (device_event_controller);
1328 }
1329
1330 static void
1331 spi_device_event_controller_forward_key_event (SpiDEController *controller,
1332                                                const XEvent    *event)
1333 {
1334   gboolean is_consumed = FALSE;
1335   CORBA_Environment ev;
1336   Accessibility_DeviceEvent key_event;
1337
1338   g_assert (event->type == KeyPress || event->type == KeyRelease);
1339
1340   CORBA_exception_init (&ev);
1341
1342   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
1343
1344   spi_controller_update_key_grabs (controller, &key_event);
1345
1346   /* relay to listeners, and decide whether to consume it or not */
1347   is_consumed = spi_controller_notify_keylisteners (
1348           controller, &key_event, CORBA_TRUE, &ev);
1349
1350   CORBA_exception_free (&ev);
1351
1352   if (is_consumed)
1353     {
1354       XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
1355     }
1356   else
1357     {
1358       XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
1359     }
1360 }
1361
1362 SpiDEController *
1363 spi_device_event_controller_new (SpiRegistry *registry)
1364 {
1365   SpiDEController *retval = g_object_new (
1366     SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
1367
1368   retval->registry = SPI_REGISTRY (bonobo_object_ref (
1369           BONOBO_OBJECT (registry)));
1370
1371   spi_dec_init_mouse_listener (registry);
1372   /* TODO: kill mouse listener on finalize */
1373   
1374   return retval;
1375 }
1376
1377 BONOBO_TYPE_FUNC_FULL (SpiDEController,
1378                        Accessibility_DeviceEventController,
1379                        PARENT_TYPE,
1380                        spi_device_event_controller);