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