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 <droute/introspect-loader.h>
  60 #include <spi-common/spi-dbus.h>
  61 #include <spi-common/spi-types.h>
  62
  63 #include "deviceeventcontroller.h"
  64 #include "reentrant-list.h"
  65
  66 KeySym ucs2keysym (long ucs);
  67 long keysym2ucs(KeySym keysym);
  68
  69 #define CHECK_RELEASE_DELAY 20
  70 #define BIT(c, x)       (c[x/8]&(1<<(x%8)))
  71 static guint check_release_handler = 0;
  72 static Accessibility_DeviceEvent pressed_event;
  73 static SpiDEController *saved_controller;
  74 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
  75
  76 /* Our parent Gtk object type */
  77 #define PARENT_TYPE G_TYPE_OBJECT
  78
  79 /* A pointer to our parent object class */
  80 static int spi_error_code = 0;
  81 static GdkPoint last_mouse_pos_static = {0, 0};
  82 static GdkPoint *last_mouse_pos = &last_mouse_pos_static;
  83 static unsigned int mouse_mask_state = 0;
  84 static unsigned int mouse_button_mask =
  85   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
  86 static unsigned int key_modifier_mask =
  87   Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
  88 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
  89
  90 static GQuark spi_dec_private_quark = 0;
  91 static XModifierKeymap* xmkeymap = NULL;
  92
  93 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
  94
  95 typedef enum {
  96   SPI_DEVICE_TYPE_KBD,
  97   SPI_DEVICE_TYPE_MOUSE,
  98   SPI_DEVICE_TYPE_LAST_DEFINED
  99 } SpiDeviceTypeCategory;
 100
 101 typedef struct {
 102   guint                             ref_count : 30;
 103   guint                             pending_add : 1;
 104   guint                             pending_remove : 1;
 105
 106   Accessibility_ControllerEventMask mod_mask;
 107   dbus_uint32_t               key_val;  /* KeyCode */
 108 } DEControllerGrabMask;
 109
 110 typedef struct {
 111   char *bus_name;
 112   char *path;
 113   SpiDeviceTypeCategory type;
 114   gulong types;
 115 } DEControllerListener;
 116
 117 typedef struct {
 118   DEControllerListener listener;
 119
 120  GSList *keys;
 121   Accessibility_ControllerEventMask mask;
 122   Accessibility_EventListenerMode  *mode;
 123 } DEControllerKeyListener;
 124
 125 typedef struct {
 126   unsigned int last_press_keycode;
 127   unsigned int last_release_keycode;
 128   struct timeval last_press_time;
 129   struct timeval last_release_time;
 130   int have_xkb;
 131   int xkb_major_extension_opcode;
 132   int xkb_base_event_code;
 133   int xkb_base_error_code;
 134   unsigned int xkb_latch_mask;
 135   unsigned int pending_xkb_mod_relatch_mask;
 136   XkbDescPtr xkb_desc;
 137   KeyCode reserved_keycode;
 138   KeySym reserved_keysym;
 139   guint  reserved_reset_timeout;
 140 } DEControllerPrivateData;
 141
 142 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
 143 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
 144                                                                Accessibility_DeviceEvent *recv);
 145 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
 146                                                                DEControllerListener      *l);
 147 static gboolean spi_device_event_controller_forward_key_event (SpiDEController           *controller,
 148                                                                const XEvent              *event);
 149 static void     spi_controller_deregister_device_listener (SpiDEController            *controller,
 150                                                            DEControllerListener *listener);
 151 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
 152                                                         DEControllerKeyListener *key_listener);
 153 static gboolean spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 154                                                       const Accessibility_DeviceEvent *event);
 155
 156 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
 157                                                   const Accessibility_DeviceEvent *event);
 158 static gboolean spi_clear_error_state (void);
 159 static gboolean spi_dec_poll_mouse_moved (gpointer data);
 160 static gboolean spi_dec_poll_mouse_moving (gpointer data);
 161 static gboolean spi_dec_poll_mouse_idle (gpointer data);
 162
 163 #define spi_get_display() GDK_DISPLAY()
 164
 165 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
 166
 167 /* Private methods */
 168
 169 static unsigned int
 170 keysym_mod_mask (KeySym keysym, KeyCode keycode)
 171 {
 172         /* we really should use XKB and look directly at the keymap */
 173         /* this is very inelegant */
 174         Display *display = spi_get_display ();
 175         unsigned int mods_rtn = 0;
 176         unsigned int retval = 0;
 177         KeySym sym_rtn;
 178
 179         if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
 180             (sym_rtn == keysym)) {
 181                 retval = 0;
 182         }
 183         else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
 184                  (sym_rtn == keysym)) {
 185                 retval = ShiftMask;
 186         }
 187         else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
 188                  (sym_rtn == keysym)) {
 189                 retval = Mod2Mask;
 190         }
 191         else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
 192                  (sym_rtn == keysym)) {
 193                 retval = Mod3Mask;
 194         }
 195         else if (XkbLookupKeySym (display, keycode,
 196                                   ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
 197                  (sym_rtn == keysym)) {
 198                 retval = (Mod2Mask | ShiftMask);
 199         }
 200         else if (XkbLookupKeySym (display, keycode,
 201                                   ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
 202                  (sym_rtn == keysym)) {
 203                 retval = (Mod3Mask | ShiftMask);
 204         }
 205         else if (XkbLookupKeySym (display, keycode,
 206                                   ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
 207                  (sym_rtn == keysym)) {
 208                 retval = (Mod4Mask | ShiftMask);
 209         }
 210         else
 211                 retval = 0xFFFF;
 212         return retval;
 213 }
 214
 215 static gboolean
 216 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
 217 {
 218 #ifdef HAVE_XKB
 219   Display *dpy = spi_get_display ();
 220   XkbDescPtr desc;
 221   if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
 222     {
 223       fprintf (stderr, "ERROR getting map\n");
 224     }
 225   XFlush (dpy);
 226   XSync (dpy, False);
 227   if (desc && desc->map)
 228     {
 229       gint offset = desc->map->key_sym_map[keycode].offset;
 230       desc->map->syms[offset] = keysym;
 231     }
 232   else
 233     {
 234       fprintf (stderr, "Error changing key map: empty server structure\n");
 235     }
 236   XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
 237   /**
 238    *  FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
 239    * would be far preferable.
 240    * HOWEVER it does not seem to work using XFree 4.3.
 241    **/
 242   /*        XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
 243   XFlush (dpy);
 244   XSync (dpy, False);
 245   XkbFreeKeyboard (desc, 0, TRUE);
 246
 247   return TRUE;
 248 #else
 249   return FALSE;
 250 #endif
 251 }
 252
 253 static gboolean
 254 spi_dec_reset_reserved (gpointer data)
 255 {
 256   DEControllerPrivateData *priv = data;
 257   spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
 258   priv->reserved_reset_timeout = 0;
 259   return FALSE;
 260 }
 261
 262 static KeyCode
 263 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
 264 {
 265         KeyCode keycode = 0;
 266         keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 267         if (!keycode)
 268         {
 269                 DEControllerPrivateData *priv = (DEControllerPrivateData *)
 270                         g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 271                 /* if there's no keycode available, fix it */
 272                 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
 273                 {
 274                         keycode = priv->reserved_keycode;
 275                         /*
 276                          * queue a timer to restore the old keycode.  Ugly, but required
 277                          * due to races / asynchronous X delivery.
 278                          * Long-term fix is to extend the X keymap here instead of replace entries.
 279                          */
 280                         priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
 281                 }
 282                 *modmask = 0;
 283                 return keycode;
 284         }
 285         if (modmask)
 286                 *modmask = keysym_mod_mask (keysym, keycode);
 287         return keycode;
 288 }
 289
 290 static DEControllerGrabMask *
 291 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
 292 {
 293   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
 294
 295   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
 296
 297   clone->ref_count = 1;
 298   clone->pending_add = TRUE;
 299   clone->pending_remove = FALSE;
 300
 301   return clone;
 302 }
 303
 304 static void
 305 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
 306 {
 307   g_free (grab_mask);
 308 }
 309
 310 static gint
 311 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
 312 {
 313   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
 314   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
 315
 316   if (p1 == p2)
 317     {
 318       return 0;
 319     }
 320   else
 321     {
 322       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
 323     }
 324 }
 325
 326 static void
 327 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
 328 {
 329   DEControllerPrivateData *priv =
 330     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 331 #ifdef SPI_XKB_DEBUG
 332   if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
 333                                      priv->xkb_latch_mask);
 334 #endif
 335   priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
 336 }
 337
 338 static void
 339 spi_dec_clear_unlatch_pending (SpiDEController *controller)
 340 {
 341   DEControllerPrivateData *priv =
 342     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 343   priv->xkb_latch_mask = 0;
 344 }
 345
 346 static void emit(SpiDEController *controller, const char *name, int first_type, ...)
 347 {
 348   va_list arg;
 349
 350   va_start(arg, first_type);
 351   spi_dbus_emit_valist(controller->droute->bus, SPI_DBUS_PATH_DEC, SPI_DBUS_INTERFACE_DEC, name, first_type, arg);
 352   va_end(arg);
 353 }
 354
 355 static gboolean
 356 spi_dec_button_update_and_emit (SpiDEController *controller,
 357                                 guint mask_return)
 358 {
 359   Accessibility_DeviceEvent mouse_e;
 360   gchar event_name[24];
 361   gboolean is_consumed = FALSE;
 362
 363   if ((mask_return & mouse_button_mask) !=
 364       (mouse_mask_state & mouse_button_mask))
 365     {
 366       int button_number = 0;
 367       gboolean is_down = False;
 368
 369       if (!(mask_return & Button1Mask) &&
 370           (mouse_mask_state & Button1Mask))
 371         {
 372           mouse_mask_state &= ~Button1Mask;
 373           button_number = 1;
 374         }
 375       else if ((mask_return & Button1Mask) &&
 376                !(mouse_mask_state & Button1Mask))
 377         {
 378           mouse_mask_state |= Button1Mask;
 379           button_number = 1;
 380           is_down = True;
 381         }
 382       else if (!(mask_return & Button2Mask) &&
 383                (mouse_mask_state & Button2Mask))
 384         {
 385           mouse_mask_state &= ~Button2Mask;
 386           button_number = 2;
 387         }
 388       else if ((mask_return & Button2Mask) &&
 389                !(mouse_mask_state & Button2Mask))
 390         {
 391           mouse_mask_state |= Button2Mask;
 392           button_number = 2;
 393           is_down = True;
 394         }
 395       else if (!(mask_return & Button3Mask) &&
 396                (mouse_mask_state & Button3Mask))
 397         {
 398           mouse_mask_state &= ~Button3Mask;
 399           button_number = 3;
 400         }
 401       else if ((mask_return & Button3Mask) &&
 402                !(mouse_mask_state & Button3Mask))
 403         {
 404           mouse_mask_state |= Button3Mask;
 405           button_number = 3;
 406           is_down = True;
 407         }
 408       else if (!(mask_return & Button4Mask) &&
 409                (mouse_mask_state & Button4Mask))
 410         {
 411           mouse_mask_state &= ~Button4Mask;
 412           button_number = 4;
 413         }
 414       else if ((mask_return & Button4Mask) &&
 415                !(mouse_mask_state & Button4Mask))
 416         {
 417           mouse_mask_state |= Button4Mask;
 418           button_number = 4;
 419           is_down = True;
 420         }
 421       else if (!(mask_return & Button5Mask) &&
 422                (mouse_mask_state & Button5Mask))
 423         {
 424           mouse_mask_state &= ~Button5Mask;
 425           button_number = 5;
 426         }
 427       else if ((mask_return & Button5Mask) &&
 428                !(mouse_mask_state & Button5Mask))
 429         {
 430           mouse_mask_state |= Button5Mask;
 431           button_number = 5;
 432           is_down = True;
 433         }
 434       if (button_number) {
 435 #ifdef SPI_DEBUG
 436         fprintf (stderr, "Button %d %s\n",
 437                  button_number, (is_down) ? "Pressed" : "Released");
 438 #endif
 439         snprintf (event_name, 22, "mouse:button:%d%c", button_number,
 440                   (is_down) ? 'p' : 'r');
 441         /* TODO: FIXME distinguish between physical and
 442          * logical buttons
 443          */
 444         mouse_e.type      = (is_down) ?
 445           Accessibility_BUTTON_PRESSED_EVENT :
 446           Accessibility_BUTTON_RELEASED_EVENT;
 447         mouse_e.id        = button_number;
 448         mouse_e.hw_code   = button_number;
 449         mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
 450         mouse_e.timestamp = 0;
 451         mouse_e.event_string = "";
 452         mouse_e.is_text   = FALSE;
 453         is_consumed =
 454           spi_controller_notify_mouselisteners (controller,
 455                                                 &mouse_e);
 456         if (!is_consumed)
 457           {
 458             dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
 459             emit(controller, event_name, DBUS_TYPE_UINT32, &x, DBUS_TYPE_UINT32, &y, DBUS_TYPE_INVALID);
 460           }
 461         else
 462           spi_dec_set_unlatch_pending (controller, mask_return);
 463       }
 464       return TRUE;
 465     }
 466   else
 467     {
 468       return FALSE;
 469     }
 470 }
 471
 472
 473 static guint
 474 spi_dec_mouse_check (SpiDEController *controller,
 475                      int *x, int *y, gboolean *moved)
 476 {
 477   int win_x_return,win_y_return;
 478   unsigned int mask_return;
 479   Window root_return, child_return;
 480   Display *display = spi_get_display ();
 481
 482   if (display != NULL)
 483     XQueryPointer(display, DefaultRootWindow (display),
 484                   &root_return, &child_return,
 485                   x, y,
 486                   &win_x_return, &win_y_return, &mask_return);
 487   /*
 488    * Since many clients grab the pointer, and X goes an automatic
 489    * pointer grab on mouse-down, we often must detect mouse button events
 490    * by polling rather than via a button grab.
 491    * The while loop (rather than if) is used since it's possible that
 492    * multiple buttons have changed state since we last checked.
 493    */
 494   if (mask_return != mouse_mask_state)
 495     {
 496       while (spi_dec_button_update_and_emit (controller, mask_return));
 497     }
 498
 499   if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
 500     {
 501       // TODO: combine these two signals?
 502       dbus_uint32_t ix = *x, iy = *y;
 503       emit(controller, "mouse_abs", DBUS_TYPE_UINT32, &ix, DBUS_TYPE_UINT32, &iy, DBUS_TYPE_INVALID);
 504       ix -= last_mouse_pos->x;
 505       iy -= last_mouse_pos->y;
 506       emit(controller, "mouse_rel", DBUS_TYPE_UINT32, &ix, DBUS_TYPE_UINT32, &iy, DBUS_TYPE_INVALID);
 507       last_mouse_pos->x = *x;
 508       last_mouse_pos->y = *y;
 509       *moved = True;
 510     }
 511   else
 512     {
 513       *moved = False;
 514     }
 515
 516   return mask_return;
 517 }
 518
 519 static void
 520 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
 521                              guint current_mask)
 522 {
 523   dbus_uint32_t d1, d2;
 524
 525 #ifdef SPI_XKB_DEBUG
 526   fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
 527            prev_mask, current_mask);
 528 #endif
 529
 530   /* set bits for the virtual modifiers like NUMLOCK */
 531   if (prev_mask & _numlock_physical_mask)
 532     prev_mask |= SPI_KEYMASK_NUMLOCK;
 533   if (current_mask & _numlock_physical_mask)
 534     current_mask |= SPI_KEYMASK_NUMLOCK;
 535
 536   d1 = prev_mask & key_modifier_mask;
 537   d2 = current_mask & key_modifier_mask;
 538       emit(controller, "keyboard_modifiers", DBUS_TYPE_UINT32, &d1, DBUS_TYPE_UINT32, &d2, DBUS_TYPE_INVALID);
 539 }
 540
 541 static gboolean
 542 spi_dec_poll_mouse_moved (gpointer data)
 543 {
 544   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
 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 (SpiDEController *dec)
 601 {
 602 #ifdef GRAB_BUTTON
 603   Display *display = spi_get_display ();
 604 #endif
 605   g_timeout_add (100, spi_dec_poll_mouse_idle, dec);
 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 }
 839
 840 static void
 841 handle_keygrab (SpiDEController         *controller,
 842                 DEControllerKeyListener *key_listener,
 843                 void                   (*process_cb) (SpiDEController *controller,
 844                                                       DEControllerGrabMask *grab_mask))
 845 {
 846   DEControllerGrabMask grab_mask = { 0 };
 847
 848   grab_mask.mod_mask = key_listener->mask;
 849   if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
 850     {
 851       grab_mask.key_val = AnyKey;
 852 #ifdef SPI_DEBUG
 853       fprintf (stderr, "AnyKey grab!");
 854 #endif
 855       process_cb (controller, &grab_mask);
 856     }
 857   else
 858     {
 859       GSList *l;
 860
 861       for (l = key_listener->keys; l; l = g_slist_next(l))
 862         {
 863           Accessibility_KeyDefinition *keydef = l->data;
 864           long int key_val = keydef->keysym;
 865           /* X Grabs require keycodes, not keysyms */
 866           if (keydef->keystring && keydef->keystring[0])
 867             {
 868               key_val = XStringToKeysym(keydef->keystring);
 869             }
 870           if (key_val > 0)
 871             {
 872               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 873             }
 874           else
 875             {
 876               key_val = keydef->keycode;
 877             }
 878           grab_mask.key_val = key_val;
 879           process_cb (controller, &grab_mask);
 880         }
 881     }
 882 }
 883
 884 static gboolean
 885 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 886                                          DEControllerKeyListener *key_listener)
 887 {
 888   handle_keygrab (controller, key_listener, _register_keygrab);
 889   if (controller->xevie_display == NULL)
 890     return spi_controller_update_key_grabs (controller, NULL);
 891   else
 892     return TRUE;
 893 }
 894
 895 static void
 896 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 897                                            DEControllerKeyListener *key_listener)
 898 {
 899   handle_keygrab (controller, key_listener, _deregister_keygrab);
 900   if (controller->xevie_display == NULL)
 901     spi_controller_update_key_grabs (controller, NULL);
 902 }
 903
 904 static gboolean
 905 spi_controller_register_device_listener (SpiDEController      *controller,
 906                                          DEControllerListener *listener)
 907 {
 908   DEControllerKeyListener *key_listener;
 909
 910   switch (listener->type) {
 911   case SPI_DEVICE_TYPE_KBD:
 912       key_listener = (DEControllerKeyListener *) listener;
 913
 914       controller->key_listeners = g_list_prepend (controller->key_listeners,
 915                                                   key_listener);
 916       spi_dbus_add_disconnect_match (controller->droute->bus, key_listener->listener.bus_name);
 917       if (key_listener->mode->global)
 918         {
 919           return spi_controller_register_global_keygrabs (controller, key_listener);
 920         }
 921       else
 922               return TRUE;
 923       break;
 924   case SPI_DEVICE_TYPE_MOUSE:
 925       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
 926       spi_dbus_add_disconnect_match (controller->droute->bus, listener->bus_name);
 927       break;
 928   default:
 929       break;
 930   }
 931   return FALSE;
 932 }
 933
 934 static gboolean
 935 Accessibility_DeviceEventListener_notifyEvent(SpiDEController *controller,
 936                                               SpiRegistry *registry,
 937                                               DEControllerListener *listener,
 938                                               const Accessibility_DeviceEvent *key_event)
 939 {
 940   DBusMessage *message = dbus_message_new_method_call(listener->bus_name, listener->path, "org.freedesktop.atspi.Registry", "notifyEvent");
 941   DBusError error;
 942   dbus_bool_t consumed = FALSE;
 943
 944   dbus_error_init(&error);
 945   if (spi_dbus_marshal_deviceEvent(message, key_event))
 946   {
 947     // TODO: Evaluate performance: perhaps rework this whole architecture
 948     // to avoid blocking calls
 949     DBusMessage *reply = dbus_connection_send_with_reply_and_block(controller->droute->bus, message, 1000, &error);
 950     if (reply)
 951     {
 952       DBusError error;
 953       dbus_error_init(&error);
 954       dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
 955       dbus_message_unref(reply);
 956     }
 957   }
 958   dbus_message_unref(message);
 959   return consumed;
 960 }
 961
 962 static gboolean
 963 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 964                                       const Accessibility_DeviceEvent *event)
 965 {
 966   GList   *l;
 967   GSList  *notify = NULL, *l2;
 968   GList  **listeners = &controller->mouse_listeners;
 969   gboolean is_consumed;
 970 #ifdef SPI_KEYEVENT_DEBUG
 971   gboolean found = FALSE;
 972 #endif
 973   if (!listeners)
 974     {
 975       return FALSE;
 976     }
 977
 978   for (l = *listeners; l; l = l->next)
 979     {
 980        DEControllerListener *listener = l->data;
 981
 982        if (spi_eventtype_seq_contains_event (listener->types, event))
 983          {
 984            /* we clone (don't dup) the listener, to avoid refcount inc. */
 985            notify = g_slist_prepend (notify,
 986                                      spi_listener_clone (listener));
 987 #ifdef SPI_KEYEVENT_DEBUG
 988            found = TRUE;
 989 #endif
 990          }
 991     }
 992
 993 #ifdef SPI_KEYEVENT_DEBUG
 994   if (!found)
 995     {
 996       g_print ("no match for event\n");
 997     }
 998 #endif
 999
1000   is_consumed = FALSE;
1001   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1002     {
1003       DEControllerListener *listener = l2->data;
1004
1005       is_consumed = Accessibility_DeviceEventListener_notifyEvent (controller, controller->registry, listener, event);
1006
1007       spi_listener_clone_free ((DEControllerListener *) l2->data);
1008     }
1009
1010   for (; l2; l2 = l2->next)
1011     {
1012       DEControllerListener *listener = l2->data;
1013       spi_listener_clone_free (listener);
1014       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1015     }
1016
1017   g_slist_free (notify);
1018
1019 #ifdef SPI_DEBUG
1020   if (is_consumed) g_message ("consumed\n");
1021 #endif
1022   return is_consumed;
1023 }
1024
1025 static void
1026 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1027                                                  XEvent *xevent)
1028 {
1029   Accessibility_DeviceEvent mouse_e;
1030   gchar event_name[24];
1031   gboolean is_consumed = FALSE;
1032   gboolean xkb_mod_unlatch_occurred;
1033   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1034   dbus_uint32_t ix, iy;
1035
1036   int button = xbutton_event->button;
1037
1038   unsigned int mouse_button_state = xbutton_event->state;
1039
1040   switch (button)
1041     {
1042     case 1:
1043             mouse_button_state |= Button1Mask;
1044             break;
1045     case 2:
1046             mouse_button_state |= Button2Mask;
1047             break;
1048     case 3:
1049             mouse_button_state |= Button3Mask;
1050             break;
1051     case 4:
1052             mouse_button_state |= Button4Mask;
1053             break;
1054     case 5:
1055             mouse_button_state |= Button5Mask;
1056             break;
1057     }
1058
1059   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1060   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1061
1062 #ifdef SPI_DEBUG
1063   fprintf (stderr, "mouse button %d %s (%x)\n",
1064            xbutton_event->button,
1065            (xevent->type == ButtonPress) ? "Press" : "Release",
1066            mouse_button_state);
1067 #endif
1068   snprintf (event_name, 22, "mouse:button_%d%c", button,
1069             (xevent->type == ButtonPress) ? 'p' : 'r');
1070
1071   /* TODO: FIXME distinguish between physical and logical buttons */
1072   mouse_e.type      = (xevent->type == ButtonPress) ?
1073                       Accessibility_BUTTON_PRESSED_EVENT :
1074                       Accessibility_BUTTON_RELEASED_EVENT;
1075   mouse_e.id        = button;
1076   mouse_e.hw_code   = button;
1077   mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1078   mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1079   mouse_e.event_string = "";
1080   mouse_e.is_text   = FALSE;
1081   if ((mouse_button_state & mouse_button_mask) !=
1082        (mouse_mask_state & mouse_button_mask))
1083     {
1084       if ((mouse_mask_state & key_modifier_mask) !=
1085           (mouse_button_state & key_modifier_mask))
1086         spi_dec_emit_modifier_event (controller,
1087                                      mouse_mask_state, mouse_button_state);
1088       mouse_mask_state = mouse_button_state;
1089       is_consumed =
1090         spi_controller_notify_mouselisteners (controller, &mouse_e);
1091       ix = last_mouse_pos->x;
1092       iy = last_mouse_pos->y;
1093       /* TODO - Work out which part of the spec this emit is fulfilling */
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       XSynchronize (display, FALSE);
1235     }
1236
1237   return GDK_FILTER_CONTINUE;
1238 }
1239
1240 static int
1241 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1242 {
1243   if (error->error_code == BadAccess)
1244     {
1245       g_message ("Could not complete key grab: grab already in use.\n");
1246       spi_error_code = BadAccess;
1247       return 0;
1248     }
1249   else
1250     {
1251       return (*x_default_error_handler) (display, error);
1252     }
1253 }
1254
1255 static void
1256 spi_controller_register_with_devices (SpiDEController *controller)
1257 {
1258   DEControllerPrivateData *priv;
1259   int event_base, error_base, major_version, minor_version;
1260
1261   priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1262   if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1263     {
1264       XTestGrabControl (spi_get_display (), True);
1265     }
1266
1267   /* calls to device-specific implementations and routines go here */
1268   /* register with: keyboard hardware code handler */
1269   /* register with: (translated) keystroke handler */
1270
1271   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1272                                       &priv->xkb_major_extension_opcode,
1273                                       &priv->xkb_base_event_code,
1274                                       &priv->xkb_base_error_code, NULL, NULL);
1275   if (priv->have_xkb)
1276     {
1277       gint i;
1278       guint64 reserved = 0;
1279       priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1280       XkbSelectEvents (spi_get_display (),
1281                        XkbUseCoreKbd,
1282                        XkbStateNotifyMask, XkbStateNotifyMask);
1283       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1284                                                      XK_Num_Lock);
1285       for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1286       {
1287           if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1288           {
1289               if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1290               {
1291                   /* don't use this one if there's a grab client! */
1292                   gdk_error_trap_push ();
1293                   XGrabKey (spi_get_display (), i, 0,
1294                             gdk_x11_get_default_root_xwindow (),
1295                             TRUE,
1296                             GrabModeSync, GrabModeSync);
1297                   XSync (spi_get_display (), TRUE);
1298                   XUngrabKey (spi_get_display (), i, 0,
1299                               gdk_x11_get_default_root_xwindow ());
1300                   if (!gdk_error_trap_pop ())
1301                   {
1302                       reserved = i;
1303                       break;
1304                   }
1305               }
1306           }
1307       }
1308       if (reserved)
1309       {
1310           priv->reserved_keycode = reserved;
1311           priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1312       }
1313       else
1314       {
1315           priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1316           priv->reserved_keysym = XK_numbersign;
1317       }
1318 #ifdef SPI_RESERVED_DEBUG
1319       unsigned sym = 0;
1320       sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1321       fprintf (stderr, "%x\n", sym);
1322       fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1323                reserved,
1324                XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1325                                                             reserved, 0)));
1326 #endif
1327     }
1328
1329   gdk_window_add_filter (NULL, global_filter_fn, controller);
1330
1331   gdk_window_set_events (gdk_get_default_root_window (),
1332                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
1333
1334   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1335 }
1336
1337 static gboolean
1338 spi_key_set_contains_key (GSList                          *key_set,
1339                           const Accessibility_DeviceEvent *key_event)
1340 {
1341   gint i;
1342   gint len;
1343   GSList *l;
1344
1345   if (!key_set)
1346     {
1347       g_print ("null key set!");
1348       return TRUE;
1349     }
1350
1351   len = g_slist_length (key_set);
1352
1353   if (len == 0) /* special case, means "all keys/any key" */
1354     {
1355 #ifdef SPI_DEBUG
1356       g_print ("anykey\n");
1357 #endif
1358       return TRUE;
1359     }
1360
1361   for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1362     {
1363       Accessibility_KeyDefinition *kd = l->data;
1364 #ifdef SPI_KEYEVENT_DEBUG
1365       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1366                 i,
1367                 (int) kd->keysym,
1368                 (int) kd->keycode,
1369                 (int) key_event->id,
1370                 (int) key_event->hw_code,
1371                 key_event->event_string);
1372 #endif
1373       if (kd->keysym == (dbus_uint32_t) key_event->id)
1374         {
1375           return TRUE;
1376         }
1377       if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1378         {
1379           return TRUE;
1380         }
1381       if (key_event->event_string && key_event->event_string[0] &&
1382           !strcmp (kd->keystring, key_event->event_string))
1383         {
1384           return TRUE;
1385         }
1386     }
1387
1388   return FALSE;
1389 }
1390
1391 static gboolean
1392 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1393                                   const Accessibility_DeviceEvent *event)
1394 {
1395   if (types == 0) /* special case, means "all events/any event" */
1396     {
1397       return TRUE;
1398     }
1399
1400   return (types & (1 << event->type));
1401 }
1402
1403 static gboolean
1404 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1405                                 DEControllerKeyListener         *listener,
1406                                 dbus_bool_t                    is_system_global)
1407 {
1408   if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1409        spi_key_set_contains_key (listener->keys, key_event) &&
1410        spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1411       (is_system_global == listener->mode->global))
1412     {
1413       return TRUE;
1414     }
1415   else
1416     {
1417       return FALSE;
1418     }
1419 }
1420
1421 static gboolean
1422 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1423                                     Accessibility_DeviceEvent       *key_event,
1424                                     dbus_bool_t                    is_system_global)
1425 {
1426   GList   *l;
1427   GSList  *notify = NULL, *l2;
1428   GList  **key_listeners = &controller->key_listeners;
1429   gboolean is_consumed;
1430
1431   if (!key_listeners)
1432     {
1433       return FALSE;
1434     }
1435
1436   /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1437   if (key_event->modifiers & _numlock_physical_mask)
1438       key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1439
1440   for (l = *key_listeners; l; l = l->next)
1441     {
1442        DEControllerKeyListener *key_listener = l->data;
1443
1444        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1445          {
1446            /* we clone (don't dup) the listener, to avoid refcount inc. */
1447            notify = g_slist_prepend (notify,
1448                                      spi_key_listener_clone (key_listener));
1449          }
1450     }
1451
1452 #ifdef SPI_KEYEVENT_DEBUG
1453   if (!notify)
1454     {
1455       g_print ("no match for event\n");
1456     }
1457 #endif
1458
1459   is_consumed = FALSE;
1460   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1461     {
1462       DEControllerKeyListener *key_listener = l2->data;
1463
1464       is_consumed = Accessibility_DeviceEventListener_notifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1465                     key_listener->mode->preemptive;
1466
1467       spi_key_listener_clone_free (key_listener);
1468     }
1469
1470   for (; l2; l2 = l2->next)
1471     {
1472       DEControllerKeyListener *key_listener = l2->data;
1473       spi_key_listener_clone_free (key_listener);
1474       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1475     }
1476
1477   g_slist_free (notify);
1478
1479 #ifdef SPI_DEBUG
1480   if (is_consumed) g_message ("consumed\n");
1481 #endif
1482   return is_consumed;
1483 }
1484
1485 static gboolean
1486 spi_clear_error_state (void)
1487 {
1488         gboolean retval = spi_error_code != 0;
1489         spi_error_code = 0;
1490         return retval;
1491 }
1492
1493 static Accessibility_DeviceEvent
1494 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1495 {
1496   Accessibility_DeviceEvent key_event;
1497   KeySym keysym;
1498   const int cbuf_bytes = 20;
1499   char cbuf [21];
1500   int nbytes;
1501
1502   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1503   key_event.id = (dbus_int32_t)(keysym);
1504   key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1505   if (((XEvent *) x_key_event)->type == KeyPress)
1506     {
1507       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1508     }
1509   else
1510     {
1511       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1512     }
1513   key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1514   key_event.is_text = FALSE;
1515   switch (keysym)
1516     {
1517       case ' ':
1518         key_event.event_string = g_strdup ("space");
1519         break;
1520       case XK_Tab:
1521         key_event.event_string = g_strdup ("Tab");
1522         break;
1523       case XK_BackSpace:
1524         key_event.event_string = g_strdup ("Backspace");
1525         break;
1526       case XK_Return:
1527         key_event.event_string = g_strdup ("Return");
1528         break;
1529       case XK_Home:
1530         key_event.event_string = g_strdup ("Home");
1531         break;
1532       case XK_Page_Down:
1533         key_event.event_string = g_strdup ("Page_Down");
1534         break;
1535       case XK_Page_Up:
1536         key_event.event_string = g_strdup ("Page_Up");
1537         break;
1538       case XK_F1:
1539         key_event.event_string = g_strdup ("F1");
1540         break;
1541       case XK_F2:
1542         key_event.event_string = g_strdup ("F2");
1543         break;
1544       case XK_F3:
1545         key_event.event_string = g_strdup ("F3");
1546         break;
1547       case XK_F4:
1548         key_event.event_string = g_strdup ("F4");
1549         break;
1550       case XK_F5:
1551         key_event.event_string = g_strdup ("F5");
1552         break;
1553       case XK_F6:
1554         key_event.event_string = g_strdup ("F6");
1555         break;
1556       case XK_F7:
1557         key_event.event_string = g_strdup ("F7");
1558         break;
1559       case XK_F8:
1560         key_event.event_string = g_strdup ("F8");
1561         break;
1562       case XK_F9:
1563         key_event.event_string = g_strdup ("F9");
1564         break;
1565       case XK_F10:
1566         key_event.event_string = g_strdup ("F10");
1567         break;
1568       case XK_F11:
1569         key_event.event_string = g_strdup ("F11");
1570         break;
1571       case XK_F12:
1572         key_event.event_string = g_strdup ("F12");
1573         break;
1574       case XK_End:
1575         key_event.event_string = g_strdup ("End");
1576         break;
1577       case XK_Escape:
1578         key_event.event_string = g_strdup ("Escape");
1579         break;
1580       case XK_Up:
1581         key_event.event_string = g_strdup ("Up");
1582         break;
1583       case XK_Down:
1584         key_event.event_string = g_strdup ("Down");
1585         break;
1586       case XK_Left:
1587         key_event.event_string = g_strdup ("Left");
1588         break;
1589       case XK_Right:
1590         key_event.event_string = g_strdup ("Right");
1591         break;
1592       default:
1593         if (nbytes > 0)
1594           {
1595             gunichar c;
1596             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1597             key_event.event_string = g_strdup (cbuf);
1598             c = keysym2ucs (keysym);
1599             if (c > 0 && !g_unichar_iscntrl (c))
1600               {
1601                 key_event.is_text = TRUE;
1602                 /* incorrect for some composed chars? */
1603               }
1604           }
1605         else
1606           {
1607             key_event.event_string = g_strdup ("");
1608           }
1609     }
1610
1611   key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1612 #ifdef SPI_KEYEVENT_DEBUG
1613   {
1614     char *pressed_str  = "pressed";
1615     char *released_str = "released";
1616     char *state_ptr;
1617
1618     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1619       state_ptr = pressed_str;
1620     else
1621       state_ptr = released_str;
1622
1623     fprintf (stderr,
1624              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1625              (unsigned long) keysym,
1626              state_ptr,
1627              keysym ? (int) keysym : '*',
1628              (int) x_key_event->state,
1629              key_event.event_string,
1630              key_event.event_string[0],
1631              (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1632   }
1633 #endif
1634 #ifdef SPI_DEBUG
1635   fprintf (stderr, "%s%c\n",
1636      (x_key_event->state & Mod1Mask)?"Alt-":"",
1637      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1638      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1639   fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1640 #endif /* SPI_DEBUG */
1641   return key_event;
1642 }
1643
1644 static gboolean
1645 spi_controller_update_key_grabs (SpiDEController           *controller,
1646                                  Accessibility_DeviceEvent *recv)
1647 {
1648   GList *l, *next;
1649   gboolean   update_failed = FALSE;
1650   KeyCode keycode = 0;
1651
1652   g_return_val_if_fail (controller != NULL, FALSE);
1653
1654   /*
1655    * masks known to work with default RH 7.1+:
1656    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1657    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1658    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1659    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1660    *
1661    * ControlMask grabs are broken, must be in use already
1662    */
1663   if (recv)
1664     keycode = keycode_for_keysym (controller, recv->id, NULL);
1665   for (l = controller->keygrabs_list; l; l = next)
1666     {
1667       gboolean do_remove;
1668       gboolean re_issue_grab;
1669       DEControllerGrabMask *grab_mask = l->data;
1670
1671       next = l->next;
1672
1673       re_issue_grab = recv &&
1674               (recv->modifiers & grab_mask->mod_mask) &&
1675               (grab_mask->key_val == keycode);
1676
1677 #ifdef SPI_DEBUG
1678       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1679                (long int) grab_mask->key_val,
1680                (long int) grab_mask->mod_mask,
1681                grab_mask->pending_add ? '+' : '.',
1682                grab_mask->pending_remove ? '-' : '.',
1683                re_issue_grab ? "re-issue": "");
1684 #endif
1685
1686       do_remove = FALSE;
1687
1688       if (grab_mask->pending_add && grab_mask->pending_remove)
1689         {
1690           do_remove = TRUE;
1691         }
1692       else if (grab_mask->pending_remove)
1693         {
1694 #ifdef SPI_DEBUG
1695       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1696 #endif
1697           XUngrabKey (spi_get_display (),
1698                       grab_mask->key_val,
1699                       grab_mask->mod_mask,
1700                       gdk_x11_get_default_root_xwindow ());
1701
1702           do_remove = TRUE;
1703         }
1704       else if (grab_mask->pending_add || re_issue_grab)
1705         {
1706
1707 #ifdef SPI_DEBUG
1708           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1709 #endif
1710           XGrabKey (spi_get_display (),
1711                     grab_mask->key_val,
1712                     grab_mask->mod_mask,
1713                     gdk_x11_get_default_root_xwindow (),
1714                     True,
1715                     GrabModeSync,
1716                     GrabModeSync);
1717           XSync (spi_get_display (), False);
1718           update_failed = spi_clear_error_state ();
1719           if (update_failed) {
1720                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1721                   do_remove = TRUE;
1722           }
1723         }
1724
1725       grab_mask->pending_add = FALSE;
1726       grab_mask->pending_remove = FALSE;
1727
1728       if (do_remove)
1729         {
1730           g_assert (grab_mask->ref_count <= 0);
1731
1732           controller->keygrabs_list = g_list_delete_link (
1733             controller->keygrabs_list, l);
1734
1735           spi_grab_mask_free (grab_mask);
1736         }
1737
1738     }
1739
1740   return ! update_failed;
1741 }
1742
1743 /*
1744  * Implemented GObject::finalize
1745  */
1746 static void
1747 spi_device_event_controller_object_finalize (GObject *object)
1748 {
1749   SpiDEController *controller;
1750   DEControllerPrivateData *private;
1751   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1752   GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1753 #ifdef SPI_DEBUG
1754   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1755 #endif
1756   /* disconnect any special listeners, get rid of outstanding keygrabs */
1757   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1758
1759 #ifdef HAVE_XEVIE
1760   if (controller->xevie_display != NULL)
1761     {
1762       XevieEnd(controller->xevie_display);
1763 #ifdef SPI_KEYEVENT_DEBUG
1764       printf("XevieEnd(dpy) finished \n");
1765 #endif
1766     }
1767 #endif
1768
1769   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1770   if (private->xkb_desc)
1771           XkbFreeKeyboard (private->xkb_desc, 0, True);
1772   g_free (private);
1773   parent_class->finalize (object);
1774 }
1775
1776 /*
1777  * DBus Accessibility::DEController::registerKeystrokeListener
1778  *     method implementation
1779  */
1780 static DBusMessage *
1781 impl_register_keystroke_listener (DBusConnection *bus,
1782                                   DBusMessage *message,
1783                                   void *user_data)
1784 {
1785   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1786   DEControllerKeyListener *dec_listener;
1787   DBusMessageIter iter, iter_array;
1788   const char *path;
1789   GSList *keys = NULL;
1790   dbus_int32_t mask, type;
1791   Accessibility_EventListenerMode *mode;
1792   dbus_bool_t ret;
1793   DBusMessage *reply;
1794   char *keystring;
1795
1796   dbus_message_iter_init(message, &iter);
1797   // TODO: verify type signature
1798   dbus_message_iter_get_basic(&iter, &path);
1799   dbus_message_iter_next(&iter);
1800   dbus_message_iter_recurse(&iter, &iter_array);
1801   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1802   {
1803     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
1804     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))
1805     {
1806       break;
1807     }
1808     kd->keystring = g_strdup (keystring);
1809     keys = g_slist_append(keys, kd);
1810   }
1811   dbus_message_iter_next(&iter);
1812   dbus_message_iter_get_basic(&iter, &mask);
1813   dbus_message_iter_next(&iter);
1814   dbus_message_iter_get_basic(&iter, &type);
1815   dbus_message_iter_next(&iter);
1816   mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
1817   if (mode)
1818   {
1819     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);
1820   }
1821 #ifdef SPI_DEBUG
1822   fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
1823            dbus_message_get_sender(message), path, (unsigned long) mask);
1824 #endif
1825   dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
1826   ret = spi_controller_register_device_listener (
1827           controller, (DEControllerListener *) dec_listener);
1828   reply = dbus_message_new_method_return (message);
1829   if (reply)
1830   {
1831     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1832   }
1833   return reply;
1834 }
1835
1836 /*
1837  * DBus Accessibility::DEController::registerDeviceEventListener
1838  *     method implementation
1839  */
1840 static DBusMessage *
1841 impl_register_device_listener (DBusConnection *bus,
1842                                   DBusMessage *message,
1843                                   void *user_data)
1844 {
1845   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1846   DEControllerListener *dec_listener;
1847   DBusError error;
1848   const char *path;
1849   dbus_int32_t event_types;
1850   dbus_bool_t ret;
1851   DBusMessage *reply;
1852
1853   dbus_error_init(&error);
1854   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
1855   {
1856     return spi_dbus_general_error (message);
1857   }
1858   dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
1859   ret =  spi_controller_register_device_listener (
1860           controller, (DEControllerListener *) dec_listener);
1861   reply = dbus_message_new_method_return (message);
1862   if (reply)
1863   {
1864     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1865   }
1866   return reply;
1867 }
1868
1869 typedef struct {
1870         DBusConnection *bus;
1871         DEControllerListener    *listener;
1872 } RemoveListenerClosure;
1873
1874 static SpiReEntrantContinue
1875 remove_listener_cb (GList * const *list,
1876                     gpointer       user_data)
1877 {
1878   DEControllerListener  *listener = (*list)->data;
1879   RemoveListenerClosure *ctx = user_data;
1880
1881   if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
1882       !strcmp(ctx->listener->path, listener->path))
1883     {
1884       spi_re_entrant_list_delete_link (list);
1885       spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
1886       spi_dec_listener_free (listener);
1887     }
1888
1889   return SPI_RE_ENTRANT_CONTINUE;
1890 }
1891
1892 static SpiReEntrantContinue
1893 copy_key_listener_cb (GList * const *list,
1894                       gpointer       user_data)
1895 {
1896   DEControllerKeyListener  *key_listener = (*list)->data;
1897   RemoveListenerClosure    *ctx = user_data;
1898
1899   if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
1900       !strcmp(ctx->listener->path, key_listener->listener.path))
1901     {
1902       /* TODO: FIXME aggregate keys in case the listener is registered twice */
1903       DEControllerKeyListener *ctx_key_listener =
1904         (DEControllerKeyListener *) ctx->listener;
1905       keylist_free (ctx_key_listener->keys);
1906       ctx_key_listener->keys = keylist_clone(key_listener->keys);
1907     }
1908
1909   return SPI_RE_ENTRANT_CONTINUE;
1910 }
1911
1912 static void
1913 spi_controller_deregister_device_listener (SpiDEController            *controller,
1914                                            DEControllerListener *listener)
1915 {
1916   RemoveListenerClosure  ctx;
1917
1918   ctx.bus = controller->droute->bus;
1919   ctx.listener = listener;
1920
1921   spi_re_entrant_list_foreach (&controller->mouse_listeners,
1922                                remove_listener_cb, &ctx);
1923 }
1924
1925 static void
1926 spi_deregister_controller_key_listener (SpiDEController            *controller,
1927                                         DEControllerKeyListener    *key_listener)
1928 {
1929   RemoveListenerClosure  ctx;
1930
1931   ctx.bus = controller->droute->bus;
1932   ctx.listener = (DEControllerListener *) key_listener;
1933
1934   /* special case, copy keyset from existing controller list entry */
1935   if (g_slist_length(key_listener->keys) == 0)
1936     {
1937       spi_re_entrant_list_foreach (&controller->key_listeners,
1938                                   copy_key_listener_cb, &ctx);
1939     }
1940
1941   spi_controller_deregister_global_keygrabs (controller, key_listener);
1942
1943   spi_re_entrant_list_foreach (&controller->key_listeners,
1944                                 remove_listener_cb, &ctx);
1945
1946 }
1947
1948 void
1949 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
1950 {
1951   GList *l, *tmp;
1952
1953   for (l = controller->mouse_listeners; l; l = tmp)
1954   {
1955     DEControllerListener *listener = l->data;
1956     tmp = l->next;
1957     if (!strcmp (listener->bus_name, bus_name))
1958     {
1959       spi_controller_deregister_device_listener (controller, listener);
1960     }
1961   }
1962   for (l = controller->key_listeners; l; l = tmp)
1963   {
1964     DEControllerKeyListener *key_listener = l->data;
1965     tmp = l->next;
1966     if (!strcmp (key_listener->listener.bus_name, bus_name))
1967     {
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_DEVICE_EVENT_CONTROLLER(user_data);
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_DEVICE_EVENT_CONTROLLER(user_data);
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) + 1;
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_DEVICE_EVENT_CONTROLLER(user_data);
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 (synth_type == Accessibility_KEY_SYM) {
2406     keysym = keycode;
2407   }
2408   else {
2409     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2410   }
2411   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2412     {
2413       spi_dec_clear_unlatch_pending (controller);
2414     }
2415   reply = dbus_message_new_method_return (message);
2416   return reply;
2417 }
2418
2419 /* Accessibility::DEController::generateMouseEvent */
2420 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2421 {
2422   DBusError error;
2423   dbus_int32_t       x;
2424   dbus_int32_t       y;
2425   char *eventName;
2426   DBusMessage *reply;
2427   int button = 0;
2428   gboolean err = FALSE;
2429   Display *display = spi_get_display ();
2430
2431   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2432   {
2433     return spi_dbus_general_error (message);
2434   }
2435
2436 #ifdef SPI_DEBUG
2437   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2438            eventName, (long int) x, (long int) y);
2439 #endif
2440   switch (eventName[0])
2441     {
2442       case 'b':
2443         switch (eventName[1])
2444           {
2445           /* TODO: check number of buttons before parsing */
2446           case '1':
2447                     button = 1;
2448                     break;
2449           case '2':
2450                   button = 2;
2451                   break;
2452           case '3':
2453                   button = 3;
2454                   break;
2455           case '4':
2456                   button = 4;
2457                   break;
2458           case '5':
2459                   button = 5;
2460                   break;
2461           default:
2462                   err = TRUE;
2463           }
2464         if (!err)
2465           {
2466             if (x != -1 && y != -1)
2467               {
2468                 XTestFakeMotionEvent (display, DefaultScreen (display),
2469                                       x, y, 0);
2470               }
2471             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2472             if (eventName[2] == 'c')
2473               XTestFakeButtonEvent (display, button, FALSE, 1);
2474             else if (eventName[2] == 'd')
2475               {
2476               XTestFakeButtonEvent (display, button, FALSE, 1);
2477               XTestFakeButtonEvent (display, button, TRUE, 2);
2478               XTestFakeButtonEvent (display, button, FALSE, 3);
2479               }
2480           }
2481         break;
2482       case 'r': /* relative motion */
2483         XTestFakeRelativeMotionEvent (display, x, y, 0);
2484         break;
2485       case 'a': /* absolute motion */
2486         XTestFakeMotionEvent (display, DefaultScreen (display),
2487                               x, y, 0);
2488         break;
2489     }
2490   reply = dbus_message_new_method_return (message);
2491   return reply;
2492 }
2493
2494 /* Accessibility::DEController::notifyListenersSync */
2495 static DBusMessage *
2496 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2497 {
2498   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2499   Accessibility_DeviceEvent event;
2500   dbus_bool_t ret;
2501   DBusMessage *reply;
2502
2503   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2504   {
2505     return spi_dbus_general_error (message);
2506   }
2507 #ifdef SPI_DEBUG
2508   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2509            controller, (int) event.id);
2510 #endif
2511   ret = spi_controller_notify_keylisteners (controller,
2512                                              (Accessibility_DeviceEvent *)
2513                                              &event, FALSE) ?
2514           TRUE : FALSE;
2515   reply = dbus_message_new_method_return (message);
2516   if (reply)
2517   {
2518     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2519   }
2520   return reply;
2521 }
2522
2523 static DBusMessage *
2524 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2525 {
2526   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2527   Accessibility_DeviceEvent event;
2528   DBusMessage *reply;
2529
2530   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2531   {
2532     return spi_dbus_general_error (message);
2533   }
2534 #ifdef SPI_DEBUG
2535   g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2536            controller, (int) event.id);
2537 #endif
2538   spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2539                                       &event, FALSE);
2540   reply = dbus_message_new_method_return (message);
2541   return reply;
2542 }
2543
2544 static void
2545 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2546 {
2547   GObjectClass * object_class = (GObjectClass *) klass;
2548
2549   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2550
2551   object_class->finalize = spi_device_event_controller_object_finalize;
2552
2553   if (!spi_dec_private_quark)
2554           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2555 }
2556
2557 #ifdef HAVE_XEVIE
2558 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2559 {
2560    return TRUE;
2561 }
2562
2563 static gboolean
2564 handle_io (GIOChannel *source,
2565            GIOCondition condition,
2566            gpointer data)
2567 {
2568   SpiDEController *controller = (SpiDEController *) data;
2569   gboolean is_consumed = FALSE;
2570   XEvent ev;
2571
2572   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2573     {
2574       if (ev.type == KeyPress || ev.type == KeyRelease)
2575         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2576
2577       if (! is_consumed)
2578         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2579     }
2580
2581   return TRUE;
2582 }
2583 #endif /* HAVE_XEVIE */
2584
2585 static void
2586 spi_device_event_controller_init (SpiDEController *device_event_controller)
2587 {
2588 #ifdef HAVE_XEVIE
2589   GIOChannel *ioc;
2590   int fd;
2591 #endif /* HAVE_XEVIE */
2592
2593   DEControllerPrivateData *private;
2594   device_event_controller->key_listeners   = NULL;
2595   device_event_controller->mouse_listeners = NULL;
2596   device_event_controller->keygrabs_list   = NULL;
2597   device_event_controller->xevie_display   = NULL;
2598
2599 #ifdef HAVE_XEVIE
2600   device_event_controller->xevie_display = XOpenDisplay(NULL);
2601
2602   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2603     {
2604 #ifdef SPI_KEYEVENT_DEBUG
2605       fprintf (stderr, "XevieStart() success \n");
2606 #endif
2607       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2608
2609       fd = ConnectionNumber(device_event_controller->xevie_display);
2610       ioc = g_io_channel_unix_new (fd);
2611       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2612       g_io_channel_unref (ioc);
2613     }
2614   else
2615     {
2616       device_event_controller->xevie_display = NULL;
2617 #ifdef SPI_KEYEVENT_DEBUG
2618       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2619 #endif
2620     }
2621 #endif /* HAVE_XEVIE */
2622
2623   private = g_new0 (DEControllerPrivateData, 1);
2624   gettimeofday (&private->last_press_time, NULL);
2625   gettimeofday (&private->last_release_time, NULL);
2626   g_object_set_qdata (G_OBJECT (device_event_controller),
2627                       spi_dec_private_quark,
2628                       private);
2629   spi_controller_register_with_devices (device_event_controller);
2630 }
2631
2632 static gboolean
2633 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2634                                                const XEvent    *event)
2635 {
2636   Accessibility_DeviceEvent key_event;
2637   gboolean ret;
2638
2639   g_assert (event->type == KeyPress || event->type == KeyRelease);
2640
2641   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2642
2643   if (controller->xevie_display == NULL)
2644     spi_controller_update_key_grabs (controller, &key_event);
2645
2646   /* relay to listeners, and decide whether to consume it or not */
2647   ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2648   g_free(key_event.event_string);
2649   return ret;
2650 }
2651
2652
2653 static gboolean
2654 is_key_released (KeyCode code)
2655 {
2656   char keys[32];
2657   int down;
2658
2659   XQueryKeymap (spi_get_display (), keys);
2660   down = BIT (keys, code);
2661   return (down == 0);
2662 }
2663
2664 static gboolean
2665 check_release (gpointer data)
2666 {
2667   gboolean released;
2668   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2669   KeyCode code = event->hw_code;
2670
2671   released = is_key_released (code);
2672
2673   if (released)
2674     {
2675       check_release_handler = 0;
2676       event->type = Accessibility_KEY_RELEASED_EVENT;
2677       spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2678     }
2679   return (released == 0);
2680 }
2681
2682 static void wait_for_release_event (XEvent          *event,
2683                                     SpiDEController *controller)
2684 {
2685   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2686   saved_controller = controller;
2687   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2688 }
2689
2690 static DBusMessage *
2691 impl_introspect (DBusConnection *bus, DBusMessage *message,
2692                  void *user_data)
2693 {
2694   const char *path;
2695   GString *output;
2696   char *final;
2697
2698   DBusMessage *reply;
2699
2700   path = dbus_message_get_path(message);
2701
2702   output = g_string_new(spi_introspection_header);
2703
2704   g_string_append_printf(output, spi_introspection_node_element, path);
2705
2706   spi_append_interface(output, SPI_DBUS_INTERFACE_DEC);
2707
2708   g_string_append(output, spi_introspection_footer);
2709   final = g_string_free(output, FALSE);
2710
2711   reply = dbus_message_new_method_return (message);
2712   g_assert(reply != NULL);
2713   dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
2714                            DBUS_TYPE_INVALID);
2715
2716   g_free(final);
2717   return reply;
2718 }
2719
2720 static DRouteMethod dev_methods[] =
2721 {
2722   { impl_register_keystroke_listener, "registerKeystrokeListener" },
2723   { impl_register_device_listener, "registerDeviceListener" },
2724   { impl_deregister_keystroke_listener, "deregisterKeystrokeListener" },
2725   { impl_deregister_device_listener, "deregisterDeviceListener" },
2726   { impl_generate_keyboard_event, "generateKeyboardEvent" },
2727   { impl_generate_mouse_event, "generateMouseEvent" },
2728   { impl_notify_listeners_sync, "notifyListenersSync" },
2729   { impl_notify_listeners_async, "notifyListenersAsync" },
2730   { NULL, NULL }
2731 };
2732
2733 static DRouteMethod intro_methods[] = {
2734   {impl_introspect, "Introspect"},
2735   {NULL, NULL}
2736 };
2737
2738 SpiDEController *
2739 spi_registry_dec_new (SpiRegistry *reg, DRouteData *droute)
2740 {
2741   SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2742
2743   dec->registry = g_object_ref (reg);
2744   dec->droute = droute;
2745
2746   droute_add_interface (droute,
2747                         SPI_DBUS_INTERFACE_DEC,
2748                         dev_methods,
2749                         NULL, NULL, NULL);
2750   droute_add_interface (droute,
2751                         "org.freedesktop.DBus.Introspectable",
2752                         intro_methods,
2753                         NULL, NULL, NULL);
2754
2755   spi_dec_init_mouse_listener (dec);
2756   /* TODO: kill mouse listener on finalize */
2757
2758   return dec;
2759 }