libspi/hyperlink.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 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 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 /* hyperlink.c : implements the Hyperlink interface */
  25
  26 #include <config.h>
  27 #include <stdio.h>
  28 #include <libspi/hyperlink.h>
  29 #include <libspi/action.h>
  30 #include <libspi/accessible.h>
  31
  32 /* Static function declarations */
  33
  34 static void
  35 spi_hyperlink_class_init (SpiHyperlinkClass *klass);
  36 static void
  37 spi_hyperlink_init (SpiHyperlink *hyperlink);
  38 static CORBA_string
  39 impl_getURI (PortableServer_Servant _servant,
  40              const CORBA_long i, CORBA_Environment * ev);
  41 static CORBA_short
  42 impl__get_n_anchors (PortableServer_Servant _servant,
  43                      CORBA_Environment * ev);
  44 static CORBA_long
  45 impl__get_startIndex (PortableServer_Servant _servant,
  46                       CORBA_Environment * ev);
  47 static CORBA_long
  48 impl__get_endIndex (PortableServer_Servant _servant,
  49                     CORBA_Environment * ev);
  50 static Accessibility_Accessible
  51 impl_getObject (PortableServer_Servant _servant,
  52                 const CORBA_long i,
  53                 CORBA_Environment * ev);
  54 static CORBA_boolean
  55 impl_isValid (PortableServer_Servant _servant,
  56               CORBA_Environment * ev);
  57
  58
  59 BONOBO_TYPE_FUNC_FULL (SpiHyperlink,
  60                        Accessibility_Hyperlink,
  61                        SPI_TYPE_BASE,
  62                        spi_hyperlink)
  63
  64
  65 static void
  66 spi_hyperlink_class_init (SpiHyperlinkClass *klass)
  67 {
  68   POA_Accessibility_Hyperlink__epv *epv = &klass->epv;
  69
  70   /* Initialize epv table */
  71
  72   epv->_get_nAnchors = impl__get_n_anchors;
  73   epv->getURI = impl_getURI;
  74   epv->_get_startIndex = impl__get_startIndex;
  75   epv->_get_endIndex = impl__get_endIndex;
  76   epv->getObject = impl_getObject;
  77   epv->isValid = impl_isValid;
  78 }
  79
  80
  81 static void
  82 spi_hyperlink_init (SpiHyperlink *hyperlink)
  83 {
  84 }
  85
  86
  87 SpiHyperlink *
  88 spi_hyperlink_new (AtkHyperlink *object)
  89 {
  90   SpiHyperlink *new_hyperlink = g_object_new (
  91           SPI_HYPERLINK_TYPE, NULL);
  92
  93   spi_base_construct (SPI_BASE (new_hyperlink), G_OBJECT(object));
  94
  95   /*
  96    * some hyperlinks are actionable... this is an ATK convention
  97    * that seems convenient though possibly poorly documented or unintended.
  98    */
  99   if (ATK_IS_ACTION (object))
 100     {
 101       /*
 102        * NOTE: we don't cast 'object' to ATK_OBJECT in the call to
 103        * spi_action_interface_new(), because of the above convention,
 104        * even though it means we may be violating the func prototype.
 105        * See discussion in bugzilla bug #120659.
 106        * !!!
 107        * IMPORTANT! The 'AtkObject' typecast, instead of the cast macro,
 108        * is used below, because 'object' may NOT really be an AtkObject;
 109        * it will be cast back to a G_OBJECT inside spi_action_interface_new
 110        * before use, so this is OK though very ropey coding style.
 111        */
 112       bonobo_object_add_interface (bonobo_object (new_hyperlink),
 113                                    BONOBO_OBJECT (spi_action_interface_new ((AtkObject *) object)));
 114     }
 115   return new_hyperlink;
 116 }
 117
 118 static AtkHyperlink *
 119 get_hyperlink_from_servant (PortableServer_Servant servant)
 120 {
 121   SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
 122
 123   g_return_val_if_fail (object != NULL, NULL);
 124   g_return_val_if_fail (ATK_IS_HYPERLINK(object->gobj), NULL);
 125   return ATK_HYPERLINK (object->gobj);
 126 }
 127
 128
 129 static CORBA_short
 130 impl__get_n_anchors (PortableServer_Servant servant,
 131                      CORBA_Environment     *ev)
 132 {
 133   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 134
 135   g_return_val_if_fail (link != NULL, 0);
 136
 137   return atk_hyperlink_get_n_anchors (link);
 138 }
 139
 140
 141 static CORBA_long
 142 impl__get_startIndex (PortableServer_Servant servant,
 143                       CORBA_Environment     *ev)
 144 {
 145   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 146
 147   g_return_val_if_fail (link != NULL, -1);
 148
 149   return atk_hyperlink_get_start_index (link);
 150 }
 151
 152
 153 static CORBA_long
 154 impl__get_endIndex (PortableServer_Servant servant,
 155                     CORBA_Environment     *ev)
 156 {
 157   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 158
 159   g_return_val_if_fail (link != NULL, -1);
 160
 161   return atk_hyperlink_get_end_index (link);
 162 }
 163
 164
 165 static CORBA_string
 166 impl_getURI (PortableServer_Servant servant,
 167              const CORBA_long i, CORBA_Environment *ev)
 168 {
 169   gchar *uri;
 170   CORBA_char *rv;
 171   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 172
 173   g_return_val_if_fail (link != NULL, CORBA_string_dup (""));
 174
 175   uri = atk_hyperlink_get_uri (link, i);
 176   if (uri)
 177     {
 178       rv = CORBA_string_dup (uri);
 179       g_free (uri);
 180     }
 181   else
 182     rv = CORBA_string_dup ("");
 183
 184   return rv;
 185 }
 186
 187
 188 static Accessibility_Accessible
 189 impl_getObject (PortableServer_Servant servant,
 190                 const CORBA_long       i,
 191                 CORBA_Environment     *ev)
 192 {
 193   AtkObject    *atk_object;
 194   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 195
 196   g_return_val_if_fail (link != NULL, CORBA_OBJECT_NIL);
 197
 198   atk_object = atk_hyperlink_get_object (link, i);
 199
 200   return spi_accessible_new_return (atk_object, FALSE, ev);
 201 }
 202
 203
 204 static CORBA_boolean
 205 impl_isValid (PortableServer_Servant servant,
 206               CORBA_Environment     *ev)
 207 {
 208   AtkHyperlink *link = get_hyperlink_from_servant (servant);
 209
 210   g_return_val_if_fail (link != NULL, TRUE);
 211
 212   return atk_hyperlink_is_valid (link);
 213 }
 214