/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+/*
*
* Basic SPI initialization and event loop function prototypes
*
*/
+
+#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <cspi/spi-private.h>
+#include "spi.h"
-static CORBA_Environment ev = { 0 };
+#undef DEBUG_OBJECTS
+
+static CORBA_Environment ev = { NULL };
static Accessibility_Registry registry = CORBA_OBJECT_NIL;
-static SPIBoolean is_gnome_app = FALSE;
-static GSList *live_refs = NULL;
+static GHashTable *live_refs = NULL;
+static GQueue *exception_handlers = NULL;
+
+static guint
+cspi_object_hash (gconstpointer key)
+{
+ CORBA_Object object = (CORBA_Object) key;
+
+ return CORBA_Object_hash (object, 0, &ev);
+}
+
+static gboolean
+cspi_object_equal (gconstpointer a, gconstpointer b)
+{
+ CORBA_Object objecta = (CORBA_Object) a;
+ CORBA_Object objectb = (CORBA_Object) b;
+
+ return CORBA_Object_is_equivalent (objecta, objectb, cspi_ev ());
+}
+
+static void
+cspi_object_release (gpointer value)
+{
+ Accessible *a = (Accessible *) value;
+
+#ifdef DEBUG_OBJECTS
+ g_print ("releasing %p => %p\n", a, a->objref);
+#endif
+
+ if (!a->on_loan)
+ {
+ cspi_release_unref (a->objref);
+ }
+
+ memset (a, 0xaa, sizeof (Accessible));
+ a->ref_count = -1;
+
+#ifndef DEBUG_OBJECTS
+ free (a);
+#endif
+}
+
+gboolean
+cspi_exception_throw (CORBA_Environment *ev, char *desc_prefix)
+{
+ SPIExceptionHandler *handler = NULL;
+ SPIException ex;
+ if (exception_handlers) handler = g_queue_peek_head (exception_handlers);
+
+ ex.type = SPI_EXCEPTION_SOURCE_UNSPECIFIED;
+ ex.source = CORBA_OBJECT_NIL; /* can we get this from here? */
+ ex.ev = CORBA_exception__copy (ev);
+ switch (ev->_major) {
+ case CORBA_SYSTEM_EXCEPTION:
+ ex.code = SPI_EXCEPTION_UNSPECIFIED;
+ break;
+ case CORBA_USER_EXCEPTION: /* help! how to interpret this? */
+ ex.code = SPI_EXCEPTION_UNSPECIFIED;
+ break;
+ default:
+ ex.code = SPI_EXCEPTION_UNSPECIFIED;
+ break;
+ }
+
+ if (handler)
+ return (*handler) (&ex, FALSE);
+ else
+ return FALSE; /* means exception was not handled */
+}
+
+SPIBoolean
+cspi_accessible_is_a (Accessible *accessible,
+ const char *interface_name)
+{
+ SPIBoolean retval;
+ Bonobo_Unknown unknown;
+
+ if (accessible == NULL)
+ {
+ return FALSE;
+ }
+
+ unknown = Bonobo_Unknown_queryInterface (CSPI_OBJREF (accessible),
+ interface_name, cspi_ev ());
+
+ if (ev._major != CORBA_NO_EXCEPTION)
+ {
+ g_warning ("Exception '%s' checking if is '%s'",
+ cspi_exception_get_text (),
+ interface_name);
+ retval = FALSE;
+ }
+
+ else if (unknown != CORBA_OBJECT_NIL)
+ {
+ retval = TRUE;
+ cspi_release_unref (unknown);
+ }
+ else
+ {
+ retval = FALSE;
+ }
+
+ return retval;
+}
+
+static GHashTable *
+cspi_get_live_refs (void)
+{
+ if (!live_refs)
+ {
+ live_refs = g_hash_table_new_full (cspi_object_hash,
+ cspi_object_equal,
+ NULL,
+ cspi_object_release);
+ }
+ return live_refs;
+}
+
+CORBA_Environment *
+cspi_peek_ev (void)
+{
+ return &ev;
+}
CORBA_Environment *
cspi_ev (void)
{
- /* This method is an ugly hack */
+ CORBA_exception_init (&ev);
return &ev;
}
Accessibility_Registry
cspi_registry (void)
{
+ if (!cspi_ping (registry))
+ {
+ registry = cspi_init ();
+ }
return registry;
}
SPIBoolean
-cspi_is_gnome_app (void)
-{
- return is_gnome_app;
-}
-
-SPIBoolean
cspi_exception (void)
{
SPIBoolean retval;
- if (BONOBO_EX (&ev))
+ if (ev._major != CORBA_NO_EXCEPTION)
{
CORBA_exception_free (&ev);
retval = TRUE;
return retval;
}
-Accessible *
-cspi_object_add (CORBA_Object corba_object)
+/*
+ * This method swallows the corba_object BonoboUnknown
+ * reference, and returns an Accessible associated with it.
+ * If the reference is loaned, it means it is only valid
+ * between a borrow / return pair.
+ */
+static Accessible *
+cspi_object_get_ref (CORBA_Object corba_object, gboolean on_loan)
{
Accessible *ref;
- if (corba_object != CORBA_OBJECT_NIL)
+ if (corba_object == CORBA_OBJECT_NIL)
{
- ref = g_new (Accessible, 1);
-
- ref->objref = CORBA_Object_duplicate (corba_object, cspi_ev());
- ref->ref_count = 1;
-
- live_refs = g_slist_prepend (live_refs, ref);
+ ref = NULL;
+ }
+ else if (!cspi_check_ev ("pre method check: add"))
+ {
+ ref = NULL;
}
else
- {
- ref = NULL;
- }
+ {
+ if ((ref = g_hash_table_lookup (cspi_get_live_refs (), corba_object)))
+ {
+ g_assert (ref->ref_count > 0);
+ ref->ref_count++;
+ if (!on_loan)
+ {
+ if (ref->on_loan) /* Convert to a permanant ref */
+ {
+ ref->on_loan = FALSE;
+ }
+ else
+ {
+ cspi_release_unref (corba_object);
+ }
+ }
+#ifdef DEBUG_OBJECTS
+ g_print ("returning cached %p => %p\n", ref, ref->objref);
+#endif
+ }
+ else
+ {
+ ref = malloc (sizeof (Accessible));
+ ref->objref = corba_object;
+ ref->ref_count = 1;
+ ref->on_loan = on_loan;
+#ifdef DEBUG_OBJECTS
+ g_print ("allocated %p => %p\n", ref, corba_object);
+#endif
+ g_hash_table_insert (cspi_get_live_refs (), ref->objref, ref);
+ }
+ }
return ref;
}
+Accessible *
+cspi_object_add (CORBA_Object corba_object)
+{
+ return cspi_object_get_ref (corba_object, FALSE);
+}
+
+Accessible *
+cspi_object_borrow (CORBA_Object corba_object)
+{
+ return cspi_object_get_ref (corba_object, TRUE);
+}
+
+void
+cspi_object_return (Accessible *accessible)
+{
+ int old_ref_count;
+ g_return_if_fail (accessible != NULL);
+
+ if (!accessible->on_loan ||
+ accessible->ref_count == 1)
+ {
+ cspi_object_unref (accessible);
+ }
+ else /* Convert to a permanant ref */
+ {
+ accessible->on_loan = FALSE;
+ old_ref_count = accessible->ref_count;
+ accessible->objref = cspi_dup_ref (accessible->objref);
+ if (old_ref_count != accessible->ref_count &&
+ accessible->ref_count == 1)
+ {
+ cspi_object_unref (accessible);
+ }
+ else
+ {
+ accessible->ref_count--;
+ }
+ }
+}
+
+Accessible *
+cspi_object_take (CORBA_Object corba_object)
+{
+ Accessible *accessible;
+ accessible = cspi_object_borrow (corba_object);
+
+ cspi_object_ref (accessible);
+ /*
+ * if the remote object is dead,
+ * cspi_object_return will throw an exception.
+ * FIXME: what clears that exception context ever ?
+ */
+ cspi_object_return (accessible);
+ if (cspi_exception ())
+ {
+ cspi_object_unref (accessible);
+ accessible = NULL;
+ }
+ return accessible;
+}
+
void
cspi_object_ref (Accessible *accessible)
{
void
cspi_object_unref (Accessible *accessible)
{
- g_return_if_fail (accessible != NULL);
-
- if (--accessible->ref_count == 0)
+ if (accessible == NULL)
{
- live_refs = g_slist_remove (live_refs, accessible);
-
- bonobo_object_release_unref (accessible->objref, cspi_ev ());
-
- cspi_check_ev (cspi_ev (), "unref");
-
- memset (accessible, 0xaa, sizeof (Accessible));
+ return;
+ }
- g_free (accessible);
+ g_return_if_fail (accessible->ref_count > 0);
+ if (--accessible->ref_count == 0)
+ {
+ g_hash_table_remove (cspi_get_live_refs (), accessible->objref);
}
}
static void
cspi_cleanup (void)
{
- GSList *l, *refs;
+ GHashTable *refs;
+
+ cspi_streams_close_all ();
refs = live_refs;
live_refs = NULL;
-
- for (l = refs; l; l = l->next)
+ if (refs)
{
- Accessible *a = l->data;
-
- g_print ("releasing %p\n", l->data);
- bonobo_object_release_unref (a->objref, NULL);
-
- g_free (a);
+ g_hash_table_destroy (refs);
}
- g_slist_free (refs);
-
if (registry != CORBA_OBJECT_NIL)
{
- bonobo_object_release_unref (registry, NULL);
+ cspi_release_unref (registry);
registry = CORBA_OBJECT_NIL;
}
}
+static gboolean SPI_inited = FALSE;
+
/**
* SPI_init:
*
* Connects to the accessibility registry and initializes the SPI.
*
- * Returns: 0 on success, otherwise an integer error code.
+ * Returns: 0 on success, otherwise an integer error code.
**/
int
SPI_init (void)
{
- int argc = 0;
- char *obj_id;
- static gboolean inited = FALSE;
-
- if (inited)
+ if (SPI_inited)
{
return 1;
}
- inited = TRUE;
+ SPI_inited = TRUE;
CORBA_exception_init (&ev);
- if (!bonobo_init (&argc, NULL))
- {
- g_error ("Could not initialize Bonobo");
- }
-
- obj_id = "OAFIID:Accessibility_Registry:proto0.1";
-
- registry = bonobo_activation_activate_from_id (
- obj_id, 0, NULL, cspi_ev ());
+ registry = cspi_init ();
- if (ev._major != CORBA_NO_EXCEPTION)
- {
- g_error ("AT-SPI error: during registry activation: %s\n",
- bonobo_exception_get_text (cspi_ev ()));
- }
+ g_atexit (cspi_cleanup);
- if (registry == CORBA_OBJECT_NIL)
- {
- g_error ("Could not locate registry");
- }
+ /* fprintf (stderr, "registry=%x\n", (int) registry); */
- Accessibility_Registry_ref (registry, &ev);
-
- bonobo_activate ();
-
- return 0;
+ if ((registry != CORBA_OBJECT_NIL) && (cspi_ping (registry)))
+ return 0;
+ else
+ return 2;
}
/**
* SPI_event_main:
- * @isGNOMEApp: a #SPIBoolean indicating whether the client of the SPI
- * will use the Gnome event loop or not. Clients that have
- * their own GUIS will usually specify #TRUE here, and must
- * do so if they use Gnome GUI components.
*
* Starts/enters the main event loop for the SPI services.
*
- * (NOTE: This method does not return control, it is exited via a call to SPI_exit()
- * from within an event handler).
+ * (NOTE: This method does not return control, it is exited via a call to
+ * SPI_event_quit () from within an event handler).
*
**/
void
-SPI_event_main (SPIBoolean isGNOMEApp)
+SPI_event_main (void)
{
- is_gnome_app = isGNOMEApp;
- if (isGNOMEApp)
- {
- g_atexit (cspi_cleanup);
- bonobo_main ();
- }
- else
- {
- /* TODO: install signal handlers to do cleanup */
- CORBA_ORB_run (bonobo_orb (), cspi_ev ());
- fprintf (stderr, "orb loop exited...\n");
- }
+ cspi_main ();
+}
+
+/**
+ * SPI_event_quit:
+ *
+ * Quits the last main event loop for the SPI services,
+ * see SPI_event_main
+ **/
+void
+SPI_event_quit (void)
+{
+ cspi_main_quit ();
}
/**
*
**/
SPIBoolean
-SPI_eventIsReady ()
+SPI_eventIsReady (void)
{
return FALSE;
}
return NULL;
}
+#ifdef PRINT_LEAKS
+static void
+report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
+{
+ char *name, *role;
+ Accessible *a = (Accessible *) val;
+
+ name = Accessible_getName (a);
+ if (cspi_exception ())
+ {
+ name = NULL;
+ }
+
+ role = Accessible_getRoleName (a);
+ if (cspi_exception ())
+ {
+ role = NULL;
+ }
+
+ fprintf (stderr, "leaked %d references to object %s, role %s %p\n",
+ a->ref_count, name ? name : "<?>", role ? role : "<?>", a);
+
+ SPI_freeString (name);
+}
+#endif
+
/**
* SPI_exit:
*
* Disconnects from the Accessibility Registry and releases
- * any floating resources.
+ * any floating resources. Call only once at exit.
+ *
+ * Returns: 0 if there were no leaks, otherwise non zero.
**/
-void
+int
SPI_exit (void)
{
- cspi_cleanup();
- if (cspi_is_gnome_app ())
+ int leaked;
+
+ if (!SPI_inited)
{
- bonobo_main_quit ();
+ return 0;
+ }
+
+ SPI_inited = FALSE;
+
+ if (live_refs)
+ {
+ leaked = g_hash_table_size (live_refs);
+#ifdef DEBUG_OBJECTS
+ fprintf (stderr, "Leaked %d SPI handles\n", leaked);
+
+#define PRINT_LEAKS
+#ifdef PRINT_LEAKS
+ g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
+#endif
+
+#endif
}
else
{
- CORBA_ORB_shutdown (bonobo_orb (), TRUE, cspi_ev ());
+ leaked = 0;
+ }
+
+ cspi_cleanup ();
+
+ return leaked;
+}
+
+/**
+ * SPI_freeString:
+ * @s: a character string returned from another at-spi call.
+ *
+ * Free a character string returned from an at-spi call. Clients of
+ * at-spi should use this function instead of free () or g_free().
+ * A NULL string @s will be silently ignored.
+ * This API should not be used to free strings
+ * from other libraries or allocated by the client.
+ **/
+void
+SPI_freeString (char *s)
+{
+ if (s)
+ {
+ CORBA_free (s);
+ }
+}
+
+/**
+ * SPI_freeRect:
+ * @r: a pointer to an SPIRect returned from another at-spi call.
+ *
+ * Free a SPIRect structure returned from an at-spi call. Clients of
+ * at-spi should use this function instead of free () or g_free().
+ * A NULL rect @r will be silently ignored.
+ * This API should not be used to free data
+ * from other libraries or allocated by the client.
+ *
+ * @Since: AT-SPI 1.6
+ **/
+void
+SPI_freeRect (SPIRect *r)
+{
+ if (r)
+ {
+ /* err, okay, in this case the client _could_
+ have called g_free, but we don't want to guarantee it */
+ g_free (r);
+ }
+}
+
+/**
+ * SPI_dupString:
+ * @s: a UTF-8 string to be duplicated
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns: a duplicate of the string passed as a parameter, which should
+ * be freed via SPI_freeString after use.
+ **/
+char *
+SPI_dupString (char *s)
+{
+ if (s)
+ {
+ return CORBA_string_dup (s);
}
- fprintf (stderr, "bye-bye!\n");
+ else
+ return NULL;
}
+/**
+ * SPI_exceptionHandlerPush:
+ * @handler: an #SPIExceptionHandler to install as the first code to deal with exceptions.
+ *
+ * Install a client-side handler for #SPIException instances, which can see and handle any
+ * exceptions before chaining them to the next exception handler in the stack.
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns %TRUE if the result succeeded, %FALSE if @hander could not be registered.
+ **/
+SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
+{
+ if (!exception_handlers)
+ exception_handlers = g_queue_new ();
+ g_queue_push_head (exception_handlers, handler);
+ return TRUE;
+}
+
+/**
+ * SPI_exceptionHandlerPop:
+ *
+ * Remove/pop an #SPIExceptionHandler off the error handler stack and return the new handler.
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns the #SPIExceptionHandler which is now at the top of the error handler stack after the call.
+ **/
+SPIExceptionHandler* SPI_exceptionHandlerPop (void)
+{
+ return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
+}
+
+/**
+ * SPIException_getSourceType:
+ * @err: the exception being queried
+ *
+ * Get the #SPIExceptionType of an exception which has been thrown.
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns: the #SPIExceptionType corresponding to exception @err.
+ **/
+SPIExceptionType SPIException_getSourceType (SPIException *err)
+{
+ if (err)
+ return err->type;
+ else
+ return SPI_EXCEPTION_SOURCE_UNSPECIFIED;
+}
+
+/**
+ * SPIException_getExceptionCode:
+ * @err: the #SPIException being queried.
+ *
+ * Get the #SPIExceptionCode telling what type of exception condition has occurred.
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns: the #SPIExceptionCode corresponding to exception @err.
+ **/
+SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
+{
+ return err->code;
+}
+
+/**
+ * SPIAccessibleException_getSource:
+ * @err: the #SPIException being queried.
+ *
+ * Get the identity of the object which threw an exception.
+ *
+ * @Since: AT-SPI 1.4
+ *
+ * Returns: a pointer to the #Accessible object which threw the exception.
+ **/
+Accessible* SPIAccessibleException_getSource (SPIException *err)
+{
+ if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
+ return cspi_object_get_ref (err->source, FALSE);
+ return NULL;
+}
+
+/**
+ * SPIException_getDescription:
+ * @err: the #SPIException being queried.
+ *
+ * Get a text description of the exception that has been thrown.
+ * Unfortunately these descriptions tend to be terse and limited in
+ * the detail which they can provide.
+ *
+ * Returns: a brief character string describing the exception.
+ **/
+char* SPIException_getDescription (SPIException *err)
+{
+ /* TODO: friendlier error messages? */
+ if (err->ev)
+ return CORBA_exception_id (err->ev);
+ return NULL;
+}
projects / platform / core / uifw / at-spi2-atk.git / blobdiff