registryd/deviceeventcontroller.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /* deviceeventcontroler.c: implement the DeviceEventController interface */
  24
  25 #include <config.h>
  26
  27 #undef  SPI_DEBUG
  28 #define  SPI_KEYEVENT_DEBUG
  29
  30 #include <string.h>
  31 #include <ctype.h>
  32 #include <stdio.h>
  33 #include <bonobo/bonobo-exception.h>
  34
  35 #include <X11/Xlib.h>
  36 #include <X11/extensions/XTest.h>
  37 #define XK_MISCELLANY
  38 #include <X11/keysymdef.h>
  39 #include <gdk/gdk.h>
  40 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
  41 #include <gdk/gdkkeysyms.h>
  42 #include <gdk/gdkwindow.h>
  43
  44 #include "../libspi/spi-private.h"
  45 #include "deviceeventcontroller.h"
  46
  47 /* Our parent Gtk object type */
  48 #define PARENT_TYPE BONOBO_TYPE_OBJECT
  49
  50 /* A pointer to our parent object class */
  51 static GObjectClass *spi_device_event_controller_parent_class;
  52
  53 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
  54
  55 typedef enum {
  56   SPI_DEVICE_TYPE_KBD,
  57   SPI_DEVICE_TYPE_MOUSE,
  58   SPI_DEVICE_TYPE_LAST_DEFINED
  59 } SpiDeviceTypeCategory;
  60
  61 typedef struct {
  62   guint                             ref_count : 30;
  63   guint                             pending_add : 1;
  64   guint                             pending_remove : 1;
  65
  66   Accessibility_ControllerEventMask mod_mask;
  67   CORBA_unsigned_long               key_val;  /* KeyCode */
  68 } DEControllerGrabMask;
  69
  70 typedef struct {
  71   CORBA_Object          object;
  72   SpiDeviceTypeCategory type;
  73 } DEControllerListener;
  74
  75 typedef struct {
  76   DEControllerListener listener;
  77
  78   Accessibility_KeySet             *keys;
  79   Accessibility_ControllerEventMask mask;
  80   Accessibility_KeyEventTypeSeq    *typeseq;
  81   Accessibility_EventListenerMode  *mode;
  82 } DEControllerKeyListener;
  83
  84 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
  85 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
  86                                                                Accessibility_DeviceEvent *recv);
  87 static void     spi_controller_register_device_listener       (SpiDEController           *controller,
  88                                                                DEControllerListener      *l,
  89                                                                CORBA_Environment         *ev);
  90 static void     spi_device_event_controller_forward_key_event (SpiDEController           *controller,
  91                                                                const XEvent              *event);
  92
  93 #define spi_get_display() GDK_DISPLAY()
  94
  95 /* Private methods */
  96
  97 static KeyCode
  98 keycode_for_keysym (long keysym)
  99 {
 100   return XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 101 }
 102
 103 static DEControllerGrabMask *
 104 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
 105 {
 106   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
 107
 108   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
 109
 110   clone->ref_count = 1;
 111   clone->pending_add = TRUE;
 112   clone->pending_remove = FALSE;
 113
 114   return clone;
 115 }
 116
 117 static void
 118 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
 119 {
 120   g_free (grab_mask);
 121 }
 122
 123 static gint
 124 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
 125 {
 126   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
 127   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
 128
 129   if (p1 == p2)
 130     {
 131       return 0;
 132     }
 133   else
 134     {
 135       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
 136     }
 137 }
 138
 139 static DEControllerKeyListener *
 140 spi_dec_key_listener_new (CORBA_Object                            l,
 141                           const Accessibility_KeySet             *keys,
 142                           const Accessibility_ControllerEventMask mask,
 143                           const Accessibility_KeyEventTypeSeq    *typeseq,
 144                           const Accessibility_EventListenerMode  *mode,
 145                           CORBA_Environment                      *ev)
 146 {
 147   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
 148   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
 149   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
 150   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
 151   key_listener->mask = mask;
 152   key_listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_KeyEventTypeSeq);
 153   if (mode)
 154     key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
 155   else
 156     key_listener->mode = NULL;
 157
 158 #ifdef SPI_DEBUG
 159   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
 160            (unsigned int) key_listener->mask,
 161            (int) (mode ? mode->global : 0),
 162            (void *) key_listener->keys,
 163            (int) (key_listener->keys ? key_listener->keys->_length : 0));
 164 #endif
 165
 166   return key_listener;
 167 }
 168
 169 static void
 170 spi_dec_key_listener_free (DEControllerKeyListener *key_listener,
 171                            CORBA_Environment       *ev)
 172 {
 173   bonobo_object_release_unref (key_listener->listener.object, ev);
 174   CORBA_free (key_listener->typeseq);
 175   CORBA_free (key_listener->keys);
 176   g_free (key_listener);
 177 }
 178
 179 static void
 180 _register_keygrab (SpiDEController      *controller,
 181                    DEControllerGrabMask *grab_mask)
 182 {
 183   GList *l;
 184
 185   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 186                           spi_grab_mask_compare_values);
 187   if (l)
 188     {
 189       DEControllerGrabMask *cur_mask = l->data;
 190
 191       cur_mask->ref_count++;
 192       if (cur_mask->pending_remove)
 193         {
 194           cur_mask->pending_remove = FALSE;
 195         }
 196     }
 197   else
 198     {
 199       controller->keygrabs_list =
 200         g_list_prepend (controller->keygrabs_list,
 201                         spi_grab_mask_clone (grab_mask));
 202     }
 203 }
 204
 205 static void
 206 _deregister_keygrab (SpiDEController      *controller,
 207                      DEControllerGrabMask *grab_mask)
 208 {
 209   GList *l;
 210
 211   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 212                           spi_grab_mask_compare_values);
 213
 214   if (l)
 215     {
 216       DEControllerGrabMask *cur_mask = l->data;
 217
 218       cur_mask->ref_count--;
 219       if (cur_mask->ref_count <= 0)
 220         {
 221           cur_mask->pending_remove = TRUE;
 222         }
 223     }
 224   else
 225     {
 226       g_warning ("De-registering non-existant grab");
 227     }
 228 }
 229
 230 static void
 231 handle_keygrab (SpiDEController         *controller,
 232                 DEControllerKeyListener *key_listener,
 233                 void                   (*process_cb) (SpiDEController *controller,
 234                                                       DEControllerGrabMask *grab_mask))
 235 {
 236   DEControllerGrabMask grab_mask = { 0 };
 237
 238   grab_mask.mod_mask = key_listener->mask;
 239   if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
 240     {
 241       grab_mask.key_val = AnyKey;
 242       process_cb (controller, &grab_mask);
 243     }
 244   else
 245     {
 246       int i;
 247
 248       for (i = 0; i < key_listener->keys->_length; ++i)
 249         {
 250           Accessibility_KeyDefinition keydef = key_listener->keys->_buffer[i];
 251           long int key_val = keydef.keysym;
 252           /* X Grabs require keycodes, not keysyms */
 253           if (keydef.keystring)
 254             {
 255               key_val = XStringToKeysym(keydef.keystring);
 256             }
 257           if (key_val > 0)
 258             {
 259               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 260             }
 261           else
 262             {
 263               key_val = keydef.keycode;
 264             }
 265           grab_mask.key_val = key_val;
 266
 267           process_cb (controller, &grab_mask);
 268         }
 269     }
 270 }
 271
 272 static void
 273 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 274                                          DEControllerKeyListener *key_listener)
 275 {
 276   handle_keygrab (controller, key_listener, _register_keygrab);
 277   spi_controller_update_key_grabs (controller, NULL);
 278 }
 279
 280 static void
 281 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 282                                            DEControllerKeyListener *key_listener)
 283 {
 284   handle_keygrab (controller, key_listener, _deregister_keygrab);
 285   spi_controller_update_key_grabs (controller, NULL);
 286 }
 287
 288 static void
 289 spi_controller_register_device_listener (SpiDEController      *controller,
 290                                          DEControllerListener *listener,
 291                                          CORBA_Environment    *ev)
 292 {
 293   DEControllerKeyListener *key_listener;
 294
 295   switch (listener->type) {
 296   case SPI_DEVICE_TYPE_KBD:
 297       key_listener = (DEControllerKeyListener *) listener;
 298
 299       controller->key_listeners = g_list_prepend (controller->key_listeners,
 300                                                   key_listener);
 301       if (key_listener->mode->global)
 302         {
 303           spi_controller_register_global_keygrabs (controller, key_listener);
 304         }
 305       break;
 306     default:
 307       break;
 308   }
 309 }
 310
 311 static GdkFilterReturn
 312 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
 313 {
 314   XEvent *xevent = gdk_xevent;
 315   SpiDEController *controller;
 316
 317   if (xevent->type != KeyPress && xevent->type != KeyRelease)
 318     {
 319       return GDK_FILTER_CONTINUE;
 320     }
 321
 322   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
 323
 324   spi_device_event_controller_forward_key_event (controller, xevent);
 325
 326   /* FIXME: is this right ? */
 327   return GDK_FILTER_CONTINUE;
 328 }
 329
 330 int
 331 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
 332 {
 333   if (error->error_code == BadAccess)
 334     {
 335       g_message ("Could not complete key grab: grab already in use.\n");
 336       return 0;
 337     }
 338   else
 339     {
 340       return (*x_default_error_handler) (display, error);
 341     }
 342 }
 343
 344 static void
 345 spi_controller_register_with_devices (SpiDEController *controller)
 346 {
 347   /* calls to device-specific implementations and routines go here */
 348   /* register with: keyboard hardware code handler */
 349   /* register with: (translated) keystroke handler */
 350
 351   gdk_window_add_filter (NULL, global_filter_fn, controller);
 352
 353   gdk_window_set_events (gdk_get_default_root_window (),
 354                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
 355
 356   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
 357 }
 358
 359 static gboolean
 360 spi_key_set_contains_key (Accessibility_KeySet            *key_set,
 361                           const Accessibility_DeviceEvent *key_event)
 362 {
 363   gint i;
 364   gint len;
 365
 366   if (!key_set)
 367     {
 368       g_print ("null key set!");
 369       return TRUE;
 370     }
 371
 372   len = key_set->_length;
 373
 374   if (len == 0) /* special case, means "all keys/any key" */
 375     {
 376       g_print ("anykey\n");
 377       return TRUE;
 378     }
 379
 380   for (i = 0; i < len; ++i)
 381     {
 382 #ifdef SPI_KEYEVENT_DEBUG
 383       g_print ("key_set[%d] = %d; key_event %d, code %d\n",
 384                 i, (int) key_set->_buffer[i].keycode,
 385                (int) key_event->id, (int) key_event->hw_code);
 386 #endif
 387       if (key_set->_buffer[i].keysym == (CORBA_long) key_event->id)
 388         {
 389           return TRUE;
 390         }
 391       if (key_set->_buffer[i].keycode == (CORBA_long) key_event->hw_code)
 392         {
 393           return TRUE;
 394         }
 395       if (key_event->event_string && key_event->event_string[0] && !strcmp
 396           (key_set->_buffer[i].keystring, key_event->event_string))
 397         {
 398           return TRUE;
 399         }
 400     }
 401
 402   return FALSE;
 403 }
 404
 405 static gboolean
 406 spi_key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq   *type_seq,
 407                                       const Accessibility_DeviceEvent *key_event)
 408 {
 409   gint i;
 410   gint len;
 411
 412
 413   if (!type_seq)
 414     {
 415       g_print ("null type seq!");
 416       return TRUE;
 417     }
 418
 419   len = type_seq->_length;
 420
 421   if (len == 0) /* special case, means "all events/any event" */
 422     {
 423       return TRUE;
 424     }
 425
 426   for (i = 0; i < len; ++i)
 427     {
 428 #ifdef SPI_DEBUG
 429       g_print ("type_seq[%d] = %d; key event type = %d\n", i,
 430                (int) type_seq->_buffer[i], (int) key_event->type);
 431 #endif
 432       if (type_seq->_buffer[i] == (CORBA_long) key_event->type)
 433         {
 434           return TRUE;
 435         }
 436     }
 437
 438   return FALSE;
 439 }
 440
 441 static gboolean
 442 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
 443                                 DEControllerKeyListener         *listener,
 444                                 CORBA_boolean                    is_system_global)
 445 {
 446   if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFFFF)) &&
 447        spi_key_set_contains_key (listener->keys, key_event) &&
 448        spi_key_eventtype_seq_contains_event (listener->typeseq, key_event) &&
 449       (is_system_global == listener->mode->global))
 450     {
 451       return TRUE;
 452     }
 453   else
 454     {
 455       return FALSE;
 456     }
 457 }
 458
 459 static gboolean
 460 spi_notify_keylisteners (GList                          **key_listeners,
 461                          const Accessibility_DeviceEvent *key_event,
 462                          CORBA_boolean                    is_system_global,
 463                          CORBA_Environment               *ev)
 464 {
 465   GList   *l;
 466   GSList  *notify = NULL, *l2;
 467   gboolean is_consumed;
 468
 469   if (!key_listeners)
 470     {
 471       return FALSE;
 472     }
 473
 474   for (l = *key_listeners; l; l = l->next)
 475     {
 476        DEControllerKeyListener *key_listener = l->data;
 477
 478        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
 479          {
 480            Accessibility_DeviceEventListener ls = key_listener->listener.object;
 481
 482            if (ls != CORBA_OBJECT_NIL)
 483              {
 484                notify = g_slist_prepend (notify, CORBA_Object_duplicate (ls, ev));
 485              }
 486          }
 487     }
 488
 489 #ifdef SPI_KEYEVENT_DEBUG
 490   if (!notify)
 491     {
 492       g_print ("no match for event\n");
 493     }
 494 #endif
 495
 496   is_consumed = FALSE;
 497   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
 498     {
 499       Accessibility_DeviceEventListener ls = l2->data;
 500
 501       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
 502
 503       if (BONOBO_EX (ev))
 504         {
 505           is_consumed = FALSE;
 506           CORBA_exception_free (ev);
 507         }
 508
 509       CORBA_Object_release (ls, ev);
 510     }
 511
 512   for (; l2; l2 = l2->next)
 513     {
 514       CORBA_Object_release (l2->data, ev);
 515     }
 516
 517   g_slist_free (notify);
 518
 519 #ifdef SPI_DEBUG
 520   if (is_consumed) g_message ("consumed\n");
 521 #endif
 522   return is_consumed;
 523 }
 524
 525 static Accessibility_DeviceEvent
 526 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
 527 {
 528   Accessibility_DeviceEvent key_event;
 529   KeySym keysym;
 530   const int cbuf_bytes = 20;
 531   char cbuf [cbuf_bytes];
 532
 533   keysym = XLookupKeysym (x_key_event, 0);
 534   key_event.id = (CORBA_long)(keysym);
 535   key_event.hw_code = (CORBA_short) x_key_event->keycode;
 536   if (((XEvent *) x_key_event)->type == KeyPress)
 537     {
 538       key_event.type = Accessibility_KEY_PRESSED;
 539     }
 540   else
 541     {
 542       key_event.type = Accessibility_KEY_RELEASED;
 543     }
 544   key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
 545   key_event.is_text = CORBA_FALSE;
 546   switch (keysym)
 547     {
 548       case ' ':
 549         key_event.event_string = CORBA_string_dup ("space");
 550         break;
 551       case XK_Tab:
 552 #ifdef SPI_KEYEVENT_DEBUG
 553         fprintf(stderr, "Tab\n");
 554 #endif
 555         key_event.event_string = CORBA_string_dup ("Tab");
 556         break;
 557       case XK_BackSpace:
 558         key_event.event_string = CORBA_string_dup ("Backspace");
 559         break;
 560       case XK_Return:
 561         key_event.event_string = CORBA_string_dup ("Return");
 562         break;
 563       default:
 564         if (XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL) > 0)
 565           {
 566             key_event.event_string = CORBA_string_dup (cbuf);
 567             if (isgraph (keysym))
 568               {
 569                 key_event.is_text = CORBA_TRUE; /* FIXME: incorrect for some composed chars? */
 570               }
 571           }
 572         else
 573           {
 574             key_event.event_string = CORBA_string_dup ("");
 575           }
 576     }
 577
 578   key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
 579 #ifdef SPI_KEYEVENT_DEBUG
 580   fprintf (stderr,
 581      "Key %lu pressed (%c), modifiers %d\n",
 582      (unsigned long) keysym,
 583      keysym ? (int) keysym : '*',
 584      (int) x_key_event->state);
 585 #endif
 586 #ifdef SPI_DEBUG
 587   fprintf (stderr, "%s%c",
 588      (x_key_event->state & Mod1Mask)?"Alt-":"",
 589      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
 590      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
 591 #endif /* SPI_DEBUG */
 592   return key_event;
 593 }
 594
 595 static gboolean
 596 spi_controller_update_key_grabs (SpiDEController           *controller,
 597                                  Accessibility_DeviceEvent *recv)
 598 {
 599   GList *l, *next;
 600
 601   g_return_val_if_fail (controller != NULL, FALSE);
 602
 603   /*
 604    * masks known to work with default RH 7.1+:
 605    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
 606    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
 607    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
 608    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
 609    *
 610    * ControlMask grabs are broken, must be in use already
 611    */
 612   for (l = controller->keygrabs_list; l; l = next)
 613     {
 614       gboolean do_remove;
 615       gboolean re_issue_grab;
 616       DEControllerGrabMask *grab_mask = l->data;
 617
 618       next = l->next;
 619
 620       re_issue_grab = recv &&
 621 /*            (recv->type == Accessibility_KEY_RELEASED) && - (?) */
 622               (recv->modifiers & grab_mask->mod_mask) &&
 623               (grab_mask->key_val == keycode_for_keysym (recv->id));
 624
 625 #ifdef SPI_DEBUG
 626       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
 627                (long int) grab_mask->key_val,
 628                (long int) grab_mask->mod_mask,
 629                grab_mask->pending_add ? '+' : '.',
 630                grab_mask->pending_remove ? '-' : '.',
 631                re_issue_grab ? "re-issue": "");
 632 #endif
 633
 634       do_remove = FALSE;
 635
 636       if (grab_mask->pending_add && grab_mask->pending_remove)
 637         {
 638           do_remove = TRUE;
 639         }
 640       else if (grab_mask->pending_remove)
 641         {
 642 #ifdef SPI_DEBUG
 643       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
 644 #endif
 645           XUngrabKey (spi_get_display (),
 646                       grab_mask->key_val,
 647                       grab_mask->mod_mask,
 648                       gdk_x11_get_default_root_xwindow ());
 649
 650           do_remove = TRUE;
 651         }
 652       else if (grab_mask->pending_add || re_issue_grab)
 653         {
 654
 655 #ifdef SPI_DEBUG
 656           fprintf (stderr, "grab with mask %x\n", grab_mask->mod_mask);
 657 #endif
 658           XGrabKey (spi_get_display (),
 659                     grab_mask->key_val,
 660                     grab_mask->mod_mask,
 661                     gdk_x11_get_default_root_xwindow (),
 662                     True,
 663                     GrabModeAsync,
 664                     GrabModeAsync);
 665         }
 666
 667       grab_mask->pending_add = FALSE;
 668       grab_mask->pending_remove = FALSE;
 669
 670       if (do_remove)
 671         {
 672           g_assert (grab_mask->ref_count <= 0);
 673
 674           controller->keygrabs_list = g_list_delete_link (
 675             controller->keygrabs_list, l);
 676
 677           spi_grab_mask_free (grab_mask);
 678         }
 679
 680       /* TODO: check calls for errors and return FALSE if error occurs */
 681     }
 682
 683   return TRUE;
 684 }
 685
 686 /*
 687  * Implemented GObject::finalize
 688  */
 689 static void
 690 spi_device_event_controller_object_finalize (GObject *object)
 691 {
 692   SpiDEController *controller;
 693
 694   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
 695
 696 #ifdef SPI_DEBUG
 697   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
 698 #endif
 699   /* disconnect any special listeners, get rid of outstanding keygrabs */
 700   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
 701
 702   spi_device_event_controller_parent_class->finalize (object);
 703 }
 704
 705 /*
 706  * CORBA Accessibility::DEController::registerKeystrokeListener
 707  *     method implementation
 708  */
 709 static void
 710 impl_register_keystroke_listener (PortableServer_Servant                  servant,
 711                                   const Accessibility_DeviceEventListener l,
 712                                   const Accessibility_KeySet             *keys,
 713                                   const Accessibility_ControllerEventMask mask,
 714                                   const Accessibility_KeyEventTypeSeq    *type,
 715                                   const Accessibility_EventListenerMode  *mode,
 716                                   CORBA_Environment                      *ev)
 717 {
 718   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
 719           bonobo_object_from_servant (servant));
 720   DEControllerKeyListener *dec_listener;
 721 #ifdef SPI_DEBUG
 722   fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
 723            (void *) l, (unsigned long) mask);
 724 #endif
 725   dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
 726   spi_controller_register_device_listener (
 727     controller, (DEControllerListener *) dec_listener, ev);
 728 }
 729
 730
 731 typedef struct {
 732         CORBA_Environment       *ev;
 733         DEControllerKeyListener *key_listener;
 734 } RemoveKeyListenerClosure;
 735
 736 static SpiReEntrantContinue
 737 remove_key_listener_cb (GList * const *list,
 738                         gpointer       user_data)
 739 {
 740   DEControllerKeyListener  *key_listener = (*list)->data;
 741   RemoveKeyListenerClosure *ctx = user_data;
 742
 743   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
 744                                   key_listener->listener.object, ctx->ev))
 745     {
 746       spi_re_entrant_list_delete_link (list);
 747       spi_dec_key_listener_free (key_listener, ctx->ev);
 748     }
 749
 750   return SPI_RE_ENTRANT_CONTINUE;
 751 }
 752
 753 static SpiReEntrantContinue
 754 copy_key_listener_cb (GList * const *list,
 755                       gpointer       user_data)
 756 {
 757   DEControllerKeyListener  *key_listener = (*list)->data;
 758   RemoveKeyListenerClosure *ctx = user_data;
 759
 760   if (CORBA_Object_is_equivalent (ctx->key_listener->listener.object,
 761                                   key_listener->listener.object, ctx->ev))
 762     {
 763       /* TODO: FIXME aggregate keys in case the listener is registered twice */
 764       CORBA_free (ctx->key_listener->keys);
 765       ctx->key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
 766     }
 767
 768   return SPI_RE_ENTRANT_CONTINUE;
 769 }
 770
 771 /*
 772  * CORBA Accessibility::DEController::deregisterKeystrokeListener
 773  *     method implementation
 774  */
 775 static void
 776 impl_deregister_keystroke_listener (PortableServer_Servant                  servant,
 777                                     const Accessibility_DeviceEventListener l,
 778                                     const Accessibility_KeySet             *keys,
 779                                     const Accessibility_ControllerEventMask mask,
 780                                     const Accessibility_KeyEventTypeSeq    *type,
 781                                     CORBA_Environment                      *ev)
 782 {
 783   DEControllerKeyListener  *key_listener;
 784   RemoveKeyListenerClosure  ctx;
 785   SpiDEController *controller;
 786
 787   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
 788
 789   key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
 790
 791 #ifdef SPI_DEREGISTER_DEBUG
 792   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
 793            (void *) l, (unsigned long) mask->value);
 794 #endif
 795
 796   ctx.ev = ev;
 797   ctx.key_listener = key_listener;
 798
 799   /* special case, copy keyset from existing controller list entry */
 800   if (keys->_length == 0)
 801     {
 802       spi_re_entrant_list_foreach (&controller->key_listeners,
 803                                   copy_key_listener_cb, &ctx);
 804     }
 805
 806   spi_controller_deregister_global_keygrabs (controller, key_listener);
 807
 808   spi_re_entrant_list_foreach (&controller->key_listeners,
 809                                 remove_key_listener_cb, &ctx);
 810
 811   spi_dec_key_listener_free (key_listener, ev);
 812 }
 813
 814 /*
 815  * CORBA Accessibility::DEController::registerKeystrokeListener
 816  *     method implementation
 817  */
 818 static void
 819 impl_generate_keyboard_event (PortableServer_Servant           servant,
 820                               const CORBA_long                 keycode,
 821                               const CORBA_char                *keystring,
 822                               const Accessibility_KeySynthType synth_type,
 823                               CORBA_Environment               *ev)
 824 {
 825   long key_synth_code;
 826
 827 #ifdef SPI_DEBUG
 828   fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
 829            (long) keycode, (int) synth_type);
 830 #endif
 831   /* TODO: hide/wrap/remove X dependency */
 832
 833   /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
 834
 835   /*
 836    * TODO: when initializing, query for XTest extension before using,
 837    * and fall back to XSendEvent() if XTest is not available.
 838    */
 839
 840   /* TODO: implement keystring mode also */
 841   gdk_error_trap_push ();
 842
 843   switch (synth_type)
 844     {
 845       case Accessibility_KEY_PRESS:
 846         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
 847         break;
 848       case Accessibility_KEY_PRESSRELEASE:
 849         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
 850       case Accessibility_KEY_RELEASE:
 851         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, False, CurrentTime);
 852         break;
 853       case Accessibility_KEY_SYM:
 854         key_synth_code = keycode_for_keysym (keycode);
 855         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, True, CurrentTime);
 856         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, False, CurrentTime);
 857         break;
 858       case Accessibility_KEY_STRING:
 859         fprintf (stderr, "Not yet implemented\n");
 860         break;
 861     }
 862   if (gdk_error_trap_pop ())
 863     {
 864       g_warning ("Error emitting keystroke");
 865     }
 866 }
 867
 868 /* Accessibility::DEController::generateMouseEvent */
 869 static void
 870 impl_generate_mouse_event (PortableServer_Servant servant,
 871                            const CORBA_long       x,
 872                            const CORBA_long       y,
 873                            const CORBA_char      *eventName,
 874                            CORBA_Environment     *ev)
 875 {
 876   int button;
 877   gboolean error = FALSE;
 878   Display *display = spi_get_display ();
 879 #ifdef SPI_DEBUG
 880   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
 881            eventName, (long int) x, (long int) y);
 882 #endif
 883   g_message ("mouse event synthesis\n");
 884   switch (eventName[0])
 885     {
 886       case 'b':
 887         switch (eventName[1])
 888           {
 889           /* TODO: check number of buttons before parsing */
 890           case '1':
 891                     button = 1;
 892                     break;
 893           case '2':
 894                   button = 2;
 895                   break;
 896           case '3':
 897                   button = 3;
 898                   break;
 899           default:
 900                   error = TRUE;
 901           }
 902         if (!error)
 903           {
 904             if (x != -1 && y != -1)
 905               {
 906                 XTestFakeMotionEvent (display, DefaultScreen (display),
 907                                       x, y, 0);
 908               }
 909             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
 910             if (eventName[2] == 'c')
 911               XTestFakeButtonEvent (display, button, FALSE, 1);
 912             else if (eventName[2] == 'd')
 913               {
 914               XTestFakeButtonEvent (display, button, FALSE, 1);
 915               XTestFakeButtonEvent (display, button, TRUE, 2);
 916               XTestFakeButtonEvent (display, button, FALSE, 3);
 917               }
 918           }
 919         break;
 920       case 'r': /* relative motion */
 921         XTestFakeRelativeMotionEvent (display, x, y, 0);
 922         break;
 923       case 'a': /* absolute motion */
 924         XTestFakeMotionEvent (display, DefaultScreen (display),
 925                               x, y, 0);
 926         break;
 927     }
 928 }
 929
 930 /* Accessibility::DEController::notifyListenersSync */
 931 static CORBA_boolean
 932 impl_notify_listeners_sync (PortableServer_Servant           servant,
 933                             const Accessibility_DeviceEvent *event,
 934                             CORBA_Environment               *ev)
 935 {
 936   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
 937     bonobo_object_from_servant (servant));
 938 #ifdef SPI_DEBUG
 939   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
 940            controller, (int) event->id);
 941 #endif
 942   return spi_notify_keylisteners (&controller->key_listeners, event, CORBA_FALSE, ev) ?
 943           CORBA_TRUE : CORBA_FALSE;
 944 }
 945
 946 /* Accessibility::DEController::notifyListenersAsync */
 947 static void
 948 impl_notify_listeners_async (PortableServer_Servant           servant,
 949                              const Accessibility_DeviceEvent *event,
 950                              CORBA_Environment               *ev)
 951 {
 952   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
 953     bonobo_object_from_servant (servant));
 954 #ifdef SPI_DEBUG
 955   fprintf (stderr, "notifying listeners asynchronously\n");
 956 #endif
 957   spi_notify_keylisteners (&controller->key_listeners, event, CORBA_FALSE, ev);
 958 }
 959
 960 static void
 961 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
 962 {
 963   GObjectClass * object_class = (GObjectClass *) klass;
 964   POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
 965
 966   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
 967
 968   object_class->finalize = spi_device_event_controller_object_finalize;
 969
 970   epv->registerKeystrokeListener   = impl_register_keystroke_listener;
 971   epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
 972   epv->generateKeyboardEvent       = impl_generate_keyboard_event;
 973   epv->generateMouseEvent          = impl_generate_mouse_event;
 974   epv->notifyListenersSync         = impl_notify_listeners_sync;
 975   epv->notifyListenersAsync        = impl_notify_listeners_async;
 976 }
 977
 978 static void
 979 spi_device_event_controller_init (SpiDEController *device_event_controller)
 980 {
 981   device_event_controller->key_listeners   = NULL;
 982   device_event_controller->mouse_listeners = NULL;
 983   device_event_controller->keygrabs_list   = NULL;
 984
 985   /*
 986    * TODO: fixme, this module makes the foolish assumptions that
 987    * registryd uses the same display as the apps, and that the
 988    * DISPLAY environment variable is set.
 989    */
 990   gdk_init (NULL, NULL);
 991
 992   spi_controller_register_with_devices (device_event_controller);
 993 }
 994
 995 static void
 996 spi_device_event_controller_forward_key_event (SpiDEController *controller,
 997                                                const XEvent    *event)
 998 {
 999   gboolean is_consumed = FALSE;
1000   CORBA_Environment ev;
1001   Accessibility_DeviceEvent key_event;
1002
1003   g_assert (event->type == KeyPress || event->type == KeyRelease);
1004
1005   CORBA_exception_init (&ev);
1006
1007   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
1008
1009   spi_controller_update_key_grabs (controller, &key_event);
1010
1011   /* relay to listeners, and decide whether to consume it or not */
1012   is_consumed = spi_notify_keylisteners (
1013     &controller->key_listeners, &key_event, CORBA_TRUE, &ev);
1014
1015   CORBA_exception_free (&ev);
1016
1017   if (is_consumed)
1018     {
1019       XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
1020     }
1021   else
1022     {
1023       XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
1024     }
1025 }
1026
1027 SpiDEController *
1028 spi_device_event_controller_new (SpiRegistry *registry)
1029 {
1030   SpiDEController *retval = g_object_new (
1031     SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
1032
1033   retval->registry = SPI_REGISTRY (bonobo_object_ref (
1034           BONOBO_OBJECT (registry)));
1035
1036   return retval;
1037 }
1038
1039 BONOBO_TYPE_FUNC_FULL (SpiDEController,
1040                        Accessibility_DeviceEventController,
1041                        PARENT_TYPE,
1042                        spi_device_event_controller);