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