Revved to 1.5.3; added ROLE_EMBEDDED (bug #144415).
[platform/core/uifw/at-spi2-atk.git] / libspi / accessible.c
index ff11bbd..9b4f70c 100644 (file)
@@ -2,7 +2,8 @@
  * AT-SPI - Assistive Technology Service Provider Interface
  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
  *
- * Copyright 2001 Sun Microsystems Inc.
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
 /* Our parent Gtk object type  */
 #define PARENT_TYPE SPI_TYPE_BASE
 
-static AtkObject *
-get_accessible_from_servant (PortableServer_Servant servant)
+static gboolean spi_init_role_lookup_table (Accessibility_Role *role_table);
+static Accessibility_Role spi_role_from_atk_role (AtkRole role);
+
+static gboolean
+spi_init_role_lookup_table (Accessibility_Role *role_table)
 {
-  SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
+  int i;
+  /* if it's not in the list below, dunno what it is */
+  for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
+    {
+      role_table [i] = Accessibility_ROLE_UNKNOWN;
+    }
+  
+  role_table [ATK_ROLE_INVALID] =             Accessibility_ROLE_INVALID;
+  role_table [ATK_ROLE_ACCEL_LABEL] =         Accessibility_ROLE_ACCELERATOR_LABEL;
+  role_table [ATK_ROLE_ALERT] =               Accessibility_ROLE_ALERT;
+  role_table [ATK_ROLE_ANIMATION] =           Accessibility_ROLE_ANIMATION; 
+  role_table [ATK_ROLE_ARROW] =               Accessibility_ROLE_ARROW; 
+  role_table [ATK_ROLE_CALENDAR] =            Accessibility_ROLE_CALENDAR; 
+  role_table [ATK_ROLE_CANVAS] =              Accessibility_ROLE_CANVAS;
+  role_table [ATK_ROLE_CHECK_BOX] =           Accessibility_ROLE_CHECK_BOX;
+  role_table [ATK_ROLE_CHECK_MENU_ITEM] =     Accessibility_ROLE_CHECK_MENU_ITEM;
+  role_table [ATK_ROLE_COLOR_CHOOSER] =       Accessibility_ROLE_COLOR_CHOOSER;
+  role_table [ATK_ROLE_COLUMN_HEADER] =       Accessibility_ROLE_COLUMN_HEADER;
+  role_table [ATK_ROLE_COMBO_BOX] =           Accessibility_ROLE_COMBO_BOX;
+  role_table [ATK_ROLE_DATE_EDITOR] =         Accessibility_ROLE_DATE_EDITOR;
+  role_table [ATK_ROLE_DESKTOP_ICON] =        Accessibility_ROLE_DESKTOP_ICON;
+  role_table [ATK_ROLE_DESKTOP_FRAME] =       Accessibility_ROLE_DESKTOP_FRAME;
+  role_table [ATK_ROLE_DIAL] =                Accessibility_ROLE_DIAL;
+  role_table [ATK_ROLE_DIALOG] =              Accessibility_ROLE_DIALOG;
+  role_table [ATK_ROLE_DIRECTORY_PANE] =      Accessibility_ROLE_DIRECTORY_PANE;
+  role_table [ATK_ROLE_DRAWING_AREA] =        Accessibility_ROLE_DRAWING_AREA;
+  role_table [ATK_ROLE_FILE_CHOOSER] =        Accessibility_ROLE_FILE_CHOOSER;
+  role_table [ATK_ROLE_FILLER] =              Accessibility_ROLE_FILLER;
+  role_table [ATK_ROLE_FONT_CHOOSER] =        Accessibility_ROLE_FONT_CHOOSER;
+  role_table [ATK_ROLE_FRAME] =               Accessibility_ROLE_FRAME;
+  role_table [ATK_ROLE_GLASS_PANE] =          Accessibility_ROLE_GLASS_PANE;
+  role_table [ATK_ROLE_HTML_CONTAINER] =      Accessibility_ROLE_HTML_CONTAINER;
+  role_table [ATK_ROLE_ICON] =                Accessibility_ROLE_ICON;
+  role_table [ATK_ROLE_IMAGE] =               Accessibility_ROLE_IMAGE; 
+  role_table [ATK_ROLE_INTERNAL_FRAME] =      Accessibility_ROLE_INTERNAL_FRAME; 
+  role_table [ATK_ROLE_LABEL] =               Accessibility_ROLE_LABEL;
+  role_table [ATK_ROLE_LAYERED_PANE] =        Accessibility_ROLE_LAYERED_PANE;
+  role_table [ATK_ROLE_LIST] =                Accessibility_ROLE_LIST;
+  role_table [ATK_ROLE_LIST_ITEM] =           Accessibility_ROLE_LIST_ITEM;
+  role_table [ATK_ROLE_MENU] =                Accessibility_ROLE_MENU;
+  role_table [ATK_ROLE_MENU_BAR] =            Accessibility_ROLE_MENU_BAR;
+  role_table [ATK_ROLE_MENU_ITEM] =           Accessibility_ROLE_MENU_ITEM;
+  role_table [ATK_ROLE_OPTION_PANE] =         Accessibility_ROLE_OPTION_PANE;
+  role_table [ATK_ROLE_PAGE_TAB] =            Accessibility_ROLE_PAGE_TAB;
+  role_table [ATK_ROLE_PAGE_TAB_LIST] =       Accessibility_ROLE_PAGE_TAB_LIST; 
+  role_table [ATK_ROLE_PANEL] =               Accessibility_ROLE_PANEL;
+  role_table [ATK_ROLE_PASSWORD_TEXT] =       Accessibility_ROLE_PASSWORD_TEXT;
+  role_table [ATK_ROLE_POPUP_MENU] =          Accessibility_ROLE_POPUP_MENU;
+  role_table [ATK_ROLE_PROGRESS_BAR] =        Accessibility_ROLE_PROGRESS_BAR;
+  role_table [ATK_ROLE_PUSH_BUTTON] =         Accessibility_ROLE_PUSH_BUTTON;
+  role_table [ATK_ROLE_RADIO_BUTTON] =        Accessibility_ROLE_RADIO_BUTTON;
+  role_table [ATK_ROLE_RADIO_MENU_ITEM] =     Accessibility_ROLE_RADIO_MENU_ITEM;
+  role_table [ATK_ROLE_ROOT_PANE] =           Accessibility_ROLE_ROOT_PANE;
+  role_table [ATK_ROLE_ROW_HEADER] =          Accessibility_ROLE_ROW_HEADER;
+  role_table [ATK_ROLE_SCROLL_BAR] =          Accessibility_ROLE_SCROLL_BAR;
+  role_table [ATK_ROLE_SCROLL_PANE] =         Accessibility_ROLE_SCROLL_PANE;
+  role_table [ATK_ROLE_SEPARATOR] =           Accessibility_ROLE_SEPARATOR;
+  role_table [ATK_ROLE_SLIDER] =              Accessibility_ROLE_SLIDER;
+  role_table [ATK_ROLE_SPIN_BUTTON] =         Accessibility_ROLE_SPIN_BUTTON;
+  role_table [ATK_ROLE_SPLIT_PANE] =          Accessibility_ROLE_SPLIT_PANE;
+  role_table [ATK_ROLE_STATUSBAR] =           Accessibility_ROLE_STATUS_BAR;
+  role_table [ATK_ROLE_TABLE] =               Accessibility_ROLE_TABLE;
+  role_table [ATK_ROLE_TABLE_CELL] =          Accessibility_ROLE_TABLE_CELL;
+  role_table [ATK_ROLE_TABLE_COLUMN_HEADER] = Accessibility_ROLE_TABLE_COLUMN_HEADER;
+  role_table [ATK_ROLE_TABLE_ROW_HEADER] =    Accessibility_ROLE_TABLE_ROW_HEADER;
+  role_table [ATK_ROLE_TEAR_OFF_MENU_ITEM] =  Accessibility_ROLE_TEAROFF_MENU_ITEM;
+  role_table [ATK_ROLE_TERMINAL] =            Accessibility_ROLE_TERMINAL;
+  role_table [ATK_ROLE_TEXT] =                Accessibility_ROLE_TEXT;
+  role_table [ATK_ROLE_TOGGLE_BUTTON] =       Accessibility_ROLE_TOGGLE_BUTTON;
+  role_table [ATK_ROLE_TOOL_BAR] =            Accessibility_ROLE_TOOL_BAR;
+  role_table [ATK_ROLE_TOOL_TIP] =            Accessibility_ROLE_TOOL_TIP;
+  role_table [ATK_ROLE_TREE] =                Accessibility_ROLE_TREE;
+  role_table [ATK_ROLE_TREE_TABLE] =          Accessibility_ROLE_TREE_TABLE;
+  role_table [ATK_ROLE_UNKNOWN] =             Accessibility_ROLE_UNKNOWN;
+  role_table [ATK_ROLE_VIEWPORT] =            Accessibility_ROLE_VIEWPORT;
+  role_table [ATK_ROLE_WINDOW] =              Accessibility_ROLE_WINDOW;
+  role_table [ATK_ROLE_HEADER] =              Accessibility_ROLE_HEADER;
+  role_table [ATK_ROLE_FOOTER] =              Accessibility_ROLE_FOOTER;
+  role_table [ATK_ROLE_PARAGRAPH] =           Accessibility_ROLE_PARAGRAPH;
+  role_table [ATK_ROLE_RULER] =               Accessibility_ROLE_RULER;
+  role_table [ATK_ROLE_APPLICATION] =         Accessibility_ROLE_APPLICATION;
+  role_table [ATK_ROLE_AUTOCOMPLETE] =        Accessibility_ROLE_AUTOCOMPLETE;
+  role_table [ATK_ROLE_EDITBAR] =             Accessibility_ROLE_EDITBAR;
+  role_table [ATK_ROLE_EMBEDDED] =            Accessibility_ROLE_EMBEDDED;
+  return TRUE;
+}
+
+static Accessibility_Role
+spi_role_from_atk_role (AtkRole role)
+{
+  static gboolean is_initialized = FALSE;
+  static Accessibility_Role spi_role_table [ATK_ROLE_LAST_DEFINED];
+  Accessibility_Role spi_role;
 
-  if (!object)
+  if (!is_initialized)
+   {
+     is_initialized = spi_init_role_lookup_table (spi_role_table);        
+   }
+
+  if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
     {
-      return NULL;
+      spi_role = spi_role_table [role];
     }
+  else
+    {
+      spi_role = Accessibility_ROLE_EXTENDED;      
+    }
+  return spi_role;
+}
+
+static AtkObject *
+get_atkobject_from_servant (PortableServer_Servant servant)
+{
+  SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
 
-  return object->atko;
+  g_return_val_if_fail (object, NULL);
+  g_return_val_if_fail (ATK_IS_OBJECT(object->gobj), NULL);
+  return ATK_OBJECT(object->gobj);
 }
 
 /*
@@ -53,7 +167,7 @@ impl_accessibility_accessible_get_name (PortableServer_Servant servant,
 {
   const gchar *name;
   CORBA_char  *retval;
-  AtkObject   *object = get_accessible_from_servant (servant);
+  AtkObject   *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
 
@@ -79,7 +193,7 @@ impl_accessibility_accessible_set_name (PortableServer_Servant servant,
                                         const CORBA_char      *name,
                                         CORBA_Environment     *ev)
 {
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
   g_return_if_fail (object != NULL);
 
@@ -95,7 +209,7 @@ impl_accessibility_accessible_get_description (PortableServer_Servant servant,
 {
   const gchar *descr;
   CORBA_char  *retval;
-  AtkObject   *object = get_accessible_from_servant (servant);
+  AtkObject   *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, CORBA_string_dup (""));
 
@@ -121,7 +235,7 @@ impl_accessibility_accessible_set_description (PortableServer_Servant servant,
                                                const CORBA_char      *descr,
                                                CORBA_Environment     *ev)
 {
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
   g_return_if_fail (object != NULL);
 
@@ -136,7 +250,7 @@ impl_accessibility_accessible_get_parent (PortableServer_Servant servant,
                                           CORBA_Environment     *ev)
 {
   AtkObject *parent;
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, CORBA_OBJECT_NIL);
 
@@ -152,7 +266,7 @@ static CORBA_long
 impl_accessibility_accessible_get_index_in_parent (PortableServer_Servant servant,
                                                    CORBA_Environment     *ev)
 {
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, -1);
 
@@ -166,7 +280,7 @@ static CORBA_long
 impl_accessibility_accessible_get_child_count (PortableServer_Servant servant,
                                                CORBA_Environment     *ev)
 {
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, 0);
 
@@ -182,9 +296,9 @@ impl_accessibility_accessible_get_child_at_index (PortableServer_Servant servant
                                                   CORBA_Environment     *ev)
 {
   AtkObject *child;
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
 
-  g_return_val_if_fail (object != NULL, 0);
+  g_return_val_if_fail (object != NULL, CORBA_OBJECT_NIL);
 
   child = atk_object_ref_accessible_child (object, index);
 
@@ -198,14 +312,21 @@ static Accessibility_StateSet
 impl_accessibility_accessible_get_state (PortableServer_Servant servant,
                                         CORBA_Environment     *ev)
 {
-  AtkObject *object = get_accessible_from_servant (servant);
+  AtkObject *object = get_atkobject_from_servant (servant);
+  AtkStateSet *atk_set;
+  SpiStateSet *set;
+  Accessibility_StateSet retval;
 
   bonobo_return_val_if_fail (object != NULL, NULL, ev);
 
-  printf ("SpiAccessible get_state.\n");
+  atk_set = atk_object_ref_state_set (object);
+  
+  set = spi_state_set_new (atk_set);
+  retval = bonobo_object_dup_ref (
+                                 BONOBO_OBJREF(set),
+                                 ev);
 
-  /* TODO: implement the bonobo stateset class */
-  return (Accessibility_StateSet) NULL;
+  return retval;
 }
 
 /*
@@ -219,15 +340,18 @@ impl_accessibility_accessible_get_relation_set (PortableServer_Servant servant,
   gint n_relations;
   gint i;
   AtkRelationSet *relation_set;
-  AtkObject      *object = get_accessible_from_servant (servant);
+  AtkObject      *object = get_atkobject_from_servant (servant);
 
   bonobo_return_val_if_fail (object != NULL, NULL, ev);
 
   relation_set = atk_object_ref_relation_set (object);
 
   n_relations = atk_relation_set_get_n_relations (relation_set);
+
   retval = CORBA_sequence_Accessibility_Relation__alloc ();
-  CORBA_sequence_Accessibility_Relation_allocbuf (n_relations);
+  retval->_length = retval->_maximum = n_relations;
+  retval->_buffer = CORBA_sequence_Accessibility_Relation_allocbuf (n_relations);
+  CORBA_sequence_set_release (retval, CORBA_TRUE);
          
   for (i = 0; i < n_relations; ++i)
     {
@@ -238,7 +362,6 @@ impl_accessibility_accessible_get_relation_set (PortableServer_Servant servant,
          ev);
     }
   
-  printf ("SpiAccessible get_relation_set.\n");
   return retval;
 }
 
@@ -251,16 +374,60 @@ impl_accessibility_accessible_get_role (PortableServer_Servant servant,
 {
   AtkRole            role;
   Accessibility_Role retval;
-  AtkObject         *object = get_accessible_from_servant (servant);
+  AtkObject         *object = get_atkobject_from_servant (servant);
 
   g_return_val_if_fail (object != NULL, 0);
 
   role = atk_object_get_role (object);
-  retval = role; /* FIXME: relies on ability to cast these back and forth */
+  retval = spi_role_from_atk_role (role);
 
   return retval;
 }
 
