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