registryd/deviceeventcontroller.c

   1 /* AT-SPI - Assistive Technology Service Provider Interface
   2  *
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2003 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 /* deviceeventcontroller.c: implement the DeviceEventController interface */
  25
  26 #include <config.h>
  27
  28 #undef  SPI_XKB_DEBUG
  29 #undef  SPI_DEBUG
  30 #undef  SPI_KEYEVENT_DEBUG
  31
  32 #include <string.h>
  33 #include <ctype.h>
  34 #include <stdio.h>
  35 #include <sys/time.h>
  36 #include <bonobo/bonobo-exception.h>
  37
  38 #include <X11/Xlib.h>
  39 #include <X11/extensions/XTest.h>
  40 #include <X11/XKBlib.h>
  41 #define XK_MISCELLANY
  42 #include <X11/keysymdef.h>
  43
  44 #ifdef HAVE_XEVIE
  45 #include <X11/Xproto.h>
  46 #include <X11/X.h>
  47 #include <X11/extensions/Xevie.h>
  48 #endif /* HAVE_XEVIE */
  49
  50 #include <gdk/gdk.h>
  51 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
  52 #include <gdk/gdkkeysyms.h>
  53 #include <gdk/gdkwindow.h>
  54
  55 #include "../libspi/spi-private.h"
  56 #include "deviceeventcontroller.h"
  57
  58 KeySym ucs2keysym (long ucs);
  59
  60 #define CHECK_RELEASE_DELAY 20
  61 #define BIT(c, x)       (c[x/8]&(1<<(x%8)))
  62 static guint check_release_handler = 0;
  63 static Accessibility_DeviceEvent pressed_event;
  64 static SpiDEController *saved_controller;
  65 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
  66
  67 /* Our parent Gtk object type */
  68 #define PARENT_TYPE BONOBO_TYPE_OBJECT
  69
  70 /* A pointer to our parent object class */
  71 static GObjectClass *spi_device_event_controller_parent_class;
  72 static int spi_error_code = 0;
  73 static GdkPoint last_mouse_pos_static = {0, 0};
  74 static GdkPoint *last_mouse_pos = &last_mouse_pos_static;
  75 static unsigned int mouse_mask_state = 0;
  76 static unsigned int mouse_button_mask =
  77   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
  78 static unsigned int key_modifier_mask =
  79   Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
  80 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
  81
  82 static GQuark spi_dec_private_quark = 0;
  83
  84 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
  85
  86 typedef enum {
  87   SPI_DEVICE_TYPE_KBD,
  88   SPI_DEVICE_TYPE_MOUSE,
  89   SPI_DEVICE_TYPE_LAST_DEFINED
  90 } SpiDeviceTypeCategory;
  91
  92 typedef struct {
  93   guint                             ref_count : 30;
  94   guint                             pending_add : 1;
  95   guint                             pending_remove : 1;
  96
  97   Accessibility_ControllerEventMask mod_mask;
  98   CORBA_unsigned_long               key_val;  /* KeyCode */
  99 } DEControllerGrabMask;
 100
 101 typedef struct {
 102   CORBA_Object          object;
 103   SpiDeviceTypeCategory type;
 104   Accessibility_EventTypeSeq    *typeseq;
 105 } DEControllerListener;
 106
 107 typedef struct {
 108   DEControllerListener listener;
 109
 110   Accessibility_KeySet             *keys;
 111   Accessibility_ControllerEventMask mask;
 112   Accessibility_EventListenerMode  *mode;
 113 } DEControllerKeyListener;
 114
 115 typedef struct {
 116   unsigned int last_press_keycode;
 117   unsigned int last_release_keycode;
 118   struct timeval last_press_time;
 119   struct timeval last_release_time;
 120   int have_xkb;
 121   int xkb_major_extension_opcode;
 122   int xkb_base_event_code;
 123   int xkb_base_error_code;
 124   unsigned int xkb_latch_mask;
 125   unsigned int pending_xkb_mod_relatch_mask;
 126   XkbDescPtr xkb_desc;
 127 } DEControllerPrivateData;
 128
 129 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
 130 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
 131                                                                Accessibility_DeviceEvent *recv);
 132 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
 133                                                                DEControllerListener      *l,
 134                                                                CORBA_Environment         *ev);
 135 static gboolean spi_device_event_controller_forward_key_event (SpiDEController           *controller,
 136                                                                const XEvent              *event);
 137 static void     spi_deregister_controller_device_listener (SpiDEController            *controller,
 138                                                            DEControllerListener *listener,
 139                                                            CORBA_Environment          *ev);
 140 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
 141                                                         DEControllerKeyListener *key_listener,
 142                                                         CORBA_Environment       *ev);
 143 static gboolean spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 144                                                       const Accessibility_DeviceEvent *event,
 145                                                       CORBA_Environment               *ev);
 146
 147 static gboolean spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq      *type_seq,
 148                                                   const Accessibility_DeviceEvent *event);
 149 static gboolean spi_clear_error_state (void);
 150 static gboolean spi_dec_poll_mouse_moved (gpointer data);
 151 static gboolean spi_dec_poll_mouse_moving (gpointer data);
 152 static gboolean spi_dec_poll_mouse_idle (gpointer data);
 153
 154 #define spi_get_display() GDK_DISPLAY()
 155
 156 /* Private methods */
 157
 158 static unsigned int
 159 keysym_mod_mask (KeySym keysym, KeyCode keycode)
 160 {
 161         /* we really should use XKB and look directly at the keymap */
 162         /* this is very inelegant */
 163         Display *display = spi_get_display ();
 164         unsigned int mods_rtn = 0;
 165         unsigned int retval = 0;
 166         KeySym sym_rtn;
 167
 168         if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
 169             (sym_rtn == keysym)) {
 170                 retval = 0;
 171         }
 172         else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
 173                  (sym_rtn == keysym)) {
 174                 retval = ShiftMask;
 175         }
 176         else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
 177                  (sym_rtn == keysym)) {
 178                 retval = Mod2Mask;
 179         }
 180         else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
 181                  (sym_rtn == keysym)) {
 182                 retval = Mod3Mask;
 183         }
 184         else if (XkbLookupKeySym (display, keycode,
 185                                   ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
 186                  (sym_rtn == keysym)) {
 187                 retval = (Mod2Mask | ShiftMask);
 188         }
 189         else if (XkbLookupKeySym (display, keycode,
 190                                   ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
 191                  (sym_rtn == keysym)) {
 192                 retval = (Mod3Mask | ShiftMask);
 193         }
 194         else if (XkbLookupKeySym (display, keycode,
 195                                   ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
 196                  (sym_rtn == keysym)) {
 197                 retval = (Mod4Mask | ShiftMask);
 198         }
 199         else
 200                 retval = 0xFFFF;
 201         return retval;
 202 }
 203
 204 static KeyCode
 205 keycode_for_keysym (long keysym, unsigned int *modmask)
 206 {
 207         KeyCode keycode = 0;
 208         keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 209         if (modmask)
 210                 *modmask = keysym_mod_mask (keysym, keycode);
 211         return keycode;
 212 }
 213
 214 static DEControllerGrabMask *
 215 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
 216 {
 217   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
 218
 219   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
 220
 221   clone->ref_count = 1;
 222   clone->pending_add = TRUE;
 223   clone->pending_remove = FALSE;
 224
 225   return clone;
 226 }
 227
 228 static void
 229 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
 230 {
 231   g_free (grab_mask);
 232 }
 233
 234 static gint
 235 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
 236 {
 237   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
 238   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
 239
 240   if (p1 == p2)
 241     {
 242       return 0;
 243     }
 244   else
 245     {
 246       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
 247     }
 248 }
 249
 250 static void
 251 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
 252 {
 253   DEControllerPrivateData *priv =
 254     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 255 #ifdef SPI_XKB_DEBUG
 256   if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
 257                                      priv->xkb_latch_mask);
 258 #endif
 259   priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
 260 }
 261
 262 static void
 263 spi_dec_clear_unlatch_pending (SpiDEController *controller)
 264 {
 265   DEControllerPrivateData *priv =
 266     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 267   priv->xkb_latch_mask = 0;
 268 }
 269
 270 static gboolean
 271 spi_dec_button_update_and_emit (SpiDEController *controller,
 272                                 guint mask_return)
 273 {
 274   CORBA_Environment ev;
 275   Accessibility_Event e;
 276   Accessibility_DeviceEvent mouse_e;
 277   gchar event_name[24];
 278   gboolean is_consumed = FALSE;
 279
 280   if ((mask_return & mouse_button_mask) !=
 281       (mouse_mask_state & mouse_button_mask))
 282     {
 283       int button_number = 0;
 284       gboolean is_down = False;
 285
 286       if (!(mask_return & Button1Mask) &&
 287           (mouse_mask_state & Button1Mask))
 288         {
 289           mouse_mask_state &= ~Button1Mask;
 290           button_number = 1;
 291         }
 292       else if ((mask_return & Button1Mask) &&
 293                !(mouse_mask_state & Button1Mask))
 294         {
 295           mouse_mask_state |= Button1Mask;
 296           button_number = 1;
 297           is_down = True;
 298         }
 299       else if (!(mask_return & Button2Mask) &&
 300                (mouse_mask_state & Button2Mask))
 301         {
 302           mouse_mask_state &= ~Button2Mask;
 303           button_number = 2;
 304         }
 305       else if ((mask_return & Button2Mask) &&
 306                !(mouse_mask_state & Button2Mask))
 307         {
 308           mouse_mask_state |= Button2Mask;
 309           button_number = 2;
 310           is_down = True;
 311         }
 312       else if (!(mask_return & Button3Mask) &&
 313                (mouse_mask_state & Button3Mask))
 314         {
 315           mouse_mask_state &= ~Button3Mask;
 316           button_number = 3;
 317         }
 318       else if ((mask_return & Button3Mask) &&
 319                !(mouse_mask_state & Button3Mask))
 320         {
 321           mouse_mask_state |= Button3Mask;
 322           button_number = 3;
 323           is_down = True;
 324         }
 325       else if (!(mask_return & Button4Mask) &&
 326                (mouse_mask_state & Button4Mask))
 327         {
 328           mouse_mask_state &= ~Button4Mask;
 329           button_number = 4;
 330         }
 331       else if ((mask_return & Button4Mask) &&
 332                !(mouse_mask_state & Button4Mask))
 333         {
 334           mouse_mask_state |= Button4Mask;
 335           button_number = 4;
 336           is_down = True;
 337         }
 338       else if (!(mask_return & Button5Mask) &&
 339                (mouse_mask_state & Button5Mask))
 340         {
 341           mouse_mask_state &= ~Button5Mask;
 342           button_number = 5;
 343         }
 344       else if ((mask_return & Button5Mask) &&
 345                !(mouse_mask_state & Button5Mask))
 346         {
 347           mouse_mask_state |= Button5Mask;
 348           button_number = 5;
 349           is_down = True;
 350         }
 351       if (button_number) {
 352 #ifdef SPI_DEBUG
 353         fprintf (stderr, "Button %d %s\n",
 354                  button_number, (is_down) ? "Pressed" : "Released");
 355 #endif
 356         snprintf (event_name, 22, "mouse:button:%d%c", button_number,
 357                   (is_down) ? 'p' : 'r');
 358         /* TODO: FIXME distinguish between physical and
 359          * logical buttons
 360          */
 361         mouse_e.type      = (is_down) ?
 362           Accessibility_BUTTON_PRESSED_EVENT :
 363           Accessibility_BUTTON_RELEASED_EVENT;
 364         mouse_e.id        = button_number;
 365         mouse_e.hw_code   = button_number;
 366         mouse_e.modifiers = (CORBA_unsigned_short) mouse_mask_state;
 367         mouse_e.timestamp = 0;
 368         mouse_e.event_string = "";
 369         mouse_e.is_text   = CORBA_FALSE;
 370         is_consumed =
 371           spi_controller_notify_mouselisteners (controller,
 372                                                 &mouse_e,
 373                                                 &ev);
 374         e.type = event_name;
 375         e.source = BONOBO_OBJREF (controller->registry->desktop);
 376         e.detail1 = last_mouse_pos->x;
 377         e.detail2 = last_mouse_pos->y;
 378         spi_init_any_nil (&e.any_data);
 379         CORBA_exception_init (&ev);
 380         if (!is_consumed)
 381           {
 382             Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 383                                                 &e,
 384                                                 &ev);
 385           }
 386         else
 387           spi_dec_set_unlatch_pending (controller, mask_return);
 388       }
 389       return TRUE;
 390     }
 391   else
 392     {
 393       return FALSE;
 394     }
 395 }
 396
 397
 398 static guint
 399 spi_dec_mouse_check (SpiDEController *controller,
 400                      int *x, int *y, gboolean *moved)
 401 {
 402   Accessibility_Event e;
 403   CORBA_Environment ev;
 404   int win_x_return,win_y_return;
 405   unsigned int mask_return;
 406   Window root_return, child_return;
 407   Display *display = spi_get_display ();
 408
 409   if (display != NULL)
 410     XQueryPointer(display, DefaultRootWindow (display),
 411                   &root_return, &child_return,
 412                   x, y,
 413                   &win_x_return, &win_y_return, &mask_return);
 414   /*
 415    * Since many clients grab the pointer, and X goes an automatic
 416    * pointer grab on mouse-down, we often must detect mouse button events
 417    * by polling rather than via a button grab.
 418    * The while loop (rather than if) is used since it's possible that
 419    * multiple buttons have changed state since we last checked.
 420    */
 421   if (mask_return != mouse_mask_state)
 422     {
 423       while (spi_dec_button_update_and_emit (controller, mask_return));
 424     }
 425
 426   if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
 427     {
 428       e.type = "mouse:abs";
 429       e.source = BONOBO_OBJREF (controller->registry->desktop);
 430       e.detail1 = *x;
 431       e.detail2 = *y;
 432       spi_init_any_nil (&e.any_data);
 433       CORBA_exception_init (&ev);
 434       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 435                                           &e,
 436                                           &ev);
 437       e.type = "mouse:rel";
 438       e.source = BONOBO_OBJREF (controller->registry->desktop);
 439       e.detail1 = *x - last_mouse_pos->x;
 440       e.detail2 = *y - last_mouse_pos->y;
 441       spi_init_any_nil (&e.any_data);
 442       CORBA_exception_init (&ev);
 443       last_mouse_pos->x = *x;
 444       last_mouse_pos->y = *y;
 445       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 446                                           &e,
 447                                           &ev);
 448       *moved = True;
 449     }
 450   else
 451     {
 452       *moved = False;
 453     }
 454
 455   return mask_return;
 456 }
 457
 458 static void
 459 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
 460                              guint current_mask)
 461 {
 462   Accessibility_Event e;
 463   CORBA_Environment ev;
 464
 465 #ifdef SPI_XKB_DEBUG
 466   fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
 467            prev_mask, current_mask);
 468 #endif
 469
 470   /* set bits for the virtual modifiers like NUMLOCK */
 471   if (prev_mask & _numlock_physical_mask)
 472     prev_mask |= SPI_KEYMASK_NUMLOCK;
 473   if (current_mask & _numlock_physical_mask)
 474     current_mask |= SPI_KEYMASK_NUMLOCK;
 475
 476   e.type = "keyboard:modifiers";
 477   e.source = BONOBO_OBJREF (controller->registry->desktop);
 478   e.detail1 = prev_mask & key_modifier_mask;
 479   e.detail2 = current_mask & key_modifier_mask;
 480   spi_init_any_nil (&e.any_data);
 481   CORBA_exception_init (&ev);
 482   Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 483                                       &e,
 484                                       &ev);
 485 }
 486
 487 static gboolean
 488 spi_dec_poll_mouse_moved (gpointer data)
 489 {
 490   SpiRegistry *registry = SPI_REGISTRY (data);
 491   SpiDEController *controller = registry->de_controller;
 492   int x, y;
 493   gboolean moved;
 494   guint mask_return;
 495
 496   mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
 497
 498   if ((mask_return & key_modifier_mask) !=
 499       (mouse_mask_state & key_modifier_mask))
 500     {
 501       spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
 502       mouse_mask_state = mask_return;
 503     }
 504
 505   return moved;
 506 }
 507
 508 static gboolean
 509 spi_dec_poll_mouse_idle (gpointer data)
 510 {
 511   if (! spi_dec_poll_mouse_moved (data))
 512     return TRUE;
 513   else
 514     {
 515       g_timeout_add (20, spi_dec_poll_mouse_moving, data);
 516       return FALSE;
 517     }
 518 }
 519
 520 static gboolean
 521 spi_dec_poll_mouse_moving (gpointer data)
 522 {
 523   if (spi_dec_poll_mouse_moved (data))
 524     return TRUE;
 525   else
 526     {
 527       g_timeout_add (100, spi_dec_poll_mouse_idle, data);
 528       return FALSE;
 529     }
 530 }
 531
 532 #ifdef WE_NEED_UGRAB_MOUSE
 533 static int
 534 spi_dec_ungrab_mouse (gpointer data)
 535 {
 536         Display *display = spi_get_display ();
 537         if (display)
 538           {
 539             XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
 540                            XDefaultRootWindow (spi_get_display ()));
 541           }
 542         return FALSE;
 543 }
 544 #endif
 545
 546 static void
 547 spi_dec_init_mouse_listener (SpiRegistry *registry)
 548 {
 549   Display *display = spi_get_display ();
 550   g_timeout_add (100, spi_dec_poll_mouse_idle, registry);
 551
 552   if (display)
 553     {
 554       if (XGrabButton (display, AnyButton, AnyModifier,
 555                        gdk_x11_get_default_root_xwindow (),
 556                        True, ButtonPressMask | ButtonReleaseMask,
 557                        GrabModeSync, GrabModeAsync, None, None) != Success) {
 558 #ifdef SPI_DEBUG
 559         fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
 560 #endif
 561         ;
 562       }
 563       XSync (display, False);
 564 #ifdef SPI_DEBUG
 565       fprintf (stderr, "mouse buttons grabbed\n");
 566 #endif
 567     }
 568 }
 569
 570 /**
 571  * Eventually we can use this to make the marshalling of mask types
 572  * more sane, but for now we just use this to detect
 573  * the use of 'virtual' masks such as numlock and convert them to
 574  * system-specific mask values (i.e. ModMask).
 575  *
 576  **/
 577 static Accessibility_ControllerEventMask
 578 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
 579 {
 580   Accessibility_ControllerEventMask tmp_mask;
 581   gboolean has_numlock;
 582
 583   has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
 584   tmp_mask = mask;
 585   if (has_numlock)
 586     {
 587       tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
 588       tmp_mask |= _numlock_physical_mask;
 589     }
 590
 591   return tmp_mask;
 592 }
 593
 594 static DEControllerKeyListener *
 595 spi_dec_key_listener_new (CORBA_Object                            l,
 596                           const Accessibility_KeySet             *keys,
 597                           const Accessibility_ControllerEventMask mask,
 598                           const Accessibility_EventTypeSeq    *typeseq,
 599                           const Accessibility_EventListenerMode  *mode,
 600                           CORBA_Environment                      *ev)
 601 {
 602   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
 603   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
 604   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
 605   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
 606   key_listener->mask = spi_dec_translate_mask (mask);
 607   key_listener->listener.typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
 608   if (mode)
 609     key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
 610   else
 611     key_listener->mode = NULL;
 612
 613 #ifdef SPI_DEBUG
 614   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
 615            (unsigned int) key_listener->mask,
 616            (int) (mode ? mode->global : 0),
 617            (void *) key_listener->keys,
 618            (int) (key_listener->keys ? key_listener->keys->_length : 0));
 619 #endif
 620
 621   return key_listener;
 622 }
 623
 624 static DEControllerListener *
 625 spi_dec_listener_new (CORBA_Object                            l,
 626                       const Accessibility_EventTypeSeq    *typeseq,
 627                       CORBA_Environment                      *ev)
 628 {
 629   DEControllerListener *listener = g_new0 (DEControllerListener, 1);
 630   listener->object = bonobo_object_dup_ref (l, ev);
 631   listener->type = SPI_DEVICE_TYPE_MOUSE;
 632   listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
 633   return listener;
 634 }
 635
 636 static DEControllerListener *
 637 spi_listener_clone (DEControllerListener *listener, CORBA_Environment *ev)
 638 {
 639   DEControllerListener *clone = g_new0 (DEControllerListener, 1);
 640   clone->object =
 641           CORBA_Object_duplicate (listener->object, ev);
 642   clone->type = listener->type;
 643   clone->typeseq = ORBit_copy_value (listener->typeseq, TC_Accessibility_EventTypeSeq);
 644   return clone;
 645 }
 646
 647 static DEControllerKeyListener *
 648 spi_key_listener_clone (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
 649 {
 650   DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
 651   clone->listener.object =
 652           CORBA_Object_duplicate (key_listener->listener.object, ev);
 653   clone->listener.type = SPI_DEVICE_TYPE_KBD;
 654   clone->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
 655   clone->mask = key_listener->mask;
 656   clone->listener.typeseq = ORBit_copy_value (key_listener->listener.typeseq, TC_Accessibility_EventTypeSeq);
 657   if (key_listener->mode)
 658     clone->mode = ORBit_copy_value (key_listener->mode, TC_Accessibility_EventListenerMode);
 659   else
 660     clone->mode = NULL;
 661   return clone;
 662 }
 663
 664 static void
 665 spi_key_listener_data_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
 666 {
 667   CORBA_free (key_listener->listener.typeseq);
 668   CORBA_free (key_listener->keys);
 669   g_free (key_listener);
 670 }
 671
 672 static void
 673 spi_key_listener_clone_free (DEControllerKeyListener *clone, CORBA_Environment *ev)
 674 {
 675   CORBA_Object_release (clone->listener.object, ev);
 676   spi_key_listener_data_free (clone, ev);
 677 }
 678
 679 static void
 680 spi_listener_clone_free (DEControllerListener *clone, CORBA_Environment *ev)
 681 {
 682   CORBA_Object_release (clone->object, ev);
 683   CORBA_free (clone->typeseq);
 684   g_free (clone);
 685 }
 686
 687 static void
 688 spi_dec_listener_free (DEControllerListener    *listener,
 689                        CORBA_Environment       *ev)
 690 {
 691   bonobo_object_release_unref (listener->object, ev);
 692   if (listener->type == SPI_DEVICE_TYPE_KBD)
 693     spi_key_listener_data_free ((DEControllerKeyListener *) listener, ev);
 694 }
 695
 696 static void
 697 _register_keygrab (SpiDEController      *controller,
 698                    DEControllerGrabMask *grab_mask)
 699 {
 700   GList *l;
 701
 702   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 703                           spi_grab_mask_compare_values);
 704   if (l)
 705     {
 706       DEControllerGrabMask *cur_mask = l->data;
 707
 708       cur_mask->ref_count++;
 709       if (cur_mask->pending_remove)
 710         {
 711           cur_mask->pending_remove = FALSE;
 712         }
 713     }
 714   else
 715     {
 716       controller->keygrabs_list =
 717         g_list_prepend (controller->keygrabs_list,
 718                         spi_grab_mask_clone (grab_mask));
 719     }
 720 }
 721
 722 static void
 723 _deregister_keygrab (SpiDEController      *controller,
 724                      DEControllerGrabMask *grab_mask)
 725 {
 726   GList *l;
 727
 728   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 729                           spi_grab_mask_compare_values);
 730
 731   if (l)
 732     {
 733       DEControllerGrabMask *cur_mask = l->data;
 734
 735       cur_mask->ref_count--;
 736       if (cur_mask->ref_count <= 0)
 737         {
 738           cur_mask->pending_remove = TRUE;
 739         }
 740     }
 741   else
 742     {
 743       DBG (1, g_warning ("De-registering non-existant grab"));
 744     }
 745 }
 746
 747 static void
 748 handle_keygrab (SpiDEController         *controller,
 749                 DEControllerKeyListener *key_listener,
 750                 void                   (*process_cb) (SpiDEController *controller,
 751                                                       DEControllerGrabMask *grab_mask))
 752 {
 753   DEControllerGrabMask grab_mask = { 0 };
 754
 755   grab_mask.mod_mask = key_listener->mask;
 756   if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
 757     {
 758       grab_mask.key_val = AnyKey;
 759 #ifdef SPI_DEBUG
 760       fprintf (stderr, "AnyKey grab!");
 761 #endif
 762       process_cb (controller, &grab_mask);
 763     }
 764   else
 765     {
 766       int i;
 767
 768       for (i = 0; i < key_listener->keys->_length; ++i)
 769         {
 770           Accessibility_KeyDefinition keydef = key_listener->keys->_buffer[i];
 771           long int key_val = keydef.keysym;
 772           /* X Grabs require keycodes, not keysyms */
 773           if (keydef.keystring && keydef.keystring[0])
 774             {
 775               key_val = XStringToKeysym(keydef.keystring);
 776             }
 777           if (key_val > 0)
 778             {
 779               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 780             }
 781           else
 782             {
 783               key_val = keydef.keycode;
 784             }
 785           grab_mask.key_val = key_val;
 786           process_cb (controller, &grab_mask);
 787         }
 788     }
 789 }
 790
 791 static gboolean
 792 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 793                                          DEControllerKeyListener *key_listener)
 794 {
 795   handle_keygrab (controller, key_listener, _register_keygrab);
 796   if (controller->xevie_display == NULL)
 797     return spi_controller_update_key_grabs (controller, NULL);
 798   else
 799     return TRUE;
 800 }
 801
 802 static void
 803 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 804                                            DEControllerKeyListener *key_listener)
 805 {
 806   handle_keygrab (controller, key_listener, _deregister_keygrab);
 807   if (controller->xevie_display == NULL)
 808     spi_controller_update_key_grabs (controller, NULL);
 809 }
 810
 811 static gboolean
 812 spi_controller_register_device_listener (SpiDEController      *controller,
 813                                          DEControllerListener *listener,
 814                                          CORBA_Environment    *ev)
 815 {
 816   DEControllerKeyListener *key_listener;
 817
 818   switch (listener->type) {
 819   case SPI_DEVICE_TYPE_KBD:
 820       key_listener = (DEControllerKeyListener *) listener;
 821
 822       controller->key_listeners = g_list_prepend (controller->key_listeners,
 823                                                   key_listener);
 824       if (key_listener->mode->global)
 825         {
 826           return spi_controller_register_global_keygrabs (controller, key_listener);
 827         }
 828       else
 829               return TRUE;
 830       break;
 831   case SPI_DEVICE_TYPE_MOUSE:
 832       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
 833       break;
 834   default:
 835       DBG (1, g_warning ("listener registration for unknown device type.\n"));
 836       break;
 837   }
 838   return FALSE;
 839 }
 840
 841 static gboolean
 842 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 843                                       const Accessibility_DeviceEvent *event,
 844                                       CORBA_Environment               *ev)
 845 {
 846   GList   *l;
 847   GSList  *notify = NULL, *l2;
 848   GList  **listeners = &controller->mouse_listeners;
 849   gboolean is_consumed;
 850   gboolean found = FALSE;
 851
 852   if (!listeners)
 853     {
 854       return FALSE;
 855     }
 856
 857   for (l = *listeners; l; l = l->next)
 858     {
 859        DEControllerListener *listener = l->data;
 860
 861        if (spi_eventtype_seq_contains_event (listener->typeseq, event))
 862          {
 863            Accessibility_DeviceEventListener ls = listener->object;
 864
 865            if (ls != CORBA_OBJECT_NIL)
 866              {
 867                /* we clone (don't dup) the listener, to avoid refcount inc. */
 868                notify = g_slist_prepend (notify,
 869                                          spi_listener_clone (listener, ev));
 870                found = TRUE;
 871              }
 872          }
 873     }
 874
 875 #ifdef SPI_KEYEVENT_DEBUG
 876   if (!found)
 877     {
 878       g_print ("no match for event\n");
 879     }
 880 #endif
 881
 882   is_consumed = FALSE;
 883   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
 884     {
 885       DEControllerListener *listener = l2->data;
 886       Accessibility_DeviceEventListener ls = listener->object;
 887
 888       CORBA_exception_init (ev);
 889       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, event, ev);
 890       if (BONOBO_EX (ev))
 891         {
 892           is_consumed = FALSE;
 893           DBG (2, g_warning ("error notifying listener, removing it\n"));
 894           spi_deregister_controller_device_listener (controller, listener,
 895                                                      ev);
 896           CORBA_exception_free (ev);
 897         }
 898
 899       spi_listener_clone_free ((DEControllerListener *) l2->data, ev);
 900     }
 901
 902   for (; l2; l2 = l2->next)
 903     {
 904       DEControllerListener *listener = l2->data;
 905       spi_listener_clone_free (listener, ev);
 906       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
 907     }
 908
 909   g_slist_free (notify);
 910
 911 #ifdef SPI_DEBUG
 912   if (is_consumed) g_message ("consumed\n");
 913 #endif
 914   return is_consumed;
 915 }
 916
 917 static void
 918 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
 919                                                  XEvent *xevent)
 920 {
 921   Accessibility_Event e;
 922   Accessibility_DeviceEvent mouse_e;
 923   CORBA_Environment ev;
 924   gchar event_name[24];
 925   gboolean is_consumed = FALSE;
 926   gboolean xkb_mod_unlatch_occurred;
 927   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
 928
 929   int button = xbutton_event->button;
 930
 931   unsigned int mouse_button_state = xbutton_event->state;
 932
 933   switch (button)
 934     {
 935     case 1:
 936             mouse_button_state |= Button1Mask;
 937             break;
 938     case 2:
 939             mouse_button_state |= Button2Mask;
 940             break;
 941     case 3:
 942             mouse_button_state |= Button3Mask;
 943             break;
 944     case 4:
 945             mouse_button_state |= Button4Mask;
 946             break;
 947     case 5:
 948             mouse_button_state |= Button5Mask;
 949             break;
 950     }
 951
 952   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
 953   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
 954
 955 #ifdef SPI_DEBUG
 956   fprintf (stderr, "mouse button %d %s (%x)\n",
 957            xbutton_event->button,
 958            (xevent->type == ButtonPress) ? "Press" : "Release",
 959            mouse_button_state);
 960 #endif
 961   snprintf (event_name, 22, "mouse:button:%d%c", button,
 962             (xevent->type == ButtonPress) ? 'p' : 'r');
 963
 964   /* TODO: FIXME distinguish between physical and logical buttons */
 965   mouse_e.type      = (xevent->type == ButtonPress) ?
 966                       Accessibility_BUTTON_PRESSED_EVENT :
 967                       Accessibility_BUTTON_RELEASED_EVENT;
 968   mouse_e.id        = button;
 969   mouse_e.hw_code   = button;
 970   mouse_e.modifiers = (CORBA_unsigned_short) xbutton_event->state;
 971   mouse_e.timestamp = (CORBA_unsigned_long) xbutton_event->time;
 972   mouse_e.event_string = "";
 973   mouse_e.is_text   = CORBA_FALSE;
 974   if ((mouse_button_state & mouse_button_mask) !=
 975        (mouse_mask_state & mouse_button_mask))
 976     {
 977       if ((mouse_mask_state & key_modifier_mask) !=
 978           (mouse_button_state & key_modifier_mask))
 979         spi_dec_emit_modifier_event (controller,
 980                                      mouse_mask_state, mouse_button_state);
 981       mouse_mask_state = mouse_button_state;
 982       is_consumed =
 983         spi_controller_notify_mouselisteners (controller, &mouse_e, &ev);
 984       e.type = CORBA_string_dup (event_name);
 985       e.source = BONOBO_OBJREF (controller->registry->desktop);
 986       e.detail1 = last_mouse_pos->x;
 987       e.detail2 = last_mouse_pos->y;
 988       spi_init_any_nil (&e.any_data);
 989       CORBA_exception_init (&ev);
 990
 991       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 992                                           &e,
 993                                           &ev);
 994     }
 995
 996   xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
 997                               xevent->type == ButtonRelease);
 998
 999   /* if client wants to consume this event, and XKB latch state was
1000    *   unset by this button event, we reset it
1001    */
1002   if (is_consumed && xkb_mod_unlatch_occurred)
1003     spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1004
1005   XAllowEvents (spi_get_display (),
1006                 (is_consumed) ? SyncPointer : ReplayPointer,
1007                 CurrentTime);
1008 }
1009
1010 static GdkFilterReturn
1011 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
1012 {
1013   XEvent *xevent = gdk_xevent;
1014   SpiDEController *controller;
1015   DEControllerPrivateData *priv;
1016   Display *display = spi_get_display ();
1017   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1018   priv = (DEControllerPrivateData *)
1019           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1020
1021   if (xevent->type == KeyPress || xevent->type == KeyRelease)
1022     {
1023       if (controller->xevie_display == NULL)
1024         {
1025           gboolean is_consumed =
1026             spi_device_event_controller_forward_key_event (controller, xevent);
1027
1028           if (is_consumed)
1029             XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
1030           else
1031             {
1032               wait_for_release_event (xevent, controller);
1033               XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
1034             }
1035         }
1036
1037       return GDK_FILTER_CONTINUE;
1038     }
1039   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1040     {
1041       spi_device_event_controller_forward_mouse_event (controller, xevent);
1042     }
1043   if (xevent->type == priv->xkb_base_event_code)
1044     {
1045       XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1046       /* ugly but probably necessary...*/
1047       XSynchronize (spi_get_display (), TRUE);
1048
1049       if (xkb_ev->xkb_type == XkbStateNotify)
1050         {
1051           XkbStateNotifyEvent *xkb_snev =
1052                   (XkbStateNotifyEvent *) xkb_ev;
1053           /* check the mouse, to catch mouse events grabbed by
1054            * another client; in case we should revert this XKB delatch
1055            */
1056           if (!priv->pending_xkb_mod_relatch_mask)
1057             {
1058               int x, y;
1059               gboolean moved;
1060               spi_dec_mouse_check (controller, &x, &y, &moved);
1061             }
1062           /* we check again, since the previous call may have
1063              changed this flag */
1064           if (priv->pending_xkb_mod_relatch_mask)
1065             {
1066               unsigned int feedback_mask;
1067 #ifdef SPI_XKB_DEBUG
1068               fprintf (stderr, "relatching %x\n",
1069                        priv->pending_xkb_mod_relatch_mask);
1070 #endif
1071               /* temporarily turn off the latch bell, if it's on */
1072               XkbGetControls (display,
1073                               XkbAccessXFeedbackMask,
1074                               priv->xkb_desc);
1075               feedback_mask = priv->xkb_desc->ctrls->ax_options;
1076               if (feedback_mask & XkbAX_StickyKeysFBMask)
1077               {
1078                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1079                                                  0, False};
1080                 priv->xkb_desc->ctrls->ax_options
1081                               &= ~(XkbAX_StickyKeysFBMask);
1082                 XkbChangeControls (display, priv->xkb_desc, &changes);
1083               }
1084               /* TODO: account for lock as well as latch */
1085               XkbLatchModifiers (display,
1086                                  XkbUseCoreKbd,
1087                                  priv->pending_xkb_mod_relatch_mask,
1088                                  priv->pending_xkb_mod_relatch_mask);
1089               if (feedback_mask & XkbAX_StickyKeysFBMask)
1090               {
1091                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1092                                                  0, False};
1093                 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1094                 XkbChangeControls (display, priv->xkb_desc, &changes);
1095               }
1096 #ifdef SPI_XKB_DEBUG
1097               fprintf (stderr, "relatched %x\n",
1098                        priv->pending_xkb_mod_relatch_mask);
1099 #endif
1100               priv->pending_xkb_mod_relatch_mask = 0;
1101             }
1102           else
1103             {
1104               priv->xkb_latch_mask = xkb_snev->latched_mods;
1105             }
1106         }
1107         else
1108                DBG (2, g_warning ("XKB event %d\n", xkb_ev->xkb_type));
1109       XSynchronize (spi_get_display (), FALSE);
1110     }
1111
1112   return GDK_FILTER_CONTINUE;
1113 }
1114
1115 int
1116 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1117 {
1118   if (error->error_code == BadAccess)
1119     {
1120       g_message ("Could not complete key grab: grab already in use.\n");
1121       spi_error_code = BadAccess;
1122       return 0;
1123     }
1124   else
1125     {
1126       return (*x_default_error_handler) (display, error);
1127     }
1128 }
1129
1130 static void
1131 spi_controller_register_with_devices (SpiDEController *controller)
1132 {
1133   DEControllerPrivateData *priv = (DEControllerPrivateData *)
1134           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1135   /* FIXME: should check for extension first! */
1136   XTestGrabControl (spi_get_display (), True);
1137
1138   /* calls to device-specific implementations and routines go here */
1139   /* register with: keyboard hardware code handler */
1140   /* register with: (translated) keystroke handler */
1141
1142   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1143                                       &priv->xkb_major_extension_opcode,
1144                                       &priv->xkb_base_event_code,
1145                                       &priv->xkb_base_error_code, NULL, NULL);
1146   if (priv->have_xkb)
1147     {
1148       priv->xkb_desc = XkbGetMap (spi_get_display (), 0, XkbUseCoreKbd);
1149       XkbSelectEvents (spi_get_display (),
1150                        XkbUseCoreKbd,
1151                        XkbStateNotifyMask, XkbStateNotifyMask);
1152       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1153                                                      XK_Num_Lock);
1154     }
1155
1156   gdk_window_add_filter (NULL, global_filter_fn, controller);
1157
1158   gdk_window_set_events (gdk_get_default_root_window (),
1159                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
1160
1161   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1162 }
1163
1164 static gboolean
1165 spi_key_set_contains_key (Accessibility_KeySet            *key_set,
1166                           const Accessibility_DeviceEvent *key_event)
1167 {
1168   gint i;
1169   gint len;
1170
1171   if (!key_set)
1172     {
1173       g_print ("null key set!");
1174       return TRUE;
1175     }
1176
1177   len = key_set->_length;
1178
1179   if (len == 0) /* special case, means "all keys/any key" */
1180     {
1181       g_print ("anykey\n");
1182       return TRUE;
1183     }
1184
1185   for (i = 0; i < len; ++i)
1186     {
1187 #ifdef SPI_KEYEVENT_DEBUG
1188       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1189                 i,
1190                 (int)key_set->_buffer[i].keysym,
1191                 (int) key_set->_buffer[i].keycode,
1192                 (int) key_event->id,
1193                 (int) key_event->hw_code,
1194                 key_event->event_string);
1195 #endif
1196       if (key_set->_buffer[i].keysym == (CORBA_long) key_event->id)
1197         {
1198           return TRUE;
1199         }
1200       if (key_set->_buffer[i].keycode == (CORBA_long) key_event->hw_code)
1201         {
1202           return TRUE;
1203         }
1204       if (key_event->event_string && key_event->event_string[0] &&
1205           !strcmp (key_set->_buffer[i].keystring, key_event->event_string))
1206         {
1207           return TRUE;
1208         }
1209     }
1210
1211   return FALSE;
1212 }
1213
1214 static gboolean
1215 spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq      *type_seq,
1216                                   const Accessibility_DeviceEvent *event)
1217 {
1218   gint i;
1219   gint len;
1220
1221
1222   if (!type_seq)
1223     {
1224       g_print ("null type seq!");
1225       return TRUE;
1226     }
1227
1228   len = type_seq->_length;
1229
1230   if (len == 0) /* special case, means "all events/any event" */
1231     {
1232       return TRUE;
1233     }
1234
1235   for (i = 0; i < len; ++i)
1236     {
1237 #ifdef SPI_DEBUG
1238       g_print ("type_seq[%d] = %d; event type = %d\n", i,
1239                (int) type_seq->_buffer[i], (int) event->type);
1240 #endif
1241       if (type_seq->_buffer[i] == (CORBA_long) event->type)
1242         {
1243           return TRUE;
1244         }
1245     }
1246
1247   return FALSE;
1248 }
1249
1250 static gboolean
1251 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1252                                 DEControllerKeyListener         *listener,
1253                                 CORBA_boolean                    is_system_global)
1254 {
1255   if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFF)) &&
1256        spi_key_set_contains_key (listener->keys, key_event) &&
1257        spi_eventtype_seq_contains_event (listener->listener.typeseq, key_event) &&
1258       (is_system_global == listener->mode->global))
1259     {
1260       return TRUE;
1261     }
1262   else
1263     {
1264       return FALSE;
1265     }
1266 }
1267
1268 static gboolean
1269 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1270                                     const Accessibility_DeviceEvent *key_event,
1271                                     CORBA_boolean                    is_system_global,
1272                                     CORBA_Environment               *ev)
1273 {
1274   GList   *l;
1275   GSList  *notify = NULL, *l2;
1276   GList  **key_listeners = &controller->key_listeners;
1277   gboolean is_consumed;
1278
1279   if (!key_listeners)
1280     {
1281       return FALSE;
1282     }
1283
1284   for (l = *key_listeners; l; l = l->next)
1285     {
1286        DEControllerKeyListener *key_listener = l->data;
1287
1288        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1289          {
1290            Accessibility_DeviceEventListener ls = key_listener->listener.object;
1291
1292            if (ls != CORBA_OBJECT_NIL)
1293              {
1294                /* we clone (don't dup) the listener, to avoid refcount inc. */
1295                notify = g_slist_prepend (notify,
1296                                          spi_key_listener_clone (key_listener, ev));
1297              }
1298          }
1299     }
1300
1301 #ifdef SPI_KEYEVENT_DEBUG
1302   if (!notify)
1303     {
1304       g_print ("no match for event\n");
1305     }
1306 #endif
1307
1308   is_consumed = FALSE;
1309   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1310     {
1311       DEControllerKeyListener *key_listener = l2->data;
1312       Accessibility_DeviceEventListener ls = key_listener->listener.object;
1313
1314       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
1315
1316       if (BONOBO_EX (ev))
1317         {
1318           is_consumed = FALSE;
1319           spi_deregister_controller_key_listener (controller, key_listener,
1320                                                   ev);
1321           CORBA_exception_free (ev);
1322         }
1323
1324       spi_key_listener_clone_free (key_listener, ev);
1325     }
1326
1327   for (; l2; l2 = l2->next)
1328     {
1329       DEControllerKeyListener *key_listener = l2->data;
1330       spi_key_listener_clone_free (key_listener, ev);
1331       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1332     }
1333
1334   g_slist_free (notify);
1335
1336 #ifdef SPI_DEBUG
1337   if (is_consumed) g_message ("consumed\n");
1338 #endif
1339   return is_consumed;
1340 }
1341
1342 static gboolean
1343 spi_clear_error_state ()
1344 {
1345         gboolean retval = spi_error_code != 0;
1346         spi_error_code = 0;
1347         return retval;
1348 }
1349
1350 static Accessibility_DeviceEvent
1351 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1352 {
1353   Accessibility_DeviceEvent key_event;
1354   KeySym keysym;
1355   const int cbuf_bytes = 20;
1356   char cbuf [cbuf_bytes+1];
1357   int nbytes;
1358
1359   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1360   key_event.id = (CORBA_long)(keysym);
1361   key_event.hw_code = (CORBA_short) x_key_event->keycode;
1362   if (((XEvent *) x_key_event)->type == KeyPress)
1363     {
1364       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1365     }
1366   else
1367     {
1368       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1369     }
1370   key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
1371   key_event.is_text = CORBA_FALSE;
1372   switch (keysym)
1373     {
1374       case ' ':
1375         key_event.event_string = CORBA_string_dup ("space");
1376         break;
1377       case XK_Tab:
1378         key_event.event_string = CORBA_string_dup ("Tab");
1379         break;
1380       case XK_BackSpace:
1381         key_event.event_string = CORBA_string_dup ("Backspace");
1382         break;
1383       case XK_Return:
1384         key_event.event_string = CORBA_string_dup ("Return");
1385         break;
1386       case XK_Home:
1387         key_event.event_string = CORBA_string_dup ("Home");
1388         break;
1389       case XK_Page_Down:
1390         key_event.event_string = CORBA_string_dup ("Page_Down");
1391         break;
1392       case XK_Page_Up:
1393         key_event.event_string = CORBA_string_dup ("Page_Up");
1394         break;
1395       case XK_F1:
1396         key_event.event_string = CORBA_string_dup ("F1");
1397         break;
1398       case XK_F2:
1399         key_event.event_string = CORBA_string_dup ("F2");
1400         break;
1401       case XK_F3:
1402         key_event.event_string = CORBA_string_dup ("F3");
1403         break;
1404       case XK_F4:
1405         key_event.event_string = CORBA_string_dup ("F4");
1406         break;
1407       case XK_F5:
1408         key_event.event_string = CORBA_string_dup ("F5");
1409         break;
1410       case XK_F6:
1411         key_event.event_string = CORBA_string_dup ("F6");
1412         break;
1413       case XK_F7:
1414         key_event.event_string = CORBA_string_dup ("F7");
1415         break;
1416       case XK_F8:
1417         key_event.event_string = CORBA_string_dup ("F8");
1418         break;
1419       case XK_F9:
1420         key_event.event_string = CORBA_string_dup ("F9");
1421         break;
1422       case XK_F10:
1423         key_event.event_string = CORBA_string_dup ("F10");
1424         break;
1425       case XK_F11:
1426         key_event.event_string = CORBA_string_dup ("F11");
1427         break;
1428       case XK_F12:
1429         key_event.event_string = CORBA_string_dup ("F12");
1430         break;
1431       case XK_End:
1432         key_event.event_string = CORBA_string_dup ("End");
1433         break;
1434       case XK_Escape:
1435         key_event.event_string = CORBA_string_dup ("Escape");
1436         break;
1437       case XK_Up:
1438         key_event.event_string = CORBA_string_dup ("Up");
1439         break;
1440       case XK_Down:
1441         key_event.event_string = CORBA_string_dup ("Down");
1442         break;
1443       case XK_Left:
1444         key_event.event_string = CORBA_string_dup ("Left");
1445         break;
1446       case XK_Right:
1447         key_event.event_string = CORBA_string_dup ("Right");
1448         break;
1449       default:
1450         if (nbytes > 0)
1451           {
1452             gunichar c;
1453             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1454             key_event.event_string = CORBA_string_dup (cbuf);
1455             c = g_utf8_get_char_validated (cbuf, nbytes);
1456             if ((c > 0) && g_unichar_isprint (c))
1457               {
1458                 key_event.is_text = CORBA_TRUE;
1459                 /* incorrect for some composed chars? */
1460               }
1461           }
1462         else
1463           {
1464             key_event.event_string = CORBA_string_dup ("");
1465           }
1466     }
1467
1468   key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
1469 #ifdef SPI_KEYEVENT_DEBUG
1470   {
1471     char *pressed_str  = "pressed";
1472     char *released_str = "released";
1473     char *state_ptr;
1474
1475     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1476       state_ptr = pressed_str;
1477     else
1478       state_ptr = released_str;
1479
1480     fprintf (stderr,
1481              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1482              (unsigned long) keysym,
1483              state_ptr,
1484              keysym ? (int) keysym : '*',
1485              (int) x_key_event->state,
1486              key_event.event_string,
1487              key_event.event_string[0],
1488              (key_event.is_text == CORBA_TRUE) ? "(text)" : "(not text)");
1489   }
1490 #endif
1491 #ifdef SPI_DEBUG
1492   fprintf (stderr, "%s%c\n",
1493      (x_key_event->state & Mod1Mask)?"Alt-":"",
1494      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1495      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1496 #endif /* SPI_DEBUG */
1497   return key_event;
1498 }
1499
1500 static gboolean
1501 spi_controller_update_key_grabs (SpiDEController           *controller,
1502                                  Accessibility_DeviceEvent *recv)
1503 {
1504   GList *l, *next;
1505   gboolean   update_failed = FALSE;
1506
1507   g_return_val_if_fail (controller != NULL, FALSE);
1508
1509   /*
1510    * masks known to work with default RH 7.1+:
1511    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1512    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1513    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1514    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1515    *
1516    * ControlMask grabs are broken, must be in use already
1517    */
1518   for (l = controller->keygrabs_list; l; l = next)
1519     {
1520       gboolean do_remove;
1521       gboolean re_issue_grab;
1522       DEControllerGrabMask *grab_mask = l->data;
1523
1524       next = l->next;
1525
1526       re_issue_grab = recv &&
1527               (recv->modifiers & grab_mask->mod_mask) &&
1528               (grab_mask->key_val == keycode_for_keysym (recv->id, NULL));
1529
1530 #ifdef SPI_DEBUG
1531       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1532                (long int) grab_mask->key_val,
1533                (long int) grab_mask->mod_mask,
1534                grab_mask->pending_add ? '+' : '.',
1535                grab_mask->pending_remove ? '-' : '.',
1536                re_issue_grab ? "re-issue": "");
1537 #endif
1538
1539       do_remove = FALSE;
1540
1541       if (grab_mask->pending_add && grab_mask->pending_remove)
1542         {
1543           do_remove = TRUE;
1544         }
1545       else if (grab_mask->pending_remove)
1546         {
1547 #ifdef SPI_DEBUG
1548       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1549 #endif
1550           XUngrabKey (spi_get_display (),
1551                       grab_mask->key_val,
1552                       grab_mask->mod_mask,
1553                       gdk_x11_get_default_root_xwindow ());
1554
1555           do_remove = TRUE;
1556         }
1557       else if (grab_mask->pending_add || re_issue_grab)
1558         {
1559
1560 #ifdef SPI_DEBUG
1561           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1562 #endif
1563           XGrabKey (spi_get_display (),
1564                     grab_mask->key_val,
1565                     grab_mask->mod_mask,
1566                     gdk_x11_get_default_root_xwindow (),
1567                     True,
1568                     GrabModeSync,
1569                     GrabModeSync);
1570           XSync (spi_get_display (), False);
1571           update_failed = spi_clear_error_state ();
1572           if (update_failed) {
1573                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1574                   do_remove = TRUE;
1575           }
1576         }
1577
1578       grab_mask->pending_add = FALSE;
1579       grab_mask->pending_remove = FALSE;
1580
1581       if (do_remove)
1582         {
1583           g_assert (grab_mask->ref_count <= 0);
1584
1585           controller->keygrabs_list = g_list_delete_link (
1586             controller->keygrabs_list, l);
1587
1588           spi_grab_mask_free (grab_mask);
1589         }
1590
1591     }
1592
1593   return ! update_failed;
1594 }
1595
1596 /*
1597  * Implemented GObject::finalize
1598  */
1599 static void
1600 spi_device_event_controller_object_finalize (GObject *object)
1601 {
1602   SpiDEController *controller;
1603   DEControllerPrivateData *private;
1604   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1605
1606 #ifdef SPI_DEBUG
1607   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1608 #endif
1609   /* disconnect any special listeners, get rid of outstanding keygrabs */
1610   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1611
1612 #ifdef HAVE_XEVIE
1613   if (controller->xevie_display != NULL)
1614     {
1615       XevieEnd(controller->xevie_display);
1616 #ifdef SPI_KEYEVENT_DEBUG
1617       printf("XevieEnd(dpy) finished \n");
1618 #endif
1619     }
1620 #endif
1621
1622   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1623   if (private->xkb_desc)
1624           XkbFreeKeyboard (private->xkb_desc, 0, True);
1625   g_free (private);
1626   spi_device_event_controller_parent_class->finalize (object);
1627 }
1628
1629 /*
1630  * CORBA Accessibility::DEController::registerKeystrokeListener
1631  *     method implementation
1632  */
1633 static CORBA_boolean
1634 impl_register_keystroke_listener (PortableServer_Servant                  servant,
1635                                   const Accessibility_DeviceEventListener l,
1636                                   const Accessibility_KeySet             *keys,
1637                                   const Accessibility_ControllerEventMask mask,
1638                                   const Accessibility_EventTypeSeq       *type,
1639                                   const Accessibility_EventListenerMode  *mode,
1640                                   CORBA_Environment                      *ev)
1641 {
1642   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1643           bonobo_object_from_servant (servant));
1644   DEControllerKeyListener *dec_listener;
1645 #ifdef SPI_DEBUG
1646   fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
1647            (void *) l, (unsigned long) mask);
1648 #endif
1649   dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
1650   return spi_controller_register_device_listener (
1651           controller, (DEControllerListener *) dec_listener, ev);
1652 }
1653
1654
1655 /*
1656  * CORBA Accessibility::DEController::registerDeviceEventListener
1657  *     method implementation
1658  */
1659 static CORBA_boolean
1660 impl_register_device_listener (PortableServer_Servant                  servant,
1661                                const Accessibility_DeviceEventListener l,
1662                                const Accessibility_EventTypeSeq       *event_types,
1663                                CORBA_Environment                      *ev)
1664 {
1665   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1666           bonobo_object_from_servant (servant));
1667   DEControllerListener *dec_listener;
1668
1669   dec_listener = spi_dec_listener_new (l, event_types, ev);
1670   return spi_controller_register_device_listener (
1671           controller, (DEControllerListener *) dec_listener, ev);
1672 }
1673
1674 typedef struct {
1675         CORBA_Environment       *ev;
1676         DEControllerListener    *listener;
1677 } RemoveListenerClosure;
1678
1679 static SpiReEntrantContinue
1680 remove_listener_cb (GList * const *list,
1681                     gpointer       user_data)
1682 {
1683   DEControllerListener  *listener = (*list)->data;
1684   RemoveListenerClosure *ctx = user_data;
1685
1686   if (CORBA_Object_is_equivalent (ctx->listener->object,
1687                                   listener->object, ctx->ev))
1688     {
1689       spi_re_entrant_list_delete_link (list);
1690       spi_dec_listener_free (listener, ctx->ev);
1691     }
1692
1693   return SPI_RE_ENTRANT_CONTINUE;
1694 }
1695
1696 static SpiReEntrantContinue
1697 copy_key_listener_cb (GList * const *list,
1698                       gpointer       user_data)
1699 {
1700   DEControllerKeyListener  *key_listener = (*list)->data;
1701   RemoveListenerClosure    *ctx = user_data;
1702
1703   if (CORBA_Object_is_equivalent (ctx->listener->object,
1704                                   key_listener->listener.object, ctx->ev))
1705     {
1706       /* TODO: FIXME aggregate keys in case the listener is registered twice */
1707       DEControllerKeyListener *ctx_key_listener =
1708         (DEControllerKeyListener *) ctx->listener;
1709       CORBA_free (ctx_key_listener->keys);
1710       ctx_key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
1711     }
1712
1713   return SPI_RE_ENTRANT_CONTINUE;
1714 }
1715
1716 static void
1717 spi_deregister_controller_device_listener (SpiDEController            *controller,
1718                                            DEControllerListener *listener,
1719                                            CORBA_Environment          *ev)
1720 {
1721   RemoveListenerClosure  ctx;
1722
1723   ctx.ev = ev;
1724   ctx.listener = listener;
1725
1726   spi_re_entrant_list_foreach (&controller->mouse_listeners,
1727                                remove_listener_cb, &ctx);
1728 }
1729
1730 static void
1731 spi_deregister_controller_key_listener (SpiDEController            *controller,
1732                                         DEControllerKeyListener    *key_listener,
1733                                         CORBA_Environment          *ev)
1734 {
1735   RemoveListenerClosure  ctx;
1736
1737   ctx.ev = ev;
1738   ctx.listener = (DEControllerListener *) key_listener;
1739
1740   /* special case, copy keyset from existing controller list entry */
1741   if (key_listener->keys->_length == 0)
1742     {
1743       spi_re_entrant_list_foreach (&controller->key_listeners,
1744                                   copy_key_listener_cb, &ctx);
1745     }
1746
1747   spi_controller_deregister_global_keygrabs (controller, key_listener);
1748
1749   spi_re_entrant_list_foreach (&controller->key_listeners,
1750                                 remove_listener_cb, &ctx);
1751
1752 }
1753
1754 /*
1755  * CORBA Accessibility::DEController::deregisterKeystrokeListener
1756  *     method implementation
1757  */
1758 static void
1759 impl_deregister_keystroke_listener (PortableServer_Servant                  servant,
1760                                     const Accessibility_DeviceEventListener l,
1761                                     const Accessibility_KeySet             *keys,
1762                                     const Accessibility_ControllerEventMask mask,
1763                                     const Accessibility_EventTypeSeq       *type,
1764                                     CORBA_Environment                      *ev)
1765 {
1766   DEControllerKeyListener  *key_listener;
1767   SpiDEController *controller;
1768
1769   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1770
1771   key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
1772
1773 #ifdef SPI_DEREGISTER_DEBUG
1774   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
1775            (void *) l, (unsigned long) mask->value);
1776 #endif
1777
1778   spi_deregister_controller_key_listener (controller, key_listener, ev);
1779
1780   spi_dec_listener_free ((DEControllerListener *) key_listener, ev);
1781 }
1782
1783 /*
1784  * CORBA Accessibility::DEController::deregisterDeviceEventListener
1785  *     method implementation
1786  */
1787 static void
1788 impl_deregister_device_listener (PortableServer_Servant                  servant,
1789                                  const Accessibility_DeviceEventListener l,
1790                                  const Accessibility_EventTypeSeq       *event_types,
1791                                  CORBA_Environment                      *ev)
1792 {
1793   SpiDEController *controller;
1794   DEControllerListener *listener =
1795           spi_dec_listener_new (l, event_types, ev);
1796
1797   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1798
1799   spi_deregister_controller_device_listener (controller, listener, ev);
1800
1801   spi_dec_listener_free (listener, ev);
1802 }
1803
1804 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
1805 {
1806   unsigned int retval = 0;
1807   DEControllerPrivateData *priv = (DEControllerPrivateData *)
1808           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1809 #ifdef HAVE_XKB
1810 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
1811   retval = XkbGetSlowKeysDelay (spi_get_display (),
1812                                 XkbUseCoreKbd, &bounce_delay);
1813 #else
1814   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
1815     {
1816       Status s = XkbGetControls (spi_get_display (),
1817                                  XkbAllControlsMask, priv->xkb_desc);
1818       if (s == Success)
1819         {
1820          if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
1821                  retval = priv->xkb_desc->ctrls->slow_keys_delay;
1822         }
1823     }
1824 #endif
1825 #endif
1826 #ifdef SPI_XKB_DEBUG
1827         fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
1828 #endif
1829         return retval;
1830 }
1831
1832 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
1833 {
1834   unsigned int retval = 0;
1835   DEControllerPrivateData *priv = (DEControllerPrivateData *)
1836           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1837 #ifdef HAVE_XKB
1838 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
1839   retval = XkbGetBounceKeysDelay (spi_get_display (),
1840                                   XkbUseCoreKbd, &bounce_delay);
1841 #else
1842   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
1843     {
1844       Status s = XkbGetControls (spi_get_display (),
1845                                  XkbAllControlsMask, priv->xkb_desc);
1846       if (s == Success)
1847         {
1848           if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
1849                   retval = priv->xkb_desc->ctrls->debounce_delay;
1850         }
1851     }
1852 #endif
1853 #endif
1854 #ifdef SPI_XKB_DEBUG
1855   fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
1856 #endif
1857   return retval;
1858 }
1859
1860 static gboolean
1861 dec_synth_keycode_press (SpiDEController *controller,
1862                          unsigned int keycode)
1863 {
1864         unsigned int time = CurrentTime;
1865         unsigned int bounce_delay;
1866         unsigned int elapsed_msec;
1867         struct timeval tv;
1868         DEControllerPrivateData *priv =
1869                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
1870                                                                 spi_dec_private_quark);
1871         if (keycode == priv->last_release_keycode)
1872         {
1873                 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
1874                 if (bounce_delay)
1875                 {
1876                         gettimeofday (&tv, NULL);
1877                         elapsed_msec =
1878                                 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
1879                                 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
1880 #ifdef SPI_XKB_DEBUG
1881                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
1882                                  (long) (tv.tv_usec - priv->last_release_time.tv_usec));
1883 #endif
1884 #ifdef THIS_IS_BROKEN
1885                         if (elapsed_msec < bounce_delay)
1886                                 time = bounce_delay - elapsed_msec + 1;
1887 #else
1888                         time = bounce_delay + 10;
1889                         /* fudge for broken XTest */
1890 #endif
1891 #ifdef SPI_XKB_DEBUG
1892                         fprintf (stderr, "waiting %d ms\n", time);
1893 #endif
1894                 }
1895         }
1896         XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
1897         priv->last_press_keycode = keycode;
1898         XSync (spi_get_display (), False);
1899         gettimeofday (&priv->last_press_time, NULL);
1900         return TRUE;
1901 }
1902
1903 static gboolean
1904 dec_synth_keycode_release (SpiDEController *controller,
1905                            unsigned int keycode)
1906 {
1907         unsigned int time = CurrentTime;
1908         unsigned int slow_delay;
1909         unsigned int elapsed_msec;
1910         struct timeval tv;
1911         DEControllerPrivateData *priv =
1912                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
1913                                                                 spi_dec_private_quark);
1914         if (keycode == priv->last_press_keycode)
1915         {
1916                 slow_delay = dec_xkb_get_slowkeys_delay (controller);
1917                 if (slow_delay)
1918                 {
1919                         gettimeofday (&tv, NULL);
1920                         elapsed_msec =
1921                                 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
1922                                 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
1923 #ifdef SPI_XKB_DEBUG
1924                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
1925                                  (long) (tv.tv_usec - priv->last_press_time.tv_usec));
1926 #endif
1927 #ifdef THIS_IS_BROKEN_DUNNO_WHY
1928                         if (elapsed_msec < slow_delay)
1929                                 time = slow_delay - elapsed_msec + 1;
1930 #else
1931                         time = slow_delay + 10;
1932                         /* our XTest seems broken, we have to add slop as above */
1933 #endif
1934 #ifdef SPI_XKB_DEBUG
1935                         fprintf (stderr, "waiting %d ms\n", time);
1936 #endif
1937                 }
1938         }
1939         XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
1940         priv->last_release_keycode = keycode;
1941         XSync (spi_get_display (), False);
1942         gettimeofday (&priv->last_release_time, NULL);
1943         return TRUE;
1944 }
1945
1946 static unsigned
1947 dec_get_modifier_state (SpiDEController *controller)
1948 {
1949         return mouse_mask_state;
1950 }
1951
1952 static gboolean
1953 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
1954 {
1955         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
1956                           modifiers, modifiers);
1957 }
1958
1959 static gboolean
1960 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
1961 {
1962         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
1963                           modifiers, 0);
1964 }
1965
1966 static KeySym
1967 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
1968 {
1969         return ucs2keysym ((long) unichar);
1970 }
1971
1972 static gboolean
1973 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
1974 {
1975         KeyCode key_synth_code;
1976         unsigned int modifiers, synth_mods, lock_mods;
1977
1978         key_synth_code = keycode_for_keysym (keysym, &synth_mods);
1979
1980         if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
1981
1982         /* TODO: set the modifiers accordingly! */
1983         modifiers = dec_get_modifier_state (controller);
1984         /* side-effect; we may unset mousebutton modifiers here! */
1985
1986         lock_mods = 0;
1987         if (synth_mods != modifiers) {
1988                 lock_mods = synth_mods & ~modifiers;
1989                 dec_lock_modifiers (controller, lock_mods);
1990         }
1991         dec_synth_keycode_press (controller, key_synth_code);
1992         dec_synth_keycode_release (controller, key_synth_code);
1993         if (synth_mods != modifiers)
1994                 dec_unlock_modifiers (controller, lock_mods);
1995         return TRUE;
1996 }
1997
1998
1999 static gboolean
2000 dec_synth_keystring (SpiDEController *controller, const CORBA_char *keystring)
2001 {
2002         /* probably we need to create and inject an XIM handler eventually. */
2003         /* for now, try to match the string to existing
2004          * keycode+modifier states.
2005          */
2006         KeySym *keysyms;
2007         gint maxlen = 0;
2008         gunichar unichar = 0;
2009         gint i = 0;
2010         gboolean retval = TRUE;
2011         const gchar *c;
2012
2013         maxlen = strlen (keystring);
2014         keysyms = g_new0 (KeySym, maxlen);
2015         if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2016                 retval = FALSE;
2017         }
2018         else {
2019 #ifdef SPI_DEBUG
2020                 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2021 #endif
2022                 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2023                         KeySym keysym;
2024                         char bytes[6];
2025                         gint mbytes;
2026
2027                         mbytes = g_unichar_to_utf8 (unichar, bytes);
2028                         bytes[mbytes] = '\0';
2029 #ifdef SPI_DEBUG
2030                         fprintf (stderr, "[unichar %s]", bytes);
2031 #endif
2032                         keysym = dec_keysym_for_unichar (controller, unichar);
2033                         if (keysym == NoSymbol) {
2034 #ifdef SPI_DEBUG
2035                                 fprintf (stderr, "no keysym for %s", bytes);
2036 #endif
2037                                 retval = FALSE;
2038                                 break;
2039                         }
2040                         keysyms[i++] = keysym;
2041                         keystring = g_utf8_next_char (keystring);
2042                 }
2043                 keysyms[i++] = 0;
2044                 for (i = 0; keysyms[i]; ++i) {
2045                         if (!dec_synth_keysym (controller, keysyms[i])) {
2046 #ifdef SPI_DEBUG
2047                                 fprintf (stderr, "could not synthesize %c\n",
2048                                          (int) keysyms[i]);
2049 #endif
2050                                 retval = FALSE;
2051                                 break;
2052                         }
2053                 }
2054         }
2055         g_free (keysyms);
2056
2057         return retval;
2058 }
2059
2060
2061 /*
2062  * CORBA Accessibility::DEController::registerKeystrokeListener
2063  *     method implementation
2064  */
2065 static void
2066 impl_generate_keyboard_event (PortableServer_Servant           servant,
2067                               const CORBA_long                 keycode,
2068                               const CORBA_char                *keystring,
2069                               const Accessibility_KeySynthType synth_type,
2070                               CORBA_Environment               *ev)
2071 {
2072   SpiDEController *controller =
2073         SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
2074   long key_synth_code;
2075   KeySym keysym;
2076
2077 #ifdef SPI_DEBUG
2078         fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2079                  (long) keycode, (int) synth_type);
2080 #endif
2081   /* TODO: hide/wrap/remove X dependency */
2082
2083   /*
2084    * TODO: when initializing, query for XTest extension before using,
2085    * and fall back to XSendEvent() if XTest is not available.
2086    */
2087
2088   gdk_error_trap_push ();
2089   key_synth_code = keycode;
2090
2091   switch (synth_type)
2092     {
2093       case Accessibility_KEY_PRESS:
2094               dec_synth_keycode_press (controller, keycode);
2095               break;
2096       case Accessibility_KEY_PRESSRELEASE:
2097               dec_synth_keycode_press (controller, keycode);
2098       case Accessibility_KEY_RELEASE:
2099               dec_synth_keycode_release (controller, keycode);
2100               break;
2101       case Accessibility_KEY_SYM:
2102 #ifdef SPI_XKB_DEBUG
2103               fprintf (stderr, "KeySym synthesis\n");
2104 #endif
2105               /*
2106                * note: we are using long for 'keycode'
2107                * in our arg list; it can contain either
2108                * a keycode or a keysym.
2109                */
2110               dec_synth_keysym (controller, (KeySym) keycode);
2111               break;
2112       case Accessibility_KEY_STRING:
2113               if (!dec_synth_keystring (controller, keystring))
2114                       fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2115                                keystring);
2116               break;
2117     }
2118   if (gdk_error_trap_pop ())
2119     {
2120       DBG (-1, g_warning ("Error emitting keystroke"));
2121     }
2122   if (synth_type == Accessibility_KEY_SYM) {
2123     keysym = keycode;
2124   }
2125   else {
2126     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2127   }
2128   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2129     {
2130       spi_dec_clear_unlatch_pending (controller);
2131     }
2132 }
2133
2134 /* Accessibility::DEController::generateMouseEvent */
2135 static void
2136 impl_generate_mouse_event (PortableServer_Servant servant,
2137                            const CORBA_long       x,
2138                            const CORBA_long       y,
2139                            const CORBA_char      *eventName,
2140                            CORBA_Environment     *ev)
2141 {
2142   int button = 0;
2143   gboolean error = FALSE;
2144   Display *display = spi_get_display ();
2145 #ifdef SPI_DEBUG
2146   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2147            eventName, (long int) x, (long int) y);
2148 #endif
2149   switch (eventName[0])
2150     {
2151       case 'b':
2152         switch (eventName[1])
2153           {
2154           /* TODO: check number of buttons before parsing */
2155           case '1':
2156                     button = 1;
2157                     break;
2158           case '2':
2159                   button = 2;
2160                   break;
2161           case '3':
2162                   button = 3;
2163                   break;
2164           case '4':
2165                   button = 4;
2166                   break;
2167           case '5':
2168                   button = 5;
2169                   break;
2170           default:
2171                   error = TRUE;
2172           }
2173         if (!error)
2174           {
2175             if (x != -1 && y != -1)
2176               {
2177                 XTestFakeMotionEvent (display, DefaultScreen (display),
2178                                       x, y, 0);
2179               }
2180             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2181             if (eventName[2] == 'c')
2182               XTestFakeButtonEvent (display, button, FALSE, 1);
2183             else if (eventName[2] == 'd')
2184               {
2185               XTestFakeButtonEvent (display, button, FALSE, 1);
2186               XTestFakeButtonEvent (display, button, TRUE, 2);
2187               XTestFakeButtonEvent (display, button, FALSE, 3);
2188               }
2189           }
2190         break;
2191       case 'r': /* relative motion */
2192         XTestFakeRelativeMotionEvent (display, x, y, 0);
2193         break;
2194       case 'a': /* absolute motion */
2195         XTestFakeMotionEvent (display, DefaultScreen (display),
2196                               x, y, 0);
2197         break;
2198     }
2199 }
2200
2201 /* Accessibility::DEController::notifyListenersSync */
2202 static CORBA_boolean
2203 impl_notify_listeners_sync (PortableServer_Servant           servant,
2204                             const Accessibility_DeviceEvent *event,
2205                             CORBA_Environment               *ev)
2206 {
2207   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2208     bonobo_object_from_servant (servant));
2209 #ifdef SPI_DEBUG
2210   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2211            controller, (int) event->id);
2212 #endif
2213   return spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev) ?
2214           CORBA_TRUE : CORBA_FALSE;
2215 }
2216
2217 /* Accessibility::DEController::notifyListenersAsync */
2218 static void
2219 impl_notify_listeners_async (PortableServer_Servant           servant,
2220                              const Accessibility_DeviceEvent *event,
2221                              CORBA_Environment               *ev)
2222 {
2223   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2224     bonobo_object_from_servant (servant));
2225 #ifdef SPI_DEBUG
2226   fprintf (stderr, "notifying listeners asynchronously\n");
2227 #endif
2228   spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev);
2229 }
2230
2231 static void
2232 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2233 {
2234   GObjectClass * object_class = (GObjectClass *) klass;
2235   POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
2236
2237   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2238
2239   object_class->finalize = spi_device_event_controller_object_finalize;
2240
2241   epv->registerKeystrokeListener   = impl_register_keystroke_listener;
2242   epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
2243   epv->registerDeviceEventListener = impl_register_device_listener;
2244   epv->deregisterDeviceEventListener = impl_deregister_device_listener;
2245   epv->generateKeyboardEvent       = impl_generate_keyboard_event;
2246   epv->generateMouseEvent          = impl_generate_mouse_event;
2247   epv->notifyListenersSync         = impl_notify_listeners_sync;
2248   epv->notifyListenersAsync        = impl_notify_listeners_async;
2249
2250   if (!spi_dec_private_quark)
2251           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2252 }
2253
2254 #ifdef HAVE_XEVIE
2255 Bool isEvent(dpy,event,arg)
2256      Display *dpy;
2257      XEvent *event;
2258      char *arg;
2259 {
2260    return TRUE;
2261 }
2262
2263 gboolean
2264 handle_io (GIOChannel *source,
2265            GIOCondition condition,
2266            gpointer data)
2267 {
2268   SpiDEController *controller = (SpiDEController *) data;
2269   gboolean is_consumed = FALSE;
2270   XEvent ev;
2271
2272   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2273     {
2274       if (ev.type == KeyPress || ev.type == KeyRelease)
2275         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2276
2277       if (! is_consumed)
2278         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2279     }
2280
2281   return TRUE;
2282 }
2283 #endif /* HAVE_XEVIE */
2284
2285 static void
2286 spi_device_event_controller_init (SpiDEController *device_event_controller)
2287 {
2288 #ifdef HAVE_XEVIE
2289   GIOChannel *ioc;
2290   int fd;
2291 #endif /* HAVE_XEVIE */
2292
2293   DEControllerPrivateData *private;
2294   device_event_controller->key_listeners   = NULL;
2295   device_event_controller->mouse_listeners = NULL;
2296   device_event_controller->keygrabs_list   = NULL;
2297   device_event_controller->xevie_display   = NULL;
2298
2299 #ifdef HAVE_XEVIE
2300   device_event_controller->xevie_display = XOpenDisplay(NULL);
2301
2302   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2303     {
2304 #ifdef SPI_KEYEVENT_DEBUG
2305       fprintf (stderr, "XevieStart() success \n");
2306 #endif
2307       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2308
2309       fd = ConnectionNumber(device_event_controller->xevie_display);
2310       ioc = g_io_channel_unix_new (fd);
2311       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2312       g_io_channel_unref (ioc);
2313     }
2314   else
2315     {
2316       device_event_controller->xevie_display = NULL;
2317 #ifdef SPI_KEYEVENT_DEBUG
2318       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2319 #endif
2320     }
2321 #endif /* HAVE_XEVIE */
2322
2323   private = g_new0 (DEControllerPrivateData, 1);
2324   gettimeofday (&private->last_press_time, NULL);
2325   gettimeofday (&private->last_release_time, NULL);
2326   g_object_set_qdata (G_OBJECT (device_event_controller),
2327                       spi_dec_private_quark,
2328                       private);
2329   spi_controller_register_with_devices (device_event_controller);
2330 }
2331
2332 static gboolean
2333 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2334                                                const XEvent    *event)
2335 {
2336   CORBA_Environment ev;
2337   Accessibility_DeviceEvent key_event;
2338
2339   g_assert (event->type == KeyPress || event->type == KeyRelease);
2340
2341   CORBA_exception_init (&ev);
2342
2343   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2344
2345   if (controller->xevie_display == NULL)
2346     spi_controller_update_key_grabs (controller, &key_event);
2347
2348   /* relay to listeners, and decide whether to consume it or not */
2349   return spi_controller_notify_keylisteners (controller, &key_event, CORBA_TRUE, &ev);
2350 }
2351
2352 SpiDEController *
2353 spi_device_event_controller_new (SpiRegistry *registry)
2354 {
2355   SpiDEController *retval = g_object_new (
2356     SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2357
2358   retval->registry = SPI_REGISTRY (bonobo_object_ref (
2359           BONOBO_OBJECT (registry)));
2360
2361   spi_dec_init_mouse_listener (registry);
2362   /* TODO: kill mouse listener on finalize */
2363   return retval;
2364 }
2365
2366 static gboolean
2367 is_key_released (KeyCode code)
2368 {
2369   char keys[32];
2370   int down;
2371   int i;
2372
2373   XQueryKeymap (spi_get_display (), keys);
2374   down = BIT (keys, code);
2375   return (down == 0);
2376 }
2377
2378 static gboolean
2379 check_release (gpointer data)
2380 {
2381   gboolean released;
2382   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2383   KeyCode code = event->hw_code;
2384   CORBA_Environment ev;
2385
2386   released = is_key_released (code);
2387
2388   if (released)
2389     {
2390       check_release_handler = 0;
2391       event->type = Accessibility_KEY_RELEASED_EVENT;
2392       ev._major = CORBA_NO_EXCEPTION;
2393       spi_controller_notify_keylisteners (saved_controller, event, CORBA_TRUE, &ev);
2394     }
2395   return (released == 0);
2396 }
2397
2398 static void wait_for_release_event (XEvent          *event,
2399                                     SpiDEController *controller)
2400 {
2401   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2402   saved_controller = controller;
2403   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2404 }
2405
2406 BONOBO_TYPE_FUNC_FULL (SpiDEController,
2407                        Accessibility_DeviceEventController,
2408                        PARENT_TYPE,
2409                        spi_device_event_controller)