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