+/*
+ * CORBA Accessibility::Accessible::getRole method implementation
+ */
+static CORBA_char *
+impl_accessibility_accessible_get_role_name (PortableServer_Servant servant,
+                                            CORBA_Environment     *ev)
+{
+  const gchar     *role_name;
+  AtkRole    role;
+  AtkObject *object = get_atkobject_from_servant (servant);
+
+  g_return_val_if_fail (object != NULL, 0);
+
+  role = atk_object_get_role (object);
+
+  role_name = atk_role_get_name (role);
+  if (role_name)
+    return CORBA_string_dup (role_name);
+  else
+    return CORBA_string_dup ("");
+}
+
+/*
+ * CORBA Accessibility::Accessible::getLocalizedRole method implementation
+ */
+static CORBA_char *
+impl_accessibility_accessible_get_local_role_name (PortableServer_Servant servant,
+                                                  CORBA_Environment     *ev)
+{
+  const gchar     *role_name;
+  AtkRole    role;
+  AtkObject *object = get_atkobject_from_servant (servant);
+
+  g_return_val_if_fail (object != NULL, 0);
+
+  role = atk_object_get_role (object);
+
+  role_name = atk_role_get_localized_name (role);
+  if (role_name)
+    return CORBA_string_dup (role_name);
+  else
+    return CORBA_string_dup ("");
+}
+
 static void
 spi_accessible_class_init (SpiAccessibleClass *klass)
 {
@@ -279,6 +446,8 @@ spi_accessible_class_init (SpiAccessibleClass *klass)
         epv->getRelationSet = impl_accessibility_accessible_get_relation_set;
         epv->getState = impl_accessibility_accessible_get_state;
         epv->getRole = impl_accessibility_accessible_get_role;
+        epv->getRoleName = impl_accessibility_accessible_get_role_name;
+       epv->getLocalizedRoleName = impl_accessibility_accessible_get_local_role_name;
 }
 
 static void
