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 LISTENER_TYPE
57 * A pointer to our parent object class
59 static ListenerClass *registry_parent_class;
72 EventTypeCategory type_cat;
80 Accessibility_EventListener listener;
81 guint event_type_hash;
82 EventTypeCategory event_type_cat;
85 /* static function prototypes */
86 static void _registry_notify_listeners ( GList *listeners,
87 const Accessibility_Event *e,
88 CORBA_Environment *ev);
90 static long _get_unique_id();
92 static gboolean _device_event_controller_hook (gpointer source);
95 * Implemented GObject::finalize
98 registry_object_finalize (GObject *object)
100 /* Registry *registry = REGISTRY (object); */
101 GObjectClass *object_class = G_OBJECT_GET_CLASS( object);
103 printf("registry_object_finalize called\n");
105 object_class->finalize (object);
109 * registerApplication:
110 * @application: a reference to the requesting @Application
111 * return values: void
113 * Register a new application with the accessibility broker.
117 impl_accessibility_registry_register_application (PortableServer_Servant servant,
118 const Accessibility_Application application,
119 CORBA_Environment * ev)
121 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
124 fprintf (stderr, "registering app %p\n", application);
126 registry->desktop->applications = g_list_append (registry->desktop->applications,
127 bonobo_object_dup_ref (application, ev));
129 /* TODO: create unique string here (with libuuid call ?) and hash ? */
130 Accessibility_Application__set_id (application, _get_unique_id(), ev);
133 * TODO: change the implementation below to a WM-aware one;
134 * e.g. don't add all apps to the Desktop
139 compare_corba_objects (gconstpointer p1, gconstpointer p2)
141 CORBA_Environment ev;
145 fprintf (stderr, "comparing %p to %p\n",
149 retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
154 register_with_toolkits (Registry *registry_bonobo_object, EventTypeStruct *etype, CORBA_Environment *ev)
159 Accessibility_Desktop desktop;
160 Accessibility_Application app;
161 Accessibility_Registry registry;
162 registry = BONOBO_OBJREF (registry_bonobo_object);
164 /* for each app in each desktop, call ...Application_registerToolkitEventListener */
166 n_desktops = Accessibility_Registry_getDesktopCount (registry, ev);
168 for (i=0; i<n_desktops; ++i)
170 desktop = Accessibility_Registry_getDesktop (registry, i, ev);
171 n_apps = Accessibility_Desktop__get_childCount (desktop, ev);
172 for (j=0; j<n_apps; ++j)
174 app = (Accessibility_Application) Accessibility_Desktop_getChildAtIndex (desktop,
177 Accessibility_Application_registerToolkitEventListener (app,
179 CORBA_string_dup (etype->event_name),
187 compare_listener_hash (gconstpointer p1, gconstpointer p2)
189 return (((ListenerStruct *)p2)->event_type_hash - ((ListenerStruct *)p1)->event_type_hash);
193 compare_listener_corbaref (gconstpointer p1, gconstpointer p2)
195 return compare_corba_objects (((ListenerStruct *)p2)->listener,
196 ((ListenerStruct *)p1)->listener);
200 parse_event_type (EventTypeStruct *etype, char *event_name)
203 gchar **split_string;
205 split_string = g_strsplit(event_name, ":", 4);
206 etype->event_name = g_strndup(event_name, 255);
208 if (!g_ascii_strncasecmp (event_name, "focus:", 6))
210 etype->type_cat = ETYPE_FOCUS;
212 else if (!g_ascii_strncasecmp (event_name, "object:", 7))
214 etype->type_cat = ETYPE_OBJECT;
216 else if (!g_ascii_strncasecmp (event_name, "window:", 7))
218 etype->type_cat = ETYPE_WINDOW;
222 etype->type_cat = ETYPE_TOOLKIT;
227 etype->major = split_string[1];
230 etype->minor = split_string[2];
233 etype->detail = split_string[3];
234 etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], split_string[3], NULL));
238 etype->detail = g_strdup ("");
239 etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], NULL));
244 etype->minor = g_strdup ("");
245 etype->hash = g_str_hash ( split_string[1]);
250 etype->major = g_strdup ("");
251 etype->minor = g_strdup ("");
252 etype->detail = g_strdup ("");
253 etype->hash = g_str_hash ("");
256 /* TODO: don't forget to free the strings from caller when done ! */
260 * deregisterApplication:
261 * @application: a reference to the @Application
262 * to be deregistered.
263 * return values: void
265 * De-register an application previously registered with the broker.
269 impl_accessibility_registry_deregister_application (PortableServer_Servant servant,
270 const Accessibility_Application application,
271 CORBA_Environment * ev)
273 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
274 GList *list = g_list_find_custom (registry->desktop->applications, &application, compare_corba_objects);
283 fprintf (stderr, "deregistering application %p\n", application);
285 registry->desktop->applications = g_list_delete_link (registry->desktop->applications, list);
287 fprintf (stderr, "there are now %d apps registered.\n", g_list_length (registry->desktop->applications));
288 for (i = 0; i < g_list_length (registry->desktop->applications); ++i) {
289 fprintf (stderr, "getting application %d\n", i);
290 fprintf (stderr, "object address %p\n",
291 g_list_nth_data (registry->desktop->applications, i));
296 fprintf (stderr, "could not deregister application\n");
300 * CORBA Accessibility::Registry::registerGlobalEventListener method implementation
303 impl_accessibility_registry_register_global_event_listener (
304 PortableServer_Servant servant,
305 Accessibility_EventListener listener,
306 const CORBA_char *event_name,
307 CORBA_Environment *ev)
309 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
310 ListenerStruct *ls = g_malloc (sizeof (ListenerStruct));
311 EventTypeStruct etype;
312 gboolean is_toolkit_specific = TRUE;
314 fprintf(stderr, "registering for events of type %s\n", event_name);
316 /* parse, check major event type and add listener accordingly */
317 parse_event_type (&etype, event_name);
318 ls->event_type_hash = etype.hash;
319 ls->event_type_cat = etype.type_cat;
321 switch (etype.type_cat)
324 case (ETYPE_OBJECT) :
325 case (ETYPE_PROPERTY) :
326 ls->listener = CORBA_Object_duplicate (listener, ev);
327 registry->object_listeners =
328 g_list_append (registry->object_listeners, ls);
330 case (ETYPE_WINDOW) :
331 /* Support for Window Manager Events is not yet implemented */
333 case (ETYPE_TOOLKIT) :
334 ls->listener = CORBA_Object_duplicate (listener, ev);
335 registry->toolkit_listeners =
336 g_list_append (registry->toolkit_listeners, ls);
337 register_with_toolkits (registry, &etype, ev);
345 * CORBA Accessibility::Registry::deregisterGlobalEventListenerAll method implementation
348 impl_accessibility_registry_deregister_global_event_listener_all (
349 PortableServer_Servant servant,
350 Accessibility_EventListener listener,
351 CORBA_Environment *ev)
353 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
354 ListenerStruct *ls = g_malloc (sizeof (ListenerStruct));
356 ls->listener = listener;
357 list = g_list_find_custom (registry->object_listeners, ls,
358 compare_listener_corbaref);
361 * TODO : de-register with toolkit if the last instance of a listener
362 * to a particular toolkit event type has been deregistered.
367 fprintf (stderr, "deregistering listener\n");
368 registry->object_listeners = g_list_delete_link (registry->object_listeners, list);
369 list = g_list_find_custom (registry->object_listeners, ls, compare_listener_corbaref);
371 list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
374 fprintf (stderr, "deregistering listener\n");
375 registry->toolkit_listeners = g_list_delete_link (registry->toolkit_listeners, list);
376 list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
381 * CORBA Accessibility::Registry::deregisterGlobalEventListener method implementation
384 impl_accessibility_registry_deregister_global_event_listener (
385 PortableServer_Servant servant,
386 Accessibility_EventListener listener,
387 const CORBA_char * event_name,
388 CORBA_Environment *ev)
390 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
392 EventTypeStruct etype;
396 parse_event_type (&etype, event_name);
397 switch (etype.type_cat)
399 case (ETYPE_OBJECT) :
400 case (ETYPE_PROPERTY) :
402 listeners = ®istry->object_listeners;
404 case (ETYPE_WINDOW) :
405 /* Support for Window Manager Events is not yet implemented */
407 case (ETYPE_TOOLKIT) :
408 listeners = ®istry->toolkit_listeners;
414 ls.event_type_hash = etype.hash;
415 list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
419 fprintf (stderr, "deregistering listener\n");
420 *listeners = g_list_delete_link (*listeners, list);
421 list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
428 * return values: a short integer indicating the current number of
431 * Get the current number of desktops.
435 impl_accessibility_registry_get_desktop_count (PortableServer_Servant servant,
436 CORBA_Environment * ev)
438 /* TODO: implement support for multiple virtual desktops */
439 CORBA_short n_desktops;
440 n_desktops = (CORBA_short) 1;
446 * @n: the index of the requested @Desktop.
447 * return values: a reference to the requested @Desktop.
449 * Get the nth accessible desktop.
452 static Accessibility_Desktop
453 impl_accessibility_registry_get_desktop (PortableServer_Servant servant,
455 CORBA_Environment * ev)
457 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
459 /* TODO: implement support for multiple virtual desktops */
462 return (Accessibility_Desktop)
463 CORBA_Object_duplicate (BONOBO_OBJREF (registry->desktop), ev);
467 return (Accessibility_Desktop) CORBA_OBJECT_NIL;
473 * return values: a sequence containing references to
476 * Get a list of accessible desktops.
479 static Accessibility_DesktopSeq *
480 impl_accessibility_registry_get_desktop_list (PortableServer_Servant servant,
481 CORBA_Environment * ev)
483 /* TODO: implement support for multiple virtual desktops */
484 return (Accessibility_DesktopSeq *) NULL;
487 static Accessibility_DeviceEventController
488 impl_accessibility_registry_get_device_event_controller (PortableServer_Servant servant,
489 CORBA_Environment * ev)
491 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
492 if (!registry->device_event_controller)
493 registry->device_event_controller = g_object_new (DEVICE_EVENT_CONTROLLER_TYPE, NULL);
494 return CORBA_Object_duplicate (BONOBO_OBJREF (registry->device_event_controller), ev);
498 impl_registry_notify_event (PortableServer_Servant servant,
499 const Accessibility_Event *e,
500 CORBA_Environment *ev)
502 Registry *registry = REGISTRY (bonobo_object_from_servant (servant));
503 EventTypeStruct etype;
505 parse_event_type (&etype, e->type);
507 switch (etype.type_cat)
509 case (ETYPE_OBJECT) :
510 case (ETYPE_PROPERTY) :
512 _registry_notify_listeners (registry->object_listeners, e, ev);
514 case (ETYPE_WINDOW) :
515 _registry_notify_listeners (registry->window_listeners, e, ev);
517 case (ETYPE_TOOLKIT) :
518 _registry_notify_listeners (registry->toolkit_listeners, e, ev);
523 /* Accessibility_Accessible_unref (e->source, ev);*/ /* This should be here! */
534 _registry_notify_listeners ( GList *listeners,
535 const Accessibility_Event *e,
536 CORBA_Environment *ev)
541 EventTypeStruct etype;
543 parse_event_type (&etype, e->type);
544 minor_hash = g_str_hash (g_strconcat (etype.major, etype.minor, NULL));
545 len = g_list_length (listeners);
547 for (n=0; n<len; ++n)
549 ls = (ListenerStruct *) g_list_nth_data (listeners, n);
550 #ifdef SPI_LISTENER_DEBUG
551 fprintf(stderr, "event hashes: %lx %lx %lx\n", ls->event_type_hash, etype.hash, minor_hash);
552 fprintf(stderr, "event name: %s\n", etype.event_name);
554 if ((ls->event_type_hash == etype.hash) || (ls->event_type_hash == minor_hash))
557 fprintf(stderr, "notifying listener #%d\n", n);
558 fprintf(stderr, "event source name %s\n", Accessibility_Accessible__get_name(e->source, ev));
560 e->source = CORBA_Object_duplicate (e->source, ev);
561 Accessibility_Accessible_ref ( e->source, ev);
562 Accessibility_EventListener_notifyEvent ((Accessibility_EventListener) ls->listener,
565 if (ev->_major != CORBA_NO_EXCEPTION) {
567 ("Accessibility app error: exception during event notification: %s\n"),
568 CORBA_exception_id(ev));
575 static gboolean _device_event_controller_hook (gpointer p)
577 Registry *registry = (Registry *)p;
578 DeviceEventController *controller = registry->device_event_controller;
580 device_event_controller_check_key_event (controller);
585 registry_class_init (RegistryClass *klass)
587 GObjectClass * object_class = (GObjectClass *) klass;
588 POA_Accessibility_Registry__epv *epv = &klass->epv;
590 registry_parent_class = g_type_class_ref (LISTENER_TYPE);
592 object_class->finalize = registry_object_finalize;
594 epv->registerApplication = impl_accessibility_registry_register_application;
595 epv->deregisterApplication = impl_accessibility_registry_deregister_application;
596 epv->registerGlobalEventListener = impl_accessibility_registry_register_global_event_listener;
597 epv->deregisterGlobalEventListener = impl_accessibility_registry_deregister_global_event_listener;
598 epv->deregisterGlobalEventListenerAll = impl_accessibility_registry_deregister_global_event_listener_all;
599 epv->getDeviceEventController = impl_accessibility_registry_get_device_event_controller;
600 epv->getDesktopCount = impl_accessibility_registry_get_desktop_count;
601 epv->getDesktop = impl_accessibility_registry_get_desktop;
602 epv->getDesktopList = impl_accessibility_registry_get_desktop_list;
604 ((ListenerClass *) klass)->epv.notifyEvent = impl_registry_notify_event;
608 registry_init (Registry *registry)
610 registry->object_listeners = NULL;
611 registry->window_listeners = NULL;
612 registry->toolkit_listeners = NULL;
613 registry->applications = NULL;
614 registry->desktop = desktop_new();
615 registry->device_event_controller = NULL;
616 registry->kbd_event_hook = _device_event_controller_hook;
620 registry_get_type (void)
622 static GType type = 0;
625 static const GTypeInfo tinfo = {
626 sizeof (RegistryClass),
627 (GBaseInitFunc) NULL,
628 (GBaseFinalizeFunc) NULL,
629 (GClassInitFunc) registry_class_init,
630 (GClassFinalizeFunc) NULL,
631 NULL, /* class data */
634 (GInstanceInitFunc) registry_init,
635 NULL /* value table */
638 * Here we use bonobo_type_unique instead of
639 * gtk_type_unique, this auto-generates a load of
640 * CORBA structures for us. All derived types must
641 * use bonobo_type_unique.
643 type = bonobo_type_unique (
645 POA_Accessibility_Registry__init,
647 G_STRUCT_OFFSET (RegistryClass, epv),
659 REGISTRY (g_object_new (registry_get_type (), NULL));