2004-02-11 Padraig O'Briain <padraig.obriain@sun.com>
[platform/core/uifw/at-spi2-atk.git] / 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       bonobo_object_add_interface (bonobo_object (new_hyperlink),
102                                    BONOBO_OBJECT (spi_action_interface_new (ATK_OBJECT (object))));
103     }
104   return new_hyperlink;
105 }
106
107 static AtkHyperlink *
108 get_hyperlink_from_servant (PortableServer_Servant servant)
109 {
110   SpiBase *object = SPI_BASE (bonobo_object_from_servant (servant));
111
112   g_return_val_if_fail (object != NULL, NULL);
113   g_return_val_if_fail (ATK_IS_HYPERLINK(object->gobj), NULL);
114   return ATK_HYPERLINK (object->gobj);
115 }
116
117
118 static CORBA_short
119 impl__get_n_anchors (PortableServer_Servant servant,
120                      CORBA_Environment     *ev)
121 {
122   AtkHyperlink *link = get_hyperlink_from_servant (servant);
123
124   g_return_val_if_fail (link != NULL, 0);
125
126   return atk_hyperlink_get_n_anchors (link);
127 }
128
129
130 static CORBA_long
131 impl__get_startIndex (PortableServer_Servant servant,
132                       CORBA_Environment     *ev)
133 {
134   AtkHyperlink *link = get_hyperlink_from_servant (servant);
135
136   g_return_val_if_fail (link != NULL, -1);
137
138   return atk_hyperlink_get_start_index (link);
139 }
140
141
142 static CORBA_long
143 impl__get_endIndex (PortableServer_Servant servant,
144                     CORBA_Environment     *ev)
145 {
146   AtkHyperlink *link = get_hyperlink_from_servant (servant);
147
148   g_return_val_if_fail (link != NULL, -1);
149
150   return atk_hyperlink_get_end_index (link);
151 }
152
153
154 static CORBA_string
155 impl_getURI (PortableServer_Servant servant,
156              const CORBA_long i, CORBA_Environment *ev)
157 {
158   gchar *uri;
159   CORBA_char *rv;
160   AtkHyperlink *link = get_hyperlink_from_servant (servant);
161
162   g_return_val_if_fail (link != NULL, CORBA_string_dup (""));
163
164   uri = atk_hyperlink_get_uri (link, i);
165   if (uri)
166     {
167       rv = CORBA_string_dup (uri);
168       g_free (uri);
169     }
170   else
171     rv = CORBA_string_dup ("");
172
173   return rv;
174
175
176
177 static Accessibility_Accessible
178 impl_getObject (PortableServer_Servant servant,
179                 const CORBA_long       i,
180                 CORBA_Environment     *ev)
181 {
182   AtkObject    *atk_object;
183   AtkHyperlink *link = get_hyperlink_from_servant (servant);
184
185   g_return_val_if_fail (link != NULL, CORBA_OBJECT_NIL);
186
187   atk_object = atk_hyperlink_get_object (link, i);
188
189   return spi_accessible_new_return (atk_object, FALSE, ev);
190 }
191
192
193 static CORBA_boolean
194 impl_isValid (PortableServer_Servant servant,
195               CORBA_Environment     *ev)
196 {
197   AtkHyperlink *link = get_hyperlink_from_servant (servant);
198
199   g_return_val_if_fail (link != NULL, TRUE);
200
201   return atk_hyperlink_is_valid (link);
202 }
203