registryd/deviceeventcontroller.c

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