2004-02-11 Padraig O'Briain <padraig.obriain@sun.com>
[platform/core/uifw/at-spi2-atk.git] / libspi / relation.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 /* relation.c : implements the Relation interface */
25
26 #include <config.h>
27 #include <stdio.h>
28 #include <libspi/accessible.h>
29 #include <libspi/relation.h>
30
31
32 static gboolean
33 spi_init_relation_type_table (Accessibility_RelationType *types)
34 {
35   gint i;
36
37   for (i = 0; i < ATK_RELATION_LAST_DEFINED; i++)
38     types[i] = Accessibility_RELATION_NULL;
39
40   types[ATK_RELATION_CONTROLLED_BY] = Accessibility_RELATION_CONTROLLED_BY;
41   types[ATK_RELATION_CONTROLLER_FOR] = Accessibility_RELATION_CONTROLLER_FOR;
42   types[ATK_RELATION_LABEL_FOR] = Accessibility_RELATION_LABEL_FOR;
43   types[ATK_RELATION_LABELLED_BY] = Accessibility_RELATION_LABELLED_BY;
44   types[ATK_RELATION_MEMBER_OF] = Accessibility_RELATION_MEMBER_OF;
45   types[ATK_RELATION_NODE_CHILD_OF] = Accessibility_RELATION_NODE_CHILD_OF;
46   types[ATK_RELATION_FLOWS_TO] = Accessibility_RELATION_FLOWS_TO;
47   types[ATK_RELATION_FLOWS_FROM] = Accessibility_RELATION_FLOWS_FROM;
48   types[ATK_RELATION_SUBWINDOW_OF] = Accessibility_RELATION_SUBWINDOW_OF;
49   types[ATK_RELATION_EMBEDS] = Accessibility_RELATION_EMBEDS;
50   types[ATK_RELATION_EMBEDDED_BY] = Accessibility_RELATION_EMBEDDED_BY;
51   types[ATK_RELATION_POPUP_FOR] = Accessibility_RELATION_POPUP_FOR;
52   return TRUE;
53 }
54
55
56
57 static Accessibility_RelationType
58 spi_relation_type_from_atk_relation_type (AtkRelationType type)
59 {
60   static gboolean is_initialized = FALSE;
61   static Accessibility_RelationType spi_relation_type_table [ATK_RELATION_LAST_DEFINED];
62   Accessibility_RelationType spi_type;
63
64   if (!is_initialized)
65     is_initialized = spi_init_relation_type_table (spi_relation_type_table);       
66
67   if (type > ATK_RELATION_NULL && type < ATK_RELATION_LAST_DEFINED)
68     spi_type = spi_relation_type_table[type];
69   else
70     spi_type = Accessibility_RELATION_EXTENDED;
71   return spi_type;
72 }
73
74
75
76 static AtkRelation *
77 get_relation_from_servant (PortableServer_Servant servant)
78 {
79   SpiBase *base = SPI_BASE (bonobo_object_from_servant(servant));
80
81   g_return_val_if_fail (base, NULL);
82   return  ATK_RELATION(base->gobj);
83 }
84
85
86
87 static Accessibility_RelationType
88 impl_getRelationType (PortableServer_Servant servant,
89                       CORBA_Environment * ev)
90 {
91   AtkRelation *relation = get_relation_from_servant (servant);
92   AtkRelationType type;
93
94   g_return_val_if_fail (relation != NULL, 0);
95   type = atk_relation_get_relation_type (relation);
96   return spi_relation_type_from_atk_relation_type (type);
97 }
98
99
100 static CORBA_short
101 impl_getNTargets (PortableServer_Servant servant,
102                   CORBA_Environment * ev)
103 {
104   AtkRelation *relation = get_relation_from_servant(servant);
105   g_return_val_if_fail (relation != NULL, 0);
106
107   return relation->target ? relation->target->len : 0;
108 }
109
110
111 static CORBA_Object
112 impl_getTarget (PortableServer_Servant servant,
113                 const CORBA_short index,
114                 CORBA_Environment * ev)
115 {
116   AtkObject *atk_object;
117   AtkRelation *relation = get_relation_from_servant (servant);
118   g_return_val_if_fail (relation, NULL);
119
120   if (!relation->target ||
121       index < 0 ||
122       index >= relation->target->len)
123     return CORBA_OBJECT_NIL;
124
125   atk_object = g_ptr_array_index (relation->target, index);
126   if (!atk_object)
127     return CORBA_OBJECT_NIL;
128
129   return spi_accessible_new_return (atk_object, FALSE, ev);
130 }
131
132
133 SpiRelation *
134 spi_relation_new (AtkRelation *obj)
135 {
136   SpiRelation *new_relation = g_object_new (SPI_RELATION_TYPE, NULL);
137   spi_base_construct (SPI_BASE (new_relation), G_OBJECT (obj));
138   return new_relation;
139 }
140
141
142 static void
143 spi_relation_class_init (SpiRelationClass *klass)
144 {
145   POA_Accessibility_Relation__epv *epv = &klass->epv;
146
147   epv->getRelationType  = impl_getRelationType;  
148   epv->getNTargets      = impl_getNTargets;
149   epv->getTarget        = impl_getTarget;
150 }
151
152
153 static void
154 spi_relation_init (SpiRelation *relation)
155 {
156 }
157
158
159 BONOBO_TYPE_FUNC_FULL (SpiRelation,
160                        Accessibility_Relation,
161                        SPI_TYPE_BASE,
162                        spi_relation)