2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
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.
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.
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.
26 * Basic SPI initialization and event loop function prototypes
33 #include <cspi/spi-private.h>
38 static CORBA_Environment ev = { 0 };
39 static Accessibility_Registry registry = CORBA_OBJECT_NIL;
40 static GHashTable *live_refs = NULL;
41 static GQueue *exception_handlers = NULL;
44 cspi_object_hash (gconstpointer key)
46 CORBA_Object object = (CORBA_Object) key;
48 return CORBA_Object_hash (object, 0, &ev);
52 cspi_object_equal (gconstpointer a, gconstpointer b)
54 CORBA_Object objecta = (CORBA_Object) a;
55 CORBA_Object objectb = (CORBA_Object) b;
57 return CORBA_Object_is_equivalent (objecta, objectb, cspi_ev ());
61 cspi_object_release (gpointer value)
63 Accessible *a = (Accessible *) value;
66 g_print ("releasing %p => %p\n", a, a->objref);
71 cspi_release_unref (a->objref);
74 memset (a, 0xaa, sizeof (Accessible));
83 _cspi_exception_throw (CORBA_Environment *ev, char *desc_prefix)
85 SPIExceptionHandler *handler = NULL;
87 if (exception_handlers) handler = g_queue_peek_head (exception_handlers);
89 ex.type = SPI_EXCEPTION_SOURCE_UNSPECIFIED;
90 ex.source = CORBA_OBJECT_NIL; /* can we get this from here? */
91 ex.ev = CORBA_exception__copy (ev);
93 case CORBA_SYSTEM_EXCEPTION:
94 ex.code = SPI_EXCEPTION_UNSPECIFIED;
96 case CORBA_USER_EXCEPTION: /* help! how to interpret this? */
97 ex.code = SPI_EXCEPTION_UNSPECIFIED;
100 ex.code = SPI_EXCEPTION_UNSPECIFIED;
105 return (*handler) (&ex, FALSE);
107 return FALSE; /* means exception was not handled */
111 cspi_accessible_is_a (Accessible *accessible,
112 const char *interface_name)
115 Bonobo_Unknown unknown;
117 if (accessible == NULL)
122 unknown = Bonobo_Unknown_queryInterface (CSPI_OBJREF (accessible),
123 interface_name, cspi_ev ());
125 if (ev._major != CORBA_NO_EXCEPTION)
127 g_warning ("Exception '%s' checking if is '%s'",
128 cspi_exception_get_text (),
133 else if (unknown != CORBA_OBJECT_NIL)
136 cspi_release_unref (unknown);
147 cspi_get_live_refs (void)
151 live_refs = g_hash_table_new_full (cspi_object_hash,
154 cspi_object_release);
162 CORBA_exception_init (&ev);
166 Accessibility_Registry
169 if (!cspi_ping (registry))
171 registry = cspi_init ();
177 cspi_exception (void)
181 if (ev._major != CORBA_NO_EXCEPTION)
183 CORBA_exception_free (&ev);
195 * This method swallows the corba_object BonoboUnknown
196 * reference, and returns an Accessible associated with it.
197 * If the reference is loaned, it means it is only valid
198 * between a borrow / return pair.
201 cspi_object_get_ref (CORBA_Object corba_object, gboolean on_loan)
205 if (corba_object == CORBA_OBJECT_NIL)
209 else if (!cspi_check_ev ("pre method check: add"))
215 if ((ref = g_hash_table_lookup (cspi_get_live_refs (), corba_object)))
217 g_assert (ref->ref_count > 0);
221 if (ref->on_loan) /* Convert to a permanant ref */
223 ref->on_loan = FALSE;
227 cspi_release_unref (corba_object);
231 g_print ("returning cached %p => %p\n", ref, ref->objref);
236 ref = malloc (sizeof (Accessible));
237 ref->objref = corba_object;
239 ref->on_loan = on_loan;
241 g_print ("allocated %p => %p\n", ref, corba_object);
243 g_hash_table_insert (cspi_get_live_refs (), ref->objref, ref);
251 cspi_object_add (CORBA_Object corba_object)
253 return cspi_object_get_ref (corba_object, FALSE);
257 cspi_object_borrow (CORBA_Object corba_object)
259 return cspi_object_get_ref (corba_object, TRUE);
263 cspi_object_return (Accessible *accessible)
265 g_return_if_fail (accessible != NULL);
267 if (!accessible->on_loan ||
268 accessible->ref_count == 1)
270 cspi_object_unref (accessible);
272 else /* Convert to a permanant ref */
274 accessible->on_loan = FALSE;
275 accessible->objref = cspi_dup_ref (accessible->objref);
276 accessible->ref_count--;
281 cspi_object_take (CORBA_Object corba_object)
283 Accessible *accessible;
284 accessible = cspi_object_borrow (corba_object);
286 cspi_object_ref (accessible);
288 * if the remote object is dead,
289 * cspi_object_return will throw an exception.
290 * FIXME: what clears that exception context ever ?
292 cspi_object_return (accessible);
293 if (cspi_exception ())
295 cspi_object_unref (accessible);
302 cspi_object_ref (Accessible *accessible)
304 g_return_if_fail (accessible != NULL);
306 accessible->ref_count++;
310 cspi_object_unref (Accessible *accessible)
312 if (accessible == NULL)
317 if (--accessible->ref_count == 0)
319 g_hash_table_remove (cspi_get_live_refs (), accessible->objref);
328 cspi_streams_close_all ();
334 g_hash_table_destroy (refs);
337 if (registry != CORBA_OBJECT_NIL)
339 cspi_release_unref (registry);
340 registry = CORBA_OBJECT_NIL;
344 static gboolean SPI_inited = FALSE;
349 * Connects to the accessibility registry and initializes the SPI.
351 * Returns: 0 on success, otherwise an integer error code.
363 CORBA_exception_init (&ev);
365 registry = cspi_init ();
367 g_atexit (cspi_cleanup);
375 * Starts/enters the main event loop for the SPI services.
377 * (NOTE: This method does not return control, it is exited via a call to
378 * SPI_event_quit () from within an event handler).
382 SPI_event_main (void)
390 * Quits the last main event loop for the SPI services,
394 SPI_event_quit (void)
402 * Checks to see if an SPI event is waiting in the event queue.
403 * Used by clients that don't wish to use SPI_event_main().
405 * Not Yet Implemented.
407 * Returns: #TRUE if an event is waiting, otherwise #FALSE.
418 * @waitForEvent: a #SPIBoolean indicating whether to block or not.
420 * Gets the next event in the SPI event queue; blocks if no event
421 * is pending and @waitForEvent is #TRUE.
422 * Used by clients that don't wish to use SPI_event_main().
424 * Not Yet Implemented.
426 * Returns: the next #AccessibleEvent in the SPI event queue.
429 SPI_nextEvent (SPIBoolean waitForEvent)
435 report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
438 Accessible *a = (Accessible *) val;
440 name = Accessible_getName (a);
441 if (cspi_exception ())
446 role = Accessible_getRoleName (a);
447 if (cspi_exception ())
452 fprintf (stderr, "leaked %d references to object %s, role %s %p\n",
453 a->ref_count, name ? name : "<?>", role ? role : "<?>", a);
455 SPI_freeString (name);
462 * Disconnects from the Accessibility Registry and releases
463 * any floating resources. Call only once at exit.
465 * Returns: 0 if there were no leaks, otherwise non zero.
481 leaked = g_hash_table_size (live_refs);
484 g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
495 fprintf (stderr, "Leaked %d SPI handles\n", leaked);
501 fprintf (stderr, "bye-bye!\n");
508 * @s: a character string returned from another at-spi call.
510 * Free a character string returned from an at-spi call. Clients of
511 * at-spi should use this function instead of free () or g_free().
512 * A NULL string @s will be silently ignored.
513 * This API should not be used to free strings
514 * from other libraries or allocated by the client.
517 SPI_freeString (char *s)
529 SPI_dupString (char *s)
533 return CORBA_string_dup (s);
542 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
544 if (!exception_handlers)
545 exception_handlers = g_queue_new ();
546 g_queue_push_head (exception_handlers, handler);
553 SPIExceptionHandler* SPI_exceptionHandlerPop (void)
555 return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
561 SPIExceptionType SPIException_getSourceType (SPIException *err)
566 return SPI_EXCEPTION_UNSPECIFIED;
572 SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
580 Accessible* SPIAccessibleException_getSource (SPIException *err)
582 if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
583 return cspi_object_get_ref (err->source, FALSE);
590 char* SPIException_getDescription (SPIException *err)
592 /* TODO: friendlier error messages? */
594 return CORBA_exception_id (err->ev);