2003-08-19 Padraig O'Briain <padraig.obriain@sun.com>
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_main.c
index 6cf1924..f54b60a 100644 (file)
@@ -2,7 +2,8 @@
  * AT-SPI - Assistive Technology Service Provider Interface
  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
  *
- * Copyright 2001 Sun Microsystems Inc.
+ * 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
  * 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"
 
 #undef DEBUG_OBJECTS
 
 static CORBA_Environment ev = { 0 };
 static Accessibility_Registry registry = CORBA_OBJECT_NIL;
 static GHashTable *live_refs = NULL;
+static GQueue *exception_handlers = NULL;
 
 static guint
 cspi_object_hash (gconstpointer key)
 {
   CORBA_Object object = (CORBA_Object) key;
-  guint        retval;
-  
-  retval = CORBA_Object_hash (object, 0, &ev);
 
-  return retval;
+  return CORBA_Object_hash (object, 0, &ev);
 }
 
 static gboolean
@@ -51,15 +53,12 @@ cspi_object_equal (gconstpointer a, gconstpointer b)
 {
   CORBA_Object objecta = (CORBA_Object) a;
   CORBA_Object objectb = (CORBA_Object) b;
-  gboolean     retval;
-
-  retval = CORBA_Object_is_equivalent (objecta, objectb, &ev);
 
-  return retval;
+  return CORBA_Object_is_equivalent (objecta, objectb, cspi_ev ());
 }
 
 static void
