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