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