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.freedesktop.atspi.LoginHelper",
 104   SPI_DBUS_INTERFACE_SELECTION,
 105   "org.freedesktop.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/freedesktop/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 }
 420
 421 static gboolean
 422 add_app_to_desktop (Accessible *a, const char *bus_name)
 423 {
 424   DBusError error;
 425   char *root_path;
 426
 427   dbus_error_init (&error);
 428   if (dbind_method_call_reentrant (bus, bus_name, "/org/freedesktop/atspi/tree", spi_interface_tree, "getRoot", &error, "=>o", &root_path))
 429   {
 430     Accessible *obj = cspi_ref_accessible (bus_name, root_path);
 431     if (obj)
 432     {
 433       GList *new_list = g_list_append (a->children, obj);
 434       if (new_list)
 435       {
 436         a->children = new_list;
 437         return TRUE;
 438       }
 439     }
 440     g_free (root_path);
 441   }
 442   else
 443   {
 444     g_warning ("Error calling getRoot for %s: %s", bus_name, error.message);
 445   }
 446   return FALSE;
 447 }
 448
 449 static void
 450 send_children_changed (Accessible *parent, Accessible *child, gboolean add)
 451 {
 452   AccessibleEvent e;
 453
 454   memset (&e, 0, sizeof(e));
 455   e.type = (add? "object:children-changed:add": "object:children-changed:remove");
 456   e.source = parent;
 457   e.detail1 = g_list_index (parent->children, child);
 458   cspi_dispatch_event (&e);
 459 }
 460
 461 static void
 462 unref_object_and_children (Accessible *obj)
 463 {
 464   GList *l;
 465
 466   for (l = obj->children; l; l = l->next)
 467   {
 468     unref_object_and_children (l->data);
 469   }
 470   cspi_object_unref_internal (obj, TRUE);
 471 }
 472
 473 static gboolean
 474 remove_app_from_desktop (Accessible *a, const char *bus_name)
 475 {
 476   GList *l;
 477   Accessible *child;
 478
 479   for (l = a->children; l; l = l->next)
 480   {
 481     child = l->data;
 482     if (!strcmp (bus_name, child->app->bus_name)) break;
 483   }
 484   if (!l)
 485   {
 486     g_warning ("Removing unregistered app %s; doing nothing\n", bus_name);
 487     return FALSE;
 488   }
 489   send_children_changed (a, child, FALSE);
 490   a->children = g_list_remove (a->children, child);
 491   unref_object_and_children (child);
 492   return TRUE;
 493 }
 494
 495 static Accessible *desktop;
 496
 497 static Accessible *
 498 ref_accessible_desktop (CSpiApplication *app)
 499 {
 500   DBusError error;
 501   GArray *apps = NULL;
 502   GArray *additions;
 503   gint i;
 504
 505   if (desktop)
 506   {
 507     cspi_object_ref (desktop);
 508     return desktop;
 509   }
 510   desktop = g_new0 (Accessible, 1);
 511   if (!desktop)
 512   {
 513     return NULL;
 514   }
 515   g_hash_table_insert (app->hash, "", desktop);
 516   desktop->app = app;
 517   desktop->ref_count = 2;       /* one for the caller, one for the hash */
 518   desktop->name = g_strdup ("");
 519   dbus_error_init (&error);
 520   if (!dbind_method_call_reentrant (bus, spi_bus_registry, spi_path_registry, spi_interface_registry, "getApplications", &error, "=>as", &apps))
 521   {
 522     g_error ("Couldn't get application list: %s", error.message);
 523   }
 524   for (i = 0; i < apps->len; i++)
 525   {
 526     const char *app_name = g_array_index (apps, char *, i);
 527     if (app_name[0] == '\0')
 528     {
 529       g_warning ("Got empty app name");
 530       continue;
 531     }
 532     CSpiApplication *app = cspi_get_application (app_name);
 533     additions = NULL;
 534     dbus_error_init (&error);
 535     dbind_method_call_reentrant (bus, app_name, "/org/freedesktop/atspi/tree", spi_interface_tree, "getTree", &error, "=>a(ooaoassusau)", &additions);
 536     if (error.message)
 537     {
 538       g_warning ("getTree (%s): %s", app_name, error.message);
 539     }
 540     handle_additions (app, additions);
 541     add_app_to_desktop (desktop, app_name);
 542   }
 543   g_array_free (apps, TRUE);
 544   return desktop;
 545 }
 546
 547 Accessible *
 548 cspi_ref_accessible (const char *app, const char *path)
 549 {
 550   CSpiApplication *a = cspi_get_application (app);
 551   if (!a) return NULL;
 552   if ( APP_IS_REGISTRY(a))
 553   {
 554     return ref_accessible_desktop (a);
 555   }
 556   return ref_accessible (a, path);
 557 }
 558
 559 Accessible *
 560 cspi_ref_related_accessible (Accessible *obj, const char *path)
 561 {
 562   return ref_accessible (obj->app, path);
 563 }
 564
 565 static const char *cacheSignalType = "(ooaoassusau)";
 566
 567 static DBusHandlerResult
 568 cspi_dbus_handle_update_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 569 {
 570   DBusMessageIter iter;
 571   CACHE_ADDITION ca;
 572   void *p = &ca;
 573   const char *sender = dbus_message_get_sender (message);
 574   CSpiApplication *app = cspi_get_application (sender);
 575   const char *type = cacheSignalType;
 576
 577   if (!app)
 578   {
 579     g_warning ("UpdateAccessible from unknown app.  Should we add it?", sender);
 580     return DBUS_HANDLER_RESULT_HANDLED;
 581   }
 582   dbus_message_iter_init (message, &iter);
 583   // TODO: Check signature
 584   dbind_any_demarshal (&iter, &type, &p);       /* additions */
 585   handle_addition (app, &ca);
 586   return DBUS_HANDLER_RESULT_HANDLED;
 587 }
 588
 589 static DBusHandlerResult
 590 cspi_dbus_handle_register_application (DBusConnection *bus, DBusMessage *message, void *user_data)
 591 {
 592   DBusError error;
 593   dbus_uint32_t v;
 594   Accessible *a;
 595   char *bus_name;
 596
 597   dbus_error_init (&error);
 598   a = cspi_ref_accessible (spi_bus_registry, spi_path_registry);
 599   if (add_app_to_desktop (a, dbus_message_get_sender (message)))
 600   {
 601     send_children_changed (a, g_list_last (a->children)->data, TRUE);
 602   }
 603   cspi_object_unref (a);
 604   return DBUS_HANDLER_RESULT_HANDLED;
 605 }
 606
 607 static DBusHandlerResult
 608 cspi_dbus_handle_deregister_application (DBusConnection *bus, DBusMessage *message, void *user_data)
 609 {
 610   Accessible *a;
 611   DBusError error;
 612   char *bus_name;
 613
 614   dbus_error_init (&error);
 615   if (!dbus_message_get_args (message, &error, DBUS_TYPE_STRING, &bus_name, DBUS_TYPE_INVALID))
 616   {
 617     g_warning ("Error processing %s: %s\n", dbus_message_get_member(message), error.message);
 618     dbus_error_free (&error);
 619     return DBUS_HANDLER_RESULT_HANDLED;
 620   }
 621
 622   a = cspi_ref_accessible (spi_bus_registry, spi_path_registry);
 623   remove_app_from_desktop (a, bus_name);
 624   cspi_object_unref (a);
 625   return DBUS_HANDLER_RESULT_HANDLED;
 626 }
 627
 628
 629 static DBusHandlerResult
 630 cspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
 631 {
 632   int type = dbus_message_get_type (message);
 633   const char *interface = dbus_message_get_interface (message);
 634   const char *member = dbus_message_get_member (message);
 635   dbus_uint32_t v;
 636   char *bus_name;
 637
 638   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 639       !strncmp (interface, "org.freedesktop.atspi.Event.", 28))
 640   {
 641     return cspi_dbus_handle_event (bus, message, data);
 642   }
 643   if (dbus_message_is_method_call (message, spi_interface_device_event_listener, "notifyEvent"))
 644   {
 645     return cspi_dbus_handle_deviceEvent (bus, message, data);
 646   }
 647   if (dbus_message_is_signal (message, spi_interface_tree, "updateAccessible"))
 648   {
 649     return cspi_dbus_handle_update_accessible (bus, message, data);
 650   }
 651   if (dbus_message_is_signal (message, spi_interface_tree, "removeAccessible"))
 652   {
 653     return cspi_dbus_handle_remove_accessible (bus, message, data);
 654   }
 655   if (dbus_message_is_method_call (message, spi_interface_registry, "registerApplication"))
 656   {
 657     return cspi_dbus_handle_register_application (bus, message, data);
 658   }
 659   if (dbus_message_is_method_call (message, spi_interface_registry, "deregisterApplication"))
 660   {
 661     return cspi_dbus_handle_deregister_application (bus, message, data);
 662   }
 663   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 664 }
 665
 666 static const char *signal_interfaces[] =
 667 {
 668   "org.freedesktop.atspi.Event.Object",
 669   "org.freedesktop.atspi.Event.Window",
 670   "org.freedesktop.atspi.Event.Mouse",
 671   "org.freedesktop.atspi.Event.Terminal",
 672   "org.freedesktop.atspi.Event.Document",
 673   "org.freedesktop.atspi.Event.Focus",
 674   NULL
 675 };
 676
 677 /**
 678  * SPI_init:
 679  *
 680  * Connects to the accessibility registry and initializes the SPI.
 681  *
 682  * Returns: 0 on success, otherwise an integer error code.
 683  **/
 684 int
 685 SPI_init (void)
 686 {
 687   DBusError error;
 688   char *match;
 689   int i;
 690
 691   if (SPI_inited)
 692     {
 693       return 1;
 694     }
 695
 696   SPI_inited = TRUE;
 697
 698   g_type_init ();
 699
 700   cspi_get_live_refs();
 701   g_atexit (cspi_cleanup);
 702
 703   dbus_error_init (&error);
 704   bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 705   if (!bus)
 706   {
 707     g_error ("Couldn't get session bus");
 708     return 2;
 709   }
 710   dbus_bus_register (bus, &error);
 711   dbus_connection_setup_with_g_main(bus, g_main_context_default());
 712   dbus_connection_add_filter (bus, cspi_dbus_filter, NULL, NULL);
 713   match = g_strdup_printf ("type='signal',interface='%s',member='updateAccessible'", spi_interface_tree);
 714   dbus_error_init (&error);
 715   dbus_bus_add_match (bus, match, &error);
 716   g_free (match);
 717   match = g_strdup_printf ("type='signal',interface='%s',member='removeAccessible'", spi_interface_tree);
 718   dbus_error_init (&error);
 719   dbus_bus_add_match (bus, match, &error);
 720   g_free (match);
 721   match = g_strdup_printf ("type='method_call',interface='%s'", spi_interface_registry);
 722   dbus_bus_add_match (bus, match, &error);
 723   g_free (match);
 724   for (i = 0; signal_interfaces[i]; i++)
 725   {
 726     match = g_strdup_printf ("type='signal',interface='%s'", signal_interfaces[i]);
 727     dbus_bus_add_match (bus, match, &error);
 728     g_free (match);
 729   }
 730   return 0;
 731 }
 732
 733   static GMainLoop *mainloop;
 734
 735 /**
 736  * SPI_event_main:
 737  *
 738  * Starts/enters the main event loop for the SPI services.
 739  *
 740  * (NOTE: This method does not return control, it is exited via a call to
 741  *  SPI_event_quit () from within an event handler).
 742  *
 743  **/
 744 void
 745 SPI_event_main (void)
 746 {
 747
 748   mainloop = g_main_loop_new (NULL, FALSE);
 749   g_main_loop_run (mainloop);
 750 }
 751
 752 /**
 753  * SPI_event_quit:
 754  *
 755  * Quits the last main event loop for the SPI services,
 756  * see SPI_event_main
 757  **/
 758 void
 759 SPI_event_quit (void)
 760 {
 761   g_main_loop_quit (mainloop);
 762 }
 763
 764 /**
 765  * SPI_eventIsReady:
 766  *
 767  * Checks to see if an SPI event is waiting in the event queue.
 768  * Used by clients that don't wish to use SPI_event_main().
 769  *
 770  * Not Yet Implemented.
 771  *
 772  * Returns: #TRUE if an event is waiting, otherwise #FALSE.
 773  *
 774  **/
 775 SPIBoolean
 776 SPI_eventIsReady (void)
 777 {
 778   return FALSE;
 779 }
 780
 781 /**
 782  * SPI_nextEvent:
 783  * @waitForEvent: a #SPIBoolean indicating whether to block or not.
 784  *
 785  * Gets the next event in the SPI event queue; blocks if no event
 786  * is pending and @waitForEvent is #TRUE.
 787  * Used by clients that don't wish to use SPI_event_main().
 788  *
 789  * Not Yet Implemented.
 790  *
 791  * Returns: the next #AccessibleEvent in the SPI event queue.
 792  **/
 793 AccessibleEvent *
 794 SPI_nextEvent (SPIBoolean waitForEvent)
 795 {
 796   return NULL;
 797 }
 798
 799 #ifdef PRINT_LEAKS
 800 static void
 801 report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
 802 {
 803   char *name, *role;
 804   Accessible *a = (Accessible *) val;
 805
 806   name = Accessible_getName (a);
 807   if (cspi_exception ())
 808     {
 809       name = NULL;
 810     }
 811
 812   role = Accessible_getRoleName (a);
 813   if (cspi_exception ())
 814     {
 815       role = NULL;
 816     }
 817
 818   fprintf (stderr, "leaked %d references to object %s, role %s %p\n",
 819            a->ref_count, name ? name : "<?>", role ? role : "<?>", a);
 820
 821   SPI_freeString (name);
 822 }
 823 #endif
 824
 825 /**
 826  * SPI_exit:
 827  *
 828  * Disconnects from the Accessibility Registry and releases
 829  * any floating resources. Call only once at exit.
 830  *
 831  * Returns: 0 if there were no leaks, otherwise non zero.
 832  **/
 833 int
 834 SPI_exit (void)
 835 {
 836   int leaked;
 837
 838   if (!SPI_inited)
 839     {
 840       return 0;
 841     }
 842
 843   SPI_inited = FALSE;
 844
 845   if (live_refs)
 846     {
 847       leaked = g_hash_table_size (live_refs);
 848 #ifdef DEBUG_OBJECTS
 849       fprintf (stderr, "Leaked %d SPI handles\n", leaked);
 850
 851 #define PRINT_LEAKS
 852 #ifdef PRINT_LEAKS
 853       g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
 854 #endif
 855
 856 #endif
 857     }
 858   else
 859     {
 860       leaked = 0;
 861     }
 862
 863   cspi_cleanup ();
 864
 865   return leaked;
 866 }
 867
 868 /**
 869  * SPI_freeString:
 870  * @s: a character string returned from another at-spi call.
 871  *
 872  * Free a character string returned from an at-spi call.  Clients of
 873  * at-spi should use this function instead of free () or g_free().
 874  * A NULL string @s will be silently ignored.
 875  * This API should not be used to free strings
 876  * from other libraries or allocated by the client.
 877  **/
 878 void
 879 SPI_freeString (char *s)
 880 {
 881   if (s)
 882     {
 883       g_free (s);
 884     }
 885 }
 886
 887 /**
 888  * SPI_freeRect:
 889  * @r: a pointer to an SPIRect returned from another at-spi call.
 890  *
 891  * Free a SPIRect structure returned from an at-spi call.  Clients of
 892  * at-spi should use this function instead of free () or g_free().
 893  * A NULL rect @r will be silently ignored.
 894  * This API should not be used to free data
 895  * from other libraries or allocated by the client.
 896  *
 897  * @Since: AT-SPI 1.6
 898  **/
 899 void
 900 SPI_freeRect (SPIRect *r)
 901 {
 902   if (r)
 903     {
 904       /* err, okay, in this case the client _could_
 905          have called g_free, but we don't want to guarantee it */
 906       g_free (r);
 907     }
 908 }
 909
 910 /**
 911  * SPI_dupString:
 912  * @s: a UTF-8 string to be duplicated
 913  *
 914  * @Since: AT-SPI 1.4
 915  *
 916  * Returns: a duplicate of the string passed as a parameter, which should
 917  * be freed via SPI_freeString after use.
 918  **/
 919 char *
 920 SPI_dupString (char *s)
 921 {
 922   if (s)
 923     {
 924       return g_strdup (s);
 925     }
 926   else
 927     return NULL;
 928 }
 929
 930 /**
 931  * SPI_exceptionHandlerPush:
 932  * @handler: an #SPIExceptionHandler to install as the first code to deal with exceptions.
 933  *
 934  * Install a client-side handler for #SPIException instances, which can see and handle any
 935  * exceptions before chaining them to the next exception handler in the stack.
 936  *
 937  * @Since: AT-SPI 1.4
 938  *
 939  * Returns %TRUE if the result succeeded, %FALSE if @hander could not be registered.
 940  **/
 941 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
 942 {
 943   if (!exception_handlers)
 944     exception_handlers = g_queue_new ();
 945   g_queue_push_head (exception_handlers, handler);
 946   return TRUE;
 947 }
 948
 949 /**
 950  * SPI_exceptionHandlerPop:
 951  *
 952  * Remove/pop an #SPIExceptionHandler off the error handler stack and return the new handler.
 953  *
 954  * @Since: AT-SPI 1.4
 955  *
 956  * Returns the #SPIExceptionHandler which is now at the top of the error handler stack after the call.
 957  **/
 958 SPIExceptionHandler* SPI_exceptionHandlerPop (void)
 959 {
 960   return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
 961 }
 962
 963 /**
 964  * SPIException_getSourceType:
 965  * @err: the exception being queried
 966  *
 967  * Get the #SPIExceptionType of an exception which has been thrown.
 968  *
 969  * @Since: AT-SPI 1.4
 970  *
 971  * Returns: the #SPIExceptionType corresponding to exception @err.
 972  **/
 973 SPIExceptionType SPIException_getSourceType (SPIException *err)
 974 {
 975   if (err)
 976     return err->type;
 977   else
 978     return SPI_EXCEPTION_SOURCE_UNSPECIFIED;
 979 }
 980
 981 /**
 982  * SPIException_getExceptionCode:
 983  * @err: the #SPIException being queried.
 984  *
 985  * Get the #SPIExceptionCode telling what type of exception condition has occurred.
 986  *
 987  * @Since: AT-SPI 1.4
 988  *
 989  * Returns: the #SPIExceptionCode corresponding to exception @err.
 990  **/
 991 SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
 992 {
 993   return err->code;
 994 }
 995
 996 /**
 997  * SPIAccessibleException_getSource:
 998  * @err: the #SPIException being queried.
 999  *
1000  * Get the identity of the object which threw an exception.
1001  *
1002  * @Since: AT-SPI 1.4
1003  *
1004  * Returns: a pointer to the #Accessible object which threw the exception.
1005  **/
1006 Accessible* SPIAccessibleException_getSource (SPIException *err)
1007 {
1008   if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
1009     cspi_object_ref (err->source);
1010     return err->source;
1011   return NULL;
1012 }
1013
1014 /**
1015  * SPIException_getDescription:
1016  * @err: the #SPIException being queried.
1017  *
1018  * Get a text description of the exception that has been thrown.
1019  * Unfortunately these descriptions tend to be terse and limited in
1020  * the detail which they can provide.
1021  *
1022  * Returns: a brief character string describing the exception.
1023  **/
1024 char* SPIException_getDescription (SPIException *err)
1025 {
1026   /* TODO: friendlier error messages? */
1027   if (err->error)
1028     return err->error->message;
1029   return NULL;
1030 }
1031
1032 static char *
1033 get_path (Accessible *obj)
1034 {
1035   if (APP_IS_REGISTRY (obj->app))
1036   {
1037     return g_strdup_printf (SPI_DBUS_PATH_REGISTRY);
1038   }
1039   return g_strdup_printf ("/org/freedesktop/atspi/accessible/%d", obj->v.id);
1040 }
1041
1042 dbus_bool_t
1043 cspi_dbus_call (Accessible *obj, const char *interface, const char *method, DBusError *error, const char *type, ...)
1044 {
1045   va_list args;
1046   char *path = get_path (obj);
1047   dbus_bool_t retval;
1048   DBusError err;
1049
1050   if (!error) error = &err;
1051   dbus_error_init (error);
1052   va_start (args, type);
1053   retval = dbind_method_call_reentrant_va (SPI_bus(), obj->app->bus_name, path, interface, method, error, type, args);
1054   va_end (args);
1055   g_free (path);
1056   if (dbus_error_is_set (error))
1057   {
1058     if (!dbus_error_is_set (&exception))
1059     {
1060       // TODO: Should we call cspi_exception_throw?
1061       dbus_move_error (error, &exception);
1062     }
1063     else if (error == &err) dbus_error_free (error);
1064   }
1065   return retval;
1066 }
1067
1068 dbus_bool_t
1069 cspi_dbus_get_property (Accessible *obj, const char *interface, const char *name, DBusError *error, const char *type, void *data)
1070 {
1071   DBusMessage *message, *reply;
1072   char *path = get_path (obj);
1073   DBusMessageIter iter, iter_variant;
1074   DBusError err;
1075   dbus_bool_t retval = FALSE;
1076
1077   message = dbus_message_new_method_call (obj->app->bus_name, path, "org.freedesktop.DBus.Properties", "Get");
1078   if (!message)
1079   {
1080     // TODO: throw exception
1081     goto done;
1082   }
1083   dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1084   if (!error) error = &err;
1085   dbus_error_init (error);
1086   reply = dbus_connection_send_with_reply_and_block (SPI_bus(), message, 1000, error);
1087   dbus_message_unref (message);
1088   if (!reply)
1089   {
1090     // TODO: throw exception
1091     goto done;
1092   }
1093   dbus_message_iter_init (reply, &iter);
1094   dbus_message_iter_recurse (&iter, &iter_variant);
1095   if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1096   {
1097     g_warning ("cspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1098     goto done;
1099   }
1100   dbus_message_iter_get_basic (&iter_variant, data);
1101   dbus_message_unref (reply);
1102   if (type[0] == 's') *(char **)data = g_strdup (*(char **)data);
1103   retval = TRUE;
1104 done:
1105   g_free (path);
1106   return retval;
1107 }