2003-08-19 Padraig O'Briain <padraig.obriain@sun.com>
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_main.c
index 0bc3a6c..f54b60a 100644 (file)
@@ -1,43 +1,64 @@
 /*
+ * 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"
 
 #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
-spi_object_hash (gconstpointer key)
+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
-spi_object_equal (gconstpointer a, gconstpointer b)
+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
-spi_object_release (gpointer  value)
+cspi_object_release (gpointer value)
 {
   Accessible *a = (Accessible *) value;
 
@@ -45,43 +66,74 @@ spi_object_release (gpointer  value)
   g_print ("releasing %p => %p\n", a, a->objref);
 #endif
 
-  bonobo_object_release_unref (a->objref, NULL);
+  if (!a->on_loan)
+    {
+      cspi_release_unref (a->objref);
+    }
 
   memset (a, 0xaa, sizeof (Accessible));
   a->ref_count = -1;
 
 #ifndef DEBUG_OBJECTS
-  g_free (a);
+  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 *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 (BONOBO_EX (cspi_ev ()))
+  if (ev._major != CORBA_NO_EXCEPTION)
     {
-      g_error ("Exception '%s' checking if is '%s'",
-              bonobo_exception_get_text (cspi_ev ()),
-              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;
-      bonobo_object_release_unref (unknown, NULL);
+      cspi_release_unref (unknown);
     }
   else
     {
@@ -92,28 +144,38 @@ cspi_accessible_is_a (Accessible *obj,
 }
 
 static GHashTable *
-get_live_refs (void)
+cspi_get_live_refs (void)
 {
   if (!live_refs) 
     {
-      live_refs = g_hash_table_new_full (spi_object_hash,
-                                        spi_object_equal,
+      live_refs = g_hash_table_new_full (cspi_object_hash,
+                                        cspi_object_equal,
                                         NULL,
-                                        spi_object_release);
+                                        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;
 }
 
@@ -122,7 +184,7 @@ cspi_exception (void)
 {
   SPIBoolean retval;
 
-  if (BONOBO_EX (&ev))
+  if (ev._major != CORBA_NO_EXCEPTION)
     {
       CORBA_exception_free (&ev);
       retval = TRUE;
@@ -135,8 +197,14 @@ cspi_exception (void)
   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;
 
@@ -144,39 +212,98 @@ cspi_object_add (CORBA_Object corba_object)
     {
       ref = NULL;
     }
-  else if (!cspi_check_ev ("pre method check"))
+  else if (!cspi_check_ev ("pre method check: add"))
     {
       ref = NULL;
     }
   else
     {
-      if ((ref = g_hash_table_lookup (get_live_refs (), corba_object)))
+      if ((ref = g_hash_table_lookup (cspi_get_live_refs (), corba_object)))
         {
           g_assert (ref->ref_count > 0);
          ref->ref_count++;
-          bonobo_object_release_unref (corba_object, NULL);
+         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 = g_new (Accessible, 1);
-
+         ref = malloc (sizeof (Accessible));
+         ref->objref = corba_object;
+         ref->ref_count = 1;
+         ref->on_loan = on_loan;
 #ifdef DEBUG_OBJECTS
-          g_print ("allocating %p => %p\n", ref, corba_object);
+          g_print ("allocated %p => %p\n", ref, corba_object);
 #endif
-
-          ref->objref = corba_object;
-          ref->ref_count = 1;
-
-          g_hash_table_insert (get_live_refs (), ref->objref, ref);
+          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)
+{
+  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;
+      accessible->objref = cspi_dup_ref (accessible->objref);
+      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)
 {
@@ -195,7 +322,7 @@ cspi_object_unref (Accessible *accessible)
 
   if (--accessible->ref_count == 0)
     {
-      g_hash_table_remove (get_live_refs (), accessible->objref);
+      g_hash_table_remove (cspi_get_live_refs (), accessible->objref);
     }
 }
 
@@ -204,6 +331,8 @@ cspi_cleanup (void)
 {
   GHashTable *refs;
 
+  cspi_streams_close_all ();
+
   refs = live_refs;
   live_refs = NULL;
   if (refs)
@@ -213,7 +342,7 @@ cspi_cleanup (void)
 
   if (registry != CORBA_OBJECT_NIL)
     {
-      bonobo_object_release_unref (registry, NULL);
+      cspi_release_unref (registry);
       registry = CORBA_OBJECT_NIL;
     }
 }
@@ -230,9 +359,6 @@ static gboolean SPI_inited = FALSE;
 int
 SPI_init (void)
 {
-  int argc = 0;
-  char *obj_id;
-
   if (SPI_inited)
     {
       return 1;
@@ -242,28 +368,7 @@ SPI_init (void)
 
   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 ());
-
-  if (ev._major != CORBA_NO_EXCEPTION)
-    {
-      g_error ("AT-SPI error: during registry activation: %s\n",
-              bonobo_exception_get_text (cspi_ev ()));
-    }
-
-  if (registry == CORBA_OBJECT_NIL)
-    {
-      g_error ("Could not locate registry");
-    }
-
-  bonobo_activate ();
+  registry = cspi_init ();
 
   g_atexit (cspi_cleanup);
   
@@ -282,7 +387,7 @@ SPI_init (void)
 void
 SPI_event_main (void)
 {
-  bonobo_main ();
+  cspi_main ();
 }
 
 /**
@@ -294,7 +399,7 @@ SPI_event_main (void)
 void
 SPI_event_quit (void)
 {
-  bonobo_main_quit ();
+  cspi_main_quit ();
 }
 
 /**
@@ -332,6 +437,31 @@ SPI_nextEvent (SPIBoolean waitForEvent)
   return NULL;
 }
 
+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);
+}
+
+
 /**
  * SPI_exit:
  *
@@ -355,6 +485,10 @@ SPI_exit (void)
   if (live_refs)
     {
       leaked = g_hash_table_size (live_refs);
+#define PRINT_LEAKS
+#ifdef PRINT_LEAKS
+      g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
+#endif
     }
   else
     {
@@ -374,3 +508,95 @@ SPI_exit (void)
 
   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);
+    }
+}
+
+/**
+ * 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;
+}