-cspi_object_release (gpointer  value)
+cspi_object_release (gpointer value)
 {
   Accessible *a = (Accessible *) value;
 
@@ -67,7 +66,10 @@ cspi_object_release (gpointer  value)
   g_print ("releasing %p => %p\n", a, a->objref);
 #endif
 
-  cspi_release_unref (a->objref);
+  if (!a->on_loan)
+    {
+      cspi_release_unref (a->objref);
+    }
 
   memset (a, 0xaa, sizeof (Accessible));
   a->ref_count = -1;
@@ -77,29 +79,58 @@ cspi_object_release (gpointer  value)
 #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 *obj,
+cspi_accessible_is_a (Accessible *accessible,
                      const char *interface_name)
 {
   SPIBoolean        retval;
   Bonobo_Unknown unknown;
 
-  if (obj == NULL)
+  if (accessible == NULL)
     {
       return FALSE;
     }
 
-  unknown = Bonobo_Unknown_queryInterface (CSPI_OBJREF (obj),
+  unknown = Bonobo_Unknown_queryInterface (CSPI_OBJREF (accessible),
                                           interface_name, cspi_ev ());
 
   if (ev._major != CORBA_NO_EXCEPTION)
     {
-      g_error ("Exception '%s' checking if is '%s'",
-              cspi_exception_get_text (),
-              interface_name);
+      g_warning ("Exception '%s' checking if is '%s'",
+                cspi_exception_get_text (),
+                interface_name);
+      retval = FALSE;
     }
 
-  if (unknown != CORBA_OBJECT_NIL)
+  else if (unknown != CORBA_OBJECT_NIL)
     {
       retval = TRUE;
       cspi_release_unref (unknown);
@@ -126,15 +157,25 @@ cspi_get_live_refs (void)
 }
 
 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;
 }
 
@@ -156,8 +197,14 @@ cspi_exception (void)
   return retval;
 }
 
-Accessible *
-cspi_object_new (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;
 
@@ -171,10 +218,36 @@ cspi_object_new (CORBA_Object corba_object)
     }
   else
     {
-      ref = malloc (sizeof (Accessible));
-//    ref->objref = CORBA_Object_duplicate (corba_object, cspi_ev ());
-      ref->objref = corba_object;
-      ref->ref_count = 1;
+      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;
@@ -183,53 +256,52 @@ cspi_object_new (CORBA_Object corba_object)
 Accessible *
 cspi_object_add (CORBA_Object corba_object)
 {
-       return cspi_object_add_ref (corba_object, FALSE);
+  return cspi_object_get_ref (corba_object, FALSE);
 }
 
 Accessible *
-cspi_object_add_ref (CORBA_Object corba_object, gboolean do_ref)
+cspi_object_borrow (CORBA_Object corba_object)
 {
-  Accessible *ref;
+  return cspi_object_get_ref (corba_object, TRUE);
+}
 
-  if (corba_object == CORBA_OBJECT_NIL)
+void
+cspi_object_return (Accessible *accessible)
+{
+  g_return_if_fail (accessible != NULL);
+
+  if (!accessible->on_loan ||
+      accessible->ref_count == 1)
     {
-      ref = NULL;
+      cspi_object_unref (accessible);
     }
-  else if (!cspi_check_ev ("pre method check: add"))
+  else /* Convert to a permanant ref */
     {
-      ref = NULL;
+      accessible->on_loan = FALSE;
+      accessible->objref = cspi_dup_ref (accessible->objref);
+      accessible->ref_count--;
     }
-  else
-    {
-      if ((ref = g_hash_table_lookup (cspi_get_live_refs (), corba_object)))
-        {
-          g_assert (ref->ref_count > 0);
-         ref->ref_count++;
-          if (!do_ref) 
-               cspi_release_unref (corba_object);
-#ifdef DEBUG_OBJECTS
-          g_print ("returning cached %p => %p\n", ref, ref->objref);
-#endif
-       }
-      else
-        {
-         ref = cspi_object_new (corba_object);
+}
 
-#ifdef DEBUG_OBJECTS
-          g_print ("allocated %p => %p\n", ref, corba_object);
-#endif
-         if (do_ref) {
-#ifdef JAVA_BRIDGE_BUG_IS_FIXED
-                 g_assert (CORBA_Object_is_a (corba_object,
-                                               "IDL:Bonobo/Unknown:1.0", cspi_ev ()));
-#endif
-                 Bonobo_Unknown_ref (corba_object, cspi_ev ());
-         }
-          g_hash_table_insert (cspi_get_live_refs (), ref->objref, ref);
-       }
+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 ref;
+  return accessible;
 }
 
 void
@@ -237,12 +309,7 @@ cspi_object_ref (Accessible *accessible)
 {
   g_return_if_fail (accessible != NULL);
 
-  if (g_hash_table_lookup (cspi_get_live_refs (), accessible->objref) == NULL) {
-         accessible->objref = bonobo_object_dup_ref (accessible->objref, cspi_ev ());
-         g_hash_table_insert (cspi_get_live_refs (), accessible->objref, accessible);    
-  } else {
-         accessible->ref_count++;
-  }
+  accessible->ref_count++;
 }
 
 void
@@ -264,6 +331,8 @@ cspi_cleanup (void)
 {
   GHashTable *refs;
 
+  cspi_streams_close_all ();
+
   refs = live_refs;
   live_refs = NULL;
   if (refs)
@@ -371,15 +440,25 @@ SPI_nextEvent (SPIBoolean waitForEvent)
 static void
 report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
 {
-       Accessible *a = (Accessible *) val;
-       char *name, *role;
-       name = Accessible_getName (a);
-       if (cspi_exception ()) name = NULL;
-       role = Accessible_getRoleName (a);
-       if (cspi_exception ()) role = NULL;
-       fprintf (stderr, "leaked object %s, role %s\n", (name) ? name : "<?>",
-                (role) ? role : "<?>");
-       if (name) SPI_freeString (name);
+  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);
 }
 
 
@@ -436,11 +515,88 @@ SPI_exit (void)
  *
  * 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)
 {
-  CORBA_free (s);
+  if (s)
+    {
+      CORBA_free (s);
+    }
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+char *
+SPI_dupString (char *s)
+{
+  if (s)
+    {
+      return CORBA_string_dup (s);
+    }
+  else 
+    return NULL;
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
+{
+  if (!exception_handlers)
+    exception_handlers = g_queue_new ();
+  g_queue_push_head (exception_handlers, handler);
+  return TRUE;
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+SPIExceptionHandler* SPI_exceptionHandlerPop (void)
+{
+  return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+SPIExceptionType SPIException_getSourceType (SPIException *err)
+{
+  if (err)
+    return err->type;
+  else
+    return SPI_EXCEPTION_SOURCE_UNSPECIFIED;
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
+{  
+  return err->code;
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+Accessible* SPIAccessibleException_getSource (SPIException *err)
+{
+  if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
+    return cspi_object_get_ref (err->source, FALSE);
+  return NULL;
+}
+
+/**
+ * DOCUMENT_ME!
+ **/
+char* SPIException_getDescription (SPIException *err)
+{
+  /* TODO: friendlier error messages? */
+  if (err->ev)
+    return CORBA_exception_id (err->ev);
+  return NULL;
 }