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.
24 * registry.c: the main accessibility service registry implementation
31 #include <bonobo/Bonobo.h>
34 * This pulls the CORBA definitions for the "Accessibility::Registry" server
36 #include <libspi/Accessibility.h>
39 * We'd like to replace the dependance on X-isms with a wrapper layer,
40 * to the extent that it can't be done with pure GDK.
41 * Anyone want to help?
47 * This pulls the definition for the BonoboObject (GType)
52 * Our parent GObject type
54 #define PARENT_TYPE SPI_LISTENER_TYPE
57 * A pointer to our parent object class
59 static SpiListenerClass *spi_registry_parent_class;
74 EventTypeCategory type_cat;
82 Accessibility_EventListener listener;
83 guint event_type_hash;
84 EventTypeCategory event_type_cat;
87 /* static function prototypes */
88 static void _registry_notify_listeners ( GList *listeners,
89 const Accessibility_Event *e,
90 CORBA_Environment *ev);
92 static long _get_unique_id();
94 static gboolean _device_event_controller_hook (gpointer source);
97 * Implemented GObject::finalize
100 spi_registry_object_finalize (GObject *object)
102 /* SpiRegistry *registry = SPI_REGISTRY (object); */
103 GObjectClass *object_class = G_OBJECT_GET_CLASS( object);
105 printf("spi_registry_object_finalize called\n");
107 object_class->finalize (object);
111 * registerApplication:
112 * @application: a reference to the requesting @Application
113 * return values: void
115 * Register a new application with the accessibility broker.
119 impl_accessibility_registry_register_application (PortableServer_Servant servant,
120 const Accessibility_Application application,
121 CORBA_Environment * ev)
123 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
126 fprintf (stderr, "registering app %p\n", application);
128 registry->desktop->applications = g_list_append (registry->desktop->applications,
129 bonobo_object_dup_ref (application, ev));
131 /* TODO: create unique string here (with libuuid call ?) and hash ? */
132 Accessibility_Application__set_id (application, _get_unique_id(), ev);
135 * TODO: change the implementation below to a WM-aware one;
136 * e.g. don't add all apps to the SpiDesktop
141 compare_corba_objects (gconstpointer p1, gconstpointer p2)
143 CORBA_Environment ev;
147 fprintf (stderr, "comparing %p to %p\n",
151 retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
156 register_with_toolkits (SpiRegistry *spi_registry_bonobo_object, EventTypeStruct *etype, CORBA_Environment *ev)
161 Accessibility_Desktop desktop;
162 Accessibility_Application app;
163 Accessibility_Registry registry;
164 registry = BONOBO_OBJREF (spi_registry_bonobo_object);
166 /* for each app in each desktop, call ...Application_registerToolkitEventListener */
168 n_desktops = Accessibility_Registry_getDesktopCount (registry, ev);
170 for (i=0; i<n_desktops; ++i)
172 desktop = Accessibility_Registry_getDesktop (registry, i, ev);
173 n_apps = Accessibility_Desktop__get_childCount (desktop, ev);
174 for (j=0; j<n_apps; ++j)
176 app = (Accessibility_Application) Accessibility_Desktop_getChildAtIndex (desktop,
179 Accessibility_Application_registerToolkitEventListener (app,
181 CORBA_string_dup (etype->event_name),
189 compare_listener_hash (gconstpointer p1, gconstpointer p2)
191 return (((SpiListenerStruct *)p2)->event_type_hash - ((SpiListenerStruct *)p1)->event_type_hash);
195 compare_listener_corbaref (gconstpointer p1, gconstpointer p2)
197 return compare_corba_objects (((SpiListenerStruct *)p2)->listener,
198 ((SpiListenerStruct *)p1)->listener);
202 parse_event_type (EventTypeStruct *etype, char *event_name)
205 gchar **split_string;
207 split_string = g_strsplit(event_name, ":", 4);
208 etype->event_name = g_strndup(event_name, 255);
210 if (!g_ascii_strncasecmp (event_name, "focus:", 6))
212 etype->type_cat = ETYPE_FOCUS;
214 else if (!g_ascii_strncasecmp (event_name, "object:", 7))
216 etype->type_cat = ETYPE_OBJECT;
218 else if (!g_ascii_strncasecmp (event_name, "window:", 7))
220 etype->type_cat = ETYPE_WINDOW;
224 etype->type_cat = ETYPE_TOOLKIT;
229 etype->major = split_string[1];
232 etype->minor = split_string[2];
235 etype->detail = split_string[3];
236 etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], split_string[3], NULL));
240 etype->detail = g_strdup ("");
241 etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], NULL));
246 etype->minor = g_strdup ("");
247 etype->hash = g_str_hash ( split_string[1]);
252 etype->major = g_strdup ("");
253 etype->minor = g_strdup ("");
254 etype->detail = g_strdup ("");
255 etype->hash = g_str_hash ("");
258 /* TODO: don't forget to free the strings from caller when done ! */
262 * deregisterApplication:
263 * @application: a reference to the @Application
264 * to be deregistered.
265 * return values: void
267 * De-register an application previously registered with the broker.
271 impl_accessibility_registry_deregister_application (PortableServer_Servant servant,
272 const Accessibility_Application application,
273 CORBA_Environment * ev)
275 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
276 GList *list = g_list_find_custom (registry->desktop->applications, &application, compare_corba_objects);
285 fprintf (stderr, "deregistering application %p\n", application);
287 registry->desktop->applications = g_list_delete_link (registry->desktop->applications, list);
289 fprintf (stderr, "there are now %d apps registered.\n", g_list_length (registry->desktop->applications));
290 for (i = 0; i < g_list_length (registry->desktop->applications); ++i) {
291 fprintf (stderr, "getting application %d\n", i);
292 fprintf (stderr, "object address %p\n",
293 g_list_nth_data (registry->desktop->applications, i));
298 fprintf (stderr, "could not deregister application\n");
302 * CORBA Accessibility::Registry::registerGlobalEventListener method implementation
305 impl_accessibility_registry_register_global_event_listener (
306 PortableServer_Servant servant,
307 Accessibility_EventListener listener,
308 const CORBA_char *event_name,
309 CORBA_Environment *ev)
311 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
312 SpiListenerStruct *ls = g_malloc (sizeof (SpiListenerStruct));
313 EventTypeStruct etype;
314 gboolean is_toolkit_specific = TRUE;
316 fprintf(stderr, "registering for events of type %s\n", event_name);
318 /* parse, check major event type and add listener accordingly */
319 parse_event_type (&etype, (char*) event_name);
320 ls->event_type_hash = etype.hash;
321 ls->event_type_cat = etype.type_cat;
323 switch (etype.type_cat)
326 case (ETYPE_OBJECT) :
327 case (ETYPE_PROPERTY) :
328 ls->listener = CORBA_Object_duplicate (listener, ev);
329 registry->object_listeners =
330 g_list_append (registry->object_listeners, ls);
332 case (ETYPE_WINDOW) :
333 /* Support for Window Manager Events is not yet implemented */
335 case (ETYPE_TOOLKIT) :
336 ls->listener = CORBA_Object_duplicate (listener, ev);
337 registry->toolkit_listeners =
338 g_list_append (registry->toolkit_listeners, ls);
339 register_with_toolkits (registry, &etype, ev);
347 * CORBA Accessibility::Registry::deregisterGlobalEventListenerAll method implementation
350 impl_accessibility_registry_deregister_global_event_listener_all (
351 PortableServer_Servant servant,
352 Accessibility_EventListener listener,
353 CORBA_Environment *ev)
355 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
356 SpiListenerStruct *ls = g_malloc (sizeof (SpiListenerStruct));
358 ls->listener = listener;
359 list = g_list_find_custom (registry->object_listeners, ls,
360 compare_listener_corbaref);
363 * TODO : de-register with toolkit if the last instance of a listener
364 * to a particular toolkit event type has been deregistered.
369 fprintf (stderr, "deregistering listener\n");
370 registry->object_listeners = g_list_delete_link (registry->object_listeners, list);
371 list = g_list_find_custom (registry->object_listeners, ls, compare_listener_corbaref);
373 list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
376 fprintf (stderr, "deregistering listener\n");
377 registry->toolkit_listeners = g_list_delete_link (registry->toolkit_listeners, list);
378 list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
383 * CORBA Accessibility::Registry::deregisterGlobalEventListener method implementation
386 impl_accessibility_registry_deregister_global_event_listener (
387 PortableServer_Servant servant,
388 Accessibility_EventListener listener,
389 const CORBA_char * event_name,
390 CORBA_Environment *ev)
392 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
393 SpiListenerStruct ls;
394 EventTypeStruct etype;
398 parse_event_type (&etype, (char *) event_name);
399 switch (etype.type_cat)
401 case (ETYPE_OBJECT) :
402 case (ETYPE_PROPERTY) :
404 listeners = ®istry->object_listeners;
406 case (ETYPE_WINDOW) :
407 /* Support for Window Manager Events is not yet implemented */
409 case (ETYPE_TOOLKIT) :
410 listeners = ®istry->toolkit_listeners;
416 ls.event_type_hash = etype.hash;
417 list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
421 fprintf (stderr, "deregistering listener\n");
422 *listeners = g_list_delete_link (*listeners, list);
423 list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
430 * return values: a short integer indicating the current number of
433 * Get the current number of desktops.
437 impl_accessibility_registry_get_desktop_count (PortableServer_Servant servant,
438 CORBA_Environment * ev)
440 /* TODO: implement support for multiple virtual desktops */
441 CORBA_short n_desktops;
442 n_desktops = (CORBA_short) 1;
448 * @n: the index of the requested @Desktop.
449 * return values: a reference to the requested @Desktop.
451 * Get the nth accessible desktop.
454 static Accessibility_Desktop
455 impl_accessibility_registry_get_desktop (PortableServer_Servant servant,
457 CORBA_Environment * ev)
459 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
461 /* TODO: implement support for multiple virtual desktops */
464 return (Accessibility_Desktop)
465 CORBA_Object_duplicate (BONOBO_OBJREF (registry->desktop), ev);
469 return (Accessibility_Desktop) CORBA_OBJECT_NIL;
475 * return values: a sequence containing references to
478 * Get a list of accessible desktops.
481 static Accessibility_DesktopSeq *
482 impl_accessibility_registry_get_desktop_list (PortableServer_Servant servant,
483 CORBA_Environment * ev)
485 /* TODO: implement support for multiple virtual desktops */
486 return (Accessibility_DesktopSeq *) NULL;
489 static Accessibility_DeviceEventController
490 impl_accessibility_registry_get_device_event_controller (PortableServer_Servant servant,
491 CORBA_Environment * ev)
493 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
494 if (!registry->device_event_controller)
495 registry->device_event_controller = spi_device_event_controller_new (registry);
497 return CORBA_Object_duplicate (BONOBO_OBJREF (registry->device_event_controller), ev);
501 impl_registry_notify_event (PortableServer_Servant servant,
502 const Accessibility_Event *e,
503 CORBA_Environment *ev)
505 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
506 EventTypeStruct etype;
508 parse_event_type (&etype, e->type);
510 switch (etype.type_cat)
512 case (ETYPE_OBJECT) :
513 case (ETYPE_PROPERTY) :
515 _registry_notify_listeners (registry->object_listeners, e, ev);
517 case (ETYPE_WINDOW) :
518 _registry_notify_listeners (registry->window_listeners, e, ev);
520 case (ETYPE_TOOLKIT) :
521 _registry_notify_listeners (registry->toolkit_listeners, e, ev);
523 case (ETYPE_KEYBOARD) :
527 /* Accessibility_Accessible_unref (e->source, ev);*/ /* This should be here! */
538 _registry_notify_listeners ( GList *listeners,
539 const Accessibility_Event *e,
540 CORBA_Environment *ev)
544 SpiListenerStruct *ls;
545 EventTypeStruct etype;
547 parse_event_type (&etype, e->type);
548 minor_hash = g_str_hash (g_strconcat (etype.major, etype.minor, NULL));
549 len = g_list_length (listeners);
551 for (n=0; n<len; ++n)
553 ls = (SpiListenerStruct *) g_list_nth_data (listeners, n);
554 #ifdef SPI_SPI_LISTENER_DEBUG
555 fprintf(stderr, "event hashes: %lx %lx %lx\n", ls->event_type_hash, etype.hash, minor_hash);
556 fprintf(stderr, "event name: %s\n", etype.event_name);
558 if ((ls->event_type_hash == etype.hash) || (ls->event_type_hash == minor_hash))
561 fprintf(stderr, "notifying listener #%d\n", n);
562 fprintf(stderr, "event source name %s\n", Accessibility_Accessible__get_name(e->source, ev));
564 e->source = CORBA_Object_duplicate (e->source, ev);
565 Accessibility_Accessible_ref ( e->source, ev);
566 Accessibility_EventListener_notifyEvent ((Accessibility_EventListener) ls->listener,
569 if (ev->_major != CORBA_NO_EXCEPTION) {
571 ("Accessibility app error: exception during event notification: %s\n"),
572 CORBA_exception_id(ev));
579 static gboolean _device_event_controller_hook (gpointer p)
581 SpiRegistry *registry = (SpiRegistry *)p;
582 SpiDeviceEventController *controller = registry->device_event_controller;
584 spi_device_event_controller_check_key_event (controller);
589 spi_registry_class_init (SpiRegistryClass *klass)
591 GObjectClass * object_class = (GObjectClass *) klass;
592 POA_Accessibility_Registry__epv *epv = &klass->epv;
594 spi_registry_parent_class = g_type_class_ref (SPI_LISTENER_TYPE);
596 object_class->finalize = spi_registry_object_finalize;
598 epv->registerApplication = impl_accessibility_registry_register_application;
599 epv->deregisterApplication = impl_accessibility_registry_deregister_application;
600 epv->registerGlobalEventListener = impl_accessibility_registry_register_global_event_listener;
601 epv->deregisterGlobalEventListener = impl_accessibility_registry_deregister_global_event_listener;
602 epv->deregisterGlobalEventListenerAll = impl_accessibility_registry_deregister_global_event_listener_all;
603 epv->getDeviceEventController = impl_accessibility_registry_get_device_event_controller;
604 epv->getDesktopCount = impl_accessibility_registry_get_desktop_count;
605 epv->getDesktop = impl_accessibility_registry_get_desktop;
606 epv->getDesktopList = impl_accessibility_registry_get_desktop_list;
608 ((SpiListenerClass *) klass)->epv.notifyEvent = impl_registry_notify_event;
612 spi_registry_init (SpiRegistry *registry)
614 registry->object_listeners = NULL;
615 registry->window_listeners = NULL;
616 registry->toolkit_listeners = NULL;
617 registry->applications = NULL;
618 registry->desktop = spi_desktop_new();
619 registry->device_event_controller = NULL;
620 registry->kbd_event_hook = _device_event_controller_hook;
624 spi_registry_get_type (void)
626 static GType type = 0;
629 static const GTypeInfo tinfo = {
630 sizeof (SpiRegistryClass),
631 (GBaseInitFunc) NULL,
632 (GBaseFinalizeFunc) NULL,
633 (GClassInitFunc) spi_registry_class_init,
634 (GClassFinalizeFunc) NULL,
635 NULL, /* class data */
636 sizeof (SpiRegistry),
638 (GInstanceInitFunc) spi_registry_init,
639 NULL /* value table */
642 * Here we use bonobo_type_unique instead of
643 * gtk_type_unique, this auto-generates a load of
644 * CORBA structures for us. All derived types must
645 * use bonobo_type_unique.
647 type = bonobo_type_unique (
649 POA_Accessibility_Registry__init,
651 G_STRUCT_OFFSET (SpiRegistryClass, epv),
660 spi_registry_new (void)
662 SpiRegistry *retval =
663 SPI_REGISTRY (g_object_new (spi_registry_get_type (), NULL));