@@ -289,7 +458,7 @@ spi_accessible_init (SpiAccessible *accessible)
 BONOBO_TYPE_FUNC_FULL (SpiAccessible,
                       Accessibility_Accessible,
                       PARENT_TYPE,
-                      spi_accessible);
+                      spi_accessible)
 
 static GHashTable *public_corba_refs = NULL;
 
@@ -306,86 +475,96 @@ get_public_refs (void)
 static void
 de_register_public_ref (SpiBase *object)
 {
-  g_hash_table_remove (get_public_refs (), object->atko);
+  g_hash_table_remove (get_public_refs (), object->gobj);
 }
 
 SpiAccessible *
 spi_accessible_new (AtkObject *o)
 {
+  return spi_accessible_construct (SPI_ACCESSIBLE_TYPE, o);      
+}
+
+SpiAccessible *
+spi_accessible_construct (GType type, AtkObject *o)
+{
     SpiAccessible *retval;
     CORBA_Environment ev;
 
     CORBA_exception_init (&ev);
 
+    g_assert (o);
+    g_assert (g_type_is_a (type, SPI_ACCESSIBLE_TYPE));
+
     if ((retval = g_hash_table_lookup (get_public_refs (), o)))
       {
         bonobo_object_ref (BONOBO_OBJECT (retval));
        return retval;
       }
-
-    retval = g_object_new (SPI_ACCESSIBLE_TYPE, NULL);
-
-    spi_base_construct (SPI_BASE (retval), o);
-
+    else
+      {
+        retval = g_object_new (type, NULL);
+        spi_base_construct (SPI_BASE (retval), G_OBJECT(o));
+      }
+    
     g_hash_table_insert (get_public_refs (), o, retval);
     g_signal_connect (G_OBJECT (retval), "destroy",
                      G_CALLBACK (de_register_public_ref),
                      NULL);
 
     /* aggregate appropriate SPI interfaces based on ATK interfaces */
-
     if (ATK_IS_ACTION (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_action_interface_new (o)));
+               BONOBO_OBJECT (spi_action_interface_new (o)));
       }
 
     if (ATK_IS_COMPONENT (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_component_interface_new (o)));
