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 */
32 #include <X11/extensions/XTest.h>
33 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
34 #include <gdk/gdkwindow.h>
36 #include <libspi/deviceeventcontroller.h>
38 /* Our parent Gtk object type */
39 #define PARENT_TYPE BONOBO_TYPE_OBJECT
41 /* A pointer to our parent object class */
42 static GObjectClass *spi_device_event_controller_parent_class;
44 static gboolean kbd_registered = FALSE;
46 static Display *display;
48 static Window root_window;
52 SPI_DEVICE_TYPE_MOUSE,
53 SPI_DEVICE_TYPE_LAST_DEFINED
54 } SpiDeviceTypeCategory;
56 struct _DEControllerListener {
58 SpiDeviceTypeCategory type;
61 typedef struct _DEControllerListener DEControllerListener;
63 struct _DEControllerKeyListener {
64 DEControllerListener listener;
65 Accessibility_KeySet *keys;
66 Accessibility_ControllerEventMask *mask;
67 Accessibility_KeyEventTypeSeq *typeseq;
68 gboolean is_system_global;
71 typedef struct _DEControllerKeyListener DEControllerKeyListener;
73 static gboolean _controller_register_with_devices (SpiDeviceEventController *controller);
74 static gboolean _controller_grab_keyboard (SpiDeviceEventController *controller);
76 static void controller_register_device_listener (SpiDeviceEventController *controller,
77 DEControllerListener *l,
78 CORBA_Environment *ev);
85 _compare_corba_objects (gconstpointer p1, gconstpointer p2)
89 retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
92 fprintf (stderr, "comparing %p to %p; result %d\n",
100 _compare_listeners (gconstpointer p1, gconstpointer p2)
102 DEControllerListener *l1 = (DEControllerListener *) p1;
103 DEControllerListener *l2 = (DEControllerListener *) p2;
104 return _compare_corba_objects (l1->object, l2->object);
108 _eventmask_compare_value (gconstpointer p1, gconstpointer p2)
112 return (gint) (p1?1:(p2?-1:0));
114 d = ((long)((Accessibility_ControllerEventMask*)p2)->value) -
115 ((long)((Accessibility_ControllerEventMask*)p1)->value);
119 static DEControllerKeyListener *
120 dec_key_listener_new (CORBA_Object l,
121 const Accessibility_KeySet *keys,
122 const Accessibility_ControllerEventMask *mask,
123 const Accessibility_KeyEventTypeSeq *typeseq,
124 const CORBA_boolean is_system_global,
125 CORBA_Environment *ev)
127 DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
128 key_listener->listener.object = CORBA_Object_duplicate (l, ev);
129 key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
130 key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
131 key_listener->mask = ORBit_copy_value (mask, TC_Accessibility_ControllerEventMask);
132 key_listener->is_system_global = is_system_global;
134 g_print ("new listener, with mask %x, is_global %d, keys %p\n",
135 (unsigned int) key_listener->mask->value,
136 (int) key_listener->is_system_global,
137 (void *) key_listener->keys);
143 controller_register_device_listener (SpiDeviceEventController *controller,
144 DEControllerListener *listener,
145 CORBA_Environment *ev)
147 Accessibility_ControllerEventMask *mask_ptr = NULL;
148 DEControllerKeyListener *key_listener;
150 switch (listener->type) {
151 case SPI_DEVICE_TYPE_KBD:
152 key_listener = (DEControllerKeyListener *) listener;
153 controller->key_listeners = g_list_append (controller->key_listeners, key_listener);
155 mask_ptr = (Accessibility_ControllerEventMask *)
156 g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
157 _eventmask_compare_value);
159 ++(mask_ptr->refcount);
162 if (key_listener->mask->refcount != (CORBA_unsigned_short) 1)
163 fprintf (stderr, "mask initial refcount is not 1!\n");
164 if (key_listener->mask->value > (CORBA_unsigned_long) 2048)
165 fprintf (stderr, "mask value looks invalid (%lu)\n",
166 (unsigned long) key_listener->mask->value);
168 fprintf (stderr, "appending mask with val=%lu\n",
169 (unsigned long) key_listener->mask->value);
170 mask_ptr = Accessibility_ControllerEventMask__alloc();
171 mask_ptr->value = key_listener->mask->value;
172 mask_ptr->refcount = (CORBA_unsigned_short) 1;
173 controller->keymask_list = g_list_append (controller->keymask_list,
174 (gpointer) mask_ptr);
177 case SPI_DEVICE_TYPE_MOUSE:
178 /* controller->mouse_listeners = g_list_append (controller->mouse_listeners,
179 CORBA_Object_duplicate (l, ev));*/
181 /* possibly this interface should NOT be used for mouse events ? */
187 controller_deregister_device_listener (SpiDeviceEventController *controller,
188 DEControllerListener *listener,
189 CORBA_Environment *ev)
191 Accessibility_ControllerEventMask *mask_ptr;
192 DEControllerKeyListener *key_listener;
194 switch (listener->type) {
195 case SPI_DEVICE_TYPE_KBD:
196 key_listener = (DEControllerKeyListener *) listener;
197 list_ptr = g_list_find_custom (controller->key_listeners, listener, _compare_listeners);
198 /* TODO: need a different custom compare func */
200 controller->key_listeners = g_list_remove (controller->key_listeners, list_ptr);
202 g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
203 _eventmask_compare_value);
206 mask_ptr = (Accessibility_ControllerEventMask *) list_ptr->data;
208 --mask_ptr->refcount;
209 if (!mask_ptr->refcount)
211 controller->keymask_list =
212 g_list_remove (controller->keymask_list, mask_ptr);
213 ; /* TODO: release any key grabs that are in place for this key mask */
217 case SPI_DEVICE_TYPE_MOUSE:
218 /* controller->mouse_listeners = g_list_append (controller->mouse_listeners,
219 CORBA_Object_duplicate (l, ev));*/
221 /* possibly this interface should NOT be used for mouse events ? */
227 _controller_register_with_devices (SpiDeviceEventController *controller)
229 gboolean retval = FALSE;
231 /* calls to device-specific implementations and routines go here */
232 /* register with: keyboard hardware code handler */
233 /* register with: (translated) keystroke handler */
235 fprintf (stderr, "About to request events on window %ld of display %p\n",
236 (unsigned long) GDK_ROOT_WINDOW(), GDK_DISPLAY());
238 /* We must open a new connection to the server to avoid clashing with the GDK event loop */
239 display = XOpenDisplay (g_getenv ("DISPLAY"));
240 root_window = DefaultRootWindow (display);
241 XSelectInput (display,
243 KeyPressMask | KeyReleaseMask);
244 /* register with: mouse hardware device handler? */
245 /* register with: mouse event handler */
251 key_event_matches_listener (Accessibility_KeyStroke *key_event,
252 DEControllerKeyListener *listener,
253 CORBA_boolean is_system_global)
255 g_print ("mask=%x, listener mask= %x\n", (unsigned int) key_event->modifiers,
256 (unsigned int) (listener->mask->value & 0xFFFF));
257 if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask->value && 0xFFFF)) &&
258 ((listener->keys == NULL) || (1)) && /* in keyset seq */
259 (1) && /* in event type seq */
260 (is_system_global == listener->is_system_global))
269 notify_keylisteners (GList *key_listeners,
270 Accessibility_KeyStroke *key_event,
271 CORBA_boolean is_system_global,
272 CORBA_Environment *ev)
274 int i, n_listeners = g_list_length (key_listeners);
275 gboolean is_consumed = FALSE;
277 for (i=0; i<n_listeners && !is_consumed; ++i)
279 Accessibility_KeystrokeListener ls;
280 DEControllerKeyListener *key_listener = (DEControllerKeyListener *)
281 g_list_nth_data (key_listeners, i);
282 ls = (Accessibility_KeystrokeListener) key_listener->listener.object;
283 if (key_event_matches_listener (key_event, key_listener, is_system_global))
285 if (!CORBA_Object_is_nil(ls, ev))
287 is_consumed = Accessibility_KeystrokeListener_keyEvent (ls, key_event, ev);
290 else g_print ("no match for listener %d\n", i);
296 _check_key_event (SpiDeviceEventController *controller)
298 static gboolean initialized = FALSE;
299 XEvent *x_event = g_new0 (XEvent, 1);
300 XKeyEvent *x_key_event;
302 gboolean is_consumed = FALSE;
303 Accessibility_KeyStroke key_event;
304 static CORBA_Environment ev;
309 CORBA_exception_init (&ev);
312 while (XPending(display))
314 XNextEvent (display, x_event);
315 if (XFilterEvent (x_event, None)) continue;
316 if (x_event->type == KeyPress)
318 x_key_event = (XKeyEvent *)x_event;
319 keysym = XLookupKeysym (x_key_event, 0);
320 key_event.keyID = (CORBA_long)(keysym);
321 key_event.keycode = (CORBA_short) x_key_event->keycode;
322 key_event.type = Accessibility_KEY_PRESSED;
323 key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
324 #ifdef SPI_KEYEVENT_DEBUG
326 "Key %lu pressed (%c), modifiers %d\n",
327 (unsigned long) keysym,
328 keysym ? (int) keysym : '*',
329 (int) x_key_event->state);
332 fprintf (stderr, "%s%c",
333 (x_key_event->state & Mod1Mask)?"Alt-":"",
334 ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
335 g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
336 #endif /* SPI_DEBUG */
340 #ifdef SPI_KEYEVENT_DEBUG
341 fprintf (stderr, "other event, type %d\n", (int) x_event->type);
344 /* relay to listeners, and decide whether to consume it or not */
345 is_consumed = notify_keylisteners (controller->key_listeners, &key_event, CORBA_TRUE, &ev);
349 XAllowEvents (display, AsyncKeyboard, CurrentTime);
353 XAllowEvents (display, ReplayKeyboard, CurrentTime);
356 XUngrabKey (display, AnyKey, AnyModifier, root_window);
357 return _controller_grab_keyboard (controller);
361 _controller_grab_keyboard (SpiDeviceEventController *controller)
363 GList *maskList = controller->keymask_list;
366 last_mask = g_list_length (maskList);
369 * masks known to work with default RH 7.1:
370 * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
371 * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
372 * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
373 * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
375 * ControlMask grabs are broken, must be in use already
378 for (i=0; i < last_mask; ++i)
380 Accessibility_ControllerEventMask *mask
381 = (Accessibility_ControllerEventMask *)g_list_nth_data (maskList, i);
382 unsigned long maskVal = 0xFFFFFFFF;
383 if (mask) maskVal = (unsigned long) mask->value;
384 #ifdef SPI_KEYEVENT_DEBUG
385 fprintf (stderr, "mask=%lx\n", maskVal);
387 if (!(maskVal & ControlMask))
396 /* TODO: check call for errors and return FALSE if error occurs */
398 return FALSE; /* can't do control key yet */
405 * Implemented GObject::finalize
408 spi_device_event_controller_object_finalize (GObject *object)
412 fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
414 spi_device_event_controller_parent_class->finalize (object);
418 * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
419 * method implementation
422 impl_register_keystroke_listener (PortableServer_Servant servant,
423 const Accessibility_KeystrokeListener l,
424 const Accessibility_KeySet *keys,
425 const Accessibility_ControllerEventMask *mask,
426 const Accessibility_KeyEventTypeSeq *type,
427 const CORBA_boolean is_system_global,
428 CORBA_Environment *ev)
430 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
431 bonobo_object_from_servant (servant));
432 DEControllerKeyListener *dec_listener;
434 fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
435 (void *) l, (unsigned long) mask->value);
437 dec_listener = dec_key_listener_new (l, keys, mask, type, is_system_global, ev);
438 controller_register_device_listener (controller, (DEControllerListener *) dec_listener, ev);
442 * CORBA Accessibility::DeviceEventController::deregisterKeystrokeListener
443 * method implementation
446 impl_deregister_keystroke_listener (PortableServer_Servant servant,
447 const Accessibility_KeystrokeListener l,
448 const Accessibility_KeySet *keys,
449 const Accessibility_ControllerEventMask *mask,
450 const Accessibility_KeyEventTypeSeq *type,
451 const CORBA_boolean is_system_global,
452 CORBA_Environment *ev)
454 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
455 bonobo_object_from_servant (servant));
456 DEControllerKeyListener *key_listener = dec_key_listener_new (l,
463 fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
464 (void *) l, (unsigned long) mask->value);
466 controller_deregister_device_listener(controller,
467 (DEControllerListener *) key_listener,
472 * CORBA Accessibility::DeviceEventController::registerMouseListener
473 * method implementation
477 impl_register_mouse_listener (PortableServer_Servant servant,
478 const Accessibility_MouseListener *l,
479 CORBA_Environment *ev)
481 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
482 bonobo_object_from_servant (servant));
484 fprintf (stderr, "registering mouse listener %p\n", l);
486 controller_register_device_listener(controller, DEVICE_TYPE_MOUSE, l, keys, mask, ev);
491 keycode_for_keysym (long keysym)
493 return XKeysymToKeycode (display, (KeySym) keysym);
497 * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
498 * method implementation
501 impl_generate_key_event (PortableServer_Servant servant,
502 const CORBA_long keycode,
503 const Accessibility_KeySynthType synth_type,
504 CORBA_Environment *ev)
508 fprintf (stderr, "synthesizing keystroke %ld\n", (long) keycode);
510 /* TODO: hide/wrap/remove X dependency */
512 /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
515 * TODO: when initializing, query for XTest extension before using,
516 * and fall back to XSendEvent() if XTest is not available.
521 case Accessibility_KEY_PRESS:
522 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
524 case Accessibility_KEY_PRESSRELEASE:
525 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
526 case Accessibility_KEY_RELEASE:
527 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, False, CurrentTime);
529 case Accessibility_KEY_SYM:
530 key_synth_code = keycode_for_keysym (keycode);
531 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, True, CurrentTime);
532 XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, False, CurrentTime);
537 /* Accessibility::DeviceEventController::generateMouseEvent */
539 impl_generate_mouse_event (PortableServer_Servant servant,
542 const CORBA_char *eventName,
543 CORBA_Environment *ev)
546 fprintf (stderr, "generating mouse %s event at %ld, %ld\n", eventName, x, y);
550 /* Accessibility::DeviceEventController::notifyListenersSync */
552 impl_notify_listeners_sync(PortableServer_Servant servant,
553 const Accessibility_DeviceEvent *event,
554 CORBA_Environment *ev)
556 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
557 bonobo_object_from_servant (servant));
558 Accessibility_KeyStroke *key_event = (Accessibility_KeyStroke *) event;
560 g_print ("notifying listeners synchronously: controller %x, event id %d\n",
561 (void *) controller, (int) event->eventID);
563 return (notify_keylisteners (controller->key_listeners, key_event, CORBA_FALSE, ev) ?
564 CORBA_TRUE : CORBA_FALSE);
567 /* Accessibility::DeviceEventController::notifyListenersAsync */
569 impl_notify_listeners_async (PortableServer_Servant servant,
570 const Accessibility_DeviceEvent *event,
571 CORBA_Environment *ev)
573 SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER(
574 bonobo_object_from_servant (servant));
575 Accessibility_KeyStroke *key_event = (Accessibility_KeyStroke *) event;
577 fprintf (stderr, "notifying listeners asynchronously\n");
579 notify_keylisteners (controller->key_listeners, key_event, CORBA_FALSE, ev);
583 spi_device_event_controller_class_init (SpiDeviceEventControllerClass *klass)
585 GObjectClass * object_class = (GObjectClass *) klass;
586 POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
587 spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
589 object_class->finalize = spi_device_event_controller_object_finalize;
591 epv->registerKeystrokeListener = impl_register_keystroke_listener;
592 epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
593 /* epv->registerMouseListener = impl_register_mouse_listener; */
594 epv->generateKeyEvent = impl_generate_key_event;
595 epv->generateMouseEvent = impl_generate_mouse_event;
596 epv->notifyListenersSync = impl_notify_listeners_sync;
597 epv->notifyListenersAsync = impl_notify_listeners_async;
598 klass->check_key_event = _check_key_event;
602 spi_device_event_controller_init (SpiDeviceEventController *device_event_controller)
604 device_event_controller->key_listeners = NULL;
605 device_event_controller->mouse_listeners = NULL;
606 device_event_controller->keymask_list = NULL;
607 kbd_registered = _controller_register_with_devices (device_event_controller);
611 spi_device_event_controller_check_key_event (SpiDeviceEventController *controller)
613 SpiDeviceEventControllerClass *klass = SPI_DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
614 if (klass->check_key_event)
615 return (klass->check_key_event) (controller);
619 SpiDeviceEventController *
620 spi_device_event_controller_new (void *registryp)
622 BonoboObject *registry = (BonoboObject *) registryp;
623 SpiDeviceEventController *retval = g_object_new (
624 SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
625 retval->registry = registry;
626 bonobo_object_ref (registry);
630 BONOBO_TYPE_FUNC_FULL (SpiDeviceEventController,
631 Accessibility_DeviceEventController,
633 spi_device_event_controller);