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