2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 /* deviceeventcontroler.c: implement the DeviceEventController interface */
34 #include <X11/extensions/XTest.h>
36 #include <X11/keysymdef.h>
37 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
38 #include <gdk/gdkwindow.h>
40 #include "deviceeventcontroller.h"
42 /* Our parent Gtk object type */
43 #define PARENT_TYPE BONOBO_TYPE_OBJECT
45 /* A pointer to our parent object class */
46 static GObjectClass *spi_device_event_controller_parent_class;
48 static gboolean kbd_registered = FALSE;
50 static Display *display;
52 static Window root_window;
56 SPI_DEVICE_TYPE_MOUSE,
57 SPI_DEVICE_TYPE_LAST_DEFINED
58 } SpiDeviceTypeCategory;
60 struct _DEControllerGrabMask {
61 Accessibility_ControllerEventMask modmask;
62 CORBA_unsigned_long keyval;
63 unsigned int refcount;
66 typedef struct _DEControllerGrabMask DEControllerGrabMask;
68 struct _DEControllerListener {
70 SpiDeviceTypeCategory type;
73 typedef struct _DEControllerListener DEControllerListener;
75 struct _DEControllerKeyListener {
76 DEControllerListener listener;
77 Accessibility_KeySet *keys;
78 Accessibility_ControllerEventMask mask;
79 Accessibility_KeyEventTypeSeq *typeseq;
80 gboolean is_system_global;
83 typedef struct _DEControllerKeyListener DEControllerKeyListener;
85 static gboolean spi_controller_register_with_devices (SpiDeviceEventController *controller);
86 static gboolean spi_controller_grab_keyboard (SpiDeviceEventController *controller);
88 static void spi_controller_register_device_listener (SpiDeviceEventController *controller,
89 DEControllerListener *l,
90 CORBA_Environment *ev);
96 static DEControllerGrabMask *
97 spi_grabmask_clone (DEControllerGrabMask *grabmask)
99 DEControllerGrabMask *clone = g_new0 (DEControllerGrabMask, 1);
100 memcpy (clone, grabmask, sizeof (DEControllerGrabMask));
105 spi_compare_corba_objects (gconstpointer p1, gconstpointer p2)
107 CORBA_Environment ev;
109 retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
112 fprintf (stderr, "comparing %p to %p; result %d\n",
120 spi_compare_listeners (gconstpointer p1, gconstpointer p2)
122 DEControllerListener *l1 = (DEControllerListener *) p1;
123 DEControllerListener *l2 = (DEControllerListener *) p2;
124 return spi_compare_corba_objects (l1->object, l2->object);
128 spi_grabmask_compare_values (gconstpointer p1, gconstpointer p2)
130 DEControllerGrabMask *l1;
131 DEControllerGrabMask *l2;
138 l1 = (DEControllerGrabMask *) p1;
139 l2 = (DEControllerGrabMask *) p2;
140 return ((l1->modmask != l2->modmask) || (l1->keyval != l2->keyval));
144 static DEControllerKeyListener *
145 spi_dec_key_listener_new (CORBA_Object l,
146 const Accessibility_KeySet *keys,
147 const Accessibility_ControllerEventMask mask,
148 const Accessibility_KeyEventTypeSeq *typeseq,
149 const CORBA_boolean is_system_global,
150 CORBA_Environment *ev)
152 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
153 key_listener->listener.object = bonobo_object_dup_ref (l, ev);
154 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
155 key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
156 key_listener->mask = mask;
157 key_listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_KeyEventTypeSeq);
158 key_listener->is_system_global = is_system_global;
161 g_print ("new listener, with mask %x, is_global %d, keys %p\n",
162 (unsigned int) key_listener->mask,
163 (int) key_listener->is_system_global,
164 (void *) key_listener->keys);
170 spi_dec_key_listener_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
172 bonobo_object_release_unref (key_listener->listener.object, ev);
173 CORBA_free (key_listener->typeseq);
174 CORBA_free (key_listener->keys);
175 g_free (key_listener);
179 spi_controller_deregister_global_keygrabs (SpiDeviceEventController *controller,
180 DEControllerKeyListener *key_listener)
183 DEControllerGrabMask *mask_ptr;
184 /* TODO: implement this! Also remember to release any keygrabs still held */
189 spi_controller_register_global_keygrabs (SpiDeviceEventController *controller,
190 DEControllerKeyListener *key_listener)
192 DEControllerGrabMask grabmask, *grabmask_ptr;
195 /* TODO: deregistration version of this function */
197 grabmask.modmask = key_listener->mask;
198 if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
200 grabmask.keyval = AnyKey;
201 list_ptr = g_list_find_custom (controller->keygrabs_list, &grabmask,
202 spi_grabmask_compare_values);
205 grabmask_ptr = (DEControllerGrabMask *) list_ptr->data;
206 grabmask_ptr->refcount++;
210 controller->keygrabs_list =
211 g_list_prepend (controller->keygrabs_list,
212 spi_grabmask_clone (&grabmask));
217 for (i = 0; i < key_listener->keys->_length; ++i)
219 long int keyval = key_listener->keys->_buffer[i];
220 /* X Grabs require keycodes, not keysyms */
223 keyval = XKeysymToKeycode(display, (KeySym) keyval);
225 grabmask.keyval = keyval;
226 list_ptr = g_list_find_custom (controller->keygrabs_list, &grabmask,
227 spi_grabmask_compare_values);
230 grabmask_ptr = (DEControllerGrabMask *) list_ptr->data;
231 grabmask_ptr->refcount++;
235 controller->keygrabs_list =
236 g_list_prepend (controller->keygrabs_list,
237 spi_grabmask_clone (&grabmask));
238 fprintf (stderr, "appending mask with val=%lu\n",
239 (unsigned long) grabmask.modmask);
246 spi_controller_register_device_listener (SpiDeviceEventController *controller,
247 DEControllerListener *listener,
248 CORBA_Environment *ev)
250 DEControllerKeyListener *key_listener;
252 switch (listener->type) {
253 case SPI_DEVICE_TYPE_KBD:
254 key_listener = (DEControllerKeyListener *) listener;
255 controller->key_listeners = g_list_prepend (controller->key_listeners, key_listener);
256 if (key_listener->is_system_global)
258 spi_controller_register_global_keygrabs (controller, key_listener);
261 case SPI_DEVICE_TYPE_MOUSE:
262 /* controller->mouse_listeners = g_list_append (controller->mouse_listeners,
263 CORBA_Object_duplicate (l, ev));*/
265 /* this interface should only be used for mouse motion events, not mouse clicks events */
271 spi_controller_deregister_device_listener (SpiDeviceEventController *controller,
272 DEControllerListener *listener,
273 CORBA_Environment *ev)
275 Accessibility_ControllerEventMask *mask_ptr;
276 DEControllerListener *dec_listener;
278 switch (listener->type)
280 case SPI_DEVICE_TYPE_KBD:
281 spi_controller_deregister_global_keygrabs (controller,
282 (DEControllerKeyListener *) listener);
284 /* now, remove this listener from the keylistener list */
285 list_ptr = g_list_find_custom (controller->key_listeners, listener, spi_compare_listeners);
288 dec_listener = (DEControllerListener *) list_ptr->data;
290 g_print ("removing keylistener %p\n", dec_listener->object);
292 controller->key_listeners = g_list_remove_link (controller->key_listeners,
294 spi_dec_key_listener_free ((DEControllerKeyListener *) dec_listener, ev);
297 case SPI_DEVICE_TYPE_MOUSE: /* TODO: implement */
303 spi_controller_register_with_devices (SpiDeviceEventController *controller)
305 gboolean retval = FALSE;
307 /* calls to device-specific implementations and routines go here */
308 /* register with: keyboard hardware code handler */
309 /* register with: (translated) keystroke handler */
311 fprintf (stderr, "About to request events on window %ld of display %p\n",
312 (unsigned long) GDK_ROOT_WINDOW(), GDK_DISPLAY());
314 /* We must open a new connection to the server to avoid clashing with the GDK event loop */
315 display = XOpenDisplay (g_getenv ("DISPLAY"));
316 root_window = DefaultRootWindow (display);
317 XSelectInput (display,
319 KeyPressMask | KeyReleaseMask);
320 /* register with: mouse hardware device handler? */
321 /* register with: mouse event handler */
326 spi_key_set_contains_key (Accessibility_KeySet *key_set, const Accessibility_DeviceEvent *key_event)
331 /* g_assert (key_set); */
332 if (!key_set) { g_print ("null key set!"); return TRUE; }
334 len = key_set->_length;
336 if (len == 0) /* special case, means "all keys/any key" */
338 g_print ("anykey\n");
342 for (i=0; i<len; ++i)
344 #ifdef SPI_KEYEVENT_DEBUG
345 g_print ("key_set[%d] = %d; key_event %d, code %d\n",
347 (int) key_set->_buffer[i],
349 (int) key_event->hw_code);
351 if (key_set->_buffer[i] == (CORBA_long) key_event->id) return TRUE;
352 if (key_set->_buffer[i] == (CORBA_long) -key_event->hw_code) return TRUE;
359 spi_key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq *type_seq,
360 const Accessibility_DeviceEvent *key_event)
365 /* g_assert (type_seq); */
366 if (!type_seq) { g_print ("null type seq!"); return TRUE; }
368 len = type_seq->_length;
370 if (len == 0) /* special case, means "all events/any event" */
375 for (i=0; i<len; ++i)
378 g_print ("type_seq[%d] = %d; key event type = %d\n", i, (int) type_seq->_buffer[i],
379 (int) key_event->type);
381 if (type_seq->_buffer[i] == (CORBA_long) key_event->type) return TRUE;
388 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
389 DEControllerKeyListener *listener,
390 CORBA_boolean is_system_global)
392 if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFFFF)) &&
393 spi_key_set_contains_key (listener->keys, key_event) &&
394 spi_key_eventtype_seq_contains_event (listener->typeseq, key_event) &&
395 (is_system_global == listener->is_system_global))
404 spi_notify_keylisteners (GList *key_listeners,
405 const Accessibility_DeviceEvent *key_event,
406 CORBA_boolean is_system_global,
407 CORBA_Environment *ev)
409 int i, n_listeners = g_list_length (key_listeners);
410 gboolean is_consumed = FALSE;
412 for (i=0; i<n_listeners && !is_consumed; ++i)
414 Accessibility_DeviceEventListener ls;
415 DEControllerKeyListener *key_listener = (DEControllerKeyListener *)
416 g_list_nth_data (key_listeners, i);
417 ls = (Accessibility_DeviceEventListener) key_listener->listener.object;
418 if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
420 if (!CORBA_Object_is_nil(ls, ev))
422 is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
427 #ifdef SPI_KEYEVENT_DEBUG
428 g_print ("no match for listener %d\n", i);
436 static Accessibility_DeviceEvent
437 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
439 Accessibility_DeviceEvent key_event;
441 const int cbuf_bytes = 20;
442 char cbuf [cbuf_bytes];
444 keysym = XLookupKeysym (x_key_event, 0);
445 key_event.id = (CORBA_long)(keysym);
446 key_event.hw_code = (CORBA_short) x_key_event->keycode;
447 if (((XEvent *) x_key_event)->type == KeyPress)
449 key_event.type = Accessibility_KEY_PRESSED;
453 key_event.type = Accessibility_KEY_RELEASED;
455 key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
460 key_event.event_string = CORBA_string_dup ("space");
463 key_event.event_string = CORBA_string_dup ("Tab");
466 key_event.event_string = CORBA_string_dup ("Backspace");
469 key_event.event_string = CORBA_string_dup ("Return");
472 if (XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL) > 0)
474 key_event.event_string = CORBA_string_dup (cbuf);
478 key_event.event_string = CORBA_string_dup ("");
482 key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
483 #ifdef SPI_KEYEVENT_DEBUG
485 "Key %lu pressed (%c), modifiers %d\n",
486 (unsigned long) keysym,
487 keysym ? (int) keysym : '*',
488 (int) x_key_event->state);
491 fprintf (stderr, "%s%c",
492 (x_key_event->state & Mod1Mask)?"Alt-":"",
493 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
494 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
495 #endif /* SPI_DEBUG */
501 spi_check_key_event (SpiDeviceEventController *controller)
503 static gboolean initialized = FALSE;
504 XEvent *x_event = g_new0 (XEvent, 1);
505 XKeyEvent *x_key_event;
506 gboolean is_consumed = FALSE;
507 Accessibility_DeviceEvent key_event;
508 static CORBA_Environment ev;
513 CORBA_exception_init (&ev);
516 while (XPending(display))
518 XNextEvent (display, x_event);
519 if (XFilterEvent (x_event, None)) continue;
520 if (x_event->type == KeyPress || x_event->type == KeyRelease)
522 key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) x_event);
523 /* relay to listeners, and decide whether to consume it or not */
524 is_consumed = spi_notify_keylisteners (controller->key_listeners, &key_event, CORBA_TRUE, &ev);
528 #ifdef SPI_KEYEVENT_DEBUG
529 fprintf (stderr, "other event, type %d\n", (int) x_event->type);
535 XAllowEvents (display, AsyncKeyboard, CurrentTime);
539 XAllowEvents (display, ReplayKeyboard, CurrentTime);
542 XUngrabKey (display, AnyKey, AnyModifier, root_window);
544 return spi_controller_grab_keyboard (controller);
548 spi_controller_grab_keyboard (SpiDeviceEventController *controller)
550 GList *maskList = controller->keygrabs_list;
553 last_mask = g_list_length (maskList);
556 * masks known to work with default RH 7.1:
557 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
558 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
559 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
560 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
562 * ControlMask grabs are broken, must be in use already
565 for (i=0; i < last_mask; ++i)
567 DEControllerGrabMask * grab_mask
568 = (DEControllerGrabMask *) g_list_nth_data (maskList, i);
569 unsigned long maskVal = 0xFFFFFFFF;
573 maskVal = (unsigned long) grab_mask->modmask;
574 keyVal = grab_mask->keyval;
577 fprintf (stderr, "mask=%lx\n", maskVal);
579 if (!(maskVal & ControlMask))
588 /* TODO: check call for errors and return FALSE if error occurs */
592 return FALSE; /* can't do control key yet */
599 * Implemented GObject::finalize
602 spi_device_event_controller_object_finalize (GObject *object)
606 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
608 /* disconnect any special listeners, get rid of outstanding keygrabs */
610 spi_device_event_controller_parent_class->finalize (object);
614 * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
615 * method implementation
618 impl_register_keystroke_listener (PortableServer_Servant servant,
619 const Accessibility_DeviceEventListener l,
620 const Accessibility_KeySet *keys,
621 const Accessibility_ControllerEventMask mask,
622 const Accessibility_KeyEventTypeSeq *type,
623 const CORBA_boolean is_system_global,
624 CORBA_Environment *ev)
626 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
627 bonobo_object_from_servant (servant));
628 DEControllerKeyListener *dec_listener;
630 fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
631 (void *) l, (unsigned long) mask);
633 dec_listener = spi_dec_key_listener_new (l, keys, mask, type, is_system_global, ev);
634 spi_controller_register_device_listener (controller, (DEControllerListener *) dec_listener, ev);
638 * CORBA Accessibility::DeviceEventController::deregisterKeystrokeListener
639 * method implementation
642 impl_deregister_keystroke_listener (PortableServer_Servant servant,
643 const Accessibility_DeviceEventListener l,
644 const Accessibility_KeySet *keys,
645 const Accessibility_ControllerEventMask mask,
646 const Accessibility_KeyEventTypeSeq *type,
647 const CORBA_boolean is_system_global,
648 CORBA_Environment *ev)
650 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
651 bonobo_object_from_servant (servant));
652 DEControllerKeyListener *key_listener = spi_dec_key_listener_new (l,
658 #ifdef SPI_DEREGISTER_DEBUG
659 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
660 (void *) l, (unsigned long) mask->value);
662 spi_controller_deregister_device_listener(controller,
663 (DEControllerListener *) key_listener,
665 spi_dec_key_listener_free (key_listener, ev);
669 * CORBA Accessibility::DeviceEventController::registerMouseListener
670 * method implementation
674 impl_register_mouse_listener (PortableServer_Servant servant,
675 const Accessibility_MouseListener *l,
676 CORBA_Environment *ev)
678 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
679 bonobo_object_from_servant (servant));
681 fprintf (stderr, "registering mouse listener %p\n", l);
683 spi_controller_register_device_listener(controller, DEVICE_TYPE_MOUSE, l, keys, mask, ev);
688 keycode_for_keysym (long keysym)
690 return XKeysymToKeycode (display, (KeySym) keysym);
694 * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
695 * method implementation
698 impl_generate_key_event (PortableServer_Servant servant,
699 const CORBA_long keycode,
700 const Accessibility_KeySynthType synth_type,
701 CORBA_Environment *ev)
705 fprintf (stderr, "synthesizing keystroke %ld\n", (long) keycode);
707 /* TODO: hide/wrap/remove X dependency */
709 /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
712 * TODO: when initializing, query for XTest extension before using,
713 * and fall back to XSendEvent() if XTest is not available.
718 case Accessibility_KEY_PRESS:
719 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
721 case Accessibility_KEY_PRESSRELEASE:
722 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
723 case Accessibility_KEY_RELEASE:
724 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, False, CurrentTime);
726 case Accessibility_KEY_SYM:
727 key_synth_code = keycode_for_keysym (keycode);
728 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, True, CurrentTime);
729 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, False, CurrentTime);
734 /* Accessibility::DeviceEventController::generateMouseEvent */
736 impl_generate_mouse_event (PortableServer_Servant servant,
739 const CORBA_char *eventName,
740 CORBA_Environment *ev)
743 fprintf (stderr, "generating mouse %s event at %ld, %ld\n", eventName, x, y);
747 /* Accessibility::DeviceEventController::notifyListenersSync */
749 impl_notify_listeners_sync(PortableServer_Servant servant,
750 const Accessibility_DeviceEvent *event,
751 CORBA_Environment *ev)
753 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
754 bonobo_object_from_servant (servant));
756 g_print ("notifylistening listeners synchronously: controller %x, event id %d\n",
757 (void *) controller, (int) event->id);
759 return (spi_notify_keylisteners (controller->key_listeners, event, CORBA_FALSE, ev) ?
760 CORBA_TRUE : CORBA_FALSE);
763 /* Accessibility::DeviceEventController::notifyListenersAsync */
765 impl_notify_listeners_async (PortableServer_Servant servant,
766 const Accessibility_DeviceEvent *event,
767 CORBA_Environment *ev)
769 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER(
770 bonobo_object_from_servant (servant));
772 fprintf (stderr, "notifying listeners asynchronously\n");
774 spi_notify_keylisteners (controller->key_listeners, event, CORBA_FALSE, ev);
778 spi_device_event_controller_class_init (SpiDeviceEventControllerClass *klass)
780 GObjectClass * object_class = (GObjectClass *) klass;
781 POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
782 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
784 object_class->finalize = spi_device_event_controller_object_finalize;
786 epv->registerKeystrokeListener = impl_register_keystroke_listener;
787 epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
788 /* epv->registerMouseListener = impl_register_mouse_listener; */
789 epv->generateKeyEvent = impl_generate_key_event;
790 epv->generateMouseEvent = impl_generate_mouse_event;
791 epv->notifyListenersSync = impl_notify_listeners_sync;
792 epv->notifyListenersAsync = impl_notify_listeners_async;
793 klass->check_key_event = spi_check_key_event;
797 spi_device_event_controller_init (SpiDeviceEventController *device_event_controller)
799 device_event_controller->key_listeners = NULL;
800 device_event_controller->mouse_listeners = NULL;
801 device_event_controller->keygrabs_list = NULL;
802 kbd_registered = spi_controller_register_with_devices (device_event_controller);
806 spi_device_event_controller_check_key_event (SpiDeviceEventController *controller)
808 SpiDeviceEventControllerClass *klass = SPI_DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
809 if (klass->check_key_event)
810 return (klass->check_key_event) (controller);
814 SpiDeviceEventController *
815 spi_device_event_controller_new (void *registryp)
817 BonoboObject *registry = (BonoboObject *) registryp;
818 SpiDeviceEventController *retval = g_object_new (
819 SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
820 retval->registry = registry;
821 bonobo_object_ref (registry);
825 BONOBO_TYPE_FUNC_FULL (SpiDeviceEventController,
826 Accessibility_DeviceEventController,
828 spi_device_event_controller);