+                                    BONOBO_OBJECT (spi_component_interface_new (o)));
       }
 
     if (ATK_IS_EDITABLE_TEXT (o))
       {
-        bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT(spi_editable_text_interface_new (o)));
-      }
-
-    else if (ATK_IS_HYPERTEXT (o))
-      {
-        bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_hypertext_interface_new (o)));
+         bonobo_object_add_interface (bonobo_object (retval),
+                                     BONOBO_OBJECT(spi_editable_text_interface_new (o)));
       }
 
     else if (ATK_IS_TEXT (o))
+       {
+         bonobo_object_add_interface (bonobo_object (retval),
+                                     BONOBO_OBJECT (spi_text_interface_new (o)));
+       }
+
+    if (ATK_IS_HYPERTEXT (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_text_interface_new (o)));
+                                    BONOBO_OBJECT (spi_hypertext_interface_new (o)));
       }
 
     if (ATK_IS_IMAGE (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_image_interface_new (o)));
+                                    BONOBO_OBJECT (spi_image_interface_new (o)));
       }
 
     if (ATK_IS_SELECTION (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_selection_interface_new (o)));
+                                    BONOBO_OBJECT (spi_selection_interface_new (o)));
       }
 
     if (ATK_IS_TABLE (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_table_interface_new (o)));
