6795cf779c815a2a28ba33766fc8c2edebbcc8e8
[platform/core/uifw/at-spi2-atk.git] / atk-adaptor / object.c
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2008 Novell, Inc.
6  * Copyright 2008, 2009, 2010 Codethink Ltd.
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 /*
25  * This module contains utility functions for exporting AT-SPI
26  * objects based upon an ATK object.
27  *
28  * It incudes functions for marshalling object references
29  * and supported interfaces to a D-Bus message.
30  */
31
32 #include <atk/atk.h>
33 #include <common/spi-types.h>
34 #include <common/spi-dbus.h>
35
36 #include "accessible-register.h"
37 #include "accessible-cache.h"
38 #include "accessible-leasing.h"
39
40 #include "bridge.h"
41
42 /*---------------------------------------------------------------------------*/
43
44 /*
45  * This is the all important function that decides whether an object should
46  * be leased or not.
47  *
48  * The choice of algorithm for this is somewhat vuage. We want ideally to lease
49  * all atk objects that are not owned by their parent.
50  *
51  * The 'cache' object attempts to cache all objects that are owned by their
52  * parent by traversing the tree of accessibles, ignoring the children of
53  * manages-descendants and transient objects.
54  *
55  * This function will simply look for all the accessibles that the cache object
56  * has not found and assume that they need to be leased.
57  */
58 void
59 spi_object_lease_if_needed (GObject *obj)
60 {
61   if (!spi_cache_in (spi_global_cache, obj))
62     {
63       spi_leasing_take (spi_global_leasing, obj);
64     }
65 }
66
67 /*---------------------------------------------------------------------------*/
68
69 /*
70  * It is assumed that all of these functions are returning an accessible
71  * object to the client side.
72  *
73  * All of them will lease the AtkObject if it is deemed neccessary.
74  */
75
76 void
77 spi_object_append_null_reference (DBusMessageIter * iter)
78 {
79   DBusMessageIter iter_struct;
80   const char *name;
81   const char *path = SPI_DBUS_PATH_NULL;
82
83   name = dbus_bus_get_unique_name (spi_global_app_data->bus);
84
85   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
86                                     &iter_struct);
87   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
88   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
89   dbus_message_iter_close_container (iter, &iter_struct);
90 }
91
92 void
93 spi_object_append_reference (DBusMessageIter * iter, AtkObject * obj)
94 {
95   DBusMessageIter iter_struct;
96   const gchar *name;
97   gchar *path;
98
99   if (!obj) {
100     spi_object_append_null_reference (iter);
101     return;
102   }
103
104   spi_object_lease_if_needed (G_OBJECT (obj));
105
106   name = dbus_bus_get_unique_name (spi_global_app_data->bus);
107   path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
108
109   if (!path)
110     path = g_strdup (SPI_DBUS_PATH_NULL);
111
112   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
113                                     &iter_struct);
114   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
115   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
116   dbus_message_iter_close_container (iter, &iter_struct);
117   
118   g_free (path);
119 }
120
121 /* TODO: Perhaps combine with spi_object_append_reference.  Leaving separate
122  * for now in case we want to use a different path for hyperlinks. */
123 void
124 spi_hyperlink_append_reference (DBusMessageIter * iter, AtkHyperlink * obj)
125 {
126   DBusMessageIter iter_struct;
127   const gchar *name;
128   gchar *path;
129
130   if (!obj) {
131     spi_object_append_null_reference (iter);
132     return;
133   }
134
135   spi_object_lease_if_needed (G_OBJECT (obj));
136
137   name = dbus_bus_get_unique_name (spi_global_app_data->bus);
138   path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
139
140   if (!path)
141     path = g_strdup (SPI_DBUS_PATH_NULL);
142
143   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
144                                     &iter_struct);
145   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
146   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
147   dbus_message_iter_close_container (iter, &iter_struct);
148   
149   g_free (path);
150 }
151
152 void
153 spi_object_append_v_reference (DBusMessageIter * iter, AtkObject * obj)
154 {
155   DBusMessageIter iter_variant;
156
157   dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
158                                     &iter_variant);
159      spi_object_append_reference (&iter_variant, obj);
160   dbus_message_iter_close_container (iter, &iter_variant);
161 }
162
163 void
164 spi_object_append_desktop_reference (DBusMessageIter * iter)
165 {
166   DBusMessageIter iter_struct;
167   const char *name = spi_global_app_data->desktop_name;
168   const char *path = spi_global_app_data->desktop_path;
169
170   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
171                                     &iter_struct);
172   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
173   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
174   dbus_message_iter_close_container (iter, &iter_struct);
175 }
176
177 DBusMessage *
178 spi_object_return_reference (DBusMessage * msg, AtkObject * obj)
179 {
180   DBusMessage *reply;
181
182   reply = dbus_message_new_method_return (msg);
183   if (reply)
184     {
185       DBusMessageIter iter;
186       dbus_message_iter_init_append (reply, &iter);
187       spi_object_append_reference (&iter, obj);
188     }
189
190   return reply;
191 }
192
193 DBusMessage *
194 spi_hyperlink_return_reference (DBusMessage * msg, AtkHyperlink * obj)
195 {
196   DBusMessage *reply;
197
198   reply = dbus_message_new_method_return (msg);
199   if (reply)
200     {
201       DBusMessageIter iter;
202       dbus_message_iter_init_append (reply, &iter);
203       spi_hyperlink_append_reference (&iter, obj);
204     }
205   if (obj)
206     g_object_unref (G_OBJECT (obj));
207
208   return reply;
209 }
210
211 /*---------------------------------------------------------------------------*/
212
213 void
214 spi_object_append_interfaces (DBusMessageIter * iter, AtkObject * obj)
215 {
216   const gchar *itf;
217
218   itf = SPI_DBUS_INTERFACE_ACCESSIBLE;
219   dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
220
221   if (ATK_IS_ACTION (obj))
222     {
223       itf = SPI_DBUS_INTERFACE_ACTION;
224       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
225     }
226
227   if (atk_object_get_role (obj) == ATK_ROLE_APPLICATION)
228     {
229       itf = SPI_DBUS_INTERFACE_APPLICATION;
230       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
231     }
232
233   if (ATK_IS_COMPONENT (obj))
234     {
235       itf = SPI_DBUS_INTERFACE_COMPONENT;
236       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
237     }
238
239   if (ATK_IS_EDITABLE_TEXT (obj))
240     {
241       itf = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
242       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
243     }
244
245   if (ATK_IS_TEXT (obj))
246     {
247       itf = SPI_DBUS_INTERFACE_TEXT;
248       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
249     }
250
251   if (ATK_IS_HYPERTEXT (obj))
252     {
253       itf = SPI_DBUS_INTERFACE_HYPERTEXT;
254       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
255     }
256
257   if (ATK_IS_IMAGE (obj))
258     {
259       itf = SPI_DBUS_INTERFACE_IMAGE;
260       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
261     }
262
263   if (ATK_IS_SELECTION (obj))
264     {
265       itf = SPI_DBUS_INTERFACE_SELECTION;
266       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
267     }
268
269   if (ATK_IS_TABLE (obj))
270     {
271       itf = SPI_DBUS_INTERFACE_TABLE;
272       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
273     }
274
275   if (ATK_IS_VALUE (obj))
276     {
277       itf = SPI_DBUS_INTERFACE_VALUE;
278       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
279     }
280
281 #if 0
282   if (ATK_IS_STREAMABLE_CONTENT (obj))
283     {
284       itf = "org.a11y.atspi.StreamableContent";
285       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
286     }
287 #endif
288
289   if (ATK_IS_DOCUMENT (obj))
290     {
291       itf = "org.a11y.atspi.Collection";
292       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
293       itf = SPI_DBUS_INTERFACE_DOCUMENT;
294       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
295     }
296
297   if (ATK_IS_HYPERLINK_IMPL (obj))
298     {
299       itf = SPI_DBUS_INTERFACE_HYPERLINK;
300       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
301     }
302 }
303
304 /*---------------------------------------------------------------------------*/
305
306 void
307 spi_object_append_attribute_set (DBusMessageIter * iter, AtkAttributeSet * attr)
308 {
309   DBusMessageIter dictIter;
310
311   dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
312   while (attr)
313     {
314       DBusMessageIter dictEntryIter;
315       AtkAttribute *attribute = (AtkAttribute *) attr->data;
316       const char *key = attribute->name;
317       const char *value = attribute->value;
318
319       if (key == NULL)
320         key = "";
321       if (value == NULL)
322         value = "";
323
324       dbus_message_iter_open_container (&dictIter, DBUS_TYPE_DICT_ENTRY, NULL,
325                                         &dictEntryIter);
326       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
327                                       &key);
328       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
329                                       &value);
330       dbus_message_iter_close_container (&dictIter, &dictEntryIter);
331       attr = g_slist_next (attr);
332     }
333   dbus_message_iter_close_container (iter, &dictIter);
334 }
335
336 /*---------------------------------------------------------------------------*/
337
338 static gboolean
339 init_role_lookup_table (Accessibility_Role * role_table)
340 {
341   int i;
342   /* if it's not in the list below, dunno what it is */
343   for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
344     {
345       role_table[i] = Accessibility_ROLE_UNKNOWN;
346     }
347
348   role_table[ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
349   role_table[ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
350   role_table[ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
351   role_table[ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
352   role_table[ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
353   role_table[ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
354   role_table[ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
355   role_table[ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
356   role_table[ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
357   role_table[ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
358   role_table[ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
359   role_table[ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
360   role_table[ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
361   role_table[ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
362   role_table[ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
363   role_table[ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
364   role_table[ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
365   role_table[ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
366   role_table[ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
367   role_table[ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
368   role_table[ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
369   role_table[ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
370   role_table[ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
371   role_table[ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
372   role_table[ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
373   role_table[ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
374   role_table[ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
375   role_table[ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
376   role_table[ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
377   role_table[ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
378   role_table[ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
379   role_table[ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
380   role_table[ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
381   role_table[ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
382   role_table[ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
383   role_table[ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
384   role_table[ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
385   role_table[ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
386   role_table[ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
387   role_table[ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
388   role_table[ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
389   role_table[ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
390   role_table[ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
391   role_table[ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
392   role_table[ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
393   role_table[ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
394   role_table[ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
395   role_table[ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
396   role_table[ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
397   role_table[ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
398   role_table[ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
399   role_table[ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
400   role_table[ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
401   role_table[ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
402   role_table[ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
403   role_table[ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
404   role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
405     Accessibility_ROLE_TABLE_COLUMN_HEADER;
406   role_table[ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
407   role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
408     Accessibility_ROLE_TEAROFF_MENU_ITEM;
409   role_table[ATK_ROLE_TERMINAL] = Accessibility_ROLE_TERMINAL;
410   role_table[ATK_ROLE_TEXT] = Accessibility_ROLE_TEXT;
411   role_table[ATK_ROLE_TOGGLE_BUTTON] = Accessibility_ROLE_TOGGLE_BUTTON;
412   role_table[ATK_ROLE_TOOL_BAR] = Accessibility_ROLE_TOOL_BAR;
413   role_table[ATK_ROLE_TOOL_TIP] = Accessibility_ROLE_TOOL_TIP;
414   role_table[ATK_ROLE_TREE] = Accessibility_ROLE_TREE;
415   role_table[ATK_ROLE_TREE_TABLE] = Accessibility_ROLE_TREE_TABLE;
416   role_table[ATK_ROLE_UNKNOWN] = Accessibility_ROLE_UNKNOWN;
417   role_table[ATK_ROLE_VIEWPORT] = Accessibility_ROLE_VIEWPORT;
418   role_table[ATK_ROLE_WINDOW] = Accessibility_ROLE_WINDOW;
419   role_table[ATK_ROLE_HEADER] = Accessibility_ROLE_HEADER;
420   role_table[ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
421   role_table[ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
422   role_table[ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
423   role_table[ATK_ROLE_APPLICATION] = Accessibility_ROLE_APPLICATION;
424   role_table[ATK_ROLE_AUTOCOMPLETE] = Accessibility_ROLE_AUTOCOMPLETE;
425   role_table[ATK_ROLE_EDITBAR] = Accessibility_ROLE_EDITBAR;
426   role_table[ATK_ROLE_EMBEDDED] = Accessibility_ROLE_EMBEDDED;
427   role_table[ATK_ROLE_ENTRY] = Accessibility_ROLE_ENTRY;
428   role_table[ATK_ROLE_CHART] = Accessibility_ROLE_CHART;
429   role_table[ATK_ROLE_CAPTION] = Accessibility_ROLE_CAPTION;
430   role_table[ATK_ROLE_DOCUMENT_FRAME] = Accessibility_ROLE_DOCUMENT_FRAME;
431   role_table[ATK_ROLE_HEADING] = Accessibility_ROLE_HEADING;
432   role_table[ATK_ROLE_PAGE] = Accessibility_ROLE_PAGE;
433   role_table[ATK_ROLE_SECTION] = Accessibility_ROLE_SECTION;
434   role_table[ATK_ROLE_FORM] = Accessibility_ROLE_FORM;
435   role_table[ATK_ROLE_REDUNDANT_OBJECT] = Accessibility_ROLE_REDUNDANT_OBJECT;
436   role_table[ATK_ROLE_LINK] = Accessibility_ROLE_LINK;
437   role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
438     Accessibility_ROLE_INPUT_METHOD_WINDOW;
439   role_table[ATK_ROLE_TABLE_ROW] = Accessibility_ROLE_TABLE_ROW;
440   role_table[ATK_ROLE_TREE_ITEM] = Accessibility_ROLE_TREE_ITEM;
441   role_table[ATK_ROLE_DOCUMENT_SPREADSHEET] =
442     Accessibility_ROLE_DOCUMENT_SPREADSHEET;
443   role_table[ATK_ROLE_DOCUMENT_PRESENTATION] =
444     Accessibility_ROLE_DOCUMENT_PRESENTATION;
445   role_table[ATK_ROLE_DOCUMENT_TEXT] = Accessibility_ROLE_DOCUMENT_TEXT;
446   role_table[ATK_ROLE_DOCUMENT_WEB] = Accessibility_ROLE_DOCUMENT_WEB;
447   role_table[ATK_ROLE_DOCUMENT_EMAIL] = Accessibility_ROLE_DOCUMENT_EMAIL;
448   role_table[ATK_ROLE_COMMENT] = Accessibility_ROLE_COMMENT;
449   role_table[ATK_ROLE_LIST_BOX] = Accessibility_ROLE_LIST_BOX;
450   role_table[ATK_ROLE_GROUPING] = Accessibility_ROLE_GROUPING;
451   role_table[ATK_ROLE_IMAGE_MAP] = Accessibility_ROLE_IMAGE_MAP;
452   role_table[ATK_ROLE_NOTIFICATION] = Accessibility_ROLE_NOTIFICATION;
453   role_table[ATK_ROLE_INFO_BAR] = Accessibility_ROLE_INFO_BAR;
454   return TRUE;
455 }
456
457 Accessibility_Role
458 spi_accessible_role_from_atk_role (AtkRole role)
459 {
460   static gboolean is_initialized = FALSE;
461   static Accessibility_Role spi_role_table[ATK_ROLE_LAST_DEFINED];
462   Accessibility_Role spi_role;
463
464   if (!is_initialized)
465     {
466       is_initialized = init_role_lookup_table (spi_role_table);
467     }
468
469   if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
470     {
471       spi_role = spi_role_table[role];
472     }
473   else
474     {
475       spi_role = Accessibility_ROLE_EXTENDED;
476     }
477   return spi_role;
478 }
479
480 /*END------------------------------------------------------------------------*/