1 /* AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2003 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
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.
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.
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.
24 /* deviceeventcontroller.c: implement the DeviceEventController interface */
30 #undef SPI_KEYEVENT_DEBUG
36 #include <bonobo/bonobo-exception.h>
39 #include <X11/extensions/XTest.h>
40 #include <X11/XKBlib.h>
42 #include <X11/keysymdef.h>
45 #include <X11/Xproto.h>
47 #include <X11/extensions/Xevie.h>
48 #endif /* HAVE_XEVIE */
51 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
52 #include <gdk/gdkkeysyms.h>
53 #include <gdk/gdkwindow.h>
55 #include "../libspi/spi-private.h"
56 #include "deviceeventcontroller.h"
58 #define CHECK_RELEASE_DELAY 20
59 #define BIT(c, x) (c[x/8]&(1<<(x%8)))
60 static guint check_release_handler = 0;
61 static Accessibility_DeviceEvent pressed_event;
62 static SpiDEController *saved_controller;
63 static void wait_for_release_event (GdkEvent *event, SpiDEController *controller);
65 /* Our parent Gtk object type */
66 #define PARENT_TYPE BONOBO_TYPE_OBJECT
68 /* A pointer to our parent object class */
69 static GObjectClass *spi_device_event_controller_parent_class;
70 static int spi_error_code = 0;
71 static GdkPoint last_mouse_pos_static = {0, 0};
72 static GdkPoint *last_mouse_pos = &last_mouse_pos_static;
73 static unsigned int mouse_mask_state = 0;
74 static unsigned int mouse_button_mask =
75 Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
76 static unsigned int key_modifier_mask =
77 Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
78 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
80 static GQuark spi_dec_private_quark = 0;
82 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
86 SPI_DEVICE_TYPE_MOUSE,
87 SPI_DEVICE_TYPE_LAST_DEFINED
88 } SpiDeviceTypeCategory;
92 guint pending_add : 1;
93 guint pending_remove : 1;
95 Accessibility_ControllerEventMask mod_mask;
96 CORBA_unsigned_long key_val; /* KeyCode */
97 } DEControllerGrabMask;
101 SpiDeviceTypeCategory type;
102 Accessibility_EventTypeSeq *typeseq;
103 } DEControllerListener;
106 DEControllerListener listener;
108 Accessibility_KeySet *keys;
109 Accessibility_ControllerEventMask mask;
110 Accessibility_EventListenerMode *mode;
111 } DEControllerKeyListener;
114 unsigned int last_press_keycode;
115 unsigned int last_release_keycode;
116 struct timeval last_press_time;
117 struct timeval last_release_time;
119 int xkb_major_extension_opcode;
120 int xkb_base_event_code;
121 int xkb_base_error_code;
122 unsigned int xkb_latch_mask;
123 unsigned int pending_xkb_mod_relatch_mask;
125 } DEControllerPrivateData;
127 static void spi_controller_register_with_devices (SpiDEController *controller);
128 static gboolean spi_controller_update_key_grabs (SpiDEController *controller,
129 Accessibility_DeviceEvent *recv);
130 static gboolean spi_controller_register_device_listener (SpiDEController *controller,
131 DEControllerListener *l,
132 CORBA_Environment *ev);
133 static gboolean spi_device_event_controller_forward_key_event (SpiDEController *controller,
134 const XEvent *event);
135 static void spi_deregister_controller_device_listener (SpiDEController *controller,
136 DEControllerListener *listener,
137 CORBA_Environment *ev);
138 static void spi_deregister_controller_key_listener (SpiDEController *controller,
139 DEControllerKeyListener *key_listener,
140 CORBA_Environment *ev);
141 static gboolean spi_controller_notify_mouselisteners (SpiDEController *controller,
142 const Accessibility_DeviceEvent *event,
143 CORBA_Environment *ev);
145 static gboolean spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq *type_seq,
146 const Accessibility_DeviceEvent *event);
147 static gboolean spi_clear_error_state (void);
148 static gboolean spi_dec_poll_mouse_moved (gpointer data);
149 static gboolean spi_dec_poll_mouse_moving (gpointer data);
150 static gboolean spi_dec_poll_mouse_idle (gpointer data);
152 #define spi_get_display() GDK_DISPLAY()
154 /* Private methods */
157 keysym_mod_mask (KeySym keysym, KeyCode keycode)
159 /* we really should use XKB and look directly at the keymap */
160 /* this is very inelegant */
161 Display *display = spi_get_display ();
162 unsigned int mods_rtn = 0;
163 unsigned int retval = 0;
166 if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
167 (sym_rtn == keysym)) {
170 else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
171 (sym_rtn == keysym)) {
174 else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
175 (sym_rtn == keysym)) {
178 else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
179 (sym_rtn == keysym)) {
182 else if (XkbLookupKeySym (display, keycode,
183 ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
184 (sym_rtn == keysym)) {
185 retval = (Mod2Mask | ShiftMask);
187 else if (XkbLookupKeySym (display, keycode,
188 ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
189 (sym_rtn == keysym)) {
190 retval = (Mod3Mask | ShiftMask);
192 else if (XkbLookupKeySym (display, keycode,
193 ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
194 (sym_rtn == keysym)) {
195 retval = (Mod4Mask | ShiftMask);
203 keycode_for_keysym (long keysym, unsigned int *modmask)
206 keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
208 *modmask = keysym_mod_mask (keysym, keycode);
212 static DEControllerGrabMask *
213 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
215 DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
217 memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
219 clone->ref_count = 1;
220 clone->pending_add = TRUE;
221 clone->pending_remove = FALSE;
227 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
233 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
235 DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
236 DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
244 return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
249 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
251 DEControllerPrivateData *priv =
252 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
254 if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
255 priv->xkb_latch_mask);
257 priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
261 spi_dec_clear_unlatch_pending (SpiDEController *controller)
263 DEControllerPrivateData *priv =
264 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
265 priv->xkb_latch_mask = 0;
269 spi_dec_button_update_and_emit (SpiDEController *controller,
272 CORBA_Environment ev;
273 Accessibility_Event e;
274 Accessibility_DeviceEvent mouse_e;
275 gchar event_name[24];
276 gboolean is_consumed = FALSE;
278 if ((mask_return & mouse_button_mask) !=
279 (mouse_mask_state & mouse_button_mask))
281 int button_number = 0;
282 gboolean is_down = False;
284 if (!(mask_return & Button1Mask) &&
285 (mouse_mask_state & Button1Mask))
287 mouse_mask_state &= ~Button1Mask;
290 else if ((mask_return & Button1Mask) &&
291 !(mouse_mask_state & Button1Mask))
293 mouse_mask_state |= Button1Mask;
297 else if (!(mask_return & Button2Mask) &&
298 (mouse_mask_state & Button2Mask))
300 mouse_mask_state &= ~Button2Mask;
303 else if ((mask_return & Button2Mask) &&
304 !(mouse_mask_state & Button2Mask))
306 mouse_mask_state |= Button2Mask;
310 else if (!(mask_return & Button3Mask) &&
311 (mouse_mask_state & Button3Mask))
313 mouse_mask_state &= ~Button3Mask;
316 else if ((mask_return & Button3Mask) &&
317 !(mouse_mask_state & Button3Mask))
319 mouse_mask_state |= Button3Mask;
323 else if (!(mask_return & Button4Mask) &&
324 (mouse_mask_state & Button4Mask))
326 mouse_mask_state &= ~Button4Mask;
329 else if ((mask_return & Button4Mask) &&
330 !(mouse_mask_state & Button4Mask))
332 mouse_mask_state |= Button4Mask;
336 else if (!(mask_return & Button5Mask) &&
337 (mouse_mask_state & Button5Mask))
339 mouse_mask_state &= ~Button5Mask;
342 else if ((mask_return & Button5Mask) &&
343 !(mouse_mask_state & Button5Mask))
345 mouse_mask_state |= Button5Mask;
351 fprintf (stderr, "Button %d %s\n",
352 button_number, (is_down) ? "Pressed" : "Released");
354 snprintf (event_name, 22, "mouse:button:%d%c", button_number,
355 (is_down) ? 'p' : 'r');
356 /* TODO: FIXME distinguish between physical and
359 mouse_e.type = (is_down) ?
360 Accessibility_BUTTON_PRESSED_EVENT :
361 Accessibility_BUTTON_RELEASED_EVENT;
362 mouse_e.id = button_number;
363 mouse_e.hw_code = button_number;
364 mouse_e.modifiers = (CORBA_unsigned_short) mouse_mask_state;
365 mouse_e.timestamp = 0;
366 mouse_e.event_string = "";
367 mouse_e.is_text = CORBA_FALSE;
369 spi_controller_notify_mouselisteners (controller,
373 e.source = BONOBO_OBJREF (controller->registry->desktop);
374 e.detail1 = last_mouse_pos->x;
375 e.detail2 = last_mouse_pos->y;
376 spi_init_any_nil (&e.any_data);
377 CORBA_exception_init (&ev);
380 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
385 spi_dec_set_unlatch_pending (controller, mask_return);
397 spi_dec_mouse_check (SpiDEController *controller,
398 int *x, int *y, gboolean *moved)
400 Accessibility_Event e;
401 CORBA_Environment ev;
402 int win_x_return,win_y_return;
403 unsigned int mask_return;
404 Window root_return, child_return;
405 Display *display = spi_get_display ();
408 XQueryPointer(display, DefaultRootWindow (display),
409 &root_return, &child_return,
411 &win_x_return, &win_y_return, &mask_return);
413 * Since many clients grab the pointer, and X goes an automatic
414 * pointer grab on mouse-down, we often must detect mouse button events
415 * by polling rather than via a button grab.
416 * The while loop (rather than if) is used since it's possible that
417 * multiple buttons have changed state since we last checked.
419 if (mask_return != mouse_mask_state)
421 while (spi_dec_button_update_and_emit (controller, mask_return));
424 if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
426 e.type = "mouse:abs";
427 e.source = BONOBO_OBJREF (controller->registry->desktop);
430 spi_init_any_nil (&e.any_data);
431 CORBA_exception_init (&ev);
432 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
435 e.type = "mouse:rel";
436 e.source = BONOBO_OBJREF (controller->registry->desktop);
437 e.detail1 = *x - last_mouse_pos->x;
438 e.detail2 = *y - last_mouse_pos->y;
439 spi_init_any_nil (&e.any_data);
440 CORBA_exception_init (&ev);
441 last_mouse_pos->x = *x;
442 last_mouse_pos->y = *y;
443 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
457 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
460 Accessibility_Event e;
461 CORBA_Environment ev;
464 fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
465 prev_mask, current_mask);
468 /* set bits for the virtual modifiers like NUMLOCK */
469 if (prev_mask & _numlock_physical_mask)
470 prev_mask |= SPI_KEYMASK_NUMLOCK;
471 if (current_mask & _numlock_physical_mask)
472 current_mask |= SPI_KEYMASK_NUMLOCK;
474 e.type = "keyboard:modifiers";
475 e.source = BONOBO_OBJREF (controller->registry->desktop);
476 e.detail1 = prev_mask & key_modifier_mask;
477 e.detail2 = current_mask & key_modifier_mask;
478 spi_init_any_nil (&e.any_data);
479 CORBA_exception_init (&ev);
480 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
486 spi_dec_poll_mouse_moved (gpointer data)
488 SpiRegistry *registry = SPI_REGISTRY (data);
489 SpiDEController *controller = registry->de_controller;
494 mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
496 if ((mask_return & key_modifier_mask) !=
497 (mouse_mask_state & key_modifier_mask))
499 spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
500 mouse_mask_state = mask_return;
507 spi_dec_poll_mouse_idle (gpointer data)
509 if (! spi_dec_poll_mouse_moved (data))
513 g_timeout_add (20, spi_dec_poll_mouse_moving, data);
519 spi_dec_poll_mouse_moving (gpointer data)
521 if (spi_dec_poll_mouse_moved (data))
525 g_timeout_add (100, spi_dec_poll_mouse_idle, data);
530 #ifdef WE_NEED_UGRAB_MOUSE
532 spi_dec_ungrab_mouse (gpointer data)
534 Display *display = spi_get_display ();
537 XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
538 XDefaultRootWindow (spi_get_display ()));
545 spi_dec_init_mouse_listener (SpiRegistry *registry)
547 Display *display = spi_get_display ();
548 g_timeout_add (100, spi_dec_poll_mouse_idle, registry);
552 if (XGrabButton (display, AnyButton, AnyModifier,
553 gdk_x11_get_default_root_xwindow (),
554 True, ButtonPressMask | ButtonReleaseMask,
555 GrabModeSync, GrabModeAsync, None, None) != Success) {
557 fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
561 XSync (display, False);
563 fprintf (stderr, "mouse buttons grabbed\n");
569 * Eventually we can use this to make the marshalling of mask types
570 * more sane, but for now we just use this to detect
571 * the use of 'virtual' masks such as Mumlock and convert them to
572 * system-specific mask values (i.e. ModMask).
575 static Accessibility_ControllerEventMask
576 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
578 if (mask == SPI_KEYMASK_NUMLOCK) {
579 mask = _numlock_physical_mask;
584 static DEControllerKeyListener *
585 spi_dec_key_listener_new (CORBA_Object l,
586 const Accessibility_KeySet *keys,
587 const Accessibility_ControllerEventMask mask,
588 const Accessibility_EventTypeSeq *typeseq,
589 const Accessibility_EventListenerMode *mode,
590 CORBA_Environment *ev)
592 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
593 key_listener->listener.object = bonobo_object_dup_ref (l, ev);
594 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
595 key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
596 key_listener->mask = spi_dec_translate_mask (mask);
597 key_listener->listener.typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
599 key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
601 key_listener->mode = NULL;
604 g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
605 (unsigned int) key_listener->mask,
606 (int) (mode ? mode->global : 0),
607 (void *) key_listener->keys,
608 (int) (key_listener->keys ? key_listener->keys->_length : 0));
614 static DEControllerListener *
615 spi_dec_listener_new (CORBA_Object l,
616 const Accessibility_EventTypeSeq *typeseq,
617 CORBA_Environment *ev)
619 DEControllerListener *listener = g_new0 (DEControllerListener, 1);
620 listener->object = bonobo_object_dup_ref (l, ev);
621 listener->type = SPI_DEVICE_TYPE_MOUSE;
622 listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
626 static DEControllerListener *
627 spi_listener_clone (DEControllerListener *listener, CORBA_Environment *ev)
629 DEControllerListener *clone = g_new0 (DEControllerListener, 1);
631 CORBA_Object_duplicate (listener->object, ev);
632 clone->type = listener->type;
633 clone->typeseq = ORBit_copy_value (listener->typeseq, TC_Accessibility_EventTypeSeq);
637 static DEControllerKeyListener *
638 spi_key_listener_clone (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
640 DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
641 clone->listener.object =
642 CORBA_Object_duplicate (key_listener->listener.object, ev);
643 clone->listener.type = SPI_DEVICE_TYPE_KBD;
644 clone->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
645 clone->mask = key_listener->mask;
646 clone->listener.typeseq = ORBit_copy_value (key_listener->listener.typeseq, TC_Accessibility_EventTypeSeq);
647 if (key_listener->mode)
648 clone->mode = ORBit_copy_value (key_listener->mode, TC_Accessibility_EventListenerMode);
655 spi_key_listener_data_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
657 CORBA_free (key_listener->listener.typeseq);
658 CORBA_free (key_listener->keys);
659 g_free (key_listener);
663 spi_key_listener_clone_free (DEControllerKeyListener *clone, CORBA_Environment *ev)
665 CORBA_Object_release (clone->listener.object, ev);
666 spi_key_listener_data_free (clone, ev);
670 spi_listener_clone_free (DEControllerListener *clone, CORBA_Environment *ev)
672 CORBA_Object_release (clone->object, ev);
673 CORBA_free (clone->typeseq);
678 spi_dec_listener_free (DEControllerListener *listener,
679 CORBA_Environment *ev)
681 bonobo_object_release_unref (listener->object, ev);
682 if (listener->type == SPI_DEVICE_TYPE_KBD)
683 spi_key_listener_data_free ((DEControllerKeyListener *) listener, ev);
687 _register_keygrab (SpiDEController *controller,
688 DEControllerGrabMask *grab_mask)
692 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
693 spi_grab_mask_compare_values);
696 DEControllerGrabMask *cur_mask = l->data;
698 cur_mask->ref_count++;
699 if (cur_mask->pending_remove)
701 cur_mask->pending_remove = FALSE;
706 controller->keygrabs_list =
707 g_list_prepend (controller->keygrabs_list,
708 spi_grab_mask_clone (grab_mask));
713 _deregister_keygrab (SpiDEController *controller,
714 DEControllerGrabMask *grab_mask)
718 l = g_list_find_custom (controller->keygrabs_list, grab_mask,
719 spi_grab_mask_compare_values);
723 DEControllerGrabMask *cur_mask = l->data;
725 cur_mask->ref_count--;
726 if (cur_mask->ref_count <= 0)
728 cur_mask->pending_remove = TRUE;
733 DBG (1, g_warning ("De-registering non-existant grab"));
738 handle_keygrab (SpiDEController *controller,
739 DEControllerKeyListener *key_listener,
740 void (*process_cb) (SpiDEController *controller,
741 DEControllerGrabMask *grab_mask))
743 DEControllerGrabMask grab_mask = { 0 };
745 grab_mask.mod_mask = key_listener->mask;
746 if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
748 grab_mask.key_val = AnyKey;
750 fprintf (stderr, "AnyKey grab!");
752 process_cb (controller, &grab_mask);
758 for (i = 0; i < key_listener->keys->_length; ++i)
760 Accessibility_KeyDefinition keydef = key_listener->keys->_buffer[i];
761 long int key_val = keydef.keysym;
762 /* X Grabs require keycodes, not keysyms */
763 if (keydef.keystring && keydef.keystring[0])
765 key_val = XStringToKeysym(keydef.keystring);
769 key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
773 key_val = keydef.keycode;
775 grab_mask.key_val = key_val;
776 process_cb (controller, &grab_mask);
782 spi_controller_register_global_keygrabs (SpiDEController *controller,
783 DEControllerKeyListener *key_listener)
785 handle_keygrab (controller, key_listener, _register_keygrab);
786 if (controller->xevie_display == NULL)
787 return spi_controller_update_key_grabs (controller, NULL);
793 spi_controller_deregister_global_keygrabs (SpiDEController *controller,
794 DEControllerKeyListener *key_listener)
796 handle_keygrab (controller, key_listener, _deregister_keygrab);
797 if (controller->xevie_display == NULL)
798 spi_controller_update_key_grabs (controller, NULL);
802 spi_controller_register_device_listener (SpiDEController *controller,
803 DEControllerListener *listener,
804 CORBA_Environment *ev)
806 DEControllerKeyListener *key_listener;
808 switch (listener->type) {
809 case SPI_DEVICE_TYPE_KBD:
810 key_listener = (DEControllerKeyListener *) listener;
812 controller->key_listeners = g_list_prepend (controller->key_listeners,
814 if (key_listener->mode->global)
816 return spi_controller_register_global_keygrabs (controller, key_listener);
821 case SPI_DEVICE_TYPE_MOUSE:
822 controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
825 DBG (1, g_warning ("listener registration for unknown device type.\n"));
832 spi_controller_notify_mouselisteners (SpiDEController *controller,
833 const Accessibility_DeviceEvent *event,
834 CORBA_Environment *ev)
837 GSList *notify = NULL, *l2;
838 GList **listeners = &controller->mouse_listeners;
839 gboolean is_consumed;
840 gboolean found = FALSE;
847 for (l = *listeners; l; l = l->next)
849 DEControllerListener *listener = l->data;
851 if (spi_eventtype_seq_contains_event (listener->typeseq, event))
853 Accessibility_DeviceEventListener ls = listener->object;
855 if (ls != CORBA_OBJECT_NIL)
857 /* we clone (don't dup) the listener, to avoid refcount inc. */
858 notify = g_slist_prepend (notify,
859 spi_listener_clone (listener, ev));
865 #ifdef SPI_KEYEVENT_DEBUG
868 g_print ("no match for event\n");
873 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
875 DEControllerListener *listener = l2->data;
876 Accessibility_DeviceEventListener ls = listener->object;
878 CORBA_exception_init (ev);
879 is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, event, ev);
883 DBG (2, g_warning ("error notifying listener, removing it\n"));
884 spi_deregister_controller_device_listener (controller, listener,
886 CORBA_exception_free (ev);
889 spi_listener_clone_free ((DEControllerListener *) l2->data, ev);
892 for (; l2; l2 = l2->next)
894 DEControllerListener *listener = l2->data;
895 spi_listener_clone_free (listener, ev);
896 /* clone doesn't have its own ref, so don't use spi_device_listener_free */
899 g_slist_free (notify);
902 if (is_consumed) g_message ("consumed\n");
908 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
911 Accessibility_Event e;
912 Accessibility_DeviceEvent mouse_e;
913 CORBA_Environment ev;
914 gchar event_name[24];
915 gboolean is_consumed = FALSE;
916 gboolean xkb_mod_unlatch_occurred;
917 XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
919 int button = xbutton_event->button;
921 unsigned int mouse_button_state = xbutton_event->state;
926 mouse_button_state |= Button1Mask;
929 mouse_button_state |= Button2Mask;
932 mouse_button_state |= Button3Mask;
935 mouse_button_state |= Button4Mask;
938 mouse_button_state |= Button5Mask;
942 last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
943 last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
946 fprintf (stderr, "mouse button %d %s (%x)\n",
947 xbutton_event->button,
948 (xevent->type == ButtonPress) ? "Press" : "Release",
951 snprintf (event_name, 22, "mouse:button:%d%c", button,
952 (xevent->type == ButtonPress) ? 'p' : 'r');
954 /* TODO: FIXME distinguish between physical and logical buttons */
955 mouse_e.type = (xevent->type == ButtonPress) ?
956 Accessibility_BUTTON_PRESSED_EVENT :
957 Accessibility_BUTTON_RELEASED_EVENT;
959 mouse_e.hw_code = button;
960 mouse_e.modifiers = (CORBA_unsigned_short) xbutton_event->state;
961 mouse_e.timestamp = (CORBA_unsigned_long) xbutton_event->time;
962 mouse_e.event_string = "";
963 mouse_e.is_text = CORBA_FALSE;
964 if ((mouse_button_state & mouse_button_mask) !=
965 (mouse_mask_state & mouse_button_mask))
967 if ((mouse_mask_state & key_modifier_mask) !=
968 (mouse_button_state & key_modifier_mask))
969 spi_dec_emit_modifier_event (controller,
970 mouse_mask_state, mouse_button_state);
971 mouse_mask_state = mouse_button_state;
973 spi_controller_notify_mouselisteners (controller, &mouse_e, &ev);
974 e.type = CORBA_string_dup (event_name);
975 e.source = BONOBO_OBJREF (controller->registry->desktop);
976 e.detail1 = last_mouse_pos->x;
977 e.detail2 = last_mouse_pos->y;
978 spi_init_any_nil (&e.any_data);
979 CORBA_exception_init (&ev);
981 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
986 xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
987 xevent->type == ButtonRelease);
989 /* if client wants to consume this event, and XKB latch state was
990 * unset by this button event, we reset it
992 if (is_consumed && xkb_mod_unlatch_occurred)
993 spi_dec_set_unlatch_pending (controller, mouse_mask_state);
995 XAllowEvents (spi_get_display (),
996 (is_consumed) ? SyncPointer : ReplayPointer,
1000 static GdkFilterReturn
1001 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
1003 XEvent *xevent = gdk_xevent;
1004 SpiDEController *controller;
1005 DEControllerPrivateData *priv;
1006 Display *display = spi_get_display ();
1007 controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1008 priv = (DEControllerPrivateData *)
1009 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1011 if (xevent->type == KeyPress || xevent->type == KeyRelease)
1013 if (controller->xevie_display == NULL)
1015 gboolean is_consumed =
1016 spi_device_event_controller_forward_key_event (controller, xevent);
1019 XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
1022 wait_for_release_event (event, controller);
1023 XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
1027 return GDK_FILTER_CONTINUE;
1029 if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1031 spi_device_event_controller_forward_mouse_event (controller, xevent);
1033 if (xevent->type == priv->xkb_base_event_code)
1035 XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1036 /* ugly but probably necessary...*/
1037 XSynchronize (spi_get_display (), TRUE);
1039 if (xkb_ev->xkb_type == XkbStateNotify)
1041 XkbStateNotifyEvent *xkb_snev =
1042 (XkbStateNotifyEvent *) xkb_ev;
1043 /* check the mouse, to catch mouse events grabbed by
1044 * another client; in case we should revert this XKB delatch
1046 if (!priv->pending_xkb_mod_relatch_mask)
1050 spi_dec_mouse_check (controller, &x, &y, &moved);
1052 /* we check again, since the previous call may have
1053 changed this flag */
1054 if (priv->pending_xkb_mod_relatch_mask)
1056 unsigned int feedback_mask;
1057 #ifdef SPI_XKB_DEBUG
1058 fprintf (stderr, "relatching %x\n",
1059 priv->pending_xkb_mod_relatch_mask);
1061 /* temporarily turn off the latch bell, if it's on */
1062 XkbGetControls (display,
1063 XkbAccessXFeedbackMask,
1065 feedback_mask = priv->xkb_desc->ctrls->ax_options;
1066 if (feedback_mask & XkbAX_StickyKeysFBMask)
1068 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1070 priv->xkb_desc->ctrls->ax_options
1071 &= ~(XkbAX_StickyKeysFBMask);
1072 XkbChangeControls (display, priv->xkb_desc, &changes);
1074 /* TODO: account for lock as well as latch */
1075 XkbLatchModifiers (display,
1077 priv->pending_xkb_mod_relatch_mask,
1078 priv->pending_xkb_mod_relatch_mask);
1079 if (feedback_mask & XkbAX_StickyKeysFBMask)
1081 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1083 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1084 XkbChangeControls (display, priv->xkb_desc, &changes);
1086 #ifdef SPI_XKB_DEBUG
1087 fprintf (stderr, "relatched %x\n",
1088 priv->pending_xkb_mod_relatch_mask);
1090 priv->pending_xkb_mod_relatch_mask = 0;
1094 priv->xkb_latch_mask = xkb_snev->latched_mods;
1098 DBG (2, g_warning ("XKB event %d\n", xkb_ev->xkb_type));
1099 XSynchronize (spi_get_display (), FALSE);
1102 return GDK_FILTER_CONTINUE;
1106 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1108 if (error->error_code == BadAccess)
1110 g_message ("Could not complete key grab: grab already in use.\n");
1111 spi_error_code = BadAccess;
1116 return (*x_default_error_handler) (display, error);
1121 spi_controller_register_with_devices (SpiDEController *controller)
1123 DEControllerPrivateData *priv = (DEControllerPrivateData *)
1124 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1125 /* FIXME: should check for extension first! */
1126 XTestGrabControl (spi_get_display (), True);
1128 /* calls to device-specific implementations and routines go here */
1129 /* register with: keyboard hardware code handler */
1130 /* register with: (translated) keystroke handler */
1132 priv->have_xkb = XkbQueryExtension (spi_get_display (),
1133 &priv->xkb_major_extension_opcode,
1134 &priv->xkb_base_event_code,
1135 &priv->xkb_base_error_code, NULL, NULL);
1138 priv->xkb_desc = XkbGetMap (spi_get_display (), 0, XkbUseCoreKbd);
1139 XkbSelectEvents (spi_get_display (),
1141 XkbStateNotifyMask, XkbStateNotifyMask);
1142 _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1146 gdk_window_add_filter (NULL, global_filter_fn, controller);
1148 gdk_window_set_events (gdk_get_default_root_window (),
1149 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
1151 x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1155 spi_key_set_contains_key (Accessibility_KeySet *key_set,
1156 const Accessibility_DeviceEvent *key_event)
1163 g_print ("null key set!");
1167 len = key_set->_length;
1169 if (len == 0) /* special case, means "all keys/any key" */
1171 g_print ("anykey\n");
1175 for (i = 0; i < len; ++i)
1177 #ifdef SPI_KEYEVENT_DEBUG
1178 g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1180 (int)key_set->_buffer[i].keysym,
1181 (int) key_set->_buffer[i].keycode,
1182 (int) key_event->id,
1183 (int) key_event->hw_code,
1184 key_event->event_string);
1186 if (key_set->_buffer[i].keysym == (CORBA_long) key_event->id)
1190 if (key_set->_buffer[i].keycode == (CORBA_long) key_event->hw_code)
1194 if (key_event->event_string && key_event->event_string[0] &&
1195 !strcmp (key_set->_buffer[i].keystring, key_event->event_string))
1205 spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq *type_seq,
1206 const Accessibility_DeviceEvent *event)
1214 g_print ("null type seq!");
1218 len = type_seq->_length;
1220 if (len == 0) /* special case, means "all events/any event" */
1225 for (i = 0; i < len; ++i)
1228 g_print ("type_seq[%d] = %d; event type = %d\n", i,
1229 (int) type_seq->_buffer[i], (int) event->type);
1231 if (type_seq->_buffer[i] == (CORBA_long) event->type)
1241 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1242 DEControllerKeyListener *listener,
1243 CORBA_boolean is_system_global)
1245 if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFF)) &&
1246 spi_key_set_contains_key (listener->keys, key_event) &&
1247 spi_eventtype_seq_contains_event (listener->listener.typeseq, key_event) &&
1248 (is_system_global == listener->mode->global))
1259 spi_controller_notify_keylisteners (SpiDEController *controller,
1260 const Accessibility_DeviceEvent *key_event,
1261 CORBA_boolean is_system_global,
1262 CORBA_Environment *ev)
1265 GSList *notify = NULL, *l2;
1266 GList **key_listeners = &controller->key_listeners;
1267 gboolean is_consumed;
1274 for (l = *key_listeners; l; l = l->next)
1276 DEControllerKeyListener *key_listener = l->data;
1278 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1280 Accessibility_DeviceEventListener ls = key_listener->listener.object;
1282 if (ls != CORBA_OBJECT_NIL)
1284 /* we clone (don't dup) the listener, to avoid refcount inc. */
1285 notify = g_slist_prepend (notify,
1286 spi_key_listener_clone (key_listener, ev));
1291 #ifdef SPI_KEYEVENT_DEBUG
1294 g_print ("no match for event\n");
1298 is_consumed = FALSE;
1299 for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1301 DEControllerKeyListener *key_listener = l2->data;
1302 Accessibility_DeviceEventListener ls = key_listener->listener.object;
1304 is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
1308 is_consumed = FALSE;
1309 spi_deregister_controller_key_listener (controller, key_listener,
1311 CORBA_exception_free (ev);
1314 spi_key_listener_clone_free (key_listener, ev);
1317 for (; l2; l2 = l2->next)
1319 DEControllerKeyListener *key_listener = l2->data;
1320 spi_key_listener_clone_free (key_listener, ev);
1321 /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1324 g_slist_free (notify);
1327 if (is_consumed) g_message ("consumed\n");
1333 spi_clear_error_state ()
1335 gboolean retval = spi_error_code != 0;
1340 static Accessibility_DeviceEvent
1341 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1343 Accessibility_DeviceEvent key_event;
1345 const int cbuf_bytes = 20;
1346 char cbuf [cbuf_bytes+1];
1349 nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1350 key_event.id = (CORBA_long)(keysym);
1351 key_event.hw_code = (CORBA_short) x_key_event->keycode;
1352 if (((XEvent *) x_key_event)->type == KeyPress)
1354 key_event.type = Accessibility_KEY_PRESSED_EVENT;
1358 key_event.type = Accessibility_KEY_RELEASED_EVENT;
1360 key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
1361 key_event.is_text = CORBA_FALSE;
1365 key_event.event_string = CORBA_string_dup ("space");
1368 key_event.event_string = CORBA_string_dup ("Tab");
1371 key_event.event_string = CORBA_string_dup ("Backspace");
1374 key_event.event_string = CORBA_string_dup ("Return");
1377 key_event.event_string = CORBA_string_dup ("Home");
1380 key_event.event_string = CORBA_string_dup ("Page_Down");
1383 key_event.event_string = CORBA_string_dup ("Page_Up");
1386 key_event.event_string = CORBA_string_dup ("F1");
1389 key_event.event_string = CORBA_string_dup ("F2");
1392 key_event.event_string = CORBA_string_dup ("F3");
1395 key_event.event_string = CORBA_string_dup ("F4");
1398 key_event.event_string = CORBA_string_dup ("F5");
1401 key_event.event_string = CORBA_string_dup ("F6");
1404 key_event.event_string = CORBA_string_dup ("F7");
1407 key_event.event_string = CORBA_string_dup ("F8");
1410 key_event.event_string = CORBA_string_dup ("F9");
1413 key_event.event_string = CORBA_string_dup ("F10");
1416 key_event.event_string = CORBA_string_dup ("F11");
1419 key_event.event_string = CORBA_string_dup ("F12");
1422 key_event.event_string = CORBA_string_dup ("End");
1425 key_event.event_string = CORBA_string_dup ("Escape");
1428 key_event.event_string = CORBA_string_dup ("Up");
1431 key_event.event_string = CORBA_string_dup ("Down");
1434 key_event.event_string = CORBA_string_dup ("Left");
1437 key_event.event_string = CORBA_string_dup ("Right");
1443 cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1444 key_event.event_string = CORBA_string_dup (cbuf);
1445 c = g_utf8_get_char_validated (cbuf, nbytes);
1446 if ((c > 0) && g_unichar_isprint (c))
1448 key_event.is_text = CORBA_TRUE;
1449 /* incorrect for some composed chars? */
1454 key_event.event_string = CORBA_string_dup ("");
1458 key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
1459 #ifdef SPI_KEYEVENT_DEBUG
1461 char *pressed_str = "pressed";
1462 char *released_str = "released";
1465 if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1466 state_ptr = pressed_str;
1468 state_ptr = released_str;
1471 "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1472 (unsigned long) keysym,
1474 keysym ? (int) keysym : '*',
1475 (int) x_key_event->state,
1476 key_event.event_string,
1477 key_event.event_string[0],
1478 (key_event.is_text == CORBA_TRUE) ? "(text)" : "(not text)");
1482 fprintf (stderr, "%s%c\n",
1483 (x_key_event->state & Mod1Mask)?"Alt-":"",
1484 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1485 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1486 #endif /* SPI_DEBUG */
1491 spi_controller_update_key_grabs (SpiDEController *controller,
1492 Accessibility_DeviceEvent *recv)
1495 gboolean update_failed = FALSE;
1497 g_return_val_if_fail (controller != NULL, FALSE);
1500 * masks known to work with default RH 7.1+:
1501 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1502 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1503 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1504 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1506 * ControlMask grabs are broken, must be in use already
1508 for (l = controller->keygrabs_list; l; l = next)
1511 gboolean re_issue_grab;
1512 DEControllerGrabMask *grab_mask = l->data;
1516 re_issue_grab = recv &&
1517 (recv->modifiers & grab_mask->mod_mask) &&
1518 (grab_mask->key_val == keycode_for_keysym (recv->id, NULL));
1521 fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1522 (long int) grab_mask->key_val,
1523 (long int) grab_mask->mod_mask,
1524 grab_mask->pending_add ? '+' : '.',
1525 grab_mask->pending_remove ? '-' : '.',
1526 re_issue_grab ? "re-issue": "");
1531 if (grab_mask->pending_add && grab_mask->pending_remove)
1535 else if (grab_mask->pending_remove)
1538 fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1540 XUngrabKey (spi_get_display (),
1542 grab_mask->mod_mask,
1543 gdk_x11_get_default_root_xwindow ());
1547 else if (grab_mask->pending_add || re_issue_grab)
1551 fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1553 XGrabKey (spi_get_display (),
1555 grab_mask->mod_mask,
1556 gdk_x11_get_default_root_xwindow (),
1560 XSync (spi_get_display (), False);
1561 update_failed = spi_clear_error_state ();
1562 if (update_failed) {
1563 while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1568 grab_mask->pending_add = FALSE;
1569 grab_mask->pending_remove = FALSE;
1573 g_assert (grab_mask->ref_count <= 0);
1575 controller->keygrabs_list = g_list_delete_link (
1576 controller->keygrabs_list, l);
1578 spi_grab_mask_free (grab_mask);
1583 return ! update_failed;
1587 * Implemented GObject::finalize
1590 spi_device_event_controller_object_finalize (GObject *object)
1592 SpiDEController *controller;
1593 DEControllerPrivateData *private;
1594 controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1597 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1599 /* disconnect any special listeners, get rid of outstanding keygrabs */
1600 XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1603 if (controller->xevie_display != NULL)
1605 XevieEnd(controller->xevie_display);
1606 #ifdef SPI_KEYEVENT_DEBUG
1607 printf("XevieEnd(dpy) finished \n");
1612 private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1613 if (private->xkb_desc)
1614 XkbFreeKeyboard (private->xkb_desc, 0, True);
1616 spi_device_event_controller_parent_class->finalize (object);
1620 * CORBA Accessibility::DEController::registerKeystrokeListener
1621 * method implementation
1623 static CORBA_boolean
1624 impl_register_keystroke_listener (PortableServer_Servant servant,
1625 const Accessibility_DeviceEventListener l,
1626 const Accessibility_KeySet *keys,
1627 const Accessibility_ControllerEventMask mask,
1628 const Accessibility_EventTypeSeq *type,
1629 const Accessibility_EventListenerMode *mode,
1630 CORBA_Environment *ev)
1632 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1633 bonobo_object_from_servant (servant));
1634 DEControllerKeyListener *dec_listener;
1636 fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
1637 (void *) l, (unsigned long) mask);
1639 dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
1640 return spi_controller_register_device_listener (
1641 controller, (DEControllerListener *) dec_listener, ev);
1646 * CORBA Accessibility::DEController::registerDeviceEventListener
1647 * method implementation
1649 static CORBA_boolean
1650 impl_register_device_listener (PortableServer_Servant servant,
1651 const Accessibility_DeviceEventListener l,
1652 const Accessibility_EventTypeSeq *event_types,
1653 CORBA_Environment *ev)
1655 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1656 bonobo_object_from_servant (servant));
1657 DEControllerListener *dec_listener;
1659 dec_listener = spi_dec_listener_new (l, event_types, ev);
1660 return spi_controller_register_device_listener (
1661 controller, (DEControllerListener *) dec_listener, ev);
1665 CORBA_Environment *ev;
1666 DEControllerListener *listener;
1667 } RemoveListenerClosure;
1669 static SpiReEntrantContinue
1670 remove_listener_cb (GList * const *list,
1673 DEControllerListener *listener = (*list)->data;
1674 RemoveListenerClosure *ctx = user_data;
1676 if (CORBA_Object_is_equivalent (ctx->listener->object,
1677 listener->object, ctx->ev))
1679 spi_re_entrant_list_delete_link (list);
1680 spi_dec_listener_free (listener, ctx->ev);
1683 return SPI_RE_ENTRANT_CONTINUE;
1686 static SpiReEntrantContinue
1687 copy_key_listener_cb (GList * const *list,
1690 DEControllerKeyListener *key_listener = (*list)->data;
1691 RemoveListenerClosure *ctx = user_data;
1693 if (CORBA_Object_is_equivalent (ctx->listener->object,
1694 key_listener->listener.object, ctx->ev))
1696 /* TODO: FIXME aggregate keys in case the listener is registered twice */
1697 DEControllerKeyListener *ctx_key_listener =
1698 (DEControllerKeyListener *) ctx->listener;
1699 CORBA_free (ctx_key_listener->keys);
1700 ctx_key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
1703 return SPI_RE_ENTRANT_CONTINUE;
1707 spi_deregister_controller_device_listener (SpiDEController *controller,
1708 DEControllerListener *listener,
1709 CORBA_Environment *ev)
1711 RemoveListenerClosure ctx;
1714 ctx.listener = listener;
1716 spi_re_entrant_list_foreach (&controller->mouse_listeners,
1717 remove_listener_cb, &ctx);
1721 spi_deregister_controller_key_listener (SpiDEController *controller,
1722 DEControllerKeyListener *key_listener,
1723 CORBA_Environment *ev)
1725 RemoveListenerClosure ctx;
1728 ctx.listener = (DEControllerListener *) key_listener;
1730 /* special case, copy keyset from existing controller list entry */
1731 if (key_listener->keys->_length == 0)
1733 spi_re_entrant_list_foreach (&controller->key_listeners,
1734 copy_key_listener_cb, &ctx);
1737 spi_controller_deregister_global_keygrabs (controller, key_listener);
1739 spi_re_entrant_list_foreach (&controller->key_listeners,
1740 remove_listener_cb, &ctx);
1745 * CORBA Accessibility::DEController::deregisterKeystrokeListener
1746 * method implementation
1749 impl_deregister_keystroke_listener (PortableServer_Servant servant,
1750 const Accessibility_DeviceEventListener l,
1751 const Accessibility_KeySet *keys,
1752 const Accessibility_ControllerEventMask mask,
1753 const Accessibility_EventTypeSeq *type,
1754 CORBA_Environment *ev)
1756 DEControllerKeyListener *key_listener;
1757 SpiDEController *controller;
1759 controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1761 key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
1763 #ifdef SPI_DEREGISTER_DEBUG
1764 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
1765 (void *) l, (unsigned long) mask->value);
1768 spi_deregister_controller_key_listener (controller, key_listener, ev);
1770 spi_dec_listener_free ((DEControllerListener *) key_listener, ev);
1774 * CORBA Accessibility::DEController::deregisterDeviceEventListener
1775 * method implementation
1778 impl_deregister_device_listener (PortableServer_Servant servant,
1779 const Accessibility_DeviceEventListener l,
1780 const Accessibility_EventTypeSeq *event_types,
1781 CORBA_Environment *ev)
1783 SpiDEController *controller;
1784 DEControllerListener *listener =
1785 spi_dec_listener_new (l, event_types, ev);
1787 controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1789 spi_deregister_controller_device_listener (controller, listener, ev);
1791 spi_dec_listener_free (listener, ev);
1794 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
1796 unsigned int retval = 0;
1797 DEControllerPrivateData *priv = (DEControllerPrivateData *)
1798 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1800 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
1801 retval = XkbGetSlowKeysDelay (spi_get_display (),
1802 XkbUseCoreKbd, &bounce_delay);
1804 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
1806 Status s = XkbGetControls (spi_get_display (),
1807 XkbAllControlsMask, priv->xkb_desc);
1810 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
1811 retval = priv->xkb_desc->ctrls->slow_keys_delay;
1816 #ifdef SPI_XKB_DEBUG
1817 fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
1822 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
1824 unsigned int retval = 0;
1825 DEControllerPrivateData *priv = (DEControllerPrivateData *)
1826 g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1828 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
1829 retval = XkbGetBounceKeysDelay (spi_get_display (),
1830 XkbUseCoreKbd, &bounce_delay);
1832 if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
1834 Status s = XkbGetControls (spi_get_display (),
1835 XkbAllControlsMask, priv->xkb_desc);
1838 if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
1839 retval = priv->xkb_desc->ctrls->debounce_delay;
1844 #ifdef SPI_XKB_DEBUG
1845 fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
1851 dec_synth_keycode_press (SpiDEController *controller,
1852 unsigned int keycode)
1854 unsigned int time = CurrentTime;
1855 unsigned int bounce_delay;
1856 unsigned int elapsed_msec;
1858 DEControllerPrivateData *priv =
1859 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
1860 spi_dec_private_quark);
1861 if (keycode == priv->last_release_keycode)
1863 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
1866 gettimeofday (&tv, NULL);
1868 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
1869 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
1870 #ifdef SPI_XKB_DEBUG
1871 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
1872 (long) (tv.tv_usec - priv->last_release_time.tv_usec));
1874 #ifdef THIS_IS_BROKEN
1875 if (elapsed_msec < bounce_delay)
1876 time = bounce_delay - elapsed_msec + 1;
1878 time = bounce_delay + 10;
1879 /* fudge for broken XTest */
1881 #ifdef SPI_XKB_DEBUG
1882 fprintf (stderr, "waiting %d ms\n", time);
1886 XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
1887 priv->last_press_keycode = keycode;
1888 XSync (spi_get_display (), False);
1889 gettimeofday (&priv->last_press_time, NULL);
1894 dec_synth_keycode_release (SpiDEController *controller,
1895 unsigned int keycode)
1897 unsigned int time = CurrentTime;
1898 unsigned int slow_delay;
1899 unsigned int elapsed_msec;
1901 DEControllerPrivateData *priv =
1902 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
1903 spi_dec_private_quark);
1904 if (keycode == priv->last_press_keycode)
1906 slow_delay = dec_xkb_get_slowkeys_delay (controller);
1909 gettimeofday (&tv, NULL);
1911 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
1912 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
1913 #ifdef SPI_XKB_DEBUG
1914 fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
1915 (long) (tv.tv_usec - priv->last_press_time.tv_usec));
1917 #ifdef THIS_IS_BROKEN_DUNNO_WHY
1918 if (elapsed_msec < slow_delay)
1919 time = slow_delay - elapsed_msec + 1;
1921 time = slow_delay + 10;
1922 /* our XTest seems broken, we have to add slop as above */
1924 #ifdef SPI_XKB_DEBUG
1925 fprintf (stderr, "waiting %d ms\n", time);
1929 XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
1930 priv->last_release_keycode = keycode;
1931 XSync (spi_get_display (), False);
1932 gettimeofday (&priv->last_release_time, NULL);
1937 dec_get_modifier_state (SpiDEController *controller)
1939 return mouse_mask_state;
1943 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
1945 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
1946 modifiers, modifiers);
1950 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
1952 return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
1957 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
1959 /* TODO: table lookups within a range, for various code pages! */
1960 KeySym keysym = NoSymbol;
1962 if (unichar >= 0x20 && unichar < 0x7f) { /* Basic Latin/ASCII */
1963 keysym = (KeySym) unichar;
1965 else if (unichar >= 0xa0 && unichar <= 0xff) { /* Latin 1 extensions */
1966 keysym = (KeySym) unichar;
1968 else if (unichar >= 0x100 && unichar <= 0x233) { /* unfortunately the mapping gets nasty for Latin-2 and 3... help! */
1971 else if (unichar >= 0x7c1 && unichar <= 0x3a1) { /* let's try Greek anyway... */
1972 keysym = (KeySym) (0x391 + (unichar - 0x7c1));
1974 else if (unichar >= 0x3a3 && unichar <= 0x3a9) { /* let's try Greek anyway... */
1975 keysym = (KeySym) (0x7d2 + (unichar - 0x3a3));
1977 else if (unichar >= 0x3b1 && unichar <= 0x3c1) { /* let's try Greek anyway... */
1978 keysym = (KeySym) (0x7e1 + (unichar - 0x3b1));
1980 else if (unichar == 0x3c2) {
1981 keysym = (KeySym) 0x7f3; /* XK_Greek_finalsmallsigma; */
1983 else if (unichar >= 0x3c3 && unichar <= 0x3c9) { /* let's try Greek anyway... */
1984 keysym = (KeySym) (0x7f2 + (unichar - 0x3c2));
1986 else if (unichar >= 0x5d0 && unichar <= 0x5ea) { /* Hebrew basics */
1987 /* probably broken :-) */
1988 keysym = (KeySym) (0xce0 + (unichar - 0x5d0));
1990 else if (unichar >= 0x30a1 && unichar <= 0x30ab) { /* partial katakana support */
1991 /* TODO: complete! */
1992 keysym = (KeySym) (0x4b1 + (unichar - 0x30a1)/2);
1994 else if (unichar >= 0x20a0 && unichar <= 0x20ac) { /* currency */
1995 keysym = (KeySym) unichar; /* how convenient ;-) */
2001 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2003 KeyCode key_synth_code;
2004 unsigned int modifiers, synth_mods, lock_mods;
2006 key_synth_code = keycode_for_keysym (keysym, &synth_mods);
2008 if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2010 /* TODO: set the modifiers accordingly! */
2011 modifiers = dec_get_modifier_state (controller);
2012 /* side-effect; we may unset mousebutton modifiers here! */
2015 if (synth_mods != modifiers) {
2016 lock_mods = synth_mods & ~modifiers;
2017 dec_lock_modifiers (controller, lock_mods);
2019 dec_synth_keycode_press (controller, key_synth_code);
2020 dec_synth_keycode_release (controller, key_synth_code);
2021 if (synth_mods != modifiers)
2022 dec_unlock_modifiers (controller, lock_mods);
2028 dec_synth_keystring (SpiDEController *controller, const CORBA_char *keystring)
2030 /* probably we need to create and inject an XIM handler eventually. */
2031 /* for now, try to match the string to existing
2032 * keycode+modifier states.
2036 gunichar unichar = 0;
2038 gboolean retval = TRUE;
2041 maxlen = strlen (keystring);
2042 keysyms = g_new0 (KeySym, maxlen);
2043 if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2048 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2050 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2055 mbytes = g_unichar_to_utf8 (unichar, bytes);
2056 bytes[mbytes] = '\0';
2058 fprintf (stderr, "[unichar %s]", bytes);
2060 keysym = dec_keysym_for_unichar (controller, unichar);
2061 if (keysym == NoSymbol) {
2063 fprintf (stderr, "no keysym for %s", bytes);
2068 keysyms[i++] = keysym;
2069 keystring = g_utf8_next_char (keystring);
2072 for (i = 0; keysyms[i]; ++i) {
2073 if (!dec_synth_keysym (controller, keysyms[i])) {
2075 fprintf (stderr, "could not synthesize %c\n",
2090 * CORBA Accessibility::DEController::registerKeystrokeListener
2091 * method implementation
2094 impl_generate_keyboard_event (PortableServer_Servant servant,
2095 const CORBA_long keycode,
2096 const CORBA_char *keystring,
2097 const Accessibility_KeySynthType synth_type,
2098 CORBA_Environment *ev)
2100 SpiDEController *controller =
2101 SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
2102 long key_synth_code;
2106 fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2107 (long) keycode, (int) synth_type);
2109 /* TODO: hide/wrap/remove X dependency */
2112 * TODO: when initializing, query for XTest extension before using,
2113 * and fall back to XSendEvent() if XTest is not available.
2116 gdk_error_trap_push ();
2117 key_synth_code = keycode;
2121 case Accessibility_KEY_PRESS:
2122 dec_synth_keycode_press (controller, keycode);
2124 case Accessibility_KEY_PRESSRELEASE:
2125 dec_synth_keycode_press (controller, keycode);
2126 case Accessibility_KEY_RELEASE:
2127 dec_synth_keycode_release (controller, keycode);
2129 case Accessibility_KEY_SYM:
2130 #ifdef SPI_XKB_DEBUG
2131 fprintf (stderr, "KeySym synthesis\n");
2134 * note: we are using long for 'keycode'
2135 * in our arg list; it can contain either
2136 * a keycode or a keysym.
2138 dec_synth_keysym (controller, (KeySym) keycode);
2140 case Accessibility_KEY_STRING:
2141 if (!dec_synth_keystring (controller, keystring))
2142 fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2146 if (gdk_error_trap_pop ())
2148 DBG (-1, g_warning ("Error emitting keystroke"));
2150 if (synth_type == Accessibility_KEY_SYM) {
2154 keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2156 if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2158 spi_dec_clear_unlatch_pending (controller);
2162 /* Accessibility::DEController::generateMouseEvent */
2164 impl_generate_mouse_event (PortableServer_Servant servant,
2167 const CORBA_char *eventName,
2168 CORBA_Environment *ev)
2171 gboolean error = FALSE;
2172 Display *display = spi_get_display ();
2174 fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2175 eventName, (long int) x, (long int) y);
2177 switch (eventName[0])
2180 switch (eventName[1])
2182 /* TODO: check number of buttons before parsing */
2203 if (x != -1 && y != -1)
2205 XTestFakeMotionEvent (display, DefaultScreen (display),
2208 XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2209 if (eventName[2] == 'c')
2210 XTestFakeButtonEvent (display, button, FALSE, 1);
2211 else if (eventName[2] == 'd')
2213 XTestFakeButtonEvent (display, button, FALSE, 1);
2214 XTestFakeButtonEvent (display, button, TRUE, 2);
2215 XTestFakeButtonEvent (display, button, FALSE, 3);
2219 case 'r': /* relative motion */
2220 XTestFakeRelativeMotionEvent (display, x, y, 0);
2222 case 'a': /* absolute motion */
2223 XTestFakeMotionEvent (display, DefaultScreen (display),
2229 /* Accessibility::DEController::notifyListenersSync */
2230 static CORBA_boolean
2231 impl_notify_listeners_sync (PortableServer_Servant servant,
2232 const Accessibility_DeviceEvent *event,
2233 CORBA_Environment *ev)
2235 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2236 bonobo_object_from_servant (servant));
2238 g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2239 controller, (int) event->id);
2241 return spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev) ?
2242 CORBA_TRUE : CORBA_FALSE;
2245 /* Accessibility::DEController::notifyListenersAsync */
2247 impl_notify_listeners_async (PortableServer_Servant servant,
2248 const Accessibility_DeviceEvent *event,
2249 CORBA_Environment *ev)
2251 SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2252 bonobo_object_from_servant (servant));
2254 fprintf (stderr, "notifying listeners asynchronously\n");
2256 spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev);
2260 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2262 GObjectClass * object_class = (GObjectClass *) klass;
2263 POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
2265 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2267 object_class->finalize = spi_device_event_controller_object_finalize;
2269 epv->registerKeystrokeListener = impl_register_keystroke_listener;
2270 epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
2271 epv->registerDeviceEventListener = impl_register_device_listener;
2272 epv->deregisterDeviceEventListener = impl_deregister_device_listener;
2273 epv->generateKeyboardEvent = impl_generate_keyboard_event;
2274 epv->generateMouseEvent = impl_generate_mouse_event;
2275 epv->notifyListenersSync = impl_notify_listeners_sync;
2276 epv->notifyListenersAsync = impl_notify_listeners_async;
2278 if (!spi_dec_private_quark)
2279 spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2283 Bool isEvent(dpy,event,arg)
2292 handle_io (GIOChannel *source,
2293 GIOCondition condition,
2296 SpiDEController *controller = (SpiDEController *) data;
2297 gboolean is_consumed = FALSE;
2300 while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2302 if (ev.type == KeyPress || ev.type == KeyRelease)
2303 is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2306 XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2311 #endif /* HAVE_XEVIE */
2314 spi_device_event_controller_init (SpiDEController *device_event_controller)
2319 #endif /* HAVE_XEVIE */
2321 DEControllerPrivateData *private;
2322 device_event_controller->key_listeners = NULL;
2323 device_event_controller->mouse_listeners = NULL;
2324 device_event_controller->keygrabs_list = NULL;
2325 device_event_controller->xevie_display = NULL;
2328 device_event_controller->xevie_display = XOpenDisplay(NULL);
2330 if (XevieStart(device_event_controller->xevie_display) == TRUE)
2332 #ifdef SPI_KEYEVENT_DEBUG
2333 fprintf (stderr, "XevieStart() success \n");
2335 XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2337 fd = ConnectionNumber(device_event_controller->xevie_display);
2338 ioc = g_io_channel_unix_new (fd);
2339 g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2340 g_io_channel_unref (ioc);
2344 device_event_controller->xevie_display = NULL;
2345 #ifdef SPI_KEYEVENT_DEBUG
2346 fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2349 #endif /* HAVE_XEVIE */
2351 private = g_new0 (DEControllerPrivateData, 1);
2352 gettimeofday (&private->last_press_time, NULL);
2353 gettimeofday (&private->last_release_time, NULL);
2354 g_object_set_qdata (G_OBJECT (device_event_controller),
2355 spi_dec_private_quark,
2357 spi_controller_register_with_devices (device_event_controller);
2361 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2362 const XEvent *event)
2364 CORBA_Environment ev;
2365 Accessibility_DeviceEvent key_event;
2367 g_assert (event->type == KeyPress || event->type == KeyRelease);
2369 CORBA_exception_init (&ev);
2371 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2373 if (controller->xevie_display == NULL)
2374 spi_controller_update_key_grabs (controller, &key_event);
2376 /* relay to listeners, and decide whether to consume it or not */
2377 return spi_controller_notify_keylisteners (controller, &key_event, CORBA_TRUE, &ev);
2381 spi_device_event_controller_new (SpiRegistry *registry)
2383 SpiDEController *retval = g_object_new (
2384 SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2386 retval->registry = SPI_REGISTRY (bonobo_object_ref (
2387 BONOBO_OBJECT (registry)));
2389 spi_dec_init_mouse_listener (registry);
2390 /* TODO: kill mouse listener on finalize */
2395 is_key_released (KeyCode code)
2401 XQueryKeymap (spi_get_display (), keys);
2402 down = BIT (keys, code);
2407 check_release (gpointer data)
2410 Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2411 KeyCode code = event->hw_code;
2412 CORBA_Environment ev;
2414 released = is_key_released (code);
2418 check_release_handler = 0;
2419 event->type = Accessibility_KEY_RELEASED_EVENT;
2420 ev._major = CORBA_NO_EXCEPTION;
2421 spi_controller_notify_keylisteners (saved_controller, event, CORBA_TRUE, &ev);
2423 return (released == 0);
2426 static void wait_for_release_event (GdkEvent *event,
2427 SpiDEController *controller)
2429 pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2430 saved_controller = controller;
2431 check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2434 BONOBO_TYPE_FUNC_FULL (SpiDEController,
2435 Accessibility_DeviceEventController,
2437 spi_device_event_controller)