+                                    BONOBO_OBJECT (spi_table_interface_new (o)));
       }
 
     if (ATK_IS_VALUE (o))
       {
         bonobo_object_add_interface (bonobo_object (retval),
-                                     BONOBO_OBJECT (spi_value_interface_new (o)));
+                                    BONOBO_OBJECT (spi_value_interface_new (o)));
       }
 
     return retval;
@@ -408,18 +587,26 @@ spi_accessible_new_return (AtkObject         *o,
                           CORBA_Environment *ev)
 {
   SpiAccessible *accessible;
+  Accessibility_Accessible retval;
 
   if (!o)
     {
       return CORBA_OBJECT_NIL;
     }
-
-  accessible = spi_accessible_new (o);
+  else if (SPI_IS_REMOTE_OBJECT (o))
+    {
+      retval = spi_remote_object_get_accessible (SPI_REMOTE_OBJECT (o));
+    }
+  else
+    {
+      accessible = spi_accessible_construct (SPI_ACCESSIBLE_TYPE, o);
+      retval = CORBA_Object_duplicate (BONOBO_OBJREF (accessible), ev); 
+    }
 
   if (release_ref)
     {
       g_object_unref (G_OBJECT (o));
     }
-
-  return CORBA_Object_duplicate (BONOBO_OBJREF (accessible), ev);
+  
+  return retval;
 }