cspi/spi-main.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /*
  25  *
  26  * Basic SPI initialization and event loop function prototypes
  27  *
  28  */
  29
  30 #include <stdio.h>
  31 #include <string.h>
  32 #include <stdlib.h>
  33 #include <cspi/spi-private.h>
  34 #include "spi.h"
  35
  36 #undef DEBUG_OBJECTS
  37
  38 static DBusConnection *bus = NULL;
  39 static GHashTable *apps = NULL;
  40 static GHashTable *live_refs = NULL;
  41 static GQueue *exception_handlers = NULL;
  42 static DBusError exception;
  43
  44 static void
  45 cspi_object_release (gpointer value)
  46 {
  47 }
  48
  49 gboolean
  50 cspi_exception_throw (DBusError *error, const char *desc_prefix)
  51 {
  52   SPIExceptionHandler *handler = NULL;
  53   SPIException ex;
  54   if (exception_handlers) handler = g_queue_peek_head (exception_handlers);
  55
  56   ex.type = SPI_EXCEPTION_SOURCE_UNSPECIFIED;
  57   ex.source = NULL;
  58   ex.code = SPI_EXCEPTION_UNSPECIFIED;
  59   ex.error = error;
  60   // TODO: Fill in description
  61
  62   if (handler)
  63     return (*handler) (&ex, FALSE);
  64   else
  65     return FALSE; /* means exception was not handled */
  66 }
  67
  68 const char *spi_path_dec = SPI_DBUS_PATH_DEC;
  69 const char *spi_path_registry = SPI_DBUS_PATH_REGISTRY;
  70 const char *spi_bus_registry = SPI_DBUS_NAME_REGISTRY;
  71 const char *spi_path_desktop = SPI_DBUS_PATH_DESKTOP;
  72 const char *spi_interface_accessible = SPI_DBUS_INTERFACE_ACCESSIBLE;
  73 const char *spi_interface_action = SPI_DBUS_INTERFACE_ACTION;
  74 const char *spi_interface_application = SPI_DBUS_INTERFACE_APPLICATION;
  75 const char *spi_interface_component = SPI_DBUS_INTERFACE_COMPONENT;
  76 const char *spi_interface_dec = SPI_DBUS_INTERFACE_DEC;
  77 const char *spi_interface_desktop = SPI_DBUS_INTERFACE_DESKTOP;
  78 const char *spi_interface_device_event_listener = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
  79 const char *spi_interface_document = SPI_DBUS_INTERFACE_DOCUMENT;
  80 const char *spi_interface_editable_text = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
  81 const char *spi_interface_hyperlink = SPI_DBUS_INTERFACE_HYPERLINK;
  82 const char *spi_interface_hypertext = SPI_DBUS_INTERFACE_HYPERTEXT;
  83 const char *spi_interface_image = SPI_DBUS_INTERFACE_IMAGE;
  84 const char *spi_interface_registry = SPI_DBUS_INTERFACE_REGISTRY;
  85 const char *spi_interface_selection = SPI_DBUS_INTERFACE_SELECTION;
  86 const char *spi_interface_table = SPI_DBUS_INTERFACE_TABLE;
  87 const char *spi_interface_text = SPI_DBUS_INTERFACE_TEXT;
  88 const char *spi_interface_tree = SPI_DBUS_INTERFACE_TREE;
  89 const char *spi_interface_value = SPI_DBUS_INTERFACE_VALUE;
  90
  91 static const char *interfaces[] =
  92 {
  93   SPI_DBUS_INTERFACE_ACCESSIBLE,
  94   SPI_DBUS_INTERFACE_ACTION,
  95   SPI_DBUS_INTERFACE_APPLICATION,
  96   SPI_DBUS_INTERFACE_COLLECTION,
  97   SPI_DBUS_INTERFACE_COMPONENT,
  98   SPI_DBUS_INTERFACE_DOCUMENT,
  99   SPI_DBUS_INTERFACE_EDITABLE_TEXT,
 100   SPI_DBUS_INTERFACE_HYPERLINK,
 101   SPI_DBUS_INTERFACE_HYPERTEXT,
 102   SPI_DBUS_INTERFACE_IMAGE,
 103   "org.a11y.atspi.LoginHelper",
 104   SPI_DBUS_INTERFACE_SELECTION,
 105   "org.a11y.atspi.Selector",
 106   SPI_DBUS_INTERFACE_TABLE,
 107   SPI_DBUS_INTERFACE_TEXT,
 108   SPI_DBUS_INTERFACE_VALUE,
 109   NULL
 110 };
 111
 112 static gint get_iface_num (const char *iface)
 113 {
 114   // TODO: Use a binary search or hash to improve performance
 115   int i;
 116
 117   for (i = 0; interfaces[i]; i++)
 118   {
 119     if (!strcmp(iface, interfaces[i])) return i;
 120   }
 121   return -1;
 122 }
 123
 124 SPIBoolean
 125 cspi_accessible_is_a (Accessible *accessible,
 126                       const char *interface_name)
 127 {
 128   int n;
 129
 130   if (accessible == NULL)
 131     {
 132       return FALSE;
 133     }
 134
 135   n = get_iface_num (interface_name);
 136   if (n == -1) return FALSE;
 137   return (SPIBoolean)((accessible->interfaces & (1 << n))? TRUE: FALSE);
 138 }
 139
 140 static GHashTable *
 141 cspi_get_live_refs (void)
 142 {
 143   if (!live_refs)
 144     {
 145       live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
 146     }
 147   return live_refs;
 148 }
 149
 150 DBusConnection *
 151 SPI_bus (void)
 152 {
 153   return bus;
 154 }
 155
 156 SPIBoolean
 157 cspi_exception (void)
 158 {
 159   if (dbus_error_is_set (&exception))
 160   {
 161     dbus_error_free (&exception);
 162     return TRUE;
 163   }
 164   return FALSE;
 165 }
 166
 167 SPIBoolean
 168 cspi_check_ev (const char *error_string)
 169 {
 170   if (dbus_error_is_set (&exception))
 171   {
 172     cspi_exception_throw (&exception, error_string);
 173     return FALSE;
 174   }
 175   return TRUE;
 176 }
 177
 178 Accessible *
 179 cspi_object_add (Accessible *accessible)
 180 {
 181   if (accessible) cspi_object_ref (accessible);
 182   return accessible;
 183 }
 184
 185 void
 186 cspi_object_ref (Accessible *accessible)
 187 {
 188   g_return_if_fail (accessible != NULL);
 189
 190   accessible->ref_count++;
 191   g_hash_table_insert (live_refs, accessible, accessible);
 192 }
 193
 194 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, spi_bus_registry))
 195
 196 static void
 197 cspi_object_unref_internal (Accessible *accessible, gboolean defunct)
 198 {
 199   gboolean cached;
 200
 201   if (accessible == NULL)
 202     {
 203       return;
 204     }
 205
 206   if (--accessible->ref_count == 0 || (accessible->ref_count == 1 && !defunct) && g_hash_table_lookup (live_refs, accessible))
 207   {
 208     AccessibleEvent e;
 209     memset (&e, 0, sizeof(e));
 210     e.type = "object:state-change:defunct";
 211     e.source = accessible;
 212     e.detail1 = 1;
 213     cspi_dispatch_event (&e);
 214     g_hash_table_remove (live_refs, accessible);
 215   }
 216   if (accessible->ref_count == 0)
 217   {
 218     if (APP_IS_REGISTRY (accessible->app))
 219     {
 220       g_free (accessible->v.path);
 221     }
 222     if (accessible->states)
 223       spi_state_set_cache_unref (accessible->states);
 224     g_free (accessible->description);
 225     g_free (accessible->name);
 226     g_free(accessible);
 227   }
 228 }
 229
 230 void
 231 cspi_object_unref (Accessible *accessible)
 232 {
 233   cspi_object_unref_internal (accessible, FALSE);
 234 }
 235
 236 static void
 237 cspi_cleanup (void)
 238 {
 239   GHashTable *refs;
 240
 241   cspi_streams_close_all ();
 242
 243   refs = live_refs;
 244   live_refs = NULL;
 245   if (refs)
 246     {
 247       g_hash_table_destroy (refs);
 248     }
 249 }
 250
 251 static gboolean SPI_inited = FALSE;
 252
 253 static GHashTable *app_hash = NULL;
 254
 255 static Accessible *
 256 ref_accessible (CSpiApplication *app, const char *path)
 257 {
 258   int id;
 259   guint *id_val;
 260
 261   if (sscanf (path, "/org/a11y/atspi/accessible/%d", &id) != 1)
 262   {
 263     return NULL;
 264   }
 265   Accessible *a = g_hash_table_lookup (app->hash, &id);
 266   if (a)
 267   {
 268     cspi_object_ref (a);
 269     return a;
 270   }
 271   id_val = g_new (guint, 1);
 272   if (!id_val) return NULL;
 273   *id_val = id;
 274   a = g_new0 (Accessible, 1);
 275   if (!a)
 276   {
 277     g_free (id_val);
 278     return NULL;
 279   }
 280   g_hash_table_insert (app->hash, id_val, a);
 281   a->app = app;
 282   a->v.id = id;
 283   a->ref_count = 2;     /* one for the caller, one for the hash */
 284   return a;
 285 }
 286
 287 static CSpiApplication *
 288 cspi_get_application (const char *bus_name)
 289 {
 290   CSpiApplication *app = NULL;
 291   char *bus_name_dup;
 292
 293   if (!app_hash)
 294   {
 295     app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_hash_table_unref);
 296     if (!app_hash) return NULL;
 297   }
 298   app = g_hash_table_lookup (app_hash, bus_name);
 299   if (app) return app;
 300   bus_name_dup = g_strdup (bus_name);
 301   if (!bus_name_dup) return NULL;
 302   // TODO: change below to something that will send state-change:defunct notification if necessary */
 303   app = g_new (CSpiApplication, 1);
 304   if (!app) return NULL;
 305   app->bus_name = bus_name_dup;
 306   if (APP_IS_REGISTRY (app))
 307   {
 308     app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, cspi_object_unref);
 309   }
 310   else
 311   {
 312     app->hash = g_hash_table_new_full (g_int_hash, g_int_equal, g_free, cspi_object_unref);
 313   }
 314   g_hash_table_insert (app_hash, bus_name_dup, app);
 315   return app;
 316 }
 317
 318 typedef struct
 319 {
 320   char *path;
 321   char *parent;
 322   GArray *children;
 323   GArray *interfaces;
 324   char *name;
 325   dbus_uint32_t role;
 326   char *description;
 327   GArray *state_bitflags;
 328 } CACHE_ADDITION;
 329
 330 static void
 331 handle_addition (CSpiApplication*app, CACHE_ADDITION *ca)
 332 {
 333   gint i;
 334   GList *new_list;
 335
 336   Accessible *a = ref_accessible (app, ca->path);
 337   /* Note: children don't hold refs for their parents or vice versa */
 338   a->parent = ref_accessible (app, ca->parent);
 339   if (a->parent) cspi_object_unref (a->parent);
 340   if (a->children)
 341   {
 342     g_list_free (a->children);
 343     a->children = NULL;
 344   }
 345   for (i = 0; i < ca->children->len; i++)
 346   {
 347     const char *child_path = g_array_index (ca->children, const char *, i);
 348     Accessible *child = ref_accessible (app, child_path);
 349     new_list = g_list_append (a->children, child);
 350     if (new_list) a->children = new_list;
 351     cspi_object_unref (child);
 352   }
 353   a->interfaces = 0;
 354   for (i = 0; i < ca->interfaces->len; i++)
 355   {
 356     const char *iface = g_array_index (ca->interfaces, const char *, i);
 357     if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
 358     gint n = get_iface_num (iface);
 359     if (n == -1)
 360     {
 361       g_warning ("Unknown interface %s", iface);
 362     }
 363     else a->interfaces |= (1 << n);
 364     g_free (iface);
 365   }
 366   if (a->name) g_free (a->name);
 367   a->name = ca->name;
 368   a->role = ca->role;
 369   if (a->description) g_free (a->description);
 370   a->description = ca->description;
 371   a->states = spi_state_set_cache_new (ca->state_bitflags);
 372   g_array_free (ca->interfaces, TRUE);
 373   g_array_free (ca->children, TRUE);
 374   /* spi_state_set_cache_new frees state_bitflags */
 375   /* This is a bit of a hack since ref_accessible sets ref_count to 2
 376    * for a new object, one of the refs being for the cache */
 377   cspi_object_unref (a);
 378 }
 379
 380 /* Update the cache with added/modified objects and free the array */
 381 static void
 382 handle_additions (CSpiApplication*app, GArray *additions)
 383 {
 384   gint i;
 385
 386   if (!additions)
 387   {
 388     return;
 389   }
 390   for (i = 0; i < additions->len; i++)
 391   {
 392     CACHE_ADDITION *ca = &g_array_index (additions, CACHE_ADDITION, i);
 393     handle_addition (app, ca);
 394   }
 395 }
 396
 397 static DBusHandlerResult
 398 cspi_dbus_handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 399 {
 400   const char *sender = dbus_message_get_sender (message);
 401   CSpiApplication *app = cspi_get_application (sender);
 402   const char *path;
 403   Accessible *a;
 404
 405   if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID))
 406   {
 407     g_warning ("Received RemoveAccessible with invalid arguments");
 408     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 409   }
 410   a = ref_accessible (app, path);
 411   if (a->parent && g_list_find (a->parent->children, a))
 412   {
 413     a->parent->children = g_list_remove (a->parent->children, a);
 414     // TODO: Send children-changed:remove event
 415     /* Note: children don't hold refs for their parents or vice versa */
 416   }
 417   g_hash_table_remove (app->hash, &a->v.id);
 418   cspi_object_unref_internal (a, TRUE); /* unref our own ref */
 419   return DBUS_HANDLER_RESULT_HANDLED;
 420 }
 421
 422 static gboolean
 423 add_app_to_desktop (Accessible *a, const char *bus_name)
 424 {
 425   DBusError error;
 426   char *root_path;
 427
 428   dbus_error_init (&error);
 429   if (dbind_method_call_reentrant (bus, bus_name, "/org/a11y/atspi/tree", spi_interface_tree, "getRoot", &error, "=>o", &root_path))
 430   {
 431     Accessible *obj = cspi_ref_accessible (bus_name, root_path);
 432     if (obj)
 433     {
 434       GList *new_list = g_list_append (a->children, obj);
 435       if (new_list)
 436       {
 437         a->children = new_list;
 438         return TRUE;
 439       }
 440     }
 441     g_free (root_path);
 442   }
 443   else
 444   {
 445     g_warning ("Error calling getRoot for %s: %s", bus_name, error.message);
 446   }
 447   return FALSE;
 448 }
 449
 450 static void
 451 send_children_changed (Accessible *parent, Accessible *child, gboolean add)
 452 {
 453   AccessibleEvent e;
 454
 455   memset (&e, 0, sizeof(e));
 456   e.type = (add? "object:children-changed:add": "object:children-changed:remove");
 457   e.source = parent;
 458   e.detail1 = g_list_index (parent->children, child);
 459   cspi_dispatch_event (&e);
 460 }
 461
 462 static void
 463 unref_object_and_children (Accessible *obj)
 464 {
 465   GList *l;
 466
 467   for (l = obj->children; l; l = l->next)
 468   {
 469     unref_object_and_children (l->data);
 470   }
 471   cspi_object_unref_internal (obj, TRUE);
 472 }
 473
 474 static gboolean
 475 remove_app_from_desktop (Accessible *a, const char *bus_name)
 476 {
 477   GList *l;
 478   Accessible *child;
 479
 480   for (l = a->children; l; l = l->next)
 481   {
 482     child = l->data;
 483     if (!strcmp (bus_name, child->app->bus_name)) break;
 484   }
 485   if (!l)
 486   {
 487     g_warning ("Removing unregistered app %s; doing nothing\n", bus_name);
 488     return FALSE;
 489   }
 490   send_children_changed (a, child, FALSE);
 491   a->children = g_list_remove (a->children, child);
 492   unref_object_and_children (child);
 493   return TRUE;
 494 }
 495
 496 static Accessible *desktop;
 497
 498 static Accessible *
 499 ref_accessible_desktop (CSpiApplication *app)
 500 {
 501   DBusError error;
 502   GArray *apps = NULL;
 503   GArray *additions;
 504   gint i;
 505
 506   if (desktop)
 507   {
 508     cspi_object_ref (desktop);
 509     return desktop;
 510   }
 511   desktop = g_new0 (Accessible, 1);
 512   if (!desktop)
 513   {
 514     return NULL;
 515   }
 516   g_hash_table_insert (app->hash, "", desktop);
 517   desktop->app = app;
 518   desktop->ref_count = 2;       /* one for the caller, one for the hash */
 519   desktop->name = g_strdup ("");
 520   dbus_error_init (&error);
 521   if (!dbind_method_call_reentrant (bus, spi_bus_registry, spi_path_registry, spi_interface_registry, "getApplications", &error, "=>as", &apps))
 522   {
 523     g_error ("Couldn't get application list: %s", error.message);
 524   }
 525   for (i = 0; i < apps->len; i++)
 526   {
 527     const char *app_name = g_array_index (apps, char *, i);
 528     if (app_name[0] == '\0')
 529     {
 530       g_warning ("Got empty app name");
 531       continue;
 532     }
 533     CSpiApplication *app = cspi_get_application (app_name);
 534     additions = NULL;
 535     dbus_error_init (&error);
 536     dbind_method_call_reentrant (bus, app_name, "/org/a11y/atspi/tree", spi_interface_tree, "getTree", &error, "=>a(ooaoassusau)", &additions);
 537     if (error.message)
 538     {
 539       g_warning ("getTree (%s): %s", app_name, error.message);
 540     }
 541     handle_additions (app, additions);
 542     add_app_to_desktop (desktop, app_name);
 543   }
 544   g_array_free (apps, TRUE);
 545   return desktop;
 546 }
 547
 548 Accessible *
 549 cspi_ref_accessible (const char *app, const char *path)
 550 {
 551   CSpiApplication *a = cspi_get_application (app);
 552   if (!a) return NULL;
 553   if ( APP_IS_REGISTRY(a))
 554   {
 555     return ref_accessible_desktop (a);
 556   }
 557   return ref_accessible (a, path);
 558 }
 559
 560 Accessible *
 561 cspi_ref_related_accessible (Accessible *obj, const char *path)
 562 {
 563   return ref_accessible (obj->app, path);
 564 }
 565
 566 static const char *cacheSignalType = "(ooaoassusau)";
 567
 568 static DBusHandlerResult
 569 cspi_dbus_handle_update_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 570 {
 571   DBusMessageIter iter;
 572   CACHE_ADDITION ca;
 573   void *p = &ca;
 574   const char *sender = dbus_message_get_sender (message);
 575   CSpiApplication *app = cspi_get_application (sender);
 576   const char *type = cacheSignalType;
 577
 578   if (!app)
 579   {
 580     g_warning ("UpdateAccessible from unknown app.  Should we add it?", sender);
 581     return DBUS_HANDLER_RESULT_HANDLED;
 582   }
 583   dbus_message_iter_init (message, &iter);
 584   // TODO: Check signature
 585   dbind_any_demarshal (&iter, &type, &p);       /* additions */
 586   handle_addition (app, &ca);
 587   return DBUS_HANDLER_RESULT_HANDLED;
 588 }
 589
 590 static DBusHandlerResult
 591 cspi_dbus_handle_register_application (DBusConnection *bus, DBusMessage *message, void *user_data)
 592 {
 593   DBusError error;
 594   dbus_uint32_t v;
 595   Accessible *a;
 596   char *bus_name;
 597
 598   dbus_error_init (&error);
 599   a = cspi_ref_accessible (spi_bus_registry, spi_path_registry);
 600   if (add_app_to_desktop (a, dbus_message_get_sender (message)))
 601   {
 602     send_children_changed (a, g_list_last (a->children)->data, TRUE);
 603   }
 604   cspi_object_unref (a);
 605   return DBUS_HANDLER_RESULT_HANDLED;
 606 }
 607
 608 static DBusHandlerResult
 609 cspi_dbus_handle_deregister_application (DBusConnection *bus, DBusMessage *message, void *user_data)
 610 {
 611   Accessible *a;
 612   DBusError error;
 613   char *bus_name;
 614
 615   dbus_error_init (&error);
 616   if (!dbus_message_get_args (message, &error, DBUS_TYPE_STRING, &bus_name, DBUS_TYPE_INVALID))
 617   {
 618     g_warning ("Error processing %s: %s\n", dbus_message_get_member(message), error.message);
 619     dbus_error_free (&error);
 620     return DBUS_HANDLER_RESULT_HANDLED;
 621   }
 622
 623   a = cspi_ref_accessible (spi_bus_registry, spi_path_registry);
 624   remove_app_from_desktop (a, bus_name);
 625   cspi_object_unref (a);
 626   return DBUS_HANDLER_RESULT_HANDLED;
 627 }
 628
 629
 630 static DBusHandlerResult
 631 cspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
 632 {
 633   int type = dbus_message_get_type (message);
 634   const char *interface = dbus_message_get_interface (message);
 635   const char *member = dbus_message_get_member (message);
 636   dbus_uint32_t v;
 637   char *bus_name;
 638
 639   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 640       !strncmp (interface, "org.a11y.atspi.Event.", 28))
 641   {
 642     return cspi_dbus_handle_event (bus, message, data);
 643   }
 644   if (dbus_message_is_method_call (message, spi_interface_device_event_listener, "notifyEvent"))
 645   {
 646     return cspi_dbus_handle_deviceEvent (bus, message, data);
 647   }
 648   if (dbus_message_is_signal (message, spi_interface_tree, "updateAccessible"))
 649   {
 650     return cspi_dbus_handle_update_accessible (bus, message, data);
 651   }
 652   if (dbus_message_is_signal (message, spi_interface_tree, "removeAccessible"))
 653   {
 654     return cspi_dbus_handle_remove_accessible (bus, message, data);
 655   }
 656   if (dbus_message_is_method_call (message, spi_interface_registry, "registerApplication"))
 657   {
 658     return cspi_dbus_handle_register_application (bus, message, data);
 659   }
 660   if (dbus_message_is_method_call (message, spi_interface_registry, "deregisterApplication"))
 661   {
 662     return cspi_dbus_handle_deregister_application (bus, message, data);
 663   }
 664   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 665 }
 666
 667 static const char *signal_interfaces[] =
 668 {
 669   "org.a11y.atspi.Event.Object",
 670   "org.a11y.atspi.Event.Window",
 671   "org.a11y.atspi.Event.Mouse",
 672   "org.a11y.atspi.Event.Terminal",
 673   "org.a11y.atspi.Event.Document",
 674   "org.a11y.atspi.Event.Focus",
 675   NULL
 676 };
 677
 678 /**
 679  * SPI_init:
 680  *
 681  * Connects to the accessibility registry and initializes the SPI.
 682  *
 683  * Returns: 0 on success, otherwise an integer error code.
 684  **/
 685 int
 686 SPI_init (void)
 687 {
 688   DBusError error;
 689   char *match;
 690   int i;
 691
 692   if (SPI_inited)
 693     {
 694       return 1;
 695     }
 696
 697   SPI_inited = TRUE;
 698
 699   g_type_init ();
 700
 701   cspi_get_live_refs();
 702   g_atexit (cspi_cleanup);
 703
 704   dbus_error_init (&error);
 705   bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 706   if (!bus)
 707   {
 708     g_error ("Couldn't get session bus");
 709     return 2;
 710   }
 711   dbus_bus_register (bus, &error);
 712   dbus_connection_setup_with_g_main(bus, g_main_context_default());
 713   dbus_connection_add_filter (bus, cspi_dbus_filter, NULL, NULL);
 714   match = g_strdup_printf ("type='signal',interface='%s',member='updateAccessible'", spi_interface_tree);
 715   dbus_error_init (&error);
 716   dbus_bus_add_match (bus, match, &error);
 717   g_free (match);
 718   match = g_strdup_printf ("type='signal',interface='%s',member='removeAccessible'", spi_interface_tree);
 719   dbus_error_init (&error);
 720   dbus_bus_add_match (bus, match, &error);
 721   g_free (match);
 722   match = g_strdup_printf ("type='method_call',interface='%s'", spi_interface_registry);
 723   dbus_bus_add_match (bus, match, &error);
 724   g_free (match);
 725   for (i = 0; signal_interfaces[i]; i++)
 726   {
 727     match = g_strdup_printf ("type='signal',interface='%s'", signal_interfaces[i]);
 728     dbus_bus_add_match (bus, match, &error);
 729     g_free (match);
 730   }
 731   return 0;
 732 }
 733
 734   static GMainLoop *mainloop;
 735
 736 /**
 737  * SPI_event_main:
 738  *
 739  * Starts/enters the main event loop for the SPI services.
 740  *
 741  * (NOTE: This method does not return control, it is exited via a call to
 742  *  SPI_event_quit () from within an event handler).
 743  *
 744  **/
 745 void
 746 SPI_event_main (void)
 747 {
 748
 749   mainloop = g_main_loop_new (NULL, FALSE);
 750   g_main_loop_run (mainloop);
 751 }
 752
 753 /**
 754  * SPI_event_quit:
 755  *
 756  * Quits the last main event loop for the SPI services,
 757  * see SPI_event_main
 758  **/
 759 void
 760 SPI_event_quit (void)
 761 {
 762   g_main_loop_quit (mainloop);
 763 }
 764
 765 /**
 766  * SPI_eventIsReady:
 767  *
 768  * Checks to see if an SPI event is waiting in the event queue.
 769  * Used by clients that don't wish to use SPI_event_main().
 770  *
 771  * Not Yet Implemented.
 772  *
 773  * Returns: #TRUE if an event is waiting, otherwise #FALSE.
 774  *
 775  **/
 776 SPIBoolean
 777 SPI_eventIsReady (void)
 778 {
 779   return FALSE;
 780 }
 781
 782 /**
 783  * SPI_nextEvent:
 784  * @waitForEvent: a #SPIBoolean indicating whether to block or not.
 785  *
 786  * Gets the next event in the SPI event queue; blocks if no event
 787  * is pending and @waitForEvent is #TRUE.
 788  * Used by clients that don't wish to use SPI_event_main().
 789  *
 790  * Not Yet Implemented.
 791  *
 792  * Returns: the next #AccessibleEvent in the SPI event queue.
 793  **/
 794 AccessibleEvent *
 795 SPI_nextEvent (SPIBoolean waitForEvent)
 796 {
 797   return NULL;
 798 }
 799
 800 #ifdef PRINT_LEAKS
 801 static void
 802 report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
 803 {
 804   char *name, *role;
 805   Accessible *a = (Accessible *) val;
 806
 807   name = Accessible_getName (a);
 808   if (cspi_exception ())
 809     {
 810       name = NULL;
 811     }
 812
 813   role = Accessible_getRoleName (a);
 814   if (cspi_exception ())
 815     {
 816       role = NULL;
 817     }
 818
 819   fprintf (stderr, "leaked %d references to object %s, role %s %p\n",
 820            a->ref_count, name ? name : "<?>", role ? role : "<?>", a);
 821
 822   SPI_freeString (name);
 823 }
 824 #endif
 825
 826 /**
 827  * SPI_exit:
 828  *
 829  * Disconnects from the Accessibility Registry and releases
 830  * any floating resources. Call only once at exit.
 831  *
 832  * Returns: 0 if there were no leaks, otherwise non zero.
 833  **/
 834 int
 835 SPI_exit (void)
 836 {
 837   int leaked;
 838
 839   if (!SPI_inited)
 840     {
 841       return 0;
 842     }
 843
 844   SPI_inited = FALSE;
 845
 846   if (live_refs)
 847     {
 848       leaked = g_hash_table_size (live_refs);
 849 #ifdef DEBUG_OBJECTS
 850       fprintf (stderr, "Leaked %d SPI handles\n", leaked);
 851
 852 #define PRINT_LEAKS
 853 #ifdef PRINT_LEAKS
 854       g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
 855 #endif
 856
 857 #endif
 858     }
 859   else
 860     {
 861       leaked = 0;
 862     }
 863
 864   cspi_cleanup ();
 865
 866   return leaked;
 867 }
 868
 869 /**
 870  * SPI_freeString:
 871  * @s: a character string returned from another at-spi call.
 872  *
 873  * Free a character string returned from an at-spi call.  Clients of
 874  * at-spi should use this function instead of free () or g_free().
 875  * A NULL string @s will be silently ignored.
 876  * This API should not be used to free strings
 877  * from other libraries or allocated by the client.
 878  **/
 879 void
 880 SPI_freeString (char *s)
 881 {
 882   if (s)
 883     {
 884       g_free (s);
 885     }
 886 }
 887
 888 /**
 889  * SPI_freeRect:
 890  * @r: a pointer to an SPIRect returned from another at-spi call.
 891  *
 892  * Free a SPIRect structure returned from an at-spi call.  Clients of
 893  * at-spi should use this function instead of free () or g_free().
 894  * A NULL rect @r will be silently ignored.
 895  * This API should not be used to free data
 896  * from other libraries or allocated by the client.
 897  *
 898  * @Since: AT-SPI 1.6
 899  **/
 900 void
 901 SPI_freeRect (SPIRect *r)
 902 {
 903   if (r)
 904     {
 905       /* err, okay, in this case the client _could_
 906          have called g_free, but we don't want to guarantee it */
 907       g_free (r);
 908     }
 909 }
 910
 911 /**
 912  * SPI_dupString:
 913  * @s: a UTF-8 string to be duplicated
 914  *
 915  * @Since: AT-SPI 1.4
 916  *
 917  * Returns: a duplicate of the string passed as a parameter, which should
 918  * be freed via SPI_freeString after use.
 919  **/
 920 char *
 921 SPI_dupString (char *s)
 922 {
 923   if (s)
 924     {
 925       return g_strdup (s);
 926     }
 927   else
 928     return NULL;
 929 }
 930
 931 /**
 932  * SPI_exceptionHandlerPush:
 933  * @handler: an #SPIExceptionHandler to install as the first code to deal with exceptions.
 934  *
 935  * Install a client-side handler for #SPIException instances, which can see and handle any
 936  * exceptions before chaining them to the next exception handler in the stack.
 937  *
 938  * @Since: AT-SPI 1.4
 939  *
 940  * Returns %TRUE if the result succeeded, %FALSE if @hander could not be registered.
 941  **/
 942 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
 943 {
 944   if (!exception_handlers)
 945     exception_handlers = g_queue_new ();
 946   g_queue_push_head (exception_handlers, handler);
 947   return TRUE;
 948 }
 949
 950 /**
 951  * SPI_exceptionHandlerPop:
 952  *
 953  * Remove/pop an #SPIExceptionHandler off the error handler stack and return the new handler.
 954  *
 955  * @Since: AT-SPI 1.4
 956  *
 957  * Returns the #SPIExceptionHandler which is now at the top of the error handler stack after the call.
 958  **/
 959 SPIExceptionHandler* SPI_exceptionHandlerPop (void)
 960 {
 961   return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
 962 }
 963
 964 /**
 965  * SPIException_getSourceType:
 966  * @err: the exception being queried
 967  *
 968  * Get the #SPIExceptionType of an exception which has been thrown.
 969  *
 970  * @Since: AT-SPI 1.4
 971  *
 972  * Returns: the #SPIExceptionType corresponding to exception @err.
 973  **/
 974 SPIExceptionType SPIException_getSourceType (SPIException *err)
 975 {
 976   if (err)
 977     return err->type;
 978   else
 979     return SPI_EXCEPTION_SOURCE_UNSPECIFIED;
 980 }
 981
 982 /**
 983  * SPIException_getExceptionCode:
 984  * @err: the #SPIException being queried.
 985  *
 986  * Get the #SPIExceptionCode telling what type of exception condition has occurred.
 987  *
 988  * @Since: AT-SPI 1.4
 989  *
 990  * Returns: the #SPIExceptionCode corresponding to exception @err.
 991  **/
 992 SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
 993 {
 994   return err->code;
 995 }
 996
 997 /**
 998  * SPIAccessibleException_getSource:
 999  * @err: the #SPIException being queried.
1000  *
1001  * Get the identity of the object which threw an exception.
1002  *
1003  * @Since: AT-SPI 1.4
1004  *
1005  * Returns: a pointer to the #Accessible object which threw the exception.
1006  **/
1007 Accessible* SPIAccessibleException_getSource (SPIException *err)
1008 {
1009   if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
1010     cspi_object_ref (err->source);
1011     return err->source;
1012   return NULL;
1013 }
1014
1015 /**
1016  * SPIException_getDescription:
1017  * @err: the #SPIException being queried.
1018  *
1019  * Get a text description of the exception that has been thrown.
1020  * Unfortunately these descriptions tend to be terse and limited in
1021  * the detail which they can provide.
1022  *
1023  * Returns: a brief character string describing the exception.
1024  **/
1025 char* SPIException_getDescription (SPIException *err)
1026 {
1027   /* TODO: friendlier error messages? */
1028   if (err->error)
1029     return err->error->message;
1030   return NULL;
1031 }
1032
1033 static char *
1034 get_path (Accessible *obj)
1035 {
1036   if (APP_IS_REGISTRY (obj->app))
1037   {
1038     return g_strdup_printf (SPI_DBUS_PATH_REGISTRY);
1039   }
1040   return g_strdup_printf ("/org/a11y/atspi/accessible/%d", obj->v.id);
1041 }
1042
1043 dbus_bool_t
1044 cspi_dbus_call (Accessible *obj, const char *interface, const char *method, DBusError *error, const char *type, ...)
1045 {
1046   va_list args;
1047   char *path = get_path (obj);
1048   dbus_bool_t retval;
1049   DBusError err;
1050
1051   if (!error) error = &err;
1052   dbus_error_init (error);
1053   va_start (args, type);
1054   retval = dbind_method_call_reentrant_va (SPI_bus(), obj->app->bus_name, path, interface, method, error, type, args);
1055   va_end (args);
1056   g_free (path);
1057   if (dbus_error_is_set (error))
1058   {
1059     if (!dbus_error_is_set (&exception))
1060     {
1061       // TODO: Should we call cspi_exception_throw?
1062       dbus_move_error (error, &exception);
1063     }
1064     else if (error == &err) dbus_error_free (error);
1065   }
1066   return retval;
1067 }
1068
1069 dbus_bool_t
1070 cspi_dbus_get_property (Accessible *obj, const char *interface, const char *name, DBusError *error, const char *type, void *data)
1071 {
1072   DBusMessage *message, *reply;
1073   char *path = get_path (obj);
1074   DBusMessageIter iter, iter_variant;
1075   DBusError err;
1076   dbus_bool_t retval = FALSE;
1077
1078   message = dbus_message_new_method_call (obj->app->bus_name, path, "org.freedesktop.DBus.Properties", "Get");
1079   if (!message)
1080   {
1081     // TODO: throw exception
1082     goto done;
1083   }
1084   dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1085   if (!error) error = &err;
1086   dbus_error_init (error);
1087   reply = dbus_connection_send_with_reply_and_block (SPI_bus(), message, 1000, error);
1088   dbus_message_unref (message);
1089   if (!reply)
1090   {
1091     // TODO: throw exception
1092     goto done;
1093   }
1094   dbus_message_iter_init (reply, &iter);
1095   dbus_message_iter_recurse (&iter, &iter_variant);
1096   if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1097   {
1098     g_warning ("cspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1099     goto done;
1100   }
1101   dbus_message_iter_get_basic (&iter_variant, data);
1102   dbus_message_unref (reply);
1103   if (type[0] == 's') *(char **)data = g_strdup (*(char **)data);
1104   retval = TRUE;
1105 done:
1106   g_free (path);
1107   return retval;
1108 }