2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
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.
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.
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.
24 /* accessible.c: the core of the accessibility implementation */
28 #include <bonobo/bonobo-exception.h>
30 #include <libspi/libspi.h>
32 /* Our parent Gtk object type */
33 #define PARENT_TYPE SPI_TYPE_BASE
35 static gboolean spi_init_role_lookup_table (Accessibility_Role *role_table);
36 static Accessibility_Role spi_role_from_atk_role (AtkRole role);
39 spi_init_role_lookup_table (Accessibility_Role *role_table)
42 /* if it's not in the list below, dunno what it is */
43 for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
45 role_table [i] = Accessibility_ROLE_UNKNOWN;
48 role_table [ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
49 role_table [ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
50 role_table [ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
51 role_table [ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
52 role_table [ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
53 role_table [ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
54 role_table [ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
55 role_table [ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
56 role_table [ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
57 role_table [ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
58 role_table [ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
59 role_table [ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
60 role_table [ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
61 role_table [ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
62 role_table [ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
63 role_table [ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
64 role_table [ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
65 role_table [ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
66 role_table [ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
67 role_table [ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
68 role_table [ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
69 role_table [ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
70 role_table [ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
71 role_table [ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
72 role_table [ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
73 role_table [ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
74 role_table [ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
75 role_table [ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
76 role_table [ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
77 role_table [ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
78 role_table [ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
79 role_table [ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
80 role_table [ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
81 role_table [ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
82 role_table [ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
83 role_table [ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
84 role_table [ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
85 role_table [ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
86 role_table [ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
87 role_table [ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
88 role_table [ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
89 role_table [ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
90 role_table [ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
91 role_table [ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
92 role_table [ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
93 role_table [ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
94 role_table [ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
95 role_table [ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
96 role_table [ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
97 role_table [ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
98 role_table [ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
99 role_table [ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
100 role_table [ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
101 role_table [ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
102 role_table [ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
103 role_table [ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
104 role_table [ATK_ROLE_TABLE_COLUMN_HEADER] = Accessibility_ROLE_TABLE_COLUMN_HEADER;
105 role_table [ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
106 role_table [ATK_ROLE_TEAR_OFF_MENU_ITEM] = 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_HEADER] = Accessibility_ROLE_HEADER;
118 role_table [ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
119 role_table [ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
120 role_table [ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
121 role_table [ATK_ROLE_LAST_DEFINED] = Accessibility_ROLE_EXTENDED;
126 static Accessibility_Role
127 spi_role_from_atk_role (AtkRole role)
129 static gboolean is_initialized = FALSE;
130 static Accessibility_Role spi_role_table [ATK_ROLE_LAST_DEFINED];
131 Accessibility_Role spi_role;
135 is_initialized = spi_init_role_lookup_table (spi_role_table);
138 if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
140 spi_role = spi_role_table [role];
144 spi_role = Accessibility_ROLE_EXTENDED;
150 get_atkobject_from_servant (PortableServer_Servant servant)
152 SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
154 g_return_val_if_fail (object, NULL);
155 g_return_val_if_fail (ATK_IS_OBJECT(object->gobj), NULL);
156 return ATK_OBJECT(object->gobj);
160 * CORBA Accessibility::Accessible::get_name method implementation
163 impl_accessibility_accessible_get_name (PortableServer_Servant servant,
164 CORBA_Environment *ev)
168 AtkObject *object = get_atkobject_from_servant (servant);
170 g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
172 name = atk_object_get_name (object);
176 retval = CORBA_string_dup (name);
180 retval = CORBA_string_dup ("");
187 * CORBA Accessibility::Accessible::set_name method implementation
190 impl_accessibility_accessible_set_name (PortableServer_Servant servant,
191 const CORBA_char *name,
192 CORBA_Environment *ev)
194 AtkObject *object = get_atkobject_from_servant (servant);
196 g_return_if_fail (object != NULL);
198 atk_object_set_name (object, name);
202 * CORBA Accessibility::Accessible::get_description method implementation
205 impl_accessibility_accessible_get_description (PortableServer_Servant servant,
206 CORBA_Environment *ev)
210 AtkObject *object = get_atkobject_from_servant (servant);
212 g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
214 descr = atk_object_get_description (object);
218 retval = CORBA_string_dup (descr);
222 retval = CORBA_string_dup ("");
229 * CORBA Accessibility::Accessible::set_description method implementation
232 impl_accessibility_accessible_set_description (PortableServer_Servant servant,
233 const CORBA_char *descr,
234 CORBA_Environment *ev)
236 AtkObject *object = get_atkobject_from_servant (servant);
238 g_return_if_fail (object != NULL);
240 atk_object_set_description (object, descr);
244 * CORBA Accessibility::Accessible::get_parent method implementation
246 static Accessibility_Accessible
247 impl_accessibility_accessible_get_parent (PortableServer_Servant servant,
248 CORBA_Environment *ev)
251 AtkObject *object = get_atkobject_from_servant (servant);
253 g_return_val_if_fail (object != NULL, CORBA_OBJECT_NIL);
255 parent = atk_object_get_parent (object);
257 return spi_accessible_new_return (parent, FALSE, ev);
261 * CORBA Accessibility::Accessible::get_IndexInParent method implementation
264 impl_accessibility_accessible_get_index_in_parent (PortableServer_Servant servant,
265 CORBA_Environment *ev)
267 AtkObject *object = get_atkobject_from_servant (servant);
269 g_return_val_if_fail (object != NULL, -1);
271 return atk_object_get_index_in_parent (object);
275 * CORBA Accessibility::Accessible::get_childCount method implementation
278 impl_accessibility_accessible_get_child_count (PortableServer_Servant servant,
279 CORBA_Environment *ev)
281 AtkObject *object = get_atkobject_from_servant (servant);
283 g_return_val_if_fail (object != NULL, 0);
285 return atk_object_get_n_accessible_children (object);
289 * CORBA Accessibility::Accessible::getChildAtIndex method implementation
291 static Accessibility_Accessible
292 impl_accessibility_accessible_get_child_at_index (PortableServer_Servant servant,
293 const CORBA_long index,
294 CORBA_Environment *ev)
297 AtkObject *object = get_atkobject_from_servant (servant);
299 g_return_val_if_fail (object != NULL, CORBA_OBJECT_NIL);
301 child = atk_object_ref_accessible_child (object, index);
303 return spi_accessible_new_return (child, TRUE, ev);
307 * CORBA Accessibility::Accessible::getState method implementation
309 static Accessibility_StateSet
310 impl_accessibility_accessible_get_state (PortableServer_Servant servant,
311 CORBA_Environment *ev)
313 AtkObject *object = get_atkobject_from_servant (servant);
314 AtkStateSet *atk_set;
316 Accessibility_StateSet retval;
318 bonobo_return_val_if_fail (object != NULL, NULL, ev);
320 atk_set = atk_object_ref_state_set (object);
322 set = spi_state_set_new (atk_set);
323 retval = bonobo_object_dup_ref (
331 * CORBA Accessibility::Accessible::getRelationSet method implementation
333 static Accessibility_RelationSet *
334 impl_accessibility_accessible_get_relation_set (PortableServer_Servant servant,
335 CORBA_Environment *ev)
337 Accessibility_RelationSet *retval;
340 AtkRelationSet *relation_set;
341 AtkObject *object = get_atkobject_from_servant (servant);
343 bonobo_return_val_if_fail (object != NULL, NULL, ev);
345 relation_set = atk_object_ref_relation_set (object);
347 n_relations = atk_relation_set_get_n_relations (relation_set);
349 retval = CORBA_sequence_Accessibility_Relation__alloc ();
350 retval->_length = retval->_maximum = n_relations;
351 retval->_buffer = CORBA_sequence_Accessibility_Relation_allocbuf (n_relations);
352 CORBA_sequence_set_release (retval, CORBA_TRUE);
354 for (i = 0; i < n_relations; ++i)
357 bonobo_object_dup_ref (
359 spi_relation_new (atk_relation_set_get_relation (relation_set, i))),
367 * CORBA Accessibility::Accessible::getRole method implementation
369 static Accessibility_Role
370 impl_accessibility_accessible_get_role (PortableServer_Servant servant,
371 CORBA_Environment *ev)
374 Accessibility_Role retval;
375 AtkObject *object = get_atkobject_from_servant (servant);
377 g_return_val_if_fail (object != NULL, 0);
379 role = atk_object_get_role (object);
380 retval = spi_role_from_atk_role (role);
386 * CORBA Accessibility::Accessible::getRole method implementation
389 impl_accessibility_accessible_get_role_name (PortableServer_Servant servant,
390 CORBA_Environment *ev)
392 const gchar *role_name;
394 AtkObject *object = get_atkobject_from_servant (servant);
396 g_return_val_if_fail (object != NULL, 0);
398 role = atk_object_get_role (object);
400 role_name = atk_role_get_name (role);
402 return CORBA_string_dup (role_name);
404 return CORBA_string_dup ("");
408 spi_accessible_class_init (SpiAccessibleClass *klass)
410 POA_Accessibility_Accessible__epv *epv = &klass->epv;
412 epv->_get_name = impl_accessibility_accessible_get_name;
413 epv->_set_name = impl_accessibility_accessible_set_name;
414 epv->_get_description = impl_accessibility_accessible_get_description;
415 epv->_set_description = impl_accessibility_accessible_set_description;
417 epv->_get_parent = impl_accessibility_accessible_get_parent;
418 epv->_get_childCount = impl_accessibility_accessible_get_child_count;
419 epv->getChildAtIndex = impl_accessibility_accessible_get_child_at_index;
420 epv->getIndexInParent = impl_accessibility_accessible_get_index_in_parent;
422 epv->getRelationSet = impl_accessibility_accessible_get_relation_set;
423 epv->getState = impl_accessibility_accessible_get_state;
424 epv->getRole = impl_accessibility_accessible_get_role;
425 epv->getRoleName = impl_accessibility_accessible_get_role_name;
429 spi_accessible_init (SpiAccessible *accessible)
433 BONOBO_TYPE_FUNC_FULL (SpiAccessible,
434 Accessibility_Accessible,
438 static GHashTable *public_corba_refs = NULL;
441 get_public_refs (void)
443 if (!public_corba_refs)
445 public_corba_refs = g_hash_table_new (NULL, NULL);
447 return public_corba_refs;
451 de_register_public_ref (SpiBase *object)
453 g_hash_table_remove (get_public_refs (), object->gobj);
457 spi_accessible_new (AtkObject *o)
459 return spi_accessible_construct (SPI_ACCESSIBLE_TYPE, o);
463 spi_accessible_construct (GType type, AtkObject *o)
465 SpiAccessible *retval;
466 CORBA_Environment ev;
468 CORBA_exception_init (&ev);
471 g_assert (g_type_is_a (type, SPI_ACCESSIBLE_TYPE));
473 if ((retval = g_hash_table_lookup (get_public_refs (), o)))
475 bonobo_object_ref (BONOBO_OBJECT (retval));
480 retval = g_object_new (type, NULL);
481 spi_base_construct (SPI_BASE (retval), G_OBJECT(o));
484 g_hash_table_insert (get_public_refs (), o, retval);
485 g_signal_connect (G_OBJECT (retval), "destroy",
486 G_CALLBACK (de_register_public_ref),
489 /* aggregate appropriate SPI interfaces based on ATK interfaces */
491 if (ATK_IS_ACTION (o))
493 bonobo_object_add_interface (bonobo_object (retval),
494 BONOBO_OBJECT (spi_action_interface_new (o)));
497 if (ATK_IS_COMPONENT (o))
499 bonobo_object_add_interface (bonobo_object (retval),
500 BONOBO_OBJECT (spi_component_interface_new (o)));
503 if (ATK_IS_EDITABLE_TEXT (o))
505 bonobo_object_add_interface (bonobo_object (retval),
506 BONOBO_OBJECT(spi_editable_text_interface_new (o)));
509 else if (ATK_IS_TEXT (o))
511 bonobo_object_add_interface (bonobo_object (retval),
512 BONOBO_OBJECT (spi_text_interface_new (o)));
515 if (ATK_IS_HYPERTEXT (o))
517 bonobo_object_add_interface (bonobo_object (retval),
518 BONOBO_OBJECT (spi_hypertext_interface_new (o)));
521 if (ATK_IS_IMAGE (o))
523 bonobo_object_add_interface (bonobo_object (retval),
524 BONOBO_OBJECT (spi_image_interface_new (o)));
527 if (ATK_IS_SELECTION (o))
529 bonobo_object_add_interface (bonobo_object (retval),
530 BONOBO_OBJECT (spi_selection_interface_new (o)));
533 if (ATK_IS_TABLE (o))
535 bonobo_object_add_interface (bonobo_object (retval),
536 BONOBO_OBJECT (spi_table_interface_new (o)));
539 if (ATK_IS_VALUE (o))
541 bonobo_object_add_interface (bonobo_object (retval),
542 BONOBO_OBJECT (spi_value_interface_new (o)));
549 * spi_accessible_new_return:
550 * @o: an AtkObject or NULL
551 * @release_ref: whether to unref this AtkObject before return
552 * @ev: a CORBA environment
554 * A helper function to instantiate a CORBA accessiblility
555 * proxy from an AtkObject.
557 * Return value: the proxy or CORBA_OBJECT_NIL
559 Accessibility_Accessible
560 spi_accessible_new_return (AtkObject *o,
561 gboolean release_ref,
562 CORBA_Environment *ev)
564 SpiAccessible *accessible;
565 Accessibility_Accessible retval;
569 return CORBA_OBJECT_NIL;
571 else if (SPI_IS_REMOTE_OBJECT (o))
573 retval = spi_remote_object_get_accessible (SPI_REMOTE_OBJECT (o));
577 accessible = spi_accessible_construct (SPI_ACCESSIBLE_TYPE, o);
578 retval = CORBA_Object_duplicate (BONOBO_OBJREF (accessible), ev);
583 g_object_unref (G_OBJECT (o));