libspi/accessible.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /* accessible.c: the core of the accessibility implementation */
  24
  25 #include <config.h>
  26 #include <stdio.h>
  27 #include <bonobo/bonobo-exception.h>
  28 #include <atk/atk.h>
  29 #include <libspi/libspi.h>
  30
  31 /* Our parent Gtk object type  */
  32 #define PARENT_TYPE SPI_TYPE_BASE
  33
  34 static gboolean spi_init_role_lookup_table (Accessibility_Role *role_table);
  35 static Accessibility_Role spi_role_from_atk_role (AtkRole role);
  36
  37 static gboolean
  38 spi_init_role_lookup_table (Accessibility_Role *role_table)
  39 {
  40   int i;
  41   /* if it's not in the list below, dunno what it is */
  42   for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
  43     {
  44       role_table [i] = Accessibility_ROLE_UNKNOWN;
  45     }
  46
  47   role_table [ATK_ROLE_INVALID] =          Accessibility_ROLE_INVALID;
  48   role_table [ATK_ROLE_ACCEL_LABEL] =      Accessibility_ROLE_ACCELERATOR_LABEL;
  49   role_table [ATK_ROLE_ALERT] =            Accessibility_ROLE_ALERT;
  50   role_table [ATK_ROLE_ANIMATION] =        Accessibility_ROLE_ANIMATION;
  51   role_table [ATK_ROLE_ARROW] =            Accessibility_ROLE_ARROW;
  52   role_table [ATK_ROLE_CALENDAR] =         Accessibility_ROLE_CALENDAR;
  53   role_table [ATK_ROLE_CANVAS] =           Accessibility_ROLE_CANVAS;
  54   role_table [ATK_ROLE_CHECK_BOX] =        Accessibility_ROLE_CHECK_BOX;
  55   role_table [ATK_ROLE_CHECK_MENU_ITEM] =  Accessibility_ROLE_CHECK_MENU_ITEM;
  56   role_table [ATK_ROLE_COLOR_CHOOSER] =    Accessibility_ROLE_COLOR_CHOOSER;
  57   role_table [ATK_ROLE_COLUMN_HEADER] =    Accessibility_ROLE_COLUMN_HEADER;
  58   role_table [ATK_ROLE_COMBO_BOX] =        Accessibility_ROLE_COMBO_BOX;
  59   role_table [ATK_ROLE_DATE_EDITOR] =      Accessibility_ROLE_DATE_EDITOR;
  60   role_table [ATK_ROLE_DESKTOP_ICON] =     Accessibility_ROLE_DESKTOP_ICON;
  61   role_table [ATK_ROLE_DESKTOP_FRAME] =    Accessibility_ROLE_DESKTOP_FRAME;
  62   role_table [ATK_ROLE_DIAL] =             Accessibility_ROLE_DIAL;
  63   role_table [ATK_ROLE_DIALOG] =           Accessibility_ROLE_DIALOG;
  64   role_table [ATK_ROLE_DIRECTORY_PANE] =   Accessibility_ROLE_DIRECTORY_PANE;
  65   role_table [ATK_ROLE_FILE_CHOOSER] =     Accessibility_ROLE_FILE_CHOOSER;
  66   role_table [ATK_ROLE_FILLER] =           Accessibility_ROLE_FILLER;
  67   role_table [ATK_ROLE_FONT_CHOOSER] =     Accessibility_ROLE_FONT_CHOOSER;
  68   role_table [ATK_ROLE_FRAME] =            Accessibility_ROLE_FRAME;
  69   role_table [ATK_ROLE_GLASS_PANE] =       Accessibility_ROLE_GLASS_PANE;
  70   role_table [ATK_ROLE_HTML_CONTAINER] =   Accessibility_ROLE_HTML_CONTAINER;
  71   role_table [ATK_ROLE_ICON] =             Accessibility_ROLE_ICON;
  72   role_table [ATK_ROLE_IMAGE] =            Accessibility_ROLE_IMAGE;
  73   role_table [ATK_ROLE_INTERNAL_FRAME] =   Accessibility_ROLE_INTERNAL_FRAME;
  74   role_table [ATK_ROLE_LABEL] =            Accessibility_ROLE_LABEL;
  75   role_table [ATK_ROLE_LAYERED_PANE] =     Accessibility_ROLE_LAYERED_PANE;
  76   role_table [ATK_ROLE_LIST] =             Accessibility_ROLE_LIST;
  77   role_table [ATK_ROLE_LIST_ITEM] =        Accessibility_ROLE_LIST_ITEM;
  78   role_table [ATK_ROLE_MENU] =             Accessibility_ROLE_MENU;
  79   role_table [ATK_ROLE_MENU_BAR] =         Accessibility_ROLE_MENU_BAR;
  80   role_table [ATK_ROLE_MENU_ITEM] =        Accessibility_ROLE_MENU_ITEM;
  81   role_table [ATK_ROLE_OPTION_PANE] =      Accessibility_ROLE_OPTION_PANE;
  82   role_table [ATK_ROLE_PAGE_TAB] =         Accessibility_ROLE_PAGE_TAB;
  83   role_table [ATK_ROLE_PAGE_TAB_LIST] =    Accessibility_ROLE_PAGE_TAB_LIST;
  84   role_table [ATK_ROLE_PANEL] =            Accessibility_ROLE_PANEL;
  85   role_table [ATK_ROLE_PASSWORD_TEXT] =    Accessibility_ROLE_PASSWORD_TEXT;
  86   role_table [ATK_ROLE_POPUP_MENU] =       Accessibility_ROLE_POPUP_MENU;
  87   role_table [ATK_ROLE_PROGRESS_BAR] =     Accessibility_ROLE_PROGRESS_BAR;
  88   role_table [ATK_ROLE_PUSH_BUTTON] =      Accessibility_ROLE_PUSH_BUTTON;
  89   role_table [ATK_ROLE_RADIO_BUTTON] =     Accessibility_ROLE_RADIO_BUTTON;
  90   role_table [ATK_ROLE_RADIO_MENU_ITEM] =  Accessibility_ROLE_RADIO_MENU_ITEM;
  91   role_table [ATK_ROLE_ROOT_PANE] =        Accessibility_ROLE_ROOT_PANE;
  92   role_table [ATK_ROLE_ROW_HEADER] =       Accessibility_ROLE_ROW_HEADER;
  93   role_table [ATK_ROLE_SCROLL_BAR] =       Accessibility_ROLE_SCROLL_BAR;
  94   role_table [ATK_ROLE_SCROLL_PANE] =      Accessibility_ROLE_SCROLL_PANE;
  95   role_table [ATK_ROLE_SEPARATOR] =        Accessibility_ROLE_SEPARATOR;
  96   role_table [ATK_ROLE_SLIDER] =           Accessibility_ROLE_SLIDER;
  97   role_table [ATK_ROLE_SPLIT_PANE] =       Accessibility_ROLE_SPLIT_PANE;
  98   role_table [ATK_ROLE_SPIN_BUTTON] =      Accessibility_ROLE_SPIN_BUTTON;
  99   role_table [ATK_ROLE_STATUSBAR] =        Accessibility_ROLE_STATUS_BAR;
 100   role_table [ATK_ROLE_TABLE] =            Accessibility_ROLE_TABLE;
 101   role_table [ATK_ROLE_TABLE_CELL] =       Accessibility_ROLE_TABLE_CELL;
 102   role_table [ATK_ROLE_TABLE_COLUMN_HEADER] =
 103                                            Accessibility_ROLE_COLUMN_HEADER;
 104   role_table [ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
 105   role_table [ATK_ROLE_TEAR_OFF_MENU_ITEM] =
 106                                            Accessibility_ROLE_TEAROFF_MENU_ITEM;
 107   role_table [ATK_ROLE_TERMINAL] =         Accessibility_ROLE_TERMINAL;
 108   role_table [ATK_ROLE_TEXT] =             Accessibility_ROLE_TEXT;
 109   role_table [ATK_ROLE_TOGGLE_BUTTON] =    Accessibility_ROLE_TOGGLE_BUTTON;
 110   role_table [ATK_ROLE_TOOL_BAR] =         Accessibility_ROLE_TOOL_BAR;
 111   role_table [ATK_ROLE_TOOL_TIP] =         Accessibility_ROLE_TOOL_TIP;
 112   role_table [ATK_ROLE_TREE] =             Accessibility_ROLE_TREE;
 113   role_table [ATK_ROLE_TREE_TABLE] =       Accessibility_ROLE_TREE_TABLE;
 114   role_table [ATK_ROLE_UNKNOWN] =          Accessibility_ROLE_UNKNOWN;
 115   role_table [ATK_ROLE_VIEWPORT] =         Accessibility_ROLE_VIEWPORT;
 116   role_table [ATK_ROLE_WINDOW] =           Accessibility_ROLE_WINDOW;
 117   role_table [ATK_ROLE_LAST_DEFINED] =     Accessibility_ROLE_EXTENDED;
 118
 119   return TRUE;
 120 }
 121
 122 static Accessibility_Role
 123 spi_role_from_atk_role (AtkRole role)
 124 {
 125   static gboolean is_initialized = FALSE;
 126   static Accessibility_Role spi_role_table [ATK_ROLE_LAST_DEFINED];
 127   Accessibility_Role spi_role;
 128
 129   if (!is_initialized)
 130    {
 131      is_initialized = spi_init_role_lookup_table (spi_role_table);
 132    }
 133
 134   if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
 135     {
 136       spi_role = spi_role_table [role];
 137     }
 138   else
 139     {
 140       spi_role = Accessibility_ROLE_EXTENDED;
 141     }
 142   return spi_role;
 143 }
 144
 145 static AtkObject *
 146 get_atkobject_from_servant (PortableServer_Servant servant)
 147 {
 148   SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
 149
 150   g_return_val_if_fail (object, NULL);
 151   g_return_val_if_fail (ATK_IS_OBJECT(object->gobj), NULL);
 152   return ATK_OBJECT(object->gobj);
 153 }
 154
 155 /*
 156  * CORBA Accessibility::Accessible::get_name method implementation
 157  */
 158 static CORBA_char *
 159 impl_accessibility_accessible_get_name (PortableServer_Servant servant,
 160                                         CORBA_Environment     *ev)
 161 {
 162   const gchar *name;
 163   CORBA_char  *retval;
 164   AtkObject   *object = get_atkobject_from_servant (servant);
 165
 166   g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
 167
 168   name = atk_object_get_name (object);
 169
 170   if (name)
 171     {
 172       retval = CORBA_string_dup (name);
 173     }
 174   else
 175     {
 176       retval = CORBA_string_dup ("");
 177     }
 178
 179   return retval;
 180 }
 181
 182 /*
 183  * CORBA Accessibility::Accessible::set_name method implementation
 184  */
 185 static void
 186 impl_accessibility_accessible_set_name (PortableServer_Servant servant,
 187                                         const CORBA_char      *name,
 188                                         CORBA_Environment     *ev)
 189 {
 190   AtkObject *object = get_atkobject_from_servant (servant);
 191
 192   g_return_if_fail (object != NULL);
 193
 194   atk_object_set_name (object, name);
 195 }
 196
 197 /*
 198  * CORBA Accessibility::Accessible::get_description method implementation
 199  */
 200 static CORBA_char *
 201 impl_accessibility_accessible_get_description (PortableServer_Servant servant,
 202                                                CORBA_Environment     *ev)
 203 {
 204   const gchar *descr;
 205   CORBA_char  *retval;
 206   AtkObject   *object = get_atkobject_from_servant (servant);
 207
 208   g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
 209
 210   descr = atk_object_get_description (object);
 211
 212   if (descr)
 213     {
 214       retval = CORBA_string_dup (descr);
 215     }
 216   else
 217     {
 218       retval = CORBA_string_dup ("");
 219     }
 220
 221   return retval;
 222 }
 223
 224 /*
 225  * CORBA Accessibility::Accessible::set_description method implementation
 226  */
 227 static void
 228 impl_accessibility_accessible_set_description (PortableServer_Servant servant,
 229                                                const CORBA_char      *descr,
 230                                                CORBA_Environment     *ev)
 231 {
 232   AtkObject *object = get_atkobject_from_servant (servant);
 233
 234   g_return_if_fail (object != NULL);
 235
 236   atk_object_set_description (object, descr);
 237 }
 238
 239 /*
 240  * CORBA Accessibility::Accessible::get_parent method implementation
 241  */
 242 static Accessibility_Accessible
 243 impl_accessibility_accessible_get_parent (PortableServer_Servant servant,
 244                                           CORBA_Environment     *ev)
 245 {
 246   AtkObject *parent;
 247   AtkObject *object = get_atkobject_from_servant (servant);
 248
 249   g_return_val_if_fail (object != NULL, CORBA_OBJECT_NIL);
 250
 251   parent = atk_object_get_parent (object);
 252
 253   return spi_accessible_new_return (parent, FALSE, ev);
 254 }
 255
 256 /*
 257  * CORBA Accessibility::Accessible::get_IndexInParent method implementation
 258  */
 259 static CORBA_long
 260 impl_accessibility_accessible_get_index_in_parent (PortableServer_Servant servant,
 261                                                    CORBA_Environment     *ev)
 262 {
 263   AtkObject *object = get_atkobject_from_servant (servant);
 264
 265   g_return_val_if_fail (object != NULL, -1);
 266
 267   return atk_object_get_index_in_parent (object);
 268 }
 269
 270 /*
 271  * CORBA Accessibility::Accessible::get_childCount method implementation
 272  */
 273 static CORBA_long
 274 impl_accessibility_accessible_get_child_count (PortableServer_Servant servant,
 275                                                CORBA_Environment     *ev)
 276 {
 277   AtkObject *object = get_atkobject_from_servant (servant);
 278
 279   g_return_val_if_fail (object != NULL, 0);
 280
 281   return atk_object_get_n_accessible_children (object);
 282 }
 283
 284 /*
 285  * CORBA Accessibility::Accessible::getChildAtIndex method implementation
 286  */
 287 static Accessibility_Accessible
 288 impl_accessibility_accessible_get_child_at_index (PortableServer_Servant servant,
 289                                                   const CORBA_long      index,
 290                                                   CORBA_Environment     *ev)
 291 {
 292   AtkObject *child;
 293   AtkObject *object = get_atkobject_from_servant (servant);
 294
 295   g_return_val_if_fail (object != NULL, 0);
 296
 297   child = atk_object_ref_accessible_child (object, index);
 298
 299   return spi_accessible_new_return (child, TRUE, ev);
 300 }
 301
 302 /*
 303  * CORBA Accessibility::Accessible::getState method implementation
 304  */
 305 static Accessibility_StateSet
 306 impl_accessibility_accessible_get_state (PortableServer_Servant servant,
 307                                          CORBA_Environment     *ev)
 308 {
 309   AtkObject *object = get_atkobject_from_servant (servant);
 310
 311   bonobo_return_val_if_fail (object != NULL, NULL, ev);
 312
 313   printf ("SpiAccessible get_state.\n");
 314
 315   /* TODO: implement the bonobo stateset class */
 316   return (Accessibility_StateSet) NULL;
 317 }
 318
 319 /*
 320  * CORBA Accessibility::Accessible::getRelationSet method implementation
 321  */
 322 static Accessibility_RelationSet *
 323 impl_accessibility_accessible_get_relation_set (PortableServer_Servant servant,
 324                                                 CORBA_Environment     *ev)
 325 {
 326   Accessibility_RelationSet *retval;
 327   gint n_relations;
 328   gint i;
 329   AtkRelationSet *relation_set;
 330   AtkObject      *object = get_atkobject_from_servant (servant);
 331
 332   bonobo_return_val_if_fail (object != NULL, NULL, ev);
 333
 334   relation_set = atk_object_ref_relation_set (object);
 335
 336   n_relations = atk_relation_set_get_n_relations (relation_set);
 337   retval = CORBA_sequence_Accessibility_Relation__alloc ();
 338   CORBA_sequence_Accessibility_Relation_allocbuf (n_relations);
 339
 340   for (i = 0; i < n_relations; ++i)
 341     {
 342       retval->_buffer[i] =
 343         bonobo_object_dup_ref (
 344           BONOBO_OBJREF (
 345             spi_relation_new (atk_relation_set_get_relation (relation_set, i))),
 346           ev);
 347     }
 348
 349   printf ("SpiAccessible get_relation_set.\n");
 350   return retval;
 351 }
 352
 353 /*
 354  * CORBA Accessibility::Accessible::getRole method implementation
 355  */
 356 static Accessibility_Role
 357 impl_accessibility_accessible_get_role (PortableServer_Servant servant,
 358                                         CORBA_Environment     *ev)
 359 {
 360   AtkRole            role;
 361   Accessibility_Role retval;
 362   AtkObject         *object = get_atkobject_from_servant (servant);
 363
 364   g_return_val_if_fail (object != NULL, 0);
 365
 366   role = atk_object_get_role (object);
 367   retval = spi_role_from_atk_role (role);
 368
 369   return retval;
 370 }
 371
 372 /*
 373  * CORBA Accessibility::Accessible::getRole method implementation
 374  */
 375 static CORBA_char *
 376 impl_accessibility_accessible_get_role_name (PortableServer_Servant servant,
 377                                              CORBA_Environment     *ev)
 378 {
 379   AtkRole            role;
 380   Accessibility_Role retval;
 381   AtkObject         *object = get_atkobject_from_servant (servant);
 382
 383   g_return_val_if_fail (object != NULL, 0);
 384
 385   role = atk_object_get_role (object);
 386
 387   return CORBA_string_dup (atk_role_get_name (role));
 388 }
 389
 390 static void
 391 spi_accessible_class_init (SpiAccessibleClass *klass)
 392 {
 393         POA_Accessibility_Accessible__epv *epv = &klass->epv;
 394
 395         epv->_get_name = impl_accessibility_accessible_get_name;
 396         epv->_set_name = impl_accessibility_accessible_set_name;
 397         epv->_get_description = impl_accessibility_accessible_get_description;
 398         epv->_set_description = impl_accessibility_accessible_set_description;
 399
 400         epv->_get_parent = impl_accessibility_accessible_get_parent;
 401         epv->_get_childCount = impl_accessibility_accessible_get_child_count;
 402         epv->getChildAtIndex = impl_accessibility_accessible_get_child_at_index;
 403         epv->getIndexInParent = impl_accessibility_accessible_get_index_in_parent;
 404
 405         epv->getRelationSet = impl_accessibility_accessible_get_relation_set;
 406         epv->getState = impl_accessibility_accessible_get_state;
 407         epv->getRole = impl_accessibility_accessible_get_role;
 408         epv->getRoleName = impl_accessibility_accessible_get_role_name;
 409 }
 410
 411 static void
 412 spi_accessible_init (SpiAccessible *accessible)
 413 {
 414 }
 415
 416 BONOBO_TYPE_FUNC_FULL (SpiAccessible,
 417                        Accessibility_Accessible,
 418                        PARENT_TYPE,
 419                        spi_accessible);
 420
 421 static GHashTable *public_corba_refs = NULL;
 422
 423 static GHashTable *
 424 get_public_refs (void)
 425 {
 426   if (!public_corba_refs)
 427     {
 428       public_corba_refs = g_hash_table_new (NULL, NULL);
 429     }
 430   return public_corba_refs;
 431 }
 432
 433 static void
 434 de_register_public_ref (SpiBase *object)
 435 {
 436   g_hash_table_remove (get_public_refs (), object->gobj);
 437 }
 438
 439 SpiAccessible *
 440 spi_accessible_new (AtkObject *o)
 441 {
 442     SpiAccessible *retval;
 443     CORBA_Environment ev;
 444
 445     CORBA_exception_init (&ev);
 446
 447     g_assert (o);
 448
 449     if ((retval = g_hash_table_lookup (get_public_refs (), o)))
 450       {
 451         bonobo_object_ref (BONOBO_OBJECT (retval));
 452         return retval;
 453       }
 454
 455     retval = g_object_new (SPI_ACCESSIBLE_TYPE, NULL);
 456
 457     spi_base_construct (SPI_BASE (retval), G_OBJECT(o));
 458
 459     g_hash_table_insert (get_public_refs (), o, retval);
 460     g_signal_connect (G_OBJECT (retval), "destroy",
 461                       G_CALLBACK (de_register_public_ref),
 462                       NULL);
 463
 464     /* aggregate appropriate SPI interfaces based on ATK interfaces */
 465
 466     if (ATK_IS_ACTION (o))
 467       {
 468         bonobo_object_add_interface (bonobo_object (retval),
 469                                      BONOBO_OBJECT (spi_action_interface_new (o)));
 470       }
 471
 472     if (ATK_IS_COMPONENT (o))
 473       {
 474         bonobo_object_add_interface (bonobo_object (retval),
 475                                      BONOBO_OBJECT (spi_component_interface_new (o)));
 476       }
 477
 478     if (ATK_IS_EDITABLE_TEXT (o))
 479       {
 480         bonobo_object_add_interface (bonobo_object (retval),
 481                                      BONOBO_OBJECT(spi_editable_text_interface_new (o)));
 482       }
 483
 484     else if (ATK_IS_TEXT (o))
 485       {
 486         bonobo_object_add_interface (bonobo_object (retval),
 487                                      BONOBO_OBJECT (spi_text_interface_new (o)));
 488       }
 489
 490     if (ATK_IS_HYPERTEXT (o))
 491       {
 492         bonobo_object_add_interface (bonobo_object (retval),
 493                                      BONOBO_OBJECT (spi_hypertext_interface_new (o)));
 494       }
 495
 496     if (ATK_IS_IMAGE (o))
 497       {
 498         bonobo_object_add_interface (bonobo_object (retval),
 499                                      BONOBO_OBJECT (spi_image_interface_new (o)));
 500       }
 501
 502     if (ATK_IS_SELECTION (o))
 503       {
 504         bonobo_object_add_interface (bonobo_object (retval),
 505                                      BONOBO_OBJECT (spi_selection_interface_new (o)));
 506       }
 507
 508     if (ATK_IS_TABLE (o))
 509       {
 510         bonobo_object_add_interface (bonobo_object (retval),
 511                                      BONOBO_OBJECT (spi_table_interface_new (o)));
 512       }
 513
 514     if (ATK_IS_VALUE (o))
 515       {
 516         bonobo_object_add_interface (bonobo_object (retval),
 517                                      BONOBO_OBJECT (spi_value_interface_new (o)));
 518       }
 519
 520     return retval;
 521 }
 522
 523 /**
 524  * spi_accessible_new_return:
 525  * @o: an AtkObject or NULL
 526  * @release_ref: whether to unref this AtkObject before return
 527  * @ev: a CORBA environment
 528  *
 529  * A helper function to instantiate a CORBA accessiblility
 530  * proxy from an AtkObject.
 531  *
 532  * Return value: the proxy or CORBA_OBJECT_NIL
 533  **/
 534 Accessibility_Accessible
 535 spi_accessible_new_return (AtkObject         *o,
 536                            gboolean           release_ref,
 537                            CORBA_Environment *ev)
 538 {
 539   SpiAccessible *accessible;
 540
 541   if (!o)
 542     {
 543       return CORBA_OBJECT_NIL;
 544     }
 545
 546   accessible = spi_accessible_new (o);
 547
 548   if (release_ref)
 549     {
 550       g_object_unref (G_OBJECT (o));
 551     }
 552
 553   return CORBA_Object_duplicate (BONOBO_OBJREF (accessible), ev);
 554 }