cspi/spi_main.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   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  *
  26  * Basic SPI initialization and event loop function prototypes
  27  *
  28  */
  29
  30 #include <stdio.h>
  31 #include <string.h>
  32 #include <stdlib.h>
  33 #include <cspi/spi-private.h>
  34 #include "spi.h"
  35
  36 #undef DEBUG_OBJECTS
  37
  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;
  42
  43 static guint
  44 cspi_object_hash (gconstpointer key)
  45 {
  46   CORBA_Object object = (CORBA_Object) key;
  47
  48   return CORBA_Object_hash (object, 0, &ev);
  49 }
  50
  51 static gboolean
  52 cspi_object_equal (gconstpointer a, gconstpointer b)
  53 {
  54   CORBA_Object objecta = (CORBA_Object) a;
  55   CORBA_Object objectb = (CORBA_Object) b;
  56
  57   return CORBA_Object_is_equivalent (objecta, objectb, cspi_ev ());
  58 }
  59
  60 static void
  61 cspi_object_release (gpointer value)
  62 {
  63   Accessible *a = (Accessible *) value;
  64
  65 #ifdef DEBUG_OBJECTS
  66   g_print ("releasing %p => %p\n", a, a->objref);
  67 #endif
  68
  69   if (!a->on_loan)
  70     {
  71       cspi_release_unref (a->objref);
  72     }
  73
  74   memset (a, 0xaa, sizeof (Accessible));
  75   a->ref_count = -1;
  76
  77 #ifndef DEBUG_OBJECTS
  78   free (a);
  79 #endif
  80 }
  81
  82 gboolean
  83 _cspi_exception_throw (CORBA_Environment *ev, char *desc_prefix)
  84 {
  85   SPIExceptionHandler *handler = NULL;
  86   SPIException ex;
  87   if (exception_handlers) handler = g_queue_peek_head (exception_handlers);
  88
  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);
  92   switch (ev->_major) {
  93   case CORBA_SYSTEM_EXCEPTION:
  94     ex.code = SPI_EXCEPTION_UNSPECIFIED;
  95     break;
  96   case CORBA_USER_EXCEPTION: /* help! how to interpret this? */
  97     ex.code = SPI_EXCEPTION_UNSPECIFIED;
  98     break;
  99   default:
 100     ex.code = SPI_EXCEPTION_UNSPECIFIED;
 101     break;
 102   }
 103
 104   if (handler)
 105     return (*handler) (&ex, FALSE);
 106   else
 107     return FALSE; /* means exception was not handled */
 108 }
 109
 110 SPIBoolean
 111 cspi_accessible_is_a (Accessible *accessible,
 112                       const char *interface_name)
 113 {
 114   SPIBoolean        retval;
 115   Bonobo_Unknown unknown;
 116
 117   if (accessible == NULL)
 118     {
 119       return FALSE;
 120     }
 121
 122   unknown = Bonobo_Unknown_queryInterface (CSPI_OBJREF (accessible),
 123                                            interface_name, cspi_ev ());
 124
 125   if (ev._major != CORBA_NO_EXCEPTION)
 126     {
 127       g_warning ("Exception '%s' checking if is '%s'",
 128                  cspi_exception_get_text (),
 129                  interface_name);
 130       retval = FALSE;
 131     }
 132
 133   else if (unknown != CORBA_OBJECT_NIL)
 134     {
 135       retval = TRUE;
 136       cspi_release_unref (unknown);
 137     }
 138   else
 139     {
 140       retval = FALSE;
 141     }
 142
 143   return retval;
 144 }
 145
 146 static GHashTable *
 147 cspi_get_live_refs (void)
 148 {
 149   if (!live_refs)
 150     {
 151       live_refs = g_hash_table_new_full (cspi_object_hash,
 152                                          cspi_object_equal,
 153                                          NULL,
 154                                          cspi_object_release);
 155     }
 156   return live_refs;
 157 }
 158
 159 CORBA_Environment *
 160 cspi_peek_ev (void)
 161 {
 162   return &ev;
 163 }
 164
 165 CORBA_Environment *
 166 cspi_ev (void)
 167 {
 168   CORBA_exception_init (&ev);
 169   return &ev;
 170 }
 171
 172 Accessibility_Registry
 173 cspi_registry (void)
 174 {
 175   if (!cspi_ping (registry))
 176     {
 177       registry = cspi_init ();
 178     }
 179   return registry;
 180 }
 181
 182 SPIBoolean
 183 cspi_exception (void)
 184 {
 185   SPIBoolean retval;
 186
 187   if (ev._major != CORBA_NO_EXCEPTION)
 188     {
 189       CORBA_exception_free (&ev);
 190       retval = TRUE;
 191     }
 192   else
 193     {
 194       retval = FALSE;
 195     }
 196
 197   return retval;
 198 }
 199
 200 /*
 201  *   This method swallows the corba_object BonoboUnknown
 202  * reference, and returns an Accessible associated with it.
 203  * If the reference is loaned, it means it is only valid
 204  * between a borrow / return pair.
 205  */
 206 static Accessible *
 207 cspi_object_get_ref (CORBA_Object corba_object, gboolean on_loan)
 208 {
 209   Accessible *ref;
 210
 211   if (corba_object == CORBA_OBJECT_NIL)
 212     {
 213       ref = NULL;
 214     }
 215   else if (!cspi_check_ev ("pre method check: add"))
 216     {
 217       ref = NULL;
 218     }
 219   else
 220     {
 221       if ((ref = g_hash_table_lookup (cspi_get_live_refs (), corba_object)))
 222         {
 223           g_assert (ref->ref_count > 0);
 224           ref->ref_count++;
 225           if (!on_loan)
 226             {
 227               if (ref->on_loan) /* Convert to a permanant ref */
 228                 {
 229                   ref->on_loan = FALSE;
 230                 }
 231               else
 232                 {
 233                   cspi_release_unref (corba_object);
 234                 }
 235             }
 236 #ifdef DEBUG_OBJECTS
 237           g_print ("returning cached %p => %p\n", ref, ref->objref);
 238 #endif
 239         }
 240       else
 241         {
 242           ref = malloc (sizeof (Accessible));
 243           ref->objref = corba_object;
 244           ref->ref_count = 1;
 245           ref->on_loan = on_loan;
 246 #ifdef DEBUG_OBJECTS
 247           g_print ("allocated %p => %p\n", ref, corba_object);
 248 #endif
 249           g_hash_table_insert (cspi_get_live_refs (), ref->objref, ref);
 250         }
 251     }
 252
 253   return ref;
 254 }
 255
 256 Accessible *
 257 cspi_object_add (CORBA_Object corba_object)
 258 {
 259   return cspi_object_get_ref (corba_object, FALSE);
 260 }
 261
 262 Accessible *
 263 cspi_object_borrow (CORBA_Object corba_object)
 264 {
 265   return cspi_object_get_ref (corba_object, TRUE);
 266 }
 267
 268 void
 269 cspi_object_return (Accessible *accessible)
 270 {
 271   g_return_if_fail (accessible != NULL);
 272
 273   if (!accessible->on_loan ||
 274       accessible->ref_count == 1)
 275     {
 276       cspi_object_unref (accessible);
 277     }
 278   else /* Convert to a permanant ref */
 279     {
 280       accessible->on_loan = FALSE;
 281       accessible->objref = cspi_dup_ref (accessible->objref);
 282       accessible->ref_count--;
 283     }
 284 }
 285
 286 Accessible *
 287 cspi_object_take (CORBA_Object corba_object)
 288 {
 289   Accessible *accessible;
 290   accessible = cspi_object_borrow (corba_object);
 291
 292   cspi_object_ref (accessible);
 293   /*
 294    * if the remote object is dead,
 295    * cspi_object_return will throw an exception.
 296    * FIXME: what clears that exception context ever ?
 297    */
 298   cspi_object_return (accessible);
 299   if (cspi_exception ())
 300     {
 301       cspi_object_unref (accessible);
 302       accessible = NULL;
 303     }
 304   return accessible;
 305 }
 306
 307 void
 308 cspi_object_ref (Accessible *accessible)
 309 {
 310   g_return_if_fail (accessible != NULL);
 311
 312   accessible->ref_count++;
 313 }
 314
 315 void
 316 cspi_object_unref (Accessible *accessible)
 317 {
 318   if (accessible == NULL)
 319     {
 320       return;
 321     }
 322
 323   if (--accessible->ref_count == 0)
 324     {
 325       g_hash_table_remove (cspi_get_live_refs (), accessible->objref);
 326     }
 327 }
 328
 329 static void
 330 cspi_cleanup (void)
 331 {
 332   GHashTable *refs;
 333
 334   cspi_streams_close_all ();
 335
 336   refs = live_refs;
 337   live_refs = NULL;
 338   if (refs)
 339     {
 340       g_hash_table_destroy (refs);
 341     }
 342
 343   if (registry != CORBA_OBJECT_NIL)
 344     {
 345       cspi_release_unref (registry);
 346       registry = CORBA_OBJECT_NIL;
 347     }
 348 }
 349
 350 static gboolean SPI_inited = FALSE;
 351
 352 /**
 353  * SPI_init:
 354  *
 355  * Connects to the accessibility registry and initializes the SPI.
 356  *
 357  * Returns: 0 on success, otherwise an integer error code.
 358  **/
 359 int
 360 SPI_init (void)
 361 {
 362   if (SPI_inited)
 363     {
 364       return 1;
 365     }
 366
 367   SPI_inited = TRUE;
 368
 369   CORBA_exception_init (&ev);
 370
 371   registry = cspi_init ();
 372
 373   g_atexit (cspi_cleanup);
 374
 375   return 0;
 376 }
 377
 378 /**
 379  * SPI_event_main:
 380  *
 381  * Starts/enters the main event loop for the SPI services.
 382  *
 383  * (NOTE: This method does not return control, it is exited via a call to
 384  *  SPI_event_quit () from within an event handler).
 385  *
 386  **/
 387 void
 388 SPI_event_main (void)
 389 {
 390   cspi_main ();
 391 }
 392
 393 /**
 394  * SPI_event_quit:
 395  *
 396  * Quits the last main event loop for the SPI services,
 397  * see SPI_event_main
 398  **/
 399 void
 400 SPI_event_quit (void)
 401 {
 402   cspi_main_quit ();
 403 }
 404
 405 /**
 406  * SPI_eventIsReady:
 407  *
 408  * Checks to see if an SPI event is waiting in the event queue.
 409  * Used by clients that don't wish to use SPI_event_main().
 410  *
 411  * Not Yet Implemented.
 412  *
 413  * Returns: #TRUE if an event is waiting, otherwise #FALSE.
 414  *
 415  **/
 416 SPIBoolean
 417 SPI_eventIsReady ()
 418 {
 419   return FALSE;
 420 }
 421
 422 /**
 423  * SPI_nextEvent:
 424  * @waitForEvent: a #SPIBoolean indicating whether to block or not.
 425  *
 426  * Gets the next event in the SPI event queue; blocks if no event
 427  * is pending and @waitForEvent is #TRUE.
 428  * Used by clients that don't wish to use SPI_event_main().
 429  *
 430  * Not Yet Implemented.
 431  *
 432  * Returns: the next #AccessibleEvent in the SPI event queue.
 433  **/
 434 AccessibleEvent *
 435 SPI_nextEvent (SPIBoolean waitForEvent)
 436 {
 437   return NULL;
 438 }
 439
 440 static void
 441 report_leaked_ref (gpointer key, gpointer val, gpointer user_data)
 442 {
 443   char *name, *role;
 444   Accessible *a = (Accessible *) val;
 445
 446   name = Accessible_getName (a);
 447   if (cspi_exception ())
 448     {
 449       name = NULL;
 450     }
 451
 452   role = Accessible_getRoleName (a);
 453   if (cspi_exception ())
 454     {
 455       role = NULL;
 456     }
 457
 458   fprintf (stderr, "leaked %d references to object %s, role %s %p\n",
 459            a->ref_count, name ? name : "<?>", role ? role : "<?>", a);
 460
 461   SPI_freeString (name);
 462 }
 463
 464
 465 /**
 466  * SPI_exit:
 467  *
 468  * Disconnects from the Accessibility Registry and releases
 469  * any floating resources. Call only once at exit.
 470  *
 471  * Returns: 0 if there were no leaks, otherwise non zero.
 472  **/
 473 int
 474 SPI_exit (void)
 475 {
 476   int leaked;
 477
 478   if (!SPI_inited)
 479     {
 480       return 0;
 481     }
 482
 483   SPI_inited = FALSE;
 484
 485   if (live_refs)
 486     {
 487       leaked = g_hash_table_size (live_refs);
 488 #define PRINT_LEAKS
 489 #ifdef PRINT_LEAKS
 490       g_hash_table_foreach (live_refs, report_leaked_ref, NULL);
 491 #endif
 492     }
 493   else
 494     {
 495       leaked = 0;
 496     }
 497
 498 #ifdef DEBUG_OBJECTS
 499   if (leaked)
 500     {
 501       fprintf (stderr, "Leaked %d SPI handles\n", leaked);
 502     }
 503 #endif
 504
 505   cspi_cleanup ();
 506
 507   fprintf (stderr, "bye-bye!\n");
 508
 509   return leaked;
 510 }
 511
 512 /**
 513  * SPI_freeString:
 514  * @s: a character string returned from another at-spi call.
 515  *
 516  * Free a character string returned from an at-spi call.  Clients of
 517  * at-spi should use this function instead of free () or g_free().
 518  * A NULL string @s will be silently ignored.
 519  * This API should not be used to free strings
 520  * from other libraries or allocated by the client.
 521  **/
 522 void
 523 SPI_freeString (char *s)
 524 {
 525   if (s)
 526     {
 527       CORBA_free (s);
 528     }
 529 }
 530
 531 /**
 532  * DOCUMENT_ME!
 533  **/
 534 char *
 535 SPI_dupString (char *s)
 536 {
 537   if (s)
 538     {
 539       return CORBA_string_dup (s);
 540     }
 541   else
 542     return NULL;
 543 }
 544
 545 /**
 546  * DOCUMENT_ME!
 547  **/
 548 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler)
 549 {
 550   if (!exception_handlers)
 551     exception_handlers = g_queue_new ();
 552   g_queue_push_head (exception_handlers, handler);
 553   return TRUE;
 554 }
 555
 556 /**
 557  * DOCUMENT_ME!
 558  **/
 559 SPIExceptionHandler* SPI_exceptionHandlerPop (void)
 560 {
 561   return (SPIExceptionHandler *) g_queue_pop_head (exception_handlers);
 562 }
 563
 564 /**
 565  * DOCUMENT_ME!
 566  **/
 567 SPIExceptionType SPIException_getSourceType (SPIException *err)
 568 {
 569   if (err)
 570     return err->type;
 571   else
 572     return SPI_EXCEPTION_SOURCE_UNSPECIFIED;
 573 }
 574
 575 /**
 576  * DOCUMENT_ME!
 577  **/
 578 SPIExceptionCode SPIException_getExceptionCode (SPIException *err)
 579 {
 580   return err->code;
 581 }
 582
 583 /**
 584  * DOCUMENT_ME!
 585  **/
 586 Accessible* SPIAccessibleException_getSource (SPIException *err)
 587 {
 588   if (err->type == SPI_EXCEPTION_SOURCE_ACCESSIBLE)
 589     return cspi_object_get_ref (err->source, FALSE);
 590   return NULL;
 591 }
 592
 593 /**
 594  * DOCUMENT_ME!
 595  **/
 596 char* SPIException_getDescription (SPIException *err)
 597 {
 598   /* TODO: friendlier error messages? */
 599   if (err->ev)
 600     return CORBA_exception_id (err->ev);
 601   return NULL;
 602 }