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