atk-adaptor/adaptors/collection-adaptor.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2007 IBM Corp.
   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 /* collection.c: implements the Collection interface */
  24
  25 #include <string.h>
  26
  27 #include <atk/atk.h>
  28 #include <droute/droute.h>
  29
  30 #include "common/bitarray.h"
  31 #include "common/spi-dbus.h"
  32 #include "common/spi-stateset.h"
  33
  34 #include "accessible-register.h"
  35 #include "object.h"
  36 #include "introspection.h"
  37
  38 typedef struct _MatchRulePrivate MatchRulePrivate;
  39 struct _MatchRulePrivate
  40 {
  41   gint *states;
  42   Accessibility_Collection_MatchType statematchtype;
  43   AtkAttributeSet *attributes;
  44   Accessibility_Collection_MatchType attributematchtype;
  45   gint *roles;
  46   Accessibility_Collection_MatchType rolematchtype;
  47   gchar **ifaces;
  48   Accessibility_Collection_MatchType interfacematchtype;
  49   gboolean invert;
  50 };
  51
  52 static gboolean
  53 child_interface_p (AtkObject * child, gchar * repo_id)
  54 {
  55   if (!strcasecmp (repo_id, "action"))
  56     return ATK_IS_ACTION (child);
  57   if (!strcasecmp (repo_id, "component"))
  58     return ATK_IS_COMPONENT (child);
  59   if (!strcasecmp (repo_id, "editabletext"))
  60     return ATK_IS_EDITABLE_TEXT (child);
  61   if (!strcasecmp (repo_id, "text"))
  62     return ATK_IS_TEXT (child);
  63   if (!strcasecmp (repo_id, "hypertext"))
  64     return ATK_IS_HYPERTEXT (child);
  65   if (!strcasecmp (repo_id, "image"))
  66     return ATK_IS_IMAGE (child);
  67   if (!strcasecmp (repo_id, "selection"))
  68     return ATK_IS_SELECTION (child);
  69   if (!strcasecmp (repo_id, "table"))
  70     return ATK_IS_TABLE (child);
  71   if (!strcasecmp (repo_id, "value"))
  72     return ATK_IS_VALUE (child);
  73   if (!strcasecmp (repo_id, "streamablecontent"))
  74     return ATK_IS_STREAMABLE_CONTENT (child);
  75   if (!strcasecmp (repo_id, "document"))
  76     return ATK_IS_DOCUMENT (child);
  77   return FALSE;
  78 }
  79
  80 #define child_collection_p(ch) (TRUE)
  81
  82 static gboolean
  83 match_states_all_p (AtkObject * child, gint * set)
  84 {
  85   AtkStateSet *chs;
  86   gint i;
  87   gboolean ret = TRUE;
  88
  89   if (set == NULL || set[0] == BITARRAY_SEQ_TERM)
  90     return TRUE;
  91
  92   chs = atk_object_ref_state_set (child);
  93
  94   // TODO: use atk-state_set_contains_states; would be more efficient
  95   for (i = 0; set[i] != BITARRAY_SEQ_TERM; i++)
  96     {
  97       if (!atk_state_set_contains_state (chs, set[i]))
  98         {
  99           ret = FALSE;
 100           break;
 101         }
 102     }
 103
 104   g_object_unref (chs);
 105   return ret;
 106 }
 107
 108 static gboolean
 109 match_states_any_p (AtkObject * child, gint * set)
 110 {
 111   AtkStateSet *chs;
 112   gint i;
 113   gboolean ret = FALSE;
 114
 115   if (set == NULL || set[0] == BITARRAY_SEQ_TERM)
 116     return TRUE;
 117
 118   chs = atk_object_ref_state_set (child);
 119
 120   for (i = 0; set[i] != BITARRAY_SEQ_TERM; i++)
 121     {
 122       if (!atk_state_set_contains_state (chs, set[i]))
 123         {
 124           ret = TRUE;
 125           break;
 126         }
 127     }
 128
 129   g_object_unref (chs);
 130   return ret;
 131 }
 132
 133 static gboolean
 134 match_states_none_p (AtkObject * child, gint * set)
 135 {
 136   AtkStateSet *chs;
 137   gint i;
 138   gboolean ret = TRUE;
 139
 140   if (set == NULL || set[0] == BITARRAY_SEQ_TERM)
 141     return TRUE;
 142
 143   chs = atk_object_ref_state_set (child);
 144
 145   for (i = 0; set[i] != BITARRAY_SEQ_TERM; i++)
 146     {
 147       if (atk_state_set_contains_state (chs, set[i]))
 148         {
 149           ret = FALSE;
 150           break;
 151         }
 152     }
 153
 154   g_object_unref (chs);
 155   return ret;
 156 }
 157
 158 // TODO: need to convert at-spi roles/states to atk roles/states */
 159 static gboolean
 160 match_states_lookup (AtkObject * child, MatchRulePrivate * mrp)
 161 {
 162   switch (mrp->statematchtype)
 163     {
 164     case Accessibility_Collection_MATCH_ALL:
 165       if (match_states_all_p (child, mrp->states))
 166         return TRUE;
 167       break;
 168
 169     case Accessibility_Collection_MATCH_ANY:
 170       if (match_states_any_p (child, mrp->states))
 171         return TRUE;
 172       break;
 173
 174     case Accessibility_Collection_MATCH_NONE:
 175       if (match_states_none_p (child, mrp->states))
 176         return TRUE;
 177       break;
 178
 179     default:
 180       break;
 181     }
 182
 183   return FALSE;
 184 }
 185
 186 // TODO: Map at-spi -> atk roles at mrp creation instead of doing this;
 187 // would be more efficient
 188 #define spi_get_role(obj) spi_accessible_role_from_atk_role(atk_object_get_role(obj))
 189
 190 static gboolean
 191 match_roles_all_p (AtkObject * child, gint * roles)
 192 {
 193   if (roles == NULL || roles[0] == BITARRAY_SEQ_TERM)
 194     return TRUE;
 195   else if (roles[1] != BITARRAY_SEQ_TERM)
 196     return FALSE;
 197
 198   return (atk_object_get_role (child) == roles[0]);
 199
 200 }
 201
 202 static gboolean
 203 match_roles_any_p (AtkObject * child, gint * roles)
 204 {
 205   Accessibility_Role role;
 206   int i;
 207
 208   if (roles == NULL || roles[0] == BITARRAY_SEQ_TERM)
 209     return TRUE;
 210
 211   role = spi_accessible_role_from_atk_role (atk_object_get_role (child));
 212
 213   for (i = 0; roles[i] != BITARRAY_SEQ_TERM; i++)
 214     if (role == roles[i])
 215       return TRUE;
 216
 217   return FALSE;
 218 }
 219
 220 static gboolean
 221 match_roles_none_p (AtkObject * child, gint * roles)
 222 {
 223   AtkRole role;
 224   int i;
 225
 226   if (roles == NULL || roles[0] == BITARRAY_SEQ_TERM)
 227     return TRUE;
 228
 229   role = atk_object_get_role (child);
 230
 231   for (i = 0; roles[i] != BITARRAY_SEQ_TERM; i++)
 232     if (role == roles[i])
 233       return FALSE;
 234
 235   return TRUE;
 236 }
 237
 238 static gboolean
 239 match_roles_lookup (AtkObject * child, MatchRulePrivate * mrp)
 240 {
 241   switch (mrp->rolematchtype)
 242     {
 243     case Accessibility_Collection_MATCH_ALL:
 244       if (match_roles_all_p (child, mrp->roles))
 245         return TRUE;
 246       break;
 247
 248     case Accessibility_Collection_MATCH_ANY:
 249       if (match_roles_any_p (child, mrp->roles))
 250         return TRUE;
 251       break;
 252
 253     case Accessibility_Collection_MATCH_NONE:
 254       if (match_roles_none_p (child, mrp->roles))
 255         return TRUE;
 256       break;
 257
 258     default:
 259       break;
 260
 261     }
 262   return FALSE;
 263 }
 264
 265 static gboolean
 266 match_interfaces_all_p (AtkObject * obj, gchar ** ifaces)
 267 {
 268   gint i;
 269
 270   if (ifaces == NULL)
 271     return TRUE;
 272
 273   for (i = 0; ifaces[i]; i++)
 274     if (!child_interface_p (obj, ifaces[i]))
 275       {
 276         return FALSE;
 277       }
 278   return TRUE;
 279 }
 280
 281 static gboolean
 282 match_interfaces_any_p (AtkObject * obj, gchar ** ifaces)
 283 {
 284   gint i;
 285
 286   if (ifaces == NULL)
 287     return TRUE;
 288
 289
 290   for (i = 0; ifaces[i]; i++)
 291     if (child_interface_p (obj, ifaces[i]))
 292       {
 293         return TRUE;
 294       }
 295   return FALSE;
 296 }
 297
 298 static gboolean
 299 match_interfaces_none_p (AtkObject * obj, gchar ** ifaces)
 300 {
 301   gint i;
 302
 303   for (i = 0; ifaces[i]; i++)
 304     if (child_interface_p (obj, ifaces[i]))
 305       return FALSE;
 306
 307   return TRUE;
 308 }
 309
 310 static gboolean
 311 match_interfaces_lookup (AtkObject * child, MatchRulePrivate * mrp)
 312 {
 313   switch (mrp->interfacematchtype)
 314     {
 315
 316     case Accessibility_Collection_MATCH_ALL:
 317       if (match_interfaces_all_p (child, mrp->ifaces))
 318         return TRUE;
 319       break;
 320
 321     case Accessibility_Collection_MATCH_ANY:
 322       if (match_interfaces_any_p (child, mrp->ifaces))
 323         return TRUE;
 324       break;
 325
 326     case Accessibility_Collection_MATCH_NONE:
 327       if (match_interfaces_none_p (child, mrp->ifaces))
 328         return TRUE;
 329       break;
 330
 331     default:
 332       break;
 333     }
 334
 335   return FALSE;
 336 }
 337
 338 #define split_attributes(attributes) (g_strsplit (attributes, ";", 0))
 339
 340 static gboolean
 341 match_attributes_all_p (AtkObject * child, AtkAttributeSet * attributes)
 342 {
 343   int i, k;
 344   AtkAttributeSet *oa;
 345   gint length, oa_length;
 346   gboolean flag = FALSE;
 347
 348   if (attributes == NULL || g_slist_length (attributes) == 0)
 349     return TRUE;
 350
 351   oa = atk_object_get_attributes (child);
 352   length = g_slist_length (attributes);
 353   oa_length = g_slist_length (oa);
 354
 355   for (i = 0; i < length; i++)
 356     {
 357       AtkAttribute *attr = g_slist_nth_data (attributes, i);
 358       for (k = 0; k < oa_length; k++)
 359         {
 360           AtkAttribute *oa_attr = g_slist_nth_data (attributes, i);
 361           if (!g_ascii_strcasecmp (oa_attr->name, attr->name) &&
 362               !g_ascii_strcasecmp (oa_attr->value, attr->value))
 363             {
 364               flag = TRUE;
 365               break;
 366             }
 367           else
 368             flag = FALSE;
 369         }
 370       if (!flag)
 371         {
 372           atk_attribute_set_free (oa);
 373           return FALSE;
 374         }
 375     }
 376   atk_attribute_set_free (oa);
 377   return TRUE;
 378 }
 379
 380 static gboolean
 381 match_attributes_any_p (AtkObject * child, AtkAttributeSet * attributes)
 382 {
 383   int i, k;
 384
 385   AtkAttributeSet *oa;
 386   gint length, oa_length;
 387
 388   length = g_slist_length (attributes);
 389   if (length == 0)
 390     return TRUE;
 391
 392   oa = atk_object_get_attributes (child);
 393   oa_length = g_slist_length (oa);
 394
 395   for (i = 0; i < length; i++)
 396     {
 397       AtkAttribute *attr = g_slist_nth_data (attributes, i);
 398       for (k = 0; k < oa_length; k++)
 399         {
 400           AtkAttribute *oa_attr = g_slist_nth_data (attributes, i);
 401           if (!g_ascii_strcasecmp (oa_attr->name, attr->name) &&
 402               !g_ascii_strcasecmp (oa_attr->value, attr->value))
 403             {
 404               atk_attribute_set_free (oa);
 405               return TRUE;
 406             }
 407         }
 408     }
 409   atk_attribute_set_free (oa);
 410   return FALSE;
 411 }
 412
 413 static gboolean
 414 match_attributes_none_p (AtkObject * child, AtkAttributeSet * attributes)
 415 {
 416   int i, k;
 417
 418   AtkAttributeSet *oa;
 419   gint length, oa_length;
 420
 421   length = g_slist_length (attributes);
 422   if (length == 0)
 423     return TRUE;
 424
 425   oa = atk_object_get_attributes (child);
 426   oa_length = g_slist_length (oa);
 427
 428   for (i = 0; i < length; i++)
 429     {
 430       AtkAttribute *attr = g_slist_nth_data (attributes, i);
 431       for (k = 0; k < oa_length; k++)
 432         {
 433           AtkAttribute *oa_attr = g_slist_nth_data (attributes, i);
 434           if (!g_ascii_strcasecmp (oa_attr->name, attr->name) &&
 435               !g_ascii_strcasecmp (oa_attr->value, attr->value))
 436             {
 437               atk_attribute_set_free (oa);
 438               return FALSE;
 439             }
 440         }
 441     }
 442   atk_attribute_set_free (oa);
 443   return TRUE;
 444 }
 445
 446 static gboolean
 447 match_attributes_lookup (AtkObject * child, MatchRulePrivate * mrp)
 448 {
 449   switch (mrp->attributematchtype)
 450     {
 451
 452     case Accessibility_Collection_MATCH_ALL:
 453       if (match_attributes_all_p (child, mrp->attributes))
 454         return TRUE;
 455       break;
 456
 457     case Accessibility_Collection_MATCH_ANY:
 458       if (match_attributes_any_p (child, mrp->attributes))
 459         return TRUE;
 460       break;
 461
 462     case Accessibility_Collection_MATCH_NONE:
 463       if (match_attributes_none_p (child, mrp->attributes))
 464         return TRUE;
 465       break;
 466
 467     default:
 468       break;
 469     }
 470   return FALSE;
 471 }
 472
 473 static gboolean
 474 traverse_p (AtkObject * child, const gboolean traverse)
 475 {
 476   if (traverse)
 477     return TRUE;
 478   else
 479     return !child_collection_p (child);
 480 }
 481
 482 static int
 483 sort_order_canonical (MatchRulePrivate * mrp, GList * ls,
 484                       gint kount, gint max,
 485                       AtkObject * obj, glong index, gboolean flag,
 486                       AtkObject * pobj, gboolean recurse, gboolean traverse)
 487 {
 488   gint i = index;
 489   glong acount = atk_object_get_n_accessible_children (obj);
 490   gboolean prev = pobj ? TRUE : FALSE;
 491
 492   for (; i < acount && (max == 0 || kount < max); i++)
 493     {
 494       AtkObject *child = atk_object_ref_accessible_child (obj, i);
 495
 496       g_object_unref (child);
 497       if (prev && child == pobj)
 498         {
 499           return kount;
 500         }
 501
 502       if (flag && match_interfaces_lookup (child, mrp)
 503           && match_states_lookup (child, mrp)
 504           && match_roles_lookup (child, mrp)
 505           && match_attributes_lookup (child, mrp))
 506         {
 507
 508           ls = g_list_append (ls, child);
 509           kount++;
 510         }
 511
 512       if (!flag)
 513         flag = TRUE;
 514
 515       if (recurse && traverse_p (child, traverse))
 516         kount = sort_order_canonical (mrp, ls, kount,
 517                                       max, child, 0, TRUE,
 518                                       pobj, recurse, traverse);
 519     }
 520   return kount;
 521 }
 522
 523 static int
 524 sort_order_rev_canonical (MatchRulePrivate * mrp, GList * ls,
 525                           gint kount, gint max,
 526                           AtkObject * obj, gboolean flag, AtkObject * pobj)
 527 {
 528   AtkObject *nextobj;
 529   AtkObject *parent;
 530   glong indexinparent;
 531
 532   /* This breaks us out of the recursion. */
 533   if (!obj || obj == pobj)
 534     {
 535       return kount;
 536     }
 537
 538   /* Add to the list if it matches */
 539   if (flag && match_interfaces_lookup (obj, mrp)
 540       && match_states_lookup (obj, mrp)
 541       && match_roles_lookup (obj, mrp) && match_attributes_lookup (obj, mrp)
 542       && (max == 0 || kount < max))
 543     {
 544       ls = g_list_append (ls, obj);
 545       kount++;
 546     }
 547
 548   if (!flag)
 549     flag = TRUE;
 550
 551   /* Get the current nodes index in it's parent and the parent object. */
 552   indexinparent = atk_object_get_index_in_parent (obj);
 553   parent = atk_object_get_parent (obj);
 554
 555   if (indexinparent > 0 && (max == 0 || kount < max))
 556     {
 557       /* there are still some siblings to visit so get the previous sibling
 558          and get it's last descendant.
 559          First, get the previous sibling */
 560       nextobj = atk_object_ref_accessible_child (parent, indexinparent - 1);
 561       g_object_unref (nextobj);
 562
 563       /* Now, drill down the right side to the last descendant */
 564       while (atk_object_get_n_accessible_children (nextobj) > 0)
 565         {
 566           nextobj = atk_object_ref_accessible_child (nextobj,
 567                                                      atk_object_get_n_accessible_children
 568                                                      (nextobj) - 1);
 569           g_object_unref (nextobj);
 570         }
 571       /* recurse with the last descendant */
 572       kount = sort_order_rev_canonical (mrp, ls, kount, max,
 573                                         nextobj, TRUE, pobj);
 574     }
 575   else if (max == 0 || kount < max)
 576     {
 577       /* no more siblings so next node must be the parent */
 578       kount = sort_order_rev_canonical (mrp, ls, kount, max,
 579                                         parent, TRUE, pobj);
 580
 581     }
 582   return kount;
 583 }
 584
 585 static int
 586 query_exec (MatchRulePrivate * mrp, Accessibility_Collection_SortOrder sortby,
 587             GList * ls, gint kount, gint max,
 588             AtkObject * obj, glong index,
 589             gboolean flag,
 590             AtkObject * pobj, gboolean recurse, gboolean traverse)
 591 {
 592   switch (sortby)
 593     {
 594     case Accessibility_Collection_SORT_ORDER_CANONICAL:
 595       kount = sort_order_canonical (mrp, ls, 0, max, obj, index, flag,
 596                                     pobj, recurse, traverse);
 597       break;
 598     case Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL:
 599       kount = sort_order_canonical (mrp, ls, 0, max, obj, index, flag,
 600                                     pobj, recurse, traverse);
 601       break;
 602     default:
 603       kount = 0;
 604       g_warning ("Sort method not implemented yet");
 605       break;
 606     }
 607
 608   return kount;
 609 }
 610
 611 static gboolean
 612 bitarray_to_seq (int *array, int array_count, int **ret)
 613 {
 614   int out_size = 4;
 615   int out_count = 0;
 616   int i, j;
 617   int *out = (int *) g_malloc (out_size * sizeof (int));
 618
 619   if (!out)
 620     return FALSE;
 621   for (i = 0; i < array_count; i++)
 622     {
 623       for (j = 0; j < 32; j++)
 624         {
 625           if (array[i] & (1 << j))
 626             {
 627               if (out_count == out_size - 2)
 628                 {
 629                   out_size <<= 1;
 630                   out = (int *) g_realloc (out, out_size * sizeof (int));
 631                   if (!out)
 632                     return FALSE;
 633                 }
 634               out[out_count++] = i * 32 + j;
 635             }
 636         }
 637     }
 638   out[out_count] = BITARRAY_SEQ_TERM;
 639   *ret = out;
 640   return TRUE;
 641 }
 642
 643
 644 static dbus_bool_t
 645 read_mr (DBusMessageIter * iter, MatchRulePrivate * mrp)
 646 {
 647   DBusMessageIter iter_struct, iter_array, iter_dict, iter_dict_entry;
 648   dbus_uint32_t *array;
 649   dbus_int32_t matchType;
 650   int array_count;
 651   AtkAttribute *attr;
 652   int i;
 653   const char *str;
 654   char *interfaces = NULL;
 655
 656   dbus_message_iter_recurse (iter, &iter_struct);
 657
 658   /* states */
 659   dbus_message_iter_recurse (&iter_struct, &iter_array);
 660   dbus_message_iter_get_fixed_array (&iter_array, &array, &array_count);
 661   bitarray_to_seq (array, array_count, &mrp->states);
 662   for (i = 0; mrp->states[i] != BITARRAY_SEQ_TERM; i++)
 663     {
 664       mrp->states[i] = spi_atk_state_from_spi_state (mrp->states[i]);
 665     }
 666   dbus_message_iter_next (&iter_struct);
 667   dbus_message_iter_get_basic (&iter_struct, &matchType);
 668   dbus_message_iter_next (&iter_struct);
 669   mrp->statematchtype = matchType;;
 670
 671   /* attributes */
 672   mrp->attributes = NULL;
 673   dbus_message_iter_recurse (&iter_struct, &iter_dict);
 674   while (dbus_message_iter_get_arg_type (&iter_dict) != DBUS_TYPE_INVALID)
 675     {
 676       const char *key, *val;
 677       dbus_message_iter_recurse (&iter_dict, &iter_dict_entry);
 678       dbus_message_iter_get_basic (&iter_dict_entry, &key);
 679       dbus_message_iter_get_basic (&iter_dict_entry, &val);
 680       attr = g_new (AtkAttribute, 1);
 681       if (attr)
 682         {
 683           attr->name = g_strdup (key);
 684           attr->value = g_strdup (val);
 685           mrp->attributes = g_slist_prepend (mrp->attributes, attr);
 686         }
 687       dbus_message_iter_next (&iter_dict);
 688     }
 689   dbus_message_iter_next (&iter_struct);
 690   dbus_message_iter_get_basic (&iter_struct, &matchType);
 691   mrp->attributematchtype = matchType;;
 692   dbus_message_iter_next (&iter_struct);
 693
 694   /* Get roles and role match */
 695   dbus_message_iter_recurse (&iter_struct, &iter_array);
 696   dbus_message_iter_get_fixed_array (&iter_array, &array, &array_count);
 697   bitarray_to_seq (array, array_count, &mrp->roles);
 698   dbus_message_iter_next (&iter_struct);
 699   dbus_message_iter_get_basic (&iter_struct, &matchType);
 700   mrp->rolematchtype = matchType;;
 701   dbus_message_iter_next (&iter_struct);
 702
 703   /* Get interfaces and interface match */
 704   dbus_message_iter_recurse (&iter_struct, &iter_array);
 705   mrp->ifaces = g_new0 (gchar *, 16);
 706   i = 0;
 707   while (i < 15 && dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 708   {
 709     char *iface;
 710     dbus_message_iter_get_basic (&iter_array, &iface);
 711     mrp->ifaces [i] = g_strdup (iface);
 712     i++;
 713     dbus_message_iter_next (&iter_array);
 714   }
 715   dbus_message_iter_next (&iter_struct);
 716   dbus_message_iter_get_basic (&iter_struct, &matchType);
 717   mrp->interfacematchtype = matchType;;
 718   dbus_message_iter_next (&iter_struct);
 719   /* get invert */
 720   dbus_message_iter_get_basic (&iter_struct, &mrp->invert);
 721   dbus_message_iter_next (iter);
 722   return TRUE;
 723 }
 724
 725 static DBusMessage *
 726 return_and_free_list (DBusMessage * message, GList * ls)
 727 {
 728   DBusMessage *reply;
 729   DBusMessageIter iter, iter_array;
 730   GList *item;
 731
 732   reply = dbus_message_new_method_return (message);
 733   if (!reply)
 734     return NULL;
 735   dbus_message_iter_init_append (reply, &iter);
 736   if (!dbus_message_iter_open_container
 737       (&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array))
 738     goto oom;
 739   for (item = ls; item; item = g_list_next (item))
 740     {
 741       spi_object_append_reference (&iter_array, ATK_OBJECT (item->data));
 742     }
 743   if (!dbus_message_iter_close_container (&iter, &iter_array))
 744     goto oom;
 745   g_list_free (ls);
 746   return reply;
 747 oom:
 748   // TODO: Handle out of memory
 749   g_list_free (ls);
 750   return reply;
 751 }
 752
 753 static void
 754 free_mrp_data (MatchRulePrivate * mrp)
 755 {
 756   g_free (mrp->states);
 757   atk_attribute_set_free (mrp->attributes);
 758   g_free (mrp->roles);
 759   g_strfreev (mrp->ifaces);
 760 }
 761
 762 static DBusMessage *
 763 GetMatchesFrom (DBusMessage * message,
 764                 AtkObject * current_object,
 765                 MatchRulePrivate * mrp,
 766                 const Accessibility_Collection_SortOrder sortby,
 767                 const dbus_bool_t isrestrict,
 768                 dbus_int32_t count, const dbus_bool_t traverse)
 769 {
 770   GList *ls = NULL;
 771   AtkObject *parent;
 772   glong index = atk_object_get_index_in_parent (current_object);
 773   gint kount = 0;
 774
 775   ls = g_list_append (ls, current_object);
 776
 777   if (!isrestrict)
 778     {
 779       parent = atk_object_get_parent (current_object);
 780       kount = query_exec (mrp, sortby, ls, 0, count, parent, index,
 781                           FALSE, NULL, TRUE, traverse);
 782     }
 783   else
 784     kount = query_exec (mrp, sortby, ls, 0, count,
 785                         current_object, 0, FALSE, NULL, TRUE, traverse);
 786
 787   ls = g_list_remove (ls, ls->data);
 788
 789   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 790     ls = g_list_reverse (ls);
 791
 792   free_mrp_data (mrp);
 793   return return_and_free_list (message, ls);
 794 }
 795
 796 /*
 797   inorder traversal from a given object in the hierarchy
 798 */
 799
 800 static int
 801 inorder (AtkObject * collection, MatchRulePrivate * mrp,
 802          GList * ls, gint kount, gint max,
 803          AtkObject * obj,
 804          gboolean flag, AtkObject * pobj, dbus_bool_t traverse)
 805 {
 806   int i = 0;
 807
 808   /* First, look through the children recursively. */
 809   kount = sort_order_canonical (mrp, ls, kount, max, obj, 0, TRUE,
 810                                 NULL, TRUE, TRUE);
 811
 812   /* Next, we look through the right subtree */
 813   while ((max == 0 || kount < max) && obj != collection)
 814     {
 815       AtkObject *parent = atk_object_get_parent (obj);
 816       i = atk_object_get_index_in_parent (obj);
 817       kount = sort_order_canonical (mrp, ls, kount, max, parent,
 818                                     i + 1, TRUE, FALSE, TRUE, TRUE);
 819       obj = parent;
 820     }
 821
 822   if (max == 0 || kount < max)
 823     {
 824       kount = sort_order_canonical (mrp, ls, kount, max,
 825                                     obj, i + 1, TRUE, FALSE, TRUE, TRUE);
 826     }
 827
 828   return kount;
 829 }
 830
 831 /*
 832   GetMatchesInOrder: get matches from a given object in an inorder traversal.
 833 */
 834
 835 static DBusMessage *
 836 GetMatchesInOrder (DBusMessage * message,
 837                    AtkObject * current_object,
 838                    MatchRulePrivate * mrp,
 839                    const Accessibility_Collection_SortOrder sortby,
 840                    const dbus_bool_t recurse,
 841                    dbus_int32_t count, const dbus_bool_t traverse)
 842 {
 843   GList *ls = NULL;
 844   AtkObject *obj;
 845   gint kount = 0;
 846
 847   ls = g_list_append (ls, current_object);
 848
 849   obj = ATK_OBJECT(spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 850
 851   kount = inorder (obj, mrp, ls, 0, count,
 852                    current_object, TRUE, NULL, traverse);
 853
 854   ls = g_list_remove (ls, ls->data);
 855
 856   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 857     ls = g_list_reverse (ls);
 858
 859   free_mrp_data (mrp);
 860   return return_and_free_list (message, ls);
 861 }
 862
 863 /*
 864   GetMatchesInBackOrder: get matches from a given object in a
 865   reverse order traversal.
 866 */
 867
 868 static DBusMessage *
 869 GetMatchesInBackOrder (DBusMessage * message,
 870                        AtkObject * current_object,
 871                        MatchRulePrivate * mrp,
 872                        const Accessibility_Collection_SortOrder sortby,
 873                        dbus_int32_t count)
 874 {
 875   GList *ls = NULL;
 876   AtkObject *collection;
 877   gint kount = 0;
 878
 879   ls = g_list_append (ls, current_object);
 880
 881   collection = ATK_OBJECT(spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 882
 883   kount = sort_order_rev_canonical (mrp, ls, 0, count, current_object,
 884                                     FALSE, collection);
 885
 886   ls = g_list_remove (ls, ls->data);
 887
 888   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 889     ls = g_list_reverse (ls);
 890
 891   free_mrp_data (mrp);
 892   return return_and_free_list (message, ls);
 893 }
 894
 895 static DBusMessage *
 896 GetMatchesTo (DBusMessage * message,
 897               AtkObject * current_object,
 898               MatchRulePrivate * mrp,
 899               const Accessibility_Collection_SortOrder sortby,
 900               const dbus_bool_t recurse,
 901               const dbus_bool_t isrestrict,
 902               dbus_int32_t count, const dbus_bool_t traverse)
 903 {
 904   GList *ls = NULL;
 905   AtkObject *obj;
 906   gint kount = 0;
 907   ls = g_list_append (ls, current_object);
 908
 909   if (recurse)
 910     {
 911       obj = ATK_OBJECT (atk_object_get_parent (current_object));
 912       kount = query_exec (mrp, sortby, ls, 0, count,
 913                           obj, 0, TRUE, current_object, TRUE, traverse);
 914     }
 915   else
 916     {
 917       obj = ATK_OBJECT (spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 918       kount = query_exec (mrp, sortby, ls, 0, count,
 919                           obj, 0, TRUE, current_object, TRUE, traverse);
 920
 921     }
 922
 923   ls = g_list_remove (ls, ls->data);
 924
 925   if (sortby != Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 926     ls = g_list_reverse (ls);
 927
 928   free_mrp_data (mrp);
 929   return return_and_free_list (message, ls);
 930 }
 931
 932 static DBusMessage *
 933 impl_GetMatchesFrom (DBusConnection * bus, DBusMessage * message,
 934                      void *user_data)
 935 {
 936   char *current_object_path = NULL;
 937   AtkObject *current_object;
 938   DBusMessageIter iter;
 939   MatchRulePrivate rule;
 940   dbus_uint32_t sortby;
 941   dbus_uint32_t tree;
 942   dbus_int32_t count;
 943   dbus_bool_t traverse;
 944   GList *ls = NULL;
 945   const char *signature;
 946
 947   signature = dbus_message_get_signature (message);
 948   if (strcmp (signature, "o(aiia{ss}iaiiasib)uuib") != 0)
 949     {
 950       return droute_invalid_arguments_error (message);
 951     }
 952
 953   dbus_message_iter_init (message, &iter);
 954   dbus_message_iter_get_basic (&iter, &current_object_path);
 955   current_object = ATK_OBJECT (spi_register_path_to_object (spi_global_register, current_object_path));
 956   if (!current_object)
 957     {
 958       // TODO: object-not-found error
 959       return spi_dbus_general_error (message);
 960     }
 961   dbus_message_iter_next (&iter);
 962   if (!read_mr (&iter, &rule))
 963     {
 964       return spi_dbus_general_error (message);
 965     }
 966   dbus_message_iter_get_basic (&iter, &sortby);
 967   dbus_message_iter_next (&iter);
 968   dbus_message_iter_get_basic (&iter, &tree);
 969   dbus_message_iter_next (&iter);
 970   dbus_message_iter_get_basic (&iter, &count);
 971   dbus_message_iter_next (&iter);
 972   dbus_message_iter_get_basic (&iter, &traverse);
 973   dbus_message_iter_next (&iter);
 974
 975   switch (tree)
 976     {
 977     case Accessibility_Collection_TREE_RESTRICT_CHILDREN:
 978       return GetMatchesFrom (message, current_object,
 979                              &rule, sortby, TRUE, count, traverse);
 980       break;
 981     case Accessibility_Collection_TREE_RESTRICT_SIBLING:
 982       return GetMatchesFrom (message, current_object,
 983                              &rule, sortby, FALSE, count, traverse);
 984       break;
 985     case Accessibility_Collection_TREE_INORDER:
 986       return GetMatchesInOrder (message, current_object,
 987                                 &rule, sortby, TRUE, count, traverse);
 988       break;
 989     default:
 990       return NULL;
 991     }
 992 }
 993
 994 static DBusMessage *
 995 impl_GetMatchesTo (DBusConnection * bus, DBusMessage * message,
 996                    void *user_data)
 997 {
 998   char *current_object_path = NULL;
 999   AtkObject *current_object;
1000   DBusMessageIter iter;
1001   MatchRulePrivate rule;
1002   dbus_uint32_t sortby;
1003   dbus_uint32_t tree;
1004   dbus_bool_t recurse;
1005   dbus_int32_t count;
1006   dbus_bool_t traverse;
1007   GList *ls = NULL;
1008   const char *signature;
1009
1010   signature = dbus_message_get_signature (message);
1011   if (strcmp (signature, "o(aiia{ss}iaiiasib)uubib") != 0)
1012     {
1013       return droute_invalid_arguments_error (message);
1014     }
1015
1016   dbus_message_iter_init (message, &iter);
1017   dbus_message_iter_get_basic (&iter, &current_object_path);
1018   current_object = ATK_OBJECT (spi_register_path_to_object (spi_global_register, current_object_path));
1019   if (!current_object)
1020     {
1021       // TODO: object-not-found error
1022       return spi_dbus_general_error (message);
1023     }
1024   dbus_message_iter_next (&iter);
1025   if (!read_mr (&iter, &rule))
1026     {
1027       return spi_dbus_general_error (message);
1028     }
1029   dbus_message_iter_get_basic (&iter, &sortby);
1030   dbus_message_iter_next (&iter);
1031   dbus_message_iter_get_basic (&iter, &tree);
1032   dbus_message_iter_next (&iter);
1033   dbus_message_iter_get_basic (&iter, &recurse);
1034   dbus_message_iter_next (&iter);
1035   dbus_message_iter_get_basic (&iter, &count);
1036   dbus_message_iter_next (&iter);
1037   dbus_message_iter_get_basic (&iter, &traverse);
1038   dbus_message_iter_next (&iter);
1039
1040   switch (tree)
1041     {
1042     case Accessibility_Collection_TREE_RESTRICT_CHILDREN:
1043       return GetMatchesTo (message, current_object,
1044                            &rule, sortby, recurse, TRUE, count, traverse);
1045       break;
1046     case Accessibility_Collection_TREE_RESTRICT_SIBLING:
1047       return GetMatchesTo (message, current_object,
1048                            &rule, sortby, recurse, FALSE, count, traverse);
1049       break;
1050     case Accessibility_Collection_TREE_INORDER:
1051       return GetMatchesInBackOrder (message, current_object,
1052                                     &rule, sortby, count);
1053       break;
1054     default:
1055       return NULL;
1056     }
1057 }
1058
1059 static DBusMessage *
1060 impl_GetMatches (DBusConnection * bus, DBusMessage * message, void *user_data)
1061 {
1062   AtkObject *obj = ATK_OBJECT (spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
1063   DBusMessageIter iter;
1064   MatchRulePrivate rule;
1065   dbus_uint32_t sortby;
1066   dbus_int32_t count;
1067   dbus_bool_t traverse;
1068   GList *ls = NULL;
1069   const char *signature;
1070
1071   signature = dbus_message_get_signature (message);
1072   if (strcmp (signature, "(aiia{ss}iaiiasib)uib") != 0)
1073     {
1074       return droute_invalid_arguments_error (message);
1075     }
1076
1077   dbus_message_iter_init (message, &iter);
1078   if (!read_mr (&iter, &rule))
1079     {
1080       return spi_dbus_general_error (message);
1081     }
1082   dbus_message_iter_get_basic (&iter, &sortby);
1083   dbus_message_iter_next (&iter);
1084   dbus_message_iter_get_basic (&iter, &count);
1085   dbus_message_iter_next (&iter);
1086   dbus_message_iter_get_basic (&iter, &traverse);
1087   dbus_message_iter_next (&iter);
1088   ls = g_list_prepend (ls, obj);
1089   count = query_exec (&rule, sortby, ls, 0, count,
1090                       obj, 0, TRUE, NULL, TRUE, traverse);
1091   ls = g_list_remove (ls, ls->data);
1092
1093   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
1094     ls = g_list_reverse (ls);
1095   free_mrp_data (&rule);
1096   return return_and_free_list (message, ls);
1097 }
1098
1099 static DRouteMethod methods[] = {
1100   {impl_GetMatchesFrom, "GetMatchesFrom"},
1101   {impl_GetMatchesTo, "GetMatchesTo"},
1102   {impl_GetMatches, "GetMatches"},
1103   {NULL, NULL}
1104 };
1105
1106 void
1107 spi_initialize_collection (DRoutePath * path)
1108 {
1109   droute_path_add_interface (path,
1110                              SPI_DBUS_INTERFACE_COLLECTION, spi_org_a11y_atspi_Collection, methods, NULL);
1111 };