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)
  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)
 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)
 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     {
 543       ls = g_list_append (ls, obj);
 544       kount++;
 545     }
 546
 547   if (!flag)
 548     flag = TRUE;
 549
 550   /* Get the current nodes index in it's parent and the parent object. */
 551   indexinparent = atk_object_get_index_in_parent (obj);
 552   parent = atk_object_get_parent (obj);
 553
 554   if (indexinparent > 0)
 555     {
 556       /* there are still some siblings to visit so get the previous sibling
 557          and get it's last descendant.
 558          First, get the previous sibling */
 559       nextobj = atk_object_ref_accessible_child (parent, indexinparent - 1);
 560       g_object_unref (nextobj);
 561
 562       /* Now, drill down the right side to the last descendant */
 563       while (atk_object_get_n_accessible_children (nextobj) > 0)
 564         {
 565           nextobj = atk_object_ref_accessible_child (nextobj,
 566                                                      atk_object_get_n_accessible_children
 567                                                      (nextobj) - 1);
 568           g_object_unref (nextobj);
 569         }
 570       /* recurse with the last descendant */
 571       kount = sort_order_rev_canonical (mrp, ls, kount, max,
 572                                         nextobj, TRUE, pobj);
 573     }
 574   else
 575     {
 576       /* no more siblings so next node must be the parent */
 577       kount = sort_order_rev_canonical (mrp, ls, kount, max,
 578                                         parent, TRUE, pobj);
 579
 580     }
 581   return kount;
 582 }
 583
 584 static int
 585 query_exec (MatchRulePrivate * mrp, Accessibility_Collection_SortOrder sortby,
 586             GList * ls, gint kount, gint max,
 587             AtkObject * obj, glong index,
 588             gboolean flag,
 589             AtkObject * pobj, gboolean recurse, gboolean traverse)
 590 {
 591   switch (sortby)
 592     {
 593     case Accessibility_Collection_SORT_ORDER_CANONICAL:
 594       kount = sort_order_canonical (mrp, ls, 0, max, obj, index, flag,
 595                                     pobj, recurse, traverse);
 596       break;
 597     case Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL:
 598       kount = sort_order_canonical (mrp, ls, 0, max, obj, index, flag,
 599                                     pobj, recurse, traverse);
 600       break;
 601     default:
 602       kount = 0;
 603       g_warning ("Sort method not implemented yet");
 604       break;
 605     }
 606
 607   return kount;
 608 }
 609
 610 static gboolean
 611 bitarray_to_seq (int *array, int array_count, int **ret)
 612 {
 613   int out_size = 4;
 614   int out_count = 0;
 615   int i, j;
 616   int *out = (int *) g_malloc (out_size * sizeof (int));
 617
 618   if (!out)
 619     return FALSE;
 620   for (i = 0; i < array_count; i++)
 621     {
 622       for (j = 0; j < 32; j++)
 623         {
 624           if (array[i] & (1 << j))
 625             {
 626               if (out_count == out_size - 2)
 627                 {
 628                   out_size <<= 1;
 629                   out = (int *) g_realloc (out, out_size * sizeof (int));
 630                   if (!out)
 631                     return FALSE;
 632                 }
 633               out[out_count++] = i * 32 + j;
 634             }
 635         }
 636     }
 637   out[out_count] = BITARRAY_SEQ_TERM;
 638   *ret = out;
 639   return TRUE;
 640 }
 641
 642
 643 static dbus_bool_t
 644 read_mr (DBusMessageIter * iter, MatchRulePrivate * mrp)
 645 {
 646   DBusMessageIter mrc, arrayc;
 647   dbus_uint32_t *array;
 648   dbus_int32_t matchType;
 649   int array_count;
 650   AtkAttribute *attr;
 651   int i;
 652   const char *str;
 653   char *interfaces = NULL;
 654
 655   dbus_message_iter_recurse (iter, &mrc);
 656   dbus_message_iter_recurse (&mrc, &arrayc);
 657   dbus_message_iter_get_fixed_array (&arrayc, &array, &array_count);
 658   bitarray_to_seq (array, array_count, &mrp->states);
 659   for (i = 0; mrp->states[i] != BITARRAY_SEQ_TERM; i++)
 660     {
 661       mrp->states[i] = spi_atk_state_from_spi_state (mrp->states[i]);
 662     }
 663   dbus_message_iter_next (&mrc);
 664   dbus_message_iter_get_basic (&mrc, &matchType);
 665   dbus_message_iter_next (&mrc);
 666   mrp->statematchtype = matchType;;
 667   /* attributes */
 668   mrp->attributes = NULL;
 669   if (dbus_message_iter_get_arg_type (&mrc) == DBUS_TYPE_STRING)
 670     {
 671       char *str;
 672       gchar **attributes;
 673       gchar **pp;
 674       dbus_message_iter_get_basic (&mrc, &str);
 675       attributes = g_strsplit (str, "\n", -1);
 676       for (pp = attributes; *pp; pp++)
 677         {
 678           str = *pp;
 679           attr = g_new (AtkAttribute, 1);
 680           if (attr)
 681             {
 682               int len = strcspn (str, ":");
 683               attr->name = g_strndup (str, len);
 684               if (str[len] == ':')
 685                 {
 686                   len++;
 687                   if (str[len] == ' ')
 688                     len++;
 689                   attr->value = g_strdup (str + len);
 690                 }
 691               else
 692                 attr->value = NULL;
 693               mrp->attributes = g_slist_prepend (mrp->attributes, attr);
 694             }
 695         }
 696       g_strfreev (attributes);
 697     }
 698   else
 699     {
 700       dbus_message_iter_recurse (&mrc, &arrayc);
 701       while (dbus_message_iter_get_arg_type (&arrayc) != DBUS_TYPE_INVALID)
 702         {
 703           dbus_message_iter_get_basic (&arrayc, &str);
 704           // TODO: remove this print
 705           g_print ("Got attribute: %s\n", str);
 706           attr = g_new (AtkAttribute, 1);
 707           if (attr)
 708             {
 709               int len = strcspn (str, ":");
 710               attr->name = g_strndup (str, len);
 711               if (str[len] == ':')
 712                 {
 713                   len++;
 714                   if (str[len] == ' ')
 715                     len++;
 716                   attr->value = g_strdup (str + len);
 717                 }
 718               else
 719                 attr->value = NULL;
 720               mrp->attributes = g_slist_prepend (mrp->attributes, attr);
 721             }
 722           dbus_message_iter_next (&arrayc);
 723         }
 724     }
 725   dbus_message_iter_next (&mrc);
 726   dbus_message_iter_get_basic (&mrc, &matchType);
 727   mrp->attributematchtype = matchType;;
 728   dbus_message_iter_next (&mrc);
 729   /* Get roles and role match */
 730   dbus_message_iter_recurse (&mrc, &arrayc);
 731   dbus_message_iter_get_fixed_array (&arrayc, &array, &array_count);
 732   bitarray_to_seq (array, array_count, &mrp->roles);
 733   dbus_message_iter_next (&mrc);
 734   dbus_message_iter_get_basic (&mrc, &matchType);
 735   mrp->rolematchtype = matchType;;
 736   dbus_message_iter_next (&mrc);
 737   /* Get interfaces and interface match */
 738   dbus_message_iter_get_basic (&mrc, &interfaces);
 739   dbus_message_iter_next (&mrc);
 740   mrp->ifaces = g_strsplit (interfaces, ";", 0);
 741   dbus_message_iter_get_basic (&mrc, &matchType);
 742   mrp->interfacematchtype = matchType;;
 743   dbus_message_iter_next (&mrc);
 744   /* get invert */
 745   dbus_message_iter_get_basic (&mrc, &mrp->invert);
 746   dbus_message_iter_next (iter);
 747   return TRUE;
 748 }
 749
 750 static DBusMessage *
 751 return_and_free_list (DBusMessage * message, GList * ls)
 752 {
 753   DBusMessage *reply;
 754   DBusMessageIter iter, iter_array;
 755   GList *item;
 756
 757   reply = dbus_message_new_method_return (message);
 758   if (!reply)
 759     return NULL;
 760   dbus_message_iter_init_append (reply, &iter);
 761   if (!dbus_message_iter_open_container
 762       (&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array))
 763     goto oom;
 764   for (item = ls; item; item = g_list_next (item))
 765     {
 766       spi_object_append_reference (&iter_array, ATK_OBJECT (item->data));
 767     }
 768   if (!dbus_message_iter_close_container (&iter, &iter_array))
 769     goto oom;
 770   g_list_free (ls);
 771   return reply;
 772 oom:
 773   // TODO: Handle out of memory
 774   g_list_free (ls);
 775   return reply;
 776 }
 777
 778 static void
 779 free_mrp_data (MatchRulePrivate * mrp)
 780 {
 781   g_free (mrp->states);
 782   atk_attribute_set_free (mrp->attributes);
 783   g_free (mrp->roles);
 784   g_strfreev (mrp->ifaces);
 785 }
 786
 787 static DBusMessage *
 788 GetMatchesFrom (DBusMessage * message,
 789                 AtkObject * current_object,
 790                 MatchRulePrivate * mrp,
 791                 const Accessibility_Collection_SortOrder sortby,
 792                 const dbus_bool_t isrestrict,
 793                 dbus_int32_t count, const dbus_bool_t traverse)
 794 {
 795   GList *ls = NULL;
 796   AtkObject *parent;
 797   glong index = atk_object_get_index_in_parent (current_object);
 798   gint kount = 0;
 799
 800   ls = g_list_append (ls, current_object);
 801
 802   if (!isrestrict)
 803     {
 804       parent = atk_object_get_parent (current_object);
 805       kount = query_exec (mrp, sortby, ls, 0, count, parent, index,
 806                           FALSE, NULL, TRUE, traverse);
 807     }
 808   else
 809     kount = query_exec (mrp, sortby, ls, 0, count,
 810                         current_object, 0, FALSE, NULL, TRUE, traverse);
 811
 812   ls = g_list_remove (ls, ls->data);
 813
 814   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 815     ls = g_list_reverse (ls);
 816
 817   free_mrp_data (mrp);
 818   return return_and_free_list (message, ls);
 819 }
 820
 821 /*
 822   inorder traversal from a given object in the hierarchy
 823 */
 824
 825 static int
 826 inorder (AtkObject * collection, MatchRulePrivate * mrp,
 827          GList * ls, gint kount, gint max,
 828          AtkObject * obj,
 829          gboolean flag, AtkObject * pobj, dbus_bool_t traverse)
 830 {
 831   int i = 0;
 832
 833   /* First, look through the children recursively. */
 834   kount = sort_order_canonical (mrp, ls, kount, max, obj, 0, TRUE,
 835                                 NULL, TRUE, TRUE);
 836
 837   /* Next, we look through the right subtree */
 838   while ((max == 0 || kount < max) && obj != collection)
 839     {
 840       AtkObject *parent = atk_object_get_parent (obj);
 841       i = atk_object_get_index_in_parent (obj);
 842       kount = sort_order_canonical (mrp, ls, kount, max, parent,
 843                                     i + 1, TRUE, FALSE, TRUE, TRUE);
 844       obj = parent;
 845     }
 846
 847   if (kount < max)
 848     {
 849       kount = sort_order_canonical (mrp, ls, kount, max,
 850                                     obj, i + 1, TRUE, FALSE, TRUE, TRUE);
 851     }
 852
 853   return kount;
 854 }
 855
 856 /*
 857   GetMatchesInOrder: get matches from a given object in an inorder traversal.
 858 */
 859
 860 static DBusMessage *
 861 GetMatchesInOrder (DBusMessage * message,
 862                    AtkObject * current_object,
 863                    MatchRulePrivate * mrp,
 864                    const Accessibility_Collection_SortOrder sortby,
 865                    const dbus_bool_t recurse,
 866                    dbus_int32_t count, const dbus_bool_t traverse)
 867 {
 868   GList *ls = NULL;
 869   AtkObject *obj;
 870   gint kount = 0;
 871
 872   ls = g_list_append (ls, current_object);
 873
 874   obj = ATK_OBJECT(spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 875
 876   kount = inorder (obj, mrp, ls, 0, count,
 877                    current_object, TRUE, NULL, traverse);
 878
 879   ls = g_list_remove (ls, ls->data);
 880
 881   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 882     ls = g_list_reverse (ls);
 883
 884   free_mrp_data (mrp);
 885   return return_and_free_list (message, ls);
 886 }
 887
 888 /*
 889   GetMatchesInBackOrder: get matches from a given object in a
 890   reverse order traversal.
 891 */
 892
 893 static DBusMessage *
 894 GetMatchesInBackOrder (DBusMessage * message,
 895                        AtkObject * current_object,
 896                        MatchRulePrivate * mrp,
 897                        const Accessibility_Collection_SortOrder sortby,
 898                        dbus_int32_t count)
 899 {
 900   GList *ls = NULL;
 901   AtkObject *collection;
 902   gint kount = 0;
 903
 904   ls = g_list_append (ls, current_object);
 905
 906   collection = ATK_OBJECT(spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 907
 908   kount = sort_order_rev_canonical (mrp, ls, 0, count, current_object,
 909                                     FALSE, collection);
 910
 911   ls = g_list_remove (ls, ls->data);
 912
 913   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 914     ls = g_list_reverse (ls);
 915
 916   free_mrp_data (mrp);
 917   return return_and_free_list (message, ls);
 918 }
 919
 920 static DBusMessage *
 921 GetMatchesTo (DBusMessage * message,
 922               AtkObject * current_object,
 923               MatchRulePrivate * mrp,
 924               const Accessibility_Collection_SortOrder sortby,
 925               const dbus_bool_t recurse,
 926               const dbus_bool_t isrestrict,
 927               dbus_int32_t count, const dbus_bool_t traverse)
 928 {
 929   GList *ls = NULL;
 930   AtkObject *obj;
 931   gint kount = 0;
 932   ls = g_list_append (ls, current_object);
 933
 934   if (recurse)
 935     {
 936       obj = ATK_OBJECT (atk_object_get_parent (current_object));
 937       kount = query_exec (mrp, sortby, ls, 0, count,
 938                           obj, 0, TRUE, current_object, TRUE, traverse);
 939     }
 940   else
 941     {
 942       obj = ATK_OBJECT (spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
 943       kount = query_exec (mrp, sortby, ls, 0, count,
 944                           obj, 0, TRUE, current_object, TRUE, traverse);
 945
 946     }
 947
 948   ls = g_list_remove (ls, ls->data);
 949
 950   if (sortby != Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
 951     ls = g_list_reverse (ls);
 952
 953   free_mrp_data (mrp);
 954   return return_and_free_list (message, ls);
 955 }
 956
 957 static DBusMessage *
 958 impl_GetMatchesFrom (DBusConnection * bus, DBusMessage * message,
 959                      void *user_data)
 960 {
 961   char *current_object_path = NULL;
 962   AtkObject *current_object;
 963   DBusMessageIter iter;
 964   MatchRulePrivate rule;
 965   dbus_uint32_t sortby;
 966   dbus_uint32_t tree;
 967   dbus_int32_t count;
 968   dbus_bool_t traverse;
 969   GList *ls = NULL;
 970   const char *signature;
 971
 972   signature = dbus_message_get_signature (message);
 973   if (strcmp (signature, "o(aiisiaiisib)uuib") != 0 &&
 974       strcmp (signature, "o(aii(as)iaiisib)uuib") != 0)
 975     {
 976       return droute_invalid_arguments_error (message);
 977     }
 978
 979   dbus_message_iter_init (message, &iter);
 980   dbus_message_iter_get_basic (&iter, &current_object_path);
 981   current_object = ATK_OBJECT (spi_register_path_to_object (spi_global_register, current_object_path));
 982   if (!current_object)
 983     {
 984       // TODO: object-not-found error
 985       return spi_dbus_general_error (message);
 986     }
 987   dbus_message_iter_next (&iter);
 988   if (!read_mr (&iter, &rule))
 989     {
 990       return spi_dbus_general_error (message);
 991     }
 992   dbus_message_iter_get_basic (&iter, &sortby);
 993   dbus_message_iter_next (&iter);
 994   dbus_message_iter_get_basic (&iter, &tree);
 995   dbus_message_iter_next (&iter);
 996   dbus_message_iter_get_basic (&iter, &count);
 997   dbus_message_iter_next (&iter);
 998   dbus_message_iter_get_basic (&iter, &traverse);
 999   dbus_message_iter_next (&iter);
1000
1001   switch (tree)
1002     {
1003     case Accessibility_Collection_TREE_RESTRICT_CHILDREN:
1004       return GetMatchesFrom (message, current_object,
1005                              &rule, sortby, TRUE, count, traverse);
1006       break;
1007     case Accessibility_Collection_TREE_RESTRICT_SIBLING:
1008       return GetMatchesFrom (message, current_object,
1009                              &rule, sortby, FALSE, count, traverse);
1010       break;
1011     case Accessibility_Collection_TREE_INORDER:
1012       return GetMatchesInOrder (message, current_object,
1013                                 &rule, sortby, TRUE, count, traverse);
1014       break;
1015     default:
1016       return NULL;
1017     }
1018 }
1019
1020 static DBusMessage *
1021 impl_GetMatchesTo (DBusConnection * bus, DBusMessage * message,
1022                    void *user_data)
1023 {
1024   char *current_object_path = NULL;
1025   AtkObject *current_object;
1026   DBusMessageIter iter;
1027   MatchRulePrivate rule;
1028   dbus_uint32_t sortby;
1029   dbus_uint32_t tree;
1030   dbus_bool_t recurse;
1031   dbus_int32_t count;
1032   dbus_bool_t traverse;
1033   GList *ls = NULL;
1034   const char *signature;
1035
1036   signature = dbus_message_get_signature (message);
1037   if (strcmp (signature, "o(aiisiaiisib)uubib") != 0 &&
1038       strcmp (signature, "o(aii(as)iaiisib)uubib") != 0)
1039     {
1040       return droute_invalid_arguments_error (message);
1041     }
1042
1043   dbus_message_iter_init (message, &iter);
1044   dbus_message_iter_get_basic (&iter, &current_object_path);
1045   current_object = ATK_OBJECT (spi_register_path_to_object (spi_global_register, current_object_path));
1046   if (!current_object)
1047     {
1048       // TODO: object-not-found error
1049       return spi_dbus_general_error (message);
1050     }
1051   dbus_message_iter_next (&iter);
1052   if (!read_mr (&iter, &rule))
1053     {
1054       return spi_dbus_general_error (message);
1055     }
1056   dbus_message_iter_get_basic (&iter, &sortby);
1057   dbus_message_iter_next (&iter);
1058   dbus_message_iter_get_basic (&iter, &tree);
1059   dbus_message_iter_next (&iter);
1060   dbus_message_iter_get_basic (&iter, &recurse);
1061   dbus_message_iter_next (&iter);
1062   dbus_message_iter_get_basic (&iter, &count);
1063   dbus_message_iter_next (&iter);
1064   dbus_message_iter_get_basic (&iter, &traverse);
1065   dbus_message_iter_next (&iter);
1066
1067   switch (tree)
1068     {
1069     case Accessibility_Collection_TREE_RESTRICT_CHILDREN:
1070       return GetMatchesTo (message, current_object,
1071                            &rule, sortby, recurse, TRUE, count, traverse);
1072       break;
1073     case Accessibility_Collection_TREE_RESTRICT_SIBLING:
1074       return GetMatchesTo (message, current_object,
1075                            &rule, sortby, recurse, FALSE, count, traverse);
1076       break;
1077     case Accessibility_Collection_TREE_INORDER:
1078       return GetMatchesInBackOrder (message, current_object,
1079                                     &rule, sortby, count);
1080       break;
1081     default:
1082       return NULL;
1083     }
1084 }
1085
1086 static DBusMessage *
1087 impl_GetMatches (DBusConnection * bus, DBusMessage * message, void *user_data)
1088 {
1089   AtkObject *obj = ATK_OBJECT (spi_register_path_to_object (spi_global_register, dbus_message_get_path (message)));
1090   DBusMessageIter iter;
1091   MatchRulePrivate rule;
1092   dbus_uint32_t sortby;
1093   dbus_int32_t count;
1094   dbus_bool_t traverse;
1095   GList *ls = NULL;
1096   const char *signature;
1097
1098   signature = dbus_message_get_signature (message);
1099   if (strcmp (signature, "(aiisiaiisib)uib") != 0 &&
1100       strcmp (signature, "(aii(as)iaiisib)uib") != 0)
1101     {
1102       return droute_invalid_arguments_error (message);
1103     }
1104
1105   dbus_message_iter_init (message, &iter);
1106   if (!read_mr (&iter, &rule))
1107     {
1108       return spi_dbus_general_error (message);
1109     }
1110   dbus_message_iter_get_basic (&iter, &sortby);
1111   dbus_message_iter_next (&iter);
1112   dbus_message_iter_get_basic (&iter, &count);
1113   dbus_message_iter_next (&iter);
1114   dbus_message_iter_get_basic (&iter, &traverse);
1115   dbus_message_iter_next (&iter);
1116   ls = g_list_prepend (ls, obj);
1117   count = query_exec (&rule, sortby, ls, 0, count,
1118                       obj, 0, TRUE, NULL, TRUE, traverse);
1119   ls = g_list_remove (ls, ls->data);
1120
1121   if (sortby == Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL)
1122     ls = g_list_reverse (ls);
1123   free_mrp_data (&rule);
1124   return return_and_free_list (message, ls);
1125 }
1126
1127 static DRouteMethod methods[] = {
1128   {impl_GetMatchesFrom, "GetMatchesFrom"},
1129   {impl_GetMatchesTo, "GetMatchesTo"},
1130   {impl_GetMatches, "GetMatches"},
1131   {NULL, NULL}
1132 };
1133
1134 void
1135 spi_initialize_collection (DRoutePath * path)
1136 {
1137   droute_path_add_interface (path,
1138                              SPI_DBUS_INTERFACE_COLLECTION, spi_org_a11y_atspi_Collection, methods, NULL);
1139 };