cspi/spi_event.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, 2003 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002, 2003 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include <cspi/spi-private.h>
  25 #include <cspi/bonobo/cspi-bonobo-listener.h>
  26
  27 static GSList *_cspi_event_queue = NULL;
  28
  29 /**
  30  * SPI_freeAccessibleKeySet:
  31  * @keyset: An AccessibleKeyset to free.
  32  *
  33  * Release the memory used by an AccessibleKeySet.
  34  *
  35  **/
  36 void
  37 SPI_freeAccessibleKeySet (AccessibleKeySet *keyset)
  38 {
  39   int i = 0;
  40   g_free (keyset->keysyms);
  41   g_free (keyset->keycodes);
  42   while (keyset->keystrings [i])
  43     {
  44       g_free (keyset->keystrings [i++]);
  45     }
  46   g_free (keyset->keystrings);
  47   g_free (keyset);
  48 }
  49
  50 /**
  51  * SPI_createAccessibleKeySet:
  52  * @len: the number of key values in the key set.
  53  * @keysyms: a UTF-8 string containing symbolic key values to be matched, or NULL if
  54  *           matching is performed against other key values instead.
  55  * @keycodes: an array of unsigned short values which are the hardware keycodes
  56  *           to be matched, or NULL if the keyset is specified solely by keysyms
  57  *           and/or keystrings.
  58  * @keystrings: an array of null-terminated character strings which specify key
  59  *             name values to match, or NULL if the keyset is specified solely by
  60  *             keycodes and/or keysyms.
  61  *
  62  * Create a new #AccessibleKeySet of a specified length.
  63  * A KeySet is used typically to match key event values, and a matches are made
  64  * using the following criteria: a match exists with a key event if all non-null
  65  * i-th members of the keyset match the key event.
  66  * If both keystring and keysym values are NULL, a keycode value match is
  67  * forced, thus the match for keysym=0, keycode=0, keystring=NULL is
  68  * keycode 0.
  69  *
  70  * Returns: a pointer to a newly-created #AccessibleKeySet.
  71  *
  72  **/
  73 AccessibleKeySet *
  74 SPI_createAccessibleKeySet (int len, const char *keysyms, short *keycodes,
  75                             const char **keystrings)
  76 {
  77   AccessibleKeySet *keyset = g_new0 (AccessibleKeySet, 1);
  78   int i, keysym_len = 0;
  79   const char *keysym_ptr = keysyms;
  80   keyset->len = len;
  81   keyset->keysyms = g_new0 (unsigned long, len);
  82   keyset->keycodes = g_new0 (unsigned short, len);
  83   keyset->keystrings = g_new0 (char *, len);
  84   if (keysyms)
  85     {
  86       keysym_len = g_utf8_strlen (keysyms, -1);
  87     }
  88   for (i = 0; i < len; ++i)
  89     {
  90       if (i < keysym_len)
  91         {
  92           keyset->keysyms [i] = (unsigned long) g_utf8_get_char (keysym_ptr);
  93           keysym_ptr = g_utf8_find_next_char (keysym_ptr, NULL);
  94         }
  95       else
  96         {
  97           keyset->keysyms [i] = 0;
  98         }
  99       if (keycodes)
 100         {
 101           keyset->keycodes [i] = keycodes [i];
 102         }
 103       if (keystrings)
 104         {
 105           keyset->keystrings [i] = g_strdup (keystrings [i]);
 106         }
 107     }
 108   return keyset;
 109 }
 110
 111 /**
 112  * SPI_createAccessibleEventListener:
 113  * @callback : an #AccessibleEventListenerCB callback function, or NULL.
 114  * @user_data: a pointer to data which will be passed to the callback when invoked.
 115  *
 116  * Create a new #AccessibleEventListener with a specified (in-process) callback function.
 117  *
 118  * Returns: a pointer to a newly-created #AccessibleEventListener.
 119  *
 120  **/
 121 AccessibleEventListener *
 122 SPI_createAccessibleEventListener (AccessibleEventListenerCB callback,
 123                                    void                     *user_data)
 124 {
 125   AccessibleEventListener *listener = cspi_event_listener_new ();
 126   if (callback)
 127     {
 128       AccessibleEventListener_addCallback (listener, callback, user_data);
 129     }
 130   return listener;
 131 }
 132
 133 /**
 134  * AccessibleEventListener_addCallback:
 135  * @listener: the #AccessibleEventListener instance to modify.
 136  * @callback: an #AccessibleEventListenerCB function pointer.
 137  * @user_data: a pointer to data which will be passed to the callback when invoked.
 138  *
 139  * Add an in-process callback function to an existing AccessibleEventListener.
 140  * Note that the callback function must live in the same address
 141  * space as the AccessibleEventListener implementation code, thus one should not
 142  * use this function to attach callbacks to a 'remote' event listener
 143  * (that is, one that was not created by a client call to
 144  * createAccessibleEventListener ();
 145  *
 146  * Returns: #TRUE if successful, otherwise #FALSE.
 147  *
 148  **/
 149 SPIBoolean
 150 AccessibleEventListener_addCallback (AccessibleEventListener *listener,
 151                                      AccessibleEventListenerCB callback,
 152                                      void                     *user_data)
 153 {
 154   cspi_event_listener_add_cb (listener, callback, user_data);
 155   return TRUE;
 156 }
 157
 158 /**
 159  * AccessibleEventListener_unref:
 160  * @listener: a pointer to the #AccessibleEventListener being operated on.
 161  *
 162  * Decrements an #AccessibleEventListener's reference count.
 163  **/
 164 void
 165 AccessibleEventListener_unref (AccessibleEventListener *listener)
 166 {
 167   cspi_event_listener_unref (listener);
 168 }
 169
 170 /**
 171  * AccessibleEventListener_removeCallback:
 172  * @listener: the #AccessibleEventListener instance to modify.
 173  * @callback: an #AccessibleEventListenerCB function pointer.
 174  *
 175  * Remove an in-process callback function from an existing AccessibleEventListener.
 176  *
 177  * Returns: #TRUE if successful, otherwise #FALSE.
 178  *
 179  **/
 180 SPIBoolean
 181 AccessibleEventListener_removeCallback (AccessibleEventListener  *listener,
 182                                         AccessibleEventListenerCB callback)
 183 {
 184   cspi_event_listener_remove_cb (listener, callback);
 185   return TRUE;
 186 }
 187
 188 /**
 189  * SPI_createAccessibleKeystrokeListener:
 190  * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL.
 191  * @user_data: a pointer to data which will be passed to the callback when invoked.
 192  *
 193  * Create a new #AccessibleKeystrokeListener with a specified callback function.
 194  *
 195  * Returns: a pointer to a newly-created #AccessibleKeystrokeListener.
 196  *
 197  **/
 198 AccessibleKeystrokeListener *
 199 SPI_createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback,
 200                                        void                         *user_data)
 201 {
 202   AccessibleDeviceListener *listener = cspi_device_listener_new ();
 203   if (callback)
 204     {
 205       AccessibleDeviceListener_addCallback (listener, callback, user_data);
 206     }
 207   return listener;
 208 }
 209
 210 /**
 211  * AccessibleKeystrokeListener_addCallback:
 212  * @listener: the #AccessibleKeystrokeListener instance to modify.
 213  * @callback: an #AccessibleKeystrokeListenerCB function pointer.
 214  * @user_data: a pointer to data which will be passed to the callback when invoked.
 215  *
 216  * Add an in-process callback function to an existing #AccessibleKeystrokeListener.
 217  *
 218  * Returns: #TRUE if successful, otherwise #FALSE.
 219  *
 220  **/
 221 SPIBoolean
 222 AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener,
 223                                          AccessibleKeystrokeListenerCB callback,
 224                                          void                         *user_data)
 225 {
 226   cspi_device_listener_add_cb (listener, callback, user_data);
 227   return TRUE;
 228 }
 229
 230 /**
 231  * AccessibleKeystrokeListener_removeCallback:
 232  * @listener: the #AccessibleKeystrokeListener instance to modify.
 233  * @callback: an #AccessibleKeystrokeListenerCB function pointer.
 234  *
 235  * Remove an in-process callback function from an existing #AccessibleKeystrokeListener.
 236  *
 237  * Returns: #TRUE if successful, otherwise #FALSE.
 238  *
 239  **/
 240 SPIBoolean
 241 AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener,
 242                                             AccessibleKeystrokeListenerCB callback)
 243 {
 244   cspi_device_listener_remove_cb (listener, callback);
 245   return TRUE;
 246 }
 247
 248 /**
 249  * AccessibleKeystrokeListener_unref:
 250  * @listener: a pointer to the #AccessibleKeystrokeListener being operated on.
 251  *
 252  * Decrements an #AccessibleKeystrokeListener's reference count.
 253  **/
 254 void
 255 AccessibleKeystrokeListener_unref (AccessibleKeystrokeListener *listener)
 256 {
 257   cspi_device_listener_unref (listener);
 258 }
 259
 260 /**
 261  * SPI_createAccessibleDeviceListener:
 262  * @callback : an #AccessibleDeviceListenerCB callback function, or NULL.
 263  * @user_data: a pointer to data which will be passed to the callback when invoked.
 264  *
 265  * Create a new #AccessibleDeviceListener with a specified callback function.
 266  *
 267  * Returns: a pointer to a newly-created #AccessibleDeviceListener.
 268  *
 269  **/
 270 AccessibleDeviceListener *
 271 SPI_createAccessibleDeviceListener (AccessibleDeviceListenerCB callback,
 272                                        void                         *user_data)
 273 {
 274   AccessibleDeviceListener *listener = cspi_device_listener_new ();
 275   if (callback)
 276     {
 277       AccessibleDeviceListener_addCallback (listener, callback, user_data);
 278     }
 279   return listener;
 280 }
 281
 282 /**
 283  * AccessibleDeviceListener_addCallback:
 284  * @listener: the #AccessibleDeviceListener instance to modify.
 285  * @callback: an #AccessibleDeviceListenerCB function pointer.
 286  * @user_data: a pointer to data which will be passed to the callback when invoked.
 287  *
 288  * Add an in-process callback function to an existing #AccessibleDeviceListener.
 289  *
 290  * Returns: #TRUE if successful, otherwise #FALSE.
 291  *
 292  **/
 293 SPIBoolean
 294 AccessibleDeviceListener_addCallback (AccessibleDeviceListener *listener,
 295                                          AccessibleDeviceListenerCB callback,
 296                                          void                         *user_data)
 297 {
 298   cspi_device_listener_add_cb (listener, callback, user_data);
 299   return TRUE;
 300 }
 301
 302 /**
 303  * AccessibleDeviceListener_removeCallback:
 304  * @listener: the #AccessibleDeviceListener instance to modify.
 305  * @callback: an #AccessibleDeviceListenerCB function pointer.
 306  *
 307  * Remove an in-process callback function from an existing #AccessibleDeviceListener.
 308  *
 309  * Returns: #TRUE if successful, otherwise #FALSE.
 310  *
 311  **/
 312 SPIBoolean
 313 AccessibleDeviceListener_removeCallback (AccessibleDeviceListener *listener,
 314                                             AccessibleDeviceListenerCB callback)
 315 {
 316   cspi_device_listener_remove_cb (listener, callback);
 317   return TRUE;
 318 }
 319
 320 /**
 321  * AccessibleDeviceListener_unref:
 322  * @listener: a pointer to the #AccessibleDeviceListener being operated on.
 323  *
 324  * Decrements an #AccessibleDeviceListener's reference count.
 325  **/
 326 void
 327 AccessibleDeviceListener_unref (AccessibleDeviceListener *listener)
 328 {
 329   cspi_device_listener_unref (listener);
 330 }
 331
 332 static char *
 333 cspi_internal_event_get_text (const InternalEvent *e)
 334 {
 335   CORBA_any *any;
 336   g_return_val_if_fail (e, NULL);
 337   g_return_val_if_fail (e->data, NULL);
 338   any = (CORBA_any *) e->data;
 339   if (CORBA_TypeCode_equivalent (any->_type, TC_Accessibility_EventDetails, NULL))
 340     {
 341       Accessibility_EventDetails *details = (Accessibility_EventDetails *)any->_value;
 342       if (CORBA_TypeCode_equal (details->any_data._type, TC_CORBA_string, cspi_ev()))
 343           return CORBA_string_dup (* (char **) (details->any_data._value));
 344       else
 345           return CORBA_string_dup ("");
 346       return CORBA_string_dup (* (char **) (details->any_data._value));
 347     }
 348   else if (CORBA_TypeCode_equivalent (any->_type, TC_CORBA_string, NULL))
 349     {
 350       return CORBA_string_dup (* (char **) any->_value);
 351     }
 352   else
 353     {
 354 #ifdef EVENT_CONTEXT_DEBUG
 355       fprintf (stderr, "requested string, TC is not TC_CORBA_string! (%u)\n",
 356                (unsigned) any->_type);
 357 #endif
 358       return NULL;
 359     }
 360 }
 361
 362 static Accessible *
 363 cspi_internal_event_get_object (const InternalEvent *e)
 364 {
 365   CORBA_any *any;
 366
 367   g_return_val_if_fail (e, NULL);
 368   g_return_val_if_fail (e->data, NULL);
 369
 370   any = (CORBA_any *) e->data;
 371   if (CORBA_TypeCode_equivalent (any->_type, TC_Accessibility_EventDetails, NULL))
 372     {
 373       Accessibility_EventDetails *details = (Accessibility_EventDetails *)any->_value;
 374       if (CORBA_TypeCode_equal (details->any_data._type, TC_CORBA_Object, cspi_ev()))
 375           return cspi_object_take (* (CORBA_Object *) (details->any_data._value));
 376       else
 377           return NULL;
 378     }
 379   else if (CORBA_TypeCode_equal (any->_type, TC_CORBA_Object, cspi_ev()))
 380     return cspi_object_take (* (CORBA_Object *) any->_value);
 381   else
 382     return NULL;
 383 }
 384
 385 static SPIRect *
 386 cspi_internal_event_get_rect (const InternalEvent *e)
 387 {
 388   CORBA_any *any;
 389   g_return_val_if_fail (e, NULL);
 390   g_return_val_if_fail (e->data, NULL);
 391   any = (CORBA_any *) e->data;
 392   if (CORBA_TypeCode_equivalent (any->_type, TC_Accessibility_EventDetails, NULL))
 393     {
 394       Accessibility_EventDetails *details = (Accessibility_EventDetails *)any->_value;
 395       SPIRect *rect = g_new (SPIRect, 1);
 396       if (CORBA_TypeCode_equal (details->any_data._type, TC_Accessibility_BoundingBox, cspi_ev()))
 397       {
 398           Accessibility_BoundingBox *bounds = (Accessibility_BoundingBox *) details->any_data._value;
 399           rect->x = bounds->x;
 400           rect->y = bounds->y;
 401           rect->width = bounds->width;
 402           rect->height = bounds->height;
 403           return rect;
 404       }
 405       else
 406           return NULL;
 407     }
 408   if (CORBA_TypeCode_equivalent (any->_type, TC_Accessibility_BoundingBox, NULL))
 409     {
 410       SPIRect *rect = g_new (SPIRect, 1);
 411       Accessibility_BoundingBox *bounds = (Accessibility_BoundingBox *) any->_value;
 412       rect->x = bounds->x;
 413       rect->y = bounds->y;
 414       rect->width = bounds->width;
 415       rect->height = bounds->height;
 416       return rect;
 417     }
 418   else
 419     {
 420 #ifdef EVENT_CONTEXT_DEBUG
 421       fprintf (stderr, "requested string, TC is not TC_Accessible_RectBounds! (%u)\n",
 422                (unsigned) any->_type);
 423 #endif
 424       return NULL;
 425     }
 426 }
 427
 428 /**
 429  * AccessibleEvent_getSourceName:
 430  *
 431  * Get the 'accessible-name' of the object emitting the event.
 432  * @event: an #AccessibleEvent to be queried.
 433  *
 434  * Returns: The name of the event source, or NULL if the event source cannot be identified
 435  *          or does not report a name.
 436  */
 437 char*        AccessibleEvent_getSourceName (const AccessibleEvent *e)
 438 {
 439     InternalEvent *ie = (InternalEvent *)e;
 440     CORBA_any *any = ((ie && ie->data) ? (CORBA_any *)ie->data : NULL);
 441     if (any &&
 442         CORBA_TypeCode_equivalent (any->_type,
 443                                    TC_Accessibility_EventDetails, NULL))
 444       {
 445           Accessibility_EventDetails *details = (Accessibility_EventDetails *) any->_value;
 446           return CORBA_string_dup (details->source_name);
 447       }
 448     else
 449         return NULL;
 450 }
 451
 452 /**
 453  * AccessibleEvent_getSourceRole:
 454  *
 455  * Get the #AccessibleRole of the object emitting the event.
 456  * @event: an #AccessibleEvent to be queried.
 457  *
 458  * Returns: #AccessibleRole of the event source, or SPI_ROLE_UNKNOWN
 459  *          if the event source's role is unknown or unspecified.
 460  *          (Some kinds of events, such as 'mouse:' events or
 461  *          toolkit events, don't have associated object roles.)
 462  */
 463 AccessibleRole AccessibleEvent_getSourceRole (const AccessibleEvent *e)
 464 {
 465     InternalEvent *ie = (InternalEvent *)e;
 466     CORBA_any *any = ((ie && ie->data) ? (CORBA_any *)ie->data : NULL);
 467     if (any &&
 468         CORBA_TypeCode_equivalent (any->_type,
 469                                    TC_Accessibility_EventDetails, NULL))
 470       {
 471           Accessibility_EventDetails *details = (Accessibility_EventDetails *) any->_value;
 472           return cspi_role_from_spi_role (details->source_role);
 473       }
 474     else
 475         return SPI_ROLE_UNKNOWN;
 476 }
 477
 478 /**
 479  * AccessibleEvent_getSourceApplication:
 480  *
 481  * Get the #Application hosting the object which emitted the event.
 482  * @event: an #AccessibleEvent to be queried.
 483  *
 484  * Returns: A pointer to the host #Application contining the event source
 485  *          component.
 486  */
 487 AccessibleApplication* AccessibleEvent_getSourceApplication (const AccessibleEvent *e)
 488 {
 489     InternalEvent *ie = (InternalEvent *)e;
 490     CORBA_any *any = ((ie && ie->data) ? (CORBA_any *)ie->data : NULL);
 491     if (any &&
 492         CORBA_TypeCode_equivalent (any->_type,
 493                                    TC_Accessibility_EventDetails, NULL))
 494       {
 495           Accessibility_EventDetails *details = (Accessibility_EventDetails *) any->_value;
 496           return  cspi_object_take (details->host_application);
 497       }
 498     else
 499         return NULL;
 500 }
 501
 502 /**
 503  * AccessibleEvent_getSourceApplication:
 504  *
 505  * Get the host #Application, "accessible name", and #AccessibleRole
 506  * of the object which emitted the event.
 507  *
 508  * @event: an #AccessibleEvent to be queried.
 509  *
 510  * Returns: TRUE if the source details were successfully retrieved,
 511  *          FALSE if they were not, either due to error, incomplete data,
 512  *          or the fact that the event did not encapsulate the required data.
 513  */
 514 SPIBoolean   AccessibleEvent_getSourceDetails (const AccessibleEvent *e,
 515                                                char **name, AccessibleRole *role,
 516                                                AccessibleApplication **app)
 517 {
 518     InternalEvent *ie = (InternalEvent *)e;
 519     CORBA_any *any = ((ie && ie->data) ? (CORBA_any *)ie->data : NULL);
 520     if (any &&
 521         CORBA_TypeCode_equivalent (any->_type,
 522                                    TC_Accessibility_EventDetails, NULL))
 523       {
 524           Accessibility_EventDetails *details = (Accessibility_EventDetails *) any->_value;
 525           *name = CORBA_string_dup (details->source_name);
 526           *role = cspi_role_from_spi_role (details->source_role);
 527           *app = cspi_object_take (details->host_application);
 528           return TRUE;
 529       }
 530     else
 531       {
 532         *name = NULL;
 533         *role = SPI_ROLE_UNKNOWN;
 534         *app = NULL;
 535         return FALSE;
 536       }
 537 }
 538
 539 /**
 540  * AccessibleTextChangedEvent_getChangeString:
 541  * @e: a pointer to the #AccessibleEvent being queried.
 542  *
 543  * Queries an #AccessibleEvent of type "object:text-changed",
 544  *         returning the text inserted or deleted.
 545  *
 546  * Returns: a UTF-8 text string indicating the text inserted,
 547  *          deleted, or substituted by this event.
 548  **/
 549 char *
 550 AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e)
 551 {
 552   const InternalEvent *foo = (InternalEvent *) e;
 553   /* TODO: check the event type. */
 554   return cspi_internal_event_get_text (foo);
 555 }
 556
 557 /**
 558  * AccessibleTextSelectionChangedEvent_getSelectionString:
 559  * @e: a pointer to the #AccessibleEvent being queried.
 560  *
 561  * Queries an #AccessibleEvent of type "object:text-selection-changed",
 562  *         returning the newly added, removed, or modified selection string.
 563  *
 564  * Returns: a UTF-8 text string indicating the recently changed selection.
 565  **/
 566 char *
 567 AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e)
 568 {
 569   const InternalEvent *foo = (InternalEvent *) e;
 570   /* TODO: check the event type. */
 571   return cspi_internal_event_get_text (foo);
 572 }
 573
 574 /**
 575  * AccessibleWindowEvent_getTitleString:
 576  * @e: a pointer to the #AccessibleEvent being queried.
 577  *
 578  * Queries an #AccessibleEvent of type "window:",
 579  *         returning the window title.
 580  *
 581  * Returns: a UTF-8 text string representing the title of the
 582  *         recently changed window.
 583  **/
 584 char *
 585 AccessibleWindowEvent_getTitleString (const AccessibleEvent *e)
 586 {
 587   const InternalEvent *foo = (InternalEvent *) e;
 588   /* TODO: check the event type. */
 589   return cspi_internal_event_get_text (foo);
 590 }
 591
 592 /**
 593  * AccessibleChildChangedEvent_getChildAccessible:
 594  * @e: a pointer to the #AccessibleEvent being queried.
 595  *
 596  * Queries an #AccessibleEvent of type "object:children_changed"
 597  *         to get a reference to the changed #Accessible.
 598  *         Note that context #Accessibles are not guaranteed to outlive
 599  *         event delivery, in which case this call may return %NULL
 600  *         even if the object existed at the time of dispatch.
 601  *
 602  * Returns: the context #Accessible for the event, or %NULL if
 603  *          there is no longer a valid context #Accessible
 604  *          object for the event.
 605  **/
 606 Accessible *
 607 AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e)
 608 {
 609   const InternalEvent *foo = (InternalEvent *) e;
 610   return (Accessible *) cspi_internal_event_get_object (foo);
 611 }
 612
 613 /**
 614  * AccessibleParentChangedEvent_getParentAccessible:
 615  * @e: a pointer to the #AccessibleEvent being queried.
 616  *
 617  * Queries an #AccessibleEvent of type "object:property-change:accessible-parent"
 618  *         to get a reference to the changed #Accessible.
 619  *         Note that context #Accessibles are not guaranteed to outlive
 620  *         event delivery, in which case this call may return %NULL
 621  *         even if the object existed at the time of dispatch.
 622  *
 623  * Returns: an #Accessible pointer representing the new parent object.
 624  **/
 625 Accessible *
 626 AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e)
 627 {
 628   const InternalEvent *foo = (InternalEvent *) e;
 629   return (Accessible *) cspi_internal_event_get_object (foo);
 630 }
 631
 632 /**
 633  * AccessibleActiveDescendantChangedEvent_getActiveDescendant:
 634  * @e: a pointer to the #AccessibleEvent being queried.
 635  *
 636  * Queries an #AccessibleEvent of type "object:active-descendant-changed"
 637  *         to get a reference to the changed #Accessible.
 638  *         Note that context #Accessibles are not guaranteed to outlive
 639  *         event delivery, in which case this call may return %NULL
 640  *         even if the object existed at the time of dispatch.
 641  *
 642  * Returns: an #Accessible pointer representing the new active descendant.
 643  **/
 644 Accessible *
 645 AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e)
 646 {
 647   const InternalEvent *foo = (InternalEvent *) e;
 648   return (Accessible *) cspi_internal_event_get_object (foo);
 649 }
 650
 651 /**
 652  * AccessibleTableSummaryChangedEvent_getSummaryAccessible:
 653  * @e: a pointer to the #AccessibleEvent being queried.
 654  *
 655  * Queries an #AccessibleEvent of type "object:property-changed:accessible-table-summary"
 656  *         to get a reference to the changed #Accessible.
 657  *         Note that context #Accessibles are not guaranteed to outlive
 658  *         event delivery, in which case this call may return %NULL
 659  *         even if the object existed at the time of dispatch.
 660  *
 661  * Returns: an #Accessible pointer representing the new table summary.
 662  **/
 663 Accessible *
 664 AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e)
 665 {
 666   const InternalEvent *foo = (InternalEvent *) e;
 667   return (Accessible *) cspi_internal_event_get_object (foo);
 668 }
 669
 670 /**
 671  * AccessibleTableHeaderChangedEvent_getHeaderAccessible:
 672  * @e: a pointer to the #AccessibleEvent being queried.
 673  *
 674  * Queries an #AccessibleEvent of type
 675  *         "object:property-changed:accessible-table-row-header" or
 676  *         "object:property-changed:accessible-table-column-header"
 677  *         to get a reference to the changed #Accessible.
 678  *         Note that context #Accessibles are not guaranteed to outlive
 679  *         event delivery, in which case this call may return %NULL
 680  *         even if the object existed at the time of dispatch.
 681  *
 682  * Returns: an #Accessible pointer representing the new table header.
 683  **/
 684 Accessible *
 685 AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e)
 686 {
 687   const InternalEvent *foo = (InternalEvent *) e;
 688   return (Accessible *) cspi_internal_event_get_object (foo);
 689 }
 690
 691
 692 /**
 693  * AccessibleTableCaptionChangedEvent_getCaptionString:
 694  * @e: a pointer to the #AccessibleEvent being queried.
 695  *
 696  * Queries an #AccessibleEvent of type
 697  *         "object:property-changed:accessible-table-caption-object"
 698  *         returning the text in the caption, if present.
 699  *
 700  * Returns: a UTF-8 text string indicating the text in the caption.
 701  **/
 702 char *
 703 AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e)
 704 {
 705   const InternalEvent *foo = (InternalEvent *) e;
 706   /* TODO: check the event type. */
 707   return cspi_internal_event_get_text (foo);
 708 }
 709
 710 /**
 711  * AccessibleTableRowDescriptionChangedEvent_getDescriptionString:
 712  * @e: a pointer to the #AccessibleEvent being queried.
 713  *
 714  * Queries an #AccessibleEvent of type
 715  *         "object:property-changed:accessible-table-row-description"
 716  *         returning the new table row description.
 717  *
 718  * Returns: a UTF-8 text string representing the recently changed
 719  *         table row description
 720  **/
 721 char *
 722 AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 723 {
 724   const InternalEvent *foo = (InternalEvent *) e;
 725   /* TODO: check the event type. */
 726   return cspi_internal_event_get_text (foo);
 727 }
 728
 729 /**
 730  * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString:
 731  * @e: a pointer to the #AccessibleEvent being queried.
 732  *
 733  * Queries an #AccessibleEvent of type
 734  *         "object:property-changed:accessible-table-column-description"
 735  *         returning the new table column description.
 736  *
 737  * Returns: a UTF-8 text string representing the recently changed
 738  *         table column description
 739  **/
 740 char *
 741 AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 742 {
 743   const InternalEvent *foo = (InternalEvent *) e;
 744   /* TODO: check the event type. */
 745   return cspi_internal_event_get_text (foo);
 746 }
 747
 748 /**
 749  * AccessibleDescriptionChangedEvent_getDescriptionString:
 750  * @e: a pointer to the #AccessibleEvent being queried.
 751  *
 752  * Queries an #AccessibleEvent of type
 753  *         "object:property-changed:accessible-description"
 754  *         returning the new description.
 755  *
 756  * Returns: a UTF-8 text string representing the recently changed
 757  *         description
 758  **/
 759 char *
 760 AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e)
 761 {
 762   const InternalEvent *foo = (InternalEvent *) e;
 763   /* TODO: check the event type. */
 764   return cspi_internal_event_get_text (foo);
 765 }
 766
 767 /**
 768  * AccessibleBoundsChangedEvent_getNewBounds:
 769  * @e: a pointer to the #AccessibleEvent being queried.
 770  *
 771  * Queries an #AccessibleEvent of type "object:bounds-changed",
 772  *         returning a pointer to an SPIRect structure containing the
 773  *         new bounds, or NULL on error.
 774  *         The returned structure should be freed with SPI_freeRect when
 775  *         the caller has finished referencing it.
 776  *
 777  * Returns: a pointer to an SPIRect defining the new object bounds.
 778  **/
 779 SPIRect *
 780 AccessibleBoundsChangedEvent_getNewBounds (const AccessibleEvent *e)
 781 {
 782   const InternalEvent *foo = (InternalEvent *) e;
 783   /* TODO: check the event type. */
 784   return cspi_internal_event_get_rect (foo);
 785 }
 786
 787 static gint
 788 cspi_event_compare (gconstpointer p1, gconstpointer p2)
 789 {
 790   const InternalEvent *e1 = p1, *e2 = p2;
 791   return (gint) ((long) e2->id  - (long) e1->id);
 792 }
 793
 794 static InternalEvent *
 795 cspi_internal_event_lookup (const InternalEvent *e)
 796 {
 797   InternalEvent *internal = NULL;
 798   GSList *p =
 799     g_slist_find_custom (_cspi_event_queue, e, cspi_event_compare);
 800   if (p)
 801     internal = p->data;
 802   return internal;
 803 }
 804
 805 static const InternalEvent *
 806 cspi_internal_event_check (const AccessibleEvent *e)
 807 {
 808   InternalEvent *internal = (InternalEvent *) e;
 809   if (internal->magic == SPI_INTERNAL_EVENT_MAGIC)
 810     return internal;
 811   else
 812     return NULL;
 813 }
 814
 815 static InternalEvent *
 816 cspi_internal_event_add (const InternalEvent *e)
 817 {
 818   _cspi_event_queue = g_slist_prepend (_cspi_event_queue, (gpointer) e);
 819   return (InternalEvent *) e;
 820 }
 821
 822 static void
 823 cspi_internal_event_remove (const InternalEvent *e)
 824 {
 825   GSList *link = g_slist_find_custom (_cspi_event_queue, e, cspi_event_compare);
 826   if (link)
 827     _cspi_event_queue = g_slist_remove_link (_cspi_event_queue, link);
 828 }
 829
 830 /**
 831  * AccessibleNameChangedEvent_getNameString:
 832  * @e: a pointer to the #AccessibleEvent being queried.
 833  *
 834  * Queries an #AccessibleEvent of type "object:property-change:accessible_name:",
 835  *         returning the name.
 836  *
 837  * Returns: a UTF-8 text string representing the name of the
 838  *         object which recently changed.
 839  **/
 840 char *
 841 AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e)
 842 {
 843   const InternalEvent *foo = (InternalEvent *) e;
 844   return cspi_internal_event_get_text (foo);
 845 }
 846
 847 /**
 848  * AccessibleEvent_ref:
 849  * @e: a pointer to the #AccessibleEvent being referenced.
 850  *
 851  * Increments by 1 the reference count of the event
 852  *
 853  * Returns: TRUE if the function succeeded; FALSE if the pointer is not a
 854  *         valid event.
 855  **/
 856 SPIBoolean
 857 AccessibleEvent_ref (const AccessibleEvent *e)
 858 {
 859   const InternalEvent *private = cspi_internal_event_check (e);
 860   if (private)
 861     {
 862       InternalEvent *event = cspi_internal_event_lookup (private);
 863       /*
 864        * put event in the cache if it's not there already,
 865        * and increment refcount
 866        */
 867       if (!event)
 868         {
 869           event = cspi_internal_event_add (private);
 870         }
 871       event->ref_count++;
 872       return TRUE;
 873     }
 874   else
 875     return FALSE;
 876 }
 877
 878 /**
 879  * AccessibleEvent_unref:
 880  * @e: a pointer to the #AccessibleEvent being referenced.
 881  *
 882  * Decrements by 1 the reference count of the event. The event is destroyed
 883  * when the reference count recahes zero.
 884  *
 885  **/
 886 void
 887 AccessibleEvent_unref (const AccessibleEvent *e)
 888 {
 889   const InternalEvent *private = cspi_internal_event_check (e);
 890   /* decrement refcount and remove if appropriate */
 891   if (private)
 892     {
 893       InternalEvent *event = cspi_internal_event_lookup (private);
 894       if (event)
 895         {
 896           event->ref_count--;
 897           if (event->ref_count < 1)
 898             {
 899               cspi_internal_event_remove (event);
 900               g_free ((gpointer)e->type);
 901               Accessible_unref (e->source);
 902               CORBA_free (event->data);
 903               g_free ((gpointer)e);
 904             }
 905         }
 906     }
 907 }