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 /* registry.c: the main accessibility service registry implementation */
25 #undef SPI_LISTENER_DEBUG
33 #include <bonobo/bonobo-exception.h>
34 #include "../libspi/spi-private.h"
37 /* Our parent GObject type */
38 #define PARENT_TYPE SPI_LISTENER_TYPE
40 /* A pointer to our parent object class */
41 static SpiListenerClass *spi_registry_parent_class;
56 EventTypeCategory type_cat;
57 GQuark major; /* from string segment[1] */
58 GQuark minor; /* from string segment[1]+segment[2] */
59 GQuark detail; /* from string segment[3] (not concatenated) */
63 Accessibility_EventListener listener;
64 GQuark event_type_quark;
65 EventTypeCategory event_type_cat;
70 spi_listener_struct_new (Accessibility_EventListener listener, CORBA_Environment *ev)
72 SpiListenerStruct *retval = g_malloc (sizeof (SpiListenerStruct));
73 retval->listener = bonobo_object_dup_ref (listener, ev);
79 spi_listener_struct_free (SpiListenerStruct *ls, CORBA_Environment *ev)
81 bonobo_object_release_unref (ls->listener, ev);
87 desktop_add_application (SpiDesktop *desktop,
88 guint index, gpointer data)
90 BonoboObject *registry = BONOBO_OBJECT (data);
91 Accessibility_Event e;
94 e.type = g_strdup ("object:children-changed:add");
95 e.source = BONOBO_OBJREF (desktop);
98 CORBA_exception_init (&ev);
99 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (registry),
101 CORBA_exception_free (&ev);
107 desktop_remove_application (SpiDesktop *desktop,
108 guint index, gpointer data)
110 BonoboObject *registry = BONOBO_OBJECT (data);
111 Accessibility_Event e;
112 CORBA_Environment ev;
114 e.type = g_strdup ("object:children-changed:remove");
115 e.source = BONOBO_OBJREF (desktop);
118 CORBA_exception_init (&ev);
119 Accessibility_Registry_notifyEvent (BONOBO_OBJREF (registry),
121 CORBA_exception_free (&ev);
126 spi_registry_object_finalize (GObject *object)
128 printf ("spi_registry_object_finalize called\n");
130 /* TODO: unref deviceeventcontroller, which disconnects key listener */
131 G_OBJECT_CLASS (spi_registry_parent_class)->finalize (object);
135 _get_unique_id (void)
143 * registerApplication:
144 * @application: a reference to the requesting @Application
145 * return values: void
147 * Register a new application with the accessibility broker.
151 impl_accessibility_registry_register_application (PortableServer_Servant servant,
152 const Accessibility_Application application,
153 CORBA_Environment * ev)
155 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
158 fprintf (stderr, "registering app %p\n", application);
160 spi_desktop_add_application (registry->desktop, application);
162 Accessibility_Application__set_id (application, _get_unique_id (), ev);
165 * TODO: change the implementation below to a WM-aware one;
166 * e.g. don't add all apps to the SpiDesktop
170 #ifdef USE_A_HASH_IN_FUTURE
172 compare_corba_objects (gconstpointer p1, gconstpointer p2)
174 CORBA_Environment ev;
178 fprintf (stderr, "comparing %p to %p\n",
182 retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
188 register_with_toolkits (SpiRegistry *spi_registry_bonobo_object, EventTypeStruct *etype, CORBA_Environment *ev)
193 Accessibility_Desktop desktop;
194 Accessibility_Application app;
195 Accessibility_Registry registry;
196 registry = BONOBO_OBJREF (spi_registry_bonobo_object);
198 /* for each app in each desktop, call ...Application_registerToolkitEventListener */
200 n_desktops = Accessibility_Registry_getDesktopCount (registry, ev);
202 for (i=0; i<n_desktops; ++i)
204 desktop = Accessibility_Registry_getDesktop (registry, i, ev);
205 n_apps = Accessibility_Desktop__get_childCount (desktop, ev);
206 for (j=0; j<n_apps; ++j)
208 app = (Accessibility_Application) Accessibility_Desktop_getChildAtIndex (desktop,
211 Accessibility_Application_registerToolkitEventListener (app,
213 CORBA_string_dup (etype->event_name),
219 #ifdef USE_A_HASH_IN_FUTURE
222 compare_listener_quarks (gconstpointer p1, gconstpointer p2)
224 return (((SpiListenerStruct *)p2)->event_type_quark !=
225 ((SpiListenerStruct *)p1)->event_type_quark);
229 compare_listener_corbaref (gconstpointer p1, gconstpointer p2)
231 return compare_corba_objects (((SpiListenerStruct *)p2)->listener,
232 ((SpiListenerStruct *)p1)->listener);
237 parse_event_type (EventTypeStruct *etype, const char *event_name)
239 gchar **split_string;
242 split_string = g_strsplit (event_name, ":", 4);
243 etype->event_name = g_strdup (event_name);
245 if (!g_ascii_strncasecmp (event_name, "focus:", 6))
247 etype->type_cat = ETYPE_FOCUS;
249 else if (!g_ascii_strncasecmp (event_name, "object:", 7))
251 etype->type_cat = ETYPE_OBJECT;
253 else if (!g_ascii_strncasecmp (event_name, "window:", 7))
255 etype->type_cat = ETYPE_WINDOW;
259 etype->type_cat = ETYPE_TOOLKIT;
264 etype->major = g_quark_from_string (split_string[1]);
267 etype->minor = g_quark_from_string (s = g_strconcat (split_string[1], split_string[2], NULL));
271 etype->detail = g_quark_from_string (split_string[3]);
275 etype->detail = g_quark_from_static_string ("");
280 etype->minor = etype->major;
281 etype->detail = g_quark_from_static_string (""); //etype->major;
286 etype->major = g_quark_from_static_string ("");
287 etype->minor = etype->major;
288 etype->detail = etype->major;
291 g_strfreev (split_string);
295 * deregisterApplication:
296 * @application: a reference to the @Application
297 * to be deregistered.
298 * return values: void
300 * De-register an application previously registered with the broker.
304 impl_accessibility_registry_deregister_application (PortableServer_Servant servant,
305 const Accessibility_Application application,
306 CORBA_Environment * ev)
308 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
310 spi_desktop_remove_application (registry->desktop, application);
313 fprintf (stderr, "de-registered app %p\n", application);
318 get_listener_list (SpiRegistry *registry,
319 EventTypeCategory cat)
328 ret = ®istry->object_listeners;
331 ret = ®istry->window_listeners;
334 ret = ®istry->toolkit_listeners;
345 * CORBA Accessibility::Registry::registerGlobalEventListener method implementation
348 impl_accessibility_registry_register_global_event_listener (
349 PortableServer_Servant servant,
350 Accessibility_EventListener listener,
351 const CORBA_char *event_name,
352 CORBA_Environment *ev)
354 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
355 SpiListenerStruct *ls = spi_listener_struct_new (listener, ev);
356 EventTypeStruct etype;
360 fprintf (stderr, "registering");
361 fprintf (stderr, "registering for events of type %s\n", event_name);
364 /* parse, check major event type and add listener accordingly */
365 parse_event_type (&etype, event_name);
366 ls->event_type_quark = etype.major;
367 ls->event_type_cat = etype.type_cat;
369 list = get_listener_list (registry, etype.type_cat);
373 *list = g_list_prepend (*list, ls);
375 if (etype.type_cat == ETYPE_TOOLKIT)
377 register_with_toolkits (registry, &etype, ev);
382 spi_listener_struct_free (ls, ev);
386 static SpiReEntrantContinue
387 remove_listener_cb (GList * const *list, gpointer user_data)
389 SpiListenerStruct *ls = (SpiListenerStruct *) (*list)->data;
390 CORBA_Environment ev;
391 Accessibility_EventListener listener = user_data;
393 CORBA_exception_init (&ev);
395 if (CORBA_Object_is_equivalent (ls->listener, listener, &ev))
397 spi_re_entrant_list_delete_link (list);
398 spi_listener_struct_free (ls, &ev);
401 CORBA_exception_free (&ev);
403 return SPI_RE_ENTRANT_CONTINUE;
407 * CORBA Accessibility::Registry::deregisterGlobalEventListenerAll method implementation
410 impl_accessibility_registry_deregister_global_event_listener_all (
411 PortableServer_Servant servant,
412 Accessibility_EventListener listener,
413 CORBA_Environment *ev)
417 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
419 lists[0] = ®istry->object_listeners;
420 lists[1] = ®istry->window_listeners;
421 lists[2] = ®istry->toolkit_listeners;
423 for (i = 0; i < sizeof (lists) / sizeof (lists[0]); i++)
425 spi_re_entrant_list_foreach (lists [i], remove_listener_cb, listener);
431 * CORBA Accessibility::Registry::deregisterGlobalEventListener method implementation
434 impl_accessibility_registry_deregister_global_event_listener (
435 PortableServer_Servant servant,
436 Accessibility_EventListener listener,
437 const CORBA_char *event_name,
438 CORBA_Environment *ev)
440 SpiRegistry *registry;
441 EventTypeStruct etype;
443 registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
445 parse_event_type (&etype, (char *) event_name);
447 spi_re_entrant_list_foreach (get_listener_list (registry, etype.type_cat),
448 remove_listener_cb, listener);
454 * return values: a short integer indicating the current number of
457 * Get the current number of desktops.
461 impl_accessibility_registry_get_desktop_count (PortableServer_Servant servant,
462 CORBA_Environment * ev)
464 /* TODO: implement support for multiple virtual desktops */
465 CORBA_short n_desktops;
466 n_desktops = (CORBA_short) 1;
473 * @n: the index of the requested @Desktop.
474 * return values: a reference to the requested @Desktop.
476 * Get the nth accessible desktop.
479 static Accessibility_Desktop
480 impl_accessibility_registry_get_desktop (PortableServer_Servant servant,
482 CORBA_Environment * ev)
484 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
486 /* TODO: implement support for multiple virtual desktops */
489 return (Accessibility_Desktop)
490 bonobo_object_dup_ref (BONOBO_OBJREF (registry->desktop), ev);
494 return (Accessibility_Desktop) CORBA_OBJECT_NIL;
501 * return values: a sequence containing references to
504 * Get a list of accessible desktops.
507 static Accessibility_DesktopSeq *
508 impl_accessibility_registry_get_desktop_list (PortableServer_Servant servant,
509 CORBA_Environment * ev)
511 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
512 Accessibility_DesktopSeq *desktops;
514 desktops = Accessibility_DesktopSeq__alloc ();
515 desktops->_length = desktops->_maximum = 1;
516 desktops->_buffer = Accessibility_DesktopSeq_allocbuf (desktops->_length);
517 desktops->_buffer [0] = bonobo_object_dup_ref (BONOBO_OBJREF (registry->desktop), ev);
523 static Accessibility_DeviceEventController
524 impl_accessibility_registry_get_device_event_controller (PortableServer_Servant servant,
525 CORBA_Environment *ev)
527 SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
529 if (!registry->de_controller)
531 registry->de_controller = spi_device_event_controller_new (registry);
534 return bonobo_object_dup_ref (BONOBO_OBJREF (registry->de_controller), ev);
538 CORBA_Environment *ev;
539 Bonobo_Unknown source;
540 EventTypeStruct etype;
541 Accessibility_Event e_out;
544 static SpiReEntrantContinue
545 notify_listeners_cb (GList * const *list, gpointer user_data)
547 SpiListenerStruct *ls;
548 NotifyContext *ctx = user_data;
555 #ifdef SPI_LISTENER_DEBUG
556 fprintf (stderr, "event quarks: %lx %lx %lx\n", ls->event_type_quark, ctx->etype.major, ctx->etype.minor);
557 fprintf (stderr, "event name: %s\n", ctx->etype.event_name);
560 if ((ls->event_type_quark == ctx->etype.major) ||
561 (ls->event_type_quark == ctx->etype.minor))
564 fprintf (stderr, "notifying listener %d\n", 0);
565 /* g_list_index (list, l->data)); */
566 s = Accessibility_Accessible__get_name (ctx->source, ctx->ev);
567 fprintf (stderr, "event source name %s\n", s);
571 ctx->e_out.source = bonobo_object_dup_ref (ctx->source, ctx->ev);
572 if (BONOBO_EX (ctx->ev))
574 return SPI_RE_ENTRANT_CONTINUE;;
577 if ((*list) && (*list)->data == ls)
579 Accessibility_EventListener_notifyEvent (
580 (Accessibility_EventListener) ls->listener, &ctx->e_out, ctx->ev);
581 if (ctx->ev->_major != CORBA_NO_EXCEPTION)
583 g_warning ("Accessibility app error: exception during "
584 "event notification: %s\n",
585 CORBA_exception_id (ctx->ev));
588 else /* dup re-entered */
590 bonobo_object_release_unref (ctx->e_out.source, ctx->ev);
594 return SPI_RE_ENTRANT_CONTINUE;
598 impl_registry_notify_event (PortableServer_Servant servant,
599 const Accessibility_Event *e,
600 CORBA_Environment *ev)
602 SpiRegistry *registry;
606 registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
608 parse_event_type (&ctx.etype, e->type);
610 list = get_listener_list (registry, ctx.etype.type_cat);
616 ctx.source = e->source;
617 parse_event_type (&ctx.etype, e->type);
619 spi_re_entrant_list_foreach (list, notify_listeners_cb, &ctx);
622 if (e->source != CORBA_OBJECT_NIL)
624 Accessibility_Accessible_unref (e->source, ev);
630 spi_registry_class_init (SpiRegistryClass *klass)
632 GObjectClass * object_class = (GObjectClass *) klass;
633 POA_Accessibility_Registry__epv *epv = &klass->epv;
635 spi_registry_parent_class = g_type_class_ref (SPI_LISTENER_TYPE);
637 object_class->finalize = spi_registry_object_finalize;
639 klass->parent_class.epv.notifyEvent = impl_registry_notify_event;
641 epv->registerApplication = impl_accessibility_registry_register_application;
642 epv->deregisterApplication = impl_accessibility_registry_deregister_application;
643 epv->registerGlobalEventListener = impl_accessibility_registry_register_global_event_listener;
644 epv->deregisterGlobalEventListener = impl_accessibility_registry_deregister_global_event_listener;
645 epv->deregisterGlobalEventListenerAll = impl_accessibility_registry_deregister_global_event_listener_all;
646 epv->getDeviceEventController = impl_accessibility_registry_get_device_event_controller;
647 epv->getDesktopCount = impl_accessibility_registry_get_desktop_count;
648 epv->getDesktop = impl_accessibility_registry_get_desktop;
649 epv->getDesktopList = impl_accessibility_registry_get_desktop_list;
653 spi_registry_init (SpiRegistry *registry)
655 registry->object_listeners = NULL;
656 registry->window_listeners = NULL;
657 registry->toolkit_listeners = NULL;
658 registry->desktop = spi_desktop_new ();
659 /* Register callback notification for application addition and removal */
660 g_signal_connect (G_OBJECT (registry->desktop),
662 G_CALLBACK (desktop_add_application),
665 g_signal_connect (G_OBJECT (registry->desktop),
666 "application_removed",
667 G_CALLBACK (desktop_remove_application),
670 registry->de_controller = NULL;
673 BONOBO_TYPE_FUNC_FULL (SpiRegistry,
674 Accessibility_Registry,
679 spi_registry_new (void)
681 SpiRegistry *retval = g_object_new (SPI_REGISTRY_TYPE, NULL);
682 bonobo_object_set_immortal (BONOBO_OBJECT (retval), TRUE);