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