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