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