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