atspi/atspi-accessible.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  * Copyright 2010, 2011 Novell, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #include "atspi-private.h"
  26 #include <string.h>
  27
  28 static void
  29 atspi_action_interface_init (AtspiAction *action)
  30 {
  31 }
  32
  33 static void
  34 atspi_collection_interface_init (AtspiCollection *component)
  35 {
  36 }
  37
  38 static void
  39 atspi_component_interface_init (AtspiComponent *component)
  40 {
  41 }
  42
  43 static void
  44 atspi_document_interface_init (AtspiDocument *document)
  45 {
  46 }
  47
  48 static void
  49 atspi_editable_text_interface_init (AtspiEditableText *editable_text)
  50 {
  51 }
  52
  53 static void
  54 atspi_hypertext_interface_init (AtspiHypertext *hypertext)
  55 {
  56 }
  57
  58 static void
  59 atspi_image_interface_init (AtspiImage *image)
  60 {
  61 }
  62
  63 static void
  64 atspi_selection_interface_init (AtspiSelection *selection)
  65 {
  66 }
  67
  68 static void
  69 atspi_table_interface_init (AtspiTable *table)
  70 {
  71 }
  72
  73 static void
  74 atspi_text_interface_init (AtspiText *text)
  75 {
  76 }
  77
  78 static void
  79 atspi_value_interface_init (AtspiValue *value)
  80 {
  81 }
  82
  83 G_DEFINE_TYPE_WITH_CODE (AtspiAccessible, atspi_accessible, ATSPI_TYPE_OBJECT,
  84                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_ACTION, atspi_action_interface_init)
  85                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COLLECTION, atspi_collection_interface_init)
  86                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COMPONENT, atspi_component_interface_init)
  87                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_DOCUMENT, atspi_document_interface_init)
  88                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_EDITABLE_TEXT, atspi_editable_text_interface_init)
  89                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_HYPERTEXT, atspi_hypertext_interface_init)
  90                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_IMAGE, atspi_image_interface_init)
  91                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_SELECTION, atspi_selection_interface_init)
  92                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE, atspi_table_interface_init)
  93                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TEXT, atspi_text_interface_init)
  94                          G_IMPLEMENT_INTERFACE (ATSPI_TYPE_VALUE, atspi_value_interface_init))
  95
  96 #ifdef DEBUG_REF_COUNTS
  97 static gint accessible_count = 0;
  98 #endif
  99
 100 static void
 101 atspi_accessible_init (AtspiAccessible *accessible)
 102 {
 103 #ifdef DEBUG_REF_COUNTS
 104   accessible_count++;
 105   printf("at-spi: init: %d objects\n", accessible_count);
 106 #endif
 107 }
 108
 109 static void
 110 atspi_accessible_dispose (GObject *object)
 111 {
 112   AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
 113   AtspiEvent e;
 114   AtspiAccessible *parent;
 115
 116   /* TODO: Only fire if object not already marked defunct */
 117   memset (&e, 0, sizeof (e));
 118   e.type = "object:state-change:defunct";
 119   e.source = accessible;
 120   e.detail1 = 1;
 121   e.detail2 = 0;
 122   _atspi_send_event (&e);
 123
 124   if (accessible->states)
 125   {
 126     g_object_unref (accessible->states);
 127     accessible->states = NULL;
 128   }
 129
 130   parent = accessible->accessible_parent;
 131   if (parent && parent->children)
 132   {
 133     GList*ls = g_list_find (parent->children, accessible);
 134     if(ls)
 135     {
 136       gboolean replace = (ls == parent->children);
 137       ls = g_list_remove (ls, accessible);
 138       if (replace)
 139         parent->children = ls;
 140       g_object_unref (object);
 141     }
 142   }
 143
 144   if (parent)
 145   {
 146     g_object_unref (parent);
 147     accessible->accessible_parent = NULL;
 148   }
 149
 150   G_OBJECT_CLASS (atspi_accessible_parent_class) ->dispose (object);
 151 }
 152
 153 static void
 154 atspi_accessible_finalize (GObject *object)
 155 {
 156   AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
 157
 158     g_free (accessible->description);
 159     g_free (accessible->name);
 160
 161 #ifdef DEBUG_REF_COUNTS
 162   accessible_count--;
 163   printf("at-spi: finalize: %d objects\n", accessible_count);
 164 #endif
 165
 166   G_OBJECT_CLASS (atspi_accessible_parent_class)
 167     ->finalize (object);
 168 }
 169
 170 static void
 171 atspi_accessible_class_init (AtspiAccessibleClass *klass)
 172 {
 173   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 174
 175   object_class->dispose = atspi_accessible_dispose;
 176   object_class->finalize = atspi_accessible_finalize;
 177 }
 178
 179 /* TODO: Generate following from spec? */
 180 static const char *role_names [] =
 181 {
 182   "invalid",
 183   "accel-label",
 184   "alert",
 185   "animation",
 186   "arrow",
 187   "calendar",
 188   "canvas",
 189   "check-box",
 190   "check-menu-item",
 191   "color-chooser",
 192   "column-header",
 193   "combo-box",
 194   "date-editor",
 195   "desktop-icon",
 196   "desktop-frame",
 197   "dial",
 198   "dialog",
 199   "directory-pane",
 200   "drawing-area",
 201   "file-chooser",
 202   "filler",
 203   "font-chooser",
 204   "frame",
 205   "glass-pane",
 206   "html-container",
 207   "icon",
 208   "image",
 209   "internalframe",
 210   "label",
 211   "layered-pane",
 212   "list",
 213   "list-item",
 214   "menu",
 215   "menu-bar",
 216   "menu-item",
 217   "option-pane",
 218   "page-tab",
 219   "page-tab-list",
 220   "panel",
 221   "password-text",
 222   "popup-menu",
 223   "progress-bar",
 224   "push-button",
 225   "radio-button",
 226   "radio-menu-item",
 227   "root-pane",
 228   "row-header",
 229   "scroll-bar",
 230   "scroll-pane",
 231   "separator",
 232   "slider",
 233   "spin-button",
 234   "split-pane",
 235   "statusbar",
 236   "table",
 237   "table-cell",
 238   "table-column-header",
 239   "table-row-header",
 240   "tear-off-menu-item",
 241   "terminal",
 242   "text",
 243   "toggle-button",
 244   "tool-bar",
 245   "tool-tip",
 246   "tree",
 247   "tree-table",
 248   "unknown",
 249   "viewport",
 250   "window",
 251   NULL,
 252   "header",
 253   "fooler",
 254   "paragraph",
 255   "ruler",
 256   "application",
 257   "autocomplete",
 258   "editbar",
 259   "embedded",
 260   "entry",
 261   "chart",
 262   "caption",
 263   "document_frame",
 264   "heading",
 265   "page",
 266   "section",
 267   "form",
 268   "redundant object",
 269   "link",
 270   "input method window"
 271 };
 272
 273 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
 274
 275 /**
 276  * atspi_role_get_name
 277  * @role: an #AtspiAccessibleRole object to query.
 278  *
 279  * Get a localizeable string that indicates the name of an #AtspiAccessibleRole.
 280  * <em>DEPRECATED.</em>
 281  *
 282  * Returns: a localizable string name for an #AtspiAccessibleRole enumerated type.
 283  **/
 284 gchar *
 285 atspi_role_get_name (AtspiRole role)
 286 {
 287   if (role < MAX_ROLES && role_names [(int) role])
 288     {
 289       return g_strdup (role_names [(int) role]);
 290     }
 291   else
 292     {
 293       return g_strdup ("");
 294     }
 295 }
 296
 297 /**
 298  * atspi_accessible_get_name:
 299  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 300  *
 301  * Get the name of an #AtspiAccessible object.
 302  *
 303  * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object.
 304  * or NULL on exception
 305  **/
 306 gchar *
 307 atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
 308 {
 309   g_return_val_if_fail (obj != NULL, g_strdup (""));
 310   if (!(obj->cached_properties & ATSPI_CACHE_NAME))
 311   {
 312     if (!_atspi_dbus_get_property (obj, atspi_interface_accessible, "Name", error,
 313                                    "s", &obj->name))
 314       return g_strdup ("");
 315     _atspi_accessible_add_cache (obj, ATSPI_CACHE_NAME);
 316   }
 317   return g_strdup (obj->name);
 318 }
 319
 320 /**
 321  * atspi_accessible_get_description:
 322  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 323  *
 324  * Get the description of an #AtspiAccessible object.
 325  *
 326  * Returns: a UTF-8 string describing the #AtspiAccessible object.
 327  * or NULL on exception
 328  **/
 329 gchar *
 330 atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
 331 {
 332   g_return_val_if_fail (obj != NULL, g_strdup (""));
 333
 334   if (!(obj->cached_properties & ATSPI_CACHE_DESCRIPTION))
 335   {
 336     if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
 337                                    "Description", error, "s",
 338                                    &obj->description))
 339       return g_strdup ("");
 340     _atspi_accessible_add_cache (obj, ATSPI_CACHE_DESCRIPTION);
 341   }
 342   return g_strdup (obj->description);
 343 }
 344
 345 const char *str_parent = "Parent";
 346
 347 /**
 348  * atspi_accessible_get_parent:
 349  * @obj: a pointer to the #AtspiAccessible object to query.
 350  *
 351  * Get an #AtspiAccessible object's parent container.
 352  *
 353  * Returns: (transfer full): a pointer to the #AtspiAccessible object which
 354  *          contains the given #AtspiAccessible instance, or NULL if the @obj
 355  *          has no parent container.
 356  *
 357  **/
 358 AtspiAccessible *
 359 atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)
 360 {
 361   g_return_val_if_fail (obj != NULL, NULL);
 362
 363   if (obj->parent.app && !(obj->cached_properties & ATSPI_CACHE_PARENT))
 364   {
 365     DBusMessage *message, *reply;
 366     DBusMessageIter iter, iter_variant;
 367     message = dbus_message_new_method_call (obj->parent.app->bus_name,
 368                                             obj->parent.path,
 369                                             DBUS_INTERFACE_PROPERTIES, "Get");
 370     if (!message)
 371       return NULL;
 372     dbus_message_append_args (message, DBUS_TYPE_STRING, &atspi_interface_accessible,
 373                                DBUS_TYPE_STRING, &str_parent,
 374                               DBUS_TYPE_INVALID);
 375     reply = _atspi_dbus_send_with_reply_and_block (message, error);
 376     if (!reply)
 377       return NULL;
 378     if (strcmp (dbus_message_get_signature (reply), "v") != 0)
 379     {
 380       dbus_message_unref (reply);
 381       return NULL;
 382     }
 383     dbus_message_iter_init (reply, &iter);
 384     dbus_message_iter_recurse (&iter, &iter_variant);
 385     obj->accessible_parent = _atspi_dbus_return_accessible_from_iter (&iter_variant);
 386     dbus_message_unref (reply);
 387     _atspi_accessible_add_cache (obj, ATSPI_CACHE_PARENT);
 388   }
 389   if (!obj->accessible_parent)
 390     return NULL;
 391   return g_object_ref (obj->accessible_parent);
 392 }
 393
 394 /**
 395  * atspi_accessible_get_child_count:
 396  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 397  *
 398  * Get the number of children contained by an #AtspiAccessible object.
 399  *
 400  * Returns: a #long indicating the number of #AtspiAccessible children
 401  *          contained by an #AtspiAccessible object. or -1 on exception
 402  *
 403  **/
 404 gint
 405 atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)
 406 {
 407   g_return_val_if_fail (obj != NULL, -1);
 408
 409   if (!(obj->cached_properties & ATSPI_CACHE_CHILDREN))
 410   {
 411     dbus_int32_t ret;
 412     if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
 413                                    "ChildCount", error, "i", &ret))
 414       return -1;
 415     return ret;
 416   }
 417
 418   return g_list_length (obj->children);
 419 }
 420
 421 /**
 422  * atspi_accessible_get_child_at_index:
 423  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 424  * @child_index: a #long indicating which child is specified.
 425  *
 426  * Get the #AtspiAccessible child of an #AtspiAccessible object at a given index.
 427  *
 428  * Returns: (transfer full): a pointer to the #AtspiAccessible child object at
 429  * index @child_index. or NULL on exception
 430  **/
 431 AtspiAccessible *
 432 atspi_accessible_get_child_at_index (AtspiAccessible *obj,
 433                             gint    child_index,
 434                             GError **error)
 435 {
 436   AtspiAccessible *child;
 437
 438   g_return_val_if_fail (obj != NULL, NULL);
 439
 440   if (!(obj->cached_properties & ATSPI_CACHE_CHILDREN))
 441   {
 442     DBusMessage *reply;
 443     reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
 444                                      "GetChildAtIndex", error, "i",
 445                                      child_index);
 446     return _atspi_dbus_return_accessible_from_message (reply);
 447   }
 448
 449   child = g_list_nth_data (obj->children, child_index);
 450   if (!child)
 451     return NULL;
 452   return g_object_ref (child);
 453 }
 454
 455 /**
 456  * atspi_accessible_get_index_in_parent
 457  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 458  *
 459  * Get the index of an #AtspiAccessible object in its containing #AtspiAccessible.
 460  *
 461  * Returns: a #glong indicating the index of the #AtspiAccessible object
 462  *          in its parent (i.e. containing) #AtspiAccessible instance,
 463  *          or -1 if @obj has no containing parent or on exception.
 464  **/
 465 gint
 466 atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error)
 467 {
 468   GList *l;
 469   gint i = 0;
 470
 471   g_return_val_if_fail (obj != NULL, -1);
 472   if (!obj->accessible_parent) return -1;
 473   if (!(obj->accessible_parent->cached_properties & ATSPI_CACHE_CHILDREN))
 474   {
 475     dbus_uint32_t ret = -1;
 476     _atspi_dbus_call (obj, atspi_interface_accessible,
 477                       "GetIndexInParent", NULL, "=>u", &ret);
 478     return ret;
 479   }
 480
 481   l = obj->accessible_parent->children;
 482   while (l)
 483   {
 484     if (l->data == obj) return i;
 485     l = g_list_next (l);
 486     i++;
 487   }
 488   return -1;
 489 }
 490
 491 typedef struct
 492 {
 493   dbus_uint32_t type;
 494   GArray *targets;
 495 } Accessibility_Relation;
 496
 497 /**
 498  * atspi_accessible_get_relation_set:
 499  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 500  *
 501  * Get the set of #AtspiRelation objects which describe this #AtspiAccessible object's
 502  *       relationships with other #AtspiAccessible objects.
 503  *
 504  * Returns: (element-type AtspiAccessible*) (transfer full): an array of
 505  *          #AtspiAccessibleRelation pointers. or NULL on exception
 506  **/
 507 GArray *
 508 atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
 509 {
 510   DBusMessage *reply;
 511   DBusMessageIter iter, iter_array;
 512   GArray *ret;
 513
 514   g_return_val_if_fail (obj != NULL, NULL);
 515
 516   reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetRelationSet", error, "");
 517   if (!reply)
 518     return NULL;
 519   _ATSPI_DBUS_CHECK_SIG (reply, "a(ua(so))", error, NULL);
 520
 521   ret = g_array_new (TRUE, TRUE, sizeof (AtspiRelation *));
 522   dbus_message_iter_init (reply, &iter);
 523   dbus_message_iter_recurse (&iter, &iter_array);
 524   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 525   {
 526     GArray *new_array;
 527     AtspiRelation *relation;
 528     relation = _atspi_relation_new_from_iter (&iter_array);
 529     new_array = g_array_append_val (ret, relation);
 530     if (new_array)
 531       ret = new_array;
 532     dbus_message_iter_next (&iter_array);
 533   }
 534   dbus_message_unref (reply);
 535   return ret;
 536 }
 537
 538 /**
 539  * atspi_accessible_get_role:
 540  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 541  *
 542  * Get the UI role of an #AtspiAccessible object.
 543  * A UTF-8 string describing this role can be obtained via atspi_accessible_getRoleName ().
 544  *
 545  * Returns: the #AtspiRole of the object.
 546  *
 547  **/
 548 AtspiRole
 549 atspi_accessible_get_role (AtspiAccessible *obj, GError **error)
 550 {
 551   g_return_val_if_fail (obj != NULL, ATSPI_ROLE_INVALID);
 552
 553   if (!(obj->cached_properties & ATSPI_CACHE_ROLE))
 554   {
 555     dbus_uint32_t role;
 556     /* TODO: Make this a property */
 557     if (_atspi_dbus_call (obj, atspi_interface_accessible, "GetRole", error, "=>u", &role))
 558     {
 559       obj->role = role;
 560     _atspi_accessible_add_cache (obj, ATSPI_CACHE_ROLE);
 561     }
 562   }
 563   return obj->role;
 564 }
 565
 566 /**
 567  * atspi_accessible_get_role_name:
 568  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 569  *
 570  * Get a UTF-8 string describing the role this object plays in the UI.
 571  * This method will return useful values for roles that fall outside the
 572  * enumeration used in atspi_accessible_getRole ().
 573  *
 574  * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
 575  *
 576  **/
 577 gchar *
 578 atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)
 579 {
 580   char *retval = NULL;
 581
 582   g_return_val_if_fail (obj != NULL, NULL);
 583
 584   _atspi_dbus_call (obj, atspi_interface_accessible, "GetRoleName", error, "=>s", &retval);
 585
 586   if (!retval)
 587     retval = g_strdup ("");
 588
 589   return retval;
 590 }
 591
 592 /**
 593  * atspi_accessible_get_localized_role_name:
 594  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 595  *
 596  * Get a UTF-8 string describing the (localized) role this object plays in the UI.
 597  * This method will return useful values for roles that fall outside the
 598  * enumeration used in atspi_accessible_getRole ().
 599  *
 600  * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
 601  *
 602  **/
 603 gchar *
 604 atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)
 605 {
 606   char *retval = NULL;
 607
 608   g_return_val_if_fail (obj != NULL, NULL);
 609
 610   _atspi_dbus_call (obj, atspi_interface_accessible, "GetLocalizedRoleName", error, "=>s", &retval);
 611
 612   if (!retval)
 613     return g_strdup ("");
 614
 615   return retval;
 616 }
 617
 618 static AtspiStateSet *
 619 defunct_set ()
 620 {
 621   AtspiStateSet *set = atspi_state_set_new (NULL);
 622   atspi_state_set_add (set, ATSPI_STATE_DEFUNCT);
 623   return set;
 624 }
 625
 626 /**
 627  * atspi_accessible_get_state_set:
 628  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 629  *
 630  * Gets the current state of an object.
 631  *
 632  * Returns: (transfer full): a pointer to an #AtspiStateSet representing the
 633  *          object's current state.
 634  **/
 635 AtspiStateSet *
 636 atspi_accessible_get_state_set (AtspiAccessible *obj)
 637 {
 638   if (!obj->parent.app || !obj->parent.app->bus)
 639     return defunct_set ();
 640
 641
 642   if (!(obj->cached_properties & ATSPI_CACHE_STATES))
 643   {
 644     DBusMessage *reply;
 645     DBusMessageIter iter;
 646     reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
 647                                       "GetState", NULL, "");
 648     _ATSPI_DBUS_CHECK_SIG (reply, "au", NULL, defunct_set ());
 649     dbus_message_iter_init (reply, &iter);
 650     _atspi_dbus_set_state (obj, &iter);
 651     dbus_message_unref (reply);
 652     _atspi_accessible_add_cache (obj, ATSPI_CACHE_STATES);
 653   }
 654
 655   return g_object_ref (obj->states);
 656 }
 657
 658 /**
 659  * atspi_accessible_get_attributes:
 660  * @obj: The #AtspiAccessible being queried.
 661  *
 662  * Get the #AttributeSet representing any assigned
 663  * name-value pair attributes or annotations for this object.
 664  * For typographic, textual, or textually-semantic attributes, see
 665  * atspi_text_get_attributes instead.
 666  *
 667  * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair
 668  *          attributes assigned to this object.
 669  */
 670 GHashTable *
 671 atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)
 672 {
 673   DBusMessage *message;
 674
 675     g_return_val_if_fail (obj != NULL, NULL);
 676
 677   message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
 678   return _atspi_dbus_return_hash_from_message (message);
 679 }
 680
 681 /**
 682  * atspi_accessible_get_attributes_as_array:
 683  * @obj: The #AtspiAccessible being queried.
 684  *
 685  * Get the #AttributeSet representing any assigned
 686  * name-value pair attributes or annotations for this object.
 687  * For typographic, textual, or textually-semantic attributes, see
 688  * atspi_text_get_attributes_as_array instead.
 689  *
 690  * Returns: (element-type gchar*) (transfer full): The name-value-pair
 691  *          attributes assigned to this object.
 692  */
 693 GArray *
 694 atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)
 695 {
 696   DBusMessage *message;
 697
 698     g_return_val_if_fail (obj != NULL, NULL);
 699
 700   message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
 701   return _atspi_dbus_return_attribute_array_from_message (message);
 702 }
 703
 704 /**
 705  * atspi_accessible_get_application:
 706  * @obj: The #AtspiAccessible being queried.
 707  *
 708  * Get the containing #AtspiApplication for an object.
 709  *
 710  * Returns: (transfer full): the containing AtspiApplication instance for
 711  *          this object.
 712  */
 713 AtspiAccessible *
 714 atspi_accessible_get_application (AtspiAccessible *obj, GError **error)
 715 {
 716   AtspiAccessible *parent;
 717
 718   g_object_ref (obj);
 719   for (;;)
 720   {
 721     parent = atspi_accessible_get_parent (obj, NULL);
 722     if (!parent && obj->parent.app &&
 723         atspi_accessible_get_role (obj, NULL) != ATSPI_ROLE_APPLICATION)
 724     {
 725       AtspiAccessible *root = g_object_ref (obj->parent.app->root);
 726       if (root)
 727       {
 728         g_object_unref (obj);
 729         return root;
 730       }
 731     }
 732     if (!parent || parent == obj ||
 733         atspi_accessible_get_role (parent, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
 734     return obj;
 735     g_object_unref (obj);
 736     obj = parent;
 737   }
 738 }
 739
 740 /* Application-specific methods */
 741
 742 /**
 743  * atspi_accessible_get_toolkit_name:
 744  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 745  *
 746  * Get the toolkit for a #AtspiAccessible object.
 747  * Only works on application root objects.
 748  *
 749  * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object.
 750  * or NULL on exception
 751  **/
 752 gchar *
 753 atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
 754 {
 755   gchar *ret = NULL;
 756
 757   g_return_val_if_fail (obj != NULL, NULL);
 758
 759   if (!_atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitName", error, "s", &ret))
 760       return NULL;
 761   return g_strdup (ret);
 762 }
 763
 764 /**
 765  * atspi_accessible_get_toolkit_version:
 766  * @obj: a pointer to the #AtspiAccessible object on which to operate.
 767  *
 768  * Get the toolkit version for a #AtspiAccessible object.
 769  * Only works on application root objects.
 770  *
 771  * Returns: a UTF-8 string indicating the toolkit ersion for the #AtspiAccessible object.
 772  * or NULL on exception
 773  **/
 774 gchar *
 775 atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
 776 {
 777   gchar *ret = NULL;
 778
 779   g_return_val_if_fail (obj != NULL, NULL);
 780
 781   if (!_atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitVersion", error, "s", &ret))
 782       return NULL;
 783   return g_strdup (ret);
 784 }
 785 /* Interface query methods */
 786
 787 static gboolean
 788 _atspi_accessible_is_a (AtspiAccessible *accessible,
 789                       const char *interface_name)
 790 {
 791   int n;
 792
 793   if (accessible == NULL)
 794     {
 795       return FALSE;
 796     }
 797
 798   if (!(accessible->cached_properties & ATSPI_CACHE_INTERFACES))
 799   {
 800     DBusMessage *reply;
 801     DBusMessageIter iter;
 802     reply = _atspi_dbus_call_partial (accessible, atspi_interface_accessible,
 803                                       "GetInterfaces", NULL, "");
 804     _ATSPI_DBUS_CHECK_SIG (reply, "as", NULL, FALSE);
 805     dbus_message_iter_init (reply, &iter);
 806     _atspi_dbus_set_interfaces (accessible, &iter);
 807     dbus_message_unref (reply);
 808     _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
 809   }
 810
 811   n = _atspi_get_iface_num (interface_name);
 812   if (n == -1) return FALSE;
 813   return (gboolean) ((accessible->interfaces & (1 << n))? TRUE: FALSE);
 814 }
 815
 816 /**
 817  * atspi_accessible_is_action:
 818  * @obj: a pointer to the #AtspiAccessible instance to query.
 819  *
 820  * Query whether the specified #AtspiAccessible implements #AtspiAction.
 821  *
 822  * Returns: #TRUE if @obj implements the #AtspiAction interface,
 823  *          #FALSE otherwise.
 824  **/
 825 gboolean
 826 atspi_accessible_is_action (AtspiAccessible *obj)
 827 {
 828   return _atspi_accessible_is_a (obj,
 829                               atspi_interface_action);
 830 }
 831
 832 /**
 833  * atspi_accessible_is_application:
 834  * @obj: a pointer to the #AtspiAccessible instance to query.
 835  *
 836  * Query whether the specified #AtspiAccessible implements #AtspiApplication.
 837  *
 838  * Returns: #TRUE if @obj implements the #AtspiApplication interface,
 839  *          #FALSE otherwise.
 840  **/
 841 gboolean
 842 atspi_accessible_is_application (AtspiAccessible *obj)
 843 {
 844   return _atspi_accessible_is_a (obj,
 845                               atspi_interface_application);
 846 }
 847
 848 /**
 849  * atspi_accessible_is_collection:                                                                                                                                                                          * @obj: a pointer to the #AtspiAccessible instance to query.
 850  *
 851  * Query whether the specified #AtspiAccessible implements #AtspiCollection.
 852  * Returns: #TRUE if @obj implements the #AtspiCollection interface,
 853  *          #FALSE otherwise.
 854  **/
 855 gboolean
 856 atspi_accessible_is_collection (AtspiAccessible *obj)
 857 {
 858      return _atspi_accessible_is_a (obj,
 859                               atspi_interface_collection);
 860 }
 861
 862 /**
 863  * atspi_accessible_is_component:
 864  * @obj: a pointer to the #AtspiAccessible instance to query.
 865  *
 866  * Query whether the specified #AtspiAccessible implements #AtspiComponent.
 867  *
 868  * Returns: #TRUE if @obj implements the #AtspiComponent interface,
 869  *          #FALSE otherwise.
 870  **/
 871 gboolean
 872 atspi_accessible_is_component (AtspiAccessible *obj)
 873 {
 874   return _atspi_accessible_is_a (obj,
 875                               atspi_interface_component);
 876 }
 877
 878 /**
 879  * atspi_accessible_is_document:
 880  * @obj: a pointer to the #AtspiAccessible instance to query.
 881  *
 882  * Query whether the specified #AtspiAccessible implements #AtspiDocument.
 883  *
 884  * Returns: #TRUE if @obj implements the #AtspiDocument interface,
 885  *          #FALSE otherwise.
 886  **/
 887 gboolean
 888 atspi_accessible_is_document (AtspiAccessible *obj)
 889 {
 890   return _atspi_accessible_is_a (obj,
 891                               atspi_interface_document);
 892 }
 893
 894 /**
 895  * atspi_accessible_is_editable_text:
 896  * @obj: a pointer to the #AtspiAccessible instance to query.
 897  *
 898  * Query whether the specified #AtspiAccessible implements #AtspiEditableText.
 899  *
 900  * Returns: #TRUE if @obj implements the #AtspiEditableText interface,
 901  *          #FALSE otherwise.
 902  **/
 903 gboolean
 904 atspi_accessible_is_editable_text (AtspiAccessible *obj)
 905 {
 906   return _atspi_accessible_is_a (obj,
 907                               atspi_interface_editable_text);
 908 }
 909
 910 /**
 911  * atspi_accessible_is_hypertext:
 912  * @obj: a pointer to the #AtspiAccessible instance to query.
 913  *
 914  * Query whether the specified #AtspiAccessible implements #AtspiHypertext.
 915  *
 916  * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
 917  *          #FALSE otherwise.
 918  **/
 919 gboolean
 920 atspi_accessible_is_hypertext (AtspiAccessible *obj)
 921 {
 922   return _atspi_accessible_is_a (obj,
 923                               atspi_interface_hypertext);
 924 }
 925
 926 /**
 927  * atspi_accessible_is_hyperlink:
 928  * @obj: a pointer to the #AtspiAccessible instance to query.
 929  *
 930  * Query whether the specified #AtspiAccessible implements #AtspiHyperlink.
 931  *
 932  * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
 933  *          #FALSE otherwise.
 934  **/
 935 gboolean
 936 atspi_accessible_is_hyperlink (AtspiAccessible *obj)
 937 {
 938   return _atspi_accessible_is_a (obj,
 939                               atspi_interface_hyperlink);
 940 }
 941
 942 /**
 943  * atspi_accessible_is_image:
 944  * @obj: a pointer to the #AtspiAccessible instance to query.
 945  *
 946  * Query whether the specified #AtspiAccessible implements #AtspiImage.
 947  *
 948  * Returns: #TRUE if @obj implements the #AtspiImage interface,
 949  *          #FALSE otherwise.
 950 **/
 951 gboolean
 952 atspi_accessible_is_image (AtspiAccessible *obj)
 953 {
 954   return _atspi_accessible_is_a (obj,
 955                               atspi_interface_image);
 956 }
 957
 958 /**
 959  * atspi_accessible_is_selection:
 960  * @obj: a pointer to the #AtspiAccessible instance to query.
 961  *
 962  * Query whether the specified #AtspiAccessible implements #AtspiSelection.
 963  *
 964  * Returns: #TRUE if @obj implements the #AtspiSelection interface,
 965  *          #FALSE otherwise.
 966 **/
 967 gboolean
 968 atspi_accessible_is_selection (AtspiAccessible *obj)
 969 {
 970   return _atspi_accessible_is_a (obj,
 971                               atspi_interface_selection);
 972 }
 973
 974 /**
 975  * atspi_accessible_is_table:
 976  * @obj: a pointer to the #AtspiAccessible instance to query.
 977  *
 978  * Query whether the specified #AtspiAccessible implements #AtspiTable.
 979  *
 980  * Returns: #TRUE if @obj implements the #AtspiTable interface,
 981  *          #FALSE otherwise.
 982 **/
 983 gboolean
 984 atspi_accessible_is_table (AtspiAccessible *obj)
 985 {
 986   return _atspi_accessible_is_a (obj,
 987                               atspi_interface_table);
 988 }
 989
 990 /**
 991  * atspi_accessible_is_streamable_content:
 992  * @obj: a pointer to the #AtspiAccessible instance to query.
 993  *
 994  * Query whether the specified #AtspiAccessible implements
 995  *          #AtspiStreamableContent.
 996  *
 997  * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,
 998  *          #FALSE otherwise.
 999 **/
1000 gboolean
1001 atspi_accessible_is_streamable_content (AtspiAccessible *obj)
1002 {
1003 #if 0
1004   return _atspi_accessible_is_a (obj,
1005                               atspi_interface_streamable_content);
1006 #else
1007   g_warning (_("Streamable content not implemented"));
1008   return FALSE;
1009 #endif
1010 }
1011
1012 /**
1013  * atspi_accessible_is_text:
1014  * @obj: a pointer to the #AtspiAccessible instance to query.
1015  *
1016  * Query whether the specified #AtspiAccessible implements #AtspiText.
1017  *
1018  * Returns: #TRUE if @obj implements the #AtspiText interface,
1019  *          #FALSE otherwise.
1020 **/
1021 gboolean
1022 atspi_accessible_is_text (AtspiAccessible *obj)
1023 {
1024   return _atspi_accessible_is_a (obj,
1025                               atspi_interface_text);
1026 }
1027
1028 /**
1029  * atspi_accessible_is_value:
1030  * @obj: a pointer to the #AtspiAccessible instance to query.
1031  *
1032  * Query whether the specified #AtspiAccessible implements #AtspiValue.
1033  *
1034  * Returns: #TRUE if @obj implements the #AtspiValue interface,
1035  *          #FALSE otherwise.
1036 **/
1037 gboolean
1038 atspi_accessible_is_value (AtspiAccessible *obj)
1039 {
1040   return _atspi_accessible_is_a (obj,
1041                               atspi_interface_value);
1042 }
1043
1044 /**
1045  * atspi_accessible_get_action:
1046  * @obj: a pointer to the #AtspiAccessible instance to query.
1047  *
1048  * Get the #AtspiAction interface for an #AtspiAccessible.
1049  *
1050  * Returns: (transfer full): a pointer to an #AtspiAction interface
1051  *          instance, or NULL if @obj does not implement #AtspiAction.
1052  **/
1053 AtspiAction *
1054 atspi_accessible_get_action (AtspiAccessible *accessible)
1055 {
1056   return (_atspi_accessible_is_a (accessible, atspi_interface_action) ?
1057           g_object_ref (ATSPI_ACTION (accessible)) : NULL);
1058 }
1059
1060 /**
1061  * atspi_accessible_get_collection:
1062  * @obj: a pointer to the #AtspiAccessible instance to query.
1063  *
1064  * Get the #AtspiCollection interface for an #AtspiAccessible.
1065  *
1066  * Returns: (transfer full): a pointer to an #AtspiCollection interface
1067  *          instance, or NULL if @obj does not implement #AtspiCollection.
1068  **/
1069 AtspiCollection *
1070 atspi_accessible_get_collection (AtspiAccessible *accessible)
1071 {
1072   return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ?
1073           g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);
1074 }
1075
1076 /**
1077  * atspi_accessible_get_component:
1078  * @obj: a pointer to the #AtspiAccessible instance to query.
1079  *
1080  * Get the #AtspiComponent interface for an #AtspiAccessible.
1081  *
1082  * Returns: (transfer full): a pointer to an #AtspiComponent interface
1083  *          instance, or NULL if @obj does not implement #AtspiComponent.
1084  **/
1085 AtspiComponent *
1086 atspi_accessible_get_component (AtspiAccessible *obj)
1087 {
1088   return (_atspi_accessible_is_a (obj, atspi_interface_component) ?
1089           g_object_ref (ATSPI_COMPONENT (obj)) : NULL);
1090 }
1091
1092 /**
1093  * atspi_accessible_get_document:
1094  * @obj: a pointer to the #AtspiAccessible instance to query.
1095  *
1096  * Get the #AtspiDocument interface for an #AtspiAccessible.
1097  *
1098  * Returns: (transfer full): a pointer to an #AtspiDocument interface
1099  *          instance, or NULL if @obj does not implement #AtspiDocument.
1100  **/
1101 AtspiDocument *
1102 atspi_accessible_get_document (AtspiAccessible *accessible)
1103 {
1104   return (_atspi_accessible_is_a (accessible, atspi_interface_document) ?
1105           g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);
1106 }
1107
1108 /**
1109  * atspi_accessible_get_editable_text:
1110  * @obj: a pointer to the #AtspiAccessible instance to query.
1111  *
1112  * Get the #AtspiEditableText interface for an #AtspiAccessible.
1113  *
1114  * Returns: (transfer full): a pointer to an #AtspiEditableText interface
1115  *          instance, or NULL if @obj does not implement #AtspiEditableText.
1116  **/
1117 AtspiEditableText *
1118 atspi_accessible_get_editable_text (AtspiAccessible *accessible)
1119 {
1120   return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ?
1121           g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);
1122 }
1123
1124 /**
1125  * atspi_accessible_get_hyperlink:
1126  * @obj: a pointer to the #AtspiAccessible object on which to operate.
1127  *
1128  * Get the #AtspiHyperlink associated with the given #AtspiAccessible, if
1129  * supported.
1130  *
1131  * Returns: (transfer full): the #AtspiHyperlink object associated with
1132  *          the given #AtspiAccessible, or NULL if not supported.
1133  **/
1134 AtspiHyperlink *
1135 atspi_accessible_get_hyperlink (AtspiAccessible *accessible)
1136 {
1137   return (_atspi_accessible_is_a (accessible, atspi_interface_hyperlink) ?
1138           atspi_hyperlink_new (accessible->parent.app, accessible->parent.path) : NULL);
1139 }
1140
1141 /**
1142  * atspi_accessible_get_hypertext:
1143  * @obj: a pointer to the #AtspiAccessible instance to query.
1144  *
1145  * Get the #AtspiHypertext interface for an #AtspiAccessible.
1146  *
1147  * Returns: (transfer full): a pointer to an #AtspiHypertext interface
1148  *          instance, or NULL if @obj does not implement #AtspiHypertext.
1149  **/
1150 AtspiHypertext *
1151 atspi_accessible_get_hypertext (AtspiAccessible *accessible)
1152 {
1153   return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ?
1154           g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);
1155 }
1156
1157 /**
1158  * atspi_accessible_get_image:
1159  * @obj: a pointer to the #AtspiAccessible instance to query.
1160  *
1161  * Get the #AtspiImage interface for an #AtspiAccessible.
1162  *
1163  * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
1164  *          NULL if @obj does not implement #AtspiImage.
1165  **/
1166 AtspiImage *
1167 atspi_accessible_get_image (AtspiAccessible *accessible)
1168 {
1169   return (_atspi_accessible_is_a (accessible, atspi_interface_image) ?
1170           g_object_ref (ATSPI_IMAGE (accessible)) : NULL);
1171 }
1172
1173 /**
1174  * atspi_accessible_get_selection:
1175  * @obj: a pointer to the #AtspiAccessible instance to query.
1176  *
1177  * Get the #AtspiSelection interface for an #AtspiAccessible.
1178  *
1179  * Returns: (transfer full): a pointer to an #AtspiSelection interface
1180  *          instance, or NULL if @obj does not implement #AtspiSelection.
1181  **/
1182 AtspiSelection *
1183 atspi_accessible_get_selection (AtspiAccessible *accessible)
1184 {
1185   return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ?
1186           g_object_ref (ATSPI_SELECTION (accessible)) : NULL);
1187 }
1188
1189 #if 0
1190 /**
1191  * atspi_accessible_get_streamable_content:
1192  * @obj: a pointer to the #AtspiAccessible instance to query.
1193  *
1194  * Get the #AtspiStreamableContent interface for an #AtspiAccessible.
1195  *
1196  * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface
1197  *          instance, or NULL if @obj does not implement #AtspiStreamableContent.
1198  **/
1199 AtspiStreamableContent *
1200 atspi_accessible_get_streamable_content (AtspiAccessible *accessible)
1201 {
1202   return (_atspi_accessible_is_a (accessible, atspi_interface_streamable_content) ?
1203           accessible : NULL);
1204 }
1205 #endif
1206
1207 /**
1208  * atspi_accessible_get_table:
1209  * @obj: a pointer to the #AtspiAccessible instance to query.
1210  *
1211  * Get the #AtspiTable interface for an #AtspiAccessible.
1212  *
1213  * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
1214  *          NULL if @obj does not implement #AtspiTable.
1215  **/
1216 AtspiTable *
1217 atspi_accessible_get_table (AtspiAccessible *obj)
1218 {
1219   return (_atspi_accessible_is_a (obj, atspi_interface_table) ?
1220           g_object_ref (ATSPI_TABLE (obj)) : NULL);
1221 }
1222
1223 /**
1224  * atspi_accessible_get_text:
1225  * @obj: a pointer to the #AtspiAccessible instance to query.
1226  *
1227  * Get the #AtspiTable interface for an #AtspiAccessible.
1228  *
1229  * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
1230  *          NULL if @obj does not implement #AtspiText.
1231  **/
1232 AtspiText *
1233 atspi_accessible_get_text (AtspiAccessible *obj)
1234 {
1235   return (_atspi_accessible_is_a (obj, atspi_interface_text) ?
1236           g_object_ref (ATSPI_TEXT (obj)) : NULL);
1237 }
1238
1239 /**
1240  * atspi_accessible_get_value:
1241  * @obj: a pointer to the #AtspiAccessible instance to query.
1242  *
1243  * Get the #AtspiTable interface for an #AtspiAccessible.
1244  *
1245  * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
1246  *          NULL if @obj does not implement #AtspiValue.
1247  **/
1248 AtspiValue *
1249 atspi_accessible_get_value (AtspiAccessible *accessible)
1250 {
1251   return (_atspi_accessible_is_a (accessible, atspi_interface_value) ?
1252           g_object_ref (ATSPI_VALUE (accessible)) : NULL);
1253 }
1254
1255 static void
1256 append_const_val (GArray *array, const gchar *val)
1257 {
1258   gchar *dup = g_strdup (val);
1259
1260   if (dup)
1261     g_array_append_val (array, dup);
1262 }
1263
1264 /**
1265  * atspi_accessible_get_interfaces:
1266  *
1267  * #obj: The #AtspiAccessible to query.
1268  *
1269  * Returns: (element-type gchar*) (transfer full): A #GArray of strings
1270  *          describing the interfaces supported by the object.  Interfaces are
1271  *          denoted in short-hand (ie, "Component", "Text", etc.)
1272  **/
1273 GArray *
1274 atspi_accessible_get_interfaces (AtspiAccessible *obj)
1275 {
1276   GArray *ret = g_array_new (TRUE, TRUE, sizeof (gchar *));
1277
1278   if (!ret)
1279     return NULL;
1280
1281   g_return_val_if_fail (obj != NULL, NULL);
1282
1283   append_const_val (ret, "Accessible");
1284   if (atspi_accessible_is_action (obj))
1285     append_const_val (ret, "Action");
1286   if (atspi_accessible_is_collection (obj))
1287     append_const_val (ret, "Collection");
1288   if (atspi_accessible_is_component (obj))
1289     append_const_val (ret, "Component");
1290   if (atspi_accessible_is_document (obj))
1291     append_const_val (ret, "Document");
1292   if (atspi_accessible_is_editable_text (obj))
1293     append_const_val (ret, "EditableText");
1294   if (atspi_accessible_is_hypertext (obj))
1295     append_const_val (ret, "Hypertext");
1296   if (atspi_accessible_is_hyperlink (obj))
1297     append_const_val (ret, "Hyperlink");
1298   if (atspi_accessible_is_image (obj))
1299     append_const_val (ret, "Image");
1300   if (atspi_accessible_is_selection (obj))
1301     append_const_val (ret, "Selection");
1302   if (atspi_accessible_is_table (obj))
1303     append_const_val (ret, "Table");
1304   if (atspi_accessible_is_text (obj))
1305     append_const_val (ret, "Text");
1306   if (atspi_accessible_is_value (obj))
1307     append_const_val (ret, "Value");
1308
1309   return ret;
1310 }
1311
1312 AtspiAccessible *
1313 atspi_accessible_new (AtspiApplication *app, const gchar *path)
1314 {
1315   AtspiAccessible *accessible;
1316
1317   accessible = g_object_new (ATSPI_TYPE_ACCESSIBLE, NULL);
1318   g_return_val_if_fail (accessible != NULL, NULL);
1319
1320   accessible->parent.app = g_object_ref (app);
1321   accessible->parent.path = g_strdup (path);
1322
1323   return accessible;
1324 }
1325
1326 /**
1327  * atspi_accessible_set_cache_mask:
1328  *
1329  * @accessible: The #AtspiAccessible to operate on.  Must be the desktop or
1330  *             the root of an application.
1331  * @mask: An #AtspiCache specifying a bit mask of the types of data to cache.
1332  *
1333  * Sets the type of data to cache for accessibles.
1334  * If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED,
1335  * then the desktop's cache flag will be used.
1336  * If the desktop's cache flag is also undefined, then all possible data will
1337  * be cached.
1338  * This function is intended to work around bugs in toolkits where the proper
1339  * events are not raised / to aid in testing for such bugs.
1340  *
1341  * Note: This function has no effect on data that has already been cached.
1342  **/
1343 void
1344 atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask)
1345 {
1346   g_return_if_fail (accessible != NULL);
1347   g_return_if_fail (accessible->parent.app != NULL);
1348   g_return_if_fail (accessible == accessible->parent.app->root);
1349   accessible->parent.app->cache = mask;
1350 }
1351
1352 void
1353 _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag)
1354 {
1355   AtspiCache mask = accessible->parent.app->cache;
1356
1357   if (mask == ATSPI_CACHE_UNDEFINED &&
1358       accessible->parent.app->root &&
1359       accessible->parent.app->root->accessible_parent)
1360   {
1361     AtspiAccessible *desktop = atspi_get_desktop (0);
1362     mask = desktop->parent.app->cache;
1363     g_object_unref (desktop);
1364   }
1365
1366   if (mask == ATSPI_CACHE_UNDEFINED)
1367     mask = ATSPI_CACHE_ALL;
1368
1369   accessible->cached_properties |= flag & mask;
1370 }