libspi/dbus.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2008 Novell, 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 #include "accessible.h"
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include "dbus.h"
  27
  28 static GHashTable *path2ptr;
  29 static guint objindex;
  30
  31 static void
  32 deregister_object (gpointer obj)
  33 {
  34   g_hash_table_remove (path2ptr, &obj);
  35 }
  36
  37 static guint
  38 register_object (AtkObject * obj)
  39 {
  40   gint *new_int;
  41
  42   if (!path2ptr)
  43     {
  44       path2ptr = g_hash_table_new_full (g_int_hash, g_int_equal, g_free, NULL);
  45       if (!path2ptr)
  46         return ++objindex;
  47     }
  48   objindex++;
  49   while (g_hash_table_lookup (path2ptr, &objindex))
  50     {
  51       objindex++;
  52       /* g_object_get_data returning 0 means no data, so handle wrap-around */
  53       if (objindex == 0)
  54         objindex++;
  55     }
  56   new_int = (gint *)g_malloc(sizeof(gint));
  57   if (new_int)
  58   {
  59     *new_int = objindex;
  60     g_hash_table_insert (path2ptr, new_int, obj);
  61   }
  62   g_object_set_data_full (G_OBJECT (obj), "dbus-id", (gpointer) objindex,
  63                           deregister_object);
  64   return objindex;
  65 }
  66
  67 AtkObject *
  68 spi_dbus_get_object (const char *path)
  69 {
  70   guint index;
  71   void *data;
  72
  73   g_assert (path);
  74   if (strncmp(path, "/org/freedesktop/atspi/accessible", 33) != 0) return NULL;
  75   path += 33;   /* skip over preamble */
  76   if (path[0] == '\0') return atk_get_root();
  77   if (path[0] != '/') return NULL;
  78   path++;
  79   index = atoi (path);
  80   data = g_hash_table_lookup (path2ptr, &index);
  81   if (data)
  82     return ATK_OBJECT (data);
  83   return NULL;
  84 }
  85
  86 gchar *
  87 spi_dbus_get_path (AtkObject * obj)
  88 {
  89   if (!obj) return NULL;
  90   guint index = (guint) g_object_get_data (G_OBJECT (obj), "dbus-id");
  91   if (!index)
  92     index = register_object (obj);
  93   return g_strdup_printf ("/org/freedesktop/atspi/accessible/%d", index);
  94 }
  95
  96 DBusMessage *
  97 spi_dbus_general_error (DBusMessage * message)
  98 {
  99   return dbus_message_new_error (message,
 100                                  "org.freedesktop.atspi.GeneralError",
 101                                  "General error");
 102 }
 103
 104 /* Reply with the given object and dereference it if unref is TRUE */
 105 DBusMessage *
 106 spi_dbus_return_object (DBusMessage * message, AtkObject * obj, int unref)
 107 {
 108   DBusMessage *reply;
 109   const char *path = spi_dbus_get_path (obj);
 110   if (unref)
 111     g_object_unref (obj);
 112   if (!path)
 113     {
 114       /* Should we have a more specific error for this? */
 115       return spi_dbus_general_error (message);
 116     }
 117   reply = dbus_message_new_method_return (message);
 118   if (reply)
 119     {
 120       dbus_message_append_args (reply, DBUS_TYPE_OBJECT_PATH, path,
 121                                 DBUS_TYPE_INVALID);
 122     }
 123   return reply;
 124 }
 125
 126 DBusMessage *
 127 spi_dbus_return_rect (DBusMessage * message, gint ix, gint iy, gint iwidth,
 128                       gint iheight)
 129 {
 130   DBusMessage *reply;
 131   dbus_uint32_t x, y, width, height;
 132
 133   x = ix;
 134   y = iy;
 135   width = iwidth;
 136   height = iheight;
 137   reply = dbus_message_new_method_return (message);
 138   if (reply)
 139     {
 140       DBusMessageIter iter, sub;
 141       dbus_message_iter_init_append (reply, &iter);
 142       if (!dbus_message_iter_open_container
 143           (&iter, DBUS_TYPE_STRUCT, NULL, &sub))
 144         goto oom;
 145       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &x);
 146       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &y);
 147       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &width);
 148       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &height);
 149       if (!dbus_message_iter_close_container (&iter, &sub))
 150         goto oom;
 151     }
 152   return reply;
 153 oom:
 154   /* todo: return an error */
 155   return reply;
 156 }
 157
 158 dbus_bool_t
 159 spi_dbus_return_v_object (DBusMessageIter * iter, AtkObject * obj, int unref)
 160 {
 161   const char *path = spi_dbus_get_path (obj);
 162   if (unref)
 163     g_object_unref (obj);
 164   if (!path)
 165     return FALSE;
 166   return droute_return_v_object (iter, path);
 167 }
 168
 169
 170 void
 171 spi_dbus_initialize (DRouteData * data)
 172 {
 173   spi_initialize_accessible (data);
 174   spi_initialize_action(data);
 175   spi_initialize_component (data);
 176   spi_initialize_document (data);
 177   spi_initialize_editabletext (data);
 178   spi_initialize_hyperlink (data);
 179   spi_initialize_hypertext (data);
 180   spi_initialize_image (data);
 181   spi_initialize_selection (data);
 182   spi_initialize_table (data);
 183   spi_initialize_tree (data);
 184   spi_initialize_text (data);
 185   spi_initialize_value (data);
 186 }
 187
 188 static GString *
 189 spi_get_tree (AtkObject * obj, GString * str, DRouteData * data)
 190 {
 191   int role;
 192   const char *name;
 193   gchar *path;
 194   GSList *l;
 195   gint childcount;
 196   gint i;
 197
 198   if (!obj)
 199     return NULL;
 200   role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));;
 201   name = atk_object_get_name (obj);
 202   if (!name)
 203     name = "";
 204   path = spi_dbus_get_path (obj);
 205   g_string_append_printf (str,
 206                           "<object path=\"%s\" name=\"%s\" role=\"%d\">\n",
 207                           path, name, role);
 208   for (l = data->interfaces; l; l = g_slist_next (l))
 209     {
 210       DRouteInterface *iface_def = (DRouteInterface *) l->data;
 211       void *datum = NULL;
 212       if (iface_def->get_datum)
 213         datum = (*iface_def->get_datum) (path, data->user_data);
 214       if (datum)
 215         {
 216           g_string_append_printf (str, "<interface name=\"%s\"/>\n",
 217                                   iface_def->name);
 218           if (iface_def->free_datum)
 219             (*iface_def->free_datum) (datum);
 220         }
 221     }
 222   childcount = atk_object_get_n_accessible_children (obj);
 223   for (i = 0; i < childcount; i++)
 224     {
 225       AtkObject *child = atk_object_ref_accessible_child (obj, i);
 226       str = spi_get_tree (child, str, data);
 227       g_object_unref (child);
 228     }
 229   str = g_string_append (str, "</object>\n");
 230   return str;
 231 }