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