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