registryd/registry.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 /* registry.c: the main accessibility service registry implementation */
  24
  25 #include <config.h>
  26 #ifdef SPI_DEBUG
  27 #  include <stdio.h>
  28 #endif
  29
  30 /*
  31  * We'd like to replace the dependance on X-isms with a wrapper layer,
  32  * to the extent that it can't be done with pure GDK.
  33  * Anyone want to help?
  34  */
  35 #include <X11/Xlib.h>
  36 #include <gdk/gdk.h>
  37 #include <gdk/gdkx.h>
  38
  39 #include <libspi/registry.h>
  40
  41 /* Our parent GObject type  */
  42 #define PARENT_TYPE SPI_LISTENER_TYPE
  43
  44 /* A pointer to our parent object class */
  45 static SpiListenerClass *spi_registry_parent_class;
  46
  47 typedef enum {
  48   ETYPE_FOCUS,
  49   ETYPE_OBJECT,
  50   ETYPE_PROPERTY,
  51   ETYPE_WINDOW,
  52   ETYPE_TOOLKIT,
  53   ETYPE_KEYBOARD,
  54
  55   ETYPE_LAST_DEFINED
  56 } EventTypeCategory;
  57
  58 typedef struct {
  59   char *event_name;
  60   EventTypeCategory type_cat;
  61   char * major;
  62   char * minor;
  63   char * detail;
  64   guint hash;
  65 } EventTypeStruct;
  66
  67 typedef struct {
  68   Accessibility_EventListener listener;
  69   guint event_type_hash;
  70   EventTypeCategory event_type_cat;
  71 } SpiListenerStruct;
  72
  73 /* static function prototypes */
  74 static void _registry_notify_listeners (GList *listeners,
  75                                         const Accessibility_Event *e,
  76                                         CORBA_Environment *ev);
  77
  78 static long _get_unique_id();
  79
  80 static gboolean _device_event_controller_hook (gpointer source);
  81
  82 SpiListenerStruct *
  83 spi_listener_struct_new (Accessibility_EventListener *listener, CORBA_Environment *ev)
  84 {
  85   SpiListenerStruct *retval = g_malloc (sizeof (SpiListenerStruct));
  86   retval->listener = bonobo_object_dup_ref (listener, ev);
  87   return retval;
  88 }
  89
  90 void
  91 spi_listener_struct_free (SpiListenerStruct *ls, CORBA_Environment *ev)
  92 {
  93   /* TODO: sanity check for ls */
  94   Accessibility_EventListener_unref (ls->listener, ev);
  95   g_free (ls);
  96 }
  97
  98 /* GObject::finalize */
  99 static void
 100 spi_registry_object_finalize (GObject *object)
 101 {
 102         SpiRegistry *registry = SPI_REGISTRY (object);
 103
 104         printf("spi_registry_object_finalize called\n");
 105         /* TODO: unref deviceeventcontroller, which disconnects key listener */
 106         G_OBJECT_CLASS (spi_registry_parent_class)->finalize (object);
 107 }
 108
 109 /**
 110  * registerApplication:
 111  * @application: a reference to the requesting @Application
 112  * return values: void
 113  *
 114  * Register a new application with the accessibility broker.
 115  *
 116  **/
 117 static void
 118 impl_accessibility_registry_register_application (PortableServer_Servant servant,
 119                                                   const Accessibility_Application application,
 120                                                   CORBA_Environment * ev)
 121 {
 122   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 123
 124 #ifdef SPI_DEBUG
 125   fprintf (stderr, "registering app %p\n", application);
 126 #endif
 127   registry->desktop->applications = g_list_append (registry->desktop->applications,
 128                                                    bonobo_object_dup_ref (application, ev));
 129
 130   /* TODO: create unique string here (with libuuid call ?) and hash ? */
 131   Accessibility_Application__set_id (application, _get_unique_id(), ev);
 132
 133   /*
 134    * TODO: change the implementation below to a WM-aware one;
 135    * e.g. don't add all apps to the SpiDesktop
 136    */
 137 }
 138
 139 static gint
 140 compare_corba_objects (gconstpointer p1, gconstpointer p2)
 141 {
 142   CORBA_Environment ev;
 143   gint retval;
 144
 145 #ifdef SPI_DEBUG
 146   fprintf (stderr, "comparing %p to %p\n",
 147            p1, p2);
 148 #endif
 149
 150   retval = !CORBA_Object_is_equivalent ((CORBA_Object) p1, (CORBA_Object) p2, &ev);
 151   return retval;
 152 }
 153
 154 static void
 155 register_with_toolkits (SpiRegistry *spi_registry_bonobo_object, EventTypeStruct *etype, CORBA_Environment *ev)
 156 {
 157   gint n_desktops;
 158   gint n_apps;
 159   gint i, j;
 160   Accessibility_Desktop desktop;
 161   Accessibility_Application app;
 162   Accessibility_Registry registry;
 163   registry  = BONOBO_OBJREF (spi_registry_bonobo_object);
 164
 165   /* for each app in each desktop, call ...Application_registerToolkitEventListener */
 166
 167   n_desktops = Accessibility_Registry_getDesktopCount (registry, ev);
 168
 169   for (i=0; i<n_desktops; ++i)
 170     {
 171       desktop = Accessibility_Registry_getDesktop (registry, i, ev);
 172       n_apps = Accessibility_Desktop__get_childCount (desktop, ev);
 173       for (j=0; j<n_apps; ++j)
 174         {
 175           app = (Accessibility_Application) Accessibility_Desktop_getChildAtIndex (desktop,
 176                                                                                    j,
 177                                                                                    ev);
 178           Accessibility_Application_registerToolkitEventListener (app,
 179                                                                   registry,
 180                                                                   CORBA_string_dup (etype->event_name),
 181
 182                                                                   ev);
 183         }
 184     }
 185 }
 186
 187 static gint
 188 compare_listener_hash (gconstpointer p1, gconstpointer p2)
 189 {
 190   return (((SpiListenerStruct *)p2)->event_type_hash - ((SpiListenerStruct *)p1)->event_type_hash);
 191 }
 192
 193 static gint
 194 compare_listener_corbaref (gconstpointer p1, gconstpointer p2)
 195 {
 196   return compare_corba_objects (((SpiListenerStruct *)p2)->listener,
 197                                 ((SpiListenerStruct *)p1)->listener);
 198 }
 199
 200 static void
 201 parse_event_type (EventTypeStruct *etype, char *event_name)
 202 {
 203   gchar **split_string;
 204
 205   split_string = g_strsplit(event_name, ":", 4);
 206   etype->event_name = g_strndup(event_name, 255);
 207
 208   if (!g_ascii_strncasecmp (event_name, "focus:", 6))
 209     {
 210       etype->type_cat = ETYPE_FOCUS;
 211     }
 212   else if (!g_ascii_strncasecmp (event_name, "object:", 7))
 213     {
 214       etype->type_cat = ETYPE_OBJECT;
 215     }
 216   else if (!g_ascii_strncasecmp (event_name, "window:", 7))
 217     {
 218       etype->type_cat = ETYPE_WINDOW;
 219     }
 220   else
 221     {
 222       etype->type_cat = ETYPE_TOOLKIT;
 223     }
 224
 225   if (split_string[1])
 226     {
 227       etype->major = split_string[1];
 228       if (split_string[2])
 229         {
 230           etype->minor = split_string[2];
 231           if (split_string[3])
 232             {
 233               etype->detail = split_string[3];
 234               etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], split_string[3], NULL));
 235             }
 236           else
 237             {
 238               etype->detail = g_strdup ("");
 239               etype->hash = g_str_hash ( g_strconcat (split_string[1], split_string[2], NULL));
 240             }
 241         }
 242       else
 243         {
 244           etype->minor = g_strdup ("");
 245           etype->hash = g_str_hash ( split_string[1]);
 246         }
 247     }
 248   else
 249     {
 250       etype->major = g_strdup ("");
 251       etype->minor = g_strdup ("");
 252       etype->detail = g_strdup ("");
 253       etype->hash = g_str_hash ("");
 254     }
 255
 256   /* TODO: don't forget to free the strings from caller when done ! */
 257 }
 258
 259 /**
 260  * deregisterApplication:
 261  * @application: a reference to the @Application
 262  * to be deregistered.
 263  * return values: void
 264  *
 265  * De-register an application previously registered with the broker.
 266  *
 267  **/
 268 static void
 269 impl_accessibility_registry_deregister_application (PortableServer_Servant servant,
 270                                                     const Accessibility_Application application,
 271                                                     CORBA_Environment * ev)
 272 {
 273   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 274   GList *list = g_list_find_custom (registry->desktop->applications, application, compare_corba_objects);
 275
 276 #ifdef SPI_DEBUG
 277   gint i;
 278 #endif
 279
 280   if (list)
 281     {
 282 #ifdef SPI_DEBUG
 283       fprintf (stderr, "deregistering application %p\n", application);
 284 #endif
 285       registry->desktop->applications = g_list_delete_link (registry->desktop->applications, list);
 286 #ifdef SPI_DEBUG
 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         {
 290           fprintf (stderr, "getting application %d\n", i);
 291           fprintf (stderr, "object address %p\n",
 292                        g_list_nth_data (registry->desktop->applications, i));
 293         }
 294 #endif
 295     }
 296   else
 297     {
 298       fprintf (stderr, "could not deregister application %p\n", application);
 299     }
 300 }
 301
 302 /*
 303  * CORBA Accessibility::Registry::registerGlobalEventListener method implementation
 304  */
 305 static void
 306 impl_accessibility_registry_register_global_event_listener (
 307                                              PortableServer_Servant  servant,
 308                                              Accessibility_EventListener listener,
 309                                              const CORBA_char *event_name,
 310                                              CORBA_Environment      *ev)
 311 {
 312   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 313   SpiListenerStruct *ls = spi_listener_struct_new (listener, ev);
 314   EventTypeStruct etype;
 315
 316   fprintf(stderr, "registering for events of type %s\n", event_name);
 317
 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;
 322
 323   switch (etype.type_cat)
 324     {
 325     case (ETYPE_FOCUS) :
 326     case (ETYPE_OBJECT) :
 327     case (ETYPE_PROPERTY) :
 328       registry->object_listeners =
 329         g_list_append (registry->object_listeners, ls);
 330       break;
 331     case (ETYPE_WINDOW) :
 332       /* Support for Window Manager Events is not yet implemented */
 333       spi_listener_struct_free (ls, ev);
 334       break;
 335     case (ETYPE_TOOLKIT) :
 336       registry->toolkit_listeners =
 337         g_list_append (registry->toolkit_listeners, ls);
 338       register_with_toolkits (registry, &etype, ev);
 339       break;
 340     default:
 341       spi_listener_struct_free (ls, ev);
 342       break;
 343     }
 344 }
 345
 346 /*
 347  * CORBA Accessibility::Registry::deregisterGlobalEventListenerAll method implementation
 348  */
 349 static void
 350 impl_accessibility_registry_deregister_global_event_listener_all (
 351                                                     PortableServer_Servant  servant,
 352                                                     Accessibility_EventListener listener,
 353                                                     CORBA_Environment      *ev)
 354 {
 355   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 356   SpiListenerStruct *spi_listener_struct, *ls = spi_listener_struct_new (listener, ev);
 357   GList *list;
 358   list = g_list_find_custom (registry->object_listeners, ls,
 359                              compare_listener_corbaref);
 360
 361   /*
 362    * TODO : de-register with toolkit if the last instance of a listener
 363    *        to a particular toolkit event type has been deregistered.
 364    */
 365
 366   while (list)
 367     {
 368       spi_listener_struct_free ((SpiListenerStruct *) list->data, ev);
 369       registry->object_listeners = g_list_delete_link (registry->object_listeners, list);
 370       list = g_list_find_custom (registry->object_listeners, ls, compare_listener_corbaref);
 371     }
 372   list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
 373   while (list)
 374     {
 375       spi_listener_struct_free ((SpiListenerStruct *) list->data, ev);
 376       registry->toolkit_listeners = g_list_delete_link (registry->toolkit_listeners, list);
 377       list = g_list_find_custom (registry->toolkit_listeners, ls, compare_listener_corbaref);
 378     }
 379   spi_listener_struct_free (ls, ev);
 380 }
 381
 382 /*
 383  * CORBA Accessibility::Registry::deregisterGlobalEventListener method implementation
 384  */
 385 static void
 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)
 391 {
 392   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 393   SpiListenerStruct ls, *spi_listener_struct;
 394   EventTypeStruct etype;
 395   GList *list;
 396   GList **listeners;
 397
 398   parse_event_type (&etype, (char *) event_name);
 399   switch (etype.type_cat)
 400     {
 401     case (ETYPE_OBJECT) :
 402     case (ETYPE_PROPERTY) :
 403     case (ETYPE_FOCUS) :
 404       listeners = &registry->object_listeners;
 405       break;
 406     case (ETYPE_WINDOW) :
 407       /* Support for Window Manager Events is not yet implemented */
 408       break;
 409     case (ETYPE_TOOLKIT) :
 410       listeners = &registry->toolkit_listeners;
 411       break;
 412     default:
 413       listeners = NULL;
 414       break;
 415     }
 416
 417   if (!listeners)
 418           return;
 419
 420   ls.event_type_hash = etype.hash;
 421   list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
 422
 423   while (list)
 424     {
 425       spi_listener_struct_free ((SpiListenerStruct *) list->data, ev);
 426       *listeners = g_list_delete_link (*listeners, list);
 427       list = g_list_find_custom (*listeners, &ls, compare_listener_hash);
 428     }
 429 }
 430
 431
 432 /**
 433  * getDesktopCount:
 434  * return values: a short integer indicating the current number of
 435  * @Desktops.
 436  *
 437  * Get the current number of desktops.
 438  *
 439  **/
 440 static short
 441 impl_accessibility_registry_get_desktop_count (PortableServer_Servant servant,
 442                                                CORBA_Environment * ev)
 443 {
 444   /* TODO: implement support for multiple virtual desktops */
 445   CORBA_short n_desktops;
 446   n_desktops = (CORBA_short) 1;
 447   return n_desktops;
 448 }
 449
 450 /**
 451  * getDesktop:
 452  * @n: the index of the requested @Desktop.
 453  * return values: a reference to the requested @Desktop.
 454  *
 455  * Get the nth accessible desktop.
 456  *
 457  **/
 458 static Accessibility_Desktop
 459 impl_accessibility_registry_get_desktop (PortableServer_Servant servant,
 460                                          const CORBA_short n,
 461                                          CORBA_Environment * ev)
 462 {
 463   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 464
 465   /* TODO: implement support for multiple virtual desktops */
 466   if (n == 0)
 467     {
 468       return (Accessibility_Desktop)
 469         bonobo_object_dup_ref (BONOBO_OBJREF (registry->desktop), ev);
 470     }
 471   else
 472     {
 473       return (Accessibility_Desktop) CORBA_OBJECT_NIL;
 474     }
 475 }
 476
 477 /**
 478  * getDesktopList:
 479  * return values: a sequence containing references to
 480  * the @Desktops.
 481  *
 482  * Get a list of accessible desktops.
 483  *
 484  **/
 485 static Accessibility_DesktopSeq *
 486 impl_accessibility_registry_get_desktop_list (PortableServer_Servant servant,
 487                                               CORBA_Environment * ev)
 488 {
 489   /* TODO: implement support for multiple virtual desktops */
 490   return (Accessibility_DesktopSeq *) NULL;
 491 }
 492
 493 static Accessibility_DeviceEventController
 494 impl_accessibility_registry_get_device_event_controller (PortableServer_Servant servant,
 495                                                          CORBA_Environment * ev)
 496 {
 497   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 498   if (!registry->device_event_controller)
 499     registry->device_event_controller = spi_device_event_controller_new (registry);
 500
 501   return bonobo_object_dup_ref (BONOBO_OBJREF (registry->device_event_controller), ev);
 502 }
 503
 504 static void
 505 impl_registry_notify_event (PortableServer_Servant servant,
 506                             const Accessibility_Event *e,
 507                             CORBA_Environment *ev)
 508 {
 509   SpiRegistry *registry = SPI_REGISTRY (bonobo_object_from_servant (servant));
 510   EventTypeStruct etype;
 511
 512   parse_event_type (&etype, e->type);
 513
 514   switch (etype.type_cat)
 515     {
 516     case (ETYPE_OBJECT) :
 517     case (ETYPE_PROPERTY) :
 518     case (ETYPE_FOCUS) :
 519       _registry_notify_listeners (registry->object_listeners, e, ev);
 520       break;
 521     case (ETYPE_WINDOW) :
 522       _registry_notify_listeners (registry->window_listeners, e, ev);
 523       break;
 524     case (ETYPE_TOOLKIT) :
 525       _registry_notify_listeners (registry->toolkit_listeners, e, ev);
 526       break;
 527     case (ETYPE_KEYBOARD) :
 528     default:
 529       break;
 530     }
 531   /* Accessibility_Accessible_unref (e->source, ev);*/ /* This should be here! */
 532 }
 533
 534 static long
 535 _get_unique_id ()
 536 {
 537   static long id = 0;
 538   return ++id;
 539 }
 540
 541 #define SPI_DEBUG
 542
 543 static void
 544 _registry_notify_listeners (GList *listeners,
 545                             const Accessibility_Event *e_in,
 546                             CORBA_Environment *ev)
 547 {
 548   int n;
 549   int len;
 550   SpiListenerStruct *ls;
 551   EventTypeStruct etype;
 552   Accessibility_Event *e_out;
 553   guint minor_hash;
 554   parse_event_type (&etype, e_in->type);
 555   minor_hash = g_str_hash (g_strconcat (etype.major, etype.minor, NULL));
 556   len = g_list_length (listeners);
 557
 558   for (n=0; n<len; ++n)
 559     {
 560       ls =  (SpiListenerStruct *) g_list_nth_data (listeners, n);
 561 #ifdef SPI_SPI_LISTENER_DEBUG
 562       fprintf(stderr, "event hashes: %lx %lx %lx\n", ls->event_type_hash, etype.hash, minor_hash);
 563       fprintf(stderr, "event name: %s\n", etype.event_name);
 564 #endif
 565       if ((ls->event_type_hash == etype.hash) || (ls->event_type_hash == minor_hash))
 566         {
 567 #ifdef SPI_DEBUG
 568           fprintf(stderr, "notifying listener #%d\n", n);
 569           fprintf(stderr, "event source name %s\n", Accessibility_Accessible__get_name(e_in->source, ev));
 570 #endif
 571           e_out = ORBit_copy_value (e_in, TC_Accessibility_Event);
 572           e_out->source = bonobo_object_dup_ref (e_in->source, ev);
 573           Accessibility_EventListener_notifyEvent ((Accessibility_EventListener) ls->listener,
 574                                                    e_out,
 575                                                    ev);
 576           /* is it safe to free e_out now ? notifyEvent is a oneway... */
 577           CORBA_free (e_out);
 578           if (ev->_major != CORBA_NO_EXCEPTION) {
 579                 fprintf(stderr,
 580                 ("Accessibility app error: exception during event notification: %s\n"),
 581                         CORBA_exception_id(ev));
 582                 exit(-1);
 583           }
 584         }
 585     }
 586 }
 587
 588 static gboolean
 589 _device_event_controller_hook (gpointer p)
 590 {
 591     SpiRegistry *registry = (SpiRegistry *)p;
 592     SpiDeviceEventController *controller = registry->device_event_controller;
 593     if (controller)
 594         spi_device_event_controller_check_key_event (controller);
 595     return TRUE;
 596 }
 597
 598 static void
 599 spi_registry_class_init (SpiRegistryClass *klass)
 600 {
 601         GObjectClass * object_class = (GObjectClass *) klass;
 602         POA_Accessibility_Registry__epv *epv = &klass->epv;
 603
 604         spi_registry_parent_class = g_type_class_ref (SPI_LISTENER_TYPE);
 605
 606         object_class->finalize = spi_registry_object_finalize;
 607
 608         epv->registerApplication = impl_accessibility_registry_register_application;
 609         epv->deregisterApplication = impl_accessibility_registry_deregister_application;
 610         epv->registerGlobalEventListener = impl_accessibility_registry_register_global_event_listener;
 611         epv->deregisterGlobalEventListener = impl_accessibility_registry_deregister_global_event_listener;
 612         epv->deregisterGlobalEventListenerAll = impl_accessibility_registry_deregister_global_event_listener_all;
 613         epv->getDeviceEventController = impl_accessibility_registry_get_device_event_controller;
 614         epv->getDesktopCount = impl_accessibility_registry_get_desktop_count;
 615         epv->getDesktop = impl_accessibility_registry_get_desktop;
 616         epv->getDesktopList = impl_accessibility_registry_get_desktop_list;
 617
 618         ((SpiListenerClass *) klass)->epv.notifyEvent = impl_registry_notify_event;
 619 }
 620
 621 static void
 622 spi_registry_init (SpiRegistry *registry)
 623 {
 624   registry->object_listeners = NULL;
 625   registry->window_listeners = NULL;
 626   registry->toolkit_listeners = NULL;
 627   registry->applications = NULL;
 628   registry->desktop = spi_desktop_new();
 629   registry->device_event_controller = NULL;
 630   registry->kbd_event_hook = _device_event_controller_hook;
 631 }
 632
 633 BONOBO_TYPE_FUNC_FULL (SpiRegistry,
 634                        Accessibility_Registry,
 635                        PARENT_TYPE,
 636                        spi_registry);
 637
 638 SpiRegistry *
 639 spi_registry_new (void)
 640 {
 641     SpiRegistry *retval = g_object_new (SPI_REGISTRY_TYPE, NULL);
 642     return retval;
 643 }