Added boolean return types for methods in Component, Selection,
[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 /* deviceeventcontroler.c: implement the DeviceEventController interface */
24
25 #include <config.h>
26
27 #define  SPI_DEBUG
28
29 #include <string.h>
30 #include <ctype.h>
31 #include <stdio.h>
32 #include <bonobo/bonobo-exception.h>
33
34 #include <X11/Xlib.h>
35 #include <X11/extensions/XTest.h>
36 #define XK_MISCELLANY
37 #include <X11/keysymdef.h>
38 #include <gdk/gdk.h>
39 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
40 #include <gdk/gdkkeysyms.h>
41 #include <gdk/gdkwindow.h>
42
43 #include "../libspi/spi-private.h"
44 #include "deviceeventcontroller.h"
45
46 /* Our parent Gtk object type */
47 #define PARENT_TYPE BONOBO_TYPE_OBJECT
48
49 /* A pointer to our parent object class */
50 static GObjectClass *spi_device_event_controller_parent_class;
51
52 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
53
54 typedef enum {
55   SPI_DEVICE_TYPE_KBD,
56   SPI_DEVICE_TYPE_MOUSE,
57   SPI_DEVICE_TYPE_LAST_DEFINED
58 } SpiDeviceTypeCategory;
59
60 typedef struct {
61   guint                             ref_count : 30;
62   guint                             pending_add : 1;
63   guint                             pending_remove : 1;
64
65   Accessibility_ControllerEventMask mod_mask;
66   CORBA_unsigned_long               key_val;  /* KeyCode */
67 } DEControllerGrabMask;
68
69 typedef struct {
70   CORBA_Object          object;
71   SpiDeviceTypeCategory type;
72 } DEControllerListener;
73
74 typedef struct {
75   DEControllerListener listener;
76
77   Accessibility_KeySet             *keys;
78   Accessibility_ControllerEventMask mask;
79   Accessibility_KeyEventTypeSeq    *typeseq;
80   Accessibility_EventListenerMode  *mode;       
81 } DEControllerKeyListener;
82
83 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
84 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
85                                                                Accessibility_DeviceEvent *recv);
86 static void     spi_controller_register_device_listener       (SpiDEController           *controller,
87                                                                DEControllerListener      *l,
88                                                                CORBA_Environment         *ev);
89 static void     spi_device_event_controller_forward_key_event (SpiDEController           *controller,
90                                                                const XEvent              *event);
91
92 #define spi_get_display() GDK_DISPLAY()
93
94 /* Private methods */
95
96 static KeyCode
97 keycode_for_keysym (long keysym)
98 {
99   return XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
100 }
101
102 static DEControllerGrabMask *
103 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
104 {
105   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
106
107   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
108
109   clone->ref_count = 1;
110   clone->pending_add = TRUE;
111   clone->pending_remove = FALSE;
112
113   return clone;
114 }
115
116 static void
117 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
118 {
119   g_free (grab_mask);
120 }
121
122 static gint
123 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
124 {
125   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
126   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
127
128   if (p1 == p2)
129     {
130       return 0;
131     }
132   else
133     { 
134       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
135     }
136 }
137
138 static DEControllerKeyListener *
139 spi_dec_key_listener_new (CORBA_Object                            l,
140                           const Accessibility_KeySet             *keys,
141                           const Accessibility_ControllerEventMask mask,
142                           const Accessibility_KeyEventTypeSeq    *typeseq,
143                           const Accessibility_EventListenerMode  *mode,
144                           CORBA_Environment                      *ev)
145 {
146   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
147   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
148   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
149   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
150   key_listener->mask = mask;
151   key_listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_KeyEventTypeSeq);
152   if (mode)
153     key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
154   else
155     key_listener->mode = NULL;
156
157 #ifdef SPI_DEBUG
158   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
159            (unsigned int) key_listener->mask,
160            (int) (mode ? mode->global : 0),
161            (void *) key_listener->keys,
162            (int) (key_listener->keys ? key_listener->keys->_length : 0));
163 #endif
164
165   return key_listener;  
166 }
167
168 static void
169 spi_dec_key_listener_free (DEControllerKeyListener *key_listener,
170                            CORBA_Environment       *ev)
171 {
172   bonobo_object_release_unref (key_listener->listener.object, ev);
173   CORBA_free (key_listener->typeseq);
174   CORBA_free (key_listener->keys);
175   g_free (key_listener);
176 }
177
178 static void
179 _register_keygrab (SpiDEController      *controller,
180                    DEControllerGrabMask *grab_mask)
181 {
182   GList *l;
183
184   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
185                           spi_grab_mask_compare_values);
186   if (l)
187     {
188       DEControllerGrabMask *cur_mask = l->data;
189
190       cur_mask->ref_count++;
191       if (cur_mask->pending_remove)
192         {
193           cur_mask->pending_remove = FALSE;
194         }
195     }
196   else
197     {
198       controller->keygrabs_list =
199         g_list_prepend (controller->keygrabs_list,
200                         spi_grab_mask_clone (grab_mask));
201     }
202 }
203
204 static void
205 _deregister_keygrab (SpiDEController      *controller,
206                      DEControllerGrabMask *grab_mask)
207 {
208   GList *l;
209
210   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
211                           spi_grab_mask_compare_values);
212
213   if (l)
214     {
215       DEControllerGrabMask *cur_mask = l->data;
216
217       cur_mask->ref_count--;
218       if (cur_mask->ref_count <= 0)
219         {
220           cur_mask->pending_remove = TRUE;
221         }
222     }
223   else
224     {
225       g_warning ("De-registering non-existant grab");
226     }
227 }
228
229 static void
230 handle_keygrab (SpiDEController         *controller,
231                 DEControllerKeyListener *key_listener,
232                 void                   (*process_cb) (SpiDEController *controller,
233                                                       DEControllerGrabMask *grab_mask))
234 {
235   DEControllerGrabMask grab_mask = { 0 };
236
237   grab_mask.mod_mask = key_listener->mask;
238   if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
239     {
240       grab_mask.key_val = AnyKey;
241       process_cb (controller, &grab_mask);
242     }
243   else
244     {
245       int i;
246
247       for (i = 0; i < key_listener->keys->_length; ++i)
248         {
249           long int key_val = key_listener->keys->_buffer[i];
250           /* X Grabs require keycodes, not keysyms */
251           if (key_val >= 0)
252             {
253               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
254             }
255           grab_mask.key_val = key_val;
256
257           process_cb (controller, &grab_mask);
258         }
259     }
260 }
261
262 static void
263 spi_controller_register_global_keygrabs (SpiDEController         *controller,
264                                          DEControllerKeyListener *key_listener)
265 {
266   handle_keygrab (controller, key_listener, _register_keygrab);
267   spi_controller_update_key_grabs (controller, NULL);
268 }
269
270 static void
271 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
272                                            DEControllerKeyListener *key_listener)
273 {
274   handle_keygrab (controller, key_listener, _deregister_keygrab);
275   spi_controller_update_key_grabs (controller, NULL);
276 }
277
278 static void
279 spi_controller_register_device_listener (SpiDEController      *controller,
280                                          DEControllerListener *listener,
281                                          CORBA_Environment    *ev)
282 {
283   DEControllerKeyListener *key_listener;
284   
285   switch (listener->type) {
286   case SPI_DEVICE_TYPE_KBD:
287       key_listener = (DEControllerKeyListener *) listener;
288
289       controller->key_listeners = g_list_prepend (controller->key_listeners,
290                                                   key_listener);
291       if (key_listener->mode->global)
292         {
293           spi_controller_register_global_keygrabs (controller, key_listener);   
294         }
295       break;
296     default:
297       break;
298   }
299 }
300
301 static GdkFilterReturn
302 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
303 {
304   XEvent *xevent = gdk_xevent;
305   SpiDEController *controller;
306
307   if (xevent->type != KeyPress && xevent->type != KeyRelease)
308     {
309       return GDK_FILTER_CONTINUE;
310     }
311
312   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
313
314   spi_device_event_controller_forward_key_event (controller, xevent);
315
316   /* FIXME: is this right ? */
317   return GDK_FILTER_CONTINUE;
318 }
319
320 int
321 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
322 {
323   if (error->error_code == BadAccess) 
324     {  
325       g_message ("Could not complete key grab: grab already in use.\n");
326       return 0;
327     }
328   else 
329     {
330       return (*x_default_error_handler) (display, error);
331     }
332 }
333
334 static void
335 spi_controller_register_with_devices (SpiDEController *controller)
336 {
337   /* calls to device-specific implementations and routines go here */
338   /* register with: keyboard hardware code handler */
339   /* register with: (translated) keystroke handler */
340
341   gdk_window_add_filter (NULL, global_filter_fn, controller);
342
343   gdk_window_set_events (gdk_get_default_root_window (),
344                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
345
346   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
347 }
348
349 static gboolean
350 spi_key_set_contains_key (Accessibility_KeySet            *key_set,
351                           const Accessibility_DeviceEvent *key_event)
352 {
353   gint i;
354   gint len;
355
356   if (!key_set)
357     {
358       g_print ("null key set!");
359       return TRUE;
360     }
361
362   len = key_set->_length;
363   
364   if (len == 0) /* special case, means "all keys/any key" */
365     {
366       g_print ("anykey\n");         
367       return TRUE;
368     }
369
370   for (i = 0; i < len; ++i)
371     {
372 #ifdef SPI_KEYEVENT_DEBUG           
373       g_print ("key_set[%d] = %d; key_event %d, code %d\n",
374                 i, (int) key_set->_buffer[i],
375                (int) key_event->id, (int) key_event->hw_code); 
376 #endif
377       if (key_set->_buffer[i] == (CORBA_long) key_event->id)
378         {
379           return TRUE;
380         }
381       if (key_set->_buffer[i] == (CORBA_long) -key_event->hw_code)
382         {
383           return TRUE;
384         }
385     }
386   
387   return FALSE;
388 }
389
390 static gboolean
391 spi_key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq   *type_seq,
392                                       const Accessibility_DeviceEvent *key_event)
393 {
394   gint i;
395   gint len;
396
397
398   if (!type_seq)
399     {
400       g_print ("null type seq!");
401       return TRUE;
402     }
403
404   len = type_seq->_length;
405   
406   if (len == 0) /* special case, means "all events/any event" */
407     {
408       return TRUE;
409     }
410
411   for (i = 0; i < len; ++i)
412     {
413 #ifdef SPI_DEBUG            
414       g_print ("type_seq[%d] = %d; key event type = %d\n", i,
415                (int) type_seq->_buffer[i], (int) key_event->type);
416 #endif      
417       if (type_seq->_buffer[i] == (CORBA_long) key_event->type)
418         {
419           return TRUE;
420         }
421     }
422   
423   return FALSE;
424 }
425
426 static gboolean
427 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
428                                 DEControllerKeyListener         *listener,
429                                 CORBA_boolean                    is_system_global)
430 {
431   if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFFFF)) &&
432        spi_key_set_contains_key (listener->keys, key_event) &&
433        spi_key_eventtype_seq_contains_event (listener->typeseq, key_event) && 
434       (is_system_global == listener->mode->global))
435     {
436       return TRUE;
437     }
438   else
439     {
440       return FALSE;
441     }
442 }
443
444 static gboolean
445 spi_notify_keylisteners (GList                          **key_listeners,
446                          const Accessibility_DeviceEvent *key_event,
447                          CORBA_boolean                    is_system_global,
448                          CORBA_Environment               *ev)
449 {
450   GList   *l;
451   GSList  *notify = NULL, *l2;
452   gboolean is_consumed;
453
454   if (!key_listeners)
455     {
456       return FALSE;
457     }
458
459   for (l = *key_listeners; l; l = l->next)
460     {
461        DEControllerKeyListener *key_listener = l->data;
462
463        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
464          {
465            Accessibility_DeviceEventListener ls = key_listener->listener.object;
466
467            if (ls != CORBA_OBJECT_NIL)
468              {
469                notify = g_slist_prepend (notify, CORBA_Object_duplicate (ls, ev));
470              }
471          }
472     }
473
474 #ifdef SPI_KEYEVENT_DEBUG
475   if (!notify)
476     {
477       g_print ("no match for listener %d\n", i);
478     }
479 #endif
480
481   is_consumed = FALSE;
482   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
483     {
484       Accessibility_DeviceEventListener ls = l2->data;
485
486       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
487
488       if (BONOBO_EX (ev))
489         {
490           is_consumed = FALSE;
491           CORBA_exception_free (ev);
492         }
493
494       CORBA_Object_release (ls, ev);
495     }
496
497   for (; l2; l2 = l2->next)
498     {
499       CORBA_Object_release (l2->data, ev);
500     }
501
502   g_slist_free (notify);
503
504 #ifdef SPI_DEBUG
505   if (is_consumed) g_message ("consumed\n");
506 #endif
507   return is_consumed;
508 }
509
510 static Accessibility_DeviceEvent
511 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
512 {
513   Accessibility_DeviceEvent key_event;
514   KeySym keysym;
515   const int cbuf_bytes = 20;
516   char cbuf [cbuf_bytes];
517   
518   keysym = XLookupKeysym (x_key_event, 0);
519   key_event.id = (CORBA_long)(keysym);
520   key_event.hw_code = (CORBA_short) x_key_event->keycode;
521   if (((XEvent *) x_key_event)->type == KeyPress)
522     {
523       key_event.type = Accessibility_KEY_PRESSED;
524     }
525   else
526     {
527       key_event.type = Accessibility_KEY_RELEASED;
528     } 
529   key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
530   key_event.is_text = CORBA_FALSE;
531   switch (keysym)
532     {
533       case ' ':
534         key_event.event_string = CORBA_string_dup ("space");
535         break;
536       case XK_Tab:
537         key_event.event_string = CORBA_string_dup ("Tab");
538         break;
539       case XK_BackSpace:
540         key_event.event_string = CORBA_string_dup ("Backspace");
541         break;
542       case XK_Return:
543         key_event.event_string = CORBA_string_dup ("Return");
544         break;
545       default:
546         if (XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL) > 0)
547           {
548             key_event.event_string = CORBA_string_dup (cbuf);
549             if (isgraph (keysym))
550               {
551                 key_event.is_text = CORBA_TRUE; /* FIXME: incorrect for some composed chars? */
552               }
553           }
554         else
555           {
556             key_event.event_string = CORBA_string_dup ("");
557           }
558     }
559
560   key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
561 #ifdef SPI_KEYEVENT_DEBUG
562   fprintf (stderr,
563      "Key %lu pressed (%c), modifiers %d\n",
564      (unsigned long) keysym,
565      keysym ? (int) keysym : '*',
566      (int) x_key_event->state);
567 #endif
568 #ifdef SPI_DEBUG
569   fprintf (stderr, "%s%c",
570      (x_key_event->state & Mod1Mask)?"Alt-":"",
571      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
572      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
573 #endif /* SPI_DEBUG */
574   return key_event;     
575 }
576
577 static gboolean
578 spi_controller_update_key_grabs (SpiDEController           *controller,
579                                  Accessibility_DeviceEvent *recv)
580 {
581   GList *l, *next;
582
583   g_return_val_if_fail (controller != NULL, FALSE);
584
585   /*
586    * masks known to work with default RH 7.1+:
587    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
588    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
589    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
590    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
591    *
592    * ControlMask grabs are broken, must be in use already
593    */
594   for (l = controller->keygrabs_list; l; l = next)
595     {
596       gboolean do_remove;
597       gboolean re_issue_grab;
598       DEControllerGrabMask *grab_mask = l->data;
599
600       next = l->next;
601
602       re_issue_grab = recv &&
603 /*            (recv->type == Accessibility_KEY_RELEASED) && - (?) */
604               (recv->modifiers & grab_mask->mod_mask) &&
605               (grab_mask->key_val == keycode_for_keysym (recv->id));
606
607 #ifdef SPI_DEBUG
608       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
609                (long int) grab_mask->key_val,
610                (long int) grab_mask->mod_mask,
611                grab_mask->pending_add ? '+' : '.',
612                grab_mask->pending_remove ? '-' : '.',
613                re_issue_grab ? "re-issue": "");
614 #endif
615
616       do_remove = FALSE;
617
618       if (grab_mask->pending_add && grab_mask->pending_remove)
619         {
620           do_remove = TRUE;
621         }
622       else if (grab_mask->pending_remove)
623         {
624 #ifdef SPI_DEBUG
625       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
626 #endif
627           XUngrabKey (spi_get_display (),
628                       grab_mask->key_val,
629                       grab_mask->mod_mask,
630                       gdk_x11_get_default_root_xwindow ());
631
632           do_remove = TRUE;
633         }
634       else if (grab_mask->pending_add || re_issue_grab)
635         {
636
637 #ifdef SPI_DEBUG
638           fprintf (stderr, "grab with mask %x\n", grab_mask->mod_mask);
639 #endif
640           XGrabKey (spi_get_display (),
641                     grab_mask->key_val,
642                     grab_mask->mod_mask,
643                     gdk_x11_get_default_root_xwindow (),
644                     True,
645                     GrabModeAsync,
646                     GrabModeAsync);
647         }
648
649       grab_mask->pending_add = FALSE;
650       grab_mask->pending_remove = FALSE;
651
652       if (do_remove)
653         {
654           g_assert (grab_mask->ref_count <= 0);
655
656           controller->keygrabs_list = g_list_delete_link (
657             controller->keygrabs_list, l);
658
659           spi_grab_mask_free (grab_mask);
660         }
661
662       /* TODO: check calls for errors and return FALSE if error occurs */
663     } 
664
665   return TRUE;
666 }
667
668 /*
669  * Implemented GObject::finalize
670  */
671 static void
672 spi_device_event_controller_object_finalize (GObject *object)
673 {
674   SpiDEController *controller;
675
676   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
677
678 #ifdef SPI_DEBUG
679   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
680 #endif
681   /* disconnect any special listeners, get rid of outstanding keygrabs */
682   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
683         
684   spi_device_event_controller_parent_class->finalize (object);
685 }
686
687 /*
688  * CORBA Accessibility::DEController::registerKeystrokeListener
689  *     method implementation
690  */
691 static void
692 impl_register_keystroke_listener (PortableServer_Servant                  servant,
693                                   const Accessibility_DeviceEventListener l,
694                                   const Accessibility_KeySet             *keys,
695                                   const Accessibility_ControllerEventMask mask,
696                                   const Accessibility_KeyEventTypeSeq    *type,
697                                   const Accessibility_EventListenerMode  *mode,
698                                   CORBA_Environment                      *ev)
699 {
700   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
701           bonobo_object_from_servant (servant));
702   DEControllerKeyListener *dec_listener;
703 #ifdef SPI_DEBUG
704   fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
705            (void *) l, (unsigned long) mask);
706 #endif
707   dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
708   spi_controller_register_device_listener (
709     controller, (DEControllerListener *) dec_listener, ev);
710 }
711
712
713 typedef struct {
714         CORBA_Environment       *ev;
715         DEControllerKeyListener *key_listener;
716 } RemoveKeyListenerClosure;
717
718 static SpiReEntrantContinue
719 remove_key_listener_cb (GList * const *list,
720                         gpointer       user_data)
721 {
722   DEControllerKeyListener  *key_listener = (*list)->data;
723   RemoveKeyListenerClosure *ctx = user_data;
724
725   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
726                                   key_listener->listener.object, ctx->ev))
727     {
728       spi_re_entrant_list_delete_link (list);
729       spi_dec_key_listener_free (key_listener, ctx->ev);
730     }
731
732   return SPI_RE_ENTRANT_CONTINUE;
733 }
734
735 static SpiReEntrantContinue
736 copy_key_listener_cb (GList * const *list,
737                       gpointer       user_data)
738 {
739   DEControllerKeyListener  *key_listener = (*list)->data;
740   RemoveKeyListenerClosure *ctx = user_data;
741
742   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
743                                   key_listener->listener.object, ctx->ev))
744     {
745       /* TODO: FIXME aggregate keys in case the listener is registered twice */
746       CORBA_free (ctx->key_listener->keys);         
747       ctx->key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
748     }
749
750   return SPI_RE_ENTRANT_CONTINUE;
751 }
752
753 /*
754  * CORBA Accessibility::DEController::deregisterKeystrokeListener
755  *     method implementation
756  */
757 static void
758 impl_deregister_keystroke_listener (PortableServer_Servant                  servant,
759                                     const Accessibility_DeviceEventListener l,
760                                     const Accessibility_KeySet             *keys,
761                                     const Accessibility_ControllerEventMask mask,
762                                     const Accessibility_KeyEventTypeSeq    *type,
763                                     CORBA_Environment                      *ev)
764 {
765   DEControllerKeyListener  *key_listener;
766   RemoveKeyListenerClosure  ctx;
767   SpiDEController *controller;
768
769   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
770
771   key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
772
773 #ifdef SPI_DEREGISTER_DEBUG
774   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
775            (void *) l, (unsigned long) mask->value);
776 #endif
777
778   ctx.ev = ev;
779   ctx.key_listener = key_listener;
780
781   /* special case, copy keyset from existing controller list entry */
782   if (keys->_length == 0) 
783     {
784       spi_re_entrant_list_foreach (&controller->key_listeners,
785                                   copy_key_listener_cb, &ctx);
786     }
787   
788   spi_controller_deregister_global_keygrabs (controller, key_listener);
789
790   spi_re_entrant_list_foreach (&controller->key_listeners,
791                                 remove_key_listener_cb, &ctx);
792
793   spi_dec_key_listener_free (key_listener, ev);
794 }
795
796 /*
797  * CORBA Accessibility::DEController::registerKeystrokeListener
798  *     method implementation
799  */
800 static void
801 impl_generate_keyboard_event (PortableServer_Servant           servant,
802                               const CORBA_long                 keycode,
803                               const CORBA_char                *keystring,
804                               const Accessibility_KeySynthType synth_type,
805                               CORBA_Environment               *ev)
806 {
807   long key_synth_code;
808
809 #ifdef SPI_DEBUG
810   fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
811            (long) keycode, (int) synth_type);
812 #endif
813   /* TODO: hide/wrap/remove X dependency */
814
815   /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
816         
817   /*
818    * TODO: when initializing, query for XTest extension before using,
819    * and fall back to XSendEvent() if XTest is not available.
820    */
821   
822   /* TODO: implement keystring mode also */
823   gdk_error_trap_push ();
824
825   switch (synth_type)
826     {
827       case Accessibility_KEY_PRESS:
828         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
829         break;
830       case Accessibility_KEY_PRESSRELEASE:
831         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
832       case Accessibility_KEY_RELEASE:
833         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, False, CurrentTime);
834         break;
835       case Accessibility_KEY_SYM:
836         key_synth_code = keycode_for_keysym (keycode);
837         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, True, CurrentTime);
838         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, False, CurrentTime);
839         break;
840       case Accessibility_KEY_STRING:
841         fprintf (stderr, "Not yet implemented\n");
842         break;
843     }
844   if (gdk_error_trap_pop ())
845     {
846       g_warning ("Error emitting keystroke");
847     }
848 }
849
850 /* Accessibility::DEController::generateMouseEvent */
851 static void
852 impl_generate_mouse_event (PortableServer_Servant servant,
853                            const CORBA_long       x,
854                            const CORBA_long       y,
855                            const CORBA_char      *eventName,
856                            CORBA_Environment     *ev)
857 {
858   int button;
859   gboolean error = FALSE;
860   Display *display = spi_get_display ();
861 #ifdef SPI_DEBUG
862   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
863            eventName, (long int) x, (long int) y);
864 #endif
865   g_message ("mouse event synthesis\n");
866   switch (eventName[0])
867     {
868       case 'b':
869         switch (eventName[1])
870           {
871           /* TODO: check number of buttons before parsing */
872           case '1':
873                     button = 1;
874                     break;
875           case '2':
876                   button = 2;
877                   break;
878           case '3':
879                   button = 3;
880                   break;
881           default:
882                   error = TRUE;
883           }
884         if (!error)
885           {
886             if (x != -1 && y != -1)
887               {
888                 XTestFakeMotionEvent (display, DefaultScreen (display),
889                                       x, y, 0);
890               }
891             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
892             if (eventName[2] == 'c')
893               XTestFakeButtonEvent (display, button, FALSE, 1);
894             else if (eventName[2] == 'd')
895               {
896               XTestFakeButtonEvent (display, button, FALSE, 1);
897               XTestFakeButtonEvent (display, button, TRUE, 2);
898               XTestFakeButtonEvent (display, button, FALSE, 3);
899               }
900           }
901         break;
902       case 'r': /* relative motion */ 
903         XTestFakeRelativeMotionEvent (display, x, y, 0);
904         break;
905       case 'a': /* absolute motion */
906         XTestFakeMotionEvent (display, DefaultScreen (display),
907                               x, y, 0);
908         break;
909     }
910 }
911
912 /* Accessibility::DEController::notifyListenersSync */
913 static CORBA_boolean
914 impl_notify_listeners_sync (PortableServer_Servant           servant,
915                             const Accessibility_DeviceEvent *event,
916                             CORBA_Environment               *ev)
917 {
918   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
919     bonobo_object_from_servant (servant));
920 #ifdef SPI_DEBUG
921   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
922            controller, (int) event->id);
923 #endif
924   return spi_notify_keylisteners (&controller->key_listeners, event, CORBA_FALSE, ev) ?
925           CORBA_TRUE : CORBA_FALSE; 
926 }
927
928 /* Accessibility::DEController::notifyListenersAsync */
929 static void
930 impl_notify_listeners_async (PortableServer_Servant           servant,
931                              const Accessibility_DeviceEvent *event,
932                              CORBA_Environment               *ev)
933 {
934   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
935     bonobo_object_from_servant (servant));
936 #ifdef SPI_DEBUG
937   fprintf (stderr, "notifying listeners asynchronously\n");
938 #endif
939   spi_notify_keylisteners (&controller->key_listeners, event, CORBA_FALSE, ev); 
940 }
941
942 static void
943 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
944 {
945   GObjectClass * object_class = (GObjectClass *) klass;
946   POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
947
948   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
949   
950   object_class->finalize = spi_device_event_controller_object_finalize;
951         
952   epv->registerKeystrokeListener   = impl_register_keystroke_listener;
953   epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
954   epv->generateKeyboardEvent       = impl_generate_keyboard_event;
955   epv->generateMouseEvent          = impl_generate_mouse_event;
956   epv->notifyListenersSync         = impl_notify_listeners_sync;
957   epv->notifyListenersAsync        = impl_notify_listeners_async;
958 }
959
960 static void
961 spi_device_event_controller_init (SpiDEController *device_event_controller)
962 {
963   device_event_controller->key_listeners   = NULL;
964   device_event_controller->mouse_listeners = NULL;
965   device_event_controller->keygrabs_list   = NULL;
966
967   /*
968    * TODO: fixme, this module makes the foolish assumptions that
969    * registryd uses the same display as the apps, and that the
970    * DISPLAY environment variable is set.
971    */
972   gdk_init (NULL, NULL);
973   
974   spi_controller_register_with_devices (device_event_controller);
975 }
976
977 static void
978 spi_device_event_controller_forward_key_event (SpiDEController *controller,
979                                                const XEvent    *event)
980 {
981   gboolean is_consumed = FALSE;
982   CORBA_Environment ev;
983   Accessibility_DeviceEvent key_event;
984
985   g_assert (event->type == KeyPress || event->type == KeyRelease);
986
987   CORBA_exception_init (&ev);
988
989   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
990
991   spi_controller_update_key_grabs (controller, &key_event);
992
993   /* relay to listeners, and decide whether to consume it or not */
994   is_consumed = spi_notify_keylisteners (
995     &controller->key_listeners, &key_event, CORBA_TRUE, &ev);
996
997   CORBA_exception_free (&ev);
998
999   if (is_consumed)
1000     {
1001       XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
1002     }
1003   else
1004     {
1005       XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
1006     }
1007 }
1008
1009 SpiDEController *
1010 spi_device_event_controller_new (SpiRegistry *registry)
1011 {
1012   SpiDEController *retval = g_object_new (
1013     SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
1014
1015   retval->registry = SPI_REGISTRY (bonobo_object_ref (
1016           BONOBO_OBJECT (registry)));
1017
1018   return retval;
1019 }
1020
1021 BONOBO_TYPE_FUNC_FULL (SpiDEController,
1022                        Accessibility_DeviceEventController,
1023                        PARENT_TYPE,
1024                        spi_device_event_controller);